Class: Brevo::MasterAccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/api/master_account_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MasterAccountApi

Returns a new instance of MasterAccountApi.



19
20
21
 
# File 'lib/brevo/api/master_account_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/brevo/api/master_account_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#corporate_group_id_delete(id, opts = {}) ⇒ nil

Delete a group This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.

Parameters:

  • id —

    Id of the group

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

    the optional parameters

Returns:

  • (nil) 


37
38
39
40
 
# File 'lib/brevo/api/master_account_api.rb', line 37

def corporate_group_id_delete(id, opts = {})
  corporate_group_id_delete_with_http_info(id, opts)
  nil
end

#corporate_group_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a group This endpoint allows you to delete a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group. The users associated with the group are no longer associated with the group once deleted.

Parameters:

  • id —

    Id of the group

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/brevo/api/master_account_api.rb', line 47

def corporate_group_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_delete"
  end
  # resource path
  local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', 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 = nil
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_group_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_group_id_get(id, opts = {}) ⇒ CorporateGroupDetailsResponse

GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.

Parameters:

  • id —

    Id of the group of sub-organization

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/brevo/api/master_account_api.rb', line 90

def corporate_group_id_get(id, opts = {})
  data, _status_code, _headers = corporate_group_id_get_with_http_info(id, opts)
  data
end

#corporate_group_id_get_with_http_info(id, opts = {}) ⇒ Array<(CorporateGroupDetailsResponse, Fixnum, Hash)>

GET a group details This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.

Parameters:

  • id —

    Id of the group of sub-organization

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

    the optional parameters

Returns:



100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/brevo/api/master_account_api.rb', line 100

def corporate_group_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_get"
  end
  # resource path
  local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', 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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'CorporateGroupDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_group_id_put(id, body, opts = {}) ⇒ nil

Update a group of sub-accounts This endpoint allows you to update a group of sub-accounts

Parameters:

  • id —

    Id of the group

  • body —

    Group details to be updated.

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

    the optional parameters

Returns:

  • (nil) 


145
146
147
148
 
# File 'lib/brevo/api/master_account_api.rb', line 145

def corporate_group_id_put(id, body, opts = {})
  corporate_group_id_put_with_http_info(id, body, opts)
  nil
end

#corporate_group_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a group of sub-accounts This endpoint allows you to update a group of sub-accounts

Parameters:

  • id —

    Id of the group

  • body —

    Group details to be updated.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/brevo/api/master_account_api.rb', line 156

def corporate_group_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_group_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_id_put"
  end
  # resource path
  local_var_path = '/corporate/group/{id}'.sub('{' + 'id' + '}', 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(body)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_group_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_group_post(body, opts = {}) ⇒ InlineResponse201

Create a new group of sub-accounts This endpoint allows to create a group of sub-accounts

Parameters:

  • body —

    Group details to be created.

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

    the optional parameters

Returns:



203
204
205
206
 
# File 'lib/brevo/api/master_account_api.rb', line 203

def corporate_group_post(body, opts = {})
  data, _status_code, _headers = corporate_group_post_with_http_info(body, opts)
  data
end

#corporate_group_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>

Create a new group of sub-accounts This endpoint allows to create a group of sub-accounts

Parameters:

  • body —

    Group details to be created.

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

    the optional parameters

Returns:

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

    InlineResponse201 data, response status code and response headers



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/brevo/api/master_account_api.rb', line 213

def corporate_group_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_post"
  end
  # resource path
  local_var_path = '/corporate/group'

  # 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(body)
  auth_names = ['api-key', 'partner-key']
  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 => 'InlineResponse201')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_group_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_group_unlink_group_id_sub_accounts_put(group_id, body, opts = {}) ⇒ nil

Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.

Parameters:

  • group_id —

    Id of the group

  • body —

    List of sub-account ids

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

    the optional parameters

Returns:

  • (nil) 


258
259
260
261
 
# File 'lib/brevo/api/master_account_api.rb', line 258

def corporate_group_unlink_group_id_sub_accounts_put(group_id, body, opts = {})
  corporate_group_unlink_group_id_sub_accounts_put_with_http_info(group_id, body, opts)
  nil
end

#corporate_group_unlink_group_id_sub_accounts_put_with_http_info(group_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete sub-account from group This endpoint allows you to remove a sub-organization from a group.

Parameters:

  • group_id —

    Id of the group

  • body —

    List of sub-account ids

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/brevo/api/master_account_api.rb', line 269

def corporate_group_unlink_group_id_sub_accounts_put_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_group_unlink_group_id_sub_accounts_put"
  end
  # resource path
  local_var_path = '/corporate/group/unlink/{groupId}/subAccounts'.sub('{' + 'groupId' + '}', 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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_group_unlink_group_id_sub_accounts_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_ip_get(opts = {}) ⇒ nil

List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin account

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


315
316
317
318
 
# File 'lib/brevo/api/master_account_api.rb', line 315

def corporate_ip_get(opts = {})
  corporate_ip_get_with_http_info(opts)
  nil
end

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

List of all IPs This endpoint allows you to retrieve the list of active IPs on your Admin account

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/brevo/api/master_account_api.rb', line 324

def corporate_ip_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_ip_get ...'
  end
  # resource path
  local_var_path = '/corporate/ip'

  # 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 = nil
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_ip_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_master_account_get(opts = {}) ⇒ MasterDetailsResponse

Get the details of requested master account This endpoint will provide the details of the master account.

Parameters:

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

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/brevo/api/master_account_api.rb', line 362

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

#corporate_master_account_get_with_http_info(opts = {}) ⇒ Array<(MasterDetailsResponse, Fixnum, Hash)>

Get the details of requested master account This endpoint will provide the details of the master account.

Parameters:

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

    the optional parameters

Returns:

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

    MasterDetailsResponse data, response status code and response headers



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
 
# File 'lib/brevo/api/master_account_api.rb', line 371

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_master_account_get ...'
  end
  # resource path
  local_var_path = '/corporate/masterAccount'

  # 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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'MasterDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_master_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sso_token_post(sso_token_request_corporate, opts = {}) ⇒ GetSsoToken

Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.

Parameters:

  • sso_token_request_corporate —

    User email of admin account

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

    the optional parameters

Returns:



411
412
413
414
 
# File 'lib/brevo/api/master_account_api.rb', line 411

def corporate_sso_token_post(sso_token_request_corporate, opts = {})
  data, _status_code, _headers = corporate_sso_token_post_with_http_info(sso_token_request_corporate, opts)
  data
end

#corporate_sso_token_post_with_http_info(sso_token_request_corporate, opts = {}) ⇒ Array<(GetSsoToken, Fixnum, Hash)>

Generate SSO token to access admin account This endpoint generates an SSO token to authenticate and access the admin account using the endpoint account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.

Parameters:

  • sso_token_request_corporate —

    User email of admin account

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

    the optional parameters

Returns:

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

    GetSsoToken data, response status code and response headers



421
422
423
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
 
# File 'lib/brevo/api/master_account_api.rb', line 421

def corporate_sso_token_post_with_http_info(sso_token_request_corporate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sso_token_post ...'
  end
  # verify the required parameter 'sso_token_request_corporate' is set
  if @api_client.config.client_side_validation && sso_token_request_corporate.nil?
    fail ArgumentError, "Missing the required parameter 'sso_token_request_corporate' when calling MasterAccountApi.corporate_sso_token_post"
  end
  # resource path
  local_var_path = '/corporate/ssoToken'

  # 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(sso_token_request_corporate)
  auth_names = ['api-key', 'partner-key']
  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 => 'GetSsoToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sso_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_get(offset, limit, opts = {}) ⇒ SubAccountsResponse

Get the list of all the sub-accounts of the master account. This endpoint will provide the list all the sub-accounts of the master account.

Parameters:

  • offset —

    Index of the first sub-account in the page

  • limit —

    Number of sub-accounts to be displayed on each page

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

    the optional parameters

Returns:



466
467
468
469
 
# File 'lib/brevo/api/master_account_api.rb', line 466

def (offset, limit, opts = {})
  data, _status_code, _headers = (offset, limit, opts)
  data
end

#corporate_sub_account_get_with_http_info(offset, limit, opts = {}) ⇒ Array<(SubAccountsResponse, Fixnum, Hash)>

Get the list of all the sub-accounts of the master account. This endpoint will provide the list all the sub-accounts of the master account.

Parameters:

  • offset —

    Index of the first sub-account in the page

  • limit —

    Number of sub-accounts to be displayed on each page

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

    the optional parameters

Returns:

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

    SubAccountsResponse data, response status code and response headers



477
478
479
480
481
482
483
484
485
486
487
488
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
 
# File 'lib/brevo/api/master_account_api.rb', line 477

def (offset, limit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_get ...'
  end
  # verify the required parameter 'offset' is set
  if @api_client.config.client_side_validation && offset.nil?
    fail ArgumentError, "Missing the required parameter 'offset' when calling MasterAccountApi.corporate_sub_account_get"
  end
  # verify the required parameter 'limit' is set
  if @api_client.config.client_side_validation && limit.nil?
    fail ArgumentError, "Missing the required parameter 'limit' when calling MasterAccountApi.corporate_sub_account_get"
  end
  # resource path
  local_var_path = '/corporate/subAccount'

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = limit

  # 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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'SubAccountsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_id_applications_toggle_put(id, toggle_applications, opts = {}) ⇒ nil

Enable/disable sub-account application(s) API endpoint for the Corporate owner to enable/disable applications on the sub-account

Parameters:

  • id —

    Id of the sub-account organization (mandatory)

  • toggle_applications —

    List of applications to activate or deactivate on a sub-account

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

    the optional parameters

Returns:

  • (nil) 


528
529
530
531
 
# File 'lib/brevo/api/master_account_api.rb', line 528

def (id, toggle_applications, opts = {})
  (id, toggle_applications, opts)
  nil
end

#corporate_sub_account_id_applications_toggle_put_with_http_info(id, toggle_applications, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enable/disable sub-account application(s) API endpoint for the Corporate owner to enable/disable applications on the sub-account

Parameters:

  • id —

    Id of the sub-account organization (mandatory)

  • toggle_applications —

    List of applications to activate or deactivate on a sub-account

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
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
 
# File 'lib/brevo/api/master_account_api.rb', line 539

def (id, toggle_applications, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_applications_toggle_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_applications_toggle_put"
  end
  # verify the required parameter 'toggle_applications' is set
  if @api_client.config.client_side_validation && toggle_applications.nil?
    fail ArgumentError, "Missing the required parameter 'toggle_applications' when calling MasterAccountApi.corporate_sub_account_id_applications_toggle_put"
  end
  # resource path
  local_var_path = '/corporate/subAccount/{id}/applications/toggle'.sub('{' + 'id' + '}', 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(toggle_applications)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_sub_account_id_applications_toggle_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_id_delete(id, opts = {}) ⇒ nil

Delete a sub-account

Parameters:

  • id —

    Id of the sub-account organization to be deleted

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

    the optional parameters

Returns:

  • (nil) 


585
586
587
588
 
# File 'lib/brevo/api/master_account_api.rb', line 585

def (id, opts = {})
  (id, opts)
  nil
end

#corporate_sub_account_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a sub-account

Parameters:

  • id —

    Id of the sub-account organization to be deleted

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/brevo/api/master_account_api.rb', line 594

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_delete"
  end
  # resource path
  local_var_path = '/corporate/subAccount/{id}'.sub('{' + 'id' + '}', 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 = nil
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_sub_account_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_id_get(id, opts = {}) ⇒ SubAccountDetailsResponse

Get sub-account details This endpoint will provide the details for the specified sub-account company

Parameters:

  • id —

    Id of the sub-account organization

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

    the optional parameters

Returns:



637
638
639
640
 
# File 'lib/brevo/api/master_account_api.rb', line 637

def (id, opts = {})
  data, _status_code, _headers = (id, opts)
  data
end

#corporate_sub_account_id_get_with_http_info(id, opts = {}) ⇒ Array<(SubAccountDetailsResponse, Fixnum, Hash)>

Get sub-account details This endpoint will provide the details for the specified sub-account company

Parameters:

  • id —

    Id of the sub-account organization

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

    the optional parameters

Returns:

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

    SubAccountDetailsResponse data, response status code and response headers



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/brevo/api/master_account_api.rb', line 647

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_get"
  end
  # resource path
  local_var_path = '/corporate/subAccount/{id}'.sub('{' + 'id' + '}', 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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'SubAccountDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_id_plan_put(id, update_plan_details, opts = {}) ⇒ nil

Update sub-account plan This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1" to set the consumable in unlimited mode.

Parameters:

  • id —

    Id of the sub-account organization

  • update_plan_details —

    Values to update a sub-account plan

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

    the optional parameters

Returns:

  • (nil) 


692
693
694
695
 
# File 'lib/brevo/api/master_account_api.rb', line 692

def (id, update_plan_details, opts = {})
  (id, update_plan_details, opts)
  nil
end

#corporate_sub_account_id_plan_put_with_http_info(id, update_plan_details, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update sub-account plan This endpoint will update the sub-account plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1&quot; to set the consumable in unlimited mode.

Parameters:

  • id —

    Id of the sub-account organization

  • update_plan_details —

    Values to update a sub-account plan

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/brevo/api/master_account_api.rb', line 703

def (id, update_plan_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_plan_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
  end
  # verify the required parameter 'update_plan_details' is set
  if @api_client.config.client_side_validation && update_plan_details.nil?
    fail ArgumentError, "Missing the required parameter 'update_plan_details' when calling MasterAccountApi.corporate_sub_account_id_plan_put"
  end
  # resource path
  local_var_path = '/corporate/subAccount/{id}/plan'.sub('{' + 'id' + '}', 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(update_plan_details)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_sub_account_id_plan_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_ip_associate_post(body, opts = {}) ⇒ Object

Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accounts

Parameters:

  • body —

    Ip address association details

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

    the optional parameters

Returns:

  • (Object) 


750
751
752
753
 
# File 'lib/brevo/api/master_account_api.rb', line 750

def (body, opts = {})
  data, _status_code, _headers = (body, opts)
  data
end

#corporate_sub_account_ip_associate_post_with_http_info(body, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Associate an IP to sub-accounts This endpoint allows to associate an IP to sub-accounts

Parameters:

  • body —

    Ip address association details

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
 
# File 'lib/brevo/api/master_account_api.rb', line 760

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_ip_associate_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_sub_account_ip_associate_post"
  end
  # resource path
  local_var_path = '/corporate/subAccount/ip/associate'

  # 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(body)
  auth_names = ['api-key', 'partner-key']
  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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_ip_associate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_ip_dissociate_put(body, opts = {}) ⇒ nil

Dissociate an IP from sub-accounts This endpoint allows to dissociate an IP from sub-accounts

Parameters:

  • body —

    Ip address dissociation details

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

    the optional parameters

Returns:

  • (nil) 


804
805
806
807
 
# File 'lib/brevo/api/master_account_api.rb', line 804

def (body, opts = {})
  (body, opts)
  nil
end

#corporate_sub_account_ip_dissociate_put_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Dissociate an IP from sub-accounts This endpoint allows to dissociate an IP from sub-accounts

Parameters:

  • body —

    Ip address dissociation details

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



814
815
816
817
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
 
# File 'lib/brevo/api/master_account_api.rb', line 814

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_ip_dissociate_put ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_sub_account_ip_dissociate_put"
  end
  # resource path
  local_var_path = '/corporate/subAccount/ip/dissociate'

  # 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(body)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_sub_account_ip_dissociate_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_key_post(create_api_key_request, opts = {}) ⇒ CreateApiKeyResponse

Create an API key for a sub-account This endpoint will generate an API v3 key for a sub account

Parameters:

  • create_api_key_request —

    Values to generate API key for sub-account

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

    the optional parameters

Returns:



857
858
859
860
 
# File 'lib/brevo/api/master_account_api.rb', line 857

def (create_api_key_request, opts = {})
  data, _status_code, _headers = (create_api_key_request, opts)
  data
end

#corporate_sub_account_key_post_with_http_info(create_api_key_request, opts = {}) ⇒ Array<(CreateApiKeyResponse, Fixnum, Hash)>

Create an API key for a sub-account This endpoint will generate an API v3 key for a sub account

Parameters:

  • create_api_key_request —

    Values to generate API key for sub-account

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

    the optional parameters

Returns:

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

    CreateApiKeyResponse data, response status code and response headers



867
868
869
870
871
872
873
874
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
 
# File 'lib/brevo/api/master_account_api.rb', line 867

def (create_api_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_key_post ...'
  end
  # verify the required parameter 'create_api_key_request' is set
  if @api_client.config.client_side_validation && create_api_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_api_key_request' when calling MasterAccountApi.corporate_sub_account_key_post"
  end
  # resource path
  local_var_path = '/corporate/subAccount/key'

  # 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(create_api_key_request)
  auth_names = ['api-key', 'partner-key']
  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 => 'CreateApiKeyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_key_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_post(sub_account_create, opts = {}) ⇒ CreateSubAccountResponse

Create a new sub-account under a master account. This endpoint will create a new sub-account under a master account

Parameters:

  • sub_account_create —

    values to create new sub-account

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

    the optional parameters

Returns:



911
912
913
914
 
# File 'lib/brevo/api/master_account_api.rb', line 911

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

#corporate_sub_account_post_with_http_info(sub_account_create, opts = {}) ⇒ Array<(CreateSubAccountResponse, Fixnum, Hash)>

Create a new sub-account under a master account. This endpoint will create a new sub-account under a master account

Parameters:

  • sub_account_create —

    values to create new sub-account

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

    the optional parameters

Returns:

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

    CreateSubAccountResponse data, response status code and response headers



921
922
923
924
925
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
 
# File 'lib/brevo/api/master_account_api.rb', line 921

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_post ...'
  end
  # verify the required parameter 'sub_account_create' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'sub_account_create' when calling MasterAccountApi.corporate_sub_account_post"
  end
  # resource path
  local_var_path = '/corporate/subAccount'

  # 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()
  auth_names = ['api-key', 'partner-key']
  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 => 'CreateSubAccountResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_account_sso_token_post(sso_token_request, opts = {}) ⇒ GetSsoToken

Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.

Parameters:

  • sso_token_request —

    Values to generate SSO token for sub-account

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

    the optional parameters

Returns:



965
966
967
968
 
# File 'lib/brevo/api/master_account_api.rb', line 965

def (sso_token_request, opts = {})
  data, _status_code, _headers = (sso_token_request, opts)
  data
end

#corporate_sub_account_sso_token_post_with_http_info(sso_token_request, opts = {}) ⇒ Array<(GetSsoToken, Fixnum, Hash)>

Generate SSO token to access sub-account This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.

Parameters:

  • sso_token_request —

    Values to generate SSO token for sub-account

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

    the optional parameters

Returns:

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

    GetSsoToken data, response status code and response headers



975
976
977
978
979
980
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
 
# File 'lib/brevo/api/master_account_api.rb', line 975

def (sso_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_sso_token_post ...'
  end
  # verify the required parameter 'sso_token_request' is set
  if @api_client.config.client_side_validation && sso_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'sso_token_request' when calling MasterAccountApi.corporate_sub_account_sso_token_post"
  end
  # resource path
  local_var_path = '/corporate/subAccount/ssoToken'

  # 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(sso_token_request)
  auth_names = ['api-key', 'partner-key']
  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 => 'GetSsoToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_sso_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_sub_accounts_plan_put(update_plan_details, opts = {}) ⇒ nil

Update sub-accounts plan This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1" to set the consumable in unlimited mode.

Parameters:

  • update_plan_details —

    Values to update sub-accounts plan

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

    the optional parameters

Returns:

  • (nil) 


1019
1020
1021
1022
 
# File 'lib/brevo/api/master_account_api.rb', line 1019

def corporate_sub_accounts_plan_put(update_plan_details, opts = {})
  corporate_sub_accounts_plan_put_with_http_info(update_plan_details, opts)
  nil
end

#corporate_sub_accounts_plan_put_with_http_info(update_plan_details, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update sub-accounts plan This endpoint will update multiple sub-accounts plan. On the Corporate solution new version v2, you can set an unlimited number of credits in your sub-organization. Please pass the value “-1&quot; to set the consumable in unlimited mode.

Parameters:

  • update_plan_details —

    Values to update sub-accounts plan

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
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
 
# File 'lib/brevo/api/master_account_api.rb', line 1029

def corporate_sub_accounts_plan_put_with_http_info(update_plan_details, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_accounts_plan_put ...'
  end
  # verify the required parameter 'update_plan_details' is set
  if @api_client.config.client_side_validation && update_plan_details.nil?
    fail ArgumentError, "Missing the required parameter 'update_plan_details' when calling MasterAccountApi.corporate_sub_accounts_plan_put"
  end
  # resource path
  local_var_path = '/corporate/subAccounts/plan'

  # 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(update_plan_details)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_sub_accounts_plan_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_user_email_permissions_put(email, body, opts = {}) ⇒ nil

Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin account

Parameters:

  • email —

    Email address of Admin user

  • body —

    Values to update an admin user permissions

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

    the optional parameters

Returns:

  • (nil) 


1073
1074
1075
1076
 
# File 'lib/brevo/api/master_account_api.rb', line 1073

def corporate_user_email_permissions_put(email, body, opts = {})
  corporate_user_email_permissions_put_with_http_info(email, body, opts)
  nil
end

#corporate_user_email_permissions_put_with_http_info(email, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Change admin user permissions This endpoint will allow you to change the permissions of Admin users of your Admin account

Parameters:

  • email —

    Email address of Admin user

  • body —

    Values to update an admin user permissions

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
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
 
# File 'lib/brevo/api/master_account_api.rb', line 1084

def corporate_user_email_permissions_put_with_http_info(email, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_email_permissions_put ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_email_permissions_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MasterAccountApi.corporate_user_email_permissions_put"
  end
  # resource path
  local_var_path = '/corporate/user/{email}/permissions'.sub('{' + 'email' + '}', email.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(body)
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_user_email_permissions_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_user_invitation_action_email_put(action, email, opts = {}) ⇒ InlineResponse200

Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation

Parameters:

  • action —

    Action to be performed (cancel / resend)

  • email —

    Email address of the recipient

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

    the optional parameters

Returns:



1132
1133
1134
1135
 
# File 'lib/brevo/api/master_account_api.rb', line 1132

def corporate_user_invitation_action_email_put(action, email, opts = {})
  data, _status_code, _headers = corporate_user_invitation_action_email_put_with_http_info(action, email, opts)
  data
end

#corporate_user_invitation_action_email_put_with_http_info(action, email, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Resend / cancel admin user invitation This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation

Parameters:

  • action —

    Action to be performed (cancel / resend)

  • email —

    Email address of the recipient

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

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
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
 
# File 'lib/brevo/api/master_account_api.rb', line 1143

def corporate_user_invitation_action_email_put_with_http_info(action, email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_invitation_action_email_put ...'
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling MasterAccountApi.corporate_user_invitation_action_email_put"
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_invitation_action_email_put"
  end
  # resource path
  local_var_path = '/corporate/user/invitation/{action}/{email}'.sub('{' + 'action' + '}', action.to_s).sub('{' + 'email' + '}', email.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 = nil
  auth_names = ['api-key', 'partner-key']
  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,
    :return_type => 'InlineResponse200')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#corporate_user_invitation_action_email_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#corporate_user_revoke_email_delete(email, opts = {}) ⇒ nil

Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin account

Parameters:

  • email —

    Email of the invited user

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

    the optional parameters

Returns:

  • (nil) 


1191
1192
1193
1194
 
# File 'lib/brevo/api/master_account_api.rb', line 1191

def corporate_user_revoke_email_delete(email, opts = {})
  corporate_user_revoke_email_delete_with_http_info(email, opts)
  nil
end

#corporate_user_revoke_email_delete_with_http_info(email, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Revoke an admin user This endpoint allows to revoke/remove an invited member of your Admin account

Parameters:

  • email —

    Email of the invited user

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/brevo/api/master_account_api.rb', line 1201

def corporate_user_revoke_email_delete_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_user_revoke_email_delete ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.corporate_user_revoke_email_delete"
  end
  # resource path
  local_var_path = '/corporate/user/revoke/{email}'.sub('{' + 'email' + '}', email.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 = nil
  auth_names = ['api-key', 'partner-key']
  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: MasterAccountApi#corporate_user_revoke_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_activity(opts = {}) ⇒ GetAccountActivity

Get user activity logs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.

  • :end_date (String) —

    Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.

  • :email (String) —

    Enter the user&#39;s email address to filter their activity in the account.

  • :limit (Integer) —

    Number of documents per page (default to 10)

  • :offset (Integer) —

    Index of the first document in the page. (default to 0)

Returns:



1247
1248
1249
1250
 
# File 'lib/brevo/api/master_account_api.rb', line 1247

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

#get_account_activity_with_http_info(opts = {}) ⇒ Array<(GetAccountActivity, Fixnum, Hash)>

Get user activity logs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.

  • :end_date (String) —

    Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.

  • :email (String) —

    Enter the user&#39;s email address to filter their activity in the account.

  • :limit (Integer) —

    Number of documents per page

  • :offset (Integer) —

    Index of the first document in the page.

Returns:

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

    GetAccountActivity data, response status code and response headers



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
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
 
# File 'lib/brevo/api/master_account_api.rb', line 1260

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.get_account_activity ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterAccountApi.get_account_activity, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MasterAccountApi.get_account_activity, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/organization/activities'

  # query parameters
  query_params = {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'GetAccountActivity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#get_account_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporate_invited_users_list(opts = {}) ⇒ GetCorporateInvitedUsersList

Get the list of all admin users This endpoint allows you to list all Admin users of your Admin account

Parameters:

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

    the optional parameters

Returns:



1312
1313
1314
1315
 
# File 'lib/brevo/api/master_account_api.rb', line 1312

def get_corporate_invited_users_list(opts = {})
  data, _status_code, _headers = get_corporate_invited_users_list_with_http_info(opts)
  data
end

#get_corporate_invited_users_list_with_http_info(opts = {}) ⇒ Array<(GetCorporateInvitedUsersList, Fixnum, Hash)>

Get the list of all admin users This endpoint allows you to list all Admin users of your Admin account

Parameters:

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

    the optional parameters

Returns:



1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/brevo/api/master_account_api.rb', line 1321

def get_corporate_invited_users_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.get_corporate_invited_users_list ...'
  end
  # resource path
  local_var_path = '/corporate/invited/users'

  # 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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'GetCorporateInvitedUsersList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#get_corporate_invited_users_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporate_user_permission(email, opts = {}) ⇒ GetCorporateUserPermission

Check admin user permissions This endpoint will provide the list of admin user permissions

Parameters:

  • email —

    Email of the invited user

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

    the optional parameters

Returns:



1361
1362
1363
1364
 
# File 'lib/brevo/api/master_account_api.rb', line 1361

def get_corporate_user_permission(email, opts = {})
  data, _status_code, _headers = get_corporate_user_permission_with_http_info(email, opts)
  data
end

#get_corporate_user_permission_with_http_info(email, opts = {}) ⇒ Array<(GetCorporateUserPermission, Fixnum, Hash)>

Check admin user permissions This endpoint will provide the list of admin user permissions

Parameters:

  • email —

    Email of the invited user

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

    the optional parameters

Returns:

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

    GetCorporateUserPermission data, response status code and response headers



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/brevo/api/master_account_api.rb', line 1371

def get_corporate_user_permission_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.get_corporate_user_permission ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling MasterAccountApi.get_corporate_user_permission"
  end
  # resource path
  local_var_path = '/corporate/user/{email}/permissions'.sub('{' + 'email' + '}', email.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 = nil
  auth_names = ['api-key', 'partner-key']
  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 => 'GetCorporateUserPermission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#get_corporate_user_permission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sub_account_groups(opts = {}) ⇒ Array<InlineResponse2001>

Get the list of groups This endpoint allows you to list all groups created on your Admin account.

Parameters:

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

    the optional parameters

Returns:



1414
1415
1416
1417
 
# File 'lib/brevo/api/master_account_api.rb', line 1414

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

#get_sub_account_groups_with_http_info(opts = {}) ⇒ Array<(Array<InlineResponse2001>, Fixnum, Hash)>

Get the list of groups This endpoint allows you to list all groups created on your Admin account.

Parameters:

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

    the optional parameters

Returns:

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

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



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
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/brevo/api/master_account_api.rb', line 1423

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.get_sub_account_groups ...'
  end
  # resource path
  local_var_path = '/corporate/groups'

  # 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 = nil
  auth_names = ['api-key', 'partner-key']
  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<InlineResponse2001>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#get_sub_account_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invite_admin_user(send_invitation, opts = {}) ⇒ InviteAdminUser

Send invitation to an admin user ‘This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - "all" - `api`: - "none" - `user_management`: - "all" - `app_management` | Not available in ENTv2: - "all" - `sub_organization_groups` - "create" - "edit_delete" - `create_sub_organizations` - "all" - `manage_sub_organizations` - "all" - `analytics` - "download_data" - "create_alerts" - "my_looks" - "explore_create" - `security` - "all" Note: - If `all_features_access: false` then only privileges are required otherwise if `true` then it’s assumed that all permissions will be there for the invited admin user.

Parameters:

  • send_invitation —

    Payload to send an invitation

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

    the optional parameters

Returns:



1463
1464
1465
1466
 
# File 'lib/brevo/api/master_account_api.rb', line 1463

def invite_admin_user(send_invitation, opts = {})
  data, _status_code, _headers = invite_admin_user_with_http_info(send_invitation, opts)
  data
end

#invite_admin_user_with_http_info(send_invitation, opts = {}) ⇒ Array<(InviteAdminUser, Fixnum, Hash)>

Send invitation to an admin user &#x60;This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - &#x60;my_plan&#x60;: - &quot;all&quot; - &#x60;api&#x60;: - &quot;none&quot; - &#x60;user_management&#x60;: - &quot;all&quot; - &#x60;app_management&#x60; | Not available in ENTv2: - &quot;all&quot; - &#x60;sub_organization_groups&#x60; - &quot;create&quot; - &quot;edit_delete&quot; - &#x60;create_sub_organizations&#x60; - &quot;all&quot; - &#x60;manage_sub_organizations&#x60; - &quot;all&quot; - &#x60;analytics&#x60; - &quot;download_data&quot; - &quot;create_alerts&quot; - &quot;my_looks&quot; - &quot;explore_create&quot; - &#x60;security&#x60; - &quot;all&quot; Note: - If &#x60;all_features_access: false&#x60; then only privileges are required otherwise if &#x60;true&#x60; then it&#39;s assumed that all permissions will be there for the invited admin user.

Parameters:

  • send_invitation —

    Payload to send an invitation

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

    the optional parameters

Returns:

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

    InviteAdminUser data, response status code and response headers



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
 
# File 'lib/brevo/api/master_account_api.rb', line 1473

def invite_admin_user_with_http_info(send_invitation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MasterAccountApi.invite_admin_user ...'
  end
  # verify the required parameter 'send_invitation' is set
  if @api_client.config.client_side_validation && send_invitation.nil?
    fail ArgumentError, "Missing the required parameter 'send_invitation' when calling MasterAccountApi.invite_admin_user"
  end
  # resource path
  local_var_path = '/corporate/user/invitation/send'

  # 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(send_invitation)
  auth_names = ['api-key', 'partner-key']
  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 => 'InviteAdminUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MasterAccountApi#invite_admin_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo/api/master_account_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end