ultracart_api 4.1.175 → 4.1.177

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.
@@ -0,0 +1,34 @@
1
+ # UltracartClient::SfvbBlogPostRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allow_comments** | **Boolean** | Whether shoppers may comment. Defaults to false on create. | [optional] |
8
+ | **author** | **String** | The author's name as plain text, up to 100 characters, with no quotes or angle brackets. | [optional] |
9
+ | **body** | **String** | The post body as HTML, up to 1 MB, rendered exactly as stored. Refused with sfvb.unsafe_html if it could run script - script and other executable tags, on attributes, links that are not http, https, mailto, tel or relative, and iframes other than YouTube or Vimeo players. Reference an attached image by the url the post's images report. | [optional] |
10
+ | **excerpt** | **String** | The post excerpt as HTML, up to 256 KB. Held to the same rule as body. | [optional] |
11
+ | **publication_dts** | **String** | When the post is published, as an ISO 8601 UTC time in the same form publication_dts reads back. Refused on a draft. A post made public without one is published now. | [optional] |
12
+ | **tags** | **Array<String>** | The post's tags as plain text, up to 100 characters each, with no quotes or angle brackets and no repeats. On an update the list replaces every tag, and an empty list clears them. | [optional] |
13
+ | **title** | **String** | The post title, up to 1000 characters. Required on create. | [optional] |
14
+ | **url_part** | **String** | The post's name in its URL, which is the page path followed by this and .html. Letters, digits, hyphens and underscores, up to 150. Must not be used by another post on the storefront, compared without regard to case, and must not be an item id or an item's url part, because the storefront checks blog posts first and the post would replace the item's page. index and index-N are reserved. Required on create. | [optional] |
15
+ | **visibility** | **String** | P public, L logged in customers only, D draft. Defaults to D on create. Anything but D needs sfvb_publish, and so does any change to a post that is not a draft. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::SfvbBlogPostRequest.new(
23
+ allow_comments: null,
24
+ author: null,
25
+ body: null,
26
+ excerpt: null,
27
+ publication_dts: null,
28
+ tags: null,
29
+ title: null,
30
+ url_part: null,
31
+ visibility: null
32
+ )
33
+ ```
34
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Attribute name. Matched without regard to case against what the page already has, so you do not have to reproduce the exact casing. A name nothing matches creates a new attribute. | [optional] |
8
8
  | **type** | **String** | Only consulted when creating an attribute no template declares. For a declared attribute the template's type always wins, because the templates decide it and not the caller. | [optional] |
9
- | **value** | **String** | The value to store. An empty string clears it. For html the markup is stored as given and rendered as given. For boolean send the text true or false. | [optional] |
9
+ | **value** | **String** | The value to store. An empty string clears it. For html the markup is stored as given and rendered as given. For boolean send the text true or false. For itemset send a comma separated list of merchant item ids in display order, not JSON. An id that does not resolve is dropped. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
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