@getbrevo/brevo 1.0.1 → 2.0.0-beta.2

package/model/requestContactImport.ts

@@ -0,0 +1,123 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { RequestContactImportJsonBodyInner } from './requestContactImportJsonBodyInner';
+import { RequestContactImportNewList } from './requestContactImportNewList';
+
+export class RequestContactImport {
+    /**
+    * Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json
+    */
+    'fileUrl'?: string;
+    /**
+    * Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.
+    */
+    'fileBody'?: string;
+    /**
+    * **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. 
+    */
+    'jsonBody'?: Array<RequestContactImportJsonBodyInner>;
+    /**
+    * Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].
+    */
+    'listIds'?: Array<number>;
+    /**
+    * URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+    */
+    'notifyUrl'?: string;
+    'newList'?: RequestContactImportNewList;
+    /**
+    * To blacklist all the contacts for email
+    */
+    'emailBlacklist'?: boolean = false;
+    /**
+    * To disable email notification
+    */
+    'disableNotification'?: boolean = false;
+    /**
+    * To blacklist all the contacts for sms
+    */
+    'smsBlacklist'?: boolean = false;
+    /**
+    * To facilitate the choice to update the existing contacts
+    */
+    'updateExistingContacts'?: boolean = true;
+    /**
+    * To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true )
+    */
+    'emptyContactsAttributes'?: boolean = false;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "fileUrl",
+            "baseName": "fileUrl",
+            "type": "string"
+        },
+        {
+            "name": "fileBody",
+            "baseName": "fileBody",
+            "type": "string"
+        },
+        {
+            "name": "jsonBody",
+            "baseName": "jsonBody",
+            "type": "Array<RequestContactImportJsonBodyInner>"
+        },
+        {
+            "name": "listIds",
+            "baseName": "listIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "notifyUrl",
+            "baseName": "notifyUrl",
+            "type": "string"
+        },
+        {
+            "name": "newList",
+            "baseName": "newList",
+            "type": "RequestContactImportNewList"
+        },
+        {
+            "name": "emailBlacklist",
+            "baseName": "emailBlacklist",
+            "type": "boolean"
+        },
+        {
+            "name": "disableNotification",
+            "baseName": "disableNotification",
+            "type": "boolean"
+        },
+        {
+            "name": "smsBlacklist",
+            "baseName": "smsBlacklist",
+            "type": "boolean"
+        },
+        {
+            "name": "updateExistingContacts",
+            "baseName": "updateExistingContacts",
+            "type": "boolean"
+        },
+        {
+            "name": "emptyContactsAttributes",
+            "baseName": "emptyContactsAttributes",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestContactImport.attributeTypeMap;
+    }
+}
+

package/model/requestContactImportJsonBodyInner.ts

@@ -0,0 +1,40 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class RequestContactImportJsonBodyInner {
+    'email'?: string;
+    /**
+    * List of attributes to be imported
+    */
+    'attributes'?: { [key: string]: any; };
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "attributes",
+            "baseName": "attributes",
+            "type": "{ [key: string]: any; }"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestContactImportJsonBodyInner.attributeTypeMap;
+    }
+}
+

package/model/requestContactImportNewList.ts

@@ -0,0 +1,46 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+/**
+* To create a new list and import the contacts into it, pass the listName and an optional folderId.
+*/
+export class RequestContactImportNewList {
+    /**
+    * List with listName will be created first and users will be imported in it (Mandatory if listIds is empty).
+    */
+    'listName'?: string;
+    /**
+    * Id of the folder where this new list shall be created (Mandatory if listName is not empty).
+    */
+    'folderId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "listName",
+            "baseName": "listName",
+            "type": "string"
+        },
+        {
+            "name": "folderId",
+            "baseName": "folderId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestContactImportNewList.attributeTypeMap;
+    }
+}
+

package/model/requestSmsRecipientExport.ts

@@ -0,0 +1,53 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class RequestSmsRecipientExport {
+    /**
+    * URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+    */
+    'notifyURL'?: string;
+    /**
+    * Filter the recipients based on how they interacted with the campaign
+    */
+    'recipientsType': RequestSmsRecipientExport.RecipientsTypeEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "notifyURL",
+            "baseName": "notifyURL",
+            "type": "string"
+        },
+        {
+            "name": "recipientsType",
+            "baseName": "recipientsType",
+            "type": "RequestSmsRecipientExport.RecipientsTypeEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestSmsRecipientExport.attributeTypeMap;
+    }
+}
+
+export namespace RequestSmsRecipientExport {
+    export enum RecipientsTypeEnum {
+        All = <any> 'all',
+        Delivered = <any> 'delivered',
+        Answered = <any> 'answered',
+        SoftBounces = <any> 'softBounces',
+        HardBounces = <any> 'hardBounces',
+        Unsubscribed = <any> 'unsubscribed'
+    }
+}

package/model/scheduleSmtpEmail.ts

@@ -0,0 +1,49 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class ScheduleSmtpEmail {
+    /**
+    * Message ID of the transactional email scheduled
+    */
+    'messageId'?: string;
+    'messageIds'?: Array<string>;
+    /**
+    * Batch ID of the batch transactional email scheduled
+    */
+    'batchId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "messageId",
+            "baseName": "messageId",
+            "type": "string"
+        },
+        {
+            "name": "messageIds",
+            "baseName": "messageIds",
+            "type": "Array<string>"
+        },
+        {
+            "name": "batchId",
+            "baseName": "batchId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ScheduleSmtpEmail.attributeTypeMap;
+    }
+}
+

package/model/sendReport.ts

@@ -0,0 +1,51 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { SendReportEmail } from './sendReportEmail';
+
+export class SendReport {
+    /**
+    * Language of email content for campaign report sending.
+    */
+    'language'?: SendReport.LanguageEnum = SendReport.LanguageEnum.Fr;
+    'email': SendReportEmail;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "language",
+            "baseName": "language",
+            "type": "SendReport.LanguageEnum"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "SendReportEmail"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendReport.attributeTypeMap;
+    }
+}
+
+export namespace SendReport {
+    export enum LanguageEnum {
+        Fr = <any> 'fr',
+        Es = <any> 'es',
+        Pt = <any> 'pt',
+        It = <any> 'it',
+        De = <any> 'de',
+        En = <any> 'en'
+    }
+}

package/model/sendReportEmail.ts

@@ -0,0 +1,46 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+/**
+* Custom attributes for the report email.
+*/
+export class SendReportEmail {
+    /**
+    * Email addresses of the recipients
+    */
+    'to': Array<string>;
+    /**
+    * Custom text message to be presented in the report email.
+    */
+    'body': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "to",
+            "baseName": "to",
+            "type": "Array<string>"
+        },
+        {
+            "name": "body",
+            "baseName": "body",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendReportEmail.attributeTypeMap;
+    }
+}
+

package/model/sendSms.ts

@@ -0,0 +1,64 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+
+export class SendSms {
+    'reference': string;
+    'messageId': number;
+    /**
+    * Count of SMS\'s to send multiple text messages
+    */
+    'smsCount'?: number;
+    /**
+    * SMS credits used per text message
+    */
+    'usedCredits'?: number;
+    /**
+    * Remaining SMS credits of the user
+    */
+    'remainingCredits'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "reference",
+            "baseName": "reference",
+            "type": "string"
+        },
+        {
+            "name": "messageId",
+            "baseName": "messageId",
+            "type": "number"
+        },
+        {
+            "name": "smsCount",
+            "baseName": "smsCount",
+            "type": "number"
+        },
+        {
+            "name": "usedCredits",
+            "baseName": "usedCredits",
+            "type": "number"
+        },
+        {
+            "name": "remainingCredits",
+            "baseName": "remainingCredits",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendSms.attributeTypeMap;
+    }
+}
+

package/model/sendSmtpEmail.ts

@@ -0,0 +1,170 @@
+/**
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RequestFile } from './models';
+import { SendSmtpEmailAttachmentInner } from './sendSmtpEmailAttachmentInner';
+import { SendSmtpEmailBccInner } from './sendSmtpEmailBccInner';
+import { SendSmtpEmailCcInner } from './sendSmtpEmailCcInner';
+import { SendSmtpEmailMessageVersionsInner } from './sendSmtpEmailMessageVersionsInner';
+import { SendSmtpEmailReplyTo } from './sendSmtpEmailReplyTo';
+import { SendSmtpEmailSender } from './sendSmtpEmailSender';
+import { SendSmtpEmailToInner } from './sendSmtpEmailToInner';
+
+export class SendSmtpEmail {
+    'sender'?: SendSmtpEmailSender;
+    /**
+    * Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]
+    */
+    'to'?: Array<SendSmtpEmailToInner>;
+    /**
+    * List of email addresses and names (optional) of the recipients in bcc
+    */
+    'bcc'?: Array<SendSmtpEmailBccInner>;
+    /**
+    * List of email addresses and names (optional) of the recipients in cc
+    */
+    'cc'?: Array<SendSmtpEmailCcInner>;
+    /**
+    * HTML body of the message ( Mandatory if \'templateId\' is not passed, ignored if \'templateId\' is passed )
+    */
+    'htmlContent'?: string;
+    /**
+    * Plain Text body of the message ( Ignored if \'templateId\' is passed )
+    */
+    'textContent'?: string;
+    /**
+    * Subject of the message. Mandatory if \'templateId\' is not passed
+    */
+    'subject'?: string;
+    'replyTo'?: SendSmtpEmailReplyTo;
+    /**
+    * Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If \'templateId\' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then \'attachment\' is ignored )
+    */
+    'attachment'?: Array<SendSmtpEmailAttachmentInner>;
+    /**
+    * Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. \'sender.ip\' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`.
+    */
+    'headers'?: object;
+    /**
+    * Id of the template.
+    */
+    'templateId'?: number;
+    /**
+    * Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It\'s considered only if template is in New Template Language format.
+    */
+    'params'?: object;
+    /**
+    * You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails
+    */
+    'messageVersions'?: Array<SendSmtpEmailMessageVersionsInner>;
+    /**
+    * Tag your emails to find them more easily
+    */
+    'tags'?: Array<string>;
+    /**
+    * UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for scheduling. There can be an expected delay of +5 minutes in scheduled email delivery. **Please note this feature is currently a public beta**.
+    */
+    'scheduledAt'?: Date;
+    /**
+    * Valid UUIDv4 batch id to identify the scheduled batches transactional email. If not passed we will create a valid UUIDv4 batch id at our end.
+    */
+    'batchId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "sender",
+            "baseName": "sender",
+            "type": "SendSmtpEmailSender"
+        },
+        {
+            "name": "to",
+            "baseName": "to",
+            "type": "Array<SendSmtpEmailToInner>"
+        },
+        {
+            "name": "bcc",
+            "baseName": "bcc",
+            "type": "Array<SendSmtpEmailBccInner>"
+        },
+        {
+            "name": "cc",
+            "baseName": "cc",
+            "type": "Array<SendSmtpEmailCcInner>"
+        },
+        {
+            "name": "htmlContent",
+            "baseName": "htmlContent",
+            "type": "string"
+        },
+        {
+            "name": "textContent",
+            "baseName": "textContent",
+            "type": "string"
+        },
+        {
+            "name": "subject",
+            "baseName": "subject",
+            "type": "string"
+        },
+        {
+            "name": "replyTo",
+            "baseName": "replyTo",
+            "type": "SendSmtpEmailReplyTo"
+        },
+        {
+            "name": "attachment",
+            "baseName": "attachment",
+            "type": "Array<SendSmtpEmailAttachmentInner>"
+        },
+        {
+            "name": "headers",
+            "baseName": "headers",
+            "type": "object"
+        },
+        {
+            "name": "templateId",
+            "baseName": "templateId",
+            "type": "number"
+        },
+        {
+            "name": "params",
+            "baseName": "params",
+            "type": "object"
+        },
+        {
+            "name": "messageVersions",
+            "baseName": "messageVersions",
+            "type": "Array<SendSmtpEmailMessageVersionsInner>"
+        },
+        {
+            "name": "tags",
+            "baseName": "tags",
+            "type": "Array<string>"
+        },
+        {
+            "name": "scheduledAt",
+            "baseName": "scheduledAt",
+            "type": "Date"
+        },
+        {
+            "name": "batchId",
+            "baseName": "batchId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendSmtpEmail.attributeTypeMap;
+    }
+}
+