ultracart_api 4.1.176 → 4.1.178

data/docs/SfvbBlogPostRequest.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbBlogPostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_comments** | **Boolean** | Whether shoppers may comment.  Defaults to false on create. | [optional] |
+| **author** | **String** | The author's name as plain text, up to 100 characters, with no quotes or angle brackets. | [optional] |
+| **body** | **String** | The post body as HTML, up to 1 MB, rendered exactly as stored.  Refused with sfvb.unsafe_html if it could run script - script and other executable tags, on attributes, links that are not http, https, mailto, tel or relative, and iframes other than YouTube or Vimeo players.  Reference an attached image by the url the post's images report. | [optional] |
+| **excerpt** | **String** | The post excerpt as HTML, up to 256 KB.  Held to the same rule as body. | [optional] |
+| **publication_dts** | **String** | When the post is published, as an ISO 8601 UTC time in the same form publication_dts reads back.  Refused on a draft.  A post made public without one is published now. | [optional] |
+| **tags** | **Array<String>** | The post's tags as plain text, up to 100 characters each, with no quotes or angle brackets and no repeats.  On an update the list replaces every tag, and an empty list clears them. | [optional] |
+| **title** | **String** | The post title, up to 1000 characters.  Required on create. | [optional] |
+| **url_part** | **String** | The post's name in its URL, which is the page path followed by this and .html.  Letters, digits, hyphens and underscores, up to 150.  Must not be used by another post on the storefront, compared without regard to case, and must not be an item id or an item's url part, because the storefront checks blog posts first and the post would replace the item's page.  index and index-N are reserved.  Required on create. | [optional] |
+| **visibility** | **String** | P public, L logged in customers only, D draft.  Defaults to D on create.  Anything but D needs sfvb_publish, and so does any change to a post that is not a draft. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbBlogPostRequest.new(
+  allow_comments: null,
+  author: null,
+  body: null,
+  excerpt: null,
+  publication_dts: null,
+  tags: null,
+  title: null,
+  url_part: null,
+  visibility: null
+)
+```
+

data/docs/SfvbPageAttributeUpdate.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Attribute name.  Matched without regard to case against what the page already has, so you do not have to reproduce the exact casing.  A name nothing matches creates a new attribute. | [optional] |
 | **type** | **String** | Only consulted when creating an attribute no template declares.  For a declared attribute the template's type always wins, because the templates decide it and not the caller. | [optional] |
-| **value** | **String** | The value to store.  An empty string clears it.  For html the markup is stored as given and rendered as given.  For boolean send the text true or false. | [optional] |
+| **value** | **String** | The value to store.  An empty string clears it.  For html the markup is stored as given and rendered as given.  For boolean send the text true or false.  For itemset send a comma separated list of merchant item ids in display order, not JSON.  An id that does not resolve is dropped. | [optional] |
 
 ## Example
 

data/docs/SfvbServerLog.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbServerLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_error** | **Boolean** | True when the render itself failed and the page could not be produced. | [optional] |
+| **duration_ms** | **Integer** | How long the render took in milliseconds. | [optional] |
+| **error_count** | **Integer** | Error lines in the log, including Velocity problems such as a null | [optional] |
+| **line_count** | **Integer** | Lines in the full log text. | [optional] |
+| **log_id** | **String** | Opaque id of this log.  Pass it to the get endpoint.  Preview pages send the same id in the X-UltraCart-Storefront-Log-Id response header. | [optional] |
+| **request_template** | **String** | The template the page rendered with, when known. | [optional] |
+| **request_url** | **String** | The address that was rendered, as the server recorded it. | [optional] |
+| **start_date** | **String** | When the render started, ISO-8601 in UTC. | [optional] |
+| **status** | **String** | ERROR when the render logged any error line or failed, otherwise SUCCESS. | [optional] |
+| **stop_date** | **String** | When the render finished, ISO-8601 in UTC. | [optional] |
+| **warning_count** | **Integer** | Warning lines in the log. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbServerLog.new(
+  app_error: null,
+  duration_ms: null,
+  error_count: null,
+  line_count: null,
+  log_id: null,
+  request_template: null,
+  request_url: null,
+  start_date: null,
+  status: null,
+  stop_date: null,
+  warning_count: null
+)
+```
+

data/docs/SfvbServerLogDetail.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbServerLogDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entries** | [**Array<SfvbServerLogEntry>**](SfvbServerLogEntry.md) | The log's lines in the order they were written, at or above min_level. | [optional] |
+| **log** | [**SfvbServerLog**](SfvbServerLog.md) |  | [optional] |
+| **min_level** | **String** | The lowest level included in entries. | [optional] |
+| **remote_ip** | **String** | The address of the browser that asked for the page, as the backend log viewer shows it. | [optional] |
+| **user_agent** | **String** | The browser's user agent, as the backend log viewer shows it. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbServerLogDetail.new(
+  entries: null,
+  log: null,
+  min_level: null,
+  remote_ip: null,
+  user_agent: null
+)
+```
+

data/docs/SfvbServerLogEntry.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbServerLogEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** | The area that wrote the line, such as VELOCITY, FLOW, CACHE or RUNTIME.  Empty for SYSERR lines. | [optional] |
+| **level** | **String** | DEBUG, INFO, WARN, ERROR or SYSERR.  SYSERR is an internal logging failure and counts as an error. | [optional] |
+| **logged_at** | **String** | The line's own time as the log wrote it, yyyy/MM/dd hh.mm.ss on a 12 hour clock without AM or PM.  Use the log start_date and the entry order for real timing. | [optional] |
+| **message** | **String** | The line's text.  A message that spanned several lines keeps its line breaks. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbServerLogEntry.new(
+  category: null,
+  level: null,
+  logged_at: null,
+  message: null
+)
+```
+

data/docs/SfvbServerLogsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbServerLogsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The most logs returned. | [optional] |
+| **logs** | [**Array<SfvbServerLog>**](SfvbServerLog.md) | Matching logs, newest first, without their text. | [optional] |
+| **more_available** | **Boolean** | True when older logs in the window were not read.  Narrow since, or page by moving since back. | [optional] |
+| **searched** | **Integer** | How many of the newest logs in the window were read to find these. | [optional] |
+| **since** | **String** | The start of the window searched, ISO-8601 in UTC.  Logs are kept for seven days. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbServerLogsResponse.new(
+  limit: null,
+  logs: null,
+  more_available: null,
+  searched: null,
+  since: null
+)
+```
+