Class: CityPayApiClient::ContactDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/contact_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContactDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

The first line of the address for the card holder.



18
19
20
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 18

def address1
  @address1
end

#address2 ⇒ Object

The second line of the address for the card holder.



21
22
23
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 21

def address2
  @address2
end

#address3 ⇒ Object

The third line of the address for the card holder.



24
25
26
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 24

def address3
  @address3
end

#area ⇒ Object

The area such as city, department, parish for the card holder.



27
28
29
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 27

def area
  @area
end

#company ⇒ Object

The company name for the card holder if the contact is a corporate contact.



30
31
32
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 30

def company
  @company
end

#country ⇒ Object

The country code in ISO 3166 format. The country value may be used for fraud analysis and for acceptance of the transaction.



33
34
35
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 33

def country
  @country
end

#email ⇒ Object

An email address for the card holder which may be used for correspondence.



36
37
38
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 36

def email
  @email
end

#firstname ⇒ Object

The first name of the card holder.



39
40
41
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 39

def firstname
  @firstname
end

#lastname ⇒ Object

The last name or surname of the card holder.



42
43
44
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 42

def lastname
  @lastname
end

#mobile_no ⇒ Object

A mobile number for the card holder the mobile number is often required by delivery companies to ensure they are able to be in contact when required.



45
46
47
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 45

def mobile_no
  @mobile_no
end

#postcode ⇒ Object

The postcode or zip code of the address which may be used for fraud analysis.



48
49
50
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 48

def postcode
  @postcode
end

#telephone_no ⇒ Object

A telephone number for the card holder.



51
52
53
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 51

def telephone_no
  @telephone_no
end

#title ⇒ Object

A title for the card holder such as Mr, Mrs, Ms, M. Mme. etc.



54
55
56
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 54

def title
  @title
end

Class Method Details

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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 446

def self._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 = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 57

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'area' => :'area',
    :'company' => :'company',
    :'country' => :'country',
    :'email' => :'email',
    :'firstname' => :'firstname',
    :'lastname' => :'lastname',
    :'mobile_no' => :'mobile_no',
    :'postcode' => :'postcode',
    :'telephone_no' => :'telephone_no',
    :'title' => :'title'
  }
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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 422

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 81

def self.openapi_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'address3' => :'String',
    :'area' => :'String',
    :'company' => :'String',
    :'country' => :'String',
    :'email' => :'String',
    :'firstname' => :'String',
    :'lastname' => :'String',
    :'mobile_no' => :'String',
    :'postcode' => :'String',
    :'telephone_no' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 389

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      address3 == o.address3 &&
      area == o.area &&
      company == o.company &&
      country == o.country &&
      email == o.email &&
      firstname == o.firstname &&
      lastname == o.lastname &&
      mobile_no == o.mobile_no &&
      postcode == o.postcode &&
      telephone_no == o.telephone_no &&
      title == o.title
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



517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 517

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


409
410
411
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



415
416
417
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 415

def hash
  [address1, address2, address3, area, company, country, email, firstname, lastname, mobile_no, postcode, telephone_no, title].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



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
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 175

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@address1.nil? && @address1.to_s.length > 50
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 50.')
  end

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

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

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

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

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

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

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

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

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

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



493
494
495
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 493

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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 499

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



487
488
489
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 487

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/citypay_api_client/models/contact_details.rb', line 227

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@address1.nil? && @address1.to_s.length > 50
  return false if !@address2.nil? && @address2.to_s.length > 50
  return false if !@address3.nil? && @address3.to_s.length > 50
  return false if !@area.nil? && @area.to_s.length > 50
  return false if !@company.nil? && @company.to_s.length > 50
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@country.nil? && @country.to_s.length < 2
  return false if !@email.nil? && @email.to_s.length > 254
  return false if !@mobile_no.nil? && @mobile_no.to_s.length > 20
  return false if !@postcode.nil? && @postcode.to_s.length > 16
  return false if !@telephone_no.nil? && @telephone_no.to_s.length > 20
  true
end