ultracart_api 4.1.169 → 4.1.171

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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +45 -2
  3. data/docs/SfvbApi.md +1786 -591
  4. data/docs/SfvbItemAttribute.md +34 -0
  5. data/docs/SfvbItemAttributeUpdate.md +22 -0
  6. data/docs/SfvbItemAttributeUpdateRequest.md +18 -0
  7. data/docs/SfvbItemContentRequest.md +20 -0
  8. data/docs/SfvbItemMultimedia.md +34 -0
  9. data/docs/SfvbItemMultimediaRequest.md +24 -0
  10. data/docs/SfvbItemResponse.md +32 -0
  11. data/docs/SfvbItemSeo.md +34 -0
  12. data/docs/SfvbItemSeoRequest.md +22 -0
  13. data/docs/SfvbPageResponse.md +2 -0
  14. data/docs/SfvbUpsellItemLogic.md +24 -0
  15. data/docs/SfvbUpsellItemLogicItem.md +22 -0
  16. data/docs/SfvbUpsellOffer.md +118 -8
  17. data/docs/SfvbUpsellPath.md +48 -0
  18. data/docs/SfvbUpsellPathDuplicateRequest.md +18 -0
  19. data/docs/SfvbUpsellPathMoveRequest.md +18 -0
  20. data/docs/SfvbUpsellPathsResponse.md +28 -0
  21. data/docs/SfvbUpsellStats.md +54 -0
  22. data/docs/SfvbUpsellStep.md +22 -0
  23. data/docs/SfvbUpsellStepOffer.md +32 -0
  24. data/docs/SfvbUpsellTowerData.md +20 -0
  25. data/docs/SfvbUpsellVariation.md +22 -0
  26. data/lib/ultracart_api/api/sfvb_api.rb +1731 -83
  27. data/lib/ultracart_api/models/sfvb_item_attribute.rb +336 -0
  28. data/lib/ultracart_api/models/sfvb_item_attribute_update.rb +274 -0
  29. data/lib/ultracart_api/models/sfvb_item_attribute_update_request.rb +222 -0
  30. data/lib/ultracart_api/models/sfvb_item_content_request.rb +230 -0
  31. data/lib/ultracart_api/models/sfvb_item_multimedia.rb +334 -0
  32. data/lib/ultracart_api/models/sfvb_item_multimedia_request.rb +250 -0
  33. data/lib/ultracart_api/models/sfvb_item_response.rb +295 -0
  34. data/lib/ultracart_api/models/sfvb_item_seo.rb +358 -0
  35. data/lib/ultracart_api/models/sfvb_item_seo_request.rb +240 -0
  36. data/lib/ultracart_api/models/sfvb_page_response.rb +11 -1
  37. data/lib/ultracart_api/models/sfvb_upsell_item_logic.rb +252 -0
  38. data/lib/ultracart_api/models/sfvb_upsell_item_logic_item.rb +240 -0
  39. data/lib/ultracart_api/models/sfvb_upsell_offer.rb +598 -9
  40. data/lib/ultracart_api/models/sfvb_upsell_path.rb +373 -0
  41. data/lib/ultracart_api/models/sfvb_upsell_path_duplicate_request.rb +220 -0
  42. data/lib/ultracart_api/models/sfvb_upsell_path_move_request.rb +220 -0
  43. data/lib/ultracart_api/models/sfvb_upsell_paths_response.rb +272 -0
  44. data/lib/ultracart_api/models/sfvb_upsell_stats.rb +400 -0
  45. data/lib/ultracart_api/models/sfvb_upsell_step.rb +241 -0
  46. data/lib/ultracart_api/models/sfvb_upsell_step_offer.rb +288 -0
  47. data/lib/ultracart_api/models/sfvb_upsell_tower_data.rb +234 -0
  48. data/lib/ultracart_api/models/sfvb_upsell_variation.rb +241 -0
  49. data/lib/ultracart_api/version.rb +1 -1
  50. data/lib/ultracart_api.rb +20 -0
  51. metadata +42 -2
data/docs/SfvbUpsellStep.md ADDED
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbUpsellStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **experiment_offers** | [**Array<SfvbUpsellStepOffer>**](SfvbUpsellStepOffer.md) | An experiment step, splitting shoppers between these offers. Set this or offer, not both. | [optional] |
8
+ | **offer** | [**SfvbUpsellStepOffer**](SfvbUpsellStepOffer.md) | | [optional] |
9
+ | **type** | **String** | Read only. offer or experiment, from whichever of the two below is set. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbUpsellStep.new(
17
+ experiment_offers: null,
18
+ offer: null,
19
+ type: null
20
+ )
21
+ ```
22
+
data/docs/SfvbUpsellStepOffer.md ADDED
@@ -0,0 +1,32 @@
1
+ # UltracartClient::SfvbUpsellStepOffer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **downsell_offer_active** | **Boolean** | Read only. Whether the downsell offer is switched on. | [optional] |
8
+ | **downsell_offer_name** | **String** | Read only. The downsell offer's name. | [optional] |
9
+ | **downsell_offer_oid** | **Integer** | The offer shown when the shopper declines offer_oid. Omitted or null for no downsell. Must be an offer of this storefront. | [optional] |
10
+ | **downsell_offer_stats** | [**SfvbUpsellStats**](SfvbUpsellStats.md) | | [optional] |
11
+ | **offer_active** | **Boolean** | Read only. Whether the offer is switched on. | [optional] |
12
+ | **offer_name** | **String** | Read only. The offer's name. | [optional] |
13
+ | **offer_oid** | **Integer** | The offer shown at this step. Must be an offer of this storefront. | [optional] |
14
+ | **offer_stats** | [**SfvbUpsellStats**](SfvbUpsellStats.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::SfvbUpsellStepOffer.new(
22
+ downsell_offer_active: null,
23
+ downsell_offer_name: null,
24
+ downsell_offer_oid: null,
25
+ downsell_offer_stats: null,
26
+ offer_active: null,
27
+ offer_name: null,
28
+ offer_oid: null,
29
+ offer_stats: null
30
+ )
31
+ ```
32
+
data/docs/SfvbUpsellTowerData.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbUpsellTowerData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ages** | **Array<String>** | Age bands the path is shown to. 18-20, 21-24, 25-34, 35-44, 45-54, 55-64, 65+ or Unknown. | [optional] |
8
+ | **genders** | **Array<String>** | Genders the path is shown to. Male, Female or Unknown. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbUpsellTowerData.new(
16
+ ages: null,
17
+ genders: null
18
+ )
19
+ ```
20
+
data/docs/SfvbUpsellVariation.md ADDED
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbUpsellVariation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Variation name. | [optional] |
8
+ | **stats** | [**SfvbUpsellStats**](SfvbUpsellStats.md) | | [optional] |
9
+ | **steps** | [**Array<SfvbUpsellStep>**](SfvbUpsellStep.md) | The steps, in the order shoppers see them. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbUpsellVariation.new(
17
+ name: null,
18
+ stats: null,
19
+ steps: null
20
+ )
21
+ ```
22
+