brevo 2.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (263) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +56 -4
  3. data/docs/Body.md +2 -3
  4. data/docs/Body1.md +2 -3
  5. data/docs/Body10.md +10 -4
  6. data/docs/Body11.md +6 -1
  7. data/docs/Body12.md +1 -4
  8. data/docs/Body13.md +11 -0
  9. data/docs/Body14.md +8 -0
  10. data/docs/Body15.md +11 -0
  11. data/docs/Body2.md +1 -4
  12. data/docs/Body3.md +3 -2
  13. data/docs/Body4.md +3 -2
  14. data/docs/Body5.md +4 -4
  15. data/docs/Body6.md +2 -11
  16. data/docs/Body7.md +2 -10
  17. data/docs/Body8.md +4 -6
  18. data/docs/Body9.md +11 -1
  19. data/docs/CompaniesApi.md +8 -8
  20. data/docs/ContactsApi.md +14 -4
  21. data/docs/ConversationsApi.md +10 -10
  22. data/docs/ConversionSourceMetrics.md +12 -0
  23. data/docs/ConversionSourceProduct.md +15 -0
  24. data/docs/CorporateGroupDetailsResponse.md +10 -0
  25. data/docs/CorporateGroupDetailsResponseGroup.md +10 -0
  26. data/docs/CorporateGroupDetailsResponseSubaccounts.md +10 -0
  27. data/docs/CorporateGroupDetailsResponseUsers.md +10 -0
  28. data/docs/CouponsApi.md +12 -9
  29. data/docs/CreateContact.md +1 -1
  30. data/docs/CreateCouponCollection.md +5 -2
  31. data/docs/CreateDomainModel.md +1 -0
  32. data/docs/CreateDomainModelDnsRecords.md +1 -0
  33. data/docs/CreateWebhook.md +3 -0
  34. data/docs/CreateWhatsAppTemplate.md +1 -0
  35. data/docs/DealsApi.md +10 -10
  36. data/docs/EcommerceApi.md +261 -2
  37. data/docs/EmailCampaignsApi.md +1 -3
  38. data/docs/Event.md +12 -0
  39. data/docs/EventIdentifiers.md +12 -0
  40. data/docs/EventsApi.md +67 -0
  41. data/docs/ExportWebhooksHistory.md +2 -1
  42. data/docs/ExternalFeedsApi.md +2 -2
  43. data/docs/GetContactDetails.md +1 -1
  44. data/docs/GetCorporateInvitedUsersList.md +8 -0
  45. data/docs/GetCorporateInvitedUsersListFeatureAccess.md +11 -0
  46. data/docs/GetCorporateInvitedUsersListGroups.md +9 -0
  47. data/docs/GetCorporateInvitedUsersListUsers.md +12 -0
  48. data/docs/GetCorporateUserPermission.md +11 -0
  49. data/docs/GetCorporateUserPermissionFeatureAccess.md +11 -0
  50. data/docs/GetCorporateUserPermissionGroups.md +9 -0
  51. data/docs/GetCouponCollection.md +9 -6
  52. data/docs/GetExtendedContactDetails.md +1 -1
  53. data/docs/GetOrders.md +9 -0
  54. data/docs/GetWebhook.md +3 -0
  55. data/docs/GetWebhookAuth.md +9 -0
  56. data/docs/GetWebhookHeaders.md +9 -0
  57. data/docs/InlineResponse200.md +1 -1
  58. data/docs/InlineResponse2001.md +2 -3
  59. data/docs/InlineResponse2002.md +8 -0
  60. data/docs/InlineResponse2003.md +10 -0
  61. data/docs/InlineResponse201.md +1 -1
  62. data/docs/InlineResponse2011.md +1 -1
  63. data/docs/InlineResponse2012.md +1 -1
  64. data/docs/InlineResponse2013.md +1 -1
  65. data/docs/InlineResponse2014.md +1 -1
  66. data/docs/InlineResponse2015.md +8 -0
  67. data/docs/InviteAdminUser.md +11 -0
  68. data/docs/InviteAdminUserPrivileges.md +9 -0
  69. data/docs/Inviteuser.md +10 -0
  70. data/docs/InviteuserPrivileges.md +9 -0
  71. data/docs/MasterAccountApi.md +828 -117
  72. data/docs/MasterDetailsResponsePlanInfoFeatures.md +2 -0
  73. data/docs/OrderBatch.md +1 -0
  74. data/docs/PutRevokeUserPermission.md +8 -0
  75. data/docs/Putresendcancelinvitation.md +8 -0
  76. data/docs/RequestContactImport.md +1 -0
  77. data/docs/SendSmtpEmail.md +18 -19
  78. data/docs/SendSmtpEmailMessageVersions.md +2 -0
  79. data/docs/SendWhatsappMessage.md +1 -0
  80. data/docs/SsoTokenRequestCorporate.md +8 -0
  81. data/docs/SubAccountAppsToggleRequest.md +1 -1
  82. data/docs/SubAccountUpdatePlanRequestFeatures.md +2 -2
  83. data/docs/TasksApi.md +8 -8
  84. data/docs/TransactionalEmailsApi.md +7 -7
  85. data/docs/TransactionalWhatsAppApi.md +2 -2
  86. data/docs/UpdateContact.md +1 -1
  87. data/docs/UpdateCouponCollection.md +4 -1
  88. data/docs/UpdateWebhook.md +3 -0
  89. data/docs/UserApi.md +239 -0
  90. data/docs/WebhooksApi.md +4 -4
  91. data/docs/WhatsAppCampaignsApi.md +3 -1
  92. data/lib/brevo/api/companies_api.rb +3 -3
  93. data/lib/brevo/api/contacts_api.rb +14 -2
  94. data/lib/brevo/api/conversations_api.rb +2 -2
  95. data/lib/brevo/api/coupons_api.rb +15 -16
  96. data/lib/brevo/api/deals_api.rb +5 -5
  97. data/lib/brevo/api/ecommerce_api.rb +250 -0
  98. data/lib/brevo/api/email_campaigns_api.rb +0 -3
  99. data/lib/brevo/api/events_api.rb +86 -0
  100. data/lib/brevo/api/external_feeds_api.rb +3 -3
  101. data/lib/brevo/api/master_account_api.rb +652 -4
  102. data/lib/brevo/api/tasks_api.rb +5 -5
  103. data/lib/brevo/api/transactional_emails_api.rb +11 -11
  104. data/lib/brevo/api/transactional_whats_app_api.rb +3 -3
  105. data/lib/brevo/api/user_api.rb +222 -0
  106. data/lib/brevo/api/webhooks_api.rb +4 -4
  107. data/lib/brevo/api/whats_app_campaigns_api.rb +6 -0
  108. data/lib/brevo/models/body.rb +20 -28
  109. data/lib/brevo/models/body_1.rb +22 -25
  110. data/lib/brevo/models/body_10.rb +95 -39
  111. data/lib/brevo/models/body_11.rb +60 -5
  112. data/lib/brevo/models/body_12.rb +13 -38
  113. data/lib/brevo/models/body_13.rb +225 -0
  114. data/lib/brevo/models/body_14.rb +190 -0
  115. data/lib/brevo/models/body_15.rb +215 -0
  116. data/lib/brevo/models/body_2.rb +14 -45
  117. data/lib/brevo/models/body_3.rb +16 -6
  118. data/lib/brevo/models/body_4.rb +16 -6
  119. data/lib/brevo/models/body_5.rb +19 -19
  120. data/lib/brevo/models/body_6.rb +9 -129
  121. data/lib/brevo/models/body_7.rb +9 -95
  122. data/lib/brevo/models/body_8.rb +37 -59
  123. data/lib/brevo/models/body_9.rb +141 -11
  124. data/lib/brevo/models/conversion_source_metrics.rb +279 -0
  125. data/lib/brevo/models/conversion_source_product.rb +252 -0
  126. data/lib/brevo/models/corporate_group_details_response.rb +206 -0
  127. data/lib/brevo/models/corporate_group_details_response_group.rb +205 -0
  128. data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +205 -0
  129. data/lib/brevo/models/corporate_group_details_response_users.rb +205 -0
  130. data/lib/brevo/models/create_contact.rb +1 -1
  131. data/lib/brevo/models/create_coupon_collection.rb +37 -7
  132. data/lib/brevo/models/create_domain_model.rb +11 -1
  133. data/lib/brevo/models/create_domain_model_dns_records.rb +13 -4
  134. data/lib/brevo/models/create_webhook.rb +35 -4
  135. data/lib/brevo/models/create_whats_app_template.rb +28 -6
  136. data/lib/brevo/models/event.rb +234 -0
  137. data/lib/brevo/models/event_identifiers.rb +236 -0
  138. data/lib/brevo/models/export_webhooks_history.rb +31 -4
  139. data/lib/brevo/models/get_contact_details.rb +0 -5
  140. data/lib/brevo/models/get_corporate_invited_users_list.rb +187 -0
  141. data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +224 -0
  142. data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +196 -0
  143. data/lib/brevo/models/get_corporate_invited_users_list_users.rb +248 -0
  144. data/lib/brevo/models/get_corporate_user_permission.rb +236 -0
  145. data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +224 -0
  146. data/lib/brevo/models/get_corporate_user_permission_groups.rb +196 -0
  147. data/lib/brevo/models/get_coupon_collection.rb +40 -10
  148. data/lib/brevo/models/get_extended_contact_details.rb +0 -5
  149. data/lib/brevo/models/get_orders.rb +196 -0
  150. data/lib/brevo/models/get_webhook.rb +35 -4
  151. data/lib/brevo/models/get_webhook_auth.rb +196 -0
  152. data/lib/brevo/models/get_webhook_headers.rb +195 -0
  153. data/lib/brevo/models/inline_response_200.rb +7 -14
  154. data/lib/brevo/models/inline_response_200_1.rb +9 -34
  155. data/lib/brevo/models/inline_response_200_2.rb +191 -0
  156. data/lib/brevo/models/inline_response_200_3.rb +215 -0
  157. data/lib/brevo/models/inline_response_201.rb +0 -7
  158. data/lib/brevo/models/inline_response_201_1.rb +2 -2
  159. data/lib/brevo/models/inline_response_201_2.rb +2 -1
  160. data/lib/brevo/models/inline_response_201_3.rb +11 -11
  161. data/lib/brevo/models/inline_response_201_4.rb +11 -11
  162. data/lib/brevo/models/inline_response_201_5.rb +190 -0
  163. data/lib/brevo/models/invite_admin_user.rb +233 -0
  164. data/lib/brevo/models/invite_admin_user_privileges.rb +232 -0
  165. data/lib/brevo/models/inviteuser.rb +221 -0
  166. data/lib/brevo/models/inviteuser_privileges.rb +232 -0
  167. data/lib/brevo/models/master_details_response_plan_info_features.rb +21 -1
  168. data/lib/brevo/models/order_batch.rb +16 -4
  169. data/lib/brevo/models/put_revoke_user_permission.rb +191 -0
  170. data/lib/brevo/models/putresendcancelinvitation.rb +191 -0
  171. data/lib/brevo/models/request_contact_import.rb +13 -1
  172. data/lib/brevo/models/send_smtp_email_message_versions.rb +24 -4
  173. data/lib/brevo/models/send_whatsapp_message.rb +11 -1
  174. data/lib/brevo/models/sso_token_request_corporate.rb +190 -0
  175. data/lib/brevo/models/sub_account_apps_toggle_request.rb +1 -1
  176. data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +1 -1
  177. data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +1 -1
  178. data/lib/brevo/models/sub_account_update_plan_request_features.rb +2 -2
  179. data/lib/brevo/models/update_contact.rb +1 -1
  180. data/lib/brevo/models/update_coupon_collection.rb +34 -9
  181. data/lib/brevo/models/update_webhook.rb +35 -4
  182. data/lib/brevo/version.rb +1 -1
  183. data/lib/brevo.rb +32 -0
  184. data/spec/api/companies_api_spec.rb +1 -1
  185. data/spec/api/contacts_api_spec.rb +5 -1
  186. data/spec/api/conversations_api_spec.rb +1 -1
  187. data/spec/api/coupons_api_spec.rb +4 -3
  188. data/spec/api/deals_api_spec.rb +2 -2
  189. data/spec/api/ecommerce_api_spec.rb +57 -0
  190. data/spec/api/email_campaigns_api_spec.rb +0 -1
  191. data/spec/api/events_api_spec.rb +47 -0
  192. data/spec/api/external_feeds_api_spec.rb +1 -1
  193. data/spec/api/master_account_api_spec.rb +145 -1
  194. data/spec/api/tasks_api_spec.rb +2 -2
  195. data/spec/api/transactional_emails_api_spec.rb +3 -3
  196. data/spec/api/transactional_whats_app_api_spec.rb +1 -1
  197. data/spec/api/user_api_spec.rb +47 -0
  198. data/spec/api/webhooks_api_spec.rb +2 -2
  199. data/spec/api/whats_app_campaigns_api_spec.rb +1 -0
  200. data/spec/models/body_10_spec.rb +40 -4
  201. data/spec/models/body_11_spec.rb +30 -0
  202. data/spec/models/body_12_spec.rb +1 -19
  203. data/spec/models/body_13_spec.rb +59 -0
  204. data/spec/models/body_14_spec.rb +41 -0
  205. data/spec/models/body_15_spec.rb +59 -0
  206. data/spec/models/body_1_spec.rb +2 -8
  207. data/spec/models/body_2_spec.rb +1 -19
  208. data/spec/models/body_3_spec.rb +6 -0
  209. data/spec/models/body_4_spec.rb +6 -0
  210. data/spec/models/body_5_spec.rb +2 -2
  211. data/spec/models/body_6_spec.rb +1 -55
  212. data/spec/models/body_7_spec.rb +1 -49
  213. data/spec/models/body_8_spec.rb +4 -16
  214. data/spec/models/body_9_spec.rb +61 -1
  215. data/spec/models/body_spec.rb +2 -8
  216. data/spec/models/conversion_source_metrics_spec.rb +69 -0
  217. data/spec/models/conversion_source_product_spec.rb +83 -0
  218. data/spec/models/corporate_group_details_response_group_spec.rb +53 -0
  219. data/spec/models/corporate_group_details_response_spec.rb +53 -0
  220. data/spec/models/corporate_group_details_response_subaccounts_spec.rb +53 -0
  221. data/spec/models/corporate_group_details_response_users_spec.rb +53 -0
  222. data/spec/models/create_coupon_collection_spec.rb +18 -0
  223. data/spec/models/create_domain_model_dns_records_spec.rb +6 -0
  224. data/spec/models/create_domain_model_spec.rb +6 -0
  225. data/spec/models/create_webhook_spec.rb +18 -0
  226. data/spec/models/create_whats_app_template_spec.rb +11 -1
  227. data/spec/models/event_identifiers_spec.rb +65 -0
  228. data/spec/models/event_spec.rb +65 -0
  229. data/spec/models/export_webhooks_history_spec.rb +11 -1
  230. data/spec/models/get_corporate_invited_users_list_feature_access_spec.rb +59 -0
  231. data/spec/models/get_corporate_invited_users_list_groups_spec.rb +47 -0
  232. data/spec/models/get_corporate_invited_users_list_spec.rb +41 -0
  233. data/spec/models/get_corporate_invited_users_list_users_spec.rb +65 -0
  234. data/spec/models/get_corporate_user_permission_feature_access_spec.rb +59 -0
  235. data/spec/models/get_corporate_user_permission_groups_spec.rb +47 -0
  236. data/spec/models/get_corporate_user_permission_spec.rb +59 -0
  237. data/spec/models/get_coupon_collection_spec.rb +18 -0
  238. data/spec/models/get_orders_spec.rb +47 -0
  239. data/spec/models/get_webhook_auth_spec.rb +47 -0
  240. data/spec/models/get_webhook_headers_spec.rb +47 -0
  241. data/spec/models/get_webhook_spec.rb +18 -0
  242. data/spec/models/inline_response_200_1_spec.rb +1 -7
  243. data/spec/models/inline_response_200_2_spec.rb +41 -0
  244. data/spec/models/inline_response_200_3_spec.rb +53 -0
  245. data/spec/models/inline_response_200_spec.rb +1 -1
  246. data/spec/models/inline_response_201_3_spec.rb +1 -1
  247. data/spec/models/inline_response_201_4_spec.rb +1 -1
  248. data/spec/models/inline_response_201_5_spec.rb +41 -0
  249. data/spec/models/invite_admin_user_privileges_spec.rb +55 -0
  250. data/spec/models/invite_admin_user_spec.rb +59 -0
  251. data/spec/models/inviteuser_privileges_spec.rb +55 -0
  252. data/spec/models/inviteuser_spec.rb +53 -0
  253. data/spec/models/master_details_response_plan_info_features_spec.rb +12 -0
  254. data/spec/models/order_batch_spec.rb +6 -0
  255. data/spec/models/put_revoke_user_permission_spec.rb +41 -0
  256. data/spec/models/putresendcancelinvitation_spec.rb +41 -0
  257. data/spec/models/request_contact_import_spec.rb +6 -0
  258. data/spec/models/send_smtp_email_message_versions_spec.rb +12 -0
  259. data/spec/models/send_whatsapp_message_spec.rb +6 -0
  260. data/spec/models/sso_token_request_corporate_spec.rb +41 -0
  261. data/spec/models/update_coupon_collection_spec.rb +18 -0
  262. data/spec/models/update_webhook_spec.rb +18 -0
  263. metadata +152 -24
@@ -4,7 +4,13 @@ All URIs are relative to *https://api.brevo.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**corporate_group_id_delete**](MasterAccountApi.md#corporate_group_id_delete) | **DELETE** /corporate/group/{id} | Delete a group
8
+ [**corporate_group_id_get**](MasterAccountApi.md#corporate_group_id_get) | **GET** /corporate/group/{id} | GET a group details
9
+ [**corporate_group_id_put**](MasterAccountApi.md#corporate_group_id_put) | **PUT** /corporate/group/{id} | Update a group of sub-accounts
10
+ [**corporate_group_post**](MasterAccountApi.md#corporate_group_post) | **POST** /corporate/group | Create a new group of sub-accounts
11
+ [**corporate_group_unlink_group_id_sub_accounts_put**](MasterAccountApi.md#corporate_group_unlink_group_id_sub_accounts_put) | **PUT** /corporate/group/unlink/{groupId}/subAccounts | Delete sub-account from group
7
12
  [**corporate_master_account_get**](MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
13
+ [**corporate_sso_token_post**](MasterAccountApi.md#corporate_sso_token_post) | **POST** /corporate/ssoToken | Generate SSO token to access admin account
8
14
  [**corporate_sub_account_get**](MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
9
15
  [**corporate_sub_account_id_applications_toggle_put**](MasterAccountApi.md#corporate_sub_account_id_applications_toggle_put) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s)
10
16
  [**corporate_sub_account_id_delete**](MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
@@ -12,16 +18,22 @@ Method | HTTP request | Description
12
18
  [**corporate_sub_account_id_plan_put**](MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
13
19
  [**corporate_sub_account_key_post**](MasterAccountApi.md#corporate_sub_account_key_post) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
14
20
  [**corporate_sub_account_post**](MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
15
- [**corporate_sub_account_sso_token_post**](MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Brevo
21
+ [**corporate_sub_account_sso_token_post**](MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access sub-account
22
+ [**corporate_user_invitation_action_email_put**](MasterAccountApi.md#corporate_user_invitation_action_email_put) | **PUT** /corporate/user/invitation/{action}/{email} | Resend / cancel admin user invitation
23
+ [**corporate_user_revoke_email_delete**](MasterAccountApi.md#corporate_user_revoke_email_delete) | **DELETE** /corporate/user/revoke/{email} | Revoke an admin user
16
24
  [**get_account_activity**](MasterAccountApi.md#get_account_activity) | **GET** /organization/activities | Get user activity logs
25
+ [**get_corporate_invited_users_list**](MasterAccountApi.md#get_corporate_invited_users_list) | **GET** /corporate/invited/users | Get the list of all admin users
26
+ [**get_corporate_user_permission**](MasterAccountApi.md#get_corporate_user_permission) | **GET** /corporate/user/{email}/permissions | Check admin user permissions
27
+ [**get_sub_account_groups**](MasterAccountApi.md#get_sub_account_groups) | **GET** /corporate/groups | Get the list of groups
28
+ [**invite_admin_user**](MasterAccountApi.md#invite_admin_user) | **POST** /corporate/user/invitation/send | Send invitation to an admin user
17
29
 
18
30
 
19
- # **corporate_master_account_get**
20
- > MasterDetailsResponse corporate_master_account_get
31
+ # **corporate_group_id_delete**
32
+ > corporate_group_id_delete(id)
21
33
 
22
- Get the details of requested master account
34
+ Delete a group
23
35
 
24
- This endpoint will provide the details of the master account.
36
+ 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.
25
37
 
26
38
  ### Example
27
39
  ```ruby
@@ -42,21 +54,26 @@ end
42
54
 
43
55
  api_instance = Brevo::MasterAccountApi.new
44
56
 
57
+ id = 'id_example' # String | Id of the group
58
+
59
+
45
60
  begin
46
- #Get the details of requested master account
47
- result = api_instance.corporate_master_account_get
48
- p result
61
+ #Delete a group
62
+ api_instance.corporate_group_id_delete(id)
49
63
  rescue Brevo::ApiError => e
50
- puts "Exception when calling MasterAccountApi->corporate_master_account_get: #{e}"
64
+ puts "Exception when calling MasterAccountApi->corporate_group_id_delete: #{e}"
51
65
  end
52
66
  ```
53
67
 
54
68
  ### Parameters
55
- This endpoint does not need any parameter.
69
+
70
+ Name | Type | Description | Notes
71
+ ------------- | ------------- | ------------- | -------------
72
+ **id** | **String**| Id of the group |
56
73
 
57
74
  ### Return type
58
75
 
59
- [**MasterDetailsResponse**](MasterDetailsResponse.md)
76
+ nil (empty response body)
60
77
 
61
78
  ### Authorization
62
79
 
@@ -69,12 +86,12 @@ This endpoint does not need any parameter.
69
86
 
70
87
 
71
88
 
72
- # **corporate_sub_account_get**
73
- > SubAccountsResponse corporate_sub_account_get(offset, limit)
89
+ # **corporate_group_id_get**
90
+ > CorporateGroupDetailsResponse corporate_group_id_get(id)
74
91
 
75
- Get the list of all the sub-accounts of the master account.
92
+ GET a group details
76
93
 
77
- This endpoint will provide the list all the sub-accounts of the master account.
94
+ 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.
78
95
 
79
96
  ### Example
80
97
  ```ruby
@@ -95,17 +112,15 @@ end
95
112
 
96
113
  api_instance = Brevo::MasterAccountApi.new
97
114
 
98
- offset = 56 # Integer | Index of the first sub-account in the page
99
-
100
- limit = 56 # Integer | Number of sub-accounts to be displayed on each page
115
+ id = 'id_example' # String | Id of the group of sub-organization
101
116
 
102
117
 
103
118
  begin
104
- #Get the list of all the sub-accounts of the master account.
105
- result = api_instance.corporate_sub_account_get(offset, limit)
119
+ #GET a group details
120
+ result = api_instance.corporate_group_id_get(id)
106
121
  p result
107
122
  rescue Brevo::ApiError => e
108
- puts "Exception when calling MasterAccountApi->corporate_sub_account_get: #{e}"
123
+ puts "Exception when calling MasterAccountApi->corporate_group_id_get: #{e}"
109
124
  end
110
125
  ```
111
126
 
@@ -113,12 +128,11 @@ end
113
128
 
114
129
  Name | Type | Description | Notes
115
130
  ------------- | ------------- | ------------- | -------------
116
- **offset** | **Integer**| Index of the first sub-account in the page |
117
- **limit** | **Integer**| Number of sub-accounts to be displayed on each page |
131
+ **id** | **String**| Id of the group of sub-organization |
118
132
 
119
133
  ### Return type
120
134
 
121
- [**SubAccountsResponse**](SubAccountsResponse.md)
135
+ [**CorporateGroupDetailsResponse**](CorporateGroupDetailsResponse.md)
122
136
 
123
137
  ### Authorization
124
138
 
@@ -131,12 +145,12 @@ Name | Type | Description | Notes
131
145
 
132
146
 
133
147
 
134
- # **corporate_sub_account_id_applications_toggle_put**
135
- > corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
148
+ # **corporate_group_id_put**
149
+ > corporate_group_id_put(id, body)
136
150
 
137
- Enable/disable sub-account application(s)
151
+ Update a group of sub-accounts
138
152
 
139
- API endpoint for the Corporate owner to enable/disable applications on the sub-account
153
+ This endpoint allows you to update a group of sub-accounts
140
154
 
141
155
  ### Example
142
156
  ```ruby
@@ -157,16 +171,16 @@ end
157
171
 
158
172
  api_instance = Brevo::MasterAccountApi.new
159
173
 
160
- id = 789 # Integer | Id of the sub-account organization (mandatory)
174
+ id = 'id_example' # String | Id of the group
161
175
 
162
- toggle_applications = Brevo::SubAccountAppsToggleRequest.new # SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account
176
+ body = Brevo::Body1.new # Body1 | Group details to be updated.
163
177
 
164
178
 
165
179
  begin
166
- #Enable/disable sub-account application(s)
167
- api_instance.corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
180
+ #Update a group of sub-accounts
181
+ api_instance.corporate_group_id_put(id, body)
168
182
  rescue Brevo::ApiError => e
169
- puts "Exception when calling MasterAccountApi->corporate_sub_account_id_applications_toggle_put: #{e}"
183
+ puts "Exception when calling MasterAccountApi->corporate_group_id_put: #{e}"
170
184
  end
171
185
  ```
172
186
 
@@ -174,8 +188,8 @@ end
174
188
 
175
189
  Name | Type | Description | Notes
176
190
  ------------- | ------------- | ------------- | -------------
177
- **id** | **Integer**| Id of the sub-account organization (mandatory) |
178
- **toggle_applications** | [**SubAccountAppsToggleRequest**](SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account |
191
+ **id** | **String**| Id of the group |
192
+ **body** | [**Body1**](Body1.md)| Group details to be updated. |
179
193
 
180
194
  ### Return type
181
195
 
@@ -192,10 +206,12 @@ nil (empty response body)
192
206
 
193
207
 
194
208
 
195
- # **corporate_sub_account_id_delete**
196
- > corporate_sub_account_id_delete(id)
209
+ # **corporate_group_post**
210
+ > InlineResponse201 corporate_group_post(body)
197
211
 
198
- Delete a sub-account
212
+ Create a new group of sub-accounts
213
+
214
+ This endpoint allows to create a group of sub-accounts
199
215
 
200
216
  ### Example
201
217
  ```ruby
@@ -216,14 +232,15 @@ end
216
232
 
217
233
  api_instance = Brevo::MasterAccountApi.new
218
234
 
219
- id = 789 # Integer | Id of the sub-account organization to be deleted
235
+ body = Brevo::Body.new # Body | Group details to be created.
220
236
 
221
237
 
222
238
  begin
223
- #Delete a sub-account
224
- api_instance.corporate_sub_account_id_delete(id)
239
+ #Create a new group of sub-accounts
240
+ result = api_instance.corporate_group_post(body)
241
+ p result
225
242
  rescue Brevo::ApiError => e
226
- puts "Exception when calling MasterAccountApi->corporate_sub_account_id_delete: #{e}"
243
+ puts "Exception when calling MasterAccountApi->corporate_group_post: #{e}"
227
244
  end
228
245
  ```
229
246
 
@@ -231,11 +248,11 @@ end
231
248
 
232
249
  Name | Type | Description | Notes
233
250
  ------------- | ------------- | ------------- | -------------
234
- **id** | **Integer**| Id of the sub-account organization to be deleted |
251
+ **body** | [**Body**](Body.md)| Group details to be created. |
235
252
 
236
253
  ### Return type
237
254
 
238
- nil (empty response body)
255
+ [**InlineResponse201**](InlineResponse201.md)
239
256
 
240
257
  ### Authorization
241
258
 
@@ -248,12 +265,12 @@ nil (empty response body)
248
265
 
249
266
 
250
267
 
251
- # **corporate_sub_account_id_get**
252
- > SubAccountDetailsResponse corporate_sub_account_id_get(id)
268
+ # **corporate_group_unlink_group_id_sub_accounts_put**
269
+ > corporate_group_unlink_group_id_sub_accounts_put(group_id, body)
253
270
 
254
- Get sub-account details
271
+ Delete sub-account from group
255
272
 
256
- This endpoint will provide the details for the specified sub-account company
273
+ This endpoint allows you to remove a sub-organization from a group.
257
274
 
258
275
  ### Example
259
276
  ```ruby
@@ -274,15 +291,16 @@ end
274
291
 
275
292
  api_instance = Brevo::MasterAccountApi.new
276
293
 
277
- id = 789 # Integer | Id of the sub-account organization
294
+ group_id = 'group_id_example' # String | Id of the group
295
+
296
+ body = Brevo::Body2.new # Body2 | List of sub-account ids
278
297
 
279
298
 
280
299
  begin
281
- #Get sub-account details
282
- result = api_instance.corporate_sub_account_id_get(id)
283
- p result
300
+ #Delete sub-account from group
301
+ api_instance.corporate_group_unlink_group_id_sub_accounts_put(group_id, body)
284
302
  rescue Brevo::ApiError => e
285
- puts "Exception when calling MasterAccountApi->corporate_sub_account_id_get: #{e}"
303
+ puts "Exception when calling MasterAccountApi->corporate_group_unlink_group_id_sub_accounts_put: #{e}"
286
304
  end
287
305
  ```
288
306
 
@@ -290,11 +308,12 @@ end
290
308
 
291
309
  Name | Type | Description | Notes
292
310
  ------------- | ------------- | ------------- | -------------
293
- **id** | **Integer**| Id of the sub-account organization |
311
+ **group_id** | **String**| Id of the group |
312
+ **body** | [**Body2**](Body2.md)| List of sub-account ids |
294
313
 
295
314
  ### Return type
296
315
 
297
- [**SubAccountDetailsResponse**](SubAccountDetailsResponse.md)
316
+ nil (empty response body)
298
317
 
299
318
  ### Authorization
300
319
 
@@ -307,12 +326,12 @@ Name | Type | Description | Notes
307
326
 
308
327
 
309
328
 
310
- # **corporate_sub_account_id_plan_put**
311
- > corporate_sub_account_id_plan_put(id, update_plan_details)
329
+ # **corporate_master_account_get**
330
+ > MasterDetailsResponse corporate_master_account_get
312
331
 
313
- Update sub-account plan
332
+ Get the details of requested master account
314
333
 
315
- This endpoint will update the sub-account plan
334
+ This endpoint will provide the details of the master account.
316
335
 
317
336
  ### Example
318
337
  ```ruby
@@ -333,16 +352,68 @@ end
333
352
 
334
353
  api_instance = Brevo::MasterAccountApi.new
335
354
 
336
- id = 789 # Integer | Id of the sub-account organization
355
+ begin
356
+ #Get the details of requested master account
357
+ result = api_instance.corporate_master_account_get
358
+ p result
359
+ rescue Brevo::ApiError => e
360
+ puts "Exception when calling MasterAccountApi->corporate_master_account_get: #{e}"
361
+ end
362
+ ```
337
363
 
338
- update_plan_details = Brevo::SubAccountUpdatePlanRequest.new # SubAccountUpdatePlanRequest | Values to update a sub-account plan
364
+ ### Parameters
365
+ This endpoint does not need any parameter.
366
+
367
+ ### Return type
368
+
369
+ [**MasterDetailsResponse**](MasterDetailsResponse.md)
370
+
371
+ ### Authorization
372
+
373
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: application/json
378
+ - **Accept**: application/json
379
+
380
+
381
+
382
+ # **corporate_sso_token_post**
383
+ > GetSsoToken corporate_sso_token_post(sso_token_request_corporate)
384
+
385
+ Generate SSO token to access admin account
386
+
387
+ This endpoint generates an SSO token to authenticate and access the admin account using the endpoint https://account-app.brevo.com/account/login/corporate/sso/[token], where [token] will be replaced by the actual token.
388
+
389
+ ### Example
390
+ ```ruby
391
+ # load the gem
392
+ require 'brevo'
393
+ # setup authorization
394
+ Brevo.configure do |config|
395
+ # Configure API key authorization: api-key
396
+ config.api_key['api-key'] = 'YOUR API KEY'
397
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
398
+ #config.api_key_prefix['api-key'] = 'Bearer'
399
+
400
+ # Configure API key authorization: partner-key
401
+ config.api_key['partner-key'] = 'YOUR API KEY'
402
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
+ #config.api_key_prefix['partner-key'] = 'Bearer'
404
+ end
405
+
406
+ api_instance = Brevo::MasterAccountApi.new
407
+
408
+ sso_token_request_corporate = Brevo::SsoTokenRequestCorporate.new # SsoTokenRequestCorporate | User email of admin account
339
409
 
340
410
 
341
411
  begin
342
- #Update sub-account plan
343
- api_instance.corporate_sub_account_id_plan_put(id, update_plan_details)
412
+ #Generate SSO token to access admin account
413
+ result = api_instance.corporate_sso_token_post(sso_token_request_corporate)
414
+ p result
344
415
  rescue Brevo::ApiError => e
345
- puts "Exception when calling MasterAccountApi->corporate_sub_account_id_plan_put: #{e}"
416
+ puts "Exception when calling MasterAccountApi->corporate_sso_token_post: #{e}"
346
417
  end
347
418
  ```
348
419
 
@@ -350,12 +421,11 @@ end
350
421
 
351
422
  Name | Type | Description | Notes
352
423
  ------------- | ------------- | ------------- | -------------
353
- **id** | **Integer**| Id of the sub-account organization |
354
- **update_plan_details** | [**SubAccountUpdatePlanRequest**](SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan |
424
+ **sso_token_request_corporate** | [**SsoTokenRequestCorporate**](SsoTokenRequestCorporate.md)| User email of admin account |
355
425
 
356
426
  ### Return type
357
427
 
358
- nil (empty response body)
428
+ [**GetSsoToken**](GetSsoToken.md)
359
429
 
360
430
  ### Authorization
361
431
 
@@ -368,12 +438,12 @@ nil (empty response body)
368
438
 
369
439
 
370
440
 
371
- # **corporate_sub_account_key_post**
372
- > CreateApiKeyResponse corporate_sub_account_key_post(create_api_key_request)
441
+ # **corporate_sub_account_get**
442
+ > SubAccountsResponse corporate_sub_account_get(offset, limit)
373
443
 
374
- Create an API key for a sub-account
444
+ Get the list of all the sub-accounts of the master account.
375
445
 
376
- This endpoint will generate an API v3 key for a sub account
446
+ This endpoint will provide the list all the sub-accounts of the master account.
377
447
 
378
448
  ### Example
379
449
  ```ruby
@@ -394,15 +464,17 @@ end
394
464
 
395
465
  api_instance = Brevo::MasterAccountApi.new
396
466
 
397
- create_api_key_request = Brevo::CreateApiKeyRequest.new # CreateApiKeyRequest | Values to generate API key for sub-account
467
+ offset = 56 # Integer | Index of the first sub-account in the page
468
+
469
+ limit = 56 # Integer | Number of sub-accounts to be displayed on each page
398
470
 
399
471
 
400
472
  begin
401
- #Create an API key for a sub-account
402
- result = api_instance.corporate_sub_account_key_post(create_api_key_request)
473
+ #Get the list of all the sub-accounts of the master account.
474
+ result = api_instance.corporate_sub_account_get(offset, limit)
403
475
  p result
404
476
  rescue Brevo::ApiError => e
405
- puts "Exception when calling MasterAccountApi->corporate_sub_account_key_post: #{e}"
477
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_get: #{e}"
406
478
  end
407
479
  ```
408
480
 
@@ -410,11 +482,12 @@ end
410
482
 
411
483
  Name | Type | Description | Notes
412
484
  ------------- | ------------- | ------------- | -------------
413
- **create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md)| Values to generate API key for sub-account |
485
+ **offset** | **Integer**| Index of the first sub-account in the page |
486
+ **limit** | **Integer**| Number of sub-accounts to be displayed on each page |
414
487
 
415
488
  ### Return type
416
489
 
417
- [**CreateApiKeyResponse**](CreateApiKeyResponse.md)
490
+ [**SubAccountsResponse**](SubAccountsResponse.md)
418
491
 
419
492
  ### Authorization
420
493
 
@@ -427,12 +500,12 @@ Name | Type | Description | Notes
427
500
 
428
501
 
429
502
 
430
- # **corporate_sub_account_post**
431
- > CreateSubAccountResponse corporate_sub_account_post(sub_account_create)
503
+ # **corporate_sub_account_id_applications_toggle_put**
504
+ > corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
432
505
 
433
- Create a new sub-account under a master account.
506
+ Enable/disable sub-account application(s)
434
507
 
435
- This endpoint will create a new sub-account under a master account
508
+ API endpoint for the Corporate owner to enable/disable applications on the sub-account
436
509
 
437
510
  ### Example
438
511
  ```ruby
@@ -453,15 +526,16 @@ end
453
526
 
454
527
  api_instance = Brevo::MasterAccountApi.new
455
528
 
456
- sub_account_create = Brevo::CreateSubAccount.new # CreateSubAccount | values to create new sub-account
529
+ id = 789 # Integer | Id of the sub-account organization (mandatory)
530
+
531
+ toggle_applications = Brevo::SubAccountAppsToggleRequest.new # SubAccountAppsToggleRequest | List of applications to activate or deactivate on a sub-account
457
532
 
458
533
 
459
534
  begin
460
- #Create a new sub-account under a master account.
461
- result = api_instance.corporate_sub_account_post(sub_account_create)
462
- p result
535
+ #Enable/disable sub-account application(s)
536
+ api_instance.corporate_sub_account_id_applications_toggle_put(id, toggle_applications)
463
537
  rescue Brevo::ApiError => e
464
- puts "Exception when calling MasterAccountApi->corporate_sub_account_post: #{e}"
538
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_id_applications_toggle_put: #{e}"
465
539
  end
466
540
  ```
467
541
 
@@ -469,11 +543,12 @@ end
469
543
 
470
544
  Name | Type | Description | Notes
471
545
  ------------- | ------------- | ------------- | -------------
472
- **sub_account_create** | [**CreateSubAccount**](CreateSubAccount.md)| values to create new sub-account |
546
+ **id** | **Integer**| Id of the sub-account organization (mandatory) |
547
+ **toggle_applications** | [**SubAccountAppsToggleRequest**](SubAccountAppsToggleRequest.md)| List of applications to activate or deactivate on a sub-account |
473
548
 
474
549
  ### Return type
475
550
 
476
- [**CreateSubAccountResponse**](CreateSubAccountResponse.md)
551
+ nil (empty response body)
477
552
 
478
553
  ### Authorization
479
554
 
@@ -486,12 +561,10 @@ Name | Type | Description | Notes
486
561
 
487
562
 
488
563
 
489
- # **corporate_sub_account_sso_token_post**
490
- > GetSsoToken corporate_sub_account_sso_token_post(sso_token_request)
491
-
492
- Generate SSO token to access Brevo
564
+ # **corporate_sub_account_id_delete**
565
+ > corporate_sub_account_id_delete(id)
493
566
 
494
- This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
567
+ Delete a sub-account
495
568
 
496
569
  ### Example
497
570
  ```ruby
@@ -512,15 +585,14 @@ end
512
585
 
513
586
  api_instance = Brevo::MasterAccountApi.new
514
587
 
515
- sso_token_request = Brevo::SsoTokenRequest.new # SsoTokenRequest | Values to generate SSO token for sub-account
588
+ id = 789 # Integer | Id of the sub-account organization to be deleted
516
589
 
517
590
 
518
591
  begin
519
- #Generate SSO token to access Brevo
520
- result = api_instance.corporate_sub_account_sso_token_post(sso_token_request)
521
- p result
592
+ #Delete a sub-account
593
+ api_instance.corporate_sub_account_id_delete(id)
522
594
  rescue Brevo::ApiError => e
523
- puts "Exception when calling MasterAccountApi->corporate_sub_account_sso_token_post: #{e}"
595
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_id_delete: #{e}"
524
596
  end
525
597
  ```
526
598
 
@@ -528,11 +600,11 @@ end
528
600
 
529
601
  Name | Type | Description | Notes
530
602
  ------------- | ------------- | ------------- | -------------
531
- **sso_token_request** | [**SsoTokenRequest**](SsoTokenRequest.md)| Values to generate SSO token for sub-account |
603
+ **id** | **Integer**| Id of the sub-account organization to be deleted |
532
604
 
533
605
  ### Return type
534
606
 
535
- [**GetSsoToken**](GetSsoToken.md)
607
+ nil (empty response body)
536
608
 
537
609
  ### Authorization
538
610
 
@@ -545,10 +617,12 @@ Name | Type | Description | Notes
545
617
 
546
618
 
547
619
 
548
- # **get_account_activity**
549
- > GetAccountActivity get_account_activity(opts)
620
+ # **corporate_sub_account_id_get**
621
+ > SubAccountDetailsResponse corporate_sub_account_id_get(id)
550
622
 
551
- Get user activity logs
623
+ Get sub-account details
624
+
625
+ This endpoint will provide the details for the specified sub-account company
552
626
 
553
627
  ### Example
554
628
  ```ruby
@@ -569,19 +643,15 @@ end
569
643
 
570
644
  api_instance = Brevo::MasterAccountApi.new
571
645
 
572
- opts = {
573
- start_date: 'start_date_example', # 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.
574
- end_date: 'end_date_example', # 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.
575
- limit: 10, # Integer | Number of documents per page
576
- offset: 0 # Integer | Index of the first document in the page.
577
- }
646
+ id = 789 # Integer | Id of the sub-account organization
647
+
578
648
 
579
649
  begin
580
- #Get user activity logs
581
- result = api_instance.get_account_activity(opts)
650
+ #Get sub-account details
651
+ result = api_instance.corporate_sub_account_id_get(id)
582
652
  p result
583
653
  rescue Brevo::ApiError => e
584
- puts "Exception when calling MasterAccountApi->get_account_activity: #{e}"
654
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_id_get: #{e}"
585
655
  end
586
656
  ```
587
657
 
@@ -589,14 +659,655 @@ end
589
659
 
590
660
  Name | Type | Description | Notes
591
661
  ------------- | ------------- | ------------- | -------------
592
- **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. | [optional]
593
- **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. | [optional]
594
- **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
595
- **offset** | **Integer**| Index of the first document in the page. | [optional] [default to 0]
662
+ **id** | **Integer**| Id of the sub-account organization |
596
663
 
597
664
  ### Return type
598
665
 
599
- [**GetAccountActivity**](GetAccountActivity.md)
666
+ [**SubAccountDetailsResponse**](SubAccountDetailsResponse.md)
667
+
668
+ ### Authorization
669
+
670
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: application/json
675
+ - **Accept**: application/json
676
+
677
+
678
+
679
+ # **corporate_sub_account_id_plan_put**
680
+ > corporate_sub_account_id_plan_put(id, update_plan_details)
681
+
682
+ Update sub-account plan
683
+
684
+ This endpoint will update the sub-account plan
685
+
686
+ ### Example
687
+ ```ruby
688
+ # load the gem
689
+ require 'brevo'
690
+ # setup authorization
691
+ Brevo.configure do |config|
692
+ # Configure API key authorization: api-key
693
+ config.api_key['api-key'] = 'YOUR API KEY'
694
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
695
+ #config.api_key_prefix['api-key'] = 'Bearer'
696
+
697
+ # Configure API key authorization: partner-key
698
+ config.api_key['partner-key'] = 'YOUR API KEY'
699
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
700
+ #config.api_key_prefix['partner-key'] = 'Bearer'
701
+ end
702
+
703
+ api_instance = Brevo::MasterAccountApi.new
704
+
705
+ id = 789 # Integer | Id of the sub-account organization
706
+
707
+ update_plan_details = Brevo::SubAccountUpdatePlanRequest.new # SubAccountUpdatePlanRequest | Values to update a sub-account plan
708
+
709
+
710
+ begin
711
+ #Update sub-account plan
712
+ api_instance.corporate_sub_account_id_plan_put(id, update_plan_details)
713
+ rescue Brevo::ApiError => e
714
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_id_plan_put: #{e}"
715
+ end
716
+ ```
717
+
718
+ ### Parameters
719
+
720
+ Name | Type | Description | Notes
721
+ ------------- | ------------- | ------------- | -------------
722
+ **id** | **Integer**| Id of the sub-account organization |
723
+ **update_plan_details** | [**SubAccountUpdatePlanRequest**](SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan |
724
+
725
+ ### Return type
726
+
727
+ nil (empty response body)
728
+
729
+ ### Authorization
730
+
731
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
732
+
733
+ ### HTTP request headers
734
+
735
+ - **Content-Type**: application/json
736
+ - **Accept**: application/json
737
+
738
+
739
+
740
+ # **corporate_sub_account_key_post**
741
+ > CreateApiKeyResponse corporate_sub_account_key_post(create_api_key_request)
742
+
743
+ Create an API key for a sub-account
744
+
745
+ This endpoint will generate an API v3 key for a sub account
746
+
747
+ ### Example
748
+ ```ruby
749
+ # load the gem
750
+ require 'brevo'
751
+ # setup authorization
752
+ Brevo.configure do |config|
753
+ # Configure API key authorization: api-key
754
+ config.api_key['api-key'] = 'YOUR API KEY'
755
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
756
+ #config.api_key_prefix['api-key'] = 'Bearer'
757
+
758
+ # Configure API key authorization: partner-key
759
+ config.api_key['partner-key'] = 'YOUR API KEY'
760
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
761
+ #config.api_key_prefix['partner-key'] = 'Bearer'
762
+ end
763
+
764
+ api_instance = Brevo::MasterAccountApi.new
765
+
766
+ create_api_key_request = Brevo::CreateApiKeyRequest.new # CreateApiKeyRequest | Values to generate API key for sub-account
767
+
768
+
769
+ begin
770
+ #Create an API key for a sub-account
771
+ result = api_instance.corporate_sub_account_key_post(create_api_key_request)
772
+ p result
773
+ rescue Brevo::ApiError => e
774
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_key_post: #{e}"
775
+ end
776
+ ```
777
+
778
+ ### Parameters
779
+
780
+ Name | Type | Description | Notes
781
+ ------------- | ------------- | ------------- | -------------
782
+ **create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md)| Values to generate API key for sub-account |
783
+
784
+ ### Return type
785
+
786
+ [**CreateApiKeyResponse**](CreateApiKeyResponse.md)
787
+
788
+ ### Authorization
789
+
790
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
791
+
792
+ ### HTTP request headers
793
+
794
+ - **Content-Type**: application/json
795
+ - **Accept**: application/json
796
+
797
+
798
+
799
+ # **corporate_sub_account_post**
800
+ > CreateSubAccountResponse corporate_sub_account_post(sub_account_create)
801
+
802
+ Create a new sub-account under a master account.
803
+
804
+ This endpoint will create a new sub-account under a master account
805
+
806
+ ### Example
807
+ ```ruby
808
+ # load the gem
809
+ require 'brevo'
810
+ # setup authorization
811
+ Brevo.configure do |config|
812
+ # Configure API key authorization: api-key
813
+ config.api_key['api-key'] = 'YOUR API KEY'
814
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
815
+ #config.api_key_prefix['api-key'] = 'Bearer'
816
+
817
+ # Configure API key authorization: partner-key
818
+ config.api_key['partner-key'] = 'YOUR API KEY'
819
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
820
+ #config.api_key_prefix['partner-key'] = 'Bearer'
821
+ end
822
+
823
+ api_instance = Brevo::MasterAccountApi.new
824
+
825
+ sub_account_create = Brevo::CreateSubAccount.new # CreateSubAccount | values to create new sub-account
826
+
827
+
828
+ begin
829
+ #Create a new sub-account under a master account.
830
+ result = api_instance.corporate_sub_account_post(sub_account_create)
831
+ p result
832
+ rescue Brevo::ApiError => e
833
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_post: #{e}"
834
+ end
835
+ ```
836
+
837
+ ### Parameters
838
+
839
+ Name | Type | Description | Notes
840
+ ------------- | ------------- | ------------- | -------------
841
+ **sub_account_create** | [**CreateSubAccount**](CreateSubAccount.md)| values to create new sub-account |
842
+
843
+ ### Return type
844
+
845
+ [**CreateSubAccountResponse**](CreateSubAccountResponse.md)
846
+
847
+ ### Authorization
848
+
849
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
850
+
851
+ ### HTTP request headers
852
+
853
+ - **Content-Type**: application/json
854
+ - **Accept**: application/json
855
+
856
+
857
+
858
+ # **corporate_sub_account_sso_token_post**
859
+ > GetSsoToken corporate_sub_account_sso_token_post(sso_token_request)
860
+
861
+ Generate SSO token to access sub-account
862
+
863
+ This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
864
+
865
+ ### Example
866
+ ```ruby
867
+ # load the gem
868
+ require 'brevo'
869
+ # setup authorization
870
+ Brevo.configure do |config|
871
+ # Configure API key authorization: api-key
872
+ config.api_key['api-key'] = 'YOUR API KEY'
873
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
874
+ #config.api_key_prefix['api-key'] = 'Bearer'
875
+
876
+ # Configure API key authorization: partner-key
877
+ config.api_key['partner-key'] = 'YOUR API KEY'
878
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
879
+ #config.api_key_prefix['partner-key'] = 'Bearer'
880
+ end
881
+
882
+ api_instance = Brevo::MasterAccountApi.new
883
+
884
+ sso_token_request = Brevo::SsoTokenRequest.new # SsoTokenRequest | Values to generate SSO token for sub-account
885
+
886
+
887
+ begin
888
+ #Generate SSO token to access sub-account
889
+ result = api_instance.corporate_sub_account_sso_token_post(sso_token_request)
890
+ p result
891
+ rescue Brevo::ApiError => e
892
+ puts "Exception when calling MasterAccountApi->corporate_sub_account_sso_token_post: #{e}"
893
+ end
894
+ ```
895
+
896
+ ### Parameters
897
+
898
+ Name | Type | Description | Notes
899
+ ------------- | ------------- | ------------- | -------------
900
+ **sso_token_request** | [**SsoTokenRequest**](SsoTokenRequest.md)| Values to generate SSO token for sub-account |
901
+
902
+ ### Return type
903
+
904
+ [**GetSsoToken**](GetSsoToken.md)
905
+
906
+ ### Authorization
907
+
908
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
909
+
910
+ ### HTTP request headers
911
+
912
+ - **Content-Type**: application/json
913
+ - **Accept**: application/json
914
+
915
+
916
+
917
+ # **corporate_user_invitation_action_email_put**
918
+ > InlineResponse200 corporate_user_invitation_action_email_put(action, email)
919
+
920
+ Resend / cancel admin user invitation
921
+
922
+ This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
923
+
924
+ ### Example
925
+ ```ruby
926
+ # load the gem
927
+ require 'brevo'
928
+ # setup authorization
929
+ Brevo.configure do |config|
930
+ # Configure API key authorization: api-key
931
+ config.api_key['api-key'] = 'YOUR API KEY'
932
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
933
+ #config.api_key_prefix['api-key'] = 'Bearer'
934
+
935
+ # Configure API key authorization: partner-key
936
+ config.api_key['partner-key'] = 'YOUR API KEY'
937
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
938
+ #config.api_key_prefix['partner-key'] = 'Bearer'
939
+ end
940
+
941
+ api_instance = Brevo::MasterAccountApi.new
942
+
943
+ action = 'action_example' # String | Action to be performed (cancel / resend)
944
+
945
+ email = 'email_example' # String | Email address of the recipient
946
+
947
+
948
+ begin
949
+ #Resend / cancel admin user invitation
950
+ result = api_instance.corporate_user_invitation_action_email_put(action, email)
951
+ p result
952
+ rescue Brevo::ApiError => e
953
+ puts "Exception when calling MasterAccountApi->corporate_user_invitation_action_email_put: #{e}"
954
+ end
955
+ ```
956
+
957
+ ### Parameters
958
+
959
+ Name | Type | Description | Notes
960
+ ------------- | ------------- | ------------- | -------------
961
+ **action** | **String**| Action to be performed (cancel / resend) |
962
+ **email** | **String**| Email address of the recipient |
963
+
964
+ ### Return type
965
+
966
+ [**InlineResponse200**](InlineResponse200.md)
967
+
968
+ ### Authorization
969
+
970
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
971
+
972
+ ### HTTP request headers
973
+
974
+ - **Content-Type**: application/json
975
+ - **Accept**: application/json
976
+
977
+
978
+
979
+ # **corporate_user_revoke_email_delete**
980
+ > corporate_user_revoke_email_delete(email)
981
+
982
+ Revoke an admin user
983
+
984
+ This endpoint allows to revoke/remove an invited member of your Admin account
985
+
986
+ ### Example
987
+ ```ruby
988
+ # load the gem
989
+ require 'brevo'
990
+ # setup authorization
991
+ Brevo.configure do |config|
992
+ # Configure API key authorization: api-key
993
+ config.api_key['api-key'] = 'YOUR API KEY'
994
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
995
+ #config.api_key_prefix['api-key'] = 'Bearer'
996
+
997
+ # Configure API key authorization: partner-key
998
+ config.api_key['partner-key'] = 'YOUR API KEY'
999
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1000
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1001
+ end
1002
+
1003
+ api_instance = Brevo::MasterAccountApi.new
1004
+
1005
+ email = 'email_example' # String | Email of the invited user
1006
+
1007
+
1008
+ begin
1009
+ #Revoke an admin user
1010
+ api_instance.corporate_user_revoke_email_delete(email)
1011
+ rescue Brevo::ApiError => e
1012
+ puts "Exception when calling MasterAccountApi->corporate_user_revoke_email_delete: #{e}"
1013
+ end
1014
+ ```
1015
+
1016
+ ### Parameters
1017
+
1018
+ Name | Type | Description | Notes
1019
+ ------------- | ------------- | ------------- | -------------
1020
+ **email** | **String**| Email of the invited user |
1021
+
1022
+ ### Return type
1023
+
1024
+ nil (empty response body)
1025
+
1026
+ ### Authorization
1027
+
1028
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1029
+
1030
+ ### HTTP request headers
1031
+
1032
+ - **Content-Type**: application/json
1033
+ - **Accept**: application/json
1034
+
1035
+
1036
+
1037
+ # **get_account_activity**
1038
+ > GetAccountActivity get_account_activity(opts)
1039
+
1040
+ Get user activity logs
1041
+
1042
+ ### Example
1043
+ ```ruby
1044
+ # load the gem
1045
+ require 'brevo'
1046
+ # setup authorization
1047
+ Brevo.configure do |config|
1048
+ # Configure API key authorization: api-key
1049
+ config.api_key['api-key'] = 'YOUR API KEY'
1050
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1051
+ #config.api_key_prefix['api-key'] = 'Bearer'
1052
+
1053
+ # Configure API key authorization: partner-key
1054
+ config.api_key['partner-key'] = 'YOUR API KEY'
1055
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1056
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1057
+ end
1058
+
1059
+ api_instance = Brevo::MasterAccountApi.new
1060
+
1061
+ opts = {
1062
+ start_date: 'start_date_example', # 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.
1063
+ end_date: 'end_date_example', # 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.
1064
+ limit: 10, # Integer | Number of documents per page
1065
+ offset: 0 # Integer | Index of the first document in the page.
1066
+ }
1067
+
1068
+ begin
1069
+ #Get user activity logs
1070
+ result = api_instance.get_account_activity(opts)
1071
+ p result
1072
+ rescue Brevo::ApiError => e
1073
+ puts "Exception when calling MasterAccountApi->get_account_activity: #{e}"
1074
+ end
1075
+ ```
1076
+
1077
+ ### Parameters
1078
+
1079
+ Name | Type | Description | Notes
1080
+ ------------- | ------------- | ------------- | -------------
1081
+ **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. | [optional]
1082
+ **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. | [optional]
1083
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
1084
+ **offset** | **Integer**| Index of the first document in the page. | [optional] [default to 0]
1085
+
1086
+ ### Return type
1087
+
1088
+ [**GetAccountActivity**](GetAccountActivity.md)
1089
+
1090
+ ### Authorization
1091
+
1092
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1093
+
1094
+ ### HTTP request headers
1095
+
1096
+ - **Content-Type**: application/json
1097
+ - **Accept**: application/json
1098
+
1099
+
1100
+
1101
+ # **get_corporate_invited_users_list**
1102
+ > GetCorporateInvitedUsersList get_corporate_invited_users_list
1103
+
1104
+ Get the list of all admin users
1105
+
1106
+ This endpoint allows you to list all Admin users of your Admin account
1107
+
1108
+ ### Example
1109
+ ```ruby
1110
+ # load the gem
1111
+ require 'brevo'
1112
+ # setup authorization
1113
+ Brevo.configure do |config|
1114
+ # Configure API key authorization: api-key
1115
+ config.api_key['api-key'] = 'YOUR API KEY'
1116
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1117
+ #config.api_key_prefix['api-key'] = 'Bearer'
1118
+
1119
+ # Configure API key authorization: partner-key
1120
+ config.api_key['partner-key'] = 'YOUR API KEY'
1121
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1122
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1123
+ end
1124
+
1125
+ api_instance = Brevo::MasterAccountApi.new
1126
+
1127
+ begin
1128
+ #Get the list of all admin users
1129
+ result = api_instance.get_corporate_invited_users_list
1130
+ p result
1131
+ rescue Brevo::ApiError => e
1132
+ puts "Exception when calling MasterAccountApi->get_corporate_invited_users_list: #{e}"
1133
+ end
1134
+ ```
1135
+
1136
+ ### Parameters
1137
+ This endpoint does not need any parameter.
1138
+
1139
+ ### Return type
1140
+
1141
+ [**GetCorporateInvitedUsersList**](GetCorporateInvitedUsersList.md)
1142
+
1143
+ ### Authorization
1144
+
1145
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1146
+
1147
+ ### HTTP request headers
1148
+
1149
+ - **Content-Type**: application/json
1150
+ - **Accept**: application/json
1151
+
1152
+
1153
+
1154
+ # **get_corporate_user_permission**
1155
+ > GetCorporateUserPermission get_corporate_user_permission(email)
1156
+
1157
+ Check admin user permissions
1158
+
1159
+ ### Example
1160
+ ```ruby
1161
+ # load the gem
1162
+ require 'brevo'
1163
+ # setup authorization
1164
+ Brevo.configure do |config|
1165
+ # Configure API key authorization: api-key
1166
+ config.api_key['api-key'] = 'YOUR API KEY'
1167
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1168
+ #config.api_key_prefix['api-key'] = 'Bearer'
1169
+
1170
+ # Configure API key authorization: partner-key
1171
+ config.api_key['partner-key'] = 'YOUR API KEY'
1172
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1173
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1174
+ end
1175
+
1176
+ api_instance = Brevo::MasterAccountApi.new
1177
+
1178
+ email = 'email_example' # String | Email of the invited user
1179
+
1180
+
1181
+ begin
1182
+ #Check admin user permissions
1183
+ result = api_instance.get_corporate_user_permission(email)
1184
+ p result
1185
+ rescue Brevo::ApiError => e
1186
+ puts "Exception when calling MasterAccountApi->get_corporate_user_permission: #{e}"
1187
+ end
1188
+ ```
1189
+
1190
+ ### Parameters
1191
+
1192
+ Name | Type | Description | Notes
1193
+ ------------- | ------------- | ------------- | -------------
1194
+ **email** | **String**| Email of the invited user |
1195
+
1196
+ ### Return type
1197
+
1198
+ [**GetCorporateUserPermission**](GetCorporateUserPermission.md)
1199
+
1200
+ ### Authorization
1201
+
1202
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1203
+
1204
+ ### HTTP request headers
1205
+
1206
+ - **Content-Type**: application/json
1207
+ - **Accept**: application/json
1208
+
1209
+
1210
+
1211
+ # **get_sub_account_groups**
1212
+ > Array<InlineResponse2001> get_sub_account_groups
1213
+
1214
+ Get the list of groups
1215
+
1216
+ This endpoint allows you to list all groups created on your Admin account.
1217
+
1218
+ ### Example
1219
+ ```ruby
1220
+ # load the gem
1221
+ require 'brevo'
1222
+ # setup authorization
1223
+ Brevo.configure do |config|
1224
+ # Configure API key authorization: api-key
1225
+ config.api_key['api-key'] = 'YOUR API KEY'
1226
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1227
+ #config.api_key_prefix['api-key'] = 'Bearer'
1228
+
1229
+ # Configure API key authorization: partner-key
1230
+ config.api_key['partner-key'] = 'YOUR API KEY'
1231
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1232
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1233
+ end
1234
+
1235
+ api_instance = Brevo::MasterAccountApi.new
1236
+
1237
+ begin
1238
+ #Get the list of groups
1239
+ result = api_instance.get_sub_account_groups
1240
+ p result
1241
+ rescue Brevo::ApiError => e
1242
+ puts "Exception when calling MasterAccountApi->get_sub_account_groups: #{e}"
1243
+ end
1244
+ ```
1245
+
1246
+ ### Parameters
1247
+ This endpoint does not need any parameter.
1248
+
1249
+ ### Return type
1250
+
1251
+ [**Array<InlineResponse2001>**](InlineResponse2001.md)
1252
+
1253
+ ### Authorization
1254
+
1255
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
1256
+
1257
+ ### HTTP request headers
1258
+
1259
+ - **Content-Type**: application/json
1260
+ - **Accept**: application/json
1261
+
1262
+
1263
+
1264
+ # **invite_admin_user**
1265
+ > InviteAdminUser invite_admin_user(send_invitation)
1266
+
1267
+ Send invitation to an admin user
1268
+
1269
+ `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.
1270
+
1271
+ ### Example
1272
+ ```ruby
1273
+ # load the gem
1274
+ require 'brevo'
1275
+ # setup authorization
1276
+ Brevo.configure do |config|
1277
+ # Configure API key authorization: api-key
1278
+ config.api_key['api-key'] = 'YOUR API KEY'
1279
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1280
+ #config.api_key_prefix['api-key'] = 'Bearer'
1281
+
1282
+ # Configure API key authorization: partner-key
1283
+ config.api_key['partner-key'] = 'YOUR API KEY'
1284
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1285
+ #config.api_key_prefix['partner-key'] = 'Bearer'
1286
+ end
1287
+
1288
+ api_instance = Brevo::MasterAccountApi.new
1289
+
1290
+ send_invitation = Brevo::InviteAdminUser.new # InviteAdminUser | Payload to send an invitation
1291
+
1292
+
1293
+ begin
1294
+ #Send invitation to an admin user
1295
+ result = api_instance.invite_admin_user(send_invitation)
1296
+ p result
1297
+ rescue Brevo::ApiError => e
1298
+ puts "Exception when calling MasterAccountApi->invite_admin_user: #{e}"
1299
+ end
1300
+ ```
1301
+
1302
+ ### Parameters
1303
+
1304
+ Name | Type | Description | Notes
1305
+ ------------- | ------------- | ------------- | -------------
1306
+ **send_invitation** | [**InviteAdminUser**](InviteAdminUser.md)| Payload to send an invitation |
1307
+
1308
+ ### Return type
1309
+
1310
+ [**InviteAdminUser**](InviteAdminUser.md)
600
1311
 
601
1312
  ### Authorization
602
1313