bombbomb 2.0.22196 → 2.0.24005

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e40ffcd84e2e93547f4957ff42ada08f1ffc5857
-  data.tar.gz: 576ee545e31104ae20fef7f7afb260b731947eda
+  metadata.gz: 87da890da0ac568bf4d0fc8fc3ef76cf35b732cd
+  data.tar.gz: 8b7f9190c00c46179b8aed2f94b4e5a4ceea3910
 SHA512:
-  metadata.gz: 77dd7daf1a07d7f9e656116323f1f611e6c35f1f3d2153be9bbb8fde98a1242b93f5394d535c29396446fd19310c3dad296da7db006b77c5d127af877ee9de6b
-  data.tar.gz: abf5a6a7b6a8aca27b66a411e1c47fa2a03328a31f3a3f7187011d4dfd8367fcffc1c3163f8e0f2fbe5dac8ad770279f8faaaa78569002cac8edbd625033eae6
+  metadata.gz: 7d155a01785c46e0fd7acc2741b782cfb2c423a0dee92c90788eb07c50312281105189322df53c4163fcdea5e0eba853b6b9b1e9c0cbe4823e5ad14080e703ff
+  data.tar.gz: 635036faaf54b06547e48b705dd9b860ab7901bb27b4020fa6c88ac89e1267e53f206d6189fed6bef33b76d263a0f903a8e26d786c3d7810a40cc2c4c49b4902

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.22196
-- Package version: 2.0.22196
-- Build date: 2017-01-23T18:33:23.058Z
+- API version: 2.0.24005
+- Package version: 2.0.24005
+- Build date: 2017-07-26T15:26:23.980Z
 - 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.22196.gem
+gem install ./bombbomb-2.0.24005.gem
 ```
-(for development, run `gem install --dev ./bombbomb-2.0.22196.gem` to install the development dependencies)
+(for development, run `gem install --dev ./bombbomb-2.0.24005.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.22196'
+    gem 'bombbomb', '~> 2.0.24005'
 
 ### Install from Git
 
@@ -55,24 +55,19 @@ Please follow the [installation](#installation) procedure and then run the follo
 # 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
+api_instance = BombBomb::AccountsApi.new
 
+opts = { 
+  email: "email_example", # String | Your login email address
+  pw: "pw_example", # String | Your password
+  api_key: "api_key_example" # String | Your Api Key
+}
 
 begin
-  #Get Automation Email Stats
-  api_instance.get_drip_drop_stats(drip_id, drip_drop_id)
+  #Get account details.
+  api_instance.account_details(opts)
 rescue BombBomb::ApiError => e
-  puts "Exception when calling AutomationsApi->get_drip_drop_stats: #{e}"
+  puts "Exception when calling AccountsApi->account_details: #{e}"
 end
 
 ```
@@ -83,14 +78,23 @@ All URIs are relative to *https://api.bombbomb.com/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
+*BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
+*BombBomb::AccountsApi* | [**subscription_purchase_allowed**](docs/AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
 *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::ContactsApi* | [**delete_contacts**](docs/ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
 *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::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files | Deletes users file
+*BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
+*BombBomb::ListsApi* | [**copy_list_contacts**](docs/ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
+*BombBomb::ListsApi* | [**suppress_all_in_list**](docs/ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
+*BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
 *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
@@ -101,21 +105,32 @@ Class | Method | HTTP request | Description
 *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::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
+*BombBomb::SocialsApi* | [**get_social_auto_shares**](docs/SocialsApi.md#get_social_auto_shares) | **GET** /socials/shares | Gets the auto shares from the client group assoc id
+*BombBomb::SocialsApi* | [**get_social_permissions**](docs/SocialsApi.md#get_social_permissions) | **GET** /socials/permissions | Get permissions for social integration
+*BombBomb::SocialsApi* | [**get_social_status**](docs/SocialsApi.md#get_social_status) | **GET** /socials/states | Gets the social state
+*BombBomb::SocialsApi* | [**update_social_auto_shares**](docs/SocialsApi.md#update_social_auto_shares) | **PUT** /socials/shares | Gets the auto shares from the client group assoc id
+*BombBomb::SocialsApi* | [**update_social_message**](docs/SocialsApi.md#update_social_message) | **PUT** /socials/message | Sets the users social message to what they typed in
+*BombBomb::SocialsApi* | [**update_social_status**](docs/SocialsApi.md#update_social_status) | **PUT** /socials/state | Updates the social state for the object
 *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
 *BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
+*BombBomb::TeamsApi* | [**get_all_client_group_associations**](docs/TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
 *BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
 *BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
 *BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
 *BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
 *BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
 *BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
+*BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
 *BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
+*BombBomb::TeamsApi* | [**update_team_member**](docs/TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
 *BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
 *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_encoding_status**](docs/VideosApi.md#get_video_encoding_status) | **GET** /videos/{videoId}/status | Video Encoding Status
 *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
@@ -137,12 +152,13 @@ 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::PromptBot](docs/PromptBot.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::VideoEncodingStatusResponse](docs/VideoEncodingStatusResponse.md)
  - [BombBomb::VideoPublicRepresentation](docs/VideoPublicRepresentation.md)
  - [BombBomb::VideoRecorderMethodResponse](docs/VideoRecorderMethodResponse.md)
 
@@ -172,5 +188,9 @@ Class | Method | HTTP request | Description
   - form:read: Read Form
   - team:manage: Manage Team
   - team:read: Read Team
+  - order:manage: Manage Order
   - settings:manage: Manage Settings
+  - file:manage: Manage File
+  - account:manage: Manage Account
+  - account:read: Read Account
 

data/bombbomb.gemspec

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

data/docs/AccountsApi.md

@@ -0,0 +1,192 @@
+# BombBomb::AccountsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_details**](AccountsApi.md#account_details) | **GET** /accounts | Get account details.
+[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create Account
+[**subscription_purchase_allowed**](AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
+
+
+# **account_details**
+> account_details(opts)
+
+Get account details.
+
+Get the details of the user's account.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+
+api_instance = BombBomb::AccountsApi.new
+
+opts = { 
+  email: "email_example", # String | Your login email address
+  pw: "pw_example", # String | Your password
+  api_key: "api_key_example" # String | Your Api Key
+}
+
+begin
+  #Get account details.
+  api_instance.account_details(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AccountsApi->account_details: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| Your login email address | [optional] 
+ **pw** | **String**| Your password | [optional] 
+ **api_key** | **String**| Your Api Key | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **create_account**
+> String create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
+
+Create Account
+
+Creates a new BombBomb account. This method is currently only available to paid seat admins.
+
+### 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::AccountsApi.new
+
+team_id = "team_id_example" # String | The team id
+
+first_name = "first_name_example" # String | First name of the user.
+
+last_name = "last_name_example" # String | Last name of the user.
+
+email_address = "email_address_example" # String | Email address of the user.
+
+company_name = "company_name_example" # String | Company of the user.
+
+phone = "phone_example" # String | Phone number of the user.
+
+opts = { 
+  country: "country_example", # String | Country of the user.
+  industry: "industry_example", # String | Industry of the user.
+  address: "address_example", # String | Street Address of the user.
+  city: "city_example", # String | City of the user.
+  postal_code: "postal_code_example" # String | Postal/Zip code of the user.
+}
+
+begin
+  #Create Account
+  result = api_instance.create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AccountsApi->create_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **team_id** | **String**| The team id | 
+ **first_name** | **String**| First name of the user. | 
+ **last_name** | **String**| Last name of the user. | 
+ **email_address** | **String**| Email address of the user. | 
+ **company_name** | **String**| Company of the user. | 
+ **phone** | **String**| Phone number of the user. | 
+ **country** | **String**| Country of the user. | [optional] 
+ **industry** | **String**| Industry of the user. | [optional] 
+ **address** | **String**| Street Address of the user. | [optional] 
+ **city** | **String**| City of the user. | [optional] 
+ **postal_code** | **String**| Postal/Zip code of the user. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **subscription_purchase_allowed**
+> subscription_purchase_allowed(opts)
+
+Check if subscription purchase allowed.
+
+Check whether the user can purchase a subscription.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+
+api_instance = BombBomb::AccountsApi.new
+
+opts = { 
+  email: "email_example", # String | Your login email address
+  pw: "pw_example", # String | Your password
+  api_key: "api_key_example" # String | Your Api Key
+}
+
+begin
+  #Check if subscription purchase allowed.
+  api_instance.subscription_purchase_allowed(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling AccountsApi->subscription_purchase_allowed: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| Your login email address | [optional] 
+ **pw** | **String**| Your password | [optional] 
+ **api_key** | **String**| Your Api Key | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/ContactsApi.md

@@ -0,0 +1,60 @@
+# BombBomb::ContactsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_contacts**](ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
+
+
+# **delete_contacts**
+> delete_contacts(list_id)
+
+Delete Contacts
+
+Delete contacts
+
+### 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::ContactsApi.new
+
+list_id = "list_id_example" # String | The list of contacts to be deleted.
+
+
+begin
+  #Delete Contacts
+  api_instance.delete_contacts(list_id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->delete_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **String**| The list of contacts to be deleted. | 
+
+### 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

@@ -11,11 +11,11 @@ Method | HTTP request | Description
 
 
 # **create_printing_press_email**
-> create_printing_press_email(template_id, content, replace, opts)
+> create_printing_press_email(template_id, content, 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.
+Prints an email using the template id and content to the users account.If a video id is included, it will replace any video placeholders with that video.
 
 ### Example
 ```ruby
@@ -33,16 +33,15 @@ 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 = { 
+  email_id: "email_id_example", # String | The email id to be printed to.
   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)
+  api_instance.create_printing_press_email(template_id, content, opts)
 rescue BombBomb::ApiError => e
   puts "Exception when calling EmailsApi->create_printing_press_email: #{e}"
 end
@@ -54,7 +53,7 @@ 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. | 
+ **email_id** | **String**| The email id to be printed to. | [optional] 
  **video_id** | **String**| A video to replace video place holders with. | [optional] 
  **subject_line** | **String**| The subject line to be printed. | [optional]