ultracart_api 4.1.177 → 4.1.179

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5927e57c7c670e896a768b1971a60dae46435a3e0554160d91ca866078c658f1
-  data.tar.gz: a9ee0e285fd76e8f7d1a72fc03257a66d1c32fc4592033658a4e2a9e05c24dea
+  metadata.gz: 7be2900314bb7fd6dbb8b131e2ec81241b554295c1f0e0a8f358351c85bd2fc9
+  data.tar.gz: ed5d67d6b4a183517fcba0bb7648dbbcd3c04e50f37e1a4d8615069763eea627
 SHA512:
-  metadata.gz: d1746a54265690eca953a6c3b0fd8b22adbb50e3927f64301991eef62bf7ee6f1687c9df5d68e9d7f981c8843c636cc99bafd25eec0bf6c927bb534134aa3d39
-  data.tar.gz: 2169951d8d08506e3e7dda88fbb54bb5673c7b976a5e4eea149f7c058054d20ea2dfc446e211c6f88df83314974e8ff816b7436ed2df2371ee51b1d219326bcb
+  metadata.gz: 8d0665e462f12b907302102007ff4a4cbde6f01fa071d0159d5b8e93b9f7444558493651ce13ed0bea8bf8280a88877f97f79fab86b4d3dbc9cb667a713da00f
+  data.tar.gz: '086081a72686f31419a1644b82921ba67f4b4736e64870be4c8554ef61850f4e8df6b9bcc903b075aca724cab43f3c975d9abc8991a82e7b67a9cb1e45796a6b'

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.177
+- Package version: 4.1.179
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.177'
+gem 'ultracart_api', '4.1.179'
 ```
 
 install:
@@ -512,6 +512,9 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
 *UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
 *UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
+*UltracartClient::SfvbApi* | [**get_sfvb_recording**](docs/SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording
+*UltracartClient::SfvbApi* | [**get_sfvb_recording_page_view_events**](docs/SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events
+*UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
 *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
 *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
 *UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
@@ -533,6 +536,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
 *UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
 *UltracartClient::SfvbApi* | [**list_sfvb_pages**](docs/SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages
+*UltracartClient::SfvbApi* | [**list_sfvb_server_logs**](docs/SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs
 *UltracartClient::SfvbApi* | [**list_sfvb_storefronts**](docs/SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts
 *UltracartClient::SfvbApi* | [**list_sfvb_templates**](docs/SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates
 *UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
@@ -1879,8 +1883,18 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
  - [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
+ - [UltracartClient::SfvbRecording](docs/SfvbRecording.md)
+ - [UltracartClient::SfvbRecordingEvent](docs/SfvbRecordingEvent.md)
+ - [UltracartClient::SfvbRecordingEventsResponse](docs/SfvbRecordingEventsResponse.md)
+ - [UltracartClient::SfvbRecordingPageView](docs/SfvbRecordingPageView.md)
+ - [UltracartClient::SfvbRecordingParameter](docs/SfvbRecordingParameter.md)
+ - [UltracartClient::SfvbRecordingResponse](docs/SfvbRecordingResponse.md)
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
+ - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
+ - [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
+ - [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
+ - [UltracartClient::SfvbServerLogsResponse](docs/SfvbServerLogsResponse.md)
  - [UltracartClient::SfvbSiteAttribute](docs/SfvbSiteAttribute.md)
  - [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
  - [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
@@ -2090,6 +2104,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.179 | 10/01/2026 | sfvb internal testing |
+| 4.1.178 | 09/30/2026 | sfvb internal testing |
 | 4.1.177 | 09/30/2026 | sfvb internal testing |
 | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
 | 4.1.175 | 09/29/2026 | sfvb internal testing |

data/docs/SfvbApi.md

@@ -44,6 +44,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
 | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
 | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
+| [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
+| [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
+| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
 | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
 | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
 | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
@@ -65,6 +68,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
 | [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
 | [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
+| [**list_sfvb_server_logs**](SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs |
 | [**list_sfvb_storefronts**](SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts |
 | [**list_sfvb_templates**](SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates |
 | [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
@@ -2282,6 +2286,170 @@ end
 - **Accept**: application/json
 
 
+## get_sfvb_recording
+
+> <SfvbRecordingResponse> get_sfvb_recording(storefront_oid, screen_recording_uuid)
+
+Get a screen recording
+
+One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view's replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_recording_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbRecordingResponse>, Integer, Hash)> get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
+
+```ruby
+begin
+  # Get a screen recording
+  data, status_code, headers = api_instance.get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbRecordingResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_recording_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **screen_recording_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbRecordingResponse**](SfvbRecordingResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sfvb_recording_page_view_events
+
+> <SfvbRecordingEventsResponse> get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
+
+Get one recorded page view's replay events
+
+The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_recording_page_view_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbRecordingEventsResponse>, Integer, Hash)> get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
+
+```ruby
+begin
+  # Get one recorded page view's replay events
+  data, status_code, headers = api_instance.get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbRecordingEventsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_recording_page_view_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **screen_recording_uuid** | **String** |  |  |
+| **screen_recording_page_view_uuid** | **String** |  |  |
+
+### Return type
+
+[**SfvbRecordingEventsResponse**](SfvbRecordingEventsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_sfvb_server_log
+
+> <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
+
+Get one storefront render log
+
+One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_sfvb_server_log_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbServerLogDetail>, Integer, Hash)> get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
+
+```ruby
+begin
+  # Get one storefront render log
+  data, status_code, headers = api_instance.get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbServerLogDetail>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->get_sfvb_server_log_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **log_id** | **String** |  |  |
+| **min_level** | **String** |  | [optional] |
+
+### Return type
+
+[**SfvbServerLogDetail**](SfvbServerLogDetail.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sfvb_site_attributes
 
 > <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
@@ -3425,6 +3593,63 @@ end
 - **Accept**: application/json
 
 
+## list_sfvb_server_logs
+
+> <SfvbServerLogsResponse> list_sfvb_server_logs(storefront_oid, opts)
+
+List recent storefront render logs
+
+The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text.  Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log.  Filter by uri (a case insensitive contains match on the rendered address) and errors_only.  since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000.  With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the list_sfvb_server_logs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SfvbServerLogsResponse>, Integer, Hash)> list_sfvb_server_logs_with_http_info(storefront_oid, opts)
+
+```ruby
+begin
+  # List recent storefront render logs
+  data, status_code, headers = api_instance.list_sfvb_server_logs_with_http_info(storefront_oid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SfvbServerLogsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling SfvbApi->list_sfvb_server_logs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **uri** | **String** |  | [optional] |
+| **since** | **String** |  | [optional] |
+| **errors_only** | **Boolean** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**SfvbServerLogsResponse**](SfvbServerLogsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_sfvb_storefronts
 
 > <SfvbStorefrontsResponse> list_sfvb_storefronts

data/docs/SfvbRecording.md

@@ -0,0 +1,60 @@
+# UltracartClient::SfvbRecording
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ad_platform** | [**ScreenRecordingAdPlatform**](ScreenRecordingAdPlatform.md) |  | [optional] |
+| **browser** | **String** | Browser name from the user agent. | [optional] |
+| **browser_version** | **String** | Browser version from the user agent. | [optional] |
+| **converted** | **Boolean** | True when the session ended in an order. | [optional] |
+| **device** | **String** | Device name from the user agent. | [optional] |
+| **end_timestamp** | **String** | When the session ended, ISO-8601 in UTC. | [optional] |
+| **geolocation_country** | **String** | Country the visitor was in. | [optional] |
+| **geolocation_state** | **String** | State or region the visitor was in. | [optional] |
+| **language_iso_code** | **String** | The browser language. | [optional] |
+| **order_id** | **String** | The order placed during the session, when there was one. | [optional] |
+| **os** | **String** | Operating system from the user agent. | [optional] |
+| **page_view_count** | **Integer** | How many pages the visitor viewed. | [optional] |
+| **page_views** | [**Array<SfvbRecordingPageView>**](SfvbRecordingPageView.md) | The pages viewed, in order. | [optional] |
+| **referrer_domain** | **String** | The domain that referred the visitor. | [optional] |
+| **rrweb_version** | **String** | The rrweb version that recorded the session.  Replay with the same version. | [optional] |
+| **screen_recording_uuid** | **String** | Identifies the recording. | [optional] |
+| **start_timestamp** | **String** | When the session started, ISO-8601 in UTC. | [optional] |
+| **time_on_site** | **Integer** | Seconds the visitor spent on the site. | [optional] |
+| **utm_campaign** | **String** | utm_campaign on arrival. | [optional] |
+| **utm_source** | **String** | utm_source on arrival. | [optional] |
+| **window_height** | **Integer** | Browser window height in pixels. | [optional] |
+| **window_width** | **Integer** | Browser window width in pixels. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecording.new(
+  ad_platform: null,
+  browser: null,
+  browser_version: null,
+  converted: null,
+  device: null,
+  end_timestamp: null,
+  geolocation_country: null,
+  geolocation_state: null,
+  language_iso_code: null,
+  order_id: null,
+  os: null,
+  page_view_count: null,
+  page_views: null,
+  referrer_domain: null,
+  rrweb_version: null,
+  screen_recording_uuid: null,
+  start_timestamp: null,
+  time_on_site: null,
+  utm_campaign: null,
+  utm_source: null,
+  window_height: null,
+  window_width: null
+)
+```
+

data/docs/SfvbRecordingEvent.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbRecordingEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The event name, such as rage click, script error, checkout error or add to cart. | [optional] |
+| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The event's parameters as name and value pairs.  Omitted for input change events, whose values are what the visitor typed. | [optional] |
+| **sub_text** | **String** | A short human readable summary of the event, when the recorder produced one. | [optional] |
+| **timestamp** | **String** | When it happened, ISO-8601 in UTC.  Subtract the page view's first_event_timestamp for the offset into the replay. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingEvent.new(
+  name: null,
+  params: null,
+  sub_text: null,
+  timestamp: null
+)
+```
+

data/docs/SfvbRecordingEventsResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbRecordingEventsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events_json** | **String** | The page view's rrweb events as a JSON array in a string, the input an rrweb Replayer takes.  Card number and security code fields are masked by the recorder, but other text the visitor typed can appear in it. | [optional] |
+| **rrweb_version** | **String** | The rrweb version that recorded the events.  Replay with the same version. | [optional] |
+| **screen_recording_page_view_uuid** | **String** | The page view these events replay. | [optional] |
+| **screen_recording_uuid** | **String** | The recording the page view belongs to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingEventsResponse.new(
+  events_json: null,
+  rrweb_version: null,
+  screen_recording_page_view_uuid: null,
+  screen_recording_uuid: null
+)
+```
+

data/docs/SfvbRecordingPageView.md

@@ -0,0 +1,42 @@
+# UltracartClient::SfvbRecordingPageView
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The host name of the address. | [optional] |
+| **events** | [**Array<SfvbRecordingEvent>**](SfvbRecordingEvent.md) | Named events on this page view in time order, such as rage clicks and script errors. | [optional] |
+| **first_event_timestamp** | **String** | When recording of this page view began, ISO-8601 in UTC. | [optional] |
+| **last_event_timestamp** | **String** | When recording of this page view ended, ISO-8601 in UTC. | [optional] |
+| **missing_events** | **Boolean** | True when no replay events were stored for this page view. | [optional] |
+| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The query string parameters on the address. | [optional] |
+| **referrer** | **String** | The referring address, when there was one. | [optional] |
+| **screen_recording_page_view_uuid** | **String** | Identifies this page view when fetching its replay events. | [optional] |
+| **time_on_page** | **Integer** | Seconds the visitor spent on the page. | [optional] |
+| **timing_dom_content_loaded** | **Integer** | Milliseconds until DOMContentLoaded fired. | [optional] |
+| **timing_loaded** | **Integer** | Milliseconds until the load event fired. | [optional] |
+| **truncated_events** | **Boolean** | True when the recorder stopped storing events part way through this page view. | [optional] |
+| **url** | **String** | The address the visitor viewed. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingPageView.new(
+  domain: null,
+  events: null,
+  first_event_timestamp: null,
+  last_event_timestamp: null,
+  missing_events: null,
+  params: null,
+  referrer: null,
+  screen_recording_page_view_uuid: null,
+  time_on_page: null,
+  timing_dom_content_loaded: null,
+  timing_loaded: null,
+  truncated_events: null,
+  url: null
+)
+```
+

data/docs/SfvbRecordingParameter.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbRecordingParameter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Parameter name. | [optional] |
+| **value** | **String** | Parameter value as text. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingParameter.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/SfvbRecordingResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbRecordingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording** | [**SfvbRecording**](SfvbRecording.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbRecordingResponse.new(
+  recording: null
+)
+```
+

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
+)
+```
+