class Bfwd::CreateAggregatingSubscriptionRequest
Entity for requesting that an 'aggregating subscription' (i.e. a 'parent subscription' which collects the charges raised by many 'child subscriptions') be created.
Attributes
{"description":"ID of the BillForward Account
who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account
created for them.","verbs":}
{"default":false,"description":"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":}
{"default":"(empty list)","description":"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.","verbs":}
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{"description":"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":}
{"default":"(null)","description":"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show’).","verbs":}
{"description":"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.","verbs":}
{"description":"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.","verbs":}
{"default":"(Subscription
will be named after the rate plan to which the subscription subscribes)","description":"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)‘).","verbs":}
{"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization
within which the requested Subscription
should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":}
{"description":"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request — this subscription will subscribe to that newly-created rate plan.","verbs":}
{"description":"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan — either recurring or non-recurring.","verbs":}
{"default":"(ServerNow upon receiving request)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.","verbs":}
{"default":"Provisioned","description":"The state in which the created subscription will begin.
<span class=\"label label-default\">Provisioned</span> — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.
<span class=\"label label-default\">AwaitingPayment</span> — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.","verbs":}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 83 def self.attribute_map { :'created' => :'created', :'account_id' => :'accountID', :'organization_id' => :'organizationID', :'name' => :'name', :'description' => :'description', :'start' => :'start', :'state' => :'state', :'product_rate_plan' => :'productRatePlan', :'duration' => :'duration', :'duration_period' => :'durationPeriod', :'product_type' => :'productType', :'aggregating_components' => :'aggregatingComponents', :'aggregate_all_subscriptions_on_account' => :'aggregateAllSubscriptionsOnAccount', :'currency' => :'currency' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 124 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'accountID') self.account_id = attributes[:'accountID'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'start') self.start = attributes[:'start'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'productRatePlan') self.product_rate_plan = attributes[:'productRatePlan'] end if attributes.has_key?(:'duration') self.duration = attributes[:'duration'] end if attributes.has_key?(:'durationPeriod') self.duration_period = attributes[:'durationPeriod'] end if attributes.has_key?(:'productType') self.product_type = attributes[:'productType'] end if attributes.has_key?(:'aggregatingComponents') if (value = attributes[:'aggregatingComponents']).is_a?(Array) self.aggregating_components = value end end if attributes.has_key?(:'aggregateAllSubscriptionsOnAccount') self.aggregate_all_subscriptions_on_account = attributes[:'aggregateAllSubscriptionsOnAccount'] else self.aggregate_all_subscriptions_on_account = false end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 103 def self.swagger_types { :'created' => :'DateTime', :'account_id' => :'String', :'organization_id' => :'String', :'name' => :'String', :'description' => :'String', :'start' => :'DateTime', :'state' => :'String', :'product_rate_plan' => :'String', :'duration' => :'Integer', :'duration_period' => :'String', :'product_type' => :'String', :'aggregating_components' => :'Array<CreateAggregatingComponentRequest>', :'aggregate_all_subscriptions_on_account' => :'BOOLEAN', :'currency' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 253 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && account_id == o.account_id && organization_id == o.organization_id && name == o.name && description == o.description && start == o.start && state == o.state && product_rate_plan == o.product_rate_plan && duration == o.duration && duration_period == o.duration_period && product_type == o.product_type && aggregating_components == o.aggregating_components && aggregate_all_subscriptions_on_account == o.aggregate_all_subscriptions_on_account && currency == o.currency end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 308 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = Bfwd.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 374 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 287 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] duration_period
Object to be assigned
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 233 def duration_period=(duration_period) validator = EnumAttributeValidator.new('String', ["minutes", "days", "months", "years"]) unless validator.valid?(duration_period) fail ArgumentError, "invalid value for 'duration_period', must be one of #{validator.allowable_values}." end @duration_period = duration_period end
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 274 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 280 def hash [created, account_id, organization_id, name, description, start, state, product_rate_plan, duration, duration_period, product_type, aggregating_components, aggregate_all_subscriptions_on_account, currency].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 194 def list_invalid_properties invalid_properties = Array.new if @account_id.nil? invalid_properties.push("invalid value for 'account_id', account_id cannot be nil.") end if @currency.nil? invalid_properties.push("invalid value for 'currency', currency cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] product_type
Object to be assigned
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 243 def product_type=(product_type) validator = EnumAttributeValidator.new('String', ["nonrecurring", "recurring"]) unless validator.valid?(product_type) fail ArgumentError, "invalid value for 'product_type', must be one of #{validator.allowable_values}." end @product_type = product_type end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 223 def state=(state) validator = EnumAttributeValidator.new('String', ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"]) unless validator.valid?(state) fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}." end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 360 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 348 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/bf_ruby2/models/create_aggregating_subscription_request.rb, line 209 def valid? return false if @account_id.nil? state_validator = EnumAttributeValidator.new('String', ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"]) return false unless state_validator.valid?(@state) duration_period_validator = EnumAttributeValidator.new('String', ["minutes", "days", "months", "years"]) return false unless duration_period_validator.valid?(@duration_period) product_type_validator = EnumAttributeValidator.new('String', ["nonrecurring", "recurring"]) return false unless product_type_validator.valid?(@product_type) return false if @currency.nil? return true end