ultracart_api 4.1.239 → 4.1.240

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 (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -2
  3. data/docs/SfvbApi.md +337 -0
  4. data/docs/SfvbApprovalCreateRequest.md +4 -0
  5. data/docs/SfvbItemChildCreateRequest.md +26 -0
  6. data/docs/SfvbItemChildCreateResponse.md +36 -0
  7. data/docs/SfvbItemDefaultPageRequest.md +20 -0
  8. data/docs/SfvbItemDefaultPageResponse.md +36 -0
  9. data/docs/SfvbItemDefaultPageResult.md +40 -0
  10. data/docs/SfvbItemDefaultPageRow.md +28 -0
  11. data/docs/SfvbItemPageAssignment.md +28 -0
  12. data/docs/SfvbItemPages.md +28 -0
  13. data/docs/SfvbItemVariationAxis.md +22 -0
  14. data/docs/SfvbItemVariationChange.md +40 -0
  15. data/docs/SfvbItemVariationChangeResult.md +24 -0
  16. data/docs/SfvbItemVariationChild.md +22 -0
  17. data/docs/SfvbItemVariationCombination.md +24 -0
  18. data/docs/SfvbItemVariationOption.md +22 -0
  19. data/docs/SfvbItemVariationValue.md +20 -0
  20. data/docs/SfvbItemVariations.md +30 -0
  21. data/docs/SfvbItemVariationsRequest.md +20 -0
  22. data/docs/SfvbItemVariationsResponse.md +38 -0
  23. data/lib/ultracart_api/api/sfvb_api.rb +459 -0
  24. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +24 -3
  25. data/lib/ultracart_api/models/sfvb_item_child_create_request.rb +260 -0
  26. data/lib/ultracart_api/models/sfvb_item_child_create_response.rb +309 -0
  27. data/lib/ultracart_api/models/sfvb_item_default_page_request.rb +232 -0
  28. data/lib/ultracart_api/models/sfvb_item_default_page_response.rb +312 -0
  29. data/lib/ultracart_api/models/sfvb_item_default_page_result.rb +330 -0
  30. data/lib/ultracart_api/models/sfvb_item_default_page_row.rb +270 -0
  31. data/lib/ultracart_api/models/sfvb_item_page_assignment.rb +270 -0
  32. data/lib/ultracart_api/models/sfvb_item_pages.rb +274 -0
  33. data/lib/ultracart_api/models/sfvb_item_variation_axis.rb +242 -0
  34. data/lib/ultracart_api/models/sfvb_item_variation_change.rb +334 -0
  35. data/lib/ultracart_api/models/sfvb_item_variation_change_result.rb +250 -0
  36. data/lib/ultracart_api/models/sfvb_item_variation_child.rb +240 -0
  37. data/lib/ultracart_api/models/sfvb_item_variation_combination.rb +251 -0
  38. data/lib/ultracart_api/models/sfvb_item_variation_option.rb +240 -0
  39. data/lib/ultracart_api/models/sfvb_item_variation_value.rb +230 -0
  40. data/lib/ultracart_api/models/sfvb_item_variations.rb +284 -0
  41. data/lib/ultracart_api/models/sfvb_item_variations_request.rb +232 -0
  42. data/lib/ultracart_api/models/sfvb_item_variations_response.rb +328 -0
  43. data/lib/ultracart_api/version.rb +1 -1
  44. data/lib/ultracart_api.rb +18 -0
  45. metadata +37 -1
@@ -0,0 +1,36 @@
1
+ # UltracartClient::SfvbItemDefaultPageResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **already_default** | **Integer** | Rows whose page is already the default. | [optional] |
8
+ | **dry_run** | **Boolean** | True when nothing was saved. | [optional] |
9
+ | **failed** | **Integer** | Rows whose change didn't save (apply). | [optional] |
10
+ | **item_count** | **Integer** | Distinct items in the request. | [optional] |
11
+ | **ready** | **Integer** | Rows that would change (dry run). | [optional] |
12
+ | **refused** | **Integer** | Rows refused - not found, not assigned, hidden, another storefront or invalid. | [optional] |
13
+ | **rows** | [**Array<SfvbItemDefaultPageResult>**](SfvbItemDefaultPageResult.md) | Every row, in request order. | [optional] |
14
+ | **rows_sha256** | **String** | Hash of the ready rows. Request item.default_page with exactly those rows, then apply them with this. | [optional] |
15
+ | **stale** | **Integer** | Rows that changed since they were read. | [optional] |
16
+ | **updated** | **Integer** | Rows changed (apply). | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::SfvbItemDefaultPageResponse.new(
24
+ already_default: null,
25
+ dry_run: null,
26
+ failed: null,
27
+ item_count: null,
28
+ ready: null,
29
+ refused: null,
30
+ rows: null,
31
+ rows_sha256: null,
32
+ stale: null,
33
+ updated: null
34
+ )
35
+ ```
36
+
@@ -0,0 +1,40 @@
1
+ # UltracartClient::SfvbItemDefaultPageResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **current_default_oid** | **Integer** | The default page's oid now, or null. | [optional] |
8
+ | **current_default_path** | **String** | The default page now, or null. | [optional] |
9
+ | **current_sha256** | **String** | Hash of the item's pages and default on this storefront. Send it back on the apply. | [optional] |
10
+ | **index** | **Integer** | The row's position in the request, from 0. | [optional] |
11
+ | **merchant_item_id** | **String** | The item's id, when found. | [optional] |
12
+ | **merchant_item_oid** | **Integer** | The item's oid, when found. | [optional] |
13
+ | **message** | **String** | Why the row is refused, stale or failed. | [optional] |
14
+ | **previous_default_oid** | **Integer** | Apply only - the previous default page's oid. | [optional] |
15
+ | **previous_default_path** | **String** | Apply only - the default page before the change, to undo it. | [optional] |
16
+ | **status** | **String** | ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden, item_not_found, invalid, stale, updated or failed. | [optional] |
17
+ | **target_oid** | **Integer** | The page's oid. | [optional] |
18
+ | **target_path** | **String** | The page the row makes the default. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ultracart_api'
24
+
25
+ instance = UltracartClient::SfvbItemDefaultPageResult.new(
26
+ current_default_oid: null,
27
+ current_default_path: null,
28
+ current_sha256: null,
29
+ index: null,
30
+ merchant_item_id: null,
31
+ merchant_item_oid: null,
32
+ message: null,
33
+ previous_default_oid: null,
34
+ previous_default_path: null,
35
+ status: null,
36
+ target_oid: null,
37
+ target_path: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbItemDefaultPageRow
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **current_sha256** | **String** | The dry run's current_sha256 for the item. Required on an apply. | [optional] |
8
+ | **expected_current_path** | **String** | Dry run only - the default page the row expects now. A different default makes the row stale. | [optional] |
9
+ | **merchant_item_id** | **String** | The item's id. Send this or merchant_item_oid. | [optional] |
10
+ | **merchant_item_oid** | **Integer** | The item's oid. Required on an apply. | [optional] |
11
+ | **page_oid** | **Integer** | The page to make the default, by oid. Required on an apply. | [optional] |
12
+ | **page_path** | **String** | The page to make the default, by path. Send this or page_oid. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbItemDefaultPageRow.new(
20
+ current_sha256: null,
21
+ expected_current_path: null,
22
+ merchant_item_id: null,
23
+ merchant_item_oid: null,
24
+ page_oid: null,
25
+ page_path: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbItemPageAssignment
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **default_assignment** | **Boolean** | True for the item's default page on this storefront, the one its canonical link uses. | [optional] |
8
+ | **page_oid** | **Integer** | The page's oid. | [optional] |
9
+ | **path** | **String** | The page's path. | [optional] |
10
+ | **sort_order** | **Integer** | The item's place on the page, or null. | [optional] |
11
+ | **url_part** | **String** | The item's URL part on the page, or null when the item id is used. | [optional] |
12
+ | **visible** | **Boolean** | False for a hidden page, which shoppers aren't served. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbItemPageAssignment.new(
20
+ default_assignment: null,
21
+ page_oid: null,
22
+ path: null,
23
+ sort_order: null,
24
+ url_part: null,
25
+ visible: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbItemPages
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **default_page_path** | **String** | The default page's path, or null when none is marked. | [optional] |
8
+ | **hash_sha256** | **String** | Hash of the item's pages and default on this storefront. The dry run reports the same value as current_sha256. | [optional] |
9
+ | **merchant_item_id** | **String** | The item's id. | [optional] |
10
+ | **merchant_item_oid** | **Integer** | The item's oid. | [optional] |
11
+ | **notes** | **Array<String>** | Things worth knowing, such as no default being marked. | [optional] |
12
+ | **pages** | [**Array<SfvbItemPageAssignment>**](SfvbItemPageAssignment.md) | Every page the item is on, on this storefront only. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbItemPages.new(
20
+ default_page_path: null,
21
+ hash_sha256: null,
22
+ merchant_item_id: null,
23
+ merchant_item_oid: null,
24
+ notes: null,
25
+ pages: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbItemVariationAxis
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **default_text** | **String** | The prompt shown before a choice, such as Choose a size, or null. | [optional] |
8
+ | **name** | **String** | The axis name, such as Size. | [optional] |
9
+ | **options** | [**Array<SfvbItemVariationOption>**](SfvbItemVariationOption.md) | The options, in the order shoppers see them. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbItemVariationAxis.new(
17
+ default_text: null,
18
+ name: null,
19
+ options: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,40 @@
1
+ # UltracartClient::SfvbItemVariationChange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **axis** | **String** | The axis the change is about. | [optional] |
8
+ | **before** | **String** | add_option puts the new option before this one. Otherwise it goes last. | [optional] |
9
+ | **child** | **String** | set_combination - the child item id, or null to clear the combination. | [optional] |
10
+ | **default** | **Boolean** | add_option and add_axis make the option the default. | [optional] |
11
+ | **default_text** | **String** | The prompt, for add_axis and set_default_text. Null clears it. | [optional] |
12
+ | **multimedia_oid** | **Integer** | An image of the parent item. For set_option_multimedia null clears it; for set_combination null keeps the current one. | [optional] |
13
+ | **op** | **String** | add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia or set_combination. | [optional] |
14
+ | **quantity** | **Integer** | set_combination - how many of the child the combination adds. Defaults to 1. | [optional] |
15
+ | **to** | **String** | The new name, for rename_axis and rename_option. | [optional] |
16
+ | **value** | **String** | The option the change is about. | [optional] |
17
+ | **values** | **Array<String>** | add_axis options in order, or every option in its new order for reorder_options. | [optional] |
18
+ | **variation_values** | [**Array<SfvbItemVariationValue>**](SfvbItemVariationValue.md) | set_combination - one axis and option per axis. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ultracart_api'
24
+
25
+ instance = UltracartClient::SfvbItemVariationChange.new(
26
+ axis: null,
27
+ before: null,
28
+ child: null,
29
+ default: null,
30
+ default_text: null,
31
+ multimedia_oid: null,
32
+ op: null,
33
+ quantity: null,
34
+ to: null,
35
+ value: null,
36
+ values: null,
37
+ variation_values: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbItemVariationChangeResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **gated** | **Boolean** | True when this change removes or re-points something shoppers can buy today, which needs approval. | [optional] |
8
+ | **index** | **Integer** | The change's position in the request, from 0. | [optional] |
9
+ | **op** | **String** | The change's op. | [optional] |
10
+ | **summary** | **String** | What the change does, in plain words. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbItemVariationChangeResult.new(
18
+ gated: null,
19
+ index: null,
20
+ op: null,
21
+ summary: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbItemVariationChild
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The child item's description. | [optional] |
8
+ | **merchant_item_id** | **String** | The child item's id. | [optional] |
9
+ | **merchant_item_oid** | **Integer** | The child item's oid. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbItemVariationChild.new(
17
+ description: null,
18
+ merchant_item_id: null,
19
+ merchant_item_oid: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbItemVariationCombination
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **child** | [**SfvbItemVariationChild**](SfvbItemVariationChild.md) | | [optional] |
8
+ | **multimedia_oid** | **Integer** | An image of the parent item shown for this combination, or null. | [optional] |
9
+ | **quantity** | **Integer** | How many of the child the combination adds to the cart. 1 unless it is a pack. | [optional] |
10
+ | **variation_values** | [**Array<SfvbItemVariationValue>**](SfvbItemVariationValue.md) | One axis and option per axis, in axis order. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbItemVariationCombination.new(
18
+ child: null,
19
+ multimedia_oid: null,
20
+ quantity: null,
21
+ variation_values: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbItemVariationOption
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **default** | **Boolean** | True for the option the item page starts on. At most one per axis. | [optional] |
8
+ | **multimedia_oid** | **Integer** | An image or swatch of the parent item shown for this option, or null. | [optional] |
9
+ | **value** | **String** | The option value, such as 2T. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbItemVariationOption.new(
17
+ default: null,
18
+ multimedia_oid: null,
19
+ value: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbItemVariationValue
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The axis 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::SfvbItemVariationValue.new(
16
+ name: null,
17
+ value: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # UltracartClient::SfvbItemVariations
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **axes** | [**Array<SfvbItemVariationAxis>**](SfvbItemVariationAxis.md) | The axes in order. Empty when the item has no variations. | [optional] |
8
+ | **combinations** | [**Array<SfvbItemVariationCombination>**](SfvbItemVariationCombination.md) | Every filled combination. A combination not listed has no child, and shoppers see it as unavailable. | [optional] |
9
+ | **description** | **String** | The parent item's description. | [optional] |
10
+ | **hash_sha256** | **String** | Hash of the variations. Send it as If-Match on the update. | [optional] |
11
+ | **merchant_item_id** | **String** | The parent item's id. | [optional] |
12
+ | **merchant_item_oid** | **Integer** | The parent item's oid. | [optional] |
13
+ | **unfilled_combinations** | **Integer** | How many combinations of the options have no child. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ultracart_api'
19
+
20
+ instance = UltracartClient::SfvbItemVariations.new(
21
+ axes: null,
22
+ combinations: null,
23
+ description: null,
24
+ hash_sha256: null,
25
+ merchant_item_id: null,
26
+ merchant_item_oid: null,
27
+ unfilled_combinations: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbItemVariationsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **changes** | [**Array<SfvbItemVariationChange>**](SfvbItemVariationChange.md) | The changes, applied in order. All are checked before anything is saved. | [optional] |
8
+ | **dry_run** | **Boolean** | True to check and plan without saving. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbItemVariationsRequest.new(
16
+ changes: null,
17
+ dry_run: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # UltracartClient::SfvbItemVariationsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **approval_needed** | **Boolean** | True when the change needs an approved item.variations request. | [optional] |
8
+ | **axes** | [**Array<SfvbItemVariationAxis>**](SfvbItemVariationAxis.md) | The axes in order. | [optional] |
9
+ | **changes** | [**Array<SfvbItemVariationChangeResult>**](SfvbItemVariationChangeResult.md) | What each change did, or would do on a dry run. | [optional] |
10
+ | **combinations** | [**Array<SfvbItemVariationCombination>**](SfvbItemVariationCombination.md) | Every filled combination. | [optional] |
11
+ | **description** | **String** | The parent item's description. | [optional] |
12
+ | **dry_run** | **Boolean** | True when nothing was saved. | [optional] |
13
+ | **hash_sha256** | **String** | Hash of the variations as returned. | [optional] |
14
+ | **merchant_item_id** | **String** | The parent item's id. | [optional] |
15
+ | **merchant_item_oid** | **Integer** | The parent item's oid. | [optional] |
16
+ | **unfilled_combinations** | **Integer** | How many combinations of the options have no child. | [optional] |
17
+ | **warnings** | **Array<String>** | Things worth knowing, such as combinations left unfilled. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'ultracart_api'
23
+
24
+ instance = UltracartClient::SfvbItemVariationsResponse.new(
25
+ approval_needed: null,
26
+ axes: null,
27
+ changes: null,
28
+ combinations: null,
29
+ description: null,
30
+ dry_run: null,
31
+ hash_sha256: null,
32
+ merchant_item_id: null,
33
+ merchant_item_oid: null,
34
+ unfilled_combinations: null,
35
+ warnings: null
36
+ )
37
+ ```
38
+