bombbomb 2.0.22196 → 2.0.24005

data/docs/FilesApi.md

@@ -0,0 +1,60 @@
+# BombBomb::FilesApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**doc_host_delete**](FilesApi.md#doc_host_delete) | **DELETE** /files | Deletes users file
+
+
+# **doc_host_delete**
+> doc_host_delete(doc_id)
+
+Deletes users file
+
+Deletes the file from the users s3 store
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::FilesApi.new
+
+doc_id = "doc_id_example" # String | Id of document
+
+
+begin
+  #Deletes users file
+  api_instance.doc_host_delete(doc_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FilesApi->doc_host_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **doc_id** | **String**| Id of document | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/JerichoPerformance.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**jericho_id** | **Integer** | The jericho id | [optional] 
 **sent** | **Integer** | The number of emails sent | [optional] 
 **unique_views** | **Integer** | The unique number of people that viewed the email | [optional] 
 **unique_landing_page_views** | **Integer** | The unique number of people that visited the landing page | [optional] 
@@ -14,5 +15,8 @@ Name | Type | Description | Notes
 **video_play** | **Integer** | The total number of times videos in the emails were played | [optional] 
 **abuse_complaints** | **Integer** | The number of recipients that marked the message as abusive | [optional] 
 **contacts** | **Integer** | The total number of contacts submitted to be sent, may be more than was sent to | [optional] 
+**prompts_sent** | **Integer** | The total number of prompts sent to members of the client group | [optional] 
+**prompts_with_recordings** | **Integer** | The total number of prompts sent that included a personal recording | [optional] 
+**prompts_opted_out** | **Integer** | The total number of members that chose not to send a prompt | [optional] 
 
 

data/docs/ListsApi.md

@@ -0,0 +1,167 @@
+# BombBomb::ListsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**clear_list**](ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
+[**copy_list_contacts**](ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
+[**suppress_all_in_list**](ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
+
+
+# **clear_list**
+> clear_list(list_id)
+
+Clear Contacts from List
+
+Clears all contacts from a list.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::ListsApi.new
+
+list_id = "list_id_example" # String | The list to be cleared.
+
+
+begin
+  #Clear Contacts from List
+  api_instance.clear_list(list_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ListsApi->clear_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **String**| The list to be cleared. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **copy_list_contacts**
+> copy_list_contacts(from_list_id, list_id)
+
+Copy All Contacts from a List
+
+Copy all contacts from a list.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::ListsApi.new
+
+from_list_id = "from_list_id_example" # String | The list to be cleared.
+
+list_id = "list_id_example" # String | The list to be cleared.
+
+
+begin
+  #Copy All Contacts from a List
+  api_instance.copy_list_contacts(from_list_id, list_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ListsApi->copy_list_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from_list_id** | **String**| The list to be cleared. | 
+ **list_id** | **String**| The list to be cleared. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **suppress_all_in_list**
+> suppress_all_in_list(list_id)
+
+Suppress All Contacts from List
+
+Suppresses all contacts in a list.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::ListsApi.new
+
+list_id = "list_id_example" # String | The list to be cleared.
+
+
+begin
+  #Suppress All Contacts from List
+  api_instance.suppress_all_in_list(list_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ListsApi->suppress_all_in_list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **String**| The list to be cleared. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/OrdersApi.md

@@ -0,0 +1,60 @@
+# BombBomb::OrdersApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**template_asset_delete**](OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
+
+
+# **template_asset_delete**
+> template_asset_delete(file_name)
+
+Deletes image from user s3 store
+
+Deletes image from user s3 store
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::OrdersApi.new
+
+file_name = "file_name_example" # String | Filename for deletion
+
+
+begin
+  #Deletes image from user s3 store
+  api_instance.template_asset_delete(file_name)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling OrdersApi->template_asset_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_name** | **String**| Filename for deletion | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/PromptBot.md

@@ -0,0 +1,22 @@
+# BombBomb::PromptBot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identifier of the prompt bot. Read Only. | [optional] 
+**user_id** | **String** | The prompt bot's owner. Read Only. | [optional] 
+**email_id** | **String** | The default email being sent to contacts in the prompt bot list. | [optional] 
+**list_id** | **String** | The list to attach the Prompt Bot to. | [optional] 
+**name** | **String** | The name of the bot. | [optional] 
+**contact_field_value_column** | **String** | The custom contact field value column used for this bot. | [optional] 
+**status** | **Integer** | The status of the prompt bot. Read Only. | [optional] 
+**start_date** | **DateTime** | when the bot started | [optional] 
+**end_date** | **DateTime** | when the bot should finish | [optional] 
+**bot_type_id** | **String** | The type of bot. | [optional] 
+**template_id** | **String** | The template id used to generate the default email. | [optional] 
+**video_id** | **String** | The video that was added to the prompt. | [optional] 
+**content** | **String** | The content to use in the email. | [optional] 
+**subject** | **String** | The subject of the default email. | [optional] 
+**generated_by** | **String** | Set when generated as a default by a bot. | [optional] 
+
+

data/docs/PromptsApi.md

@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 
 # **create_prompt_bot**
-> PromptBotBot create_prompt_bot(list_id, email_id, end_date, prompt_subject, prompt_body, bot_type_id, template_id)
+> PromptBot create_prompt_bot(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
 
 Create a running Prompt Bot for a list
 
@@ -39,20 +39,26 @@ list_id = "list_id_example" # String | The list id to attach the bot to.
 
 email_id = "email_id_example" # String | The default email to use.
 
-end_date = "end_date_example" # String | The time frame to complete sending to the list.
+name = "name_example" # String | The name of the bot.
 
-prompt_subject = "prompt_subject_example" # String | The prompt subject.
+subject = "subject_example" # String | The subject of the default email.
 
-prompt_body = "prompt_body_example" # String | The prompt script.
+content = "content_example" # String | The content used in the email.
+
+contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.
 
 bot_type_id = "bot_type_id_example" # String | The type of bot to create.
 
 template_id = "template_id_example" # String | The template used to create the email id.
 
+opts = { 
+  video_id: "video_id_example", # String | The video used in the email.
+  end_date: "end_date_example" # String | The time frame to complete sending to the list.
+}
 
 begin
   #Create a running Prompt Bot for a list
-  result = api_instance.create_prompt_bot(list_id, email_id, end_date, prompt_subject, prompt_body, bot_type_id, template_id)
+  result = api_instance.create_prompt_bot(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
   p result
 rescue BombBomb::ApiError => e
   puts "Exception when calling PromptsApi->create_prompt_bot: #{e}"
@@ -65,15 +71,18 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **list_id** | **String**| The list id to attach the bot to. | 
  **email_id** | **String**| The default email to use. | 
- **end_date** | **String**| The time frame to complete sending to the list. | 
- **prompt_subject** | **String**| The prompt subject. | 
- **prompt_body** | **String**| The prompt script. | 
+ **name** | **String**| The name of the bot. | 
+ **subject** | **String**| The subject of the default email. | 
+ **content** | **String**| The content used in the email. | 
+ **contact_field_value_column** | **String**| The custom field value column with dates for this bot. | 
  **bot_type_id** | **String**| The type of bot to create. | 
  **template_id** | **String**| The template used to create the email id. | 
+ **video_id** | **String**| The video used in the email. | [optional] 
+ **end_date** | **String**| The time frame to complete sending to the list. | [optional] 
 
 ### Return type
 
-[**PromptBotBot**](PromptBotBot.md)
+[**PromptBot**](PromptBot.md)
 
 ### Authorization
 
@@ -185,7 +194,7 @@ This endpoint does not need any parameter.
 
 
 # **get_prompt_bots**
-> Array<PromptBotBot> get_prompt_bots
+> Array<PromptBot> get_prompt_bots
 
 List Prompt Bots
 
@@ -217,7 +226,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**Array<PromptBotBot>**](PromptBotBot.md)
+[**Array<PromptBot>**](PromptBot.md)
 
 ### Authorization
 
@@ -389,11 +398,12 @@ api_instance = BombBomb::PromptsApi.new
 
 id = "id_example" # String | The id of the prompt.
 
-choice = "choice_example" # String | The users' selection. Can be: WithVideo, WithEmail, Cancel
+choice = "choice_example" # String | The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual
 
 opts = { 
   video_id: "video_id_example", # String | The id of the video.
-  email_id: "email_id_example" # String | The id of the video.
+  email_id: "email_id_example", # String | The id of the email.
+  subject: "subject_example" # String | The subject of the email
 }
 
 begin
@@ -410,9 +420,10 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The id of the prompt. | 
- **choice** | **String**| The users' selection. Can be: WithVideo, WithEmail, Cancel | 
+ **choice** | **String**| The users' selection. Can be: WithVideo, WithEmail, Cancel, Restore, Reset, Manual | 
  **video_id** | **String**| The id of the video. | [optional] 
- **email_id** | **String**| The id of the video. | [optional] 
+ **email_id** | **String**| The id of the email. | [optional] 
+ **subject** | **String**| The subject of the email | [optional] 
 
 ### Return type
 
@@ -430,7 +441,7 @@ No authorization required
 
 
 # **update_prompt_bot**
-> PromptBotBot update_prompt_bot(id, opts)
+> PromptBot update_prompt_bot(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
 
 Update Prompt Bot
 
@@ -450,15 +461,29 @@ api_instance = BombBomb::PromptsApi.new
 
 id = "id_example" # String | The bot id.
 
+list_id = "list_id_example" # String | The list id to attach the bot to.
+
+email_id = "email_id_example" # String | The default email to use.
+
+name = "name_example" # String | The name of the bot.
+
+subject = "subject_example" # String | The subject of the default email.
+
+content = "content_example" # String | The content used in the default email.
+
+contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.
+
+template_id = "template_id_example" # String | The template used to create the email id.
+
 opts = { 
-  email_id: "email_id_example", # String | The default email to use.
+  video_id: "video_id_example", # String | The video used in the default email.
   end_date: "end_date_example", # String | The time frame to complete sending to the list.
   status: "status_example" # String | The status of the bot.
 }
 
 begin
   #Update Prompt Bot
-  result = api_instance.update_prompt_bot(id, opts)
+  result = api_instance.update_prompt_bot(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
   p result
 rescue BombBomb::ApiError => e
   puts "Exception when calling PromptsApi->update_prompt_bot: #{e}"
@@ -470,13 +495,20 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The bot id. | 
- **email_id** | **String**| The default email to use. | [optional] 
+ **list_id** | **String**| The list id to attach the bot to. | 
+ **email_id** | **String**| The default email to use. | 
+ **name** | **String**| The name of the bot. | 
+ **subject** | **String**| The subject of the default email. | 
+ **content** | **String**| The content used in the default email. | 
+ **contact_field_value_column** | **String**| The custom field value column with dates for this bot. | 
+ **template_id** | **String**| The template used to create the email id. | 
+ **video_id** | **String**| The video used in the default email. | [optional] 
  **end_date** | **String**| The time frame to complete sending to the list. | [optional] 
  **status** | **String**| The status of the bot. | [optional] 
 
 ### Return type
 
-[**PromptBotBot**](PromptBotBot.md)
+[**PromptBot**](PromptBot.md)
 
 ### Authorization
 
@@ -513,7 +545,8 @@ client_group_id = "client_group_id_example" # String | The client group of the c
 opts = { 
   branded_template_id: "branded_template_id_example", # String | The template to use for branded feel emails.
   personal_template_id: "personal_template_id_example", # String | The template to use for personal feel emails.
-  enabled: true # BOOLEAN | Set whether the user is able to start receiving prompts.
+  enabled: true, # BOOLEAN | Set whether the user is able to start receiving prompts.
+  auto_shares: "auto_shares_example" # String | These are what we are autosharing to
 }
 
 begin
@@ -532,6 +565,7 @@ Name | Type | Description  | Notes
  **branded_template_id** | **String**| The template to use for branded feel emails. | [optional] 
  **personal_template_id** | **String**| The template to use for personal feel emails. | [optional] 
  **enabled** | **BOOLEAN**| Set whether the user is able to start receiving prompts. | [optional] 
+ **auto_shares** | **String**| These are what we are autosharing to | [optional] 
 
 ### Return type