bombbomb 2.0.831 → 2.0.20679

Sign up to get free protection for your applications and to get access to all the features.
Files changed (118) hide show
  1. checksums.yaml +13 -5
  2. data/README.md +31 -147
  3. data/Rakefile +3 -8
  4. data/bombbomb.gemspec +17 -8
  5. data/docs/InlineResponse200.md +1 -1
  6. data/docs/JerichoConfiguration.md +1 -7
  7. data/docs/JerichoPerformance.md +0 -4
  8. data/docs/PromptsApi.md +6 -712
  9. data/docs/TeamsApi.md +62 -1144
  10. data/docs/UtilitiesApi.md +4 -4
  11. data/docs/VideoEmailPrompt.md +10 -24
  12. data/docs/WebhooksApi.md +4 -45
  13. data/git_push.sh +13 -1
  14. data/lib/bombbomb.rb +14 -30
  15. data/lib/bombbomb/api/prompts_api.rb +42 -833
  16. data/lib/bombbomb/api/teams_api.rb +157 -1331
  17. data/lib/bombbomb/api/utilities_api.rb +44 -23
  18. data/lib/bombbomb/api/webhooks_api.rb +43 -68
  19. data/lib/bombbomb/api_client.rb +45 -55
  20. data/lib/bombbomb/api_error.rb +18 -9
  21. data/lib/bombbomb/configuration.rb +13 -8
  22. data/lib/bombbomb/models/bb_web_hook.rb +17 -6
  23. data/lib/bombbomb/models/inline_response_200.rb +18 -7
  24. data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
  25. data/lib/bombbomb/models/jericho_configuration.rb +22 -75
  26. data/lib/bombbomb/models/jericho_performance.rb +21 -50
  27. data/lib/bombbomb/models/o_auth_client.rb +17 -6
  28. data/lib/bombbomb/models/string.rb +17 -6
  29. data/lib/bombbomb/models/video_email_prompt.rb +90 -214
  30. data/lib/bombbomb/version.rb +14 -3
  31. data/spec/models/{team_public_representation_spec.rb → inline_response_200_items_spec.rb} +14 -8
  32. metadata +56 -168
  33. data/Gemfile +0 -7
  34. data/docs/AccountsApi.md +0 -384
  35. data/docs/AutomationsApi.md +0 -167
  36. data/docs/ClientGroupAssetMetaData.md +0 -11
  37. data/docs/ContactsApi.md +0 -436
  38. data/docs/Curriculum.md +0 -15
  39. data/docs/CurriculumApi.md +0 -109
  40. data/docs/CurriculumUserProgress.md +0 -12
  41. data/docs/CurriculumWithProgress.md +0 -15
  42. data/docs/EmailsApi.md +0 -633
  43. data/docs/FilesApi.md +0 -272
  44. data/docs/FormsApi.md +0 -60
  45. data/docs/HostedDoc.md +0 -13
  46. data/docs/IntegrationsApi.md +0 -285
  47. data/docs/ListsApi.md +0 -265
  48. data/docs/OrdersApi.md +0 -60
  49. data/docs/PromptBot.md +0 -22
  50. data/docs/PromptBotBot.md +0 -18
  51. data/docs/PromptMonthlyPerformance.md +0 -11
  52. data/docs/PromptOverview.md +0 -11
  53. data/docs/PromptSocialPrompt.md +0 -20
  54. data/docs/SignUploadRequest.md +0 -9
  55. data/docs/SignUploadResponse.md +0 -9
  56. data/docs/SocialsApi.md +0 -653
  57. data/docs/TeamPublicRepresentation.md +0 -10
  58. data/docs/UsersApi.md +0 -100
  59. data/docs/VideoEncodingStatusResponse.md +0 -10
  60. data/docs/VideoPublicRepresentation.md +0 -18
  61. data/docs/VideoRecorderMethodResponse.md +0 -15
  62. data/docs/VideosApi.md +0 -287
  63. data/lib/bombbomb/api/accounts_api.rb +0 -432
  64. data/lib/bombbomb/api/automations_api.rb +0 -191
  65. data/lib/bombbomb/api/contacts_api.rb +0 -470
  66. data/lib/bombbomb/api/curriculum_api.rb +0 -124
  67. data/lib/bombbomb/api/emails_api.rb +0 -673
  68. data/lib/bombbomb/api/files_api.rb +0 -302
  69. data/lib/bombbomb/api/forms_api.rb +0 -77
  70. data/lib/bombbomb/api/integrations_api.rb +0 -308
  71. data/lib/bombbomb/api/lists_api.rb +0 -295
  72. data/lib/bombbomb/api/orders_api.rb +0 -78
  73. data/lib/bombbomb/api/socials_api.rb +0 -714
  74. data/lib/bombbomb/api/users_api.rb +0 -119
  75. data/lib/bombbomb/api/videos_api.rb +0 -326
  76. data/lib/bombbomb/models/client_group_asset_meta_data.rb +0 -215
  77. data/lib/bombbomb/models/curriculum.rb +0 -261
  78. data/lib/bombbomb/models/curriculum_user_progress.rb +0 -229
  79. data/lib/bombbomb/models/curriculum_with_progress.rb +0 -261
  80. data/lib/bombbomb/models/hosted_doc.rb +0 -239
  81. data/lib/bombbomb/models/prompt_bot.rb +0 -329
  82. data/lib/bombbomb/models/prompt_bot_bot.rb +0 -300
  83. data/lib/bombbomb/models/prompt_monthly_performance.rb +0 -219
  84. data/lib/bombbomb/models/prompt_overview.rb +0 -219
  85. data/lib/bombbomb/models/prompt_social_prompt.rb +0 -311
  86. data/lib/bombbomb/models/sign_upload_request.rb +0 -199
  87. data/lib/bombbomb/models/sign_upload_response.rb +0 -199
  88. data/lib/bombbomb/models/team_public_representation.rb +0 -209
  89. data/lib/bombbomb/models/video_encoding_status_response.rb +0 -209
  90. data/lib/bombbomb/models/video_public_representation.rb +0 -291
  91. data/lib/bombbomb/models/video_recorder_method_response.rb +0 -259
  92. data/spec/api/accounts_api_spec.rb +0 -96
  93. data/spec/api/automations_api_spec.rb +0 -71
  94. data/spec/api/contacts_api_spec.rb +0 -58
  95. data/spec/api/curriculum_api_spec.rb +0 -69
  96. data/spec/api/emails_api_spec.rb +0 -104
  97. data/spec/api/files_api_spec.rb +0 -58
  98. data/spec/api/forms_api_spec.rb +0 -58
  99. data/spec/api/integrations_api_spec.rb +0 -58
  100. data/spec/api/lists_api_spec.rb +0 -83
  101. data/spec/api/orders_api_spec.rb +0 -58
  102. data/spec/api/socials_api_spec.rb +0 -135
  103. data/spec/api/users_api_spec.rb +0 -57
  104. data/spec/api/videos_api_spec.rb +0 -86
  105. data/spec/models/client_group_asset_meta_data_spec.rb +0 -60
  106. data/spec/models/curriculum_spec.rb +0 -95
  107. data/spec/models/curriculum_user_progress_spec.rb +0 -77
  108. data/spec/models/curriculum_with_progress_spec.rb +0 -95
  109. data/spec/models/hosted_doc_spec.rb +0 -83
  110. data/spec/models/prompt_bot_spec.rb +0 -137
  111. data/spec/models/prompt_monthly_performance_spec.rb +0 -60
  112. data/spec/models/prompt_overview_spec.rb +0 -60
  113. data/spec/models/prompt_social_prompt_spec.rb +0 -125
  114. data/spec/models/sign_upload_request_spec.rb +0 -59
  115. data/spec/models/sign_upload_response_spec.rb +0 -59
  116. data/spec/models/video_encoding_status_response_spec.rb +0 -65
  117. data/spec/models/video_public_representation_spec.rb +0 -113
  118. data/spec/models/video_recorder_method_response_spec.rb +0 -95
@@ -3,1244 +3,147 @@
3
3
 
4
4
  #We make it easy to build relationships using simple videos.
5
5
 
6
- OpenAPI spec version: 2.0.831
6
+ OpenAPI spec version: 2.0.20679
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.3.1
10
9
 
11
- =end
12
-
13
- require "uri"
14
-
15
- module BombBomb
16
- class TeamsApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Add Member to Team
24
- # Adds a member to a team.
25
- # @param team_id The team id
26
- # @param [Hash] opts the optional parameters
27
- # @option opts [BOOLEAN] :admin Set if the user is an admin of this team.
28
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
29
- # @option opts [String] :user_email The email of the member being added to the team.
30
- # @option opts [String] :user_id The user id of the member being added to the team.
31
- # @return [String]
32
- def add_team_member(team_id, opts = {})
33
- data, _status_code, _headers = add_team_member_with_http_info(team_id, opts)
34
- return data
35
- end
36
-
37
- # Add Member to Team
38
- # Adds a member to a team.
39
- # @param team_id The team id
40
- # @param [Hash] opts the optional parameters
41
- # @option opts [BOOLEAN] :admin Set if the user is an admin of this team.
42
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
43
- # @option opts [String] :user_email The email of the member being added to the team.
44
- # @option opts [String] :user_id The user id of the member being added to the team.
45
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
46
- def add_team_member_with_http_info(team_id, opts = {})
47
- if @api_client.config.debugging
48
- @api_client.config.logger.debug "Calling API: TeamsApi.add_team_member ..."
49
- end
50
- # verify the required parameter 'team_id' is set
51
- if @api_client.config.client_side_validation && team_id.nil?
52
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_team_member"
53
- end
54
- # resource path
55
- local_var_path = "/team/{teamId}/member".sub('{' + 'teamId' + '}', team_id.to_s)
56
-
57
- # query parameters
58
- query_params = {}
59
-
60
- # header parameters
61
- header_params = {}
62
- # HTTP header 'Accept' (if needed)
63
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
64
- # HTTP header 'Content-Type'
65
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
66
-
67
- # form parameters
68
- form_params = {}
69
- form_params["admin"] = opts[:'admin'] if !opts[:'admin'].nil?
70
- form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?
71
- form_params["userEmail"] = opts[:'user_email'] if !opts[:'user_email'].nil?
72
- form_params["userId"] = opts[:'user_id'] if !opts[:'user_id'].nil?
73
-
74
- # http body (model)
75
- post_body = nil
76
- auth_names = ['BBOAuth2']
77
- data, status_code, headers = @api_client.call_api(:POST, 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 => 'String')
84
- if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: TeamsApi#add_team_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
- end
87
- return data, status_code, headers
88
- end
89
-
90
- # Add users to group.
91
- # Add a new or existing user to group.
92
- # @param team_id The team id
93
- # @param user_details Array of emails or objects containing details needed to create user
94
- # @param [Hash] opts the optional parameters
95
- # @option opts [String] :send_welcome_email Whether to send welcome email to new users
96
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
97
- # @return [nil]
98
- def add_users(team_id, user_details, opts = {})
99
- add_users_with_http_info(team_id, user_details, opts)
100
- return nil
101
- end
102
-
103
- # Add users to group.
104
- # Add a new or existing user to group.
105
- # @param team_id The team id
106
- # @param user_details Array of emails or objects containing details needed to create user
107
- # @param [Hash] opts the optional parameters
108
- # @option opts [String] :send_welcome_email Whether to send welcome email to new users
109
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
110
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
111
- def add_users_with_http_info(team_id, user_details, opts = {})
112
- if @api_client.config.debugging
113
- @api_client.config.logger.debug "Calling API: TeamsApi.add_users ..."
114
- end
115
- # verify the required parameter 'team_id' is set
116
- if @api_client.config.client_side_validation && team_id.nil?
117
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_users"
118
- end
119
- # verify the required parameter 'user_details' is set
120
- if @api_client.config.client_side_validation && user_details.nil?
121
- fail ArgumentError, "Missing the required parameter 'user_details' when calling TeamsApi.add_users"
122
- end
123
- # resource path
124
- local_var_path = "/team/{teamId}/members".sub('{' + 'teamId' + '}', team_id.to_s)
125
-
126
- # query parameters
127
- query_params = {}
128
-
129
- # header parameters
130
- header_params = {}
131
- # HTTP header 'Accept' (if needed)
132
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
133
- # HTTP header 'Content-Type'
134
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
135
-
136
- # form parameters
137
- form_params = {}
138
- form_params["userDetails"] = user_details
139
- form_params["sendWelcomeEmail"] = opts[:'send_welcome_email'] if !opts[:'send_welcome_email'].nil?
140
- form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?
141
-
142
- # http body (model)
143
- post_body = nil
144
- auth_names = ['BBOAuth2']
145
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
146
- :header_params => header_params,
147
- :query_params => query_params,
148
- :form_params => form_params,
149
- :body => post_body,
150
- :auth_names => auth_names)
151
- if @api_client.config.debugging
152
- @api_client.config.logger.debug "API called: TeamsApi#add_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
- end
154
- return data, status_code, headers
155
- end
156
-
157
- # Add members to group from CSV
158
- # Imports members to a group from a given CSV ID.
159
- # @param team_id The team id
160
- # @param csv_import_id ID of the CSV to import
161
- # @param map Object to use when mapping import to AccountCreateDetails. Key is property name on details, value is CSV column number.
162
- # @param [Hash] opts the optional parameters
163
- # @option opts [String] :send_welcome_email Whether to send welcome email to new users
164
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
165
- # @return [nil]
166
- def add_users_from_csv(team_id, csv_import_id, map, opts = {})
167
- add_users_from_csv_with_http_info(team_id, csv_import_id, map, opts)
168
- return nil
169
- end
170
-
171
- # Add members to group from CSV
172
- # Imports members to a group from a given CSV ID.
173
- # @param team_id The team id
174
- # @param csv_import_id ID of the CSV to import
175
- # @param map Object to use when mapping import to AccountCreateDetails. Key is property name on details, value is CSV column number.
176
- # @param [Hash] opts the optional parameters
177
- # @option opts [String] :send_welcome_email Whether to send welcome email to new users
178
- # @option opts [String] :subgroup_ids Subgroup IDs to add user to
179
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
180
- def add_users_from_csv_with_http_info(team_id, csv_import_id, map, opts = {})
181
- if @api_client.config.debugging
182
- @api_client.config.logger.debug "Calling API: TeamsApi.add_users_from_csv ..."
183
- end
184
- # verify the required parameter 'team_id' is set
185
- if @api_client.config.client_side_validation && team_id.nil?
186
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_users_from_csv"
187
- end
188
- # verify the required parameter 'csv_import_id' is set
189
- if @api_client.config.client_side_validation && csv_import_id.nil?
190
- fail ArgumentError, "Missing the required parameter 'csv_import_id' when calling TeamsApi.add_users_from_csv"
191
- end
192
- # verify the required parameter 'map' is set
193
- if @api_client.config.client_side_validation && map.nil?
194
- fail ArgumentError, "Missing the required parameter 'map' when calling TeamsApi.add_users_from_csv"
195
- end
196
- # resource path
197
- local_var_path = "/team/{teamId}/members/csv".sub('{' + 'teamId' + '}', team_id.to_s)
198
-
199
- # query parameters
200
- query_params = {}
201
-
202
- # header parameters
203
- header_params = {}
204
- # HTTP header 'Accept' (if needed)
205
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
206
- # HTTP header 'Content-Type'
207
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
208
-
209
- # form parameters
210
- form_params = {}
211
- form_params["csvImportId"] = csv_import_id
212
- form_params["map"] = map
213
- form_params["sendWelcomeEmail"] = opts[:'send_welcome_email'] if !opts[:'send_welcome_email'].nil?
214
- form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?
215
-
216
- # http body (model)
217
- post_body = nil
218
- auth_names = ['BBOAuth2']
219
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
220
- :header_params => header_params,
221
- :query_params => query_params,
222
- :form_params => form_params,
223
- :body => post_body,
224
- :auth_names => auth_names)
225
- if @api_client.config.debugging
226
- @api_client.config.logger.debug "API called: TeamsApi#add_users_from_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
227
- end
228
- return data, status_code, headers
229
- end
230
-
231
- # Cancel a Jericho Send
232
- # Cancels a scheduled Jericho send from being sent.
233
- # @param jericho_id ID of the Jericho Job to cancel
234
- # @param [Hash] opts the optional parameters
235
- # @return [nil]
236
- def cancel_jericho_send(jericho_id, opts = {})
237
- cancel_jericho_send_with_http_info(jericho_id, opts)
238
- return nil
239
- end
240
-
241
- # Cancel a Jericho Send
242
- # Cancels a scheduled Jericho send from being sent.
243
- # @param jericho_id ID of the Jericho Job to cancel
244
- # @param [Hash] opts the optional parameters
245
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
246
- def cancel_jericho_send_with_http_info(jericho_id, opts = {})
247
- if @api_client.config.debugging
248
- @api_client.config.logger.debug "Calling API: TeamsApi.cancel_jericho_send ..."
249
- end
250
- # verify the required parameter 'jericho_id' is set
251
- if @api_client.config.client_side_validation && jericho_id.nil?
252
- fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.cancel_jericho_send"
253
- end
254
- # resource path
255
- local_var_path = "/team/{teamId}/jericho/{jerichoId}".sub('{' + 'jerichoId' + '}', jericho_id.to_s)
256
-
257
- # query parameters
258
- query_params = {}
259
-
260
- # header parameters
261
- header_params = {}
262
- # HTTP header 'Accept' (if needed)
263
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
264
- # HTTP header 'Content-Type'
265
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
266
-
267
- # form parameters
268
- form_params = {}
269
-
270
- # http body (model)
271
- post_body = nil
272
- auth_names = ['BBOAuth2']
273
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
274
- :header_params => header_params,
275
- :query_params => query_params,
276
- :form_params => form_params,
277
- :body => post_body,
278
- :auth_names => auth_names)
279
- if @api_client.config.debugging
280
- @api_client.config.logger.debug "API called: TeamsApi#cancel_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
281
- end
282
- return data, status_code, headers
283
- end
284
-
285
- # Add a Subteam
286
- # Adds a subteam to a parent team
287
- # @param team_id The team id
288
- # @param name The subteam&#39;s name.
289
- # @param [Hash] opts the optional parameters
290
- # @return [TeamPublicRepresentation]
291
- def create_subteam(team_id, name, opts = {})
292
- data, _status_code, _headers = create_subteam_with_http_info(team_id, name, opts)
293
- return data
294
- end
295
-
296
- # Add a Subteam
297
- # Adds a subteam to a parent team
298
- # @param team_id The team id
299
- # @param name The subteam&#39;s name.
300
- # @param [Hash] opts the optional parameters
301
- # @return [Array<(TeamPublicRepresentation, Fixnum, Hash)>] TeamPublicRepresentation data, response status code and response headers
302
- def create_subteam_with_http_info(team_id, name, opts = {})
303
- if @api_client.config.debugging
304
- @api_client.config.logger.debug "Calling API: TeamsApi.create_subteam ..."
305
- end
306
- # verify the required parameter 'team_id' is set
307
- if @api_client.config.client_side_validation && team_id.nil?
308
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.create_subteam"
309
- end
310
- # verify the required parameter 'name' is set
311
- if @api_client.config.client_side_validation && name.nil?
312
- fail ArgumentError, "Missing the required parameter 'name' when calling TeamsApi.create_subteam"
313
- end
314
- # resource path
315
- local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)
316
-
317
- # query parameters
318
- query_params = {}
319
-
320
- # header parameters
321
- header_params = {}
322
- # HTTP header 'Accept' (if needed)
323
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
324
- # HTTP header 'Content-Type'
325
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
326
-
327
- # form parameters
328
- form_params = {}
329
- form_params["name"] = name
330
-
331
- # http body (model)
332
- post_body = nil
333
- auth_names = ['BBOAuth2']
334
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
335
- :header_params => header_params,
336
- :query_params => query_params,
337
- :form_params => form_params,
338
- :body => post_body,
339
- :auth_names => auth_names,
340
- :return_type => 'TeamPublicRepresentation')
341
- if @api_client.config.debugging
342
- @api_client.config.logger.debug "API called: TeamsApi#create_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
- end
344
- return data, status_code, headers
345
- end
346
-
347
- # Delete Subteam
348
- # Deletes a subteam
349
- # @param team_id The team id
350
- # @param subteam_id The subteam you wish to delete.
351
- # @param [Hash] opts the optional parameters
352
- # @return [String]
353
- def delete_subteam(team_id, subteam_id, opts = {})
354
- data, _status_code, _headers = delete_subteam_with_http_info(team_id, subteam_id, opts)
355
- return data
356
- end
357
-
358
- # Delete Subteam
359
- # Deletes a subteam
360
- # @param team_id The team id
361
- # @param subteam_id The subteam you wish to delete.
362
- # @param [Hash] opts the optional parameters
363
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
364
- def delete_subteam_with_http_info(team_id, subteam_id, opts = {})
365
- if @api_client.config.debugging
366
- @api_client.config.logger.debug "Calling API: TeamsApi.delete_subteam ..."
367
- end
368
- # verify the required parameter 'team_id' is set
369
- if @api_client.config.client_side_validation && team_id.nil?
370
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.delete_subteam"
371
- end
372
- # verify the required parameter 'subteam_id' is set
373
- if @api_client.config.client_side_validation && subteam_id.nil?
374
- fail ArgumentError, "Missing the required parameter 'subteam_id' when calling TeamsApi.delete_subteam"
375
- end
376
- # resource path
377
- local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)
378
-
379
- # query parameters
380
- query_params = {}
381
-
382
- # header parameters
383
- header_params = {}
384
- # HTTP header 'Accept' (if needed)
385
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
386
- # HTTP header 'Content-Type'
387
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
388
-
389
- # form parameters
390
- form_params = {}
391
- form_params["subteamId"] = subteam_id
392
-
393
- # http body (model)
394
- post_body = nil
395
- auth_names = ['BBOAuth2']
396
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
397
- :header_params => header_params,
398
- :query_params => query_params,
399
- :form_params => form_params,
400
- :body => post_body,
401
- :auth_names => auth_names,
402
- :return_type => 'String')
403
- if @api_client.config.debugging
404
- @api_client.config.logger.debug "API called: TeamsApi#delete_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
405
- end
406
- return data, status_code, headers
407
- end
408
-
409
- # Lists team associations
410
- # Returns a collection of team associations for a given user
411
- # @param client_id The clientId requesting group associations.
412
- # @param [Hash] opts the optional parameters
413
- # @return [nil]
414
- def get_all_client_group_associations(client_id, opts = {})
415
- get_all_client_group_associations_with_http_info(client_id, opts)
416
- return nil
417
- end
418
-
419
- # Lists team associations
420
- # Returns a collection of team associations for a given user
421
- # @param client_id The clientId requesting group associations.
422
- # @param [Hash] opts the optional parameters
423
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
424
- def get_all_client_group_associations_with_http_info(client_id, opts = {})
425
- if @api_client.config.debugging
426
- @api_client.config.logger.debug "Calling API: TeamsApi.get_all_client_group_associations ..."
427
- end
428
- # verify the required parameter 'client_id' is set
429
- if @api_client.config.client_side_validation && client_id.nil?
430
- fail ArgumentError, "Missing the required parameter 'client_id' when calling TeamsApi.get_all_client_group_associations"
431
- end
432
- # resource path
433
- local_var_path = "/team/associations/"
434
-
435
- # query parameters
436
- query_params = {}
437
- query_params[:'clientId'] = client_id
438
-
439
- # header parameters
440
- header_params = {}
441
- # HTTP header 'Accept' (if needed)
442
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
443
- # HTTP header 'Content-Type'
444
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
445
-
446
- # form parameters
447
- form_params = {}
448
-
449
- # http body (model)
450
- post_body = nil
451
- auth_names = ['BBOAuth2']
452
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
453
- :header_params => header_params,
454
- :query_params => query_params,
455
- :form_params => form_params,
456
- :body => post_body,
457
- :auth_names => auth_names)
458
- if @api_client.config.debugging
459
- @api_client.config.logger.debug "API called: TeamsApi#get_all_client_group_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
460
- end
461
- return data, status_code, headers
462
- end
463
-
464
- # Lists team assets
465
- # Returns a collection of assets
466
- # @param asset_type The type of assets.
467
- # @param [Hash] opts the optional parameters
468
- # @option opts [String] :team_id The team containing the assets.
469
- # @option opts [String] :auto_tag_name The auto tag name containing the assets.
470
- # @option opts [String] :page_size The number of items to retrieve in a single db query.
471
- # @option opts [String] :page Zero-based index of the page of data to retrieve from the db.
472
- # @option opts [String] :search Search words.
473
- # @return [InlineResponse200]
474
- def get_client_group_assets(asset_type, opts = {})
475
- data, _status_code, _headers = get_client_group_assets_with_http_info(asset_type, opts)
476
- return data
477
- end
478
-
479
- # Lists team assets
480
- # Returns a collection of assets
481
- # @param asset_type The type of assets.
482
- # @param [Hash] opts the optional parameters
483
- # @option opts [String] :team_id The team containing the assets.
484
- # @option opts [String] :auto_tag_name The auto tag name containing the assets.
485
- # @option opts [String] :page_size The number of items to retrieve in a single db query.
486
- # @option opts [String] :page Zero-based index of the page of data to retrieve from the db.
487
- # @option opts [String] :search Search words.
488
- # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
489
- def get_client_group_assets_with_http_info(asset_type, opts = {})
490
- if @api_client.config.debugging
491
- @api_client.config.logger.debug "Calling API: TeamsApi.get_client_group_assets ..."
492
- end
493
- # verify the required parameter 'asset_type' is set
494
- if @api_client.config.client_side_validation && asset_type.nil?
495
- fail ArgumentError, "Missing the required parameter 'asset_type' when calling TeamsApi.get_client_group_assets"
496
- end
497
- # verify enum value
498
- if @api_client.config.client_side_validation && !['email', 'video'].include?(asset_type)
499
- fail ArgumentError, "invalid value for 'asset_type', must be one of email, video"
500
- end
501
- # resource path
502
- local_var_path = "/team/assets/"
503
-
504
- # query parameters
505
- query_params = {}
506
- query_params[:'assetType'] = asset_type
507
- query_params[:'teamId'] = opts[:'team_id'] if !opts[:'team_id'].nil?
508
- query_params[:'autoTagName'] = opts[:'auto_tag_name'] if !opts[:'auto_tag_name'].nil?
509
- query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
510
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
511
- query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
512
-
513
- # header parameters
514
- header_params = {}
515
- # HTTP header 'Accept' (if needed)
516
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
517
- # HTTP header 'Content-Type'
518
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
519
-
520
- # form parameters
521
- form_params = {}
522
-
523
- # http body (model)
524
- post_body = nil
525
- auth_names = ['BBOAuth2']
526
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
527
- :header_params => header_params,
528
- :query_params => query_params,
529
- :form_params => form_params,
530
- :body => post_body,
531
- :auth_names => auth_names,
532
- :return_type => 'InlineResponse200')
533
- if @api_client.config.debugging
534
- @api_client.config.logger.debug "API called: TeamsApi#get_client_group_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
535
- end
536
- return data, status_code, headers
537
- end
538
-
539
- # Get Team statistics
540
- # Get top level statistic data for a Team
541
- # @param team_id The team id
542
- # @param [Hash] opts the optional parameters
543
- # @option opts [String] :member_status The status of members to query for
544
- # @return [nil]
545
- def get_client_group_statistics(team_id, opts = {})
546
- get_client_group_statistics_with_http_info(team_id, opts)
547
- return nil
548
- end
549
-
550
- # Get Team statistics
551
- # Get top level statistic data for a Team
552
- # @param team_id The team id
553
- # @param [Hash] opts the optional parameters
554
- # @option opts [String] :member_status The status of members to query for
555
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
556
- def get_client_group_statistics_with_http_info(team_id, opts = {})
557
- if @api_client.config.debugging
558
- @api_client.config.logger.debug "Calling API: TeamsApi.get_client_group_statistics ..."
559
- end
560
- # verify the required parameter 'team_id' is set
561
- if @api_client.config.client_side_validation && team_id.nil?
562
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_client_group_statistics"
563
- end
564
- if @api_client.config.client_side_validation && opts[:'member_status'] && !['all', 'active', 'inactive', 'self-paid'].include?(opts[:'member_status'])
565
- fail ArgumentError, 'invalid value for "member_status", must be one of all, active, inactive, self-paid'
566
- end
567
- # resource path
568
- local_var_path = "/team/{teamId}/stats".sub('{' + 'teamId' + '}', team_id.to_s)
569
-
570
- # query parameters
571
- query_params = {}
572
- query_params[:'memberStatus'] = opts[:'member_status'] if !opts[:'member_status'].nil?
573
-
574
- # header parameters
575
- header_params = {}
576
- # HTTP header 'Accept' (if needed)
577
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
578
- # HTTP header 'Content-Type'
579
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
580
-
581
- # form parameters
582
- form_params = {}
583
-
584
- # http body (model)
585
- post_body = nil
586
- auth_names = ['BBOAuth2']
587
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
588
- :header_params => header_params,
589
- :query_params => query_params,
590
- :form_params => form_params,
591
- :body => post_body,
592
- :auth_names => auth_names)
593
- if @api_client.config.debugging
594
- @api_client.config.logger.debug "API called: TeamsApi#get_client_group_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
595
- end
596
- return data, status_code, headers
597
- end
598
-
599
- # List Jericho Sends
600
- # Lists Jericho sends, both pending and sent.
601
- # @param team_id The team whose Jericho sends you wish to see.
602
- # @param [Hash] opts the optional parameters
603
- # @return [Array<JerichoConfiguration>]
604
- def get_jericho_sends(team_id, opts = {})
605
- data, _status_code, _headers = get_jericho_sends_with_http_info(team_id, opts)
606
- return data
607
- end
608
-
609
- # List Jericho Sends
610
- # Lists Jericho sends, both pending and sent.
611
- # @param team_id The team whose Jericho sends you wish to see.
612
- # @param [Hash] opts the optional parameters
613
- # @return [Array<(Array<JerichoConfiguration>, Fixnum, Hash)>] Array<JerichoConfiguration> data, response status code and response headers
614
- def get_jericho_sends_with_http_info(team_id, opts = {})
615
- if @api_client.config.debugging
616
- @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_sends ..."
617
- end
618
- # verify the required parameter 'team_id' is set
619
- if @api_client.config.client_side_validation && team_id.nil?
620
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_sends"
621
- end
622
- # resource path
623
- local_var_path = "/team/{teamId}/jericho".sub('{' + 'teamId' + '}', team_id.to_s)
624
-
625
- # query parameters
626
- query_params = {}
627
-
628
- # header parameters
629
- header_params = {}
630
- # HTTP header 'Accept' (if needed)
631
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
632
- # HTTP header 'Content-Type'
633
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
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(:GET, 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 => 'Array<JerichoConfiguration>')
648
- if @api_client.config.debugging
649
- @api_client.config.logger.debug "API called: TeamsApi#get_jericho_sends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
650
- end
651
- return data, status_code, headers
652
- end
653
-
654
- # Gets Jericho performance statistics
655
- # Returns an aggregate view of the performance of a Jericho send
656
- # @param jericho_id ID of the Jericho job
657
- # @param team_id ID of team through which Jericho was sent
658
- # @param [Hash] opts the optional parameters
659
- # @return [JerichoPerformance]
660
- def get_jericho_stats(jericho_id, team_id, opts = {})
661
- data, _status_code, _headers = get_jericho_stats_with_http_info(jericho_id, team_id, opts)
662
- return data
663
- end
664
-
665
- # Gets Jericho performance statistics
666
- # Returns an aggregate view of the performance of a Jericho send
667
- # @param jericho_id ID of the Jericho job
668
- # @param team_id ID of team through which Jericho was sent
669
- # @param [Hash] opts the optional parameters
670
- # @return [Array<(JerichoPerformance, Fixnum, Hash)>] JerichoPerformance data, response status code and response headers
671
- def get_jericho_stats_with_http_info(jericho_id, team_id, opts = {})
672
- if @api_client.config.debugging
673
- @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_stats ..."
674
- end
675
- # verify the required parameter 'jericho_id' is set
676
- if @api_client.config.client_side_validation && jericho_id.nil?
677
- fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.get_jericho_stats"
678
- end
679
- # verify the required parameter 'team_id' is set
680
- if @api_client.config.client_side_validation && team_id.nil?
681
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_stats"
682
- end
683
- # resource path
684
- local_var_path = "/team/{teamId}/jericho/{jerichoId}/performance".sub('{' + 'jerichoId' + '}', jericho_id.to_s).sub('{' + 'teamId' + '}', team_id.to_s)
685
-
686
- # query parameters
687
- query_params = {}
688
-
689
- # header parameters
690
- header_params = {}
691
- # HTTP header 'Accept' (if needed)
692
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
693
- # HTTP header 'Content-Type'
694
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
695
-
696
- # form parameters
697
- form_params = {}
698
-
699
- # http body (model)
700
- post_body = nil
701
- auth_names = ['BBOAuth2']
702
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
703
- :header_params => header_params,
704
- :query_params => query_params,
705
- :form_params => form_params,
706
- :body => post_body,
707
- :auth_names => auth_names,
708
- :return_type => 'JerichoPerformance')
709
- if @api_client.config.debugging
710
- @api_client.config.logger.debug "API called: TeamsApi#get_jericho_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
711
- end
712
- return data, status_code, headers
713
- end
714
-
715
- # List Team Members
716
- # Get a paginated listing of Team members
717
- # @param team_id The team id
718
- # @param page_size Amount of records to return in a page.
719
- # @param page The page to return.
720
- # @param [Hash] opts the optional parameters
721
- # @option opts [String] :status The status type to filter by.
722
- # @option opts [String] :search Filter results with names that match the search term.
723
- # @option opts [String] :order_by Key to order results by
724
- # @option opts [String] :order_direction ASC or DESC
725
- # @return [nil]
726
- def get_paged_client_group_members(team_id, page_size, page, opts = {})
727
- get_paged_client_group_members_with_http_info(team_id, page_size, page, opts)
728
- return nil
729
- end
730
-
731
- # List Team Members
732
- # Get a paginated listing of Team members
733
- # @param team_id The team id
734
- # @param page_size Amount of records to return in a page.
735
- # @param page The page to return.
736
- # @param [Hash] opts the optional parameters
737
- # @option opts [String] :status The status type to filter by.
738
- # @option opts [String] :search Filter results with names that match the search term.
739
- # @option opts [String] :order_by Key to order results by
740
- # @option opts [String] :order_direction ASC or DESC
741
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
742
- def get_paged_client_group_members_with_http_info(team_id, page_size, page, opts = {})
743
- if @api_client.config.debugging
744
- @api_client.config.logger.debug "Calling API: TeamsApi.get_paged_client_group_members ..."
745
- end
746
- # verify the required parameter 'team_id' is set
747
- if @api_client.config.client_side_validation && team_id.nil?
748
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_paged_client_group_members"
749
- end
750
- # verify the required parameter 'page_size' is set
751
- if @api_client.config.client_side_validation && page_size.nil?
752
- fail ArgumentError, "Missing the required parameter 'page_size' when calling TeamsApi.get_paged_client_group_members"
753
- end
754
- # verify the required parameter 'page' is set
755
- if @api_client.config.client_side_validation && page.nil?
756
- fail ArgumentError, "Missing the required parameter 'page' when calling TeamsApi.get_paged_client_group_members"
757
- end
758
- if @api_client.config.client_side_validation && opts[:'order_by'] && !['jobs', 'logins', 'videos', 'contacts', 'firstName', 'lastName', 'status', 'isAdmin'].include?(opts[:'order_by'])
759
- fail ArgumentError, 'invalid value for "order_by", must be one of jobs, logins, videos, contacts, firstName, lastName, status, isAdmin'
760
- end
761
- if @api_client.config.client_side_validation && opts[:'order_direction'] && !['ASC', 'DESC'].include?(opts[:'order_direction'])
762
- fail ArgumentError, 'invalid value for "order_direction", must be one of ASC, DESC'
763
- end
764
- # resource path
765
- local_var_path = "/team/{teamId}/members".sub('{' + 'teamId' + '}', team_id.to_s)
766
-
767
- # query parameters
768
- query_params = {}
769
- query_params[:'pageSize'] = page_size
770
- query_params[:'page'] = page
771
- query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
772
- query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
773
- query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
774
- query_params[:'orderDirection'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
775
-
776
- # header parameters
777
- header_params = {}
778
- # HTTP header 'Accept' (if needed)
779
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
780
- # HTTP header 'Content-Type'
781
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
782
-
783
- # form parameters
784
- form_params = {}
785
-
786
- # http body (model)
787
- post_body = nil
788
- auth_names = ['BBOAuth2']
789
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
790
- :header_params => header_params,
791
- :query_params => query_params,
792
- :form_params => form_params,
793
- :body => post_body,
794
- :auth_names => auth_names)
795
- if @api_client.config.debugging
796
- @api_client.config.logger.debug "API called: TeamsApi#get_paged_client_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
797
- end
798
- return data, status_code, headers
799
- end
800
-
801
- # Jericho Monthly Stats
802
- # Jericho Monthly Stats
803
- # @param month The month whose Jericho sends you wish to see.
804
- # @param year The year whose Jericho sends you wish to see.
805
- # @param [Hash] opts the optional parameters
806
- # @return [String]
807
- def get_prompt_monthly_stats(month, year, opts = {})
808
- data, _status_code, _headers = get_prompt_monthly_stats_with_http_info(month, year, opts)
809
- return data
810
- end
811
-
812
- # Jericho Monthly Stats
813
- # Jericho Monthly Stats
814
- # @param month The month whose Jericho sends you wish to see.
815
- # @param year The year whose Jericho sends you wish to see.
816
- # @param [Hash] opts the optional parameters
817
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
818
- def get_prompt_monthly_stats_with_http_info(month, year, opts = {})
819
- if @api_client.config.debugging
820
- @api_client.config.logger.debug "Calling API: TeamsApi.get_prompt_monthly_stats ..."
821
- end
822
- # verify the required parameter 'month' is set
823
- if @api_client.config.client_side_validation && month.nil?
824
- fail ArgumentError, "Missing the required parameter 'month' when calling TeamsApi.get_prompt_monthly_stats"
825
- end
826
- # verify the required parameter 'year' is set
827
- if @api_client.config.client_side_validation && year.nil?
828
- fail ArgumentError, "Missing the required parameter 'year' when calling TeamsApi.get_prompt_monthly_stats"
829
- end
830
- # resource path
831
- local_var_path = "/team/{month}/{year}/monthStats".sub('{' + 'month' + '}', month.to_s).sub('{' + 'year' + '}', year.to_s)
832
-
833
- # query parameters
834
- query_params = {}
835
-
836
- # header parameters
837
- header_params = {}
838
- # HTTP header 'Accept' (if needed)
839
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
840
- # HTTP header 'Content-Type'
841
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
842
-
843
- # form parameters
844
- form_params = {}
845
-
846
- # http body (model)
847
- post_body = nil
848
- auth_names = ['BBOAuth2']
849
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
850
- :header_params => header_params,
851
- :query_params => query_params,
852
- :form_params => form_params,
853
- :body => post_body,
854
- :auth_names => auth_names,
855
- :return_type => 'String')
856
- if @api_client.config.debugging
857
- @api_client.config.logger.debug "API called: TeamsApi#get_prompt_monthly_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
858
- end
859
- return data, status_code, headers
860
- end
861
-
862
- # Get Prompt Overview
863
- # Get Prompt Overview
864
- # @param [Hash] opts the optional parameters
865
- # @return [String]
866
- def get_prompt_overview(opts = {})
867
- data, _status_code, _headers = get_prompt_overview_with_http_info(opts)
868
- return data
869
- end
870
-
871
- # Get Prompt Overview
872
- # Get Prompt Overview
873
- # @param [Hash] opts the optional parameters
874
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
875
- def get_prompt_overview_with_http_info(opts = {})
876
- if @api_client.config.debugging
877
- @api_client.config.logger.debug "Calling API: TeamsApi.get_prompt_overview ..."
878
- end
879
- # resource path
880
- local_var_path = "/team/promptOverview"
881
-
882
- # query parameters
883
- query_params = {}
884
-
885
- # header parameters
886
- header_params = {}
887
- # HTTP header 'Accept' (if needed)
888
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
889
- # HTTP header 'Content-Type'
890
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
891
-
892
- # form parameters
893
- form_params = {}
894
-
895
- # http body (model)
896
- post_body = nil
897
- auth_names = ['BBOAuth2']
898
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
899
- :header_params => header_params,
900
- :query_params => query_params,
901
- :form_params => form_params,
902
- :body => post_body,
903
- :auth_names => auth_names,
904
- :return_type => 'String')
905
- if @api_client.config.debugging
906
- @api_client.config.logger.debug "API called: TeamsApi#get_prompt_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
907
- end
908
- return data, status_code, headers
909
- end
910
-
911
- # List Subteams
912
- # Returns a collection of subteams for a parent team
913
- # @param team_id The team id
914
- # @param [Hash] opts the optional parameters
915
- # @return [Array<TeamPublicRepresentation>]
916
- def get_subteams(team_id, opts = {})
917
- data, _status_code, _headers = get_subteams_with_http_info(team_id, opts)
918
- return data
919
- end
920
-
921
- # List Subteams
922
- # Returns a collection of subteams for a parent team
923
- # @param team_id The team id
924
- # @param [Hash] opts the optional parameters
925
- # @return [Array<(Array<TeamPublicRepresentation>, Fixnum, Hash)>] Array<TeamPublicRepresentation> data, response status code and response headers
926
- def get_subteams_with_http_info(team_id, opts = {})
927
- if @api_client.config.debugging
928
- @api_client.config.logger.debug "Calling API: TeamsApi.get_subteams ..."
929
- end
930
- # verify the required parameter 'team_id' is set
931
- if @api_client.config.client_side_validation && team_id.nil?
932
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_subteams"
933
- end
934
- # resource path
935
- local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)
936
-
937
- # query parameters
938
- query_params = {}
939
-
940
- # header parameters
941
- header_params = {}
942
- # HTTP header 'Accept' (if needed)
943
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
944
- # HTTP header 'Content-Type'
945
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
946
-
947
- # form parameters
948
- form_params = {}
949
-
950
- # http body (model)
951
- post_body = nil
952
- auth_names = []
953
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
954
- :header_params => header_params,
955
- :query_params => query_params,
956
- :form_params => form_params,
957
- :body => post_body,
958
- :auth_names => auth_names,
959
- :return_type => 'Array<TeamPublicRepresentation>')
960
- if @api_client.config.debugging
961
- @api_client.config.logger.debug "API called: TeamsApi#get_subteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
962
- end
963
- return data, status_code, headers
964
- end
965
-
966
- # Get aggregate stats for campaigns
967
- # Get all the campaigns aggregate stats
968
- # @param client_group_id ID of the client group association
969
- # @param [Hash] opts the optional parameters
970
- # @return [nil]
971
- def get_team_prompt_aggregate_stats(client_group_id, opts = {})
972
- get_team_prompt_aggregate_stats_with_http_info(client_group_id, opts)
973
- return nil
974
- end
975
-
976
- # Get aggregate stats for campaigns
977
- # Get all the campaigns aggregate stats
978
- # @param client_group_id ID of the client group association
979
- # @param [Hash] opts the optional parameters
980
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
981
- def get_team_prompt_aggregate_stats_with_http_info(client_group_id, opts = {})
982
- if @api_client.config.debugging
983
- @api_client.config.logger.debug "Calling API: TeamsApi.get_team_prompt_aggregate_stats ..."
984
- end
985
- # verify the required parameter 'client_group_id' is set
986
- if @api_client.config.client_side_validation && client_group_id.nil?
987
- fail ArgumentError, "Missing the required parameter 'client_group_id' when calling TeamsApi.get_team_prompt_aggregate_stats"
988
- end
989
- # resource path
990
- local_var_path = "/team/{clientGroupId}/campaign/stats".sub('{' + 'clientGroupId' + '}', client_group_id.to_s)
991
-
992
- # query parameters
993
- query_params = {}
994
-
995
- # header parameters
996
- header_params = {}
997
- # HTTP header 'Accept' (if needed)
998
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
999
- # HTTP header 'Content-Type'
1000
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
1001
-
1002
- # form parameters
1003
- form_params = {}
1004
-
1005
- # http body (model)
1006
- post_body = nil
1007
- auth_names = ['BBOAuth2']
1008
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1009
- :header_params => header_params,
1010
- :query_params => query_params,
1011
- :form_params => form_params,
1012
- :body => post_body,
1013
- :auth_names => auth_names)
1014
- if @api_client.config.debugging
1015
- @api_client.config.logger.debug "API called: TeamsApi#get_team_prompt_aggregate_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1016
- end
1017
- return data, status_code, headers
1018
- end
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
1019
13
 
1020
- # Get campaigns for team
1021
- # Get campaigns for the team and their stats
1022
- # @param client_group_id ID of the client group association
1023
- # @param [Hash] opts the optional parameters
1024
- # @option opts [String] :search_term The value to search for in prompt subject
1025
- # @option opts [String] :current_page The current page
1026
- # @return [nil]
1027
- def get_team_prompt_campaigns(client_group_id, opts = {})
1028
- get_team_prompt_campaigns_with_http_info(client_group_id, opts)
1029
- return nil
1030
- end
14
+ http://www.apache.org/licenses/LICENSE-2.0
1031
15
 
1032
- # Get campaigns for team
1033
- # Get campaigns for the team and their stats
1034
- # @param client_group_id ID of the client group association
1035
- # @param [Hash] opts the optional parameters
1036
- # @option opts [String] :search_term The value to search for in prompt subject
1037
- # @option opts [String] :current_page The current page
1038
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1039
- def get_team_prompt_campaigns_with_http_info(client_group_id, opts = {})
1040
- if @api_client.config.debugging
1041
- @api_client.config.logger.debug "Calling API: TeamsApi.get_team_prompt_campaigns ..."
1042
- end
1043
- # verify the required parameter 'client_group_id' is set
1044
- if @api_client.config.client_side_validation && client_group_id.nil?
1045
- fail ArgumentError, "Missing the required parameter 'client_group_id' when calling TeamsApi.get_team_prompt_campaigns"
1046
- end
1047
- # resource path
1048
- local_var_path = "/team/{clientGroupId}/campaign".sub('{' + 'clientGroupId' + '}', client_group_id.to_s)
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.
1049
21
 
1050
- # query parameters
1051
- query_params = {}
1052
- query_params[:'searchTerm'] = opts[:'search_term'] if !opts[:'search_term'].nil?
1053
- query_params[:'currentPage'] = opts[:'current_page'] if !opts[:'current_page'].nil?
22
+ =end
1054
23
 
1055
- # header parameters
1056
- header_params = {}
1057
- # HTTP header 'Accept' (if needed)
1058
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1059
- # HTTP header 'Content-Type'
1060
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
24
+ require "uri"
1061
25
 
1062
- # form parameters
1063
- form_params = {}
26
+ module BombBomb
27
+ class TeamsApi
28
+ attr_accessor :api_client
1064
29
 
1065
- # http body (model)
1066
- post_body = nil
1067
- auth_names = ['BBOAuth2']
1068
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1069
- :header_params => header_params,
1070
- :query_params => query_params,
1071
- :form_params => form_params,
1072
- :body => post_body,
1073
- :auth_names => auth_names)
1074
- if @api_client.config.debugging
1075
- @api_client.config.logger.debug "API called: TeamsApi#get_team_prompt_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1076
- end
1077
- return data, status_code, headers
30
+ def initialize(api_client = ApiClient.default)
31
+ @api_client = api_client
1078
32
  end
1079
33
 
1080
- # Invite a list to join the admin's social prompt team
1081
- # Invite to Social Prompt Team
1082
- # @param team_id The team id
1083
- # @param list_id List to invite to the social prompt team.
34
+ # Cancel a Jericho Send
35
+ # Cancels a scheduled Jericho send from being sent.
36
+ # @param jericho_id ID of the Jericho Job to cancel
1084
37
  # @param [Hash] opts the optional parameters
1085
38
  # @return [nil]
1086
- def invite_to_social_prompt_team(team_id, list_id, opts = {})
1087
- invite_to_social_prompt_team_with_http_info(team_id, list_id, opts)
39
+ def cancel_jericho_send(jericho_id, opts = {})
40
+ cancel_jericho_send_with_http_info(jericho_id, opts)
1088
41
  return nil
1089
42
  end
1090
43
 
1091
- # Invite a list to join the admin&#39;s social prompt team
1092
- # Invite to Social Prompt Team
1093
- # @param team_id The team id
1094
- # @param list_id List to invite to the social prompt team.
44
+ # Cancel a Jericho Send
45
+ # Cancels a scheduled Jericho send from being sent.
46
+ # @param jericho_id ID of the Jericho Job to cancel
1095
47
  # @param [Hash] opts the optional parameters
1096
48
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1097
- def invite_to_social_prompt_team_with_http_info(team_id, list_id, opts = {})
49
+ def cancel_jericho_send_with_http_info(jericho_id, opts = {})
1098
50
  if @api_client.config.debugging
1099
- @api_client.config.logger.debug "Calling API: TeamsApi.invite_to_social_prompt_team ..."
1100
- end
1101
- # verify the required parameter 'team_id' is set
1102
- if @api_client.config.client_side_validation && team_id.nil?
1103
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.invite_to_social_prompt_team"
1104
- end
1105
- # verify the required parameter 'list_id' is set
1106
- if @api_client.config.client_side_validation && list_id.nil?
1107
- fail ArgumentError, "Missing the required parameter 'list_id' when calling TeamsApi.invite_to_social_prompt_team"
51
+ @api_client.config.logger.debug "Calling API: TeamsApi.cancel_jericho_send ..."
1108
52
  end
53
+ # verify the required parameter 'jericho_id' is set
54
+ fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.cancel_jericho_send" if jericho_id.nil?
1109
55
  # resource path
1110
- local_var_path = "/teams/prompt/invite"
56
+ local_var_path = "/team/{teamId}/jericho/{jerichoId}".sub('{format}','json').sub('{' + 'jerichoId' + '}', jericho_id.to_s)
1111
57
 
1112
58
  # query parameters
1113
59
  query_params = {}
1114
60
 
1115
61
  # header parameters
1116
62
  header_params = {}
63
+
1117
64
  # HTTP header 'Accept' (if needed)
1118
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
1119
68
  # HTTP header 'Content-Type'
1120
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
69
+ local_header_content_type = []
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1121
71
 
1122
72
  # form parameters
1123
73
  form_params = {}
1124
- form_params["teamId"] = team_id
1125
- form_params["listId"] = list_id
1126
74
 
1127
75
  # http body (model)
1128
76
  post_body = nil
1129
77
  auth_names = ['BBOAuth2']
1130
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
78
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1131
79
  :header_params => header_params,
1132
80
  :query_params => query_params,
1133
81
  :form_params => form_params,
1134
82
  :body => post_body,
1135
83
  :auth_names => auth_names)
1136
84
  if @api_client.config.debugging
1137
- @api_client.config.logger.debug "API called: TeamsApi#invite_to_social_prompt_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ @api_client.config.logger.debug "API called: TeamsApi#cancel_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1138
86
  end
1139
87
  return data, status_code, headers
1140
88
  end
1141
89
 
1142
- # Creates a Jericho send.
1143
- # 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.
1144
- # @param config JSON representing a Jericho configuration
1145
- # @param team_id The ID of the team.
90
+ # Lists team assets
91
+ # Returns a collection of assets
92
+ # @param asset_type The type of assets.
1146
93
  # @param [Hash] opts the optional parameters
1147
- # @return [JerichoConfiguration]
1148
- def queue_jericho_send(config, team_id, opts = {})
1149
- data, _status_code, _headers = queue_jericho_send_with_http_info(config, team_id, opts)
94
+ # @option opts [String] :team_id The team containing the assets.
95
+ # @option opts [String] :auto_tag_name The auto tag name containing the assets.
96
+ # @option opts [String] :page_size The number of items to retrieve in a single db query.
97
+ # @option opts [String] :page Zero-based index of the page of data to retrieve from the db.
98
+ # @option opts [String] :search Search words.
99
+ # @return [InlineResponse200]
100
+ def get_client_group_assets(asset_type, opts = {})
101
+ data, _status_code, _headers = get_client_group_assets_with_http_info(asset_type, opts)
1150
102
  return data
1151
103
  end
1152
104
 
1153
- # Creates a Jericho send.
1154
- # 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.
1155
- # @param config JSON representing a Jericho configuration
1156
- # @param team_id The ID of the team.
105
+ # Lists team assets
106
+ # Returns a collection of assets
107
+ # @param asset_type The type of assets.
1157
108
  # @param [Hash] opts the optional parameters
1158
- # @return [Array<(JerichoConfiguration, Fixnum, Hash)>] JerichoConfiguration data, response status code and response headers
1159
- def queue_jericho_send_with_http_info(config, team_id, opts = {})
109
+ # @option opts [String] :team_id The team containing the assets.
110
+ # @option opts [String] :auto_tag_name The auto tag name containing the assets.
111
+ # @option opts [String] :page_size The number of items to retrieve in a single db query.
112
+ # @option opts [String] :page Zero-based index of the page of data to retrieve from the db.
113
+ # @option opts [String] :search Search words.
114
+ # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
115
+ def get_client_group_assets_with_http_info(asset_type, opts = {})
1160
116
  if @api_client.config.debugging
1161
- @api_client.config.logger.debug "Calling API: TeamsApi.queue_jericho_send ..."
1162
- end
1163
- # verify the required parameter 'config' is set
1164
- if @api_client.config.client_side_validation && config.nil?
1165
- fail ArgumentError, "Missing the required parameter 'config' when calling TeamsApi.queue_jericho_send"
117
+ @api_client.config.logger.debug "Calling API: TeamsApi.get_client_group_assets ..."
1166
118
  end
1167
- # verify the required parameter 'team_id' is set
1168
- if @api_client.config.client_side_validation && team_id.nil?
1169
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.queue_jericho_send"
119
+ # verify the required parameter 'asset_type' is set
120
+ fail ArgumentError, "Missing the required parameter 'asset_type' when calling TeamsApi.get_client_group_assets" if asset_type.nil?
121
+ # verify enum value
122
+ unless ['email', 'video'].include?(asset_type)
123
+ fail ArgumentError, "invalid value for 'asset_type', must be one of email, video"
1170
124
  end
1171
125
  # resource path
1172
- local_var_path = "/team/{teamId}/jericho".sub('{' + 'teamId' + '}', team_id.to_s)
126
+ local_var_path = "/team/assets/".sub('{format}','json')
1173
127
 
1174
128
  # query parameters
1175
129
  query_params = {}
130
+ query_params[:'assetType'] = asset_type
131
+ query_params[:'teamId'] = opts[:'team_id'] if !opts[:'team_id'].nil?
132
+ query_params[:'autoTagName'] = opts[:'auto_tag_name'] if !opts[:'auto_tag_name'].nil?
133
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
134
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
135
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
1176
136
 
1177
137
  # header parameters
1178
138
  header_params = {}
1179
- # HTTP header 'Accept' (if needed)
1180
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1181
- # HTTP header 'Content-Type'
1182
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1183
-
1184
- # form parameters
1185
- form_params = {}
1186
-
1187
- # http body (model)
1188
- post_body = @api_client.object_to_http_body(config)
1189
- auth_names = ['BBOAuth2']
1190
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1191
- :header_params => header_params,
1192
- :query_params => query_params,
1193
- :form_params => form_params,
1194
- :body => post_body,
1195
- :auth_names => auth_names,
1196
- :return_type => 'JerichoConfiguration')
1197
- if @api_client.config.debugging
1198
- @api_client.config.logger.debug "API called: TeamsApi#queue_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1199
- end
1200
- return data, status_code, headers
1201
- end
1202
-
1203
- # Remove Member from Team
1204
- # Removes a member from a team.
1205
- # @param team_id The team id
1206
- # @param user_id The user id of the member being removed.
1207
- # @param [Hash] opts the optional parameters
1208
- # @return [String]
1209
- def remove_member_from_team(team_id, user_id, opts = {})
1210
- data, _status_code, _headers = remove_member_from_team_with_http_info(team_id, user_id, opts)
1211
- return data
1212
- end
1213
-
1214
- # Remove Member from Team
1215
- # Removes a member from a team.
1216
- # @param team_id The team id
1217
- # @param user_id The user id of the member being removed.
1218
- # @param [Hash] opts the optional parameters
1219
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1220
- def remove_member_from_team_with_http_info(team_id, user_id, opts = {})
1221
- if @api_client.config.debugging
1222
- @api_client.config.logger.debug "Calling API: TeamsApi.remove_member_from_team ..."
1223
- end
1224
- # verify the required parameter 'team_id' is set
1225
- if @api_client.config.client_side_validation && team_id.nil?
1226
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.remove_member_from_team"
1227
- end
1228
- # verify the required parameter 'user_id' is set
1229
- if @api_client.config.client_side_validation && user_id.nil?
1230
- fail ArgumentError, "Missing the required parameter 'user_id' when calling TeamsApi.remove_member_from_team"
1231
- end
1232
- # resource path
1233
- local_var_path = "/team/{teamId}/member/{userId}".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1234
-
1235
- # query parameters
1236
- query_params = {}
1237
139
 
1238
- # header parameters
1239
- header_params = {}
1240
140
  # HTTP header 'Accept' (if needed)
1241
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
141
+ local_header_accept = ['application/json']
142
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
143
+
1242
144
  # HTTP header 'Content-Type'
1243
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
145
+ local_header_content_type = []
146
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1244
147
 
1245
148
  # form parameters
1246
149
  form_params = {}
@@ -1248,60 +151,56 @@ module BombBomb
1248
151
  # http body (model)
1249
152
  post_body = nil
1250
153
  auth_names = ['BBOAuth2']
1251
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
154
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1252
155
  :header_params => header_params,
1253
156
  :query_params => query_params,
1254
157
  :form_params => form_params,
1255
158
  :body => post_body,
1256
159
  :auth_names => auth_names,
1257
- :return_type => 'String')
160
+ :return_type => 'InlineResponse200')
1258
161
  if @api_client.config.debugging
1259
- @api_client.config.logger.debug "API called: TeamsApi#remove_member_from_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
162
+ @api_client.config.logger.debug "API called: TeamsApi#get_client_group_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1260
163
  end
1261
164
  return data, status_code, headers
1262
165
  end
1263
166
 
1264
- # Resend invite
1265
- # Resend invitation to a member of a team
1266
- # @param team_id The team id
1267
- # @param member_user_id The user id of the member being resent an invitation.
167
+ # List Jericho Sends
168
+ # Lists Jericho sends, both pending and sent.
169
+ # @param team_id The team whose Jericho sends you wish to see.
1268
170
  # @param [Hash] opts the optional parameters
1269
- # @return [TeamPublicRepresentation]
1270
- def resend_team_member_invitation(team_id, member_user_id, opts = {})
1271
- data, _status_code, _headers = resend_team_member_invitation_with_http_info(team_id, member_user_id, opts)
171
+ # @return [Array<JerichoConfiguration>]
172
+ def get_jericho_sends(team_id, opts = {})
173
+ data, _status_code, _headers = get_jericho_sends_with_http_info(team_id, opts)
1272
174
  return data
1273
175
  end
1274
176
 
1275
- # Resend invite
1276
- # Resend invitation to a member of a team
1277
- # @param team_id The team id
1278
- # @param member_user_id The user id of the member being resent an invitation.
177
+ # List Jericho Sends
178
+ # Lists Jericho sends, both pending and sent.
179
+ # @param team_id The team whose Jericho sends you wish to see.
1279
180
  # @param [Hash] opts the optional parameters
1280
- # @return [Array<(TeamPublicRepresentation, Fixnum, Hash)>] TeamPublicRepresentation data, response status code and response headers
1281
- def resend_team_member_invitation_with_http_info(team_id, member_user_id, opts = {})
181
+ # @return [Array<(Array<JerichoConfiguration>, Fixnum, Hash)>] Array<JerichoConfiguration> data, response status code and response headers
182
+ def get_jericho_sends_with_http_info(team_id, opts = {})
1282
183
  if @api_client.config.debugging
1283
- @api_client.config.logger.debug "Calling API: TeamsApi.resend_team_member_invitation ..."
184
+ @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_sends ..."
1284
185
  end
1285
186
  # verify the required parameter 'team_id' is set
1286
- if @api_client.config.client_side_validation && team_id.nil?
1287
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.resend_team_member_invitation"
1288
- end
1289
- # verify the required parameter 'member_user_id' is set
1290
- if @api_client.config.client_side_validation && member_user_id.nil?
1291
- fail ArgumentError, "Missing the required parameter 'member_user_id' when calling TeamsApi.resend_team_member_invitation"
1292
- end
187
+ fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_sends" if team_id.nil?
1293
188
  # resource path
1294
- local_var_path = "/team/{teamId}/{memberUserId}/rewelcome".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'memberUserId' + '}', member_user_id.to_s)
189
+ local_var_path = "/team/{teamId}/jericho".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
1295
190
 
1296
191
  # query parameters
1297
192
  query_params = {}
1298
193
 
1299
194
  # header parameters
1300
195
  header_params = {}
196
+
1301
197
  # HTTP header 'Accept' (if needed)
1302
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
198
+ local_header_accept = ['application/json']
199
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
200
+
1303
201
  # HTTP header 'Content-Type'
1304
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
202
+ local_header_content_type = []
203
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1305
204
 
1306
205
  # form parameters
1307
206
  form_params = {}
@@ -1309,60 +208,60 @@ module BombBomb
1309
208
  # http body (model)
1310
209
  post_body = nil
1311
210
  auth_names = ['BBOAuth2']
1312
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
211
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1313
212
  :header_params => header_params,
1314
213
  :query_params => query_params,
1315
214
  :form_params => form_params,
1316
215
  :body => post_body,
1317
216
  :auth_names => auth_names,
1318
- :return_type => 'TeamPublicRepresentation')
217
+ :return_type => 'Array<JerichoConfiguration>')
1319
218
  if @api_client.config.debugging
1320
- @api_client.config.logger.debug "API called: TeamsApi#resend_team_member_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
+ @api_client.config.logger.debug "API called: TeamsApi#get_jericho_sends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1321
220
  end
1322
221
  return data, status_code, headers
1323
222
  end
1324
223
 
1325
- # Updates the Jericho Prompt Settings
1326
- # Updates the prompt settings based on the original email id
1327
- # @param team_id The team id
224
+ # Gets Jericho performance statistics
225
+ # Returns an aggregate view of the performance of a Jericho send
1328
226
  # @param jericho_id ID of the Jericho job
227
+ # @param team_id ID of team through which Jericho was sent
1329
228
  # @param [Hash] opts the optional parameters
1330
- # @return [nil]
1331
- def update_jericho_prompt_send(team_id, jericho_id, opts = {})
1332
- update_jericho_prompt_send_with_http_info(team_id, jericho_id, opts)
1333
- return nil
229
+ # @return [JerichoPerformance]
230
+ def get_jericho_stats(jericho_id, team_id, opts = {})
231
+ data, _status_code, _headers = get_jericho_stats_with_http_info(jericho_id, team_id, opts)
232
+ return data
1334
233
  end
1335
234
 
1336
- # Updates the Jericho Prompt Settings
1337
- # Updates the prompt settings based on the original email id
1338
- # @param team_id The team id
235
+ # Gets Jericho performance statistics
236
+ # Returns an aggregate view of the performance of a Jericho send
1339
237
  # @param jericho_id ID of the Jericho job
238
+ # @param team_id ID of team through which Jericho was sent
1340
239
  # @param [Hash] opts the optional parameters
1341
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1342
- def update_jericho_prompt_send_with_http_info(team_id, jericho_id, opts = {})
240
+ # @return [Array<(JerichoPerformance, Fixnum, Hash)>] JerichoPerformance data, response status code and response headers
241
+ def get_jericho_stats_with_http_info(jericho_id, team_id, opts = {})
1343
242
  if @api_client.config.debugging
1344
- @api_client.config.logger.debug "Calling API: TeamsApi.update_jericho_prompt_send ..."
1345
- end
1346
- # verify the required parameter 'team_id' is set
1347
- if @api_client.config.client_side_validation && team_id.nil?
1348
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_jericho_prompt_send"
243
+ @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_stats ..."
1349
244
  end
1350
245
  # verify the required parameter 'jericho_id' is set
1351
- if @api_client.config.client_side_validation && jericho_id.nil?
1352
- fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.update_jericho_prompt_send"
1353
- end
246
+ fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.get_jericho_stats" if jericho_id.nil?
247
+ # verify the required parameter 'team_id' is set
248
+ fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_stats" if team_id.nil?
1354
249
  # resource path
1355
- local_var_path = "/team/{teamId}/jericho/{jerichoId}".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'jerichoId' + '}', jericho_id.to_s)
250
+ local_var_path = "/team/{teamId}/jericho/{jerichoId}/performance".sub('{format}','json').sub('{' + 'jerichoId' + '}', jericho_id.to_s).sub('{' + 'teamId' + '}', team_id.to_s)
1356
251
 
1357
252
  # query parameters
1358
253
  query_params = {}
1359
254
 
1360
255
  # header parameters
1361
256
  header_params = {}
257
+
1362
258
  # HTTP header 'Accept' (if needed)
1363
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
259
+ local_header_accept = ['application/json']
260
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
261
+
1364
262
  # HTTP header 'Content-Type'
1365
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
263
+ local_header_content_type = []
264
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1366
265
 
1367
266
  # form parameters
1368
267
  form_params = {}
@@ -1370,68 +269,66 @@ module BombBomb
1370
269
  # http body (model)
1371
270
  post_body = nil
1372
271
  auth_names = ['BBOAuth2']
1373
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
272
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1374
273
  :header_params => header_params,
1375
274
  :query_params => query_params,
1376
275
  :form_params => form_params,
1377
276
  :body => post_body,
1378
- :auth_names => auth_names)
277
+ :auth_names => auth_names,
278
+ :return_type => 'JerichoPerformance')
1379
279
  if @api_client.config.debugging
1380
- @api_client.config.logger.debug "API called: TeamsApi#update_jericho_prompt_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
280
+ @api_client.config.logger.debug "API called: TeamsApi#get_jericho_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1381
281
  end
1382
282
  return data, status_code, headers
1383
283
  end
1384
284
 
1385
- # Update a team
1386
- # Update fields on a team
1387
- # @param team_id The team id
285
+ # Creates a Jericho send.
286
+ # 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
+ # @param config JSON representing a Jericho configuration
288
+ # @param team_id The ID of the team.
1388
289
  # @param [Hash] opts the optional parameters
1389
- # @option opts [String] :name The name of the team
1390
- # @option opts [String] :state The status of the login permissions
1391
- # @option opts [BOOLEAN] :subteams_can_add_members Updates subteam member adding setting on group
1392
- # @return [TeamPublicRepresentation]
1393
- def update_team(team_id, opts = {})
1394
- data, _status_code, _headers = update_team_with_http_info(team_id, opts)
290
+ # @return [JerichoConfiguration]
291
+ def queue_jericho_send(config, team_id, opts = {})
292
+ data, _status_code, _headers = queue_jericho_send_with_http_info(config, team_id, opts)
1395
293
  return data
1396
294
  end
1397
295
 
1398
- # Update a team
1399
- # Update fields on a team
1400
- # @param team_id The team id
296
+ # Creates a Jericho send.
297
+ # 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.
298
+ # @param config JSON representing a Jericho configuration
299
+ # @param team_id The ID of the team.
1401
300
  # @param [Hash] opts the optional parameters
1402
- # @option opts [String] :name The name of the team
1403
- # @option opts [String] :state The status of the login permissions
1404
- # @option opts [BOOLEAN] :subteams_can_add_members Updates subteam member adding setting on group
1405
- # @return [Array<(TeamPublicRepresentation, Fixnum, Hash)>] TeamPublicRepresentation data, response status code and response headers
1406
- def update_team_with_http_info(team_id, opts = {})
301
+ # @return [Array<(JerichoConfiguration, Fixnum, Hash)>] JerichoConfiguration data, response status code and response headers
302
+ def queue_jericho_send_with_http_info(config, team_id, opts = {})
1407
303
  if @api_client.config.debugging
1408
- @api_client.config.logger.debug "Calling API: TeamsApi.update_team ..."
304
+ @api_client.config.logger.debug "Calling API: TeamsApi.queue_jericho_send ..."
1409
305
  end
306
+ # verify the required parameter 'config' is set
307
+ fail ArgumentError, "Missing the required parameter 'config' when calling TeamsApi.queue_jericho_send" if config.nil?
1410
308
  # verify the required parameter 'team_id' is set
1411
- if @api_client.config.client_side_validation && team_id.nil?
1412
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_team"
1413
- end
309
+ fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.queue_jericho_send" if team_id.nil?
1414
310
  # resource path
1415
- local_var_path = "/team/{teamId}".sub('{' + 'teamId' + '}', team_id.to_s)
311
+ local_var_path = "/team/{teamId}/jericho".sub('{format}','json').sub('{' + 'teamId' + '}', team_id.to_s)
1416
312
 
1417
313
  # query parameters
1418
314
  query_params = {}
1419
315
 
1420
316
  # header parameters
1421
317
  header_params = {}
318
+
1422
319
  # HTTP header 'Accept' (if needed)
1423
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
320
+ local_header_accept = ['application/json']
321
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
322
+
1424
323
  # HTTP header 'Content-Type'
1425
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
324
+ local_header_content_type = []
325
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1426
326
 
1427
327
  # form parameters
1428
328
  form_params = {}
1429
- form_params["name"] = opts[:'name'] if !opts[:'name'].nil?
1430
- form_params["state"] = opts[:'state'] if !opts[:'state'].nil?
1431
- form_params["subteamsCanAddMembers"] = opts[:'subteams_can_add_members'] if !opts[:'subteams_can_add_members'].nil?
1432
329
 
1433
330
  # http body (model)
1434
- post_body = nil
331
+ post_body = @api_client.object_to_http_body(config)
1435
332
  auth_names = ['BBOAuth2']
1436
333
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1437
334
  :header_params => header_params,
@@ -1439,80 +336,9 @@ module BombBomb
1439
336
  :form_params => form_params,
1440
337
  :body => post_body,
1441
338
  :auth_names => auth_names,
1442
- :return_type => 'TeamPublicRepresentation')
1443
- if @api_client.config.debugging
1444
- @api_client.config.logger.debug "API called: TeamsApi#update_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1445
- end
1446
- return data, status_code, headers
1447
- end
1448
-
1449
- # Update Member of Team
1450
- # Updates a member of a team
1451
- # @param team_id The team id
1452
- # @param user_id The user id of the member being added to the team.
1453
- # @param admin Set if the user is an admin of this team.
1454
- # @param [Hash] opts the optional parameters
1455
- # @option opts [String] :permission_suite_id Set if the user is an admin of this team.
1456
- # @return [nil]
1457
- def update_team_member(team_id, user_id, admin, opts = {})
1458
- update_team_member_with_http_info(team_id, user_id, admin, opts)
1459
- return nil
1460
- end
1461
-
1462
- # Update Member of Team
1463
- # Updates a member of a team
1464
- # @param team_id The team id
1465
- # @param user_id The user id of the member being added to the team.
1466
- # @param admin Set if the user is an admin of this team.
1467
- # @param [Hash] opts the optional parameters
1468
- # @option opts [String] :permission_suite_id Set if the user is an admin of this team.
1469
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1470
- def update_team_member_with_http_info(team_id, user_id, admin, opts = {})
1471
- if @api_client.config.debugging
1472
- @api_client.config.logger.debug "Calling API: TeamsApi.update_team_member ..."
1473
- end
1474
- # verify the required parameter 'team_id' is set
1475
- if @api_client.config.client_side_validation && team_id.nil?
1476
- fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_team_member"
1477
- end
1478
- # verify the required parameter 'user_id' is set
1479
- if @api_client.config.client_side_validation && user_id.nil?
1480
- fail ArgumentError, "Missing the required parameter 'user_id' when calling TeamsApi.update_team_member"
1481
- end
1482
- # verify the required parameter 'admin' is set
1483
- if @api_client.config.client_side_validation && admin.nil?
1484
- fail ArgumentError, "Missing the required parameter 'admin' when calling TeamsApi.update_team_member"
1485
- end
1486
- # resource path
1487
- local_var_path = "/team/{teamId}/member".sub('{' + 'teamId' + '}', team_id.to_s)
1488
-
1489
- # query parameters
1490
- query_params = {}
1491
-
1492
- # header parameters
1493
- header_params = {}
1494
- # HTTP header 'Accept' (if needed)
1495
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1496
- # HTTP header 'Content-Type'
1497
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
1498
-
1499
- # form parameters
1500
- form_params = {}
1501
- form_params["userId"] = user_id
1502
- form_params["admin"] = admin
1503
- form_params["permissionSuiteId"] = opts[:'permission_suite_id'] if !opts[:'permission_suite_id'].nil?
1504
-
1505
- # http body (model)
1506
- post_body = nil
1507
- auth_names = ['BBOAuth2']
1508
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1509
- :header_params => header_params,
1510
- :query_params => query_params,
1511
- :form_params => form_params,
1512
- :body => post_body,
1513
- :auth_names => auth_names)
339
+ :return_type => 'JerichoConfiguration')
1514
340
  if @api_client.config.debugging
1515
- @api_client.config.logger.debug "API called: TeamsApi#update_team_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
341
+ @api_client.config.logger.debug "API called: TeamsApi#queue_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1516
342
  end
1517
343
  return data, status_code, headers
1518
344
  end