Class: UnitOpenapiRubySdk::ReceivedPaymentAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReceivedPaymentAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UnitOpenapiRubySdk::ReceivedPaymentAttributes` 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 `UnitOpenapiRubySdk::ReceivedPaymentAttributes`. 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?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

  if attributes.key?(:'completion_date')
    self.completion_date = attributes[:'completion_date']
  else
    self.completion_date = nil
  end

  if attributes.key?(:'direction')
    self.direction = attributes[:'direction']
  else
    self.direction = nil
  end

  if attributes.key?(:'was_advanced')
    self.was_advanced = attributes[:'was_advanced']
  else
    self.was_advanced = nil
  end

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

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

  if attributes.key?(:'company_name')
    self.company_name = attributes[:'company_name']
  else
    self.company_name = nil
  end

  if attributes.key?(:'counterparty_routing_number')
    self.counterparty_routing_number = attributes[:'counterparty_routing_number']
  else
    self.counterparty_routing_number = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = nil
  end

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

  if attributes.key?(:'trace_number')
    self.trace_number = attributes[:'trace_number']
  else
    self.trace_number = nil
  end

  if attributes.key?(:'sec_code')
    self.sec_code = attributes[:'sec_code']
  else
    self.sec_code = nil
  end

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Hash)
      self.tags = value
    end
  end
end

Instance Attribute Details

#addenda ⇒ Object

Returns the value of attribute addenda.



40
41
42
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 40

def addenda
  @addenda
end

#amount ⇒ Object

Returns the value of attribute amount.



22
23
24
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 22

def amount
  @amount
end

#company_name ⇒ Object

Returns the value of attribute company_name.



34
35
36
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 34

def company_name
  @company_name
end

#completion_date ⇒ Object

Returns the value of attribute completion_date.



24
25
26
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 24

def completion_date
  @completion_date
end

#counterparty_routing_number ⇒ Object

Returns the value of attribute counterparty_routing_number.



36
37
38
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 36

def counterparty_routing_number
  @counterparty_routing_number
end

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 18

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



38
39
40
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 38

def description
  @description
end

#direction ⇒ Object

Returns the value of attribute direction.



26
27
28
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 26

def direction
  @direction
end

#is_advaceable ⇒ Object

Returns the value of attribute is_advaceable.



32
33
34
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 32

def is_advaceable
  @is_advaceable
end

#is_advanceable ⇒ Object

Returns the value of attribute is_advanceable.



30
31
32
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 30

def is_advanceable
  @is_advanceable
end

#receiving_entity_name ⇒ Object

Returns the value of attribute receiving_entity_name.



48
49
50
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 48

def receiving_entity_name
  @receiving_entity_name
end

#return_reason ⇒ Object

Returns the value of attribute return_reason.



46
47
48
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 46

def return_reason
  @return_reason
end

#sec_code ⇒ Object

Returns the value of attribute sec_code.



44
45
46
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 44

def sec_code
  @sec_code
end

#status ⇒ Object

Returns the value of attribute status.



20
21
22
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 20

def status
  @status
end

#tags ⇒ Object

Returns the value of attribute tags.



50
51
52
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 50

def tags
  @tags
end

#trace_number ⇒ Object

Returns the value of attribute trace_number.



42
43
44
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 42

def trace_number
  @trace_number
end

#was_advanced ⇒ Object

Returns the value of attribute was_advanced.



28
29
30
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 28

def was_advanced
  @was_advanced
end

Class Method Details

._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



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 462

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UnitOpenapiRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 75

def self.attribute_map
  {
    :'created_at' => :'createdAt',
    :'status' => :'status',
    :'amount' => :'amount',
    :'completion_date' => :'completionDate',
    :'direction' => :'direction',
    :'was_advanced' => :'wasAdvanced',
    :'is_advanceable' => :'isAdvanceable',
    :'is_advaceable' => :'isAdvaceable',
    :'company_name' => :'companyName',
    :'counterparty_routing_number' => :'counterpartyRoutingNumber',
    :'description' => :'description',
    :'addenda' => :'addenda',
    :'trace_number' => :'traceNumber',
    :'sec_code' => :'secCode',
    :'return_reason' => :'returnReason',
    :'receiving_entity_name' => :'receivingEntityName',
    :'tags' => :'tags'
  }
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



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 438

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 126

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 103

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'status' => :'String',
    :'amount' => :'Integer',
    :'completion_date' => :'String',
    :'direction' => :'String',
    :'was_advanced' => :'Boolean',
    :'is_advanceable' => :'Boolean',
    :'is_advaceable' => :'Boolean',
    :'company_name' => :'String',
    :'counterparty_routing_number' => :'String',
    :'description' => :'String',
    :'addenda' => :'String',
    :'trace_number' => :'String',
    :'sec_code' => :'String',
    :'return_reason' => :'String',
    :'receiving_entity_name' => :'String',
    :'tags' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 401

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      status == o.status &&
      amount == o.amount &&
      completion_date == o.completion_date &&
      direction == o.direction &&
      was_advanced == o.was_advanced &&
      is_advanceable == o.is_advanceable &&
      is_advaceable == o.is_advaceable &&
      company_name == o.company_name &&
      counterparty_routing_number == o.counterparty_routing_number &&
      description == o.description &&
      addenda == o.addenda &&
      trace_number == o.trace_number &&
      sec_code == o.sec_code &&
      return_reason == o.return_reason &&
      receiving_entity_name == o.receiving_entity_name &&
      tags == o.tags
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



533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 533

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


425
426
427
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 425

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



431
432
433
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 431

def hash
  [created_at, status, amount, completion_date, direction, was_advanced, is_advanceable, is_advaceable, company_name, counterparty_routing_number, description, addenda, trace_number, sec_code, return_reason, receiving_entity_name, tags].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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 241

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

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

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

  if @amount < 1
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.')
  end

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

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

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

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

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

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

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

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

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

  if @sec_code.to_s.length < 3
    invalid_properties.push('invalid value for "sec_code", the character length must be great than or equal to 3.')
  end

  if !@tags.nil? && @tags.length > 15
    invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 15.')
  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



509
510
511
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 509

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 515

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



503
504
505
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 503

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/unit_openapi_ruby_sdk/models/received_payment_attributes.rb', line 309

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["Pending", "Advanced", "PendingReview", "MarkedForReturn", "Returned", "Completed"])
  return false unless status_validator.valid?(@status)
  return false if @amount.nil?
  return false if @amount < 1
  return false if @completion_date.nil?
  return false if @direction.nil?
  direction_validator = EnumAttributeValidator.new('String', ["Debit", "Credit"])
  return false unless direction_validator.valid?(@direction)
  return false if @was_advanced.nil?
  return false if @company_name.nil?
  return false if @counterparty_routing_number.nil?
  return false if @description.nil?
  return false if @trace_number.nil?
  return false if @sec_code.nil?
  return false if @sec_code.to_s.length > 3
  return false if @sec_code.to_s.length < 3
  return false if !@tags.nil? && @tags.length > 15
  true
end