Class: OpenapiClient::SenderInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/sender_info.rb

Overview

Sender information for a disbursement transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SenderInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/openapi_client/models/sender_info.rb', line 82

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Sender account number.



46
47
48
 
# File 'lib/openapi_client/models/sender_info.rb', line 46

def 
  @account_number
end

#birth_date ⇒ Object

Sender date of birth (YYYYMMDD).



40
41
42
 
# File 'lib/openapi_client/models/sender_info.rb', line 40

def birth_date
  @birth_date
end

#city ⇒ Object

Sender city.



25
26
27
 
# File 'lib/openapi_client/models/sender_info.rb', line 25

def city
  @city
end

#country_code ⇒ Object

Sender country code.



31
32
33
 
# File 'lib/openapi_client/models/sender_info.rb', line 31

def country_code
  @country_code
end

#name ⇒ Object

Sender name.



19
20
21
 
# File 'lib/openapi_client/models/sender_info.rb', line 19

def name
  @name
end

#phone_number ⇒ Object

Sender phone number.



37
38
39
 
# File 'lib/openapi_client/models/sender_info.rb', line 37

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Sender postal code.



34
35
36
 
# File 'lib/openapi_client/models/sender_info.rb', line 34

def postal_code
  @postal_code
end

#reference_number ⇒ Object

Sender reference number.



43
44
45
 
# File 'lib/openapi_client/models/sender_info.rb', line 43

def reference_number
  @reference_number
end

#state_code ⇒ Object

Sender state.



28
29
30
 
# File 'lib/openapi_client/models/sender_info.rb', line 28

def state_code
  @state_code
end

#street_address ⇒ Object

Sender street address.



22
23
24
 
# File 'lib/openapi_client/models/sender_info.rb', line 22

def street_address
  @street_address
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_client/models/sender_info.rb', line 49

def self.attribute_map
  {
    :'name' => :'name',
    :'street_address' => :'streetAddress',
    :'city' => :'city',
    :'state_code' => :'stateCode',
    :'country_code' => :'countryCode',
    :'postal_code' => :'postalCode',
    :'phone_number' => :'phoneNumber',
    :'birth_date' => :'birthDate',
    :'reference_number' => :'referenceNumber',
    :'account_number' => :'accountNumber'
  }
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



477
478
479
 
# File 'lib/openapi_client/models/sender_info.rb', line 477

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/openapi_client/models/sender_info.rb', line 65

def self.openapi_types
  {
    :'name' => :'String',
    :'street_address' => :'String',
    :'city' => :'String',
    :'state_code' => :'String',
    :'country_code' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'birth_date' => :'String',
    :'reference_number' => :'String',
    :'account_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/openapi_client/models/sender_info.rb', line 447

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      street_address == o.street_address &&
      city == o.city &&
      state_code == o.state_code &&
      country_code == o.country_code &&
      postal_code == o.postal_code &&
      phone_number == o.phone_number &&
      birth_date == o.birth_date &&
      reference_number == o.reference_number &&
       == o.
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



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/openapi_client/models/sender_info.rb', line 505

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
    OpenapiClient.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



570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/openapi_client/models/sender_info.rb', line 570

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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/openapi_client/models/sender_info.rb', line 484

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


464
465
466
 
# File 'lib/openapi_client/models/sender_info.rb', line 464

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



470
471
472
 
# File 'lib/openapi_client/models/sender_info.rb', line 470

def hash
  [name, street_address, city, state_code, country_code, postal_code, phone_number, birth_date, reference_number, ].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



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
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
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/openapi_client/models/sender_info.rb', line 138

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

  if @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

  if @street_address.to_s.length > 250
    invalid_properties.push('invalid value for "street_address", the character length must be smaller than or equal to 250.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @street_address !~ pattern
    invalid_properties.push("invalid value for \"street_address\", must conform to the pattern #{pattern}.")
  end

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

  if @city.to_s.length > 50
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 50.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @city !~ pattern
    invalid_properties.push("invalid value for \"city\", must conform to the pattern #{pattern}.")
  end

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

  if @state_code.to_s.length > 50
    invalid_properties.push('invalid value for "state_code", the character length must be smaller than or equal to 50.')
  end

  pattern = Regexp.new(/[A-Z]{2}/)
  if @state_code !~ pattern
    invalid_properties.push("invalid value for \"state_code\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/[A-Z]{2}/)
  if @country_code !~ pattern
    invalid_properties.push("invalid value for \"country_code\", must conform to the pattern #{pattern}.")
  end

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

  if @postal_code.to_s.length > 10
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 10.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @postal_code !~ pattern
    invalid_properties.push("invalid value for \"postal_code\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/[0-9]{10}/)
  if @phone_number !~ pattern
    invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$/)
  if !@birth_date.nil? && @birth_date !~ pattern
    invalid_properties.push("invalid value for \"birth_date\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @reference_number !~ pattern
    invalid_properties.push("invalid value for \"reference_number\", must conform to the pattern #{pattern}.")
  end

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

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



550
551
552
 
# File 'lib/openapi_client/models/sender_info.rb', line 550

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



556
557
558
559
560
561
562
563
564
 
# File 'lib/openapi_client/models/sender_info.rb', line 556

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



544
545
546
 
# File 'lib/openapi_client/models/sender_info.rb', line 544

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



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
 
# File 'lib/openapi_client/models/sender_info.rb', line 251

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @name !~ Regexp.new(/^(?!\s*$).+/)
  return false if @street_address.nil?
  return false if @street_address.to_s.length > 250
  return false if @street_address !~ Regexp.new(/^(?!\s*$).+/)
  return false if @city.nil?
  return false if @city.to_s.length > 50
  return false if @city !~ Regexp.new(/^(?!\s*$).+/)
  return false if @state_code.nil?
  return false if @state_code.to_s.length > 50
  return false if @state_code !~ Regexp.new(/[A-Z]{2}/)
  return false if @country_code.nil?
  return false if @country_code !~ Regexp.new(/[A-Z]{2}/)
  return false if @postal_code.nil?
  return false if @postal_code.to_s.length > 10
  return false if @postal_code !~ Regexp.new(/^(?!\s*$).+/)
  return false if @phone_number.nil?
  return false if @phone_number !~ Regexp.new(/[0-9]{10}/)
  return false if !@birth_date.nil? && @birth_date !~ Regexp.new(/^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$/)
  return false if @reference_number.nil?
  return false if @reference_number !~ Regexp.new(/^(?!\s*$).+/)
  return false if @account_number.nil?
  return false if @account_number !~ Regexp.new(/^(?!\s*$).+/)
  true
end