ultracart_api 4.1.12 → 4.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/TaxApi.md CHANGED
@@ -1,2017 +1,1541 @@
1
- # UltracartClient::TaxApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**delete_tax_provider_self_city**](TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city |
8
- | [**delete_tax_provider_self_country**](TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country |
9
- | [**delete_tax_provider_self_county**](TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county |
10
- | [**delete_tax_provider_self_postal_code**](TaxApi.md#delete_tax_provider_self_postal_code) | **DELETE** /tax/providers/self/postalCode/{postal_code} | Deletes a Self tax provider postalCode |
11
- | [**delete_tax_provider_self_state**](TaxApi.md#delete_tax_provider_self_state) | **DELETE** /tax/providers/self/state/{stateCode} | Deletes a Self tax provider state |
12
- | [**get_tax_provider_avalara**](TaxApi.md#get_tax_provider_avalara) | **GET** /tax/providers/avalara | Retrieve the Avalara tax provider |
13
- | [**get_tax_provider_avalara_companies**](TaxApi.md#get_tax_provider_avalara_companies) | **POST** /tax/providers/avalara/companies | Returns Avalara Tax companies configured by the merchant |
14
- | [**get_tax_provider_avalara_test**](TaxApi.md#get_tax_provider_avalara_test) | **GET** /tax/providers/avalara/test | Attempts to connect to Avalara and returns back the response |
15
- | [**get_tax_provider_self**](TaxApi.md#get_tax_provider_self) | **GET** /tax/providers/self | Retrieve the Self tax provider |
16
- | [**get_tax_provider_self_countries**](TaxApi.md#get_tax_provider_self_countries) | **GET** /tax/providers/self/countries | Retrieve the Self tax provider countries |
17
- | [**get_tax_provider_self_regions_by_country_code**](TaxApi.md#get_tax_provider_self_regions_by_country_code) | **GET** /tax/providers/self/regions/{countryCode} | Retrieve the Self tax provider regions for a given country code |
18
- | [**get_tax_provider_sovos**](TaxApi.md#get_tax_provider_sovos) | **GET** /tax/providers/sovos | Retrieve the Sovos tax provider |
19
- | [**get_tax_provider_sovos_test**](TaxApi.md#get_tax_provider_sovos_test) | **GET** /tax/providers/sovos/test | Attempts to connect to Sovos and returns back the response |
20
- | [**get_tax_provider_tax_jar**](TaxApi.md#get_tax_provider_tax_jar) | **GET** /tax/providers/taxjar | Retrieve the TaxJar tax provider |
21
- | [**get_tax_provider_tax_jar_test**](TaxApi.md#get_tax_provider_tax_jar_test) | **GET** /tax/providers/taxjar/test | Attempts to connect to TaxJar and returns back the response |
22
- | [**get_tax_provider_ultra_cart**](TaxApi.md#get_tax_provider_ultra_cart) | **GET** /tax/providers/ultracart | Retrieve the UltraCart tax provider |
23
- | [**get_tax_providers**](TaxApi.md#get_tax_providers) | **GET** /tax/providers | Retrieve tax methods |
24
- | [**set_active_tax_provider**](TaxApi.md#set_active_tax_provider) | **POST** /tax/providers/setActive/{providerName} | Toggle a tax provider to active |
25
- | [**update_tax_provider_avalara**](TaxApi.md#update_tax_provider_avalara) | **POST** /tax/providers/avalara | Update the Avalara tax provider |
26
- | [**update_tax_provider_self**](TaxApi.md#update_tax_provider_self) | **POST** /tax/providers/self | Update the Self tax provider |
27
- | [**update_tax_provider_self_city**](TaxApi.md#update_tax_provider_self_city) | **POST** /tax/providers/self/city/{city} | Updates a Self tax provider city |
28
- | [**update_tax_provider_self_country**](TaxApi.md#update_tax_provider_self_country) | **POST** /tax/providers/self/country/{countryCode} | Updates a Self tax provider country |
29
- | [**update_tax_provider_self_county**](TaxApi.md#update_tax_provider_self_county) | **POST** /tax/providers/self/county/{county} | Updates a Self tax provider county |
30
- | [**update_tax_provider_self_postal_code**](TaxApi.md#update_tax_provider_self_postal_code) | **POST** /tax/providers/self/postalCode/{postal_code} | Updates a Self tax provider postalCode |
31
- | [**update_tax_provider_self_state**](TaxApi.md#update_tax_provider_self_state) | **POST** /tax/providers/self/state/{stateCode} | Updates a Self tax provider state |
32
- | [**update_tax_provider_sovos**](TaxApi.md#update_tax_provider_sovos) | **POST** /tax/providers/sovos | Update the Sovos tax provider |
33
- | [**update_tax_provider_tax_jar**](TaxApi.md#update_tax_provider_tax_jar) | **POST** /tax/providers/taxjar | Update the TaxJar tax provider |
34
- | [**update_tax_provider_ultra_cart**](TaxApi.md#update_tax_provider_ultra_cart) | **POST** /tax/providers/ultracart | Update the UltraCart tax provider |
35
-
36
-
37
- ## delete_tax_provider_self_city
38
-
39
- > delete_tax_provider_self_city(city, tax_city)
40
-
41
- Deletes a Self tax provider city
42
-
43
- Deletes a Self tax provider city.
44
-
45
- ### Examples
46
-
47
- ```ruby
48
- require 'time'
49
- require 'ultracart_api'
50
- require 'json'
51
- require 'yaml'
52
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
53
-
54
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
55
- # As such, this might not be the best way to use this object.
56
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
57
-
58
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
59
- city = 'city_example' # String | The city being deleted.
60
- tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be deleted
61
-
62
- begin
63
- # Deletes a Self tax provider city
64
- api_instance.delete_tax_provider_self_city(city, tax_city)
65
- rescue UltracartClient::ApiError => e
66
- puts "Error when calling TaxApi->delete_tax_provider_self_city: #{e}"
67
- end
68
- ```
69
-
70
- #### Using the delete_tax_provider_self_city_with_http_info variant
71
-
72
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
73
-
74
- > <Array(nil, Integer, Hash)> delete_tax_provider_self_city_with_http_info(city, tax_city)
75
-
76
- ```ruby
77
- begin
78
- # Deletes a Self tax provider city
79
- data, status_code, headers = api_instance.delete_tax_provider_self_city_with_http_info(city, tax_city)
80
- p status_code # => 2xx
81
- p headers # => { ... }
82
- p data # => nil
83
- rescue UltracartClient::ApiError => e
84
- puts "Error when calling TaxApi->delete_tax_provider_self_city_with_http_info: #{e}"
85
- end
86
- ```
87
-
88
- ### Parameters
89
-
90
- | Name | Type | Description | Notes |
91
- | ---- | ---- | ----------- | ----- |
92
- | **city** | **String** | The city being deleted. | |
93
- | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be deleted | |
94
-
95
- ### Return type
96
-
97
- nil (empty response body)
98
-
99
- ### Authorization
100
-
101
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
102
-
103
- ### HTTP request headers
104
-
105
- - **Content-Type**: application/json
106
- - **Accept**: application/json
107
-
108
-
109
- ## delete_tax_provider_self_country
110
-
111
- > delete_tax_provider_self_country(country_code, tax_country)
112
-
113
- Deletes a Self tax provider country
114
-
115
- Deletes a Self tax provider country.
116
-
117
- ### Examples
118
-
119
- ```ruby
120
- require 'time'
121
- require 'ultracart_api'
122
- require 'json'
123
- require 'yaml'
124
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
125
-
126
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
127
- # As such, this might not be the best way to use this object.
128
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
129
-
130
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
131
- country_code = 'country_code_example' # String | The country code being deleted.
132
- tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be deleted
133
-
134
- begin
135
- # Deletes a Self tax provider country
136
- api_instance.delete_tax_provider_self_country(country_code, tax_country)
137
- rescue UltracartClient::ApiError => e
138
- puts "Error when calling TaxApi->delete_tax_provider_self_country: #{e}"
139
- end
140
- ```
141
-
142
- #### Using the delete_tax_provider_self_country_with_http_info variant
143
-
144
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
145
-
146
- > <Array(nil, Integer, Hash)> delete_tax_provider_self_country_with_http_info(country_code, tax_country)
147
-
148
- ```ruby
149
- begin
150
- # Deletes a Self tax provider country
151
- data, status_code, headers = api_instance.delete_tax_provider_self_country_with_http_info(country_code, tax_country)
152
- p status_code # => 2xx
153
- p headers # => { ... }
154
- p data # => nil
155
- rescue UltracartClient::ApiError => e
156
- puts "Error when calling TaxApi->delete_tax_provider_self_country_with_http_info: #{e}"
157
- end
158
- ```
159
-
160
- ### Parameters
161
-
162
- | Name | Type | Description | Notes |
163
- | ---- | ---- | ----------- | ----- |
164
- | **country_code** | **String** | The country code being deleted. | |
165
- | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be deleted | |
166
-
167
- ### Return type
168
-
169
- nil (empty response body)
170
-
171
- ### Authorization
172
-
173
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
174
-
175
- ### HTTP request headers
176
-
177
- - **Content-Type**: application/json
178
- - **Accept**: application/json
179
-
180
-
181
- ## delete_tax_provider_self_county
182
-
183
- > delete_tax_provider_self_county(county, tax_county)
184
-
185
- Deletes a Self tax provider county
186
-
187
- Deletes a Self tax provider county.
188
-
189
- ### Examples
190
-
191
- ```ruby
192
- require 'time'
193
- require 'ultracart_api'
194
- require 'json'
195
- require 'yaml'
196
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
197
-
198
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
199
- # As such, this might not be the best way to use this object.
200
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
201
-
202
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
203
- county = 'county_example' # String | The county being deleted.
204
- tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be deleted
205
-
206
- begin
207
- # Deletes a Self tax provider county
208
- api_instance.delete_tax_provider_self_county(county, tax_county)
209
- rescue UltracartClient::ApiError => e
210
- puts "Error when calling TaxApi->delete_tax_provider_self_county: #{e}"
211
- end
212
- ```
213
-
214
- #### Using the delete_tax_provider_self_county_with_http_info variant
215
-
216
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
217
-
218
- > <Array(nil, Integer, Hash)> delete_tax_provider_self_county_with_http_info(county, tax_county)
219
-
220
- ```ruby
221
- begin
222
- # Deletes a Self tax provider county
223
- data, status_code, headers = api_instance.delete_tax_provider_self_county_with_http_info(county, tax_county)
224
- p status_code # => 2xx
225
- p headers # => { ... }
226
- p data # => nil
227
- rescue UltracartClient::ApiError => e
228
- puts "Error when calling TaxApi->delete_tax_provider_self_county_with_http_info: #{e}"
229
- end
230
- ```
231
-
232
- ### Parameters
233
-
234
- | Name | Type | Description | Notes |
235
- | ---- | ---- | ----------- | ----- |
236
- | **county** | **String** | The county being deleted. | |
237
- | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be deleted | |
238
-
239
- ### Return type
240
-
241
- nil (empty response body)
242
-
243
- ### Authorization
244
-
245
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
246
-
247
- ### HTTP request headers
248
-
249
- - **Content-Type**: application/json
250
- - **Accept**: application/json
251
-
252
-
253
- ## delete_tax_provider_self_postal_code
254
-
255
- > delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
256
-
257
- Deletes a Self tax provider postalCode
258
-
259
- Deletes a Self tax provider postalCode.
260
-
261
- ### Examples
262
-
263
- ```ruby
264
- require 'time'
265
- require 'ultracart_api'
266
- require 'json'
267
- require 'yaml'
268
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
269
-
270
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
271
- # As such, this might not be the best way to use this object.
272
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
273
-
274
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
275
- postal_code = 'postal_code_example' # String | The postal code being deleted.
276
- tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be deleted
277
-
278
- begin
279
- # Deletes a Self tax provider postalCode
280
- api_instance.delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
281
- rescue UltracartClient::ApiError => e
282
- puts "Error when calling TaxApi->delete_tax_provider_self_postal_code: #{e}"
283
- end
284
- ```
285
-
286
- #### Using the delete_tax_provider_self_postal_code_with_http_info variant
287
-
288
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
289
-
290
- > <Array(nil, Integer, Hash)> delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
291
-
292
- ```ruby
293
- begin
294
- # Deletes a Self tax provider postalCode
295
- data, status_code, headers = api_instance.delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
296
- p status_code # => 2xx
297
- p headers # => { ... }
298
- p data # => nil
299
- rescue UltracartClient::ApiError => e
300
- puts "Error when calling TaxApi->delete_tax_provider_self_postal_code_with_http_info: #{e}"
301
- end
302
- ```
303
-
304
- ### Parameters
305
-
306
- | Name | Type | Description | Notes |
307
- | ---- | ---- | ----------- | ----- |
308
- | **postal_code** | **String** | The postal code being deleted. | |
309
- | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be deleted | |
310
-
311
- ### Return type
312
-
313
- nil (empty response body)
314
-
315
- ### Authorization
316
-
317
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
318
-
319
- ### HTTP request headers
320
-
321
- - **Content-Type**: application/json
322
- - **Accept**: application/json
323
-
324
-
325
- ## delete_tax_provider_self_state
326
-
327
- > delete_tax_provider_self_state(state_code, tax_state)
328
-
329
- Deletes a Self tax provider state
330
-
331
- Deletes a Self tax provider state.
332
-
333
- ### Examples
334
-
335
- ```ruby
336
- require 'time'
337
- require 'ultracart_api'
338
- require 'json'
339
- require 'yaml'
340
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
341
-
342
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
343
- # As such, this might not be the best way to use this object.
344
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
345
-
346
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
347
- state_code = 'state_code_example' # String | The state code being deleted.
348
- tax_state = UltracartClient::TaxState.new # TaxState | tax state to be deleted
349
-
350
- begin
351
- # Deletes a Self tax provider state
352
- api_instance.delete_tax_provider_self_state(state_code, tax_state)
353
- rescue UltracartClient::ApiError => e
354
- puts "Error when calling TaxApi->delete_tax_provider_self_state: #{e}"
355
- end
356
- ```
357
-
358
- #### Using the delete_tax_provider_self_state_with_http_info variant
359
-
360
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
361
-
362
- > <Array(nil, Integer, Hash)> delete_tax_provider_self_state_with_http_info(state_code, tax_state)
363
-
364
- ```ruby
365
- begin
366
- # Deletes a Self tax provider state
367
- data, status_code, headers = api_instance.delete_tax_provider_self_state_with_http_info(state_code, tax_state)
368
- p status_code # => 2xx
369
- p headers # => { ... }
370
- p data # => nil
371
- rescue UltracartClient::ApiError => e
372
- puts "Error when calling TaxApi->delete_tax_provider_self_state_with_http_info: #{e}"
373
- end
374
- ```
375
-
376
- ### Parameters
377
-
378
- | Name | Type | Description | Notes |
379
- | ---- | ---- | ----------- | ----- |
380
- | **state_code** | **String** | The state code being deleted. | |
381
- | **tax_state** | [**TaxState**](TaxState.md) | tax state to be deleted | |
382
-
383
- ### Return type
384
-
385
- nil (empty response body)
386
-
387
- ### Authorization
388
-
389
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
390
-
391
- ### HTTP request headers
392
-
393
- - **Content-Type**: application/json
394
- - **Accept**: application/json
395
-
396
-
397
- ## get_tax_provider_avalara
398
-
399
- > <TaxProviderAvalara> get_tax_provider_avalara
400
-
401
- Retrieve the Avalara tax provider
402
-
403
- Retrieves the Avalara tax provider.
404
-
405
- ### Examples
406
-
407
- ```ruby
408
- require 'time'
409
- require 'ultracart_api'
410
- require 'json'
411
- require 'yaml'
412
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
413
-
414
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
415
- # As such, this might not be the best way to use this object.
416
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
417
-
418
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
419
-
420
- begin
421
- # Retrieve the Avalara tax provider
422
- result = api_instance.get_tax_provider_avalara
423
- p result
424
- rescue UltracartClient::ApiError => e
425
- puts "Error when calling TaxApi->get_tax_provider_avalara: #{e}"
426
- end
427
- ```
428
-
429
- #### Using the get_tax_provider_avalara_with_http_info variant
430
-
431
- This returns an Array which contains the response data, status code and headers.
432
-
433
- > <Array(<TaxProviderAvalara>, Integer, Hash)> get_tax_provider_avalara_with_http_info
434
-
435
- ```ruby
436
- begin
437
- # Retrieve the Avalara tax provider
438
- data, status_code, headers = api_instance.get_tax_provider_avalara_with_http_info
439
- p status_code # => 2xx
440
- p headers # => { ... }
441
- p data # => <TaxProviderAvalara>
442
- rescue UltracartClient::ApiError => e
443
- puts "Error when calling TaxApi->get_tax_provider_avalara_with_http_info: #{e}"
444
- end
445
- ```
446
-
447
- ### Parameters
448
-
449
- This endpoint does not need any parameter.
450
-
451
- ### Return type
452
-
453
- [**TaxProviderAvalara**](TaxProviderAvalara.md)
454
-
455
- ### Authorization
456
-
457
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
458
-
459
- ### HTTP request headers
460
-
461
- - **Content-Type**: Not defined
462
- - **Accept**: application/json
463
-
464
-
465
- ## get_tax_provider_avalara_companies
466
-
467
- > <TaxProviderAvalaraCompaniesResult> get_tax_provider_avalara_companies(tax_provider_avalara)
468
-
469
- Returns Avalara Tax companies configured by the merchant
470
-
471
- Returns Avalara Tax companies configured by the merchant
472
-
473
- ### Examples
474
-
475
- ```ruby
476
- require 'time'
477
- require 'ultracart_api'
478
- require 'json'
479
- require 'yaml'
480
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
481
-
482
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
483
- # As such, this might not be the best way to use this object.
484
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
485
-
486
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
487
- tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
488
-
489
- begin
490
- # Returns Avalara Tax companies configured by the merchant
491
- result = api_instance.get_tax_provider_avalara_companies(tax_provider_avalara)
492
- p result
493
- rescue UltracartClient::ApiError => e
494
- puts "Error when calling TaxApi->get_tax_provider_avalara_companies: #{e}"
495
- end
496
- ```
497
-
498
- #### Using the get_tax_provider_avalara_companies_with_http_info variant
499
-
500
- This returns an Array which contains the response data, status code and headers.
501
-
502
- > <Array(<TaxProviderAvalaraCompaniesResult>, Integer, Hash)> get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
503
-
504
- ```ruby
505
- begin
506
- # Returns Avalara Tax companies configured by the merchant
507
- data, status_code, headers = api_instance.get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
508
- p status_code # => 2xx
509
- p headers # => { ... }
510
- p data # => <TaxProviderAvalaraCompaniesResult>
511
- rescue UltracartClient::ApiError => e
512
- puts "Error when calling TaxApi->get_tax_provider_avalara_companies_with_http_info: #{e}"
513
- end
514
- ```
515
-
516
- ### Parameters
517
-
518
- | Name | Type | Description | Notes |
519
- | ---- | ---- | ----------- | ----- |
520
- | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
521
-
522
- ### Return type
523
-
524
- [**TaxProviderAvalaraCompaniesResult**](TaxProviderAvalaraCompaniesResult.md)
525
-
526
- ### Authorization
527
-
528
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
529
-
530
- ### HTTP request headers
531
-
532
- - **Content-Type**: application/json
533
- - **Accept**: application/json
534
-
535
-
536
- ## get_tax_provider_avalara_test
537
-
538
- > <TaxProviderTestResult> get_tax_provider_avalara_test
539
-
540
- Attempts to connect to Avalara and returns back the response
541
-
542
- Attempts to connect to Avalara and returns back the response.
543
-
544
- ### Examples
545
-
546
- ```ruby
547
- require 'time'
548
- require 'ultracart_api'
549
- require 'json'
550
- require 'yaml'
551
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
552
-
553
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
554
- # As such, this might not be the best way to use this object.
555
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
556
-
557
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
558
-
559
- begin
560
- # Attempts to connect to Avalara and returns back the response
561
- result = api_instance.get_tax_provider_avalara_test
562
- p result
563
- rescue UltracartClient::ApiError => e
564
- puts "Error when calling TaxApi->get_tax_provider_avalara_test: #{e}"
565
- end
566
- ```
567
-
568
- #### Using the get_tax_provider_avalara_test_with_http_info variant
569
-
570
- This returns an Array which contains the response data, status code and headers.
571
-
572
- > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_avalara_test_with_http_info
573
-
574
- ```ruby
575
- begin
576
- # Attempts to connect to Avalara and returns back the response
577
- data, status_code, headers = api_instance.get_tax_provider_avalara_test_with_http_info
578
- p status_code # => 2xx
579
- p headers # => { ... }
580
- p data # => <TaxProviderTestResult>
581
- rescue UltracartClient::ApiError => e
582
- puts "Error when calling TaxApi->get_tax_provider_avalara_test_with_http_info: #{e}"
583
- end
584
- ```
585
-
586
- ### Parameters
587
-
588
- This endpoint does not need any parameter.
589
-
590
- ### Return type
591
-
592
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
593
-
594
- ### Authorization
595
-
596
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
597
-
598
- ### HTTP request headers
599
-
600
- - **Content-Type**: Not defined
601
- - **Accept**: application/json
602
-
603
-
604
- ## get_tax_provider_self
605
-
606
- > <TaxProviderSelf> get_tax_provider_self
607
-
608
- Retrieve the Self tax provider
609
-
610
- Retrieves the Self tax provider.
611
-
612
- ### Examples
613
-
614
- ```ruby
615
- require 'time'
616
- require 'ultracart_api'
617
- require 'json'
618
- require 'yaml'
619
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
620
-
621
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
622
- # As such, this might not be the best way to use this object.
623
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
624
-
625
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
626
-
627
- begin
628
- # Retrieve the Self tax provider
629
- result = api_instance.get_tax_provider_self
630
- p result
631
- rescue UltracartClient::ApiError => e
632
- puts "Error when calling TaxApi->get_tax_provider_self: #{e}"
633
- end
634
- ```
635
-
636
- #### Using the get_tax_provider_self_with_http_info variant
637
-
638
- This returns an Array which contains the response data, status code and headers.
639
-
640
- > <Array(<TaxProviderSelf>, Integer, Hash)> get_tax_provider_self_with_http_info
641
-
642
- ```ruby
643
- begin
644
- # Retrieve the Self tax provider
645
- data, status_code, headers = api_instance.get_tax_provider_self_with_http_info
646
- p status_code # => 2xx
647
- p headers # => { ... }
648
- p data # => <TaxProviderSelf>
649
- rescue UltracartClient::ApiError => e
650
- puts "Error when calling TaxApi->get_tax_provider_self_with_http_info: #{e}"
651
- end
652
- ```
653
-
654
- ### Parameters
655
-
656
- This endpoint does not need any parameter.
657
-
658
- ### Return type
659
-
660
- [**TaxProviderSelf**](TaxProviderSelf.md)
661
-
662
- ### Authorization
663
-
664
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
665
-
666
- ### HTTP request headers
667
-
668
- - **Content-Type**: Not defined
669
- - **Accept**: application/json
670
-
671
-
672
- ## get_tax_provider_self_countries
673
-
674
- > <TaxProviderSelfCountriesResponse> get_tax_provider_self_countries
675
-
676
- Retrieve the Self tax provider countries
677
-
678
- Retrieves the Self tax provider countries.
679
-
680
- ### Examples
681
-
682
- ```ruby
683
- require 'time'
684
- require 'ultracart_api'
685
- require 'json'
686
- require 'yaml'
687
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
688
-
689
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
690
- # As such, this might not be the best way to use this object.
691
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
692
-
693
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
694
-
695
- begin
696
- # Retrieve the Self tax provider countries
697
- result = api_instance.get_tax_provider_self_countries
698
- p result
699
- rescue UltracartClient::ApiError => e
700
- puts "Error when calling TaxApi->get_tax_provider_self_countries: #{e}"
701
- end
702
- ```
703
-
704
- #### Using the get_tax_provider_self_countries_with_http_info variant
705
-
706
- This returns an Array which contains the response data, status code and headers.
707
-
708
- > <Array(<TaxProviderSelfCountriesResponse>, Integer, Hash)> get_tax_provider_self_countries_with_http_info
709
-
710
- ```ruby
711
- begin
712
- # Retrieve the Self tax provider countries
713
- data, status_code, headers = api_instance.get_tax_provider_self_countries_with_http_info
714
- p status_code # => 2xx
715
- p headers # => { ... }
716
- p data # => <TaxProviderSelfCountriesResponse>
717
- rescue UltracartClient::ApiError => e
718
- puts "Error when calling TaxApi->get_tax_provider_self_countries_with_http_info: #{e}"
719
- end
720
- ```
721
-
722
- ### Parameters
723
-
724
- This endpoint does not need any parameter.
725
-
726
- ### Return type
727
-
728
- [**TaxProviderSelfCountriesResponse**](TaxProviderSelfCountriesResponse.md)
729
-
730
- ### Authorization
731
-
732
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
733
-
734
- ### HTTP request headers
735
-
736
- - **Content-Type**: Not defined
737
- - **Accept**: application/json
738
-
739
-
740
- ## get_tax_provider_self_regions_by_country_code
741
-
742
- > <TaxProviderSelfRegionsResponse> get_tax_provider_self_regions_by_country_code(country_code)
743
-
744
- Retrieve the Self tax provider regions for a given country code
745
-
746
- Retrieves the Self tax provider regions for a given country code.
747
-
748
- ### Examples
749
-
750
- ```ruby
751
- require 'time'
752
- require 'ultracart_api'
753
- require 'json'
754
- require 'yaml'
755
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
756
-
757
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
758
- # As such, this might not be the best way to use this object.
759
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
760
-
761
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
762
- country_code = 'country_code_example' # String | The country code regions desired.
763
-
764
- begin
765
- # Retrieve the Self tax provider regions for a given country code
766
- result = api_instance.get_tax_provider_self_regions_by_country_code(country_code)
767
- p result
768
- rescue UltracartClient::ApiError => e
769
- puts "Error when calling TaxApi->get_tax_provider_self_regions_by_country_code: #{e}"
770
- end
771
- ```
772
-
773
- #### Using the get_tax_provider_self_regions_by_country_code_with_http_info variant
774
-
775
- This returns an Array which contains the response data, status code and headers.
776
-
777
- > <Array(<TaxProviderSelfRegionsResponse>, Integer, Hash)> get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
778
-
779
- ```ruby
780
- begin
781
- # Retrieve the Self tax provider regions for a given country code
782
- data, status_code, headers = api_instance.get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
783
- p status_code # => 2xx
784
- p headers # => { ... }
785
- p data # => <TaxProviderSelfRegionsResponse>
786
- rescue UltracartClient::ApiError => e
787
- puts "Error when calling TaxApi->get_tax_provider_self_regions_by_country_code_with_http_info: #{e}"
788
- end
789
- ```
790
-
791
- ### Parameters
792
-
793
- | Name | Type | Description | Notes |
794
- | ---- | ---- | ----------- | ----- |
795
- | **country_code** | **String** | The country code regions desired. | |
796
-
797
- ### Return type
798
-
799
- [**TaxProviderSelfRegionsResponse**](TaxProviderSelfRegionsResponse.md)
800
-
801
- ### Authorization
802
-
803
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
804
-
805
- ### HTTP request headers
806
-
807
- - **Content-Type**: Not defined
808
- - **Accept**: application/json
809
-
810
-
811
- ## get_tax_provider_sovos
812
-
813
- > <TaxProviderSovos> get_tax_provider_sovos
814
-
815
- Retrieve the Sovos tax provider
816
-
817
- Retrieves the Sovos tax provider.
818
-
819
- ### Examples
820
-
821
- ```ruby
822
- require 'time'
823
- require 'ultracart_api'
824
- require 'json'
825
- require 'yaml'
826
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
827
-
828
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
829
- # As such, this might not be the best way to use this object.
830
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
831
-
832
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
833
-
834
- begin
835
- # Retrieve the Sovos tax provider
836
- result = api_instance.get_tax_provider_sovos
837
- p result
838
- rescue UltracartClient::ApiError => e
839
- puts "Error when calling TaxApi->get_tax_provider_sovos: #{e}"
840
- end
841
- ```
842
-
843
- #### Using the get_tax_provider_sovos_with_http_info variant
844
-
845
- This returns an Array which contains the response data, status code and headers.
846
-
847
- > <Array(<TaxProviderSovos>, Integer, Hash)> get_tax_provider_sovos_with_http_info
848
-
849
- ```ruby
850
- begin
851
- # Retrieve the Sovos tax provider
852
- data, status_code, headers = api_instance.get_tax_provider_sovos_with_http_info
853
- p status_code # => 2xx
854
- p headers # => { ... }
855
- p data # => <TaxProviderSovos>
856
- rescue UltracartClient::ApiError => e
857
- puts "Error when calling TaxApi->get_tax_provider_sovos_with_http_info: #{e}"
858
- end
859
- ```
860
-
861
- ### Parameters
862
-
863
- This endpoint does not need any parameter.
864
-
865
- ### Return type
866
-
867
- [**TaxProviderSovos**](TaxProviderSovos.md)
868
-
869
- ### Authorization
870
-
871
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
872
-
873
- ### HTTP request headers
874
-
875
- - **Content-Type**: Not defined
876
- - **Accept**: application/json
877
-
878
-
879
- ## get_tax_provider_sovos_test
880
-
881
- > <TaxProviderTestResult> get_tax_provider_sovos_test
882
-
883
- Attempts to connect to Sovos and returns back the response
884
-
885
- Attempts to connect to Sovos and returns back the response.
886
-
887
- ### Examples
888
-
889
- ```ruby
890
- require 'time'
891
- require 'ultracart_api'
892
- require 'json'
893
- require 'yaml'
894
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
895
-
896
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
897
- # As such, this might not be the best way to use this object.
898
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
899
-
900
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
901
-
902
- begin
903
- # Attempts to connect to Sovos and returns back the response
904
- result = api_instance.get_tax_provider_sovos_test
905
- p result
906
- rescue UltracartClient::ApiError => e
907
- puts "Error when calling TaxApi->get_tax_provider_sovos_test: #{e}"
908
- end
909
- ```
910
-
911
- #### Using the get_tax_provider_sovos_test_with_http_info variant
912
-
913
- This returns an Array which contains the response data, status code and headers.
914
-
915
- > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_sovos_test_with_http_info
916
-
917
- ```ruby
918
- begin
919
- # Attempts to connect to Sovos and returns back the response
920
- data, status_code, headers = api_instance.get_tax_provider_sovos_test_with_http_info
921
- p status_code # => 2xx
922
- p headers # => { ... }
923
- p data # => <TaxProviderTestResult>
924
- rescue UltracartClient::ApiError => e
925
- puts "Error when calling TaxApi->get_tax_provider_sovos_test_with_http_info: #{e}"
926
- end
927
- ```
928
-
929
- ### Parameters
930
-
931
- This endpoint does not need any parameter.
932
-
933
- ### Return type
934
-
935
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
936
-
937
- ### Authorization
938
-
939
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
940
-
941
- ### HTTP request headers
942
-
943
- - **Content-Type**: Not defined
944
- - **Accept**: application/json
945
-
946
-
947
- ## get_tax_provider_tax_jar
948
-
949
- > <TaxProviderTaxJar> get_tax_provider_tax_jar
950
-
951
- Retrieve the TaxJar tax provider
952
-
953
- Retrieves the TaxJar tax provider.
954
-
955
- ### Examples
956
-
957
- ```ruby
958
- require 'time'
959
- require 'ultracart_api'
960
- require 'json'
961
- require 'yaml'
962
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
963
-
964
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
965
- # As such, this might not be the best way to use this object.
966
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
967
-
968
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
969
-
970
- begin
971
- # Retrieve the TaxJar tax provider
972
- result = api_instance.get_tax_provider_tax_jar
973
- p result
974
- rescue UltracartClient::ApiError => e
975
- puts "Error when calling TaxApi->get_tax_provider_tax_jar: #{e}"
976
- end
977
- ```
978
-
979
- #### Using the get_tax_provider_tax_jar_with_http_info variant
980
-
981
- This returns an Array which contains the response data, status code and headers.
982
-
983
- > <Array(<TaxProviderTaxJar>, Integer, Hash)> get_tax_provider_tax_jar_with_http_info
984
-
985
- ```ruby
986
- begin
987
- # Retrieve the TaxJar tax provider
988
- data, status_code, headers = api_instance.get_tax_provider_tax_jar_with_http_info
989
- p status_code # => 2xx
990
- p headers # => { ... }
991
- p data # => <TaxProviderTaxJar>
992
- rescue UltracartClient::ApiError => e
993
- puts "Error when calling TaxApi->get_tax_provider_tax_jar_with_http_info: #{e}"
994
- end
995
- ```
996
-
997
- ### Parameters
998
-
999
- This endpoint does not need any parameter.
1000
-
1001
- ### Return type
1002
-
1003
- [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
1004
-
1005
- ### Authorization
1006
-
1007
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1008
-
1009
- ### HTTP request headers
1010
-
1011
- - **Content-Type**: Not defined
1012
- - **Accept**: application/json
1013
-
1014
-
1015
- ## get_tax_provider_tax_jar_test
1016
-
1017
- > <TaxProviderTestResult> get_tax_provider_tax_jar_test
1018
-
1019
- Attempts to connect to TaxJar and returns back the response
1020
-
1021
- Attempts to connect to TaxJar and returns back the response.
1022
-
1023
- ### Examples
1024
-
1025
- ```ruby
1026
- require 'time'
1027
- require 'ultracart_api'
1028
- require 'json'
1029
- require 'yaml'
1030
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1031
-
1032
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1033
- # As such, this might not be the best way to use this object.
1034
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1035
-
1036
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1037
-
1038
- begin
1039
- # Attempts to connect to TaxJar and returns back the response
1040
- result = api_instance.get_tax_provider_tax_jar_test
1041
- p result
1042
- rescue UltracartClient::ApiError => e
1043
- puts "Error when calling TaxApi->get_tax_provider_tax_jar_test: #{e}"
1044
- end
1045
- ```
1046
-
1047
- #### Using the get_tax_provider_tax_jar_test_with_http_info variant
1048
-
1049
- This returns an Array which contains the response data, status code and headers.
1050
-
1051
- > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_tax_jar_test_with_http_info
1052
-
1053
- ```ruby
1054
- begin
1055
- # Attempts to connect to TaxJar and returns back the response
1056
- data, status_code, headers = api_instance.get_tax_provider_tax_jar_test_with_http_info
1057
- p status_code # => 2xx
1058
- p headers # => { ... }
1059
- p data # => <TaxProviderTestResult>
1060
- rescue UltracartClient::ApiError => e
1061
- puts "Error when calling TaxApi->get_tax_provider_tax_jar_test_with_http_info: #{e}"
1062
- end
1063
- ```
1064
-
1065
- ### Parameters
1066
-
1067
- This endpoint does not need any parameter.
1068
-
1069
- ### Return type
1070
-
1071
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
1072
-
1073
- ### Authorization
1074
-
1075
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1076
-
1077
- ### HTTP request headers
1078
-
1079
- - **Content-Type**: Not defined
1080
- - **Accept**: application/json
1081
-
1082
-
1083
- ## get_tax_provider_ultra_cart
1084
-
1085
- > <TaxProviderUltraCart> get_tax_provider_ultra_cart
1086
-
1087
- Retrieve the UltraCart tax provider
1088
-
1089
- Retrieves the UltraCart tax provider.
1090
-
1091
- ### Examples
1092
-
1093
- ```ruby
1094
- require 'time'
1095
- require 'ultracart_api'
1096
- require 'json'
1097
- require 'yaml'
1098
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1099
-
1100
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1101
- # As such, this might not be the best way to use this object.
1102
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1103
-
1104
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1105
-
1106
- begin
1107
- # Retrieve the UltraCart tax provider
1108
- result = api_instance.get_tax_provider_ultra_cart
1109
- p result
1110
- rescue UltracartClient::ApiError => e
1111
- puts "Error when calling TaxApi->get_tax_provider_ultra_cart: #{e}"
1112
- end
1113
- ```
1114
-
1115
- #### Using the get_tax_provider_ultra_cart_with_http_info variant
1116
-
1117
- This returns an Array which contains the response data, status code and headers.
1118
-
1119
- > <Array(<TaxProviderUltraCart>, Integer, Hash)> get_tax_provider_ultra_cart_with_http_info
1120
-
1121
- ```ruby
1122
- begin
1123
- # Retrieve the UltraCart tax provider
1124
- data, status_code, headers = api_instance.get_tax_provider_ultra_cart_with_http_info
1125
- p status_code # => 2xx
1126
- p headers # => { ... }
1127
- p data # => <TaxProviderUltraCart>
1128
- rescue UltracartClient::ApiError => e
1129
- puts "Error when calling TaxApi->get_tax_provider_ultra_cart_with_http_info: #{e}"
1130
- end
1131
- ```
1132
-
1133
- ### Parameters
1134
-
1135
- This endpoint does not need any parameter.
1136
-
1137
- ### Return type
1138
-
1139
- [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
1140
-
1141
- ### Authorization
1142
-
1143
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1144
-
1145
- ### HTTP request headers
1146
-
1147
- - **Content-Type**: Not defined
1148
- - **Accept**: application/json
1149
-
1150
-
1151
- ## get_tax_providers
1152
-
1153
- > <TaxProvidersResponse> get_tax_providers(opts)
1154
-
1155
- Retrieve tax methods
1156
-
1157
- Retrieves tax methods for this account.
1158
-
1159
- ### Examples
1160
-
1161
- ```ruby
1162
- require 'time'
1163
- require 'ultracart_api'
1164
- require 'json'
1165
- require 'yaml'
1166
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1167
-
1168
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1169
- # As such, this might not be the best way to use this object.
1170
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1171
-
1172
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1173
- opts = {
1174
- _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
1175
- _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
1176
- _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
1177
- }
1178
-
1179
- begin
1180
- # Retrieve tax methods
1181
- result = api_instance.get_tax_providers(opts)
1182
- p result
1183
- rescue UltracartClient::ApiError => e
1184
- puts "Error when calling TaxApi->get_tax_providers: #{e}"
1185
- end
1186
- ```
1187
-
1188
- #### Using the get_tax_providers_with_http_info variant
1189
-
1190
- This returns an Array which contains the response data, status code and headers.
1191
-
1192
- > <Array(<TaxProvidersResponse>, Integer, Hash)> get_tax_providers_with_http_info(opts)
1193
-
1194
- ```ruby
1195
- begin
1196
- # Retrieve tax methods
1197
- data, status_code, headers = api_instance.get_tax_providers_with_http_info(opts)
1198
- p status_code # => 2xx
1199
- p headers # => { ... }
1200
- p data # => <TaxProvidersResponse>
1201
- rescue UltracartClient::ApiError => e
1202
- puts "Error when calling TaxApi->get_tax_providers_with_http_info: #{e}"
1203
- end
1204
- ```
1205
-
1206
- ### Parameters
1207
-
1208
- | Name | Type | Description | Notes |
1209
- | ---- | ---- | ----------- | ----- |
1210
- | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
1211
- | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
1212
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1213
-
1214
- ### Return type
1215
-
1216
- [**TaxProvidersResponse**](TaxProvidersResponse.md)
1217
-
1218
- ### Authorization
1219
-
1220
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1221
-
1222
- ### HTTP request headers
1223
-
1224
- - **Content-Type**: Not defined
1225
- - **Accept**: application/json
1226
-
1227
-
1228
- ## set_active_tax_provider
1229
-
1230
- > <TaxProviderActivateResult> set_active_tax_provider(provider_name)
1231
-
1232
- Toggle a tax provider to active
1233
-
1234
- Toggle a tax provider to active.
1235
-
1236
- ### Examples
1237
-
1238
- ```ruby
1239
- require 'time'
1240
- require 'ultracart_api'
1241
- require 'json'
1242
- require 'yaml'
1243
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1244
-
1245
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1246
- # As such, this might not be the best way to use this object.
1247
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1248
-
1249
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1250
- provider_name = 'provider_name_example' # String | The tax provider to set active.
1251
-
1252
- begin
1253
- # Toggle a tax provider to active
1254
- result = api_instance.set_active_tax_provider(provider_name)
1255
- p result
1256
- rescue UltracartClient::ApiError => e
1257
- puts "Error when calling TaxApi->set_active_tax_provider: #{e}"
1258
- end
1259
- ```
1260
-
1261
- #### Using the set_active_tax_provider_with_http_info variant
1262
-
1263
- This returns an Array which contains the response data, status code and headers.
1264
-
1265
- > <Array(<TaxProviderActivateResult>, Integer, Hash)> set_active_tax_provider_with_http_info(provider_name)
1266
-
1267
- ```ruby
1268
- begin
1269
- # Toggle a tax provider to active
1270
- data, status_code, headers = api_instance.set_active_tax_provider_with_http_info(provider_name)
1271
- p status_code # => 2xx
1272
- p headers # => { ... }
1273
- p data # => <TaxProviderActivateResult>
1274
- rescue UltracartClient::ApiError => e
1275
- puts "Error when calling TaxApi->set_active_tax_provider_with_http_info: #{e}"
1276
- end
1277
- ```
1278
-
1279
- ### Parameters
1280
-
1281
- | Name | Type | Description | Notes |
1282
- | ---- | ---- | ----------- | ----- |
1283
- | **provider_name** | **String** | The tax provider to set active. | |
1284
-
1285
- ### Return type
1286
-
1287
- [**TaxProviderActivateResult**](TaxProviderActivateResult.md)
1288
-
1289
- ### Authorization
1290
-
1291
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1292
-
1293
- ### HTTP request headers
1294
-
1295
- - **Content-Type**: Not defined
1296
- - **Accept**: application/json
1297
-
1298
-
1299
- ## update_tax_provider_avalara
1300
-
1301
- > <TaxProviderAvalara> update_tax_provider_avalara(tax_provider_avalara)
1302
-
1303
- Update the Avalara tax provider
1304
-
1305
- Update the Avalara tax provider.
1306
-
1307
- ### Examples
1308
-
1309
- ```ruby
1310
- require 'time'
1311
- require 'ultracart_api'
1312
- require 'json'
1313
- require 'yaml'
1314
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1315
-
1316
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1317
- # As such, this might not be the best way to use this object.
1318
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1319
-
1320
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1321
- tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
1322
-
1323
- begin
1324
- # Update the Avalara tax provider
1325
- result = api_instance.update_tax_provider_avalara(tax_provider_avalara)
1326
- p result
1327
- rescue UltracartClient::ApiError => e
1328
- puts "Error when calling TaxApi->update_tax_provider_avalara: #{e}"
1329
- end
1330
- ```
1331
-
1332
- #### Using the update_tax_provider_avalara_with_http_info variant
1333
-
1334
- This returns an Array which contains the response data, status code and headers.
1335
-
1336
- > <Array(<TaxProviderAvalara>, Integer, Hash)> update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1337
-
1338
- ```ruby
1339
- begin
1340
- # Update the Avalara tax provider
1341
- data, status_code, headers = api_instance.update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1342
- p status_code # => 2xx
1343
- p headers # => { ... }
1344
- p data # => <TaxProviderAvalara>
1345
- rescue UltracartClient::ApiError => e
1346
- puts "Error when calling TaxApi->update_tax_provider_avalara_with_http_info: #{e}"
1347
- end
1348
- ```
1349
-
1350
- ### Parameters
1351
-
1352
- | Name | Type | Description | Notes |
1353
- | ---- | ---- | ----------- | ----- |
1354
- | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
1355
-
1356
- ### Return type
1357
-
1358
- [**TaxProviderAvalara**](TaxProviderAvalara.md)
1359
-
1360
- ### Authorization
1361
-
1362
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1363
-
1364
- ### HTTP request headers
1365
-
1366
- - **Content-Type**: application/json
1367
- - **Accept**: application/json
1368
-
1369
-
1370
- ## update_tax_provider_self
1371
-
1372
- > <TaxProviderSelf> update_tax_provider_self(tax_provider_self)
1373
-
1374
- Update the Self tax provider
1375
-
1376
- Update the Self tax provider.
1377
-
1378
- ### Examples
1379
-
1380
- ```ruby
1381
- require 'time'
1382
- require 'ultracart_api'
1383
- require 'json'
1384
- require 'yaml'
1385
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1386
-
1387
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1388
- # As such, this might not be the best way to use this object.
1389
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1390
-
1391
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1392
- tax_provider_self = UltracartClient::TaxProviderSelf.new # TaxProviderSelf | TaxProviderSelf object
1393
-
1394
- begin
1395
- # Update the Self tax provider
1396
- result = api_instance.update_tax_provider_self(tax_provider_self)
1397
- p result
1398
- rescue UltracartClient::ApiError => e
1399
- puts "Error when calling TaxApi->update_tax_provider_self: #{e}"
1400
- end
1401
- ```
1402
-
1403
- #### Using the update_tax_provider_self_with_http_info variant
1404
-
1405
- This returns an Array which contains the response data, status code and headers.
1406
-
1407
- > <Array(<TaxProviderSelf>, Integer, Hash)> update_tax_provider_self_with_http_info(tax_provider_self)
1408
-
1409
- ```ruby
1410
- begin
1411
- # Update the Self tax provider
1412
- data, status_code, headers = api_instance.update_tax_provider_self_with_http_info(tax_provider_self)
1413
- p status_code # => 2xx
1414
- p headers # => { ... }
1415
- p data # => <TaxProviderSelf>
1416
- rescue UltracartClient::ApiError => e
1417
- puts "Error when calling TaxApi->update_tax_provider_self_with_http_info: #{e}"
1418
- end
1419
- ```
1420
-
1421
- ### Parameters
1422
-
1423
- | Name | Type | Description | Notes |
1424
- | ---- | ---- | ----------- | ----- |
1425
- | **tax_provider_self** | [**TaxProviderSelf**](TaxProviderSelf.md) | TaxProviderSelf object | |
1426
-
1427
- ### Return type
1428
-
1429
- [**TaxProviderSelf**](TaxProviderSelf.md)
1430
-
1431
- ### Authorization
1432
-
1433
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1434
-
1435
- ### HTTP request headers
1436
-
1437
- - **Content-Type**: application/json
1438
- - **Accept**: application/json
1439
-
1440
-
1441
- ## update_tax_provider_self_city
1442
-
1443
- > <TaxCity> update_tax_provider_self_city(city, tax_city)
1444
-
1445
- Updates a Self tax provider city
1446
-
1447
- Updates a Self tax provider city.
1448
-
1449
- ### Examples
1450
-
1451
- ```ruby
1452
- require 'time'
1453
- require 'ultracart_api'
1454
- require 'json'
1455
- require 'yaml'
1456
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1457
-
1458
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1459
- # As such, this might not be the best way to use this object.
1460
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1461
-
1462
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1463
- city = 'city_example' # String | The city being updated.
1464
- tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be updated
1465
-
1466
- begin
1467
- # Updates a Self tax provider city
1468
- result = api_instance.update_tax_provider_self_city(city, tax_city)
1469
- p result
1470
- rescue UltracartClient::ApiError => e
1471
- puts "Error when calling TaxApi->update_tax_provider_self_city: #{e}"
1472
- end
1473
- ```
1474
-
1475
- #### Using the update_tax_provider_self_city_with_http_info variant
1476
-
1477
- This returns an Array which contains the response data, status code and headers.
1478
-
1479
- > <Array(<TaxCity>, Integer, Hash)> update_tax_provider_self_city_with_http_info(city, tax_city)
1480
-
1481
- ```ruby
1482
- begin
1483
- # Updates a Self tax provider city
1484
- data, status_code, headers = api_instance.update_tax_provider_self_city_with_http_info(city, tax_city)
1485
- p status_code # => 2xx
1486
- p headers # => { ... }
1487
- p data # => <TaxCity>
1488
- rescue UltracartClient::ApiError => e
1489
- puts "Error when calling TaxApi->update_tax_provider_self_city_with_http_info: #{e}"
1490
- end
1491
- ```
1492
-
1493
- ### Parameters
1494
-
1495
- | Name | Type | Description | Notes |
1496
- | ---- | ---- | ----------- | ----- |
1497
- | **city** | **String** | The city being updated. | |
1498
- | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be updated | |
1499
-
1500
- ### Return type
1501
-
1502
- [**TaxCity**](TaxCity.md)
1503
-
1504
- ### Authorization
1505
-
1506
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1507
-
1508
- ### HTTP request headers
1509
-
1510
- - **Content-Type**: application/json
1511
- - **Accept**: application/json
1512
-
1513
-
1514
- ## update_tax_provider_self_country
1515
-
1516
- > <TaxCountry> update_tax_provider_self_country(country_code, tax_country)
1517
-
1518
- Updates a Self tax provider country
1519
-
1520
- Updates a Self tax provider country.
1521
-
1522
- ### Examples
1523
-
1524
- ```ruby
1525
- require 'time'
1526
- require 'ultracart_api'
1527
- require 'json'
1528
- require 'yaml'
1529
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1530
-
1531
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1532
- # As such, this might not be the best way to use this object.
1533
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1534
-
1535
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1536
- country_code = 'country_code_example' # String | The country code being updated.
1537
- tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be updated
1538
-
1539
- begin
1540
- # Updates a Self tax provider country
1541
- result = api_instance.update_tax_provider_self_country(country_code, tax_country)
1542
- p result
1543
- rescue UltracartClient::ApiError => e
1544
- puts "Error when calling TaxApi->update_tax_provider_self_country: #{e}"
1545
- end
1546
- ```
1547
-
1548
- #### Using the update_tax_provider_self_country_with_http_info variant
1549
-
1550
- This returns an Array which contains the response data, status code and headers.
1551
-
1552
- > <Array(<TaxCountry>, Integer, Hash)> update_tax_provider_self_country_with_http_info(country_code, tax_country)
1553
-
1554
- ```ruby
1555
- begin
1556
- # Updates a Self tax provider country
1557
- data, status_code, headers = api_instance.update_tax_provider_self_country_with_http_info(country_code, tax_country)
1558
- p status_code # => 2xx
1559
- p headers # => { ... }
1560
- p data # => <TaxCountry>
1561
- rescue UltracartClient::ApiError => e
1562
- puts "Error when calling TaxApi->update_tax_provider_self_country_with_http_info: #{e}"
1563
- end
1564
- ```
1565
-
1566
- ### Parameters
1567
-
1568
- | Name | Type | Description | Notes |
1569
- | ---- | ---- | ----------- | ----- |
1570
- | **country_code** | **String** | The country code being updated. | |
1571
- | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be updated | |
1572
-
1573
- ### Return type
1574
-
1575
- [**TaxCountry**](TaxCountry.md)
1576
-
1577
- ### Authorization
1578
-
1579
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1580
-
1581
- ### HTTP request headers
1582
-
1583
- - **Content-Type**: application/json
1584
- - **Accept**: application/json
1585
-
1586
-
1587
- ## update_tax_provider_self_county
1588
-
1589
- > <TaxCounty> update_tax_provider_self_county(county, tax_county)
1590
-
1591
- Updates a Self tax provider county
1592
-
1593
- Updates a Self tax provider county.
1594
-
1595
- ### Examples
1596
-
1597
- ```ruby
1598
- require 'time'
1599
- require 'ultracart_api'
1600
- require 'json'
1601
- require 'yaml'
1602
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1603
-
1604
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1605
- # As such, this might not be the best way to use this object.
1606
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1607
-
1608
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1609
- county = 'county_example' # String | The county being updated.
1610
- tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be updated
1611
-
1612
- begin
1613
- # Updates a Self tax provider county
1614
- result = api_instance.update_tax_provider_self_county(county, tax_county)
1615
- p result
1616
- rescue UltracartClient::ApiError => e
1617
- puts "Error when calling TaxApi->update_tax_provider_self_county: #{e}"
1618
- end
1619
- ```
1620
-
1621
- #### Using the update_tax_provider_self_county_with_http_info variant
1622
-
1623
- This returns an Array which contains the response data, status code and headers.
1624
-
1625
- > <Array(<TaxCounty>, Integer, Hash)> update_tax_provider_self_county_with_http_info(county, tax_county)
1626
-
1627
- ```ruby
1628
- begin
1629
- # Updates a Self tax provider county
1630
- data, status_code, headers = api_instance.update_tax_provider_self_county_with_http_info(county, tax_county)
1631
- p status_code # => 2xx
1632
- p headers # => { ... }
1633
- p data # => <TaxCounty>
1634
- rescue UltracartClient::ApiError => e
1635
- puts "Error when calling TaxApi->update_tax_provider_self_county_with_http_info: #{e}"
1636
- end
1637
- ```
1638
-
1639
- ### Parameters
1640
-
1641
- | Name | Type | Description | Notes |
1642
- | ---- | ---- | ----------- | ----- |
1643
- | **county** | **String** | The county being updated. | |
1644
- | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be updated | |
1645
-
1646
- ### Return type
1647
-
1648
- [**TaxCounty**](TaxCounty.md)
1649
-
1650
- ### Authorization
1651
-
1652
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1653
-
1654
- ### HTTP request headers
1655
-
1656
- - **Content-Type**: application/json
1657
- - **Accept**: application/json
1658
-
1659
-
1660
- ## update_tax_provider_self_postal_code
1661
-
1662
- > <TaxPostalCode> update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1663
-
1664
- Updates a Self tax provider postalCode
1665
-
1666
- Updates a Self tax provider postalCode.
1667
-
1668
- ### Examples
1669
-
1670
- ```ruby
1671
- require 'time'
1672
- require 'ultracart_api'
1673
- require 'json'
1674
- require 'yaml'
1675
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1676
-
1677
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1678
- # As such, this might not be the best way to use this object.
1679
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1680
-
1681
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1682
- postal_code = 'postal_code_example' # String | The postal code being updated.
1683
- tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be updated
1684
-
1685
- begin
1686
- # Updates a Self tax provider postalCode
1687
- result = api_instance.update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1688
- p result
1689
- rescue UltracartClient::ApiError => e
1690
- puts "Error when calling TaxApi->update_tax_provider_self_postal_code: #{e}"
1691
- end
1692
- ```
1693
-
1694
- #### Using the update_tax_provider_self_postal_code_with_http_info variant
1695
-
1696
- This returns an Array which contains the response data, status code and headers.
1697
-
1698
- > <Array(<TaxPostalCode>, Integer, Hash)> update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1699
-
1700
- ```ruby
1701
- begin
1702
- # Updates a Self tax provider postalCode
1703
- data, status_code, headers = api_instance.update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1704
- p status_code # => 2xx
1705
- p headers # => { ... }
1706
- p data # => <TaxPostalCode>
1707
- rescue UltracartClient::ApiError => e
1708
- puts "Error when calling TaxApi->update_tax_provider_self_postal_code_with_http_info: #{e}"
1709
- end
1710
- ```
1711
-
1712
- ### Parameters
1713
-
1714
- | Name | Type | Description | Notes |
1715
- | ---- | ---- | ----------- | ----- |
1716
- | **postal_code** | **String** | The postal code being updated. | |
1717
- | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be updated | |
1718
-
1719
- ### Return type
1720
-
1721
- [**TaxPostalCode**](TaxPostalCode.md)
1722
-
1723
- ### Authorization
1724
-
1725
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1726
-
1727
- ### HTTP request headers
1728
-
1729
- - **Content-Type**: application/json
1730
- - **Accept**: application/json
1731
-
1732
-
1733
- ## update_tax_provider_self_state
1734
-
1735
- > <TaxState> update_tax_provider_self_state(state_code, tax_state)
1736
-
1737
- Updates a Self tax provider state
1738
-
1739
- Updates a Self tax provider state.
1740
-
1741
- ### Examples
1742
-
1743
- ```ruby
1744
- require 'time'
1745
- require 'ultracart_api'
1746
- require 'json'
1747
- require 'yaml'
1748
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1749
-
1750
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1751
- # As such, this might not be the best way to use this object.
1752
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1753
-
1754
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1755
- state_code = 'state_code_example' # String | The state code being updated.
1756
- tax_state = UltracartClient::TaxState.new # TaxState | tax state to be updated
1757
-
1758
- begin
1759
- # Updates a Self tax provider state
1760
- result = api_instance.update_tax_provider_self_state(state_code, tax_state)
1761
- p result
1762
- rescue UltracartClient::ApiError => e
1763
- puts "Error when calling TaxApi->update_tax_provider_self_state: #{e}"
1764
- end
1765
- ```
1766
-
1767
- #### Using the update_tax_provider_self_state_with_http_info variant
1768
-
1769
- This returns an Array which contains the response data, status code and headers.
1770
-
1771
- > <Array(<TaxState>, Integer, Hash)> update_tax_provider_self_state_with_http_info(state_code, tax_state)
1772
-
1773
- ```ruby
1774
- begin
1775
- # Updates a Self tax provider state
1776
- data, status_code, headers = api_instance.update_tax_provider_self_state_with_http_info(state_code, tax_state)
1777
- p status_code # => 2xx
1778
- p headers # => { ... }
1779
- p data # => <TaxState>
1780
- rescue UltracartClient::ApiError => e
1781
- puts "Error when calling TaxApi->update_tax_provider_self_state_with_http_info: #{e}"
1782
- end
1783
- ```
1784
-
1785
- ### Parameters
1786
-
1787
- | Name | Type | Description | Notes |
1788
- | ---- | ---- | ----------- | ----- |
1789
- | **state_code** | **String** | The state code being updated. | |
1790
- | **tax_state** | [**TaxState**](TaxState.md) | tax state to be updated | |
1791
-
1792
- ### Return type
1793
-
1794
- [**TaxState**](TaxState.md)
1795
-
1796
- ### Authorization
1797
-
1798
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1799
-
1800
- ### HTTP request headers
1801
-
1802
- - **Content-Type**: application/json
1803
- - **Accept**: application/json
1804
-
1805
-
1806
- ## update_tax_provider_sovos
1807
-
1808
- > <TaxProviderSovos> update_tax_provider_sovos(tax_provider_sovos)
1809
-
1810
- Update the Sovos tax provider
1811
-
1812
- Update the Sovos tax provider.
1813
-
1814
- ### Examples
1815
-
1816
- ```ruby
1817
- require 'time'
1818
- require 'ultracart_api'
1819
- require 'json'
1820
- require 'yaml'
1821
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1822
-
1823
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1824
- # As such, this might not be the best way to use this object.
1825
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1826
-
1827
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1828
- tax_provider_sovos = UltracartClient::TaxProviderSovos.new # TaxProviderSovos | TaxProviderSovos object
1829
-
1830
- begin
1831
- # Update the Sovos tax provider
1832
- result = api_instance.update_tax_provider_sovos(tax_provider_sovos)
1833
- p result
1834
- rescue UltracartClient::ApiError => e
1835
- puts "Error when calling TaxApi->update_tax_provider_sovos: #{e}"
1836
- end
1837
- ```
1838
-
1839
- #### Using the update_tax_provider_sovos_with_http_info variant
1840
-
1841
- This returns an Array which contains the response data, status code and headers.
1842
-
1843
- > <Array(<TaxProviderSovos>, Integer, Hash)> update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1844
-
1845
- ```ruby
1846
- begin
1847
- # Update the Sovos tax provider
1848
- data, status_code, headers = api_instance.update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1849
- p status_code # => 2xx
1850
- p headers # => { ... }
1851
- p data # => <TaxProviderSovos>
1852
- rescue UltracartClient::ApiError => e
1853
- puts "Error when calling TaxApi->update_tax_provider_sovos_with_http_info: #{e}"
1854
- end
1855
- ```
1856
-
1857
- ### Parameters
1858
-
1859
- | Name | Type | Description | Notes |
1860
- | ---- | ---- | ----------- | ----- |
1861
- | **tax_provider_sovos** | [**TaxProviderSovos**](TaxProviderSovos.md) | TaxProviderSovos object | |
1862
-
1863
- ### Return type
1864
-
1865
- [**TaxProviderSovos**](TaxProviderSovos.md)
1866
-
1867
- ### Authorization
1868
-
1869
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1870
-
1871
- ### HTTP request headers
1872
-
1873
- - **Content-Type**: application/json
1874
- - **Accept**: application/json
1875
-
1876
-
1877
- ## update_tax_provider_tax_jar
1878
-
1879
- > <TaxProviderTaxJar> update_tax_provider_tax_jar(tax_provider_tax_jar)
1880
-
1881
- Update the TaxJar tax provider
1882
-
1883
- Update the TaxJar tax provider.
1884
-
1885
- ### Examples
1886
-
1887
- ```ruby
1888
- require 'time'
1889
- require 'ultracart_api'
1890
- require 'json'
1891
- require 'yaml'
1892
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1893
-
1894
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1895
- # As such, this might not be the best way to use this object.
1896
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1897
-
1898
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1899
- tax_provider_tax_jar = UltracartClient::TaxProviderTaxJar.new # TaxProviderTaxJar | TaxProviderTaxJar object
1900
-
1901
- begin
1902
- # Update the TaxJar tax provider
1903
- result = api_instance.update_tax_provider_tax_jar(tax_provider_tax_jar)
1904
- p result
1905
- rescue UltracartClient::ApiError => e
1906
- puts "Error when calling TaxApi->update_tax_provider_tax_jar: #{e}"
1907
- end
1908
- ```
1909
-
1910
- #### Using the update_tax_provider_tax_jar_with_http_info variant
1911
-
1912
- This returns an Array which contains the response data, status code and headers.
1913
-
1914
- > <Array(<TaxProviderTaxJar>, Integer, Hash)> update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
1915
-
1916
- ```ruby
1917
- begin
1918
- # Update the TaxJar tax provider
1919
- data, status_code, headers = api_instance.update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
1920
- p status_code # => 2xx
1921
- p headers # => { ... }
1922
- p data # => <TaxProviderTaxJar>
1923
- rescue UltracartClient::ApiError => e
1924
- puts "Error when calling TaxApi->update_tax_provider_tax_jar_with_http_info: #{e}"
1925
- end
1926
- ```
1927
-
1928
- ### Parameters
1929
-
1930
- | Name | Type | Description | Notes |
1931
- | ---- | ---- | ----------- | ----- |
1932
- | **tax_provider_tax_jar** | [**TaxProviderTaxJar**](TaxProviderTaxJar.md) | TaxProviderTaxJar object | |
1933
-
1934
- ### Return type
1935
-
1936
- [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
1937
-
1938
- ### Authorization
1939
-
1940
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1941
-
1942
- ### HTTP request headers
1943
-
1944
- - **Content-Type**: application/json
1945
- - **Accept**: application/json
1946
-
1947
-
1948
- ## update_tax_provider_ultra_cart
1949
-
1950
- > <TaxProviderUltraCart> update_tax_provider_ultra_cart(tax_provider_ultracart)
1951
-
1952
- Update the UltraCart tax provider
1953
-
1954
- Update the UltraCart tax provider.
1955
-
1956
- ### Examples
1957
-
1958
- ```ruby
1959
- require 'time'
1960
- require 'ultracart_api'
1961
- require 'json'
1962
- require 'yaml'
1963
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1964
-
1965
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1966
- # As such, this might not be the best way to use this object.
1967
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
1968
-
1969
- api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1970
- tax_provider_ultracart = UltracartClient::TaxProviderUltraCart.new # TaxProviderUltraCart | TaxProviderUltraCart object
1971
-
1972
- begin
1973
- # Update the UltraCart tax provider
1974
- result = api_instance.update_tax_provider_ultra_cart(tax_provider_ultracart)
1975
- p result
1976
- rescue UltracartClient::ApiError => e
1977
- puts "Error when calling TaxApi->update_tax_provider_ultra_cart: #{e}"
1978
- end
1979
- ```
1980
-
1981
- #### Using the update_tax_provider_ultra_cart_with_http_info variant
1982
-
1983
- This returns an Array which contains the response data, status code and headers.
1984
-
1985
- > <Array(<TaxProviderUltraCart>, Integer, Hash)> update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
1986
-
1987
- ```ruby
1988
- begin
1989
- # Update the UltraCart tax provider
1990
- data, status_code, headers = api_instance.update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
1991
- p status_code # => 2xx
1992
- p headers # => { ... }
1993
- p data # => <TaxProviderUltraCart>
1994
- rescue UltracartClient::ApiError => e
1995
- puts "Error when calling TaxApi->update_tax_provider_ultra_cart_with_http_info: #{e}"
1996
- end
1997
- ```
1998
-
1999
- ### Parameters
2000
-
2001
- | Name | Type | Description | Notes |
2002
- | ---- | ---- | ----------- | ----- |
2003
- | **tax_provider_ultracart** | [**TaxProviderUltraCart**](TaxProviderUltraCart.md) | TaxProviderUltraCart object | |
2004
-
2005
- ### Return type
2006
-
2007
- [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
2008
-
2009
- ### Authorization
2010
-
2011
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2012
-
2013
- ### HTTP request headers
2014
-
2015
- - **Content-Type**: application/json
2016
- - **Accept**: application/json
2017
-
1
+ # UltracartClient::TaxApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_tax_provider_self_city**](TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city |
8
+ | [**delete_tax_provider_self_country**](TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country |
9
+ | [**delete_tax_provider_self_county**](TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county |
10
+ | [**delete_tax_provider_self_postal_code**](TaxApi.md#delete_tax_provider_self_postal_code) | **DELETE** /tax/providers/self/postalCode/{postal_code} | Deletes a Self tax provider postalCode |
11
+ | [**delete_tax_provider_self_state**](TaxApi.md#delete_tax_provider_self_state) | **DELETE** /tax/providers/self/state/{stateCode} | Deletes a Self tax provider state |
12
+ | [**get_tax_provider_avalara**](TaxApi.md#get_tax_provider_avalara) | **GET** /tax/providers/avalara | Retrieve the Avalara tax provider |
13
+ | [**get_tax_provider_avalara_companies**](TaxApi.md#get_tax_provider_avalara_companies) | **POST** /tax/providers/avalara/companies | Returns Avalara Tax companies configured by the merchant |
14
+ | [**get_tax_provider_avalara_test**](TaxApi.md#get_tax_provider_avalara_test) | **GET** /tax/providers/avalara/test | Attempts to connect to Avalara and returns back the response |
15
+ | [**get_tax_provider_self**](TaxApi.md#get_tax_provider_self) | **GET** /tax/providers/self | Retrieve the Self tax provider |
16
+ | [**get_tax_provider_self_countries**](TaxApi.md#get_tax_provider_self_countries) | **GET** /tax/providers/self/countries | Retrieve the Self tax provider countries |
17
+ | [**get_tax_provider_self_regions_by_country_code**](TaxApi.md#get_tax_provider_self_regions_by_country_code) | **GET** /tax/providers/self/regions/{countryCode} | Retrieve the Self tax provider regions for a given country code |
18
+ | [**get_tax_provider_sovos**](TaxApi.md#get_tax_provider_sovos) | **GET** /tax/providers/sovos | Retrieve the Sovos tax provider |
19
+ | [**get_tax_provider_sovos_test**](TaxApi.md#get_tax_provider_sovos_test) | **GET** /tax/providers/sovos/test | Attempts to connect to Sovos and returns back the response |
20
+ | [**get_tax_provider_tax_jar**](TaxApi.md#get_tax_provider_tax_jar) | **GET** /tax/providers/taxjar | Retrieve the TaxJar tax provider |
21
+ | [**get_tax_provider_tax_jar_test**](TaxApi.md#get_tax_provider_tax_jar_test) | **GET** /tax/providers/taxjar/test | Attempts to connect to TaxJar and returns back the response |
22
+ | [**get_tax_provider_ultra_cart**](TaxApi.md#get_tax_provider_ultra_cart) | **GET** /tax/providers/ultracart | Retrieve the UltraCart tax provider |
23
+ | [**get_tax_providers**](TaxApi.md#get_tax_providers) | **GET** /tax/providers | Retrieve tax methods |
24
+ | [**set_active_tax_provider**](TaxApi.md#set_active_tax_provider) | **POST** /tax/providers/setActive/{providerName} | Toggle a tax provider to active |
25
+ | [**update_tax_provider_avalara**](TaxApi.md#update_tax_provider_avalara) | **POST** /tax/providers/avalara | Update the Avalara tax provider |
26
+ | [**update_tax_provider_self**](TaxApi.md#update_tax_provider_self) | **POST** /tax/providers/self | Update the Self tax provider |
27
+ | [**update_tax_provider_self_city**](TaxApi.md#update_tax_provider_self_city) | **POST** /tax/providers/self/city/{city} | Updates a Self tax provider city |
28
+ | [**update_tax_provider_self_country**](TaxApi.md#update_tax_provider_self_country) | **POST** /tax/providers/self/country/{countryCode} | Updates a Self tax provider country |
29
+ | [**update_tax_provider_self_county**](TaxApi.md#update_tax_provider_self_county) | **POST** /tax/providers/self/county/{county} | Updates a Self tax provider county |
30
+ | [**update_tax_provider_self_postal_code**](TaxApi.md#update_tax_provider_self_postal_code) | **POST** /tax/providers/self/postalCode/{postal_code} | Updates a Self tax provider postalCode |
31
+ | [**update_tax_provider_self_state**](TaxApi.md#update_tax_provider_self_state) | **POST** /tax/providers/self/state/{stateCode} | Updates a Self tax provider state |
32
+ | [**update_tax_provider_sovos**](TaxApi.md#update_tax_provider_sovos) | **POST** /tax/providers/sovos | Update the Sovos tax provider |
33
+ | [**update_tax_provider_tax_jar**](TaxApi.md#update_tax_provider_tax_jar) | **POST** /tax/providers/taxjar | Update the TaxJar tax provider |
34
+ | [**update_tax_provider_ultra_cart**](TaxApi.md#update_tax_provider_ultra_cart) | **POST** /tax/providers/ultracart | Update the UltraCart tax provider |
35
+
36
+
37
+ ## delete_tax_provider_self_city
38
+
39
+ > delete_tax_provider_self_city(city, tax_city)
40
+
41
+ Deletes a Self tax provider city
42
+
43
+ Deletes a Self tax provider city.
44
+
45
+
46
+ ### Examples
47
+
48
+ ```ruby
49
+ # Internal API. No samples are provided as merchants will never need this api method
50
+ ```
51
+
52
+
53
+ #### Using the delete_tax_provider_self_city_with_http_info variant
54
+
55
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
56
+
57
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_city_with_http_info(city, tax_city)
58
+
59
+ ```ruby
60
+ begin
61
+ # Deletes a Self tax provider city
62
+ data, status_code, headers = api_instance.delete_tax_provider_self_city_with_http_info(city, tax_city)
63
+ p status_code # => 2xx
64
+ p headers # => { ... }
65
+ p data # => nil
66
+ rescue UltracartClient::ApiError => e
67
+ puts "Error when calling TaxApi->delete_tax_provider_self_city_with_http_info: #{e}"
68
+ end
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Name | Type | Description | Notes |
74
+ | ---- | ---- | ----------- | ----- |
75
+ | **city** | **String** | The city being deleted. | |
76
+ | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be deleted | |
77
+
78
+ ### Return type
79
+
80
+ nil (empty response body)
81
+
82
+ ### Authorization
83
+
84
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: application/json
89
+ - **Accept**: application/json
90
+
91
+
92
+ ## delete_tax_provider_self_country
93
+
94
+ > delete_tax_provider_self_country(country_code, tax_country)
95
+
96
+ Deletes a Self tax provider country
97
+
98
+ Deletes a Self tax provider country.
99
+
100
+
101
+ ### Examples
102
+
103
+ ```ruby
104
+ # Internal API. No samples are provided as merchants will never need this api method
105
+ ```
106
+
107
+
108
+ #### Using the delete_tax_provider_self_country_with_http_info variant
109
+
110
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
111
+
112
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_country_with_http_info(country_code, tax_country)
113
+
114
+ ```ruby
115
+ begin
116
+ # Deletes a Self tax provider country
117
+ data, status_code, headers = api_instance.delete_tax_provider_self_country_with_http_info(country_code, tax_country)
118
+ p status_code # => 2xx
119
+ p headers # => { ... }
120
+ p data # => nil
121
+ rescue UltracartClient::ApiError => e
122
+ puts "Error when calling TaxApi->delete_tax_provider_self_country_with_http_info: #{e}"
123
+ end
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ | Name | Type | Description | Notes |
129
+ | ---- | ---- | ----------- | ----- |
130
+ | **country_code** | **String** | The country code being deleted. | |
131
+ | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be deleted | |
132
+
133
+ ### Return type
134
+
135
+ nil (empty response body)
136
+
137
+ ### Authorization
138
+
139
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
140
+
141
+ ### HTTP request headers
142
+
143
+ - **Content-Type**: application/json
144
+ - **Accept**: application/json
145
+
146
+
147
+ ## delete_tax_provider_self_county
148
+
149
+ > delete_tax_provider_self_county(county, tax_county)
150
+
151
+ Deletes a Self tax provider county
152
+
153
+ Deletes a Self tax provider county.
154
+
155
+
156
+ ### Examples
157
+
158
+ ```ruby
159
+ # Internal API. No samples are provided as merchants will never need this api method
160
+ ```
161
+
162
+
163
+ #### Using the delete_tax_provider_self_county_with_http_info variant
164
+
165
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
166
+
167
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_county_with_http_info(county, tax_county)
168
+
169
+ ```ruby
170
+ begin
171
+ # Deletes a Self tax provider county
172
+ data, status_code, headers = api_instance.delete_tax_provider_self_county_with_http_info(county, tax_county)
173
+ p status_code # => 2xx
174
+ p headers # => { ... }
175
+ p data # => nil
176
+ rescue UltracartClient::ApiError => e
177
+ puts "Error when calling TaxApi->delete_tax_provider_self_county_with_http_info: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ | Name | Type | Description | Notes |
184
+ | ---- | ---- | ----------- | ----- |
185
+ | **county** | **String** | The county being deleted. | |
186
+ | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be deleted | |
187
+
188
+ ### Return type
189
+
190
+ nil (empty response body)
191
+
192
+ ### Authorization
193
+
194
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
195
+
196
+ ### HTTP request headers
197
+
198
+ - **Content-Type**: application/json
199
+ - **Accept**: application/json
200
+
201
+
202
+ ## delete_tax_provider_self_postal_code
203
+
204
+ > delete_tax_provider_self_postal_code(postal_code, tax_postal_code)
205
+
206
+ Deletes a Self tax provider postalCode
207
+
208
+ Deletes a Self tax provider postalCode.
209
+
210
+
211
+ ### Examples
212
+
213
+ ```ruby
214
+ # Internal API. No samples are provided as merchants will never need this api method
215
+ ```
216
+
217
+
218
+ #### Using the delete_tax_provider_self_postal_code_with_http_info variant
219
+
220
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
221
+
222
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
223
+
224
+ ```ruby
225
+ begin
226
+ # Deletes a Self tax provider postalCode
227
+ data, status_code, headers = api_instance.delete_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
228
+ p status_code # => 2xx
229
+ p headers # => { ... }
230
+ p data # => nil
231
+ rescue UltracartClient::ApiError => e
232
+ puts "Error when calling TaxApi->delete_tax_provider_self_postal_code_with_http_info: #{e}"
233
+ end
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+ | Name | Type | Description | Notes |
239
+ | ---- | ---- | ----------- | ----- |
240
+ | **postal_code** | **String** | The postal code being deleted. | |
241
+ | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be deleted | |
242
+
243
+ ### Return type
244
+
245
+ nil (empty response body)
246
+
247
+ ### Authorization
248
+
249
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
250
+
251
+ ### HTTP request headers
252
+
253
+ - **Content-Type**: application/json
254
+ - **Accept**: application/json
255
+
256
+
257
+ ## delete_tax_provider_self_state
258
+
259
+ > delete_tax_provider_self_state(state_code, tax_state)
260
+
261
+ Deletes a Self tax provider state
262
+
263
+ Deletes a Self tax provider state.
264
+
265
+
266
+ ### Examples
267
+
268
+ ```ruby
269
+ # Internal API. No samples are provided as merchants will never need this api method
270
+ ```
271
+
272
+
273
+ #### Using the delete_tax_provider_self_state_with_http_info variant
274
+
275
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
276
+
277
+ > <Array(nil, Integer, Hash)> delete_tax_provider_self_state_with_http_info(state_code, tax_state)
278
+
279
+ ```ruby
280
+ begin
281
+ # Deletes a Self tax provider state
282
+ data, status_code, headers = api_instance.delete_tax_provider_self_state_with_http_info(state_code, tax_state)
283
+ p status_code # => 2xx
284
+ p headers # => { ... }
285
+ p data # => nil
286
+ rescue UltracartClient::ApiError => e
287
+ puts "Error when calling TaxApi->delete_tax_provider_self_state_with_http_info: #{e}"
288
+ end
289
+ ```
290
+
291
+ ### Parameters
292
+
293
+ | Name | Type | Description | Notes |
294
+ | ---- | ---- | ----------- | ----- |
295
+ | **state_code** | **String** | The state code being deleted. | |
296
+ | **tax_state** | [**TaxState**](TaxState.md) | tax state to be deleted | |
297
+
298
+ ### Return type
299
+
300
+ nil (empty response body)
301
+
302
+ ### Authorization
303
+
304
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
305
+
306
+ ### HTTP request headers
307
+
308
+ - **Content-Type**: application/json
309
+ - **Accept**: application/json
310
+
311
+
312
+ ## get_tax_provider_avalara
313
+
314
+ > <TaxProviderAvalara> get_tax_provider_avalara
315
+
316
+ Retrieve the Avalara tax provider
317
+
318
+ Retrieves the Avalara tax provider.
319
+
320
+
321
+ ### Examples
322
+
323
+ ```ruby
324
+ # Internal API. No samples are provided as merchants will never need this api method
325
+ ```
326
+
327
+
328
+ #### Using the get_tax_provider_avalara_with_http_info variant
329
+
330
+ This returns an Array which contains the response data, status code and headers.
331
+
332
+ > <Array(<TaxProviderAvalara>, Integer, Hash)> get_tax_provider_avalara_with_http_info
333
+
334
+ ```ruby
335
+ begin
336
+ # Retrieve the Avalara tax provider
337
+ data, status_code, headers = api_instance.get_tax_provider_avalara_with_http_info
338
+ p status_code # => 2xx
339
+ p headers # => { ... }
340
+ p data # => <TaxProviderAvalara>
341
+ rescue UltracartClient::ApiError => e
342
+ puts "Error when calling TaxApi->get_tax_provider_avalara_with_http_info: #{e}"
343
+ end
344
+ ```
345
+
346
+ ### Parameters
347
+
348
+ This endpoint does not need any parameter.
349
+
350
+ ### Return type
351
+
352
+ [**TaxProviderAvalara**](TaxProviderAvalara.md)
353
+
354
+ ### Authorization
355
+
356
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: Not defined
361
+ - **Accept**: application/json
362
+
363
+
364
+ ## get_tax_provider_avalara_companies
365
+
366
+ > <TaxProviderAvalaraCompaniesResult> get_tax_provider_avalara_companies(tax_provider_avalara)
367
+
368
+ Returns Avalara Tax companies configured by the merchant
369
+
370
+ Returns Avalara Tax companies configured by the merchant
371
+
372
+
373
+ ### Examples
374
+
375
+ ```ruby
376
+ # Internal API. No samples are provided as merchants will never need this api method
377
+ ```
378
+
379
+
380
+ #### Using the get_tax_provider_avalara_companies_with_http_info variant
381
+
382
+ This returns an Array which contains the response data, status code and headers.
383
+
384
+ > <Array(<TaxProviderAvalaraCompaniesResult>, Integer, Hash)> get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
385
+
386
+ ```ruby
387
+ begin
388
+ # Returns Avalara Tax companies configured by the merchant
389
+ data, status_code, headers = api_instance.get_tax_provider_avalara_companies_with_http_info(tax_provider_avalara)
390
+ p status_code # => 2xx
391
+ p headers # => { ... }
392
+ p data # => <TaxProviderAvalaraCompaniesResult>
393
+ rescue UltracartClient::ApiError => e
394
+ puts "Error when calling TaxApi->get_tax_provider_avalara_companies_with_http_info: #{e}"
395
+ end
396
+ ```
397
+
398
+ ### Parameters
399
+
400
+ | Name | Type | Description | Notes |
401
+ | ---- | ---- | ----------- | ----- |
402
+ | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
403
+
404
+ ### Return type
405
+
406
+ [**TaxProviderAvalaraCompaniesResult**](TaxProviderAvalaraCompaniesResult.md)
407
+
408
+ ### Authorization
409
+
410
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
411
+
412
+ ### HTTP request headers
413
+
414
+ - **Content-Type**: application/json
415
+ - **Accept**: application/json
416
+
417
+
418
+ ## get_tax_provider_avalara_test
419
+
420
+ > <TaxProviderTestResult> get_tax_provider_avalara_test
421
+
422
+ Attempts to connect to Avalara and returns back the response
423
+
424
+ Attempts to connect to Avalara and returns back the response.
425
+
426
+
427
+ ### Examples
428
+
429
+ ```ruby
430
+ # Internal API. No samples are provided as merchants will never need this api method
431
+ ```
432
+
433
+
434
+ #### Using the get_tax_provider_avalara_test_with_http_info variant
435
+
436
+ This returns an Array which contains the response data, status code and headers.
437
+
438
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_avalara_test_with_http_info
439
+
440
+ ```ruby
441
+ begin
442
+ # Attempts to connect to Avalara and returns back the response
443
+ data, status_code, headers = api_instance.get_tax_provider_avalara_test_with_http_info
444
+ p status_code # => 2xx
445
+ p headers # => { ... }
446
+ p data # => <TaxProviderTestResult>
447
+ rescue UltracartClient::ApiError => e
448
+ puts "Error when calling TaxApi->get_tax_provider_avalara_test_with_http_info: #{e}"
449
+ end
450
+ ```
451
+
452
+ ### Parameters
453
+
454
+ This endpoint does not need any parameter.
455
+
456
+ ### Return type
457
+
458
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
459
+
460
+ ### Authorization
461
+
462
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
463
+
464
+ ### HTTP request headers
465
+
466
+ - **Content-Type**: Not defined
467
+ - **Accept**: application/json
468
+
469
+
470
+ ## get_tax_provider_self
471
+
472
+ > <TaxProviderSelf> get_tax_provider_self
473
+
474
+ Retrieve the Self tax provider
475
+
476
+ Retrieves the Self tax provider.
477
+
478
+
479
+ ### Examples
480
+
481
+ ```ruby
482
+ # Internal API. No samples are provided as merchants will never need this api method
483
+ ```
484
+
485
+
486
+ #### Using the get_tax_provider_self_with_http_info variant
487
+
488
+ This returns an Array which contains the response data, status code and headers.
489
+
490
+ > <Array(<TaxProviderSelf>, Integer, Hash)> get_tax_provider_self_with_http_info
491
+
492
+ ```ruby
493
+ begin
494
+ # Retrieve the Self tax provider
495
+ data, status_code, headers = api_instance.get_tax_provider_self_with_http_info
496
+ p status_code # => 2xx
497
+ p headers # => { ... }
498
+ p data # => <TaxProviderSelf>
499
+ rescue UltracartClient::ApiError => e
500
+ puts "Error when calling TaxApi->get_tax_provider_self_with_http_info: #{e}"
501
+ end
502
+ ```
503
+
504
+ ### Parameters
505
+
506
+ This endpoint does not need any parameter.
507
+
508
+ ### Return type
509
+
510
+ [**TaxProviderSelf**](TaxProviderSelf.md)
511
+
512
+ ### Authorization
513
+
514
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
515
+
516
+ ### HTTP request headers
517
+
518
+ - **Content-Type**: Not defined
519
+ - **Accept**: application/json
520
+
521
+
522
+ ## get_tax_provider_self_countries
523
+
524
+ > <TaxProviderSelfCountriesResponse> get_tax_provider_self_countries
525
+
526
+ Retrieve the Self tax provider countries
527
+
528
+ Retrieves the Self tax provider countries.
529
+
530
+
531
+ ### Examples
532
+
533
+ ```ruby
534
+ # Internal API. No samples are provided as merchants will never need this api method
535
+ ```
536
+
537
+
538
+ #### Using the get_tax_provider_self_countries_with_http_info variant
539
+
540
+ This returns an Array which contains the response data, status code and headers.
541
+
542
+ > <Array(<TaxProviderSelfCountriesResponse>, Integer, Hash)> get_tax_provider_self_countries_with_http_info
543
+
544
+ ```ruby
545
+ begin
546
+ # Retrieve the Self tax provider countries
547
+ data, status_code, headers = api_instance.get_tax_provider_self_countries_with_http_info
548
+ p status_code # => 2xx
549
+ p headers # => { ... }
550
+ p data # => <TaxProviderSelfCountriesResponse>
551
+ rescue UltracartClient::ApiError => e
552
+ puts "Error when calling TaxApi->get_tax_provider_self_countries_with_http_info: #{e}"
553
+ end
554
+ ```
555
+
556
+ ### Parameters
557
+
558
+ This endpoint does not need any parameter.
559
+
560
+ ### Return type
561
+
562
+ [**TaxProviderSelfCountriesResponse**](TaxProviderSelfCountriesResponse.md)
563
+
564
+ ### Authorization
565
+
566
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
567
+
568
+ ### HTTP request headers
569
+
570
+ - **Content-Type**: Not defined
571
+ - **Accept**: application/json
572
+
573
+
574
+ ## get_tax_provider_self_regions_by_country_code
575
+
576
+ > <TaxProviderSelfRegionsResponse> get_tax_provider_self_regions_by_country_code(country_code)
577
+
578
+ Retrieve the Self tax provider regions for a given country code
579
+
580
+ Retrieves the Self tax provider regions for a given country code.
581
+
582
+
583
+ ### Examples
584
+
585
+ ```ruby
586
+ # Internal API. No samples are provided as merchants will never need this api method
587
+ ```
588
+
589
+
590
+ #### Using the get_tax_provider_self_regions_by_country_code_with_http_info variant
591
+
592
+ This returns an Array which contains the response data, status code and headers.
593
+
594
+ > <Array(<TaxProviderSelfRegionsResponse>, Integer, Hash)> get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
595
+
596
+ ```ruby
597
+ begin
598
+ # Retrieve the Self tax provider regions for a given country code
599
+ data, status_code, headers = api_instance.get_tax_provider_self_regions_by_country_code_with_http_info(country_code)
600
+ p status_code # => 2xx
601
+ p headers # => { ... }
602
+ p data # => <TaxProviderSelfRegionsResponse>
603
+ rescue UltracartClient::ApiError => e
604
+ puts "Error when calling TaxApi->get_tax_provider_self_regions_by_country_code_with_http_info: #{e}"
605
+ end
606
+ ```
607
+
608
+ ### Parameters
609
+
610
+ | Name | Type | Description | Notes |
611
+ | ---- | ---- | ----------- | ----- |
612
+ | **country_code** | **String** | The country code regions desired. | |
613
+
614
+ ### Return type
615
+
616
+ [**TaxProviderSelfRegionsResponse**](TaxProviderSelfRegionsResponse.md)
617
+
618
+ ### Authorization
619
+
620
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
621
+
622
+ ### HTTP request headers
623
+
624
+ - **Content-Type**: Not defined
625
+ - **Accept**: application/json
626
+
627
+
628
+ ## get_tax_provider_sovos
629
+
630
+ > <TaxProviderSovos> get_tax_provider_sovos
631
+
632
+ Retrieve the Sovos tax provider
633
+
634
+ Retrieves the Sovos tax provider.
635
+
636
+
637
+ ### Examples
638
+
639
+ ```ruby
640
+ # Internal API. No samples are provided as merchants will never need this api method
641
+ ```
642
+
643
+
644
+ #### Using the get_tax_provider_sovos_with_http_info variant
645
+
646
+ This returns an Array which contains the response data, status code and headers.
647
+
648
+ > <Array(<TaxProviderSovos>, Integer, Hash)> get_tax_provider_sovos_with_http_info
649
+
650
+ ```ruby
651
+ begin
652
+ # Retrieve the Sovos tax provider
653
+ data, status_code, headers = api_instance.get_tax_provider_sovos_with_http_info
654
+ p status_code # => 2xx
655
+ p headers # => { ... }
656
+ p data # => <TaxProviderSovos>
657
+ rescue UltracartClient::ApiError => e
658
+ puts "Error when calling TaxApi->get_tax_provider_sovos_with_http_info: #{e}"
659
+ end
660
+ ```
661
+
662
+ ### Parameters
663
+
664
+ This endpoint does not need any parameter.
665
+
666
+ ### Return type
667
+
668
+ [**TaxProviderSovos**](TaxProviderSovos.md)
669
+
670
+ ### Authorization
671
+
672
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
673
+
674
+ ### HTTP request headers
675
+
676
+ - **Content-Type**: Not defined
677
+ - **Accept**: application/json
678
+
679
+
680
+ ## get_tax_provider_sovos_test
681
+
682
+ > <TaxProviderTestResult> get_tax_provider_sovos_test
683
+
684
+ Attempts to connect to Sovos and returns back the response
685
+
686
+ Attempts to connect to Sovos and returns back the response.
687
+
688
+
689
+ ### Examples
690
+
691
+ ```ruby
692
+ # Internal API. No samples are provided as merchants will never need this api method
693
+ ```
694
+
695
+
696
+ #### Using the get_tax_provider_sovos_test_with_http_info variant
697
+
698
+ This returns an Array which contains the response data, status code and headers.
699
+
700
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_sovos_test_with_http_info
701
+
702
+ ```ruby
703
+ begin
704
+ # Attempts to connect to Sovos and returns back the response
705
+ data, status_code, headers = api_instance.get_tax_provider_sovos_test_with_http_info
706
+ p status_code # => 2xx
707
+ p headers # => { ... }
708
+ p data # => <TaxProviderTestResult>
709
+ rescue UltracartClient::ApiError => e
710
+ puts "Error when calling TaxApi->get_tax_provider_sovos_test_with_http_info: #{e}"
711
+ end
712
+ ```
713
+
714
+ ### Parameters
715
+
716
+ This endpoint does not need any parameter.
717
+
718
+ ### Return type
719
+
720
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
721
+
722
+ ### Authorization
723
+
724
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: Not defined
729
+ - **Accept**: application/json
730
+
731
+
732
+ ## get_tax_provider_tax_jar
733
+
734
+ > <TaxProviderTaxJar> get_tax_provider_tax_jar
735
+
736
+ Retrieve the TaxJar tax provider
737
+
738
+ Retrieves the TaxJar tax provider.
739
+
740
+
741
+ ### Examples
742
+
743
+ ```ruby
744
+ # Internal API. No samples are provided as merchants will never need this api method
745
+ ```
746
+
747
+
748
+ #### Using the get_tax_provider_tax_jar_with_http_info variant
749
+
750
+ This returns an Array which contains the response data, status code and headers.
751
+
752
+ > <Array(<TaxProviderTaxJar>, Integer, Hash)> get_tax_provider_tax_jar_with_http_info
753
+
754
+ ```ruby
755
+ begin
756
+ # Retrieve the TaxJar tax provider
757
+ data, status_code, headers = api_instance.get_tax_provider_tax_jar_with_http_info
758
+ p status_code # => 2xx
759
+ p headers # => { ... }
760
+ p data # => <TaxProviderTaxJar>
761
+ rescue UltracartClient::ApiError => e
762
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar_with_http_info: #{e}"
763
+ end
764
+ ```
765
+
766
+ ### Parameters
767
+
768
+ This endpoint does not need any parameter.
769
+
770
+ ### Return type
771
+
772
+ [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
773
+
774
+ ### Authorization
775
+
776
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
777
+
778
+ ### HTTP request headers
779
+
780
+ - **Content-Type**: Not defined
781
+ - **Accept**: application/json
782
+
783
+
784
+ ## get_tax_provider_tax_jar_test
785
+
786
+ > <TaxProviderTestResult> get_tax_provider_tax_jar_test
787
+
788
+ Attempts to connect to TaxJar and returns back the response
789
+
790
+ Attempts to connect to TaxJar and returns back the response.
791
+
792
+
793
+ ### Examples
794
+
795
+ ```ruby
796
+ # Internal API. No samples are provided as merchants will never need this api method
797
+ ```
798
+
799
+
800
+ #### Using the get_tax_provider_tax_jar_test_with_http_info variant
801
+
802
+ This returns an Array which contains the response data, status code and headers.
803
+
804
+ > <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_tax_jar_test_with_http_info
805
+
806
+ ```ruby
807
+ begin
808
+ # Attempts to connect to TaxJar and returns back the response
809
+ data, status_code, headers = api_instance.get_tax_provider_tax_jar_test_with_http_info
810
+ p status_code # => 2xx
811
+ p headers # => { ... }
812
+ p data # => <TaxProviderTestResult>
813
+ rescue UltracartClient::ApiError => e
814
+ puts "Error when calling TaxApi->get_tax_provider_tax_jar_test_with_http_info: #{e}"
815
+ end
816
+ ```
817
+
818
+ ### Parameters
819
+
820
+ This endpoint does not need any parameter.
821
+
822
+ ### Return type
823
+
824
+ [**TaxProviderTestResult**](TaxProviderTestResult.md)
825
+
826
+ ### Authorization
827
+
828
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
829
+
830
+ ### HTTP request headers
831
+
832
+ - **Content-Type**: Not defined
833
+ - **Accept**: application/json
834
+
835
+
836
+ ## get_tax_provider_ultra_cart
837
+
838
+ > <TaxProviderUltraCart> get_tax_provider_ultra_cart
839
+
840
+ Retrieve the UltraCart tax provider
841
+
842
+ Retrieves the UltraCart tax provider.
843
+
844
+
845
+ ### Examples
846
+
847
+ ```ruby
848
+ # Internal API. No samples are provided as merchants will never need this api method
849
+ ```
850
+
851
+
852
+ #### Using the get_tax_provider_ultra_cart_with_http_info variant
853
+
854
+ This returns an Array which contains the response data, status code and headers.
855
+
856
+ > <Array(<TaxProviderUltraCart>, Integer, Hash)> get_tax_provider_ultra_cart_with_http_info
857
+
858
+ ```ruby
859
+ begin
860
+ # Retrieve the UltraCart tax provider
861
+ data, status_code, headers = api_instance.get_tax_provider_ultra_cart_with_http_info
862
+ p status_code # => 2xx
863
+ p headers # => { ... }
864
+ p data # => <TaxProviderUltraCart>
865
+ rescue UltracartClient::ApiError => e
866
+ puts "Error when calling TaxApi->get_tax_provider_ultra_cart_with_http_info: #{e}"
867
+ end
868
+ ```
869
+
870
+ ### Parameters
871
+
872
+ This endpoint does not need any parameter.
873
+
874
+ ### Return type
875
+
876
+ [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
877
+
878
+ ### Authorization
879
+
880
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
881
+
882
+ ### HTTP request headers
883
+
884
+ - **Content-Type**: Not defined
885
+ - **Accept**: application/json
886
+
887
+
888
+ ## get_tax_providers
889
+
890
+ > <TaxProvidersResponse> get_tax_providers(opts)
891
+
892
+ Retrieve tax methods
893
+
894
+ Retrieves tax methods for this account.
895
+
896
+
897
+ ### Examples
898
+
899
+ ```ruby
900
+ # Internal API. No samples are provided as merchants will never need this api method
901
+ ```
902
+
903
+
904
+ #### Using the get_tax_providers_with_http_info variant
905
+
906
+ This returns an Array which contains the response data, status code and headers.
907
+
908
+ > <Array(<TaxProvidersResponse>, Integer, Hash)> get_tax_providers_with_http_info(opts)
909
+
910
+ ```ruby
911
+ begin
912
+ # Retrieve tax methods
913
+ data, status_code, headers = api_instance.get_tax_providers_with_http_info(opts)
914
+ p status_code # => 2xx
915
+ p headers # => { ... }
916
+ p data # => <TaxProvidersResponse>
917
+ rescue UltracartClient::ApiError => e
918
+ puts "Error when calling TaxApi->get_tax_providers_with_http_info: #{e}"
919
+ end
920
+ ```
921
+
922
+ ### Parameters
923
+
924
+ | Name | Type | Description | Notes |
925
+ | ---- | ---- | ----------- | ----- |
926
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
927
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
928
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
929
+
930
+ ### Return type
931
+
932
+ [**TaxProvidersResponse**](TaxProvidersResponse.md)
933
+
934
+ ### Authorization
935
+
936
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: Not defined
941
+ - **Accept**: application/json
942
+
943
+
944
+ ## set_active_tax_provider
945
+
946
+ > <TaxProviderActivateResult> set_active_tax_provider(provider_name)
947
+
948
+ Toggle a tax provider to active
949
+
950
+ Toggle a tax provider to active.
951
+
952
+
953
+ ### Examples
954
+
955
+ ```ruby
956
+ # Internal API. No samples are provided as merchants will never need this api method
957
+ ```
958
+
959
+
960
+ #### Using the set_active_tax_provider_with_http_info variant
961
+
962
+ This returns an Array which contains the response data, status code and headers.
963
+
964
+ > <Array(<TaxProviderActivateResult>, Integer, Hash)> set_active_tax_provider_with_http_info(provider_name)
965
+
966
+ ```ruby
967
+ begin
968
+ # Toggle a tax provider to active
969
+ data, status_code, headers = api_instance.set_active_tax_provider_with_http_info(provider_name)
970
+ p status_code # => 2xx
971
+ p headers # => { ... }
972
+ p data # => <TaxProviderActivateResult>
973
+ rescue UltracartClient::ApiError => e
974
+ puts "Error when calling TaxApi->set_active_tax_provider_with_http_info: #{e}"
975
+ end
976
+ ```
977
+
978
+ ### Parameters
979
+
980
+ | Name | Type | Description | Notes |
981
+ | ---- | ---- | ----------- | ----- |
982
+ | **provider_name** | **String** | The tax provider to set active. | |
983
+
984
+ ### Return type
985
+
986
+ [**TaxProviderActivateResult**](TaxProviderActivateResult.md)
987
+
988
+ ### Authorization
989
+
990
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
991
+
992
+ ### HTTP request headers
993
+
994
+ - **Content-Type**: Not defined
995
+ - **Accept**: application/json
996
+
997
+
998
+ ## update_tax_provider_avalara
999
+
1000
+ > <TaxProviderAvalara> update_tax_provider_avalara(tax_provider_avalara)
1001
+
1002
+ Update the Avalara tax provider
1003
+
1004
+ Update the Avalara tax provider.
1005
+
1006
+
1007
+ ### Examples
1008
+
1009
+ ```ruby
1010
+ # Internal API. No samples are provided as merchants will never need this api method
1011
+ ```
1012
+
1013
+
1014
+ #### Using the update_tax_provider_avalara_with_http_info variant
1015
+
1016
+ This returns an Array which contains the response data, status code and headers.
1017
+
1018
+ > <Array(<TaxProviderAvalara>, Integer, Hash)> update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1019
+
1020
+ ```ruby
1021
+ begin
1022
+ # Update the Avalara tax provider
1023
+ data, status_code, headers = api_instance.update_tax_provider_avalara_with_http_info(tax_provider_avalara)
1024
+ p status_code # => 2xx
1025
+ p headers # => { ... }
1026
+ p data # => <TaxProviderAvalara>
1027
+ rescue UltracartClient::ApiError => e
1028
+ puts "Error when calling TaxApi->update_tax_provider_avalara_with_http_info: #{e}"
1029
+ end
1030
+ ```
1031
+
1032
+ ### Parameters
1033
+
1034
+ | Name | Type | Description | Notes |
1035
+ | ---- | ---- | ----------- | ----- |
1036
+ | **tax_provider_avalara** | [**TaxProviderAvalara**](TaxProviderAvalara.md) | TaxProviderAvalara object | |
1037
+
1038
+ ### Return type
1039
+
1040
+ [**TaxProviderAvalara**](TaxProviderAvalara.md)
1041
+
1042
+ ### Authorization
1043
+
1044
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1045
+
1046
+ ### HTTP request headers
1047
+
1048
+ - **Content-Type**: application/json
1049
+ - **Accept**: application/json
1050
+
1051
+
1052
+ ## update_tax_provider_self
1053
+
1054
+ > <TaxProviderSelf> update_tax_provider_self(tax_provider_self)
1055
+
1056
+ Update the Self tax provider
1057
+
1058
+ Update the Self tax provider.
1059
+
1060
+
1061
+ ### Examples
1062
+
1063
+ ```ruby
1064
+ # Internal API. No samples are provided as merchants will never need this api method
1065
+ ```
1066
+
1067
+
1068
+ #### Using the update_tax_provider_self_with_http_info variant
1069
+
1070
+ This returns an Array which contains the response data, status code and headers.
1071
+
1072
+ > <Array(<TaxProviderSelf>, Integer, Hash)> update_tax_provider_self_with_http_info(tax_provider_self)
1073
+
1074
+ ```ruby
1075
+ begin
1076
+ # Update the Self tax provider
1077
+ data, status_code, headers = api_instance.update_tax_provider_self_with_http_info(tax_provider_self)
1078
+ p status_code # => 2xx
1079
+ p headers # => { ... }
1080
+ p data # => <TaxProviderSelf>
1081
+ rescue UltracartClient::ApiError => e
1082
+ puts "Error when calling TaxApi->update_tax_provider_self_with_http_info: #{e}"
1083
+ end
1084
+ ```
1085
+
1086
+ ### Parameters
1087
+
1088
+ | Name | Type | Description | Notes |
1089
+ | ---- | ---- | ----------- | ----- |
1090
+ | **tax_provider_self** | [**TaxProviderSelf**](TaxProviderSelf.md) | TaxProviderSelf object | |
1091
+
1092
+ ### Return type
1093
+
1094
+ [**TaxProviderSelf**](TaxProviderSelf.md)
1095
+
1096
+ ### Authorization
1097
+
1098
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1099
+
1100
+ ### HTTP request headers
1101
+
1102
+ - **Content-Type**: application/json
1103
+ - **Accept**: application/json
1104
+
1105
+
1106
+ ## update_tax_provider_self_city
1107
+
1108
+ > <TaxCity> update_tax_provider_self_city(city, tax_city)
1109
+
1110
+ Updates a Self tax provider city
1111
+
1112
+ Updates a Self tax provider city.
1113
+
1114
+
1115
+ ### Examples
1116
+
1117
+ ```ruby
1118
+ # Internal API. No samples are provided as merchants will never need this api method
1119
+ ```
1120
+
1121
+
1122
+ #### Using the update_tax_provider_self_city_with_http_info variant
1123
+
1124
+ This returns an Array which contains the response data, status code and headers.
1125
+
1126
+ > <Array(<TaxCity>, Integer, Hash)> update_tax_provider_self_city_with_http_info(city, tax_city)
1127
+
1128
+ ```ruby
1129
+ begin
1130
+ # Updates a Self tax provider city
1131
+ data, status_code, headers = api_instance.update_tax_provider_self_city_with_http_info(city, tax_city)
1132
+ p status_code # => 2xx
1133
+ p headers # => { ... }
1134
+ p data # => <TaxCity>
1135
+ rescue UltracartClient::ApiError => e
1136
+ puts "Error when calling TaxApi->update_tax_provider_self_city_with_http_info: #{e}"
1137
+ end
1138
+ ```
1139
+
1140
+ ### Parameters
1141
+
1142
+ | Name | Type | Description | Notes |
1143
+ | ---- | ---- | ----------- | ----- |
1144
+ | **city** | **String** | The city being updated. | |
1145
+ | **tax_city** | [**TaxCity**](TaxCity.md) | tax city to be updated | |
1146
+
1147
+ ### Return type
1148
+
1149
+ [**TaxCity**](TaxCity.md)
1150
+
1151
+ ### Authorization
1152
+
1153
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1154
+
1155
+ ### HTTP request headers
1156
+
1157
+ - **Content-Type**: application/json
1158
+ - **Accept**: application/json
1159
+
1160
+
1161
+ ## update_tax_provider_self_country
1162
+
1163
+ > <TaxCountry> update_tax_provider_self_country(country_code, tax_country)
1164
+
1165
+ Updates a Self tax provider country
1166
+
1167
+ Updates a Self tax provider country.
1168
+
1169
+
1170
+ ### Examples
1171
+
1172
+ ```ruby
1173
+ # Internal API. No samples are provided as merchants will never need this api method
1174
+ ```
1175
+
1176
+
1177
+ #### Using the update_tax_provider_self_country_with_http_info variant
1178
+
1179
+ This returns an Array which contains the response data, status code and headers.
1180
+
1181
+ > <Array(<TaxCountry>, Integer, Hash)> update_tax_provider_self_country_with_http_info(country_code, tax_country)
1182
+
1183
+ ```ruby
1184
+ begin
1185
+ # Updates a Self tax provider country
1186
+ data, status_code, headers = api_instance.update_tax_provider_self_country_with_http_info(country_code, tax_country)
1187
+ p status_code # => 2xx
1188
+ p headers # => { ... }
1189
+ p data # => <TaxCountry>
1190
+ rescue UltracartClient::ApiError => e
1191
+ puts "Error when calling TaxApi->update_tax_provider_self_country_with_http_info: #{e}"
1192
+ end
1193
+ ```
1194
+
1195
+ ### Parameters
1196
+
1197
+ | Name | Type | Description | Notes |
1198
+ | ---- | ---- | ----------- | ----- |
1199
+ | **country_code** | **String** | The country code being updated. | |
1200
+ | **tax_country** | [**TaxCountry**](TaxCountry.md) | tax country to be updated | |
1201
+
1202
+ ### Return type
1203
+
1204
+ [**TaxCountry**](TaxCountry.md)
1205
+
1206
+ ### Authorization
1207
+
1208
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1209
+
1210
+ ### HTTP request headers
1211
+
1212
+ - **Content-Type**: application/json
1213
+ - **Accept**: application/json
1214
+
1215
+
1216
+ ## update_tax_provider_self_county
1217
+
1218
+ > <TaxCounty> update_tax_provider_self_county(county, tax_county)
1219
+
1220
+ Updates a Self tax provider county
1221
+
1222
+ Updates a Self tax provider county.
1223
+
1224
+
1225
+ ### Examples
1226
+
1227
+ ```ruby
1228
+ # Internal API. No samples are provided as merchants will never need this api method
1229
+ ```
1230
+
1231
+
1232
+ #### Using the update_tax_provider_self_county_with_http_info variant
1233
+
1234
+ This returns an Array which contains the response data, status code and headers.
1235
+
1236
+ > <Array(<TaxCounty>, Integer, Hash)> update_tax_provider_self_county_with_http_info(county, tax_county)
1237
+
1238
+ ```ruby
1239
+ begin
1240
+ # Updates a Self tax provider county
1241
+ data, status_code, headers = api_instance.update_tax_provider_self_county_with_http_info(county, tax_county)
1242
+ p status_code # => 2xx
1243
+ p headers # => { ... }
1244
+ p data # => <TaxCounty>
1245
+ rescue UltracartClient::ApiError => e
1246
+ puts "Error when calling TaxApi->update_tax_provider_self_county_with_http_info: #{e}"
1247
+ end
1248
+ ```
1249
+
1250
+ ### Parameters
1251
+
1252
+ | Name | Type | Description | Notes |
1253
+ | ---- | ---- | ----------- | ----- |
1254
+ | **county** | **String** | The county being updated. | |
1255
+ | **tax_county** | [**TaxCounty**](TaxCounty.md) | tax county to be updated | |
1256
+
1257
+ ### Return type
1258
+
1259
+ [**TaxCounty**](TaxCounty.md)
1260
+
1261
+ ### Authorization
1262
+
1263
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1264
+
1265
+ ### HTTP request headers
1266
+
1267
+ - **Content-Type**: application/json
1268
+ - **Accept**: application/json
1269
+
1270
+
1271
+ ## update_tax_provider_self_postal_code
1272
+
1273
+ > <TaxPostalCode> update_tax_provider_self_postal_code(postal_code, tax_postal_code)
1274
+
1275
+ Updates a Self tax provider postalCode
1276
+
1277
+ Updates a Self tax provider postalCode.
1278
+
1279
+
1280
+ ### Examples
1281
+
1282
+ ```ruby
1283
+ # Internal API. No samples are provided as merchants will never need this api method
1284
+ ```
1285
+
1286
+
1287
+ #### Using the update_tax_provider_self_postal_code_with_http_info variant
1288
+
1289
+ This returns an Array which contains the response data, status code and headers.
1290
+
1291
+ > <Array(<TaxPostalCode>, Integer, Hash)> update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1292
+
1293
+ ```ruby
1294
+ begin
1295
+ # Updates a Self tax provider postalCode
1296
+ data, status_code, headers = api_instance.update_tax_provider_self_postal_code_with_http_info(postal_code, tax_postal_code)
1297
+ p status_code # => 2xx
1298
+ p headers # => { ... }
1299
+ p data # => <TaxPostalCode>
1300
+ rescue UltracartClient::ApiError => e
1301
+ puts "Error when calling TaxApi->update_tax_provider_self_postal_code_with_http_info: #{e}"
1302
+ end
1303
+ ```
1304
+
1305
+ ### Parameters
1306
+
1307
+ | Name | Type | Description | Notes |
1308
+ | ---- | ---- | ----------- | ----- |
1309
+ | **postal_code** | **String** | The postal code being updated. | |
1310
+ | **tax_postal_code** | [**TaxPostalCode**](TaxPostalCode.md) | tax postal code to be updated | |
1311
+
1312
+ ### Return type
1313
+
1314
+ [**TaxPostalCode**](TaxPostalCode.md)
1315
+
1316
+ ### Authorization
1317
+
1318
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1319
+
1320
+ ### HTTP request headers
1321
+
1322
+ - **Content-Type**: application/json
1323
+ - **Accept**: application/json
1324
+
1325
+
1326
+ ## update_tax_provider_self_state
1327
+
1328
+ > <TaxState> update_tax_provider_self_state(state_code, tax_state)
1329
+
1330
+ Updates a Self tax provider state
1331
+
1332
+ Updates a Self tax provider state.
1333
+
1334
+
1335
+ ### Examples
1336
+
1337
+ ```ruby
1338
+ # Internal API. No samples are provided as merchants will never need this api method
1339
+ ```
1340
+
1341
+
1342
+ #### Using the update_tax_provider_self_state_with_http_info variant
1343
+
1344
+ This returns an Array which contains the response data, status code and headers.
1345
+
1346
+ > <Array(<TaxState>, Integer, Hash)> update_tax_provider_self_state_with_http_info(state_code, tax_state)
1347
+
1348
+ ```ruby
1349
+ begin
1350
+ # Updates a Self tax provider state
1351
+ data, status_code, headers = api_instance.update_tax_provider_self_state_with_http_info(state_code, tax_state)
1352
+ p status_code # => 2xx
1353
+ p headers # => { ... }
1354
+ p data # => <TaxState>
1355
+ rescue UltracartClient::ApiError => e
1356
+ puts "Error when calling TaxApi->update_tax_provider_self_state_with_http_info: #{e}"
1357
+ end
1358
+ ```
1359
+
1360
+ ### Parameters
1361
+
1362
+ | Name | Type | Description | Notes |
1363
+ | ---- | ---- | ----------- | ----- |
1364
+ | **state_code** | **String** | The state code being updated. | |
1365
+ | **tax_state** | [**TaxState**](TaxState.md) | tax state to be updated | |
1366
+
1367
+ ### Return type
1368
+
1369
+ [**TaxState**](TaxState.md)
1370
+
1371
+ ### Authorization
1372
+
1373
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1374
+
1375
+ ### HTTP request headers
1376
+
1377
+ - **Content-Type**: application/json
1378
+ - **Accept**: application/json
1379
+
1380
+
1381
+ ## update_tax_provider_sovos
1382
+
1383
+ > <TaxProviderSovos> update_tax_provider_sovos(tax_provider_sovos)
1384
+
1385
+ Update the Sovos tax provider
1386
+
1387
+ Update the Sovos tax provider.
1388
+
1389
+
1390
+ ### Examples
1391
+
1392
+ ```ruby
1393
+ # Internal API. No samples are provided as merchants will never need this api method
1394
+ ```
1395
+
1396
+
1397
+ #### Using the update_tax_provider_sovos_with_http_info variant
1398
+
1399
+ This returns an Array which contains the response data, status code and headers.
1400
+
1401
+ > <Array(<TaxProviderSovos>, Integer, Hash)> update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1402
+
1403
+ ```ruby
1404
+ begin
1405
+ # Update the Sovos tax provider
1406
+ data, status_code, headers = api_instance.update_tax_provider_sovos_with_http_info(tax_provider_sovos)
1407
+ p status_code # => 2xx
1408
+ p headers # => { ... }
1409
+ p data # => <TaxProviderSovos>
1410
+ rescue UltracartClient::ApiError => e
1411
+ puts "Error when calling TaxApi->update_tax_provider_sovos_with_http_info: #{e}"
1412
+ end
1413
+ ```
1414
+
1415
+ ### Parameters
1416
+
1417
+ | Name | Type | Description | Notes |
1418
+ | ---- | ---- | ----------- | ----- |
1419
+ | **tax_provider_sovos** | [**TaxProviderSovos**](TaxProviderSovos.md) | TaxProviderSovos object | |
1420
+
1421
+ ### Return type
1422
+
1423
+ [**TaxProviderSovos**](TaxProviderSovos.md)
1424
+
1425
+ ### Authorization
1426
+
1427
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1428
+
1429
+ ### HTTP request headers
1430
+
1431
+ - **Content-Type**: application/json
1432
+ - **Accept**: application/json
1433
+
1434
+
1435
+ ## update_tax_provider_tax_jar
1436
+
1437
+ > <TaxProviderTaxJar> update_tax_provider_tax_jar(tax_provider_tax_jar)
1438
+
1439
+ Update the TaxJar tax provider
1440
+
1441
+ Update the TaxJar tax provider.
1442
+
1443
+
1444
+ ### Examples
1445
+
1446
+ ```ruby
1447
+ # Internal API. No samples are provided as merchants will never need this api method
1448
+ ```
1449
+
1450
+
1451
+ #### Using the update_tax_provider_tax_jar_with_http_info variant
1452
+
1453
+ This returns an Array which contains the response data, status code and headers.
1454
+
1455
+ > <Array(<TaxProviderTaxJar>, Integer, Hash)> update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
1456
+
1457
+ ```ruby
1458
+ begin
1459
+ # Update the TaxJar tax provider
1460
+ data, status_code, headers = api_instance.update_tax_provider_tax_jar_with_http_info(tax_provider_tax_jar)
1461
+ p status_code # => 2xx
1462
+ p headers # => { ... }
1463
+ p data # => <TaxProviderTaxJar>
1464
+ rescue UltracartClient::ApiError => e
1465
+ puts "Error when calling TaxApi->update_tax_provider_tax_jar_with_http_info: #{e}"
1466
+ end
1467
+ ```
1468
+
1469
+ ### Parameters
1470
+
1471
+ | Name | Type | Description | Notes |
1472
+ | ---- | ---- | ----------- | ----- |
1473
+ | **tax_provider_tax_jar** | [**TaxProviderTaxJar**](TaxProviderTaxJar.md) | TaxProviderTaxJar object | |
1474
+
1475
+ ### Return type
1476
+
1477
+ [**TaxProviderTaxJar**](TaxProviderTaxJar.md)
1478
+
1479
+ ### Authorization
1480
+
1481
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1482
+
1483
+ ### HTTP request headers
1484
+
1485
+ - **Content-Type**: application/json
1486
+ - **Accept**: application/json
1487
+
1488
+
1489
+ ## update_tax_provider_ultra_cart
1490
+
1491
+ > <TaxProviderUltraCart> update_tax_provider_ultra_cart(tax_provider_ultracart)
1492
+
1493
+ Update the UltraCart tax provider
1494
+
1495
+ Update the UltraCart tax provider.
1496
+
1497
+
1498
+ ### Examples
1499
+
1500
+ ```ruby
1501
+ # Internal API. No samples are provided as merchants will never need this api method
1502
+ ```
1503
+
1504
+
1505
+ #### Using the update_tax_provider_ultra_cart_with_http_info variant
1506
+
1507
+ This returns an Array which contains the response data, status code and headers.
1508
+
1509
+ > <Array(<TaxProviderUltraCart>, Integer, Hash)> update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
1510
+
1511
+ ```ruby
1512
+ begin
1513
+ # Update the UltraCart tax provider
1514
+ data, status_code, headers = api_instance.update_tax_provider_ultra_cart_with_http_info(tax_provider_ultracart)
1515
+ p status_code # => 2xx
1516
+ p headers # => { ... }
1517
+ p data # => <TaxProviderUltraCart>
1518
+ rescue UltracartClient::ApiError => e
1519
+ puts "Error when calling TaxApi->update_tax_provider_ultra_cart_with_http_info: #{e}"
1520
+ end
1521
+ ```
1522
+
1523
+ ### Parameters
1524
+
1525
+ | Name | Type | Description | Notes |
1526
+ | ---- | ---- | ----------- | ----- |
1527
+ | **tax_provider_ultracart** | [**TaxProviderUltraCart**](TaxProviderUltraCart.md) | TaxProviderUltraCart object | |
1528
+
1529
+ ### Return type
1530
+
1531
+ [**TaxProviderUltraCart**](TaxProviderUltraCart.md)
1532
+
1533
+ ### Authorization
1534
+
1535
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1536
+
1537
+ ### HTTP request headers
1538
+
1539
+ - **Content-Type**: application/json
1540
+ - **Accept**: application/json
1541
+