ultracart_api 4.1.159 → 4.1.161

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 (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -2
  3. data/docs/SfvbApi.md +1123 -10
  4. data/docs/SfvbBlogPost.md +30 -0
  5. data/docs/SfvbBlogPostsResponse.md +24 -0
  6. data/docs/SfvbExperiment.md +36 -0
  7. data/docs/SfvbExperimentEndRequest.md +18 -0
  8. data/docs/SfvbExperimentObjective.md +24 -0
  9. data/docs/SfvbExperimentObjectivesResponse.md +18 -0
  10. data/docs/SfvbExperimentStartRequest.md +40 -0
  11. data/docs/SfvbExperimentStartVariation.md +22 -0
  12. data/docs/SfvbExperimentVariationUpdateRequest.md +18 -0
  13. data/docs/SfvbExperimentsResponse.md +18 -0
  14. data/docs/SfvbPageBlogPostSelector.md +26 -0
  15. data/docs/SfvbPageBlogPostsRequest.md +18 -0
  16. data/docs/SfvbPageBlogPostsResponse.md +22 -0
  17. data/docs/SfvbPageCreateRequest.md +34 -0
  18. data/docs/SfvbPageDuplicateRequest.md +22 -0
  19. data/docs/SfvbPageItem.md +26 -0
  20. data/docs/SfvbPageItemSelector.md +42 -0
  21. data/docs/SfvbPageItemsAddRequest.md +18 -0
  22. data/docs/SfvbPageItemsRemoveRequest.md +18 -0
  23. data/docs/SfvbPageItemsResponse.md +24 -0
  24. data/docs/SfvbPageListResponse.md +18 -0
  25. data/docs/SfvbPageResponse.md +13 -1
  26. data/docs/SfvbPageSelectors.md +26 -0
  27. data/docs/SfvbPageSettingsRequest.md +44 -0
  28. data/docs/SfvbPageSummary.md +44 -0
  29. data/docs/SfvbTemplate.md +36 -0
  30. data/docs/SfvbTemplatesResponse.md +20 -0
  31. data/lib/ultracart_api/api/sfvb_api.rb +1722 -211
  32. data/lib/ultracart_api/models/sfvb_blog_post.rb +280 -0
  33. data/lib/ultracart_api/models/sfvb_blog_posts_response.rb +252 -0
  34. data/lib/ultracart_api/models/sfvb_experiment.rb +309 -0
  35. data/lib/ultracart_api/models/sfvb_experiment_end_request.rb +220 -0
  36. data/lib/ultracart_api/models/sfvb_experiment_objective.rb +250 -0
  37. data/lib/ultracart_api/models/sfvb_experiment_objectives_response.rb +222 -0
  38. data/lib/ultracart_api/models/sfvb_experiment_start_request.rb +332 -0
  39. data/lib/ultracart_api/models/sfvb_experiment_start_variation.rb +240 -0
  40. data/lib/ultracart_api/models/sfvb_experiment_variation_update_request.rb +220 -0
  41. data/lib/ultracart_api/models/sfvb_experiments_response.rb +222 -0
  42. data/lib/ultracart_api/models/sfvb_page_blog_post_selector.rb +260 -0
  43. data/lib/ultracart_api/models/sfvb_page_blog_posts_request.rb +222 -0
  44. data/lib/ultracart_api/models/sfvb_page_blog_posts_response.rb +242 -0
  45. data/lib/ultracart_api/models/sfvb_page_create_request.rb +300 -0
  46. data/lib/ultracart_api/models/sfvb_page_duplicate_request.rb +240 -0
  47. data/lib/ultracart_api/models/sfvb_page_item.rb +260 -0
  48. data/lib/ultracart_api/models/sfvb_page_item_selector.rb +340 -0
  49. data/lib/ultracart_api/models/sfvb_page_items_add_request.rb +222 -0
  50. data/lib/ultracart_api/models/sfvb_page_items_remove_request.rb +222 -0
  51. data/lib/ultracart_api/models/sfvb_page_items_response.rb +252 -0
  52. data/lib/ultracart_api/models/sfvb_page_list_response.rb +222 -0
  53. data/lib/ultracart_api/models/sfvb_page_response.rb +64 -4
  54. data/lib/ultracart_api/models/sfvb_page_selectors.rb +264 -0
  55. data/lib/ultracart_api/models/sfvb_page_settings_request.rb +350 -0
  56. data/lib/ultracart_api/models/sfvb_page_summary.rb +350 -0
  57. data/lib/ultracart_api/models/sfvb_template.rb +310 -0
  58. data/lib/ultracart_api/models/sfvb_templates_response.rb +232 -0
  59. data/lib/ultracart_api/version.rb +1 -1
  60. data/lib/ultracart_api.rb +26 -0
  61. metadata +53 -1
data/docs/SfvbPageSummary.md ADDED
@@ -0,0 +1,44 @@
1
+ # UltracartClient::SfvbPageSummary
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **child_count** | **Integer** | Number of pages directly under this one. | [optional] |
8
+ | **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
9
+ | **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
10
+ | **item_count** | **Integer** | Number of items assigned to the page. The catalog stops counting at its per-page item ceiling. | [optional] |
11
+ | **item_template** | **String** | Template file that renders the item pages under this page. | [optional] |
12
+ | **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
13
+ | **parent_path** | **String** | Path of the page this one sits under. Empty for the root page. | [optional] |
14
+ | **path** | **String** | The page path, beginning and ending with a slash. The root page is /. | [optional] |
15
+ | **root** | **Boolean** | True for the storefront's home page. | [optional] |
16
+ | **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. | [optional] |
17
+ | **title** | **String** | The page title. | [optional] |
18
+ | **uses_selectors** | **Boolean** | True when the page's items or blog posts are chosen by selectors rather than assigned by hand. | [optional] |
19
+ | **visible** | **Boolean** | False when the page is hidden. A hidden page answers 404 to shoppers. | [optional] |
20
+ | **visible_dts** | **String** | When set, the page stays hidden until this time (ISO 8601, UTC). | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'ultracart_api'
26
+
27
+ instance = UltracartClient::SfvbPageSummary.new(
28
+ child_count: null,
29
+ exclude_from_sitemap: null,
30
+ group_template: null,
31
+ item_count: null,
32
+ item_template: null,
33
+ page_type: null,
34
+ parent_path: null,
35
+ path: null,
36
+ root: null,
37
+ sort_order: null,
38
+ title: null,
39
+ uses_selectors: null,
40
+ visible: null,
41
+ visible_dts: null
42
+ )
43
+ ```
44
+
data/docs/SfvbTemplate.md ADDED
@@ -0,0 +1,36 @@
1
+ # UltracartClient::SfvbTemplate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **display_blog_posts** | **Boolean** | True when the template shows the page's blog posts. | [optional] |
8
+ | **display_items** | **Boolean** | True when the template shows the page's items. | [optional] |
9
+ | **display_subgroups** | **Boolean** | True when the template shows the pages under this one. | [optional] |
10
+ | **metadata_available** | **Boolean** | False when the template has no metadata, so the capability flags below are unknown. | [optional] |
11
+ | **name** | **String** | The bare file name. This is the value a page's group_template or item_template holds. | [optional] |
12
+ | **page_type** | **String** | The page type the template declares, such as group, item or static. system for the fixed templates the storefront itself uses, such as checkout and my account. Null when the template has no metadata. | [optional] |
13
+ | **pagination** | **Boolean** | True when the template pages through a long list of items. | [optional] |
14
+ | **system** | **Boolean** | True for the fixed templates the storefront itself uses. Never assign one to a page. | [optional] |
15
+ | **theme_relative_path** | **String** | Where the file sits inside the theme. | [optional] |
16
+ | **visual_builder** | **Boolean** | True when the template renders visual builder containers. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::SfvbTemplate.new(
24
+ display_blog_posts: null,
25
+ display_items: null,
26
+ display_subgroups: null,
27
+ metadata_available: null,
28
+ name: null,
29
+ page_type: null,
30
+ pagination: null,
31
+ system: null,
32
+ theme_relative_path: null,
33
+ visual_builder: null
34
+ )
35
+ ```
36
+
data/docs/SfvbTemplatesResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbTemplatesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **templates** | [**Array<SfvbTemplate>**](SfvbTemplate.md) | Templates sorted by name. | [optional] |
8
+ | **theme_oid** | **Integer** | The active theme the templates were read from. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbTemplatesResponse.new(
16
+ templates: null,
17
+ theme_oid: null
18
+ )
19
+ ```
20
+