Class: SyncteraRubySdk::Wire

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/wire.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Wire

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Transfer amount in cents ($100 would be 10000)



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 19

def amount
  @amount
end

#bank_message ⇒ Object

Instructions intended for the financial institutions that are processing the wire.



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 22

def bank_message
  @bank_message
end

#creation_time ⇒ Object

Returns the value of attribute creation_time.



24
25
26
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 24

def creation_time
  @creation_time
end

#currency ⇒ Object

3-character currency code



27
28
29
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 27

def currency
  @currency
end

#customer_id ⇒ Object

The customer UUID representing the person initiating the Wire transfer



30
31
32
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 30

def customer_id
  @customer_id
end

#effective_date ⇒ Object

The effective date of the transaction once it gets posted



33
34
35
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 33

def effective_date
  @effective_date
end

#id ⇒ Object

wire ID



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 36

def id
  @id
end

#last_updated_time ⇒ Object

Returns the value of attribute last_updated_time.



38
39
40
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 38

def last_updated_time
  @last_updated_time
end

#originating_account_id ⇒ Object

Sender account ID



41
42
43
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 41

def 
  @originating_account_id
end

#originating_account_number ⇒ Object

The account number representing the sender account. If the outgoing wire is a return, it refers to the sender of the initial wire not the sender of the return.



44
45
46
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 44

def 
  @originating_account_number
end

#receiving_account_id ⇒ Object

The external account uuid representing the recipient of the wire.



47
48
49
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 47

def 
  @receiving_account_id
end

#receiving_account_number ⇒ Object

The account number representing the recipient account. If the outgoing wire is a return, it refers to the recipient of the initial wire not the destination of the return.



50
51
52
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 50

def 
  @receiving_account_number
end

#recipient_message ⇒ Object

Information from the originator to the beneficiary (recipient).



53
54
55
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 53

def recipient_message
  @recipient_message
end

#return_data ⇒ Object

Returns the value of attribute return_data.



55
56
57
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 55

def return_data
  @return_data
end

#sender_reference_id ⇒ Object

Sender’s id associated with fedwire transfer



58
59
60
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 58

def sender_reference_id
  @sender_reference_id
end

#status ⇒ Object

The current status of the transfer



61
62
63
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 61

def status
  @status
end

#transaction_id ⇒ Object

ID of the resulting transaction resource



64
65
66
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 64

def transaction_id
  @transaction_id
end

#transaction_in_id ⇒ Object

The transaction uuid of the incoming wire that triggered an outgoing return. This is only used if the outgoing wire is a return.



67
68
69
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 67

def transaction_in_id
  @transaction_in_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 92

def self.attribute_map
  {
    :'amount' => :'amount',
    :'bank_message' => :'bank_message',
    :'creation_time' => :'creation_time',
    :'currency' => :'currency',
    :'customer_id' => :'customer_id',
    :'effective_date' => :'effective_date',
    :'id' => :'id',
    :'last_updated_time' => :'last_updated_time',
    :'originating_account_id' => :'originating_account_id',
    :'originating_account_number' => :'originating_account_number',
    :'receiving_account_id' => :'receiving_account_id',
    :'receiving_account_number' => :'receiving_account_number',
    :'recipient_message' => :'recipient_message',
    :'return_data' => :'return_data',
    :'sender_reference_id' => :'sender_reference_id',
    :'status' => :'status',
    :'transaction_id' => :'transaction_id',
    :'transaction_in_id' => :'transaction_in_id'
  }
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



358
359
360
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 358

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



145
146
147
148
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 145

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

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 121

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'bank_message' => :'String',
    :'creation_time' => :'Time',
    :'currency' => :'String',
    :'customer_id' => :'String',
    :'effective_date' => :'Date',
    :'id' => :'String',
    :'last_updated_time' => :'Time',
    :'originating_account_id' => :'String',
    :'originating_account_number' => :'String',
    :'receiving_account_id' => :'String',
    :'receiving_account_number' => :'String',
    :'recipient_message' => :'String',
    :'return_data' => :'ReturnData',
    :'sender_reference_id' => :'String',
    :'status' => :'String',
    :'transaction_id' => :'String',
    :'transaction_in_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      bank_message == o.bank_message &&
      creation_time == o.creation_time &&
      currency == o.currency &&
      customer_id == o.customer_id &&
      effective_date == o.effective_date &&
      id == o.id &&
      last_updated_time == o.last_updated_time &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      recipient_message == o.recipient_message &&
      return_data == o.return_data &&
      sender_reference_id == o.sender_reference_id &&
      status == o.status &&
      transaction_id == o.transaction_id &&
      transaction_in_id == o.transaction_in_id
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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 389

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 460

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 365

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


345
346
347
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 351

def hash
  [amount, bank_message, creation_time, currency, customer_id, effective_date, id, last_updated_time, , , , , recipient_message, return_data, sender_reference_id, status, transaction_id, transaction_in_id].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



240
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
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 240

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

  if @transaction_id.nil?
    invalid_properties.push('invalid value for "transaction_id", transaction_id 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



436
437
438
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 436

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



442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 442

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



430
431
432
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 430

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/synctera_ruby_sdk/models/wire.rb', line 291

def valid?
  return false if @amount.nil?
  return false if @creation_time.nil?
  return false if @currency.nil?
  return false if @effective_date.nil?
  return false if @id.nil?
  return false if @last_updated_time.nil?
  return false if @originating_account_number.nil?
  return false if @receiving_account_number.nil?
  return false if @sender_reference_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["PENDING", "COMPLETED", "CANCELED", "DECLINED"])
  return false unless status_validator.valid?(@status)
  return false if @transaction_id.nil?
  true
end