Class: Tradenity::TaxRate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxRate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#based_on ⇒ Object

Returns the value of attribute based_on.



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

def based_on
  @based_on
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#customer_groups ⇒ Object

Returns the value of attribute customer_groups.



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

def customer_groups
  @customer_groups
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#fixed_rate ⇒ Object

Returns the value of attribute fixed_rate.



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

def fixed_rate
  @fixed_rate
end

#geo_zone ⇒ Object

Returns the value of attribute geo_zone.



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

def geo_zone
  @geo_zone
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#percentage ⇒ Object

Returns the value of attribute percentage.



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

def percentage
  @percentage
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#tax_class ⇒ Object

Returns the value of attribute tax_class.



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

def tax_class
  @tax_class
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



437
438
439
 
# File 'lib/tradenity/resources/tax_rate.rb', line 437

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tradenity/resources/tax_rate.rb', line 81

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'percentage' => :'percentage',
    :'fixed_rate' => :'fixedRate',
    :'status' => :'status',
    :'tax_class' => :'taxClass',
    :'geo_zone' => :'geoZone',
    :'customer_groups' => :'customerGroups',
    :'based_on' => :'basedOn'
  }
end

.create_tax_rate(tax_rate, opts = {}) ⇒ TaxRate

Create TaxRate Create a new TaxRate

Parameters:

  • tax_rate —

    Attributes of taxRate to create

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

    the optional parameters

Returns:



510
511
512
513
 
# File 'lib/tradenity/resources/tax_rate.rb', line 510

def create_tax_rate(tax_rate, opts = {})
  data, _status_code, _headers = create_tax_rate_with_http_info(tax_rate, opts)
  data
end

.create_tax_rate_with_http_info(tax_rate, opts = {}) ⇒ Array<(TaxRate, Fixnum, Hash)>

Create TaxRate Create a new TaxRate

Parameters:

  • tax_rate —

    Attributes of taxRate to create

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

    the optional parameters

Returns:

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

    TaxRate data, response status code and response headers



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/tradenity/resources/tax_rate.rb', line 520

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

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

.delete_by_id(id) ⇒ nil

Delete TaxRate Delete an instance of TaxRate by its ID.

Parameters:

  • id —

    ID of TaxRate to delete.

Returns:

  • (nil) 


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

def delete_by_id(id)
  delete_tax_rate_by_id(id)
end

.delete_tax_rate_by_id(tax_rate_id, opts = {}) ⇒ nil

Delete TaxRate Delete an instance of TaxRate by its ID.

Parameters:

  • tax_rate_id —

    ID of taxRate to delete.

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

    the optional parameters

Returns:

  • (nil) 


564
565
566
567
 
# File 'lib/tradenity/resources/tax_rate.rb', line 564

def delete_tax_rate_by_id(tax_rate_id, opts = {})
  delete_tax_rate_by_id_with_http_info(tax_rate_id, opts)
  nil
end

.delete_tax_rate_by_id_with_http_info(tax_rate_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete TaxRate Delete an instance of TaxRate by its ID.

Parameters:

  • tax_rate_id —

    ID of taxRate to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/tradenity/resources/tax_rate.rb', line 574

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

.find_all ⇒ Page<TaxRate>

List TaxRates Return a list of TaxRates

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



469
470
471
 
# File 'lib/tradenity/resources/tax_rate.rb', line 469

def find_all
  list_all_tax_rates
end

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

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

Parameters:

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

    the search parameters

Returns:



477
478
479
 
# File 'lib/tradenity/resources/tax_rate.rb', line 477

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

.find_by_id(id) ⇒ TaxRate

Find TaxRate Return single instance of TaxRate by its ID.

Parameters:

  • id —

    ID of TaxRate to return

Returns:



493
494
495
 
# File 'lib/tradenity/resources/tax_rate.rb', line 493

def find_by_id(id)
  get_tax_rate_by_id(id)
end

.find_one_by(opts = {}) ⇒ TaxRate

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

Parameters:

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

    search parameters

Returns:



485
486
487
 
# File 'lib/tradenity/resources/tax_rate.rb', line 485

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

.get_tax_rate_by_id(tax_rate_id, opts = {}) ⇒ TaxRate

Find TaxRate Return single instance of TaxRate by its ID.

Parameters:

  • tax_rate_id —

    ID of taxRate to return

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

    the optional parameters

Returns:



617
618
619
620
 
# File 'lib/tradenity/resources/tax_rate.rb', line 617

def get_tax_rate_by_id(tax_rate_id, opts = {})
  data, _status_code, _headers = get_tax_rate_by_id_with_http_info(tax_rate_id, opts)
  data
end

.get_tax_rate_by_id_with_http_info(tax_rate_id, opts = {}) ⇒ Array<(TaxRate, Fixnum, Hash)>

Find TaxRate Return single instance of TaxRate by its ID.

Parameters:

  • tax_rate_id —

    ID of taxRate to return

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

    the optional parameters

Returns:

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

    TaxRate data, response status code and response headers



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

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

.list_all_tax_rates(opts = {}) ⇒ Page<TaxRate>

List TaxRates Return a list of TaxRates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



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

def list_all_tax_rates(opts = {})
  data, _status_code, _headers = list_all_tax_rates_with_http_info(opts)
  data
end

.list_all_tax_rates_with_http_info(opts = {}) ⇒ Array<(Page<TaxRate>, Fixnum, Hash)>

List TaxRates Return a list of TaxRates

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

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



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

def list_all_tax_rates_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.list_all_tax_rates ...'
  end
  # resource path
  local_var_path = '/taxRates'

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

.replace_tax_rate_by_id(tax_rate_id, tax_rate, opts = {}) ⇒ TaxRate

Replace TaxRate Replace all attributes of TaxRate

Parameters:

  • tax_rate_id —

    ID of taxRate to replace

  • tax_rate —

    Attributes of taxRate to replace

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

    the optional parameters

Returns:



729
730
731
732
 
# File 'lib/tradenity/resources/tax_rate.rb', line 729

def replace_tax_rate_by_id(tax_rate_id, tax_rate, opts = {})
  data, _status_code, _headers = replace_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts)
  data
end

.replace_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {}) ⇒ Array<(TaxRate, Fixnum, Hash)>

Replace TaxRate Replace all attributes of TaxRate

Parameters:

  • tax_rate_id —

    ID of taxRate to replace

  • tax_rate —

    Attributes of taxRate to replace

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

    the optional parameters

Returns:

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

    TaxRate data, response status code and response headers



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
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/tradenity/resources/tax_rate.rb', line 740

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

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/tradenity/resources/tax_rate.rb', line 101

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'percentage' => :'Float',
    :'fixed_rate' => :'Integer',
    :'status' => :'String',
    :'tax_class' => :'TaxClass',
    :'geo_zone' => :'GeoZone',
    :'customer_groups' => :'Array<CustomerGroup>',
    :'based_on' => :'String'
  }
end

.update_tax_rate_by_id(tax_rate_id, tax_rate, opts = {}) ⇒ TaxRate

Update TaxRate Update attributes of TaxRate

Parameters:

  • tax_rate_id —

    ID of taxRate to update.

  • tax_rate —

    Attributes of taxRate to update.

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

    the optional parameters

Returns:



789
790
791
792
 
# File 'lib/tradenity/resources/tax_rate.rb', line 789

def update_tax_rate_by_id(tax_rate_id, tax_rate, opts = {})
  data, _status_code, _headers = update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts)
  data
end

.update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {}) ⇒ Array<(TaxRate, Fixnum, Hash)>

Update TaxRate Update attributes of TaxRate

Parameters:

  • tax_rate_id —

    ID of taxRate to update.

  • tax_rate —

    Attributes of taxRate to update.

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

    the optional parameters

Returns:

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

    TaxRate data, response status code and response headers



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
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/tradenity/resources/tax_rate.rb', line 800

def update_tax_rate_by_id_with_http_info(tax_rate_id, tax_rate, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxRate.update_tax_rate_by_id ...'
  end
  # verify the required parameter 'tax_rate_id' is set
  if api_client.config.client_side_validation && tax_rate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate_id' when calling TaxRate.update_tax_rate_by_id"
  end
  # verify the required parameter 'tax_rate' is set
  if api_client.config.client_side_validation && tax_rate.nil?
    fail ArgumentError, "Missing the required parameter 'tax_rate' when calling TaxRate.update_tax_rate_by_id"
  end
  # resource path
  local_var_path = '/taxRates/{taxRateId}'.sub('{' + 'taxRateId' + '}', tax_rate_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(tax_rate)
  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 => 'TaxRate')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxRate#update_tax_rate_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



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

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 &&
      description == o.description &&
      type == o.type &&
      percentage == o.percentage &&
      fixed_rate == o.fixed_rate &&
      status == o.status &&
      tax_class == o.tax_class &&
      geo_zone == o.geo_zone &&
      customer_groups == o.customer_groups &&
      based_on == o.based_on
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



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
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/tradenity/resources/tax_rate.rb', line 356

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/tradenity/resources/tax_rate.rb', line 422

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/tradenity/resources/tax_rate.rb', line 335

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



443
444
445
446
447
 
# File 'lib/tradenity/resources/tax_rate.rb', line 443

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

#delete ⇒ nil

Delete TaxRate Delete this instance of TaxRate.

Returns:

  • (nil) 


459
460
461
 
# File 'lib/tradenity/resources/tax_rate.rb', line 459

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/tradenity/resources/tax_rate.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



328
329
330
 
# File 'lib/tradenity/resources/tax_rate.rb', line 328

def hash
  [__meta, created_at, updated_at, name, description, type, percentage, fixed_rate, status, tax_class, geo_zone, customer_groups, based_on].hash
end

#id ⇒ Object 



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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/tradenity/resources/tax_rate.rb', line 218

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

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

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

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

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

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

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



402
403
404
 
# File 'lib/tradenity/resources/tax_rate.rb', line 402

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



408
409
410
411
412
413
414
415
416
 
# File 'lib/tradenity/resources/tax_rate.rb', line 408

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



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

def to_s
  to_hash.to_s
end

#update ⇒ TaxRate

Update TaxRate Update attributes of TaxRate

Returns:



452
453
454
 
# File 'lib/tradenity/resources/tax_rate.rb', line 452

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/tradenity/resources/tax_rate.rb', line 253

def valid?
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['percentage', 'fixed'])
  return false unless type_validator.valid?(@type)
  return false if @percentage.nil?
  return false if @fixed_rate.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  return false if @tax_class.nil?
  return false if @geo_zone.nil?
  based_on_validator = EnumAttributeValidator.new('String', ['shippingAddress', 'billingAddress'])
  return false unless based_on_validator.valid?(@based_on)
  true
end