class OpenapiClient::InstallmentOptions

Indicates that the total sum payable is divided for payment at successive fixed times.

Attributes

installment_delay_months[RW]

The number of months the first installment payment will be delayed.

installments_interest[RW]

Indicates whether the installment interest amount has been applied.

merchant_advice_code_supported[RW]

Indicates if the merchant supports merchant advice code (MAC) in order to receive table 55 code for a declined recurring transaction.

number_of_installments[RW]

Number of installments for a sale transaction if the customer pays the total amount in multiple transactions.

recurring_type[RW]

The type of recurring payment.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 56
def self.attribute_map
  {
    :'number_of_installments' => :'numberOfInstallments',
    :'installments_interest' => :'installmentsInterest',
    :'installment_delay_months' => :'installmentDelayMonths',
    :'recurring_type' => :'recurringType',
    :'merchant_advice_code_supported' => :'merchantAdviceCodeSupported'
  }
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/openapi_client/models/installment_options.rb, line 213
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 79
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::InstallmentOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::InstallmentOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'number_of_installments')
    self.number_of_installments = attributes[:'number_of_installments']
  end

  if attributes.key?(:'installments_interest')
    self.installments_interest = attributes[:'installments_interest']
  end

  if attributes.key?(:'installment_delay_months')
    self.installment_delay_months = attributes[:'installment_delay_months']
  end

  if attributes.key?(:'recurring_type')
    self.recurring_type = attributes[:'recurring_type']
  end

  if attributes.key?(:'merchant_advice_code_supported')
    self.merchant_advice_code_supported = attributes[:'merchant_advice_code_supported']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/installment_options.rb, line 67
def self.openapi_types
  {
    :'number_of_installments' => :'Integer',
    :'installments_interest' => :'Boolean',
    :'installment_delay_months' => :'Integer',
    :'recurring_type' => :'String',
    :'merchant_advice_code_supported' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 188
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number_of_installments == o.number_of_installments &&
      installments_interest == o.installments_interest &&
      installment_delay_months == o.installment_delay_months &&
      recurring_type == o.recurring_type &&
      merchant_advice_code_supported == o.merchant_advice_code_supported
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/openapi_client/models/installment_options.rb, line 241
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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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/openapi_client/models/installment_options.rb, line 315
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
build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) 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/openapi_client/models/installment_options.rb, line 220
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/installment_options.rb, line 200
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 206
def hash
  [number_of_installments, installments_interest, installment_delay_months, recurring_type, merchant_advice_code_supported].hash
end
installment_delay_months=(installment_delay_months) click to toggle source

Custom attribute writer method with validation @param [Object] installment_delay_months Value to be assigned

# File lib/openapi_client/models/installment_options.rb, line 164
def installment_delay_months=(installment_delay_months)
  if !installment_delay_months.nil? && installment_delay_months > 99
    fail ArgumentError, 'invalid value for "installment_delay_months", must be smaller than or equal to 99.'
  end

  if !installment_delay_months.nil? && installment_delay_months < 1
    fail ArgumentError, 'invalid value for "installment_delay_months", must be greater than or equal to 1.'
  end

  @installment_delay_months = installment_delay_months
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/openapi_client/models/installment_options.rb, line 115
def list_invalid_properties
  invalid_properties = Array.new
  if !@number_of_installments.nil? && @number_of_installments > 99
    invalid_properties.push('invalid value for "number_of_installments", must be smaller than or equal to 99.')
  end

  if !@number_of_installments.nil? && @number_of_installments < 1
    invalid_properties.push('invalid value for "number_of_installments", must be greater than or equal to 1.')
  end

  if !@installment_delay_months.nil? && @installment_delay_months > 99
    invalid_properties.push('invalid value for "installment_delay_months", must be smaller than or equal to 99.')
  end

  if !@installment_delay_months.nil? && @installment_delay_months < 1
    invalid_properties.push('invalid value for "installment_delay_months", must be greater than or equal to 1.')
  end

  invalid_properties
end
number_of_installments=(number_of_installments) click to toggle source

Custom attribute writer method with validation @param [Object] number_of_installments Value to be assigned

# File lib/openapi_client/models/installment_options.rb, line 150
def number_of_installments=(number_of_installments)
  if !number_of_installments.nil? && number_of_installments > 99
    fail ArgumentError, 'invalid value for "number_of_installments", must be smaller than or equal to 99.'
  end

  if !number_of_installments.nil? && number_of_installments < 1
    fail ArgumentError, 'invalid value for "number_of_installments", must be greater than or equal to 1.'
  end

  @number_of_installments = number_of_installments
end
recurring_type=(recurring_type) click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 178
def recurring_type=(recurring_type)
  validator = EnumAttributeValidator.new('String', ["FIRST", "REPEAT", "STANDING_INSTRUCTION"])
  unless validator.valid?(recurring_type)
    fail ArgumentError, "invalid value for \"recurring_type\", must be one of #{validator.allowable_values}."
  end
  @recurring_type = recurring_type
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/openapi_client/models/installment_options.rb, line 291
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) click to toggle source

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

# File lib/openapi_client/models/installment_options.rb, line 297
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/openapi_client/models/installment_options.rb, line 285
def to_s
  to_hash.to_s
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/openapi_client/models/installment_options.rb, line 138
def valid?
  return false if !@number_of_installments.nil? && @number_of_installments > 99
  return false if !@number_of_installments.nil? && @number_of_installments < 1
  return false if !@installment_delay_months.nil? && @installment_delay_months > 99
  return false if !@installment_delay_months.nil? && @installment_delay_months < 1
  recurring_type_validator = EnumAttributeValidator.new('String', ["FIRST", "REPEAT", "STANDING_INSTRUCTION"])
  return false unless recurring_type_validator.valid?(@recurring_type)
  true
end