bombbomb 2.0.24005 → 2.0.25797

data/docs/FilesApi.md

@@ -4,15 +4,19 @@ All URIs are relative to *https://api.bombbomb.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**doc_host_delete**](FilesApi.md#doc_host_delete) | **DELETE** /files | Deletes users file
+[**doc_host_delete**](FilesApi.md#doc_host_delete) | **DELETE** /files/{docId} | Delete file
+[**doc_host_get**](FilesApi.md#doc_host_get) | **GET** /files/{docId} | Get file
+[**doc_host_list**](FilesApi.md#doc_host_list) | **GET** /files | List all files
+[**doc_host_upload_v2**](FilesApi.md#doc_host_upload_v2) | **POST** /files | Upload a file
+[**get_hosted_images_paged**](FilesApi.md#get_hosted_images_paged) | **GET** /files/images/paged | Get paged hosted images
 
 
 # **doc_host_delete**
 > doc_host_delete(doc_id)
 
-Deletes users file
+Delete file
 
-Deletes the file from the users s3 store
+Deletes a users file
 
 ### Example
 ```ruby
@@ -30,7 +34,7 @@ doc_id = "doc_id_example" # String | Id of document
 
 
 begin
-  #Deletes users file
+  #Delete file
   api_instance.doc_host_delete(doc_id)
 rescue BombBomb::ApiError => e
   puts "Exception when calling FilesApi->doc_host_delete: #{e}"
@@ -58,3 +62,211 @@ nil (empty response body)
 
 
 
+# **doc_host_get**
+> HostedDoc doc_host_get(doc_id)
+
+Get file
+
+Get a single file 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::FilesApi.new
+
+doc_id = "doc_id_example" # String | Id of document
+
+
+begin
+  #Get file
+  result = api_instance.doc_host_get(doc_id)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FilesApi->doc_host_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **doc_id** | **String**| Id of document | 
+
+### Return type
+
+[**HostedDoc**](HostedDoc.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **doc_host_list**
+> Array<HostedDoc> doc_host_list
+
+List all files
+
+List all uploaded user files
+
+### 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::FilesApi.new
+
+begin
+  #List all files
+  result = api_instance.doc_host_list
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FilesApi->doc_host_list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<HostedDoc>**](HostedDoc.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **doc_host_upload_v2**
+> Array<HostedDoc> doc_host_upload_v2(file)
+
+Upload a file
+
+Upload a new file
+
+### 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::FilesApi.new
+
+file = "file_example" # String | The file being uploaded
+
+
+begin
+  #Upload a file
+  result = api_instance.doc_host_upload_v2(file)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FilesApi->doc_host_upload_v2: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **String**| The file being uploaded | 
+
+### Return type
+
+[**Array<HostedDoc>**](HostedDoc.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **get_hosted_images_paged**
+> get_hosted_images_paged(page_size, page, opts)
+
+Get paged hosted images
+
+Get a specific page of uploaded images available to 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::FilesApi.new
+
+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.
+
+opts = { 
+  search: "search_example" # String | Filter results with names that match the search term.
+}
+
+begin
+  #Get paged hosted images
+  api_instance.get_hosted_images_paged(page_size, page, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling FilesApi->get_hosted_images_paged: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page_size** | **String**| The number of items to retrieve in a single db query. | 
+ **page** | **String**| Zero-based index of the page of data to retrieve from the db. | 
+ **search** | **String**| Filter results with names that match the search term. | [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
+
+
+

data/docs/HostedDoc.md

@@ -0,0 +1,13 @@
+# BombBomb::HostedDoc
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The doc's id. | [optional] 
+**user_id** | **String** | The doc's owner. | [optional] 
+**file_name** | **String** | docs file name. | [optional] 
+**short_url** | **String** | The doc's short url. | [optional] 
+**long_url** | **String** | The doc's long url. | [optional] 
+**upload_date** | **DateTime** | The doc's upload date. | [optional] 
+
+

data/docs/IntegrationsApi.md

@@ -0,0 +1,62 @@
+# BombBomb::IntegrationsApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sync_users_integrated_lists**](IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
+
+
+# **sync_users_integrated_lists**
+> String sync_users_integrated_lists(opts)
+
+Synchronize your integration list or lists.
+
+Synchronize your integration contact list with the service you are integrated with. If no integration code is provided, all integrations will be synchronized.
+
+### 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 = { 
+  integration_id: "integration_id_example" # String | The integration to sync lists for. All integrations will sync if nothing is provided.
+}
+
+begin
+  #Synchronize your integration list or lists.
+  result = api_instance.sync_users_integrated_lists(opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling IntegrationsApi->sync_users_integrated_lists: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The integration to sync lists for. All integrations will sync if nothing is provided. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/ListsApi.md

@@ -4,11 +4,64 @@ 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)
 
@@ -114,6 +167,51 @@ nil (empty response body)
 
 
 
+# **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)
 

data/docs/PromptsApi.md

@@ -12,12 +12,13 @@ Method | HTTP request | Description
 [**get_video_email_prompt**](PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
 [**get_video_email_prompts**](PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
 [**respond_to_video_email_prompt**](PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
+[**update_prompt**](PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
 [**update_prompt_bot**](PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
 [**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
 
 
 # **create_prompt_bot**
-> PromptBot create_prompt_bot(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
+> PromptBot create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
 
 Create a running Prompt Bot for a list
 
@@ -35,8 +36,6 @@ end
 
 api_instance = BombBomb::PromptsApi.new
 
-list_id = "list_id_example" # String | The list id to attach the bot to.
-
 email_id = "email_id_example" # String | The default email to use.
 
 name = "name_example" # String | The name of the bot.
@@ -52,13 +51,14 @@ bot_type_id = "bot_type_id_example" # String | The type of bot to create.
 template_id = "template_id_example" # String | The template used to create the email id.
 
 opts = { 
+  list_id: "list_id_example", # String | The list id to attach the bot to.
   video_id: "video_id_example", # String | The video used in the email.
   end_date: "end_date_example" # String | The time frame to complete sending to the list.
 }
 
 begin
   #Create a running Prompt Bot for a list
-  result = api_instance.create_prompt_bot(list_id, email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
+  result = api_instance.create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
   p result
 rescue BombBomb::ApiError => e
   puts "Exception when calling PromptsApi->create_prompt_bot: #{e}"
@@ -69,7 +69,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| The list id to attach the bot to. | 
  **email_id** | **String**| The default email to use. | 
  **name** | **String**| The name of the bot. | 
  **subject** | **String**| The subject of the default email. | 
@@ -77,6 +76,7 @@ Name | Type | Description  | Notes
  **contact_field_value_column** | **String**| The custom field value column with dates for this bot. | 
  **bot_type_id** | **String**| The type of bot to create. | 
  **template_id** | **String**| The template used to create the email id. | 
+ **list_id** | **String**| The list id to attach the bot to. | [optional] 
  **video_id** | **String**| The video used in the email. | [optional] 
  **end_date** | **String**| The time frame to complete sending to the list. | [optional] 
 
@@ -440,8 +440,73 @@ No authorization required
 
 
 
+# **update_prompt**
+> update_prompt(id, opts)
+
+Update Prompt
+
+Updates 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 prompt's id
+
+opts = { 
+  send_mechanism: "send_mechanism_example", # String | The mechanism for the prompt to be sent
+  facebook_message: "facebook_message_example", # String | The facebook message assigned to the prompt
+  twitter_message: "twitter_message_example", # String | The twitter message assigned to the prompt
+  video_id: "video_id_example", # String | The id of the video.
+  email_id: "email_id_example", # String | The id of the email.
+  subject: "subject_example" # String | The subject of the email
+}
+
+begin
+  #Update Prompt
+  api_instance.update_prompt(id, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling PromptsApi->update_prompt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The prompt's id | 
+ **send_mechanism** | **String**| The mechanism for the prompt to be sent | [optional] 
+ **facebook_message** | **String**| The facebook message assigned to the prompt | [optional] 
+ **twitter_message** | **String**| The twitter message assigned to the prompt | [optional] 
+ **video_id** | **String**| The id of the video. | [optional] 
+ **email_id** | **String**| The id of the email. | [optional] 
+ **subject** | **String**| The subject of the email | [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_prompt_bot**
-> PromptBot update_prompt_bot(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
+> PromptBot update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
 
 Update Prompt Bot
 
@@ -461,8 +526,6 @@ api_instance = BombBomb::PromptsApi.new
 
 id = "id_example" # String | The bot id.
 
-list_id = "list_id_example" # String | The list id to attach the bot to.
-
 email_id = "email_id_example" # String | The default email to use.
 
 name = "name_example" # String | The name of the bot.
@@ -476,6 +539,7 @@ contact_field_value_column = "contact_field_value_column_example" # String | The
 template_id = "template_id_example" # String | The template used to create the email id.
 
 opts = { 
+  list_id: "list_id_example", # String | The list id to attach the bot to.
   video_id: "video_id_example", # String | The video used in the default email.
   end_date: "end_date_example", # String | The time frame to complete sending to the list.
   status: "status_example" # String | The status of the bot.
@@ -483,7 +547,7 @@ opts = {
 
 begin
   #Update Prompt Bot
-  result = api_instance.update_prompt_bot(id, list_id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
+  result = api_instance.update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
   p result
 rescue BombBomb::ApiError => e
   puts "Exception when calling PromptsApi->update_prompt_bot: #{e}"
@@ -495,13 +559,13 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| The bot id. | 
- **list_id** | **String**| The list id to attach the bot to. | 
  **email_id** | **String**| The default email to use. | 
  **name** | **String**| The name of the bot. | 
  **subject** | **String**| The subject of the default email. | 
  **content** | **String**| The content used in the default email. | 
  **contact_field_value_column** | **String**| The custom field value column with dates for this bot. | 
  **template_id** | **String**| The template used to create the email id. | 
+ **list_id** | **String**| The list id to attach the bot to. | [optional] 
  **video_id** | **String**| The video used in the default email. | [optional] 
  **end_date** | **String**| The time frame to complete sending to the list. | [optional] 
  **status** | **String**| The status of the bot. | [optional] 
@@ -546,7 +610,7 @@ opts = {
   branded_template_id: "branded_template_id_example", # String | The template to use for branded feel emails.
   personal_template_id: "personal_template_id_example", # String | The template to use for personal feel emails.
   enabled: true, # BOOLEAN | Set whether the user is able to start receiving prompts.
-  auto_shares: "auto_shares_example" # String | These are what we are autosharing to
+  send_mechanism: "send_mechanism_example" # String | The way to send the prompt
 }
 
 begin
@@ -565,7 +629,7 @@ Name | Type | Description  | Notes
  **branded_template_id** | **String**| The template to use for branded feel emails. | [optional] 
  **personal_template_id** | **String**| The template to use for personal feel emails. | [optional] 
  **enabled** | **BOOLEAN**| Set whether the user is able to start receiving prompts. | [optional] 
- **auto_shares** | **String**| These are what we are autosharing to | [optional] 
+ **send_mechanism** | **String**| The way to send the prompt | [optional] 
 
 ### Return type