bombbomb 2.0.25797 → 2.0.25798

data/docs/AutomationsApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_drip_drop_stats**](AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
 [**get_drip_stats**](AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
+[**get_scheduling_status**](AutomationsApi.md#get_scheduling_status) | **GET** /automation/{id}/scheduling/status | Get the number of pending scheduling calculations
 
 
 # **get_drip_drop_stats**
@@ -113,3 +114,54 @@ nil (empty response body)
 
 
 
+# **get_scheduling_status**
+> get_scheduling_status(id)
+
+Get the number of pending scheduling calculations
+
+Get the number of pending scheduling calculations
+
+### 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::AutomationsApi.new
+
+id = "id_example" # String | The id of the automation
+
+
+begin
+  #Get the number of pending scheduling calculations
+  api_instance.get_scheduling_status(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AutomationsApi->get_scheduling_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the automation | 
+
+### 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/ClientGroupAssetMetaData.md

@@ -0,0 +1,11 @@
+# BombBomb::ClientGroupAssetMetaData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**thumb_url** | **String** |  | [optional] 
+
+

data/docs/ContactsApi.md

@@ -285,11 +285,11 @@ nil (empty response body)
 
 
 # **delete_contacts**
-> delete_contacts(list_id)
+> delete_contacts(opts)
 
 Delete Contacts
 
-Delete contacts
+Delete all contacts within a list, or provide a comma separated list of contactIds to delete.
 
 ### Example
 ```ruby
@@ -303,12 +303,14 @@ end
 
 api_instance = BombBomb::ContactsApi.new
 
-list_id = "list_id_example" # String | The list of contacts to be deleted.
-
+opts = { 
+  list_id: "list_id_example", # String | The list of contacts to be deleted.
+  contact_ids: "contact_ids_example" # String | comma separated list of contact ids to delete
+}
 
 begin
   #Delete Contacts
-  api_instance.delete_contacts(list_id)
+  api_instance.delete_contacts(opts)
 rescue BombBomb::ApiError => e
   puts "Exception when calling ContactsApi->delete_contacts: #{e}"
 end
@@ -318,7 +320,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| The list of contacts to be deleted. | 
+ **list_id** | **String**| The list of contacts to be deleted. | [optional] 
+ **contact_ids** | **String**| comma separated list of contact ids to delete | [optional] 
 
 ### Return type
 

data/docs/EmailsApi.md

@@ -9,7 +9,11 @@ Method | HTTP request | Description
 [**get_email_tracking**](EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
 [**get_email_tracking_interactions**](EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
 [**get_hourly_email_tracking**](EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
+[**get_live_fire_data**](EmailsApi.md#get_live_fire_data) | **GET** /emails/livefire | Get livefire feed data
 [**get_quick_send_templates**](EmailsApi.md#get_quick_send_templates) | **GET** /emails/quicksend/templates | Get all quicksend templates
+[**get_template_html_for_template_id**](EmailsApi.md#get_template_html_for_template_id) | **GET** /emails/templates/{templateId}/html | Get the HTML for a given template
+[**get_video_quick_sender_data**](EmailsApi.md#get_video_quick_sender_data) | **GET** /emails/quicksend | Get quicksend data
+[**save_quick_sender_settings**](EmailsApi.md#save_quick_sender_settings) | **POST** /emails/quicksend/settings | Save quicksender settings
 [**video_quick_sender**](EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
 
 
@@ -298,6 +302,51 @@ nil (empty response body)
 
 
 
+# **get_live_fire_data**
+> get_live_fire_data
+
+Get livefire feed data
+
+Get the user data for the live fire feed emails
+
+### 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::EmailsApi.new
+
+begin
+  #Get livefire feed data
+  api_instance.get_live_fire_data
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_live_fire_data: #{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_quick_send_templates**
 > get_quick_send_templates
 
@@ -343,6 +392,177 @@ nil (empty response body)
 
 
 
+# **get_template_html_for_template_id**
+> get_template_html_for_template_id(template_id, opts)
+
+Get the HTML for a given template
+
+Get the HTML for a given template, with or without rendered variables
+
+### 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::EmailsApi.new
+
+template_id = "template_id_example" # String | The id of the template.
+
+opts = { 
+  render_variables: "render_variables_example" # String | Whether to render profile variables in the returned HTML.
+}
+
+begin
+  #Get the HTML for a given template
+  api_instance.get_template_html_for_template_id(template_id, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_template_html_for_template_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**| The id of the template. | 
+ **render_variables** | **String**| Whether to render profile variables in the returned HTML. | [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_video_quick_sender_data**
+> get_video_quick_sender_data(opts)
+
+Get quicksend data
+
+Get the user data for quicksender, including templates and lists.
+
+### 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::EmailsApi.new
+
+opts = { 
+  message: "message_example", # String | A message for the video content.
+  subject: "subject_example", # String | A subject for the video content.
+  video_id: "video_id_example", # String | A video ID.
+  template_id: "template_id_example", # String | A template ID.
+  comma_delim_emails: "comma_delim_emails_example" # String | Comma delimited emails
+}
+
+begin
+  #Get quicksend data
+  api_instance.get_video_quick_sender_data(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_video_quick_sender_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message** | **String**| A message for the video content. | [optional] 
+ **subject** | **String**| A subject for the video content. | [optional] 
+ **video_id** | **String**| A video ID. | [optional] 
+ **template_id** | **String**| A template ID. | [optional] 
+ **comma_delim_emails** | **String**| Comma delimited emails | [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
+
+
+
+# **save_quick_sender_settings**
+> save_quick_sender_settings(opts)
+
+Save quicksender settings
+
+Save the quicksender notification and default template settings
+
+### 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::EmailsApi.new
+
+opts = { 
+  alert_on_play: "alert_on_play_example", # String | A preference setting for whether or not to notify user on quicksend email video plays.
+  alert_on_open: "alert_on_open_example", # String | A preference setting for whether or not to notify user on quicksend email opens.
+  template_id: "template_id_example" # String | Id of a template to use for this send. A null value means use the default for this user.
+}
+
+begin
+  #Save quicksender settings
+  api_instance.save_quick_sender_settings(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->save_quick_sender_settings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alert_on_play** | **String**| A preference setting for whether or not to notify user on quicksend email video plays. | [optional] 
+ **alert_on_open** | **String**| A preference setting for whether or not to notify user on quicksend email opens. | [optional] 
+ **template_id** | **String**| Id of a template to use for this send. A null value means use the default for this user. | [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
+
+
+
 # **video_quick_sender**
 > video_quick_sender(opts)
 

data/docs/FormsApi.md

@@ -0,0 +1,60 @@
+# BombBomb::FormsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_form_tracking_as_csv**](FormsApi.md#get_form_tracking_as_csv) | **GET** /forms/{id}/tracking/export | Get csv
+
+
+# **get_form_tracking_as_csv**
+> get_form_tracking_as_csv(id)
+
+Get csv
+
+Get form tracking as csv
+
+### 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::FormsApi.new
+
+id = "id_example" # String | Id of the form
+
+
+begin
+  #Get csv
+  api_instance.get_form_tracking_as_csv(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FormsApi->get_form_tracking_as_csv: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Id of the form | 
+
+### 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/InlineResponse200.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **total_pages** | **Integer** |  | [optional] 
-**items** | [**Array<InlineResponse200Items>**](InlineResponse200Items.md) |  | [optional] 
+**items** | [**Array<ClientGroupAssetMetaData>**](ClientGroupAssetMetaData.md) |  | [optional] 
 
 

data/docs/IntegrationsApi.md

@@ -4,9 +4,232 @@ All URIs are relative to *https://api.bombbomb.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**connect_integration**](IntegrationsApi.md#connect_integration) | **POST** /integrations | Activate an integration for a user.
+[**delete_integration**](IntegrationsApi.md#delete_integration) | **DELETE** /integrations | Remove an integration for a user.
+[**get_integration_health**](IntegrationsApi.md#get_integration_health) | **GET** /integrations/health/{code} | Get health for a given integration
+[**get_integration_page_components**](IntegrationsApi.md#get_integration_page_components) | **GET** /integrations/pageComponents | Get page components for a given integration
 [**sync_users_integrated_lists**](IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
 
 
+# **connect_integration**
+> connect_integration(code, opts)
+
+Activate an integration for a user.
+
+Provide the correct parameters to enable an integration. Required Parameters vary based on the desired          integration. Integrations requiring OAuth will provide the OAuth link that the user must be presented.
+
+### 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::IntegrationsApi.new
+
+code = "code_example" # String | The identifier of the integration.
+
+opts = { 
+  key: "key_example", # String | The key value.
+  secret: "secret_example", # String | The secret value.
+  token: "token_example", # String | The token value.
+  data: "data_example", # String | The data value as JSON.
+  overwrite: "overwrite_example" # String | Boolean value to know whether or not to delete the integration if it already exists
+}
+
+begin
+  #Activate an integration for a user.
+  api_instance.connect_integration(code, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling IntegrationsApi->connect_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The identifier of the integration. | 
+ **key** | **String**| The key value. | [optional] 
+ **secret** | **String**| The secret value. | [optional] 
+ **token** | **String**| The token value. | [optional] 
+ **data** | **String**| The data value as JSON. | [optional] 
+ **overwrite** | **String**| Boolean value to know whether or not to delete the integration if it already exists | [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
+
+
+
+# **delete_integration**
+> delete_integration(opts)
+
+Remove an integration for a user.
+
+Remove an integration by providing the integration id or integration code. Only provide one of the             parameters.
+
+### 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::IntegrationsApi.new
+
+opts = { 
+  id: "id_example", # String | Integration ID
+  code: "code_example" # String | Integration Code
+}
+
+begin
+  #Remove an integration for a user.
+  api_instance.delete_integration(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling IntegrationsApi->delete_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Integration ID | [optional] 
+ **code** | **String**| Integration Code | [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_integration_health**
+> get_integration_health(code)
+
+Get health for a given integration
+
+Get health for an integration.
+
+### 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::IntegrationsApi.new
+
+code = "code_example" # String | The integration code for which to retrieve the information from
+
+
+begin
+  #Get health for a given integration
+  api_instance.get_integration_health(code)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling IntegrationsApi->get_integration_health: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The integration code for which to retrieve the information from | 
+
+### 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_integration_page_components**
+> get_integration_page_components(integration_name)
+
+Get page components for a given integration
+
+Get all page components for an integration.
+
+### 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::IntegrationsApi.new
+
+integration_name = "integration_name_example" # String | The integration for which to retrieve HTML page components.
+
+
+begin
+  #Get page components for a given integration
+  api_instance.get_integration_page_components(integration_name)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling IntegrationsApi->get_integration_page_components: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_name** | **String**| The integration for which to retrieve HTML page components. | 
+
+### 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_users_integrated_lists**
 > String sync_users_integrated_lists(opts)