Class: BombBomb::TeamsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bombbomb/api/teams_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamsApi

Returns a new instance of TeamsApi.



19
20
21
 
# File 'lib/bombbomb/api/teams_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bombbomb/api/teams_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_team_member(team_id, opts = {}) ⇒ String

Add Member to Team Adds a member to a team.

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :admin (BOOLEAN) —

    Set if the user is an admin of this team.

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

  • :user_email (String) —

    The email of the member being added to the team.

  • :user_id (String) —

    The user id of the member being added to the team.

Returns:



32
33
34
35
 
# File 'lib/bombbomb/api/teams_api.rb', line 32

def add_team_member(team_id, opts = {})
  data, _status_code, _headers = add_team_member_with_http_info(team_id, opts)
  return data
end

#add_team_member_with_http_info(team_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Add Member to Team Adds a member to a team.

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :admin (BOOLEAN) —

    Set if the user is an admin of this team.

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

  • :user_email (String) —

    The email of the member being added to the team.

  • :user_id (String) —

    The user id of the member being added to the team.

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/bombbomb/api/teams_api.rb', line 46

def add_team_member_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.add_team_member ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_team_member"
  end
  # resource path
  local_var_path = "/team/{teamId}/member".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["admin"] = opts[:'admin'] if !opts[:'admin'].nil?
  form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?
  form_params["userEmail"] = opts[:'user_email'] if !opts[:'user_email'].nil?
  form_params["userId"] = opts[:'user_id'] if !opts[:'user_id'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#add_team_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_users(team_id, user_details, opts = {}) ⇒ nil

Add users to group. Add a new or existing user to group.

Parameters:

  • team_id —

    The team id

  • user_details —

    Array of emails or objects containing details needed to create user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :send_welcome_email (String) —

    Whether to send welcome email to new users

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/bombbomb/api/teams_api.rb', line 98

def add_users(team_id, user_details, opts = {})
  add_users_with_http_info(team_id, user_details, opts)
  return nil
end

#add_users_from_csv(team_id, csv_import_id, map, opts = {}) ⇒ nil

Add members to group from CSV Imports members to a group from a given CSV ID.

Parameters:

  • team_id —

    The team id

  • csv_import_id —

    ID of the CSV to import

  • map —

    Object to use when mapping import to AccountCreateDetails. Key is property name on details, value is CSV column number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :send_welcome_email (String) —

    Whether to send welcome email to new users

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

Returns:

  • (nil) 


166
167
168
169
 
# File 'lib/bombbomb/api/teams_api.rb', line 166

def add_users_from_csv(team_id, csv_import_id, map, opts = {})
  add_users_from_csv_with_http_info(team_id, csv_import_id, map, opts)
  return nil
end

#add_users_from_csv_with_http_info(team_id, csv_import_id, map, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add members to group from CSV Imports members to a group from a given CSV ID.

Parameters:

  • team_id —

    The team id

  • csv_import_id —

    ID of the CSV to import

  • map —

    Object to use when mapping import to AccountCreateDetails. Key is property name on details, value is CSV column number.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :send_welcome_email (String) —

    Whether to send welcome email to new users

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/bombbomb/api/teams_api.rb', line 180

def add_users_from_csv_with_http_info(team_id, csv_import_id, map, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.add_users_from_csv ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_users_from_csv"
  end
  # verify the required parameter 'csv_import_id' is set
  if @api_client.config.client_side_validation && csv_import_id.nil?
    fail ArgumentError, "Missing the required parameter 'csv_import_id' when calling TeamsApi.add_users_from_csv"
  end
  # verify the required parameter 'map' is set
  if @api_client.config.client_side_validation && map.nil?
    fail ArgumentError, "Missing the required parameter 'map' when calling TeamsApi.add_users_from_csv"
  end
  # resource path
  local_var_path = "/team/{teamId}/members/csv".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["csvImportId"] = csv_import_id
  form_params["map"] = map
  form_params["sendWelcomeEmail"] = opts[:'send_welcome_email'] if !opts[:'send_welcome_email'].nil?
  form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#add_users_from_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_users_with_http_info(team_id, user_details, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add users to group. Add a new or existing user to group.

Parameters:

  • team_id —

    The team id

  • user_details —

    Array of emails or objects containing details needed to create user

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :send_welcome_email (String) —

    Whether to send welcome email to new users

  • :subgroup_ids (String) —

    Subgroup IDs to add user to

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/bombbomb/api/teams_api.rb', line 111

def add_users_with_http_info(team_id, user_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.add_users ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.add_users"
  end
  # verify the required parameter 'user_details' is set
  if @api_client.config.client_side_validation && user_details.nil?
    fail ArgumentError, "Missing the required parameter 'user_details' when calling TeamsApi.add_users"
  end
  # resource path
  local_var_path = "/team/{teamId}/members".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["userDetails"] = user_details
  form_params["sendWelcomeEmail"] = opts[:'send_welcome_email'] if !opts[:'send_welcome_email'].nil?
  form_params["subgroupIds"] = opts[:'subgroup_ids'] if !opts[:'subgroup_ids'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#add_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_jericho_send(jericho_id, opts = {}) ⇒ nil

Cancel a Jericho Send Cancels a scheduled Jericho send from being sent.

Parameters:

  • jericho_id —

    ID of the Jericho Job to cancel

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


236
237
238
239
 
# File 'lib/bombbomb/api/teams_api.rb', line 236

def cancel_jericho_send(jericho_id, opts = {})
  cancel_jericho_send_with_http_info(jericho_id, opts)
  return nil
end

#cancel_jericho_send_with_http_info(jericho_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel a Jericho Send Cancels a scheduled Jericho send from being sent.

Parameters:

  • jericho_id —

    ID of the Jericho Job to cancel

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/bombbomb/api/teams_api.rb', line 246

def cancel_jericho_send_with_http_info(jericho_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.cancel_jericho_send ..."
  end
  # verify the required parameter 'jericho_id' is set
  if @api_client.config.client_side_validation && jericho_id.nil?
    fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.cancel_jericho_send"
  end
  # resource path
  local_var_path = "/team/{teamId}/jericho/{jerichoId}".sub('{' + 'jerichoId' + '}', jericho_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#cancel_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_subteam(team_id, name, opts = {}) ⇒ TeamPublicRepresentation

Add a Subteam Adds a subteam to a parent team

Parameters:

  • team_id —

    The team id

  • name —

    The subteam&#39;s name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/bombbomb/api/teams_api.rb', line 291

def create_subteam(team_id, name, opts = {})
  data, _status_code, _headers = create_subteam_with_http_info(team_id, name, opts)
  return data
end

#create_subteam_with_http_info(team_id, name, opts = {}) ⇒ Array<(TeamPublicRepresentation, Fixnum, Hash)>

Add a Subteam Adds a subteam to a parent team

Parameters:

  • team_id —

    The team id

  • name —

    The subteam&#39;s name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TeamPublicRepresentation, Fixnum, Hash)>) —

    TeamPublicRepresentation data, response status code and response headers



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/bombbomb/api/teams_api.rb', line 302

def create_subteam_with_http_info(team_id, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.create_subteam ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.create_subteam"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling TeamsApi.create_subteam"
  end
  # resource path
  local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["name"] = name

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TeamPublicRepresentation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#create_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_subteam(team_id, subteam_id, opts = {}) ⇒ String

Delete Subteam Deletes a subteam

Parameters:

  • team_id —

    The team id

  • subteam_id —

    The subteam you wish to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/bombbomb/api/teams_api.rb', line 353

def delete_subteam(team_id, subteam_id, opts = {})
  data, _status_code, _headers = delete_subteam_with_http_info(team_id, subteam_id, opts)
  return data
end

#delete_subteam_with_http_info(team_id, subteam_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete Subteam Deletes a subteam

Parameters:

  • team_id —

    The team id

  • subteam_id —

    The subteam you wish to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/bombbomb/api/teams_api.rb', line 364

def delete_subteam_with_http_info(team_id, subteam_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.delete_subteam ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.delete_subteam"
  end
  # verify the required parameter 'subteam_id' is set
  if @api_client.config.client_side_validation && subteam_id.nil?
    fail ArgumentError, "Missing the required parameter 'subteam_id' when calling TeamsApi.delete_subteam"
  end
  # resource path
  local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["subteamId"] = subteam_id

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#delete_subteam\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_client_group_associations(client_id, opts = {}) ⇒ nil

Lists team associations Returns a collection of team associations for a given user

Parameters:

  • client_id —

    The clientId requesting group associations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


414
415
416
417
 
# File 'lib/bombbomb/api/teams_api.rb', line 414

def get_all_client_group_associations(client_id, opts = {})
  get_all_client_group_associations_with_http_info(client_id, opts)
  return nil
end

#get_all_client_group_associations_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Lists team associations Returns a collection of team associations for a given user

Parameters:

  • client_id —

    The clientId requesting group associations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/bombbomb/api/teams_api.rb', line 424

def get_all_client_group_associations_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_all_client_group_associations ..."
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling TeamsApi.get_all_client_group_associations"
  end
  # resource path
  local_var_path = "/team/associations/"

  # query parameters
  query_params = {}
  query_params[:'clientId'] = client_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_all_client_group_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_group_assets(asset_type, opts = {}) ⇒ InlineResponse200

Lists team assets Returns a collection of assets

Parameters:

  • asset_type —

    The type of assets.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    The team containing the assets.

  • :auto_tag_name (String) —

    The auto tag name containing the assets.

  • :page_size (String) —

    The number of items to retrieve in a single db query.

  • :page (String) —

    Zero-based index of the page of data to retrieve from the db.

  • :search (String) —

    Search words.

Returns:



474
475
476
477
 
# File 'lib/bombbomb/api/teams_api.rb', line 474

def get_client_group_assets(asset_type, opts = {})
  data, _status_code, _headers = get_client_group_assets_with_http_info(asset_type, opts)
  return data
end

#get_client_group_assets_with_http_info(asset_type, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Lists team assets Returns a collection of assets

Parameters:

  • asset_type —

    The type of assets.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    The team containing the assets.

  • :auto_tag_name (String) —

    The auto tag name containing the assets.

  • :page_size (String) —

    The number of items to retrieve in a single db query.

  • :page (String) —

    Zero-based index of the page of data to retrieve from the db.

  • :search (String) —

    Search words.

Returns:

  • (Array<(InlineResponse200, Fixnum, Hash)>) —

    InlineResponse200 data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/bombbomb/api/teams_api.rb', line 489

def get_client_group_assets_with_http_info(asset_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_client_group_assets ..."
  end
  # verify the required parameter 'asset_type' is set
  if @api_client.config.client_side_validation && asset_type.nil?
    fail ArgumentError, "Missing the required parameter 'asset_type' when calling TeamsApi.get_client_group_assets"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['email', 'video'].include?(asset_type)
    fail ArgumentError, "invalid value for 'asset_type', must be one of email, video"
  end
  # resource path
  local_var_path = "/team/assets/"

  # query parameters
  query_params = {}
  query_params[:'assetType'] = asset_type
  query_params[:'teamId'] = opts[:'team_id'] if !opts[:'team_id'].nil?
  query_params[:'autoTagName'] = opts[:'auto_tag_name'] if !opts[:'auto_tag_name'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse200')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_client_group_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_group_statistics(team_id, opts = {}) ⇒ nil

Get Team statistics Get top level statistic data for a Team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :member_status (String) —

    The status of members to query for

Returns:

  • (nil) 


545
546
547
548
 
# File 'lib/bombbomb/api/teams_api.rb', line 545

def get_client_group_statistics(team_id, opts = {})
  get_client_group_statistics_with_http_info(team_id, opts)
  return nil
end

#get_client_group_statistics_with_http_info(team_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get Team statistics Get top level statistic data for a Team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :member_status (String) —

    The status of members to query for

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/bombbomb/api/teams_api.rb', line 556

def get_client_group_statistics_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_client_group_statistics ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_client_group_statistics"
  end
  if @api_client.config.client_side_validation && opts[:'member_status'] && !['all', 'active', 'inactive', 'self-paid'].include?(opts[:'member_status'])
    fail ArgumentError, 'invalid value for "member_status", must be one of all, active, inactive, self-paid'
  end
  # resource path
  local_var_path = "/team/{teamId}/stats".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'memberStatus'] = opts[:'member_status'] if !opts[:'member_status'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_client_group_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_jericho_sends(team_id, opts = {}) ⇒ Array<JerichoConfiguration>

List Jericho Sends Lists Jericho sends, both pending and sent.

Parameters:

  • team_id —

    The team whose Jericho sends you wish to see.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



604
605
606
607
 
# File 'lib/bombbomb/api/teams_api.rb', line 604

def get_jericho_sends(team_id, opts = {})
  data, _status_code, _headers = get_jericho_sends_with_http_info(team_id, opts)
  return data
end

#get_jericho_sends_with_http_info(team_id, opts = {}) ⇒ Array<(Array<JerichoConfiguration>, Fixnum, Hash)>

List Jericho Sends Lists Jericho sends, both pending and sent.

Parameters:

  • team_id —

    The team whose Jericho sends you wish to see.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<JerichoConfiguration>, Fixnum, Hash)>) —

    Array<JerichoConfiguration> data, response status code and response headers



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/bombbomb/api/teams_api.rb', line 614

def get_jericho_sends_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_sends ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_sends"
  end
  # resource path
  local_var_path = "/team/{teamId}/jericho".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<JerichoConfiguration>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_jericho_sends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_jericho_stats(jericho_id, team_id, opts = {}) ⇒ JerichoPerformance

Gets Jericho performance statistics Returns an aggregate view of the performance of a Jericho send

Parameters:

  • jericho_id —

    ID of the Jericho job

  • team_id —

    ID of team through which Jericho was sent

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



660
661
662
663
 
# File 'lib/bombbomb/api/teams_api.rb', line 660

def get_jericho_stats(jericho_id, team_id, opts = {})
  data, _status_code, _headers = get_jericho_stats_with_http_info(jericho_id, team_id, opts)
  return data
end

#get_jericho_stats_with_http_info(jericho_id, team_id, opts = {}) ⇒ Array<(JerichoPerformance, Fixnum, Hash)>

Gets Jericho performance statistics Returns an aggregate view of the performance of a Jericho send

Parameters:

  • jericho_id —

    ID of the Jericho job

  • team_id —

    ID of team through which Jericho was sent

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(JerichoPerformance, Fixnum, Hash)>) —

    JerichoPerformance data, response status code and response headers



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/bombbomb/api/teams_api.rb', line 671

def get_jericho_stats_with_http_info(jericho_id, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_jericho_stats ..."
  end
  # verify the required parameter 'jericho_id' is set
  if @api_client.config.client_side_validation && jericho_id.nil?
    fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.get_jericho_stats"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_jericho_stats"
  end
  # resource path
  local_var_path = "/team/{teamId}/jericho/{jerichoId}/performance".sub('{' + 'jerichoId' + '}', jericho_id.to_s).sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JerichoPerformance')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_jericho_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_paged_client_group_members(team_id, page_size, page, opts = {}) ⇒ nil

List Team Members Get a paginated listing of Team members

Parameters:

  • team_id —

    The team id

  • page_size —

    Amount of records to return in a page.

  • page —

    The page to return.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status type to filter by.

  • :search (String) —

    Filter results with names that match the search term.

  • :order_by (String) —

    Key to order results by

  • :order_direction (String) —

    ASC or DESC

Returns:

  • (nil) 


726
727
728
729
 
# File 'lib/bombbomb/api/teams_api.rb', line 726

def get_paged_client_group_members(team_id, page_size, page, opts = {})
  get_paged_client_group_members_with_http_info(team_id, page_size, page, opts)
  return nil
end

#get_paged_client_group_members_with_http_info(team_id, page_size, page, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

List Team Members Get a paginated listing of Team members

Parameters:

  • team_id —

    The team id

  • page_size —

    Amount of records to return in a page.

  • page —

    The page to return.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status type to filter by.

  • :search (String) —

    Filter results with names that match the search term.

  • :order_by (String) —

    Key to order results by

  • :order_direction (String) —

    ASC or DESC

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/bombbomb/api/teams_api.rb', line 742

def get_paged_client_group_members_with_http_info(team_id, page_size, page, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_paged_client_group_members ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_paged_client_group_members"
  end
  # verify the required parameter 'page_size' is set
  if @api_client.config.client_side_validation && page_size.nil?
    fail ArgumentError, "Missing the required parameter 'page_size' when calling TeamsApi.get_paged_client_group_members"
  end
  # verify the required parameter 'page' is set
  if @api_client.config.client_side_validation && page.nil?
    fail ArgumentError, "Missing the required parameter 'page' when calling TeamsApi.get_paged_client_group_members"
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['jobs', 'logins', 'videos', 'contacts', 'firstName', 'lastName', 'status', 'isAdmin'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of jobs, logins, videos, contacts, firstName, lastName, status, isAdmin'
  end
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !['ASC', 'DESC'].include?(opts[:'order_direction'])
    fail ArgumentError, 'invalid value for "order_direction", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/team/{teamId}/members".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = page_size
  query_params[:'page'] = page
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'orderDirection'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_paged_client_group_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prompt_monthly_stats(month, year, opts = {}) ⇒ String

Jericho Monthly Stats Jericho Monthly Stats

Parameters:

  • month —

    The month whose Jericho sends you wish to see.

  • year —

    The year whose Jericho sends you wish to see.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



807
808
809
810
 
# File 'lib/bombbomb/api/teams_api.rb', line 807

def get_prompt_monthly_stats(month, year, opts = {})
  data, _status_code, _headers = get_prompt_monthly_stats_with_http_info(month, year, opts)
  return data
end

#get_prompt_monthly_stats_with_http_info(month, year, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Jericho Monthly Stats Jericho Monthly Stats

Parameters:

  • month —

    The month whose Jericho sends you wish to see.

  • year —

    The year whose Jericho sends you wish to see.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/bombbomb/api/teams_api.rb', line 818

def get_prompt_monthly_stats_with_http_info(month, year, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_prompt_monthly_stats ..."
  end
  # verify the required parameter 'month' is set
  if @api_client.config.client_side_validation && month.nil?
    fail ArgumentError, "Missing the required parameter 'month' when calling TeamsApi.get_prompt_monthly_stats"
  end
  # verify the required parameter 'year' is set
  if @api_client.config.client_side_validation && year.nil?
    fail ArgumentError, "Missing the required parameter 'year' when calling TeamsApi.get_prompt_monthly_stats"
  end
  # resource path
  local_var_path = "/team/{month}/{year}/monthStats".sub('{' + 'month' + '}', month.to_s).sub('{' + 'year' + '}', year.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_prompt_monthly_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_prompt_overview(opts = {}) ⇒ String

Get Prompt Overview Get Prompt Overview

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



866
867
868
869
 
# File 'lib/bombbomb/api/teams_api.rb', line 866

def get_prompt_overview(opts = {})
  data, _status_code, _headers = get_prompt_overview_with_http_info(opts)
  return data
end

#get_prompt_overview_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get Prompt Overview Get Prompt Overview

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/bombbomb/api/teams_api.rb', line 875

def get_prompt_overview_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_prompt_overview ..."
  end
  # resource path
  local_var_path = "/team/promptOverview"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_prompt_overview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_subteams(team_id, opts = {}) ⇒ Array<TeamPublicRepresentation>

List Subteams Returns a collection of subteams for a parent team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



916
917
918
919
 
# File 'lib/bombbomb/api/teams_api.rb', line 916

def get_subteams(team_id, opts = {})
  data, _status_code, _headers = get_subteams_with_http_info(team_id, opts)
  return data
end

#get_subteams_with_http_info(team_id, opts = {}) ⇒ Array<(Array<TeamPublicRepresentation>, Fixnum, Hash)>

List Subteams Returns a collection of subteams for a parent team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<TeamPublicRepresentation>, Fixnum, Hash)>) —

    Array<TeamPublicRepresentation> data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/bombbomb/api/teams_api.rb', line 926

def get_subteams_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_subteams ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.get_subteams"
  end
  # resource path
  local_var_path = "/team/{teamId}/subteam".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<TeamPublicRepresentation>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_subteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team_prompt_aggregate_stats(client_group_id, opts = {}) ⇒ nil

Get aggregate stats for campaigns Get all the campaigns aggregate stats

Parameters:

  • client_group_id —

    ID of the client group association

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


971
972
973
974
 
# File 'lib/bombbomb/api/teams_api.rb', line 971

def get_team_prompt_aggregate_stats(client_group_id, opts = {})
  get_team_prompt_aggregate_stats_with_http_info(client_group_id, opts)
  return nil
end

#get_team_prompt_aggregate_stats_with_http_info(client_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get aggregate stats for campaigns Get all the campaigns aggregate stats

Parameters:

  • client_group_id —

    ID of the client group association

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/bombbomb/api/teams_api.rb', line 981

def get_team_prompt_aggregate_stats_with_http_info(client_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_team_prompt_aggregate_stats ..."
  end
  # verify the required parameter 'client_group_id' is set
  if @api_client.config.client_side_validation && client_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_group_id' when calling TeamsApi.get_team_prompt_aggregate_stats"
  end
  # resource path
  local_var_path = "/team/{clientGroupId}/campaign/stats".sub('{' + 'clientGroupId' + '}', client_group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_team_prompt_aggregate_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team_prompt_campaigns(client_group_id, opts = {}) ⇒ nil

Get campaigns for team Get campaigns for the team and their stats

Parameters:

  • client_group_id —

    ID of the client group association

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    The value to search for in prompt subject

  • :current_page (String) —

    The current page

Returns:

  • (nil) 


1027
1028
1029
1030
 
# File 'lib/bombbomb/api/teams_api.rb', line 1027

def get_team_prompt_campaigns(client_group_id, opts = {})
  get_team_prompt_campaigns_with_http_info(client_group_id, opts)
  return nil
end

#get_team_prompt_campaigns_with_http_info(client_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get campaigns for team Get campaigns for the team and their stats

Parameters:

  • client_group_id —

    ID of the client group association

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    The value to search for in prompt subject

  • :current_page (String) —

    The current page

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/bombbomb/api/teams_api.rb', line 1039

def get_team_prompt_campaigns_with_http_info(client_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.get_team_prompt_campaigns ..."
  end
  # verify the required parameter 'client_group_id' is set
  if @api_client.config.client_side_validation && client_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_group_id' when calling TeamsApi.get_team_prompt_campaigns"
  end
  # resource path
  local_var_path = "/team/{clientGroupId}/campaign".sub('{' + 'clientGroupId' + '}', client_group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'searchTerm'] = opts[:'search_term'] if !opts[:'search_term'].nil?
  query_params[:'currentPage'] = opts[:'current_page'] if !opts[:'current_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#get_team_prompt_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invite_to_social_prompt_team(team_id, list_id, opts = {}) ⇒ nil

Invite a list to join the admin’s social prompt team Invite to Social Prompt Team

Parameters:

  • team_id —

    The team id

  • list_id —

    List to invite to the social prompt team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1086
1087
1088
1089
 
# File 'lib/bombbomb/api/teams_api.rb', line 1086

def invite_to_social_prompt_team(team_id, list_id, opts = {})
  invite_to_social_prompt_team_with_http_info(team_id, list_id, opts)
  return nil
end

#invite_to_social_prompt_team_with_http_info(team_id, list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Invite a list to join the admin&#39;s social prompt team Invite to Social Prompt Team

Parameters:

  • team_id —

    The team id

  • list_id —

    List to invite to the social prompt team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'lib/bombbomb/api/teams_api.rb', line 1097

def invite_to_social_prompt_team_with_http_info(team_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.invite_to_social_prompt_team ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.invite_to_social_prompt_team"
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling TeamsApi.invite_to_social_prompt_team"
  end
  # resource path
  local_var_path = "/teams/prompt/invite"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["teamId"] = team_id
  form_params["listId"] = list_id

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#invite_to_social_prompt_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#queue_jericho_send(config, team_id, opts = {}) ⇒ JerichoConfiguration

Creates a Jericho send. 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.

Parameters:

  • config —

    JSON representing a Jericho configuration

  • team_id —

    The ID of the team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1148
1149
1150
1151
 
# File 'lib/bombbomb/api/teams_api.rb', line 1148

def queue_jericho_send(config, team_id, opts = {})
  data, _status_code, _headers = queue_jericho_send_with_http_info(config, team_id, opts)
  return data
end

#queue_jericho_send_with_http_info(config, team_id, opts = {}) ⇒ Array<(JerichoConfiguration, Fixnum, Hash)>

Creates a Jericho send. 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.

Parameters:

  • config —

    JSON representing a Jericho configuration

  • team_id —

    The ID of the team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(JerichoConfiguration, Fixnum, Hash)>) —

    JerichoConfiguration data, response status code and response headers



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/bombbomb/api/teams_api.rb', line 1159

def queue_jericho_send_with_http_info(config, team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.queue_jericho_send ..."
  end
  # verify the required parameter 'config' is set
  if @api_client.config.client_side_validation && config.nil?
    fail ArgumentError, "Missing the required parameter 'config' when calling TeamsApi.queue_jericho_send"
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.queue_jericho_send"
  end
  # resource path
  local_var_path = "/team/{teamId}/jericho".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(config)
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'JerichoConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#queue_jericho_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_member_from_team(team_id, user_id, opts = {}) ⇒ String

Remove Member from Team Removes a member from a team.

Parameters:

  • team_id —

    The team id

  • user_id —

    The user id of the member being removed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1209
1210
1211
1212
 
# File 'lib/bombbomb/api/teams_api.rb', line 1209

def remove_member_from_team(team_id, user_id, opts = {})
  data, _status_code, _headers = remove_member_from_team_with_http_info(team_id, user_id, opts)
  return data
end

#remove_member_from_team_with_http_info(team_id, user_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Remove Member from Team Removes a member from a team.

Parameters:

  • team_id —

    The team id

  • user_id —

    The user id of the member being removed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/bombbomb/api/teams_api.rb', line 1220

def remove_member_from_team_with_http_info(team_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.remove_member_from_team ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.remove_member_from_team"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling TeamsApi.remove_member_from_team"
  end
  # resource path
  local_var_path = "/team/{teamId}/member/{userId}".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#remove_member_from_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#resend_team_member_invitation(team_id, member_user_id, opts = {}) ⇒ TeamPublicRepresentation

Resend invite Resend invitation to a member of a team

Parameters:

  • team_id —

    The team id

  • member_user_id —

    The user id of the member being resent an invitation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1270
1271
1272
1273
 
# File 'lib/bombbomb/api/teams_api.rb', line 1270

def resend_team_member_invitation(team_id, member_user_id, opts = {})
  data, _status_code, _headers = resend_team_member_invitation_with_http_info(team_id, member_user_id, opts)
  return data
end

#resend_team_member_invitation_with_http_info(team_id, member_user_id, opts = {}) ⇒ Array<(TeamPublicRepresentation, Fixnum, Hash)>

Resend invite Resend invitation to a member of a team

Parameters:

  • team_id —

    The team id

  • member_user_id —

    The user id of the member being resent an invitation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TeamPublicRepresentation, Fixnum, Hash)>) —

    TeamPublicRepresentation data, response status code and response headers



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/bombbomb/api/teams_api.rb', line 1281

def resend_team_member_invitation_with_http_info(team_id, member_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.resend_team_member_invitation ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.resend_team_member_invitation"
  end
  # verify the required parameter 'member_user_id' is set
  if @api_client.config.client_side_validation && member_user_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_user_id' when calling TeamsApi.resend_team_member_invitation"
  end
  # resource path
  local_var_path = "/team/{teamId}/{memberUserId}/rewelcome".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'memberUserId' + '}', member_user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TeamPublicRepresentation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#resend_team_member_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_jericho_prompt_send(team_id, jericho_id, opts = {}) ⇒ nil

Updates the Jericho Prompt Settings Updates the prompt settings based on the original email id

Parameters:

  • team_id —

    The team id

  • jericho_id —

    ID of the Jericho job

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1331
1332
1333
1334
 
# File 'lib/bombbomb/api/teams_api.rb', line 1331

def update_jericho_prompt_send(team_id, jericho_id, opts = {})
  update_jericho_prompt_send_with_http_info(team_id, jericho_id, opts)
  return nil
end

#update_jericho_prompt_send_with_http_info(team_id, jericho_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Updates the Jericho Prompt Settings Updates the prompt settings based on the original email id

Parameters:

  • team_id —

    The team id

  • jericho_id —

    ID of the Jericho job

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/bombbomb/api/teams_api.rb', line 1342

def update_jericho_prompt_send_with_http_info(team_id, jericho_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.update_jericho_prompt_send ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_jericho_prompt_send"
  end
  # verify the required parameter 'jericho_id' is set
  if @api_client.config.client_side_validation && jericho_id.nil?
    fail ArgumentError, "Missing the required parameter 'jericho_id' when calling TeamsApi.update_jericho_prompt_send"
  end
  # resource path
  local_var_path = "/team/{teamId}/jericho/{jerichoId}".sub('{' + 'teamId' + '}', team_id.to_s).sub('{' + 'jerichoId' + '}', jericho_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#update_jericho_prompt_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_team(team_id, opts = {}) ⇒ TeamPublicRepresentation

Update a team Update fields on a team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The name of the team

  • :state (String) —

    The status of the login permissions

  • :subteams_can_add_members (BOOLEAN) —

    Updates subteam member adding setting on group

Returns:



1393
1394
1395
1396
 
# File 'lib/bombbomb/api/teams_api.rb', line 1393

def update_team(team_id, opts = {})
  data, _status_code, _headers = update_team_with_http_info(team_id, opts)
  return data
end

#update_team_member(team_id, user_id, admin, opts = {}) ⇒ nil

Update Member of Team Updates a member of a team

Parameters:

  • team_id —

    The team id

  • user_id —

    The user id of the member being added to the team.

  • admin —

    Set if the user is an admin of this team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :permission_suite_id (String) —

    Set if the user is an admin of this team.

Returns:

  • (nil) 


1457
1458
1459
1460
 
# File 'lib/bombbomb/api/teams_api.rb', line 1457

def update_team_member(team_id, user_id, admin, opts = {})
  update_team_member_with_http_info(team_id, user_id, admin, opts)
  return nil
end

#update_team_member_with_http_info(team_id, user_id, admin, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Member of Team Updates a member of a team

Parameters:

  • team_id —

    The team id

  • user_id —

    The user id of the member being added to the team.

  • admin —

    Set if the user is an admin of this team.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :permission_suite_id (String) —

    Set if the user is an admin of this team.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
 
# File 'lib/bombbomb/api/teams_api.rb', line 1470

def update_team_member_with_http_info(team_id, user_id, admin, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.update_team_member ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_team_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling TeamsApi.update_team_member"
  end
  # verify the required parameter 'admin' is set
  if @api_client.config.client_side_validation && admin.nil?
    fail ArgumentError, "Missing the required parameter 'admin' when calling TeamsApi.update_team_member"
  end
  # resource path
  local_var_path = "/team/{teamId}/member".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["userId"] = user_id
  form_params["admin"] = admin
  form_params["permissionSuiteId"] = opts[:'permission_suite_id'] if !opts[:'permission_suite_id'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#update_team_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_team_with_http_info(team_id, opts = {}) ⇒ Array<(TeamPublicRepresentation, Fixnum, Hash)>

Update a team Update fields on a team

Parameters:

  • team_id —

    The team id

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The name of the team

  • :state (String) —

    The status of the login permissions

  • :subteams_can_add_members (BOOLEAN) —

    Updates subteam member adding setting on group

Returns:

  • (Array<(TeamPublicRepresentation, Fixnum, Hash)>) —

    TeamPublicRepresentation data, response status code and response headers



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'lib/bombbomb/api/teams_api.rb', line 1406

def update_team_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TeamsApi.update_team ..."
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamsApi.update_team"
  end
  # resource path
  local_var_path = "/team/{teamId}".sub('{' + 'teamId' + '}', team_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params["name"] = opts[:'name'] if !opts[:'name'].nil?
  form_params["state"] = opts[:'state'] if !opts[:'state'].nil?
  form_params["subteamsCanAddMembers"] = opts[:'subteams_can_add_members'] if !opts[:'subteams_can_add_members'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TeamPublicRepresentation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamsApi#update_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end