Class: OCI::OspGateway::Models::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osp_gateway/models/address.rb

Overview

Address details model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :address_key (String) —

    The value to assign to the #address_key property

  • :line1 (String) —

    The value to assign to the #line1 property

  • :line2 (String) —

    The value to assign to the #line2 property

  • :line3 (String) —

    The value to assign to the #line3 property

  • :line4 (String) —

    The value to assign to the #line4 property

  • :street_name (String) —

    The value to assign to the #street_name property

  • :street_number (String) —

    The value to assign to the #street_number property

  • :city (String) —

    The value to assign to the #city property

  • :county (String) —

    The value to assign to the #county property

  • :country (String) —

    The value to assign to the #country property

  • :province (String) —

    The value to assign to the #province property

  • :postal_code (String) —

    The value to assign to the #postal_code property

  • :state (String) —

    The value to assign to the #state property

  • :email_address (String) —

    The value to assign to the #email_address property

  • :company_name (String) —

    The value to assign to the #company_name property

  • :first_name (String) —

    The value to assign to the #first_name property

  • :middle_name (String) —

    The value to assign to the #middle_name property

  • :last_name (String) —

    The value to assign to the #last_name property

  • :phone_country_code (String) —

    The value to assign to the #phone_country_code property

  • :phone_number (String) —

    The value to assign to the #phone_number property

  • :job_title (String) —

    The value to assign to the #job_title property

  • :department_name (String) —

    The value to assign to the #department_name property

  • :internal_number (String) —

    The value to assign to the #internal_number property

  • :contributor_class (String) —

    The value to assign to the #contributor_class property

  • :state_inscription (String) —

    The value to assign to the #state_inscription property

  • :municipal_inscription (String) —

    The value to assign to the #municipal_inscription property



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
248
249
250
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/osp_gateway/models/address.rb', line 215

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.address_key = attributes[:'addressKey'] if attributes[:'addressKey']

  raise 'You cannot provide both :addressKey and :address_key' if attributes.key?(:'addressKey') && attributes.key?(:'address_key')

  self.address_key = attributes[:'address_key'] if attributes[:'address_key']

  self.line1 = attributes[:'line1'] if attributes[:'line1']

  self.line2 = attributes[:'line2'] if attributes[:'line2']

  self.line3 = attributes[:'line3'] if attributes[:'line3']

  self.line4 = attributes[:'line4'] if attributes[:'line4']

  self.street_name = attributes[:'streetName'] if attributes[:'streetName']

  raise 'You cannot provide both :streetName and :street_name' if attributes.key?(:'streetName') && attributes.key?(:'street_name')

  self.street_name = attributes[:'street_name'] if attributes[:'street_name']

  self.street_number = attributes[:'streetNumber'] if attributes[:'streetNumber']

  raise 'You cannot provide both :streetNumber and :street_number' if attributes.key?(:'streetNumber') && attributes.key?(:'street_number')

  self.street_number = attributes[:'street_number'] if attributes[:'street_number']

  self.city = attributes[:'city'] if attributes[:'city']

  self.county = attributes[:'county'] if attributes[:'county']

  self.country = attributes[:'country'] if attributes[:'country']

  self.province = attributes[:'province'] if attributes[:'province']

  self.postal_code = attributes[:'postalCode'] if attributes[:'postalCode']

  raise 'You cannot provide both :postalCode and :postal_code' if attributes.key?(:'postalCode') && attributes.key?(:'postal_code')

  self.postal_code = attributes[:'postal_code'] if attributes[:'postal_code']

  self.state = attributes[:'state'] if attributes[:'state']

  self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress']

  raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')

  self.email_address = attributes[:'email_address'] if attributes[:'email_address']

  self.company_name = attributes[:'companyName'] if attributes[:'companyName']

  raise 'You cannot provide both :companyName and :company_name' if attributes.key?(:'companyName') && attributes.key?(:'company_name')

  self.company_name = attributes[:'company_name'] if attributes[:'company_name']

  self.first_name = attributes[:'firstName'] if attributes[:'firstName']

  raise 'You cannot provide both :firstName and :first_name' if attributes.key?(:'firstName') && attributes.key?(:'first_name')

  self.first_name = attributes[:'first_name'] if attributes[:'first_name']

  self.middle_name = attributes[:'middleName'] if attributes[:'middleName']

  raise 'You cannot provide both :middleName and :middle_name' if attributes.key?(:'middleName') && attributes.key?(:'middle_name')

  self.middle_name = attributes[:'middle_name'] if attributes[:'middle_name']

  self.last_name = attributes[:'lastName'] if attributes[:'lastName']

  raise 'You cannot provide both :lastName and :last_name' if attributes.key?(:'lastName') && attributes.key?(:'last_name')

  self.last_name = attributes[:'last_name'] if attributes[:'last_name']

  self.phone_country_code = attributes[:'phoneCountryCode'] if attributes[:'phoneCountryCode']

  raise 'You cannot provide both :phoneCountryCode and :phone_country_code' if attributes.key?(:'phoneCountryCode') && attributes.key?(:'phone_country_code')

  self.phone_country_code = attributes[:'phone_country_code'] if attributes[:'phone_country_code']

  self.phone_number = attributes[:'phoneNumber'] if attributes[:'phoneNumber']

  raise 'You cannot provide both :phoneNumber and :phone_number' if attributes.key?(:'phoneNumber') && attributes.key?(:'phone_number')

  self.phone_number = attributes[:'phone_number'] if attributes[:'phone_number']

  self.job_title = attributes[:'jobTitle'] if attributes[:'jobTitle']

  raise 'You cannot provide both :jobTitle and :job_title' if attributes.key?(:'jobTitle') && attributes.key?(:'job_title')

  self.job_title = attributes[:'job_title'] if attributes[:'job_title']

  self.department_name = attributes[:'departmentName'] if attributes[:'departmentName']

  raise 'You cannot provide both :departmentName and :department_name' if attributes.key?(:'departmentName') && attributes.key?(:'department_name')

  self.department_name = attributes[:'department_name'] if attributes[:'department_name']

  self.internal_number = attributes[:'internalNumber'] if attributes[:'internalNumber']

  raise 'You cannot provide both :internalNumber and :internal_number' if attributes.key?(:'internalNumber') && attributes.key?(:'internal_number')

  self.internal_number = attributes[:'internal_number'] if attributes[:'internal_number']

  self.contributor_class = attributes[:'contributorClass'] if attributes[:'contributorClass']

  raise 'You cannot provide both :contributorClass and :contributor_class' if attributes.key?(:'contributorClass') && attributes.key?(:'contributor_class')

  self.contributor_class = attributes[:'contributor_class'] if attributes[:'contributor_class']

  self.state_inscription = attributes[:'stateInscription'] if attributes[:'stateInscription']

  raise 'You cannot provide both :stateInscription and :state_inscription' if attributes.key?(:'stateInscription') && attributes.key?(:'state_inscription')

  self.state_inscription = attributes[:'state_inscription'] if attributes[:'state_inscription']

  self.municipal_inscription = attributes[:'municipalInscription'] if attributes[:'municipalInscription']

  raise 'You cannot provide both :municipalInscription and :municipal_inscription' if attributes.key?(:'municipalInscription') && attributes.key?(:'municipal_inscription')

  self.municipal_inscription = attributes[:'municipal_inscription'] if attributes[:'municipal_inscription']
end

Instance Attribute Details

#address_key ⇒ String

Address identifier.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/osp_gateway/models/address.rb', line 13

def address_key
  @address_key
end

#city ⇒ String

Name of the city.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/osp_gateway/models/address.rb', line 41

def city
  @city
end

#company_name ⇒ String

Name of the customer company.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/osp_gateway/models/address.rb', line 69

def company_name
  @company_name
end

#contributor_class ⇒ String

Contributor class of the customer company.

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/osp_gateway/models/address.rb', line 105

def contributor_class
  @contributor_class
end

#country ⇒ String

Country of the address.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/osp_gateway/models/address.rb', line 49

def country
  @country
end

#county ⇒ String

County of the address.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/osp_gateway/models/address.rb', line 45

def county
  @county
end

#department_name ⇒ String

Department name of the customer company.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/osp_gateway/models/address.rb', line 97

def department_name
  @department_name
end

#email_address ⇒ String

Contact person email address.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/osp_gateway/models/address.rb', line 65

def email_address
  @email_address
end

#first_name ⇒ String

First name of the contact person.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/osp_gateway/models/address.rb', line 73

def first_name
  @first_name
end

#internal_number ⇒ String

Internal number of the customer company.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/osp_gateway/models/address.rb', line 101

def internal_number
  @internal_number
end

#job_title ⇒ String

Job title of the contact person.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/osp_gateway/models/address.rb', line 93

def job_title
  @job_title
end

#last_name ⇒ String

Last name of the contact person.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/osp_gateway/models/address.rb', line 81

def last_name
  @last_name
end

#line1 ⇒ String

Address line 1.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/osp_gateway/models/address.rb', line 17

def line1
  @line1
end

#line2 ⇒ String

Address line 2.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/osp_gateway/models/address.rb', line 21

def line2
  @line2
end

#line3 ⇒ String

Address line 3.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/osp_gateway/models/address.rb', line 25

def line3
  @line3
end

#line4 ⇒ String

Address line 4.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/osp_gateway/models/address.rb', line 29

def line4
  @line4
end

#middle_name ⇒ String

Middle name of the contact person.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/osp_gateway/models/address.rb', line 77

def middle_name
  @middle_name
end

#municipal_inscription ⇒ String

Municipal Inscription.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/osp_gateway/models/address.rb', line 113

def municipal_inscription
  @municipal_inscription
end

#phone_country_code ⇒ String

Phone country code of the contact person.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/osp_gateway/models/address.rb', line 85

def phone_country_code
  @phone_country_code
end

#phone_number ⇒ String

Phone number of the contact person.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/osp_gateway/models/address.rb', line 89

def phone_number
  @phone_number
end

#postal_code ⇒ String

Post code of the address.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/osp_gateway/models/address.rb', line 57

def postal_code
  @postal_code
end

#province ⇒ String

Province of the address.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/osp_gateway/models/address.rb', line 53

def province
  @province
end

#state ⇒ String

State of the address.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/osp_gateway/models/address.rb', line 61

def state
  @state
end

#state_inscription ⇒ String

State Inscription.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/osp_gateway/models/address.rb', line 109

def state_inscription
  @state_inscription
end

#street_name ⇒ String

Street name of the address.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/osp_gateway/models/address.rb', line 33

def street_name
  @street_name
end

#street_number ⇒ String

Street number of the address.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/osp_gateway/models/address.rb', line 37

def street_number
  @street_number
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/osp_gateway/models/address.rb', line 116

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'address_key': :'addressKey',
    'line1': :'line1',
    'line2': :'line2',
    'line3': :'line3',
    'line4': :'line4',
    'street_name': :'streetName',
    'street_number': :'streetNumber',
    'city': :'city',
    'county': :'county',
    'country': :'country',
    'province': :'province',
    'postal_code': :'postalCode',
    'state': :'state',
    'email_address': :'emailAddress',
    'company_name': :'companyName',
    'first_name': :'firstName',
    'middle_name': :'middleName',
    'last_name': :'lastName',
    'phone_country_code': :'phoneCountryCode',
    'phone_number': :'phoneNumber',
    'job_title': :'jobTitle',
    'department_name': :'departmentName',
    'internal_number': :'internalNumber',
    'contributor_class': :'contributorClass',
    'state_inscription': :'stateInscription',
    'municipal_inscription': :'municipalInscription'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/oci/osp_gateway/models/address.rb', line 150

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'address_key': :'String',
    'line1': :'String',
    'line2': :'String',
    'line3': :'String',
    'line4': :'String',
    'street_name': :'String',
    'street_number': :'String',
    'city': :'String',
    'county': :'String',
    'country': :'String',
    'province': :'String',
    'postal_code': :'String',
    'state': :'String',
    'email_address': :'String',
    'company_name': :'String',
    'first_name': :'String',
    'middle_name': :'String',
    'last_name': :'String',
    'phone_country_code': :'String',
    'phone_number': :'String',
    'job_title': :'String',
    'department_name': :'String',
    'internal_number': :'String',
    'contributor_class': :'String',
    'state_inscription': :'String',
    'municipal_inscription': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



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
 
# File 'lib/oci/osp_gateway/models/address.rb', line 349

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    address_key == other.address_key &&
    line1 == other.line1 &&
    line2 == other.line2 &&
    line3 == other.line3 &&
    line4 == other.line4 &&
    street_name == other.street_name &&
    street_number == other.street_number &&
    city == other.city &&
    county == other.county &&
    country == other.country &&
    province == other.province &&
    postal_code == other.postal_code &&
    state == other.state &&
    email_address == other.email_address &&
    company_name == other.company_name &&
    first_name == other.first_name &&
    middle_name == other.middle_name &&
    last_name == other.last_name &&
    phone_country_code == other.phone_country_code &&
    phone_number == other.phone_number &&
    job_title == other.job_title &&
    department_name == other.department_name &&
    internal_number == other.internal_number &&
    contributor_class == other.contributor_class &&
    state_inscription == other.state_inscription &&
    municipal_inscription == other.municipal_inscription
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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/oci/osp_gateway/models/address.rb', line 404

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


384
385
386
 
# File 'lib/oci/osp_gateway/models/address.rb', line 384

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



393
394
395
 
# File 'lib/oci/osp_gateway/models/address.rb', line 393

def hash
  [address_key, line1, line2, line3, line4, street_name, street_number, city, county, country, province, postal_code, state, email_address, company_name, first_name, middle_name, last_name, phone_country_code, phone_number, job_title, department_name, internal_number, contributor_class, state_inscription, municipal_inscription].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



437
438
439
440
441
442
443
444
445
446
 
# File 'lib/oci/osp_gateway/models/address.rb', line 437

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



431
432
433
 
# File 'lib/oci/osp_gateway/models/address.rb', line 431

def to_s
  to_hash.to_s
end