@getbrevo/brevo 1.0.0

package/docs/CreateSenderIps.md

@@ -0,0 +1,10 @@
+# Brevo.CreateSenderIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | Dedicated IP available in your account | 
+**domain** | **String** | Domain of the IP | 
+**weight** | **Number** | 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] 
+
+

package/docs/CreateSenderModel.md

@@ -0,0 +1,10 @@
+# Brevo.CreateSenderModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the Sender created | 
+**spfError** | **Boolean** | Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured) | [optional] 
+**dkimError** | **Boolean** | Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured) | [optional] 
+
+

package/docs/CreateSmsCampaign.md

@@ -0,0 +1,15 @@
+# Brevo.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** | [**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** | **Boolean** | 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] 
+
+

package/docs/CreateSmsCampaignRecipients.md

@@ -0,0 +1,9 @@
+# Brevo.CreateSmsCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**listIds** | **[Number]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty | 
+**exclusionListIds** | **[Number]** | List ids which have to be excluded from a campaign | [optional] 
+
+

package/docs/CreateSmtpEmail.md

@@ -0,0 +1,9 @@
+# Brevo.CreateSmtpEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messageId** | **String** | Message ID of the transactional email sent | [optional] 
+**messageIds** | **[String]** |  | [optional] 
+
+

package/docs/CreateSmtpTemplate.md

@@ -0,0 +1,17 @@
+# Brevo.CreateSmtpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the template | [optional] 
+**sender** | [**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** | **Boolean** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] 
+
+

package/docs/CreateSmtpTemplateSender.md

@@ -0,0 +1,10 @@
+# Brevo.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** | **Number** | 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] 
+
+

package/docs/CreateSubAccount.md

@@ -0,0 +1,30 @@
+# Brevo.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] 
+
+
+<a name="LanguageEnum"></a>
+## Enum: LanguageEnum
+
+
+* `en` (value: `"en"`)
+
+* `fr` (value: `"fr"`)
+
+* `it` (value: `"it"`)
+
+* `es` (value: `"es"`)
+
+* `pt` (value: `"pt"`)
+
+* `de` (value: `"de"`)
+
+
+
+

package/docs/CreateSubAccountResponse.md

@@ -0,0 +1,8 @@
+# Brevo.CreateSubAccountResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the sub-account created | 
+
+

package/docs/CreateUpdateBatchCategory.md

@@ -0,0 +1,9 @@
+# Brevo.CreateUpdateBatchCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**categories** | [**[CreateUpdateCategories]**](CreateUpdateCategories.md) | array of categories objects | 
+**updateEnabled** | **Boolean** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 
+
+

package/docs/CreateUpdateBatchCategoryModel.md

@@ -0,0 +1,9 @@
+# Brevo.CreateUpdateBatchCategoryModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdCount** | **Number** | Number of the new created categories | [optional] 
+**updatedCount** | **Number** | Number of the existing categories updated | [optional] 
+
+

package/docs/CreateUpdateBatchProducts.md

@@ -0,0 +1,9 @@
+# Brevo.CreateUpdateBatchProducts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**products** | [**[CreateUpdateProducts]**](CreateUpdateProducts.md) | array of products objects | 
+**updateEnabled** | **Boolean** | Facilitate to update the existing categories in the same request (updateEnabled = true) | [optional] 
+
+

package/docs/CreateUpdateBatchProductsModel.md

@@ -0,0 +1,9 @@
+# Brevo.CreateUpdateBatchProductsModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdCount** | **Number** | Number of the new created products | [optional] 
+**updatedCount** | **Number** | Number of the existing products updated | [optional] 
+
+

package/docs/CreateUpdateCategories.md

@@ -0,0 +1,11 @@
+# Brevo.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] 
+
+

package/docs/CreateUpdateCategory.md

@@ -0,0 +1,12 @@
+# Brevo.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** | **Boolean** | 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] 
+
+

package/docs/CreateUpdateContactModel.md

@@ -0,0 +1,8 @@
+# Brevo.CreateUpdateContactModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** | ID of the contact when a new contact is created | [optional] 
+
+

package/docs/CreateUpdateFolder.md

@@ -0,0 +1,8 @@
+# Brevo.CreateUpdateFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the folder | [optional] 
+
+

package/docs/CreateUpdateProduct.md

@@ -0,0 +1,18 @@
+# Brevo.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** | **Number** | Price of the product | [optional] 
+**categories** | **[String]** | Category ID-s of the product | [optional] 
+**parentId** | **String** | Parent product id of the product | [optional] 
+**metaInfo** | **{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** | **Boolean** | 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] 
+
+

package/docs/CreateUpdateProducts.md

@@ -0,0 +1,17 @@
+# Brevo.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** | **Number** | Price of the product | [optional] 
+**categories** | **[String]** | Category ID-s of the product | [optional] 
+**parentId** | **String** | Parent product id of the product | [optional] 
+**metaInfo** | **{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] 
+
+

package/docs/CreateWebhook.md

@@ -0,0 +1,66 @@
+# Brevo.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] 
+
+
+<a name="[EventsEnum]"></a>
+## Enum: [EventsEnum]
+
+
+* `sent` (value: `"sent"`)
+
+* `hardBounce` (value: `"hardBounce"`)
+
+* `softBounce` (value: `"softBounce"`)
+
+* `blocked` (value: `"blocked"`)
+
+* `spam` (value: `"spam"`)
+
+* `delivered` (value: `"delivered"`)
+
+* `request` (value: `"request"`)
+
+* `click` (value: `"click"`)
+
+* `invalid` (value: `"invalid"`)
+
+* `deferred` (value: `"deferred"`)
+
+* `opened` (value: `"opened"`)
+
+* `uniqueOpened` (value: `"uniqueOpened"`)
+
+* `unsubscribed` (value: `"unsubscribed"`)
+
+* `listAddition` (value: `"listAddition"`)
+
+* `contactUpdated` (value: `"contactUpdated"`)
+
+* `contactDeleted` (value: `"contactDeleted"`)
+
+* `inboundEmailProcessed` (value: `"inboundEmailProcessed"`)
+
+
+
+
+<a name="TypeEnum"></a>
+## Enum: TypeEnum
+
+
+* `transactional` (value: `"transactional"`)
+
+* `marketing` (value: `"marketing"`)
+
+* `inbound` (value: `"inbound"`)
+
+
+
+

package/docs/CreateWhatsAppCampaign.md

@@ -0,0 +1,11 @@
+# Brevo.CreateWhatsAppCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the WhatsApp campaign creation | 
+**templateId** | **Number** | 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** | [**CreateWhatsAppCampaignRecipients**](CreateWhatsAppCampaignRecipients.md) |  | 
+
+

package/docs/CreateWhatsAppCampaignRecipients.md

@@ -0,0 +1,10 @@
+# Brevo.CreateWhatsAppCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**excludedListIds** | **[Number]** | List ids to exclude from the campaign | [optional] 
+**listIds** | **[Number]** | **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to  | [optional] 
+**segments** | **[Number]** | **Mandatory if listIds are not used**. Segment ids to send the campaign to.  | [optional] 
+
+

package/docs/CreateWhatsAppTemplate.md

@@ -0,0 +1,24 @@
+# Brevo.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] 
+
+
+<a name="CategoryEnum"></a>
+## Enum: CategoryEnum
+
+
+* `MARKETING` (value: `"MARKETING"`)
+
+* `TRANSACTIONAL` (value: `"TRANSACTIONAL"`)
+
+
+
+

package/docs/CreatedBatchId.md

@@ -0,0 +1,8 @@
+# Brevo.CreatedBatchId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batchId** | **Number** | Batch ID of the request | 
+
+

package/docs/CreatedProcessId.md

@@ -0,0 +1,8 @@
+# Brevo.CreatedProcessId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**processId** | **Number** | Id of the process created | 
+
+

package/docs/Deal.md

@@ -0,0 +1,11 @@
+# Brevo.Deal
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique deal id | [optional] 
+**attributes** | **Object** | Deal attributes with values | [optional] 
+**linkedContactsIds** | **[Number]** | Contact ids for contacts linked to this deal | [optional] 
+**linkedCompaniesIds** | **[String]** | Companies ids for companies linked to this deal | [optional] 
+
+

package/docs/DealAttributes.md

@@ -0,0 +1,7 @@
+# Brevo.DealAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

package/docs/DealAttributesInner.md

@@ -0,0 +1,12 @@
+# Brevo.DealAttributesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internalName** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**attributeTypeName** | **String** |  | [optional] 
+**attributeOptions** | **[Object]** |  | [optional] 
+**isRequired** | **Boolean** |  | [optional] 
+
+