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
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
6
6
  **name** | **String** | Name of the feature | [optional]
7
7
  **unit_value** | **String** | Unit value of the feature | [optional]
8
8
  **quantity** | **Integer** | Quantity provided in the plan | [optional]
9
+ **quantity_with_overages** | **Integer** | Quantity with overages provided in the plan (only applicable on ENTv2) | [optional]
9
10
  **used** | **Integer** | Quantity consumed by master | [optional]
11
+ **used_overages** | **Integer** | Quantity consumed by sub-organizations over the admin plan limit (only applicable on ENTv2) | [optional]
10
12
  **remaining** | **Integer** | Quantity remaining in the plan | [optional]
11
13
 
12
14
 
data/docs/OrderBatch.md CHANGED
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **orders** | [**Array<Order>**](Order.md) | array of order objects |
7
7
  **notify_url** | **String** | Notify Url provided by client to get the status of batch request | [optional]
8
+ **historical** | **BOOLEAN** | Defines wether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual. | [optional] [default to true]
8
9
 
9
10
 
@@ -0,0 +1,8 @@
1
+ # Brevo::PutRevokeUserPermission
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address of the user. |
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # Brevo::Putresendcancelinvitation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | Email address of the user. |
7
+
8
+
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **notify_url** | **String** | URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional]
11
11
  **new_list** | [**RequestContactImportNewList**](RequestContactImportNewList.md) | | [optional]
12
12
  **email_blacklist** | **BOOLEAN** | To blacklist all the contacts for email | [optional] [default to false]
13
+ **disable_notification** | **BOOLEAN** | To disable email notification | [optional] [default to false]
13
14
  **sms_blacklist** | **BOOLEAN** | To blacklist all the contacts for sms | [optional] [default to false]
14
15
  **update_existing_contacts** | **BOOLEAN** | To facilitate the choice to update the existing contacts | [optional] [default to true]
15
16
  **empty_contacts_attributes** | **BOOLEAN** | To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true ) | [optional] [default to false]
@@ -1,23 +1,22 @@
1
1
  # Brevo::SendSmtpEmail
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional]
7
- **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional]
8
- **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional]
9
- **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
- **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional]
11
- **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional]
12
- **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional]
13
- **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional]
14
- **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional]
15
- **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional]
16
- **template_id** | **Integer** | Id of the template. | [optional]
17
- **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional]
18
- **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails | [optional]
19
- **tags** | **Array<String>** | Tag your emails to find them more easily | [optional]
20
- **scheduled_at** | **DateTime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional]
21
- **batch_id** | **String** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional]
22
-
23
4
 
5
+ | Name | Type | Description | Notes |
6
+ | -------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
7
+ | **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional] |
8
+ | **to** | [**Array<SendSmtpEmailTo>**](SendSmtpEmailTo.md) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional] |
9
+ | **bcc** | [**Array<SendSmtpEmailBcc>**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] |
10
+ | **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] |
11
+ | **html_content** | **String** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] |
12
+ | **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] |
13
+ | **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] |
14
+ | **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] |
15
+ | **attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] |
16
+ | **headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional] |
17
+ | **templateId** | **Integer** | Id of the template. | [optional] |
18
+ | **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] |
19
+ | **message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails | [optional] |
20
+ | **tags** | **Array<String>** | Tag your emails to find them more easily | [optional] |
21
+ | **scheduled_at** | **DateTime** | UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**. | [optional] |
22
+ | **batch_id** | **String** | Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end. | [optional] |
@@ -9,5 +9,7 @@ Name | Type | Description | Notes
9
9
  **cc** | [**Array<SendSmtpEmailCc>**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional]
10
10
  **reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional]
11
11
  **subject** | **String** | Custom subject specific to message version | [optional]
12
+ **html_content** | **String** | HTML body of the message. **Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed** | [optional]
13
+ **text_content** | **String** | Plain Text body of the message. **Ignored if 'templateId' is passed** | [optional]
12
14
 
13
15
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **template_id** | **Integer** | ID of the template to send | [optional]
7
7
  **text** | **String** | Text to be sent as message body (will be overridden if templateId is passed in the same request) | [optional]
8
8
  **sender_number** | **String** | WhatsApp Number with country code. Example, 85264318721 |
9
+ **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. | [optional]
9
10
  **contact_numbers** | **Array<String>** | List of phone numbers of the contacts |
10
11
 
11
12
 
@@ -0,0 +1,8 @@
1
+ # Brevo::SsoTokenRequestCorporate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | User email of sub-account organization |
7
+
8
+
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **inbox** | **BOOLEAN** | Set this field to enable or disable Inbox on the sub-account | [optional]
6
+ **inbox** | **BOOLEAN** | Set this field to enable or disable Inbox on the sub-account / Not applicable on ENTv2 | [optional]
7
7
  **whatsapp** | **BOOLEAN** | Set this field to enable or disable Whatsapp campaigns on the sub-account | [optional]
8
8
  **automation** | **BOOLEAN** | Set this field to enable or disable Automation on the sub-account | [optional]
9
9
  **email_campaigns** | **BOOLEAN** | Set this field to enable or disable Email Campaigns on the sub-account | [optional]
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **users** | **Integer** | Number of multi-users | [optional]
7
- **landing_page** | **Integer** | Number of landing pages | [optional]
8
- **inbox** | **Integer** | Number of inboxes | [optional]
7
+ **landing_page** | **Integer** | Number of landing pages / Not required on ENTv2 | [optional]
8
+ **inbox** | **Integer** | Number of inboxes / Not required on ENTv2 | [optional]
9
9
 
10
10
 
data/docs/TasksApi.md CHANGED
@@ -40,7 +40,7 @@ opts = {
40
40
  filter_type: 'filter_type_example', # String | Filter by task type (ID)
41
41
  filter_status: 'filter_status_example', # String | Filter by task status
42
42
  filter_date: 'filter_date_example', # String | Filter by date
43
- filter_assign_to: 'filter_assign_to_example', # String | Filter by assignTo id
43
+ filter_assign_to: 'filter_assign_to_example', # String | Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute.
44
44
  filter_contacts: 'filter_contacts_example', # String | Filter by contact ids
45
45
  filter_deals: 'filter_deals_example', # String | Filter by deals ids
46
46
  filter_companies: 'filter_companies_example', # String | Filter by companies ids
@@ -68,7 +68,7 @@ Name | Type | Description | Notes
68
68
  **filter_type** | **String**| Filter by task type (ID) | [optional]
69
69
  **filter_status** | **String**| Filter by task status | [optional]
70
70
  **filter_date** | **String**| Filter by date | [optional]
71
- **filter_assign_to** | **String**| Filter by assignTo id | [optional]
71
+ **filter_assign_to** | **String**| Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute. | [optional]
72
72
  **filter_contacts** | **String**| Filter by contact ids | [optional]
73
73
  **filter_deals** | **String**| Filter by deals ids | [optional]
74
74
  **filter_companies** | **String**| Filter by companies ids | [optional]
@@ -233,7 +233,7 @@ api_instance = Brevo::TasksApi.new
233
233
 
234
234
  id = 'id_example' # String |
235
235
 
236
- body = Brevo::Body7.new # Body7 | Updated task details.
236
+ body = Brevo::Body10.new # Body10 | Updated task details.
237
237
 
238
238
 
239
239
  begin
@@ -249,7 +249,7 @@ end
249
249
  Name | Type | Description | Notes
250
250
  ------------- | ------------- | ------------- | -------------
251
251
  **id** | **String**| |
252
- **body** | [**Body7**](Body7.md)| Updated task details. |
252
+ **body** | [**Body10**](Body10.md)| Updated task details. |
253
253
 
254
254
  ### Return type
255
255
 
@@ -267,7 +267,7 @@ nil (empty response body)
267
267
 
268
268
 
269
269
  # **crm_tasks_post**
270
- > InlineResponse2011 crm_tasks_post(body)
270
+ > InlineResponse2012 crm_tasks_post(body)
271
271
 
272
272
  Create a task
273
273
 
@@ -290,7 +290,7 @@ end
290
290
 
291
291
  api_instance = Brevo::TasksApi.new
292
292
 
293
- body = Brevo::Body6.new # Body6 | Task name.
293
+ body = Brevo::Body9.new # Body9 | Task name.
294
294
 
295
295
 
296
296
  begin
@@ -306,11 +306,11 @@ end
306
306
 
307
307
  Name | Type | Description | Notes
308
308
  ------------- | ------------- | ------------- | -------------
309
- **body** | [**Body6**](Body6.md)| Task name. |
309
+ **body** | [**Body9**](Body9.md)| Task name. |
310
310
 
311
311
  ### Return type
312
312
 
313
- [**InlineResponse2011**](InlineResponse2011.md)
313
+ [**InlineResponse2012**](InlineResponse2012.md)
314
314
 
315
315
  ### Authorization
316
316
 
@@ -24,7 +24,7 @@ Method | HTTP request | Description
24
24
  [**send_test_template**](TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
25
25
  [**send_transac_email**](TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
26
26
  [**smtp_blocked_contacts_email_delete**](TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
27
- [**smtp_log_message_id_delete**](TransactionalEmailsApi.md#smtp_log_message_id_delete) | **DELETE** /smtp/log/{messageId} | Delete an SMTP transactional log
27
+ [**smtp_log_identifier_delete**](TransactionalEmailsApi.md#smtp_log_identifier_delete) | **DELETE** /smtp/log/{identifier} | Delete an SMTP transactional log
28
28
  [**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
29
29
 
30
30
 
@@ -1273,8 +1273,8 @@ nil (empty response body)
1273
1273
 
1274
1274
 
1275
1275
 
1276
- # **smtp_log_message_id_delete**
1277
- > smtp_log_message_id_delete(message_id)
1276
+ # **smtp_log_identifier_delete**
1277
+ > smtp_log_identifier_delete(identifier)
1278
1278
 
1279
1279
  Delete an SMTP transactional log
1280
1280
 
@@ -1297,14 +1297,14 @@ end
1297
1297
 
1298
1298
  api_instance = Brevo::TransactionalEmailsApi.new
1299
1299
 
1300
- message_id = 'message_id_example' # String | MessageId of the transactional log to delete
1300
+ identifier = 'identifier_example' # String | MessageId or Email of the transactional log(s) to delete
1301
1301
 
1302
1302
 
1303
1303
  begin
1304
1304
  #Delete an SMTP transactional log
1305
- api_instance.smtp_log_message_id_delete(message_id)
1305
+ api_instance.smtp_log_identifier_delete(identifier)
1306
1306
  rescue Brevo::ApiError => e
1307
- puts "Exception when calling TransactionalEmailsApi->smtp_log_message_id_delete: #{e}"
1307
+ puts "Exception when calling TransactionalEmailsApi->smtp_log_identifier_delete: #{e}"
1308
1308
  end
1309
1309
  ```
1310
1310
 
@@ -1312,7 +1312,7 @@ end
1312
1312
 
1313
1313
  Name | Type | Description | Notes
1314
1314
  ------------- | ------------- | ------------- | -------------
1315
- **message_id** | **String**| MessageId of the transactional log to delete |
1315
+ **identifier** | **String**| MessageId or Email of the transactional log(s) to delete |
1316
1316
 
1317
1317
  ### Return type
1318
1318
 
@@ -83,7 +83,7 @@ Name | Type | Description | Notes
83
83
 
84
84
 
85
85
  # **send_whatsapp_message**
86
- > InlineResponse2013 send_whatsapp_message(send_whatsapp_message)
86
+ > InlineResponse2014 send_whatsapp_message(send_whatsapp_message)
87
87
 
88
88
  Send a WhatsApp message
89
89
 
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
128
128
 
129
129
  ### Return type
130
130
 
131
- [**InlineResponse2013**](InlineResponse2013.md)
131
+ [**InlineResponse2014**](InlineResponse2014.md)
132
132
 
133
133
  ### Authorization
134
134
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
6
+ **attributes** | **Object** | Pass the set of attributes to be updated. These attributes must be present in your account. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional]
7
7
  **ext_id** | **String** | Pass your own Id to update ext_id of a contact. | [optional]
8
8
  **email_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional]
9
9
  **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional]
@@ -3,6 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **default_coupon** | **String** | A default coupon to be used in case there are no coupons left |
6
+ **default_coupon** | **String** | A default coupon to be used in case there are no coupons left | [optional]
7
+ **expiration_date** | **DateTime** | Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. | [optional]
8
+ **remaining_days_alert** | **Integer** | Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. | [optional]
9
+ **remaining_coupons_alert** | **Integer** | Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. | [optional]
7
10
 
8
11
 
@@ -7,5 +7,8 @@ Name | Type | Description | Notes
7
7
  **description** | **String** | Description of the webhook | [optional]
8
8
  **events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` | [optional]
9
9
  **domain** | **String** | Inbound domain of webhook, used in case of event type `inbound` | [optional]
10
+ **batched** | **BOOLEAN** | To send batched webhooks | [optional]
11
+ **auth** | [**GetWebhookAuth**](GetWebhookAuth.md) | | [optional]
12
+ **headers** | [**Array<GetWebhookHeaders>**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional]
10
13
 
11
14
 
data/docs/UserApi.md CHANGED
@@ -4,8 +4,71 @@ All URIs are relative to *https://api.brevo.com/v3*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**edit_user_permission**](UserApi.md#edit_user_permission) | **POST** /organization/user/update/permissions | Update permission for a user
7
8
  [**get_invited_users_list**](UserApi.md#get_invited_users_list) | **GET** /organization/invited/users | Get the list of all your users
8
9
  [**get_user_permission**](UserApi.md#get_user_permission) | **GET** /organization/user/{email}/permissions | Check user permission
10
+ [**inviteuser**](UserApi.md#inviteuser) | **POST** /organization/user/invitation/send | Send invitation to user
11
+ [**put_revoke_user_permission**](UserApi.md#put_revoke_user_permission) | **PUT** /organization/user/invitation/revoke/{email} | Revoke user permission
12
+ [**putresendcancelinvitation**](UserApi.md#putresendcancelinvitation) | **PUT** /organization/user/invitation/{action}/{email} | Resend / Cancel invitation
13
+
14
+
15
+ # **edit_user_permission**
16
+ > Inviteuser edit_user_permission(update_permissions)
17
+
18
+ Update permission for a user
19
+
20
+ `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **Note**: - The privileges array remains the same as in the send invitation; the user simply needs to provide the permissions that need to be updated. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'brevo'
26
+ # setup authorization
27
+ Brevo.configure do |config|
28
+ # Configure API key authorization: api-key
29
+ config.api_key['api-key'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ #config.api_key_prefix['api-key'] = 'Bearer'
32
+
33
+ # Configure API key authorization: partner-key
34
+ config.api_key['partner-key'] = 'YOUR API KEY'
35
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
36
+ #config.api_key_prefix['partner-key'] = 'Bearer'
37
+ end
38
+
39
+ api_instance = Brevo::UserApi.new
40
+
41
+ update_permissions = Brevo::Inviteuser.new # Inviteuser | Values to update permissions for an invited user
42
+
43
+
44
+ begin
45
+ #Update permission for a user
46
+ result = api_instance.edit_user_permission(update_permissions)
47
+ p result
48
+ rescue Brevo::ApiError => e
49
+ puts "Exception when calling UserApi->edit_user_permission: #{e}"
50
+ end
51
+ ```
52
+
53
+ ### Parameters
54
+
55
+ Name | Type | Description | Notes
56
+ ------------- | ------------- | ------------- | -------------
57
+ **update_permissions** | [**Inviteuser**](Inviteuser.md)| Values to update permissions for an invited user |
58
+
59
+ ### Return type
60
+
61
+ [**Inviteuser**](Inviteuser.md)
62
+
63
+ ### Authorization
64
+
65
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: application/json
70
+ - **Accept**: application/json
71
+
9
72
 
10
73
 
11
74
  # **get_invited_users_list**
@@ -116,3 +179,179 @@ Name | Type | Description | Notes
116
179
 
117
180
 
118
181
 
182
+ # **inviteuser**
183
+ > Inviteuser inviteuser(send_invitation)
184
+
185
+ Send invitation to user
186
+
187
+ `Feature` - A Feature represents a specific functionality like Email campaign, Deals, Calls, Automations, etc. on Brevo. While inviting a user, determine which feature you want to manage access to. You must specify the feature accurately to avoid errors. `Permission` - A Permission defines the level of access or control a user has over a specific feature. While inviting user, decide on the permission level required for the selected feature. Make sure the chosen permission is related to the selected feature. Features and their respective permissions are as below: - `email_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `sms_campaigns`: - \"create_edit_delete\" - \"send_schedule_suspend\" - `contacts`: - \"view\" - \"create_edit_delete\" - \"import\" - \"export\" - \"list_and_attributes\" - \"forms\" - `templates`: - \"create_edit_delete\" - \"activate_deactivate\" - `workflows`: - \"create_edit_delete\" - \"activate_deactivate_pause\" - \"settings\" - `facebook_ads`: - \"create_edit_delete\" - \"schedule_pause\" - `landing_pages`: - \"all\" - `transactional_emails`: - \"settings\" - \"logs\" - `smtp_api`: - \"smtp\" - \"api_keys\" - \"authorized_ips\" - `user_management`: - \"all\" - `sales_platform`: - \"manage_owned_deals_tasks_companies\" - \"manage_others_deals_tasks_companies\" - \"reports\" - \"settings\" - `phone`: - \"all\" - `conversations`: - \"access\" - \"assign\" - \"configure\" - `senders_domains_dedicated_ips`: - \"senders_management\" - \"domains_management\" - \"dedicated_ips_management\" - `push_notifications`: - \"view\" - \"create_edit_delete\" - \"send\" - \"settings\" **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 user. - The availability of feature and its permission depends on your current plan. Please select the features and permissions accordingly.
188
+
189
+ ### Example
190
+ ```ruby
191
+ # load the gem
192
+ require 'brevo'
193
+ # setup authorization
194
+ Brevo.configure do |config|
195
+ # Configure API key authorization: api-key
196
+ config.api_key['api-key'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ #config.api_key_prefix['api-key'] = 'Bearer'
199
+
200
+ # Configure API key authorization: partner-key
201
+ config.api_key['partner-key'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ #config.api_key_prefix['partner-key'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = Brevo::UserApi.new
207
+
208
+ send_invitation = Brevo::Inviteuser.new # Inviteuser | Values to create an invitation
209
+
210
+
211
+ begin
212
+ #Send invitation to user
213
+ result = api_instance.inviteuser(send_invitation)
214
+ p result
215
+ rescue Brevo::ApiError => e
216
+ puts "Exception when calling UserApi->inviteuser: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ Name | Type | Description | Notes
223
+ ------------- | ------------- | ------------- | -------------
224
+ **send_invitation** | [**Inviteuser**](Inviteuser.md)| Values to create an invitation |
225
+
226
+ ### Return type
227
+
228
+ [**Inviteuser**](Inviteuser.md)
229
+
230
+ ### Authorization
231
+
232
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
233
+
234
+ ### HTTP request headers
235
+
236
+ - **Content-Type**: application/json
237
+ - **Accept**: application/json
238
+
239
+
240
+
241
+ # **put_revoke_user_permission**
242
+ > PutRevokeUserPermission put_revoke_user_permission(email)
243
+
244
+ Revoke user permission
245
+
246
+ ### Example
247
+ ```ruby
248
+ # load the gem
249
+ require 'brevo'
250
+ # setup authorization
251
+ Brevo.configure do |config|
252
+ # Configure API key authorization: api-key
253
+ config.api_key['api-key'] = 'YOUR API KEY'
254
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
255
+ #config.api_key_prefix['api-key'] = 'Bearer'
256
+
257
+ # Configure API key authorization: partner-key
258
+ config.api_key['partner-key'] = 'YOUR API KEY'
259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
260
+ #config.api_key_prefix['partner-key'] = 'Bearer'
261
+ end
262
+
263
+ api_instance = Brevo::UserApi.new
264
+
265
+ email = 'email_example' # String | Email of the invited user.
266
+
267
+
268
+ begin
269
+ #Revoke user permission
270
+ result = api_instance.put_revoke_user_permission(email)
271
+ p result
272
+ rescue Brevo::ApiError => e
273
+ puts "Exception when calling UserApi->put_revoke_user_permission: #{e}"
274
+ end
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ Name | Type | Description | Notes
280
+ ------------- | ------------- | ------------- | -------------
281
+ **email** | **String**| Email of the invited user. |
282
+
283
+ ### Return type
284
+
285
+ [**PutRevokeUserPermission**](PutRevokeUserPermission.md)
286
+
287
+ ### Authorization
288
+
289
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: application/json
294
+ - **Accept**: application/json
295
+
296
+
297
+
298
+ # **putresendcancelinvitation**
299
+ > Putresendcancelinvitation putresendcancelinvitation(action, email)
300
+
301
+ Resend / Cancel invitation
302
+
303
+ ### Example
304
+ ```ruby
305
+ # load the gem
306
+ require 'brevo'
307
+ # setup authorization
308
+ Brevo.configure do |config|
309
+ # Configure API key authorization: api-key
310
+ config.api_key['api-key'] = 'YOUR API KEY'
311
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
312
+ #config.api_key_prefix['api-key'] = 'Bearer'
313
+
314
+ # Configure API key authorization: partner-key
315
+ config.api_key['partner-key'] = 'YOUR API KEY'
316
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
317
+ #config.api_key_prefix['partner-key'] = 'Bearer'
318
+ end
319
+
320
+ api_instance = Brevo::UserApi.new
321
+
322
+ action = 'action_example' # String | action
323
+
324
+ email = 'email_example' # String | Email of the invited user.
325
+
326
+
327
+ begin
328
+ #Resend / Cancel invitation
329
+ result = api_instance.putresendcancelinvitation(action, email)
330
+ p result
331
+ rescue Brevo::ApiError => e
332
+ puts "Exception when calling UserApi->putresendcancelinvitation: #{e}"
333
+ end
334
+ ```
335
+
336
+ ### Parameters
337
+
338
+ Name | Type | Description | Notes
339
+ ------------- | ------------- | ------------- | -------------
340
+ **action** | **String**| action |
341
+ **email** | **String**| Email of the invited user. |
342
+
343
+ ### Return type
344
+
345
+ [**Putresendcancelinvitation**](Putresendcancelinvitation.md)
346
+
347
+ ### Authorization
348
+
349
+ [api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
350
+
351
+ ### HTTP request headers
352
+
353
+ - **Content-Type**: application/json
354
+ - **Accept**: application/json
355
+
356
+
357
+
data/docs/WebhooksApi.md CHANGED
@@ -6,7 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
8
8
  [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
9
- [**export_webhooks_history**](WebhooksApi.md#export_webhooks_history) | **POST** /webhooks/export | Export all transactional events
9
+ [**export_webhooks_history**](WebhooksApi.md#export_webhooks_history) | **POST** /webhooks/export | Export all webhook events
10
10
  [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
11
11
  [**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get all webhooks
12
12
  [**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks/{webhookId} | Update a webhook
@@ -128,9 +128,9 @@ nil (empty response body)
128
128
  # **export_webhooks_history**
129
129
  > CreatedProcessId export_webhooks_history(export_webhook_history)
130
130
 
131
- Export all transactional events
131
+ Export all webhook events
132
132
 
133
- This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download that CSV file will send to the webhook link provided in notifyURL of the body payload.
133
+ This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.
134
134
 
135
135
  ### Example
136
136
  ```ruby
@@ -155,7 +155,7 @@ export_webhook_history = Brevo::ExportWebhooksHistory.new # ExportWebhooksHistor
155
155
 
156
156
 
157
157
  begin
158
- #Export all transactional events
158
+ #Export all webhook events
159
159
  result = api_instance.export_webhooks_history(export_webhook_history)
160
160
  p result
161
161
  rescue Brevo::ApiError => e