bombbomb 2.0.20679 → 2.0.21432
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 -13
- data/README.md +28 -12
- data/bombbomb.gemspec +1 -1
- data/docs/Curriculum.md +15 -0
- data/docs/CurriculumApi.md +109 -0
- data/docs/CurriculumUserProgress.md +12 -0
- data/docs/CurriculumWithProgress.md +15 -0
- data/docs/PromptsApi.md +3 -3
- data/docs/TeamPublicRepresentation.md +10 -0
- data/docs/TeamsApi.md +344 -5
- data/docs/UtilitiesApi.md +4 -4
- data/docs/WebhooksApi.md +45 -4
- data/lib/bombbomb.rb +6 -1
- data/lib/bombbomb/api/curriculum_api.rb +143 -0
- data/lib/bombbomb/api/prompts_api.rb +4 -4
- data/lib/bombbomb/api/teams_api.rb +374 -6
- data/lib/bombbomb/api/utilities_api.rb +5 -5
- data/lib/bombbomb/api/webhooks_api.rb +57 -5
- 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 +272 -0
- data/lib/bombbomb/models/curriculum_user_progress.rb +240 -0
- data/lib/bombbomb/models/curriculum_with_progress.rb +272 -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/string.rb +1 -1
- data/lib/bombbomb/models/team_public_representation.rb +220 -0
- data/lib/bombbomb/models/video_email_prompt.rb +1 -1
- data/lib/bombbomb/version.rb +2 -2
- data/spec/api/curriculum_api_spec.rb +69 -0
- data/spec/models/curriculum_spec.rb +95 -0
- data/spec/models/curriculum_user_progress_spec.rb +77 -0
- data/spec/models/curriculum_with_progress_spec.rb +95 -0
- data/spec/models/team_public_representation_spec.rb +65 -0
- metadata +60 -40
checksums.yaml
CHANGED
@@ -1,15 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
|
5
|
-
data.tar.gz: !binary |-
|
6
|
-
YWFmNTk0NTMxMDcwNjVmYjJkNzc5MmMzYWE4NWZhOTkzMmM0ZGMzOA==
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 3cdd328377afc1841357ec5c89969004862c5ad4
|
4
|
+
data.tar.gz: 9e8bbb55b7d4b6df3645a700edb3fdd61f81037d
|
7
5
|
SHA512:
|
8
|
-
metadata.gz:
|
9
|
-
|
10
|
-
ZGIzN2M2ZDU0MTY5ZjFiMjFhZDljODU2YWMwMTlmOTczYWUyZjAyNThlYTU1
|
11
|
-
NWRhYTg1MGU1NmU2NGU5NTkwOWVhMmFlOWFiMDdjNGIwYzljM2Y=
|
12
|
-
data.tar.gz: !binary |-
|
13
|
-
MmE3YWJhNjZiMmNjMDc1MGNjOWU5YjViYmZlODcwN2IxY2NmOTY4OTE1ZDBk
|
14
|
-
MTk5MGU5MGVmY2Y4OWYxZjUzZDc3MjUwZWYzZjg3NDI5NjliNTViOTlmOTU5
|
15
|
-
MDNhNDdhODU0MWEzYmM1MDJjNjIyMjZjYTliNmNjMjg0Y2IxM2E=
|
6
|
+
metadata.gz: be5694253a065eb4ae2f983ea3bd980033fe407debfd28b5fcc1dc974a711a44fd3d261588fd5acf65dd5c4f7290a739c973f1b55ce3eab32f289f0bbd297eb3
|
7
|
+
data.tar.gz: 604d8722fd799d3b8cc1125ce0378ae6a5d948e30d85e34d904f5550d696b5a3578057d2fc51f9d4fa203a971f7d61a538444e0b944aec5681829e026bca0ea4
|
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.
|
10
|
-
- Package version: 2.0.
|
11
|
-
- Build date: 2016-
|
9
|
+
- API version: 2.0.21432
|
10
|
+
- Package version: 2.0.21432
|
11
|
+
- Build date: 2016-11-14T17:57:56.615Z
|
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.
|
27
|
+
gem install ./bombbomb-2.0.21432.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./bombbomb-2.0.
|
29
|
+
(for development, run `gem install --dev ./bombbomb-2.0.21432.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.
|
35
|
+
gem 'bombbomb', '~> 2.0.21432'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -61,17 +61,18 @@ BombBomb.configure do |config|
|
|
61
61
|
config.access_token = 'YOUR ACCESS TOKEN'
|
62
62
|
end
|
63
63
|
|
64
|
-
api_instance = BombBomb::
|
65
|
-
|
66
|
-
prompt = BombBomb::VideoEmailPrompt.new # VideoEmailPrompt | The Video Email Prompt to be created
|
64
|
+
api_instance = BombBomb::CurriculumApi.new
|
67
65
|
|
66
|
+
opts = {
|
67
|
+
include_progress: true # BOOLEAN | Whether to return progress with the curriculum.
|
68
|
+
}
|
68
69
|
|
69
70
|
begin
|
70
|
-
#
|
71
|
-
result = api_instance.
|
71
|
+
#Get Curricula
|
72
|
+
result = api_instance.get_curricula(opts)
|
72
73
|
p result
|
73
74
|
rescue BombBomb::ApiError => e
|
74
|
-
puts "Exception when calling
|
75
|
+
puts "Exception when calling CurriculumApi->get_curricula: #{e}"
|
75
76
|
end
|
76
77
|
|
77
78
|
```
|
@@ -82,14 +83,22 @@ All URIs are relative to *https://api.bombbomb.com/v2*
|
|
82
83
|
|
83
84
|
Class | Method | HTTP request | Description
|
84
85
|
------------ | ------------- | ------------- | -------------
|
86
|
+
*BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
|
87
|
+
*BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
|
85
88
|
*BombBomb::PromptsApi* | [**create_video_email_prompt**](docs/PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
|
86
89
|
*BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
|
87
90
|
*BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
|
91
|
+
*BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
|
88
92
|
*BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
|
93
|
+
*BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
|
94
|
+
*BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
89
95
|
*BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
|
90
96
|
*BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
91
97
|
*BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
98
|
+
*BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
92
99
|
*BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
100
|
+
*BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
101
|
+
*BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
93
102
|
*BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
|
94
103
|
*BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
|
95
104
|
*BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
|
@@ -97,18 +106,23 @@ Class | Method | HTTP request | Description
|
|
97
106
|
*BombBomb::WebhooksApi* | [**add_web_hook**](docs/WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
|
98
107
|
*BombBomb::WebhooksApi* | [**delete_web_hook**](docs/WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
|
99
108
|
*BombBomb::WebhooksApi* | [**get_web_hooks**](docs/WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
|
109
|
+
*BombBomb::WebhooksApi* | [**list_web_hook_events**](docs/WebhooksApi.md#list_web_hook_events) | **GET** /webhook/events | Describe WebHook Events
|
100
110
|
*BombBomb::WebhooksApi* | [**send_webhook_example**](docs/WebhooksApi.md#send_webhook_example) | **POST** /webhook/test | Sends test Webhook
|
101
111
|
|
102
112
|
|
103
113
|
## Documentation for Models
|
104
114
|
|
105
115
|
- [BombBomb::BBWebHook](docs/BBWebHook.md)
|
116
|
+
- [BombBomb::Curriculum](docs/Curriculum.md)
|
117
|
+
- [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
|
118
|
+
- [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
|
106
119
|
- [BombBomb::InlineResponse200](docs/InlineResponse200.md)
|
107
120
|
- [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
|
108
121
|
- [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
|
109
122
|
- [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
|
110
123
|
- [BombBomb::OAuthClient](docs/OAuthClient.md)
|
111
124
|
- [BombBomb::String](docs/String.md)
|
125
|
+
- [BombBomb::TeamPublicRepresentation](docs/TeamPublicRepresentation.md)
|
112
126
|
- [BombBomb::VideoEmailPrompt](docs/VideoEmailPrompt.md)
|
113
127
|
|
114
128
|
|
@@ -129,6 +143,8 @@ Class | Method | HTTP request | Description
|
|
129
143
|
- video:read: Read Video
|
130
144
|
- contact:manage: Manage Contact
|
131
145
|
- contact:read: Read Contact
|
146
|
+
- curriculum:manage: Manage Curriculum
|
147
|
+
- curriculum:read: Read Curriculum
|
132
148
|
- automation:manage: Manage Automation
|
133
149
|
- automation:read: Read Automation
|
134
150
|
- form:manage: Manage Form
|
data/bombbomb.gemspec
CHANGED
data/docs/Curriculum.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# BombBomb::Curriculum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id | [optional]
|
7
|
+
**name** | **String** | Name | [optional]
|
8
|
+
**html_intro** | **String** | HTML formatted intro | [optional]
|
9
|
+
**img_url** | **String** | URI of header image | [optional]
|
10
|
+
**item_count** | **Integer** | Number of curriculum items | [optional]
|
11
|
+
**render_as** | **String** | Render method for curriculum | [optional]
|
12
|
+
**visible_to_all_users** | **BOOLEAN** | Globally visible | [optional]
|
13
|
+
**progress** | [**Array<CurriculumUserProgress>**](CurriculumUserProgress.md) | Collection of User Progress for Curriculum | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,109 @@
|
|
1
|
+
# BombBomb::CurriculumApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.bombbomb.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_curricula**](CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
|
8
|
+
[**get_user_curriculum_with_progress**](CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
|
9
|
+
|
10
|
+
|
11
|
+
# **get_curricula**
|
12
|
+
> Array<Curriculum> get_curricula(opts)
|
13
|
+
|
14
|
+
Get Curricula
|
15
|
+
|
16
|
+
Get Curricula, optionally with progress included.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'bombbomb'
|
22
|
+
# setup authorization
|
23
|
+
BombBomb.configure do |config|
|
24
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
25
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
26
|
+
end
|
27
|
+
|
28
|
+
api_instance = BombBomb::CurriculumApi.new
|
29
|
+
|
30
|
+
opts = {
|
31
|
+
include_progress: true # BOOLEAN | Whether to return progress with the curriculum.
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Get Curricula
|
36
|
+
result = api_instance.get_curricula(opts)
|
37
|
+
p result
|
38
|
+
rescue BombBomb::ApiError => e
|
39
|
+
puts "Exception when calling CurriculumApi->get_curricula: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**include_progress** | **BOOLEAN**| Whether to return progress with the curriculum. | [optional]
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**Array<Curriculum>**](Curriculum.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
60
|
+
- **Accept**: application/json
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
# **get_user_curriculum_with_progress**
|
65
|
+
> Array<CurriculumWithProgress> get_user_curriculum_with_progress
|
66
|
+
|
67
|
+
Get Detailed For User
|
68
|
+
|
69
|
+
Get all curricula for user including progress for each curriculum.
|
70
|
+
|
71
|
+
### Example
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'bombbomb'
|
75
|
+
# setup authorization
|
76
|
+
BombBomb.configure do |config|
|
77
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
78
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
79
|
+
end
|
80
|
+
|
81
|
+
api_instance = BombBomb::CurriculumApi.new
|
82
|
+
|
83
|
+
begin
|
84
|
+
#Get Detailed For User
|
85
|
+
result = api_instance.get_user_curriculum_with_progress
|
86
|
+
p result
|
87
|
+
rescue BombBomb::ApiError => e
|
88
|
+
puts "Exception when calling CurriculumApi->get_user_curriculum_with_progress: #{e}"
|
89
|
+
end
|
90
|
+
```
|
91
|
+
|
92
|
+
### Parameters
|
93
|
+
This endpoint does not need any parameter.
|
94
|
+
|
95
|
+
### Return type
|
96
|
+
|
97
|
+
[**Array<CurriculumWithProgress>**](CurriculumWithProgress.md)
|
98
|
+
|
99
|
+
### Authorization
|
100
|
+
|
101
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
102
|
+
|
103
|
+
### HTTP request headers
|
104
|
+
|
105
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
106
|
+
- **Accept**: application/json
|
107
|
+
|
108
|
+
|
109
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# BombBomb::CurriculumUserProgress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id | [optional]
|
7
|
+
**user_id** | **String** | User Id | [optional]
|
8
|
+
**curriculum_item_id** | **String** | Curriculum Item Id | [optional]
|
9
|
+
**curriculum_id** | **String** | Curriculum Id | [optional]
|
10
|
+
**completed_date** | **DateTime** | When the final email is scheduled to be sent | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# BombBomb::CurriculumWithProgress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**progress** | [**Array<CurriculumUserProgress>**](CurriculumUserProgress.md) | Collection of User Progress for Curriculum | [optional]
|
7
|
+
**id** | **String** | Id | [optional]
|
8
|
+
**name** | **String** | Name | [optional]
|
9
|
+
**html_intro** | **String** | HTML formatted intro | [optional]
|
10
|
+
**img_url** | **String** | URI of header image | [optional]
|
11
|
+
**item_count** | **Integer** | Number of curriculum items | [optional]
|
12
|
+
**render_as** | **String** | Render method for curriculum | [optional]
|
13
|
+
**visible_to_all_users** | **BOOLEAN** | Globally visible | [optional]
|
14
|
+
|
15
|
+
|
data/docs/PromptsApi.md
CHANGED
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
|
|
56
56
|
|
57
57
|
### HTTP request headers
|
58
58
|
|
59
|
-
- **Content-Type**:
|
59
|
+
- **Content-Type**: application/json
|
60
60
|
- **Accept**: application/json
|
61
61
|
|
62
62
|
|
@@ -108,7 +108,7 @@ Name | Type | Description | Notes
|
|
108
108
|
|
109
109
|
### HTTP request headers
|
110
110
|
|
111
|
-
- **Content-Type**:
|
111
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
112
112
|
- **Accept**: application/json
|
113
113
|
|
114
114
|
|
@@ -162,7 +162,7 @@ No authorization required
|
|
162
162
|
|
163
163
|
### HTTP request headers
|
164
164
|
|
165
|
-
- **Content-Type**:
|
165
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
166
166
|
- **Accept**: application/json
|
167
167
|
|
168
168
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# BombBomb::TeamPublicRepresentation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the team | [optional]
|
7
|
+
**name** | **String** | The name of the team | [optional]
|
8
|
+
**created_date** | **String** | The date the team was created | [optional]
|
9
|
+
|
10
|
+
|
data/docs/TeamsApi.md
CHANGED
@@ -4,11 +4,77 @@ All URIs are relative to *https://api.bombbomb.com/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_team_member**](TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
|
7
8
|
[**cancel_jericho_send**](TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
|
9
|
+
[**create_subteam**](TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
|
10
|
+
[**delete_subteam**](TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
|
8
11
|
[**get_client_group_assets**](TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
|
9
12
|
[**get_jericho_sends**](TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
|
10
13
|
[**get_jericho_stats**](TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
|
14
|
+
[**get_subteams**](TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
|
11
15
|
[**queue_jericho_send**](TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
|
16
|
+
[**remove_member_from_team**](TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
|
17
|
+
[**update_team**](TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
|
18
|
+
|
19
|
+
|
20
|
+
# **add_team_member**
|
21
|
+
> String add_team_member(team_id, opts)
|
22
|
+
|
23
|
+
Add Member to Team
|
24
|
+
|
25
|
+
Adds a member to a team.
|
26
|
+
|
27
|
+
### Example
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'bombbomb'
|
31
|
+
# setup authorization
|
32
|
+
BombBomb.configure do |config|
|
33
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
34
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = BombBomb::TeamsApi.new
|
38
|
+
|
39
|
+
team_id = "team_id_example" # String | The team id
|
40
|
+
|
41
|
+
opts = {
|
42
|
+
user_id: "user_id_example", # String | The user id of the member being added to the team.
|
43
|
+
user_email: "user_email_example", # String | The email of the member being added to the team.
|
44
|
+
admin: true # BOOLEAN | Set if the user is an admin of this team.
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Add Member to Team
|
49
|
+
result = api_instance.add_team_member(team_id, opts)
|
50
|
+
p result
|
51
|
+
rescue BombBomb::ApiError => e
|
52
|
+
puts "Exception when calling TeamsApi->add_team_member: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**team_id** | **String**| The team id |
|
61
|
+
**user_id** | **String**| The user id of the member being added to the team. | [optional]
|
62
|
+
**user_email** | **String**| The email of the member being added to the team. | [optional]
|
63
|
+
**admin** | **BOOLEAN**| Set if the user is an admin of this team. | [optional]
|
64
|
+
|
65
|
+
### Return type
|
66
|
+
|
67
|
+
**String**
|
68
|
+
|
69
|
+
### Authorization
|
70
|
+
|
71
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
72
|
+
|
73
|
+
### HTTP request headers
|
74
|
+
|
75
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
76
|
+
- **Accept**: application/json
|
77
|
+
|
12
78
|
|
13
79
|
|
14
80
|
# **cancel_jericho_send**
|
@@ -57,7 +123,117 @@ nil (empty response body)
|
|
57
123
|
|
58
124
|
### HTTP request headers
|
59
125
|
|
60
|
-
- **Content-Type**:
|
126
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
# **create_subteam**
|
132
|
+
> TeamPublicRepresentation create_subteam(team_id, name)
|
133
|
+
|
134
|
+
Add a Subteam
|
135
|
+
|
136
|
+
Adds a subteam to a parent team
|
137
|
+
|
138
|
+
### Example
|
139
|
+
```ruby
|
140
|
+
# load the gem
|
141
|
+
require 'bombbomb'
|
142
|
+
# setup authorization
|
143
|
+
BombBomb.configure do |config|
|
144
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
145
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = BombBomb::TeamsApi.new
|
149
|
+
|
150
|
+
team_id = "team_id_example" # String | The team id
|
151
|
+
|
152
|
+
name = "name_example" # String | The subteam's name.
|
153
|
+
|
154
|
+
|
155
|
+
begin
|
156
|
+
#Add a Subteam
|
157
|
+
result = api_instance.create_subteam(team_id, name)
|
158
|
+
p result
|
159
|
+
rescue BombBomb::ApiError => e
|
160
|
+
puts "Exception when calling TeamsApi->create_subteam: #{e}"
|
161
|
+
end
|
162
|
+
```
|
163
|
+
|
164
|
+
### Parameters
|
165
|
+
|
166
|
+
Name | Type | Description | Notes
|
167
|
+
------------- | ------------- | ------------- | -------------
|
168
|
+
**team_id** | **String**| The team id |
|
169
|
+
**name** | **String**| The subteam's name. |
|
170
|
+
|
171
|
+
### Return type
|
172
|
+
|
173
|
+
[**TeamPublicRepresentation**](TeamPublicRepresentation.md)
|
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
|
+
# **delete_subteam**
|
187
|
+
> String delete_subteam(team_id, subteam_id)
|
188
|
+
|
189
|
+
Delete Subteam
|
190
|
+
|
191
|
+
Deletes a subteam
|
192
|
+
|
193
|
+
### Example
|
194
|
+
```ruby
|
195
|
+
# load the gem
|
196
|
+
require 'bombbomb'
|
197
|
+
# setup authorization
|
198
|
+
BombBomb.configure do |config|
|
199
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
200
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
201
|
+
end
|
202
|
+
|
203
|
+
api_instance = BombBomb::TeamsApi.new
|
204
|
+
|
205
|
+
team_id = "team_id_example" # String | The team id
|
206
|
+
|
207
|
+
subteam_id = "subteam_id_example" # String | The subteam you wish to delete.
|
208
|
+
|
209
|
+
|
210
|
+
begin
|
211
|
+
#Delete Subteam
|
212
|
+
result = api_instance.delete_subteam(team_id, subteam_id)
|
213
|
+
p result
|
214
|
+
rescue BombBomb::ApiError => e
|
215
|
+
puts "Exception when calling TeamsApi->delete_subteam: #{e}"
|
216
|
+
end
|
217
|
+
```
|
218
|
+
|
219
|
+
### Parameters
|
220
|
+
|
221
|
+
Name | Type | Description | Notes
|
222
|
+
------------- | ------------- | ------------- | -------------
|
223
|
+
**team_id** | **String**| The team id |
|
224
|
+
**subteam_id** | **String**| The subteam you wish to delete. |
|
225
|
+
|
226
|
+
### Return type
|
227
|
+
|
228
|
+
**String**
|
229
|
+
|
230
|
+
### Authorization
|
231
|
+
|
232
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
233
|
+
|
234
|
+
### HTTP request headers
|
235
|
+
|
236
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
61
237
|
- **Accept**: application/json
|
62
238
|
|
63
239
|
|
@@ -121,7 +297,7 @@ Name | Type | Description | Notes
|
|
121
297
|
|
122
298
|
### HTTP request headers
|
123
299
|
|
124
|
-
- **Content-Type**:
|
300
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
125
301
|
- **Accept**: application/json
|
126
302
|
|
127
303
|
|
@@ -173,7 +349,7 @@ Name | Type | Description | Notes
|
|
173
349
|
|
174
350
|
### HTTP request headers
|
175
351
|
|
176
|
-
- **Content-Type**:
|
352
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
177
353
|
- **Accept**: application/json
|
178
354
|
|
179
355
|
|
@@ -228,7 +404,59 @@ Name | Type | Description | Notes
|
|
228
404
|
|
229
405
|
### HTTP request headers
|
230
406
|
|
231
|
-
- **Content-Type**:
|
407
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
408
|
+
- **Accept**: application/json
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
# **get_subteams**
|
413
|
+
> Array<TeamPublicRepresentation> get_subteams(team_id)
|
414
|
+
|
415
|
+
List Subteams
|
416
|
+
|
417
|
+
Returns a collection of subteams for a parent team
|
418
|
+
|
419
|
+
### Example
|
420
|
+
```ruby
|
421
|
+
# load the gem
|
422
|
+
require 'bombbomb'
|
423
|
+
# setup authorization
|
424
|
+
BombBomb.configure do |config|
|
425
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
426
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
427
|
+
end
|
428
|
+
|
429
|
+
api_instance = BombBomb::TeamsApi.new
|
430
|
+
|
431
|
+
team_id = "team_id_example" # String | The team id
|
432
|
+
|
433
|
+
|
434
|
+
begin
|
435
|
+
#List Subteams
|
436
|
+
result = api_instance.get_subteams(team_id)
|
437
|
+
p result
|
438
|
+
rescue BombBomb::ApiError => e
|
439
|
+
puts "Exception when calling TeamsApi->get_subteams: #{e}"
|
440
|
+
end
|
441
|
+
```
|
442
|
+
|
443
|
+
### Parameters
|
444
|
+
|
445
|
+
Name | Type | Description | Notes
|
446
|
+
------------- | ------------- | ------------- | -------------
|
447
|
+
**team_id** | **String**| The team id |
|
448
|
+
|
449
|
+
### Return type
|
450
|
+
|
451
|
+
[**Array<TeamPublicRepresentation>**](TeamPublicRepresentation.md)
|
452
|
+
|
453
|
+
### Authorization
|
454
|
+
|
455
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
456
|
+
|
457
|
+
### HTTP request headers
|
458
|
+
|
459
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
232
460
|
- **Accept**: application/json
|
233
461
|
|
234
462
|
|
@@ -283,7 +511,118 @@ Name | Type | Description | Notes
|
|
283
511
|
|
284
512
|
### HTTP request headers
|
285
513
|
|
286
|
-
- **Content-Type**:
|
514
|
+
- **Content-Type**: application/json
|
515
|
+
- **Accept**: application/json
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
# **remove_member_from_team**
|
520
|
+
> String remove_member_from_team(team_id, user_id)
|
521
|
+
|
522
|
+
Remove Member from Team
|
523
|
+
|
524
|
+
Removes a member from a team.
|
525
|
+
|
526
|
+
### Example
|
527
|
+
```ruby
|
528
|
+
# load the gem
|
529
|
+
require 'bombbomb'
|
530
|
+
# setup authorization
|
531
|
+
BombBomb.configure do |config|
|
532
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
533
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
534
|
+
end
|
535
|
+
|
536
|
+
api_instance = BombBomb::TeamsApi.new
|
537
|
+
|
538
|
+
team_id = "team_id_example" # String | The team id
|
539
|
+
|
540
|
+
user_id = "user_id_example" # String | The user id of the member being removed.
|
541
|
+
|
542
|
+
|
543
|
+
begin
|
544
|
+
#Remove Member from Team
|
545
|
+
result = api_instance.remove_member_from_team(team_id, user_id)
|
546
|
+
p result
|
547
|
+
rescue BombBomb::ApiError => e
|
548
|
+
puts "Exception when calling TeamsApi->remove_member_from_team: #{e}"
|
549
|
+
end
|
550
|
+
```
|
551
|
+
|
552
|
+
### Parameters
|
553
|
+
|
554
|
+
Name | Type | Description | Notes
|
555
|
+
------------- | ------------- | ------------- | -------------
|
556
|
+
**team_id** | **String**| The team id |
|
557
|
+
**user_id** | **String**| The user id of the member being removed. |
|
558
|
+
|
559
|
+
### Return type
|
560
|
+
|
561
|
+
**String**
|
562
|
+
|
563
|
+
### Authorization
|
564
|
+
|
565
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
566
|
+
|
567
|
+
### HTTP request headers
|
568
|
+
|
569
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
570
|
+
- **Accept**: application/json
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
# **update_team**
|
575
|
+
> TeamPublicRepresentation update_team(team_id, opts)
|
576
|
+
|
577
|
+
Update a team
|
578
|
+
|
579
|
+
Update fields on a team
|
580
|
+
|
581
|
+
### Example
|
582
|
+
```ruby
|
583
|
+
# load the gem
|
584
|
+
require 'bombbomb'
|
585
|
+
# setup authorization
|
586
|
+
BombBomb.configure do |config|
|
587
|
+
# Configure OAuth2 access token for authorization: BBOAuth2
|
588
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
589
|
+
end
|
590
|
+
|
591
|
+
api_instance = BombBomb::TeamsApi.new
|
592
|
+
|
593
|
+
team_id = "team_id_example" # String | The team id
|
594
|
+
|
595
|
+
opts = {
|
596
|
+
name: "name_example" # String | The name of the team
|
597
|
+
}
|
598
|
+
|
599
|
+
begin
|
600
|
+
#Update a team
|
601
|
+
result = api_instance.update_team(team_id, opts)
|
602
|
+
p result
|
603
|
+
rescue BombBomb::ApiError => e
|
604
|
+
puts "Exception when calling TeamsApi->update_team: #{e}"
|
605
|
+
end
|
606
|
+
```
|
607
|
+
|
608
|
+
### Parameters
|
609
|
+
|
610
|
+
Name | Type | Description | Notes
|
611
|
+
------------- | ------------- | ------------- | -------------
|
612
|
+
**team_id** | **String**| The team id |
|
613
|
+
**name** | **String**| The name of the team | [optional]
|
614
|
+
|
615
|
+
### Return type
|
616
|
+
|
617
|
+
[**TeamPublicRepresentation**](TeamPublicRepresentation.md)
|
618
|
+
|
619
|
+
### Authorization
|
620
|
+
|
621
|
+
[BBOAuth2](../README.md#BBOAuth2)
|
622
|
+
|
623
|
+
### HTTP request headers
|
624
|
+
|
625
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
287
626
|
- **Accept**: application/json
|
288
627
|
|
289
628
|
|