@getbrevo/brevo 1.0.0 → 2.0.0-beta.2

package/model/createWebhook.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 CreateWebhook {
+    /**
+    * URL of the webhook
+    */
+    'url': string;
+    /**
+    * Description of the webhook
+    */
+    'description'?: 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` 
+    */
+    'events': Array<CreateWebhook.EventsEnum>;
+    /**
+    * Type of the webhook
+    */
+    'type'?: CreateWebhook.TypeEnum = CreateWebhook.TypeEnum.Transactional;
+    /**
+    * Inbound domain of webhook, required in case of event type `inbound`
+    */
+    'domain'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "url",
+            "baseName": "url",
+            "type": "string"
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string"
+        },
+        {
+            "name": "events",
+            "baseName": "events",
+            "type": "Array<CreateWebhook.EventsEnum>"
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "CreateWebhook.TypeEnum"
+        },
+        {
+            "name": "domain",
+            "baseName": "domain",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateWebhook.attributeTypeMap;
+    }
+}
+
+export namespace CreateWebhook {
+    export enum EventsEnum {
+        Sent = <any> 'sent',
+        HardBounce = <any> 'hardBounce',
+        SoftBounce = <any> 'softBounce',
+        Blocked = <any> 'blocked',
+        Spam = <any> 'spam',
+        Delivered = <any> 'delivered',
+        Request = <any> 'request',
+        Click = <any> 'click',
+        Invalid = <any> 'invalid',
+        Deferred = <any> 'deferred',
+        Opened = <any> 'opened',
+        UniqueOpened = <any> 'uniqueOpened',
+        Unsubscribed = <any> 'unsubscribed',
+        ListAddition = <any> 'listAddition',
+        ContactUpdated = <any> 'contactUpdated',
+        ContactDeleted = <any> 'contactDeleted',
+        InboundEmailProcessed = <any> 'inboundEmailProcessed'
+    }
+    export enum TypeEnum {
+        Transactional = <any> 'transactional',
+        Marketing = <any> 'marketing',
+        Inbound = <any> 'inbound'
+    }
+}

package/model/createWhatsAppCampaign.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { CreateWhatsAppCampaignRecipients } from './createWhatsAppCampaignRecipients';
+
+export class CreateWhatsAppCampaign {
+    /**
+    * Name of the WhatsApp campaign creation
+    */
+    'name': string;
+    /**
+    * Id of the WhatsApp template in **approved** state
+    */
+    'templateId': number;
+    /**
+    * 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** 
+    */
+    'scheduledAt': string;
+    'recipients': CreateWhatsAppCampaignRecipients;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "templateId",
+            "baseName": "templateId",
+            "type": "number"
+        },
+        {
+            "name": "scheduledAt",
+            "baseName": "scheduledAt",
+            "type": "string"
+        },
+        {
+            "name": "recipients",
+            "baseName": "recipients",
+            "type": "CreateWhatsAppCampaignRecipients"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateWhatsAppCampaign.attributeTypeMap;
+    }
+}
+

package/model/createWhatsAppCampaignRecipients.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 CreateWhatsAppCampaignRecipients {
+    /**
+    * List ids to exclude from the campaign
+    */
+    'excludedListIds'?: Array<number>;
+    /**
+    * **Mandatory if scheduledAt is not empty**. List Ids to send the campaign to 
+    */
+    'listIds'?: Array<number>;
+    /**
+    * **Mandatory if listIds are not used**. Segment ids to send the campaign to. 
+    */
+    'segments'?: Array<number>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "excludedListIds",
+            "baseName": "excludedListIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "listIds",
+            "baseName": "listIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "segments",
+            "baseName": "segments",
+            "type": "Array<number>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateWhatsAppCampaignRecipients.attributeTypeMap;
+    }
+}
+

package/model/createWhatsAppTemplate.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 CreateWhatsAppTemplate {
+    /**
+    * Name of the template
+    */
+    'name': string;
+    /**
+    * Language of the template. For Example : **en** for English 
+    */
+    'language': string;
+    /**
+    * Category of the template
+    */
+    'category': CreateWhatsAppTemplate.CategoryEnum;
+    /**
+    * 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 
+    */
+    'mediaUrl'?: string;
+    /**
+    * Body of the template. **Maximum allowed characters are 1024**
+    */
+    'bodyText': 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** 
+    */
+    'headerText'?: string;
+    /**
+    * source of the template
+    */
+    'source'?: CreateWhatsAppTemplate.SourceEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "language",
+            "baseName": "language",
+            "type": "string"
+        },
+        {
+            "name": "category",
+            "baseName": "category",
+            "type": "CreateWhatsAppTemplate.CategoryEnum"
+        },
+        {
+            "name": "mediaUrl",
+            "baseName": "mediaUrl",
+            "type": "string"
+        },
+        {
+            "name": "bodyText",
+            "baseName": "bodyText",
+            "type": "string"
+        },
+        {
+            "name": "headerText",
+            "baseName": "headerText",
+            "type": "string"
+        },
+        {
+            "name": "source",
+            "baseName": "source",
+            "type": "CreateWhatsAppTemplate.SourceEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateWhatsAppTemplate.attributeTypeMap;
+    }
+}
+
+export namespace CreateWhatsAppTemplate {
+    export enum CategoryEnum {
+        Marketing = <any> 'MARKETING',
+        Transactional = <any> 'TRANSACTIONAL'
+    }
+    export enum SourceEnum {
+        Automation = <any> 'Automation',
+        Conversation = <any> 'Conversation'
+    }
+}

package/model/createdBatchId.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 CreatedBatchId {
+    /**
+    * Batch ID of the request
+    */
+    'batchId': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "batchId",
+            "baseName": "batchId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreatedBatchId.attributeTypeMap;
+    }
+}
+

package/model/createdProcessId.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 CreatedProcessId {
+    /**
+    * Id of the process created
+    */
+    'processId': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "processId",
+            "baseName": "processId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreatedProcessId.attributeTypeMap;
+    }
+}
+

package/model/crmDealsIdPatchRequest.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 CrmDealsIdPatchRequest {
+    /**
+    * Name of deal
+    */
+    'name'?: string;
+    /**
+    * Attributes for deal update  If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`.  Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` 
+    */
+    'attributes'?: object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "attributes",
+            "baseName": "attributes",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CrmDealsIdPatchRequest.attributeTypeMap;
+    }
+}
+

package/model/crmDealsLinkUnlinkIdPatchRequest.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 CrmDealsLinkUnlinkIdPatchRequest {
+    /**
+    * Contact ids for contacts to be linked with deal
+    */
+    'linkContactIds'?: Array<number>;
+    /**
+    * Contact ids for contacts to be unlinked from deal
+    */
+    'unlinkContactIds'?: Array<number>;
+    /**
+    * Company ids to be linked with deal
+    */
+    'linkCompanyIds'?: Array<string>;
+    /**
+    * Company ids to be unlinked from deal
+    */
+    'unlinkCompanyIds'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "linkContactIds",
+            "baseName": "linkContactIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "unlinkContactIds",
+            "baseName": "unlinkContactIds",
+            "type": "Array<number>"
+        },
+        {
+            "name": "linkCompanyIds",
+            "baseName": "linkCompanyIds",
+            "type": "Array<string>"
+        },
+        {
+            "name": "unlinkCompanyIds",
+            "baseName": "unlinkCompanyIds",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CrmDealsLinkUnlinkIdPatchRequest.attributeTypeMap;
+    }
+}
+

package/model/crmDealsPost201Response.ts

@@ -0,0 +1,37 @@
+/**
+ * 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';
+
+/**
+* Created deal id
+*/
+export class CrmDealsPost201Response {
+    /**
+    * Unique deal id
+    */
+    'id': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CrmDealsPost201Response.attributeTypeMap;
+    }
+}
+

package/model/crmDealsPostRequest.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 CrmDealsPostRequest {
+    /**
+    * Name of deal
+    */
+    'name': string;
+    /**
+    * Attributes for deal creation  If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`.  Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` 
+    */
+    'attributes'?: object;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string"
+        },
+        {
+            "name": "attributes",
+            "baseName": "attributes",
+            "type": "object"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CrmDealsPostRequest.attributeTypeMap;
+    }
+}
+