ultracart_api 4.1.163 → 4.1.166

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