bombbomb 1.0.0

data/docs/JerichoConfiguration.md

@@ -0,0 +1,18 @@
+# BombBomb::JerichoConfiguration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**client_group_id** | **String** |  | [optional] 
+**send_date** | **DateTime** | When the email should be sent. | [optional] 
+**is_prompt** | **BOOLEAN** | Determines whether this is a static or prompted send. | 
+**email_id** | **String** | Static send: The Email to send on behalf of the group members. | [optional] 
+**prompt_subject** | **String** | Video Prompt: The subject line prompting the user to record a video. | [optional] 
+**prompt_body** | **String** | Video Prompt: The HTML body of the email prompting the user to record a video. | [optional] 
+**email_subject** | **String** | Video Prompt: The subject line of the final sent email | [optional] 
+**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] 
+
+

data/docs/JerichoPerformance.md

@@ -0,0 +1,18 @@
+# BombBomb::JerichoPerformance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**landing_page_views** | **Integer** | The total number of people that visisted the landing page | [optional] 
+**delivered** | **Integer** | The number of emails delivered, likely less than sent due to bounces, and other common delivery issues | [optional] 
+**bounce** | **Integer** | The number of emails that bounced as undeliverable | [optional] 
+**open** | **Integer** | The total number of times the emails were viewed | [optional] 
+**click** | **Integer** | The total number of times links in the emails were clicked | [optional] 
+**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] 
+
+

data/docs/OAuthClient.md

@@ -0,0 +1,13 @@
+# BombBomb::OAuthClient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**identifier** | **String** | The id of the OAuth Client | [optional] 
+**name** | **String** | The user-facing name of the client. Eg. MyCrm | [optional] 
+**client_secret** | **String** | The secret supplied to the OAuth Application | [optional] 
+**grants_allowed** | **String** | The grants allowed | [optional] 
+**owning_user_id** | **String** | The user who controls the OAuth App | [optional] 
+**redirect_uri** | **String** | Where OAuth authorization sessions are returned to | [optional] 
+
+

data/docs/PromptsApi.md

@@ -0,0 +1,169 @@
+# BombBomb::PromptsApi
+
+All URIs are relative to *https://dev.api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_video_email_prompt**](PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
+[**get_video_email_prompt**](PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
+[**respond_to_video_email_prompt**](PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
+
+
+# **create_video_email_prompt**
+> VideoEmailPrompt create_video_email_prompt(prompt)
+
+Prompts user to send a video
+
+Sends the account holder an email prompting them to add a video to a scheduled outgoing message. Recipients, content and timing is all preset for the 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::PromptsApi.new
+
+prompt = BombBomb::VideoEmailPrompt.new # VideoEmailPrompt | The Video Email Prompt to be created
+
+
+begin
+  #Prompts user to send a video
+  result = api_instance.create_video_email_prompt(prompt)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->create_video_email_prompt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prompt** | [**VideoEmailPrompt**](VideoEmailPrompt.md)| The Video Email Prompt to be created | 
+
+### Return type
+
+[**VideoEmailPrompt**](VideoEmailPrompt.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_video_email_prompt**
+> VideoEmailPrompt get_video_email_prompt(id)
+
+Gets a prompt
+
+Gets a 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::PromptsApi.new
+
+id = "id_example" # String | The Id of the prompt
+
+
+begin
+  #Gets a prompt
+  result = api_instance.get_video_email_prompt(id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->get_video_email_prompt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The Id of the prompt | 
+
+### Return type
+
+[**VideoEmailPrompt**](VideoEmailPrompt.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **respond_to_video_email_prompt**
+> VideoEmailPrompt respond_to_video_email_prompt(id, choice, opts)
+
+Respond to a prompt
+
+Respond to a prompt by either adding a video, sending without a video or cancelling the prompt.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+
+api_instance = BombBomb::PromptsApi.new
+
+id = "id_example" # String | The id of the prompt.
+
+choice = "choice_example" # String | The users' selection. Can be: WithVideo, WithoutVideo, Cancel
+
+opts = { 
+  video_id: "video_id_example" # String | The id of the video.
+}
+
+begin
+  #Respond to a prompt
+  result = api_instance.respond_to_video_email_prompt(id, choice, opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->respond_to_video_email_prompt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The id of the prompt. | 
+ **choice** | **String**| The users' selection. Can be: WithVideo, WithoutVideo, Cancel | 
+ **video_id** | **String**| The id of the video. | [optional] 
+
+### Return type
+
+[**VideoEmailPrompt**](VideoEmailPrompt.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/String.md

@@ -0,0 +1,7 @@
+# BombBomb::String
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/TeamsApi.md

@@ -0,0 +1,290 @@
+# BombBomb::TeamsApi
+
+All URIs are relative to *https://dev.api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_jericho_send**](TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
+[**get_client_group_assets**](TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
+[**get_jericho_sends**](TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
+[**get_jericho_stats**](TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
+[**queue_jericho_send**](TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
+
+
+# **cancel_jericho_send**
+> cancel_jericho_send(jericho_id)
+
+Cancel a Jericho Send
+
+Cancels a scheduled Jericho send from being sent.
+
+### 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::TeamsApi.new
+
+jericho_id = "jericho_id_example" # String | ID of the Jericho Job to cancel
+
+
+begin
+  #Cancel a Jericho Send
+  api_instance.cancel_jericho_send(jericho_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling TeamsApi->cancel_jericho_send: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jericho_id** | **String**| ID of the Jericho Job to cancel | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_client_group_assets**
+> InlineResponse200 get_client_group_assets(asset_type, opts)
+
+Lists team assets
+
+Returns a collection of assets
+
+### 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::TeamsApi.new
+
+asset_type = "asset_type_example" # String | The type of assets.
+
+opts = { 
+  team_id: "team_id_example", # String | The team containing the assets.
+  auto_tag_name: "auto_tag_name_example", # String | The auto tag name containing the assets.
+  page_size: "page_size_example", # String | The number of items to retrieve in a single db query.
+  page: "page_example", # String | Zero-based index of the page of data to retrieve from the db.
+  search: "search_example" # String | Search words.
+}
+
+begin
+  #Lists team assets
+  result = api_instance.get_client_group_assets(asset_type, opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling TeamsApi->get_client_group_assets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_type** | **String**| The type of assets. | 
+ **team_id** | **String**| The team containing the assets. | [optional] 
+ **auto_tag_name** | **String**| The auto tag name containing the assets. | [optional] 
+ **page_size** | **String**| The number of items to retrieve in a single db query. | [optional] 
+ **page** | **String**| Zero-based index of the page of data to retrieve from the db. | [optional] 
+ **search** | **String**| Search words. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_jericho_sends**
+> Array<JerichoConfiguration> get_jericho_sends(team_id)
+
+List Jericho Sends
+
+Lists Jericho sends, both pending and sent.
+
+### 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::TeamsApi.new
+
+team_id = "team_id_example" # String | The team whose Jericho sends you wish to see.
+
+
+begin
+  #List Jericho Sends
+  result = api_instance.get_jericho_sends(team_id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling TeamsApi->get_jericho_sends: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **String**| The team whose Jericho sends you wish to see. | 
+
+### Return type
+
+[**Array<JerichoConfiguration>**](JerichoConfiguration.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_jericho_stats**
+> JerichoPerformance get_jericho_stats(jericho_id, team_id)
+
+Gets Jericho performance statistics
+
+Returns an aggregate view of the performance of a Jericho send
+
+### 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::TeamsApi.new
+
+jericho_id = "jericho_id_example" # String | ID of the Jericho job
+
+team_id = "team_id_example" # String | ID of team through which Jericho was sent
+
+
+begin
+  #Gets Jericho performance statistics
+  result = api_instance.get_jericho_stats(jericho_id, team_id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling TeamsApi->get_jericho_stats: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jericho_id** | **String**| ID of the Jericho job | 
+ **team_id** | **String**| ID of team through which Jericho was sent | 
+
+### Return type
+
+[**JerichoPerformance**](JerichoPerformance.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **queue_jericho_send**
+> JerichoConfiguration queue_jericho_send(config, team_id)
+
+Creates a Jericho send.
+
+Sends email content on behalf of members of a client group. There are two forms this send can take:         Static Email, and Video Prompt. Static emails require only an emailId.         Video Prompts build emails dynamically and require most of the other fields.         You must be an administrator of a Team Account to use this method.
+
+### 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::TeamsApi.new
+
+config = BombBomb::JerichoConfiguration.new # JerichoConfiguration | JSON representing a Jericho configuration
+
+team_id = "team_id_example" # String | The ID of the team.
+
+
+begin
+  #Creates a Jericho send.
+  result = api_instance.queue_jericho_send(config, team_id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling TeamsApi->queue_jericho_send: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **config** | [**JerichoConfiguration**](JerichoConfiguration.md)| JSON representing a Jericho configuration | 
+ **team_id** | **String**| The ID of the team. | 
+
+### Return type
+
+[**JerichoConfiguration**](JerichoConfiguration.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+