ultracart_api 4.1.198 → 4.1.200
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +30 -2
- data/docs/SfvbApi.md +582 -15
- data/docs/SfvbApproval.md +3 -1
- data/docs/SfvbApprovalCreateRequest.md +11 -1
- data/docs/SfvbApprovalParams.md +30 -2
- data/docs/SfvbApprovalReview.md +36 -0
- data/docs/SfvbApprovalReviewFinding.md +24 -0
- data/docs/SfvbItemAttributeBatchRequest.md +20 -0
- data/docs/SfvbItemAttributeBatchResponse.md +40 -0
- data/docs/SfvbItemAttributeBatchRow.md +30 -0
- data/docs/SfvbItemAttributeBatchRowResult.md +36 -0
- data/docs/SfvbItemPricing.md +38 -0
- data/docs/SfvbItemPricingRequest.md +32 -0
- data/docs/SfvbItemRelated.md +28 -0
- data/docs/SfvbItemRelatedItem.md +22 -0
- data/docs/SfvbItemRelatedRequest.md +22 -0
- data/docs/SfvbItemVolumeDiscount.md +20 -0
- data/docs/SfvbRedirectDeleteRequest.md +20 -0
- data/docs/SfvbRedirectDeleteResponse.md +36 -0
- data/docs/SfvbRedirectDeleteRow.md +20 -0
- data/docs/SfvbRedirectDeleteRowResult.md +32 -0
- data/lib/ultracart_api/api/sfvb_api.rb +852 -69
- data/lib/ultracart_api/models/sfvb_approval.rb +13 -4
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +58 -6
- data/lib/ultracart_api/models/sfvb_approval_params.rb +181 -5
- data/lib/ultracart_api/models/sfvb_approval_review.rb +354 -0
- data/lib/ultracart_api/models/sfvb_approval_review_finding.rb +250 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_batch_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_batch_response.rb +332 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_batch_row.rb +280 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_batch_row_result.rb +344 -0
- data/lib/ultracart_api/models/sfvb_item_pricing.rb +322 -0
- data/lib/ultracart_api/models/sfvb_item_pricing_request.rb +292 -0
- data/lib/ultracart_api/models/sfvb_item_related.rb +272 -0
- data/lib/ultracart_api/models/sfvb_item_related_item.rb +274 -0
- data/lib/ultracart_api/models/sfvb_item_related_request.rb +242 -0
- data/lib/ultracart_api/models/sfvb_item_volume_discount.rb +230 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_response.rb +312 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_row.rb +230 -0
- data/lib/ultracart_api/models/sfvb_redirect_delete_row_result.rb +324 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +16 -0
- metadata +34 -2
data/docs/SfvbApproval.md
CHANGED
|
@@ -18,8 +18,9 @@
|
|
|
18
18
|
| **outcome_http_status** | **Integer** | The HTTP status the gated call answered with. | [optional] |
|
|
19
19
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
20
20
|
| **reason** | **String** | The reason the agent sent, as stored and shown (cleaned and capped). | [optional] |
|
|
21
|
+
| **review** | [**SfvbApprovalReview**](SfvbApprovalReview.md) | | [optional] |
|
|
21
22
|
| **scope** | **String** | Where the action applies. The storefront host name, or account for account-wide actions. | [optional] |
|
|
22
|
-
| **status** | **String** | pending, approved, denied, cancelled, expired or
|
|
23
|
+
| **status** | **String** | reviewing, pending, approved, denied, cancelled, expired, used or refused. Only approved may be sent with the gated call. A script write starts as reviewing while UltraCart reviews it; keep polling, and show approval_url only once it is pending. refused means the review refused the script; outcome_code and review say why. | [optional] |
|
|
23
24
|
| **storefront_oid** | **Integer** | The storefront the action runs on. Absent for account-wide actions. | [optional] |
|
|
24
25
|
| **used_at** | **String** | When the gated call used this approval, ISO 8601 UTC. | [optional] |
|
|
25
26
|
| **user_code** | **String** | Short matching code. Print it next to approval_url so the person can check the page shows the same code. | [optional] |
|
|
@@ -44,6 +45,7 @@ instance = UltracartClient::SfvbApproval.new(
|
|
|
44
45
|
outcome_http_status: null,
|
|
45
46
|
params: null,
|
|
46
47
|
reason: null,
|
|
48
|
+
review: null,
|
|
47
49
|
scope: null,
|
|
48
50
|
status: null,
|
|
49
51
|
storefront_oid: null,
|
|
@@ -5,8 +5,13 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **action** | **String** | The gated action to approve. | [optional] |
|
|
8
|
+
| **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB. UltraCart reviews it and keeps only its hash, so send the same bytes again on the write. Leave it out for a revert, which names params.version. | [optional] |
|
|
9
|
+
| **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
|
|
10
|
+
| **item_attribute_rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
|
|
11
|
+
| **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) | | [optional] |
|
|
8
12
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
9
13
|
| **reason** | **String** | Why the agent wants to do this, in a sentence. Shown to the person as unverified text, capped at 500 characters. | [optional] |
|
|
14
|
+
| **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256. UltraCart keeps only their hash. | [optional] |
|
|
10
15
|
|
|
11
16
|
## Example
|
|
12
17
|
|
|
@@ -15,8 +20,13 @@ require 'ultracart_api'
|
|
|
15
20
|
|
|
16
21
|
instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
17
22
|
action: null,
|
|
23
|
+
content: null,
|
|
24
|
+
experiment_start: null,
|
|
25
|
+
item_attribute_rows: null,
|
|
26
|
+
item_pricing: null,
|
|
18
27
|
params: null,
|
|
19
|
-
reason: null
|
|
28
|
+
reason: null,
|
|
29
|
+
redirect_rows: null
|
|
20
30
|
)
|
|
21
31
|
```
|
|
22
32
|
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -4,8 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change. Set by the server. | [optional] |
|
|
7
8
|
| **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
|
|
8
|
-
| **
|
|
9
|
+
| **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
|
|
10
|
+
| **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
|
|
11
|
+
| **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
|
|
12
|
+
| **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
|
|
13
|
+
| **path** | **String** | The file path, for file.delete and file.put_script, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it. | [optional] |
|
|
14
|
+
| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change. Set by the server. The gated call must send the same. | [optional] |
|
|
15
|
+
| **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved. Set by the server. The batch must send rows with this hash. | [optional] |
|
|
16
|
+
| **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
|
|
17
|
+
| **slot** | **String** | For experiment.start of a page experiment, the page body name. Defaults to body. | [optional] |
|
|
18
|
+
| **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
|
|
19
|
+
| **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
|
|
20
|
+
| **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
|
|
21
|
+
| **widget_id** | **String** | For experiment.start of a page experiment, the id of the experiment element. | [optional] |
|
|
22
|
+
| **winner_variation_number** | **Integer** | For experiment.end, the winning variation. Leave it out to end without a winner, and leave it out of the end call too. | [optional] |
|
|
9
23
|
|
|
10
24
|
## Example
|
|
11
25
|
|
|
@@ -13,8 +27,22 @@
|
|
|
13
27
|
require 'ultracart_api'
|
|
14
28
|
|
|
15
29
|
instance = UltracartClient::SfvbApprovalParams.new(
|
|
30
|
+
attribute_names: null,
|
|
16
31
|
blog_post_oid: null,
|
|
17
|
-
|
|
32
|
+
content_sha256: null,
|
|
33
|
+
experiment_oid: null,
|
|
34
|
+
item_count: null,
|
|
35
|
+
merchant_item_oid: null,
|
|
36
|
+
path: null,
|
|
37
|
+
request_sha256: null,
|
|
38
|
+
rows_sha256: null,
|
|
39
|
+
rule_count: null,
|
|
40
|
+
slot: null,
|
|
41
|
+
upsell_kind: null,
|
|
42
|
+
upsell_oid: null,
|
|
43
|
+
version: null,
|
|
44
|
+
widget_id: null,
|
|
45
|
+
winner_variation_number: null
|
|
18
46
|
)
|
|
19
47
|
```
|
|
20
48
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalReview
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **apis** | **Array<String>** | Browser features the script uses that matter for safety, such as network calls, cookies, storage and dynamic code. | [optional] |
|
|
8
|
+
| **domains** | **Array<String>** | Every host the script names, found by UltraCart's scanner rather than the AI. | [optional] |
|
|
9
|
+
| **findings** | [**Array<SfvbApprovalReviewFinding>**](SfvbApprovalReviewFinding.md) | What the reviewers flagged, each with the line and the quoted code. | [optional] |
|
|
10
|
+
| **new_domains** | **Array<String>** | Hosts the current version of the file does not name. | [optional] |
|
|
11
|
+
| **prompt_version** | **String** | Version of the review policy that produced this. | [optional] |
|
|
12
|
+
| **reviewed_at** | **String** | When the review ran, ISO 8601 UTC. | [optional] |
|
|
13
|
+
| **signals** | **Array<String>** | Obfuscation, card field and credential signals the scanner found. Credentials are named by kind, never by value. | [optional] |
|
|
14
|
+
| **size_bytes** | **Integer** | Size of the reviewed script in bytes. | [optional] |
|
|
15
|
+
| **summary** | **String** | What the script does, in plain words, as the reviewers read it. | [optional] |
|
|
16
|
+
| **verdict** | **String** | approve when both reviewers found nothing, human when the person should look closely. On a refused request, block when both reviewers found a clear violation, error when the review could not finish. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbApprovalReview.new(
|
|
24
|
+
apis: null,
|
|
25
|
+
domains: null,
|
|
26
|
+
findings: null,
|
|
27
|
+
new_domains: null,
|
|
28
|
+
prompt_version: null,
|
|
29
|
+
reviewed_at: null,
|
|
30
|
+
signals: null,
|
|
31
|
+
size_bytes: null,
|
|
32
|
+
summary: null,
|
|
33
|
+
verdict: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbApprovalReviewFinding
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **category** | **String** | What kind of problem, such as data_exfiltration or third_party_tracking. | [optional] |
|
|
8
|
+
| **clear_violation** | **Boolean** | True when this alone would justify refusing the script. | [optional] |
|
|
9
|
+
| **evidence** | **String** | The code quoted from the script, at most 500 characters. | [optional] |
|
|
10
|
+
| **line** | **Integer** | The line of the script the evidence is on, when the reviewer named one. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbApprovalReviewFinding.new(
|
|
18
|
+
category: null,
|
|
19
|
+
clear_violation: null,
|
|
20
|
+
evidence: null,
|
|
21
|
+
line: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeBatchRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan_hash** | **String** | From the dry run. Required to apply, with exactly the rows the dry run answered as change. | [optional] |
|
|
8
|
+
| **rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | The changes, up to 5,000 rows on up to 500 items. Each item and name at most once. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemAttributeBatchRequest.new(
|
|
16
|
+
plan_hash: null,
|
|
17
|
+
rows: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeBatchResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **applied** | **Boolean** | True after an apply. | [optional] |
|
|
8
|
+
| **change** | **Integer** | Rows that would change, from a dry run. | [optional] |
|
|
9
|
+
| **error** | **Integer** | Rows on an item that could not be saved, after an apply. | [optional] |
|
|
10
|
+
| **invalid** | **Integer** | Rows refused by the attribute checks. | [optional] |
|
|
11
|
+
| **item_count** | **Integer** | Distinct items with at least one row that would change, or did. | [optional] |
|
|
12
|
+
| **not_found** | **Integer** | Rows naming an item that does not exist. | [optional] |
|
|
13
|
+
| **plan_hash** | **String** | The hash of the rows answered as change, with their current_sha256. Apply exactly those rows with this hash. | [optional] |
|
|
14
|
+
| **rows** | [**Array<SfvbItemAttributeBatchRowResult>**](SfvbItemAttributeBatchRowResult.md) | One result per row, in request order. | [optional] |
|
|
15
|
+
| **stale** | **Integer** | Rows skipped because the value is not the one expected. | [optional] |
|
|
16
|
+
| **total** | **Integer** | Rows checked. | [optional] |
|
|
17
|
+
| **unchanged** | **Integer** | Rows whose value is already the new one. | [optional] |
|
|
18
|
+
| **updated** | **Integer** | Rows written, after an apply. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'ultracart_api'
|
|
24
|
+
|
|
25
|
+
instance = UltracartClient::SfvbItemAttributeBatchResponse.new(
|
|
26
|
+
applied: null,
|
|
27
|
+
change: null,
|
|
28
|
+
error: null,
|
|
29
|
+
invalid: null,
|
|
30
|
+
item_count: null,
|
|
31
|
+
not_found: null,
|
|
32
|
+
plan_hash: null,
|
|
33
|
+
rows: null,
|
|
34
|
+
stale: null,
|
|
35
|
+
total: null,
|
|
36
|
+
unchanged: null,
|
|
37
|
+
updated: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeBatchRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **current_sha256** | **String** | The current_sha256 the dry run answered for this row. Required to apply; a row whose value changed since is skipped as stale. | [optional] |
|
|
8
|
+
| **expected_value** | **String** | For a dry run, the value the caller believes the item holds now. A different current value makes the row stale. | [optional] |
|
|
9
|
+
| **merchant_item_id** | **String** | The item by its merchant item id, for a dry run. Send this or merchant_item_oid, not both. | [optional] |
|
|
10
|
+
| **merchant_item_oid** | **Integer** | The item. Required to apply; the dry run answers it for a row that named merchant_item_id. | [optional] |
|
|
11
|
+
| **name** | **String** | The attribute name, matched without regard to case. | [optional] |
|
|
12
|
+
| **type** | **String** | The attribute type, used only when no template on the item's pages declares the name. | [optional] |
|
|
13
|
+
| **value** | **String** | The new value. An empty string clears the attribute. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::SfvbItemAttributeBatchRow.new(
|
|
21
|
+
current_sha256: null,
|
|
22
|
+
expected_value: null,
|
|
23
|
+
merchant_item_id: null,
|
|
24
|
+
merchant_item_oid: null,
|
|
25
|
+
name: null,
|
|
26
|
+
type: null,
|
|
27
|
+
value: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeBatchRowResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **current_present** | **Boolean** | Whether the item had the attribute before this batch. | [optional] |
|
|
8
|
+
| **current_sha256** | **String** | The hash of the value before this batch. Send it back with the row to apply. | [optional] |
|
|
9
|
+
| **current_value** | **String** | The value before this batch, for a backup. Empty when the item has no such attribute. | [optional] |
|
|
10
|
+
| **merchant_item_id** | **String** | The item's merchant item id. Absent when not_found. | [optional] |
|
|
11
|
+
| **merchant_item_oid** | **Integer** | The item. Absent when not_found. | [optional] |
|
|
12
|
+
| **message** | **String** | Why a row is invalid, stale or error. | [optional] |
|
|
13
|
+
| **name** | **String** | The attribute name as sent. | [optional] |
|
|
14
|
+
| **result** | **String** | change or unchanged from a dry run, updated after an apply, stale (the value differs from expected_value or changed since the dry run), not_found, invalid, or error when the item could not be saved. | [optional] |
|
|
15
|
+
| **row** | **Integer** | The row's position in the request, from 1. | [optional] |
|
|
16
|
+
| **type** | **String** | The type the value is checked and stored as - the declaring template's, else the one sent. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbItemAttributeBatchRowResult.new(
|
|
24
|
+
current_present: null,
|
|
25
|
+
current_sha256: null,
|
|
26
|
+
current_value: null,
|
|
27
|
+
merchant_item_id: null,
|
|
28
|
+
merchant_item_oid: null,
|
|
29
|
+
message: null,
|
|
30
|
+
name: null,
|
|
31
|
+
result: null,
|
|
32
|
+
row: null,
|
|
33
|
+
type: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPricing
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cost** | **Float** | The price. | [optional] |
|
|
8
|
+
| **currency_code** | **String** | The currency every amount is in. Read only here. | [optional] |
|
|
9
|
+
| **hash_sha256** | **String** | The hash of the pricing above. Send it as If-Match to change it. | [optional] |
|
|
10
|
+
| **merchant_item_id** | **String** | The item's merchant item id. | [optional] |
|
|
11
|
+
| **merchant_item_oid** | **Integer** | The item. | [optional] |
|
|
12
|
+
| **msrp** | **Float** | The manufacturer suggested retail price, when set. | [optional] |
|
|
13
|
+
| **sale_active** | **Boolean** | Whether the sale price applies right now. | [optional] |
|
|
14
|
+
| **sale_cost** | **Float** | The sale price, when a sale is set. | [optional] |
|
|
15
|
+
| **sale_end** | **String** | When the sale ends, ISO 8601. | [optional] |
|
|
16
|
+
| **sale_start** | **String** | When the sale starts, ISO 8601. | [optional] |
|
|
17
|
+
| **volume_discounts** | [**Array<SfvbItemVolumeDiscount>**](SfvbItemVolumeDiscount.md) | Retail quantity breaks, lowest quantity first. Wholesale pricing tiers are not shown or changed here. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbItemPricing.new(
|
|
25
|
+
cost: null,
|
|
26
|
+
currency_code: null,
|
|
27
|
+
hash_sha256: null,
|
|
28
|
+
merchant_item_id: null,
|
|
29
|
+
merchant_item_oid: null,
|
|
30
|
+
msrp: null,
|
|
31
|
+
sale_active: null,
|
|
32
|
+
sale_cost: null,
|
|
33
|
+
sale_end: null,
|
|
34
|
+
sale_start: null,
|
|
35
|
+
volume_discounts: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPricingRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **clear_msrp** | **Boolean** | True to remove the MSRP. Not with msrp. | [optional] |
|
|
8
|
+
| **clear_sale** | **Boolean** | True to remove the sale. Not with sale_cost. | [optional] |
|
|
9
|
+
| **cost** | **Float** | The new price, 0 or more. | [optional] |
|
|
10
|
+
| **msrp** | **Float** | The manufacturer suggested retail price, more than 0 (or 0 when the price is 0). | [optional] |
|
|
11
|
+
| **sale_cost** | **Float** | The sale price, 0 or more. Sent with sale_start and sale_end, all three or none. | [optional] |
|
|
12
|
+
| **sale_end** | **String** | When the sale ends, ISO 8601 with an offset, after sale_start. Required with sale_cost. | [optional] |
|
|
13
|
+
| **sale_start** | **String** | When the sale starts, ISO 8601 with an offset. Required with sale_cost. | [optional] |
|
|
14
|
+
| **volume_discounts** | [**Array<SfvbItemVolumeDiscount>**](SfvbItemVolumeDiscount.md) | Replaces the retail quantity breaks. An empty list removes them all. Up to 20, each quantity 2 or more and named once. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbItemPricingRequest.new(
|
|
22
|
+
clear_msrp: null,
|
|
23
|
+
clear_sale: null,
|
|
24
|
+
cost: null,
|
|
25
|
+
msrp: null,
|
|
26
|
+
sale_cost: null,
|
|
27
|
+
sale_end: null,
|
|
28
|
+
sale_start: null,
|
|
29
|
+
volume_discounts: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemRelated
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hash_sha256** | **String** | The hash of the above. Send it as If-Match to change them. | [optional] |
|
|
8
|
+
| **merchant_item_id** | **String** | The item's merchant item id. | [optional] |
|
|
9
|
+
| **merchant_item_oid** | **Integer** | The item. | [optional] |
|
|
10
|
+
| **no_system_calculated_related_items** | **Boolean** | True when UltraCart does not calculate related items for this item. | [optional] |
|
|
11
|
+
| **not_relatable** | **Boolean** | True when this item is never shown as related to another. | [optional] |
|
|
12
|
+
| **related_items** | [**Array<SfvbItemRelatedItem>**](SfvbItemRelatedItem.md) | In stored order - the merchant's own (user, addon, complementary) and UltraCart's calculated ones (system). | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbItemRelated.new(
|
|
20
|
+
hash_sha256: null,
|
|
21
|
+
merchant_item_id: null,
|
|
22
|
+
merchant_item_oid: null,
|
|
23
|
+
no_system_calculated_related_items: null,
|
|
24
|
+
not_relatable: null,
|
|
25
|
+
related_items: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemRelatedItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **merchant_item_id** | **String** | The related item. On a write, send this or merchant_item_oid. | [optional] |
|
|
8
|
+
| **merchant_item_oid** | **Integer** | The related item's oid. | [optional] |
|
|
9
|
+
| **type** | **String** | user (the default on a write), addon or complementary. system marks one UltraCart calculated and other a kind this API does not change. Both are read only and kept by a write. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbItemRelatedItem.new(
|
|
17
|
+
merchant_item_id: null,
|
|
18
|
+
merchant_item_oid: null,
|
|
19
|
+
type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemRelatedRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **no_system_calculated_related_items** | **Boolean** | Left out keeps the stored value. | [optional] |
|
|
8
|
+
| **not_relatable** | **Boolean** | Left out keeps the stored value. | [optional] |
|
|
9
|
+
| **related_items** | [**Array<SfvbItemRelatedItem>**](SfvbItemRelatedItem.md) | The merchant's related items, in order, up to 50. An empty list removes them all. The calculated (system) ones are kept. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbItemRelatedRequest.new(
|
|
17
|
+
no_system_calculated_related_items: null,
|
|
18
|
+
not_relatable: null,
|
|
19
|
+
related_items: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemVolumeDiscount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cost** | **Float** | The unit price at that quantity, in the item's currency. | [optional] |
|
|
8
|
+
| **quantity** | **Integer** | The quantity from which this unit price applies. 2 or more. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemVolumeDiscount.new(
|
|
16
|
+
cost: null,
|
|
17
|
+
quantity: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan_hash** | **String** | From the dry run of exactly these rows. Required to delete. | [optional] |
|
|
8
|
+
| **rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | The rules, up to 5,000. Each redirect_id at most once. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRedirectDeleteRequest.new(
|
|
16
|
+
plan_hash: null,
|
|
17
|
+
rows: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **applied** | **Boolean** | True when this call deleted rules. | [optional] |
|
|
8
|
+
| **deletable** | **Integer** | Rows that can be, or on an apply could be, deleted. | [optional] |
|
|
9
|
+
| **deleted** | **Integer** | Rules deleted. Zero on a dry run. | [optional] |
|
|
10
|
+
| **limit** | **Integer** | The most rules a storefront can have for add and import to work. | [optional] |
|
|
11
|
+
| **not_found** | **Integer** | Rows naming no rule on this storefront. Skipped. | [optional] |
|
|
12
|
+
| **plan_hash** | **String** | Send this to apply exactly these rows. Also what an approval for them is bound to. | [optional] |
|
|
13
|
+
| **rows** | [**Array<SfvbRedirectDeleteRowResult>**](SfvbRedirectDeleteRowResult.md) | One result per row, in request order. | [optional] |
|
|
14
|
+
| **rule_count** | **Integer** | The storefront's redirect rules now. After an apply, after the delete. | [optional] |
|
|
15
|
+
| **stale** | **Integer** | Rows whose rule changed since its hash was read. Skipped. | [optional] |
|
|
16
|
+
| **total** | **Integer** | Rows in the request. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbRedirectDeleteResponse.new(
|
|
24
|
+
applied: null,
|
|
25
|
+
deletable: null,
|
|
26
|
+
deleted: null,
|
|
27
|
+
limit: null,
|
|
28
|
+
not_found: null,
|
|
29
|
+
plan_hash: null,
|
|
30
|
+
rows: null,
|
|
31
|
+
rule_count: null,
|
|
32
|
+
stale: null,
|
|
33
|
+
total: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hash_sha256** | **String** | The hash_sha256 you read. Optional on a dry run, which reports the current one. Required to delete. | [optional] |
|
|
8
|
+
| **redirect_id** | **Integer** | The rule. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRedirectDeleteRow.new(
|
|
16
|
+
hash_sha256: null,
|
|
17
|
+
redirect_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbRedirectDeleteRowResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **hash_sha256** | **String** | The rule's current hash. Absent when not_found. | [optional] |
|
|
8
|
+
| **note** | **String** | The rule's note. | [optional] |
|
|
9
|
+
| **redirect_id** | **Integer** | The rule. | [optional] |
|
|
10
|
+
| **result** | **String** | deletable, stale (the rule changed since its hash was read), not_found, or deleted after an apply. | [optional] |
|
|
11
|
+
| **source** | **String** | The rule's source, for a backup. | [optional] |
|
|
12
|
+
| **status** | **String** | The rule's status (301, 302 or rewrite). | [optional] |
|
|
13
|
+
| **target** | **String** | The rule's target, for a backup. | [optional] |
|
|
14
|
+
| **type** | **String** | exact or pattern. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbRedirectDeleteRowResult.new(
|
|
22
|
+
hash_sha256: null,
|
|
23
|
+
note: null,
|
|
24
|
+
redirect_id: null,
|
|
25
|
+
result: null,
|
|
26
|
+
source: null,
|
|
27
|
+
status: null,
|
|
28
|
+
target: null,
|
|
29
|
+
type: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|