brevo 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/docs/EcommerceApi.md
CHANGED
|
@@ -11,8 +11,12 @@ Method | HTTP request | Description
|
|
|
11
11
|
[**create_update_category**](EcommerceApi.md#create_update_category) | **POST** /categories | Create/Update a category
|
|
12
12
|
[**create_update_product**](EcommerceApi.md#create_update_product) | **POST** /products | Create/Update a product
|
|
13
13
|
[**ecommerce_activate_post**](EcommerceApi.md#ecommerce_activate_post) | **POST** /ecommerce/activate | Activate the eCommerce app
|
|
14
|
+
[**ecommerce_attribution_metrics_conversion_source_conversion_source_id_get**](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
|
|
15
|
+
[**ecommerce_attribution_metrics_get**](EcommerceApi.md#ecommerce_attribution_metrics_get) | **GET** /ecommerce/attribution/metrics | Get attribution metrics for one or more Brevo campaigns
|
|
16
|
+
[**ecommerce_attribution_products_conversion_source_conversion_source_id_get**](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
|
|
14
17
|
[**get_categories**](EcommerceApi.md#get_categories) | **GET** /categories | Return all your categories
|
|
15
18
|
[**get_category_info**](EcommerceApi.md#get_category_info) | **GET** /categories/{id} | Get a category details
|
|
19
|
+
[**get_orders**](EcommerceApi.md#get_orders) | **GET** /orders | Get order details
|
|
16
20
|
[**get_product_info**](EcommerceApi.md#get_product_info) | **GET** /products/{id} | Get a product's details
|
|
17
21
|
[**get_products**](EcommerceApi.md#get_products) | **GET** /products | Return all your products
|
|
18
22
|
|
|
@@ -413,6 +417,185 @@ nil (empty response body)
|
|
|
413
417
|
|
|
414
418
|
|
|
415
419
|
|
|
420
|
+
# **ecommerce_attribution_metrics_conversion_source_conversion_source_id_get**
|
|
421
|
+
> ecommerce_attribution_metrics_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id)
|
|
422
|
+
|
|
423
|
+
Get detailed attribution metrics for a single Brevo campaign
|
|
424
|
+
|
|
425
|
+
### Example
|
|
426
|
+
```ruby
|
|
427
|
+
# load the gem
|
|
428
|
+
require 'brevo'
|
|
429
|
+
# setup authorization
|
|
430
|
+
Brevo.configure do |config|
|
|
431
|
+
# Configure API key authorization: api-key
|
|
432
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
433
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
434
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
435
|
+
|
|
436
|
+
# Configure API key authorization: partner-key
|
|
437
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
438
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
439
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
api_instance = Brevo::EcommerceApi.new
|
|
443
|
+
|
|
444
|
+
conversion_source = nil # Object | The Brevo campaign type for which data will be retrieved
|
|
445
|
+
|
|
446
|
+
conversion_source_id = nil # Object | The Brevo campaign id for which data will be retrieved
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
begin
|
|
450
|
+
#Get detailed attribution metrics for a single Brevo campaign
|
|
451
|
+
api_instance.ecommerce_attribution_metrics_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id)
|
|
452
|
+
rescue Brevo::ApiError => e
|
|
453
|
+
puts "Exception when calling EcommerceApi->ecommerce_attribution_metrics_conversion_source_conversion_source_id_get: #{e}"
|
|
454
|
+
end
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### Parameters
|
|
458
|
+
|
|
459
|
+
Name | Type | Description | Notes
|
|
460
|
+
------------- | ------------- | ------------- | -------------
|
|
461
|
+
**conversion_source** | [**Object**](.md)| The Brevo campaign type for which data will be retrieved |
|
|
462
|
+
**conversion_source_id** | [**Object**](.md)| The Brevo campaign id for which data will be retrieved |
|
|
463
|
+
|
|
464
|
+
### Return type
|
|
465
|
+
|
|
466
|
+
nil (empty response body)
|
|
467
|
+
|
|
468
|
+
### Authorization
|
|
469
|
+
|
|
470
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
471
|
+
|
|
472
|
+
### HTTP request headers
|
|
473
|
+
|
|
474
|
+
- **Content-Type**: application/json
|
|
475
|
+
- **Accept**: application/json
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
# **ecommerce_attribution_metrics_get**
|
|
480
|
+
> ecommerce_attribution_metrics_get(opts)
|
|
481
|
+
|
|
482
|
+
Get attribution metrics for one or more Brevo campaigns
|
|
483
|
+
|
|
484
|
+
### Example
|
|
485
|
+
```ruby
|
|
486
|
+
# load the gem
|
|
487
|
+
require 'brevo'
|
|
488
|
+
# setup authorization
|
|
489
|
+
Brevo.configure do |config|
|
|
490
|
+
# Configure API key authorization: api-key
|
|
491
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
492
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
493
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
494
|
+
|
|
495
|
+
# Configure API key authorization: partner-key
|
|
496
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
497
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
498
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
api_instance = Brevo::EcommerceApi.new
|
|
502
|
+
|
|
503
|
+
opts = {
|
|
504
|
+
period_from: nil, # Object | When getting metrics for a specific period, define the starting datetime in RFC3339 format
|
|
505
|
+
period_to: nil, # Object | When getting metrics for a specific period, define the end datetime in RFC3339 format
|
|
506
|
+
email_campaign_id: nil # Object | The email campaign id(s) to get metrics for
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
begin
|
|
510
|
+
#Get attribution metrics for one or more Brevo campaigns
|
|
511
|
+
api_instance.ecommerce_attribution_metrics_get(opts)
|
|
512
|
+
rescue Brevo::ApiError => e
|
|
513
|
+
puts "Exception when calling EcommerceApi->ecommerce_attribution_metrics_get: #{e}"
|
|
514
|
+
end
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### Parameters
|
|
518
|
+
|
|
519
|
+
Name | Type | Description | Notes
|
|
520
|
+
------------- | ------------- | ------------- | -------------
|
|
521
|
+
**period_from** | [**Object**](.md)| When getting metrics for a specific period, define the starting datetime in RFC3339 format | [optional]
|
|
522
|
+
**period_to** | [**Object**](.md)| When getting metrics for a specific period, define the end datetime in RFC3339 format | [optional]
|
|
523
|
+
**email_campaign_id** | [**Object**](.md)| The email campaign id(s) to get metrics for | [optional]
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
nil (empty response body)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: application/json
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
# **ecommerce_attribution_products_conversion_source_conversion_source_id_get**
|
|
541
|
+
> ecommerce_attribution_products_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id)
|
|
542
|
+
|
|
543
|
+
Get attributed product sales for a single Brevo campaign
|
|
544
|
+
|
|
545
|
+
### Example
|
|
546
|
+
```ruby
|
|
547
|
+
# load the gem
|
|
548
|
+
require 'brevo'
|
|
549
|
+
# setup authorization
|
|
550
|
+
Brevo.configure do |config|
|
|
551
|
+
# Configure API key authorization: api-key
|
|
552
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
553
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
554
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
555
|
+
|
|
556
|
+
# Configure API key authorization: partner-key
|
|
557
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
558
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
559
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
api_instance = Brevo::EcommerceApi.new
|
|
563
|
+
|
|
564
|
+
conversion_source = nil # Object | The Brevo campaign type for which data will be retrieved
|
|
565
|
+
|
|
566
|
+
conversion_source_id = nil # Object | The Brevo campaign id for which data will be retrieved
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
begin
|
|
570
|
+
#Get attributed product sales for a single Brevo campaign
|
|
571
|
+
api_instance.ecommerce_attribution_products_conversion_source_conversion_source_id_get(conversion_source, conversion_source_id)
|
|
572
|
+
rescue Brevo::ApiError => e
|
|
573
|
+
puts "Exception when calling EcommerceApi->ecommerce_attribution_products_conversion_source_conversion_source_id_get: #{e}"
|
|
574
|
+
end
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
### Parameters
|
|
578
|
+
|
|
579
|
+
Name | Type | Description | Notes
|
|
580
|
+
------------- | ------------- | ------------- | -------------
|
|
581
|
+
**conversion_source** | [**Object**](.md)| The Brevo campaign type for which data will be retrieved |
|
|
582
|
+
**conversion_source_id** | [**Object**](.md)| The Brevo campaign id for which data will be retrieved |
|
|
583
|
+
|
|
584
|
+
### Return type
|
|
585
|
+
|
|
586
|
+
nil (empty response body)
|
|
587
|
+
|
|
588
|
+
### Authorization
|
|
589
|
+
|
|
590
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
591
|
+
|
|
592
|
+
### HTTP request headers
|
|
593
|
+
|
|
594
|
+
- **Content-Type**: application/json
|
|
595
|
+
- **Accept**: application/json
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
416
599
|
# **get_categories**
|
|
417
600
|
> GetCategories get_categories(opts)
|
|
418
601
|
|
|
@@ -442,7 +625,9 @@ opts = {
|
|
|
442
625
|
offset: 0, # Integer | Index of the first document in the page
|
|
443
626
|
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
444
627
|
ids: ['ids_example'], # Array<String> | Filter by category ids
|
|
445
|
-
name: 'name_example' # String | Filter by category name
|
|
628
|
+
name: 'name_example', # String | Filter by category name
|
|
629
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the categories 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.**
|
|
630
|
+
created_since: 'created_since_example' # String | Filter (urlencoded) the categories 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.**
|
|
446
631
|
}
|
|
447
632
|
|
|
448
633
|
begin
|
|
@@ -463,6 +648,8 @@ Name | Type | Description | Notes
|
|
|
463
648
|
**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]
|
|
464
649
|
**ids** | [**Array<String>**](String.md)| Filter by category ids | [optional]
|
|
465
650
|
**name** | **String**| Filter by category name | [optional]
|
|
651
|
+
**modified_since** | **String**| Filter (urlencoded) the categories 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]
|
|
652
|
+
**created_since** | **String**| Filter (urlencoded) the categories 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]
|
|
466
653
|
|
|
467
654
|
### Return type
|
|
468
655
|
|
|
@@ -536,6 +723,74 @@ Name | Type | Description | Notes
|
|
|
536
723
|
|
|
537
724
|
|
|
538
725
|
|
|
726
|
+
# **get_orders**
|
|
727
|
+
> GetOrders get_orders(opts)
|
|
728
|
+
|
|
729
|
+
Get order details
|
|
730
|
+
|
|
731
|
+
Get all the orders
|
|
732
|
+
|
|
733
|
+
### Example
|
|
734
|
+
```ruby
|
|
735
|
+
# load the gem
|
|
736
|
+
require 'brevo'
|
|
737
|
+
# setup authorization
|
|
738
|
+
Brevo.configure do |config|
|
|
739
|
+
# Configure API key authorization: api-key
|
|
740
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
741
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
742
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
743
|
+
|
|
744
|
+
# Configure API key authorization: partner-key
|
|
745
|
+
config.api_key['partner-key'] = 'YOUR API KEY'
|
|
746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
747
|
+
#config.api_key_prefix['partner-key'] = 'Bearer'
|
|
748
|
+
end
|
|
749
|
+
|
|
750
|
+
api_instance = Brevo::EcommerceApi.new
|
|
751
|
+
|
|
752
|
+
opts = {
|
|
753
|
+
limit: 50, # Integer | Number of documents per page
|
|
754
|
+
offset: 0, # Integer | Index of the first document in the page
|
|
755
|
+
sort: 'desc', # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
756
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the orders 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.**
|
|
757
|
+
created_since: 'created_since_example' # String | Filter (urlencoded) the orders 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.**
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
begin
|
|
761
|
+
#Get order details
|
|
762
|
+
result = api_instance.get_orders(opts)
|
|
763
|
+
p result
|
|
764
|
+
rescue Brevo::ApiError => e
|
|
765
|
+
puts "Exception when calling EcommerceApi->get_orders: #{e}"
|
|
766
|
+
end
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
### Parameters
|
|
770
|
+
|
|
771
|
+
Name | Type | Description | Notes
|
|
772
|
+
------------- | ------------- | ------------- | -------------
|
|
773
|
+
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
|
|
774
|
+
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
|
|
775
|
+
**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]
|
|
776
|
+
**modified_since** | **String**| Filter (urlencoded) the orders 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]
|
|
777
|
+
**created_since** | **String**| Filter (urlencoded) the orders 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]
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
[**GetOrders**](GetOrders.md)
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: application/json
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
539
794
|
# **get_product_info**
|
|
540
795
|
> GetProductDetails get_product_info(id)
|
|
541
796
|
|
|
@@ -629,7 +884,9 @@ opts = {
|
|
|
629
884
|
price_gt: 8.14, # Float | Price filter for products greater than particular amount
|
|
630
885
|
price_eq: 8.14, # Float | Price filter for products equals to particular amount
|
|
631
886
|
price_ne: 8.14, # Float | Price filter for products not equals to particular amount
|
|
632
|
-
categories: ['categories_example'] # Array<String> | Filter by category ids
|
|
887
|
+
categories: ['categories_example'], # Array<String> | Filter by category ids
|
|
888
|
+
modified_since: 'modified_since_example', # String | Filter (urlencoded) the orders 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.**
|
|
889
|
+
created_since: 'created_since_example' # String | Filter (urlencoded) the orders 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.**
|
|
633
890
|
}
|
|
634
891
|
|
|
635
892
|
begin
|
|
@@ -657,6 +914,8 @@ Name | Type | Description | Notes
|
|
|
657
914
|
**price_eq** | **Float**| Price filter for products equals to particular amount | [optional]
|
|
658
915
|
**price_ne** | **Float**| Price filter for products not equals to particular amount | [optional]
|
|
659
916
|
**categories** | [**Array<String>**](String.md)| Filter by category ids | [optional]
|
|
917
|
+
**modified_since** | **String**| Filter (urlencoded) the orders 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]
|
|
918
|
+
**created_since** | **String**| Filter (urlencoded) the orders 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]
|
|
660
919
|
|
|
661
920
|
### Return type
|
|
662
921
|
|
data/docs/EmailCampaignsApi.md
CHANGED
|
@@ -279,8 +279,7 @@ api_instance = Brevo::EmailCampaignsApi.new
|
|
|
279
279
|
campaign_id = 789 # Integer | Id of the campaign
|
|
280
280
|
|
|
281
281
|
opts = {
|
|
282
|
-
statistics: 'statistics_example'
|
|
283
|
-
utm_value: 'utm_value_example' # String | Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.**
|
|
282
|
+
statistics: 'statistics_example' # String | Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
|
|
284
283
|
}
|
|
285
284
|
|
|
286
285
|
begin
|
|
@@ -298,7 +297,6 @@ Name | Type | Description | Notes
|
|
|
298
297
|
------------- | ------------- | ------------- | -------------
|
|
299
298
|
**campaign_id** | **Integer**| Id of the campaign |
|
|
300
299
|
**statistics** | **String**| Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response. | [optional]
|
|
301
|
-
**utm_value** | **String**| Get email campaign report on the basis of custom UTM Value.**You can use either campaignId or utmValue to fetch campaign report.To use utmValue filter pass campaignId as empty.** | [optional]
|
|
302
300
|
|
|
303
301
|
### Return type
|
|
304
302
|
|
data/docs/Event.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Brevo::Event
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**event_name** | **String** | The name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters, alphanumerical characters and - _ only. |
|
|
7
|
+
**event_date** | **String** | Timestamp of when the event occurred (e.g. \"2024-01-24T17:39:57+01:00\"). If no value is passed, the timestamp of the event creation is used. | [optional]
|
|
8
|
+
**identifiers** | [**EventIdentifiers**](EventIdentifiers.md) | |
|
|
9
|
+
**contact_properties** | **Object** | Properties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. For example: **\"FIRSTNAME\": \"Jane\" , \"AGE\": 37** | [optional]
|
|
10
|
+
**event_properties** | **Object** | Properties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field type are supported: string, number, boolean (true/false), date (Timestamp e.g. \"2024-01-24T17:39:57+01:00\"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50Kb. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Brevo::EventIdentifiers
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**email_id** | **String** | Email Id associated with the event | [optional] [default to 'jane.doe@example.com']
|
|
7
|
+
**sms** | **String** | SMS associated with the event | [optional] [default to '+91xxxxxxxxxx']
|
|
8
|
+
**whatsapp** | **String** | whatsapp associated with the event | [optional] [default to '+91xxxxxxxxxx']
|
|
9
|
+
**landline_number** | **String** | landline_number associated with the event | [optional] [default to '+91xxxxxxxxxx']
|
|
10
|
+
**ext_id** | **String** | ext_id associated with the event | [optional] [default to 'abc123']
|
|
11
|
+
|
|
12
|
+
|
data/docs/EventsApi.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Brevo::EventsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.brevo.com/v3*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_event**](EventsApi.md#create_event) | **POST** /events | Create an event
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **create_event**
|
|
11
|
+
> create_event(event)
|
|
12
|
+
|
|
13
|
+
Create an event
|
|
14
|
+
|
|
15
|
+
Create an event to track a contact's interaction.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'brevo'
|
|
21
|
+
# setup authorization
|
|
22
|
+
Brevo.configure do |config|
|
|
23
|
+
# Configure API key authorization: api-key
|
|
24
|
+
config.api_key['api-key'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['api-key'] = 'Bearer'
|
|
27
|
+
|
|
28
|
+
# Configure API key authorization: partner-key
|
|
29
|
+
config.api_key['partner-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['partner-key'] = 'Bearer'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = Brevo::EventsApi.new
|
|
35
|
+
|
|
36
|
+
event = Brevo::Event.new # Event |
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
#Create an event
|
|
41
|
+
api_instance.create_event(event)
|
|
42
|
+
rescue Brevo::ApiError => e
|
|
43
|
+
puts "Exception when calling EventsApi->create_event: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**event** | [**Event**](Event.md)| |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
nil (empty response body)
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: application/json
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
@@ -7,10 +7,11 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**start_date** | **String** | Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
|
|
8
8
|
**end_date** | **String** | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
|
|
9
9
|
**sort** | **String** | Sorting order of records (asc or desc) | [optional]
|
|
10
|
+
**type** | **String** | Filter the history based on webhook type |
|
|
10
11
|
**event** | **String** | Filter the history for a specific event type |
|
|
11
12
|
**notify_url** | **String** | Webhook URL to receive CSV file link |
|
|
12
13
|
**webhook_id** | **Integer** | Filter the history for a specific webhook id | [optional]
|
|
13
14
|
**email** | **String** | Filter the history for a specific email | [optional]
|
|
14
|
-
**message_id** | **Integer** | Filter the history for a specific message id | [optional]
|
|
15
|
+
**message_id** | **Integer** | Filter the history for a specific message id. Applicable only for transactional webhooks. | [optional]
|
|
15
16
|
|
|
16
17
|
|
data/docs/ExternalFeedsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
# **create_external_feed**
|
|
15
|
-
>
|
|
15
|
+
> InlineResponse2015 create_external_feed(create_external_feed)
|
|
16
16
|
|
|
17
17
|
Create an external feed
|
|
18
18
|
|
|
@@ -57,7 +57,7 @@ Name | Type | Description | Notes
|
|
|
57
57
|
|
|
58
58
|
### Return type
|
|
59
59
|
|
|
60
|
-
[**
|
|
60
|
+
[**InlineResponse2015**](InlineResponse2015.md)
|
|
61
61
|
|
|
62
62
|
### Authorization
|
|
63
63
|
|
data/docs/GetContactDetails.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**email** | **String** | Email address of the contact for which you requested the details |
|
|
6
|
+
**email** | **String** | Email address of the contact for which you requested the details | [optional]
|
|
7
7
|
**id** | **Integer** | ID of the contact for which you requested the details |
|
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Brevo::GetCorporateInvitedUsersList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**users** | [**Array<GetCorporateInvitedUsersListUsers>**](GetCorporateInvitedUsersListUsers.md) | Get invited users list | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Brevo::GetCorporateInvitedUsersListFeatureAccess
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**user_management** | **Array<String>** | User management accessiblity. | [optional]
|
|
7
|
+
**api_keys** | **Array<String>** | Api keys accessiblity. | [optional]
|
|
8
|
+
**my_plan** | **Array<String>** | My plan accessiblity. | [optional]
|
|
9
|
+
**apps_management** | **Array<String>** | Apps management accessiblity | Not available in ENTv2 | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Brevo::GetCorporateInvitedUsersListUsers
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**groups** | [**GetCorporateInvitedUsersListGroups**](GetCorporateInvitedUsersListGroups.md) | |
|
|
7
|
+
**email** | **String** | Email address of the user. |
|
|
8
|
+
**is_owner** | **String** | Flag for indicating is user owner of the organization. |
|
|
9
|
+
**status** | **String** | Status of the invited user. |
|
|
10
|
+
**feature_access** | [**GetCorporateInvitedUsersListFeatureAccess**](GetCorporateInvitedUsersListFeatureAccess.md) | |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Brevo::GetCorporateUserPermission
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**email** | **String** | Email address of the user. |
|
|
7
|
+
**status** | **String** | Status of the invited user. |
|
|
8
|
+
**groups** | [**Array<GetCorporateUserPermissionGroups>**](GetCorporateUserPermissionGroups.md) | |
|
|
9
|
+
**feature_access** | [**GetCorporateUserPermissionFeatureAccess**](GetCorporateUserPermissionFeatureAccess.md) | |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Brevo::GetCorporateUserPermissionFeatureAccess
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**api_keys** | **Array<String>** | Permission on api keys | [optional]
|
|
7
|
+
**my_plan** | **Array<String>** | Permission on my plan | [optional]
|
|
8
|
+
**user_management** | **Array<String>** | Permission on user management | [optional]
|
|
9
|
+
**apps_management** | **Array<String>** | Permission on apps management | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::GetCorporateUserPermissionGroups
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | group identifier | [optional]
|
|
7
|
+
**name** | **String** | Group name | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/GetCouponCollection.md
CHANGED
|
@@ -3,11 +3,14 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** | The id of the collection |
|
|
7
|
-
**name** | **String** | The name of the collection |
|
|
8
|
-
**default_coupon** | **String** | The default coupon of the collection |
|
|
9
|
-
**created_at** | **DateTime** | Datetime on which the collection was created |
|
|
10
|
-
**total_coupons** | **Integer** | Total coupons in the collection |
|
|
11
|
-
**remaining_coupons** | **Integer** |
|
|
6
|
+
**id** | **String** | The id of the collection. |
|
|
7
|
+
**name** | **String** | The name of the collection. |
|
|
8
|
+
**default_coupon** | **String** | The default coupon of the collection. |
|
|
9
|
+
**created_at** | **DateTime** | Datetime on which the collection was created. |
|
|
10
|
+
**total_coupons** | **Integer** | Total number of coupons in the collection. |
|
|
11
|
+
**remaining_coupons** | **Integer** | Number of coupons that have not been sent yet. |
|
|
12
|
+
**expiration_date** | **DateTime** | Expiration date for the coupon collection in RFC3339 format. | [optional]
|
|
13
|
+
**remaining_days_alert** | **Integer** | If present, an email notification is going to be sent the defined amount of days before the expiration date. | [optional]
|
|
14
|
+
**remaining_coupons_alert** | **Integer** | If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold. | [optional]
|
|
12
15
|
|
|
13
16
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**email** | **String** | Email address of the contact for which you requested the details |
|
|
6
|
+
**email** | **String** | Email address of the contact for which you requested the details | [optional]
|
|
7
7
|
**id** | **Integer** | ID of the contact for which you requested the details |
|
|
8
8
|
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
|
|
9
9
|
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
|
data/docs/GetOrders.md
ADDED
data/docs/GetWebhook.md
CHANGED
|
@@ -10,5 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**type** | **String** | Type of webhook (marketing or transactional) |
|
|
11
11
|
**created_at** | **String** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
12
12
|
**modified_at** | **String** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
|
|
13
|
+
**batched** | **BOOLEAN** | To send batched webhooks | [optional]
|
|
14
|
+
**auth** | [**GetWebhookAuth**](GetWebhookAuth.md) | | [optional]
|
|
15
|
+
**headers** | [**Array<GetWebhookHeaders>**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional]
|
|
13
16
|
|
|
14
17
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Brevo::GetWebhookAuth
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**type** | **String** | Type of authentication | [optional]
|
|
7
|
+
**token** | **String** | Webhook authentication token | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/InlineResponse200.md
CHANGED
data/docs/InlineResponse2001.md
CHANGED
|
@@ -3,8 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**id** | **String** |
|
|
7
|
-
**
|
|
8
|
-
**default_coupon** | **String** | The default coupon of the collection |
|
|
6
|
+
**id** | **String** | Unique id of the group | [optional]
|
|
7
|
+
**group_name** | **String** | The name of the group of sub-accounts | [optional]
|
|
9
8
|
|
|
10
9
|
|