Class: Yapstone::PayoutInstrumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-so/models/payout_instrument_request.rb

Overview

The Payout Instrument such as Bank Account is used when sending money to an Asset Owner.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutInstrumentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 93

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

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

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

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

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

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

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

Instance Attribute Details

#bank_account ⇒ Object

Returns the value of attribute bank_account.



21
22
23
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 21

def 
  @bank_account
end

#consents ⇒ Object

list of consent requests



31
32
33
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 31

def consents
  @consents
end

#external_id ⇒ Object

The partners externalId id for the Payout Instrument.



19
20
21
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 19

def external_id
  @external_id
end

#owner ⇒ Object

Returns the value of attribute owner.



28
29
30
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 28

def owner
  @owner
end

#payment_card ⇒ Object

Returns the value of attribute payment_card.



23
24
25
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 23

def payment_card
  @payment_card
end

#products ⇒ Object

Products requested by marketplace.



34
35
36
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 34

def products
  @products
end

#type ⇒ Object

The type of finanancial instrument [BANK_ACCOUNT]



26
27
28
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 26

def type
  @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
69
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 59

def self.attribute_map
  {
    :'external_id' => :'externalId',
    :'bank_account' => :'bankAccount',
    :'payment_card' => :'paymentCard',
    :'type' => :'type',
    :'owner' => :'owner',
    :'consents' => :'consents',
    :'products' => :'products'
  }
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



233
234
235
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 233

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



85
86
87
88
89
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 85

def self.openapi_all_of
  [
  :'PayoutInstrumentResourceCommonEntities'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 72

def self.openapi_types
  {
    :'external_id' => :'String',
    :'bank_account' => :'BankAccountResource',
    :'payment_card' => :'CardDataResource',
    :'type' => :'String',
    :'owner' => :'OwnerResource',
    :'consents' => :'Array<Consent>',
    :'products' => :'Array<Product>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
       == o. &&
      payment_card == o.payment_card &&
      type == o.type &&
      owner == o.owner &&
      consents == o.consents &&
      products == o.products
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



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
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 261

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
    Yapstone.const_get(type).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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 326

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.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[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 # 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


220
221
222
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 226

def hash
  [external_id, , payment_card, type, owner, consents, products].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 255
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 255.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  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



306
307
308
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 312

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



300
301
302
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 300

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



165
166
167
168
169
170
171
172
173
 
# File 'lib/yapstone-so/models/payout_instrument_request.rb', line 165

def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 255
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@external_id.nil? && @external_id !~ Regexp.new(/.*[^\s].*/)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["BANK_ACCOUNT", "CARD", "CHECK"])
  return false unless type_validator.valid?(@type)
  true
end