Class: Tradenity::TableRateShipping

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TableRateShipping

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 126

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

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

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

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

  if attributes.has_key?(:'customerGroups')
    if (value = attributes[:'customerGroups']).is_a?(Array)
      self.customer_groups = value
    end
  end

  if attributes.has_key?(:'customer_groups')
    if (value = attributes[:'customer_groups']).is_a?(Array)
      self.customer_groups = value
    end
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'ranges')
    if (value = attributes[:'ranges']).is_a?(Array)
      self.ranges = value
    end
  end
end

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#cost_type ⇒ Object

Returns the value of attribute cost_type.



56
57
58
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 56

def cost_type
  @cost_type
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#customer_groups ⇒ Object

Returns the value of attribute customer_groups.



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

def customer_groups
  @customer_groups
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#geo_zone ⇒ Object

Returns the value of attribute geo_zone.



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

def geo_zone
  @geo_zone
end

#include_taxes ⇒ Object

Returns the value of attribute include_taxes.



54
55
56
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 54

def include_taxes
  @include_taxes
end

#message ⇒ Object

Returns the value of attribute message.



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

def message
  @message
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#ranges ⇒ Object

Returns the value of attribute ranges.



58
59
60
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 58

def ranges
  @ranges
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#status ⇒ Object

Returns the value of attribute status.



50
51
52
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 50

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#use_discounted_subtotal ⇒ Object

Returns the value of attribute use_discounted_subtotal.



52
53
54
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 52

def use_discounted_subtotal
  @use_discounted_subtotal
end

Class Method Details

.api_client ⇒ Object 



426
427
428
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 426

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 83

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'message' => :'message',
    :'description' => :'description',
    :'geo_zone' => :'geoZone',
    :'customer_groups' => :'customerGroups',
    :'status' => :'status',
    :'use_discounted_subtotal' => :'useDiscountedSubtotal',
    :'include_taxes' => :'includeTaxes',
    :'cost_type' => :'costType',
    :'ranges' => :'ranges'
  }
end

.create_table_rate_shipping(table_rate_shipping, opts = {}) ⇒ TableRateShipping

Create TableRateShipping Create a new TableRateShipping

Parameters:

  • table_rate_shipping —

    Attributes of tableRateShipping to create

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

    the optional parameters

Returns:



499
500
501
502
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 499

def create_table_rate_shipping(table_rate_shipping, opts = {})
  data, _status_code, _headers = create_table_rate_shipping_with_http_info(table_rate_shipping, opts)
  data
end

.create_table_rate_shipping_with_http_info(table_rate_shipping, opts = {}) ⇒ Array<(TableRateShipping, Fixnum, Hash)>

Create TableRateShipping Create a new TableRateShipping

Parameters:

  • table_rate_shipping —

    Attributes of tableRateShipping to create

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

    the optional parameters

Returns:

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

    TableRateShipping data, response status code and response headers



509
510
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
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 509

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

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

.delete_by_id(id) ⇒ nil

Delete TableRateShipping Delete an instance of TableRateShipping by its ID.

Parameters:

  • id —

    ID of TableRateShipping to delete.

Returns:

  • (nil) 


490
491
492
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 490

def delete_by_id(id)
  delete_table_rate_shipping_by_id(id)
end

.delete_table_rate_shipping_by_id(table_rate_shipping_id, opts = {}) ⇒ nil

Delete TableRateShipping Delete an instance of TableRateShipping by its ID.

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to delete.

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

    the optional parameters

Returns:

  • (nil) 


553
554
555
556
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 553

def delete_table_rate_shipping_by_id(table_rate_shipping_id, opts = {})
  delete_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, opts)
  nil
end

.delete_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete TableRateShipping Delete an instance of TableRateShipping by its ID.

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



563
564
565
566
567
568
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
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 563

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

.find_all ⇒ Page<TableRateShipping>

List TableRateShippings Return a list of TableRateShippings

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



458
459
460
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 458

def find_all
  list_all_table_rate_shippings
end

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

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

Parameters:

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

    the search parameters

Returns:



466
467
468
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 466

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

.find_by_id(id) ⇒ TableRateShipping

Find TableRateShipping Return single instance of TableRateShipping by its ID.

Parameters:

  • id —

    ID of TableRateShipping to return

Returns:



482
483
484
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 482

def find_by_id(id)
  get_table_rate_shipping_by_id(id)
end

.find_one_by(opts = {}) ⇒ TableRateShipping

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

Parameters:

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

    search parameters

Returns:



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

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

.get_table_rate_shipping_by_id(table_rate_shipping_id, opts = {}) ⇒ TableRateShipping

Find TableRateShipping Return single instance of TableRateShipping by its ID.

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to return

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

    the optional parameters

Returns:



606
607
608
609
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 606

def get_table_rate_shipping_by_id(table_rate_shipping_id, opts = {})
  data, _status_code, _headers = get_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, opts)
  data
end

.get_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, opts = {}) ⇒ Array<(TableRateShipping, Fixnum, Hash)>

Find TableRateShipping Return single instance of TableRateShipping by its ID.

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to return

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

    the optional parameters

Returns:

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

    TableRateShipping data, response status code and response headers



616
617
618
619
620
621
622
623
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
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 616

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

.list_all_table_rate_shippings(opts = {}) ⇒ Page<TableRateShipping>

List TableRateShippings Return a list of TableRateShippings

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



662
663
664
665
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 662

def list_all_table_rate_shippings(opts = {})
  data, _status_code, _headers = list_all_table_rate_shippings_with_http_info(opts)
  data
end

.list_all_table_rate_shippings_with_http_info(opts = {}) ⇒ Array<(Page<TableRateShipping>, Fixnum, Hash)>

List TableRateShippings Return a list of TableRateShippings

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

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



674
675
676
677
678
679
680
681
682
683
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
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 674

def list_all_table_rate_shippings_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateShipping.list_all_table_rate_shippings ...'
  end
  # resource path
  local_var_path = '/tableRateShippings'

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

.replace_table_rate_shipping_by_id(table_rate_shipping_id, table_rate_shipping, opts = {}) ⇒ TableRateShipping

Replace TableRateShipping Replace all attributes of TableRateShipping

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to replace

  • table_rate_shipping —

    Attributes of tableRateShipping to replace

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

    the optional parameters

Returns:



718
719
720
721
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 718

def replace_table_rate_shipping_by_id(table_rate_shipping_id, table_rate_shipping, opts = {})
  data, _status_code, _headers = replace_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, table_rate_shipping, opts)
  data
end

.replace_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, table_rate_shipping, opts = {}) ⇒ Array<(TableRateShipping, Fixnum, Hash)>

Replace TableRateShipping Replace all attributes of TableRateShipping

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to replace

  • table_rate_shipping —

    Attributes of tableRateShipping to replace

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

    the optional parameters

Returns:

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

    TableRateShipping data, response status code and response headers



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 729

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

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 104

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'message' => :'String',
    :'description' => :'String',
    :'geo_zone' => :'GeoZone',
    :'customer_groups' => :'Array<CustomerGroup>',
    :'status' => :'String',
    :'use_discounted_subtotal' => :'BOOLEAN',
    :'include_taxes' => :'BOOLEAN',
    :'cost_type' => :'String',
    :'ranges' => :'Array<TableRateRule>'
  }
end

.update_table_rate_shipping_by_id(table_rate_shipping_id, table_rate_shipping, opts = {}) ⇒ TableRateShipping

Update TableRateShipping Update attributes of TableRateShipping

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to update.

  • table_rate_shipping —

    Attributes of tableRateShipping to update.

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

    the optional parameters

Returns:



778
779
780
781
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 778

def update_table_rate_shipping_by_id(table_rate_shipping_id, table_rate_shipping, opts = {})
  data, _status_code, _headers = update_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, table_rate_shipping, opts)
  data
end

.update_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, table_rate_shipping, opts = {}) ⇒ Array<(TableRateShipping, Fixnum, Hash)>

Update TableRateShipping Update attributes of TableRateShipping

Parameters:

  • table_rate_shipping_id —

    ID of tableRateShipping to update.

  • table_rate_shipping —

    Attributes of tableRateShipping to update.

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

    the optional parameters

Returns:

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

    TableRateShipping data, response status code and response headers



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 789

def update_table_rate_shipping_by_id_with_http_info(table_rate_shipping_id, table_rate_shipping, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateShipping.update_table_rate_shipping_by_id ...'
  end
  # verify the required parameter 'table_rate_shipping_id' is set
  if api_client.config.client_side_validation && table_rate_shipping_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_shipping_id' when calling TableRateShipping.update_table_rate_shipping_by_id"
  end
  # verify the required parameter 'table_rate_shipping' is set
  if api_client.config.client_side_validation && table_rate_shipping.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_shipping' when calling TableRateShipping.update_table_rate_shipping_by_id"
  end
  # resource path
  local_var_path = '/tableRateShippings/{tableRateShippingId}'.sub('{' + 'tableRateShippingId' + '}', table_rate_shipping_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(table_rate_shipping)
  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 => 'TableRateShipping')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateShipping#update_table_rate_shipping_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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 290

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 &&
      message == o.message &&
      description == o.description &&
      geo_zone == o.geo_zone &&
      customer_groups == o.customer_groups &&
      status == o.status &&
      use_discounted_subtotal == o.use_discounted_subtotal &&
      include_taxes == o.include_taxes &&
      cost_type == o.cost_type &&
      ranges == o.ranges
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 345

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 411

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



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

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



432
433
434
435
436
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 432

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

#delete ⇒ nil

Delete TableRateShipping Delete this instance of TableRateShipping.

Returns:

  • (nil) 


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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 317

def hash
  [__meta, created_at, updated_at, name, slug, message, description, geo_zone, customer_groups, status, use_discounted_subtotal, include_taxes, cost_type, ranges].hash
end

#id ⇒ Object 



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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 228

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

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

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



391
392
393
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 391

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



397
398
399
400
401
402
403
404
405
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 397

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



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

def to_s
  to_hash.to_s
end

#update ⇒ TableRateShipping

Update TableRateShipping Update attributes of TableRateShipping

Returns:



441
442
443
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 441

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



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/tradenity/resources/table_rate_shipping.rb', line 255

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