@getbrevo/brevo 1.0.0 → 2.0.0-beta.2

package/model/updateEmailCampaign.ts

@@ -0,0 +1,306 @@
+/**
+ * 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 { UpdateEmailCampaignRecipients } from './updateEmailCampaignRecipients';
+import { UpdateEmailCampaignSender } from './updateEmailCampaignSender';
+
+export class UpdateEmailCampaign {
+    /**
+    * Tag of the campaign
+    */
+    'tag'?: string;
+    'sender'?: UpdateEmailCampaignSender;
+    /**
+    * Name of the campaign
+    */
+    'name'?: string;
+    /**
+    * Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty
+    */
+    'htmlContent'?: string;
+    /**
+    * Url which contents the body of the email message. REQUIRED if htmlContent is empty
+    */
+    'htmlUrl'?: 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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
+    */
+    'scheduledAt'?: string;
+    /**
+    * Subject of the campaign
+    */
+    'subject'?: string;
+    /**
+    * Preview text or preheader of the email campaign
+    */
+    'previewText'?: string;
+    /**
+    * Email on which campaign recipients will be able to reply to
+    */
+    'replyTo'?: 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
+    */
+    'toField'?: string;
+    'recipients'?: UpdateEmailCampaignRecipients;
+    /**
+    * 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
+    */
+    'attachmentUrl'?: string;
+    /**
+    * Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.
+    */
+    'inlineImageActivation'?: boolean = false;
+    /**
+    * Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
+    */
+    'mirrorActive'?: boolean;
+    /**
+    * FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
+    */
+    'recurring'?: boolean = false;
+    /**
+    * Footer of the email campaign
+    */
+    'footer'?: string;
+    /**
+    * Header of the email campaign
+    */
+    'header'?: string;
+    /**
+    * Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
+    */
+    'utmCampaign'?: string;
+    /**
+    * Pass the set of attributes to customize the type \'classic\' campaign. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The \'params\' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of \'subject\', \'htmlContent/htmlUrl\', \'sender.name\' & \'toField\'
+    */
+    'params'?: object;
+    /**
+    * Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
+    */
+    'sendAtBestTime'?: boolean;
+    /**
+    * 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 if abTesting is set to true. \'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
+    */
+    'abTesting'?: boolean = false;
+    /**
+    * Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
+    */
+    'subjectA'?: string;
+    /**
+    * Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
+    */
+    'subjectB'?: string;
+    /**
+    * Add the size of your test groups. Considered if abTesting = true. We\'ll send version A and B to a random sample of recipients, and then the winning version to everyone else
+    */
+    'splitRule'?: number;
+    /**
+    * Choose the metrics that will determinate the winning version. Considered if \'splitRule\' >= 1 and < 50. If splitRule = 50, \'winnerCriteria\' is ignored if passed or alreday exist in record
+    */
+    'winnerCriteria'?: UpdateEmailCampaign.WinnerCriteriaEnum;
+    /**
+    * 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. Considered if \'splitRule\' >= 1 and < 50. If splitRule = 50, \'winnerDelay\' is ignored if passed or alreday exist in record
+    */
+    'winnerDelay'?: number;
+    /**
+    * Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
+    */
+    'ipWarmupEnable'?: boolean = false;
+    /**
+    * Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+    */
+    'initialQuota'?: number;
+    /**
+    * 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%.
+    */
+    'increaseRate'?: number;
+    /**
+    * 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.
+    */
+    'unsubscriptionPageId'?: 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.
+    */
+    'updateFormId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "tag",
+            "baseName": "tag",
+            "type": "string"
+        },
+        {
+            "name": "sender",
+            "baseName": "sender",
+            "type": "UpdateEmailCampaignSender"
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "htmlContent",
+            "baseName": "htmlContent",
+            "type": "string"
+        },
+        {
+            "name": "htmlUrl",
+            "baseName": "htmlUrl",
+            "type": "string"
+        },
+        {
+            "name": "scheduledAt",
+            "baseName": "scheduledAt",
+            "type": "string"
+        },
+        {
+            "name": "subject",
+            "baseName": "subject",
+            "type": "string"
+        },
+        {
+            "name": "previewText",
+            "baseName": "previewText",
+            "type": "string"
+        },
+        {
+            "name": "replyTo",
+            "baseName": "replyTo",
+            "type": "string"
+        },
+        {
+            "name": "toField",
+            "baseName": "toField",
+            "type": "string"
+        },
+        {
+            "name": "recipients",
+            "baseName": "recipients",
+            "type": "UpdateEmailCampaignRecipients"
+        },
+        {
+            "name": "attachmentUrl",
+            "baseName": "attachmentUrl",
+            "type": "string"
+        },
+        {
+            "name": "inlineImageActivation",
+            "baseName": "inlineImageActivation",
+            "type": "boolean"
+        },
+        {
+            "name": "mirrorActive",
+            "baseName": "mirrorActive",
+            "type": "boolean"
+        },
+        {
+            "name": "recurring",
+            "baseName": "recurring",
+            "type": "boolean"
+        },
+        {
+            "name": "footer",
+            "baseName": "footer",
+            "type": "string"
+        },
+        {
+            "name": "header",
+            "baseName": "header",
+            "type": "string"
+        },
+        {
+            "name": "utmCampaign",
+            "baseName": "utmCampaign",
+            "type": "string"
+        },
+        {
+            "name": "params",
+            "baseName": "params",
+            "type": "object"
+        },
+        {
+            "name": "sendAtBestTime",
+            "baseName": "sendAtBestTime",
+            "type": "boolean"
+        },
+        {
+            "name": "abTesting",
+            "baseName": "abTesting",
+            "type": "boolean"
+        },
+        {
+            "name": "subjectA",
+            "baseName": "subjectA",
+            "type": "string"
+        },
+        {
+            "name": "subjectB",
+            "baseName": "subjectB",
+            "type": "string"
+        },
+        {
+            "name": "splitRule",
+            "baseName": "splitRule",
+            "type": "number"
+        },
+        {
+            "name": "winnerCriteria",
+            "baseName": "winnerCriteria",
+            "type": "UpdateEmailCampaign.WinnerCriteriaEnum"
+        },
+        {
+            "name": "winnerDelay",
+            "baseName": "winnerDelay",
+            "type": "number"
+        },
+        {
+            "name": "ipWarmupEnable",
+            "baseName": "ipWarmupEnable",
+            "type": "boolean"
+        },
+        {
+            "name": "initialQuota",
+            "baseName": "initialQuota",
+            "type": "number"
+        },
+        {
+            "name": "increaseRate",
+            "baseName": "increaseRate",
+            "type": "number"
+        },
+        {
+            "name": "unsubscriptionPageId",
+            "baseName": "unsubscriptionPageId",
+            "type": "string"
+        },
+        {
+            "name": "updateFormId",
+            "baseName": "updateFormId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateEmailCampaign.attributeTypeMap;
+    }
+}
+
+export namespace UpdateEmailCampaign {
+    export enum WinnerCriteriaEnum {
+        Open = <any> 'open',
+        Click = <any> 'click'
+    }
+}

package/model/updateEmailCampaignRecipients.ts

@@ -0,0 +1,55 @@
+/**
+ * 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';
+
+/**
+* Segment ids and List ids to include/exclude from campaign
+*/
+export class UpdateEmailCampaignRecipients {
+    /**
+    * List ids which have to be excluded from a campaign
+    */
+    'exclusionListIds'?: Array<number>;
+    /**
+    * Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty
+    */
+    'listIds'?: Array<number>;
+    /**
+    * Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to.
+    */
+    'segmentIds'?: Array<number>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "exclusionListIds",
+            "baseName": "exclusionListIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "listIds",
+            "baseName": "listIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "segmentIds",
+            "baseName": "segmentIds",
+            "type": "Array<number>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateEmailCampaignRecipients.attributeTypeMap;
+    }
+}
+

package/model/updateEmailCampaignSender.ts

@@ -0,0 +1,55 @@
+/**
+ * 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';
+
+/**
+* Sender details including id or email and name (optional). Only one of either Sender\'s email or Sender\'s ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`
+*/
+export class UpdateEmailCampaignSender {
+    /**
+    * Sender Name from which the campaign emails are sent
+    */
+    'name'?: string;
+    /**
+    * Sender email from which the campaign emails are sent
+    */
+    'email'?: string;
+    /**
+    * 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).
+    */
+    'id'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateEmailCampaignSender.attributeTypeMap;
+    }
+}
+

package/model/updateExternalFeed.ts

@@ -0,0 +1,114 @@
+/**
+ * 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 { GetExternalFeedByUUIDHeadersInner } from './getExternalFeedByUUIDHeadersInner';
+
+export class UpdateExternalFeed {
+    /**
+    * Name of the feed
+    */
+    'name'?: string;
+    /**
+    * URL of the feed
+    */
+    'url'?: string;
+    /**
+    * Auth type of the feed:   * `basic`   * `token`   * `noAuth` 
+    */
+    'authType'?: UpdateExternalFeed.AuthTypeEnum;
+    /**
+    * Username for authType `basic`
+    */
+    'username'?: string;
+    /**
+    * Password for authType `basic`
+    */
+    'password'?: string;
+    /**
+    * Token for authType `token`
+    */
+    'token'?: string;
+    /**
+    * Custom headers for the feed
+    */
+    'headers'?: Array<GetExternalFeedByUUIDHeadersInner>;
+    /**
+    * Maximum number of retries on the feed url
+    */
+    'maxRetries'?: number;
+    /**
+    * Toggle caching of feed url response
+    */
+    'cache'?: boolean = false;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "authType",
+            "baseName": "authType",
+            "type": "UpdateExternalFeed.AuthTypeEnum"
+        },
+        {
+            "name": "username",
+            "baseName": "username",
+            "type": "string"
+        },
+        {
+            "name": "password",
+            "baseName": "password",
+            "type": "string"
+        },
+        {
+            "name": "token",
+            "baseName": "token",
+            "type": "string"
+        },
+        {
+            "name": "headers",
+            "baseName": "headers",
+            "type": "Array<GetExternalFeedByUUIDHeadersInner>"
+        },
+        {
+            "name": "maxRetries",
+            "baseName": "maxRetries",
+            "type": "number"
+        },
+        {
+            "name": "cache",
+            "baseName": "cache",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateExternalFeed.attributeTypeMap;
+    }
+}
+
+export namespace UpdateExternalFeed {
+    export enum AuthTypeEnum {
+        Basic = <any> 'basic',
+        Token = <any> 'token',
+        NoAuth = <any> 'noAuth'
+    }
+}

package/model/updateList.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 UpdateList {
+    /**
+    * Name of the list. Either of the two parameters (name, folderId) can be updated at a time.
+    */
+    'name'?: string;
+    /**
+    * Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.
+    */
+    'folderId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "folderId",
+            "baseName": "folderId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateList.attributeTypeMap;
+    }
+}
+

package/model/updateSender.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';
+import { CreateSenderIpsInner } from './createSenderIpsInner';
+
+export class UpdateSender {
+    /**
+    * From Name to update the sender
+    */
+    'name'?: string;
+    /**
+    * From Email to update the sender
+    */
+    'email'?: string;
+    /**
+    * Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs.
+    */
+    'ips'?: Array<CreateSenderIpsInner>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        },
+        {
+            "name": "ips",
+            "baseName": "ips",
+            "type": "Array<CreateSenderIpsInner>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdateSender.attributeTypeMap;
+    }
+}
+