@getbrevo/brevo 1.0.1 → 2.0.0-beta.2

package/model/postContactInfoContacts.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';
+
+export class PostContactInfoContacts {
+    'success'?: Array<string>;
+    'failure'?: Array<string>;
+    /**
+    * Displays the count of total number of contacts removed from list when user opts for \"all\" option.
+    */
+    'total'?: number;
+    /**
+    * Id of the process created to remove contacts from list when user opts for \"all\" option.
+    */
+    'processId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "success",
+            "baseName": "success",
+            "type": "Array<string>"
+        },
+        {
+            "name": "failure",
+            "baseName": "failure",
+            "type": "Array<string>"
+        },
+        {
+            "name": "total",
+            "baseName": "total",
+            "type": "number"
+        },
+        {
+            "name": "processId",
+            "baseName": "processId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PostContactInfoContacts.attributeTypeMap;
+    }
+}
+

package/model/postSendFailed.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 PostSendFailed {
+    /**
+    * Response code
+    */
+    'code': number;
+    /**
+    * Response message
+    */
+    'message': string;
+    'unexistingEmails'?: Array<string>;
+    'withoutListEmails'?: Array<string>;
+    'blackListedEmails'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "number"
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        },
+        {
+            "name": "unexistingEmails",
+            "baseName": "unexistingEmails",
+            "type": "Array<string>"
+        },
+        {
+            "name": "withoutListEmails",
+            "baseName": "withoutListEmails",
+            "type": "Array<string>"
+        },
+        {
+            "name": "blackListedEmails",
+            "baseName": "blackListedEmails",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PostSendFailed.attributeTypeMap;
+    }
+}
+

package/model/postSendSmsTestFailed.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';
+
+export class PostSendSmsTestFailed {
+    /**
+    * Response code
+    */
+    'code': number;
+    /**
+    * Response message
+    */
+    'message': string;
+    'unexistingSms'?: Array<string>;
+    'withoutListSms'?: Array<string>;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "code",
+            "baseName": "code",
+            "type": "number"
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string"
+        },
+        {
+            "name": "unexistingSms",
+            "baseName": "unexistingSms",
+            "type": "Array<string>"
+        },
+        {
+            "name": "withoutListSms",
+            "baseName": "withoutListSms",
+            "type": "Array<string>"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PostSendSmsTestFailed.attributeTypeMap;
+    }
+}
+

package/model/putRevokeUserPermission.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';
+
+/**
+* Revoke user permission
+*/
+export class PutRevokeUserPermission {
+    /**
+    * Email address of the user.
+    */
+    'email': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PutRevokeUserPermission.attributeTypeMap;
+    }
+}
+

package/model/putresendcancelinvitation.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';
+
+/**
+* Revoke user permission
+*/
+export class Putresendcancelinvitation {
+    /**
+    * Email address of the user.
+    */
+    'email': string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Putresendcancelinvitation.attributeTypeMap;
+    }
+}
+

package/model/remainingCreditModel.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { RemainingCreditModelChild } from './remainingCreditModelChild';
+import { RemainingCreditModelReseller } from './remainingCreditModelReseller';
+
+export class RemainingCreditModel {
+    'child': RemainingCreditModelChild;
+    'reseller': RemainingCreditModelReseller;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "child",
+            "baseName": "child",
+            "type": "RemainingCreditModelChild"
+        },
+        {
+            "name": "reseller",
+            "baseName": "reseller",
+            "type": "RemainingCreditModelReseller"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RemainingCreditModel.attributeTypeMap;
+    }
+}
+

package/model/remainingCreditModelChild.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';
+
+/**
+* Credits remaining for child account
+*/
+export class RemainingCreditModelChild {
+    /**
+    * SMS Credits remaining for child account
+    */
+    'sms': number;
+    /**
+    * Email Credits remaining for child account
+    */
+    'email': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "sms",
+            "baseName": "sms",
+            "type": "number"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RemainingCreditModelChild.attributeTypeMap;
+    }
+}
+

package/model/remainingCreditModelReseller.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 RemainingCreditModelReseller {
+    /**
+    * SMS Credits remaining for reseller account
+    */
+    'sms': number;
+    /**
+    * Email Credits remaining for reseller account
+    */
+    'email': number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "sms",
+            "baseName": "sms",
+            "type": "number"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RemainingCreditModelReseller.attributeTypeMap;
+    }
+}
+

package/model/removeContactFromList.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 RemoveContactFromList {
+    /**
+    * Required if \'all\' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
+    */
+    'emails'?: Array<string>;
+    /**
+    * Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.
+    */
+    'ids'?: Array<number>;
+    /**
+    * Required if none of \'emails\' or \'ids\' are passed. Remove all existing contacts from a list.  A process will be created in this scenario. You can fetch the process details to know about the progress
+    */
+    'all'?: boolean;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "emails",
+            "baseName": "emails",
+            "type": "Array<string>"
+        },
+        {
+            "name": "ids",
+            "baseName": "ids",
+            "type": "Array<number>"
+        },
+        {
+            "name": "all",
+            "baseName": "all",
+            "type": "boolean"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RemoveContactFromList.attributeTypeMap;
+    }
+}
+

package/model/removeCredits.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 RemoveCredits {
+    /**
+    * Required if email credits are empty. SMS credits to be removed from the child account
+    */
+    'sms'?: number;
+    /**
+    * Required if sms credits are empty. Email credits to be removed from the child account
+    */
+    'email'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "sms",
+            "baseName": "sms",
+            "type": "number"
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RemoveCredits.attributeTypeMap;
+    }
+}
+

package/model/requestContactExport.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { RequestContactExportCustomContactFilter } from './requestContactExportCustomContactFilter';
+
+export class RequestContactExport {
+    /**
+    * List of all the attributes that you want to export. These attributes must be present in your contact database. For example, [\'fname\', \'lname\', \'email\'].
+    */
+    'exportAttributes'?: Array<string>;
+    'customContactFilter': RequestContactExportCustomContactFilter;
+    /**
+    * Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+    */
+    'notifyUrl'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "exportAttributes",
+            "baseName": "exportAttributes",
+            "type": "Array<string>"
+        },
+        {
+            "name": "customContactFilter",
+            "baseName": "customContactFilter",
+            "type": "RequestContactExportCustomContactFilter"
+        },
+        {
+            "name": "notifyUrl",
+            "baseName": "notifyUrl",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestContactExport.attributeTypeMap;
+    }
+}
+

package/model/requestContactExportCustomContactFilter.ts

@@ -0,0 +1,104 @@
+/**
+ * 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';
+
+/**
+* Set the filter for the contacts to be exported.
+*/
+export class RequestContactExportCustomContactFilter {
+    /**
+    * Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. 
+    */
+    'actionForContacts'?: RequestContactExportCustomContactFilter.ActionForContactsEnum;
+    /**
+    * Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). 
+    */
+    'actionForEmailCampaigns'?: RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum;
+    /**
+    * Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. 
+    */
+    'actionForSmsCampaigns'?: RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum;
+    /**
+    * Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
+    */
+    'listId'?: number;
+    /**
+    * Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.
+    */
+    'emailCampaignId'?: number;
+    /**
+    * Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
+    */
+    'smsCampaignId'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "actionForContacts",
+            "baseName": "actionForContacts",
+            "type": "RequestContactExportCustomContactFilter.ActionForContactsEnum"
+        },
+        {
+            "name": "actionForEmailCampaigns",
+            "baseName": "actionForEmailCampaigns",
+            "type": "RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum"
+        },
+        {
+            "name": "actionForSmsCampaigns",
+            "baseName": "actionForSmsCampaigns",
+            "type": "RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum"
+        },
+        {
+            "name": "listId",
+            "baseName": "listId",
+            "type": "number"
+        },
+        {
+            "name": "emailCampaignId",
+            "baseName": "emailCampaignId",
+            "type": "number"
+        },
+        {
+            "name": "smsCampaignId",
+            "baseName": "smsCampaignId",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return RequestContactExportCustomContactFilter.attributeTypeMap;
+    }
+}
+
+export namespace RequestContactExportCustomContactFilter {
+    export enum ActionForContactsEnum {
+        AllContacts = <any> 'allContacts',
+        Subscribed = <any> 'subscribed',
+        Unsubscribed = <any> 'unsubscribed',
+        UnsubscribedPerList = <any> 'unsubscribedPerList'
+    }
+    export enum ActionForEmailCampaignsEnum {
+        Openers = <any> 'openers',
+        NonOpeners = <any> 'nonOpeners',
+        Clickers = <any> 'clickers',
+        NonClickers = <any> 'nonClickers',
+        Unsubscribed = <any> 'unsubscribed',
+        HardBounces = <any> 'hardBounces',
+        SoftBounces = <any> 'softBounces'
+    }
+    export enum ActionForSmsCampaignsEnum {
+        HardBounces = <any> 'hardBounces',
+        SoftBounces = <any> 'softBounces',
+        Unsubscribed = <any> 'unsubscribed'
+    }
+}