EmailFlow.md in ultracart_api-4.0.32.rc

- old
+ new
@@ -1,38 +1,72 @@
-# UltracartClient::EmailFlow
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**allow_multiple_concurrent_enrollments** | **BOOLEAN** | True if a customer may be enrolled in this flow multiple times | [optional] 
-**back_populating** | **BOOLEAN** | True if the flow is currently performing a back population. | [optional] 
-**click_rate_formatted** | **String** | Click rate of emails, formatted | [optional] 
-**created_dts** | **String** | Created date | [optional] 
-**deleted** | **BOOLEAN** | True if this campaign was deleted | [optional] 
-**email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional] 
-**email_flow_uuid** | **String** | Email flow UUID | [optional] 
-**end_once_customer_purchases** | **BOOLEAN** | True if the customer should end the flow once they purchase from an email on this flow | [optional] 
-**end_once_customer_purchases_anywhere** | **BOOLEAN** | True if the customer should end the flow once they purchase from any source | [optional] 
-**enrolled_customers** | **Integer** | Number of enrolled customers. | [optional] 
-**esp_domain_user** | **String** | Username of sending email | [optional] 
-**esp_domain_uuid** | **String** | UUID of sending domain | [optional] 
-**esp_flow_folder_uuid** | **String** | Flow folder UUID.  Null for uncategorized | [optional] 
-**esp_friendly_name** | **String** | Friendly name of the sending email | [optional] 
-**filter_profile_equation_json** | **String** | File profile equation json | [optional] 
-**library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before.  This value is used to determine if a library item should be inserted or updated. | [optional] 
-**maximum_enrolled** | **BOOLEAN** | The number of maximum customers for the plan are currently enrolled in this flow. | [optional] 
-**merchant_id** | **String** | Merchant ID | [optional] 
-**name** | **String** | Name of email flow | [optional] 
-**open_rate_formatted** | **String** | Open rate of emails, formatted | [optional] 
-**revenue_formatted** | **String** | Revenue, formatted | [optional] 
-**revenue_per_customer_formatted** | **String** | Revenue per customer, formatted | [optional] 
-**screenshot_large_full_url** | **String** | URL to a large full length screenshot | [optional] 
-**sms_esp_twilio_uuid** | **String** | Twilio Account UUID.  Null for none | [optional] 
-**sms_phone_number** | **String** | Twilio SMS Phone Number.  Null for none | [optional] 
-**status** | **String** | Status of the campaign of draft, archived, active, and inactive | [optional] 
-**status_dts** | **String** | Timestamp when the last status change happened | [optional] 
-**storefront_oid** | **Integer** | Storefront oid | [optional] 
-**trigger_parameter** | **String** | Trigger parameter | [optional] 
-**trigger_parameter_name** | **String** | Trigger parameter name | [optional] 
-**trigger_type** | **String** | Trigger type | [optional] 
-
-
+# UltracartClient::EmailFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allow_multiple_concurrent_enrollments** | **Boolean** | True if a customer may be enrolled in this flow multiple times | [optional] |
+| **back_populating** | **Boolean** | True if the flow is currently performing a back population. | [optional] |
+| **click_rate_formatted** | **String** | Click rate of emails, formatted | [optional] |
+| **created_dts** | **String** | Created date | [optional] |
+| **deleted** | **Boolean** | True if this campaign was deleted | [optional] |
+| **email_communication_sequence_uuid** | **String** | Email communication sequence UUID | [optional] |
+| **email_flow_uuid** | **String** | Email flow UUID | [optional] |
+| **end_once_customer_purchases** | **Boolean** | True if the customer should end the flow once they purchase from an email on this flow | [optional] |
+| **end_once_customer_purchases_anywhere** | **Boolean** | True if the customer should end the flow once they purchase from any source | [optional] |
+| **enrolled_customers** | **Integer** | Number of enrolled customers. | [optional] |
+| **esp_domain_user** | **String** | Username of sending email | [optional] |
+| **esp_domain_uuid** | **String** | UUID of sending domain | [optional] |
+| **esp_flow_folder_uuid** | **String** | Flow folder UUID.  Null for uncategorized | [optional] |
+| **esp_friendly_name** | **String** | Friendly name of the sending email | [optional] |
+| **filter_profile_equation_json** | **String** | File profile equation json | [optional] |
+| **library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before.  This value is used to determine if a library item should be inserted or updated. | [optional] |
+| **merchant_id** | **String** | Merchant ID | [optional] |
+| **name** | **String** | Name of email flow | [optional] |
+| **open_rate_formatted** | **String** | Open rate of emails, formatted | [optional] |
+| **revenue_formatted** | **String** | Revenue, formatted | [optional] |
+| **revenue_per_customer_formatted** | **String** | Revenue per customer, formatted | [optional] |
+| **screenshot_large_full_url** | **String** | URL to a large full length screenshot | [optional] |
+| **status** | **String** | Status of the campaign of draft, archived, active, and inactive | [optional] |
+| **status_dts** | **String** | Timestamp when the last status change happened | [optional] |
+| **storefront_oid** | **Integer** | Storefront oid | [optional] |
+| **trigger_parameter** | **String** | Trigger parameter | [optional] |
+| **trigger_parameter_name** | **String** | Trigger parameter name | [optional] |
+| **trigger_type** | **String** | Trigger type | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailFlow.new(
+  allow_multiple_concurrent_enrollments: null,
+  back_populating: null,
+  click_rate_formatted: null,
+  created_dts: null,
+  deleted: null,
+  email_communication_sequence_uuid: null,
+  email_flow_uuid: null,
+  end_once_customer_purchases: null,
+  end_once_customer_purchases_anywhere: null,
+  enrolled_customers: null,
+  esp_domain_user: null,
+  esp_domain_uuid: null,
+  esp_flow_folder_uuid: null,
+  esp_friendly_name: null,
+  filter_profile_equation_json: null,
+  library_item_oid: null,
+  merchant_id: null,
+  name: null,
+  open_rate_formatted: null,
+  revenue_formatted: null,
+  revenue_per_customer_formatted: null,
+  screenshot_large_full_url: null,
+  status: null,
+  status_dts: null,
+  storefront_oid: null,
+  trigger_parameter: null,
+  trigger_parameter_name: null,
+  trigger_type: null
+)
+```
+