bombbomb 2.0.831 → 2.0.20679
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +13 -5
- data/README.md +31 -147
- data/Rakefile +3 -8
- data/bombbomb.gemspec +17 -8
- data/docs/InlineResponse200.md +1 -1
- data/docs/JerichoConfiguration.md +1 -7
- data/docs/JerichoPerformance.md +0 -4
- data/docs/PromptsApi.md +6 -712
- data/docs/TeamsApi.md +62 -1144
- data/docs/UtilitiesApi.md +4 -4
- data/docs/VideoEmailPrompt.md +10 -24
- data/docs/WebhooksApi.md +4 -45
- data/git_push.sh +13 -1
- data/lib/bombbomb.rb +14 -30
- data/lib/bombbomb/api/prompts_api.rb +42 -833
- data/lib/bombbomb/api/teams_api.rb +157 -1331
- data/lib/bombbomb/api/utilities_api.rb +44 -23
- data/lib/bombbomb/api/webhooks_api.rb +43 -68
- data/lib/bombbomb/api_client.rb +45 -55
- data/lib/bombbomb/api_error.rb +18 -9
- data/lib/bombbomb/configuration.rb +13 -8
- data/lib/bombbomb/models/bb_web_hook.rb +17 -6
- data/lib/bombbomb/models/inline_response_200.rb +18 -7
- data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
- data/lib/bombbomb/models/jericho_configuration.rb +22 -75
- data/lib/bombbomb/models/jericho_performance.rb +21 -50
- data/lib/bombbomb/models/o_auth_client.rb +17 -6
- data/lib/bombbomb/models/string.rb +17 -6
- data/lib/bombbomb/models/video_email_prompt.rb +90 -214
- data/lib/bombbomb/version.rb +14 -3
- data/spec/models/{team_public_representation_spec.rb → inline_response_200_items_spec.rb} +14 -8
- metadata +56 -168
- data/Gemfile +0 -7
- data/docs/AccountsApi.md +0 -384
- data/docs/AutomationsApi.md +0 -167
- data/docs/ClientGroupAssetMetaData.md +0 -11
- data/docs/ContactsApi.md +0 -436
- data/docs/Curriculum.md +0 -15
- data/docs/CurriculumApi.md +0 -109
- data/docs/CurriculumUserProgress.md +0 -12
- data/docs/CurriculumWithProgress.md +0 -15
- data/docs/EmailsApi.md +0 -633
- data/docs/FilesApi.md +0 -272
- data/docs/FormsApi.md +0 -60
- data/docs/HostedDoc.md +0 -13
- data/docs/IntegrationsApi.md +0 -285
- data/docs/ListsApi.md +0 -265
- data/docs/OrdersApi.md +0 -60
- data/docs/PromptBot.md +0 -22
- data/docs/PromptBotBot.md +0 -18
- data/docs/PromptMonthlyPerformance.md +0 -11
- data/docs/PromptOverview.md +0 -11
- data/docs/PromptSocialPrompt.md +0 -20
- data/docs/SignUploadRequest.md +0 -9
- data/docs/SignUploadResponse.md +0 -9
- data/docs/SocialsApi.md +0 -653
- data/docs/TeamPublicRepresentation.md +0 -10
- data/docs/UsersApi.md +0 -100
- data/docs/VideoEncodingStatusResponse.md +0 -10
- data/docs/VideoPublicRepresentation.md +0 -18
- data/docs/VideoRecorderMethodResponse.md +0 -15
- data/docs/VideosApi.md +0 -287
- data/lib/bombbomb/api/accounts_api.rb +0 -432
- data/lib/bombbomb/api/automations_api.rb +0 -191
- data/lib/bombbomb/api/contacts_api.rb +0 -470
- data/lib/bombbomb/api/curriculum_api.rb +0 -124
- data/lib/bombbomb/api/emails_api.rb +0 -673
- data/lib/bombbomb/api/files_api.rb +0 -302
- data/lib/bombbomb/api/forms_api.rb +0 -77
- data/lib/bombbomb/api/integrations_api.rb +0 -308
- data/lib/bombbomb/api/lists_api.rb +0 -295
- data/lib/bombbomb/api/orders_api.rb +0 -78
- data/lib/bombbomb/api/socials_api.rb +0 -714
- data/lib/bombbomb/api/users_api.rb +0 -119
- data/lib/bombbomb/api/videos_api.rb +0 -326
- data/lib/bombbomb/models/client_group_asset_meta_data.rb +0 -215
- data/lib/bombbomb/models/curriculum.rb +0 -261
- data/lib/bombbomb/models/curriculum_user_progress.rb +0 -229
- data/lib/bombbomb/models/curriculum_with_progress.rb +0 -261
- data/lib/bombbomb/models/hosted_doc.rb +0 -239
- data/lib/bombbomb/models/prompt_bot.rb +0 -329
- data/lib/bombbomb/models/prompt_bot_bot.rb +0 -300
- data/lib/bombbomb/models/prompt_monthly_performance.rb +0 -219
- data/lib/bombbomb/models/prompt_overview.rb +0 -219
- data/lib/bombbomb/models/prompt_social_prompt.rb +0 -311
- data/lib/bombbomb/models/sign_upload_request.rb +0 -199
- data/lib/bombbomb/models/sign_upload_response.rb +0 -199
- data/lib/bombbomb/models/team_public_representation.rb +0 -209
- data/lib/bombbomb/models/video_encoding_status_response.rb +0 -209
- data/lib/bombbomb/models/video_public_representation.rb +0 -291
- data/lib/bombbomb/models/video_recorder_method_response.rb +0 -259
- data/spec/api/accounts_api_spec.rb +0 -96
- data/spec/api/automations_api_spec.rb +0 -71
- data/spec/api/contacts_api_spec.rb +0 -58
- data/spec/api/curriculum_api_spec.rb +0 -69
- data/spec/api/emails_api_spec.rb +0 -104
- data/spec/api/files_api_spec.rb +0 -58
- data/spec/api/forms_api_spec.rb +0 -58
- data/spec/api/integrations_api_spec.rb +0 -58
- data/spec/api/lists_api_spec.rb +0 -83
- data/spec/api/orders_api_spec.rb +0 -58
- data/spec/api/socials_api_spec.rb +0 -135
- data/spec/api/users_api_spec.rb +0 -57
- data/spec/api/videos_api_spec.rb +0 -86
- data/spec/models/client_group_asset_meta_data_spec.rb +0 -60
- data/spec/models/curriculum_spec.rb +0 -95
- data/spec/models/curriculum_user_progress_spec.rb +0 -77
- data/spec/models/curriculum_with_progress_spec.rb +0 -95
- data/spec/models/hosted_doc_spec.rb +0 -83
- data/spec/models/prompt_bot_spec.rb +0 -137
- data/spec/models/prompt_monthly_performance_spec.rb +0 -60
- data/spec/models/prompt_overview_spec.rb +0 -60
- data/spec/models/prompt_social_prompt_spec.rb +0 -125
- data/spec/models/sign_upload_request_spec.rb +0 -59
- data/spec/models/sign_upload_response_spec.rb +0 -59
- data/spec/models/video_encoding_status_response_spec.rb +0 -65
- data/spec/models/video_public_representation_spec.rb +0 -113
- data/spec/models/video_recorder_method_response_spec.rb +0 -95
checksums.yaml
CHANGED
@@ -1,7 +1,15 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
|
2
|
+
!binary "U0hBMQ==":
|
3
|
+
metadata.gz: !binary |-
|
4
|
+
ODhhYmNmY2YxOWM1OGZmNjc2OTAwZWQ3ODMwYThjNzVlYWU0YTMzNg==
|
5
|
+
data.tar.gz: !binary |-
|
6
|
+
YWFmNTk0NTMxMDcwNjVmYjJkNzc5MmMzYWE4NWZhOTkzMmM0ZGMzOA==
|
5
7
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
|
8
|
+
metadata.gz: !binary |-
|
9
|
+
NTcyOTRlN2EyMzE3YjliZGJmN2U2ZmNhYmYwYzQ5NDAxNWVmZDZiYmY4MWU4
|
10
|
+
ZGIzN2M2ZDU0MTY5ZjFiMjFhZDljODU2YWMwMTlmOTczYWUyZjAyNThlYTU1
|
11
|
+
NWRhYTg1MGU1NmU2NGU5NTkwOWVhMmFlOWFiMDdjNGIwYzljM2Y=
|
12
|
+
data.tar.gz: !binary |-
|
13
|
+
MmE3YWJhNjZiMmNjMDc1MGNjOWU5YjViYmZlODcwN2IxY2NmOTY4OTE1ZDBk
|
14
|
+
MTk5MGU5MGVmY2Y4OWYxZjUzZDc3MjUwZWYzZjg3NDI5NjliNTViOTlmOTU5
|
15
|
+
MDNhNDdhODU0MWEzYmM1MDJjNjIyMjZjYTliNmNjMjg0Y2IxM2E=
|
data/README.md
CHANGED
@@ -6,9 +6,10 @@ We make it easy to build relationships using simple videos.
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
|
-
- API version: 2.0.
|
10
|
-
- Package version: 2.0.
|
11
|
-
- Build
|
9
|
+
- API version: 2.0.20679
|
10
|
+
- Package version: 2.0.20679
|
11
|
+
- Build date: 2016-09-08T20:31:23.946Z
|
12
|
+
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
12
13
|
|
13
14
|
## Installation
|
14
15
|
|
@@ -23,15 +24,15 @@ gem build bombbomb.gemspec
|
|
23
24
|
Then either install the gem locally:
|
24
25
|
|
25
26
|
```shell
|
26
|
-
gem install ./bombbomb-2.0.
|
27
|
+
gem install ./bombbomb-2.0.20679.gem
|
27
28
|
```
|
28
|
-
(for development, run `gem install --dev ./bombbomb-2.0.
|
29
|
+
(for development, run `gem install --dev ./bombbomb-2.0.20679.gem` to install the development dependencies)
|
29
30
|
|
30
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
32
|
|
32
33
|
Finally add this to the Gemfile:
|
33
34
|
|
34
|
-
gem 'bombbomb', '~> 2.0.
|
35
|
+
gem 'bombbomb', '~> 2.0.20679'
|
35
36
|
|
36
37
|
### Install from Git
|
37
38
|
|
@@ -60,13 +61,17 @@ BombBomb.configure do |config|
|
|
60
61
|
config.access_token = 'YOUR ACCESS TOKEN'
|
61
62
|
end
|
62
63
|
|
63
|
-
api_instance = BombBomb::
|
64
|
+
api_instance = BombBomb::PromptsApi.new
|
65
|
+
|
66
|
+
prompt = BombBomb::VideoEmailPrompt.new # VideoEmailPrompt | The Video Email Prompt to be created
|
67
|
+
|
64
68
|
|
65
69
|
begin
|
66
|
-
#
|
67
|
-
api_instance.
|
70
|
+
#Prompts user to send a video
|
71
|
+
result = api_instance.create_video_email_prompt(prompt)
|
72
|
+
p result
|
68
73
|
rescue BombBomb::ApiError => e
|
69
|
-
puts "Exception when calling
|
74
|
+
puts "Exception when calling PromptsApi->create_video_email_prompt: #{e}"
|
70
75
|
end
|
71
76
|
|
72
77
|
```
|
@@ -77,147 +82,34 @@ All URIs are relative to *https://api.bombbomb.com/v2*
|
|
77
82
|
|
78
83
|
Class | Method | HTTP request | Description
|
79
84
|
------------ | ------------- | ------------- | -------------
|
80
|
-
*BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
|
81
|
-
*BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
|
82
|
-
*BombBomb::AccountsApi* | [**get_client_statistics**](docs/AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
|
83
|
-
*BombBomb::AccountsApi* | [**get_user_country**](docs/AccountsApi.md#get_user_country) | **GET** /accounts/{clientId}/country | Gets user country
|
84
|
-
*BombBomb::AccountsApi* | [**reset_api_key**](docs/AccountsApi.md#reset_api_key) | **PUT** /accounts/apikey | Reset API key
|
85
|
-
*BombBomb::AccountsApi* | [**subscription_purchase_allowed**](docs/AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
|
86
|
-
*BombBomb::AccountsApi* | [**update_profile_data**](docs/AccountsApi.md#update_profile_data) | **POST** /account/profile/ | Add profile information.
|
87
|
-
*BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
|
88
|
-
*BombBomb::AutomationsApi* | [**get_drip_stats**](docs/AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
|
89
|
-
*BombBomb::AutomationsApi* | [**get_scheduling_status**](docs/AutomationsApi.md#get_scheduling_status) | **GET** /automation/{id}/scheduling/status | Get the number of pending scheduling calculations
|
90
|
-
*BombBomb::ContactsApi* | [**add_contacts_csv**](docs/ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
|
91
|
-
*BombBomb::ContactsApi* | [**add_new_contact**](docs/ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
|
92
|
-
*BombBomb::ContactsApi* | [**add_new_custom_field**](docs/ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
|
93
|
-
*BombBomb::ContactsApi* | [**add_pasted_contacts**](docs/ContactsApi.md#add_pasted_contacts) | **POST** /contacts/paste | Add pasted contacts.
|
94
|
-
*BombBomb::ContactsApi* | [**c_sv_to_object**](docs/ContactsApi.md#c_sv_to_object) | **POST** /csv-to-object | Format CSV.
|
95
|
-
*BombBomb::ContactsApi* | [**delete_contacts**](docs/ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
|
96
|
-
*BombBomb::ContactsApi* | [**get_contact_by_id**](docs/ContactsApi.md#get_contact_by_id) | **GET** /contact/{id} | Get Contact Details
|
97
|
-
*BombBomb::ContactsApi* | [**get_custom_fields**](docs/ContactsApi.md#get_custom_fields) | **GET** /contacts/custom_fields/ | Get custom fields.
|
98
|
-
*BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
|
99
|
-
*BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
|
100
|
-
*BombBomb::EmailsApi* | [**create_printing_press_email**](docs/EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
|
101
|
-
*BombBomb::EmailsApi* | [**get_all_templates_for_current_user**](docs/EmailsApi.md#get_all_templates_for_current_user) | **GET** /emails/templates | Get all user templates
|
102
|
-
*BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
|
103
|
-
*BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
|
104
|
-
*BombBomb::EmailsApi* | [**get_hourly_email_tracking**](docs/EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
|
105
|
-
*BombBomb::EmailsApi* | [**get_live_fire_data**](docs/EmailsApi.md#get_live_fire_data) | **GET** /emails/livefire | Get livefire feed data
|
106
|
-
*BombBomb::EmailsApi* | [**get_quick_send_templates**](docs/EmailsApi.md#get_quick_send_templates) | **GET** /emails/quicksend/templates | Get all quicksend templates
|
107
|
-
*BombBomb::EmailsApi* | [**get_template_html_for_template_id**](docs/EmailsApi.md#get_template_html_for_template_id) | **GET** /emails/templates/{templateId}/html | Get the HTML for a given template
|
108
|
-
*BombBomb::EmailsApi* | [**get_video_quick_sender_data**](docs/EmailsApi.md#get_video_quick_sender_data) | **GET** /emails/quicksend | Get quicksend data
|
109
|
-
*BombBomb::EmailsApi* | [**save_quick_sender_settings**](docs/EmailsApi.md#save_quick_sender_settings) | **POST** /emails/quicksend/settings | Save quicksender settings
|
110
|
-
*BombBomb::EmailsApi* | [**video_quick_sender**](docs/EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
|
111
|
-
*BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files/{docId} | Delete file
|
112
|
-
*BombBomb::FilesApi* | [**doc_host_get**](docs/FilesApi.md#doc_host_get) | **GET** /files/{docId} | Get file
|
113
|
-
*BombBomb::FilesApi* | [**doc_host_list**](docs/FilesApi.md#doc_host_list) | **GET** /files | List all files
|
114
|
-
*BombBomb::FilesApi* | [**doc_host_upload_v2**](docs/FilesApi.md#doc_host_upload_v2) | **POST** /files | Upload a file
|
115
|
-
*BombBomb::FilesApi* | [**get_hosted_images_paged**](docs/FilesApi.md#get_hosted_images_paged) | **GET** /files/images/paged | Get paged hosted images
|
116
|
-
*BombBomb::FormsApi* | [**get_form_tracking_as_csv**](docs/FormsApi.md#get_form_tracking_as_csv) | **GET** /forms/{id}/tracking/export | Get csv
|
117
|
-
*BombBomb::IntegrationsApi* | [**connect_integration**](docs/IntegrationsApi.md#connect_integration) | **POST** /integrations | Activate an integration for a user.
|
118
|
-
*BombBomb::IntegrationsApi* | [**delete_integration**](docs/IntegrationsApi.md#delete_integration) | **DELETE** /integrations | Remove an integration for a user.
|
119
|
-
*BombBomb::IntegrationsApi* | [**get_integration_health**](docs/IntegrationsApi.md#get_integration_health) | **GET** /integrations/health/{code} | Get health for a given integration
|
120
|
-
*BombBomb::IntegrationsApi* | [**get_integration_page_components**](docs/IntegrationsApi.md#get_integration_page_components) | **GET** /integrations/pageComponents | Get page components for a given integration
|
121
|
-
*BombBomb::IntegrationsApi* | [**sync_users_integrated_lists**](docs/IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
|
122
|
-
*BombBomb::ListsApi* | [**add_new_list**](docs/ListsApi.md#add_new_list) | **POST** /lists/ | Add list.
|
123
|
-
*BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
|
124
|
-
*BombBomb::ListsApi* | [**copy_list_contacts**](docs/ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
|
125
|
-
*BombBomb::ListsApi* | [**get_all_lists**](docs/ListsApi.md#get_all_lists) | **GET** /lists/ | Get all Lists
|
126
|
-
*BombBomb::ListsApi* | [**suppress_all_in_list**](docs/ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
|
127
|
-
*BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
|
128
|
-
*BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
|
129
85
|
*BombBomb::PromptsApi* | [**create_video_email_prompt**](docs/PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
|
130
|
-
*BombBomb::PromptsApi* | [**get_alternate_campaign_content**](docs/PromptsApi.md#get_alternate_campaign_content) | **GET** /campaign/{campaignId}/content/alternate | List alternate campaign content
|
131
|
-
*BombBomb::PromptsApi* | [**get_pending_video_email_prompts**](docs/PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
|
132
|
-
*BombBomb::PromptsApi* | [**get_prompt_bots**](docs/PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
|
133
|
-
*BombBomb::PromptsApi* | [**get_prompt_campaigns**](docs/PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/{userId}/campaigns | List Prompt Campaigns
|
134
86
|
*BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
|
135
|
-
*BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
|
136
87
|
*BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
|
137
|
-
*BombBomb::PromptsApi* | [**send_prompt_immediately**](docs/PromptsApi.md#send_prompt_immediately) | **POST** /prompt/{id}/sendit |
|
138
|
-
*BombBomb::PromptsApi* | [**sync_prompt_subscriptions**](docs/PromptsApi.md#sync_prompt_subscriptions) | **POST** /prompts/campaigns/sync | Syncs Campaigns and One to Ones Subscriptions for User
|
139
|
-
*BombBomb::PromptsApi* | [**update_prompt**](docs/PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
|
140
|
-
*BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
|
141
|
-
*BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{clientGroupId} | Update Prompt Campaign
|
142
|
-
*BombBomb::PromptsApi* | [**update_prompt_template**](docs/PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
|
143
|
-
*BombBomb::SocialsApi* | [**get_facebook_pages**](docs/SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
|
144
|
-
*BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
|
145
|
-
*BombBomb::SocialsApi* | [**get_social_authorizations**](docs/SocialsApi.md#get_social_authorizations) | **GET** /socials/authorizations | Get authorizations for all social integration
|
146
|
-
*BombBomb::SocialsApi* | [**get_social_profile_properties**](docs/SocialsApi.md#get_social_profile_properties) | **GET** /socials/profile | Gets the profile properties
|
147
|
-
*BombBomb::SocialsApi* | [**get_social_stats**](docs/SocialsApi.md#get_social_stats) | **GET** /socials/{promptId}/stats | Get social stats for a prompt
|
148
|
-
*BombBomb::SocialsApi* | [**post_social_content**](docs/SocialsApi.md#post_social_content) | **POST** /socials/content | Creates social content
|
149
|
-
*BombBomb::SocialsApi* | [**retry_social_send**](docs/SocialsApi.md#retry_social_send) | **POST** /socials/send/retry | Sends social content
|
150
|
-
*BombBomb::SocialsApi* | [**send_social**](docs/SocialsApi.md#send_social) | **POST** /socials/send | Sends social content
|
151
|
-
*BombBomb::SocialsApi* | [**update_client_group_send_mechanism**](docs/SocialsApi.md#update_client_group_send_mechanism) | **PUT** /socials/client/sendMechanism | Gets the auto shares from the client group assoc id
|
152
|
-
*BombBomb::SocialsApi* | [**update_client_groups_send_mechanism**](docs/SocialsApi.md#update_client_groups_send_mechanism) | **PUT** /socials/client/sendMechanisms | Toggles the prompt campaigns in a users account
|
153
|
-
*BombBomb::SocialsApi* | [**update_facebook_pages**](docs/SocialsApi.md#update_facebook_pages) | **PUT** /socials/facebook/pages | Updates facebook page Ids
|
154
|
-
*BombBomb::SocialsApi* | [**update_social_content**](docs/SocialsApi.md#update_social_content) | **PUT** /socials/content | Updates social content
|
155
|
-
*BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
|
156
|
-
*BombBomb::TeamsApi* | [**add_users**](docs/TeamsApi.md#add_users) | **POST** /team/{teamId}/members | Add users to group.
|
157
|
-
*BombBomb::TeamsApi* | [**add_users_from_csv**](docs/TeamsApi.md#add_users_from_csv) | **POST** /team/{teamId}/members/csv | Add members to group from CSV
|
158
88
|
*BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
|
159
|
-
*BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
|
160
|
-
*BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
161
|
-
*BombBomb::TeamsApi* | [**get_all_client_group_associations**](docs/TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
|
162
89
|
*BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
|
163
|
-
*BombBomb::TeamsApi* | [**get_client_group_statistics**](docs/TeamsApi.md#get_client_group_statistics) | **GET** /team/{teamId}/stats | Get Team statistics
|
164
90
|
*BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
165
91
|
*BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
166
|
-
*BombBomb::TeamsApi* | [**get_paged_client_group_members**](docs/TeamsApi.md#get_paged_client_group_members) | **GET** /team/{teamId}/members | List Team Members
|
167
|
-
*BombBomb::TeamsApi* | [**get_prompt_monthly_stats**](docs/TeamsApi.md#get_prompt_monthly_stats) | **GET** /team/{month}/{year}/monthStats | Jericho Monthly Stats
|
168
|
-
*BombBomb::TeamsApi* | [**get_prompt_overview**](docs/TeamsApi.md#get_prompt_overview) | **GET** /team/promptOverview | Get Prompt Overview
|
169
|
-
*BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
170
|
-
*BombBomb::TeamsApi* | [**get_team_prompt_aggregate_stats**](docs/TeamsApi.md#get_team_prompt_aggregate_stats) | **GET** /team/{clientGroupId}/campaign/stats | Get aggregate stats for campaigns
|
171
|
-
*BombBomb::TeamsApi* | [**get_team_prompt_campaigns**](docs/TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
|
172
|
-
*BombBomb::TeamsApi* | [**invite_to_social_prompt_team**](docs/TeamsApi.md#invite_to_social_prompt_team) | **POST** /teams/prompt/invite | Invite a list to join the admin's social prompt team
|
173
92
|
*BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
174
|
-
*BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
175
|
-
*BombBomb::TeamsApi* | [**resend_team_member_invitation**](docs/TeamsApi.md#resend_team_member_invitation) | **POST** /team/{teamId}/{memberUserId}/rewelcome | Resend invite
|
176
|
-
*BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
|
177
|
-
*BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
178
|
-
*BombBomb::TeamsApi* | [**update_team_member**](docs/TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
|
179
|
-
*BombBomb::UsersApi* | [**get_client_contact_information**](docs/UsersApi.md#get_client_contact_information) | **GET** /clients/contact/information | Get client contact information.
|
180
|
-
*BombBomb::UsersApi* | [**get_user_profile_info**](docs/UsersApi.md#get_user_profile_info) | **GET** /users/profile/information | Get user profile information.
|
181
93
|
*BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
|
182
94
|
*BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
|
183
95
|
*BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
|
184
96
|
*BombBomb::UtilitiesApi* | [**get_spec**](docs/UtilitiesApi.md#get_spec) | **GET** /spec | Describes this api
|
185
|
-
*BombBomb::VideosApi* | [**get_video_encoding_status**](docs/VideosApi.md#get_video_encoding_status) | **GET** /videos/{videoId}/status | Video Encoding Status
|
186
|
-
*BombBomb::VideosApi* | [**get_video_recorder**](docs/VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
|
187
|
-
*BombBomb::VideosApi* | [**mark_live_recording_complete**](docs/VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
|
188
|
-
*BombBomb::VideosApi* | [**sign_upload**](docs/VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
|
189
|
-
*BombBomb::VideosApi* | [**update_video_thumbnail_v2**](docs/VideosApi.md#update_video_thumbnail_v2) | **PUT** /videos/thumbnail | Upload thumbnail
|
190
97
|
*BombBomb::WebhooksApi* | [**add_web_hook**](docs/WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
|
191
98
|
*BombBomb::WebhooksApi* | [**delete_web_hook**](docs/WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
|
192
99
|
*BombBomb::WebhooksApi* | [**get_web_hooks**](docs/WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
|
193
|
-
*BombBomb::WebhooksApi* | [**list_web_hook_events**](docs/WebhooksApi.md#list_web_hook_events) | **GET** /webhook/events | Describe WebHook Events
|
194
100
|
*BombBomb::WebhooksApi* | [**send_webhook_example**](docs/WebhooksApi.md#send_webhook_example) | **POST** /webhook/test | Sends test Webhook
|
195
101
|
|
196
102
|
|
197
103
|
## Documentation for Models
|
198
104
|
|
199
105
|
- [BombBomb::BBWebHook](docs/BBWebHook.md)
|
200
|
-
- [BombBomb::ClientGroupAssetMetaData](docs/ClientGroupAssetMetaData.md)
|
201
|
-
- [BombBomb::Curriculum](docs/Curriculum.md)
|
202
|
-
- [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
|
203
|
-
- [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
|
204
|
-
- [BombBomb::HostedDoc](docs/HostedDoc.md)
|
205
106
|
- [BombBomb::InlineResponse200](docs/InlineResponse200.md)
|
107
|
+
- [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
|
206
108
|
- [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
|
207
109
|
- [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
|
208
110
|
- [BombBomb::OAuthClient](docs/OAuthClient.md)
|
209
|
-
- [BombBomb::PromptBot](docs/PromptBot.md)
|
210
|
-
- [BombBomb::PromptMonthlyPerformance](docs/PromptMonthlyPerformance.md)
|
211
|
-
- [BombBomb::PromptOverview](docs/PromptOverview.md)
|
212
|
-
- [BombBomb::PromptSocialPrompt](docs/PromptSocialPrompt.md)
|
213
|
-
- [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
|
214
|
-
- [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
|
215
111
|
- [BombBomb::String](docs/String.md)
|
216
|
-
- [BombBomb::TeamPublicRepresentation](docs/TeamPublicRepresentation.md)
|
217
112
|
- [BombBomb::VideoEmailPrompt](docs/VideoEmailPrompt.md)
|
218
|
-
- [BombBomb::VideoEncodingStatusResponse](docs/VideoEncodingStatusResponse.md)
|
219
|
-
- [BombBomb::VideoPublicRepresentation](docs/VideoPublicRepresentation.md)
|
220
|
-
- [BombBomb::VideoRecorderMethodResponse](docs/VideoRecorderMethodResponse.md)
|
221
113
|
|
222
114
|
|
223
115
|
## Documentation for Authorization
|
@@ -229,27 +121,19 @@ Class | Method | HTTP request | Description
|
|
229
121
|
- **Flow**: implicit
|
230
122
|
- **Authorization URL**: https://app.bombbomb.com/auth/authorize
|
231
123
|
- **Scopes**:
|
232
|
-
- all:manage:
|
233
|
-
- all:read:
|
234
|
-
- email:manage:
|
235
|
-
- email:read:
|
236
|
-
- video:manage:
|
237
|
-
- video:read:
|
238
|
-
- contact:manage:
|
239
|
-
- contact:read:
|
240
|
-
-
|
241
|
-
-
|
242
|
-
-
|
243
|
-
-
|
244
|
-
-
|
245
|
-
-
|
246
|
-
-
|
247
|
-
- team:manage: View & Manage your BombBomb teams
|
248
|
-
- team:read: View your BombBomb teams
|
249
|
-
- order:manage: Manage your BombBomb orders
|
250
|
-
- settings:manage: Manage your BombBomb settings
|
251
|
-
- file:manage: View & Manage your BombBomb files
|
252
|
-
- file:read: View your BombBomb files
|
253
|
-
- account:manage: View & Manage your BombBomb account
|
254
|
-
- account:read: View your BombBomb account
|
124
|
+
- all:manage: Manage All
|
125
|
+
- all:read: Read All
|
126
|
+
- email:manage: Manage Email
|
127
|
+
- email:read: Read Email
|
128
|
+
- video:manage: Manage Video
|
129
|
+
- video:read: Read Video
|
130
|
+
- contact:manage: Manage Contact
|
131
|
+
- contact:read: Read Contact
|
132
|
+
- automation:manage: Manage Automation
|
133
|
+
- automation:read: Read Automation
|
134
|
+
- form:manage: Manage Form
|
135
|
+
- form:read: Read Form
|
136
|
+
- team:manage: Manage Team
|
137
|
+
- team:read: Read Team
|
138
|
+
- settings:manage: Manage Settings
|
255
139
|
|
data/Rakefile
CHANGED
data/bombbomb.gemspec
CHANGED
@@ -5,10 +5,21 @@
|
|
5
5
|
|
6
6
|
#We make it easy to build relationships using simple videos.
|
7
7
|
|
8
|
-
OpenAPI spec version: 2.0.
|
8
|
+
OpenAPI spec version: 2.0.20679
|
9
9
|
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
-
|
11
|
+
|
12
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
13
|
+
you may not use this file except in compliance with the License.
|
14
|
+
You may obtain a copy of the License at
|
15
|
+
|
16
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
17
|
+
|
18
|
+
Unless required by applicable law or agreed to in writing, software
|
19
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
20
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
21
|
+
See the License for the specific language governing permissions and
|
22
|
+
limitations under the License.
|
12
23
|
|
13
24
|
=end
|
14
25
|
|
@@ -24,20 +35,18 @@ Gem::Specification.new do |s|
|
|
24
35
|
s.homepage = "http://developer.bombbomb.com"
|
25
36
|
s.summary = "A ruby wrapper for BombBomb's API"
|
26
37
|
s.description = "We make it easy to build relationships using simple videos."
|
27
|
-
|
28
|
-
#s.license = "Apache 2.0"
|
29
|
-
s.required_ruby_version = ">= 1.9"
|
38
|
+
s.license = "Apache 2.0"
|
30
39
|
|
31
40
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
32
|
-
s.add_runtime_dependency 'json', '~>
|
41
|
+
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
33
42
|
|
34
|
-
s.add_development_dependency 'rspec', '~> 3.
|
43
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
35
44
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
36
45
|
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
37
46
|
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
38
47
|
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
39
48
|
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
40
|
-
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.
|
49
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
41
50
|
|
42
51
|
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
43
52
|
s.test_files = `find spec/*`.split("\n")
|
data/docs/InlineResponse200.md
CHANGED
@@ -4,6 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**total_pages** | **Integer** | | [optional]
|
7
|
-
**items** | [**Array<
|
7
|
+
**items** | [**Array<InlineResponse200Items>**](InlineResponse200Items.md) | | [optional]
|
8
8
|
|
9
9
|
|
@@ -6,19 +6,13 @@ Name | Type | Description | Notes
|
|
6
6
|
**id** | **String** | | [optional]
|
7
7
|
**client_group_id** | **String** | | [optional]
|
8
8
|
**send_date** | **DateTime** | When the email should be sent. | [optional]
|
9
|
-
**is_prompt** | **BOOLEAN** |
|
10
|
-
**print_to_template** | **BOOLEAN** | Controls whether or not the content is printed into a template. | [optional]
|
9
|
+
**is_prompt** | **BOOLEAN** | Determines whether this is a static or prompted send. |
|
11
10
|
**email_id** | **String** | Static send: The Email to send on behalf of the group members. | [optional]
|
12
|
-
**example_video_id** | **String** | Video Prompt: The Video to include as an example for prompted users. | [optional]
|
13
|
-
**follow_up_video_id** | **String** | The Video to include in the tracking follow up. | [optional]
|
14
|
-
**prompt_intro** | **String** | Video Prompt: The intro text directed toward prompted users. | [optional]
|
15
11
|
**prompt_subject** | **String** | Video Prompt: The subject line prompting the user to record a video. | [optional]
|
16
12
|
**prompt_body** | **String** | Video Prompt: The HTML body of the email prompting the user to record a video. | [optional]
|
17
13
|
**email_subject** | **String** | Video Prompt: The subject line of the final sent email | [optional]
|
18
14
|
**email_body** | **String** | Video Prompt: The HTML body of the final sent email. | [optional]
|
19
15
|
**send_without_video** | **BOOLEAN** | Video Prompt: Whether to send the final email if no video was recorded. | [optional]
|
20
16
|
**status** | **String** | The state of the send. | [optional]
|
21
|
-
**media_type** | **String** | The type of media used for a social send | [optional]
|
22
|
-
**custom_initial_email_subject_line** | **String** | The custom subject line for the prompt initial email | [optional]
|
23
17
|
|
24
18
|
|
data/docs/JerichoPerformance.md
CHANGED
@@ -3,7 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**jericho_id** | **Integer** | The jericho id | [optional]
|
7
6
|
**sent** | **Integer** | The number of emails sent | [optional]
|
8
7
|
**unique_views** | **Integer** | The unique number of people that viewed the email | [optional]
|
9
8
|
**unique_landing_page_views** | **Integer** | The unique number of people that visited the landing page | [optional]
|
@@ -15,8 +14,5 @@ Name | Type | Description | Notes
|
|
15
14
|
**video_play** | **Integer** | The total number of times videos in the emails were played | [optional]
|
16
15
|
**abuse_complaints** | **Integer** | The number of recipients that marked the message as abusive | [optional]
|
17
16
|
**contacts** | **Integer** | The total number of contacts submitted to be sent, may be more than was sent to | [optional]
|
18
|
-
**prompts_sent** | **Integer** | The total number of prompts sent to members of the client group | [optional]
|
19
|
-
**prompts_with_recordings** | **Integer** | The total number of prompts sent that included a personal recording | [optional]
|
20
|
-
**prompts_opted_out** | **Integer** | The total number of members that chose not to send a prompt | [optional]
|
21
17
|
|
22
18
|
|
data/docs/PromptsApi.md
CHANGED
@@ -4,99 +4,9 @@ All URIs are relative to *https://api.bombbomb.com/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_prompt_bot**](PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
|
8
7
|
[**create_video_email_prompt**](PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
|
9
|
-
[**get_alternate_campaign_content**](PromptsApi.md#get_alternate_campaign_content) | **GET** /campaign/{campaignId}/content/alternate | List alternate campaign content
|
10
|
-
[**get_pending_video_email_prompts**](PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
|
11
|
-
[**get_prompt_bots**](PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
|
12
|
-
[**get_prompt_campaigns**](PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/{userId}/campaigns | List Prompt Campaigns
|
13
8
|
[**get_video_email_prompt**](PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
|
14
|
-
[**get_video_email_prompts**](PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
|
15
9
|
[**respond_to_video_email_prompt**](PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
|
16
|
-
[**send_prompt_immediately**](PromptsApi.md#send_prompt_immediately) | **POST** /prompt/{id}/sendit |
|
17
|
-
[**sync_prompt_subscriptions**](PromptsApi.md#sync_prompt_subscriptions) | **POST** /prompts/campaigns/sync | Syncs Campaigns and One to Ones Subscriptions for User
|
18
|
-
[**update_prompt**](PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
|
19
|
-
[**update_prompt_bot**](PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
|
20
|
-
[**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{clientGroupId} | Update Prompt Campaign
|
21
|
-
[**update_prompt_template**](PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
|
22
|
-
|
23
|
-
|
24
|
-
# **create_prompt_bot**
|
25
|
-
> PromptBot create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
|
26
|
-
|
27
|
-
Create a running Prompt Bot for a list
|
28
|
-
|
29
|
-
Creates a Prompt Bot that sends emails to contacts on a list over the span of time defined.
|
30
|
-
|
31
|
-
### Example
|
32
|
-
```ruby
|
33
|
-
# load the gem
|
34
|
-
require 'bombbomb'
|
35
|
-
# setup authorization
|
36
|
-
BombBomb.configure do |config|
|
37
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
38
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
39
|
-
end
|
40
|
-
|
41
|
-
api_instance = BombBomb::PromptsApi.new
|
42
|
-
|
43
|
-
email_id = "email_id_example" # String | The default email to use.
|
44
|
-
|
45
|
-
name = "name_example" # String | The name of the bot.
|
46
|
-
|
47
|
-
subject = "subject_example" # String | The subject of the default email.
|
48
|
-
|
49
|
-
content = "content_example" # String | The content used in the email.
|
50
|
-
|
51
|
-
contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.
|
52
|
-
|
53
|
-
bot_type_id = "bot_type_id_example" # String | The type of bot to create.
|
54
|
-
|
55
|
-
template_id = "template_id_example" # String | The template used to create the email id.
|
56
|
-
|
57
|
-
opts = {
|
58
|
-
list_id: "list_id_example", # String | The list id to attach the bot to.
|
59
|
-
video_id: "video_id_example", # String | The video used in the email.
|
60
|
-
end_date: "end_date_example" # String | The time frame to complete sending to the list.
|
61
|
-
}
|
62
|
-
|
63
|
-
begin
|
64
|
-
#Create a running Prompt Bot for a list
|
65
|
-
result = api_instance.create_prompt_bot(email_id, name, subject, content, contact_field_value_column, bot_type_id, template_id, opts)
|
66
|
-
p result
|
67
|
-
rescue BombBomb::ApiError => e
|
68
|
-
puts "Exception when calling PromptsApi->create_prompt_bot: #{e}"
|
69
|
-
end
|
70
|
-
```
|
71
|
-
|
72
|
-
### Parameters
|
73
|
-
|
74
|
-
Name | Type | Description | Notes
|
75
|
-
------------- | ------------- | ------------- | -------------
|
76
|
-
**email_id** | **String**| The default email to use. |
|
77
|
-
**name** | **String**| The name of the bot. |
|
78
|
-
**subject** | **String**| The subject of the default email. |
|
79
|
-
**content** | **String**| The content used in the email. |
|
80
|
-
**contact_field_value_column** | **String**| The custom field value column with dates for this bot. |
|
81
|
-
**bot_type_id** | **String**| The type of bot to create. |
|
82
|
-
**template_id** | **String**| The template used to create the email id. |
|
83
|
-
**list_id** | **String**| The list id to attach the bot to. | [optional]
|
84
|
-
**video_id** | **String**| The video used in the email. | [optional]
|
85
|
-
**end_date** | **String**| The time frame to complete sending to the list. | [optional]
|
86
|
-
|
87
|
-
### Return type
|
88
|
-
|
89
|
-
[**PromptBot**](PromptBot.md)
|
90
|
-
|
91
|
-
### Authorization
|
92
|
-
|
93
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
94
|
-
|
95
|
-
### HTTP request headers
|
96
|
-
|
97
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
98
|
-
- **Accept**: application/json
|
99
|
-
|
100
10
|
|
101
11
|
|
102
12
|
# **create_video_email_prompt**
|
@@ -146,195 +56,7 @@ Name | Type | Description | Notes
|
|
146
56
|
|
147
57
|
### HTTP request headers
|
148
58
|
|
149
|
-
- **Content-Type**:
|
150
|
-
- **Accept**: application/json
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
# **get_alternate_campaign_content**
|
155
|
-
> get_alternate_campaign_content(client_group_id)
|
156
|
-
|
157
|
-
List alternate campaign content
|
158
|
-
|
159
|
-
Returns a list of alternate campaign content by campaign id
|
160
|
-
|
161
|
-
### Example
|
162
|
-
```ruby
|
163
|
-
# load the gem
|
164
|
-
require 'bombbomb'
|
165
|
-
# setup authorization
|
166
|
-
BombBomb.configure do |config|
|
167
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
168
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
169
|
-
end
|
170
|
-
|
171
|
-
api_instance = BombBomb::PromptsApi.new
|
172
|
-
|
173
|
-
client_group_id = "client_group_id_example" # String | Id for the campaign
|
174
|
-
|
175
|
-
|
176
|
-
begin
|
177
|
-
#List alternate campaign content
|
178
|
-
api_instance.get_alternate_campaign_content(client_group_id)
|
179
|
-
rescue BombBomb::ApiError => e
|
180
|
-
puts "Exception when calling PromptsApi->get_alternate_campaign_content: #{e}"
|
181
|
-
end
|
182
|
-
```
|
183
|
-
|
184
|
-
### Parameters
|
185
|
-
|
186
|
-
Name | Type | Description | Notes
|
187
|
-
------------- | ------------- | ------------- | -------------
|
188
|
-
**client_group_id** | **String**| Id for the campaign |
|
189
|
-
|
190
|
-
### Return type
|
191
|
-
|
192
|
-
nil (empty response body)
|
193
|
-
|
194
|
-
### Authorization
|
195
|
-
|
196
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
197
|
-
|
198
|
-
### HTTP request headers
|
199
|
-
|
200
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
201
|
-
- **Accept**: application/json
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
# **get_pending_video_email_prompts**
|
206
|
-
> Array<VideoEmailPrompt> get_pending_video_email_prompts
|
207
|
-
|
208
|
-
List pending prompts
|
209
|
-
|
210
|
-
Returns a list of prompts that have not been sent yet, and can still be customized.
|
211
|
-
|
212
|
-
### Example
|
213
|
-
```ruby
|
214
|
-
# load the gem
|
215
|
-
require 'bombbomb'
|
216
|
-
# setup authorization
|
217
|
-
BombBomb.configure do |config|
|
218
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
219
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
220
|
-
end
|
221
|
-
|
222
|
-
api_instance = BombBomb::PromptsApi.new
|
223
|
-
|
224
|
-
begin
|
225
|
-
#List pending prompts
|
226
|
-
result = api_instance.get_pending_video_email_prompts
|
227
|
-
p result
|
228
|
-
rescue BombBomb::ApiError => e
|
229
|
-
puts "Exception when calling PromptsApi->get_pending_video_email_prompts: #{e}"
|
230
|
-
end
|
231
|
-
```
|
232
|
-
|
233
|
-
### Parameters
|
234
|
-
This endpoint does not need any parameter.
|
235
|
-
|
236
|
-
### Return type
|
237
|
-
|
238
|
-
[**Array<VideoEmailPrompt>**](VideoEmailPrompt.md)
|
239
|
-
|
240
|
-
### Authorization
|
241
|
-
|
242
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
243
|
-
|
244
|
-
### HTTP request headers
|
245
|
-
|
246
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
247
|
-
- **Accept**: application/json
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
# **get_prompt_bots**
|
252
|
-
> Array<PromptBot> get_prompt_bots
|
253
|
-
|
254
|
-
List Prompt Bots
|
255
|
-
|
256
|
-
Returns a list of all Prompt Bots for the user.
|
257
|
-
|
258
|
-
### Example
|
259
|
-
```ruby
|
260
|
-
# load the gem
|
261
|
-
require 'bombbomb'
|
262
|
-
# setup authorization
|
263
|
-
BombBomb.configure do |config|
|
264
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
265
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
266
|
-
end
|
267
|
-
|
268
|
-
api_instance = BombBomb::PromptsApi.new
|
269
|
-
|
270
|
-
begin
|
271
|
-
#List Prompt Bots
|
272
|
-
result = api_instance.get_prompt_bots
|
273
|
-
p result
|
274
|
-
rescue BombBomb::ApiError => e
|
275
|
-
puts "Exception when calling PromptsApi->get_prompt_bots: #{e}"
|
276
|
-
end
|
277
|
-
```
|
278
|
-
|
279
|
-
### Parameters
|
280
|
-
This endpoint does not need any parameter.
|
281
|
-
|
282
|
-
### Return type
|
283
|
-
|
284
|
-
[**Array<PromptBot>**](PromptBot.md)
|
285
|
-
|
286
|
-
### Authorization
|
287
|
-
|
288
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
289
|
-
|
290
|
-
### HTTP request headers
|
291
|
-
|
292
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
293
|
-
- **Accept**: application/json
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
# **get_prompt_campaigns**
|
298
|
-
> get_prompt_campaigns
|
299
|
-
|
300
|
-
List Prompt Campaigns
|
301
|
-
|
302
|
-
Returns a list of all Prompt Campaigns for the user.
|
303
|
-
|
304
|
-
### Example
|
305
|
-
```ruby
|
306
|
-
# load the gem
|
307
|
-
require 'bombbomb'
|
308
|
-
# setup authorization
|
309
|
-
BombBomb.configure do |config|
|
310
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
311
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
312
|
-
end
|
313
|
-
|
314
|
-
api_instance = BombBomb::PromptsApi.new
|
315
|
-
|
316
|
-
begin
|
317
|
-
#List Prompt Campaigns
|
318
|
-
api_instance.get_prompt_campaigns
|
319
|
-
rescue BombBomb::ApiError => e
|
320
|
-
puts "Exception when calling PromptsApi->get_prompt_campaigns: #{e}"
|
321
|
-
end
|
322
|
-
```
|
323
|
-
|
324
|
-
### Parameters
|
325
|
-
This endpoint does not need any parameter.
|
326
|
-
|
327
|
-
### Return type
|
328
|
-
|
329
|
-
nil (empty response body)
|
330
|
-
|
331
|
-
### Authorization
|
332
|
-
|
333
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
334
|
-
|
335
|
-
### HTTP request headers
|
336
|
-
|
337
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
59
|
+
- **Content-Type**: Not defined
|
338
60
|
- **Accept**: application/json
|
339
61
|
|
340
62
|
|
@@ -386,53 +108,7 @@ Name | Type | Description | Notes
|
|
386
108
|
|
387
109
|
### HTTP request headers
|
388
110
|
|
389
|
-
- **Content-Type**:
|
390
|
-
- **Accept**: application/json
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
# **get_video_email_prompts**
|
395
|
-
> Array<VideoEmailPrompt> get_video_email_prompts
|
396
|
-
|
397
|
-
List prompts
|
398
|
-
|
399
|
-
Returns a list of all prompts.
|
400
|
-
|
401
|
-
### Example
|
402
|
-
```ruby
|
403
|
-
# load the gem
|
404
|
-
require 'bombbomb'
|
405
|
-
# setup authorization
|
406
|
-
BombBomb.configure do |config|
|
407
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
408
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
409
|
-
end
|
410
|
-
|
411
|
-
api_instance = BombBomb::PromptsApi.new
|
412
|
-
|
413
|
-
begin
|
414
|
-
#List prompts
|
415
|
-
result = api_instance.get_video_email_prompts
|
416
|
-
p result
|
417
|
-
rescue BombBomb::ApiError => e
|
418
|
-
puts "Exception when calling PromptsApi->get_video_email_prompts: #{e}"
|
419
|
-
end
|
420
|
-
```
|
421
|
-
|
422
|
-
### Parameters
|
423
|
-
This endpoint does not need any parameter.
|
424
|
-
|
425
|
-
### Return type
|
426
|
-
|
427
|
-
[**Array<VideoEmailPrompt>**](VideoEmailPrompt.md)
|
428
|
-
|
429
|
-
### Authorization
|
430
|
-
|
431
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
432
|
-
|
433
|
-
### HTTP request headers
|
434
|
-
|
435
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
111
|
+
- **Content-Type**: Not defined
|
436
112
|
- **Accept**: application/json
|
437
113
|
|
438
114
|
|
@@ -453,12 +129,10 @@ api_instance = BombBomb::PromptsApi.new
|
|
453
129
|
|
454
130
|
id = "id_example" # String | The id of the prompt.
|
455
131
|
|
456
|
-
choice = "choice_example" # String | The users' selection. Can be: WithVideo,
|
132
|
+
choice = "choice_example" # String | The users' selection. Can be: WithVideo, WithoutVideo, Cancel
|
457
133
|
|
458
134
|
opts = {
|
459
|
-
video_id: "video_id_example"
|
460
|
-
email_id: "email_id_example", # String | The id of the email.
|
461
|
-
subject: "subject_example" # String | The subject of the email
|
135
|
+
video_id: "video_id_example" # String | The id of the video.
|
462
136
|
}
|
463
137
|
|
464
138
|
begin
|
@@ -475,10 +149,8 @@ end
|
|
475
149
|
Name | Type | Description | Notes
|
476
150
|
------------- | ------------- | ------------- | -------------
|
477
151
|
**id** | **String**| The id of the prompt. |
|
478
|
-
**choice** | **String**| The users' selection. Can be: WithVideo,
|
152
|
+
**choice** | **String**| The users' selection. Can be: WithVideo, WithoutVideo, Cancel |
|
479
153
|
**video_id** | **String**| The id of the video. | [optional]
|
480
|
-
**email_id** | **String**| The id of the email. | [optional]
|
481
|
-
**subject** | **String**| The subject of the email | [optional]
|
482
154
|
|
483
155
|
### Return type
|
484
156
|
|
@@ -490,385 +162,7 @@ No authorization required
|
|
490
162
|
|
491
163
|
### HTTP request headers
|
492
164
|
|
493
|
-
- **Content-Type**:
|
494
|
-
- **Accept**: application/json
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
# **send_prompt_immediately**
|
499
|
-
> send_prompt_immediately(id)
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
Ignore send date and send the prompt now.
|
504
|
-
|
505
|
-
### Example
|
506
|
-
```ruby
|
507
|
-
# load the gem
|
508
|
-
require 'bombbomb'
|
509
|
-
# setup authorization
|
510
|
-
BombBomb.configure do |config|
|
511
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
512
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
513
|
-
end
|
514
|
-
|
515
|
-
api_instance = BombBomb::PromptsApi.new
|
516
|
-
|
517
|
-
id = "id_example" # String | The Id of the prompt
|
518
|
-
|
519
|
-
|
520
|
-
begin
|
521
|
-
#
|
522
|
-
api_instance.send_prompt_immediately(id)
|
523
|
-
rescue BombBomb::ApiError => e
|
524
|
-
puts "Exception when calling PromptsApi->send_prompt_immediately: #{e}"
|
525
|
-
end
|
526
|
-
```
|
527
|
-
|
528
|
-
### Parameters
|
529
|
-
|
530
|
-
Name | Type | Description | Notes
|
531
|
-
------------- | ------------- | ------------- | -------------
|
532
|
-
**id** | **String**| The Id of the prompt |
|
533
|
-
|
534
|
-
### Return type
|
535
|
-
|
536
|
-
nil (empty response body)
|
537
|
-
|
538
|
-
### Authorization
|
539
|
-
|
540
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
541
|
-
|
542
|
-
### HTTP request headers
|
543
|
-
|
544
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
545
|
-
- **Accept**: application/json
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
# **sync_prompt_subscriptions**
|
550
|
-
> sync_prompt_subscriptions(opts)
|
551
|
-
|
552
|
-
Syncs Campaigns and One to Ones Subscriptions for User
|
553
|
-
|
554
|
-
Syncs Campaigns and One to Ones Subscriptions for User based on their profile information. The user must be a Prompt Subscriber.
|
555
|
-
|
556
|
-
### Example
|
557
|
-
```ruby
|
558
|
-
# load the gem
|
559
|
-
require 'bombbomb'
|
560
|
-
# setup authorization
|
561
|
-
BombBomb.configure do |config|
|
562
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
563
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
564
|
-
end
|
565
|
-
|
566
|
-
api_instance = BombBomb::PromptsApi.new
|
567
|
-
|
568
|
-
opts = {
|
569
|
-
migrate: true # BOOLEAN | After syncing, migrate away from old campaigns.
|
570
|
-
}
|
571
|
-
|
572
|
-
begin
|
573
|
-
#Syncs Campaigns and One to Ones Subscriptions for User
|
574
|
-
api_instance.sync_prompt_subscriptions(opts)
|
575
|
-
rescue BombBomb::ApiError => e
|
576
|
-
puts "Exception when calling PromptsApi->sync_prompt_subscriptions: #{e}"
|
577
|
-
end
|
578
|
-
```
|
579
|
-
|
580
|
-
### Parameters
|
581
|
-
|
582
|
-
Name | Type | Description | Notes
|
583
|
-
------------- | ------------- | ------------- | -------------
|
584
|
-
**migrate** | **BOOLEAN**| After syncing, migrate away from old campaigns. | [optional]
|
585
|
-
|
586
|
-
### Return type
|
587
|
-
|
588
|
-
nil (empty response body)
|
589
|
-
|
590
|
-
### Authorization
|
591
|
-
|
592
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
593
|
-
|
594
|
-
### HTTP request headers
|
595
|
-
|
596
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
597
|
-
- **Accept**: application/json
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
# **update_prompt**
|
602
|
-
> update_prompt(id, opts)
|
603
|
-
|
604
|
-
Update Prompt
|
605
|
-
|
606
|
-
Updates a Prompt
|
607
|
-
|
608
|
-
### Example
|
609
|
-
```ruby
|
610
|
-
# load the gem
|
611
|
-
require 'bombbomb'
|
612
|
-
# setup authorization
|
613
|
-
BombBomb.configure do |config|
|
614
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
615
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
616
|
-
end
|
617
|
-
|
618
|
-
api_instance = BombBomb::PromptsApi.new
|
619
|
-
|
620
|
-
id = "id_example" # String | The prompt's id
|
621
|
-
|
622
|
-
opts = {
|
623
|
-
send_mechanism: "send_mechanism_example", # String | The mechanism for the prompt to be sent
|
624
|
-
facebook_message: "facebook_message_example", # String | The facebook message assigned to the prompt
|
625
|
-
twitter_message: "twitter_message_example", # String | The twitter message assigned to the prompt
|
626
|
-
video_id: "video_id_example", # String | The id of the video.
|
627
|
-
email_id: "email_id_example", # String | The id of the email.
|
628
|
-
subject: "subject_example", # String | The subject of the email
|
629
|
-
reset_cache: "reset_cache_example", # String | The subject of the email
|
630
|
-
reset_email_content: "reset_email_content_example", # String | The subject of the email
|
631
|
-
status: "status_example" # String | The status of the prompt
|
632
|
-
}
|
633
|
-
|
634
|
-
begin
|
635
|
-
#Update Prompt
|
636
|
-
api_instance.update_prompt(id, opts)
|
637
|
-
rescue BombBomb::ApiError => e
|
638
|
-
puts "Exception when calling PromptsApi->update_prompt: #{e}"
|
639
|
-
end
|
640
|
-
```
|
641
|
-
|
642
|
-
### Parameters
|
643
|
-
|
644
|
-
Name | Type | Description | Notes
|
645
|
-
------------- | ------------- | ------------- | -------------
|
646
|
-
**id** | **String**| The prompt's id |
|
647
|
-
**send_mechanism** | **String**| The mechanism for the prompt to be sent | [optional]
|
648
|
-
**facebook_message** | **String**| The facebook message assigned to the prompt | [optional]
|
649
|
-
**twitter_message** | **String**| The twitter message assigned to the prompt | [optional]
|
650
|
-
**video_id** | **String**| The id of the video. | [optional]
|
651
|
-
**email_id** | **String**| The id of the email. | [optional]
|
652
|
-
**subject** | **String**| The subject of the email | [optional]
|
653
|
-
**reset_cache** | **String**| The subject of the email | [optional]
|
654
|
-
**reset_email_content** | **String**| The subject of the email | [optional]
|
655
|
-
**status** | **String**| The status of the prompt | [optional]
|
656
|
-
|
657
|
-
### Return type
|
658
|
-
|
659
|
-
nil (empty response body)
|
660
|
-
|
661
|
-
### Authorization
|
662
|
-
|
663
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
664
|
-
|
665
|
-
### HTTP request headers
|
666
|
-
|
667
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
668
|
-
- **Accept**: application/json
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
# **update_prompt_bot**
|
673
|
-
> PromptBot update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
|
674
|
-
|
675
|
-
Update Prompt Bot
|
676
|
-
|
677
|
-
Updates a Prompt Bot's settings.
|
678
|
-
|
679
|
-
### Example
|
680
|
-
```ruby
|
681
|
-
# load the gem
|
682
|
-
require 'bombbomb'
|
683
|
-
# setup authorization
|
684
|
-
BombBomb.configure do |config|
|
685
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
686
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
687
|
-
end
|
688
|
-
|
689
|
-
api_instance = BombBomb::PromptsApi.new
|
690
|
-
|
691
|
-
id = "id_example" # String | The bot id.
|
692
|
-
|
693
|
-
email_id = "email_id_example" # String | The default email to use.
|
694
|
-
|
695
|
-
name = "name_example" # String | The name of the bot.
|
696
|
-
|
697
|
-
subject = "subject_example" # String | The subject of the default email.
|
698
|
-
|
699
|
-
content = "content_example" # String | The content used in the default email.
|
700
|
-
|
701
|
-
contact_field_value_column = "contact_field_value_column_example" # String | The custom field value column with dates for this bot.
|
702
|
-
|
703
|
-
template_id = "template_id_example" # String | The template used to create the email id.
|
704
|
-
|
705
|
-
opts = {
|
706
|
-
list_id: "list_id_example", # String | The list id to attach the bot to.
|
707
|
-
video_id: "video_id_example", # String | The video used in the default email.
|
708
|
-
end_date: "end_date_example", # String | The time frame to complete sending to the list.
|
709
|
-
status: "status_example" # String | The status of the bot.
|
710
|
-
}
|
711
|
-
|
712
|
-
begin
|
713
|
-
#Update Prompt Bot
|
714
|
-
result = api_instance.update_prompt_bot(id, email_id, name, subject, content, contact_field_value_column, template_id, opts)
|
715
|
-
p result
|
716
|
-
rescue BombBomb::ApiError => e
|
717
|
-
puts "Exception when calling PromptsApi->update_prompt_bot: #{e}"
|
718
|
-
end
|
719
|
-
```
|
720
|
-
|
721
|
-
### Parameters
|
722
|
-
|
723
|
-
Name | Type | Description | Notes
|
724
|
-
------------- | ------------- | ------------- | -------------
|
725
|
-
**id** | **String**| The bot id. |
|
726
|
-
**email_id** | **String**| The default email to use. |
|
727
|
-
**name** | **String**| The name of the bot. |
|
728
|
-
**subject** | **String**| The subject of the default email. |
|
729
|
-
**content** | **String**| The content used in the default email. |
|
730
|
-
**contact_field_value_column** | **String**| The custom field value column with dates for this bot. |
|
731
|
-
**template_id** | **String**| The template used to create the email id. |
|
732
|
-
**list_id** | **String**| The list id to attach the bot to. | [optional]
|
733
|
-
**video_id** | **String**| The video used in the default email. | [optional]
|
734
|
-
**end_date** | **String**| The time frame to complete sending to the list. | [optional]
|
735
|
-
**status** | **String**| The status of the bot. | [optional]
|
736
|
-
|
737
|
-
### Return type
|
738
|
-
|
739
|
-
[**PromptBot**](PromptBot.md)
|
740
|
-
|
741
|
-
### Authorization
|
742
|
-
|
743
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
744
|
-
|
745
|
-
### HTTP request headers
|
746
|
-
|
747
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
748
|
-
- **Accept**: application/json
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
# **update_prompt_campaign**
|
753
|
-
> update_prompt_campaign(client_group_id, opts)
|
754
|
-
|
755
|
-
Update Prompt Campaign
|
756
|
-
|
757
|
-
Updates a Prompt Campaign's Settings
|
758
|
-
|
759
|
-
### Example
|
760
|
-
```ruby
|
761
|
-
# load the gem
|
762
|
-
require 'bombbomb'
|
763
|
-
# setup authorization
|
764
|
-
BombBomb.configure do |config|
|
765
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
766
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
767
|
-
end
|
768
|
-
|
769
|
-
api_instance = BombBomb::PromptsApi.new
|
770
|
-
|
771
|
-
client_group_id = "client_group_id_example" # String | The client group of the campaign.
|
772
|
-
|
773
|
-
opts = {
|
774
|
-
branded_template_id: "branded_template_id_example", # String | The template to use for branded feel emails.
|
775
|
-
personal_template_id: "personal_template_id_example", # String | The template to use for personal feel emails.
|
776
|
-
enabled: true, # BOOLEAN | Set whether the user is able to start receiving prompts.
|
777
|
-
send_mechanism: "send_mechanism_example" # String | The way to send the prompt
|
778
|
-
}
|
779
|
-
|
780
|
-
begin
|
781
|
-
#Update Prompt Campaign
|
782
|
-
api_instance.update_prompt_campaign(client_group_id, opts)
|
783
|
-
rescue BombBomb::ApiError => e
|
784
|
-
puts "Exception when calling PromptsApi->update_prompt_campaign: #{e}"
|
785
|
-
end
|
786
|
-
```
|
787
|
-
|
788
|
-
### Parameters
|
789
|
-
|
790
|
-
Name | Type | Description | Notes
|
791
|
-
------------- | ------------- | ------------- | -------------
|
792
|
-
**client_group_id** | **String**| The client group of the campaign. |
|
793
|
-
**branded_template_id** | **String**| The template to use for branded feel emails. | [optional]
|
794
|
-
**personal_template_id** | **String**| The template to use for personal feel emails. | [optional]
|
795
|
-
**enabled** | **BOOLEAN**| Set whether the user is able to start receiving prompts. | [optional]
|
796
|
-
**send_mechanism** | **String**| The way to send the prompt | [optional]
|
797
|
-
|
798
|
-
### Return type
|
799
|
-
|
800
|
-
nil (empty response body)
|
801
|
-
|
802
|
-
### Authorization
|
803
|
-
|
804
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
805
|
-
|
806
|
-
### HTTP request headers
|
807
|
-
|
808
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
809
|
-
- **Accept**: application/json
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
# **update_prompt_template**
|
814
|
-
> update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)
|
815
|
-
|
816
|
-
Update Prompt Content
|
817
|
-
|
818
|
-
Updates a Prompt Content
|
819
|
-
|
820
|
-
### Example
|
821
|
-
```ruby
|
822
|
-
# load the gem
|
823
|
-
require 'bombbomb'
|
824
|
-
# setup authorization
|
825
|
-
BombBomb.configure do |config|
|
826
|
-
# Configure OAuth2 access token for authorization: BBOAuth2
|
827
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
828
|
-
end
|
829
|
-
|
830
|
-
api_instance = BombBomb::PromptsApi.new
|
831
|
-
|
832
|
-
id = "id_example" # String | The prompt's id
|
833
|
-
|
834
|
-
alternate_content_id = "alternate_content_id_example" # String | The alternate content id
|
835
|
-
|
836
|
-
new_email_id = "new_email_id_example" # String | The prompt's new email id
|
837
|
-
|
838
|
-
og_email_id = "og_email_id_example" # String | The prompt's original email id
|
839
|
-
|
840
|
-
new_example_video_id = "new_example_video_id_example" # String | The prompt's new tutorial video id
|
841
|
-
|
842
|
-
|
843
|
-
begin
|
844
|
-
#Update Prompt Content
|
845
|
-
api_instance.update_prompt_template(id, alternate_content_id, new_email_id, og_email_id, new_example_video_id)
|
846
|
-
rescue BombBomb::ApiError => e
|
847
|
-
puts "Exception when calling PromptsApi->update_prompt_template: #{e}"
|
848
|
-
end
|
849
|
-
```
|
850
|
-
|
851
|
-
### Parameters
|
852
|
-
|
853
|
-
Name | Type | Description | Notes
|
854
|
-
------------- | ------------- | ------------- | -------------
|
855
|
-
**id** | **String**| The prompt's id |
|
856
|
-
**alternate_content_id** | **String**| The alternate content id |
|
857
|
-
**new_email_id** | **String**| The prompt's new email id |
|
858
|
-
**og_email_id** | **String**| The prompt's original email id |
|
859
|
-
**new_example_video_id** | **String**| The prompt's new tutorial video id |
|
860
|
-
|
861
|
-
### Return type
|
862
|
-
|
863
|
-
nil (empty response body)
|
864
|
-
|
865
|
-
### Authorization
|
866
|
-
|
867
|
-
[BBOAuth2](../README.md#BBOAuth2)
|
868
|
-
|
869
|
-
### HTTP request headers
|
870
|
-
|
871
|
-
- **Content-Type**: application/x-www-form-urlencoded
|
165
|
+
- **Content-Type**: Not defined
|
872
166
|
- **Accept**: application/json
|
873
167
|
|
874
168
|
|