ultracart_api 4.1.136 → 4.1.140

data/docs/SfvbCompileRequest.md

@@ -0,0 +1,26 @@
+# UltracartClient::SfvbCompileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson** | **String** | The container JSON to compile. | [optional] |
+| **container_name** | **String** | Optional container name, used to derive the container id the same way a .cjson file name would.  Omit and the id on the document is kept. | [optional] |
+| **storefront_oid** | **Integer** | Optional storefront oid.  Required when theme_oid is supplied. | [optional] |
+| **theme_oid** | **Integer** | Optional theme oid.  Supplies the theme's inherit groups configuration so compilation matches what the theme would produce.  Omit to compile without inheritance. | [optional] |
+| **validate** | **Boolean** | Run validation before compiling and fail on errors.  Defaults to true. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCompileRequest.new(
+  cjson: null,
+  container_name: null,
+  storefront_oid: null,
+  theme_oid: null,
+  validate: null
+)
+```
+

data/docs/SfvbCompileResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbCompileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_id** | **String** | Container id the document compiled under. | [optional] |
+| **directives** | **Array<String>** | Velocity directives the compiled output declares. | [optional] |
+| **success** | **Boolean** | True when compilation produced output. | [optional] |
+| **used_elements** | **Array<String>** | Element types used, sorted. | [optional] |
+| **validation** | [**SfvbValidationResponse**](SfvbValidationResponse.md) |  | [optional] |
+| **velocity** | **String** | The compiled Velocity.  This is the body only; the cache wrapper a stored .cjson gets is not included. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCompileResponse.new(
+  container_id: null,
+  directives: null,
+  success: null,
+  used_elements: null,
+  validation: null,
+  velocity: null
+)
+```
+

data/docs/SfvbContainerResponse.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbContainerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_theme** | **Boolean** | True when this container lives in the theme currently serving live traffic.  Writing to it requires the sfvb_publish scope. | [optional] |
+| **cjson** | **String** | The container JSON.  Runtime state is stripped on the way out. | [optional] |
+| **container_id** | **String** | Container id as the compiler will derive it. | [optional] |
+| **container_name** | **String** | Container name. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of the cjson.  Send back as If-Match when writing. | [optional] |
+| **last_modified** | **String** | When the container was last modified, where the store records it. | [optional] |
+| **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
+| **owner_type** | **String** | Where this container lives. | [optional] |
+| **path** | **String** | File path, for theme and page containers only. | [optional] |
+| **version** | **Integer** | File version, for theme and page containers only. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbContainerResponse.new(
+  active_theme: null,
+  cjson: null,
+  container_id: null,
+  container_name: null,
+  hash_sha256: null,
+  last_modified: null,
+  owner_object_id: null,
+  owner_type: null,
+  path: null,
+  version: null
+)
+```
+

data/docs/SfvbContainerRevertRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbContainerRevertRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | Optional comment recorded against the new version the revert creates. | [optional] |
+| **container_history_oid** | **Integer** | History record oid to restore, as returned by container_versions. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbContainerRevertRequest.new(
+  comment: null,
+  container_history_oid: null
+)
+```
+

data/docs/SfvbContainerVersion.md

@@ -0,0 +1,40 @@
+# UltracartClient::SfvbContainerVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cjson** | **String** | The CJSON this version held.  Populated only when reading a single version, and null when the operation is create.  Listings omit it because container CJSON is large. | [optional] |
+| **comment** | **String** | Comment recorded with the write that replaced this version. | [optional] |
+| **container_history_oid** | **Integer** | History record oid.  Pass to the revert operation on the owning container. | [optional] |
+| **container_name** | **String** | Container name, where the owner has more than one container. | [optional] |
+| **created_dts** | **String** | When this snapshot was taken. | [optional] |
+| **current** | **Boolean** | True for the value currently stored. | [optional] |
+| **edited_by** | **String** | Login of whoever caused this snapshot. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of this version's CJSON. | [optional] |
+| **operation** | **String** | What the container was before the write this entry precedes.  create means it did not exist, so reverting to this entry removes it again; update means it held the cjson recorded here. | [optional] |
+| **owner_object_id** | **String** | Owner object identifier. | [optional] |
+| **owner_type** | **String** | Owner type. | [optional] |
+| **size** | **Integer** | Size of this version's CJSON in bytes. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbContainerVersion.new(
+  cjson: null,
+  comment: null,
+  container_history_oid: null,
+  container_name: null,
+  created_dts: null,
+  current: null,
+  edited_by: null,
+  hash_sha256: null,
+  operation: null,
+  owner_object_id: null,
+  owner_type: null,
+  size: null
+)
+```
+

data/docs/SfvbContainerVersionsResponse.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbContainerVersionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **versions** | [**Array<SfvbContainerVersion>**](SfvbContainerVersion.md) | Versions, newest first. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbContainerVersionsResponse.new(
+  versions: null
+)
+```
+

data/docs/SfvbContainerWriteRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbContainerWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_warnings** | **Boolean** | Store the container even if quality warnings were raised.  Warnings never block by default; this field exists so a caller can opt into treating them as blocking by setting it false. | [optional] |
+| **cjson** | **String** | The container JSON to store. | [optional] |
+| **comment** | **String** | Optional comment recorded against the version this write creates. | [optional] |
+| **marketing_email** | **Boolean** | For email containers, whether this is a marketing email.  Selects whether CAN-SPAM footer rules apply. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbContainerWriteRequest.new(
+  allow_warnings: null,
+  cjson: null,
+  comment: null,
+  marketing_email: null
+)
+```
+

data/docs/SfvbElement.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbElement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_available** | **Boolean** | True when a per element configuration schema is available from elements/{element_type}. | [optional] |
+| **type** | **String** | The element type as it appears in the type property of a CJSON node. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbElement.new(
+  schema_available: null,
+  type: null
+)
+```
+

data/docs/SfvbElementSchemaResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbElementSchemaResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema** | **String** | JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet. | [optional] |
+| **type** | **String** | The element type. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbElementSchemaResponse.new(
+  schema: null,
+  type: null
+)
+```
+

data/docs/SfvbElementsResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbElementsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **element_count** | **Integer** | Number of element types. | [optional] |
+| **elements** | [**Array<SfvbElement>**](SfvbElement.md) | Every element type the compiler recognizes, sorted. | [optional] |
+| **version** | **String** | Container manager version this vocabulary belongs to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbElementsResponse.new(
+  element_count: null,
+  elements: null,
+  version: null
+)
+```
+

data/docs/SfvbErrorDetail.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbErrorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Stable machine readable code.  Namespaced sfvb.*  Safe to match on; these are never reworded. | [optional] |
+| **column** | **Integer** | 1-indexed column number.  Populated for Velocity problems. | [optional] |
+| **did_you_mean** | **Array<String>** | Close matches for an unrecognized value, best match first.  Populated for unknown element types and unknown configuration keys. | [optional] |
+| **expected** | **String** | Description of what was expected instead. | [optional] |
+| **found** | **String** | The value that was actually found, when the problem is about a value. | [optional] |
+| **line** | **Integer** | 1-indexed line number.  Populated for Velocity problems; null for CJSON problems, which carry a pointer instead. | [optional] |
+| **message** | **String** | Human readable description of the problem. | [optional] |
+| **pointer** | **String** | JSON Pointer (RFC 6901) to the offending node within the submitted CJSON.  Null for whole-document problems. | [optional] |
+| **severity** | **String** | error or warning.  Warnings never fail a request. | [optional] |
+| **suggestion** | **String** | Optional pointer at a known good example, typically a storefront library fragment that solves the same problem properly. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbErrorDetail.new(
+  code: null,
+  column: null,
+  did_you_mean: null,
+  expected: null,
+  found: null,
+  line: null,
+  message: null,
+  pointer: null,
+  severity: null,
+  suggestion: null
+)
+```
+

data/docs/SfvbFileContentResponse.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbFileContentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_compiled** | **Boolean** | True when this file is compiler output and must not be edited directly. | [optional] |
+| **content** | **String** | UTF-8 content.  Only text/* files can be read this way. | [optional] |
+| **fs_file_oid** | **Integer** | StoreFront file system file oid. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of the content.  Also returned as the ETag header; send it back as If-Match when writing. | [optional] |
+| **mime_type** | **String** | Mime type. | [optional] |
+| **path** | **String** | Full path of the file. | [optional] |
+| **size** | **Integer** | Size in bytes. | [optional] |
+| **truncated** | **Boolean** | True when the content was cut short.  Never truncated silently. | [optional] |
+| **valid** | **Boolean** | False when the file failed Velocity validation on its last write. | [optional] |
+| **velocity_errors** | **String** | Velocity errors recorded on the last write.  Null when valid. | [optional] |
+| **version** | **Integer** | Version number of the content returned. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileContentResponse.new(
+  auto_compiled: null,
+  content: null,
+  fs_file_oid: null,
+  hash_sha256: null,
+  mime_type: null,
+  path: null,
+  size: null,
+  truncated: null,
+  valid: null,
+  velocity_errors: null,
+  version: null
+)
+```
+

data/docs/SfvbFileEntry.md

@@ -0,0 +1,46 @@
+# UltracartClient::SfvbFileEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_compiled** | **Boolean** | True when this file is generated by the CJSON compiler and must not be edited directly.  Its .cjson sibling is the source. | [optional] |
+| **directory** | **Boolean** | True when this entry is a directory. | [optional] |
+| **fs_directory_oid** | **Integer** | StoreFront file system directory oid.  For a directory this is its own oid; for a file it is the parent. | [optional] |
+| **fs_file_oid** | **Integer** | StoreFront file system file oid. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of the content.  Use as the If-Match value when writing. | [optional] |
+| **i18n_violation** | **Boolean** | True when the file has internationalization violations. | [optional] |
+| **last_modified** | **String** | Last modified timestamp. | [optional] |
+| **merge_conflict** | **Boolean** | True when the file carries an unresolved theme merge conflict.  Blocks theme activation. | [optional] |
+| **mime_type** | **String** | Mime type.  Only text/* files can be read as content or searched by text. | [optional] |
+| **name** | **String** | File or directory name. | [optional] |
+| **path** | **String** | Full path of the file or directory. | [optional] |
+| **read_only** | **Boolean** | True when the file is marked read only. | [optional] |
+| **size** | **Integer** | Size in bytes.  Zero for directories. | [optional] |
+| **valid** | **Boolean** | False when the file failed Velocity validation on its last write. | [optional] |
+| **version** | **Integer** | Current version number of the file. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileEntry.new(
+  auto_compiled: null,
+  directory: null,
+  fs_directory_oid: null,
+  fs_file_oid: null,
+  hash_sha256: null,
+  i18n_violation: null,
+  last_modified: null,
+  merge_conflict: null,
+  mime_type: null,
+  name: null,
+  path: null,
+  read_only: null,
+  size: null,
+  valid: null,
+  version: null
+)
+```
+

data/docs/SfvbFileRevertRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbFileRevertRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | Optional comment recorded against the new version the revert creates. | [optional] |
+| **path** | **String** | Path of the file to revert. | [optional] |
+| **version** | **Integer** | Version to restore, as returned by files/versions. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileRevertRequest.new(
+  comment: null,
+  path: null,
+  version: null
+)
+```
+

data/docs/SfvbFileSearchRequest.md

@@ -0,0 +1,48 @@
+# UltracartClient::SfvbFileSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **case_sensitive** | **Boolean** | Whether the text search is case sensitive.  Defaults to false. | [optional] |
+| **dynamic_html** | **Boolean** | Only dynamic HTML (arbitrary) files. | [optional] |
+| **file_name** | **String** | Comma separated file name patterns, matched case insensitively with wildcards. | [optional] |
+| **i18n_violations** | **Boolean** | Only files with internationalization violations. | [optional] |
+| **invalid** | **Boolean** | Only files that failed Velocity validation. | [optional] |
+| **max_results** | **Integer** | Maximum results to return.  Clamped to the server maximum. | [optional] |
+| **merge_conflicts** | **Boolean** | Only files with unresolved theme merge conflicts. | [optional] |
+| **mime_type** | **String** | Restrict to a mime type. | [optional] |
+| **modified_max** | **String** | Only files modified at or before this ISO-8601 timestamp. | [optional] |
+| **modified_min** | **String** | Only files modified at or after this ISO-8601 timestamp. | [optional] |
+| **offset** | **Integer** | Results to skip.  Send the next_offset from a truncated response to continue.  Ordering is by path with the file oid as a tie breaker, so pages do not overlap or skip entries between calls. | [optional] |
+| **path** | **String** | Restrict to a directory path.  Strongly recommended alongside text. | [optional] |
+| **size_max** | **Integer** | Maximum size in bytes. | [optional] |
+| **size_min** | **Integer** | Minimum size in bytes. | [optional] |
+| **sub_directories** | **Boolean** | Recurse below path.  Defaults to true. | [optional] |
+| **text** | **String** | Text to find inside files.  Only text/* files are searched.  This is the expensive filter; narrow with path or file_name where possible. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileSearchRequest.new(
+  case_sensitive: null,
+  dynamic_html: null,
+  file_name: null,
+  i18n_violations: null,
+  invalid: null,
+  max_results: null,
+  merge_conflicts: null,
+  mime_type: null,
+  modified_max: null,
+  modified_min: null,
+  offset: null,
+  path: null,
+  size_max: null,
+  size_min: null,
+  sub_directories: null,
+  text: null
+)
+```
+

data/docs/SfvbFileSearchResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbFileSearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **files** | [**Array<SfvbFileEntry>**](SfvbFileEntry.md) | Matching files. | [optional] |
+| **max_results** | **Integer** | The cap that was applied. | [optional] |
+| **next_offset** | **Integer** | Offset to send for the next page.  Zero when truncated is false.  Never truncates without giving a way to continue. | [optional] |
+| **offset** | **Integer** | Results skipped to produce this page. | [optional] |
+| **result_count** | **Integer** | Number of results returned. | [optional] |
+| **total_count** | **Integer** | Total matches found.  Available because the underlying query is unbounded and returns everything anyway; it is not evidence that fetching them all is cheap. | [optional] |
+| **truncated** | **Boolean** | True when matches exist beyond this page.  next_offset is populated when it is. | [optional] |
+| **truncation_advice** | **String** | Advice for the caller when truncated is true. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileSearchResponse.new(
+  files: null,
+  max_results: null,
+  next_offset: null,
+  offset: null,
+  result_count: null,
+  total_count: null,
+  truncated: null,
+  truncation_advice: null
+)
+```
+

data/docs/SfvbFileVersion.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbFileVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | Comment recorded with the write. | [optional] |
+| **current** | **Boolean** | True for the version currently on disk. | [optional] |
+| **edited_by** | **String** | Login of whoever wrote this version. | [optional] |
+| **fs_file_history_oid** | **Integer** | History record oid. | [optional] |
+| **hash_sha256** | **String** | SHA-256 of this version's content. | [optional] |
+| **last_modified** | **String** | When this version was written. | [optional] |
+| **revertable** | **Boolean** | True when this version can be reverted to. | [optional] |
+| **size** | **Integer** | Size in bytes. | [optional] |
+| **version** | **Integer** | Version number.  Pass to files/content or files/revert. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileVersion.new(
+  comment: null,
+  current: null,
+  edited_by: null,
+  fs_file_history_oid: null,
+  hash_sha256: null,
+  last_modified: null,
+  revertable: null,
+  size: null,
+  version: null
+)
+```
+

data/docs/SfvbFileVersionsResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbFileVersionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fs_file_oid** | **Integer** | StoreFront file system file oid. | [optional] |
+| **path** | **String** | Path of the file. | [optional] |
+| **versions** | [**Array<SfvbFileVersion>**](SfvbFileVersion.md) | Versions, newest first.  The first entry is the current content. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileVersionsResponse.new(
+  fs_file_oid: null,
+  path: null,
+  versions: null
+)
+```
+

data/docs/SfvbFileWriteRequest.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbFileWriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | Optional comment recorded against the version this write creates. | [optional] |
+| **content** | **String** | UTF-8 content to write. | [optional] |
+| **create_if_missing** | **Boolean** | Create the file if it does not exist.  Defaults to true. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileWriteRequest.new(
+  comment: null,
+  content: null,
+  create_if_missing: null
+)
+```
+

data/docs/SfvbFileWriteResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbFileWriteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compiled_path** | **String** | Path of the compiled output, when writing a .cjson under a theme triggered a compile. | [optional] |
+| **file** | [**SfvbFileEntry**](SfvbFileEntry.md) |  | [optional] |
+| **hash_sha256** | **String** | New SHA-256.  Use as the next If-Match value. | [optional] |
+| **validation** | [**SfvbValidationResponse**](SfvbValidationResponse.md) |  | [optional] |
+| **velocity_errors** | **String** | Velocity errors recorded by the store.  Present means the file was written but is not valid. | [optional] |
+| **version** | **Integer** | New version number. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFileWriteResponse.new(
+  compiled_path: null,
+  file: null,
+  hash_sha256: null,
+  validation: null,
+  velocity_errors: null,
+  version: null
+)
+```
+

data/docs/SfvbFilesResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbFilesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **files** | [**Array<SfvbFileEntry>**](SfvbFileEntry.md) | Directories first, then files, each sorted by name. | [optional] |
+| **fs_directory_oid** | **Integer** | Oid of the directory that was listed. | [optional] |
+| **omitted_count** | **Integer** | Number of entries omitted when truncated is true. | [optional] |
+| **parent_fs_directory_oid** | **Integer** | Oid of the parent directory, or zero at the root. | [optional] |
+| **path** | **String** | Path that was listed. | [optional] |
+| **truncated** | **Boolean** | True when the listing was capped.  Never truncated silently. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbFilesResponse.new(
+  files: null,
+  fs_directory_oid: null,
+  omitted_count: null,
+  parent_fs_directory_oid: null,
+  path: null,
+  truncated: null
+)
+```
+

data/docs/SfvbLibraryEntry.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbLibraryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bookmarked** | **Boolean** | True when the calling user has bookmarked this entry. | [optional] |
+| **cjson** | **String** | The fragment's CJSON.  Omitted from search results to keep them terse; fetch a single entry to get it. | [optional] |
+| **description** | **String** | What this fragment is for. | [optional] |
+| **library_oid** | **Integer** | Library entry oid. | [optional] |
+| **name** | **String** | Entry name. | [optional] |
+| **owned** | **Boolean** | True when the calling user owns this entry. | [optional] |
+| **referenced_files** | **Array<String>** | Storefront file paths this fragment references.  Installing the fragment copies them into the storefront; reading it does not. | [optional] |
+| **screenshot_key** | **String** | S3 listing key for the large screenshot, when one has been generated. | [optional] |
+| **share_with_account** | **Boolean** | True when the entry is shared across the merchant account. | [optional] |
+| **thumbnail_key** | **String** | S3 listing key for the medium thumbnail, when one has been generated.  Thumbnails are produced asynchronously and can lag a save by a minute or two. | [optional] |
+| **widget_type** | **String** | Element type at the root of the fragment. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbLibraryEntry.new(
+  bookmarked: null,
+  cjson: null,
+  description: null,
+  library_oid: null,
+  name: null,
+  owned: null,
+  referenced_files: null,
+  screenshot_key: null,
+  share_with_account: null,
+  thumbnail_key: null,
+  widget_type: null
+)
+```
+