bombbomb 2.0.25797 → 2.0.25798

data/docs/JerichoConfiguration.md

@@ -18,5 +18,7 @@ Name | Type | Description | Notes
 **email_body** | **String** | Video Prompt: The HTML body of the final sent email. | [optional] 
 **send_without_video** | **BOOLEAN** | Video Prompt: Whether to send the final email if no video was recorded. | [optional] 
 **status** | **String** | The state of the send. | [optional] 
+**media_type** | **String** | The type of media used for a social send | [optional] 
+**custom_initial_email_subject_line** | **String** | The custom subject line for the prompt initial email | [optional] 
 
 

data/docs/PromptMonthlyPerformance.md

@@ -0,0 +1,11 @@
+# BombBomb::PromptMonthlyPerformance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **String** | The startDate property | [optional] 
+**end_date** | **String** | The endDate property | [optional] 
+**user_batch_lists_id_helper** | **String** | The userBatchListsIdHelper property | [optional] 
+**prompt_id_helper** | **String** | The promptIdHelper property | [optional] 
+
+

data/docs/PromptOverview.md

@@ -0,0 +1,11 @@
+# BombBomb::PromptOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **String** | The startDate property | [optional] 
+**end_date** | **String** | The endDate property | [optional] 
+**user_batch_lists_id_helper** | **String** | The userBatchListsIdHelper property | [optional] 
+**prompt_id_helper** | **String** | The promptIdHelper property | [optional] 
+
+

data/docs/PromptSocialPrompt.md

@@ -0,0 +1,20 @@
+# BombBomb::PromptSocialPrompt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The identifier of the prompt. Read Only. | [optional] 
+**user_id** | **String** | The prompt's owner. Read Only. | [optional] 
+**jericho_id** | **String** | If sent in a jericho context, this will have the jericho id | [optional] 
+**prompt_subject** | **String** | The prompt's subject line | [optional] 
+**prompt_html** | **String** | The suggested script of the prompt. | [optional] 
+**scheduled_send_date** | **DateTime** | When the final email is scheduled to be sent | [optional] 
+**client_group_id** | **String** | The client group campaign that created the prompt. | [optional] 
+**thumbnail_url** | **String** | The URL of a thumbnail image for this prompt | [optional] 
+**status** | **Integer** | The status of the prompt: created = 0, sent = 10, recorded = 20, job_created = 30, timed_out = 40, declined = 50 Read Only | [optional] 
+**created_date** | **DateTime** | When the email was first sent out | [optional] 
+**last_notified** | **DateTime** | When the user was last notified about a prompt email waiting for a video | [optional] 
+**send_mechanism** | **DateTime** | The sendMechanism property | [optional] 
+**send_types** | **Array<String>** | The types of mechanisms this prompt can send. | [optional] 
+
+

data/docs/PromptsApi.md

@@ -6,15 +6,19 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_prompt_bot**](PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
 [**create_video_email_prompt**](PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
+[**get_alternate_campaign_content**](PromptsApi.md#get_alternate_campaign_content) | **GET** /campaign/{campaignId}/content/alternate | List alternate campaign content
 [**get_pending_video_email_prompts**](PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
 [**get_prompt_bots**](PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
-[**get_prompt_campaigns**](PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/campaigns | List Prompt Campaigns
+[**get_prompt_campaigns**](PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/{userId}/campaigns | List Prompt Campaigns
 [**get_video_email_prompt**](PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
 [**get_video_email_prompts**](PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
 [**respond_to_video_email_prompt**](PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
+[**send_prompt_immediately**](PromptsApi.md#send_prompt_immediately) | **POST** /prompt/{id}/sendit | 
+[**sync_prompt_subscriptions**](PromptsApi.md#sync_prompt_subscriptions) | **POST** /prompts/campaigns/sync | Syncs Campaigns and One to Ones Subscriptions for User
 [**update_prompt**](PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
 [**update_prompt_bot**](PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
-[**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
+[**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{clientGroupId} | Update Prompt Campaign
+[**update_prompt_template**](PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
 
 
 # **create_prompt_bot**
@@ -147,6 +151,57 @@ Name | Type | Description  | Notes
 
 
 
+# **get_alternate_campaign_content**
+> get_alternate_campaign_content(client_group_id)
+
+List alternate campaign content
+
+Returns a list of alternate campaign content by campaign id
+
+### 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::PromptsApi.new
+
+client_group_id = "client_group_id_example" # String | Id for the campaign
+
+
+begin
+  #List alternate campaign content
+  api_instance.get_alternate_campaign_content(client_group_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->get_alternate_campaign_content: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_group_id** | **String**| Id for the campaign | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
 # **get_pending_video_email_prompts**
 > Array<VideoEmailPrompt> get_pending_video_email_prompts
 
@@ -440,6 +495,109 @@ No authorization required
 
 
 
+# **send_prompt_immediately**
+> send_prompt_immediately(id)
+
+
+
+Ignore send date and send the prompt now.
+
+### 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::PromptsApi.new
+
+id = "id_example" # String | The Id of the prompt
+
+
+begin
+  #
+  api_instance.send_prompt_immediately(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->send_prompt_immediately: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Id of the prompt | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **sync_prompt_subscriptions**
+> sync_prompt_subscriptions(opts)
+
+Syncs Campaigns and One to Ones Subscriptions for User
+
+Syncs Campaigns and One to Ones Subscriptions for User based on their profile information. The user must be a Prompt Subscriber.
+
+### 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::PromptsApi.new
+
+opts = { 
+  migrate: true # BOOLEAN | After syncing, migrate away from old campaigns.
+}
+
+begin
+  #Syncs Campaigns and One to Ones Subscriptions for User
+  api_instance.sync_prompt_subscriptions(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->sync_prompt_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **migrate** | **BOOLEAN**| After syncing, migrate away from old campaigns. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
 # **update_prompt**
 > update_prompt(id, opts)
 
@@ -467,7 +625,10 @@ opts = {
   twitter_message: "twitter_message_example", # String | The twitter message assigned to the prompt
   video_id: "video_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
+  subject: "subject_example", # String | The subject of the email
+  reset_cache: "reset_cache_example", # String | The subject of the email
+  reset_email_content: "reset_email_content_example", # String | The subject of the email
+  status: "status_example" # String | The status of the prompt
 }
 
 begin
@@ -489,6 +650,9 @@ Name | Type | Description  | Notes
  **video_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] 
+ **reset_cache** | **String**| The subject of the email | [optional] 
+ **reset_email_content** | **String**| The subject of the email | [optional] 
+ **status** | **String**| The status of the prompt | [optional] 
 
 ### Return type
 
@@ -646,3 +810,66 @@ nil (empty response body)
 
 
 
+# **update_prompt_template**
+> update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)
+
+Update Prompt Content
+
+Updates a Prompt Content
+
+### 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::PromptsApi.new
+
+id = "id_example" # String | The prompt's id
+
+alternate_content_id = "alternate_content_id_example" # String | The alternate content id
+
+new_email_id = "new_email_id_example" # String | The prompt's new email id
+
+og_email_id = "og_email_id_example" # String | The prompt's original email id
+
+new_example_video_id = "new_example_video_id_example" # String | The prompt's new tutorial video id
+
+
+begin
+  #Update Prompt Content
+  api_instance.update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->update_prompt_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The prompt's id | 
+ **alternate_content_id** | **String**| The alternate content id | 
+ **new_email_id** | **String**| The prompt's new email id | 
+ **og_email_id** | **String**| The prompt's original email id | 
+ **new_example_video_id** | **String**| The prompt's new tutorial video id | 
+
+### 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/SocialsApi.md

@@ -10,7 +10,10 @@ Method | HTTP request | Description
 [**get_social_profile_properties**](SocialsApi.md#get_social_profile_properties) | **GET** /socials/profile | Gets the profile properties
 [**get_social_stats**](SocialsApi.md#get_social_stats) | **GET** /socials/{promptId}/stats | Get social stats for a prompt
 [**post_social_content**](SocialsApi.md#post_social_content) | **POST** /socials/content | Creates social content
+[**retry_social_send**](SocialsApi.md#retry_social_send) | **POST** /socials/send/retry | Sends social content
+[**send_social**](SocialsApi.md#send_social) | **POST** /socials/send | Sends social content
 [**update_client_group_send_mechanism**](SocialsApi.md#update_client_group_send_mechanism) | **PUT** /socials/client/sendMechanism | Gets the auto shares from the client group assoc id
+[**update_client_groups_send_mechanism**](SocialsApi.md#update_client_groups_send_mechanism) | **PUT** /socials/client/sendMechanisms | Toggles the prompt campaigns in a users account
 [**update_facebook_pages**](SocialsApi.md#update_facebook_pages) | **PUT** /socials/facebook/pages | Updates facebook page Ids
 [**update_social_content**](SocialsApi.md#update_social_content) | **PUT** /socials/content | Updates social content
 
@@ -61,7 +64,7 @@ nil (empty response body)
 
 
 # **get_social_article_properties**
-> get_social_article_properties(email_id)
+> get_social_article_properties(email_id, social_content_id)
 
 Gets the social email properties
 
@@ -81,10 +84,12 @@ api_instance = BombBomb::SocialsApi.new
 
 email_id = "email_id_example" # String | This is the email Id for the email url
 
+social_content_id = "social_content_id_example" # String | This is the social content Id
+
 
 begin
   #Gets the social email properties
-  api_instance.get_social_article_properties(email_id)
+  api_instance.get_social_article_properties(email_id, social_content_id)
 rescue BombBomb::ApiError => e
   puts "Exception when calling SocialsApi->get_social_article_properties: #{e}"
 end
@@ -95,6 +100,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **email_id** | **String**| This is the email Id for the email url | 
+ **social_content_id** | **String**| This is the social content Id | 
 
 ### Return type
 
@@ -316,6 +322,111 @@ nil (empty response body)
 
 
 
+# **retry_social_send**
+> retry_social_send(prompt_id)
+
+Sends social content
+
+Sends social content that failed for a user via their associated prompt
+
+### 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::SocialsApi.new
+
+prompt_id = "prompt_id_example" # String | The prompt id
+
+
+begin
+  #Sends social content
+  api_instance.retry_social_send(prompt_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling SocialsApi->retry_social_send: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| The prompt id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **send_social**
+> send_social(prompt_id, social_type)
+
+Sends social content
+
+Sends social content for a user via their associated prompt
+
+### 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::SocialsApi.new
+
+prompt_id = "prompt_id_example" # String | The prompt id
+
+social_type = "social_type_example" # String | The destination for social content
+
+
+begin
+  #Sends social content
+  api_instance.send_social(prompt_id, social_type)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling SocialsApi->send_social: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt_id** | **String**| The prompt id | 
+ **social_type** | **String**| The destination for social content | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
 # **update_client_group_send_mechanism**
 > update_client_group_send_mechanism(send_mechanism, client_group_id, opts)
 
@@ -374,6 +485,60 @@ nil (empty response body)
 
 
 
+# **update_client_groups_send_mechanism**
+> update_client_groups_send_mechanism(send_mechanism, enabled)
+
+Toggles the prompt campaigns in a users account
+
+Toggles the prompt campaigns in a users account for a social integrations on or off
+
+### 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::SocialsApi.new
+
+send_mechanism = "send_mechanism_example" # String | The send mechanism for the prompt
+
+enabled = "enabled_example" # String | Is the send mechanism enabled?
+
+
+begin
+  #Toggles the prompt campaigns in a users account
+  api_instance.update_client_groups_send_mechanism(send_mechanism, enabled)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling SocialsApi->update_client_groups_send_mechanism: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_mechanism** | **String**| The send mechanism for the prompt | 
+ **enabled** | **String**| Is the send mechanism enabled? | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
 # **update_facebook_pages**
 > update_facebook_pages(page_ids)