@getbrevo/brevo 1.0.0 → 2.0.0-beta.2

package/docs/GetFolders.md

@@ -1,9 +0,0 @@
-# Brevo.GetFolders
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**folders** | **[Object]** |  | [optional] 
-**count** | **Number** | Number of folders available in your account | [optional] 
-
-

package/docs/GetInboundEmailEvents.md

@@ -1,8 +0,0 @@
-# Brevo.GetInboundEmailEvents
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**events** | [**[GetInboundEmailEventsEvents]**](GetInboundEmailEventsEvents.md) |  | [optional] 
-
-

package/docs/GetInboundEmailEventsByUuid.md

@@ -1,15 +0,0 @@
-# Brevo.GetInboundEmailEventsByUuid
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**receivedAt** | **Date** | Date when email was received on SMTP relay | [optional] 
-**deliveredAt** | **Date** | Date when email was delivered successfully to client’s webhook | [optional] 
-**recipient** | **String** | Recipient’s email address | [optional] 
-**sender** | **String** | Sender’s email address | [optional] 
-**messageId** | **String** | Value of the Message-ID header. This will be present only after the processing is done. | [optional] 
-**subject** | **String** | Value of the Subject header. This will be present only after the processing is done.  | [optional] 
-**attachments** | [**[GetInboundEmailEventsByUuidAttachments]**](GetInboundEmailEventsByUuidAttachments.md) | List of attachments of the email. This will be present only after the processing is done. | [optional] 
-**logs** | [**[GetInboundEmailEventsByUuidLogs]**](GetInboundEmailEventsByUuidLogs.md) | List of events/logs that describe the lifecycle of the email on SIB platform | [optional] 
-
-

package/docs/GetInboundEmailEventsByUuidAttachments.md

@@ -1,11 +0,0 @@
-# Brevo.GetInboundEmailEventsByUuidAttachments
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | filename specified in the Content-Disposition header of the attachment | [optional] 
-**contentType** | **String** | value of the Content-Type header of the attachment | [optional] 
-**contentId** | **String** | value of the Content-ID header of the attachment. | [optional] 
-**contentLength** | **Number** | size of the attachment in bytes | [optional] 
-
-

package/docs/GetInboundEmailEventsByUuidLogs.md

@@ -1,24 +0,0 @@
-# Brevo.GetInboundEmailEventsByUuidLogs
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_date** | **Date** | Date of the event | [optional] 
-**type** | **String** | Type of the event | [optional] 
-
-
-<a name="TypeEnum"></a>
-## Enum: TypeEnum
-
-
-* `received` (value: `"received"`)
-
-* `processed` (value: `"processed"`)
-
-* `webhookFailed` (value: `"webhookFailed"`)
-
-* `webhookDelivered` (value: `"webhookDelivered"`)
-
-
-
-

package/docs/GetInboundEmailEventsEvents.md

@@ -1,11 +0,0 @@
-# Brevo.GetInboundEmailEventsEvents
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**uuid** | **String** | UUID that can be used to fetch additional data | 
-**_date** | **Date** | Date when email was received on SMTP relay | 
-**sender** | **String** | Sender’s email address | 
-**recipient** | **String** | Recipient’s email address | 
-
-

package/docs/GetInvitedUsersList.md

@@ -1,8 +0,0 @@
-# Brevo.GetInvitedUsersList
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**users** | [**[GetInvitedUsersListUsers]**](GetInvitedUsersListUsers.md) | Get invited users list | [optional] 
-
-

package/docs/GetInvitedUsersListFeatureAccess.md

@@ -1,10 +0,0 @@
-# Brevo.GetInvitedUsersListFeatureAccess
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**marketing** | **Object** | Marketing features accessiblity. | [optional] 
-**conversations** | **Object** | Conversations features accessiblity. | [optional] 
-**crm** | **Object** | CRM features accessiblity. | [optional] 
-
-

package/docs/GetInvitedUsersListUsers.md

@@ -1,11 +0,0 @@
-# Brevo.GetInvitedUsersListUsers
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**email** | **String** | Email address of the user. | 
-**isOwner** | **String** | Flag for indicating is user owner of the organization. | 
-**status** | **String** | Status of the invited user. | 
-**featureAccess** | [**GetInvitedUsersListFeatureAccess**](GetInvitedUsersListFeatureAccess.md) |  | 
-
-

package/docs/GetIp.md

@@ -1,11 +0,0 @@
-# Brevo.GetIp
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the dedicated IP | 
-**ip** | **String** | Dedicated IP | 
-**active** | **Boolean** | Status of the IP (true=active, false=inactive) | 
-**domain** | **String** | Domain associated to the IP | 
-
-

package/docs/GetIpFromSender.md

@@ -1,11 +0,0 @@
-# Brevo.GetIpFromSender
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the dedicated IP | 
-**ip** | **String** | Dedicated IP | 
-**domain** | **String** | Domain associated to the IP | 
-**weight** | **Number** | Weight of the IP | 
-
-

package/docs/GetIps.md

@@ -1,8 +0,0 @@
-# Brevo.GetIps
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ips** | [**[GetIp]**](GetIp.md) | Dedicated IP(s) available on your account | 
-
-

package/docs/GetIpsFromSender.md

@@ -1,8 +0,0 @@
-# Brevo.GetIpsFromSender
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ips** | [**[GetIpFromSender]**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | 
-
-

package/docs/GetList.md

@@ -1,12 +0,0 @@
-# Brevo.GetList
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the list | 
-**name** | **String** | Name of the list | 
-**totalBlacklisted** | **Number** | Number of blacklisted contacts in the list | 
-**totalSubscribers** | **Number** | Number of contacts in the list | 
-**uniqueSubscribers** | **Number** | Number of unique contacts in the list | 
-
-

package/docs/GetLists.md

@@ -1,9 +0,0 @@
-# Brevo.GetLists
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**lists** | **[Object]** | Listing of all the lists available in your account | [optional] 
-**count** | **Number** | Number of lists in your account | [optional] 
-
-

package/docs/GetProcess.md

@@ -1,24 +0,0 @@
-# Brevo.GetProcess
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | Id of the process | 
-**status** | **String** | Status of the process | 
-**name** | **String** | Process name | 
-**exportUrl** | **String** | URL on which send export the of contacts once the process is completed | [optional] 
-
-
-<a name="StatusEnum"></a>
-## Enum: StatusEnum
-
-
-* `queued` (value: `"queued"`)
-
-* `inProcess` (value: `"in_process"`)
-
-* `completed` (value: `"completed"`)
-
-
-
-

package/docs/GetProcesses.md

@@ -1,9 +0,0 @@
-# Brevo.GetProcesses
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**processes** | [**[GetProcess]**](GetProcess.md) | List of processes available on your account | [optional] 
-**count** | **Number** | Number of processes available on your account | [optional] 
-
-

package/docs/GetProductDetails.md

@@ -1,22 +0,0 @@
-# Brevo.GetProductDetails
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Product ID for which you requested the details | 
-**name** | **String** | Name of the product for which you requested the details | 
-**createdAt** | **String** | Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modifiedAt** | **String** | Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**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] 
-**s3Original** | **String** | S3 url of original image | [optional] 
-**s3ThumbAnalytics** | **String** | S3 thumbnail url of original image in 120x120 dimension for analytics section | 
-**metaInfo** | **Object** | Meta data of product such as description, vendor, producer, stock level, etc. | [optional] 
-**s3ThumbEditor** | **String** | S3 thumbnail url of original image in 600x400 dimension for editor section | 
-**isDeleted** | **Boolean** | product deleted from the shop's database | [optional] 
-
-

package/docs/GetProducts.md

@@ -1,9 +0,0 @@
-# Brevo.GetProducts
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**products** | **[Object]** |  | 
-**count** | **Number** | Number of products | 
-
-

package/docs/GetReports.md

@@ -1,8 +0,0 @@
-# Brevo.GetReports
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**reports** | [**[GetReportsReports]**](GetReportsReports.md) |  | [optional] 
-
-

package/docs/GetReportsReports.md

@@ -1,20 +0,0 @@
-# Brevo.GetReportsReports
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_date** | **Date** | Date of the statistics | 
-**requests** | **Number** | Number of requests for the date | 
-**delivered** | **Number** | Number of delivered emails for the date | 
-**hardBounces** | **Number** | Number of hardbounces for the date | 
-**softBounces** | **Number** | Number of softbounces for the date | 
-**clicks** | **Number** | Number of clicks for the date | 
-**uniqueClicks** | **Number** | Number of unique clicks for the date | 
-**opens** | **Number** | Number of openings for the date | 
-**uniqueOpens** | **Number** | Number of unique openings for the date | 
-**spamReports** | **Number** | Number of complaints (spam reports) for the date | 
-**blocked** | **Number** | Number of blocked emails for the date | 
-**invalid** | **Number** | Number of invalid emails for the date | 
-**unsubscribed** | **Number** | Number of unsubscribed emails for the date | 
-
-

package/docs/GetScheduledEmailByBatchId.md

@@ -1,9 +0,0 @@
-# Brevo.GetScheduledEmailByBatchId
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Number** | Total number of batches | [optional] 
-**batches** | [**[GetScheduledEmailByBatchIdBatches]**](GetScheduledEmailByBatchIdBatches.md) |  | [optional] 
-
-

package/docs/GetScheduledEmailByBatchIdBatches.md

@@ -1,25 +0,0 @@
-# Brevo.GetScheduledEmailByBatchIdBatches
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**scheduledAt** | **Date** | Datetime for which the batch was scheduled | 
-**createdAt** | **Date** | Datetime on which the batch was scheduled | 
-**status** | **String** | Current status of the scheduled batch | 
-
-
-<a name="StatusEnum"></a>
-## Enum: StatusEnum
-
-
-* `inProgress` (value: `"inProgress"`)
-
-* `queued` (value: `"queued"`)
-
-* `processed` (value: `"processed"`)
-
-* `error` (value: `"error"`)
-
-
-
-

package/docs/GetScheduledEmailByMessageId.md

@@ -1,25 +0,0 @@
-# Brevo.GetScheduledEmailByMessageId
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**scheduledAt** | **Date** | Datetime for which the email was scheduled | 
-**createdAt** | **Date** | Datetime on which the email was scheduled | 
-**status** | **String** | Current status of the scheduled email | 
-
-
-<a name="StatusEnum"></a>
-## Enum: StatusEnum
-
-
-* `inProgress` (value: `"inProgress"`)
-
-* `queued` (value: `"queued"`)
-
-* `processed` (value: `"processed"`)
-
-* `error` (value: `"error"`)
-
-
-
-

package/docs/GetSegments.md

@@ -1,9 +0,0 @@
-# Brevo.GetSegments
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**segments** | [**GetSegmentsSegments**](GetSegmentsSegments.md) |  | [optional] 
-**count** | **Number** | Number of Segments available in your account | [optional] 
-
-

package/docs/GetSegmentsSegments.md

@@ -1,11 +0,0 @@
-# Brevo.GetSegmentsSegments
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the list | [optional] 
-**segmentName** | **String** | Name of the Segment | [optional] 
-**categoryName** | **String** | Name of the Segment Category | [optional] 
-**updatedAt** | **String** | Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 
-
-

package/docs/GetSendersList.md

@@ -1,8 +0,0 @@
-# Brevo.GetSendersList
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**senders** | [**[GetSendersListSenders]**](GetSendersListSenders.md) | List of the senders available in your account | [optional] 
-
-

package/docs/GetSendersListIps.md

@@ -1,10 +0,0 @@
-# Brevo.GetSendersListIps
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ip** | **String** | Dedicated IP available in your account | 
-**domain** | **String** | Domain of the IP | 
-**weight** | **Number** | Weight of the IP for this sender | 
-
-

package/docs/GetSendersListSenders.md

@@ -1,12 +0,0 @@
-# Brevo.GetSendersListSenders
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | Id of the sender | 
-**name** | **String** | From Name associated to the sender | 
-**email** | **String** | From Email associated to the sender | 
-**active** | **Boolean** | Status of sender (true=activated, false=deactivated) | 
-**ips** | [**[GetSendersListIps]**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] 
-
-

package/docs/GetSharedTemplateUrl.md

@@ -1,8 +0,0 @@
-# Brevo.GetSharedTemplateUrl
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sharedUrl** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Brevo users. | 
-
-

package/docs/GetSmsCampaign.md

@@ -1,9 +0,0 @@
-# Brevo.GetSmsCampaign
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipients** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) |  | 
-**statistics** | [**GetSmsCampaignRecipients**](GetSmsCampaignRecipients.md) |  | 
-
-

package/docs/GetSmsCampaignOverview.md

@@ -1,34 +0,0 @@
-# Brevo.GetSmsCampaignOverview
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the SMS Campaign | 
-**name** | **String** | Name of the SMS Campaign | 
-**status** | **String** | Status of the SMS Campaign | 
-**content** | **String** | Content of the SMS Campaign | 
-**scheduledAt** | **String** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional] 
-**sender** | **String** | Sender of the SMS Campaign | 
-**createdAt** | **String** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modifiedAt** | **String** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-
-
-<a name="StatusEnum"></a>
-## Enum: StatusEnum
-
-
-* `draft` (value: `"draft"`)
-
-* `sent` (value: `"sent"`)
-
-* `archive` (value: `"archive"`)
-
-* `queued` (value: `"queued"`)
-
-* `suspended` (value: `"suspended"`)
-
-* `inProcess` (value: `"inProcess"`)
-
-
-
-

package/docs/GetSmsCampaignRecipients.md

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

package/docs/GetSmsCampaignStats.md

@@ -1,14 +0,0 @@
-# Brevo.GetSmsCampaignStats
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**delivered** | **Number** | Number of delivered SMS | 
-**sent** | **Number** | Number of sent SMS | 
-**processing** | **Number** | Number of processing SMS | 
-**softBounces** | **Number** | Number of softbounced SMS | 
-**hardBounces** | **Number** | Number of hardbounced SMS | 
-**unsubscriptions** | **Number** | Number of unsubscription SMS | 
-**answered** | **Number** | Number of replies to the SMS | 
-
-

package/docs/GetSmsCampaigns.md

@@ -1,9 +0,0 @@
-# Brevo.GetSmsCampaigns
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**campaigns** | **[Object]** |  | [optional] 
-**count** | **Number** | Number of SMS campaigns retrieved | [optional] 
-
-

package/docs/GetSmsEventReport.md

@@ -1,8 +0,0 @@
-# Brevo.GetSmsEventReport
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**events** | [**[GetSmsEventReportEvents]**](GetSmsEventReportEvents.md) |  | [optional] 
-
-

package/docs/GetSmsEventReportEvents.md

@@ -1,41 +0,0 @@
-# Brevo.GetSmsEventReportEvents
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phoneNumber** | **String** | Phone number which has generated the event | [optional] 
-**_date** | **String** | UTC date-time on which the event has been generated | [optional] 
-**messageId** | **String** | Message ID which generated the event | [optional] 
-**event** | **String** | Event which occurred | [optional] 
-**reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] 
-**reply** | **String** |  | [optional] 
-**tag** | **String** | Tag of the SMS which generated the event | [optional] 
-
-
-<a name="EventEnum"></a>
-## Enum: EventEnum
-
-
-* `bounces` (value: `"bounces"`)
-
-* `hardBounces` (value: `"hardBounces"`)
-
-* `softBounces` (value: `"softBounces"`)
-
-* `delivered` (value: `"delivered"`)
-
-* `sent` (value: `"sent"`)
-
-* `accepted` (value: `"accepted"`)
-
-* `unsubscription` (value: `"unsubscription"`)
-
-* `replies` (value: `"replies"`)
-
-* `blocked` (value: `"blocked"`)
-
-* `rejected` (value: `"rejected"`)
-
-
-
-

package/docs/GetSmtpTemplateOverview.md

@@ -1,20 +0,0 @@
-# Brevo.GetSmtpTemplateOverview
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | ID of the template | 
-**name** | **String** | Name of the template | 
-**subject** | **String** | Subject of the template | 
-**isActive** | **Boolean** | Status of template (true=active, false=inactive) | 
-**testSent** | **Boolean** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | 
-**sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) |  | 
-**replyTo** | **String** | Email defined as the \"Reply to\" for the template | 
-**toField** | **String** | Customisation of the \"to\" field for the template | 
-**tag** | **String** | Tag of the template | 
-**htmlContent** | **String** | HTML content of the template | 
-**createdAt** | **String** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**modifiedAt** | **String** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) | 
-**doiTemplate** | **Boolean** | It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call. | [optional] 
-
-

package/docs/GetSmtpTemplateOverviewSender.md

@@ -1,10 +0,0 @@
-# Brevo.GetSmtpTemplateOverviewSender
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | From email for the template | [optional] 
-**email** | **String** | From email for the template | [optional] 
-**id** | **String** | Sender id of the template | [optional] 
-
-

package/docs/GetSmtpTemplates.md

@@ -1,9 +0,0 @@
-# Brevo.GetSmtpTemplates
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Number** | Count of transactional email templates | [optional] 
-**templates** | [**[GetSmtpTemplateOverview]**](GetSmtpTemplateOverview.md) |  | [optional] 
-
-

package/docs/GetSsoToken.md

@@ -1,8 +0,0 @@
-# Brevo.GetSsoToken
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**token** | **String** | Session token, it will remain valid for 15 days. | 
-
-

package/docs/GetStatsByBrowser.md

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

package/docs/GetStatsByDevice.md

@@ -1,11 +0,0 @@
-# Brevo.GetStatsByDevice
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**desktop** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional] 
-**mobile** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional] 
-**tablet** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional] 
-**unknown** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional] 
-
-

package/docs/GetStatsByDomain.md

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