Class: Tradenity::ZipCodesGeoZone

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ZipCodesGeoZone

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 106

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

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

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

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

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

  if attributes.has_key?(:'zip_codes')
    self.zip_codes = attributes[:'zip_codes']
  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/zip_codes_geo_zone.rb', line 32

def __meta
  @__meta
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#zip_codes ⇒ Object

Returns the value of attribute zip_codes.



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

def zip_codes
  @zip_codes
end

Class Method Details

.api_client ⇒ Object 



347
348
349
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 347

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 73

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'status' => :'status',
    :'description' => :'description',
    :'zip_codes' => :'zipCodes',
    :'country' => :'country'
  }
end

.create_zip_codes_geo_zone(zip_codes_geo_zone, opts = {}) ⇒ ZipCodesGeoZone

Create ZipCodesGeoZone Create a new ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to create

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

    the optional parameters

Returns:



420
421
422
423
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 420

def create_zip_codes_geo_zone(zip_codes_geo_zone, opts = {})
  data, _status_code, _headers = create_zip_codes_geo_zone_with_http_info(zip_codes_geo_zone, opts)
  data
end

.create_zip_codes_geo_zone_with_http_info(zip_codes_geo_zone, opts = {}) ⇒ Array<(ZipCodesGeoZone, Fixnum, Hash)>

Create ZipCodesGeoZone Create a new ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to create

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

    the optional parameters

Returns:

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

    ZipCodesGeoZone data, response status code and response headers



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 430

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

  # 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(zip_codes_geo_zone)
  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 => 'ZipCodesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ZipCodesGeoZone#create_zip_codes_geo_zone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete ZipCodesGeoZone Delete an instance of ZipCodesGeoZone by its ID.

Parameters:

  • id —

    ID of ZipCodesGeoZone to delete.

Returns:

  • (nil) 


411
412
413
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 411

def delete_by_id(id)
  delete_zip_codes_geo_zone_by_id(id)
end

.delete_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, opts = {}) ⇒ nil

Delete ZipCodesGeoZone Delete an instance of ZipCodesGeoZone by its ID.

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to delete.

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

    the optional parameters

Returns:

  • (nil) 


474
475
476
477
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 474

def delete_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, opts = {})
  delete_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts)
  nil
end

.delete_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete ZipCodesGeoZone Delete an instance of ZipCodesGeoZone by its ID.

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 484

def delete_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ZipCodesGeoZone.delete_zip_codes_geo_zone_by_id ...'
  end
  # verify the required parameter 'zip_codes_geo_zone_id' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone_id' when calling ZipCodesGeoZone.delete_zip_codes_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/zipCodesGeoZones/{zipCodesGeoZoneId}'.sub('{' + 'zipCodesGeoZoneId' + '}', zip_codes_geo_zone_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: ZipCodesGeoZone#delete_zip_codes_geo_zone_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_all ⇒ Page<ZipCodesGeoZone>

List ZipCodesGeoZones Return a list of ZipCodesGeoZones

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



379
380
381
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 379

def find_all
  list_all_zip_codes_geo_zones
end

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

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

Parameters:

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

    the search parameters

Returns:



387
388
389
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 387

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

.find_by_id(id) ⇒ ZipCodesGeoZone

Find ZipCodesGeoZone Return single instance of ZipCodesGeoZone by its ID.

Parameters:

  • id —

    ID of ZipCodesGeoZone to return

Returns:



403
404
405
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 403

def find_by_id(id)
  get_zip_codes_geo_zone_by_id(id)
end

.find_one_by(opts = {}) ⇒ ZipCodesGeoZone

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

Parameters:

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

    search parameters

Returns:



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

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

.get_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, opts = {}) ⇒ ZipCodesGeoZone

Find ZipCodesGeoZone Return single instance of ZipCodesGeoZone by its ID.

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to return

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

    the optional parameters

Returns:



527
528
529
530
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 527

def get_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, opts = {})
  data, _status_code, _headers = get_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts)
  data
end

.get_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts = {}) ⇒ Array<(ZipCodesGeoZone, Fixnum, Hash)>

Find ZipCodesGeoZone Return single instance of ZipCodesGeoZone by its ID.

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to return

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

    the optional parameters

Returns:

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

    ZipCodesGeoZone data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 537

def get_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ZipCodesGeoZone.get_zip_codes_geo_zone_by_id ...'
  end
  # verify the required parameter 'zip_codes_geo_zone_id' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone_id' when calling ZipCodesGeoZone.get_zip_codes_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/zipCodesGeoZones/{zipCodesGeoZoneId}'.sub('{' + 'zipCodesGeoZoneId' + '}', zip_codes_geo_zone_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 => 'ZipCodesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ZipCodesGeoZone#get_zip_codes_geo_zone_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_zip_codes_geo_zones(opts = {}) ⇒ Page<ZipCodesGeoZone>

List ZipCodesGeoZones Return a list of ZipCodesGeoZones

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



583
584
585
586
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 583

def list_all_zip_codes_geo_zones(opts = {})
  data, _status_code, _headers = list_all_zip_codes_geo_zones_with_http_info(opts)
  data
end

.list_all_zip_codes_geo_zones_with_http_info(opts = {}) ⇒ Array<(Page<ZipCodesGeoZone>, Fixnum, Hash)>

List ZipCodesGeoZones Return a list of ZipCodesGeoZones

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<ZipCodesGeoZone>, Fixnum, Hash)>) —

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



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 595

def list_all_zip_codes_geo_zones_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ZipCodesGeoZone.list_all_zip_codes_geo_zones ...'
  end
  # resource path
  local_var_path = '/zipCodesGeoZones'

  # 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<ZipCodesGeoZone>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ZipCodesGeoZone#list_all_zip_codes_geo_zones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {}) ⇒ ZipCodesGeoZone

Replace ZipCodesGeoZone Replace all attributes of ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to replace

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to replace

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

    the optional parameters

Returns:



639
640
641
642
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 639

def replace_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {})
  data, _status_code, _headers = replace_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts)
  data
end

.replace_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {}) ⇒ Array<(ZipCodesGeoZone, Fixnum, Hash)>

Replace ZipCodesGeoZone Replace all attributes of ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to replace

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to replace

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

    the optional parameters

Returns:

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

    ZipCodesGeoZone data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 650

def replace_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ZipCodesGeoZone.replace_zip_codes_geo_zone_by_id ...'
  end
  # verify the required parameter 'zip_codes_geo_zone_id' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone_id' when calling ZipCodesGeoZone.replace_zip_codes_geo_zone_by_id"
  end
  # verify the required parameter 'zip_codes_geo_zone' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone' when calling ZipCodesGeoZone.replace_zip_codes_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/zipCodesGeoZones/{zipCodesGeoZoneId}'.sub('{' + 'zipCodesGeoZoneId' + '}', zip_codes_geo_zone_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(zip_codes_geo_zone)
  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 => 'ZipCodesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ZipCodesGeoZone#replace_zip_codes_geo_zone_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 89

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'status' => :'String',
    :'description' => :'String',
    :'zip_codes' => :'String',
    :'country' => :'Country'
  }
end

.update_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {}) ⇒ ZipCodesGeoZone

Update ZipCodesGeoZone Update attributes of ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to update.

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to update.

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

    the optional parameters

Returns:



699
700
701
702
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 699

def update_zip_codes_geo_zone_by_id(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {})
  data, _status_code, _headers = update_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts)
  data
end

.update_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {}) ⇒ Array<(ZipCodesGeoZone, Fixnum, Hash)>

Update ZipCodesGeoZone Update attributes of ZipCodesGeoZone

Parameters:

  • zip_codes_geo_zone_id —

    ID of zipCodesGeoZone to update.

  • zip_codes_geo_zone —

    Attributes of zipCodesGeoZone to update.

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

    the optional parameters

Returns:

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

    ZipCodesGeoZone data, response status code and response headers



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 710

def update_zip_codes_geo_zone_by_id_with_http_info(zip_codes_geo_zone_id, zip_codes_geo_zone, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: ZipCodesGeoZone.update_zip_codes_geo_zone_by_id ...'
  end
  # verify the required parameter 'zip_codes_geo_zone_id' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone_id' when calling ZipCodesGeoZone.update_zip_codes_geo_zone_by_id"
  end
  # verify the required parameter 'zip_codes_geo_zone' is set
  if api_client.config.client_side_validation && zip_codes_geo_zone.nil?
    fail ArgumentError, "Missing the required parameter 'zip_codes_geo_zone' when calling ZipCodesGeoZone.update_zip_codes_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/zipCodesGeoZones/{zipCodesGeoZoneId}'.sub('{' + 'zipCodesGeoZoneId' + '}', zip_codes_geo_zone_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(zip_codes_geo_zone)
  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 => 'ZipCodesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: ZipCodesGeoZone#update_zip_codes_geo_zone_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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 216

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 &&
      name == o.name &&
      slug == o.slug &&
      status == o.status &&
      description == o.description &&
      zip_codes == o.zip_codes &&
      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



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

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 332

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 245

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 ZipCodesGeoZone Create a new ZipCodesGeoZone



353
354
355
356
357
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 353

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

#delete ⇒ nil

Delete ZipCodesGeoZone Delete this instance of ZipCodesGeoZone.

Returns:

  • (nil) 


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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


232
233
234
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 238

def hash
  [__meta, created_at, updated_at, name, slug, status, description, zip_codes, country].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.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/zip_codes_geo_zone.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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 166

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

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

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

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



312
313
314
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 312

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 318

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



306
307
308
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 306

def to_s
  to_hash.to_s
end

#update ⇒ ZipCodesGeoZone

Update ZipCodesGeoZone Update attributes of ZipCodesGeoZone

Returns:



362
363
364
 
# File 'lib/tradenity/resources/zip_codes_geo_zone.rb', line 362

def update
  self.class.update_zip_codes_geo_zone_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



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

def valid?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  return false if @zip_codes.nil?
  return false if @country.nil?
  true
end