bombbomb 2.0.24005 → 2.0.25797

data/docs/ContactsApi.md

@@ -4,7 +4,284 @@ All URIs are relative to *https://api.bombbomb.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_contacts_csv**](ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
+[**add_new_contact**](ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
+[**add_new_custom_field**](ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
+[**add_pasted_contacts**](ContactsApi.md#add_pasted_contacts) | **POST** /contacts/paste | Add pasted contacts.
+[**c_sv_to_object**](ContactsApi.md#c_sv_to_object) | **POST** /csv-to-object | Format CSV.
 [**delete_contacts**](ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
+[**get_contact_by_id**](ContactsApi.md#get_contact_by_id) | **GET** /contact/{id} | Get Contact Details
+[**get_custom_fields**](ContactsApi.md#get_custom_fields) | **GET** /contacts/custom_fields/ | Get custom fields.
+
+
+# **add_contacts_csv**
+> add_contacts_csv(mapping_data, list_data)
+
+Add contacts from a CSV file.
+
+Add multiple contacts through the upload importer from a CSV 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::ContactsApi.new
+
+mapping_data = "mapping_data_example" # String | The info sent for the contacts
+
+list_data = "list_data_example" # String | The info sent with the import for the list
+
+
+begin
+  #Add contacts from a CSV file.
+  api_instance.add_contacts_csv(mapping_data, list_data)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->add_contacts_csv: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mapping_data** | **String**| The info sent for the contacts | 
+ **list_data** | **String**| The info sent with the import for the list | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **add_new_contact**
+> add_new_contact(contact_email, opts)
+
+Add a contact.
+
+Add a contact to the users list.
+
+### 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
+
+contact_email = "contact_email_example" # String | Email of the new contact we are adding
+
+opts = { 
+  contact_info: "contact_info_example" # String | The info sent for this contact
+}
+
+begin
+  #Add a contact.
+  api_instance.add_new_contact(contact_email, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->add_new_contact: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_email** | **String**| Email of the new contact we are adding | 
+ **contact_info** | **String**| The info sent for this contact | [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
+
+
+
+# **add_new_custom_field**
+> add_new_custom_field(field_name, opts)
+
+Add custom fields.
+
+Add a new custom field.
+
+### 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
+
+field_name = "field_name_example" # String | Custom field name to be added
+
+opts = { 
+  field_type: "field_type_example" # String | Custom field type for the field to be added
+}
+
+begin
+  #Add custom fields.
+  api_instance.add_new_custom_field(field_name, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->add_new_custom_field: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **field_name** | **String**| Custom field name to be added | 
+ **field_type** | **String**| Custom field type for the field to be added | [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
+
+
+
+# **add_pasted_contacts**
+> add_pasted_contacts(contact_emails, opts)
+
+Add pasted contacts.
+
+Add the pasted contacts to the users list.
+
+### 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
+
+contact_emails = "contact_emails_example" # String | Emails array of the new contacts we are adding
+
+opts = { 
+  list_info: "list_info_example" # String | Information about the lists id, recalculations on totals, consent etc
+}
+
+begin
+  #Add pasted contacts.
+  api_instance.add_pasted_contacts(contact_emails, opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->add_pasted_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact_emails** | **String**| Emails array of the new contacts we are adding | 
+ **list_info** | **String**| Information about the lists id, recalculations on totals, consent etc | [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
+
+
+
+# **c_sv_to_object**
+> c_sv_to_object(file)
+
+Format CSV.
+
+Format a CSV file to an object.
+
+### 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
+
+file = "file_example" # String | The CSV file being uploaded
+
+
+begin
+  #Format CSV.
+  api_instance.c_sv_to_object(file)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->c_sv_to_object: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **String**| The CSV file being uploaded | 
+
+### 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_contacts**
@@ -58,3 +335,99 @@ nil (empty response body)
 
 
 
+# **get_contact_by_id**
+> get_contact_by_id(id)
+
+Get Contact Details
+
+Get the contact details
+
+### 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
+
+id = "id_example" # String | Guid for the contact.
+
+
+begin
+  #Get Contact Details
+  api_instance.get_contact_by_id(id)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->get_contact_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Guid for the contact. | 
+
+### 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_custom_fields**
+> get_custom_fields
+
+Get custom fields.
+
+Get the current users custom fields.
+
+### 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
+
+begin
+  #Get custom fields.
+  api_instance.get_custom_fields
+rescue BombBomb::ApiError => e
+  puts "Exception when calling ContactsApi->get_custom_fields: #{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
+
+
+

data/docs/EmailsApi.md

@@ -5,9 +5,12 @@ 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_all_templates_for_current_user**](EmailsApi.md#get_all_templates_for_current_user) | **GET** /emails/templates | Get all user templates
 [**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_quick_send_templates**](EmailsApi.md#get_quick_send_templates) | **GET** /emails/quicksend/templates | Get all quicksend templates
+[**video_quick_sender**](EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
 
 
 # **create_printing_press_email**
@@ -72,6 +75,58 @@ nil (empty response body)
 
 
 
+# **get_all_templates_for_current_user**
+> get_all_templates_for_current_user(opts)
+
+Get all user templates
+
+Get all templates accessible to the current 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::EmailsApi.new
+
+opts = { 
+  quick_send_only: true # BOOLEAN | Whether to return only quick send templates.
+}
+
+begin
+  #Get all user templates
+  api_instance.get_all_templates_for_current_user(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_all_templates_for_current_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **quick_send_only** | **BOOLEAN**| Whether to return only quick send templates. | [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)
 
@@ -243,3 +298,116 @@ nil (empty response body)
 
 
 
+# **get_quick_send_templates**
+> get_quick_send_templates
+
+Get all quicksend templates
+
+Get all quicksend templates accessible 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::EmailsApi.new
+
+begin
+  #Get all quicksend templates
+  api_instance.get_quick_send_templates
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->get_quick_send_templates: #{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
+
+
+
+# **video_quick_sender**
+> video_quick_sender(opts)
+
+Send a quicksend email
+
+Send a quicksend video email to the list or users provided.
+
+### 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 = { 
+  video_id: "video_id_example", # String | A guid id for the video.
+  email_addresses: "email_addresses_example", # String | A semi-colon separated list of email addresses to send to.
+  subject: "subject_example", # String | Subject line for the email.
+  message: "message_example", # String | Message for the body of the email.
+  list_ids: "list_ids_example", # String | An array of list ids
+  scheduled_send_timestamp: 56, # Integer | When to schedule the send (seconds since epoch). null value means send immediately.
+  extended_properties: "extended_properties_example", # String | Bool value that when checked will send back both emailId as well as extra properties
+  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.
+  strip_html: "strip_html_example" # String | remove HTML elements
+}
+
+begin
+  #Send a quicksend email
+  api_instance.video_quick_sender(opts)
+rescue BombBomb::ApiError => e
+  puts "Exception when calling EmailsApi->video_quick_sender: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **video_id** | **String**| A guid id for the video. | [optional] 
+ **email_addresses** | **String**| A semi-colon separated list of email addresses to send to. | [optional] 
+ **subject** | **String**| Subject line for the email. | [optional] 
+ **message** | **String**| Message for the body of the email. | [optional] 
+ **list_ids** | **String**| An array of list ids | [optional] 
+ **scheduled_send_timestamp** | **Integer**| When to schedule the send (seconds since epoch). null value means send immediately. | [optional] 
+ **extended_properties** | **String**| Bool value that when checked will send back both emailId as well as extra properties | [optional] 
+ **template_id** | **String**| Id of a template to use for this send. A null value means use the default for this user. | [optional] 
+ **strip_html** | **String**| remove HTML elements | [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
+
+
+