Class: CybridApiBank::PostCustomerBankModel

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

Overview

Request body for customer creation.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostCustomerBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 123

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



22
23
24
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 22

def address
  @address
end

#aliases ⇒ Object

The aliases of the customer. Optional when type is business.



39
40
41
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 39

def aliases
  @aliases
end

#date_of_birth ⇒ Object

The customer’s date of birth. Optional when type is individual.



36
37
38
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 36

def date_of_birth
  @date_of_birth
end

#email_address ⇒ Object

The customer’s email address.



28
29
30
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 28

def email_address
  @email_address
end

#identification_numbers ⇒ Object

The customer’s identification numbers.



31
32
33
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 31

def identification_numbers
  @identification_numbers
end

#labels ⇒ Object

The labels associated with the customer.



45
46
47
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 45

def labels
  @labels
end

#name ⇒ Object

Returns the value of attribute name.



33
34
35
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 33

def name
  @name
end

#phone_number ⇒ Object

The customer’s phone number.



25
26
27
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 25

def phone_number
  @phone_number
end

#type ⇒ Object

The type of customer.



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

def type
  @type
end

#website ⇒ Object

The customer’s website. Optional when type is business.



42
43
44
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 42

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 70

def self.attribute_map
  {
    :'type' => :'type',
    :'address' => :'address',
    :'phone_number' => :'phone_number',
    :'email_address' => :'email_address',
    :'identification_numbers' => :'identification_numbers',
    :'name' => :'name',
    :'date_of_birth' => :'date_of_birth',
    :'aliases' => :'aliases',
    :'website' => :'website',
    :'labels' => :'labels'
  }
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



308
309
310
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 308

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 107

def self.openapi_nullable
  Set.new([
    :'address',
    :'phone_number',
    :'email_address',
    :'identification_numbers',
    :'name',
    :'date_of_birth',
    :'aliases',
    :'website',
    :'labels'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 91

def self.openapi_types
  {
    :'type' => :'String',
    :'address' => :'PostCustomerAddressBankModel',
    :'phone_number' => :'String',
    :'email_address' => :'String',
    :'identification_numbers' => :'Array<PostIdentificationNumberBankModel>',
    :'name' => :'PostCustomerNameBankModel',
    :'date_of_birth' => :'Date',
    :'aliases' => :'Array<PostCustomerAliasesInnerBankModel>',
    :'website' => :'String',
    :'labels' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      address == o.address &&
      phone_number == o.phone_number &&
      email_address == o.email_address &&
      identification_numbers == o.identification_numbers &&
      name == o.name &&
      date_of_birth == o.date_of_birth &&
      aliases == o.aliases &&
      website == o.website &&
      labels == o.labels
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



339
340
341
342
343
344
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
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 339

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 410

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 315

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


295
296
297
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 301

def hash
  [type, address, phone_number, email_address, identification_numbers, name, date_of_birth, aliases, website, labels].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



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

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

  if !@identification_numbers.nil? && @identification_numbers.length > 10
    invalid_properties.push('invalid value for "identification_numbers", number of items must be less than or equal to 10.')
  end

  if !@identification_numbers.nil? && @identification_numbers.length < 1
    invalid_properties.push('invalid value for "identification_numbers", number of items must be greater than or equal to 1.')
  end

  if !@aliases.nil? && @aliases.length > 1
    invalid_properties.push('invalid value for "aliases", number of items must be less than or equal to 1.')
  end

  if !@aliases.nil? && @aliases.length < 0
    invalid_properties.push('invalid value for "aliases", number of items must be greater than or equal to 0.')
  end

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



386
387
388
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 392

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



380
381
382
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 380

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



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb', line 216

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["business", "individual"])
  return false unless type_validator.valid?(@type)
  return false if !@identification_numbers.nil? && @identification_numbers.length > 10
  return false if !@identification_numbers.nil? && @identification_numbers.length < 1
  return false if !@aliases.nil? && @aliases.length > 1
  return false if !@aliases.nil? && @aliases.length < 0
  return false if !@labels.nil? && @labels.length > 8
  true
end