bombbomb 2.0.0 → 2.0.831

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -0
  3. data/README.md +16 -9
  4. data/Rakefile +8 -3
  5. data/bombbomb.gemspec +8 -17
  6. data/docs/AutomationsApi.md +52 -0
  7. data/docs/ClientGroupAssetMetaData.md +11 -0
  8. data/docs/InlineResponse200.md +1 -1
  9. data/docs/JerichoConfiguration.md +1 -0
  10. data/docs/PromptMonthlyPerformance.md +11 -0
  11. data/docs/PromptOverview.md +11 -0
  12. data/docs/PromptsApi.md +53 -1
  13. data/docs/TeamsApi.md +103 -5
  14. data/docs/UsersApi.md +100 -0
  15. data/git_push.sh +1 -13
  16. data/lib/bombbomb.rb +6 -14
  17. data/lib/bombbomb/api/accounts_api.rb +41 -68
  18. data/lib/bombbomb/api/automations_api.rb +71 -30
  19. data/lib/bombbomb/api/contacts_api.rb +47 -76
  20. data/lib/bombbomb/api/curriculum_api.rb +8 -27
  21. data/lib/bombbomb/api/emails_api.rb +53 -96
  22. data/lib/bombbomb/api/files_api.rb +32 -53
  23. data/lib/bombbomb/api/forms_api.rb +8 -21
  24. data/lib/bombbomb/api/integrations_api.rb +26 -51
  25. data/lib/bombbomb/api/lists_api.rb +32 -53
  26. data/lib/bombbomb/api/orders_api.rb +8 -21
  27. data/lib/bombbomb/api/prompts_api.rb +177 -139
  28. data/lib/bombbomb/api/socials_api.rb +80 -111
  29. data/lib/bombbomb/api/teams_api.rb +294 -209
  30. data/lib/bombbomb/api/users_api.rb +119 -0
  31. data/lib/bombbomb/api/utilities_api.rb +23 -44
  32. data/lib/bombbomb/api/videos_api.rb +38 -55
  33. data/lib/bombbomb/api/webhooks_api.rb +23 -50
  34. data/lib/bombbomb/api_client.rb +55 -45
  35. data/lib/bombbomb/api_error.rb +9 -18
  36. data/lib/bombbomb/configuration.rb +8 -13
  37. data/lib/bombbomb/models/bb_web_hook.rb +6 -17
  38. data/lib/bombbomb/models/client_group_asset_meta_data.rb +215 -0
  39. data/lib/bombbomb/models/curriculum.rb +6 -17
  40. data/lib/bombbomb/models/curriculum_user_progress.rb +6 -17
  41. data/lib/bombbomb/models/curriculum_with_progress.rb +6 -17
  42. data/lib/bombbomb/models/hosted_doc.rb +6 -17
  43. data/lib/bombbomb/models/inline_response_200.rb +7 -18
  44. data/lib/bombbomb/models/jericho_configuration.rb +24 -21
  45. data/lib/bombbomb/models/jericho_performance.rb +6 -17
  46. data/lib/bombbomb/models/o_auth_client.rb +6 -17
  47. data/lib/bombbomb/models/prompt_bot.rb +6 -17
  48. data/lib/bombbomb/models/prompt_monthly_performance.rb +219 -0
  49. data/lib/bombbomb/models/prompt_overview.rb +219 -0
  50. data/lib/bombbomb/models/prompt_social_prompt.rb +6 -17
  51. data/lib/bombbomb/models/sign_upload_request.rb +6 -17
  52. data/lib/bombbomb/models/sign_upload_response.rb +6 -17
  53. data/lib/bombbomb/models/string.rb +6 -17
  54. data/lib/bombbomb/models/team_public_representation.rb +6 -17
  55. data/lib/bombbomb/models/video_email_prompt.rb +6 -17
  56. data/lib/bombbomb/models/video_encoding_status_response.rb +6 -17
  57. data/lib/bombbomb/models/video_public_representation.rb +6 -17
  58. data/lib/bombbomb/models/video_recorder_method_response.rb +6 -17
  59. data/lib/bombbomb/version.rb +3 -14
  60. data/spec/api/users_api_spec.rb +57 -0
  61. data/spec/models/{inline_response_200_items_spec.rb → client_group_asset_meta_data_spec.rb} +8 -19
  62. data/spec/models/prompt_monthly_performance_spec.rb +60 -0
  63. data/spec/models/prompt_overview_spec.rb +60 -0
  64. metadata +31 -19
  65. data/spec/models/prompt_bot_bot_spec.rb +0 -113
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cff8bb80873e06526c7f969d14fda328b14d3ee53d23ff3fb2a2a1c7581a0733
4
- data.tar.gz: 585d5715cf8cf8c25e8804fca5827d419a22198e8dd367af941bd14f3de08757
3
+ metadata.gz: d1047153ebdca15904703f17bba422847a1ef9cb5af99e1b7721dc6bca495426
4
+ data.tar.gz: 2b01c89bd9158c524e264cb8767f773d85d4f4a48235a90d44b122bd3a9227ea
5
5
  SHA512:
6
- metadata.gz: b88ae86b5d4b615f17833155aa23344cf6dc35de8ec7075fe8e945720bc2d6866ab16b1ad87feb8339e9fd0c29da7da1fda950e31aad77698a5164c2a332eb44
7
- data.tar.gz: fde9eabd85cccb66bf9ac680ffec3b82c6aff0410089f5a398cbdf9eedc6ca6489fdf64ed8086acb1b70b219f72b5aef64dd9a4495388d9491119500dd53cf26
6
+ metadata.gz: d9c481331f48e6278b4c39a5641bd40338d21f311923b55e9706a5a73d74cadb3e203b8d04683b8710e7aebc72975598712b63b9db0b7be21d8df25182175f73
7
+ data.tar.gz: 919efe76475139cdf8b74504f22f41040062b766cc9e893c90965a8146d1d2c9bdf89ac07356df7bef3c695ec34512033a5d6d80e31bfaf20e26b3e72601022a
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
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.0
10
- - Package version: 2.0.0
11
- - Build date: 2018-05-30T21:55:54.971Z
12
- - Build package: class io.swagger.codegen.languages.RubyClientCodegen
9
+ - API version: 2.0.831
10
+ - Package version: 2.0.831
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.0.gem
26
+ gem install ./bombbomb-2.0.831.gem
28
27
  ```
29
- (for development, run `gem install --dev ./bombbomb-2.0.0.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./bombbomb-2.0.831.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.0'
34
+ gem 'bombbomb', '~> 2.0.831'
36
35
 
37
36
  ### Install from Git
38
37
 
@@ -87,6 +86,7 @@ Class | Method | HTTP request | Description
87
86
  *BombBomb::AccountsApi* | [**update_profile_data**](docs/AccountsApi.md#update_profile_data) | **POST** /account/profile/ | Add profile information.
88
87
  *BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
89
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
90
  *BombBomb::ContactsApi* | [**add_contacts_csv**](docs/ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
91
91
  *BombBomb::ContactsApi* | [**add_new_contact**](docs/ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
92
92
  *BombBomb::ContactsApi* | [**add_new_custom_field**](docs/ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
@@ -134,10 +134,11 @@ Class | Method | HTTP request | Description
134
134
  *BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
135
135
  *BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
136
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 |
137
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
138
139
  *BombBomb::PromptsApi* | [**update_prompt**](docs/PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
139
140
  *BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
140
- *BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
141
+ *BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{clientGroupId} | Update Prompt Campaign
141
142
  *BombBomb::PromptsApi* | [**update_prompt_template**](docs/PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
142
143
  *BombBomb::SocialsApi* | [**get_facebook_pages**](docs/SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
143
144
  *BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
@@ -163,6 +164,8 @@ Class | Method | HTTP request | Description
163
164
  *BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
164
165
  *BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
165
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
166
169
  *BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
167
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
168
171
  *BombBomb::TeamsApi* | [**get_team_prompt_campaigns**](docs/TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
@@ -173,6 +176,8 @@ Class | Method | HTTP request | Description
173
176
  *BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
174
177
  *BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
175
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.
176
181
  *BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
177
182
  *BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
178
183
  *BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
@@ -192,16 +197,18 @@ Class | Method | HTTP request | Description
192
197
  ## Documentation for Models
193
198
 
194
199
  - [BombBomb::BBWebHook](docs/BBWebHook.md)
200
+ - [BombBomb::ClientGroupAssetMetaData](docs/ClientGroupAssetMetaData.md)
195
201
  - [BombBomb::Curriculum](docs/Curriculum.md)
196
202
  - [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
197
203
  - [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
198
204
  - [BombBomb::HostedDoc](docs/HostedDoc.md)
199
205
  - [BombBomb::InlineResponse200](docs/InlineResponse200.md)
200
- - [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
201
206
  - [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
202
207
  - [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
203
208
  - [BombBomb::OAuthClient](docs/OAuthClient.md)
204
209
  - [BombBomb::PromptBot](docs/PromptBot.md)
210
+ - [BombBomb::PromptMonthlyPerformance](docs/PromptMonthlyPerformance.md)
211
+ - [BombBomb::PromptOverview](docs/PromptOverview.md)
205
212
  - [BombBomb::PromptSocialPrompt](docs/PromptSocialPrompt.md)
206
213
  - [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
207
214
  - [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
data/Rakefile CHANGED
@@ -1,3 +1,8 @@
1
- task :default do
2
- puts "So Raked!"
3
- end
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
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.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
- s.license = "Apache 2.0"
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.8', '>= 1.8.3'
32
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
42
33
 
43
- s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
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.11'
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")
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**get_drip_drop_stats**](AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
8
8
  [**get_drip_stats**](AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
9
+ [**get_scheduling_status**](AutomationsApi.md#get_scheduling_status) | **GET** /automation/{id}/scheduling/status | Get the number of pending scheduling calculations
9
10
 
10
11
 
11
12
  # **get_drip_drop_stats**
@@ -113,3 +114,54 @@ nil (empty response body)
113
114
 
114
115
 
115
116
 
117
+ # **get_scheduling_status**
118
+ > get_scheduling_status(id)
119
+
120
+ Get the number of pending scheduling calculations
121
+
122
+ Get the number of pending scheduling calculations
123
+
124
+ ### Example
125
+ ```ruby
126
+ # load the gem
127
+ require 'bombbomb'
128
+ # setup authorization
129
+ BombBomb.configure do |config|
130
+ # Configure OAuth2 access token for authorization: BBOAuth2
131
+ config.access_token = 'YOUR ACCESS TOKEN'
132
+ end
133
+
134
+ api_instance = BombBomb::AutomationsApi.new
135
+
136
+ id = "id_example" # String | The id of the automation
137
+
138
+
139
+ begin
140
+ #Get the number of pending scheduling calculations
141
+ api_instance.get_scheduling_status(id)
142
+ rescue BombBomb::ApiError => e
143
+ puts "Exception when calling AutomationsApi->get_scheduling_status: #{e}"
144
+ end
145
+ ```
146
+
147
+ ### Parameters
148
+
149
+ Name | Type | Description | Notes
150
+ ------------- | ------------- | ------------- | -------------
151
+ **id** | **String**| The id of the automation |
152
+
153
+ ### Return type
154
+
155
+ nil (empty response body)
156
+
157
+ ### Authorization
158
+
159
+ [BBOAuth2](../README.md#BBOAuth2)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/x-www-form-urlencoded
164
+ - **Accept**: application/json
165
+
166
+
167
+
@@ -0,0 +1,11 @@
1
+ # BombBomb::ClientGroupAssetMetaData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
+ **user_id** | **String** | | [optional]
9
+ **thumb_url** | **String** | | [optional]
10
+
11
+
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **total_pages** | **Integer** | | [optional]
7
- **items** | [**Array<InlineResponse200Items>**](InlineResponse200Items.md) | | [optional]
7
+ **items** | [**Array<ClientGroupAssetMetaData>**](ClientGroupAssetMetaData.md) | | [optional]
8
8
 
9
9
 
@@ -19,5 +19,6 @@ Name | Type | Description | Notes
19
19
  **send_without_video** | **BOOLEAN** | Video Prompt: Whether to send the final email if no video was recorded. | [optional]
20
20
  **status** | **String** | The state of the send. | [optional]
21
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]
22
23
 
23
24
 
@@ -0,0 +1,11 @@
1
+ # BombBomb::PromptMonthlyPerformance
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **start_date** | **String** | The startDate property | [optional]
7
+ **end_date** | **String** | The endDate property | [optional]
8
+ **user_batch_lists_id_helper** | **String** | The userBatchListsIdHelper property | [optional]
9
+ **prompt_id_helper** | **String** | The promptIdHelper property | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # BombBomb::PromptOverview
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **start_date** | **String** | The startDate property | [optional]
7
+ **end_date** | **String** | The endDate property | [optional]
8
+ **user_batch_lists_id_helper** | **String** | The userBatchListsIdHelper property | [optional]
9
+ **prompt_id_helper** | **String** | The promptIdHelper property | [optional]
10
+
11
+
data/docs/PromptsApi.md CHANGED
@@ -13,10 +13,11 @@ Method | HTTP request | Description
13
13
  [**get_video_email_prompt**](PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
14
14
  [**get_video_email_prompts**](PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
15
15
  [**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 |
16
17
  [**sync_prompt_subscriptions**](PromptsApi.md#sync_prompt_subscriptions) | **POST** /prompts/campaigns/sync | Syncs Campaigns and One to Ones Subscriptions for User
17
18
  [**update_prompt**](PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
18
19
  [**update_prompt_bot**](PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
19
- [**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
20
+ [**update_prompt_campaign**](PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{clientGroupId} | Update Prompt Campaign
20
21
  [**update_prompt_template**](PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
21
22
 
22
23
 
@@ -494,6 +495,57 @@ No authorization required
494
495
 
495
496
 
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
+
497
549
  # **sync_prompt_subscriptions**
498
550
  > sync_prompt_subscriptions(opts)
499
551
 
data/docs/TeamsApi.md CHANGED
@@ -16,6 +16,8 @@ Method | HTTP request | Description
16
16
  [**get_jericho_sends**](TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
17
17
  [**get_jericho_stats**](TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
18
18
  [**get_paged_client_group_members**](TeamsApi.md#get_paged_client_group_members) | **GET** /team/{teamId}/members | List Team Members
19
+ [**get_prompt_monthly_stats**](TeamsApi.md#get_prompt_monthly_stats) | **GET** /team/{month}/{year}/monthStats | Jericho Monthly Stats
20
+ [**get_prompt_overview**](TeamsApi.md#get_prompt_overview) | **GET** /team/promptOverview | Get Prompt Overview
19
21
  [**get_subteams**](TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
20
22
  [**get_team_prompt_aggregate_stats**](TeamsApi.md#get_team_prompt_aggregate_stats) | **GET** /team/{clientGroupId}/campaign/stats | Get aggregate stats for campaigns
21
23
  [**get_team_prompt_campaigns**](TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
@@ -718,12 +720,67 @@ nil (empty response body)
718
720
 
719
721
 
720
722
 
721
- # **get_subteams**
722
- > Array<TeamPublicRepresentation> get_subteams(team_id)
723
+ # **get_prompt_monthly_stats**
724
+ > String get_prompt_monthly_stats(month, year)
723
725
 
724
- List Subteams
726
+ Jericho Monthly Stats
725
727
 
726
- Returns a collection of subteams for a parent team
728
+ Jericho Monthly Stats
729
+
730
+ ### Example
731
+ ```ruby
732
+ # load the gem
733
+ require 'bombbomb'
734
+ # setup authorization
735
+ BombBomb.configure do |config|
736
+ # Configure OAuth2 access token for authorization: BBOAuth2
737
+ config.access_token = 'YOUR ACCESS TOKEN'
738
+ end
739
+
740
+ api_instance = BombBomb::TeamsApi.new
741
+
742
+ month = "month_example" # String | The month whose Jericho sends you wish to see.
743
+
744
+ year = "year_example" # String | The year whose Jericho sends you wish to see.
745
+
746
+
747
+ begin
748
+ #Jericho Monthly Stats
749
+ result = api_instance.get_prompt_monthly_stats(month, year)
750
+ p result
751
+ rescue BombBomb::ApiError => e
752
+ puts "Exception when calling TeamsApi->get_prompt_monthly_stats: #{e}"
753
+ end
754
+ ```
755
+
756
+ ### Parameters
757
+
758
+ Name | Type | Description | Notes
759
+ ------------- | ------------- | ------------- | -------------
760
+ **month** | **String**| The month whose Jericho sends you wish to see. |
761
+ **year** | **String**| The year whose Jericho sends you wish to see. |
762
+
763
+ ### Return type
764
+
765
+ **String**
766
+
767
+ ### Authorization
768
+
769
+ [BBOAuth2](../README.md#BBOAuth2)
770
+
771
+ ### HTTP request headers
772
+
773
+ - **Content-Type**: application/x-www-form-urlencoded
774
+ - **Accept**: application/json
775
+
776
+
777
+
778
+ # **get_prompt_overview**
779
+ > String get_prompt_overview
780
+
781
+ Get Prompt Overview
782
+
783
+ Get Prompt Overview
727
784
 
728
785
  ### Example
729
786
  ```ruby
@@ -737,6 +794,47 @@ end
737
794
 
738
795
  api_instance = BombBomb::TeamsApi.new
739
796
 
797
+ begin
798
+ #Get Prompt Overview
799
+ result = api_instance.get_prompt_overview
800
+ p result
801
+ rescue BombBomb::ApiError => e
802
+ puts "Exception when calling TeamsApi->get_prompt_overview: #{e}"
803
+ end
804
+ ```
805
+
806
+ ### Parameters
807
+ This endpoint does not need any parameter.
808
+
809
+ ### Return type
810
+
811
+ **String**
812
+
813
+ ### Authorization
814
+
815
+ [BBOAuth2](../README.md#BBOAuth2)
816
+
817
+ ### HTTP request headers
818
+
819
+ - **Content-Type**: application/x-www-form-urlencoded
820
+ - **Accept**: application/json
821
+
822
+
823
+
824
+ # **get_subteams**
825
+ > Array<TeamPublicRepresentation> get_subteams(team_id)
826
+
827
+ List Subteams
828
+
829
+ Returns a collection of subteams for a parent team
830
+
831
+ ### Example
832
+ ```ruby
833
+ # load the gem
834
+ require 'bombbomb'
835
+
836
+ api_instance = BombBomb::TeamsApi.new
837
+
740
838
  team_id = "team_id_example" # String | The team id
741
839
 
742
840
 
@@ -761,7 +859,7 @@ Name | Type | Description | Notes
761
859
 
762
860
  ### Authorization
763
861
 
764
- [BBOAuth2](../README.md#BBOAuth2)
862
+ No authorization required
765
863
 
766
864
  ### HTTP request headers
767
865