Class: CybridApiBank::PostWorkflowBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb

Overview

Request body for workflow creation.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostWorkflowBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 113

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

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

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

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

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

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

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

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

Instance Attribute Details

#android_package_name ⇒ Object

The Android package name for Plaid link. Optional when type is plaid.



41
42
43
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 41

def android_package_name
  @android_package_name
end

#customer_guid ⇒ Object

The customer identifier associated with the workflow. Optional when type is plaid and kind is link_token_create.



26
27
28
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 26

def customer_guid
  @customer_guid
end

#external_bank_account_guid ⇒ Object

The external bank account identifier associated with the workflow. Required when type is plaid and kind is link_token_update.



29
30
31
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 29

def 
  @external_bank_account_guid
end

#kind ⇒ Object

The Plaid workflow kind. Required when type is plaid.



23
24
25
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 23

def kind
  @kind
end

#language ⇒ Object

The language to initialize Plaid link. Required when type is plaid.



32
33
34
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 32

def language
  @language
end

#link_customization_name ⇒ Object

The customization name for Plaid link. Currently only supports the value "default". Required when type is plaid.



35
36
37
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 35

def link_customization_name
  @link_customization_name
end

#redirect_uri ⇒ Object

The redirect URI for Plaid link. Optional when type is plaid.



38
39
40
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 38

def redirect_uri
  @redirect_uri
end

#type ⇒ Object

The workflow type.



20
21
22
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 66

def self.attribute_map
  {
    :'type' => :'type',
    :'kind' => :'kind',
    :'customer_guid' => :'customer_guid',
    :'external_bank_account_guid' => :'external_bank_account_guid',
    :'language' => :'language',
    :'link_customization_name' => :'link_customization_name',
    :'redirect_uri' => :'redirect_uri',
    :'android_package_name' => :'android_package_name'
  }
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



318
319
320
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 318

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 99

def self.openapi_nullable
  Set.new([
    :'kind',
    :'customer_guid',
    :'external_bank_account_guid',
    :'language',
    :'link_customization_name',
    :'redirect_uri',
    :'android_package_name'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 85

def self.openapi_types
  {
    :'type' => :'String',
    :'kind' => :'String',
    :'customer_guid' => :'String',
    :'external_bank_account_guid' => :'String',
    :'language' => :'String',
    :'link_customization_name' => :'String',
    :'redirect_uri' => :'String',
    :'android_package_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      kind == o.kind &&
      customer_guid == o.customer_guid &&
       == o. &&
      language == o.language &&
      link_customization_name == o.link_customization_name &&
      redirect_uri == o.redirect_uri &&
      android_package_name == o.android_package_name
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



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
383
384
385
386
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 349

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 = CybridApiBank.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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 420

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 325

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


305
306
307
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 311

def hash
  [type, kind, customer_guid, , language, link_customization_name, redirect_uri, android_package_name].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



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
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 161

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

  if !@customer_guid.nil? && @customer_guid.to_s.length > 32
    invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
  end

  if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length > 32
    invalid_properties.push('invalid value for "external_bank_account_guid", the character length must be smaller than or equal to 32.')
  end

  if !@link_customization_name.nil? && @link_customization_name.to_s.length > 128
    invalid_properties.push('invalid value for "link_customization_name", the character length must be smaller than or equal to 128.')
  end

  if !@redirect_uri.nil? && @redirect_uri.to_s.length > 128
    invalid_properties.push('invalid value for "redirect_uri", the character length must be smaller than or equal to 128.')
  end

  if !@android_package_name.nil? && @android_package_name.to_s.length > 128
    invalid_properties.push('invalid value for "android_package_name", the character length must be smaller than or equal to 128.')
  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



396
397
398
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 396

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 402

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



390
391
392
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 390

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb', line 192

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["plaid"])
  return false unless type_validator.valid?(@type)
  kind_validator = EnumAttributeValidator.new('String', ["link_token_create", "link_token_update"])
  return false unless kind_validator.valid?(@kind)
  return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
  return false if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length > 32
  language_validator = EnumAttributeValidator.new('String', ["en", "fr", "es", "nl", "de"])
  return false unless language_validator.valid?(@language)
  return false if !@link_customization_name.nil? && @link_customization_name.to_s.length > 128
  return false if !@redirect_uri.nil? && @redirect_uri.to_s.length > 128
  return false if !@android_package_name.nil? && @android_package_name.to_s.length > 128
  true
end