newsletter field working

vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResult.md

@@ -0,0 +1,17 @@
+# AbTestCampaignResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**winningVersion** | **string** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional] 
+**winningCriteria** | **string** | Criteria choosen for winning version (Open/Click) | [optional] 
+**winningSubjectLine** | **string** | Subject Line of current winning version | [optional] 
+**openRate** | **string** | Open rate for current winning version | [optional] 
+**clickRate** | **string** | Click rate for current winning version | [optional] 
+**winningVersionRate** | **string** | Open/Click rate for the winner version | [optional] 
+**statistics** | [**\Brevo\Client\Model\AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) |  | [optional] 
+**clickedLinks** | [**\Brevo\Client\Model\AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultClickedLinks.md

@@ -0,0 +1,11 @@
+# AbTestCampaignResultClickedLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**versionA** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) |  | 
+**versionB** | [**\Brevo\Client\Model\AbTestVersionClicks**](AbTestVersionClicks.md) |  | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AbTestCampaignResultStatistics.md

@@ -0,0 +1,15 @@
+# AbTestCampaignResultStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**openers** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**clicks** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**unsubscribed** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**hardBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**softBounces** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+**complaints** | [**\Brevo\Client\Model\AbTestVersionStats**](AbTestVersionStats.md) |  | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicks.md

@@ -0,0 +1,9 @@
+# AbTestVersionClicks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AbTestVersionClicksInner.md

@@ -0,0 +1,12 @@
+# AbTestVersionClicksInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link** | **string** | URL of the link | 
+**clicksCount** | **int** | Number of times a link is clicked | 
+**clickRate** | **string** | Percentage of clicks of link with respect to total clicks | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AbTestVersionStats.md

@@ -0,0 +1,11 @@
+# AbTestVersionStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**versionA** | **string** | percentage of an event for version A | 
+**versionB** | **string** | percentage of an event for version B | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AddChildDomain.md

@@ -0,0 +1,10 @@
+# AddChildDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** | Sender domain to add for a specific child account | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AddContactToList.md

@@ -0,0 +1,11 @@
+# AddContactToList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **string[]** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
+**ids** | **int[]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AddCredits.md

@@ -0,0 +1,11 @@
+# AddCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional] 
+**email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/AuthenticateDomainModel.md

@@ -0,0 +1,11 @@
+# AuthenticateDomainModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domainName** | **string** | Domain | 
+**message** | **string** | Success message | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/BlockDomain.md

@@ -0,0 +1,10 @@
+# BlockDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** | name of the domain to be blocked | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body.md

@@ -0,0 +1,11 @@
+# Body
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupName** | **string** | The name of the group of sub-accounts | 
+**subAccountIds** | **int[]** | Pass the list of sub-account Ids to be included in the group | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body1.md

@@ -0,0 +1,11 @@
+# Body1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupName** | **string** | The name of the group of sub-accounts | 
+**subAccountIds** | **int[]** | Pass the list of sub-account Ids to be included in the group | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body10.md

@@ -0,0 +1,15 @@
+# Body10
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitorId** | **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> | 
+**text** | **string** | message text | 
+**agentId** | **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] 
+**receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional] 
+**agentEmail** | **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] 
+**agentName** | **string** | agent name | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body11.md

@@ -0,0 +1,10 @@
+# Body11
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **string** | edited message text | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body12.md

@@ -0,0 +1,13 @@
+# Body12
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitorId** | **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> | 
+**text** | **string** | message text | 
+**agentId** | **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] 
+**groupId** | **string** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body13.md

@@ -0,0 +1,10 @@
+# Body13
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **string** | edited message text | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body14.md

@@ -0,0 +1,13 @@
+# Body14
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agentId** | **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] 
+**receivedFrom** | **string** | mark your messages to distinguish messages created by you from the others. | [optional] 
+**agentEmail** | **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] 
+**agentName** | **string** | agent name. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body2.md

@@ -0,0 +1,12 @@
+# Body2
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of company | 
+**attributes** | **object** | Attributes for company creation | [optional] 
+**countryCode** | **int** | Country code if phone_number is passed in attributes. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body3.md

@@ -0,0 +1,12 @@
+# Body3
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of company | [optional] 
+**attributes** | **object** | Attributes for company update | [optional] 
+**countryCode** | **int** | Country code if phone_number is passed in attributes. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body4.md

@@ -0,0 +1,13 @@
+# Body4
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**linkContactIds** | **int[]** | Contact ids for contacts to be linked with company | [optional] 
+**unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from company | [optional] 
+**linkDealsIds** | **string[]** | Deals ids for deals to be linked with company | [optional] 
+**unlinkDealsIds** | **string[]** | Deals ids for deals to be unlinked from company | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body5.md

@@ -0,0 +1,11 @@
+# Body5
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of deal | 
+**attributes** | **object** | Attributes for deal creation  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] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body6.md

@@ -0,0 +1,11 @@
+# Body6
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of deal | [optional] 
+**attributes** | **object** | Attributes for deal update  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] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body7.md

@@ -0,0 +1,13 @@
+# Body7
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**linkContactIds** | **int[]** | Contact ids for contacts to be linked with deal | [optional] 
+**unlinkContactIds** | **int[]** | Contact ids for contacts to be unlinked from deal | [optional] 
+**linkCompanyIds** | **string[]** | Company ids to be linked with deal | [optional] 
+**unlinkCompanyIds** | **string[]** | Company ids to be unlinked from deal | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body8.md

@@ -0,0 +1,20 @@
+# Body8
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of task | 
+**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 
+**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | 
+**date** | [**\DateTime**] | Task due date and time | 
+**notes** | **string** | Notes added to a task | [optional] 
+**done** | **bool** | Task marked as done | [optional] 
+**assignToId** | **string** | User id to whom task is assigned | [optional] 
+**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] 
+**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] 
+**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] 
+**reminder** | [**\Brevo\Client\Model\TaskReminder**](TaskReminder.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Body9.md

@@ -0,0 +1,19 @@
+# Body9
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of task | [optional] 
+**duration** | **int** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional] 
+**taskTypeId** | **string** | Id for type of task e.g Call / Email / Meeting etc. | [optional] 
+**date** | [**\DateTime**] | Task date/time | [optional] 
+**notes** | **string** | Notes added to a task | [optional] 
+**done** | **bool** | Task marked as done | [optional] 
+**assignToId** | **string** | User id to whom task is assigned | [optional] 
+**contactsIds** | **int[]** | Contact ids for contacts linked to this task | [optional] 
+**dealsIds** | **string[]** | Deal ids for deals a task is linked to | [optional] 
+**companiesIds** | **string[]** | Companies ids for companies a task is linked to | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/BodyVariablesItems.md

@@ -0,0 +1,9 @@
+# BodyVariablesItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CompaniesList.md

@@ -0,0 +1,10 @@
+# CompaniesList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**\Brevo\Client\Model\Company[]**](Company.md) | List of compaies | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Company.md

@@ -0,0 +1,13 @@
+# Company
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique company id | [optional] 
+**attributes** | **object** | Company attributes with values | [optional] 
+**linkedContactsIds** | **int[]** | Contact ids for contacts linked to this company | [optional] 
+**linkedDealsIds** | **string[]** | Deals ids for companies linked to this company | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CompanyAttributes.md

@@ -0,0 +1,9 @@
+# CompanyAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CompanyAttributesInner.md

@@ -0,0 +1,14 @@
+# CompanyAttributesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internalName** | **string** |  | [optional] 
+**label** | **string** |  | [optional] 
+**attributeTypeName** | **string** |  | [optional] 
+**attributeOptions** | **object[]** |  | [optional] 
+**isRequired** | **bool** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/ComponentItems.md

@@ -0,0 +1,11 @@
+# ComponentItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] 
+**text** | **string** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Contact.md

@@ -0,0 +1,17 @@
+# Contact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**virtualNextTask** | **object** | Next incomplete task of contact | [optional] 
+**email** | **string** | Contact email | 
+**assignToId** | **string** | User id to whom contact is assigned | [optional] 
+**contactsId** | **int** | Contact id | [optional] 
+**crmLists** | **object** | CRM lists in which contact is added | 
+**attributes** | **object** | Contact attributes e.g firstname / lastname / SMS etc. | [optional] 
+**createdAt** | [**\DateTime**] | Contact created date/time | [optional] 
+**updatedAt** | [**\DateTime**] | Contact updated date/time | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/ConversationsMessageFile.md

@@ -0,0 +1,14 @@
+# ConversationsMessageFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **string** | Name of the file | [optional] 
+**size** | **int** | Size in bytes | [optional] 
+**isImage** | **bool** | Whether the file is an image | [optional] 
+**url** | **string** | URL of the file | [optional] 
+**imageInfo** | [**\Brevo\Client\Model\ConversationsMessageFileImageInfo**](ConversationsMessageFileImageInfo.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Conversationsmessage.md

@@ -0,0 +1,19 @@
+# ConversationsMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Message ID. It can be used for further manipulations with the message. | [optional] 
+**type** | **string** | `\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. | [optional] 
+**text** | **string** | Message text or name of the attached file | [optional] 
+**visitorId** | **string** | visitor’s ID | [optional] 
+**agentId** | **string** | ID of the agent on whose behalf the message was sent (only in messages sent by an agent). | [optional] 
+**agentName** | **string** | Agent’s name as displayed to the visitor. Only in the messages sent by an agent. | [optional] 
+**createdAt** | **int** | Timestamp in milliseconds. | [optional] 
+**isPushed** | **bool** | `true` for pushed messages | [optional] 
+**receivedFrom** | **string** | In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop. | [optional] 
+**file** | [**\Brevo\Client\Model\ConversationsMessageFile**](ConversationsMessageFile.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/ConversationsmessageFileImageInfo.md

@@ -0,0 +1,12 @@
+# ConversationsMessageFileImageInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**width** | **int** | Width of the image | [optional] 
+**height** | **int** | height of the image | [optional] 
+**previewUrl** | **string** | URL of the preview | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyRequest.md

@@ -0,0 +1,11 @@
+# CreateApiKeyRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | Id of the sub-account organization | 
+**name** | **string** | Name of the API key | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateApiKeyResponse.md

@@ -0,0 +1,11 @@
+# CreateApiKeyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Status of the API operation. | [optional] 
+**key** | **string** | API Key | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateAttribute.md

@@ -0,0 +1,13 @@
+# CreateAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**isRecurring** | **bool** | Type of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
+**enumeration** | [**\Brevo\Client\Model\CreateAttributeEnumeration[]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}] | [optional] 
+**type** | **string** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateAttributeEnumeration.md

@@ -0,0 +1,11 @@
+# CreateAttributeEnumeration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **int** | Id of the value | 
+**label** | **string** | Label of the value | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateCategoryModel.md

@@ -0,0 +1,10 @@
+# CreateCategoryModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the category when a new category is created | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateChild.md

@@ -0,0 +1,15 @@
+# CreateChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email address to create the child account | 
+**firstName** | **string** | First name to use to create the child account | 
+**lastName** | **string** | Last name to use to create the child account | 
+**companyName** | **string** | Company name to use to create the child account | 
+**password** | **string** | Password for the child account to login | 
+**language** | **string** | Language of the child account | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateContact.md

@@ -0,0 +1,17 @@
+# CreateContact
+
+## Properties
+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] 
+**extId** | **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. 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] 
+**emailBlacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] 
+**smsBlacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
+**listIds** | **int[]** | Ids of the lists to add the contact to | [optional] 
+**updateEnabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to false]
+**smtpBlacklistSender** | **string[]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateCouponCollection.md

@@ -0,0 +1,11 @@
+# CreateCouponCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **object** | Name of the collection with no white spaces between words | 
+**defaultCoupon** | **object** | A default coupon to be used in case there are no coupons left | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateCoupons.md

@@ -0,0 +1,11 @@
+# CreateCoupons
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collectionId** | **string** | The id of the coupon collection for which the coupons will be created | 
+**coupons** | **string[]** |  | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateDoiContact.md

@@ -0,0 +1,15 @@
+# CreateDoiContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes. | 
+**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] 
+**includeListIds** | **int[]** | Lists under user account where contact should be added | 
+**excludeListIds** | **int[]** | Lists under user account where contact should not be added | [optional] 
+**templateId** | **int** | Id of the Double opt-in (DOI) template | 
+**redirectionUrl** | **string** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateDomain.md

@@ -0,0 +1,10 @@
+# CreateDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Domain name | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateDomainModel.md

@@ -0,0 +1,13 @@
+# CreateDomainModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the Domain created | 
+**domainName** | **string** | Domain | [optional] 
+**message** | **string** | Success message | [optional] 
+**dnsRecords** | [**\Brevo\Client\Model\CreateDomainModelDnsRecords**](CreateDomainModelDnsRecords.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecords.md

@@ -0,0 +1,11 @@
+# CreateDomainModelDnsRecords
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dkimRecord** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
+**brevoCode** | [**\Brevo\Client\Model\CreateDomainModelDnsRecordsDkimRecord**](CreateDomainModelDnsRecordsDkimRecord.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateDomainModelDnsRecordsDkimRecord.md

@@ -0,0 +1,13 @@
+# CreateDomainModelDnsRecordsDkimRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] 
+**value** | **string** |  | [optional] 
+**hostName** | **string** |  | [optional] 
+**status** | **bool** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaign.md

@@ -0,0 +1,40 @@
+# CreateEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **string** | Tag of the campaign | [optional] 
+**sender** | [**\Brevo\Client\Model\CreateEmailCampaignSender**](CreateEmailCampaignSender.md) |  | 
+**name** | **string** | Name of the campaign | 
+**htmlContent** | **string** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional] 
+**htmlUrl** | **string** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] 
+**templateId** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] 
+**scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] 
+**subject** | **string** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional] 
+**previewText** | **string** | Preview text or preheader of the email campaign | [optional] 
+**replyTo** | **string** | Email on which the campaign recipients will be able to reply to | [optional] 
+**toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
+**recipients** | [**\Brevo\Client\Model\CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) |  | [optional] 
+**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
+**inlineImageActivation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false]
+**mirrorActive** | **bool** | Use true to enable the mirror link | [optional] 
+**footer** | **string** | Footer of the email campaign | [optional] 
+**header** | **string** | Header of the email campaign | [optional] 
+**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] 
+**sendAtBestTime** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to false]
+**abTesting** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to false]
+**subjectA** | **string** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**subjectB** | **string** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] 
+**splitRule** | **int** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] 
+**winnerCriteria** | **string** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional] 
+**winnerDelay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [optional] 
+**ipWarmupEnable** | **bool** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
+**initialQuota** | **int** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional] 
+**increaseRate** | **int** | Mandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. | [optional] 
+**unsubscriptionPageId** | **string** | Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used. | [optional] 
+**updateFormId** | **string** | Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaignRecipients.md

@@ -0,0 +1,12 @@
+# CreateEmailCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusionListIds** | **int[]** | List ids to exclude from the campaign | [optional] 
+**listIds** | **int[]** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional] 
+**segmentIds** | **int[]** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateEmailCampaignSender.md

@@ -0,0 +1,12 @@
+# CreateEmailCampaignSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Sender Name | [optional] 
+**email** | **string** | Sender email | 
+**id** | **int** | Select the sender for the campaign on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateExternalFeed.md

@@ -0,0 +1,18 @@
+# CreateExternalFeed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the feed | 
+**url** | **string** | URL of the feed | 
+**authType** | **string** | Auth type of the feed:   * `basic`   * `token`   * `noAuth` | [optional] [default to 'noAuth']
+**username** | **string** | Username for authType `basic` | [optional] 
+**password** | **string** | Password for authType `basic` | [optional] 
+**token** | **string** | Token for authType `token` | [optional] 
+**headers** | [**\Brevo\Client\Model\GetExternalFeedByUUIDHeaders[]**](GetExternalFeedByUUIDHeaders.md) | Custom headers for the feed | [optional] 
+**maxRetries** | **int** | Maximum number of retries on the feed url | [optional] 
+**cache** | **bool** | Toggle caching of feed url response | [optional] [default to false]
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateList.md

@@ -0,0 +1,11 @@
+# CreateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the list | 
+**folderId** | **int** | Id of the parent folder in which this list is to be created | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateModel.md

@@ -0,0 +1,10 @@
+# CreateModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the object created | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateProductModel.md

@@ -0,0 +1,10 @@
+# CreateProductModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the Product when a new product is created | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateReseller.md

@@ -0,0 +1,11 @@
+# CreateReseller
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authKey** | **string** | AuthKey of Reseller child created | 
+**id** | **int** | Id of Reseller child created | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSender.md

@@ -0,0 +1,12 @@
+# CreateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | From Name to use for the sender | 
+**email** | **string** | From email to use for the sender. A verification email will be sent to this address. | 
+**ips** | [**\Brevo\Client\Model\CreateSenderIps[]**](CreateSenderIps.md) | Mandatory in case of dedicated IP, IPs to associate to the sender | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSenderIps.md

@@ -0,0 +1,12 @@
+# CreateSenderIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **string** | Dedicated IP available in your account | 
+**domain** | **string** | Domain of the IP | 
+**weight** | **int** | Weight to apply to the IP. Sum of all IP weights must be 100. Should be passed for either ALL or NONE of the IPs. If it's not passed, the sending will be equally balanced on all IPs. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSenderModel.md

@@ -0,0 +1,12 @@
+# CreateSenderModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the Sender created | 
+**spfError** | **bool** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 
+**dkimError** | **bool** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSmsCampaign.md

@@ -0,0 +1,17 @@
+# CreateSmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the campaign | 
+**sender** | **string** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** | 
+**content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | 
+**recipients** | [**\Brevo\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [optional] 
+**scheduledAt** | **string** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] 
+**unicodeEnabled** | **bool** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
+**organisationPrefix** | **string** | A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.** | [optional] 
+**unsubscribeInstruction** | **string** | Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.** | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSmsCampaignRecipients.md

@@ -0,0 +1,11 @@
+# CreateSmsCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 
+**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSmtpEmail.md

@@ -0,0 +1,11 @@
+# CreateSmtpEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messageId** | **string** | Message ID of the transactional email sent | [optional] 
+**messageIds** | **string[]** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSmtpTemplate.md

@@ -0,0 +1,19 @@
+# CreateSmtpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **string** | Tag of the template | [optional] 
+**sender** | [**\Brevo\Client\Model\CreateSmtpTemplateSender**](CreateSmtpTemplateSender.md) |  | 
+**templateName** | **string** | Name of the template | 
+**htmlContent** | **string** | Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty | [optional] 
+**htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
+**subject** | **string** | Subject of the template | 
+**replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] 
+**toField** | **string** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] 
+**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] 
+**isActive** | **bool** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSmtpTemplateSender.md

@@ -0,0 +1,12 @@
+# CreateSmtpTemplateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the sender. If not passed, will be set to default | [optional] 
+**email** | **string** | Email of the sender | [optional] 
+**id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSubAccount.md

@@ -0,0 +1,13 @@
+# CreateSubAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Set the name of the sub-account company | 
+**email** | **string** | Email address for the organization | 
+**language** | **string** | Set the language of the sub-account | [optional] 
+**timezone** | **string** | Set the timezone of the sub-account | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateSubAccountResponse.md

@@ -0,0 +1,10 @@
+# CreateSubAccountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the sub-account created | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateBatchCategory.md

@@ -0,0 +1,11 @@
+# CreateUpdateBatchCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**\Brevo\Client\Model\CreateUpdateCategories[]**](CreateUpdateCategories.md) | array of categories objects | 
+**updateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateBatchCategoryModel.md

@@ -0,0 +1,11 @@
+# CreateUpdateBatchCategoryModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdCount** | **int** | Number of the new created categories | [optional] 
+**updatedCount** | **int** | Number of the existing categories updated | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateBatchProducts.md

@@ -0,0 +1,11 @@
+# CreateUpdateBatchProducts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**\Brevo\Client\Model\CreateUpdateProducts[]**](CreateUpdateProducts.md) | array of products objects | 
+**updateEnabled** | **bool** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateBatchProductsModel.md

@@ -0,0 +1,11 @@
+# CreateUpdateBatchProductsModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdCount** | **int** | Number of the new created products | [optional] 
+**updatedCount** | **int** | Number of the existing products updated | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateCategories.md

@@ -0,0 +1,13 @@
+# CreateUpdateCategories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique Category ID as saved in the shop | 
+**name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 
+**url** | **string** | URL to the category | [optional] 
+**deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateCategory.md

@@ -0,0 +1,14 @@
+# CreateUpdateCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique Category ID as saved in the shop | 
+**name** | **string** | **Mandatory in case of creation**. Name of the Category, as displayed in the shop | [optional] 
+**url** | **string** | URL to the category | [optional] 
+**updateEnabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to false]
+**deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateContactModel.md

@@ -0,0 +1,10 @@
+# CreateUpdateContactModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | ID of the contact when a new contact is created | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateFolder.md

@@ -0,0 +1,10 @@
+# CreateUpdateFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the folder | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateProducts.md

@@ -0,0 +1,19 @@
+# CreateUpdateProducts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Product ID for which you requested the details | 
+**name** | **string** | Mandatory in case of creation**. Name of the product for which you requested the details | 
+**url** | **string** | URL to the product | [optional] 
+**imageUrl** | **string** | Absolute URL to the cover image of the product | [optional] 
+**sku** | **string** | Product identifier from the shop | [optional] 
+**price** | **float** | Price of the product | [optional] 
+**categories** | **string[]** | Category ID-s of the product | [optional] 
+**parentId** | **string** | Parent product id of the product | [optional] 
+**metaInfo** | **map[string,string]** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 
+**deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateUpdateproduct.md

@@ -0,0 +1,20 @@
+# CreateUpdateProduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Product ID for which you requested the details | 
+**name** | **string** | Mandatory in case of creation**. Name of the product for which you requested the details | 
+**url** | **string** | URL to the product | [optional] 
+**imageUrl** | **string** | Absolute URL to the cover image of the product | [optional] 
+**sku** | **string** | Product identifier from the shop | [optional] 
+**price** | **float** | Price of the product | [optional] 
+**categories** | **string[]** | Category ID-s of the product | [optional] 
+**parentId** | **string** | Parent product id of the product | [optional] 
+**metaInfo** | **map[string,string]** | Meta data of product such as description, vendor, producer, stock level. The size of cumulative metaInfo shall not exceed **1000 KB**. Maximum length of metaInfo object can be 10. | [optional] 
+**updateEnabled** | **bool** | Facilitate to update the existing category in the same request (updateEnabled = true) | [optional] [default to false]
+**deletedAt** | **string** | UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateWebhook.md

@@ -0,0 +1,17 @@
+# CreateWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | URL of the webhook | 
+**description** | **string** | Description of the webhook | [optional] 
+**events** | **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** | **bool** | To send batched webhooks | [optional] 
+**auth** | [**\Brevo\Client\Model\GetWebhookAuth**](GetWebhookAuth.md) |  | [optional] 
+**headers** | [**\Brevo\Client\Model\GetWebhookHeaders[]**](GetWebhookHeaders.md) | Custom headers to be send with webhooks | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateWhatsAppCampaign.md

@@ -0,0 +1,13 @@
+# CreateWhatsAppCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the WhatsApp campaign creation | 
+**templateId** | **int** | Id of the WhatsApp template in **approved** state | 
+**scheduledAt** | **string** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** | 
+**recipients** | [**\Brevo\Client\Model\CreateWhatsAppCampaignRecipients**](CreateWhatsAppCampaignRecipients.md) |  | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateWhatsAppCampaignRecipients.md

@@ -0,0 +1,12 @@
+# CreateWhatsAppCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**excludedListIds** | **int[]** | List ids to exclude from the campaign | [optional] 
+**listIds** | **int[]** | **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to | [optional] 
+**segments** | **int[]** | **Mandatory if listIds are not used**. Segment ids to send the campaign to. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreateWhatsAppTemplate.md

@@ -0,0 +1,16 @@
+# CreateWhatsAppTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the template | 
+**language** | **string** | Language of the template. For Example : **en** for English | 
+**category** | **string** | Category of the template | 
+**mediaUrl** | **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] 
+**bodyText** | **string** | Body of the template. **Maximum allowed characters are 1024** | 
+**headerText** | **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] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreatedBatchId.md

@@ -0,0 +1,10 @@
+# CreatedBatchId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batchId** | **float** | Batch ID of the request | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/CreatedProcessId.md

@@ -0,0 +1,10 @@
+# CreatedProcessId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**processId** | **int** | Id of the process created | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Deal.md

@@ -0,0 +1,13 @@
+# Deal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique deal id | [optional] 
+**attributes** | **object** | Deal attributes with values | [optional] 
+**linkedContactsIds** | **int[]** | Contact ids for contacts linked to this deal | [optional] 
+**linkedCompaniesIds** | **string[]** | Companies ids for companies linked to this deal | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/DealAttributes.md

@@ -0,0 +1,9 @@
+# DealAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/DealAttributesInner.md

@@ -0,0 +1,14 @@
+# DealAttributesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internalName** | **string** |  | [optional] 
+**label** | **string** |  | [optional] 
+**attributeTypeName** | **string** |  | [optional] 
+**attributeOptions** | **object[]** |  | [optional] 
+**isRequired** | **bool** |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/DealsList.md

@@ -0,0 +1,10 @@
+# DealsList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**\Brevo\Client\Model\Deal[]**](Deal.md) | List of deals | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/DeleteHardbounces.md

@@ -0,0 +1,12 @@
+# DeleteHardbounces
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDate** | **string** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional] 
+**endDate** | **string** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional] 
+**contactEmail** | **string** | Target a specific email address | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/EmailExportRecipients.md

@@ -0,0 +1,11 @@
+# EmailExportRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notifyURL** | **string** | Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 | [optional] 
+**recipientsType** | **string** | Type of recipients to export for a campaign | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/ErrorModel.md

@@ -0,0 +1,11 @@
+# ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** | Error code displayed in case of a failure | 
+**message** | **string** | Readable message associated to the failure | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/Event.md

@@ -0,0 +1,14 @@
+# Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eventName** | **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. | 
+**eventDate** | **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] 
+**identifiers** | [**\Brevo\Client\Model\EventIdentifiers**](EventIdentifiers.md) |  | 
+**contactProperties** | **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] 
+**eventProperties** | **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] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/EventIdentifiers.md

@@ -0,0 +1,14 @@
+# EventIdentifiers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emailId** | **string** | Email Id associated with the event | [optional] 
+**phoneId** | **string** | SMS associated with the event | [optional] 
+**whatsappId** | **string** | whatsapp associated with the event | [optional] 
+**landlineNumberId** | **string** | landline_number associated with the event | [optional] 
+**extId** | **string** | ext_id associated with the event | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/ExportWebhooksHistory.md

@@ -0,0 +1,19 @@
+# ExportWebhooksHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**days** | **int** | Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ | [optional] 
+**startDate** | **string** | Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate | [optional] 
+**endDate** | **string** | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional] 
+**sort** | **string** | Sorting order of records (asc or desc) | [optional] 
+**type** | **string** | Filter the history based on webhook type | 
+**event** | **string** | Filter the history for a specific event type | 
+**notifyURL** | **string** | Webhook URL to receive CSV file link | 
+**webhookId** | **int** | Filter the history for a specific webhook id | [optional] 
+**email** | **string** | Filter the history for a specific email | [optional] 
+**messageId** | **int** | Filter the history for a specific message id. Applicable only for transactional webhooks. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/FileData.md

@@ -0,0 +1,19 @@
+# FileData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | Url of uploaded file | [optional] 
+**id** | **string** | Id of uploaded file | [optional] 
+**name** | **string** | Name of uploaded file | [optional] 
+**authorId** | **string** | Account id of user which created the file | [optional] 
+**author** | **object** | Account details of user which created the file | [optional] 
+**contactId** | **int** | Contact id of contact on which file is uploaded | [optional] 
+**dealId** | **string** | Deal id linked to a file | [optional] 
+**companyId** | **string** | Company id linked to a file | [optional] 
+**size** | **int** | Size of file in bytes | [optional] 
+**createdAt** | [**\DateTime**] | File created date/time | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/FileDownloadableLink.md

@@ -0,0 +1,10 @@
+# FileDownloadableLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fileUrl** | **string** | A unique link to download the requested file. | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/FileList.md

@@ -0,0 +1,9 @@
+# FileList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/GetAccount.md

@@ -0,0 +1,12 @@
+# GetAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plan** | [**\Brevo\Client\Model\GetAccountPlan[]**](GetAccountPlan.md) | Information about your plans and credits | 
+**relay** | [**\Brevo\Client\Model\GetAccountRelay**](GetAccountRelay.md) |  | 
+**marketingAutomation** | [**\Brevo\Client\Model\GetAccountMarketingAutomation**](GetAccountMarketingAutomation.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/GetAccountActivity.md

@@ -0,0 +1,10 @@
+# GetAccountActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**logs** | [**\Brevo\Client\Model\GetAccountActivityLogs[]**](GetAccountActivityLogs.md) | Get user activity logs | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+

vendor/getbrevo/brevo-php/docs/Model/GetAccountActivityLogs.md

@@ -0,0 +1,14 @@
+# GetAccountActivityLogs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | Type of activity in the account. | 
+**date** | **string** | Time of the activity. | 
+**userEmail** | **string** | Email address of the user who performed activity in the account. | 
+**userIp** | **string** | IP address of the user who performed activity in the account. | 
+**userAgent** | **string** | Browser details of the user who performed the activity. | 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
+