class Bfwd::ProductRatePlanMigrationAmendment
Attributes
{ "description" : "The time the amendment completed.", "verbs":["GET"] }
{ "description" : "When the amendment will run", "verbs":["POST","PUT","GET"] }
{ "description" : "Type of amendment", "verbs":["POST","GET"] }
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "description" : "Is the amendment deleted.", "verbs":["GET"] }
{ "description" : "", "verbs":["GET"] }
{ "description" : "<span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued immediately for migration charges. <span class=\"label label-default\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.", "default" : "Immediate", "verbs":["POST","GET"] }
{ "description" : "Mapping of new rate-plans pricing-components to values", "verbs":["POST","GET"] }
{ "description" : "User definable description for the migrated subscription.", "verbs":["POST","GET"] }
{ "description" : "ID of the next subscription.", "verbs":["GET"] }
{ "description" : "User definable friendly name for the migrated subscription.", "verbs":["POST","GET"] }
{ "description" : "", "verbs":[""] }
{ "description" : "ID of the previous subscription.", "verbs":["GET"] }
{ "description" : "Pricing behaviour defines how migration charges are calculated. <span class=\"label label-default\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\"label label-default\">None</span> sets the migration charge as zero cost. <span class=\"label label-default\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\"label label-default\">Difference</span> is the same calculation as <span class=\"label label-default\">DifferenceProRated</span> but no pro-ration is applied. <span class=\"label label-default\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.", "default" : "DifferenceProRated", "verbs":["POST","GET"] }
{ "description" : "Identifier of the rate-plan the subscription to migrate to", "verbs":["POST","GET"] }
Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending
{ "description" : "", "verbs":["POST","PUT","GET"] }
{ "description" : "", "default" : "", "verbs":["POST","GET"] }
{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 101 def self.attribute_map { :'created' => :'created', :'changed_by' => :'changedBy', :'updated' => :'updated', :'type' => :'@type', :'id' => :'id', :'organization_id' => :'organizationID', :'subscription_id' => :'subscriptionID', :'amendment_type' => :'amendmentType', :'actioning_time' => :'actioningTime', :'actioned_time' => :'actionedTime', :'state' => :'state', :'deleted' => :'deleted', :'product_rate_plan_id' => :'productRatePlanID', :'invoicing_type' => :'invoicingType', :'mappings' => :'mappings', :'previous_subscription_id' => :'previousSubscriptionID', :'next_subscription_id' => :'nextSubscriptionID', :'next_subscription_name' => :'nextSubscriptionName', :'next_subscription_description' => :'nextSubscriptionDescription', :'pricing_behaviour' => :'pricingBehaviour' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 154 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?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'updated') self.updated = attributes[:'updated'] end if attributes.has_key?(:'@type') self.type = attributes[:'@type'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'subscriptionID') self.subscription_id = attributes[:'subscriptionID'] end if attributes.has_key?(:'amendmentType') self.amendment_type = attributes[:'amendmentType'] end if attributes.has_key?(:'actioningTime') self.actioning_time = attributes[:'actioningTime'] end if attributes.has_key?(:'actionedTime') self.actioned_time = attributes[:'actionedTime'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] else self.deleted = false end if attributes.has_key?(:'productRatePlanID') self.product_rate_plan_id = attributes[:'productRatePlanID'] end if attributes.has_key?(:'invoicingType') self.invoicing_type = attributes[:'invoicingType'] end if attributes.has_key?(:'mappings') if (value = attributes[:'mappings']).is_a?(Array) self.mappings = value end end if attributes.has_key?(:'previousSubscriptionID') self.previous_subscription_id = attributes[:'previousSubscriptionID'] end if attributes.has_key?(:'nextSubscriptionID') self.next_subscription_id = attributes[:'nextSubscriptionID'] end if attributes.has_key?(:'nextSubscriptionName') self.next_subscription_name = attributes[:'nextSubscriptionName'] end if attributes.has_key?(:'nextSubscriptionDescription') self.next_subscription_description = attributes[:'nextSubscriptionDescription'] end if attributes.has_key?(:'pricingBehaviour') self.pricing_behaviour = attributes[:'pricingBehaviour'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 127 def self.swagger_types { :'created' => :'DateTime', :'changed_by' => :'String', :'updated' => :'DateTime', :'type' => :'String', :'id' => :'String', :'organization_id' => :'String', :'subscription_id' => :'String', :'amendment_type' => :'String', :'actioning_time' => :'DateTime', :'actioned_time' => :'DateTime', :'state' => :'String', :'deleted' => :'BOOLEAN', :'product_rate_plan_id' => :'String', :'invoicing_type' => :'String', :'mappings' => :'Array<PricingComponentValueMigrationAmendmentMapping>', :'previous_subscription_id' => :'String', :'next_subscription_id' => :'String', :'next_subscription_name' => :'String', :'next_subscription_description' => :'String', :'pricing_behaviour' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 361 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && changed_by == o.changed_by && updated == o.updated && type == o.type && id == o.id && organization_id == o.organization_id && subscription_id == o.subscription_id && amendment_type == o.amendment_type && actioning_time == o.actioning_time && actioned_time == o.actioned_time && state == o.state && deleted == o.deleted && product_rate_plan_id == o.product_rate_plan_id && invoicing_type == o.invoicing_type && mappings == o.mappings && previous_subscription_id == o.previous_subscription_id && next_subscription_id == o.next_subscription_id && next_subscription_name == o.next_subscription_name && next_subscription_description == o.next_subscription_description && pricing_behaviour == o.pricing_behaviour 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/product_rate_plan_migration_amendment.rb, line 422 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/product_rate_plan_migration_amendment.rb, line 488 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
Custom attribute writer method checking allowed values (enum). @param [Object] amendment_type
Object to be assigned
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 321 def amendment_type=(amendment_type) validator = EnumAttributeValidator.new('String', ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"]) unless validator.valid?(amendment_type) fail ArgumentError, "invalid value for 'amendment_type', must be one of #{validator.allowable_values}." end @amendment_type = amendment_type 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/product_rate_plan_migration_amendment.rb, line 401 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
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 388 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 394 def hash [created, changed_by, updated, type, id, organization_id, subscription_id, amendment_type, actioning_time, actioned_time, state, deleted, product_rate_plan_id, invoicing_type, mappings, previous_subscription_id, next_subscription_id, next_subscription_name, next_subscription_description, pricing_behaviour].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] invoicing_type
Object to be assigned
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 341 def invoicing_type=(invoicing_type) validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"]) unless validator.valid?(invoicing_type) fail ArgumentError, "invalid value for 'invoicing_type', must be one of #{validator.allowable_values}." end @invoicing_type = invoicing_type 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/product_rate_plan_migration_amendment.rb, line 248 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if @subscription_id.nil? invalid_properties.push("invalid value for 'subscription_id', subscription_id cannot be nil.") end if @amendment_type.nil? invalid_properties.push("invalid value for 'amendment_type', amendment_type cannot be nil.") end if @state.nil? invalid_properties.push("invalid value for 'state', state cannot be nil.") end if @deleted.nil? invalid_properties.push("invalid value for 'deleted', deleted cannot be nil.") end if @product_rate_plan_id.nil? invalid_properties.push("invalid value for 'product_rate_plan_id', product_rate_plan_id cannot be nil.") end if @invoicing_type.nil? invalid_properties.push("invalid value for 'invoicing_type', invoicing_type cannot be nil.") end if @pricing_behaviour.nil? invalid_properties.push("invalid value for 'pricing_behaviour', pricing_behaviour cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] pricing_behaviour
Object to be assigned
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 351 def pricing_behaviour=(pricing_behaviour) validator = EnumAttributeValidator.new('String', ["None", "Full", "Difference", "DifferenceProRated", "ProRated"]) unless validator.valid?(pricing_behaviour) fail ArgumentError, "invalid value for 'pricing_behaviour', must be one of #{validator.allowable_values}." end @pricing_behaviour = pricing_behaviour end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 331 def state=(state) validator = EnumAttributeValidator.new('String', ["Pending", "Succeeded", "Failed", "Discarded"]) 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/product_rate_plan_migration_amendment.rb, line 474 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/product_rate_plan_migration_amendment.rb, line 462 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb, line 311 def type=(type) validator = EnumAttributeValidator.new('String', ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"]) unless validator.valid?(type) fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}." end @type = type 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/product_rate_plan_migration_amendment.rb, line 287 def valid? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"]) return false unless type_validator.valid?(@type) return false if @subscription_id.nil? return false if @amendment_type.nil? amendment_type_validator = EnumAttributeValidator.new('String', ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"]) return false unless amendment_type_validator.valid?(@amendment_type) return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ["Pending", "Succeeded", "Failed", "Discarded"]) return false unless state_validator.valid?(@state) return false if @deleted.nil? return false if @product_rate_plan_id.nil? return false if @invoicing_type.nil? invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"]) return false unless invoicing_type_validator.valid?(@invoicing_type) return false if @pricing_behaviour.nil? pricing_behaviour_validator = EnumAttributeValidator.new('String', ["None", "Full", "Difference", "DifferenceProRated", "ProRated"]) return false unless pricing_behaviour_validator.valid?(@pricing_behaviour) return true end