brevo 2.0.0 → 3.0.0

data/docs/ConversationsApi.md

@@ -41,7 +41,7 @@ end
 
 api_instance = Brevo::ConversationsApi.new
 
-body = Brevo::Body12.new # Body12 | Agent fields.
+body = Brevo::Body15.new # Body15 | Agent fields.
 
 
 begin
@@ -56,7 +56,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**Body12**](Body12.md)| Agent fields. | 
+ **body** | [**Body15**](Body15.md)| Agent fields. | 
 
 ### Return type
 
@@ -217,7 +217,7 @@ api_instance = Brevo::ConversationsApi.new
 id = 'id_example' # String | ID of the message
 
 opts = { 
-  body: Brevo::Body9.new # Body9 | 
+  body: Brevo::Body12.new # Body12 | 
 }
 
 begin
@@ -234,7 +234,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| ID of the message | 
- **body** | [**Body9**](Body9.md)|  | [optional] 
+ **body** | [**Body12**](Body12.md)|  | [optional] 
 
 ### Return type
 
@@ -275,7 +275,7 @@ end
 
 api_instance = Brevo::ConversationsApi.new
 
-body = Brevo::Body8.new # Body8 | Message fields.
+body = Brevo::Body11.new # Body11 | Message fields.
 
 
 begin
@@ -291,7 +291,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**Body8**](Body8.md)| Message fields. | 
+ **body** | [**Body11**](Body11.md)| Message fields. | 
 
 ### Return type
 
@@ -447,7 +447,7 @@ api_instance = Brevo::ConversationsApi.new
 
 id = 'id_example' # String | ID of the message
 
-body = Brevo::Body11.new # Body11 | 
+body = Brevo::Body14.new # Body14 | 
 
 
 begin
@@ -464,7 +464,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| ID of the message | 
- **body** | [**Body11**](Body11.md)|  | 
+ **body** | [**Body14**](Body14.md)|  | 
 
 ### Return type
 
@@ -507,7 +507,7 @@ end
 
 api_instance = Brevo::ConversationsApi.new
 
-body = Brevo::Body10.new # Body10 | 
+body = Brevo::Body13.new # Body13 | 
 
 
 begin
@@ -523,7 +523,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**Body10**](Body10.md)|  | 
+ **body** | [**Body13**](Body13.md)|  | 
 
 ### Return type
 

data/docs/ConversionSourceMetrics.md

@@ -0,0 +1,12 @@
+# Brevo::ConversionSourceMetrics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Float** |  | 
+**conversion_source** | **String** |  | 
+**orders_count** | **Float** |  | 
+**revenue** | **Float** |  | 
+**average_basket** | **Float** |  | 
+
+

data/docs/ConversionSourceProduct.md

@@ -0,0 +1,15 @@
+# Brevo::ConversionSourceProduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | [optional] 
+**sku** | **String** |  | [optional] 
+**price** | **Float** |  | [optional] 
+**url** | **String** |  | [optional] 
+**image_url** | **String** |  | [optional] 
+**orders_count** | **Integer** |  | [optional] 
+**revenue** | **Float** |  | [optional] 
+
+

data/docs/CorporateGroupDetailsResponse.md

@@ -0,0 +1,10 @@
+# Brevo::CorporateGroupDetailsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | [**CorporateGroupDetailsResponseGroup**](CorporateGroupDetailsResponseGroup.md) |  | [optional] 
+**sub_accounts** | [**Array<CorporateGroupDetailsResponseSubaccounts>**](CorporateGroupDetailsResponseSubaccounts.md) |  | [optional] 
+**users** | [**Array<CorporateGroupDetailsResponseUsers>**](CorporateGroupDetailsResponseUsers.md) |  | [optional] 
+
+

data/docs/CorporateGroupDetailsResponseGroup.md

@@ -0,0 +1,10 @@
+# Brevo::CorporateGroupDetailsResponseGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Group id | [optional] 
+**group_name** | **String** | Name of the group | [optional] 
+**created_at** | **String** | Group creation date | [optional] 
+
+

data/docs/CorporateGroupDetailsResponseSubaccounts.md

@@ -0,0 +1,10 @@
+# Brevo::CorporateGroupDetailsResponseSubaccounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the sub-account organzation | [optional] 
+**company_name** | **String** | Name of the sub-account organzation | [optional] 
+**created_at** | **String** | Creation date of the sub-account organzation | [optional] 
+
+

data/docs/CorporateGroupDetailsResponseUsers.md

@@ -0,0 +1,10 @@
+# Brevo::CorporateGroupDetailsResponseUsers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the user | [optional] 
+**last_name** | **String** | Last name of the user | [optional] 
+**first_name** | **String** | First name of the user | [optional] 
+
+

data/docs/CouponsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **create_coupon_collection**
-> InlineResponse2012 create_coupon_collection(create_coupon_collection)
+> InlineResponse2013 create_coupon_collection(create_coupon_collection)
 
 Create а coupon collection
 
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2012**](InlineResponse2012.md)
+[**InlineResponse2013**](InlineResponse2013.md)
 
 ### Authorization
 
@@ -208,7 +208,8 @@ api_instance = Brevo::CouponsApi.new
 opts = { 
   limit: 50, # Integer | Number of documents returned per page
   offset: 0, # Integer | Index of the first document on the page
-  sort: 'desc' # String | Sort the results by creation time in ascending/descending order
+  sort: 'desc', # String | Sort the results by creation time in ascending/descending order
+  sort_by: nil # Object | The field used to sort coupon collections
 }
 
 begin
@@ -227,6 +228,7 @@ Name | Type | Description  | Notes
  **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
  **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
  **sort** | **String**| Sort the results by creation time in ascending/descending order | [optional] [default to desc]
+ **sort_by** | [**Object**](.md)| The field used to sort coupon collections | [optional] 
 
 ### Return type
 
@@ -244,7 +246,7 @@ Name | Type | Description  | Notes
 
 
 # **update_coupon_collection**
-> InlineResponse2001 update_coupon_collection(id, update_coupon_collection)
+> InlineResponse2003 update_coupon_collection(id, opts)
 
 Update a coupon collection by id
 
@@ -269,12 +271,13 @@ api_instance = Brevo::CouponsApi.new
 
 id = 'id_example' # String | Id of the collection to update
 
-update_coupon_collection = Brevo::UpdateCouponCollection.new # UpdateCouponCollection | Values to update the coupon collection
-
+opts = { 
+  update_coupon_collection: Brevo::UpdateCouponCollection.new # UpdateCouponCollection | Values to update the coupon collection
+}
 
 begin
   #Update a coupon collection by id
-  result = api_instance.update_coupon_collection(id, update_coupon_collection)
+  result = api_instance.update_coupon_collection(id, opts)
   p result
 rescue Brevo::ApiError => e
   puts "Exception when calling CouponsApi->update_coupon_collection: #{e}"
@@ -286,11 +289,11 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| Id of the collection to update | 
- **update_coupon_collection** | [**UpdateCouponCollection**](UpdateCouponCollection.md)| Values to update the coupon collection | 
+ **update_coupon_collection** | [**UpdateCouponCollection**](UpdateCouponCollection.md)| Values to update the coupon collection | [optional] 
 
 ### Return type
 
-[**InlineResponse2001**](InlineResponse2001.md)
+[**InlineResponse2003**](InlineResponse2003.md)
 
 ### Authorization
 

data/docs/CreateContact.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **email** | **String** | Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} | [optional] 
 **ext_id** | **String** | Pass your own Id to create a contact. | [optional] 
-**attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 
+**attributes** | **Object** | Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} | [optional] 
 **email_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 
 **sms_blacklisted** | **BOOLEAN** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
 **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 

data/docs/CreateCouponCollection.md

@@ -3,7 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **Object** | Name of the collection with no white spaces between words | 
-**default_coupon** | **Object** | A default coupon to be used in case there are no coupons left | 
+**name** | **String** | Name of the coupons collection | 
+**default_coupon** | **String** | Default coupons collection name | 
+**expiration_date** | **DateTime** | Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date. | [optional] 
+**remaining_days_alert** | **Integer** | Send a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts. | [optional] 
+**remaining_coupons_alert** | **Integer** | Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts. | [optional] 
 
 

data/docs/CreateDomainModel.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | ID of the Domain created | 
 **domain_name** | **String** | Domain | [optional] 
+**domain_provider** | **String** | Domain Provider | [optional] 
 **message** | **String** | Success message | [optional] 
 **dns_records** | [**CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) |  | [optional] 
 

data/docs/CreateDomainModelDnsRecords.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dkim_record** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
 **brevo_code** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
+**dmarc_record** | [**CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
 
 

data/docs/CreateWebhook.md

@@ -8,5 +8,8 @@ Name | Type | Description | Notes
 **events** | **Array<String>** | - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`  | 
 **type** | **String** | Type of the webhook | [optional] [default to 'transactional']
 **domain** | **String** | Inbound domain of webhook, required in case of event type `inbound` | [optional] 
+**batched** | **BOOLEAN** | To send batched webhooks | [optional] 
+**auth** | [**GetWebhookAuth**](GetWebhookAuth.md) |  | [optional] 
+**headers** | [**Array<GetWebhookHeaders>**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional] 
 
 

data/docs/CreateWhatsAppTemplate.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **media_url** | **String** | Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty.** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf  | [optional] 
 **body_text** | **String** | Body of the template. **Maximum allowed characters are 1024** | 
 **header_text** | **String** | Text content of the header in the template.  **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**  | [optional] 
+**source** | **String** | source of the template | [optional] 
 
 

data/docs/DealsApi.md

@@ -92,7 +92,7 @@ end
 api_instance = Brevo::DealsApi.new
 
 opts = { 
-  filters_attributes_deal_name: 'filters_attributes_deal_name_example', # String | Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\"
+  filters_attributes_deal_name: 'filters_attributes_deal_name_example', # String | Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
   filters_linked_companies_ids: 'filters_linked_companies_ids_example', # String | Filter by linked companies ids
   filters_linked_contacts_ids: 'filters_linked_contacts_ids_example', # String | Filter by linked companies ids
   offset: 789, # Integer | Index of the first document of the page
@@ -114,7 +114,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **filters_attributes_deal_name** | **String**| Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`.\" | [optional] 
+ **filters_attributes_deal_name** | **String**| Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering. | [optional] 
  **filters_linked_companies_ids** | **String**| Filter by linked companies ids | [optional] 
  **filters_linked_contacts_ids** | **String**| Filter by linked companies ids | [optional] 
  **offset** | **Integer**| Index of the first document of the page | [optional] 
@@ -276,7 +276,7 @@ api_instance = Brevo::DealsApi.new
 
 id = 'id_example' # String | 
 
-body = Brevo::Body4.new # Body4 | Updated deal details.
+body = Brevo::Body7.new # Body7 | Updated deal details.
 
 
 begin
@@ -292,7 +292,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **body** | [**Body4**](Body4.md)| Updated deal details. | 
+ **body** | [**Body7**](Body7.md)| Updated deal details. | 
 
 ### Return type
 
@@ -335,7 +335,7 @@ api_instance = Brevo::DealsApi.new
 
 id = 'id_example' # String | 
 
-body = Brevo::Body5.new # Body5 | Linked / Unlinked contacts and companies ids.
+body = Brevo::Body8.new # Body8 | Linked / Unlinked contacts and companies ids.
 
 
 begin
@@ -351,7 +351,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**|  | 
- **body** | [**Body5**](Body5.md)| Linked / Unlinked contacts and companies ids. | 
+ **body** | [**Body8**](Body8.md)| Linked / Unlinked contacts and companies ids. | 
 
 ### Return type
 
@@ -369,7 +369,7 @@ nil (empty response body)
 
 
 # **crm_deals_post**
-> InlineResponse201 crm_deals_post(body)
+> InlineResponse2011 crm_deals_post(body)
 
 Create a deal
 
@@ -392,7 +392,7 @@ end
 
 api_instance = Brevo::DealsApi.new
 
-body = Brevo::Body3.new # Body3 | Deal create data.
+body = Brevo::Body6.new # Body6 | Deal create data.
 
 
 begin
@@ -408,11 +408,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**Body3**](Body3.md)| Deal create data. | 
+ **body** | [**Body6**](Body6.md)| Deal create data. | 
 
 ### Return type
 
-[**InlineResponse201**](InlineResponse201.md)
+[**InlineResponse2011**](InlineResponse2011.md)
 
 ### Authorization