Class: UltracartClient::TaxApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/tax_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TaxApi

Returns a new instance of TaxApi.



19
20
21
 
# File 'lib/ultracart_api/api/tax_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ultracart_api/api/tax_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/tax_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::TaxApi.new(api_client)
end

Instance Method Details

#delete_tax_provider_self_city(city, tax_city, opts = {}) ⇒ nil

Deletes a Self tax provider city Deletes a Self tax provider city.

Parameters:

  • city —

    The city being deleted.

  • tax_city —

    tax city to be deleted

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

    the optional parameters

Returns:

  • (nil) 


41
42
43
44
 
# File 'lib/ultracart_api/api/tax_api.rb', line 41

def delete_tax_provider_self_city(city, tax_city, opts = {})
  delete_tax_provider_self_city_with_http_info(city, tax_city, opts)
  nil
end

#delete_tax_provider_self_city_with_http_info(city, tax_city, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a Self tax provider city Deletes a Self tax provider city.

Parameters:

  • city —

    The city being deleted.

  • tax_city —

    tax city to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/api/tax_api.rb', line 52

def delete_tax_provider_self_city_with_http_info(city, tax_city, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.delete_tax_provider_self_city ...'
  end
  # verify the required parameter 'city' is set
  if @api_client.config.client_side_validation && city.nil?
    fail ArgumentError, "Missing the required parameter 'city' when calling TaxApi.delete_tax_provider_self_city"
  end
  # verify the required parameter 'tax_city' is set
  if @api_client.config.client_side_validation && tax_city.nil?
    fail ArgumentError, "Missing the required parameter 'tax_city' when calling TaxApi.delete_tax_provider_self_city"
  end
  # resource path
  local_var_path = '/tax/providers/self/city/{city}'.sub('{' + 'city' + '}', city.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_city)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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: TaxApi#delete_tax_provider_self_city\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tax_provider_self_country(country_code, tax_country, opts = {}) ⇒ nil

Deletes a Self tax provider country Deletes a Self tax provider country.

Parameters:

  • country_code —

    The country code being deleted.

  • tax_country —

    tax country to be deleted

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

    the optional parameters

Returns:

  • (nil) 


101
102
103
104
 
# File 'lib/ultracart_api/api/tax_api.rb', line 101

def delete_tax_provider_self_country(country_code, tax_country, opts = {})
  delete_tax_provider_self_country_with_http_info(country_code, tax_country, opts)
  nil
end

#delete_tax_provider_self_country_with_http_info(country_code, tax_country, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a Self tax provider country Deletes a Self tax provider country.

Parameters:

  • country_code —

    The country code being deleted.

  • tax_country —

    tax country to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/tax_api.rb', line 112

def delete_tax_provider_self_country_with_http_info(country_code, tax_country, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.delete_tax_provider_self_country ...'
  end
  # verify the required parameter 'country_code' is set
  if @api_client.config.client_side_validation && country_code.nil?
    fail ArgumentError, "Missing the required parameter 'country_code' when calling TaxApi.delete_tax_provider_self_country"
  end
  # verify the required parameter 'tax_country' is set
  if @api_client.config.client_side_validation && tax_country.nil?
    fail ArgumentError, "Missing the required parameter 'tax_country' when calling TaxApi.delete_tax_provider_self_country"
  end
  # resource path
  local_var_path = '/tax/providers/self/country/{countryCode}'.sub('{' + 'countryCode' + '}', country_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_country)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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: TaxApi#delete_tax_provider_self_country\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tax_provider_self_county(county, tax_county, opts = {}) ⇒ nil

Deletes a Self tax provider county Deletes a Self tax provider county.

Parameters:

  • county —

    The county being deleted.

  • tax_county —

    tax county to be deleted

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

    the optional parameters

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/ultracart_api/api/tax_api.rb', line 161

def delete_tax_provider_self_county(county, tax_county, opts = {})
  delete_tax_provider_self_county_with_http_info(county, tax_county, opts)
  nil
end

#delete_tax_provider_self_county_with_http_info(county, tax_county, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a Self tax provider county Deletes a Self tax provider county.

Parameters:

  • county —

    The county being deleted.

  • tax_county —

    tax county to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/ultracart_api/api/tax_api.rb', line 172

def delete_tax_provider_self_county_with_http_info(county, tax_county, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.delete_tax_provider_self_county ...'
  end
  # verify the required parameter 'county' is set
  if @api_client.config.client_side_validation && county.nil?
    fail ArgumentError, "Missing the required parameter 'county' when calling TaxApi.delete_tax_provider_self_county"
  end
  # verify the required parameter 'tax_county' is set
  if @api_client.config.client_side_validation && tax_county.nil?
    fail ArgumentError, "Missing the required parameter 'tax_county' when calling TaxApi.delete_tax_provider_self_county"
  end
  # resource path
  local_var_path = '/tax/providers/self/county/{county}'.sub('{' + 'county' + '}', county.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_county)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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: TaxApi#delete_tax_provider_self_county\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tax_provider_self_postal_code(postal_code, tax_postal_code, opts = {}) ⇒ nil

Deletes a Self tax provider postalCode Deletes a Self tax provider postalCode.

Parameters:

  • postal_code —

    The postal code being deleted.

  • tax_postal_code —

    tax postal code to be deleted

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

    the optional parameters

Returns:

  • (nil) 


221
222
223
224
 
# File 'lib/ultracart_api/api/tax_api.rb', line 221

def delete_tax_provider_self_postal_code(postal_code, tax_postal_code, opts = {})
  delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts)
  nil
end

#delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a Self tax provider postalCode Deletes a Self tax provider postalCode.

Parameters:

  • postal_code —

    The postal code being deleted.

  • tax_postal_code —

    tax postal code to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ultracart_api/api/tax_api.rb', line 232

def delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.delete_tax_provider_self_postal_code ...'
  end
  # verify the required parameter 'postal_code' is set
  if @api_client.config.client_side_validation && postal_code.nil?
    fail ArgumentError, "Missing the required parameter 'postal_code' when calling TaxApi.delete_tax_provider_self_postal_code"
  end
  # verify the required parameter 'tax_postal_code' is set
  if @api_client.config.client_side_validation && tax_postal_code.nil?
    fail ArgumentError, "Missing the required parameter 'tax_postal_code' when calling TaxApi.delete_tax_provider_self_postal_code"
  end
  # resource path
  local_var_path = '/tax/providers/self/postalCode/{postal_code}'.sub('{' + 'postal_code' + '}', postal_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_postal_code)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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: TaxApi#delete_tax_provider_self_postal_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tax_provider_self_state(state_code, tax_state, opts = {}) ⇒ nil

Deletes a Self tax provider state Deletes a Self tax provider state.

Parameters:

  • state_code —

    The state code being deleted.

  • tax_state —

    tax state to be deleted

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

    the optional parameters

Returns:

  • (nil) 


281
282
283
284
 
# File 'lib/ultracart_api/api/tax_api.rb', line 281

def delete_tax_provider_self_state(state_code, tax_state, opts = {})
  delete_tax_provider_self_state_with_http_info(state_code, tax_state, opts)
  nil
end

#delete_tax_provider_self_state_with_http_info(state_code, tax_state, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes a Self tax provider state Deletes a Self tax provider state.

Parameters:

  • state_code —

    The state code being deleted.

  • tax_state —

    tax state to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/ultracart_api/api/tax_api.rb', line 292

def delete_tax_provider_self_state_with_http_info(state_code, tax_state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.delete_tax_provider_self_state ...'
  end
  # verify the required parameter 'state_code' is set
  if @api_client.config.client_side_validation && state_code.nil?
    fail ArgumentError, "Missing the required parameter 'state_code' when calling TaxApi.delete_tax_provider_self_state"
  end
  # verify the required parameter 'tax_state' is set
  if @api_client.config.client_side_validation && tax_state.nil?
    fail ArgumentError, "Missing the required parameter 'tax_state' when calling TaxApi.delete_tax_provider_self_state"
  end
  # resource path
  local_var_path = '/tax/providers/self/state/{stateCode}'.sub('{' + 'stateCode' + '}', state_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_state)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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: TaxApi#delete_tax_provider_self_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_avalara(opts = {}) ⇒ TaxProviderAvalara

Retrieve the Avalara tax provider Retrieves the Avalara tax provider.

Parameters:

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

    the optional parameters

Returns:



339
340
341
342
 
# File 'lib/ultracart_api/api/tax_api.rb', line 339

def get_tax_provider_avalara(opts = {})
  data, _status_code, _headers = get_tax_provider_avalara_with_http_info(opts)
  data
end

#get_tax_provider_avalara_companies(tax_provider_avalara, opts = {}) ⇒ TaxProviderAvalaraCompaniesResult

Returns Avalara Tax companies configured by the merchant Returns Avalara Tax companies configured by the merchant

Parameters:

  • tax_provider_avalara —

    TaxProviderAvalara object

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

    the optional parameters

Returns:



389
390
391
392
 
# File 'lib/ultracart_api/api/tax_api.rb', line 389

def get_tax_provider_avalara_companies(tax_provider_avalara, opts = {})
  data, _status_code, _headers = get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara, opts)
  data
end

#get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara, opts = {}) ⇒ Array<(TaxProviderAvalaraCompaniesResult, Fixnum, Hash)>

Returns Avalara Tax companies configured by the merchant Returns Avalara Tax companies configured by the merchant

Parameters:

  • tax_provider_avalara —

    TaxProviderAvalara object

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

    the optional parameters

Returns:



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ultracart_api/api/tax_api.rb', line 399

def get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_avalara_companies ...'
  end
  # verify the required parameter 'tax_provider_avalara' is set
  if @api_client.config.client_side_validation && tax_provider_avalara.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_avalara' when calling TaxApi.get_tax_provider_avalara_companies"
  end
  # resource path
  local_var_path = '/tax/providers/avalara/companies'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_avalara)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderAvalaraCompaniesResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_avalara_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_avalara_test(opts = {}) ⇒ TaxProviderTestResult

Attempts to connect to Avalara and returns back the response Attempts to connect to Avalara and returns back the response.

Parameters:

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

    the optional parameters

Returns:



443
444
445
446
 
# File 'lib/ultracart_api/api/tax_api.rb', line 443

def get_tax_provider_avalara_test(opts = {})
  data, _status_code, _headers = get_tax_provider_avalara_test_with_http_info(opts)
  data
end

#get_tax_provider_avalara_test_with_http_info(opts = {}) ⇒ Array<(TaxProviderTestResult, Fixnum, Hash)>

Attempts to connect to Avalara and returns back the response Attempts to connect to Avalara and returns back the response.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderTestResult data, response status code and response headers



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/ultracart_api/api/tax_api.rb', line 452

def get_tax_provider_avalara_test_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_avalara_test ...'
  end
  # resource path
  local_var_path = '/tax/providers/avalara/test'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderTestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_avalara_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_avalara_with_http_info(opts = {}) ⇒ Array<(TaxProviderAvalara, Fixnum, Hash)>

Retrieve the Avalara tax provider Retrieves the Avalara tax provider.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderAvalara data, response status code and response headers



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
382
383
 
# File 'lib/ultracart_api/api/tax_api.rb', line 348

def get_tax_provider_avalara_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_avalara ...'
  end
  # resource path
  local_var_path = '/tax/providers/avalara'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderAvalara')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_avalara\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_self(opts = {}) ⇒ TaxProviderSelf

Retrieve the Self tax provider Retrieves the Self tax provider.

Parameters:

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

    the optional parameters

Returns:



492
493
494
495
 
# File 'lib/ultracart_api/api/tax_api.rb', line 492

def get_tax_provider_self(opts = {})
  data, _status_code, _headers = get_tax_provider_self_with_http_info(opts)
  data
end

#get_tax_provider_self_countries(opts = {}) ⇒ TaxProviderSelfCountriesResponse

Retrieve the Self tax provider countries Retrieves the Self tax provider countries.

Parameters:

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

    the optional parameters

Returns:



541
542
543
544
 
# File 'lib/ultracart_api/api/tax_api.rb', line 541

def get_tax_provider_self_countries(opts = {})
  data, _status_code, _headers = get_tax_provider_self_countries_with_http_info(opts)
  data
end

#get_tax_provider_self_countries_with_http_info(opts = {}) ⇒ Array<(TaxProviderSelfCountriesResponse, Fixnum, Hash)>

Retrieve the Self tax provider countries Retrieves the Self tax provider countries.

Parameters:

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

    the optional parameters

Returns:



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/ultracart_api/api/tax_api.rb', line 550

def get_tax_provider_self_countries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_self_countries ...'
  end
  # resource path
  local_var_path = '/tax/providers/self/countries'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSelfCountriesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_self_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_self_regions_by_country_code(country_code, opts = {}) ⇒ TaxProviderSelfRegionsResponse

Retrieve the Self tax provider regions for a given country code Retrieves the Self tax provider regions for a given country code.

Parameters:

  • country_code —

    The country code regions desired.

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

    the optional parameters

Returns:



591
592
593
594
 
# File 'lib/ultracart_api/api/tax_api.rb', line 591

def get_tax_provider_self_regions_by_country_code(country_code, opts = {})
  data, _status_code, _headers = get_tax_provider_self_regions_by_country_code_with_http_info(country_code, opts)
  data
end

#get_tax_provider_self_regions_by_country_code_with_http_info(country_code, opts = {}) ⇒ Array<(TaxProviderSelfRegionsResponse, Fixnum, Hash)>

Retrieve the Self tax provider regions for a given country code Retrieves the Self tax provider regions for a given country code.

Parameters:

  • country_code —

    The country code regions desired.

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

    the optional parameters

Returns:



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/ultracart_api/api/tax_api.rb', line 601

def get_tax_provider_self_regions_by_country_code_with_http_info(country_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_self_regions_by_country_code ...'
  end
  # verify the required parameter 'country_code' is set
  if @api_client.config.client_side_validation && country_code.nil?
    fail ArgumentError, "Missing the required parameter 'country_code' when calling TaxApi.get_tax_provider_self_regions_by_country_code"
  end
  # resource path
  local_var_path = '/tax/providers/self/regions/{countryCode}'.sub('{' + 'countryCode' + '}', country_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSelfRegionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_self_regions_by_country_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_self_with_http_info(opts = {}) ⇒ Array<(TaxProviderSelf, Fixnum, Hash)>

Retrieve the Self tax provider Retrieves the Self tax provider.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderSelf data, response status code and response headers



501
502
503
504
505
506
507
508
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
 
# File 'lib/ultracart_api/api/tax_api.rb', line 501

def get_tax_provider_self_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_self ...'
  end
  # resource path
  local_var_path = '/tax/providers/self'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSelf')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_sovos(opts = {}) ⇒ TaxProviderSovos

Retrieve the Sovos tax provider Retrieves the Sovos tax provider.

Parameters:

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

    the optional parameters

Returns:



645
646
647
648
 
# File 'lib/ultracart_api/api/tax_api.rb', line 645

def get_tax_provider_sovos(opts = {})
  data, _status_code, _headers = get_tax_provider_sovos_with_http_info(opts)
  data
end

#get_tax_provider_sovos_test(opts = {}) ⇒ TaxProviderTestResult

Attempts to connect to Sovos and returns back the response Attempts to connect to Sovos and returns back the response.

Parameters:

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

    the optional parameters

Returns:



694
695
696
697
 
# File 'lib/ultracart_api/api/tax_api.rb', line 694

def get_tax_provider_sovos_test(opts = {})
  data, _status_code, _headers = get_tax_provider_sovos_test_with_http_info(opts)
  data
end

#get_tax_provider_sovos_test_with_http_info(opts = {}) ⇒ Array<(TaxProviderTestResult, Fixnum, Hash)>

Attempts to connect to Sovos and returns back the response Attempts to connect to Sovos and returns back the response.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderTestResult 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
 
# File 'lib/ultracart_api/api/tax_api.rb', line 703

def get_tax_provider_sovos_test_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_sovos_test ...'
  end
  # resource path
  local_var_path = '/tax/providers/sovos/test'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderTestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_sovos_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_sovos_with_http_info(opts = {}) ⇒ Array<(TaxProviderSovos, Fixnum, Hash)>

Retrieve the Sovos tax provider Retrieves the Sovos tax provider.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderSovos data, response status code and response headers



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/ultracart_api/api/tax_api.rb', line 654

def get_tax_provider_sovos_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_sovos ...'
  end
  # resource path
  local_var_path = '/tax/providers/sovos'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSovos')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_sovos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_tax_jar(opts = {}) ⇒ TaxProviderTaxJar

Retrieve the TaxJar tax provider Retrieves the TaxJar tax provider.

Parameters:

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

    the optional parameters

Returns:



743
744
745
746
 
# File 'lib/ultracart_api/api/tax_api.rb', line 743

def get_tax_provider_tax_jar(opts = {})
  data, _status_code, _headers = get_tax_provider_tax_jar_with_http_info(opts)
  data
end

#get_tax_provider_tax_jar_test(opts = {}) ⇒ TaxProviderTestResult

Attempts to connect to TaxJar and returns back the response Attempts to connect to TaxJar and returns back the response.

Parameters:

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

    the optional parameters

Returns:



792
793
794
795
 
# File 'lib/ultracart_api/api/tax_api.rb', line 792

def get_tax_provider_tax_jar_test(opts = {})
  data, _status_code, _headers = get_tax_provider_tax_jar_test_with_http_info(opts)
  data
end

#get_tax_provider_tax_jar_test_with_http_info(opts = {}) ⇒ Array<(TaxProviderTestResult, Fixnum, Hash)>

Attempts to connect to TaxJar and returns back the response Attempts to connect to TaxJar and returns back the response.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderTestResult data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/tax_api.rb', line 801

def get_tax_provider_tax_jar_test_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_tax_jar_test ...'
  end
  # resource path
  local_var_path = '/tax/providers/taxjar/test'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderTestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_tax_jar_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_tax_jar_with_http_info(opts = {}) ⇒ Array<(TaxProviderTaxJar, Fixnum, Hash)>

Retrieve the TaxJar tax provider Retrieves the TaxJar tax provider.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderTaxJar data, response status code and response headers



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
783
784
785
786
787
 
# File 'lib/ultracart_api/api/tax_api.rb', line 752

def get_tax_provider_tax_jar_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_tax_jar ...'
  end
  # resource path
  local_var_path = '/tax/providers/taxjar'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderTaxJar')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_tax_jar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_provider_ultra_cart(opts = {}) ⇒ TaxProviderUltraCart

Retrieve the UltraCart tax provider Retrieves the UltraCart tax provider.

Parameters:

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

    the optional parameters

Returns:



841
842
843
844
 
# File 'lib/ultracart_api/api/tax_api.rb', line 841

def get_tax_provider_ultra_cart(opts = {})
  data, _status_code, _headers = get_tax_provider_ultra_cart_with_http_info(opts)
  data
end

#get_tax_provider_ultra_cart_with_http_info(opts = {}) ⇒ Array<(TaxProviderUltraCart, Fixnum, Hash)>

Retrieve the UltraCart tax provider Retrieves the UltraCart tax provider.

Parameters:

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

    the optional parameters

Returns:

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

    TaxProviderUltraCart data, response status code and response headers



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/ultracart_api/api/tax_api.rb', line 850

def get_tax_provider_ultra_cart_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_ultra_cart ...'
  end
  # resource path
  local_var_path = '/tax/providers/ultracart'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderUltraCart')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_provider_ultra_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tax_providers(opts = {}) ⇒ TaxProvidersResponse

Retrieve tax methods Retrieves tax methods for this account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:



893
894
895
896
 
# File 'lib/ultracart_api/api/tax_api.rb', line 893

def get_tax_providers(opts = {})
  data, _status_code, _headers = get_tax_providers_with_http_info(opts)
  data
end

#get_tax_providers_with_http_info(opts = {}) ⇒ Array<(TaxProvidersResponse, Fixnum, Hash)>

Retrieve tax methods Retrieves tax methods for this account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Max 200)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:

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

    TaxProvidersResponse data, response status code and response headers



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/ultracart_api/api/tax_api.rb', line 905

def get_tax_providers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.get_tax_providers ...'
  end
  # resource path
  local_var_path = '/tax/providers'

  # query parameters
  query_params = {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProvidersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#get_tax_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_active_tax_provider(provider_name, opts = {}) ⇒ TaxProviderActivateResult

Toggle a tax provider to active Toggle a tax provider to active.

Parameters:

  • provider_name —

    The tax provider to set active.

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

    the optional parameters

Returns:



949
950
951
952
 
# File 'lib/ultracart_api/api/tax_api.rb', line 949

def set_active_tax_provider(provider_name, opts = {})
  data, _status_code, _headers = set_active_tax_provider_with_http_info(provider_name, opts)
  data
end

#set_active_tax_provider_with_http_info(provider_name, opts = {}) ⇒ Array<(TaxProviderActivateResult, Fixnum, Hash)>

Toggle a tax provider to active Toggle a tax provider to active.

Parameters:

  • provider_name —

    The tax provider to set active.

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

    the optional parameters

Returns:

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

    TaxProviderActivateResult data, response status code and response headers



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/ultracart_api/api/tax_api.rb', line 959

def set_active_tax_provider_with_http_info(provider_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.set_active_tax_provider ...'
  end
  # verify the required parameter 'provider_name' is set
  if @api_client.config.client_side_validation && provider_name.nil?
    fail ArgumentError, "Missing the required parameter 'provider_name' when calling TaxApi.set_active_tax_provider"
  end
  # resource path
  local_var_path = '/tax/providers/setActive/{providerName}'.sub('{' + 'providerName' + '}', provider_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderActivateResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#set_active_tax_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_avalara(tax_provider_avalara, opts = {}) ⇒ TaxProviderAvalara

Update the Avalara tax provider Update the Avalara tax provider.

Parameters:

  • tax_provider_avalara —

    TaxProviderAvalara object

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

    the optional parameters

Returns:



1004
1005
1006
1007
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1004

def update_tax_provider_avalara(tax_provider_avalara, opts = {})
  data, _status_code, _headers = update_tax_provider_avalara_with_http_info(tax_provider_avalara, opts)
  data
end

#update_tax_provider_avalara_with_http_info(tax_provider_avalara, opts = {}) ⇒ Array<(TaxProviderAvalara, Fixnum, Hash)>

Update the Avalara tax provider Update the Avalara tax provider.

Parameters:

  • tax_provider_avalara —

    TaxProviderAvalara object

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

    the optional parameters

Returns:

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

    TaxProviderAvalara data, response status code and response headers



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1014

def update_tax_provider_avalara_with_http_info(tax_provider_avalara, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_avalara ...'
  end
  # verify the required parameter 'tax_provider_avalara' is set
  if @api_client.config.client_side_validation && tax_provider_avalara.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_avalara' when calling TaxApi.update_tax_provider_avalara"
  end
  # resource path
  local_var_path = '/tax/providers/avalara'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_avalara)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderAvalara')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_avalara\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self(tax_provider_self, opts = {}) ⇒ TaxProviderSelf

Update the Self tax provider Update the Self tax provider.

Parameters:

  • tax_provider_self —

    TaxProviderSelf object

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

    the optional parameters

Returns:



1059
1060
1061
1062
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1059

def update_tax_provider_self(tax_provider_self, opts = {})
  data, _status_code, _headers = update_tax_provider_self_with_http_info(tax_provider_self, opts)
  data
end

#update_tax_provider_self_city(city, tax_city, opts = {}) ⇒ TaxCity

Updates a Self tax provider city Updates a Self tax provider city.

Parameters:

  • city —

    The city being updated.

  • tax_city —

    tax city to be updated

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

    the optional parameters

Returns:



1115
1116
1117
1118
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1115

def update_tax_provider_self_city(city, tax_city, opts = {})
  data, _status_code, _headers = update_tax_provider_self_city_with_http_info(city, tax_city, opts)
  data
end

#update_tax_provider_self_city_with_http_info(city, tax_city, opts = {}) ⇒ Array<(TaxCity, Fixnum, Hash)>

Updates a Self tax provider city Updates a Self tax provider city.

Parameters:

  • city —

    The city being updated.

  • tax_city —

    tax city to be updated

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

    the optional parameters

Returns:

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

    TaxCity data, response status code and response headers



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1126

def update_tax_provider_self_city_with_http_info(city, tax_city, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self_city ...'
  end
  # verify the required parameter 'city' is set
  if @api_client.config.client_side_validation && city.nil?
    fail ArgumentError, "Missing the required parameter 'city' when calling TaxApi.update_tax_provider_self_city"
  end
  # verify the required parameter 'tax_city' is set
  if @api_client.config.client_side_validation && tax_city.nil?
    fail ArgumentError, "Missing the required parameter 'tax_city' when calling TaxApi.update_tax_provider_self_city"
  end
  # resource path
  local_var_path = '/tax/providers/self/city/{city}'.sub('{' + 'city' + '}', city.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_city)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxCity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self_city\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self_country(country_code, tax_country, opts = {}) ⇒ TaxCountry

Updates a Self tax provider country Updates a Self tax provider country.

Parameters:

  • country_code —

    The country code being updated.

  • tax_country —

    tax country to be updated

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

    the optional parameters

Returns:



1176
1177
1178
1179
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1176

def update_tax_provider_self_country(country_code, tax_country, opts = {})
  data, _status_code, _headers = update_tax_provider_self_country_with_http_info(country_code, tax_country, opts)
  data
end

#update_tax_provider_self_country_with_http_info(country_code, tax_country, opts = {}) ⇒ Array<(TaxCountry, Fixnum, Hash)>

Updates a Self tax provider country Updates a Self tax provider country.

Parameters:

  • country_code —

    The country code being updated.

  • tax_country —

    tax country to be updated

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

    the optional parameters

Returns:

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

    TaxCountry data, response status code and response headers



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1187

def update_tax_provider_self_country_with_http_info(country_code, tax_country, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self_country ...'
  end
  # verify the required parameter 'country_code' is set
  if @api_client.config.client_side_validation && country_code.nil?
    fail ArgumentError, "Missing the required parameter 'country_code' when calling TaxApi.update_tax_provider_self_country"
  end
  # verify the required parameter 'tax_country' is set
  if @api_client.config.client_side_validation && tax_country.nil?
    fail ArgumentError, "Missing the required parameter 'tax_country' when calling TaxApi.update_tax_provider_self_country"
  end
  # resource path
  local_var_path = '/tax/providers/self/country/{countryCode}'.sub('{' + 'countryCode' + '}', country_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_country)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxCountry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self_country\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self_county(county, tax_county, opts = {}) ⇒ TaxCounty

Updates a Self tax provider county Updates a Self tax provider county.

Parameters:

  • county —

    The county being updated.

  • tax_county —

    tax county to be updated

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

    the optional parameters

Returns:



1237
1238
1239
1240
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1237

def update_tax_provider_self_county(county, tax_county, opts = {})
  data, _status_code, _headers = update_tax_provider_self_county_with_http_info(county, tax_county, opts)
  data
end

#update_tax_provider_self_county_with_http_info(county, tax_county, opts = {}) ⇒ Array<(TaxCounty, Fixnum, Hash)>

Updates a Self tax provider county Updates a Self tax provider county.

Parameters:

  • county —

    The county being updated.

  • tax_county —

    tax county to be updated

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

    the optional parameters

Returns:

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

    TaxCounty data, response status code and response headers



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1248

def update_tax_provider_self_county_with_http_info(county, tax_county, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self_county ...'
  end
  # verify the required parameter 'county' is set
  if @api_client.config.client_side_validation && county.nil?
    fail ArgumentError, "Missing the required parameter 'county' when calling TaxApi.update_tax_provider_self_county"
  end
  # verify the required parameter 'tax_county' is set
  if @api_client.config.client_side_validation && tax_county.nil?
    fail ArgumentError, "Missing the required parameter 'tax_county' when calling TaxApi.update_tax_provider_self_county"
  end
  # resource path
  local_var_path = '/tax/providers/self/county/{county}'.sub('{' + 'county' + '}', county.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_county)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxCounty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self_county\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self_postal_code(postal_code, tax_postal_code, opts = {}) ⇒ TaxPostalCode

Updates a Self tax provider postalCode Updates a Self tax provider postalCode.

Parameters:

  • postal_code —

    The postal code being updated.

  • tax_postal_code —

    tax postal code to be updated

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

    the optional parameters

Returns:



1298
1299
1300
1301
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1298

def update_tax_provider_self_postal_code(postal_code, tax_postal_code, opts = {})
  data, _status_code, _headers = update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts)
  data
end

#update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts = {}) ⇒ Array<(TaxPostalCode, Fixnum, Hash)>

Updates a Self tax provider postalCode Updates a Self tax provider postalCode.

Parameters:

  • postal_code —

    The postal code being updated.

  • tax_postal_code —

    tax postal code to be updated

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

    the optional parameters

Returns:

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

    TaxPostalCode data, response status code and response headers



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1309

def update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self_postal_code ...'
  end
  # verify the required parameter 'postal_code' is set
  if @api_client.config.client_side_validation && postal_code.nil?
    fail ArgumentError, "Missing the required parameter 'postal_code' when calling TaxApi.update_tax_provider_self_postal_code"
  end
  # verify the required parameter 'tax_postal_code' is set
  if @api_client.config.client_side_validation && tax_postal_code.nil?
    fail ArgumentError, "Missing the required parameter 'tax_postal_code' when calling TaxApi.update_tax_provider_self_postal_code"
  end
  # resource path
  local_var_path = '/tax/providers/self/postalCode/{postal_code}'.sub('{' + 'postal_code' + '}', postal_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_postal_code)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxPostalCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self_postal_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self_state(state_code, tax_state, opts = {}) ⇒ TaxState

Updates a Self tax provider state Updates a Self tax provider state.

Parameters:

  • state_code —

    The state code being updated.

  • tax_state —

    tax state to be updated

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

    the optional parameters

Returns:



1359
1360
1361
1362
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1359

def update_tax_provider_self_state(state_code, tax_state, opts = {})
  data, _status_code, _headers = update_tax_provider_self_state_with_http_info(state_code, tax_state, opts)
  data
end

#update_tax_provider_self_state_with_http_info(state_code, tax_state, opts = {}) ⇒ Array<(TaxState, Fixnum, Hash)>

Updates a Self tax provider state Updates a Self tax provider state.

Parameters:

  • state_code —

    The state code being updated.

  • tax_state —

    tax state to be updated

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

    the optional parameters

Returns:

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

    TaxState data, response status code and response headers



1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1370

def update_tax_provider_self_state_with_http_info(state_code, tax_state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self_state ...'
  end
  # verify the required parameter 'state_code' is set
  if @api_client.config.client_side_validation && state_code.nil?
    fail ArgumentError, "Missing the required parameter 'state_code' when calling TaxApi.update_tax_provider_self_state"
  end
  # verify the required parameter 'tax_state' is set
  if @api_client.config.client_side_validation && tax_state.nil?
    fail ArgumentError, "Missing the required parameter 'tax_state' when calling TaxApi.update_tax_provider_self_state"
  end
  # resource path
  local_var_path = '/tax/providers/self/state/{stateCode}'.sub('{' + 'stateCode' + '}', state_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_state)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxState')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_self_with_http_info(tax_provider_self, opts = {}) ⇒ Array<(TaxProviderSelf, Fixnum, Hash)>

Update the Self tax provider Update the Self tax provider.

Parameters:

  • tax_provider_self —

    TaxProviderSelf object

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

    the optional parameters

Returns:

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

    TaxProviderSelf data, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1069

def update_tax_provider_self_with_http_info(tax_provider_self, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_self ...'
  end
  # verify the required parameter 'tax_provider_self' is set
  if @api_client.config.client_side_validation && tax_provider_self.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_self' when calling TaxApi.update_tax_provider_self"
  end
  # resource path
  local_var_path = '/tax/providers/self'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_self)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSelf')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_sovos(tax_provider_sovos, opts = {}) ⇒ TaxProviderSovos

Update the Sovos tax provider Update the Sovos tax provider.

Parameters:

  • tax_provider_sovos —

    TaxProviderSovos object

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

    the optional parameters

Returns:



1419
1420
1421
1422
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1419

def update_tax_provider_sovos(tax_provider_sovos, opts = {})
  data, _status_code, _headers = update_tax_provider_sovos_with_http_info(tax_provider_sovos, opts)
  data
end

#update_tax_provider_sovos_with_http_info(tax_provider_sovos, opts = {}) ⇒ Array<(TaxProviderSovos, Fixnum, Hash)>

Update the Sovos tax provider Update the Sovos tax provider.

Parameters:

  • tax_provider_sovos —

    TaxProviderSovos object

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

    the optional parameters

Returns:

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

    TaxProviderSovos data, response status code and response headers



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1429

def update_tax_provider_sovos_with_http_info(tax_provider_sovos, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_sovos ...'
  end
  # verify the required parameter 'tax_provider_sovos' is set
  if @api_client.config.client_side_validation && tax_provider_sovos.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_sovos' when calling TaxApi.update_tax_provider_sovos"
  end
  # resource path
  local_var_path = '/tax/providers/sovos'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_sovos)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderSovos')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_sovos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_tax_jar(tax_provider_tax_jar, opts = {}) ⇒ TaxProviderTaxJar

Update the TaxJar tax provider Update the TaxJar tax provider.

Parameters:

  • tax_provider_tax_jar —

    TaxProviderTaxJar object

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

    the optional parameters

Returns:



1474
1475
1476
1477
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1474

def update_tax_provider_tax_jar(tax_provider_tax_jar, opts = {})
  data, _status_code, _headers = update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar, opts)
  data
end

#update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar, opts = {}) ⇒ Array<(TaxProviderTaxJar, Fixnum, Hash)>

Update the TaxJar tax provider Update the TaxJar tax provider.

Parameters:

  • tax_provider_tax_jar —

    TaxProviderTaxJar object

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

    the optional parameters

Returns:

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

    TaxProviderTaxJar data, response status code and response headers



1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1484

def update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_tax_jar ...'
  end
  # verify the required parameter 'tax_provider_tax_jar' is set
  if @api_client.config.client_side_validation && tax_provider_tax_jar.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_tax_jar' when calling TaxApi.update_tax_provider_tax_jar"
  end
  # resource path
  local_var_path = '/tax/providers/taxjar'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_tax_jar)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderTaxJar')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_tax_jar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tax_provider_ultra_cart(tax_provider_ultracart, opts = {}) ⇒ TaxProviderUltraCart

Update the UltraCart tax provider Update the UltraCart tax provider.

Parameters:

  • tax_provider_ultracart —

    TaxProviderUltraCart object

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

    the optional parameters

Returns:



1529
1530
1531
1532
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1529

def update_tax_provider_ultra_cart(tax_provider_ultracart, opts = {})
  data, _status_code, _headers = update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart, opts)
  data
end

#update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart, opts = {}) ⇒ Array<(TaxProviderUltraCart, Fixnum, Hash)>

Update the UltraCart tax provider Update the UltraCart tax provider.

Parameters:

  • tax_provider_ultracart —

    TaxProviderUltraCart object

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

    the optional parameters

Returns:

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

    TaxProviderUltraCart data, response status code and response headers



1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
 
# File 'lib/ultracart_api/api/tax_api.rb', line 1539

def update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_ultra_cart ...'
  end
  # verify the required parameter 'tax_provider_ultracart' is set
  if @api_client.config.client_side_validation && tax_provider_ultracart.nil?
    fail ArgumentError, "Missing the required parameter 'tax_provider_ultracart' when calling TaxApi.update_tax_provider_ultra_cart"
  end
  # resource path
  local_var_path = '/tax/providers/ultracart'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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_provider_ultracart)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  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 => 'TaxProviderUltraCart')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaxApi#update_tax_provider_ultra_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end