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_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:



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

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



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

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:



364
365
366
367
 
# File 'lib/brevo/api/master_account_api.rb', line 364

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



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
408
409
410
411
412
 
# File 'lib/brevo/api/master_account_api.rb', line 374

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:



419
420
421
422
 
# File 'lib/brevo/api/master_account_api.rb', line 419

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



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
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/brevo/api/master_account_api.rb', line 430

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) 


481
482
483
484
 
# File 'lib/brevo/api/master_account_api.rb', line 481

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



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

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) 


538
539
540
541
 
# File 'lib/brevo/api/master_account_api.rb', line 538

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



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
581
582
583
584
 
# File 'lib/brevo/api/master_account_api.rb', line 547

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:



590
591
592
593
 
# File 'lib/brevo/api/master_account_api.rb', line 590

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



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
632
633
634
635
636
637
638
 
# File 'lib/brevo/api/master_account_api.rb', line 600

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

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) 


645
646
647
648
 
# File 'lib/brevo/api/master_account_api.rb', line 645

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

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



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
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/brevo/api/master_account_api.rb', line 656

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_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:



703
704
705
706
 
# File 'lib/brevo/api/master_account_api.rb', line 703

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



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
745
746
747
748
749
750
751
 
# File 'lib/brevo/api/master_account_api.rb', line 713

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:



757
758
759
760
 
# File 'lib/brevo/api/master_account_api.rb', line 757

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



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
800
801
802
803
804
805
 
# File 'lib/brevo/api/master_account_api.rb', line 767

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:



811
812
813
814
 
# File 'lib/brevo/api/master_account_api.rb', line 811

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



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

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_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:



866
867
868
869
 
# File 'lib/brevo/api/master_account_api.rb', line 866

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



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
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/brevo/api/master_account_api.rb', line 877

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) 


925
926
927
928
 
# File 'lib/brevo/api/master_account_api.rb', line 925

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



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
965
966
967
968
969
970
971
972
 
# File 'lib/brevo/api/master_account_api.rb', line 935

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.

  • :limit (Integer) —

    Number of documents per page (default to 10)

  • :offset (Integer) —

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

Returns:



980
981
982
983
 
# File 'lib/brevo/api/master_account_api.rb', line 980

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.

  • :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



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
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/brevo/api/master_account_api.rb', line 992

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[:'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:



1043
1044
1045
1046
 
# File 'lib/brevo/api/master_account_api.rb', line 1043

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:



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
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/brevo/api/master_account_api.rb', line 1052

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

Parameters:

  • email —

    Email of the invited user

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

    the optional parameters

Returns:



1091
1092
1093
1094
 
# File 'lib/brevo/api/master_account_api.rb', line 1091

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

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



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

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:



1143
1144
1145
1146
 
# File 'lib/brevo/api/master_account_api.rb', line 1143

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



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

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" 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:



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

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; 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



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

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