bombbomb 2.0.24005 → 2.0.25797

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +44 -20
  3. data/bombbomb.gemspec +1 -1
  4. data/docs/AccountsApi.md +61 -28
  5. data/docs/ContactsApi.md +373 -0
  6. data/docs/EmailsApi.md +168 -0
  7. data/docs/FilesApi.md +216 -4
  8. data/docs/HostedDoc.md +13 -0
  9. data/docs/IntegrationsApi.md +62 -0
  10. data/docs/ListsApi.md +98 -0
  11. data/docs/PromptsApi.md +76 -12
  12. data/docs/SocialsApi.md +172 -71
  13. data/docs/TeamsApi.md +295 -1
  14. data/docs/VideoEmailPrompt.md +6 -0
  15. data/docs/VideosApi.md +59 -0
  16. data/lib/bombbomb/api/accounts_api.rb +59 -19
  17. data/lib/bombbomb/api/automations_api.rb +1 -1
  18. data/lib/bombbomb/api/contacts_api.rb +408 -1
  19. data/lib/bombbomb/api/curriculum_api.rb +1 -1
  20. data/lib/bombbomb/api/emails_api.rb +187 -1
  21. data/lib/bombbomb/api/files_api.rb +239 -7
  22. data/lib/bombbomb/api/integrations_api.rb +90 -0
  23. data/lib/bombbomb/api/lists_api.rb +110 -1
  24. data/lib/bombbomb/api/orders_api.rb +1 -1
  25. data/lib/bombbomb/api/prompts_api.rb +90 -20
  26. data/lib/bombbomb/api/socials_api.rb +210 -109
  27. data/lib/bombbomb/api/teams_api.rb +332 -1
  28. data/lib/bombbomb/api/utilities_api.rb +1 -1
  29. data/lib/bombbomb/api/videos_api.rb +66 -1
  30. data/lib/bombbomb/api/webhooks_api.rb +1 -1
  31. data/lib/bombbomb/api_client.rb +1 -1
  32. data/lib/bombbomb/api_error.rb +1 -1
  33. data/lib/bombbomb/configuration.rb +1 -1
  34. data/lib/bombbomb/models/bb_web_hook.rb +1 -1
  35. data/lib/bombbomb/models/curriculum.rb +1 -1
  36. data/lib/bombbomb/models/curriculum_user_progress.rb +1 -1
  37. data/lib/bombbomb/models/curriculum_with_progress.rb +1 -1
  38. data/lib/bombbomb/models/hosted_doc.rb +250 -0
  39. data/lib/bombbomb/models/inline_response_200.rb +1 -1
  40. data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
  41. data/lib/bombbomb/models/jericho_configuration.rb +1 -1
  42. data/lib/bombbomb/models/jericho_performance.rb +1 -1
  43. data/lib/bombbomb/models/o_auth_client.rb +1 -1
  44. data/lib/bombbomb/models/prompt_bot.rb +1 -1
  45. data/lib/bombbomb/models/sign_upload_request.rb +1 -1
  46. data/lib/bombbomb/models/sign_upload_response.rb +1 -1
  47. data/lib/bombbomb/models/string.rb +1 -1
  48. data/lib/bombbomb/models/team_public_representation.rb +1 -1
  49. data/lib/bombbomb/models/video_email_prompt.rb +67 -5
  50. data/lib/bombbomb/models/video_encoding_status_response.rb +1 -1
  51. data/lib/bombbomb/models/video_public_representation.rb +1 -1
  52. data/lib/bombbomb/models/video_recorder_method_response.rb +1 -1
  53. data/lib/bombbomb/version.rb +2 -2
  54. data/lib/bombbomb.rb +3 -1
  55. data/spec/api/integrations_api_spec.rb +58 -0
  56. data/spec/models/hosted_doc_spec.rb +83 -0
  57. metadata +11 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 87da890da0ac568bf4d0fc8fc3ef76cf35b732cd
4
- data.tar.gz: 8b7f9190c00c46179b8aed2f94b4e5a4ceea3910
2
+ SHA256:
3
+ metadata.gz: da6486119d70018ae595a10387990a004e9c8d8697a21bb6c002c06032ba3bf8
4
+ data.tar.gz: f9c2a0d4ab26cc9b13de52604e3a430b0217d87d2989a03ec5929b70a6b80def
5
5
  SHA512:
6
- metadata.gz: 7d155a01785c46e0fd7acc2741b782cfb2c423a0dee92c90788eb07c50312281105189322df53c4163fcdea5e0eba853b6b9b1e9c0cbe4823e5ad14080e703ff
7
- data.tar.gz: 635036faaf54b06547e48b705dd9b860ab7901bb27b4020fa6c88ac89e1267e53f206d6189fed6bef33b76d263a0f903a8e26d786c3d7810a40cc2c4c49b4902
6
+ metadata.gz: c317decda1920157536057b4ea584c918faca7f1a7a966e0a97ad5b83b47b548b9f183e90075cb9e1bd779a6ffab7a2ef00a783b7fcc5857a82c4ac49fbd650e
7
+ data.tar.gz: cfba91a8295704f89e681e0cf00350ee5b94cd5171df635ed350c78c742dc4f30e1ecc7c6339f4ba7335804d72fd9b93df63304870bb0d6015d987cf4d91e32e
data/README.md CHANGED
@@ -6,9 +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.24005
10
- - Package version: 2.0.24005
11
- - Build date: 2017-07-26T15:26:23.980Z
9
+ - API version: 2.0.25797
10
+ - Package version: 2.0.25797
11
+ - Build date: 2017-11-29T16:36:11.697Z
12
12
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
13
13
 
14
14
  ## Installation
@@ -24,15 +24,15 @@ gem build bombbomb.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./bombbomb-2.0.24005.gem
27
+ gem install ./bombbomb-2.0.25797.gem
28
28
  ```
29
- (for development, run `gem install --dev ./bombbomb-2.0.24005.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./bombbomb-2.0.25797.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'bombbomb', '~> 2.0.24005'
35
+ gem 'bombbomb', '~> 2.0.25797'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -57,15 +57,9 @@ require 'bombbomb'
57
57
 
58
58
  api_instance = BombBomb::AccountsApi.new
59
59
 
60
- opts = {
61
- email: "email_example", # String | Your login email address
62
- pw: "pw_example", # String | Your password
63
- api_key: "api_key_example" # String | Your Api Key
64
- }
65
-
66
60
  begin
67
61
  #Get account details.
68
- api_instance.account_details(opts)
62
+ api_instance.account_details
69
63
  rescue BombBomb::ApiError => e
70
64
  puts "Exception when calling AccountsApi->account_details: #{e}"
71
65
  end
@@ -80,19 +74,37 @@ Class | Method | HTTP request | Description
80
74
  ------------ | ------------- | ------------- | -------------
81
75
  *BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
82
76
  *BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
77
+ *BombBomb::AccountsApi* | [**get_client_statistics**](docs/AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
83
78
  *BombBomb::AccountsApi* | [**subscription_purchase_allowed**](docs/AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
84
79
  *BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
85
80
  *BombBomb::AutomationsApi* | [**get_drip_stats**](docs/AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
81
+ *BombBomb::ContactsApi* | [**add_contacts_csv**](docs/ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
82
+ *BombBomb::ContactsApi* | [**add_new_contact**](docs/ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
83
+ *BombBomb::ContactsApi* | [**add_new_custom_field**](docs/ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
84
+ *BombBomb::ContactsApi* | [**add_pasted_contacts**](docs/ContactsApi.md#add_pasted_contacts) | **POST** /contacts/paste | Add pasted contacts.
85
+ *BombBomb::ContactsApi* | [**c_sv_to_object**](docs/ContactsApi.md#c_sv_to_object) | **POST** /csv-to-object | Format CSV.
86
86
  *BombBomb::ContactsApi* | [**delete_contacts**](docs/ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
87
+ *BombBomb::ContactsApi* | [**get_contact_by_id**](docs/ContactsApi.md#get_contact_by_id) | **GET** /contact/{id} | Get Contact Details
88
+ *BombBomb::ContactsApi* | [**get_custom_fields**](docs/ContactsApi.md#get_custom_fields) | **GET** /contacts/custom_fields/ | Get custom fields.
87
89
  *BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
88
90
  *BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
89
91
  *BombBomb::EmailsApi* | [**create_printing_press_email**](docs/EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
92
+ *BombBomb::EmailsApi* | [**get_all_templates_for_current_user**](docs/EmailsApi.md#get_all_templates_for_current_user) | **GET** /emails/templates | Get all user templates
90
93
  *BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
91
94
  *BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
92
95
  *BombBomb::EmailsApi* | [**get_hourly_email_tracking**](docs/EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
93
- *BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files | Deletes users file
96
+ *BombBomb::EmailsApi* | [**get_quick_send_templates**](docs/EmailsApi.md#get_quick_send_templates) | **GET** /emails/quicksend/templates | Get all quicksend templates
97
+ *BombBomb::EmailsApi* | [**video_quick_sender**](docs/EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
98
+ *BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files/{docId} | Delete file
99
+ *BombBomb::FilesApi* | [**doc_host_get**](docs/FilesApi.md#doc_host_get) | **GET** /files/{docId} | Get file
100
+ *BombBomb::FilesApi* | [**doc_host_list**](docs/FilesApi.md#doc_host_list) | **GET** /files | List all files
101
+ *BombBomb::FilesApi* | [**doc_host_upload_v2**](docs/FilesApi.md#doc_host_upload_v2) | **POST** /files | Upload a file
102
+ *BombBomb::FilesApi* | [**get_hosted_images_paged**](docs/FilesApi.md#get_hosted_images_paged) | **GET** /files/images/paged | Get paged hosted images
103
+ *BombBomb::IntegrationsApi* | [**sync_users_integrated_lists**](docs/IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
104
+ *BombBomb::ListsApi* | [**add_new_list**](docs/ListsApi.md#add_new_list) | **POST** /lists/ | Add list.
94
105
  *BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
95
106
  *BombBomb::ListsApi* | [**copy_list_contacts**](docs/ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
107
+ *BombBomb::ListsApi* | [**get_all_lists**](docs/ListsApi.md#get_all_lists) | **GET** /lists/ | Get all Lists
96
108
  *BombBomb::ListsApi* | [**suppress_all_in_list**](docs/ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
97
109
  *BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
98
110
  *BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
@@ -103,26 +115,34 @@ Class | Method | HTTP request | Description
103
115
  *BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
104
116
  *BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
105
117
  *BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
118
+ *BombBomb::PromptsApi* | [**update_prompt**](docs/PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
106
119
  *BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
107
120
  *BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
121
+ *BombBomb::SocialsApi* | [**get_facebook_pages**](docs/SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
108
122
  *BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
109
- *BombBomb::SocialsApi* | [**get_social_auto_shares**](docs/SocialsApi.md#get_social_auto_shares) | **GET** /socials/shares | Gets the auto shares from the client group assoc id
110
- *BombBomb::SocialsApi* | [**get_social_permissions**](docs/SocialsApi.md#get_social_permissions) | **GET** /socials/permissions | Get permissions for social integration
111
- *BombBomb::SocialsApi* | [**get_social_status**](docs/SocialsApi.md#get_social_status) | **GET** /socials/states | Gets the social state
112
- *BombBomb::SocialsApi* | [**update_social_auto_shares**](docs/SocialsApi.md#update_social_auto_shares) | **PUT** /socials/shares | Gets the auto shares from the client group assoc id
113
- *BombBomb::SocialsApi* | [**update_social_message**](docs/SocialsApi.md#update_social_message) | **PUT** /socials/message | Sets the users social message to what they typed in
114
- *BombBomb::SocialsApi* | [**update_social_status**](docs/SocialsApi.md#update_social_status) | **PUT** /socials/state | Updates the social state for the object
123
+ *BombBomb::SocialsApi* | [**get_social_authorizations**](docs/SocialsApi.md#get_social_authorizations) | **GET** /socials/authorizations | Get authorizations for all social integration
124
+ *BombBomb::SocialsApi* | [**get_social_profile_properties**](docs/SocialsApi.md#get_social_profile_properties) | **GET** /socials/profile | Gets the profile properties
125
+ *BombBomb::SocialsApi* | [**get_social_stats**](docs/SocialsApi.md#get_social_stats) | **GET** /socials/{promptId}/stats | Get social stats for a prompt
126
+ *BombBomb::SocialsApi* | [**post_social_content**](docs/SocialsApi.md#post_social_content) | **POST** /socials/content | Creates social content
127
+ *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
128
+ *BombBomb::SocialsApi* | [**update_facebook_pages**](docs/SocialsApi.md#update_facebook_pages) | **PUT** /socials/facebook/pages | Updates facebook page Ids
129
+ *BombBomb::SocialsApi* | [**update_social_content**](docs/SocialsApi.md#update_social_content) | **PUT** /socials/content | Updates social content
115
130
  *BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
116
131
  *BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
117
132
  *BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
118
133
  *BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
119
134
  *BombBomb::TeamsApi* | [**get_all_client_group_associations**](docs/TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
120
135
  *BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
136
+ *BombBomb::TeamsApi* | [**get_client_group_statistics**](docs/TeamsApi.md#get_client_group_statistics) | **GET** /team/{teamId}/stats | Get Team statistics
121
137
  *BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
122
138
  *BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
139
+ *BombBomb::TeamsApi* | [**get_paged_client_group_members**](docs/TeamsApi.md#get_paged_client_group_members) | **GET** /team/{teamId}/members | List Team Members
123
140
  *BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
141
+ *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
+ *BombBomb::TeamsApi* | [**get_team_prompt_campaigns**](docs/TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
124
143
  *BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
125
144
  *BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
145
+ *BombBomb::TeamsApi* | [**resend_team_member_invitation**](docs/TeamsApi.md#resend_team_member_invitation) | **POST** /team/{teamId}/{memberUserId}/rewelcome | Resend invite
126
146
  *BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
127
147
  *BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
128
148
  *BombBomb::TeamsApi* | [**update_team_member**](docs/TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
@@ -134,6 +154,7 @@ Class | Method | HTTP request | Description
134
154
  *BombBomb::VideosApi* | [**get_video_recorder**](docs/VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
135
155
  *BombBomb::VideosApi* | [**mark_live_recording_complete**](docs/VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
136
156
  *BombBomb::VideosApi* | [**sign_upload**](docs/VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
157
+ *BombBomb::VideosApi* | [**update_video_thumbnail_v2**](docs/VideosApi.md#update_video_thumbnail_v2) | **PUT** /videos/thumbnail | Upload thumbnail
137
158
  *BombBomb::WebhooksApi* | [**add_web_hook**](docs/WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
138
159
  *BombBomb::WebhooksApi* | [**delete_web_hook**](docs/WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
139
160
  *BombBomb::WebhooksApi* | [**get_web_hooks**](docs/WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
@@ -147,6 +168,7 @@ Class | Method | HTTP request | Description
147
168
  - [BombBomb::Curriculum](docs/Curriculum.md)
148
169
  - [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
149
170
  - [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
171
+ - [BombBomb::HostedDoc](docs/HostedDoc.md)
150
172
  - [BombBomb::InlineResponse200](docs/InlineResponse200.md)
151
173
  - [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
152
174
  - [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
@@ -186,11 +208,13 @@ Class | Method | HTTP request | Description
186
208
  - automation:read: Read Automation
187
209
  - form:manage: Manage Form
188
210
  - form:read: Read Form
211
+ - list:manage: Manage List
189
212
  - team:manage: Manage Team
190
213
  - team:read: Read Team
191
214
  - order:manage: Manage Order
192
215
  - settings:manage: Manage Settings
193
216
  - file:manage: Manage File
217
+ - file:read: Read File
194
218
  - account:manage: Manage Account
195
219
  - account:read: Read Account
196
220
 
data/bombbomb.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  #We make it easy to build relationships using simple videos.
7
7
 
8
- OpenAPI spec version: 2.0.24005
8
+ OpenAPI spec version: 2.0.25797
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
 
data/docs/AccountsApi.md CHANGED
@@ -6,11 +6,12 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
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
+ [**get_client_statistics**](AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
9
10
  [**subscription_purchase_allowed**](AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
10
11
 
11
12
 
12
13
  # **account_details**
13
- > account_details(opts)
14
+ > account_details
14
15
 
15
16
  Get account details.
16
17
 
@@ -23,27 +24,16 @@ require 'bombbomb'
23
24
 
24
25
  api_instance = BombBomb::AccountsApi.new
25
26
 
26
- opts = {
27
- email: "email_example", # String | Your login email address
28
- pw: "pw_example", # String | Your password
29
- api_key: "api_key_example" # String | Your Api Key
30
- }
31
-
32
27
  begin
33
28
  #Get account details.
34
- api_instance.account_details(opts)
29
+ api_instance.account_details
35
30
  rescue BombBomb::ApiError => e
36
31
  puts "Exception when calling AccountsApi->account_details: #{e}"
37
32
  end
38
33
  ```
39
34
 
40
35
  ### Parameters
41
-
42
- Name | Type | Description | Notes
43
- ------------- | ------------- | ------------- | -------------
44
- **email** | **String**| Your login email address | [optional]
45
- **pw** | **String**| Your password | [optional]
46
- **api_key** | **String**| Your Api Key | [optional]
36
+ This endpoint does not need any parameter.
47
37
 
48
38
  ### Return type
49
39
 
@@ -96,7 +86,8 @@ opts = {
96
86
  industry: "industry_example", # String | Industry of the user.
97
87
  address: "address_example", # String | Street Address of the user.
98
88
  city: "city_example", # String | City of the user.
99
- postal_code: "postal_code_example" # String | Postal/Zip code of the user.
89
+ postal_code: "postal_code_example", # String | Postal/Zip code of the user.
90
+ prevent_welcome_email: "prevent_welcome_email_example" # String | prevent an email with login credentials from being sent to the new account. must be set to 'true'
100
91
  }
101
92
 
102
93
  begin
@@ -123,6 +114,7 @@ Name | Type | Description | Notes
123
114
  **address** | **String**| Street Address of the user. | [optional]
124
115
  **city** | **String**| City of the user. | [optional]
125
116
  **postal_code** | **String**| Postal/Zip code of the user. | [optional]
117
+ **prevent_welcome_email** | **String**| prevent an email with login credentials from being sent to the new account. must be set to 'true' | [optional]
126
118
 
127
119
  ### Return type
128
120
 
@@ -139,31 +131,34 @@ Name | Type | Description | Notes
139
131
 
140
132
 
141
133
 
142
- # **subscription_purchase_allowed**
143
- > subscription_purchase_allowed(opts)
134
+ # **get_client_statistics**
135
+ > get_client_statistics(opts)
144
136
 
145
- Check if subscription purchase allowed.
137
+ Get Client Statistics
146
138
 
147
- Check whether the user can purchase a subscription.
139
+ Gets general statics for a Client
148
140
 
149
141
  ### Example
150
142
  ```ruby
151
143
  # load the gem
152
144
  require 'bombbomb'
145
+ # setup authorization
146
+ BombBomb.configure do |config|
147
+ # Configure OAuth2 access token for authorization: BBOAuth2
148
+ config.access_token = 'YOUR ACCESS TOKEN'
149
+ end
153
150
 
154
151
  api_instance = BombBomb::AccountsApi.new
155
152
 
156
153
  opts = {
157
- email: "email_example", # String | Your login email address
158
- pw: "pw_example", # String | Your password
159
- api_key: "api_key_example" # String | Your Api Key
154
+ client_id: "client_id_example" # String | Client ID of the account to retrieve. Defaults to yourself.
160
155
  }
161
156
 
162
157
  begin
163
- #Check if subscription purchase allowed.
164
- api_instance.subscription_purchase_allowed(opts)
158
+ #Get Client Statistics
159
+ api_instance.get_client_statistics(opts)
165
160
  rescue BombBomb::ApiError => e
166
- puts "Exception when calling AccountsApi->subscription_purchase_allowed: #{e}"
161
+ puts "Exception when calling AccountsApi->get_client_statistics: #{e}"
167
162
  end
168
163
  ```
169
164
 
@@ -171,9 +166,47 @@ end
171
166
 
172
167
  Name | Type | Description | Notes
173
168
  ------------- | ------------- | ------------- | -------------
174
- **email** | **String**| Your login email address | [optional]
175
- **pw** | **String**| Your password | [optional]
176
- **api_key** | **String**| Your Api Key | [optional]
169
+ **client_id** | **String**| Client ID of the account to retrieve. Defaults to yourself. | [optional]
170
+
171
+ ### Return type
172
+
173
+ nil (empty response body)
174
+
175
+ ### Authorization
176
+
177
+ [BBOAuth2](../README.md#BBOAuth2)
178
+
179
+ ### HTTP request headers
180
+
181
+ - **Content-Type**: application/x-www-form-urlencoded
182
+ - **Accept**: application/json
183
+
184
+
185
+
186
+ # **subscription_purchase_allowed**
187
+ > subscription_purchase_allowed
188
+
189
+ Check if subscription purchase allowed.
190
+
191
+ Check whether the user can purchase a subscription.
192
+
193
+ ### Example
194
+ ```ruby
195
+ # load the gem
196
+ require 'bombbomb'
197
+
198
+ api_instance = BombBomb::AccountsApi.new
199
+
200
+ begin
201
+ #Check if subscription purchase allowed.
202
+ api_instance.subscription_purchase_allowed
203
+ rescue BombBomb::ApiError => e
204
+ puts "Exception when calling AccountsApi->subscription_purchase_allowed: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+ This endpoint does not need any parameter.
177
210
 
178
211
  ### Return type
179
212