brevo 2.0.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +56 -4
- data/docs/Body.md +2 -3
- data/docs/Body1.md +2 -3
- data/docs/Body10.md +10 -4
- data/docs/Body11.md +6 -1
- data/docs/Body12.md +1 -4
- data/docs/Body13.md +11 -0
- data/docs/Body14.md +8 -0
- data/docs/Body15.md +11 -0
- data/docs/Body2.md +1 -4
- data/docs/Body3.md +3 -2
- data/docs/Body4.md +3 -2
- data/docs/Body5.md +4 -4
- data/docs/Body6.md +2 -11
- data/docs/Body7.md +2 -10
- data/docs/Body8.md +4 -6
- data/docs/Body9.md +11 -1
- data/docs/CompaniesApi.md +8 -8
- data/docs/ContactsApi.md +14 -4
- data/docs/ConversationsApi.md +10 -10
- data/docs/ConversionSourceMetrics.md +12 -0
- data/docs/ConversionSourceProduct.md +15 -0
- data/docs/CorporateGroupDetailsResponse.md +10 -0
- data/docs/CorporateGroupDetailsResponseGroup.md +10 -0
- data/docs/CorporateGroupDetailsResponseSubaccounts.md +10 -0
- data/docs/CorporateGroupDetailsResponseUsers.md +10 -0
- data/docs/CouponsApi.md +12 -9
- data/docs/CreateContact.md +1 -1
- data/docs/CreateCouponCollection.md +5 -2
- data/docs/CreateDomainModel.md +1 -0
- data/docs/CreateDomainModelDnsRecords.md +1 -0
- data/docs/CreateWebhook.md +3 -0
- data/docs/CreateWhatsAppTemplate.md +1 -0
- data/docs/DealsApi.md +10 -10
- data/docs/EcommerceApi.md +261 -2
- data/docs/EmailCampaignsApi.md +1 -3
- data/docs/Event.md +12 -0
- data/docs/EventIdentifiers.md +12 -0
- data/docs/EventsApi.md +67 -0
- data/docs/ExportWebhooksHistory.md +2 -1
- data/docs/ExternalFeedsApi.md +2 -2
- data/docs/GetContactDetails.md +1 -1
- data/docs/GetCorporateInvitedUsersList.md +8 -0
- data/docs/GetCorporateInvitedUsersListFeatureAccess.md +11 -0
- data/docs/GetCorporateInvitedUsersListGroups.md +9 -0
- data/docs/GetCorporateInvitedUsersListUsers.md +12 -0
- data/docs/GetCorporateUserPermission.md +11 -0
- data/docs/GetCorporateUserPermissionFeatureAccess.md +11 -0
- data/docs/GetCorporateUserPermissionGroups.md +9 -0
- data/docs/GetCouponCollection.md +9 -6
- data/docs/GetExtendedContactDetails.md +1 -1
- data/docs/GetOrders.md +9 -0
- data/docs/GetWebhook.md +3 -0
- data/docs/GetWebhookAuth.md +9 -0
- data/docs/GetWebhookHeaders.md +9 -0
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +2 -3
- data/docs/InlineResponse2002.md +8 -0
- data/docs/InlineResponse2003.md +10 -0
- data/docs/InlineResponse201.md +1 -1
- data/docs/InlineResponse2011.md +1 -1
- data/docs/InlineResponse2012.md +1 -1
- data/docs/InlineResponse2013.md +1 -1
- data/docs/InlineResponse2014.md +1 -1
- data/docs/InlineResponse2015.md +8 -0
- data/docs/InviteAdminUser.md +11 -0
- data/docs/InviteAdminUserPrivileges.md +9 -0
- data/docs/Inviteuser.md +10 -0
- data/docs/InviteuserPrivileges.md +9 -0
- data/docs/MasterAccountApi.md +828 -117
- data/docs/MasterDetailsResponsePlanInfoFeatures.md +2 -0
- data/docs/OrderBatch.md +1 -0
- data/docs/PutRevokeUserPermission.md +8 -0
- data/docs/Putresendcancelinvitation.md +8 -0
- data/docs/RequestContactImport.md +1 -0
- data/docs/SendSmtpEmail.md +18 -19
- data/docs/SendSmtpEmailMessageVersions.md +2 -0
- data/docs/SendWhatsappMessage.md +1 -0
- data/docs/SsoTokenRequestCorporate.md +8 -0
- data/docs/SubAccountAppsToggleRequest.md +1 -1
- data/docs/SubAccountUpdatePlanRequestFeatures.md +2 -2
- data/docs/TasksApi.md +8 -8
- data/docs/TransactionalEmailsApi.md +7 -7
- data/docs/TransactionalWhatsAppApi.md +2 -2
- data/docs/UpdateContact.md +1 -1
- data/docs/UpdateCouponCollection.md +4 -1
- data/docs/UpdateWebhook.md +3 -0
- data/docs/UserApi.md +239 -0
- data/docs/WebhooksApi.md +4 -4
- data/docs/WhatsAppCampaignsApi.md +3 -1
- data/lib/brevo/api/companies_api.rb +3 -3
- data/lib/brevo/api/contacts_api.rb +14 -2
- data/lib/brevo/api/conversations_api.rb +2 -2
- data/lib/brevo/api/coupons_api.rb +15 -16
- data/lib/brevo/api/deals_api.rb +5 -5
- data/lib/brevo/api/ecommerce_api.rb +250 -0
- data/lib/brevo/api/email_campaigns_api.rb +0 -3
- data/lib/brevo/api/events_api.rb +86 -0
- data/lib/brevo/api/external_feeds_api.rb +3 -3
- data/lib/brevo/api/master_account_api.rb +652 -4
- data/lib/brevo/api/tasks_api.rb +5 -5
- data/lib/brevo/api/transactional_emails_api.rb +11 -11
- data/lib/brevo/api/transactional_whats_app_api.rb +3 -3
- data/lib/brevo/api/user_api.rb +222 -0
- data/lib/brevo/api/webhooks_api.rb +4 -4
- data/lib/brevo/api/whats_app_campaigns_api.rb +6 -0
- data/lib/brevo/models/body.rb +20 -28
- data/lib/brevo/models/body_1.rb +22 -25
- data/lib/brevo/models/body_10.rb +95 -39
- data/lib/brevo/models/body_11.rb +60 -5
- data/lib/brevo/models/body_12.rb +13 -38
- data/lib/brevo/models/body_13.rb +225 -0
- data/lib/brevo/models/body_14.rb +190 -0
- data/lib/brevo/models/body_15.rb +215 -0
- data/lib/brevo/models/body_2.rb +14 -45
- data/lib/brevo/models/body_3.rb +16 -6
- data/lib/brevo/models/body_4.rb +16 -6
- data/lib/brevo/models/body_5.rb +19 -19
- data/lib/brevo/models/body_6.rb +9 -129
- data/lib/brevo/models/body_7.rb +9 -95
- data/lib/brevo/models/body_8.rb +37 -59
- data/lib/brevo/models/body_9.rb +141 -11
- data/lib/brevo/models/conversion_source_metrics.rb +279 -0
- data/lib/brevo/models/conversion_source_product.rb +252 -0
- data/lib/brevo/models/corporate_group_details_response.rb +206 -0
- data/lib/brevo/models/corporate_group_details_response_group.rb +205 -0
- data/lib/brevo/models/corporate_group_details_response_subaccounts.rb +205 -0
- data/lib/brevo/models/corporate_group_details_response_users.rb +205 -0
- data/lib/brevo/models/create_contact.rb +1 -1
- data/lib/brevo/models/create_coupon_collection.rb +37 -7
- data/lib/brevo/models/create_domain_model.rb +11 -1
- data/lib/brevo/models/create_domain_model_dns_records.rb +13 -4
- data/lib/brevo/models/create_webhook.rb +35 -4
- data/lib/brevo/models/create_whats_app_template.rb +28 -6
- data/lib/brevo/models/event.rb +234 -0
- data/lib/brevo/models/event_identifiers.rb +236 -0
- data/lib/brevo/models/export_webhooks_history.rb +31 -4
- data/lib/brevo/models/get_contact_details.rb +0 -5
- data/lib/brevo/models/get_corporate_invited_users_list.rb +187 -0
- data/lib/brevo/models/get_corporate_invited_users_list_feature_access.rb +224 -0
- data/lib/brevo/models/get_corporate_invited_users_list_groups.rb +196 -0
- data/lib/brevo/models/get_corporate_invited_users_list_users.rb +248 -0
- data/lib/brevo/models/get_corporate_user_permission.rb +236 -0
- data/lib/brevo/models/get_corporate_user_permission_feature_access.rb +224 -0
- data/lib/brevo/models/get_corporate_user_permission_groups.rb +196 -0
- data/lib/brevo/models/get_coupon_collection.rb +40 -10
- data/lib/brevo/models/get_extended_contact_details.rb +0 -5
- data/lib/brevo/models/get_orders.rb +196 -0
- data/lib/brevo/models/get_webhook.rb +35 -4
- data/lib/brevo/models/get_webhook_auth.rb +196 -0
- data/lib/brevo/models/get_webhook_headers.rb +195 -0
- data/lib/brevo/models/inline_response_200.rb +7 -14
- data/lib/brevo/models/inline_response_200_1.rb +9 -34
- data/lib/brevo/models/inline_response_200_2.rb +191 -0
- data/lib/brevo/models/inline_response_200_3.rb +215 -0
- data/lib/brevo/models/inline_response_201.rb +0 -7
- data/lib/brevo/models/inline_response_201_1.rb +2 -2
- data/lib/brevo/models/inline_response_201_2.rb +2 -1
- data/lib/brevo/models/inline_response_201_3.rb +11 -11
- data/lib/brevo/models/inline_response_201_4.rb +11 -11
- data/lib/brevo/models/inline_response_201_5.rb +190 -0
- data/lib/brevo/models/invite_admin_user.rb +233 -0
- data/lib/brevo/models/invite_admin_user_privileges.rb +232 -0
- data/lib/brevo/models/inviteuser.rb +221 -0
- data/lib/brevo/models/inviteuser_privileges.rb +232 -0
- data/lib/brevo/models/master_details_response_plan_info_features.rb +21 -1
- data/lib/brevo/models/order_batch.rb +16 -4
- data/lib/brevo/models/put_revoke_user_permission.rb +191 -0
- data/lib/brevo/models/putresendcancelinvitation.rb +191 -0
- data/lib/brevo/models/request_contact_import.rb +13 -1
- data/lib/brevo/models/send_smtp_email_message_versions.rb +24 -4
- data/lib/brevo/models/send_whatsapp_message.rb +11 -1
- data/lib/brevo/models/sso_token_request_corporate.rb +190 -0
- data/lib/brevo/models/sub_account_apps_toggle_request.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_features_inbox.rb +1 -1
- data/lib/brevo/models/sub_account_details_response_plan_info_features_landing_page.rb +1 -1
- data/lib/brevo/models/sub_account_update_plan_request_features.rb +2 -2
- data/lib/brevo/models/update_contact.rb +1 -1
- data/lib/brevo/models/update_coupon_collection.rb +34 -9
- data/lib/brevo/models/update_webhook.rb +35 -4
- data/lib/brevo/version.rb +1 -1
- data/lib/brevo.rb +32 -0
- data/spec/api/companies_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +5 -1
- data/spec/api/conversations_api_spec.rb +1 -1
- data/spec/api/coupons_api_spec.rb +4 -3
- data/spec/api/deals_api_spec.rb +2 -2
- data/spec/api/ecommerce_api_spec.rb +57 -0
- data/spec/api/email_campaigns_api_spec.rb +0 -1
- data/spec/api/events_api_spec.rb +47 -0
- data/spec/api/external_feeds_api_spec.rb +1 -1
- data/spec/api/master_account_api_spec.rb +145 -1
- data/spec/api/tasks_api_spec.rb +2 -2
- data/spec/api/transactional_emails_api_spec.rb +3 -3
- data/spec/api/transactional_whats_app_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +47 -0
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/api/whats_app_campaigns_api_spec.rb +1 -0
- data/spec/models/body_10_spec.rb +40 -4
- data/spec/models/body_11_spec.rb +30 -0
- data/spec/models/body_12_spec.rb +1 -19
- data/spec/models/body_13_spec.rb +59 -0
- data/spec/models/body_14_spec.rb +41 -0
- data/spec/models/body_15_spec.rb +59 -0
- data/spec/models/body_1_spec.rb +2 -8
- data/spec/models/body_2_spec.rb +1 -19
- data/spec/models/body_3_spec.rb +6 -0
- data/spec/models/body_4_spec.rb +6 -0
- data/spec/models/body_5_spec.rb +2 -2
- data/spec/models/body_6_spec.rb +1 -55
- data/spec/models/body_7_spec.rb +1 -49
- data/spec/models/body_8_spec.rb +4 -16
- data/spec/models/body_9_spec.rb +61 -1
- data/spec/models/body_spec.rb +2 -8
- data/spec/models/conversion_source_metrics_spec.rb +69 -0
- data/spec/models/conversion_source_product_spec.rb +83 -0
- data/spec/models/corporate_group_details_response_group_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_subaccounts_spec.rb +53 -0
- data/spec/models/corporate_group_details_response_users_spec.rb +53 -0
- data/spec/models/create_coupon_collection_spec.rb +18 -0
- data/spec/models/create_domain_model_dns_records_spec.rb +6 -0
- data/spec/models/create_domain_model_spec.rb +6 -0
- data/spec/models/create_webhook_spec.rb +18 -0
- data/spec/models/create_whats_app_template_spec.rb +11 -1
- data/spec/models/event_identifiers_spec.rb +65 -0
- data/spec/models/event_spec.rb +65 -0
- data/spec/models/export_webhooks_history_spec.rb +11 -1
- data/spec/models/get_corporate_invited_users_list_feature_access_spec.rb +59 -0
- data/spec/models/get_corporate_invited_users_list_groups_spec.rb +47 -0
- data/spec/models/get_corporate_invited_users_list_spec.rb +41 -0
- data/spec/models/get_corporate_invited_users_list_users_spec.rb +65 -0
- data/spec/models/get_corporate_user_permission_feature_access_spec.rb +59 -0
- data/spec/models/get_corporate_user_permission_groups_spec.rb +47 -0
- data/spec/models/get_corporate_user_permission_spec.rb +59 -0
- data/spec/models/get_coupon_collection_spec.rb +18 -0
- data/spec/models/get_orders_spec.rb +47 -0
- data/spec/models/get_webhook_auth_spec.rb +47 -0
- data/spec/models/get_webhook_headers_spec.rb +47 -0
- data/spec/models/get_webhook_spec.rb +18 -0
- data/spec/models/inline_response_200_1_spec.rb +1 -7
- data/spec/models/inline_response_200_2_spec.rb +41 -0
- data/spec/models/inline_response_200_3_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +1 -1
- data/spec/models/inline_response_201_3_spec.rb +1 -1
- data/spec/models/inline_response_201_4_spec.rb +1 -1
- data/spec/models/inline_response_201_5_spec.rb +41 -0
- data/spec/models/invite_admin_user_privileges_spec.rb +55 -0
- data/spec/models/invite_admin_user_spec.rb +59 -0
- data/spec/models/inviteuser_privileges_spec.rb +55 -0
- data/spec/models/inviteuser_spec.rb +53 -0
- data/spec/models/master_details_response_plan_info_features_spec.rb +12 -0
- data/spec/models/order_batch_spec.rb +6 -0
- data/spec/models/put_revoke_user_permission_spec.rb +41 -0
- data/spec/models/putresendcancelinvitation_spec.rb +41 -0
- data/spec/models/request_contact_import_spec.rb +6 -0
- data/spec/models/send_smtp_email_message_versions_spec.rb +12 -0
- data/spec/models/send_whatsapp_message_spec.rb +6 -0
- data/spec/models/sso_token_request_corporate_spec.rb +41 -0
- data/spec/models/update_coupon_collection_spec.rb +18 -0
- data/spec/models/update_webhook_spec.rb +18 -0
- metadata +152 -24
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 74b0475868605a4c0adb5383065e179e81a68ad9b119e0c2d25b0ca7181d9e6b
|
4
|
+
data.tar.gz: 9fda4b6c278299d175ed52168457a4014bfa162e41f79c5e7592cb32bfa62c16
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 190d0d947ecb571f4ed078a567d79acb56d227238e24ba18766e5663d8233c3c241229ed4087a1ac9ab0cb82e5b01e0b35b0cd2b2e688858a41149f62a6e60d4
|
7
|
+
data.tar.gz: c0337bdbcbecfb7b33e03a883df12e6629bc39f1a5eace27d5e57f211fe3d3791441fb3894776b4c800a2d16b24e60f5e42ca104d6de9f569d50d3f799a7e59f
|
data/README.md
CHANGED
@@ -4,7 +4,7 @@ Brevo's API exposes the entire Brevo features via a standardized programmatic in
|
|
4
4
|
|
5
5
|
This is the wrapper for the API. It implements all the features of the API v3.
|
6
6
|
|
7
|
-
Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/
|
7
|
+
Brevo's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded [here](https://api.brevo.com/v3/swagger_definition_v3.yml).
|
8
8
|
|
9
9
|
This RUBY package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by Brevo:
|
10
10
|
|
@@ -157,8 +157,12 @@ Class | Method | HTTP request | Description
|
|
157
157
|
*Brevo::EcommerceApi* | [**create_update_category**](docs/EcommerceApi.md#create_update_category) | **POST** /categories | Create/Update a category
|
158
158
|
*Brevo::EcommerceApi* | [**create_update_product**](docs/EcommerceApi.md#create_update_product) | **POST** /products | Create/Update a product
|
159
159
|
*Brevo::EcommerceApi* | [**ecommerce_activate_post**](docs/EcommerceApi.md#ecommerce_activate_post) | **POST** /ecommerce/activate | Activate the eCommerce app
|
160
|
+
*Brevo::EcommerceApi* | [**ecommerce_attribution_metrics_conversion_source_conversion_source_id_get**](docs/EcommerceApi.md#ecommerce_attribution_metrics_conversion_source_conversion_source_id_get) | **GET** /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId} | Get detailed attribution metrics for a single Brevo campaign
|
161
|
+
*Brevo::EcommerceApi* | [**ecommerce_attribution_metrics_get**](docs/EcommerceApi.md#ecommerce_attribution_metrics_get) | **GET** /ecommerce/attribution/metrics | Get attribution metrics for one or more Brevo campaigns
|
162
|
+
*Brevo::EcommerceApi* | [**ecommerce_attribution_products_conversion_source_conversion_source_id_get**](docs/EcommerceApi.md#ecommerce_attribution_products_conversion_source_conversion_source_id_get) | **GET** /ecommerce/attribution/products/{conversionSource}/{conversionSourceId} | Get attributed product sales for a single Brevo campaign
|
160
163
|
*Brevo::EcommerceApi* | [**get_categories**](docs/EcommerceApi.md#get_categories) | **GET** /categories | Return all your categories
|
161
164
|
*Brevo::EcommerceApi* | [**get_category_info**](docs/EcommerceApi.md#get_category_info) | **GET** /categories/{id} | Get a category details
|
165
|
+
*Brevo::EcommerceApi* | [**get_orders**](docs/EcommerceApi.md#get_orders) | **GET** /orders | Get order details
|
162
166
|
*Brevo::EcommerceApi* | [**get_product_info**](docs/EcommerceApi.md#get_product_info) | **GET** /products/{id} | Get a product's details
|
163
167
|
*Brevo::EcommerceApi* | [**get_products**](docs/EcommerceApi.md#get_products) | **GET** /products | Return all your products
|
164
168
|
*Brevo::EmailCampaignsApi* | [**create_email_campaign**](docs/EmailCampaignsApi.md#create_email_campaign) | **POST** /emailCampaigns | Create an email campaign
|
@@ -174,6 +178,7 @@ Class | Method | HTTP request | Description
|
|
174
178
|
*Brevo::EmailCampaignsApi* | [**update_campaign_status**](docs/EmailCampaignsApi.md#update_campaign_status) | **PUT** /emailCampaigns/{campaignId}/status | Update an email campaign status
|
175
179
|
*Brevo::EmailCampaignsApi* | [**update_email_campaign**](docs/EmailCampaignsApi.md#update_email_campaign) | **PUT** /emailCampaigns/{campaignId} | Update an email campaign
|
176
180
|
*Brevo::EmailCampaignsApi* | [**upload_image_to_gallery**](docs/EmailCampaignsApi.md#upload_image_to_gallery) | **POST** /emailCampaigns/images | Upload an image to your account's image gallery
|
181
|
+
*Brevo::EventsApi* | [**create_event**](docs/EventsApi.md#create_event) | **POST** /events | Create an event
|
177
182
|
*Brevo::ExternalFeedsApi* | [**create_external_feed**](docs/ExternalFeedsApi.md#create_external_feed) | **POST** /feeds | Create an external feed
|
178
183
|
*Brevo::ExternalFeedsApi* | [**delete_external_feed**](docs/ExternalFeedsApi.md#delete_external_feed) | **DELETE** /feeds/{uuid} | Delete an external feed
|
179
184
|
*Brevo::ExternalFeedsApi* | [**get_all_external_feeds**](docs/ExternalFeedsApi.md#get_all_external_feeds) | **GET** /feeds | Fetch all external feeds
|
@@ -187,7 +192,13 @@ Class | Method | HTTP request | Description
|
|
187
192
|
*Brevo::InboundParsingApi* | [**get_inbound_email_attachment**](docs/InboundParsingApi.md#get_inbound_email_attachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
|
188
193
|
*Brevo::InboundParsingApi* | [**get_inbound_email_events**](docs/InboundParsingApi.md#get_inbound_email_events) | **GET** /inbound/events | Get the list of all the events for the received emails.
|
189
194
|
*Brevo::InboundParsingApi* | [**get_inbound_email_events_by_uuid**](docs/InboundParsingApi.md#get_inbound_email_events_by_uuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
|
195
|
+
*Brevo::MasterAccountApi* | [**corporate_group_id_delete**](docs/MasterAccountApi.md#corporate_group_id_delete) | **DELETE** /corporate/group/{id} | Delete a group
|
196
|
+
*Brevo::MasterAccountApi* | [**corporate_group_id_get**](docs/MasterAccountApi.md#corporate_group_id_get) | **GET** /corporate/group/{id} | GET a group details
|
197
|
+
*Brevo::MasterAccountApi* | [**corporate_group_id_put**](docs/MasterAccountApi.md#corporate_group_id_put) | **PUT** /corporate/group/{id} | Update a group of sub-accounts
|
198
|
+
*Brevo::MasterAccountApi* | [**corporate_group_post**](docs/MasterAccountApi.md#corporate_group_post) | **POST** /corporate/group | Create a new group of sub-accounts
|
199
|
+
*Brevo::MasterAccountApi* | [**corporate_group_unlink_group_id_sub_accounts_put**](docs/MasterAccountApi.md#corporate_group_unlink_group_id_sub_accounts_put) | **PUT** /corporate/group/unlink/{groupId}/subAccounts | Delete sub-account from group
|
190
200
|
*Brevo::MasterAccountApi* | [**corporate_master_account_get**](docs/MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
|
201
|
+
*Brevo::MasterAccountApi* | [**corporate_sso_token_post**](docs/MasterAccountApi.md#corporate_sso_token_post) | **POST** /corporate/ssoToken | Generate SSO token to access admin account
|
191
202
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_get**](docs/MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
|
192
203
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_id_applications_toggle_put**](docs/MasterAccountApi.md#corporate_sub_account_id_applications_toggle_put) | **PUT** /corporate/subAccount/{id}/applications/toggle | Enable/disable sub-account application(s)
|
193
204
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_id_delete**](docs/MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
|
@@ -195,8 +206,14 @@ Class | Method | HTTP request | Description
|
|
195
206
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_id_plan_put**](docs/MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
|
196
207
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_key_post**](docs/MasterAccountApi.md#corporate_sub_account_key_post) | **POST** /corporate/subAccount/key | Create an API key for a sub-account
|
197
208
|
*Brevo::MasterAccountApi* | [**corporate_sub_account_post**](docs/MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
|
198
|
-
*Brevo::MasterAccountApi* | [**corporate_sub_account_sso_token_post**](docs/MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access
|
209
|
+
*Brevo::MasterAccountApi* | [**corporate_sub_account_sso_token_post**](docs/MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access sub-account
|
210
|
+
*Brevo::MasterAccountApi* | [**corporate_user_invitation_action_email_put**](docs/MasterAccountApi.md#corporate_user_invitation_action_email_put) | **PUT** /corporate/user/invitation/{action}/{email} | Resend / cancel admin user invitation
|
211
|
+
*Brevo::MasterAccountApi* | [**corporate_user_revoke_email_delete**](docs/MasterAccountApi.md#corporate_user_revoke_email_delete) | **DELETE** /corporate/user/revoke/{email} | Revoke an admin user
|
199
212
|
*Brevo::MasterAccountApi* | [**get_account_activity**](docs/MasterAccountApi.md#get_account_activity) | **GET** /organization/activities | Get user activity logs
|
213
|
+
*Brevo::MasterAccountApi* | [**get_corporate_invited_users_list**](docs/MasterAccountApi.md#get_corporate_invited_users_list) | **GET** /corporate/invited/users | Get the list of all admin users
|
214
|
+
*Brevo::MasterAccountApi* | [**get_corporate_user_permission**](docs/MasterAccountApi.md#get_corporate_user_permission) | **GET** /corporate/user/{email}/permissions | Check admin user permissions
|
215
|
+
*Brevo::MasterAccountApi* | [**get_sub_account_groups**](docs/MasterAccountApi.md#get_sub_account_groups) | **GET** /corporate/groups | Get the list of groups
|
216
|
+
*Brevo::MasterAccountApi* | [**invite_admin_user**](docs/MasterAccountApi.md#invite_admin_user) | **POST** /corporate/user/invitation/send | Send invitation to an admin user
|
200
217
|
*Brevo::NotesApi* | [**crm_notes_get**](docs/NotesApi.md#crm_notes_get) | **GET** /crm/notes | Get all notes
|
201
218
|
*Brevo::NotesApi* | [**crm_notes_id_delete**](docs/NotesApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
|
202
219
|
*Brevo::NotesApi* | [**crm_notes_id_get**](docs/NotesApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
|
@@ -263,7 +280,7 @@ Class | Method | HTTP request | Description
|
|
263
280
|
*Brevo::TransactionalEmailsApi* | [**send_test_template**](docs/TransactionalEmailsApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
|
264
281
|
*Brevo::TransactionalEmailsApi* | [**send_transac_email**](docs/TransactionalEmailsApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
|
265
282
|
*Brevo::TransactionalEmailsApi* | [**smtp_blocked_contacts_email_delete**](docs/TransactionalEmailsApi.md#smtp_blocked_contacts_email_delete) | **DELETE** /smtp/blockedContacts/{email} | Unblock or resubscribe a transactional contact
|
266
|
-
*Brevo::TransactionalEmailsApi* | [**
|
283
|
+
*Brevo::TransactionalEmailsApi* | [**smtp_log_identifier_delete**](docs/TransactionalEmailsApi.md#smtp_log_identifier_delete) | **DELETE** /smtp/log/{identifier} | Delete an SMTP transactional log
|
267
284
|
*Brevo::TransactionalEmailsApi* | [**update_smtp_template**](docs/TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template
|
268
285
|
*Brevo::TransactionalSMSApi* | [**get_sms_events**](docs/TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events)
|
269
286
|
*Brevo::TransactionalSMSApi* | [**get_transac_aggregated_sms_report**](docs/TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
|
@@ -271,11 +288,15 @@ Class | Method | HTTP request | Description
|
|
271
288
|
*Brevo::TransactionalSMSApi* | [**send_transac_sms**](docs/TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send SMS message to a mobile number
|
272
289
|
*Brevo::TransactionalWhatsAppApi* | [**get_whatsapp_event_report**](docs/TransactionalWhatsAppApi.md#get_whatsapp_event_report) | **GET** /whatsapp/statistics/events | Get all your WhatsApp activity (unaggregated events)
|
273
290
|
*Brevo::TransactionalWhatsAppApi* | [**send_whatsapp_message**](docs/TransactionalWhatsAppApi.md#send_whatsapp_message) | **POST** /whatsapp/sendMessage | Send a WhatsApp message
|
291
|
+
*Brevo::UserApi* | [**edit_user_permission**](docs/UserApi.md#edit_user_permission) | **POST** /organization/user/update/permissions | Update permission for a user
|
274
292
|
*Brevo::UserApi* | [**get_invited_users_list**](docs/UserApi.md#get_invited_users_list) | **GET** /organization/invited/users | Get the list of all your users
|
275
293
|
*Brevo::UserApi* | [**get_user_permission**](docs/UserApi.md#get_user_permission) | **GET** /organization/user/{email}/permissions | Check user permission
|
294
|
+
*Brevo::UserApi* | [**inviteuser**](docs/UserApi.md#inviteuser) | **POST** /organization/user/invitation/send | Send invitation to user
|
295
|
+
*Brevo::UserApi* | [**put_revoke_user_permission**](docs/UserApi.md#put_revoke_user_permission) | **PUT** /organization/user/invitation/revoke/{email} | Revoke user permission
|
296
|
+
*Brevo::UserApi* | [**putresendcancelinvitation**](docs/UserApi.md#putresendcancelinvitation) | **PUT** /organization/user/invitation/{action}/{email} | Resend / Cancel invitation
|
276
297
|
*Brevo::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
|
277
298
|
*Brevo::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
|
278
|
-
*Brevo::WebhooksApi* | [**export_webhooks_history**](docs/WebhooksApi.md#export_webhooks_history) | **POST** /webhooks/export | Export all
|
299
|
+
*Brevo::WebhooksApi* | [**export_webhooks_history**](docs/WebhooksApi.md#export_webhooks_history) | **POST** /webhooks/export | Export all webhook events
|
279
300
|
*Brevo::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
|
280
301
|
*Brevo::WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get all webhooks
|
281
302
|
*Brevo::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks/{webhookId} | Update a webhook
|
@@ -308,6 +329,9 @@ Class | Method | HTTP request | Description
|
|
308
329
|
- [Brevo::Body10](docs/Body10.md)
|
309
330
|
- [Brevo::Body11](docs/Body11.md)
|
310
331
|
- [Brevo::Body12](docs/Body12.md)
|
332
|
+
- [Brevo::Body13](docs/Body13.md)
|
333
|
+
- [Brevo::Body14](docs/Body14.md)
|
334
|
+
- [Brevo::Body15](docs/Body15.md)
|
311
335
|
- [Brevo::Body2](docs/Body2.md)
|
312
336
|
- [Brevo::Body3](docs/Body3.md)
|
313
337
|
- [Brevo::Body4](docs/Body4.md)
|
@@ -325,6 +349,12 @@ Class | Method | HTTP request | Description
|
|
325
349
|
- [Brevo::ConversationsMessage](docs/ConversationsMessage.md)
|
326
350
|
- [Brevo::ConversationsMessageFile](docs/ConversationsMessageFile.md)
|
327
351
|
- [Brevo::ConversationsMessageFileImageInfo](docs/ConversationsMessageFileImageInfo.md)
|
352
|
+
- [Brevo::ConversionSourceMetrics](docs/ConversionSourceMetrics.md)
|
353
|
+
- [Brevo::ConversionSourceProduct](docs/ConversionSourceProduct.md)
|
354
|
+
- [Brevo::CorporateGroupDetailsResponse](docs/CorporateGroupDetailsResponse.md)
|
355
|
+
- [Brevo::CorporateGroupDetailsResponseGroup](docs/CorporateGroupDetailsResponseGroup.md)
|
356
|
+
- [Brevo::CorporateGroupDetailsResponseSubaccounts](docs/CorporateGroupDetailsResponseSubaccounts.md)
|
357
|
+
- [Brevo::CorporateGroupDetailsResponseUsers](docs/CorporateGroupDetailsResponseUsers.md)
|
328
358
|
- [Brevo::CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
329
359
|
- [Brevo::CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
|
330
360
|
- [Brevo::CreateAttribute](docs/CreateAttribute.md)
|
@@ -380,6 +410,8 @@ Class | Method | HTTP request | Description
|
|
380
410
|
- [Brevo::DeleteHardbounces](docs/DeleteHardbounces.md)
|
381
411
|
- [Brevo::EmailExportRecipients](docs/EmailExportRecipients.md)
|
382
412
|
- [Brevo::ErrorModel](docs/ErrorModel.md)
|
413
|
+
- [Brevo::Event](docs/Event.md)
|
414
|
+
- [Brevo::EventIdentifiers](docs/EventIdentifiers.md)
|
383
415
|
- [Brevo::ExportWebhooksHistory](docs/ExportWebhooksHistory.md)
|
384
416
|
- [Brevo::FileData](docs/FileData.md)
|
385
417
|
- [Brevo::FileDownloadableLink](docs/FileDownloadableLink.md)
|
@@ -421,6 +453,13 @@ Class | Method | HTTP request | Description
|
|
421
453
|
- [Brevo::GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
|
422
454
|
- [Brevo::GetContactDetails](docs/GetContactDetails.md)
|
423
455
|
- [Brevo::GetContacts](docs/GetContacts.md)
|
456
|
+
- [Brevo::GetCorporateInvitedUsersList](docs/GetCorporateInvitedUsersList.md)
|
457
|
+
- [Brevo::GetCorporateInvitedUsersListFeatureAccess](docs/GetCorporateInvitedUsersListFeatureAccess.md)
|
458
|
+
- [Brevo::GetCorporateInvitedUsersListGroups](docs/GetCorporateInvitedUsersListGroups.md)
|
459
|
+
- [Brevo::GetCorporateInvitedUsersListUsers](docs/GetCorporateInvitedUsersListUsers.md)
|
460
|
+
- [Brevo::GetCorporateUserPermission](docs/GetCorporateUserPermission.md)
|
461
|
+
- [Brevo::GetCorporateUserPermissionFeatureAccess](docs/GetCorporateUserPermissionFeatureAccess.md)
|
462
|
+
- [Brevo::GetCorporateUserPermissionGroups](docs/GetCorporateUserPermissionGroups.md)
|
424
463
|
- [Brevo::GetCouponCollection](docs/GetCouponCollection.md)
|
425
464
|
- [Brevo::GetDeviceBrowserStats](docs/GetDeviceBrowserStats.md)
|
426
465
|
- [Brevo::GetDomainConfigurationModel](docs/GetDomainConfigurationModel.md)
|
@@ -467,6 +506,7 @@ Class | Method | HTTP request | Description
|
|
467
506
|
- [Brevo::GetIpsFromSender](docs/GetIpsFromSender.md)
|
468
507
|
- [Brevo::GetList](docs/GetList.md)
|
469
508
|
- [Brevo::GetLists](docs/GetLists.md)
|
509
|
+
- [Brevo::GetOrders](docs/GetOrders.md)
|
470
510
|
- [Brevo::GetProcess](docs/GetProcess.md)
|
471
511
|
- [Brevo::GetProcesses](docs/GetProcesses.md)
|
472
512
|
- [Brevo::GetProductDetails](docs/GetProductDetails.md)
|
@@ -511,6 +551,8 @@ Class | Method | HTTP request | Description
|
|
511
551
|
- [Brevo::GetWATemplates](docs/GetWATemplates.md)
|
512
552
|
- [Brevo::GetWATemplatesTemplates](docs/GetWATemplatesTemplates.md)
|
513
553
|
- [Brevo::GetWebhook](docs/GetWebhook.md)
|
554
|
+
- [Brevo::GetWebhookAuth](docs/GetWebhookAuth.md)
|
555
|
+
- [Brevo::GetWebhookHeaders](docs/GetWebhookHeaders.md)
|
514
556
|
- [Brevo::GetWebhooks](docs/GetWebhooks.md)
|
515
557
|
- [Brevo::GetWhatsAppConfig](docs/GetWhatsAppConfig.md)
|
516
558
|
- [Brevo::GetWhatsappCampaignOverview](docs/GetWhatsappCampaignOverview.md)
|
@@ -520,11 +562,18 @@ Class | Method | HTTP request | Description
|
|
520
562
|
- [Brevo::GetWhatsappEventReportEvents](docs/GetWhatsappEventReportEvents.md)
|
521
563
|
- [Brevo::InlineResponse200](docs/InlineResponse200.md)
|
522
564
|
- [Brevo::InlineResponse2001](docs/InlineResponse2001.md)
|
565
|
+
- [Brevo::InlineResponse2002](docs/InlineResponse2002.md)
|
566
|
+
- [Brevo::InlineResponse2003](docs/InlineResponse2003.md)
|
523
567
|
- [Brevo::InlineResponse201](docs/InlineResponse201.md)
|
524
568
|
- [Brevo::InlineResponse2011](docs/InlineResponse2011.md)
|
525
569
|
- [Brevo::InlineResponse2012](docs/InlineResponse2012.md)
|
526
570
|
- [Brevo::InlineResponse2013](docs/InlineResponse2013.md)
|
527
571
|
- [Brevo::InlineResponse2014](docs/InlineResponse2014.md)
|
572
|
+
- [Brevo::InlineResponse2015](docs/InlineResponse2015.md)
|
573
|
+
- [Brevo::InviteAdminUser](docs/InviteAdminUser.md)
|
574
|
+
- [Brevo::InviteAdminUserPrivileges](docs/InviteAdminUserPrivileges.md)
|
575
|
+
- [Brevo::Inviteuser](docs/Inviteuser.md)
|
576
|
+
- [Brevo::InviteuserPrivileges](docs/InviteuserPrivileges.md)
|
528
577
|
- [Brevo::ManageIp](docs/ManageIp.md)
|
529
578
|
- [Brevo::MasterDetailsResponse](docs/MasterDetailsResponse.md)
|
530
579
|
- [Brevo::MasterDetailsResponseBillingInfo](docs/MasterDetailsResponseBillingInfo.md)
|
@@ -548,6 +597,8 @@ Class | Method | HTTP request | Description
|
|
548
597
|
- [Brevo::PostContactInfoContacts](docs/PostContactInfoContacts.md)
|
549
598
|
- [Brevo::PostSendFailed](docs/PostSendFailed.md)
|
550
599
|
- [Brevo::PostSendSmsTestFailed](docs/PostSendSmsTestFailed.md)
|
600
|
+
- [Brevo::PutRevokeUserPermission](docs/PutRevokeUserPermission.md)
|
601
|
+
- [Brevo::Putresendcancelinvitation](docs/Putresendcancelinvitation.md)
|
551
602
|
- [Brevo::RemainingCreditModel](docs/RemainingCreditModel.md)
|
552
603
|
- [Brevo::RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
|
553
604
|
- [Brevo::RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
|
@@ -578,6 +629,7 @@ Class | Method | HTTP request | Description
|
|
578
629
|
- [Brevo::SendTransacSms](docs/SendTransacSms.md)
|
579
630
|
- [Brevo::SendWhatsappMessage](docs/SendWhatsappMessage.md)
|
580
631
|
- [Brevo::SsoTokenRequest](docs/SsoTokenRequest.md)
|
632
|
+
- [Brevo::SsoTokenRequestCorporate](docs/SsoTokenRequestCorporate.md)
|
581
633
|
- [Brevo::SubAccountAppsToggleRequest](docs/SubAccountAppsToggleRequest.md)
|
582
634
|
- [Brevo::SubAccountDetailsResponse](docs/SubAccountDetailsResponse.md)
|
583
635
|
- [Brevo::SubAccountDetailsResponsePlanInfo](docs/SubAccountDetailsResponsePlanInfo.md)
|
data/docs/Body.md
CHANGED
@@ -3,8 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
8
|
-
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
|
6
|
+
**group_name** | **String** | The name of the group of sub-accounts |
|
7
|
+
**sub_account_ids** | **Array<Integer>** | Pass the list of sub-account Ids to be included in the group | [optional]
|
9
8
|
|
10
9
|
|
data/docs/Body1.md
CHANGED
@@ -3,8 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
8
|
-
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
|
6
|
+
**group_name** | **String** | The name of the group of sub-accounts |
|
7
|
+
**sub_account_ids** | **Array<Integer>** | Pass the list of sub-account Ids to be included in the group | [optional]
|
9
8
|
|
10
9
|
|
data/docs/Body10.md
CHANGED
@@ -3,9 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
6
|
+
**name** | **String** | Name of task | [optional]
|
7
|
+
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8
|
+
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
|
9
|
+
**date** | **DateTime** | Task date/time | [optional]
|
10
|
+
**notes** | **String** | Notes added to a task | [optional]
|
11
|
+
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
+
**assign_to_id** | **String** | To assign a task to a user you can use either the account email or ID. | [optional]
|
13
|
+
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
+
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
+
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
10
16
|
|
11
17
|
|
data/docs/Body11.md
CHANGED
@@ -3,6 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
7
|
+
**text** | **String** | message text |
|
8
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
9
|
+
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
|
10
|
+
**agent_email** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional]
|
11
|
+
**agent_name** | **String** | agent name | [optional]
|
7
12
|
|
8
13
|
|
data/docs/Body12.md
CHANGED
@@ -3,9 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
|
8
|
-
**agent_email** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. | [optional]
|
9
|
-
**agent_name** | **String** | agent name. | [optional]
|
6
|
+
**text** | **String** | edited message text |
|
10
7
|
|
11
8
|
|
data/docs/Body13.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# Brevo::Body13
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
|
7
|
+
**text** | **String** | message text |
|
8
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional]
|
9
|
+
**group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body14.md
ADDED
data/docs/Body15.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# Brevo::Body15
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
|
7
|
+
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
|
8
|
+
**agent_email** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically. | [optional]
|
9
|
+
**agent_name** | **String** | agent name. | [optional]
|
10
|
+
|
11
|
+
|
data/docs/Body2.md
CHANGED
@@ -3,9 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional]
|
8
|
-
**link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional]
|
9
|
-
**unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional]
|
6
|
+
**sub_account_ids** | **Array<Integer>** | List of sub-account ids |
|
10
7
|
|
11
8
|
|
data/docs/Body3.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**attributes** | **Object** | Attributes for
|
6
|
+
**name** | **String** | Name of company |
|
7
|
+
**attributes** | **Object** | Attributes for company creation | [optional]
|
8
|
+
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
|
8
9
|
|
9
10
|
|
data/docs/Body4.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**attributes** | **Object** | Attributes for
|
6
|
+
**name** | **String** | Name of company | [optional]
|
7
|
+
**attributes** | **Object** | Attributes for company update | [optional]
|
8
|
+
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
|
8
9
|
|
9
10
|
|
data/docs/Body5.md
CHANGED
@@ -3,9 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with
|
7
|
-
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from
|
8
|
-
**
|
9
|
-
**
|
6
|
+
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with company | [optional]
|
7
|
+
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional]
|
8
|
+
**link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional]
|
9
|
+
**unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional]
|
10
10
|
|
11
11
|
|
data/docs/Body6.md
CHANGED
@@ -3,16 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**
|
8
|
-
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
|
9
|
-
**date** | **DateTime** | Task due date and time |
|
10
|
-
**notes** | **String** | Notes added to a task | [optional]
|
11
|
-
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
-
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
-
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
-
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
-
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
-
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
|
6
|
+
**name** | **String** | Name of deal |
|
7
|
+
**attributes** | **Object** | Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
|
17
8
|
|
18
9
|
|
data/docs/Body7.md
CHANGED
@@ -3,15 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | Name of
|
7
|
-
**
|
8
|
-
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
|
9
|
-
**date** | **DateTime** | Task date/time | [optional]
|
10
|
-
**notes** | **String** | Notes added to a task | [optional]
|
11
|
-
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
-
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
|
13
|
-
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
-
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
-
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
6
|
+
**name** | **String** | Name of deal | [optional]
|
7
|
+
**attributes** | **Object** | Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
|
16
8
|
|
17
9
|
|
data/docs/Body8.md
CHANGED
@@ -3,11 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**agent_email** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional]
|
11
|
-
**agent_name** | **String** | agent name | [optional]
|
6
|
+
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with deal | [optional]
|
7
|
+
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from deal | [optional]
|
8
|
+
**link_company_ids** | **Array<String>** | Company ids to be linked with deal | [optional]
|
9
|
+
**unlink_company_ids** | **Array<String>** | Company ids to be unlinked from deal | [optional]
|
12
10
|
|
13
11
|
|
data/docs/Body9.md
CHANGED
@@ -3,6 +3,16 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**name** | **String** | Name of task |
|
7
|
+
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
|
8
|
+
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
|
9
|
+
**date** | **DateTime** | Task due date and time |
|
10
|
+
**notes** | **String** | Notes added to a task | [optional]
|
11
|
+
**done** | **BOOLEAN** | Task marked as done | [optional]
|
12
|
+
**assign_to_id** | **String** | To assign a task to a user you can use either the account email or ID. | [optional]
|
13
|
+
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
|
14
|
+
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
|
15
|
+
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
|
16
|
+
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
|
7
17
|
|
8
18
|
|
data/docs/CompaniesApi.md
CHANGED
@@ -273,7 +273,7 @@ api_instance = Brevo::CompaniesApi.new
|
|
273
273
|
|
274
274
|
id = 'id_example' # String |
|
275
275
|
|
276
|
-
body = Brevo::
|
276
|
+
body = Brevo::Body4.new # Body4 | Updated company details.
|
277
277
|
|
278
278
|
|
279
279
|
begin
|
@@ -290,7 +290,7 @@ end
|
|
290
290
|
Name | Type | Description | Notes
|
291
291
|
------------- | ------------- | ------------- | -------------
|
292
292
|
**id** | **String**| |
|
293
|
-
**body** | [**
|
293
|
+
**body** | [**Body4**](Body4.md)| Updated company details. |
|
294
294
|
|
295
295
|
### Return type
|
296
296
|
|
@@ -333,7 +333,7 @@ api_instance = Brevo::CompaniesApi.new
|
|
333
333
|
|
334
334
|
id = 'id_example' # String |
|
335
335
|
|
336
|
-
body = Brevo::
|
336
|
+
body = Brevo::Body5.new # Body5 | Linked / Unlinked contacts and deals ids.
|
337
337
|
|
338
338
|
|
339
339
|
begin
|
@@ -349,7 +349,7 @@ end
|
|
349
349
|
Name | Type | Description | Notes
|
350
350
|
------------- | ------------- | ------------- | -------------
|
351
351
|
**id** | **String**| |
|
352
|
-
**body** | [**
|
352
|
+
**body** | [**Body5**](Body5.md)| Linked / Unlinked contacts and deals ids. |
|
353
353
|
|
354
354
|
### Return type
|
355
355
|
|
@@ -367,7 +367,7 @@ nil (empty response body)
|
|
367
367
|
|
368
368
|
|
369
369
|
# **companies_post**
|
370
|
-
>
|
370
|
+
> InlineResponse2002 companies_post(body)
|
371
371
|
|
372
372
|
Create a company
|
373
373
|
|
@@ -390,7 +390,7 @@ end
|
|
390
390
|
|
391
391
|
api_instance = Brevo::CompaniesApi.new
|
392
392
|
|
393
|
-
body = Brevo::
|
393
|
+
body = Brevo::Body3.new # Body3 | Company create data.
|
394
394
|
|
395
395
|
|
396
396
|
begin
|
@@ -406,11 +406,11 @@ end
|
|
406
406
|
|
407
407
|
Name | Type | Description | Notes
|
408
408
|
------------- | ------------- | ------------- | -------------
|
409
|
-
**body** | [**
|
409
|
+
**body** | [**Body3**](Body3.md)| Company create data. |
|
410
410
|
|
411
411
|
### Return type
|
412
412
|
|
413
|
-
[**
|
413
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
414
414
|
|
415
415
|
### Authorization
|
416
416
|
|
data/docs/ContactsApi.md
CHANGED
@@ -819,7 +819,9 @@ opts = {
|
|
819
819
|
offset: 0, # Integer | Index of the first document of the page
|
820
820
|
modified_since: 'modified_since_example', # String | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
821
821
|
created_since: 'created_since_example', # String | Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
822
|
-
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
822
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
823
|
+
segment_id: 789, # Integer | Id of the segment. **Either listIds or segmentId can be passed.**
|
824
|
+
list_ids: [56] # Array<Integer> | Ids of the list. **Either listIds or segmentId can be passed.**
|
823
825
|
}
|
824
826
|
|
825
827
|
begin
|
@@ -840,6 +842,8 @@ Name | Type | Description | Notes
|
|
840
842
|
**modified_since** | **String**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
841
843
|
**created_since** | **String**| Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
|
842
844
|
**sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc]
|
845
|
+
**segment_id** | **Integer**| Id of the segment. **Either listIds or segmentId can be passed.** | [optional]
|
846
|
+
**list_ids** | [**Array<Integer>**](Integer.md)| Ids of the list. **Either listIds or segmentId can be passed.** | [optional]
|
843
847
|
|
844
848
|
### Return type
|
845
849
|
|
@@ -1110,7 +1114,7 @@ Name | Type | Description | Notes
|
|
1110
1114
|
|
1111
1115
|
|
1112
1116
|
# **get_list**
|
1113
|
-
> GetExtendedList get_list(list_id)
|
1117
|
+
> GetExtendedList get_list(list_id, opts)
|
1114
1118
|
|
1115
1119
|
Get a list's details
|
1116
1120
|
|
@@ -1135,10 +1139,14 @@ api_instance = Brevo::ContactsApi.new
|
|
1135
1139
|
|
1136
1140
|
list_id = 789 # Integer | Id of the list
|
1137
1141
|
|
1142
|
+
opts = {
|
1143
|
+
start_date: 'start_date_example', # String | Mandatory if endDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
|
1144
|
+
end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result
|
1145
|
+
}
|
1138
1146
|
|
1139
1147
|
begin
|
1140
1148
|
#Get a list's details
|
1141
|
-
result = api_instance.get_list(list_id)
|
1149
|
+
result = api_instance.get_list(list_id, opts)
|
1142
1150
|
p result
|
1143
1151
|
rescue Brevo::ApiError => e
|
1144
1152
|
puts "Exception when calling ContactsApi->get_list: #{e}"
|
@@ -1150,6 +1158,8 @@ end
|
|
1150
1158
|
Name | Type | Description | Notes
|
1151
1159
|
------------- | ------------- | ------------- | -------------
|
1152
1160
|
**list_id** | **Integer**| Id of the list |
|
1161
|
+
**start_date** | **String**| Mandatory if endDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result | [optional]
|
1162
|
+
**end_date** | **String**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id.Prefer to pass your timezone in date-time format for accurate result | [optional]
|
1153
1163
|
|
1154
1164
|
### Return type
|
1155
1165
|
|
@@ -1297,7 +1307,7 @@ Name | Type | Description | Notes
|
|
1297
1307
|
|
1298
1308
|
Import contacts
|
1299
1309
|
|
1300
|
-
It returns the background process ID which on completion calls the notify URL that you have set in the input.
|
1310
|
+
It returns the background process ID which on completion calls the notify URL that you have set in the input. **Note**: - Any contact attribute that doesn't exist in your account will be ignored at import end.
|
1301
1311
|
|
1302
1312
|
### Example
|
1303
1313
|
```ruby
|