Class: OpenapiClient::StandInDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/stand_in_details.rb

Overview

Indicates standin transaction.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StandInDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# 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

Instance Attribute Details

#frequency ⇒ Object

Indicates frequency of the standin instruction debit.



34
35
36
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 34

def frequency
  @frequency
end

#maximum_transaction_amount ⇒ Object

Maximum debit amount per standin instruction transaction.



28
29
30
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 28

def maximum_transaction_amount
  @maximum_transaction_amount
end

#number_of_debits ⇒ Object

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



22
23
24
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 22

def number_of_debits
  @number_of_debits
end

#si_hub_id ⇒ Object

Unique identifier for standin instruction.



31
32
33
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 31

def si_hub_id
  @si_hub_id
end

#si_validated ⇒ Object

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



25
26
27
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 25

def si_validated
  @si_validated
end

#stand_in_type ⇒ Object

Indicates standin instruction type.



19
20
21
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 19

def stand_in_type
  @stand_in_type
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



257
258
259
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 257

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



335
336
337
 
# 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([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



329
330
331
 
# File 'lib/openapi_client/models/stand_in_details.rb', line 329

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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