@getbrevo/brevo 1.0.0

package/src/model/RemainingCreditModelChild.js

@@ -0,0 +1,86 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RemainingCreditModelChild = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The RemainingCreditModelChild model module.
+   * @module model/RemainingCreditModelChild
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RemainingCreditModelChild</code>.
+   * Credits remaining for child account
+   * @alias module:model/RemainingCreditModelChild
+   * @class
+   * @param sms {Number} SMS Credits remaining for child account
+   * @param email {Number} Email Credits remaining for child account
+   */
+  var exports = function(sms, email) {
+    this.sms = sms;
+    this.email = email;
+  };
+
+  /**
+   * Constructs a <code>RemainingCreditModelChild</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RemainingCreditModelChild} obj Optional instance to populate.
+   * @return {module:model/RemainingCreditModelChild} The populated <code>RemainingCreditModelChild</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('sms'))
+        obj.sms = ApiClient.convertToType(data['sms'], 'Number');
+      if (data.hasOwnProperty('email'))
+        obj.email = ApiClient.convertToType(data['email'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * SMS Credits remaining for child account
+   * @member {Number} sms
+   */
+  exports.prototype.sms = undefined;
+
+  /**
+   * Email Credits remaining for child account
+   * @member {Number} email
+   */
+  exports.prototype.email = undefined;
+
+
+  return exports;
+
+}));

package/src/model/RemainingCreditModelReseller.js

@@ -0,0 +1,85 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RemainingCreditModelReseller = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The RemainingCreditModelReseller model module.
+   * @module model/RemainingCreditModelReseller
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RemainingCreditModelReseller</code>.
+   * @alias module:model/RemainingCreditModelReseller
+   * @class
+   * @param sms {Number} SMS Credits remaining for reseller account
+   * @param email {Number} Email Credits remaining for reseller account
+   */
+  var exports = function(sms, email) {
+    this.sms = sms;
+    this.email = email;
+  };
+
+  /**
+   * Constructs a <code>RemainingCreditModelReseller</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RemainingCreditModelReseller} obj Optional instance to populate.
+   * @return {module:model/RemainingCreditModelReseller} The populated <code>RemainingCreditModelReseller</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('sms'))
+        obj.sms = ApiClient.convertToType(data['sms'], 'Number');
+      if (data.hasOwnProperty('email'))
+        obj.email = ApiClient.convertToType(data['email'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * SMS Credits remaining for reseller account
+   * @member {Number} sms
+   */
+  exports.prototype.sms = undefined;
+
+  /**
+   * Email Credits remaining for reseller account
+   * @member {Number} email
+   */
+  exports.prototype.email = undefined;
+
+
+  return exports;
+
+}));

package/src/model/RemoveContactFromList.js

@@ -0,0 +1,89 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RemoveContactFromList = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The RemoveContactFromList model module.
+   * @module model/RemoveContactFromList
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RemoveContactFromList</code>.
+   * @alias module:model/RemoveContactFromList
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>RemoveContactFromList</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RemoveContactFromList} obj Optional instance to populate.
+   * @return {module:model/RemoveContactFromList} The populated <code>RemoveContactFromList</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('emails'))
+        obj.emails = ApiClient.convertToType(data['emails'], ['String']);
+      if (data.hasOwnProperty('ids'))
+        obj.ids = ApiClient.convertToType(data['ids'], ['Number']);
+      if (data.hasOwnProperty('all'))
+        obj.all = ApiClient.convertToType(data['all'], 'Boolean');
+    }
+    return obj;
+  }
+
+  /**
+   * Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
+   * @member {Array.<String>} emails
+   */
+  exports.prototype.emails = undefined;
+
+  /**
+   * 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.
+   * @member {Array.<Number>} ids
+   */
+  exports.prototype.ids = undefined;
+
+  /**
+   * 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
+   * @member {Boolean} all
+   */
+  exports.prototype.all = undefined;
+
+
+  return exports;
+
+}));

package/src/model/RemoveCredits.js

@@ -0,0 +1,81 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RemoveCredits = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The RemoveCredits model module.
+   * @module model/RemoveCredits
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RemoveCredits</code>.
+   * @alias module:model/RemoveCredits
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>RemoveCredits</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RemoveCredits} obj Optional instance to populate.
+   * @return {module:model/RemoveCredits} The populated <code>RemoveCredits</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('sms'))
+        obj.sms = ApiClient.convertToType(data['sms'], 'Number');
+      if (data.hasOwnProperty('email'))
+        obj.email = ApiClient.convertToType(data['email'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Required if email credits are empty. SMS credits to be removed from the child account
+   * @member {Number} sms
+   */
+  exports.prototype.sms = undefined;
+
+  /**
+   * Required if sms credits are empty. Email credits to be removed from the child account
+   * @member {Number} email
+   */
+  exports.prototype.email = undefined;
+
+
+  return exports;
+
+}));

package/src/model/RequestContactExport.js

@@ -0,0 +1,90 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient', 'model/RequestContactExportCustomContactFilter'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./RequestContactExportCustomContactFilter'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RequestContactExport = factory(root.Brevo.ApiClient, root.Brevo.RequestContactExportCustomContactFilter);
+  }
+}(this, function(ApiClient, RequestContactExportCustomContactFilter) {
+  'use strict';
+
+  /**
+   * The RequestContactExport model module.
+   * @module model/RequestContactExport
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RequestContactExport</code>.
+   * @alias module:model/RequestContactExport
+   * @class
+   * @param customContactFilter {module:model/RequestContactExportCustomContactFilter} 
+   */
+  var exports = function(customContactFilter) {
+    this.customContactFilter = customContactFilter;
+  };
+
+  /**
+   * Constructs a <code>RequestContactExport</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RequestContactExport} obj Optional instance to populate.
+   * @return {module:model/RequestContactExport} The populated <code>RequestContactExport</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('exportAttributes'))
+        obj.exportAttributes = ApiClient.convertToType(data['exportAttributes'], ['String']);
+      if (data.hasOwnProperty('customContactFilter'))
+        obj.customContactFilter = RequestContactExportCustomContactFilter.constructFromObject(data['customContactFilter']);
+      if (data.hasOwnProperty('notifyUrl'))
+        obj.notifyUrl = ApiClient.convertToType(data['notifyUrl'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].
+   * @member {Array.<String>} exportAttributes
+   */
+  exports.prototype.exportAttributes = undefined;
+
+  /**
+   * @member {module:model/RequestContactExportCustomContactFilter} customContactFilter
+   */
+  exports.prototype.customContactFilter = undefined;
+
+  /**
+   * Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+   * @member {String} notifyUrl
+   */
+  exports.prototype.notifyUrl = undefined;
+
+
+  return exports;
+
+}));

package/src/model/RequestContactExportCustomContactFilter.js

@@ -0,0 +1,222 @@
+/*
+ * 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  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.RequestContactExportCustomContactFilter = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The RequestContactExportCustomContactFilter model module.
+   * @module model/RequestContactExportCustomContactFilter
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>RequestContactExportCustomContactFilter</code>.
+   * Set the filter for the contacts to be exported.
+   * @alias module:model/RequestContactExportCustomContactFilter
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>RequestContactExportCustomContactFilter</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:model/RequestContactExportCustomContactFilter} obj Optional instance to populate.
+   * @return {module:model/RequestContactExportCustomContactFilter} The populated <code>RequestContactExportCustomContactFilter</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('actionForContacts'))
+        obj.actionForContacts = ApiClient.convertToType(data['actionForContacts'], 'String');
+      if (data.hasOwnProperty('actionForEmailCampaigns'))
+        obj.actionForEmailCampaigns = ApiClient.convertToType(data['actionForEmailCampaigns'], 'String');
+      if (data.hasOwnProperty('actionForSmsCampaigns'))
+        obj.actionForSmsCampaigns = ApiClient.convertToType(data['actionForSmsCampaigns'], 'String');
+      if (data.hasOwnProperty('listId'))
+        obj.listId = ApiClient.convertToType(data['listId'], 'Number');
+      if (data.hasOwnProperty('emailCampaignId'))
+        obj.emailCampaignId = ApiClient.convertToType(data['emailCampaignId'], 'Number');
+      if (data.hasOwnProperty('smsCampaignId'))
+        obj.smsCampaignId = ApiClient.convertToType(data['smsCampaignId'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * 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. 
+   * @member {module:model/RequestContactExportCustomContactFilter.ActionForContactsEnum} actionForContacts
+   */
+  exports.prototype.actionForContacts = undefined;
+
+  /**
+   * 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). 
+   * @member {module:model/RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum} actionForEmailCampaigns
+   */
+  exports.prototype.actionForEmailCampaigns = undefined;
+
+  /**
+   * 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. 
+   * @member {module:model/RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum} actionForSmsCampaigns
+   */
+  exports.prototype.actionForSmsCampaigns = undefined;
+
+  /**
+   * Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
+   * @member {Number} listId
+   */
+  exports.prototype.listId = undefined;
+
+  /**
+   * 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.
+   * @member {Number} emailCampaignId
+   */
+  exports.prototype.emailCampaignId = undefined;
+
+  /**
+   * Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
+   * @member {Number} smsCampaignId
+   */
+  exports.prototype.smsCampaignId = undefined;
+
+
+
+  /**
+   * Allowed values for the <code>actionForContacts</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.ActionForContactsEnum = {
+    /**
+     * value: "allContacts"
+     * @const
+     */
+    allContacts: "allContacts",
+
+    /**
+     * value: "subscribed"
+     * @const
+     */
+    subscribed: "subscribed",
+
+    /**
+     * value: "unsubscribed"
+     * @const
+     */
+    unsubscribed: "unsubscribed",
+
+    /**
+     * value: "unsubscribedPerList"
+     * @const
+     */
+    unsubscribedPerList: "unsubscribedPerList"
+  };
+
+
+  /**
+   * Allowed values for the <code>actionForEmailCampaigns</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.ActionForEmailCampaignsEnum = {
+    /**
+     * value: "openers"
+     * @const
+     */
+    openers: "openers",
+
+    /**
+     * value: "nonOpeners"
+     * @const
+     */
+    nonOpeners: "nonOpeners",
+
+    /**
+     * value: "clickers"
+     * @const
+     */
+    clickers: "clickers",
+
+    /**
+     * value: "nonClickers"
+     * @const
+     */
+    nonClickers: "nonClickers",
+
+    /**
+     * value: "unsubscribed"
+     * @const
+     */
+    unsubscribed: "unsubscribed",
+
+    /**
+     * value: "hardBounces"
+     * @const
+     */
+    hardBounces: "hardBounces",
+
+    /**
+     * value: "softBounces"
+     * @const
+     */
+    softBounces: "softBounces"
+  };
+
+
+  /**
+   * Allowed values for the <code>actionForSmsCampaigns</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.ActionForSmsCampaignsEnum = {
+    /**
+     * value: "hardBounces"
+     * @const
+     */
+    hardBounces: "hardBounces",
+
+    /**
+     * value: "softBounces"
+     * @const
+     */
+    softBounces: "softBounces",
+
+    /**
+     * value: "unsubscribed"
+     * @const
+     */
+    unsubscribed: "unsubscribed"
+  };
+
+  return exports;
+
+}));