ultracart_api 4.1.236 → 4.1.238

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 (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -2
  3. data/docs/SfvbApi.md +338 -0
  4. data/docs/SfvbApprovalCreateRequest.md +4 -0
  5. data/docs/SfvbDocsGap.md +28 -0
  6. data/docs/SfvbDocsGapReport.md +24 -0
  7. data/docs/SfvbDocsGapReportGap.md +26 -0
  8. data/docs/SfvbItemPreorder.md +36 -0
  9. data/docs/SfvbItemPreorderChange.md +24 -0
  10. data/docs/SfvbItemPreorderChildRow.md +20 -0
  11. data/docs/SfvbItemPreorderChildrenRequest.md +24 -0
  12. data/docs/SfvbItemPreorderListResponse.md +20 -0
  13. data/docs/SfvbItemPreorderOption.md +20 -0
  14. data/docs/SfvbItemPreorderRequest.md +22 -0
  15. data/docs/SfvbWhoamiResponse.md +4 -0
  16. data/docs/TaxJarConfig.md +2 -0
  17. data/lib/ultracart_api/api/sfvb_api.rb +451 -0
  18. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +21 -3
  19. data/lib/ultracart_api/models/sfvb_docs_gap.rb +304 -0
  20. data/lib/ultracart_api/models/sfvb_docs_gap_report.rb +249 -0
  21. data/lib/ultracart_api/models/sfvb_docs_gap_report_gap.rb +262 -0
  22. data/lib/ultracart_api/models/sfvb_item_preorder.rb +347 -0
  23. data/lib/ultracart_api/models/sfvb_item_preorder_change.rb +250 -0
  24. data/lib/ultracart_api/models/sfvb_item_preorder_child_row.rb +230 -0
  25. data/lib/ultracart_api/models/sfvb_item_preorder_children_request.rb +252 -0
  26. data/lib/ultracart_api/models/sfvb_item_preorder_list_response.rb +231 -0
  27. data/lib/ultracart_api/models/sfvb_item_preorder_option.rb +230 -0
  28. data/lib/ultracart_api/models/sfvb_item_preorder_request.rb +240 -0
  29. data/lib/ultracart_api/models/sfvb_whoami_response.rb +21 -1
  30. data/lib/ultracart_api/models/tax_jar_config.rb +11 -1
  31. data/lib/ultracart_api/version.rb +1 -1
  32. data/lib/ultracart_api.rb +10 -0
  33. metadata +22 -2
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbItemPreorderChildRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **child** | **String** | The variation's merchant item id, or an option value that exactly one variation of the parent has, such as 2T. | [optional] |
8
+ | **hash_sha256** | **String** | The variation's hash_sha256 from the read. Required. A stale hash refuses the whole call. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbItemPreorderChildRow.new(
16
+ child: null,
17
+ hash_sha256: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbItemPreorderChildrenRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **children** | [**Array<SfvbItemPreorderChildRow>**](SfvbItemPreorderChildRow.md) | The variations to change, 1 to 100, each named once. | [optional] |
8
+ | **clear_eta** | **Boolean** | True to remove the ETA from every variation named. Not with eta. | [optional] |
9
+ | **eta** | **String** | The expected date for every variation named, YYYY-MM-DD. Not with clear_eta. | [optional] |
10
+ | **preorder** | **Boolean** | True to put the variations on pre-order, false to take them off. Needs an approved item.preorder request when it changes any of them. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbItemPreorderChildrenRequest.new(
18
+ children: null,
19
+ clear_eta: null,
20
+ eta: null,
21
+ preorder: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbItemPreorderListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **children** | [**Array<SfvbItemPreorder>**](SfvbItemPreorder.md) | Each variation, with the option values that pick it. After a change, the variations named, in the order sent. | [optional] |
8
+ | **parent** | [**SfvbItemPreorder**](SfvbItemPreorder.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbItemPreorderListResponse.new(
16
+ children: null,
17
+ parent: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbItemPreorderOption
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The variation's name, such as Size. | [optional] |
8
+ | **value** | **String** | The option value, such as 2T. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbItemPreorderOption.new(
16
+ name: null,
17
+ value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbItemPreorderRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **clear_eta** | **Boolean** | True to remove the ETA. Not with eta. | [optional] |
8
+ | **eta** | **String** | The expected date, YYYY-MM-DD. Not with clear_eta. | [optional] |
9
+ | **preorder** | **Boolean** | True to put the item on pre-order, false to take it off. Either needs an approved item.preorder request when it changes the item. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbItemPreorderRequest.new(
17
+ clear_eta: null,
18
+ eta: null,
19
+ preorder: null
20
+ )
21
+ ```
22
+
@@ -7,9 +7,11 @@
7
7
  | **acting_as_user** | **Boolean** | True when this token resolves to a merchant user. Preview sessions and file writes need one, because they are recorded against the person who approved the token. Only device flow tokens resolve a user, so a plain API key will see this false. | [optional] |
8
8
  | **application_name** | **String** | Description of the application this credential belongs to. | [optional] |
9
9
  | **authentication_type** | **String** | How this token authenticated - Oauth2, Simple Key, Public/Private Key or Browser Key. | [optional] |
10
+ | **can_edit_items** | **Boolean** | True when this token may change item data. Needs can_write, and the UltraCart user behind the token must hold Edit Items. A token with no user is judged on its scopes alone. | [optional] |
10
11
  | **can_publish** | **Boolean** | True when this token may write a target that is currently live - an active upsell offer, an email on a delivering flow, the active theme, the storefront root. Never infer this; it is the difference between a draft edit and a shopper visible change. | [optional] |
11
12
  | **can_publish_public** | **Boolean** | True when this account may publish library entries to the public library. Set by UltraCart staff only. | [optional] |
12
13
  | **can_read** | **Boolean** | True when this token may read. Do not infer this from the requested scope name. | [optional] |
14
+ | **can_read_items** | **Boolean** | True when this token may read item data - the item, its pricing, pre-order and related items. Needs can_read, and the UltraCart user behind the token must hold View Items or Edit Items. A token with no user is judged on its scopes alone. | [optional] |
13
15
  | **can_write** | **Boolean** | True when this token may write. Writing a target that is not currently live needs only this. | [optional] |
14
16
  | **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
15
17
  | **login** | **String** | Login of the user who approved this token. Populated for device flow tokens; null for plain API key credentials. | [optional] |
@@ -28,9 +30,11 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
28
30
  acting_as_user: null,
29
31
  application_name: null,
30
32
  authentication_type: null,
33
+ can_edit_items: null,
31
34
  can_publish: null,
32
35
  can_publish_public: null,
33
36
  can_read: null,
37
+ can_read_items: null,
34
38
  can_write: null,
35
39
  device_scope: null,
36
40
  login: null,
data/docs/TaxJarConfig.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **estimate_only** | **Boolean** | True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar | [optional] |
10
10
  | **send_outside_nexus** | **Boolean** | Send orders outside your nexus TaxJar. The default is to not transmit outside orders to TaxJar to reduce API calls. However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state. | [optional] |
11
11
  | **send_test_orders** | **Boolean** | Send test orders through to TaxJar. The default is to not transmit test orders to TaxJar. | [optional] |
12
+ | **skip_calculation_outside_nexus** | **Boolean** | Only calculate tax for states within your nexus. Requires send_outside_nexus to be true. When true, orders outside your nexus are still transmitted to TaxJar for nexus tracking, but no tax calculation is requested for them, reducing API calls. | [optional] |
12
13
  | **skip_channel_orders** | **Boolean** | Do not send channel partner orders to TaxJar. Set this to true if your channel partner reports tax on their own. | [optional] |
13
14
  | **use_distribution_center_from** | **Boolean** | Use distribution center from address | [optional] |
14
15
 
@@ -23,6 +24,7 @@ instance = UltracartClient::TaxJarConfig.new(
23
24
  estimate_only: null,
24
25
  send_outside_nexus: null,
25
26
  send_test_orders: null,
27
+ skip_calculation_outside_nexus: null,
26
28
  skip_channel_orders: null,
27
29
  use_distribution_center_from: null
28
30
  )
@@ -6854,6 +6854,70 @@ module UltracartClient
6854
6854
  return data, status_code, headers
6855
6855
  end
6856
6856
 
6857
+ # Get a documentation-gap report's status
6858
+ # The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart's internal notes are not returned. A report from another account answers 404.
6859
+ # @param report_id [String]
6860
+ # @param [Hash] opts the optional parameters
6861
+ # @return [SfvbDocsGap]
6862
+ def get_sfvb_docs_gap(report_id, opts = {})
6863
+ data, _status_code, _headers = get_sfvb_docs_gap_with_http_info(report_id, opts)
6864
+ data
6865
+ end
6866
+
6867
+ # Get a documentation-gap report's status
6868
+ # The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart's internal notes are not returned. A report from another account answers 404.
6869
+ # @param report_id [String]
6870
+ # @param [Hash] opts the optional parameters
6871
+ # @return [Array<(SfvbDocsGap, Integer, Hash)>] SfvbDocsGap data, response status code and response headers
6872
+ def get_sfvb_docs_gap_with_http_info(report_id, opts = {})
6873
+ if @api_client.config.debugging
6874
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_docs_gap ...'
6875
+ end
6876
+ # verify the required parameter 'report_id' is set
6877
+ if @api_client.config.client_side_validation && report_id.nil?
6878
+ fail ArgumentError, "Missing the required parameter 'report_id' when calling SfvbApi.get_sfvb_docs_gap"
6879
+ end
6880
+ # resource path
6881
+ local_var_path = '/sfvb/docs/gaps/{report_id}'.sub('{' + 'report_id' + '}', CGI.escape(report_id.to_s))
6882
+
6883
+ # query parameters
6884
+ query_params = opts[:query_params] || {}
6885
+
6886
+ # header parameters
6887
+ header_params = opts[:header_params] || {}
6888
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6889
+ # HTTP header 'Accept' (if needed)
6890
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6891
+
6892
+ # form parameters
6893
+ form_params = opts[:form_params] || {}
6894
+
6895
+ # http body (model)
6896
+ post_body = opts[:debug_body]
6897
+
6898
+ # return_type
6899
+ return_type = opts[:debug_return_type] || 'SfvbDocsGap'
6900
+
6901
+ # auth_names
6902
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6903
+
6904
+ new_options = opts.merge(
6905
+ :operation => :"SfvbApi.get_sfvb_docs_gap",
6906
+ :header_params => header_params,
6907
+ :query_params => query_params,
6908
+ :form_params => form_params,
6909
+ :body => post_body,
6910
+ :auth_names => auth_names,
6911
+ :return_type => return_type
6912
+ )
6913
+
6914
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6915
+ if @api_client.config.debugging
6916
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_docs_gap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6917
+ end
6918
+ return data, status_code, headers
6919
+ end
6920
+
6857
6921
  # Configuration schema and field card for one element type
6858
6922
  # schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
6859
6923
  # @param element_type [String]
@@ -7884,6 +7948,146 @@ module UltracartClient
7884
7948
  return data, status_code, headers
7885
7949
  end
7886
7950
 
7951
+ # Read an item's pre-order flag and ETA
7952
+ # Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent's variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
7953
+ # @param storefront_oid [Integer]
7954
+ # @param [Hash] opts the optional parameters
7955
+ # @option opts [String] :merchant_item_id
7956
+ # @option opts [Integer] :merchant_item_oid
7957
+ # @return [SfvbItemPreorder]
7958
+ def get_sfvb_item_preorder(storefront_oid, opts = {})
7959
+ data, _status_code, _headers = get_sfvb_item_preorder_with_http_info(storefront_oid, opts)
7960
+ data
7961
+ end
7962
+
7963
+ # Read an item&#39;s pre-order flag and ETA
7964
+ # Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent&#39;s variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
7965
+ # @param storefront_oid [Integer]
7966
+ # @param [Hash] opts the optional parameters
7967
+ # @option opts [String] :merchant_item_id
7968
+ # @option opts [Integer] :merchant_item_oid
7969
+ # @return [Array<(SfvbItemPreorder, Integer, Hash)>] SfvbItemPreorder data, response status code and response headers
7970
+ def get_sfvb_item_preorder_with_http_info(storefront_oid, opts = {})
7971
+ if @api_client.config.debugging
7972
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_item_preorder ...'
7973
+ end
7974
+ # verify the required parameter 'storefront_oid' is set
7975
+ if @api_client.config.client_side_validation && storefront_oid.nil?
7976
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_item_preorder"
7977
+ end
7978
+ # resource path
7979
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/items/preorder'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
7980
+
7981
+ # query parameters
7982
+ query_params = opts[:query_params] || {}
7983
+ query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
7984
+ query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
7985
+
7986
+ # header parameters
7987
+ header_params = opts[:header_params] || {}
7988
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7989
+ # HTTP header 'Accept' (if needed)
7990
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7991
+
7992
+ # form parameters
7993
+ form_params = opts[:form_params] || {}
7994
+
7995
+ # http body (model)
7996
+ post_body = opts[:debug_body]
7997
+
7998
+ # return_type
7999
+ return_type = opts[:debug_return_type] || 'SfvbItemPreorder'
8000
+
8001
+ # auth_names
8002
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8003
+
8004
+ new_options = opts.merge(
8005
+ :operation => :"SfvbApi.get_sfvb_item_preorder",
8006
+ :header_params => header_params,
8007
+ :query_params => query_params,
8008
+ :form_params => form_params,
8009
+ :body => post_body,
8010
+ :auth_names => auth_names,
8011
+ :return_type => return_type
8012
+ )
8013
+
8014
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8015
+ if @api_client.config.debugging
8016
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_item_preorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8017
+ end
8018
+ return data, status_code, headers
8019
+ end
8020
+
8021
+ # Read the pre-order flag and ETA of a parent item's variations
8022
+ # The parent's own values and each variation's, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
8023
+ # @param storefront_oid [Integer]
8024
+ # @param [Hash] opts the optional parameters
8025
+ # @option opts [String] :merchant_item_id
8026
+ # @option opts [Integer] :merchant_item_oid
8027
+ # @return [SfvbItemPreorderListResponse]
8028
+ def get_sfvb_item_preorder_children(storefront_oid, opts = {})
8029
+ data, _status_code, _headers = get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts)
8030
+ data
8031
+ end
8032
+
8033
+ # Read the pre-order flag and ETA of a parent item&#39;s variations
8034
+ # The parent&#39;s own values and each variation&#39;s, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
8035
+ # @param storefront_oid [Integer]
8036
+ # @param [Hash] opts the optional parameters
8037
+ # @option opts [String] :merchant_item_id
8038
+ # @option opts [Integer] :merchant_item_oid
8039
+ # @return [Array<(SfvbItemPreorderListResponse, Integer, Hash)>] SfvbItemPreorderListResponse data, response status code and response headers
8040
+ def get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts = {})
8041
+ if @api_client.config.debugging
8042
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_item_preorder_children ...'
8043
+ end
8044
+ # verify the required parameter 'storefront_oid' is set
8045
+ if @api_client.config.client_side_validation && storefront_oid.nil?
8046
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_item_preorder_children"
8047
+ end
8048
+ # resource path
8049
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/items/preorder/children'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
8050
+
8051
+ # query parameters
8052
+ query_params = opts[:query_params] || {}
8053
+ query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
8054
+ query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
8055
+
8056
+ # header parameters
8057
+ header_params = opts[:header_params] || {}
8058
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
8059
+ # HTTP header 'Accept' (if needed)
8060
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8061
+
8062
+ # form parameters
8063
+ form_params = opts[:form_params] || {}
8064
+
8065
+ # http body (model)
8066
+ post_body = opts[:debug_body]
8067
+
8068
+ # return_type
8069
+ return_type = opts[:debug_return_type] || 'SfvbItemPreorderListResponse'
8070
+
8071
+ # auth_names
8072
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8073
+
8074
+ new_options = opts.merge(
8075
+ :operation => :"SfvbApi.get_sfvb_item_preorder_children",
8076
+ :header_params => header_params,
8077
+ :query_params => query_params,
8078
+ :form_params => form_params,
8079
+ :body => post_body,
8080
+ :auth_names => auth_names,
8081
+ :return_type => return_type
8082
+ )
8083
+
8084
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8085
+ if @api_client.config.debugging
8086
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_item_preorder_children\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8087
+ end
8088
+ return data, status_code, headers
8089
+ end
8090
+
7887
8091
  # Read what an item charges
7888
8092
  # Price, sale (with whether it applies now), MSRP and retail volume pricing - what itemprice, itemsale, itemmsrp, itemsavings and itemvolumediscounts render - with a hash_sha256 to send as If-Match when changing it. Wholesale pricing tiers are not shown. Address by merchant_item_id or merchant_item_oid.
7889
8093
  # @param storefront_oid [Integer]
@@ -12382,6 +12586,78 @@ module UltracartClient
12382
12586
  return data, status_code, headers
12383
12587
  end
12384
12588
 
12589
+ # Send UltraCart a documentation-gap report
12590
+ # Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
12591
+ # @param docs_gap_report [SfvbDocsGapReport] The report
12592
+ # @param [Hash] opts the optional parameters
12593
+ # @option opts [Integer] :storefront_oid The storefront the agent was working on, recorded for context. Leave it out when none applies.
12594
+ # @return [SfvbDocsGap]
12595
+ def insert_sfvb_docs_gap(docs_gap_report, opts = {})
12596
+ data, _status_code, _headers = insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts)
12597
+ data
12598
+ end
12599
+
12600
+ # Send UltraCart a documentation-gap report
12601
+ # Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
12602
+ # @param docs_gap_report [SfvbDocsGapReport] The report
12603
+ # @param [Hash] opts the optional parameters
12604
+ # @option opts [Integer] :storefront_oid The storefront the agent was working on, recorded for context. Leave it out when none applies.
12605
+ # @return [Array<(SfvbDocsGap, Integer, Hash)>] SfvbDocsGap data, response status code and response headers
12606
+ def insert_sfvb_docs_gap_with_http_info(docs_gap_report, opts = {})
12607
+ if @api_client.config.debugging
12608
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_docs_gap ...'
12609
+ end
12610
+ # verify the required parameter 'docs_gap_report' is set
12611
+ if @api_client.config.client_side_validation && docs_gap_report.nil?
12612
+ fail ArgumentError, "Missing the required parameter 'docs_gap_report' when calling SfvbApi.insert_sfvb_docs_gap"
12613
+ end
12614
+ # resource path
12615
+ local_var_path = '/sfvb/docs/gaps'
12616
+
12617
+ # query parameters
12618
+ query_params = opts[:query_params] || {}
12619
+ query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
12620
+
12621
+ # header parameters
12622
+ header_params = opts[:header_params] || {}
12623
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
12624
+ # HTTP header 'Accept' (if needed)
12625
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12626
+ # HTTP header 'Content-Type'
12627
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
12628
+ if !content_type.nil?
12629
+ header_params['Content-Type'] = content_type
12630
+ end
12631
+
12632
+ # form parameters
12633
+ form_params = opts[:form_params] || {}
12634
+
12635
+ # http body (model)
12636
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(docs_gap_report)
12637
+
12638
+ # return_type
12639
+ return_type = opts[:debug_return_type] || 'SfvbDocsGap'
12640
+
12641
+ # auth_names
12642
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
12643
+
12644
+ new_options = opts.merge(
12645
+ :operation => :"SfvbApi.insert_sfvb_docs_gap",
12646
+ :header_params => header_params,
12647
+ :query_params => query_params,
12648
+ :form_params => form_params,
12649
+ :body => post_body,
12650
+ :auth_names => auth_names,
12651
+ :return_type => return_type
12652
+ )
12653
+
12654
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12655
+ if @api_client.config.debugging
12656
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_docs_gap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12657
+ end
12658
+ return data, status_code, headers
12659
+ end
12660
+
12385
12661
  # Create a page
12386
12662
  # Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
12387
12663
  # @param storefront_oid [Integer]
@@ -15598,6 +15874,181 @@ module UltracartClient
15598
15874
  return data, status_code, headers
15599
15875
  end
15600
15876
 
15877
+ # Change an item's pre-order flag or ETA
15878
+ # Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
15879
+ # @param storefront_oid [Integer]
15880
+ # @param if_match [String] hash_sha256 from the pre-order read. Required; 428 when absent, 412 when stale.
15881
+ # @param item_preorder_request [SfvbItemPreorderRequest] The change
15882
+ # @param [Hash] opts the optional parameters
15883
+ # @option opts [String] :merchant_item_id
15884
+ # @option opts [Integer] :merchant_item_oid
15885
+ # @option opts [String] :approval_id The approval_id of an approved item.preorder request for this item and change. Required when the change puts the item on or off pre-order. See POST /sfvb/approvals.
15886
+ # @return [SfvbItemPreorder]
15887
+ def put_sfvb_item_preorder(storefront_oid, if_match, item_preorder_request, opts = {})
15888
+ data, _status_code, _headers = put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts)
15889
+ data
15890
+ end
15891
+
15892
+ # Change an item&#39;s pre-order flag or ETA
15893
+ # Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
15894
+ # @param storefront_oid [Integer]
15895
+ # @param if_match [String] hash_sha256 from the pre-order read. Required; 428 when absent, 412 when stale.
15896
+ # @param item_preorder_request [SfvbItemPreorderRequest] The change
15897
+ # @param [Hash] opts the optional parameters
15898
+ # @option opts [String] :merchant_item_id
15899
+ # @option opts [Integer] :merchant_item_oid
15900
+ # @option opts [String] :approval_id The approval_id of an approved item.preorder request for this item and change. Required when the change puts the item on or off pre-order. See POST /sfvb/approvals.
15901
+ # @return [Array<(SfvbItemPreorder, Integer, Hash)>] SfvbItemPreorder data, response status code and response headers
15902
+ def put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts = {})
15903
+ if @api_client.config.debugging
15904
+ @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_item_preorder ...'
15905
+ end
15906
+ # verify the required parameter 'storefront_oid' is set
15907
+ if @api_client.config.client_side_validation && storefront_oid.nil?
15908
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_item_preorder"
15909
+ end
15910
+ # verify the required parameter 'if_match' is set
15911
+ if @api_client.config.client_side_validation && if_match.nil?
15912
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.put_sfvb_item_preorder"
15913
+ end
15914
+ # verify the required parameter 'item_preorder_request' is set
15915
+ if @api_client.config.client_side_validation && item_preorder_request.nil?
15916
+ fail ArgumentError, "Missing the required parameter 'item_preorder_request' when calling SfvbApi.put_sfvb_item_preorder"
15917
+ end
15918
+ # resource path
15919
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/items/preorder'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
15920
+
15921
+ # query parameters
15922
+ query_params = opts[:query_params] || {}
15923
+ query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
15924
+ query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
15925
+
15926
+ # header parameters
15927
+ header_params = opts[:header_params] || {}
15928
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
15929
+ # HTTP header 'Accept' (if needed)
15930
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
15931
+ # HTTP header 'Content-Type'
15932
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
15933
+ if !content_type.nil?
15934
+ header_params['Content-Type'] = content_type
15935
+ end
15936
+ header_params[:'If-Match'] = if_match
15937
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
15938
+
15939
+ # form parameters
15940
+ form_params = opts[:form_params] || {}
15941
+
15942
+ # http body (model)
15943
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_preorder_request)
15944
+
15945
+ # return_type
15946
+ return_type = opts[:debug_return_type] || 'SfvbItemPreorder'
15947
+
15948
+ # auth_names
15949
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
15950
+
15951
+ new_options = opts.merge(
15952
+ :operation => :"SfvbApi.put_sfvb_item_preorder",
15953
+ :header_params => header_params,
15954
+ :query_params => query_params,
15955
+ :form_params => form_params,
15956
+ :body => post_body,
15957
+ :auth_names => auth_names,
15958
+ :return_type => return_type
15959
+ )
15960
+
15961
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
15962
+ if @api_client.config.debugging
15963
+ @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_item_preorder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
15964
+ end
15965
+ return data, status_code, headers
15966
+ end
15967
+
15968
+ # Change the pre-order flag or ETA of several variations of one parent
15969
+ # The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
15970
+ # @param storefront_oid [Integer]
15971
+ # @param item_preorder_children_request [SfvbItemPreorderChildrenRequest] The change and the variations
15972
+ # @param [Hash] opts the optional parameters
15973
+ # @option opts [String] :merchant_item_id
15974
+ # @option opts [Integer] :merchant_item_oid
15975
+ # @option opts [String] :approval_id The approval_id of an approved item.preorder request for the parent and this change. Required when the change puts any variation on or off pre-order. See POST /sfvb/approvals.
15976
+ # @return [SfvbItemPreorderListResponse]
15977
+ def put_sfvb_item_preorder_children(storefront_oid, item_preorder_children_request, opts = {})
15978
+ data, _status_code, _headers = put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts)
15979
+ data
15980
+ end
15981
+
15982
+ # Change the pre-order flag or ETA of several variations of one parent
15983
+ # The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
15984
+ # @param storefront_oid [Integer]
15985
+ # @param item_preorder_children_request [SfvbItemPreorderChildrenRequest] The change and the variations
15986
+ # @param [Hash] opts the optional parameters
15987
+ # @option opts [String] :merchant_item_id
15988
+ # @option opts [Integer] :merchant_item_oid
15989
+ # @option opts [String] :approval_id The approval_id of an approved item.preorder request for the parent and this change. Required when the change puts any variation on or off pre-order. See POST /sfvb/approvals.
15990
+ # @return [Array<(SfvbItemPreorderListResponse, Integer, Hash)>] SfvbItemPreorderListResponse data, response status code and response headers
15991
+ def put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts = {})
15992
+ if @api_client.config.debugging
15993
+ @api_client.config.logger.debug 'Calling API: SfvbApi.put_sfvb_item_preorder_children ...'
15994
+ end
15995
+ # verify the required parameter 'storefront_oid' is set
15996
+ if @api_client.config.client_side_validation && storefront_oid.nil?
15997
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.put_sfvb_item_preorder_children"
15998
+ end
15999
+ # verify the required parameter 'item_preorder_children_request' is set
16000
+ if @api_client.config.client_side_validation && item_preorder_children_request.nil?
16001
+ fail ArgumentError, "Missing the required parameter 'item_preorder_children_request' when calling SfvbApi.put_sfvb_item_preorder_children"
16002
+ end
16003
+ # resource path
16004
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/items/preorder/children'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
16005
+
16006
+ # query parameters
16007
+ query_params = opts[:query_params] || {}
16008
+ query_params[:'merchant_item_id'] = opts[:'merchant_item_id'] if !opts[:'merchant_item_id'].nil?
16009
+ query_params[:'merchant_item_oid'] = opts[:'merchant_item_oid'] if !opts[:'merchant_item_oid'].nil?
16010
+
16011
+ # header parameters
16012
+ header_params = opts[:header_params] || {}
16013
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
16014
+ # HTTP header 'Accept' (if needed)
16015
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16016
+ # HTTP header 'Content-Type'
16017
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
16018
+ if !content_type.nil?
16019
+ header_params['Content-Type'] = content_type
16020
+ end
16021
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16022
+
16023
+ # form parameters
16024
+ form_params = opts[:form_params] || {}
16025
+
16026
+ # http body (model)
16027
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_preorder_children_request)
16028
+
16029
+ # return_type
16030
+ return_type = opts[:debug_return_type] || 'SfvbItemPreorderListResponse'
16031
+
16032
+ # auth_names
16033
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16034
+
16035
+ new_options = opts.merge(
16036
+ :operation => :"SfvbApi.put_sfvb_item_preorder_children",
16037
+ :header_params => header_params,
16038
+ :query_params => query_params,
16039
+ :form_params => form_params,
16040
+ :body => post_body,
16041
+ :auth_names => auth_names,
16042
+ :return_type => return_type
16043
+ )
16044
+
16045
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
16046
+ if @api_client.config.debugging
16047
+ @api_client.config.logger.debug "API called: SfvbApi#put_sfvb_item_preorder_children\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16048
+ end
16049
+ return data, status_code, headers
16050
+ end
16051
+
15601
16052
  # Change what an item charges
15602
16053
  # Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
15603
16054
  # @param storefront_oid [Integer]