bombbomb 2.0.21454 → 2.0.22196

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f3687154c9ffd958cee79fba5e35ec74cdd836
-  data.tar.gz: 1019446de3c26d85fac570f01e005c20d78f4941
+  metadata.gz: e40ffcd84e2e93547f4957ff42ada08f1ffc5857
+  data.tar.gz: 576ee545e31104ae20fef7f7afb260b731947eda
 SHA512:
-  metadata.gz: 3cea7e2a91e44edf8a143ddbad11b7b57607e93ffc8fb3029db877fae2fa1266b1fa360b4f755d6b499b7e0a28e6ab60e8cb6bbdb46cd81f97c53f3714c77f2e
-  data.tar.gz: 97a48e8b1b1f5b5c2f53b9148767d4d3640e52eb02171bda6f168e4a6dbe23f79893a2380efa4485cf48f7e28c2f915f73a80407be6a97916a9f23a618c2a0ec
+  metadata.gz: 77dd7daf1a07d7f9e656116323f1f611e6c35f1f3d2153be9bbb8fde98a1242b93f5394d535c29396446fd19310c3dad296da7db006b77c5d127af877ee9de6b
+  data.tar.gz: abf5a6a7b6a8aca27b66a411e1c47fa2a03328a31f3a3f7187011d4dfd8367fcffc1c3163f8e0f2fbe5dac8ad770279f8faaaa78569002cac8edbd625033eae6

data/README.md

@@ -6,9 +6,9 @@ We make it easy to build relationships using simple videos.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.0.21454
-- Package version: 2.0.21454
-- Build date: 2016-11-16T16:11:14.077Z
+- API version: 2.0.22196
+- Package version: 2.0.22196
+- Build date: 2017-01-23T18:33:23.058Z
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -24,15 +24,15 @@ gem build bombbomb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./bombbomb-2.0.21454.gem
+gem install ./bombbomb-2.0.22196.gem
 ```
-(for development, run `gem install --dev ./bombbomb-2.0.21454.gem` to install the development dependencies)
+(for development, run `gem install --dev ./bombbomb-2.0.22196.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'bombbomb', '~> 2.0.21454'
+    gem 'bombbomb', '~> 2.0.22196'
 
 ### Install from Git
 
@@ -61,18 +61,18 @@ BombBomb.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = BombBomb::CurriculumApi.new
+api_instance = BombBomb::AutomationsApi.new
+
+drip_id = "drip_id_example" # String | The id of the drip
+
+drip_drop_id = "drip_drop_id_example" # String | The id of the drip drop
 
-opts = { 
-  include_progress: true # BOOLEAN | Whether to return progress with the curriculum.
-}
 
 begin
-  #Get Curricula
-  result = api_instance.get_curricula(opts)
-  p result
+  #Get Automation Email Stats
+  api_instance.get_drip_drop_stats(drip_id, drip_drop_id)
 rescue BombBomb::ApiError => e
-  puts "Exception when calling CurriculumApi->get_curricula: #{e}"
+  puts "Exception when calling AutomationsApi->get_drip_drop_stats: #{e}"
 end
 
 ```
@@ -83,11 +83,24 @@ All URIs are relative to *https://api.bombbomb.com/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
+*BombBomb::AutomationsApi* | [**get_drip_stats**](docs/AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
 *BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
 *BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
+*BombBomb::EmailsApi* | [**create_printing_press_email**](docs/EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
+*BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
+*BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
+*BombBomb::EmailsApi* | [**get_hourly_email_tracking**](docs/EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
+*BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
 *BombBomb::PromptsApi* | [**create_video_email_prompt**](docs/PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
+*BombBomb::PromptsApi* | [**get_pending_video_email_prompts**](docs/PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
+*BombBomb::PromptsApi* | [**get_prompt_bots**](docs/PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
+*BombBomb::PromptsApi* | [**get_prompt_campaigns**](docs/PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/campaigns | List Prompt Campaigns
 *BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
+*BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
 *BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
+*BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
+*BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
 *BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
 *BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
 *BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
@@ -103,6 +116,9 @@ Class | Method | HTTP request | Description
 *BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
 *BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
 *BombBomb::UtilitiesApi* | [**get_spec**](docs/UtilitiesApi.md#get_spec) | **GET** /spec | Describes this api
+*BombBomb::VideosApi* | [**get_video_recorder**](docs/VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
+*BombBomb::VideosApi* | [**mark_live_recording_complete**](docs/VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
+*BombBomb::VideosApi* | [**sign_upload**](docs/VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
 *BombBomb::WebhooksApi* | [**add_web_hook**](docs/WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
 *BombBomb::WebhooksApi* | [**delete_web_hook**](docs/WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
 *BombBomb::WebhooksApi* | [**get_web_hooks**](docs/WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
@@ -121,9 +137,14 @@ Class | Method | HTTP request | Description
  - [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
  - [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
  - [BombBomb::OAuthClient](docs/OAuthClient.md)
+ - [BombBomb::PromptBotBot](docs/PromptBotBot.md)
+ - [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
+ - [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
  - [BombBomb::String](docs/String.md)
  - [BombBomb::TeamPublicRepresentation](docs/TeamPublicRepresentation.md)
  - [BombBomb::VideoEmailPrompt](docs/VideoEmailPrompt.md)
+ - [BombBomb::VideoPublicRepresentation](docs/VideoPublicRepresentation.md)
+ - [BombBomb::VideoRecorderMethodResponse](docs/VideoRecorderMethodResponse.md)
 
 
 ## Documentation for Authorization

data/bombbomb.gemspec

@@ -5,7 +5,7 @@
 
 #We make it easy to build relationships using simple videos.
 
-OpenAPI spec version: 2.0.21454
+OpenAPI spec version: 2.0.22196
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 

data/docs/AutomationsApi.md

@@ -0,0 +1,115 @@
+# BombBomb::AutomationsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+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_drip_drop_stats**
+> get_drip_drop_stats(drip_id, drip_drop_id)
+
+Get Automation Email Stats
+
+Get Automation Email Stats
+
+### 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
+
+drip_id = "drip_id_example" # String | The id of the drip
+
+drip_drop_id = "drip_drop_id_example" # String | The id of the drip drop
+
+
+begin
+  #Get Automation Email Stats
+  api_instance.get_drip_drop_stats(drip_id, drip_drop_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AutomationsApi->get_drip_drop_stats: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **drip_id** | **String**| The id of the drip | 
+ **drip_drop_id** | **String**| The id of the drip drop | 
+
+### 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_drip_stats**
+> get_drip_stats(id)
+
+Get Automation Stats
+
+Get Automation Stats
+
+### 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 Automation Stats
+  api_instance.get_drip_stats(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AutomationsApi->get_drip_stats: #{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/EmailsApi.md

@@ -0,0 +1,246 @@
+# BombBomb::EmailsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_printing_press_email**](EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
+[**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
+
+
+# **create_printing_press_email**
+> create_printing_press_email(template_id, content, replace, opts)
+
+Create an Email with Printing Press
+
+Prints an email using the template id and content to the users account.If a video id, is include it will replace any video placeholders with that video.
+
+### 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 template id to be printed.
+
+content = "content_example" # String | The content of the email.
+
+replace = true # BOOLEAN | Set whether to replace video placeholders with video id.
+
+opts = { 
+  video_id: "video_id_example", # String | A video to replace video place holders with.
+  subject_line: "subject_line_example" # String | The subject line to be printed.
+}
+
+begin
+  #Create an Email with Printing Press
+  api_instance.create_printing_press_email(template_id, content, replace, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->create_printing_press_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**| The template id to be printed. | 
+ **content** | **String**| The content of the email. | 
+ **replace** | **BOOLEAN**| Set whether to replace video placeholders with video id. | 
+ **video_id** | **String**| A video to replace video place holders with. | [optional] 
+ **subject_line** | **String**| The subject line to be printed. | [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_email_tracking**
+> get_email_tracking(email_id, opts)
+
+Get Email Tracking
+
+Get Tracking data for all sends of 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::EmailsApi.new
+
+email_id = "email_id_example" # String | ID of the email
+
+opts = { 
+  job_id: "job_id_example" # String | ID of the Job (or null for all jobs)
+}
+
+begin
+  #Get Email Tracking
+  api_instance.get_email_tracking(email_id, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_email_tracking: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**| ID of the email | 
+ **job_id** | **String**| ID of the Job (or null for all jobs) | [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_email_tracking_interactions**
+> get_email_tracking_interactions(email_id, opts)
+
+Get Email Tracking Interactions
+
+Get Contact detail interactions 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::EmailsApi.new
+
+email_id = "email_id_example" # String | ID of the email
+
+opts = { 
+  job_id: "job_id_example", # String | ID of the Job (or null for all jobs)
+  interaction_type: "interaction_type_example", # String | Interaction type to order and filter by
+  search_term: "search_term_example" # String | Search term to filer by
+}
+
+begin
+  #Get Email Tracking Interactions
+  api_instance.get_email_tracking_interactions(email_id, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_email_tracking_interactions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**| ID of the email | 
+ **job_id** | **String**| ID of the Job (or null for all jobs) | [optional] 
+ **interaction_type** | **String**| Interaction type to order and filter by | [optional] 
+ **search_term** | **String**| Search term to filer by | [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_hourly_email_tracking**
+> get_hourly_email_tracking(email_id, opts)
+
+Get Hourly Email Tracking
+
+Get Tracking data for an Email,             broken down by the hour and filterable by an Interaction type
+
+### 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
+
+email_id = "email_id_example" # String | ID of the email
+
+opts = { 
+  job_id: "job_id_example", # String | ID of the Job (or null for all jobs)
+  interaction_type: "interaction_type_example" # String | Interaction type to filter by
+}
+
+begin
+  #Get Hourly Email Tracking
+  api_instance.get_hourly_email_tracking(email_id, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_hourly_email_tracking: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**| ID of the email | 
+ **job_id** | **String**| ID of the Job (or null for all jobs) | [optional] 
+ **interaction_type** | **String**| Interaction type to filter by | [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
+
+
+