bombbomb 2.0.831 → 2.0.20679

data/docs/ListsApi.md

@@ -1,265 +0,0 @@
-# BombBomb::ListsApi
-
-All URIs are relative to *https://api.bombbomb.com/v2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**add_new_list**](ListsApi.md#add_new_list) | **POST** /lists/ | Add list.
-[**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
-[**get_all_lists**](ListsApi.md#get_all_lists) | **GET** /lists/ | Get all Lists
-[**suppress_all_in_list**](ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
-
-
-# **add_new_list**
-> add_new_list(list_name)
-
-Add list.
-
-Add a list to the users account.
-
-### 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_name = "list_name_example" # String | Name of the new list being added
-
-
-begin
-  #Add list.
-  api_instance.add_new_list(list_name)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling ListsApi->add_new_list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **list_name** | **String**| Name of the new list being added | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[BBOAuth2](../README.md#BBOAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/x-www-form-urlencoded
- - **Accept**: application/json
-
-
-
-# **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
-
-
-
-# **get_all_lists**
-> get_all_lists
-
-Get all Lists
-
-Get all the lists for a specific user.
-
-### 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
-
-begin
-  #Get all Lists
-  api_instance.get_all_lists
-rescue BombBomb::ApiError => e
-  puts "Exception when calling ListsApi->get_all_lists: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### 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

@@ -1,60 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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/PromptBotBot.md

@@ -1,18 +0,0 @@
-# BombBomb::PromptBotBot
-
-## 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] 
-**prompt_subject** | **String** | The prompt subject. | [optional] 
-**prompt_body** | **String** | The prompt body. | [optional] 
-**status** | **String** | 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] 
-
-

data/docs/PromptMonthlyPerformance.md

@@ -1,11 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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/SignUploadRequest.md

@@ -1,9 +0,0 @@
-# BombBomb::SignUploadRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**expiration** | **DateTime** | when the upload will expire. | [optional] 
-**conditions** | **Object** | Key/Value object of request conditions. | [optional] 
-
-

data/docs/SignUploadResponse.md

@@ -1,9 +0,0 @@
-# BombBomb::SignUploadResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**policy** | **String** | Base64 encoded policy. | [optional] 
-**signature** | **String** | Signature for policy. | [optional] 
-
-

data/docs/SocialsApi.md

@@ -1,653 +0,0 @@
-# BombBomb::SocialsApi
-
-All URIs are relative to *https://api.bombbomb.com/v2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_facebook_pages**](SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
-[**get_social_article_properties**](SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
-[**get_social_authorizations**](SocialsApi.md#get_social_authorizations) | **GET** /socials/authorizations | Get authorizations for all social integration
-[**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
-
-
-# **get_facebook_pages**
-> get_facebook_pages
-
-Gets facebook pages
-
-Gets facebook pages by client 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::SocialsApi.new
-
-begin
-  #Gets facebook pages
-  api_instance.get_facebook_pages
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->get_facebook_pages: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### 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_social_article_properties**
-> get_social_article_properties(email_id, social_content_id)
-
-Gets the social email properties
-
-Gets the social email properties
-
-### 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
-
-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, social_content_id)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->get_social_article_properties: #{e}"
-end
-```
-
-### Parameters
-
-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
-
-nil (empty response body)
-
-### Authorization
-
-[BBOAuth2](../README.md#BBOAuth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/x-www-form-urlencoded
- - **Accept**: application/json
-
-
-
-# **get_social_authorizations**
-> get_social_authorizations(opts)
-
-Get authorizations for all social integration
-
-Get authorizations and autoshares for all social integration and has redirect for user to login
-
-### 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
-
-opts = { 
-  client_group_id: "client_group_id_example" # String | ID of the client group association
-}
-
-begin
-  #Get authorizations for all social integration
-  api_instance.get_social_authorizations(opts)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->get_social_authorizations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **client_group_id** | **String**| ID of the client group association | [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
-
-
-
-# **get_social_profile_properties**
-> get_social_profile_properties(social_type)
-
-Gets the profile properties
-
-Gets the social profile properties
-
-### 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
-
-social_type = "social_type_example" # String | The social type
-
-
-begin
-  #Gets the profile properties
-  api_instance.get_social_profile_properties(social_type)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->get_social_profile_properties: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **social_type** | **String**| The social type | 
-
-### 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_social_stats**
-> get_social_stats(prompt_id)
-
-Get social stats for a prompt
-
-Get social stats for a prompt by 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::SocialsApi.new
-
-prompt_id = "prompt_id_example" # String | ID of the prompt
-
-
-begin
-  #Get social stats for a prompt
-  api_instance.get_social_stats(prompt_id)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->get_social_stats: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **prompt_id** | **String**| 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
-
-
-
-# **post_social_content**
-> post_social_content(email_id)
-
-Creates social content
-
-Creates social content for an email
-
-### 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
-
-email_id = "email_id_example" # String | The email's id
-
-
-begin
-  #Creates social content
-  api_instance.post_social_content(email_id)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->post_social_content: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **email_id** | **String**| The email's 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
-
-
-
-# **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)
-
-Gets the auto shares from the client group assoc id
-
-Gets the auto shares from the client group assoc 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::SocialsApi.new
-
-send_mechanism = "send_mechanism_example" # String | The send mechanism for the prompt
-
-client_group_id = "client_group_id_example" # String | ID of the client group association
-
-opts = { 
-  enabled: "enabled_example" # String | Is the send mechanism enabled?
-}
-
-begin
-  #Gets the auto shares from the client group assoc id
-  api_instance.update_client_group_send_mechanism(send_mechanism, client_group_id, opts)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->update_client_group_send_mechanism: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **send_mechanism** | **String**| The send mechanism for the prompt | 
- **client_group_id** | **String**| ID of the client group association | 
- **enabled** | **String**| Is the send mechanism enabled? | [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_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)
-
-Updates facebook page Ids
-
-Updates facebook page Ids to be sent to for prompts
-
-### 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
-
-page_ids = "page_ids_example" # String | Page Ids for the prompt
-
-
-begin
-  #Updates facebook page Ids
-  api_instance.update_facebook_pages(page_ids)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->update_facebook_pages: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **page_ids** | **String**| Page Ids for 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
-
-
-
-# **update_social_content**
-> update_social_content(social_id, opts)
-
-Updates social content
-
-Updates social content for an email
-
-### 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
-
-social_id = "social_id_example" # String | The social id
-
-opts = { 
-  title: "title_example", # String | The title for the article
-  description: "description_example", # String | The article description
-  picture_url: "picture_url_example", # String | The article picture url
-  suggested_message: "suggested_message_example" # String | The suggested message to use
-}
-
-begin
-  #Updates social content
-  api_instance.update_social_content(social_id, opts)
-rescue BombBomb::ApiError => e
-  puts "Exception when calling SocialsApi->update_social_content: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **social_id** | **String**| The social id | 
- **title** | **String**| The title for the article | [optional] 
- **description** | **String**| The article description | [optional] 
- **picture_url** | **String**| The article picture url | [optional] 
- **suggested_message** | **String**| The suggested message to use | [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
-
-
-