ultracart_api 4.1.174 → 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6744f7bfd2e6e6f44a4483bf87b7b1b8228ae29f1ca7883a3781584423b9e6d7
4
- data.tar.gz: 3640f3fc644cb45dda4640fe9d924b9411c42deef351cf397512da7a01b31eee
3
+ metadata.gz: 7fd7d9b22eb441bbd63953ad47b59eaec06757e2c01f5a1185af5e86a80923a4
4
+ data.tar.gz: 83fbaab211de4ee96ff07cb8376c9decfcd61c1c58b1bf7b568867d8ce2afcc9
5
5
  SHA512:
6
- metadata.gz: 6ffbcca0cf147ebf40b4e2e2cdc4088286b68d122d6d88a7314f97d0722727e656ede9e981276a3263e21600d868255ec2b1c560ff128afc007afda763d988c0
7
- data.tar.gz: 945b8d5bcfd7fa80e6cfd8458412065338caa3ad9a00ea5717ab2452217684642f326cb21e0f199878fb8621cb8d6a33aecf9a76c0f3a7e1fd5860e6baf5305e
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.174
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.174'
19
+ gem 'ultracart_api', '4.1.176'
20
20
  ```
21
21
 
22
22
  install:
@@ -549,6 +549,7 @@ Class | Method | HTTP request | Description
549
549
  *UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
550
550
  *UltracartClient::SfvbApi* | [**put_sfvb_site_attributes**](docs/SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes
551
551
  *UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
552
+ *UltracartClient::SfvbApi* | [**refresh_sfvb_page**](docs/SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy
552
553
  *UltracartClient::SfvbApi* | [**remove_sfvb_page_blog_posts**](docs/SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page
553
554
  *UltracartClient::SfvbApi* | [**remove_sfvb_page_items**](docs/SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page
554
555
  *UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
@@ -770,6 +771,8 @@ Class | Method | HTTP request | Description
770
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
771
772
  *UltracartClient::TaxApi* | [**get_tax_provider_sovos**](docs/TaxApi.md#get_tax_provider_sovos) | **GET** /tax/providers/sovos | Retrieve the Sovos tax provider
772
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
773
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
774
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
775
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
@@ -784,6 +787,7 @@ Class | Method | HTTP request | Description
784
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
785
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
786
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
787
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
788
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
789
793
  *UltracartClient::UserApi* | [**delete_group**](docs/UserApi.md#delete_group) | **DELETE** /user/groups/{group_oid} | Delete a group
@@ -1854,6 +1858,8 @@ Class | Method | HTTP request | Description
1854
1858
  - [UltracartClient::SfvbPageListResponse](docs/SfvbPageListResponse.md)
1855
1859
  - [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
1856
1860
  - [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
1861
+ - [UltracartClient::SfvbPageRefreshRequest](docs/SfvbPageRefreshRequest.md)
1862
+ - [UltracartClient::SfvbPageRefreshResponse](docs/SfvbPageRefreshResponse.md)
1857
1863
  - [UltracartClient::SfvbPageResponse](docs/SfvbPageResponse.md)
1858
1864
  - [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
1859
1865
  - [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
@@ -1917,6 +1923,7 @@ Class | Method | HTTP request | Description
1917
1923
  - [UltracartClient::StoreFrontPageContentAttribute](docs/StoreFrontPageContentAttribute.md)
1918
1924
  - [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
1919
1925
  - [UltracartClient::TaxCity](docs/TaxCity.md)
1926
+ - [UltracartClient::TaxCloudConfig](docs/TaxCloudConfig.md)
1920
1927
  - [UltracartClient::TaxCountry](docs/TaxCountry.md)
1921
1928
  - [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
1922
1929
  - [UltracartClient::TaxCounty](docs/TaxCounty.md)
@@ -1924,6 +1931,8 @@ Class | Method | HTTP request | Description
1924
1931
  - [UltracartClient::TaxPostalCode](docs/TaxPostalCode.md)
1925
1932
  - [UltracartClient::TaxProviderActivateResult](docs/TaxProviderActivateResult.md)
1926
1933
  - [UltracartClient::TaxProviderAnrok](docs/TaxProviderAnrok.md)
1934
+ - [UltracartClient::TaxProviderAnrokProduct](docs/TaxProviderAnrokProduct.md)
1935
+ - [UltracartClient::TaxProviderAnrokTestResult](docs/TaxProviderAnrokTestResult.md)
1927
1936
  - [UltracartClient::TaxProviderAvalara](docs/TaxProviderAvalara.md)
1928
1937
  - [UltracartClient::TaxProviderAvalaraCompaniesResult](docs/TaxProviderAvalaraCompaniesResult.md)
1929
1938
  - [UltracartClient::TaxProviderAvalaraCompany](docs/TaxProviderAvalaraCompany.md)
@@ -1931,6 +1940,7 @@ Class | Method | HTTP request | Description
1931
1940
  - [UltracartClient::TaxProviderSelfCountriesResponse](docs/TaxProviderSelfCountriesResponse.md)
1932
1941
  - [UltracartClient::TaxProviderSelfRegionsResponse](docs/TaxProviderSelfRegionsResponse.md)
1933
1942
  - [UltracartClient::TaxProviderSovos](docs/TaxProviderSovos.md)
1943
+ - [UltracartClient::TaxProviderTaxCloud](docs/TaxProviderTaxCloud.md)
1934
1944
  - [UltracartClient::TaxProviderTaxJar](docs/TaxProviderTaxJar.md)
1935
1945
  - [UltracartClient::TaxProviderTestResult](docs/TaxProviderTestResult.md)
1936
1946
  - [UltracartClient::TaxProviderUltraCart](docs/TaxProviderUltraCart.md)
@@ -2070,6 +2080,8 @@ Not every change is committed to every SDK.
2070
2080
 
2071
2081
  | Version | Date | Comments |
2072
2082
  | --: | :-: | --- |
2083
+ | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
2084
+ | 4.1.175 | 09/29/2026 | sfvb internal testing |
2073
2085
  | 4.1.174 | 09/25/2026 | sfvb internal testing |
2074
2086
  | 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
2075
2087
  | 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |
data/docs/SfvbApi.md CHANGED
@@ -81,6 +81,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
81
81
  | [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
82
82
  | [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
83
83
  | [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
84
+ | [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
84
85
  | [**remove_sfvb_page_blog_posts**](SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page |
85
86
  | [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
86
87
  | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
@@ -4311,6 +4312,60 @@ end
4311
4312
  - **Accept**: application/json
4312
4313
 
4313
4314
 
4315
+ ## refresh_sfvb_page
4316
+
4317
+ > <SfvbPageRefreshResponse> refresh_sfvb_page(storefront_oid, page_refresh_request)
4318
+
4319
+ Drop one page's cached copy
4320
+
4321
+ The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
4322
+
4323
+
4324
+ ### Examples
4325
+
4326
+
4327
+ (No example for this operation).
4328
+
4329
+
4330
+ #### Using the refresh_sfvb_page_with_http_info variant
4331
+
4332
+ This returns an Array which contains the response data, status code and headers.
4333
+
4334
+ > <Array(<SfvbPageRefreshResponse>, Integer, Hash)> refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request)
4335
+
4336
+ ```ruby
4337
+ begin
4338
+ # Drop one page's cached copy
4339
+ data, status_code, headers = api_instance.refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request)
4340
+ p status_code # => 2xx
4341
+ p headers # => { ... }
4342
+ p data # => <SfvbPageRefreshResponse>
4343
+ rescue UltracartClient::ApiError => e
4344
+ puts "Error when calling SfvbApi->refresh_sfvb_page_with_http_info: #{e}"
4345
+ end
4346
+ ```
4347
+
4348
+ ### Parameters
4349
+
4350
+ | Name | Type | Description | Notes |
4351
+ | ---- | ---- | ----------- | ----- |
4352
+ | **storefront_oid** | **Integer** | | |
4353
+ | **page_refresh_request** | [**SfvbPageRefreshRequest**](SfvbPageRefreshRequest.md) | The page to refresh | |
4354
+
4355
+ ### Return type
4356
+
4357
+ [**SfvbPageRefreshResponse**](SfvbPageRefreshResponse.md)
4358
+
4359
+ ### Authorization
4360
+
4361
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4362
+
4363
+ ### HTTP request headers
4364
+
4365
+ - **Content-Type**: application/json
4366
+ - **Accept**: application/json
4367
+
4368
+
4314
4369
  ## remove_sfvb_page_blog_posts
4315
4370
 
4316
4371
  > <SfvbPageBlogPostsResponse> remove_sfvb_page_blog_posts(storefront_oid, path, page_blog_posts_request)
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbPageRefreshRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | The page to refresh. A path such as /shop/coffee.html, or a full URL on this storefront&#39;s host. The query string is ignored, and a path ending in / means its index.html. One page per request. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::SfvbPageRefreshRequest.new(
15
+ url: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::SfvbPageRefreshResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | A plain sentence saying what happened. | [optional] |
8
+ | **path** | **String** | The page path the refresh used, after normalization. | [optional] |
9
+ | **refreshed** | **Boolean** | True when a cached copy was dropped. The next request renders the page fresh. | [optional] |
10
+ | **was_cached** | **Boolean** | True when the page had a cache entry. | [optional] |
11
+ | **was_valid** | **Boolean** | True when that entry was being served from cache. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::SfvbPageRefreshResponse.new(
19
+ message: null,
20
+ path: null,
21
+ refreshed: null,
22
+ was_cached: null,
23
+ was_valid: null
24
+ )
25
+ ```
26
+
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
- > <TaxProviderTestResult> get_tax_provider_anrok_test
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(<TaxProviderTestResult>, Integer, Hash)> get_tax_provider_anrok_test_with_http_info
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 # => <TaxProviderTestResult>
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
- [**TaxProviderTestResult**](TaxProviderTestResult.md)
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 &#x3D; 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&#39;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 \&quot;SaaS - General, B2C\&quot; | [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&lt;TaxProviderAnrokProduct&gt;**](TaxProviderAnrokProduct.md) | Products configured on the merchant&#39;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
@@ -5721,6 +5721,81 @@ module UltracartClient
5721
5721
  return data, status_code, headers
5722
5722
  end
5723
5723
 
5724
+ # Drop one page's cached copy
5725
+ # The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
5726
+ # @param storefront_oid [Integer]
5727
+ # @param page_refresh_request [SfvbPageRefreshRequest] The page to refresh
5728
+ # @param [Hash] opts the optional parameters
5729
+ # @return [SfvbPageRefreshResponse]
5730
+ def refresh_sfvb_page(storefront_oid, page_refresh_request, opts = {})
5731
+ data, _status_code, _headers = refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request, opts)
5732
+ data
5733
+ end
5734
+
5735
+ # Drop one page&#39;s cached copy
5736
+ # The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
5737
+ # @param storefront_oid [Integer]
5738
+ # @param page_refresh_request [SfvbPageRefreshRequest] The page to refresh
5739
+ # @param [Hash] opts the optional parameters
5740
+ # @return [Array<(SfvbPageRefreshResponse, Integer, Hash)>] SfvbPageRefreshResponse data, response status code and response headers
5741
+ def refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request, opts = {})
5742
+ if @api_client.config.debugging
5743
+ @api_client.config.logger.debug 'Calling API: SfvbApi.refresh_sfvb_page ...'
5744
+ end
5745
+ # verify the required parameter 'storefront_oid' is set
5746
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5747
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.refresh_sfvb_page"
5748
+ end
5749
+ # verify the required parameter 'page_refresh_request' is set
5750
+ if @api_client.config.client_side_validation && page_refresh_request.nil?
5751
+ fail ArgumentError, "Missing the required parameter 'page_refresh_request' when calling SfvbApi.refresh_sfvb_page"
5752
+ end
5753
+ # resource path
5754
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/refresh'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5755
+
5756
+ # query parameters
5757
+ query_params = opts[:query_params] || {}
5758
+
5759
+ # header parameters
5760
+ header_params = opts[:header_params] || {}
5761
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5762
+ # HTTP header 'Accept' (if needed)
5763
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5764
+ # HTTP header 'Content-Type'
5765
+ content_type = @api_client.select_header_content_type(['application/json'])
5766
+ if !content_type.nil?
5767
+ header_params['Content-Type'] = content_type
5768
+ end
5769
+
5770
+ # form parameters
5771
+ form_params = opts[:form_params] || {}
5772
+
5773
+ # http body (model)
5774
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(page_refresh_request)
5775
+
5776
+ # return_type
5777
+ return_type = opts[:debug_return_type] || 'SfvbPageRefreshResponse'
5778
+
5779
+ # auth_names
5780
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5781
+
5782
+ new_options = opts.merge(
5783
+ :operation => :"SfvbApi.refresh_sfvb_page",
5784
+ :header_params => header_params,
5785
+ :query_params => query_params,
5786
+ :form_params => form_params,
5787
+ :body => post_body,
5788
+ :auth_names => auth_names,
5789
+ :return_type => return_type
5790
+ )
5791
+
5792
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5793
+ if @api_client.config.debugging
5794
+ @api_client.config.logger.debug "API called: SfvbApi#refresh_sfvb_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5795
+ end
5796
+ return data, status_code, headers
5797
+ end
5798
+
5724
5799
  # Take blog posts off a page
5725
5800
  # Removes posts by blog_post_oid, at most 500 at a time. Every oid must be on the page, and one that is not changes nothing. The posts themselves are not touched. Always needs sfvb_publish.
5726
5801
  # @param storefront_oid [Integer]