class OpenapiClient::StandInDetails

Indicates standin transaction.

Attributes

frequency[RW]

Indicates frequency of the standin instruction debit.

maximum_transaction_amount[RW]

Maximum debit amount per standin instruction transaction.

number_of_debits[RW]

Indicates number of standin instruction debits.Possible values can be two digit number or UN (Until it is cancelled) or ND (Not defined).

si_hub_id[RW]

Unique identifier for standin instruction.

si_validated[RW]

Indicates standin instruction validation flag, it can be true or false. "false" - Not validated, "true" - Validated.

stand_in_type[RW]

Indicates standin instruction type.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 59
def self.attribute_map
  {
    :'stand_in_type' => :'standInType',
    :'number_of_debits' => :'numberOfDebits',
    :'si_validated' => :'siValidated',
    :'maximum_transaction_amount' => :'maximumTransactionAmount',
    :'si_hub_id' => :'siHubId',
    :'frequency' => :'frequency'
  }
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/stand_in_details.rb, line 257
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/stand_in_details.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::StandInDetails` 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::StandInDetails`. 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?(:'stand_in_type')
    self.stand_in_type = attributes[:'stand_in_type']
  end

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

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

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

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

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

Attribute type mapping.

# File lib/openapi_client/models/stand_in_details.rb, line 71
def self.openapi_types
  {
    :'stand_in_type' => :'String',
    :'number_of_debits' => :'String',
    :'si_validated' => :'Boolean',
    :'maximum_transaction_amount' => :'Float',
    :'si_hub_id' => :'String',
    :'frequency' => :'String'
  }
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/stand_in_details.rb, line 231
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      stand_in_type == o.stand_in_type &&
      number_of_debits == o.number_of_debits &&
      si_validated == o.si_validated &&
      maximum_transaction_amount == o.maximum_transaction_amount &&
      si_hub_id == o.si_hub_id &&
      frequency == o.frequency
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/stand_in_details.rb, line 285
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/stand_in_details.rb, line 359
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/stand_in_details.rb, line 264
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/stand_in_details.rb, line 244
def eql?(o)
  self == o
end
frequency=(frequency) click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 221
def frequency=(frequency)
  validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHTLY", "MONTHLY", "QUARTERLY", "HALFYEARLY", "YEARLY", "UNSCHEDULED"])
  unless validator.valid?(frequency)
    fail ArgumentError, "invalid value for \"frequency\", must be one of #{validator.allowable_values}."
  end
  @frequency = frequency
end
hash() click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 250
def hash
  [stand_in_type, number_of_debits, si_validated, maximum_transaction_amount, si_hub_id, frequency].hash
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/stand_in_details.rb, line 124
def list_invalid_properties
  invalid_properties = Array.new
  if @stand_in_type.nil?
    invalid_properties.push('invalid value for "stand_in_type", stand_in_type cannot be nil.')
  end

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

  pattern = Regexp.new(/(UN)|(ND)|([0-9]{2})/)
  if @number_of_debits !~ pattern
    invalid_properties.push("invalid value for \"number_of_debits\", must conform to the pattern #{pattern}.")
  end

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

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

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

  if @si_hub_id.to_s.length > 10
    invalid_properties.push('invalid value for "si_hub_id", the character length must be smaller than or equal to 10.')
  end

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

  invalid_properties
end
number_of_debits=(number_of_debits) click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 192
def number_of_debits=(number_of_debits)
  if number_of_debits.nil?
    fail ArgumentError, 'number_of_debits cannot be nil'
  end

  pattern = Regexp.new(/(UN)|(ND)|([0-9]{2})/)
  if number_of_debits !~ pattern
    fail ArgumentError, "invalid value for \"number_of_debits\", must conform to the pattern #{pattern}."
  end

  @number_of_debits = number_of_debits
end
si_hub_id=(si_hub_id) click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 207
def si_hub_id=(si_hub_id)
  if si_hub_id.nil?
    fail ArgumentError, 'si_hub_id cannot be nil'
  end

  if si_hub_id.to_s.length > 10
    fail ArgumentError, 'invalid value for "si_hub_id", the character length must be smaller than or equal to 10.'
  end

  @si_hub_id = si_hub_id
end
stand_in_type=(stand_in_type) click to toggle source

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

# File lib/openapi_client/models/stand_in_details.rb, line 182
def stand_in_type=(stand_in_type)
  validator = EnumAttributeValidator.new('String', ["FIXED_AMOUNT", "MAXIMUM_AMOUNT"])
  unless validator.valid?(stand_in_type)
    fail ArgumentError, "invalid value for \"stand_in_type\", must be one of #{validator.allowable_values}."
  end
  @stand_in_type = stand_in_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/stand_in_details.rb, line 335
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/stand_in_details.rb, line 341
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/stand_in_details.rb, line 329
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/stand_in_details.rb, line 164
def valid?
  return false if @stand_in_type.nil?
  stand_in_type_validator = EnumAttributeValidator.new('String', ["FIXED_AMOUNT", "MAXIMUM_AMOUNT"])
  return false unless stand_in_type_validator.valid?(@stand_in_type)
  return false if @number_of_debits.nil?
  return false if @number_of_debits !~ Regexp.new(/(UN)|(ND)|([0-9]{2})/)
  return false if @si_validated.nil?
  return false if @maximum_transaction_amount.nil?
  return false if @si_hub_id.nil?
  return false if @si_hub_id.to_s.length > 10
  return false if @frequency.nil?
  frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "FORTNIGHTLY", "MONTHLY", "QUARTERLY", "HALFYEARLY", "YEARLY", "UNSCHEDULED"])
  return false unless frequency_validator.valid?(@frequency)
  true
end