ultracart_api 4.1.159 → 4.1.161

data/docs/SfvbBlogPost.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbBlogPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **String** | The post author. | [optional] |
+| **blog_post_oid** | **Integer** | The blog post's oid.  This is what a page's blog post assignment names. | [optional] |
+| **publication_dts** | **String** | When the post was published (ISO 8601, UTC), or when it was created if it has no publication time. | [optional] |
+| **title** | **String** | The post title. | [optional] |
+| **unassigned** | **Boolean** | True when no page shows this post yet.  Only reported by the blog post list. | [optional] |
+| **url_part** | **String** | The post's name in its URL. | [optional] |
+| **visibility** | **String** | P public, L logged in customers only, D draft. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbBlogPost.new(
+  author: null,
+  blog_post_oid: null,
+  publication_dts: null,
+  title: null,
+  unassigned: null,
+  url_part: null,
+  visibility: null
+)
+```
+

data/docs/SfvbBlogPostsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbBlogPostsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_posts** | [**Array<SfvbBlogPost>**](SfvbBlogPost.md) | One page of the storefront's blog posts, newest first. | [optional] |
+| **page** | **Integer** | The page returned, starting at 1. | [optional] |
+| **page_size** | **Integer** | Posts per page. | [optional] |
+| **total** | **Integer** | How many posts match, across all pages. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbBlogPostsResponse.new(
+  blog_posts: null,
+  page: null,
+  page_size: null,
+  total: null
+)
+```
+

data/docs/SfvbExperiment.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbExperiment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_ends_at** | **String** | When the experiment engine will end this experiment by itself and declare the variation with the best raw objective per session the winner, without a significance check (ISO 8601, UTC).  Set for running url and theme experiments, and for any running experiment whose traffic shifts toward the leader (equal_weighting false).  Null when only ending it deliberately will stop it. | [optional] |
+| **days_elapsed** | **Integer** | Whole days the experiment has run, up to now or to when it ended. | [optional] |
+| **experiment** | [**Experiment**](Experiment.md) |  | [optional] |
+| **notice** | **String** | Something the caller should know about what this call did or could not do. | [optional] |
+| **p_value_test** | **String** | The test behind p_value.  one_way_anova across all variations, so a low p_value says some variation differs, not which one is best. | [optional] |
+| **page_body_path** | **String** | Set when this call rewrote a page body - starting a page experiment writes its id there, and ending one without a winner clears it.  Pull the file again before editing it. | [optional] |
+| **page_body_sha256** | **String** | The rewritten page body's new hash, for If-Match on the next write. | [optional] |
+| **router_url** | **String** | For a url experiment, the address visitors must enter through to be split between the pages.  Ads and links must point here, not at the pages. | [optional] |
+| **sessions_needed_computed_dts** | **String** | When p95_sessions_needed was last estimated (ISO 8601, UTC).  It is estimated only once the experiment has 1000 sessions, and at most hourly.  Null before then. | [optional] |
+| **type** | **String** | page for an experiment element inside a page, url for a split between pages, theme for a split between themes, openai for a generated headline experiment. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperiment.new(
+  auto_ends_at: null,
+  days_elapsed: null,
+  experiment: null,
+  notice: null,
+  p_value_test: null,
+  page_body_path: null,
+  page_body_sha256: null,
+  router_url: null,
+  sessions_needed_computed_dts: null,
+  type: null
+)
+```
+

data/docs/SfvbExperimentEndRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbExperimentEndRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **winner_variation_number** | **Integer** | The variation to declare the winner.  Leave it out to end without one - a page experiment then shows variation 0, and a url experiment sends everyone to variation 0. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentEndRequest.new(
+  winner_variation_number: null
+)
+```
+

data/docs/SfvbExperimentObjective.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbExperimentObjective
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **objective** | **String** | The value an experiment's objective holds. | [optional] |
+| **per_session_value** | **String** | What is measured in each session and compared between variations. | [optional] |
+| **requires_parameter** | **Boolean** | True when the experiment also needs objective_parameter, the event name. | [optional] |
+| **usual_optimization_type** | **String** | MAXIMUM or MINIMUM, whichever is the usual goal for this objective. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentObjective.new(
+  objective: null,
+  per_session_value: null,
+  requires_parameter: null,
+  usual_optimization_type: null
+)
+```
+

data/docs/SfvbExperimentObjectivesResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbExperimentObjectivesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **objectives** | [**Array<SfvbExperimentObjective>**](SfvbExperimentObjective.md) | Every objective an experiment can optimize. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentObjectivesResponse.new(
+  objectives: null
+)
+```
+

data/docs/SfvbExperimentStartRequest.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbExperimentStartRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **duration_days** | **Integer** | url - 3 to 90.  A url experiment always ends by itself after this many days. | [optional] |
+| **equal_weighting** | **Boolean** | url - true keeps the split fixed.  false shifts traffic toward the leader as the experiment runs.  Defaults to true. | [optional] |
+| **name** | **String** | url - experiment name. | [optional] |
+| **notes** | **String** | url - notes, such as the hypothesis being tested. | [optional] |
+| **objective** | **String** | url - one of the objectives from the objective list. | [optional] |
+| **objective_parameter** | **String** | url - the event name, when the objective is Events. | [optional] |
+| **optimization_type** | **String** | url - MAXIMUM or MINIMUM. | [optional] |
+| **path** | **String** | page - path of the page whose body holds the experiment element. | [optional] |
+| **slot** | **String** | page - the body file's name without .cjson.  Defaults to body. | [optional] |
+| **type** | **String** | page or url. | [optional] |
+| **variations** | [**Array<SfvbExperimentStartVariation>**](SfvbExperimentStartVariation.md) | url - 2 to 5 pages.  The first is the control. | [optional] |
+| **widget_id** | **String** | page - id of the experiment element in that body. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentStartRequest.new(
+  duration_days: null,
+  equal_weighting: null,
+  name: null,
+  notes: null,
+  objective: null,
+  objective_parameter: null,
+  optimization_type: null,
+  path: null,
+  slot: null,
+  type: null,
+  variations: null,
+  widget_id: null
+)
+```
+

data/docs/SfvbExperimentStartVariation.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbExperimentStartVariation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Variation name, shown in the statistics. | [optional] |
+| **path** | **String** | Path of an existing page on this storefront, for example /lp/spring-sale-b/. | [optional] |
+| **traffic_percentage** | **Integer** | Starting share of traffic, 1 to 100.  Set it on every variation, adding up to 100, or on none for an even split. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentStartVariation.new(
+  name: null,
+  path: null,
+  traffic_percentage: null
+)
+```
+

data/docs/SfvbExperimentVariationUpdateRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbExperimentVariationUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **paused** | **Boolean** | true stops sending new visitors to the variation, false resumes it.  Visitors already assigned keep seeing it.  Variation 0 cannot be paused. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentVariationUpdateRequest.new(
+  paused: null
+)
+```
+

data/docs/SfvbExperimentsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbExperimentsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **experiments** | [**Array<SfvbExperiment>**](SfvbExperiment.md) | Experiments, running first, then by name.  Deleted experiments are left out.  Daily statistics are only on the single experiment read. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbExperimentsResponse.new(
+  experiments: null
+)
+```
+

data/docs/SfvbPageBlogPostSelector.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbPageBlogPostSelector
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attribute_name** | **String** | attribute - the blog post attribute name.  Required with attribute_value. | [optional] |
+| **attribute_value** | **String** | attribute - the value to match. | [optional] |
+| **author_name** | **String** | author name - required. | [optional] |
+| **tag** | **String** | tag - required. | [optional] |
+| **type** | **String** | One of all, author name, attribute, tag. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageBlogPostSelector.new(
+  attribute_name: null,
+  attribute_value: null,
+  author_name: null,
+  tag: null,
+  type: null
+)
+```
+

data/docs/SfvbPageBlogPostsRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbPageBlogPostsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_post_oids** | **Array<Integer>** | Blog post oids from the blog post list, at most 500. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageBlogPostsRequest.new(
+  blog_post_oids: null
+)
+```
+

data/docs/SfvbPageBlogPostsResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbPageBlogPostsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_posts** | [**Array<SfvbBlogPost>**](SfvbBlogPost.md) | The blog posts assigned to the page, newest first. | [optional] |
+| **path** | **String** | The page path. | [optional] |
+| **uses_selectors** | **Boolean** | True when selectors choose this page's blog posts.  They are then recalculated from the selectors, and adding or removing posts by hand is refused. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageBlogPostsResponse.new(
+  blog_posts: null,
+  path: null,
+  uses_selectors: null
+)
+```
+

data/docs/SfvbPageCreateRequest.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbPageCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The page description, for templates that show one. | [optional] |
+| **exclude_from_sitemap** | **Boolean** | Leave the page out of the sitemap and mark it noindex.  Usual for ad landing pages. | [optional] |
+| **group_template** | **String** | Template that renders the page, a name from the template list.  When omitted the page inherits its parent's templates, or catalog_group.vm directly under the root. | [optional] |
+| **item_template** | **String** | Template that renders the item pages under this page.  Inherited or defaulted like group_template. | [optional] |
+| **page_type** | **String** | S for a static page, D for a dynamic one.  Defaults to D, as in the admin. | [optional] |
+| **path** | **String** | Path of the new page, for example /lp/spring-sale/.  The parent page must already exist, and the last part may only contain letters, digits, hyphens and underscores. | [optional] |
+| **title** | **String** | The page title. | [optional] |
+| **visible** | **Boolean** | False creates the page hidden, so it answers 404 to shoppers until it is shown. | [optional] |
+| **visible_dts** | **String** | Keep the page hidden until this time (ISO 8601). | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageCreateRequest.new(
+  description: null,
+  exclude_from_sitemap: null,
+  group_template: null,
+  item_template: null,
+  page_type: null,
+  path: null,
+  title: null,
+  visible: null,
+  visible_dts: null
+)
+```
+

data/docs/SfvbPageDuplicateRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbPageDuplicateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** | Path of the copy, for example /lp/spring-sale-b/.  The same rules as creating a page - the parent must exist, the path must be new, and the last part may only contain letters, digits, hyphens and underscores. | [optional] |
+| **source_path** | **String** | Path of the page to copy.  Not the root, and not a page with pages under it. | [optional] |
+| **title** | **String** | Title of the copy.  Defaults to the source page's title. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageDuplicateRequest.new(
+  path: null,
+  source_path: null,
+  title: null
+)
+```
+

data/docs/SfvbPageItem.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbPageItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default_assignment** | **Boolean** | True when this page is the item's canonical home.  Read only - set in the store admin. | [optional] |
+| **item_id** | **String** | The item id, as the merchant knows it. | [optional] |
+| **merchant_item_oid** | **Integer** | The item's internal oid.  Read only. | [optional] |
+| **sort_order** | **Integer** | Position on the page.  Used only when the page sorts its items by a custom order (sort_order_child_items C). | [optional] |
+| **url_part** | **String** | The item page's name under this page, so the item is shown at the page path plus url_part plus .html.  Letters, digits, hyphens and underscores.  When empty the item id is used. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageItem.new(
+  default_assignment: null,
+  item_id: null,
+  merchant_item_oid: null,
+  sort_order: null,
+  url_part: null
+)
+```
+

data/docs/SfvbPageItemSelector.md

@@ -0,0 +1,42 @@
+# UltracartClient::SfvbPageItemSelector
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attribute_name** | **String** | attribute - the item attribute name.  Required with attribute_value. | [optional] |
+| **attribute_value** | **String** | attribute - the value to match. | [optional] |
+| **item_folder_oid** | **Integer** | item folder and item folder tree - the item folder, which must exist. | [optional] |
+| **manufacturer_name** | **String** | manufacturer name - required. | [optional] |
+| **retail_cost_high** | **Float** | retail cost - the highest price. | [optional] |
+| **retail_cost_low** | **Float** | retail cost - the lowest price.  At least one of low and high is required. | [optional] |
+| **sale_item** | **Boolean** | sale item - match items on sale. | [optional] |
+| **tag** | **String** | tag - the item tag to match.  Required. | [optional] |
+| **top_seller_count** | **Integer** | top seller - how many items, 1 to 250.  Required with top_seller_days. | [optional] |
+| **top_seller_days** | **Integer** | top seller - over how many days, 1 to 180. | [optional] |
+| **type** | **String** | One of retail cost, attribute, variation, not variation, manufacturer name, exploded diagram, sale item, item folder, item folder tree, top seller, new, pre-order, tag. | [optional] |
+| **variation_name** | **String** | variation - the variation name.  Required with variation_value. | [optional] |
+| **variation_value** | **String** | variation - the variation value to match. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageItemSelector.new(
+  attribute_name: null,
+  attribute_value: null,
+  item_folder_oid: null,
+  manufacturer_name: null,
+  retail_cost_high: null,
+  retail_cost_low: null,
+  sale_item: null,
+  tag: null,
+  top_seller_count: null,
+  top_seller_days: null,
+  type: null,
+  variation_name: null,
+  variation_value: null
+)
+```
+

data/docs/SfvbPageItemsAddRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbPageItemsAddRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<SfvbPageItem>**](SfvbPageItem.md) | Items to assign, at most 500.  An item already on the page keeps its place unless a sort_order or url_part is given, which replaces the stored one. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageItemsAddRequest.new(
+  items: null
+)
+```
+

data/docs/SfvbPageItemsRemoveRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbPageItemsRemoveRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_ids** | **Array<String>** | Item ids to take off the page, at most 500.  Every one must be on the page. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageItemsRemoveRequest.new(
+  item_ids: null
+)
+```
+

data/docs/SfvbPageItemsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbPageItemsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<SfvbPageItem>**](SfvbPageItem.md) | The items assigned to the page. | [optional] |
+| **path** | **String** | The page path. | [optional] |
+| **sort_order_child_items** | **String** | How the page orders its items.  C means by each item's sort_order. | [optional] |
+| **uses_selectors** | **Boolean** | True when selectors choose this page's items.  The items are then recalculated from the selectors, and adding or removing items by hand is refused. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageItemsResponse.new(
+  items: null,
+  path: null,
+  sort_order_child_items: null,
+  uses_selectors: null
+)
+```
+

data/docs/SfvbPageListResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbPageListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pages** | [**Array<SfvbPageSummary>**](SfvbPageSummary.md) | Pages sorted by path, the root first.  Hidden pages are included. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageListResponse.new(
+  pages: null
+)
+```
+

data/docs/SfvbPageResponse.md

@@ -5,8 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet.  These are what the pageattribute element renders.  Sorted by name. | [optional] |
+| **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
+| **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
+| **item_template** | **String** | Template file that renders the item pages under this page. | [optional] |
 | **multimedia** | [**Array<SfvbPageMultimedia>**](SfvbPageMultimedia.md) | The page's images, including codes a template declares but nothing has attached yet.  These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code.  The default image comes first. | [optional] |
 | **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
+| **title** | **String** | The page title. | [optional] |
+| **visible** | **Boolean** | False when the page is hidden.  A hidden page answers 404 to shoppers. | [optional] |
+| **visible_dts** | **String** | When set, the page stays hidden until this time (ISO 8601, UTC). | [optional] |
 
 ## Example
 
@@ -15,8 +21,14 @@ require 'ultracart_api'
 
 instance = UltracartClient::SfvbPageResponse.new(
   attributes: null,
+  exclude_from_sitemap: null,
+  group_template: null,
+  item_template: null,
   multimedia: null,
-  path: null
+  path: null,
+  title: null,
+  visible: null,
+  visible_dts: null
 )
 ```
 

data/docs/SfvbPageSelectors.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbPageSelectors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_post_selectors** | [**Array<SfvbPageBlogPostSelector>**](SfvbPageBlogPostSelector.md) | The conditions that choose the page's blog posts. | [optional] |
+| **item_selectors** | [**Array<SfvbPageItemSelector>**](SfvbPageItemSelector.md) | The conditions that choose the page's items.  While there are any, the page's items are recalculated from them and cannot be assigned by hand. | [optional] |
+| **match_all_blog_post_selectors** | **Boolean** | True when a blog post must meet every blog post selector, false when any one is enough. | [optional] |
+| **match_all_item_selectors** | **Boolean** | True when an item must meet every item selector, false when meeting any one is enough. | [optional] |
+| **path** | **String** | The page path.  Read only. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageSelectors.new(
+  blog_post_selectors: null,
+  item_selectors: null,
+  match_all_blog_post_selectors: null,
+  match_all_item_selectors: null,
+  path: null
+)
+```
+

data/docs/SfvbPageSettingsRequest.md

@@ -0,0 +1,44 @@
+# UltracartClient::SfvbPageSettingsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blog_post_template** | **String** | Template that renders the blog posts under this page. | [optional] |
+| **description** | **String** | The page description.  Null or empty clears it. | [optional] |
+| **exclude_from_sitemap** | **Boolean** | Leave the page out of the sitemap and mark it noindex. | [optional] |
+| **group_template** | **String** | Template that renders the page, a name from the template list. | [optional] |
+| **item_template** | **String** | Template that renders the item pages under this page. | [optional] |
+| **items_per_page** | **Integer** | Items per page on a template that paginates.  Null returns to the template's default. | [optional] |
+| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
+| **review_template** | **String** | Template that renders the item review pages under this page. | [optional] |
+| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order.  Null clears it. | [optional] |
+| **sort_order_child_groups** | **String** | How the pages under this one are ordered.  TA or TD by title, DA or DD by description, C custom. | [optional] |
+| **sort_order_child_items** | **String** | How the page's items are ordered.  IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom. | [optional] |
+| **title** | **String** | The page title. | [optional] |
+| **visible** | **Boolean** | False hides the page, so it answers 404 to shoppers.  The root page cannot be hidden. | [optional] |
+| **visible_dts** | **String** | Keep the page hidden until this time (ISO 8601).  Null or empty clears it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbPageSettingsRequest.new(
+  blog_post_template: null,
+  description: null,
+  exclude_from_sitemap: null,
+  group_template: null,
+  item_template: null,
+  items_per_page: null,
+  page_type: null,
+  review_template: null,
+  sort_order: null,
+  sort_order_child_groups: null,
+  sort_order_child_items: null,
+  title: null,
+  visible: null,
+  visible_dts: null
+)
+```
+