Class: Tradenity::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/tradenity/resources/address.rb

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



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/tradenity/resources/address.rb', line 84

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 }
  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'__meta')
    self.__meta = attributes[:'__meta']
  end

  if attributes.has_key?(:'createdAt')
    self.created_at = attributes[:'createdAt']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updatedAt')
    self.updated_at = attributes[:'updatedAt']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'streetLine1')
    self.street_line1 = attributes[:'streetLine1']
  end

  if attributes.has_key?(:'street_line1')
    self.street_line1 = attributes[:'street_line1']
  end

  if attributes.has_key?(:'streetLine2')
    self.street_line2 = attributes[:'streetLine2']
  end

  if attributes.has_key?(:'street_line2')
    self.street_line2 = attributes[:'street_line2']
  end

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

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'zipCode')
    self.zip_code = attributes[:'zipCode']
  end

  if attributes.has_key?(:'zip_code')
    self.zip_code = attributes[:'zip_code']
  end

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



32
33
34
 
# File 'lib/tradenity/resources/address.rb', line 32

def __meta
  @__meta
end

#city ⇒ Object

Returns the value of attribute city.



42
43
44
 
# File 'lib/tradenity/resources/address.rb', line 42

def city
  @city
end

#country ⇒ Object

Returns the value of attribute country.



48
49
50
 
# File 'lib/tradenity/resources/address.rb', line 48

def country
  @country
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/tradenity/resources/address.rb', line 34

def created_at
  @created_at
end

#state ⇒ Object

Returns the value of attribute state.



44
45
46
 
# File 'lib/tradenity/resources/address.rb', line 44

def state
  @state
end

#street_line1 ⇒ Object

Returns the value of attribute street_line1.



38
39
40
 
# File 'lib/tradenity/resources/address.rb', line 38

def street_line1
  @street_line1
end

#street_line2 ⇒ Object

Returns the value of attribute street_line2.



40
41
42
 
# File 'lib/tradenity/resources/address.rb', line 40

def street_line2
  @street_line2
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



36
37
38
 
# File 'lib/tradenity/resources/address.rb', line 36

def updated_at
  @updated_at
end

#zip_code ⇒ Object

Returns the value of attribute zip_code.



46
47
48
 
# File 'lib/tradenity/resources/address.rb', line 46

def zip_code
  @zip_code
end

Class Method Details

.api_client ⇒ Object 



321
322
323
 
# File 'lib/tradenity/resources/address.rb', line 321

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/tradenity/resources/address.rb', line 51

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'street_line1' => :'streetLine1',
    :'street_line2' => :'streetLine2',
    :'city' => :'city',
    :'state' => :'state',
    :'zip_code' => :'zipCode',
    :'country' => :'country'
  }
end

.create_address(address, opts = {}) ⇒ Address

Create Address Create a new Address

Parameters:

  • address —

    Attributes of address to create

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

    the optional parameters

Returns:



394
395
396
397
 
# File 'lib/tradenity/resources/address.rb', line 394

def create_address(address, opts = {})
  data, _status_code, _headers = create_address_with_http_info(address, opts)
  data
end

.create_address_with_http_info(address, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Create Address Create a new Address

Parameters:

  • address —

    Attributes of address to create

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

    the optional parameters

Returns:

  • (Array<(Address, Fixnum, Hash)>) —

    Address data, response status code and response headers



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/tradenity/resources/address.rb', line 404

def create_address_with_http_info(address, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.create_address ...'
  end
  # verify the required parameter 'address' is set
  if api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling Address.create_address"
  end
  # resource path
  local_var_path = '/addresses'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(address)
  auth_names = []
  data, status_code, headers = api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Address')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#create_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_address_by_id(address_id, opts = {}) ⇒ nil

Delete Address Delete an instance of Address by its ID.

Parameters:

  • address_id —

    ID of address to delete.

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

    the optional parameters

Returns:

  • (nil) 


448
449
450
451
 
# File 'lib/tradenity/resources/address.rb', line 448

def delete_address_by_id(address_id, opts = {})
  delete_address_by_id_with_http_info(address_id, opts)
  nil
end

.delete_address_by_id_with_http_info(address_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Address Delete an instance of Address by its ID.

Parameters:

  • address_id —

    ID of address to delete.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/tradenity/resources/address.rb', line 458

def delete_address_by_id_with_http_info(address_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.delete_address_by_id ...'
  end
  # verify the required parameter 'address_id' is set
  if api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling Address.delete_address_by_id"
  end
  # resource path
  local_var_path = '/addresses/{addressId}'.sub('{' + 'addressId' + '}', address_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#delete_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete Address Delete an instance of Address by its ID.

Parameters:

  • id —

    ID of Address to delete.

Returns:

  • (nil) 


385
386
387
 
# File 'lib/tradenity/resources/address.rb', line 385

def delete_by_id(id)
  delete_address_by_id(id)
end

.find_all ⇒ Page<Address>

List Addresss Return a list of Addresss

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



353
354
355
 
# File 'lib/tradenity/resources/address.rb', line 353

def find_all
  list_all_addresses
end

.find_all_by(opts = {}) ⇒ Page<Collection>

Find List of Address Return multiple instances of Address by its attributes.

Parameters:

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

    the search parameters

Returns:



361
362
363
 
# File 'lib/tradenity/resources/address.rb', line 361

def find_all_by(opts = {})
  list_all_addresses(opts)
end

.find_by_id(id) ⇒ Address

Find Address Return single instance of Address by its ID.

Parameters:

  • id —

    ID of Address to return

Returns:



377
378
379
 
# File 'lib/tradenity/resources/address.rb', line 377

def find_by_id(id)
  get_address_by_id(id)
end

.find_one_by(opts = {}) ⇒ Address

Find Address by its parameters Return single instance of Collection by its attributes.

Parameters:

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

    search parameters

Returns:



369
370
371
 
# File 'lib/tradenity/resources/address.rb', line 369

def find_one_by(opts = {})
  list_all_addresses(opts)[0]
end

.get_address_by_id(address_id, opts = {}) ⇒ Address

Find Address Return single instance of Address by its ID.

Parameters:

  • address_id —

    ID of address to return

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

    the optional parameters

Returns:



501
502
503
504
 
# File 'lib/tradenity/resources/address.rb', line 501

def get_address_by_id(address_id, opts = {})
  data, _status_code, _headers = get_address_by_id_with_http_info(address_id, opts)
  data
end

.get_address_by_id_with_http_info(address_id, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Find Address Return single instance of Address by its ID.

Parameters:

  • address_id —

    ID of address to return

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

    the optional parameters

Returns:

  • (Array<(Address, Fixnum, Hash)>) —

    Address data, response status code and response headers



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
541
542
543
544
545
546
547
548
549
 
# File 'lib/tradenity/resources/address.rb', line 511

def get_address_by_id_with_http_info(address_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.get_address_by_id ...'
  end
  # verify the required parameter 'address_id' is set
  if api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling Address.get_address_by_id"
  end
  # resource path
  local_var_path = '/addresses/{addressId}'.sub('{' + 'addressId' + '}', address_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Address')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#get_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_addresses(opts = {}) ⇒ Page<Address>

List Addresses Return a list of Addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



557
558
559
560
 
# File 'lib/tradenity/resources/address.rb', line 557

def list_all_addresses(opts = {})
  data, _status_code, _headers = list_all_addresses_with_http_info(opts)
  data
end

.list_all_addresses_with_http_info(opts = {}) ⇒ Array<(Page<Address>, Fixnum, Hash)>

List Addresses Return a list of Addresses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:

  • (Array<(Page<Address>, Fixnum, Hash)>) —

    Page<Address> data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/tradenity/resources/address.rb', line 569

def list_all_addresses_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.list_all_addresses ...'
  end
  # resource path
  local_var_path = '/addresses'

  # query parameters
  query_params = opts
  # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Page<Address>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#list_all_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_address_by_id(address_id, address, opts = {}) ⇒ Address

Replace Address Replace all attributes of Address

Parameters:

  • address_id —

    ID of address to replace

  • address —

    Attributes of address to replace

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

    the optional parameters

Returns:



613
614
615
616
 
# File 'lib/tradenity/resources/address.rb', line 613

def replace_address_by_id(address_id, address, opts = {})
  data, _status_code, _headers = replace_address_by_id_with_http_info(address_id, address, opts)
  data
end

.replace_address_by_id_with_http_info(address_id, address, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Replace Address Replace all attributes of Address

Parameters:

  • address_id —

    ID of address to replace

  • address —

    Attributes of address to replace

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

    the optional parameters

Returns:

  • (Array<(Address, Fixnum, Hash)>) —

    Address data, response status code and response headers



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/tradenity/resources/address.rb', line 624

def replace_address_by_id_with_http_info(address_id, address, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.replace_address_by_id ...'
  end
  # verify the required parameter 'address_id' is set
  if api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling Address.replace_address_by_id"
  end
  # verify the required parameter 'address' is set
  if api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling Address.replace_address_by_id"
  end
  # resource path
  local_var_path = '/addresses/{addressId}'.sub('{' + 'addressId' + '}', address_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(address)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Address')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#replace_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/tradenity/resources/address.rb', line 67

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'street_line1' => :'String',
    :'street_line2' => :'String',
    :'city' => :'String',
    :'state' => :'State',
    :'zip_code' => :'String',
    :'country' => :'Country'
  }
end

.update_address_by_id(address_id, address, opts = {}) ⇒ Address

Update Address Update attributes of Address

Parameters:

  • address_id —

    ID of address to update.

  • address —

    Attributes of address to update.

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

    the optional parameters

Returns:



673
674
675
676
 
# File 'lib/tradenity/resources/address.rb', line 673

def update_address_by_id(address_id, address, opts = {})
  data, _status_code, _headers = update_address_by_id_with_http_info(address_id, address, opts)
  data
end

.update_address_by_id_with_http_info(address_id, address, opts = {}) ⇒ Array<(Address, Fixnum, Hash)>

Update Address Update attributes of Address

Parameters:

  • address_id —

    ID of address to update.

  • address —

    Attributes of address to update.

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

    the optional parameters

Returns:

  • (Array<(Address, Fixnum, Hash)>) —

    Address data, response status code and response headers



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/tradenity/resources/address.rb', line 684

def update_address_by_id_with_http_info(address_id, address, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Address.update_address_by_id ...'
  end
  # verify the required parameter 'address_id' is set
  if api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling Address.update_address_by_id"
  end
  # verify the required parameter 'address' is set
  if api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling Address.update_address_by_id"
  end
  # resource path
  local_var_path = '/addresses/{addressId}'.sub('{' + 'addressId' + '}', address_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(address)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Address')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Address#update_address_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/tradenity/resources/address.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      street_line1 == o.street_line1 &&
      street_line2 == o.street_line2 &&
      city == o.city &&
      state == o.state &&
      zip_code == o.zip_code &&
      country == o.country
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



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
 
# File 'lib/tradenity/resources/address.rb', line 240

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
    temp_model = Tradenity.const_get(type).new
    temp_model.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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/tradenity/resources/address.rb', line 306

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/tradenity/resources/address.rb', line 219

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        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

#create ⇒ Object

Create Address Create a new Address



327
328
329
330
331
 
# File 'lib/tradenity/resources/address.rb', line 327

def create
  data = self.class.create_address(self)
  self.id = data.id
  data
end

#delete ⇒ nil

Delete Address Delete this instance of Address.

Returns:

  • (nil) 


343
344
345
 
# File 'lib/tradenity/resources/address.rb', line 343

def delete
  self.class.delete_address_by_id(self.id)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/tradenity/resources/address.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/tradenity/resources/address.rb', line 212

def hash
  [__meta, created_at, updated_at, street_line1, street_line2, city, state, zip_code, country].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/address.rb', line 21

def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end

#id=(id) ⇒ Object 



17
18
19
 
# File 'lib/tradenity/resources/address.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/tradenity/resources/address.rb', line 152

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

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

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

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

  if @country.nil?
    invalid_properties.push('invalid value for "country", country cannot be nil.')
  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



286
287
288
 
# File 'lib/tradenity/resources/address.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/tradenity/resources/address.rb', line 292

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



280
281
282
 
# File 'lib/tradenity/resources/address.rb', line 280

def to_s
  to_hash.to_s
end

#update ⇒ Address

Update Address Update attributes of Address

Returns:



336
337
338
 
# File 'lib/tradenity/resources/address.rb', line 336

def update
  self.class.update_address_by_id(self.id, self)
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



179
180
181
182
183
184
185
186
 
# File 'lib/tradenity/resources/address.rb', line 179

def valid?
  return false if @street_line1.nil?
  return false if @city.nil?
  return false if @state.nil?
  return false if @zip_code.nil?
  return false if @country.nil?
  true
end