ultracart_api 4.1.231 → 4.1.232

data/docs/SfvbCommsTemplate.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbCommsTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The description. | [optional] |
+| **email_template_oid** | **Integer** | The saved template's id, for a storefront or system template. | [optional] |
+| **name** | **String** | The name. | [optional] |
+| **path** | **String** | The theme file, for a base template. | [optional] |
+| **sort_order** | **Integer** | The admin's order. | [optional] |
+| **source** | **String** | storefront (saved on this storefront), system (UltraCart's), or base (a theme file an email renders inside). | [optional] |
+| **trigger_type** | **String** | The flow trigger the template is meant for, or none. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplate.new(
+  description: null,
+  email_template_oid: null,
+  name: null,
+  path: null,
+  sort_order: null,
+  source: null,
+  trigger_type: null
+)
+```
+

data/docs/SfvbCommsTemplateResponse.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsTemplateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_cjson** | **String** | The template's body, as CJSON. | [optional] |
+| **email_template_vm_path** | **String** | The Velocity template it renders inside.  Its content isn't shown here. | [optional] |
+| **notes** | **Array<String>** | What isn't shown. | [optional] |
+| **template** | [**SfvbCommsTemplate**](SfvbCommsTemplate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplateResponse.new(
+  container_cjson: null,
+  email_template_vm_path: null,
+  notes: null,
+  template: null
+)
+```
+

data/docs/SfvbCommsTemplatesResponse.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbCommsTemplatesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notes** | **Array<String>** | What each source is. | [optional] |
+| **templates** | [**Array<SfvbCommsTemplate>**](SfvbCommsTemplate.md) | Saved templates first (system, then this storefront's), then base templates. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTemplatesResponse.new(
+  notes: null,
+  templates: null
+)
+```
+

data/docs/SfvbCommsTestEmailRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbCommsTestEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cart_item_ids** | **Array<String>** | Items for a cart flow's email.  The cart is built for the test. | [optional] |
+| **email_uuid** | **String** | The email, which this step sends.  For an experiment step, one variant's email. | [optional] |
+| **order_id** | **String** | A test order to render an order flow's email with.  A real customer's order is refused. | [optional] |
+| **to_email** | **String** | The recipient, which must be the email address of a user on this account. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestEmailRequest.new(
+  cart_item_ids: null,
+  email_uuid: null,
+  order_id: null,
+  to_email: null
+)
+```
+

data/docs/SfvbCommsTestPostcardRequest.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbCommsTestPostcardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | The street address. | [optional] |
+| **address2** | **String** | The second address line. | [optional] |
+| **cart_item_ids** | **Array<String>** | Items for a cart flow's card. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **dry_run** | **Boolean** | Check everything, including that postcards are turned on, and show the cost, without mailing or using an approval. | [optional] |
+| **mail_card** | **Boolean** | Must be true.  Without it nothing is mailed; use the postcard proof to see the card. | [optional] |
+| **name** | **String** | The recipient's name. | [optional] |
+| **order_id** | **String** | A test order to render an order flow's card with.  A real customer's order is refused. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **state** | **String** | The state. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestPostcardRequest.new(
+  address1: null,
+  address2: null,
+  cart_item_ids: null,
+  city: null,
+  dry_run: null,
+  mail_card: null,
+  name: null,
+  order_id: null,
+  postal_code: null,
+  state: null
+)
+```
+

data/docs/SfvbCommsTestSendResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbCommsTestSendResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | For an SMS, the message as sent. | [optional] |
+| **channel** | **String** | email, sms or postcard. | [optional] |
+| **cost** | **Float** | For a postcard, what this card costs the account. | [optional] |
+| **dry_run** | **Boolean** | True when nothing was sent. | [optional] |
+| **notes** | **Array<String>** | What else happened, such as records created by the test. | [optional] |
+| **recipient** | **String** | Who it went to, as a user on this account (their login), or the postcard's city and state. | [optional] |
+| **sent** | **Boolean** | True when it was sent or mailed.  False on a dry run or when it was skipped. | [optional] |
+| **skipped_reason** | **String** | Why it wasn't sent or mailed, when it wasn't. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestSendResponse.new(
+  body: null,
+  channel: null,
+  cost: null,
+  dry_run: null,
+  notes: null,
+  recipient: null,
+  sent: null,
+  skipped_reason: null
+)
+```
+

data/docs/SfvbCommsTestSmsRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::SfvbCommsTestSmsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to_phone** | **String** | The recipient in E.164 form, such as +14045550100.  It must be the cell phone of a user on this account. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbCommsTestSmsRequest.new(
+  to_phone: null
+)
+```
+