Class: Tradenity::StatesGeoZone

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StatesGeoZone

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
 
# File 'lib/tradenity/resources/states_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?(:'states')
    if (value = attributes[:'states']).is_a?(Array)
      self.states = value
    end
  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/states_geo_zone.rb', line 32

def __meta
  @__meta
end

#country ⇒ Object

Returns the value of attribute country.



48
49
50
 
# File 'lib/tradenity/resources/states_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/states_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/states_geo_zone.rb', line 44

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#states ⇒ Object

Returns the value of attribute states.



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

def states
  @states
end

#status ⇒ Object

Returns the value of attribute status.



42
43
44
 
# File 'lib/tradenity/resources/states_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/states_geo_zone.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



340
341
342
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 340

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/states_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',
    :'states' => :'states',
    :'country' => :'country'
  }
end

.create_states_geo_zone(states_geo_zone, opts = {}) ⇒ StatesGeoZone

Create StatesGeoZone Create a new StatesGeoZone

Parameters:

  • states_geo_zone —

    Attributes of statesGeoZone to create

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 413

def create_states_geo_zone(states_geo_zone, opts = {})
  data, _status_code, _headers = create_states_geo_zone_with_http_info(states_geo_zone, opts)
  data
end

.create_states_geo_zone_with_http_info(states_geo_zone, opts = {}) ⇒ Array<(StatesGeoZone, Fixnum, Hash)>

Create StatesGeoZone Create a new StatesGeoZone

Parameters:

  • states_geo_zone —

    Attributes of statesGeoZone to create

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

    the optional parameters

Returns:

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

    StatesGeoZone data, response status code and response headers



423
424
425
426
427
428
429
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 423

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

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

.delete_by_id(id) ⇒ nil

Delete StatesGeoZone Delete an instance of StatesGeoZone by its ID.

Parameters:

  • id —

    ID of StatesGeoZone to delete.

Returns:

  • (nil) 


404
405
406
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 404

def delete_by_id(id)
  delete_states_geo_zone_by_id(id)
end

.delete_states_geo_zone_by_id(states_geo_zone_id, opts = {}) ⇒ nil

Delete StatesGeoZone Delete an instance of StatesGeoZone by its ID.

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to delete.

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

    the optional parameters

Returns:

  • (nil) 


467
468
469
470
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 467

def delete_states_geo_zone_by_id(states_geo_zone_id, opts = {})
  delete_states_geo_zone_by_id_with_http_info(states_geo_zone_id, opts)
  nil
end

.delete_states_geo_zone_by_id_with_http_info(states_geo_zone_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete StatesGeoZone Delete an instance of StatesGeoZone by its ID.

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



477
478
479
480
481
482
483
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 477

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

.find_all ⇒ Page<StatesGeoZone>

List StatesGeoZones Return a list of StatesGeoZones

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



372
373
374
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 372

def find_all
  list_all_states_geo_zones
end

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

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

Parameters:

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

    the search parameters

Returns:



380
381
382
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 380

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

.find_by_id(id) ⇒ StatesGeoZone

Find StatesGeoZone Return single instance of StatesGeoZone by its ID.

Parameters:

  • id —

    ID of StatesGeoZone to return

Returns:



396
397
398
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 396

def find_by_id(id)
  get_states_geo_zone_by_id(id)
end

.find_one_by(opts = {}) ⇒ StatesGeoZone

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

Parameters:

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

    search parameters

Returns:



388
389
390
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 388

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

.get_states_geo_zone_by_id(states_geo_zone_id, opts = {}) ⇒ StatesGeoZone

Find StatesGeoZone Return single instance of StatesGeoZone by its ID.

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to return

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

    the optional parameters

Returns:



520
521
522
523
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 520

def get_states_geo_zone_by_id(states_geo_zone_id, opts = {})
  data, _status_code, _headers = get_states_geo_zone_by_id_with_http_info(states_geo_zone_id, opts)
  data
end

.get_states_geo_zone_by_id_with_http_info(states_geo_zone_id, opts = {}) ⇒ Array<(StatesGeoZone, Fixnum, Hash)>

Find StatesGeoZone Return single instance of StatesGeoZone by its ID.

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to return

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

    the optional parameters

Returns:

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

    StatesGeoZone data, response status code and response headers



530
531
532
533
534
535
536
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 530

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

.list_all_states_geo_zones(opts = {}) ⇒ Page<StatesGeoZone>

List StatesGeoZones Return a list of StatesGeoZones

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



576
577
578
579
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 576

def list_all_states_geo_zones(opts = {})
  data, _status_code, _headers = list_all_states_geo_zones_with_http_info(opts)
  data
end

.list_all_states_geo_zones_with_http_info(opts = {}) ⇒ Array<(Page<StatesGeoZone>, Fixnum, Hash)>

List StatesGeoZones Return a list of StatesGeoZones

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

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



588
589
590
591
592
593
594
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 588

def list_all_states_geo_zones_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StatesGeoZone.list_all_states_geo_zones ...'
  end
  # resource path
  local_var_path = '/statesGeoZones'

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

.replace_states_geo_zone_by_id(states_geo_zone_id, states_geo_zone, opts = {}) ⇒ StatesGeoZone

Replace StatesGeoZone Replace all attributes of StatesGeoZone

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to replace

  • states_geo_zone —

    Attributes of statesGeoZone to replace

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

    the optional parameters

Returns:



632
633
634
635
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 632

def replace_states_geo_zone_by_id(states_geo_zone_id, states_geo_zone, opts = {})
  data, _status_code, _headers = replace_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts)
  data
end

.replace_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts = {}) ⇒ Array<(StatesGeoZone, Fixnum, Hash)>

Replace StatesGeoZone Replace all attributes of StatesGeoZone

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to replace

  • states_geo_zone —

    Attributes of statesGeoZone to replace

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

    the optional parameters

Returns:

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

    StatesGeoZone data, response status code and response headers



643
644
645
646
647
648
649
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 643

def replace_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StatesGeoZone.replace_states_geo_zone_by_id ...'
  end
  # verify the required parameter 'states_geo_zone_id' is set
  if api_client.config.client_side_validation && states_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'states_geo_zone_id' when calling StatesGeoZone.replace_states_geo_zone_by_id"
  end
  # verify the required parameter 'states_geo_zone' is set
  if api_client.config.client_side_validation && states_geo_zone.nil?
    fail ArgumentError, "Missing the required parameter 'states_geo_zone' when calling StatesGeoZone.replace_states_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/statesGeoZones/{statesGeoZoneId}'.sub('{' + 'statesGeoZoneId' + '}', states_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(states_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 => 'StatesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StatesGeoZone#replace_states_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/states_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',
    :'states' => :'Array<State>',
    :'country' => :'Country'
  }
end

.update_states_geo_zone_by_id(states_geo_zone_id, states_geo_zone, opts = {}) ⇒ StatesGeoZone

Update StatesGeoZone Update attributes of StatesGeoZone

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to update.

  • states_geo_zone —

    Attributes of statesGeoZone to update.

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

    the optional parameters

Returns:



692
693
694
695
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 692

def update_states_geo_zone_by_id(states_geo_zone_id, states_geo_zone, opts = {})
  data, _status_code, _headers = update_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts)
  data
end

.update_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts = {}) ⇒ Array<(StatesGeoZone, Fixnum, Hash)>

Update StatesGeoZone Update attributes of StatesGeoZone

Parameters:

  • states_geo_zone_id —

    ID of statesGeoZone to update.

  • states_geo_zone —

    Attributes of statesGeoZone to update.

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

    the optional parameters

Returns:

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

    StatesGeoZone data, response status code and response headers



703
704
705
706
707
708
709
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
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 703

def update_states_geo_zone_by_id_with_http_info(states_geo_zone_id, states_geo_zone, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StatesGeoZone.update_states_geo_zone_by_id ...'
  end
  # verify the required parameter 'states_geo_zone_id' is set
  if api_client.config.client_side_validation && states_geo_zone_id.nil?
    fail ArgumentError, "Missing the required parameter 'states_geo_zone_id' when calling StatesGeoZone.update_states_geo_zone_by_id"
  end
  # verify the required parameter 'states_geo_zone' is set
  if api_client.config.client_side_validation && states_geo_zone.nil?
    fail ArgumentError, "Missing the required parameter 'states_geo_zone' when calling StatesGeoZone.update_states_geo_zone_by_id"
  end
  # resource path
  local_var_path = '/statesGeoZones/{statesGeoZoneId}'.sub('{' + 'statesGeoZoneId' + '}', states_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(states_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 => 'StatesGeoZone')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StatesGeoZone#update_states_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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 209

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 &&
      states == o.states &&
      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



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

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 325

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 238

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



346
347
348
349
350
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 346

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

#delete ⇒ nil

Delete StatesGeoZone Delete this instance of StatesGeoZone.

Returns:

  • (nil) 


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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 231

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

#id ⇒ Object 



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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 164

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



305
306
307
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 311

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



299
300
301
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 299

def to_s
  to_hash.to_s
end

#update ⇒ StatesGeoZone

Update StatesGeoZone Update attributes of StatesGeoZone

Returns:



355
356
357
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 355

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



187
188
189
190
191
192
193
194
195
 
# File 'lib/tradenity/resources/states_geo_zone.rb', line 187

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 @states.nil?
  true
end