bombbomb 2.0.24005 → 2.0.25797
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/README.md +44 -20
- data/bombbomb.gemspec +1 -1
- data/docs/AccountsApi.md +61 -28
- data/docs/ContactsApi.md +373 -0
- data/docs/EmailsApi.md +168 -0
- data/docs/FilesApi.md +216 -4
- data/docs/HostedDoc.md +13 -0
- data/docs/IntegrationsApi.md +62 -0
- data/docs/ListsApi.md +98 -0
- data/docs/PromptsApi.md +76 -12
- data/docs/SocialsApi.md +172 -71
- data/docs/TeamsApi.md +295 -1
- data/docs/VideoEmailPrompt.md +6 -0
- data/docs/VideosApi.md +59 -0
- data/lib/bombbomb/api/accounts_api.rb +59 -19
- data/lib/bombbomb/api/automations_api.rb +1 -1
- data/lib/bombbomb/api/contacts_api.rb +408 -1
- data/lib/bombbomb/api/curriculum_api.rb +1 -1
- data/lib/bombbomb/api/emails_api.rb +187 -1
- data/lib/bombbomb/api/files_api.rb +239 -7
- data/lib/bombbomb/api/integrations_api.rb +90 -0
- data/lib/bombbomb/api/lists_api.rb +110 -1
- data/lib/bombbomb/api/orders_api.rb +1 -1
- data/lib/bombbomb/api/prompts_api.rb +90 -20
- data/lib/bombbomb/api/socials_api.rb +210 -109
- data/lib/bombbomb/api/teams_api.rb +332 -1
- data/lib/bombbomb/api/utilities_api.rb +1 -1
- data/lib/bombbomb/api/videos_api.rb +66 -1
- data/lib/bombbomb/api/webhooks_api.rb +1 -1
- data/lib/bombbomb/api_client.rb +1 -1
- data/lib/bombbomb/api_error.rb +1 -1
- data/lib/bombbomb/configuration.rb +1 -1
- data/lib/bombbomb/models/bb_web_hook.rb +1 -1
- data/lib/bombbomb/models/curriculum.rb +1 -1
- data/lib/bombbomb/models/curriculum_user_progress.rb +1 -1
- data/lib/bombbomb/models/curriculum_with_progress.rb +1 -1
- data/lib/bombbomb/models/hosted_doc.rb +250 -0
- data/lib/bombbomb/models/inline_response_200.rb +1 -1
- data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
- data/lib/bombbomb/models/jericho_configuration.rb +1 -1
- data/lib/bombbomb/models/jericho_performance.rb +1 -1
- data/lib/bombbomb/models/o_auth_client.rb +1 -1
- data/lib/bombbomb/models/prompt_bot.rb +1 -1
- data/lib/bombbomb/models/sign_upload_request.rb +1 -1
- data/lib/bombbomb/models/sign_upload_response.rb +1 -1
- data/lib/bombbomb/models/string.rb +1 -1
- data/lib/bombbomb/models/team_public_representation.rb +1 -1
- data/lib/bombbomb/models/video_email_prompt.rb +67 -5
- data/lib/bombbomb/models/video_encoding_status_response.rb +1 -1
- data/lib/bombbomb/models/video_public_representation.rb +1 -1
- data/lib/bombbomb/models/video_recorder_method_response.rb +1 -1
- data/lib/bombbomb/version.rb +2 -2
- data/lib/bombbomb.rb +3 -1
- data/spec/api/integrations_api_spec.rb +58 -0
- data/spec/models/hosted_doc_spec.rb +83 -0
- metadata +11 -3
data/docs/TeamsApi.md
CHANGED
@@ -10,11 +10,16 @@ Method | HTTP request | Description
|
|
10
10
|
[**delete_subteam**](TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
11
11
|
[**get_all_client_group_associations**](TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
|
12
12
|
[**get_client_group_assets**](TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
|
13
|
+
[**get_client_group_statistics**](TeamsApi.md#get_client_group_statistics) | **GET** /team/{teamId}/stats | Get Team statistics
|
13
14
|
[**get_jericho_sends**](TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
14
15
|
[**get_jericho_stats**](TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
16
|
+
[**get_paged_client_group_members**](TeamsApi.md#get_paged_client_group_members) | **GET** /team/{teamId}/members | List Team Members
|
15
17
|
[**get_subteams**](TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
18
|
+
[**get_team_prompt_aggregate_stats**](TeamsApi.md#get_team_prompt_aggregate_stats) | **GET** /team/{clientGroupId}/campaign/stats | Get aggregate stats for campaigns
|
19
|
+
[**get_team_prompt_campaigns**](TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
|
16
20
|
[**queue_jericho_send**](TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
17
21
|
[**remove_member_from_team**](TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
22
|
+
[**resend_team_member_invitation**](TeamsApi.md#resend_team_member_invitation) | **POST** /team/{teamId}/{memberUserId}/rewelcome | Resend invite
|
18
23
|
[**update_jericho_prompt_send**](TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
|
19
24
|
[**update_team**](TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
20
25
|
[**update_team_member**](TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
|
@@ -356,6 +361,61 @@ Name | Type | Description | Notes
|
|
356
361
|
|
357
362
|
|
358
363
|
|
364
|
+
# **get_client_group_statistics**
|
365
|
+
> get_client_group_statistics(team_id, opts)
|
366
|
+
|
367
|
+
Get Team statistics
|
368
|
+
|
369
|
+
Get top level statistic data for a Team
|
370
|
+
|
371
|
+
### Example
|
372
|
+
```ruby
|
373
|
+
# load the gem
|
374
|
+
require 'bombbomb'
|
375
|
+
# setup authorization
|
376
|
+
BombBomb.configure do |config|
|
377
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
378
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
379
|
+
end
|
380
|
+
|
381
|
+
api_instance = BombBomb::TeamsApi.new
|
382
|
+
|
383
|
+
team_id = "team_id_example" # String | The team id
|
384
|
+
|
385
|
+
opts = {
|
386
|
+
member_status: "member_status_example" # String | The status of members to query for
|
387
|
+
}
|
388
|
+
|
389
|
+
begin
|
390
|
+
#Get Team statistics
|
391
|
+
api_instance.get_client_group_statistics(team_id, opts)
|
392
|
+
rescue BombBomb::ApiError => e
|
393
|
+
puts "Exception when calling TeamsApi->get_client_group_statistics: #{e}"
|
394
|
+
end
|
395
|
+
```
|
396
|
+
|
397
|
+
### Parameters
|
398
|
+
|
399
|
+
Name | Type | Description | Notes
|
400
|
+
------------- | ------------- | ------------- | -------------
|
401
|
+
**team_id** | **String**| The team id |
|
402
|
+
**member_status** | **String**| The status of members to query for | [optional]
|
403
|
+
|
404
|
+
### Return type
|
405
|
+
|
406
|
+
nil (empty response body)
|
407
|
+
|
408
|
+
### Authorization
|
409
|
+
|
410
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
411
|
+
|
412
|
+
### HTTP request headers
|
413
|
+
|
414
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
415
|
+
- **Accept**: application/json
|
416
|
+
|
417
|
+
|
418
|
+
|
359
419
|
# **get_jericho_sends**
|
360
420
|
> Array<JerichoConfiguration> get_jericho_sends(team_id)
|
361
421
|
|
@@ -463,6 +523,73 @@ Name | Type | Description | Notes
|
|
463
523
|
|
464
524
|
|
465
525
|
|
526
|
+
# **get_paged_client_group_members**
|
527
|
+
> get_paged_client_group_members(team_id, page_size, page, opts)
|
528
|
+
|
529
|
+
List Team Members
|
530
|
+
|
531
|
+
Get a paginated listing of Team members
|
532
|
+
|
533
|
+
### Example
|
534
|
+
```ruby
|
535
|
+
# load the gem
|
536
|
+
require 'bombbomb'
|
537
|
+
# setup authorization
|
538
|
+
BombBomb.configure do |config|
|
539
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
540
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
541
|
+
end
|
542
|
+
|
543
|
+
api_instance = BombBomb::TeamsApi.new
|
544
|
+
|
545
|
+
team_id = "team_id_example" # String | The team id
|
546
|
+
|
547
|
+
page_size = "page_size_example" # String | Amount of records to return in a page.
|
548
|
+
|
549
|
+
page = "page_example" # String | The page to return.
|
550
|
+
|
551
|
+
opts = {
|
552
|
+
status: "status_example", # String | The status type to filter by.
|
553
|
+
search: "search_example", # String | Filter results with names that match the search term.
|
554
|
+
order_by: "order_by_example", # String | Key to order results by
|
555
|
+
order_direction: "order_direction_example" # String | ASC or DESC
|
556
|
+
}
|
557
|
+
|
558
|
+
begin
|
559
|
+
#List Team Members
|
560
|
+
api_instance.get_paged_client_group_members(team_id, page_size, page, opts)
|
561
|
+
rescue BombBomb::ApiError => e
|
562
|
+
puts "Exception when calling TeamsApi->get_paged_client_group_members: #{e}"
|
563
|
+
end
|
564
|
+
```
|
565
|
+
|
566
|
+
### Parameters
|
567
|
+
|
568
|
+
Name | Type | Description | Notes
|
569
|
+
------------- | ------------- | ------------- | -------------
|
570
|
+
**team_id** | **String**| The team id |
|
571
|
+
**page_size** | **String**| Amount of records to return in a page. |
|
572
|
+
**page** | **String**| The page to return. |
|
573
|
+
**status** | **String**| The status type to filter by. | [optional]
|
574
|
+
**search** | **String**| Filter results with names that match the search term. | [optional]
|
575
|
+
**order_by** | **String**| Key to order results by | [optional]
|
576
|
+
**order_direction** | **String**| ASC or DESC | [optional]
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
nil (empty response body)
|
581
|
+
|
582
|
+
### Authorization
|
583
|
+
|
584
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
585
|
+
|
586
|
+
### HTTP request headers
|
587
|
+
|
588
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
589
|
+
- **Accept**: application/json
|
590
|
+
|
591
|
+
|
592
|
+
|
466
593
|
# **get_subteams**
|
467
594
|
> Array<TeamPublicRepresentation> get_subteams(team_id)
|
468
595
|
|
@@ -515,6 +642,116 @@ Name | Type | Description | Notes
|
|
515
642
|
|
516
643
|
|
517
644
|
|
645
|
+
# **get_team_prompt_aggregate_stats**
|
646
|
+
> get_team_prompt_aggregate_stats(client_group_id)
|
647
|
+
|
648
|
+
Get aggregate stats for campaigns
|
649
|
+
|
650
|
+
Get all the campaigns aggregate stats
|
651
|
+
|
652
|
+
### Example
|
653
|
+
```ruby
|
654
|
+
# load the gem
|
655
|
+
require 'bombbomb'
|
656
|
+
# setup authorization
|
657
|
+
BombBomb.configure do |config|
|
658
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
659
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
660
|
+
end
|
661
|
+
|
662
|
+
api_instance = BombBomb::TeamsApi.new
|
663
|
+
|
664
|
+
client_group_id = "client_group_id_example" # String | ID of the client group association
|
665
|
+
|
666
|
+
|
667
|
+
begin
|
668
|
+
#Get aggregate stats for campaigns
|
669
|
+
api_instance.get_team_prompt_aggregate_stats(client_group_id)
|
670
|
+
rescue BombBomb::ApiError => e
|
671
|
+
puts "Exception when calling TeamsApi->get_team_prompt_aggregate_stats: #{e}"
|
672
|
+
end
|
673
|
+
```
|
674
|
+
|
675
|
+
### Parameters
|
676
|
+
|
677
|
+
Name | Type | Description | Notes
|
678
|
+
------------- | ------------- | ------------- | -------------
|
679
|
+
**client_group_id** | **String**| ID of the client group association |
|
680
|
+
|
681
|
+
### Return type
|
682
|
+
|
683
|
+
nil (empty response body)
|
684
|
+
|
685
|
+
### Authorization
|
686
|
+
|
687
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
688
|
+
|
689
|
+
### HTTP request headers
|
690
|
+
|
691
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
692
|
+
- **Accept**: application/json
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
# **get_team_prompt_campaigns**
|
697
|
+
> get_team_prompt_campaigns(client_group_id, opts)
|
698
|
+
|
699
|
+
Get campaigns for team
|
700
|
+
|
701
|
+
Get campaigns for the team and their stats
|
702
|
+
|
703
|
+
### Example
|
704
|
+
```ruby
|
705
|
+
# load the gem
|
706
|
+
require 'bombbomb'
|
707
|
+
# setup authorization
|
708
|
+
BombBomb.configure do |config|
|
709
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
710
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
711
|
+
end
|
712
|
+
|
713
|
+
api_instance = BombBomb::TeamsApi.new
|
714
|
+
|
715
|
+
client_group_id = "client_group_id_example" # String | ID of the client group association
|
716
|
+
|
717
|
+
opts = {
|
718
|
+
search_term: "search_term_example", # String | The value to search for in prompt subject
|
719
|
+
order_by: "order_by_example", # String | How to sort the column
|
720
|
+
asc: "asc_example" # String | Ascending or not
|
721
|
+
}
|
722
|
+
|
723
|
+
begin
|
724
|
+
#Get campaigns for team
|
725
|
+
api_instance.get_team_prompt_campaigns(client_group_id, opts)
|
726
|
+
rescue BombBomb::ApiError => e
|
727
|
+
puts "Exception when calling TeamsApi->get_team_prompt_campaigns: #{e}"
|
728
|
+
end
|
729
|
+
```
|
730
|
+
|
731
|
+
### Parameters
|
732
|
+
|
733
|
+
Name | Type | Description | Notes
|
734
|
+
------------- | ------------- | ------------- | -------------
|
735
|
+
**client_group_id** | **String**| ID of the client group association |
|
736
|
+
**search_term** | **String**| The value to search for in prompt subject | [optional]
|
737
|
+
**order_by** | **String**| How to sort the column | [optional]
|
738
|
+
**asc** | **String**| Ascending or not | [optional]
|
739
|
+
|
740
|
+
### Return type
|
741
|
+
|
742
|
+
nil (empty response body)
|
743
|
+
|
744
|
+
### Authorization
|
745
|
+
|
746
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
747
|
+
|
748
|
+
### HTTP request headers
|
749
|
+
|
750
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
751
|
+
- **Accept**: application/json
|
752
|
+
|
753
|
+
|
754
|
+
|
518
755
|
# **queue_jericho_send**
|
519
756
|
> JerichoConfiguration queue_jericho_send(config, team_id)
|
520
757
|
|
@@ -625,6 +862,61 @@ Name | Type | Description | Notes
|
|
625
862
|
|
626
863
|
|
627
864
|
|
865
|
+
# **resend_team_member_invitation**
|
866
|
+
> TeamPublicRepresentation resend_team_member_invitation(team_id, member_user_id)
|
867
|
+
|
868
|
+
Resend invite
|
869
|
+
|
870
|
+
Resend invitation to a member of a team
|
871
|
+
|
872
|
+
### Example
|
873
|
+
```ruby
|
874
|
+
# load the gem
|
875
|
+
require 'bombbomb'
|
876
|
+
# setup authorization
|
877
|
+
BombBomb.configure do |config|
|
878
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
879
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
880
|
+
end
|
881
|
+
|
882
|
+
api_instance = BombBomb::TeamsApi.new
|
883
|
+
|
884
|
+
team_id = "team_id_example" # String | The team id
|
885
|
+
|
886
|
+
member_user_id = "member_user_id_example" # String | The user id of the member being resent an invitation.
|
887
|
+
|
888
|
+
|
889
|
+
begin
|
890
|
+
#Resend invite
|
891
|
+
result = api_instance.resend_team_member_invitation(team_id, member_user_id)
|
892
|
+
p result
|
893
|
+
rescue BombBomb::ApiError => e
|
894
|
+
puts "Exception when calling TeamsApi->resend_team_member_invitation: #{e}"
|
895
|
+
end
|
896
|
+
```
|
897
|
+
|
898
|
+
### Parameters
|
899
|
+
|
900
|
+
Name | Type | Description | Notes
|
901
|
+
------------- | ------------- | ------------- | -------------
|
902
|
+
**team_id** | **String**| The team id |
|
903
|
+
**member_user_id** | **String**| The user id of the member being resent an invitation. |
|
904
|
+
|
905
|
+
### Return type
|
906
|
+
|
907
|
+
[**TeamPublicRepresentation**](TeamPublicRepresentation.md)
|
908
|
+
|
909
|
+
### Authorization
|
910
|
+
|
911
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
912
|
+
|
913
|
+
### HTTP request headers
|
914
|
+
|
915
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
916
|
+
- **Accept**: application/json
|
917
|
+
|
918
|
+
|
919
|
+
|
628
920
|
# **update_jericho_prompt_send**
|
629
921
|
> update_jericho_prompt_send(team_id, jericho_id)
|
630
922
|
|
@@ -701,7 +993,8 @@ api_instance = BombBomb::TeamsApi.new
|
|
701
993
|
team_id = "team_id_example" # String | The team id
|
702
994
|
|
703
995
|
opts = {
|
704
|
-
name: "name_example" # String | The name of the team
|
996
|
+
name: "name_example", # String | The name of the team
|
997
|
+
state: "state_example" # String | The status of the login permissions
|
705
998
|
}
|
706
999
|
|
707
1000
|
begin
|
@@ -719,6 +1012,7 @@ Name | Type | Description | Notes
|
|
719
1012
|
------------- | ------------- | ------------- | -------------
|
720
1013
|
**team_id** | **String**| The team id |
|
721
1014
|
**name** | **String**| The name of the team | [optional]
|
1015
|
+
**state** | **String**| The status of the login permissions | [optional]
|
722
1016
|
|
723
1017
|
### Return type
|
724
1018
|
|
data/docs/VideoEmailPrompt.md
CHANGED
@@ -29,5 +29,11 @@ Name | Type | Description | Notes
|
|
29
29
|
**apply_template** | **BOOLEAN** | Controls whether a user template is applied to the message as it is sent | [optional]
|
30
30
|
**created_date** | **DateTime** | When the email was first sent out | [optional]
|
31
31
|
**last_notified** | **DateTime** | When the user was last notified about a prompt email waiting for a video | [optional]
|
32
|
+
**facebook_message** | **String** | The facebook message to be passed off to social sender | [optional]
|
33
|
+
**twitter_message** | **String** | The twitter message to be passed off to social sender | [optional]
|
34
|
+
**linkedin_message** | **String** | The linkedin message to be passed off to social sender | [optional]
|
35
|
+
**send_mechanism** | **String** | The sendMechanism property | [optional]
|
36
|
+
**has_social** | **BOOLEAN** | this determines whether or not it has a social content. | [optional]
|
37
|
+
**send_types** | **Array<String>** | The types of mechanisms this prompt can send. | [optional]
|
32
38
|
|
33
39
|
|
data/docs/VideosApi.md
CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
[**get_video_recorder**](VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
|
9
9
|
[**mark_live_recording_complete**](VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
|
10
10
|
[**sign_upload**](VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
|
11
|
+
[**update_video_thumbnail_v2**](VideosApi.md#update_video_thumbnail_v2) | **PUT** /videos/thumbnail | Upload thumbnail
|
11
12
|
|
12
13
|
|
13
14
|
# **get_video_encoding_status**
|
@@ -226,3 +227,61 @@ No authorization required
|
|
226
227
|
|
227
228
|
|
228
229
|
|
230
|
+
# **update_video_thumbnail_v2**
|
231
|
+
> update_video_thumbnail_v2(video_id, thumbnail, opts)
|
232
|
+
|
233
|
+
Upload thumbnail
|
234
|
+
|
235
|
+
Upload a new video thumbnail
|
236
|
+
|
237
|
+
### Example
|
238
|
+
```ruby
|
239
|
+
# load the gem
|
240
|
+
require 'bombbomb'
|
241
|
+
# setup authorization
|
242
|
+
BombBomb.configure do |config|
|
243
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
244
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
245
|
+
end
|
246
|
+
|
247
|
+
api_instance = BombBomb::VideosApi.new
|
248
|
+
|
249
|
+
video_id = "video_id_example" # String | The id of the video
|
250
|
+
|
251
|
+
thumbnail = "thumbnail_example" # String | The thumbnail being uploaded
|
252
|
+
|
253
|
+
opts = {
|
254
|
+
custom: true # BOOLEAN | The default email to use.
|
255
|
+
}
|
256
|
+
|
257
|
+
begin
|
258
|
+
#Upload thumbnail
|
259
|
+
api_instance.update_video_thumbnail_v2(video_id, thumbnail, opts)
|
260
|
+
rescue BombBomb::ApiError => e
|
261
|
+
puts "Exception when calling VideosApi->update_video_thumbnail_v2: #{e}"
|
262
|
+
end
|
263
|
+
```
|
264
|
+
|
265
|
+
### Parameters
|
266
|
+
|
267
|
+
Name | Type | Description | Notes
|
268
|
+
------------- | ------------- | ------------- | -------------
|
269
|
+
**video_id** | **String**| The id of the video |
|
270
|
+
**thumbnail** | **String**| The thumbnail being uploaded |
|
271
|
+
**custom** | **BOOLEAN**| The default email to use. | [optional]
|
272
|
+
|
273
|
+
### Return type
|
274
|
+
|
275
|
+
nil (empty response body)
|
276
|
+
|
277
|
+
### Authorization
|
278
|
+
|
279
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
280
|
+
|
281
|
+
### HTTP request headers
|
282
|
+
|
283
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
284
|
+
- **Accept**: application/json
|
285
|
+
|
286
|
+
|
287
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#We make it easy to build relationships using simple videos.
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.0.
|
6
|
+
OpenAPI spec version: 2.0.25797
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -34,9 +34,6 @@ module BombBomb
|
|
34
34
|
# Get account details.
|
35
35
|
# Get the details of the user's account.
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :email Your login email address
|
38
|
-
# @option opts [String] :pw Your password
|
39
|
-
# @option opts [String] :api_key Your Api Key
|
40
37
|
# @return [nil]
|
41
38
|
def account_details(opts = {})
|
42
39
|
account_details_with_http_info(opts)
|
@@ -46,9 +43,6 @@ module BombBomb
|
|
46
43
|
# Get account details.
|
47
44
|
# Get the details of the user's account.
|
48
45
|
# @param [Hash] opts the optional parameters
|
49
|
-
# @option opts [String] :email Your login email address
|
50
|
-
# @option opts [String] :pw Your password
|
51
|
-
# @option opts [String] :api_key Your Api Key
|
52
46
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
53
47
|
def account_details_with_http_info(opts = {})
|
54
48
|
if @api_client.config.debugging
|
@@ -59,9 +53,6 @@ module BombBomb
|
|
59
53
|
|
60
54
|
# query parameters
|
61
55
|
query_params = {}
|
62
|
-
query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
|
63
|
-
query_params[:'pw'] = opts[:'pw'] if !opts[:'pw'].nil?
|
64
|
-
query_params[:'api_key'] = opts[:'api_key'] if !opts[:'api_key'].nil?
|
65
56
|
|
66
57
|
# header parameters
|
67
58
|
header_params = {}
|
@@ -106,6 +97,7 @@ module BombBomb
|
|
106
97
|
# @option opts [String] :address Street Address of the user.
|
107
98
|
# @option opts [String] :city City of the user.
|
108
99
|
# @option opts [String] :postal_code Postal/Zip code of the user.
|
100
|
+
# @option opts [String] :prevent_welcome_email prevent an email with login credentials from being sent to the new account. must be set to 'true'
|
109
101
|
# @return [String]
|
110
102
|
def create_account(team_id, first_name, last_name, email_address, company_name, phone, opts = {})
|
111
103
|
data, _status_code, _headers = create_account_with_http_info(team_id, first_name, last_name, email_address, company_name, phone, opts)
|
@@ -126,6 +118,7 @@ module BombBomb
|
|
126
118
|
# @option opts [String] :address Street Address of the user.
|
127
119
|
# @option opts [String] :city City of the user.
|
128
120
|
# @option opts [String] :postal_code Postal/Zip code of the user.
|
121
|
+
# @option opts [String] :prevent_welcome_email prevent an email with login credentials from being sent to the new account. must be set to 'true'
|
129
122
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
130
123
|
def create_account_with_http_info(team_id, first_name, last_name, email_address, company_name, phone, opts = {})
|
131
124
|
if @api_client.config.debugging
|
@@ -173,6 +166,7 @@ module BombBomb
|
|
173
166
|
form_params["address"] = opts[:'address'] if !opts[:'address'].nil?
|
174
167
|
form_params["city"] = opts[:'city'] if !opts[:'city'].nil?
|
175
168
|
form_params["postalCode"] = opts[:'postal_code'] if !opts[:'postal_code'].nil?
|
169
|
+
form_params["preventWelcomeEmail"] = opts[:'prevent_welcome_email'] if !opts[:'prevent_welcome_email'].nil?
|
176
170
|
|
177
171
|
# http body (model)
|
178
172
|
post_body = nil
|
@@ -190,12 +184,64 @@ module BombBomb
|
|
190
184
|
return data, status_code, headers
|
191
185
|
end
|
192
186
|
|
187
|
+
# Get Client Statistics
|
188
|
+
# Gets general statics for a Client
|
189
|
+
# @param [Hash] opts the optional parameters
|
190
|
+
# @option opts [String] :client_id Client ID of the account to retrieve. Defaults to yourself.
|
191
|
+
# @return [nil]
|
192
|
+
def get_client_statistics(opts = {})
|
193
|
+
get_client_statistics_with_http_info(opts)
|
194
|
+
return nil
|
195
|
+
end
|
196
|
+
|
197
|
+
# Get Client Statistics
|
198
|
+
# Gets general statics for a Client
|
199
|
+
# @param [Hash] opts the optional parameters
|
200
|
+
# @option opts [String] :client_id Client ID of the account to retrieve. Defaults to yourself.
|
201
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
202
|
+
def get_client_statistics_with_http_info(opts = {})
|
203
|
+
if @api_client.config.debugging
|
204
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_client_statistics ..."
|
205
|
+
end
|
206
|
+
# resource path
|
207
|
+
local_var_path = "/accounts/stats".sub('{format}','json')
|
208
|
+
|
209
|
+
# query parameters
|
210
|
+
query_params = {}
|
211
|
+
query_params[:'clientId'] = opts[:'client_id'] if !opts[:'client_id'].nil?
|
212
|
+
|
213
|
+
# header parameters
|
214
|
+
header_params = {}
|
215
|
+
|
216
|
+
# HTTP header 'Accept' (if needed)
|
217
|
+
local_header_accept = ['application/json']
|
218
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
219
|
+
|
220
|
+
# HTTP header 'Content-Type'
|
221
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
222
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
223
|
+
|
224
|
+
# form parameters
|
225
|
+
form_params = {}
|
226
|
+
|
227
|
+
# http body (model)
|
228
|
+
post_body = nil
|
229
|
+
auth_names = ['BBOAuth2']
|
230
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
231
|
+
:header_params => header_params,
|
232
|
+
:query_params => query_params,
|
233
|
+
:form_params => form_params,
|
234
|
+
:body => post_body,
|
235
|
+
:auth_names => auth_names)
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_client_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
238
|
+
end
|
239
|
+
return data, status_code, headers
|
240
|
+
end
|
241
|
+
|
193
242
|
# Check if subscription purchase allowed.
|
194
243
|
# Check whether the user can purchase a subscription.
|
195
244
|
# @param [Hash] opts the optional parameters
|
196
|
-
# @option opts [String] :email Your login email address
|
197
|
-
# @option opts [String] :pw Your password
|
198
|
-
# @option opts [String] :api_key Your Api Key
|
199
245
|
# @return [nil]
|
200
246
|
def subscription_purchase_allowed(opts = {})
|
201
247
|
subscription_purchase_allowed_with_http_info(opts)
|
@@ -205,9 +251,6 @@ module BombBomb
|
|
205
251
|
# Check if subscription purchase allowed.
|
206
252
|
# Check whether the user can purchase a subscription.
|
207
253
|
# @param [Hash] opts the optional parameters
|
208
|
-
# @option opts [String] :email Your login email address
|
209
|
-
# @option opts [String] :pw Your password
|
210
|
-
# @option opts [String] :api_key Your Api Key
|
211
254
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
212
255
|
def subscription_purchase_allowed_with_http_info(opts = {})
|
213
256
|
if @api_client.config.debugging
|
@@ -218,9 +261,6 @@ module BombBomb
|
|
218
261
|
|
219
262
|
# query parameters
|
220
263
|
query_params = {}
|
221
|
-
query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
|
222
|
-
query_params[:'pw'] = opts[:'pw'] if !opts[:'pw'].nil?
|
223
|
-
query_params[:'api_key'] = opts[:'api_key'] if !opts[:'api_key'].nil?
|
224
264
|
|
225
265
|
# header parameters
|
226
266
|
header_params = {}
|