class Bfwd::CreateSubscriptionChargeAmendment

Attributes

actioned_time[RW]

{ "description" : "The time the amendment completed.", "verbs":["GET"] }

actioning_time[RW]

{ "description" : "When the amendment will run", "verbs":["POST","PUT","GET"] }

amendment_type[RW]

{ "description" : "Type of amendment", "verbs":["POST","GET"] }

amount[RW]

{ "description" : "Monetary value to charge in the same currency as the subscription.", "verbs":["POST","GET"] }

changed_by[RW]

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }

created[RW]

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }

deleted[RW]

{ "description" : "Is the amendment deleted.", "verbs":["GET"] }

description[RW]

{ "description" : ".", "verbs":["POST","GET"] }

discount[RW]

{ "description" : "", "verbs":[] }

id[RW]

{ "description" : "", "verbs":["GET"] }

invoicing_type[RW]

{ "description" : "<span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <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" : "Aggregated", "verbs":["POST","PUT","GET"] }

organization_id[RW]

{ "description" : "", "verbs":[""] }

pricing_component_id[RW]

{ "description" : "", "verbs":[] }

pricing_component_value_change[RW]

{ "description" : "", "verbs":[] }

state[RW]

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

subscription_charge[RW]

{ "description" : "", "verbs":["GET"] }

subscription_charge_id[RW]

{ "description" : "", "verbs":["GET"] }

subscription_id[RW]

{ "description" : "", "verbs":["POST","PUT","GET"] }

tax_status[RW]

{ "description" : "Whether the amount specified is <span class=\"label label-default\">inclusive</span> or <span class=\"label label-default\">exclusive</span> of tax", "default" : "inclusive", "verbs":["POST","PUT","GET"] }

type[RW]

{ "description" : "", "default" : "", "verbs":["POST","GET"] }

updated[RW]

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 104
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',
    :'subscription_charge_id' => :'subscriptionChargeID',
    :'description' => :'description',
    :'amount' => :'amount',
    :'discount' => :'discount',
    :'invoicing_type' => :'invoicingType',
    :'tax_status' => :'taxStatus',
    :'subscription_charge' => :'subscriptionCharge',
    :'pricing_component_value_change' => :'pricingComponentValueChange',
    :'pricing_component_id' => :'pricingComponentID'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 159
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?(:'subscriptionChargeID')
    self.subscription_charge_id = attributes[:'subscriptionChargeID']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'discount')
    self.discount = attributes[:'discount']
  end

  if attributes.has_key?(:'invoicingType')
    self.invoicing_type = attributes[:'invoicingType']
  end

  if attributes.has_key?(:'taxStatus')
    self.tax_status = attributes[:'taxStatus']
  end

  if attributes.has_key?(:'subscriptionCharge')
    self.subscription_charge = attributes[:'subscriptionCharge']
  end

  if attributes.has_key?(:'pricingComponentValueChange')
    self.pricing_component_value_change = attributes[:'pricingComponentValueChange']
  end

  if attributes.has_key?(:'pricingComponentID')
    self.pricing_component_id = attributes[:'pricingComponentID']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 131
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',
    :'subscription_charge_id' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'discount' => :'Float',
    :'invoicing_type' => :'String',
    :'tax_status' => :'String',
    :'subscription_charge' => :'SubscriptionCharge',
    :'pricing_component_value_change' => :'InsertableBillingEntity',
    :'pricing_component_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 368
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 &&
      subscription_charge_id == o.subscription_charge_id &&
      description == o.description &&
      amount == o.amount &&
      discount == o.discount &&
      invoicing_type == o.invoicing_type &&
      tax_status == o.tax_status &&
      subscription_charge == o.subscription_charge &&
      pricing_component_value_change == o.pricing_component_value_change &&
      pricing_component_id == o.pricing_component_id
end
_deserialize(type, value) click to toggle source

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_subscription_charge_amendment.rb, line 430
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
_to_hash(value) click to toggle source

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_subscription_charge_amendment.rb, line 496
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
amendment_type=(amendment_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] amendment_type Object to be assigned

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 328
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
build_from_hash(attributes) click to toggle source

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_subscription_charge_amendment.rb, line 409
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 396
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 402
def hash
  [created, changed_by, updated, type, id, organization_id, subscription_id, amendment_type, actioning_time, actioned_time, state, deleted, subscription_charge_id, description, amount, discount, invoicing_type, tax_status, subscription_charge, pricing_component_value_change, pricing_component_id].hash
end
invoicing_type=(invoicing_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] invoicing_type Object to be assigned

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 348
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
list_invalid_properties() click to toggle source

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_subscription_charge_amendment.rb, line 255
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 @amount.nil?
    invalid_properties.push("invalid value for 'amount', amount cannot be nil.")
  end

  if @invoicing_type.nil?
    invalid_properties.push("invalid value for 'invoicing_type', invoicing_type cannot be nil.")
  end

  if @tax_status.nil?
    invalid_properties.push("invalid value for 'tax_status', tax_status cannot be nil.")
  end

  return invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 338
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
tax_status=(tax_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] tax_status Object to be assigned

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 358
def tax_status=(tax_status)
  validator = EnumAttributeValidator.new('String', ["inclusive", "exclusive"])
  unless validator.valid?(tax_status)
    fail ArgumentError, "invalid value for 'tax_status', must be one of #{validator.allowable_values}."
  end
  @tax_status = tax_status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 476
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 482
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 470
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/bf_ruby2/models/create_subscription_charge_amendment.rb, line 318
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
valid?() click to toggle source

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_subscription_charge_amendment.rb, line 294
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 @amount.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 @tax_status.nil?
  tax_status_validator = EnumAttributeValidator.new('String', ["inclusive", "exclusive"])
  return false unless tax_status_validator.valid?(@tax_status)
  return true
end