bombbomb 2.0.25797 → 2.0.25798
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +68 -33
- data/Rakefile +8 -3
- data/bombbomb.gemspec +8 -17
- data/docs/AccountsApi.md +164 -5
- data/docs/AutomationsApi.md +52 -0
- data/docs/ClientGroupAssetMetaData.md +11 -0
- data/docs/ContactsApi.md +9 -6
- data/docs/EmailsApi.md +220 -0
- data/docs/FormsApi.md +60 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/IntegrationsApi.md +223 -0
- data/docs/JerichoConfiguration.md +2 -0
- data/docs/PromptMonthlyPerformance.md +11 -0
- data/docs/PromptOverview.md +11 -0
- data/docs/PromptSocialPrompt.md +20 -0
- data/docs/PromptsApi.md +230 -3
- data/docs/SocialsApi.md +167 -2
- data/docs/TeamsApi.md +300 -16
- data/docs/UsersApi.md +100 -0
- data/docs/VideoEmailPrompt.md +15 -15
- data/git_push.sh +1 -13
- data/lib/bombbomb.rb +8 -14
- data/lib/bombbomb/api/accounts_api.rb +189 -51
- data/lib/bombbomb/api/automations_api.rb +71 -30
- data/lib/bombbomb/api/contacts_api.rb +58 -86
- data/lib/bombbomb/api/curriculum_api.rb +8 -27
- data/lib/bombbomb/api/emails_api.rb +262 -66
- data/lib/bombbomb/api/files_api.rb +32 -53
- data/lib/bombbomb/api/forms_api.rb +77 -0
- data/lib/bombbomb/api/integrations_api.rb +238 -20
- data/lib/bombbomb/api/lists_api.rb +32 -53
- data/lib/bombbomb/api/orders_api.rb +8 -21
- data/lib/bombbomb/api/prompts_api.rb +347 -112
- data/lib/bombbomb/api/socials_api.rb +242 -87
- data/lib/bombbomb/api/teams_api.rb +485 -193
- data/lib/bombbomb/api/users_api.rb +119 -0
- data/lib/bombbomb/api/utilities_api.rb +23 -44
- data/lib/bombbomb/api/videos_api.rb +38 -55
- data/lib/bombbomb/api/webhooks_api.rb +23 -50
- data/lib/bombbomb/api_client.rb +55 -45
- data/lib/bombbomb/api_error.rb +9 -18
- data/lib/bombbomb/configuration.rb +8 -13
- data/lib/bombbomb/models/bb_web_hook.rb +6 -17
- data/lib/bombbomb/models/client_group_asset_meta_data.rb +215 -0
- data/lib/bombbomb/models/curriculum.rb +6 -17
- data/lib/bombbomb/models/curriculum_user_progress.rb +6 -17
- data/lib/bombbomb/models/curriculum_with_progress.rb +6 -17
- data/lib/bombbomb/models/hosted_doc.rb +6 -17
- data/lib/bombbomb/models/inline_response_200.rb +7 -18
- data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
- data/lib/bombbomb/models/jericho_configuration.rb +34 -21
- data/lib/bombbomb/models/jericho_performance.rb +6 -17
- data/lib/bombbomb/models/o_auth_client.rb +6 -17
- data/lib/bombbomb/models/prompt_bot.rb +6 -17
- data/lib/bombbomb/models/prompt_monthly_performance.rb +219 -0
- data/lib/bombbomb/models/prompt_overview.rb +219 -0
- data/lib/bombbomb/models/prompt_social_prompt.rb +311 -0
- data/lib/bombbomb/models/sign_upload_request.rb +6 -17
- data/lib/bombbomb/models/sign_upload_response.rb +6 -17
- data/lib/bombbomb/models/string.rb +6 -17
- data/lib/bombbomb/models/team_public_representation.rb +6 -17
- data/lib/bombbomb/models/video_email_prompt.rb +128 -144
- data/lib/bombbomb/models/video_encoding_status_response.rb +6 -17
- data/lib/bombbomb/models/video_public_representation.rb +6 -17
- data/lib/bombbomb/models/video_recorder_method_response.rb +6 -17
- data/lib/bombbomb/version.rb +3 -14
- data/spec/api/forms_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +57 -0
- data/spec/models/{inline_response_200_items_spec.rb → client_group_asset_meta_data_spec.rb} +8 -19
- data/spec/models/prompt_monthly_performance_spec.rb +60 -0
- data/spec/models/prompt_overview_spec.rb +60 -0
- data/spec/models/{prompt_bot_bot_spec.rb → prompt_social_prompt_spec.rb} +27 -15
- metadata +40 -20
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5652631bc6f6515c0313a45726f4bef466ad0d3ceae74545a5cb1a88fe4f77af
|
4
|
+
data.tar.gz: c069582feda29d2b31160077c5268c26ec096435dd91917bc9e1eba9f9a05010
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3e5c937e28d4c5946a03aa808bc18a371ba212c68cfa135482dc6a757b7b3b18a78e8595235900898d78d42d0b9e5d09754d7412c97e271520cdad003ce232b9
|
7
|
+
data.tar.gz: 490ae589be41569bdda228cf9de5799a719b2fa14ecbe673abcaf9ccfad43f55ff34186a0022b2a590e2aaebcf4dfac33b50895cd36025d4d61d5827b0fa4536
|
data/Gemfile
ADDED
data/README.md
CHANGED
@@ -6,10 +6,9 @@ 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
|
12
|
-
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
9
|
+
- API version: 2.0.831
|
10
|
+
- Package version: 2.0.25798
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
13
12
|
|
14
13
|
## Installation
|
15
14
|
|
@@ -24,15 +23,15 @@ gem build bombbomb.gemspec
|
|
24
23
|
Then either install the gem locally:
|
25
24
|
|
26
25
|
```shell
|
27
|
-
gem install ./bombbomb-2.0.
|
26
|
+
gem install ./bombbomb-2.0.25798.gem
|
28
27
|
```
|
29
|
-
(for development, run `gem install --dev ./bombbomb-2.0.
|
28
|
+
(for development, run `gem install --dev ./bombbomb-2.0.25798.gem` to install the development dependencies)
|
30
29
|
|
31
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
31
|
|
33
32
|
Finally add this to the Gemfile:
|
34
33
|
|
35
|
-
gem 'bombbomb', '~> 2.0.
|
34
|
+
gem 'bombbomb', '~> 2.0.25798'
|
36
35
|
|
37
36
|
### Install from Git
|
38
37
|
|
@@ -55,6 +54,12 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
55
54
|
# Load the gem
|
56
55
|
require 'bombbomb'
|
57
56
|
|
57
|
+
# Setup authorization
|
58
|
+
BombBomb.configure do |config|
|
59
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
60
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
61
|
+
end
|
62
|
+
|
58
63
|
api_instance = BombBomb::AccountsApi.new
|
59
64
|
|
60
65
|
begin
|
@@ -75,9 +80,13 @@ Class | Method | HTTP request | Description
|
|
75
80
|
*BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
|
76
81
|
*BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
|
77
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
|
78
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.
|
79
87
|
*BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
|
80
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
|
81
90
|
*BombBomb::ContactsApi* | [**add_contacts_csv**](docs/ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
|
82
91
|
*BombBomb::ContactsApi* | [**add_new_contact**](docs/ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
|
83
92
|
*BombBomb::ContactsApi* | [**add_new_custom_field**](docs/ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
|
@@ -93,13 +102,22 @@ Class | Method | HTTP request | Description
|
|
93
102
|
*BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
|
94
103
|
*BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
|
95
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
|
96
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
|
97
110
|
*BombBomb::EmailsApi* | [**video_quick_sender**](docs/EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
|
98
111
|
*BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files/{docId} | Delete file
|
99
112
|
*BombBomb::FilesApi* | [**doc_host_get**](docs/FilesApi.md#doc_host_get) | **GET** /files/{docId} | Get file
|
100
113
|
*BombBomb::FilesApi* | [**doc_host_list**](docs/FilesApi.md#doc_host_list) | **GET** /files | List all files
|
101
114
|
*BombBomb::FilesApi* | [**doc_host_upload_v2**](docs/FilesApi.md#doc_host_upload_v2) | **POST** /files | Upload a file
|
102
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
|
103
121
|
*BombBomb::IntegrationsApi* | [**sync_users_integrated_lists**](docs/IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
|
104
122
|
*BombBomb::ListsApi* | [**add_new_list**](docs/ListsApi.md#add_new_list) | **POST** /lists/ | Add list.
|
105
123
|
*BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
|
@@ -109,25 +127,34 @@ Class | Method | HTTP request | Description
|
|
109
127
|
*BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
|
110
128
|
*BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
|
111
129
|
*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
|
112
131
|
*BombBomb::PromptsApi* | [**get_pending_video_email_prompts**](docs/PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
|
113
132
|
*BombBomb::PromptsApi* | [**get_prompt_bots**](docs/PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
|
114
|
-
*BombBomb::PromptsApi* | [**get_prompt_campaigns**](docs/PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/campaigns | List Prompt Campaigns
|
133
|
+
*BombBomb::PromptsApi* | [**get_prompt_campaigns**](docs/PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/{userId}/campaigns | List Prompt Campaigns
|
115
134
|
*BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
|
116
135
|
*BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
|
117
136
|
*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
|
118
139
|
*BombBomb::PromptsApi* | [**update_prompt**](docs/PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
|
119
140
|
*BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
|
120
|
-
*BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{
|
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
|
121
143
|
*BombBomb::SocialsApi* | [**get_facebook_pages**](docs/SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
|
122
144
|
*BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
|
123
145
|
*BombBomb::SocialsApi* | [**get_social_authorizations**](docs/SocialsApi.md#get_social_authorizations) | **GET** /socials/authorizations | Get authorizations for all social integration
|
124
146
|
*BombBomb::SocialsApi* | [**get_social_profile_properties**](docs/SocialsApi.md#get_social_profile_properties) | **GET** /socials/profile | Gets the profile properties
|
125
147
|
*BombBomb::SocialsApi* | [**get_social_stats**](docs/SocialsApi.md#get_social_stats) | **GET** /socials/{promptId}/stats | Get social stats for a prompt
|
126
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
|
127
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
|
128
153
|
*BombBomb::SocialsApi* | [**update_facebook_pages**](docs/SocialsApi.md#update_facebook_pages) | **PUT** /socials/facebook/pages | Updates facebook page Ids
|
129
154
|
*BombBomb::SocialsApi* | [**update_social_content**](docs/SocialsApi.md#update_social_content) | **PUT** /socials/content | Updates social content
|
130
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
|
131
158
|
*BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
|
132
159
|
*BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
|
133
160
|
*BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
@@ -137,15 +164,20 @@ Class | Method | HTTP request | Description
|
|
137
164
|
*BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
138
165
|
*BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
139
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
|
140
169
|
*BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
141
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
|
142
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
|
143
173
|
*BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
144
174
|
*BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
145
175
|
*BombBomb::TeamsApi* | [**resend_team_member_invitation**](docs/TeamsApi.md#resend_team_member_invitation) | **POST** /team/{teamId}/{memberUserId}/rewelcome | Resend invite
|
146
176
|
*BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
|
147
177
|
*BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
148
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.
|
149
181
|
*BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
|
150
182
|
*BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
|
151
183
|
*BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
|
@@ -165,16 +197,19 @@ Class | Method | HTTP request | Description
|
|
165
197
|
## Documentation for Models
|
166
198
|
|
167
199
|
- [BombBomb::BBWebHook](docs/BBWebHook.md)
|
200
|
+
- [BombBomb::ClientGroupAssetMetaData](docs/ClientGroupAssetMetaData.md)
|
168
201
|
- [BombBomb::Curriculum](docs/Curriculum.md)
|
169
202
|
- [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
|
170
203
|
- [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
|
171
204
|
- [BombBomb::HostedDoc](docs/HostedDoc.md)
|
172
205
|
- [BombBomb::InlineResponse200](docs/InlineResponse200.md)
|
173
|
-
- [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
|
174
206
|
- [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
|
175
207
|
- [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
|
176
208
|
- [BombBomb::OAuthClient](docs/OAuthClient.md)
|
177
209
|
- [BombBomb::PromptBot](docs/PromptBot.md)
|
210
|
+
- [BombBomb::PromptMonthlyPerformance](docs/PromptMonthlyPerformance.md)
|
211
|
+
- [BombBomb::PromptOverview](docs/PromptOverview.md)
|
212
|
+
- [BombBomb::PromptSocialPrompt](docs/PromptSocialPrompt.md)
|
178
213
|
- [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
|
179
214
|
- [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
|
180
215
|
- [BombBomb::String](docs/String.md)
|
@@ -194,27 +229,27 @@ Class | Method | HTTP request | Description
|
|
194
229
|
- **Flow**: implicit
|
195
230
|
- **Authorization URL**: https://app.bombbomb.com/auth/authorize
|
196
231
|
- **Scopes**:
|
197
|
-
- all:manage: Manage
|
198
|
-
- all:read:
|
199
|
-
- email:manage: Manage
|
200
|
-
- email:read:
|
201
|
-
- video:manage: Manage
|
202
|
-
- video:read:
|
203
|
-
- contact:manage: Manage
|
204
|
-
- contact:read:
|
205
|
-
- curriculum:manage: Manage
|
206
|
-
- curriculum:read:
|
207
|
-
- automation:manage: Manage
|
208
|
-
- automation:read:
|
209
|
-
- form:manage: Manage
|
210
|
-
- form:read:
|
211
|
-
- list:manage: Manage
|
212
|
-
- team:manage: Manage
|
213
|
-
- team:read:
|
214
|
-
- order:manage: Manage
|
215
|
-
- settings:manage: Manage
|
216
|
-
- file:manage: Manage
|
217
|
-
- file:read:
|
218
|
-
- account:manage: Manage
|
219
|
-
- account:read:
|
232
|
+
- all:manage: View & Manage your BombBomb information
|
233
|
+
- all:read: View your BombBomb information
|
234
|
+
- email:manage: View & Manage your BombBomb emails
|
235
|
+
- email:read: View your BombBomb emails
|
236
|
+
- video:manage: View & Manage your BombBomb videos
|
237
|
+
- video:read: View your BombBomb videos
|
238
|
+
- contact:manage: View & Manage your BombBomb contacts
|
239
|
+
- contact:read: View your BombBomb contacts
|
240
|
+
- curriculum:manage: View & Manage your BombBomb challenges
|
241
|
+
- curriculum:read: View your BombBomb challenges
|
242
|
+
- automation:manage: View & Manage your BombBomb automations
|
243
|
+
- automation:read: View your BombBomb automations
|
244
|
+
- form:manage: View & Manage your BombBomb forms
|
245
|
+
- form:read: View your BombBomb forms
|
246
|
+
- list:manage: View & Manage your BombBomb lists
|
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
|
220
255
|
|
data/Rakefile
CHANGED
data/bombbomb.gemspec
CHANGED
@@ -5,21 +5,10 @@
|
|
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.831
|
9
9
|
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
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.
|
11
|
+
Swagger Codegen version: 2.3.1
|
23
12
|
|
24
13
|
=end
|
25
14
|
|
@@ -35,18 +24,20 @@ Gem::Specification.new do |s|
|
|
35
24
|
s.homepage = "http://developer.bombbomb.com"
|
36
25
|
s.summary = "A ruby wrapper for BombBomb's API"
|
37
26
|
s.description = "We make it easy to build relationships using simple videos."
|
38
|
-
|
27
|
+
# TODO uncommnet and update below with a proper license
|
28
|
+
#s.license = "Apache 2.0"
|
29
|
+
s.required_ruby_version = ">= 1.9"
|
39
30
|
|
40
31
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
41
|
-
s.add_runtime_dependency 'json', '~> 1
|
32
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
42
33
|
|
43
|
-
s.add_development_dependency 'rspec', '~> 3.
|
34
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
44
35
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
45
36
|
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
46
37
|
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
47
38
|
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
48
39
|
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
49
|
-
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.
|
40
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
50
41
|
|
51
42
|
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
52
43
|
s.test_files = `find spec/*`.split("\n")
|
data/docs/AccountsApi.md
CHANGED
@@ -7,7 +7,10 @@ Method | HTTP request | Description
|
|
7
7
|
[**account_details**](AccountsApi.md#account_details) | **GET** /accounts | Get account details.
|
8
8
|
[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create Account
|
9
9
|
[**get_client_statistics**](AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
|
10
|
+
[**get_user_country**](AccountsApi.md#get_user_country) | **GET** /accounts/{clientId}/country | Gets user country
|
11
|
+
[**reset_api_key**](AccountsApi.md#reset_api_key) | **PUT** /accounts/apikey | Reset API key
|
10
12
|
[**subscription_purchase_allowed**](AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
|
13
|
+
[**update_profile_data**](AccountsApi.md#update_profile_data) | **POST** /account/profile/ | Add profile information.
|
11
14
|
|
12
15
|
|
13
16
|
# **account_details**
|
@@ -21,6 +24,11 @@ Get the details of the user's account.
|
|
21
24
|
```ruby
|
22
25
|
# load the gem
|
23
26
|
require 'bombbomb'
|
27
|
+
# setup authorization
|
28
|
+
BombBomb.configure do |config|
|
29
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
30
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
31
|
+
end
|
24
32
|
|
25
33
|
api_instance = BombBomb::AccountsApi.new
|
26
34
|
|
@@ -41,7 +49,7 @@ nil (empty response body)
|
|
41
49
|
|
42
50
|
### Authorization
|
43
51
|
|
44
|
-
|
52
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
45
53
|
|
46
54
|
### HTTP request headers
|
47
55
|
|
@@ -87,7 +95,7 @@ opts = {
|
|
87
95
|
address: "address_example", # String | Street Address of the user.
|
88
96
|
city: "city_example", # String | City of the user.
|
89
97
|
postal_code: "postal_code_example", # String | Postal/Zip code of the user.
|
90
|
-
prevent_welcome_email:
|
98
|
+
prevent_welcome_email: true # BOOLEAN | prevent an email with login credentials from being sent to the new account. must be set to 'true'
|
91
99
|
}
|
92
100
|
|
93
101
|
begin
|
@@ -114,7 +122,7 @@ Name | Type | Description | Notes
|
|
114
122
|
**address** | **String**| Street Address of the user. | [optional]
|
115
123
|
**city** | **String**| City of the user. | [optional]
|
116
124
|
**postal_code** | **String**| Postal/Zip code of the user. | [optional]
|
117
|
-
**prevent_welcome_email** | **
|
125
|
+
**prevent_welcome_email** | **BOOLEAN**| prevent an email with login credentials from being sent to the new account. must be set to 'true' | [optional]
|
118
126
|
|
119
127
|
### Return type
|
120
128
|
|
@@ -151,7 +159,9 @@ end
|
|
151
159
|
api_instance = BombBomb::AccountsApi.new
|
152
160
|
|
153
161
|
opts = {
|
154
|
-
client_id: "client_id_example" # String | Client ID of the account to retrieve. Defaults to yourself.
|
162
|
+
client_id: "client_id_example", # String | Client ID of the account to retrieve. Defaults to yourself.
|
163
|
+
refresh: true, # BOOLEAN | Boolean for whether data returned should be from cache or not.
|
164
|
+
statistic_values: "statistic_values_example" # String | Array of data that should be returned, used exclusively for cacheless data
|
155
165
|
}
|
156
166
|
|
157
167
|
begin
|
@@ -167,6 +177,98 @@ end
|
|
167
177
|
Name | Type | Description | Notes
|
168
178
|
------------- | ------------- | ------------- | -------------
|
169
179
|
**client_id** | **String**| Client ID of the account to retrieve. Defaults to yourself. | [optional]
|
180
|
+
**refresh** | **BOOLEAN**| Boolean for whether data returned should be from cache or not. | [optional]
|
181
|
+
**statistic_values** | **String**| Array of data that should be returned, used exclusively for cacheless data | [optional]
|
182
|
+
|
183
|
+
### Return type
|
184
|
+
|
185
|
+
nil (empty response body)
|
186
|
+
|
187
|
+
### Authorization
|
188
|
+
|
189
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
190
|
+
|
191
|
+
### HTTP request headers
|
192
|
+
|
193
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
194
|
+
- **Accept**: application/json
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
# **get_user_country**
|
199
|
+
> get_user_country
|
200
|
+
|
201
|
+
Gets user country
|
202
|
+
|
203
|
+
Gets the users country
|
204
|
+
|
205
|
+
### Example
|
206
|
+
```ruby
|
207
|
+
# load the gem
|
208
|
+
require 'bombbomb'
|
209
|
+
# setup authorization
|
210
|
+
BombBomb.configure do |config|
|
211
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
212
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
213
|
+
end
|
214
|
+
|
215
|
+
api_instance = BombBomb::AccountsApi.new
|
216
|
+
|
217
|
+
begin
|
218
|
+
#Gets user country
|
219
|
+
api_instance.get_user_country
|
220
|
+
rescue BombBomb::ApiError => e
|
221
|
+
puts "Exception when calling AccountsApi->get_user_country: #{e}"
|
222
|
+
end
|
223
|
+
```
|
224
|
+
|
225
|
+
### Parameters
|
226
|
+
This endpoint does not need any parameter.
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
nil (empty response body)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
# **reset_api_key**
|
244
|
+
> reset_api_key
|
245
|
+
|
246
|
+
Reset API key
|
247
|
+
|
248
|
+
Resets the current user's API key and returns the new key
|
249
|
+
|
250
|
+
### Example
|
251
|
+
```ruby
|
252
|
+
# load the gem
|
253
|
+
require 'bombbomb'
|
254
|
+
# setup authorization
|
255
|
+
BombBomb.configure do |config|
|
256
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
257
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
258
|
+
end
|
259
|
+
|
260
|
+
api_instance = BombBomb::AccountsApi.new
|
261
|
+
|
262
|
+
begin
|
263
|
+
#Reset API key
|
264
|
+
api_instance.reset_api_key
|
265
|
+
rescue BombBomb::ApiError => e
|
266
|
+
puts "Exception when calling AccountsApi->reset_api_key: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
This endpoint does not need any parameter.
|
170
272
|
|
171
273
|
### Return type
|
172
274
|
|
@@ -194,6 +296,11 @@ Check whether the user can purchase a subscription.
|
|
194
296
|
```ruby
|
195
297
|
# load the gem
|
196
298
|
require 'bombbomb'
|
299
|
+
# setup authorization
|
300
|
+
BombBomb.configure do |config|
|
301
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
302
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
303
|
+
end
|
197
304
|
|
198
305
|
api_instance = BombBomb::AccountsApi.new
|
199
306
|
|
@@ -214,7 +321,59 @@ nil (empty response body)
|
|
214
321
|
|
215
322
|
### Authorization
|
216
323
|
|
217
|
-
|
324
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
325
|
+
|
326
|
+
### HTTP request headers
|
327
|
+
|
328
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
329
|
+
- **Accept**: application/json
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
# **update_profile_data**
|
334
|
+
> update_profile_data(opts)
|
335
|
+
|
336
|
+
Add profile information.
|
337
|
+
|
338
|
+
Add profile information to this users account
|
339
|
+
|
340
|
+
### Example
|
341
|
+
```ruby
|
342
|
+
# load the gem
|
343
|
+
require 'bombbomb'
|
344
|
+
# setup authorization
|
345
|
+
BombBomb.configure do |config|
|
346
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
347
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
348
|
+
end
|
349
|
+
|
350
|
+
api_instance = BombBomb::AccountsApi.new
|
351
|
+
|
352
|
+
opts = {
|
353
|
+
profile_data: "profile_data_example" # String | Profile field information for the account
|
354
|
+
}
|
355
|
+
|
356
|
+
begin
|
357
|
+
#Add profile information.
|
358
|
+
api_instance.update_profile_data(opts)
|
359
|
+
rescue BombBomb::ApiError => e
|
360
|
+
puts "Exception when calling AccountsApi->update_profile_data: #{e}"
|
361
|
+
end
|
362
|
+
```
|
363
|
+
|
364
|
+
### Parameters
|
365
|
+
|
366
|
+
Name | Type | Description | Notes
|
367
|
+
------------- | ------------- | ------------- | -------------
|
368
|
+
**profile_data** | **String**| Profile field information for the account | [optional]
|
369
|
+
|
370
|
+
### Return type
|
371
|
+
|
372
|
+
nil (empty response body)
|
373
|
+
|
374
|
+
### Authorization
|
375
|
+
|
376
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
218
377
|
|
219
378
|
### HTTP request headers
|
220
379
|
|