Class: SyncteraRubySdk::InternalTransfer

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InternalTransfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount (in cents) to transfer from originating account to receiving account.



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

def amount
  @amount
end

#capture_mode ⇒ Object

Controls when the transfer will take effect. A value of ‘IMMEDIATE` (the default) means that the transfer will be completed immediately. A value of `MANUAL` means that the transaction will remain in a "pending" state until explicitly completed or cancelled (or the auth expires).



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

def capture_mode
  @capture_mode
end

#currency ⇒ Object

ISO 4217 alphabetic currency code of the transfer amount



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 25

def currency
  @currency
end

#expires_at ⇒ Object

When ‘capture_mode` is `MANUAL`, this field describes when the pending transaction should expire.



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 28

def expires_at
  @expires_at
end

#final_customer_id ⇒ Object

The customer id of the international customer that receives the final remittance transfer (required for remittance payments).



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 31

def final_customer_id
  @final_customer_id
end

#memo ⇒ Object

A short note to the recipient



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 34

def memo
  @memo
end

#metadata ⇒ Object

Arbitrary key-value metadata to associate with the transaction



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 37

def metadata
  @metadata
end

#originating_account_alias ⇒ Object

An alias representing a GL account to debit. This is alternative to specifying by account id



40
41
42
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 40

def 
  @originating_account_alias
end

#originating_account_customer_id ⇒ Object

The customer id of the owner of the originating account.



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 43

def 
  @originating_account_customer_id
end

#originating_account_id ⇒ Object

The UUID of the account being debited



46
47
48
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 46

def 
  @originating_account_id
end

#receiving_account_alias ⇒ Object

An alias representing a GL account to credit. This is an alternative to specifying by account id



49
50
51
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 49

def 
  @receiving_account_alias
end

#receiving_account_customer_id ⇒ Object

The customer id of the owner of the receiving account.



52
53
54
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 52

def 
  @receiving_account_customer_id
end

#receiving_account_id ⇒ Object

The UUID of the account being credited



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

def 
  @receiving_account_id
end

#type ⇒ Object

The desired transaction type to use for this transfer



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 83

def self.attribute_map
  {
    :'amount' => :'amount',
    :'capture_mode' => :'capture_mode',
    :'currency' => :'currency',
    :'expires_at' => :'expires_at',
    :'final_customer_id' => :'final_customer_id',
    :'memo' => :'memo',
    :'metadata' => :'metadata',
    :'originating_account_alias' => :'originating_account_alias',
    :'originating_account_customer_id' => :'originating_account_customer_id',
    :'originating_account_id' => :'originating_account_id',
    :'receiving_account_alias' => :'receiving_account_alias',
    :'receiving_account_customer_id' => :'receiving_account_customer_id',
    :'receiving_account_id' => :'receiving_account_id',
    :'type' => :'type'
  }
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



314
315
316
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 314

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 108

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'capture_mode' => :'String',
    :'currency' => :'String',
    :'expires_at' => :'Time',
    :'final_customer_id' => :'String',
    :'memo' => :'String',
    :'metadata' => :'Object',
    :'originating_account_alias' => :'String',
    :'originating_account_customer_id' => :'String',
    :'originating_account_id' => :'String',
    :'receiving_account_alias' => :'String',
    :'receiving_account_customer_id' => :'String',
    :'receiving_account_id' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      capture_mode == o.capture_mode &&
      currency == o.currency &&
      expires_at == o.expires_at &&
      final_customer_id == o.final_customer_id &&
      memo == o.memo &&
      metadata == o.metadata &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      type == o.type
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 345

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 416

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



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

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


301
302
303
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 307

def hash
  [amount, capture_mode, currency, expires_at, final_customer_id, memo, metadata, , , , , , , type].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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  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 @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

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



392
393
394
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 392

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 398

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



386
387
388
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 386

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



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/synctera_ruby_sdk/models/internal_transfer.rb', line 232

def valid?
  return false if @amount.nil?
  return false if @amount < 1
  capture_mode_validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "MANUAL"])
  return false unless capture_mode_validator.valid?(@capture_mode)
  return false if @currency.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["ACCOUNT_TO_ACCOUNT", "ACCOUNT_TO_ACCOUNT_SWEEP", "ACH_CREDIT_SWEEP", "ACH_DEBIT_SWEEP", "ACH_FLOAT_TRANSFER", "ACH_INCOMING_CREDIT_SWEEP", "ACH_INCOMING_DEBIT_SWEEP", "ACH_INCOMING_RETURN_CREDIT_SWEEP", "ACH_INCOMING_RETURN_DEBIT_SWEEP", "ACH_OUTGOING_CREDIT_SWEEP", "ACH_OUTGOING_DEBIT_SWEEP", "ACH_OUTGOING_RETURN_CREDIT_SWEEP", "ACH_OUTGOING_RETURN_DEBIT_SWEEP", "ACH_SWEEP", "CARD_CHARGEBACK", "CARD_CHARGEBACK_WRITEOFF", "CARD_PROVISIONAL_CREDIT", "CASHBACK", "CASHBACK_SWEEP", "CREDIT_MEMO", "DOMESTIC_WIRE_INCOMING_SWEEP", "DOMESTIC_WIRE_INCOMING_SWEEP_REVERSAL", "DOMESTIC_WIRE_INCOMING_RETURN_SWEEP", "DOMESTIC_WIRE_INCOMING_RETURN_SWEEP_REVERSAL", "DOMESTIC_WIRE_OUTGOING_SWEEP", "DOMESTIC_WIRE_OUTGOING_SWEEP_REVERSAL", "DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP", "DOMESTIC_WIRE_OUTGOING_RETURN_SWEEP_REVERSAL", "FEE", "FEE_SWEEP", "FORCE_PAYMENT", "INCOMING_WIRE", "INCOMING_WIRE_SWEEP", "INTEREST_CHARGED_SWEEP", "INTEREST_PAYOUT", "INTEREST_PAYOUT_SWEEP", "INTERNATIONAL_WIRE_OUTGOING_SWEEP", "INTERNATIONAL_WIRE_OUTGOING_SWEEP_REVERSAL", "INVOICE", "LOAN_DISBURSEMENT", "LOAN_FUNDING", "MANUAL_ADJUSTMENT", "MANUAL_ADJUSTMENT_REVERSAL", "MANUAL_ADJUSTMENT_SWEEP", "MANUAL_CARD_SWEEP", "MANUAL_CHECK_SWEEP", "MANUAL_WIRE_SWEEP", "MASTERCARD_GROSS_SWEEP", "MASTERCARD_GROSS_SWEEP_REVERSAL", "MASTERCARD_INTERCHANGE_SWEEP", "MASTERCARD_INTERCHANGE_SWEEP_REVERSAL", "MASTERCARD_NET_SWEEP", "MASTERCARD_NET_SWEEP_REVERSAL", "MOBILE_DEPOSIT_SWEEP", "MOBILE_DEPOSIT_SWEEP_REVERSAL", "MOBILE_DEPOSIT_RETURN_SWEEP", "MOBILE_DEPOSIT_RETURN_SWEEP_REVERSAL", "NETWORK_ADJUSTMENT_SWEEP", "NETWORK_CHARGEBACK_SWEEP", "OUTGOING_INTERNATIONAL_REMITTANCE", "OUTGOING_INTERNATIONAL_REMITTANCE_REVERSAL", "PROMOTIONAL_CREDIT", "PROMOTIONAL_CREDIT_REVERSAL", "PROMOTIONAL_CREDIT_SWEEP", "PULSE_GROSS_SWEEP", "PULSE_GROSS_SWEEP_REVERSAL", "PULSE_INTERCHANGE_SWEEP", "PULSE_INTERCHANGE_SWEEP_REVERSAL", "SIGN_UP_BONUS", "SUBSCRIPTION_FEE", "SECURITY_ACCOUNT_PAYMENT", "TRANSFER_FEE", "TRANSFER_FEE_REVERSAL", "WIRE_SETTLEMENT_CREDIT", "WIRE_SETTLEMENT_DEBIT"])
  return false unless type_validator.valid?(@type)
  true
end