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
data/docs/UtilitiesApi.md
CHANGED
@@ -60,7 +60,7 @@ Name | Type | Description | Notes
|
|
60
60
|
|
61
61
|
### HTTP request headers
|
62
62
|
|
63
|
-
- **Content-Type**:
|
63
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
64
64
|
- **Accept**: application/json
|
65
65
|
|
66
66
|
|
@@ -111,7 +111,7 @@ nil (empty response body)
|
|
111
111
|
|
112
112
|
### HTTP request headers
|
113
113
|
|
114
|
-
- **Content-Type**:
|
114
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
115
115
|
- **Accept**: application/json
|
116
116
|
|
117
117
|
|
@@ -157,7 +157,7 @@ This endpoint does not need any parameter.
|
|
157
157
|
|
158
158
|
### HTTP request headers
|
159
159
|
|
160
|
-
- **Content-Type**:
|
160
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
161
161
|
- **Accept**: application/json
|
162
162
|
|
163
163
|
|
@@ -197,7 +197,7 @@ No authorization required
|
|
197
197
|
|
198
198
|
### HTTP request headers
|
199
199
|
|
200
|
-
- **Content-Type**:
|
200
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
201
201
|
- **Accept**: application/json
|
202
202
|
|
203
203
|
|
data/docs/WebhooksApi.md
CHANGED
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**add_web_hook**](WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
|
8
8
|
[**delete_web_hook**](WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
|
9
9
|
[**get_web_hooks**](WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
|
10
|
+
[**list_web_hook_events**](WebhooksApi.md#list_web_hook_events) | **GET** /webhook/events | Describe WebHook Events
|
10
11
|
[**send_webhook_example**](WebhooksApi.md#send_webhook_example) | **POST** /webhook/test | Sends test Webhook
|
11
12
|
|
12
13
|
|
@@ -57,7 +58,7 @@ Name | Type | Description | Notes
|
|
57
58
|
|
58
59
|
### HTTP request headers
|
59
60
|
|
60
|
-
- **Content-Type**:
|
61
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
61
62
|
- **Accept**: application/json
|
62
63
|
|
63
64
|
|
@@ -109,7 +110,7 @@ Name | Type | Description | Notes
|
|
109
110
|
|
110
111
|
### HTTP request headers
|
111
112
|
|
112
|
-
- **Content-Type**:
|
113
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
113
114
|
- **Accept**: application/json
|
114
115
|
|
115
116
|
|
@@ -155,7 +156,47 @@ This endpoint does not need any parameter.
|
|
155
156
|
|
156
157
|
### HTTP request headers
|
157
158
|
|
158
|
-
- **Content-Type**:
|
159
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
160
|
+
- **Accept**: application/json
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
# **list_web_hook_events**
|
165
|
+
> list_web_hook_events
|
166
|
+
|
167
|
+
Describe WebHook Events
|
168
|
+
|
169
|
+
Returns example Webhook events for each kind of possible event.
|
170
|
+
|
171
|
+
### Example
|
172
|
+
```ruby
|
173
|
+
# load the gem
|
174
|
+
require 'bombbomb'
|
175
|
+
|
176
|
+
api_instance = BombBomb::WebhooksApi.new
|
177
|
+
|
178
|
+
begin
|
179
|
+
#Describe WebHook Events
|
180
|
+
api_instance.list_web_hook_events
|
181
|
+
rescue BombBomb::ApiError => e
|
182
|
+
puts "Exception when calling WebhooksApi->list_web_hook_events: #{e}"
|
183
|
+
end
|
184
|
+
```
|
185
|
+
|
186
|
+
### Parameters
|
187
|
+
This endpoint does not need any parameter.
|
188
|
+
|
189
|
+
### Return type
|
190
|
+
|
191
|
+
nil (empty response body)
|
192
|
+
|
193
|
+
### Authorization
|
194
|
+
|
195
|
+
No authorization required
|
196
|
+
|
197
|
+
### HTTP request headers
|
198
|
+
|
199
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
159
200
|
- **Accept**: application/json
|
160
201
|
|
161
202
|
|
@@ -200,7 +241,7 @@ nil (empty response body)
|
|
200
241
|
|
201
242
|
### HTTP request headers
|
202
243
|
|
203
|
-
- **Content-Type**:
|
244
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
204
245
|
- **Accept**: application/json
|
205
246
|
|
206
247
|
|
data/lib/bombbomb.rb
CHANGED
@@ -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.21432
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -29,15 +29,20 @@ require 'bombbomb/configuration'
|
|
29
29
|
|
30
30
|
# Models
|
31
31
|
require 'bombbomb/models/bb_web_hook'
|
32
|
+
require 'bombbomb/models/curriculum'
|
33
|
+
require 'bombbomb/models/curriculum_user_progress'
|
34
|
+
require 'bombbomb/models/curriculum_with_progress'
|
32
35
|
require 'bombbomb/models/inline_response_200'
|
33
36
|
require 'bombbomb/models/inline_response_200_items'
|
34
37
|
require 'bombbomb/models/jericho_configuration'
|
35
38
|
require 'bombbomb/models/jericho_performance'
|
36
39
|
require 'bombbomb/models/o_auth_client'
|
37
40
|
require 'bombbomb/models/string'
|
41
|
+
require 'bombbomb/models/team_public_representation'
|
38
42
|
require 'bombbomb/models/video_email_prompt'
|
39
43
|
|
40
44
|
# APIs
|
45
|
+
require 'bombbomb/api/curriculum_api'
|
41
46
|
require 'bombbomb/api/prompts_api'
|
42
47
|
require 'bombbomb/api/teams_api'
|
43
48
|
require 'bombbomb/api/utilities_api'
|
@@ -0,0 +1,143 @@
|
|
1
|
+
=begin
|
2
|
+
#BombBomb
|
3
|
+
|
4
|
+
#We make it easy to build relationships using simple videos.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.21432
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
11
|
+
you may not use this file except in compliance with the License.
|
12
|
+
You may obtain a copy of the License at
|
13
|
+
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
15
|
+
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
19
|
+
See the License for the specific language governing permissions and
|
20
|
+
limitations under the License.
|
21
|
+
|
22
|
+
=end
|
23
|
+
|
24
|
+
require "uri"
|
25
|
+
|
26
|
+
module BombBomb
|
27
|
+
class CurriculumApi
|
28
|
+
attr_accessor :api_client
|
29
|
+
|
30
|
+
def initialize(api_client = ApiClient.default)
|
31
|
+
@api_client = api_client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Get Curricula
|
35
|
+
# Get Curricula, optionally with progress included.
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [BOOLEAN] :include_progress Whether to return progress with the curriculum.
|
38
|
+
# @return [Array<Curriculum>]
|
39
|
+
def get_curricula(opts = {})
|
40
|
+
data, _status_code, _headers = get_curricula_with_http_info(opts)
|
41
|
+
return data
|
42
|
+
end
|
43
|
+
|
44
|
+
# Get Curricula
|
45
|
+
# Get Curricula, optionally with progress included.
|
46
|
+
# @param [Hash] opts the optional parameters
|
47
|
+
# @option opts [BOOLEAN] :include_progress Whether to return progress with the curriculum.
|
48
|
+
# @return [Array<(Array<Curriculum>, Fixnum, Hash)>] Array<Curriculum> data, response status code and response headers
|
49
|
+
def get_curricula_with_http_info(opts = {})
|
50
|
+
if @api_client.config.debugging
|
51
|
+
@api_client.config.logger.debug "Calling API: CurriculumApi.get_curricula ..."
|
52
|
+
end
|
53
|
+
# resource path
|
54
|
+
local_var_path = "/curricula/".sub('{format}','json')
|
55
|
+
|
56
|
+
# query parameters
|
57
|
+
query_params = {}
|
58
|
+
query_params[:'includeProgress'] = opts[:'include_progress'] if !opts[:'include_progress'].nil?
|
59
|
+
|
60
|
+
# header parameters
|
61
|
+
header_params = {}
|
62
|
+
|
63
|
+
# HTTP header 'Accept' (if needed)
|
64
|
+
local_header_accept = ['application/json']
|
65
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
66
|
+
|
67
|
+
# HTTP header 'Content-Type'
|
68
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
69
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
70
|
+
|
71
|
+
# form parameters
|
72
|
+
form_params = {}
|
73
|
+
|
74
|
+
# http body (model)
|
75
|
+
post_body = nil
|
76
|
+
auth_names = ['BBOAuth2']
|
77
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
78
|
+
:header_params => header_params,
|
79
|
+
:query_params => query_params,
|
80
|
+
:form_params => form_params,
|
81
|
+
:body => post_body,
|
82
|
+
:auth_names => auth_names,
|
83
|
+
:return_type => 'Array<Curriculum>')
|
84
|
+
if @api_client.config.debugging
|
85
|
+
@api_client.config.logger.debug "API called: CurriculumApi#get_curricula\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
|
90
|
+
# Get Detailed For User
|
91
|
+
# Get all curricula for user including progress for each curriculum.
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [Array<CurriculumWithProgress>]
|
94
|
+
def get_user_curriculum_with_progress(opts = {})
|
95
|
+
data, _status_code, _headers = get_user_curriculum_with_progress_with_http_info(opts)
|
96
|
+
return data
|
97
|
+
end
|
98
|
+
|
99
|
+
# Get Detailed For User
|
100
|
+
# Get all curricula for user including progress for each curriculum.
|
101
|
+
# @param [Hash] opts the optional parameters
|
102
|
+
# @return [Array<(Array<CurriculumWithProgress>, Fixnum, Hash)>] Array<CurriculumWithProgress> data, response status code and response headers
|
103
|
+
def get_user_curriculum_with_progress_with_http_info(opts = {})
|
104
|
+
if @api_client.config.debugging
|
105
|
+
@api_client.config.logger.debug "Calling API: CurriculumApi.get_user_curriculum_with_progress ..."
|
106
|
+
end
|
107
|
+
# resource path
|
108
|
+
local_var_path = "/curriculum/getForUserWithProgress".sub('{format}','json')
|
109
|
+
|
110
|
+
# query parameters
|
111
|
+
query_params = {}
|
112
|
+
|
113
|
+
# header parameters
|
114
|
+
header_params = {}
|
115
|
+
|
116
|
+
# HTTP header 'Accept' (if needed)
|
117
|
+
local_header_accept = ['application/json']
|
118
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
119
|
+
|
120
|
+
# HTTP header 'Content-Type'
|
121
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
122
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
123
|
+
|
124
|
+
# form parameters
|
125
|
+
form_params = {}
|
126
|
+
|
127
|
+
# http body (model)
|
128
|
+
post_body = nil
|
129
|
+
auth_names = ['BBOAuth2']
|
130
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
131
|
+
:header_params => header_params,
|
132
|
+
:query_params => query_params,
|
133
|
+
:form_params => form_params,
|
134
|
+
:body => post_body,
|
135
|
+
:auth_names => auth_names,
|
136
|
+
:return_type => 'Array<CurriculumWithProgress>')
|
137
|
+
if @api_client.config.debugging
|
138
|
+
@api_client.config.logger.debug "API called: CurriculumApi#get_user_curriculum_with_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
139
|
+
end
|
140
|
+
return data, status_code, headers
|
141
|
+
end
|
142
|
+
end
|
143
|
+
end
|
@@ -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.21432
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -66,7 +66,7 @@ module BombBomb
|
|
66
66
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
67
|
|
68
68
|
# HTTP header 'Content-Type'
|
69
|
-
local_header_content_type = []
|
69
|
+
local_header_content_type = ['application/json']
|
70
70
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
71
|
|
72
72
|
# form parameters
|
@@ -123,7 +123,7 @@ module BombBomb
|
|
123
123
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
124
124
|
|
125
125
|
# HTTP header 'Content-Type'
|
126
|
-
local_header_content_type = []
|
126
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
127
127
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
128
128
|
|
129
129
|
# form parameters
|
@@ -190,7 +190,7 @@ module BombBomb
|
|
190
190
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
191
191
|
|
192
192
|
# HTTP header 'Content-Type'
|
193
|
-
local_header_content_type = []
|
193
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
194
194
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
195
195
|
|
196
196
|
# form parameters
|
@@ -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.21432
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -31,6 +31,72 @@ module BombBomb
|
|
31
31
|
@api_client = api_client
|
32
32
|
end
|
33
33
|
|
34
|
+
# Add Member to Team
|
35
|
+
# Adds a member to a team.
|
36
|
+
# @param team_id The team id
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @option opts [String] :user_id The user id of the member being added to the team.
|
39
|
+
# @option opts [String] :user_email The email of the member being added to the team.
|
40
|
+
# @option opts [BOOLEAN] :admin Set if the user is an admin of this team.
|
41
|
+
# @return [String]
|
42
|
+
def add_team_member(team_id, opts = {})
|
43
|
+
data, _status_code, _headers = add_team_member_with_http_info(team_id, opts)
|
44
|
+
return data
|
45
|
+
end
|
46
|
+
|
47
|
+
# Add Member to Team
|
48
|
+
# Adds a member to a team.
|
49
|
+
# @param team_id The team id
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @option opts [String] :user_id The user id of the member being added to the team.
|
52
|
+
# @option opts [String] :user_email The email of the member being added to the team.
|
53
|
+
# @option opts [BOOLEAN] :admin Set if the user is an admin of this team.
|
54
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
55
|
+
def add_team_member_with_http_info(team_id, opts = {})
|
56
|
+
if @api_client.config.debugging
|
57
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.add_team_member ..."
|
58
|
+
end
|
59
|
+
# verify the required parameter 'team_id' is set
|
60
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_team_member" if team_id.nil?
|
61
|
+
# resource path
|
62
|
+
local_var_path = "/team/{teamId}/member".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
|
63
|
+
|
64
|
+
# query parameters
|
65
|
+
query_params = {}
|
66
|
+
|
67
|
+
# header parameters
|
68
|
+
header_params = {}
|
69
|
+
|
70
|
+
# HTTP header 'Accept' (if needed)
|
71
|
+
local_header_accept = ['application/json']
|
72
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
73
|
+
|
74
|
+
# HTTP header 'Content-Type'
|
75
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
76
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
77
|
+
|
78
|
+
# form parameters
|
79
|
+
form_params = {}
|
80
|
+
form_params["userId"] = opts[:'user_id'] if !opts[:'user_id'].nil?
|
81
|
+
form_params["userEmail"] = opts[:'user_email'] if !opts[:'user_email'].nil?
|
82
|
+
form_params["admin"] = opts[:'admin'] if !opts[:'admin'].nil?
|
83
|
+
|
84
|
+
# http body (model)
|
85
|
+
post_body = nil
|
86
|
+
auth_names = ['BBOAuth2']
|
87
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
88
|
+
:header_params => header_params,
|
89
|
+
:query_params => query_params,
|
90
|
+
:form_params => form_params,
|
91
|
+
:body => post_body,
|
92
|
+
:auth_names => auth_names,
|
93
|
+
:return_type => 'String')
|
94
|
+
if @api_client.config.debugging
|
95
|
+
@api_client.config.logger.debug "API called: TeamsApi#add_team_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
96
|
+
end
|
97
|
+
return data, status_code, headers
|
98
|
+
end
|
99
|
+
|
34
100
|
# Cancel a Jericho Send
|
35
101
|
# Cancels a scheduled Jericho send from being sent.
|
36
102
|
# @param jericho_id ID of the Jericho Job to cancel
|
@@ -66,7 +132,7 @@ module BombBomb
|
|
66
132
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
133
|
|
68
134
|
# HTTP header 'Content-Type'
|
69
|
-
local_header_content_type = []
|
135
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
70
136
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
137
|
|
72
138
|
# form parameters
|
@@ -87,6 +153,130 @@ module BombBomb
|
|
87
153
|
return data, status_code, headers
|
88
154
|
end
|
89
155
|
|
156
|
+
# Add a Subteam
|
157
|
+
# Adds a subteam to a parent team
|
158
|
+
# @param team_id The team id
|
159
|
+
# @param name The subteam's name.
|
160
|
+
# @param [Hash] opts the optional parameters
|
161
|
+
# @return [TeamPublicRepresentation]
|
162
|
+
def create_subteam(team_id, name, opts = {})
|
163
|
+
data, _status_code, _headers = create_subteam_with_http_info(team_id, name, opts)
|
164
|
+
return data
|
165
|
+
end
|
166
|
+
|
167
|
+
# Add a Subteam
|
168
|
+
# Adds a subteam to a parent team
|
169
|
+
# @param team_id The team id
|
170
|
+
# @param name The subteam's name.
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @return [Array<(TeamPublicRepresentation, Fixnum, Hash)>] TeamPublicRepresentation data, response status code and response headers
|
173
|
+
def create_subteam_with_http_info(team_id, name, opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.create_subteam ..."
|
176
|
+
end
|
177
|
+
# verify the required parameter 'team_id' is set
|
178
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.create_subteam" if team_id.nil?
|
179
|
+
# verify the required parameter 'name' is set
|
180
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling TeamsApi.create_subteam" if name.nil?
|
181
|
+
# resource path
|
182
|
+
local_var_path = "/team/{teamId}/subteam".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
|
183
|
+
|
184
|
+
# query parameters
|
185
|
+
query_params = {}
|
186
|
+
|
187
|
+
# header parameters
|
188
|
+
header_params = {}
|
189
|
+
|
190
|
+
# HTTP header 'Accept' (if needed)
|
191
|
+
local_header_accept = ['application/json']
|
192
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
193
|
+
|
194
|
+
# HTTP header 'Content-Type'
|
195
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
196
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
197
|
+
|
198
|
+
# form parameters
|
199
|
+
form_params = {}
|
200
|
+
form_params["name"] = name
|
201
|
+
|
202
|
+
# http body (model)
|
203
|
+
post_body = nil
|
204
|
+
auth_names = ['BBOAuth2']
|
205
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
206
|
+
:header_params => header_params,
|
207
|
+
:query_params => query_params,
|
208
|
+
:form_params => form_params,
|
209
|
+
:body => post_body,
|
210
|
+
:auth_names => auth_names,
|
211
|
+
:return_type => 'TeamPublicRepresentation')
|
212
|
+
if @api_client.config.debugging
|
213
|
+
@api_client.config.logger.debug "API called: TeamsApi#create_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
214
|
+
end
|
215
|
+
return data, status_code, headers
|
216
|
+
end
|
217
|
+
|
218
|
+
# Delete Subteam
|
219
|
+
# Deletes a subteam
|
220
|
+
# @param team_id The team id
|
221
|
+
# @param subteam_id The subteam you wish to delete.
|
222
|
+
# @param [Hash] opts the optional parameters
|
223
|
+
# @return [String]
|
224
|
+
def delete_subteam(team_id, subteam_id, opts = {})
|
225
|
+
data, _status_code, _headers = delete_subteam_with_http_info(team_id, subteam_id, opts)
|
226
|
+
return data
|
227
|
+
end
|
228
|
+
|
229
|
+
# Delete Subteam
|
230
|
+
# Deletes a subteam
|
231
|
+
# @param team_id The team id
|
232
|
+
# @param subteam_id The subteam you wish to delete.
|
233
|
+
# @param [Hash] opts the optional parameters
|
234
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
235
|
+
def delete_subteam_with_http_info(team_id, subteam_id, opts = {})
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.delete_subteam ..."
|
238
|
+
end
|
239
|
+
# verify the required parameter 'team_id' is set
|
240
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.delete_subteam" if team_id.nil?
|
241
|
+
# verify the required parameter 'subteam_id' is set
|
242
|
+
fail ArgumentError, "Missing the required parameter 'subteam_id' when calling TeamsApi.delete_subteam" if subteam_id.nil?
|
243
|
+
# resource path
|
244
|
+
local_var_path = "/team/{teamId}/subteam".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
|
245
|
+
|
246
|
+
# query parameters
|
247
|
+
query_params = {}
|
248
|
+
|
249
|
+
# header parameters
|
250
|
+
header_params = {}
|
251
|
+
|
252
|
+
# HTTP header 'Accept' (if needed)
|
253
|
+
local_header_accept = ['application/json']
|
254
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
255
|
+
|
256
|
+
# HTTP header 'Content-Type'
|
257
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
258
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
259
|
+
|
260
|
+
# form parameters
|
261
|
+
form_params = {}
|
262
|
+
form_params["subteamId"] = subteam_id
|
263
|
+
|
264
|
+
# http body (model)
|
265
|
+
post_body = nil
|
266
|
+
auth_names = ['BBOAuth2']
|
267
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
268
|
+
:header_params => header_params,
|
269
|
+
:query_params => query_params,
|
270
|
+
:form_params => form_params,
|
271
|
+
:body => post_body,
|
272
|
+
:auth_names => auth_names,
|
273
|
+
:return_type => 'String')
|
274
|
+
if @api_client.config.debugging
|
275
|
+
@api_client.config.logger.debug "API called: TeamsApi#delete_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
276
|
+
end
|
277
|
+
return data, status_code, headers
|
278
|
+
end
|
279
|
+
|
90
280
|
# Lists team assets
|
91
281
|
# Returns a collection of assets
|
92
282
|
# @param asset_type The type of assets.
|
@@ -142,7 +332,7 @@ module BombBomb
|
|
142
332
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
143
333
|
|
144
334
|
# HTTP header 'Content-Type'
|
145
|
-
local_header_content_type = []
|
335
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
146
336
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
147
337
|
|
148
338
|
# form parameters
|
@@ -199,7 +389,7 @@ module BombBomb
|
|
199
389
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
200
390
|
|
201
391
|
# HTTP header 'Content-Type'
|
202
|
-
local_header_content_type = []
|
392
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
203
393
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
204
394
|
|
205
395
|
# form parameters
|
@@ -260,7 +450,7 @@ module BombBomb
|
|
260
450
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
261
451
|
|
262
452
|
# HTTP header 'Content-Type'
|
263
|
-
local_header_content_type = []
|
453
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
264
454
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
265
455
|
|
266
456
|
# form parameters
|
@@ -282,6 +472,63 @@ module BombBomb
|
|
282
472
|
return data, status_code, headers
|
283
473
|
end
|
284
474
|
|
475
|
+
# List Subteams
|
476
|
+
# Returns a collection of subteams for a parent team
|
477
|
+
# @param team_id The team id
|
478
|
+
# @param [Hash] opts the optional parameters
|
479
|
+
# @return [Array<TeamPublicRepresentation>]
|
480
|
+
def get_subteams(team_id, opts = {})
|
481
|
+
data, _status_code, _headers = get_subteams_with_http_info(team_id, opts)
|
482
|
+
return data
|
483
|
+
end
|
484
|
+
|
485
|
+
# List Subteams
|
486
|
+
# Returns a collection of subteams for a parent team
|
487
|
+
# @param team_id The team id
|
488
|
+
# @param [Hash] opts the optional parameters
|
489
|
+
# @return [Array<(Array<TeamPublicRepresentation>, Fixnum, Hash)>] Array<TeamPublicRepresentation> data, response status code and response headers
|
490
|
+
def get_subteams_with_http_info(team_id, opts = {})
|
491
|
+
if @api_client.config.debugging
|
492
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.get_subteams ..."
|
493
|
+
end
|
494
|
+
# verify the required parameter 'team_id' is set
|
495
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_subteams" if team_id.nil?
|
496
|
+
# resource path
|
497
|
+
local_var_path = "/team/{teamId}/subteam".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
|
498
|
+
|
499
|
+
# query parameters
|
500
|
+
query_params = {}
|
501
|
+
|
502
|
+
# header parameters
|
503
|
+
header_params = {}
|
504
|
+
|
505
|
+
# HTTP header 'Accept' (if needed)
|
506
|
+
local_header_accept = ['application/json']
|
507
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
508
|
+
|
509
|
+
# HTTP header 'Content-Type'
|
510
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
511
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
512
|
+
|
513
|
+
# form parameters
|
514
|
+
form_params = {}
|
515
|
+
|
516
|
+
# http body (model)
|
517
|
+
post_body = nil
|
518
|
+
auth_names = ['BBOAuth2']
|
519
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
520
|
+
:header_params => header_params,
|
521
|
+
:query_params => query_params,
|
522
|
+
:form_params => form_params,
|
523
|
+
:body => post_body,
|
524
|
+
:auth_names => auth_names,
|
525
|
+
:return_type => 'Array<TeamPublicRepresentation>')
|
526
|
+
if @api_client.config.debugging
|
527
|
+
@api_client.config.logger.debug "API called: TeamsApi#get_subteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
528
|
+
end
|
529
|
+
return data, status_code, headers
|
530
|
+
end
|
531
|
+
|
285
532
|
# Creates a Jericho send.
|
286
533
|
# Sends email content on behalf of members of a client group. There are two forms this send can take: Static Email, and Video Prompt. Static emails require only an emailId. Video Prompts build emails dynamically and require most of the other fields. You must be an administrator of a Team Account to use this method.
|
287
534
|
# @param config JSON representing a Jericho configuration
|
@@ -321,7 +568,7 @@ module BombBomb
|
|
321
568
|
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
322
569
|
|
323
570
|
# HTTP header 'Content-Type'
|
324
|
-
local_header_content_type = []
|
571
|
+
local_header_content_type = ['application/json']
|
325
572
|
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
326
573
|
|
327
574
|
# form parameters
|
@@ -342,5 +589,126 @@ module BombBomb
|
|
342
589
|
end
|
343
590
|
return data, status_code, headers
|
344
591
|
end
|
592
|
+
|
593
|
+
# Remove Member from Team
|
594
|
+
# Removes a member from a team.
|
595
|
+
# @param team_id The team id
|
596
|
+
# @param user_id The user id of the member being removed.
|
597
|
+
# @param [Hash] opts the optional parameters
|
598
|
+
# @return [String]
|
599
|
+
def remove_member_from_team(team_id, user_id, opts = {})
|
600
|
+
data, _status_code, _headers = remove_member_from_team_with_http_info(team_id, user_id, opts)
|
601
|
+
return data
|
602
|
+
end
|
603
|
+
|
604
|
+
# Remove Member from Team
|
605
|
+
# Removes a member from a team.
|
606
|
+
# @param team_id The team id
|
607
|
+
# @param user_id The user id of the member being removed.
|
608
|
+
# @param [Hash] opts the optional parameters
|
609
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
610
|
+
def remove_member_from_team_with_http_info(team_id, user_id, opts = {})
|
611
|
+
if @api_client.config.debugging
|
612
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.remove_member_from_team ..."
|
613
|
+
end
|
614
|
+
# verify the required parameter 'team_id' is set
|
615
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.remove_member_from_team" if team_id.nil?
|
616
|
+
# verify the required parameter 'user_id' is set
|
617
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling TeamsApi.remove_member_from_team" if user_id.nil?
|
618
|
+
# resource path
|
619
|
+
local_var_path = "/team/{teamId}/member/{userId}".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
620
|
+
|
621
|
+
# query parameters
|
622
|
+
query_params = {}
|
623
|
+
|
624
|
+
# header parameters
|
625
|
+
header_params = {}
|
626
|
+
|
627
|
+
# HTTP header 'Accept' (if needed)
|
628
|
+
local_header_accept = ['application/json']
|
629
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
630
|
+
|
631
|
+
# HTTP header 'Content-Type'
|
632
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
633
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
634
|
+
|
635
|
+
# form parameters
|
636
|
+
form_params = {}
|
637
|
+
|
638
|
+
# http body (model)
|
639
|
+
post_body = nil
|
640
|
+
auth_names = ['BBOAuth2']
|
641
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
642
|
+
:header_params => header_params,
|
643
|
+
:query_params => query_params,
|
644
|
+
:form_params => form_params,
|
645
|
+
:body => post_body,
|
646
|
+
:auth_names => auth_names,
|
647
|
+
:return_type => 'String')
|
648
|
+
if @api_client.config.debugging
|
649
|
+
@api_client.config.logger.debug "API called: TeamsApi#remove_member_from_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
650
|
+
end
|
651
|
+
return data, status_code, headers
|
652
|
+
end
|
653
|
+
|
654
|
+
# Update a team
|
655
|
+
# Update fields on a team
|
656
|
+
# @param team_id The team id
|
657
|
+
# @param [Hash] opts the optional parameters
|
658
|
+
# @option opts [String] :name The name of the team
|
659
|
+
# @return [TeamPublicRepresentation]
|
660
|
+
def update_team(team_id, opts = {})
|
661
|
+
data, _status_code, _headers = update_team_with_http_info(team_id, opts)
|
662
|
+
return data
|
663
|
+
end
|
664
|
+
|
665
|
+
# Update a team
|
666
|
+
# Update fields on a team
|
667
|
+
# @param team_id The team id
|
668
|
+
# @param [Hash] opts the optional parameters
|
669
|
+
# @option opts [String] :name The name of the team
|
670
|
+
# @return [Array<(TeamPublicRepresentation, Fixnum, Hash)>] TeamPublicRepresentation data, response status code and response headers
|
671
|
+
def update_team_with_http_info(team_id, opts = {})
|
672
|
+
if @api_client.config.debugging
|
673
|
+
@api_client.config.logger.debug "Calling API: TeamsApi.update_team ..."
|
674
|
+
end
|
675
|
+
# verify the required parameter 'team_id' is set
|
676
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_team" if team_id.nil?
|
677
|
+
# resource path
|
678
|
+
local_var_path = "/team/{teamId}".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
|
679
|
+
|
680
|
+
# query parameters
|
681
|
+
query_params = {}
|
682
|
+
|
683
|
+
# header parameters
|
684
|
+
header_params = {}
|
685
|
+
|
686
|
+
# HTTP header 'Accept' (if needed)
|
687
|
+
local_header_accept = ['application/json']
|
688
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
689
|
+
|
690
|
+
# HTTP header 'Content-Type'
|
691
|
+
local_header_content_type = ['application/x-www-form-urlencoded']
|
692
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
693
|
+
|
694
|
+
# form parameters
|
695
|
+
form_params = {}
|
696
|
+
form_params["name"] = opts[:'name'] if !opts[:'name'].nil?
|
697
|
+
|
698
|
+
# http body (model)
|
699
|
+
post_body = nil
|
700
|
+
auth_names = ['BBOAuth2']
|
701
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
702
|
+
:header_params => header_params,
|
703
|
+
:query_params => query_params,
|
704
|
+
:form_params => form_params,
|
705
|
+
:body => post_body,
|
706
|
+
:auth_names => auth_names,
|
707
|
+
:return_type => 'TeamPublicRepresentation')
|
708
|
+
if @api_client.config.debugging
|
709
|
+
@api_client.config.logger.debug "API called: TeamsApi#update_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
710
|
+
end
|
711
|
+
return data, status_code, headers
|
712
|
+
end
|
345
713
|
end
|
346
714
|
end
|