ultracart_api 4.1.175 → 4.1.176
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.
- checksums.yaml +4 -4
- data/README.md +10 -2
- data/docs/TaxApi.md +163 -5
- data/docs/TaxCloudConfig.md +30 -0
- data/docs/TaxProviderAnrokProduct.md +24 -0
- data/docs/TaxProviderAnrokTestResult.md +22 -0
- data/docs/TaxProviderTaxCloud.md +24 -0
- data/docs/TaxProvidersResponse.md +2 -0
- data/lib/ultracart_api/api/tax_api.rb +190 -5
- data/lib/ultracart_api/models/tax_cloud_config.rb +280 -0
- data/lib/ultracart_api/models/tax_provider_anrok_product.rb +250 -0
- data/lib/ultracart_api/models/tax_provider_anrok_test_result.rb +241 -0
- data/lib/ultracart_api/models/tax_provider_tax_cloud.rb +249 -0
- data/lib/ultracart_api/models/tax_providers_response.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +9 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7fd7d9b22eb441bbd63953ad47b59eaec06757e2c01f5a1185af5e86a80923a4
|
|
4
|
+
data.tar.gz: 83fbaab211de4ee96ff07cb8376c9decfcd61c1c58b1bf7b568867d8ce2afcc9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f5329ff0ed52d4e9588b00ebb9cd645cf43dbcb7c90d98f2377b5d35ca1c8d10961c3ded7809d514860a0163613f51b3bf5994b146005836bb7dc45cab4a6481
|
|
7
|
+
data.tar.gz: 9f51a64f4b60db5d09963ac6a99b6137907bb98cc371f75efdb8b100a34f73a617f8179249674260b8cd7d0fcbd73663f38f3956e6e69a09caf232b96bde5c77
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.176
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.176'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -771,6 +771,8 @@ Class | Method | HTTP request | Description
|
|
|
771
771
|
*UltracartClient::TaxApi* | [**get_tax_provider_self_regions_by_country_code**](docs/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
|
|
772
772
|
*UltracartClient::TaxApi* | [**get_tax_provider_sovos**](docs/TaxApi.md#get_tax_provider_sovos) | **GET** /tax/providers/sovos | Retrieve the Sovos tax provider
|
|
773
773
|
*UltracartClient::TaxApi* | [**get_tax_provider_sovos_test**](docs/TaxApi.md#get_tax_provider_sovos_test) | **GET** /tax/providers/sovos/test | Attempts to connect to Sovos and returns back the response
|
|
774
|
+
*UltracartClient::TaxApi* | [**get_tax_provider_tax_cloud**](docs/TaxApi.md#get_tax_provider_tax_cloud) | **GET** /tax/providers/taxcloud | Retrieve the TaxCloud tax provider
|
|
775
|
+
*UltracartClient::TaxApi* | [**get_tax_provider_tax_cloud_test**](docs/TaxApi.md#get_tax_provider_tax_cloud_test) | **GET** /tax/providers/taxcloud/test | Attempts to connect to TaxCloud and returns back the response
|
|
774
776
|
*UltracartClient::TaxApi* | [**get_tax_provider_tax_jar**](docs/TaxApi.md#get_tax_provider_tax_jar) | **GET** /tax/providers/taxjar | Retrieve the TaxJar tax provider
|
|
775
777
|
*UltracartClient::TaxApi* | [**get_tax_provider_tax_jar_test**](docs/TaxApi.md#get_tax_provider_tax_jar_test) | **GET** /tax/providers/taxjar/test | Attempts to connect to TaxJar and returns back the response
|
|
776
778
|
*UltracartClient::TaxApi* | [**get_tax_provider_ultra_cart**](docs/TaxApi.md#get_tax_provider_ultra_cart) | **GET** /tax/providers/ultracart | Retrieve the UltraCart tax provider
|
|
@@ -785,6 +787,7 @@ Class | Method | HTTP request | Description
|
|
|
785
787
|
*UltracartClient::TaxApi* | [**update_tax_provider_self_postal_code**](docs/TaxApi.md#update_tax_provider_self_postal_code) | **POST** /tax/providers/self/postalCode/{postal_code} | Updates a Self tax provider postalCode
|
|
786
788
|
*UltracartClient::TaxApi* | [**update_tax_provider_self_state**](docs/TaxApi.md#update_tax_provider_self_state) | **POST** /tax/providers/self/state/{stateCode} | Updates a Self tax provider state
|
|
787
789
|
*UltracartClient::TaxApi* | [**update_tax_provider_sovos**](docs/TaxApi.md#update_tax_provider_sovos) | **POST** /tax/providers/sovos | Update the Sovos tax provider
|
|
790
|
+
*UltracartClient::TaxApi* | [**update_tax_provider_tax_cloud**](docs/TaxApi.md#update_tax_provider_tax_cloud) | **POST** /tax/providers/taxcloud | Update the TaxCloud tax provider
|
|
788
791
|
*UltracartClient::TaxApi* | [**update_tax_provider_tax_jar**](docs/TaxApi.md#update_tax_provider_tax_jar) | **POST** /tax/providers/taxjar | Update the TaxJar tax provider
|
|
789
792
|
*UltracartClient::TaxApi* | [**update_tax_provider_ultra_cart**](docs/TaxApi.md#update_tax_provider_ultra_cart) | **POST** /tax/providers/ultracart | Update the UltraCart tax provider
|
|
790
793
|
*UltracartClient::UserApi* | [**delete_group**](docs/UserApi.md#delete_group) | **DELETE** /user/groups/{group_oid} | Delete a group
|
|
@@ -1920,6 +1923,7 @@ Class | Method | HTTP request | Description
|
|
|
1920
1923
|
- [UltracartClient::StoreFrontPageContentAttribute](docs/StoreFrontPageContentAttribute.md)
|
|
1921
1924
|
- [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
|
|
1922
1925
|
- [UltracartClient::TaxCity](docs/TaxCity.md)
|
|
1926
|
+
- [UltracartClient::TaxCloudConfig](docs/TaxCloudConfig.md)
|
|
1923
1927
|
- [UltracartClient::TaxCountry](docs/TaxCountry.md)
|
|
1924
1928
|
- [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
|
|
1925
1929
|
- [UltracartClient::TaxCounty](docs/TaxCounty.md)
|
|
@@ -1927,6 +1931,8 @@ Class | Method | HTTP request | Description
|
|
|
1927
1931
|
- [UltracartClient::TaxPostalCode](docs/TaxPostalCode.md)
|
|
1928
1932
|
- [UltracartClient::TaxProviderActivateResult](docs/TaxProviderActivateResult.md)
|
|
1929
1933
|
- [UltracartClient::TaxProviderAnrok](docs/TaxProviderAnrok.md)
|
|
1934
|
+
- [UltracartClient::TaxProviderAnrokProduct](docs/TaxProviderAnrokProduct.md)
|
|
1935
|
+
- [UltracartClient::TaxProviderAnrokTestResult](docs/TaxProviderAnrokTestResult.md)
|
|
1930
1936
|
- [UltracartClient::TaxProviderAvalara](docs/TaxProviderAvalara.md)
|
|
1931
1937
|
- [UltracartClient::TaxProviderAvalaraCompaniesResult](docs/TaxProviderAvalaraCompaniesResult.md)
|
|
1932
1938
|
- [UltracartClient::TaxProviderAvalaraCompany](docs/TaxProviderAvalaraCompany.md)
|
|
@@ -1934,6 +1940,7 @@ Class | Method | HTTP request | Description
|
|
|
1934
1940
|
- [UltracartClient::TaxProviderSelfCountriesResponse](docs/TaxProviderSelfCountriesResponse.md)
|
|
1935
1941
|
- [UltracartClient::TaxProviderSelfRegionsResponse](docs/TaxProviderSelfRegionsResponse.md)
|
|
1936
1942
|
- [UltracartClient::TaxProviderSovos](docs/TaxProviderSovos.md)
|
|
1943
|
+
- [UltracartClient::TaxProviderTaxCloud](docs/TaxProviderTaxCloud.md)
|
|
1937
1944
|
- [UltracartClient::TaxProviderTaxJar](docs/TaxProviderTaxJar.md)
|
|
1938
1945
|
- [UltracartClient::TaxProviderTestResult](docs/TaxProviderTestResult.md)
|
|
1939
1946
|
- [UltracartClient::TaxProviderUltraCart](docs/TaxProviderUltraCart.md)
|
|
@@ -2073,6 +2080,7 @@ Not every change is committed to every SDK.
|
|
|
2073
2080
|
|
|
2074
2081
|
| Version | Date | Comments |
|
|
2075
2082
|
| --: | :-: | --- |
|
|
2083
|
+
| 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
|
|
2076
2084
|
| 4.1.175 | 09/29/2026 | sfvb internal testing |
|
|
2077
2085
|
| 4.1.174 | 09/25/2026 | sfvb internal testing |
|
|
2078
2086
|
| 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
|
data/docs/TaxApi.md
CHANGED
|
@@ -19,6 +19,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
19
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
20
|
| [**get_tax_provider_sovos**](TaxApi.md#get_tax_provider_sovos) | **GET** /tax/providers/sovos | Retrieve the Sovos tax provider |
|
|
21
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_cloud**](TaxApi.md#get_tax_provider_tax_cloud) | **GET** /tax/providers/taxcloud | Retrieve the TaxCloud tax provider |
|
|
23
|
+
| [**get_tax_provider_tax_cloud_test**](TaxApi.md#get_tax_provider_tax_cloud_test) | **GET** /tax/providers/taxcloud/test | Attempts to connect to TaxCloud and returns back the response |
|
|
22
24
|
| [**get_tax_provider_tax_jar**](TaxApi.md#get_tax_provider_tax_jar) | **GET** /tax/providers/taxjar | Retrieve the TaxJar tax provider |
|
|
23
25
|
| [**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
26
|
| [**get_tax_provider_ultra_cart**](TaxApi.md#get_tax_provider_ultra_cart) | **GET** /tax/providers/ultracart | Retrieve the UltraCart tax provider |
|
|
@@ -33,6 +35,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
33
35
|
| [**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
36
|
| [**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
37
|
| [**update_tax_provider_sovos**](TaxApi.md#update_tax_provider_sovos) | **POST** /tax/providers/sovos | Update the Sovos tax provider |
|
|
38
|
+
| [**update_tax_provider_tax_cloud**](TaxApi.md#update_tax_provider_tax_cloud) | **POST** /tax/providers/taxcloud | Update the TaxCloud tax provider |
|
|
36
39
|
| [**update_tax_provider_tax_jar**](TaxApi.md#update_tax_provider_tax_jar) | **POST** /tax/providers/taxjar | Update the TaxJar tax provider |
|
|
37
40
|
| [**update_tax_provider_ultra_cart**](TaxApi.md#update_tax_provider_ultra_cart) | **POST** /tax/providers/ultracart | Update the UltraCart tax provider |
|
|
38
41
|
|
|
@@ -365,11 +368,11 @@ This endpoint does not need any parameter.
|
|
|
365
368
|
|
|
366
369
|
## get_tax_provider_anrok_test
|
|
367
370
|
|
|
368
|
-
> <
|
|
371
|
+
> <TaxProviderAnrokTestResult> get_tax_provider_anrok_test
|
|
369
372
|
|
|
370
373
|
Attempts to connect to Anrok and returns back the response
|
|
371
374
|
|
|
372
|
-
Attempts to connect to Anrok and returns back the response.
|
|
375
|
+
Attempts to connect to Anrok and returns back the response, including the products configured on the merchant's Anrok account.
|
|
373
376
|
|
|
374
377
|
|
|
375
378
|
### Examples
|
|
@@ -382,7 +385,7 @@ Attempts to connect to Anrok and returns back the response.
|
|
|
382
385
|
|
|
383
386
|
This returns an Array which contains the response data, status code and headers.
|
|
384
387
|
|
|
385
|
-
> <Array(<
|
|
388
|
+
> <Array(<TaxProviderAnrokTestResult>, Integer, Hash)> get_tax_provider_anrok_test_with_http_info
|
|
386
389
|
|
|
387
390
|
```ruby
|
|
388
391
|
begin
|
|
@@ -390,7 +393,7 @@ begin
|
|
|
390
393
|
data, status_code, headers = api_instance.get_tax_provider_anrok_test_with_http_info
|
|
391
394
|
p status_code # => 2xx
|
|
392
395
|
p headers # => { ... }
|
|
393
|
-
p data # => <
|
|
396
|
+
p data # => <TaxProviderAnrokTestResult>
|
|
394
397
|
rescue UltracartClient::ApiError => e
|
|
395
398
|
puts "Error when calling TaxApi->get_tax_provider_anrok_test_with_http_info: #{e}"
|
|
396
399
|
end
|
|
@@ -402,7 +405,7 @@ This endpoint does not need any parameter.
|
|
|
402
405
|
|
|
403
406
|
### Return type
|
|
404
407
|
|
|
405
|
-
[**
|
|
408
|
+
[**TaxProviderAnrokTestResult**](TaxProviderAnrokTestResult.md)
|
|
406
409
|
|
|
407
410
|
### Authorization
|
|
408
411
|
|
|
@@ -834,6 +837,108 @@ This endpoint does not need any parameter.
|
|
|
834
837
|
- **Accept**: application/json
|
|
835
838
|
|
|
836
839
|
|
|
840
|
+
## get_tax_provider_tax_cloud
|
|
841
|
+
|
|
842
|
+
> <TaxProviderTaxCloud> get_tax_provider_tax_cloud
|
|
843
|
+
|
|
844
|
+
Retrieve the TaxCloud tax provider
|
|
845
|
+
|
|
846
|
+
Retrieves the TaxCloud tax provider.
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
### Examples
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
(No example for this operation).
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
#### Using the get_tax_provider_tax_cloud_with_http_info variant
|
|
856
|
+
|
|
857
|
+
This returns an Array which contains the response data, status code and headers.
|
|
858
|
+
|
|
859
|
+
> <Array(<TaxProviderTaxCloud>, Integer, Hash)> get_tax_provider_tax_cloud_with_http_info
|
|
860
|
+
|
|
861
|
+
```ruby
|
|
862
|
+
begin
|
|
863
|
+
# Retrieve the TaxCloud tax provider
|
|
864
|
+
data, status_code, headers = api_instance.get_tax_provider_tax_cloud_with_http_info
|
|
865
|
+
p status_code # => 2xx
|
|
866
|
+
p headers # => { ... }
|
|
867
|
+
p data # => <TaxProviderTaxCloud>
|
|
868
|
+
rescue UltracartClient::ApiError => e
|
|
869
|
+
puts "Error when calling TaxApi->get_tax_provider_tax_cloud_with_http_info: #{e}"
|
|
870
|
+
end
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
### Parameters
|
|
874
|
+
|
|
875
|
+
This endpoint does not need any parameter.
|
|
876
|
+
|
|
877
|
+
### Return type
|
|
878
|
+
|
|
879
|
+
[**TaxProviderTaxCloud**](TaxProviderTaxCloud.md)
|
|
880
|
+
|
|
881
|
+
### Authorization
|
|
882
|
+
|
|
883
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
884
|
+
|
|
885
|
+
### HTTP request headers
|
|
886
|
+
|
|
887
|
+
- **Content-Type**: Not defined
|
|
888
|
+
- **Accept**: application/json
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
## get_tax_provider_tax_cloud_test
|
|
892
|
+
|
|
893
|
+
> <TaxProviderTestResult> get_tax_provider_tax_cloud_test
|
|
894
|
+
|
|
895
|
+
Attempts to connect to TaxCloud and returns back the response
|
|
896
|
+
|
|
897
|
+
Attempts to connect to TaxCloud with the saved API key and Connection ID and returns back the response.
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
### Examples
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
(No example for this operation).
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
#### Using the get_tax_provider_tax_cloud_test_with_http_info variant
|
|
907
|
+
|
|
908
|
+
This returns an Array which contains the response data, status code and headers.
|
|
909
|
+
|
|
910
|
+
> <Array(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_tax_cloud_test_with_http_info
|
|
911
|
+
|
|
912
|
+
```ruby
|
|
913
|
+
begin
|
|
914
|
+
# Attempts to connect to TaxCloud and returns back the response
|
|
915
|
+
data, status_code, headers = api_instance.get_tax_provider_tax_cloud_test_with_http_info
|
|
916
|
+
p status_code # => 2xx
|
|
917
|
+
p headers # => { ... }
|
|
918
|
+
p data # => <TaxProviderTestResult>
|
|
919
|
+
rescue UltracartClient::ApiError => e
|
|
920
|
+
puts "Error when calling TaxApi->get_tax_provider_tax_cloud_test_with_http_info: #{e}"
|
|
921
|
+
end
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Parameters
|
|
925
|
+
|
|
926
|
+
This endpoint does not need any parameter.
|
|
927
|
+
|
|
928
|
+
### Return type
|
|
929
|
+
|
|
930
|
+
[**TaxProviderTestResult**](TaxProviderTestResult.md)
|
|
931
|
+
|
|
932
|
+
### Authorization
|
|
933
|
+
|
|
934
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
935
|
+
|
|
936
|
+
### HTTP request headers
|
|
937
|
+
|
|
938
|
+
- **Content-Type**: Not defined
|
|
939
|
+
- **Accept**: application/json
|
|
940
|
+
|
|
941
|
+
|
|
837
942
|
## get_tax_provider_tax_jar
|
|
838
943
|
|
|
839
944
|
> <TaxProviderTaxJar> get_tax_provider_tax_jar
|
|
@@ -1590,6 +1695,59 @@ end
|
|
|
1590
1695
|
- **Accept**: application/json
|
|
1591
1696
|
|
|
1592
1697
|
|
|
1698
|
+
## update_tax_provider_tax_cloud
|
|
1699
|
+
|
|
1700
|
+
> <TaxProviderTaxCloud> update_tax_provider_tax_cloud(tax_provider_taxcloud)
|
|
1701
|
+
|
|
1702
|
+
Update the TaxCloud tax provider
|
|
1703
|
+
|
|
1704
|
+
Update the TaxCloud tax provider.
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
### Examples
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
(No example for this operation).
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
#### Using the update_tax_provider_tax_cloud_with_http_info variant
|
|
1714
|
+
|
|
1715
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1716
|
+
|
|
1717
|
+
> <Array(<TaxProviderTaxCloud>, Integer, Hash)> update_tax_provider_tax_cloud_with_http_info(tax_provider_taxcloud)
|
|
1718
|
+
|
|
1719
|
+
```ruby
|
|
1720
|
+
begin
|
|
1721
|
+
# Update the TaxCloud tax provider
|
|
1722
|
+
data, status_code, headers = api_instance.update_tax_provider_tax_cloud_with_http_info(tax_provider_taxcloud)
|
|
1723
|
+
p status_code # => 2xx
|
|
1724
|
+
p headers # => { ... }
|
|
1725
|
+
p data # => <TaxProviderTaxCloud>
|
|
1726
|
+
rescue UltracartClient::ApiError => e
|
|
1727
|
+
puts "Error when calling TaxApi->update_tax_provider_tax_cloud_with_http_info: #{e}"
|
|
1728
|
+
end
|
|
1729
|
+
```
|
|
1730
|
+
|
|
1731
|
+
### Parameters
|
|
1732
|
+
|
|
1733
|
+
| Name | Type | Description | Notes |
|
|
1734
|
+
| ---- | ---- | ----------- | ----- |
|
|
1735
|
+
| **tax_provider_taxcloud** | [**TaxProviderTaxCloud**](TaxProviderTaxCloud.md) | TaxProviderTaxCloud object | |
|
|
1736
|
+
|
|
1737
|
+
### Return type
|
|
1738
|
+
|
|
1739
|
+
[**TaxProviderTaxCloud**](TaxProviderTaxCloud.md)
|
|
1740
|
+
|
|
1741
|
+
### Authorization
|
|
1742
|
+
|
|
1743
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1744
|
+
|
|
1745
|
+
### HTTP request headers
|
|
1746
|
+
|
|
1747
|
+
- **Content-Type**: application/json
|
|
1748
|
+
- **Accept**: application/json
|
|
1749
|
+
|
|
1750
|
+
|
|
1593
1751
|
## update_tax_provider_tax_jar
|
|
1594
1752
|
|
|
1595
1753
|
> <TaxProviderTaxJar> update_tax_provider_tax_jar(tax_provider_tax_jar)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::TaxCloudConfig
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **api_key** | **String** | TaxCloud API key | [optional] |
|
|
8
|
+
| **connection_id** | **String** | TaxCloud Connection ID (a UUID) identifying the TaxCloud connection to use; a test connection and a production connection have different IDs | [optional] |
|
|
9
|
+
| **default_tic** | **String** | Default TaxCloud TIC (Taxability Information Code), used for items that do not have their own TIC; blank lets TaxCloud apply its default (0, general goods) | [optional] |
|
|
10
|
+
| **estimate_only** | **Boolean** | True if this TaxCloud configuration is to estimate taxes only and not report placed orders to TaxCloud | [optional] |
|
|
11
|
+
| **last_test_dts** | **String** | Date/time of the connection test to TaxCloud | [optional] |
|
|
12
|
+
| **shipping_tic** | **String** | TaxCloud TIC used to classify shipping/handling charges (11000 = shipping and handling); blank means shipping is not taxed | [optional] |
|
|
13
|
+
| **test_results** | **String** | Test results of the last connection test to TaxCloud | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::TaxCloudConfig.new(
|
|
21
|
+
api_key: null,
|
|
22
|
+
connection_id: null,
|
|
23
|
+
default_tic: null,
|
|
24
|
+
estimate_only: null,
|
|
25
|
+
last_test_dts: null,
|
|
26
|
+
shipping_tic: null,
|
|
27
|
+
test_results: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::TaxProviderAnrokProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | Product description in Anrok | [optional] |
|
|
8
|
+
| **external_id** | **String** | Anrok product external id. This is the value to enter as the item's Anrok Product ID. | [optional] |
|
|
9
|
+
| **name** | **String** | Product name in Anrok | [optional] |
|
|
10
|
+
| **tax_category_name** | **String** | Anrok product tax category applied to this product, for example \"SaaS - General, B2C\" | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::TaxProviderAnrokProduct.new(
|
|
18
|
+
description: null,
|
|
19
|
+
external_id: null,
|
|
20
|
+
name: null,
|
|
21
|
+
tax_category_name: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::TaxProviderAnrokTestResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **details** | **String** | | [optional] |
|
|
8
|
+
| **products** | [**Array<TaxProviderAnrokProduct>**](TaxProviderAnrokProduct.md) | Products configured on the merchant's Anrok account, returned on a successful test | [optional] |
|
|
9
|
+
| **success** | **Boolean** | True if the connection was successful | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::TaxProviderAnrokTestResult.new(
|
|
17
|
+
details: null,
|
|
18
|
+
products: null,
|
|
19
|
+
success: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::TaxProviderTaxCloud
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **configuration** | [**TaxCloudConfig**](TaxCloudConfig.md) | | [optional] |
|
|
8
|
+
| **description** | **String** | Description | [optional] |
|
|
9
|
+
| **selected** | **Boolean** | Selected | [optional] |
|
|
10
|
+
| **title** | **String** | Title | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::TaxProviderTaxCloud.new(
|
|
18
|
+
configuration: null,
|
|
19
|
+
description: null,
|
|
20
|
+
selected: null,
|
|
21
|
+
title: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **_self** | [**TaxProviderSelf**](TaxProviderSelf.md) | | [optional] |
|
|
12
12
|
| **sovos** | [**TaxProviderSovos**](TaxProviderSovos.md) | | [optional] |
|
|
13
13
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
14
|
+
| **taxcloud** | [**TaxProviderTaxCloud**](TaxProviderTaxCloud.md) | | [optional] |
|
|
14
15
|
| **taxjar** | [**TaxProviderTaxJar**](TaxProviderTaxJar.md) | | [optional] |
|
|
15
16
|
| **ultracart** | [**TaxProviderUltraCart**](TaxProviderUltraCart.md) | | [optional] |
|
|
16
17
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
@@ -28,6 +29,7 @@ instance = UltracartClient::TaxProvidersResponse.new(
|
|
|
28
29
|
_self: null,
|
|
29
30
|
sovos: null,
|
|
30
31
|
success: null,
|
|
32
|
+
taxcloud: null,
|
|
31
33
|
taxjar: null,
|
|
32
34
|
ultracart: null,
|
|
33
35
|
warning: null
|
|
@@ -466,18 +466,18 @@ module UltracartClient
|
|
|
466
466
|
end
|
|
467
467
|
|
|
468
468
|
# Attempts to connect to Anrok and returns back the response
|
|
469
|
-
# Attempts to connect to Anrok and returns back the response.
|
|
469
|
+
# Attempts to connect to Anrok and returns back the response, including the products configured on the merchant's Anrok account.
|
|
470
470
|
# @param [Hash] opts the optional parameters
|
|
471
|
-
# @return [
|
|
471
|
+
# @return [TaxProviderAnrokTestResult]
|
|
472
472
|
def get_tax_provider_anrok_test(opts = {})
|
|
473
473
|
data, _status_code, _headers = get_tax_provider_anrok_test_with_http_info(opts)
|
|
474
474
|
data
|
|
475
475
|
end
|
|
476
476
|
|
|
477
477
|
# Attempts to connect to Anrok and returns back the response
|
|
478
|
-
# Attempts to connect to Anrok and returns back the response.
|
|
478
|
+
# Attempts to connect to Anrok and returns back the response, including the products configured on the merchant's Anrok account.
|
|
479
479
|
# @param [Hash] opts the optional parameters
|
|
480
|
-
# @return [Array<(
|
|
480
|
+
# @return [Array<(TaxProviderAnrokTestResult, Integer, Hash)>] TaxProviderAnrokTestResult data, response status code and response headers
|
|
481
481
|
def get_tax_provider_anrok_test_with_http_info(opts = {})
|
|
482
482
|
if @api_client.config.debugging
|
|
483
483
|
@api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_anrok_test ...'
|
|
@@ -501,7 +501,7 @@ module UltracartClient
|
|
|
501
501
|
post_body = opts[:debug_body]
|
|
502
502
|
|
|
503
503
|
# return_type
|
|
504
|
-
return_type = opts[:debug_return_type] || '
|
|
504
|
+
return_type = opts[:debug_return_type] || 'TaxProviderAnrokTestResult'
|
|
505
505
|
|
|
506
506
|
# auth_names
|
|
507
507
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
@@ -1004,6 +1004,122 @@ module UltracartClient
|
|
|
1004
1004
|
return data, status_code, headers
|
|
1005
1005
|
end
|
|
1006
1006
|
|
|
1007
|
+
# Retrieve the TaxCloud tax provider
|
|
1008
|
+
# Retrieves the TaxCloud tax provider.
|
|
1009
|
+
# @param [Hash] opts the optional parameters
|
|
1010
|
+
# @return [TaxProviderTaxCloud]
|
|
1011
|
+
def get_tax_provider_tax_cloud(opts = {})
|
|
1012
|
+
data, _status_code, _headers = get_tax_provider_tax_cloud_with_http_info(opts)
|
|
1013
|
+
data
|
|
1014
|
+
end
|
|
1015
|
+
|
|
1016
|
+
# Retrieve the TaxCloud tax provider
|
|
1017
|
+
# Retrieves the TaxCloud tax provider.
|
|
1018
|
+
# @param [Hash] opts the optional parameters
|
|
1019
|
+
# @return [Array<(TaxProviderTaxCloud, Integer, Hash)>] TaxProviderTaxCloud data, response status code and response headers
|
|
1020
|
+
def get_tax_provider_tax_cloud_with_http_info(opts = {})
|
|
1021
|
+
if @api_client.config.debugging
|
|
1022
|
+
@api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_tax_cloud ...'
|
|
1023
|
+
end
|
|
1024
|
+
# resource path
|
|
1025
|
+
local_var_path = '/tax/providers/taxcloud'
|
|
1026
|
+
|
|
1027
|
+
# query parameters
|
|
1028
|
+
query_params = opts[:query_params] || {}
|
|
1029
|
+
|
|
1030
|
+
# header parameters
|
|
1031
|
+
header_params = opts[:header_params] || {}
|
|
1032
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1033
|
+
# HTTP header 'Accept' (if needed)
|
|
1034
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1035
|
+
|
|
1036
|
+
# form parameters
|
|
1037
|
+
form_params = opts[:form_params] || {}
|
|
1038
|
+
|
|
1039
|
+
# http body (model)
|
|
1040
|
+
post_body = opts[:debug_body]
|
|
1041
|
+
|
|
1042
|
+
# return_type
|
|
1043
|
+
return_type = opts[:debug_return_type] || 'TaxProviderTaxCloud'
|
|
1044
|
+
|
|
1045
|
+
# auth_names
|
|
1046
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1047
|
+
|
|
1048
|
+
new_options = opts.merge(
|
|
1049
|
+
:operation => :"TaxApi.get_tax_provider_tax_cloud",
|
|
1050
|
+
:header_params => header_params,
|
|
1051
|
+
:query_params => query_params,
|
|
1052
|
+
:form_params => form_params,
|
|
1053
|
+
:body => post_body,
|
|
1054
|
+
:auth_names => auth_names,
|
|
1055
|
+
:return_type => return_type
|
|
1056
|
+
)
|
|
1057
|
+
|
|
1058
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1059
|
+
if @api_client.config.debugging
|
|
1060
|
+
@api_client.config.logger.debug "API called: TaxApi#get_tax_provider_tax_cloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1061
|
+
end
|
|
1062
|
+
return data, status_code, headers
|
|
1063
|
+
end
|
|
1064
|
+
|
|
1065
|
+
# Attempts to connect to TaxCloud and returns back the response
|
|
1066
|
+
# Attempts to connect to TaxCloud with the saved API key and Connection ID and returns back the response.
|
|
1067
|
+
# @param [Hash] opts the optional parameters
|
|
1068
|
+
# @return [TaxProviderTestResult]
|
|
1069
|
+
def get_tax_provider_tax_cloud_test(opts = {})
|
|
1070
|
+
data, _status_code, _headers = get_tax_provider_tax_cloud_test_with_http_info(opts)
|
|
1071
|
+
data
|
|
1072
|
+
end
|
|
1073
|
+
|
|
1074
|
+
# Attempts to connect to TaxCloud and returns back the response
|
|
1075
|
+
# Attempts to connect to TaxCloud with the saved API key and Connection ID and returns back the response.
|
|
1076
|
+
# @param [Hash] opts the optional parameters
|
|
1077
|
+
# @return [Array<(TaxProviderTestResult, Integer, Hash)>] TaxProviderTestResult data, response status code and response headers
|
|
1078
|
+
def get_tax_provider_tax_cloud_test_with_http_info(opts = {})
|
|
1079
|
+
if @api_client.config.debugging
|
|
1080
|
+
@api_client.config.logger.debug 'Calling API: TaxApi.get_tax_provider_tax_cloud_test ...'
|
|
1081
|
+
end
|
|
1082
|
+
# resource path
|
|
1083
|
+
local_var_path = '/tax/providers/taxcloud/test'
|
|
1084
|
+
|
|
1085
|
+
# query parameters
|
|
1086
|
+
query_params = opts[:query_params] || {}
|
|
1087
|
+
|
|
1088
|
+
# header parameters
|
|
1089
|
+
header_params = opts[:header_params] || {}
|
|
1090
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1091
|
+
# HTTP header 'Accept' (if needed)
|
|
1092
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1093
|
+
|
|
1094
|
+
# form parameters
|
|
1095
|
+
form_params = opts[:form_params] || {}
|
|
1096
|
+
|
|
1097
|
+
# http body (model)
|
|
1098
|
+
post_body = opts[:debug_body]
|
|
1099
|
+
|
|
1100
|
+
# return_type
|
|
1101
|
+
return_type = opts[:debug_return_type] || 'TaxProviderTestResult'
|
|
1102
|
+
|
|
1103
|
+
# auth_names
|
|
1104
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1105
|
+
|
|
1106
|
+
new_options = opts.merge(
|
|
1107
|
+
:operation => :"TaxApi.get_tax_provider_tax_cloud_test",
|
|
1108
|
+
:header_params => header_params,
|
|
1109
|
+
:query_params => query_params,
|
|
1110
|
+
:form_params => form_params,
|
|
1111
|
+
:body => post_body,
|
|
1112
|
+
:auth_names => auth_names,
|
|
1113
|
+
:return_type => return_type
|
|
1114
|
+
)
|
|
1115
|
+
|
|
1116
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1117
|
+
if @api_client.config.debugging
|
|
1118
|
+
@api_client.config.logger.debug "API called: TaxApi#get_tax_provider_tax_cloud_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1119
|
+
end
|
|
1120
|
+
return data, status_code, headers
|
|
1121
|
+
end
|
|
1122
|
+
|
|
1007
1123
|
# Retrieve the TaxJar tax provider
|
|
1008
1124
|
# Retrieves the TaxJar tax provider.
|
|
1009
1125
|
# @param [Hash] opts the optional parameters
|
|
@@ -1960,6 +2076,75 @@ module UltracartClient
|
|
|
1960
2076
|
return data, status_code, headers
|
|
1961
2077
|
end
|
|
1962
2078
|
|
|
2079
|
+
# Update the TaxCloud tax provider
|
|
2080
|
+
# Update the TaxCloud tax provider.
|
|
2081
|
+
# @param tax_provider_taxcloud [TaxProviderTaxCloud] TaxProviderTaxCloud object
|
|
2082
|
+
# @param [Hash] opts the optional parameters
|
|
2083
|
+
# @return [TaxProviderTaxCloud]
|
|
2084
|
+
def update_tax_provider_tax_cloud(tax_provider_taxcloud, opts = {})
|
|
2085
|
+
data, _status_code, _headers = update_tax_provider_tax_cloud_with_http_info(tax_provider_taxcloud, opts)
|
|
2086
|
+
data
|
|
2087
|
+
end
|
|
2088
|
+
|
|
2089
|
+
# Update the TaxCloud tax provider
|
|
2090
|
+
# Update the TaxCloud tax provider.
|
|
2091
|
+
# @param tax_provider_taxcloud [TaxProviderTaxCloud] TaxProviderTaxCloud object
|
|
2092
|
+
# @param [Hash] opts the optional parameters
|
|
2093
|
+
# @return [Array<(TaxProviderTaxCloud, Integer, Hash)>] TaxProviderTaxCloud data, response status code and response headers
|
|
2094
|
+
def update_tax_provider_tax_cloud_with_http_info(tax_provider_taxcloud, opts = {})
|
|
2095
|
+
if @api_client.config.debugging
|
|
2096
|
+
@api_client.config.logger.debug 'Calling API: TaxApi.update_tax_provider_tax_cloud ...'
|
|
2097
|
+
end
|
|
2098
|
+
# verify the required parameter 'tax_provider_taxcloud' is set
|
|
2099
|
+
if @api_client.config.client_side_validation && tax_provider_taxcloud.nil?
|
|
2100
|
+
fail ArgumentError, "Missing the required parameter 'tax_provider_taxcloud' when calling TaxApi.update_tax_provider_tax_cloud"
|
|
2101
|
+
end
|
|
2102
|
+
# resource path
|
|
2103
|
+
local_var_path = '/tax/providers/taxcloud'
|
|
2104
|
+
|
|
2105
|
+
# query parameters
|
|
2106
|
+
query_params = opts[:query_params] || {}
|
|
2107
|
+
|
|
2108
|
+
# header parameters
|
|
2109
|
+
header_params = opts[:header_params] || {}
|
|
2110
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2111
|
+
# HTTP header 'Accept' (if needed)
|
|
2112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2113
|
+
# HTTP header 'Content-Type'
|
|
2114
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2115
|
+
if !content_type.nil?
|
|
2116
|
+
header_params['Content-Type'] = content_type
|
|
2117
|
+
end
|
|
2118
|
+
|
|
2119
|
+
# form parameters
|
|
2120
|
+
form_params = opts[:form_params] || {}
|
|
2121
|
+
|
|
2122
|
+
# http body (model)
|
|
2123
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(tax_provider_taxcloud)
|
|
2124
|
+
|
|
2125
|
+
# return_type
|
|
2126
|
+
return_type = opts[:debug_return_type] || 'TaxProviderTaxCloud'
|
|
2127
|
+
|
|
2128
|
+
# auth_names
|
|
2129
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2130
|
+
|
|
2131
|
+
new_options = opts.merge(
|
|
2132
|
+
:operation => :"TaxApi.update_tax_provider_tax_cloud",
|
|
2133
|
+
:header_params => header_params,
|
|
2134
|
+
:query_params => query_params,
|
|
2135
|
+
:form_params => form_params,
|
|
2136
|
+
:body => post_body,
|
|
2137
|
+
:auth_names => auth_names,
|
|
2138
|
+
:return_type => return_type
|
|
2139
|
+
)
|
|
2140
|
+
|
|
2141
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2142
|
+
if @api_client.config.debugging
|
|
2143
|
+
@api_client.config.logger.debug "API called: TaxApi#update_tax_provider_tax_cloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2144
|
+
end
|
|
2145
|
+
return data, status_code, headers
|
|
2146
|
+
end
|
|
2147
|
+
|
|
1963
2148
|
# Update the TaxJar tax provider
|
|
1964
2149
|
# Update the TaxJar tax provider.
|
|
1965
2150
|
# @param tax_provider_tax_jar [TaxProviderTaxJar] TaxProviderTaxJar object
|