@getbrevo/brevo 1.0.0

package/src/model/GetCampaignOverview.js

@@ -0,0 +1,249 @@
+/*
+ * 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.GetCampaignOverview = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetCampaignOverview model module.
+   * @module model/GetCampaignOverview
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetCampaignOverview</code>.
+   * @alias module:model/GetCampaignOverview
+   * @class
+   * @param id {Number} ID of the campaign
+   * @param name {String} Name of the campaign
+   * @param type {module:model/GetCampaignOverview.TypeEnum} Type of campaign
+   * @param status {module:model/GetCampaignOverview.StatusEnum} Status of the campaign
+   */
+  var exports = function(id, name, type, status) {
+    this.id = id;
+    this.name = name;
+    this.type = type;
+    this.status = status;
+  };
+
+  /**
+   * Constructs a <code>GetCampaignOverview</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/GetCampaignOverview} obj Optional instance to populate.
+   * @return {module:model/GetCampaignOverview} The populated <code>GetCampaignOverview</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('id'))
+        obj.id = ApiClient.convertToType(data['id'], 'Number');
+      if (data.hasOwnProperty('name'))
+        obj.name = ApiClient.convertToType(data['name'], 'String');
+      if (data.hasOwnProperty('subject'))
+        obj.subject = ApiClient.convertToType(data['subject'], 'String');
+      if (data.hasOwnProperty('previewText'))
+        obj.previewText = ApiClient.convertToType(data['previewText'], 'String');
+      if (data.hasOwnProperty('type'))
+        obj.type = ApiClient.convertToType(data['type'], 'String');
+      if (data.hasOwnProperty('status'))
+        obj.status = ApiClient.convertToType(data['status'], 'String');
+      if (data.hasOwnProperty('scheduledAt'))
+        obj.scheduledAt = ApiClient.convertToType(data['scheduledAt'], 'String');
+      if (data.hasOwnProperty('abTesting'))
+        obj.abTesting = ApiClient.convertToType(data['abTesting'], 'Boolean');
+      if (data.hasOwnProperty('subjectA'))
+        obj.subjectA = ApiClient.convertToType(data['subjectA'], 'String');
+      if (data.hasOwnProperty('subjectB'))
+        obj.subjectB = ApiClient.convertToType(data['subjectB'], 'String');
+      if (data.hasOwnProperty('splitRule'))
+        obj.splitRule = ApiClient.convertToType(data['splitRule'], 'Number');
+      if (data.hasOwnProperty('winnerCriteria'))
+        obj.winnerCriteria = ApiClient.convertToType(data['winnerCriteria'], 'String');
+      if (data.hasOwnProperty('winnerDelay'))
+        obj.winnerDelay = ApiClient.convertToType(data['winnerDelay'], 'Number');
+      if (data.hasOwnProperty('sendAtBestTime'))
+        obj.sendAtBestTime = ApiClient.convertToType(data['sendAtBestTime'], 'Boolean');
+    }
+    return obj;
+  }
+
+  /**
+   * ID of the campaign
+   * @member {Number} id
+   */
+  exports.prototype.id = undefined;
+
+  /**
+   * Name of the campaign
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
+   * @member {String} subject
+   */
+  exports.prototype.subject = undefined;
+
+  /**
+   * Preview text or preheader of the email campaign
+   * @member {String} previewText
+   */
+  exports.prototype.previewText = undefined;
+
+  /**
+   * Type of campaign
+   * @member {module:model/GetCampaignOverview.TypeEnum} type
+   */
+  exports.prototype.type = undefined;
+
+  /**
+   * Status of the campaign
+   * @member {module:model/GetCampaignOverview.StatusEnum} status
+   */
+  exports.prototype.status = undefined;
+
+  /**
+   * UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @member {String} scheduledAt
+   */
+  exports.prototype.scheduledAt = undefined;
+
+  /**
+   * Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
+   * @member {Boolean} abTesting
+   */
+  exports.prototype.abTesting = undefined;
+
+  /**
+   * Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
+   * @member {String} subjectA
+   */
+  exports.prototype.subjectA = undefined;
+
+  /**
+   * Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
+   * @member {String} subjectB
+   */
+  exports.prototype.subjectB = undefined;
+
+  /**
+   * The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
+   * @member {Number} splitRule
+   */
+  exports.prototype.splitRule = undefined;
+
+  /**
+   * Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
+   * @member {String} winnerCriteria
+   */
+  exports.prototype.winnerCriteria = undefined;
+
+  /**
+   * The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
+   * @member {Number} winnerDelay
+   */
+  exports.prototype.winnerDelay = undefined;
+
+  /**
+   * It is true if you have chosen to send your campaign at best time, otherwise it is false
+   * @member {Boolean} sendAtBestTime
+   */
+  exports.prototype.sendAtBestTime = undefined;
+
+
+
+  /**
+   * Allowed values for the <code>type</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.TypeEnum = {
+    /**
+     * value: "classic"
+     * @const
+     */
+    classic: "classic",
+
+    /**
+     * value: "trigger"
+     * @const
+     */
+    trigger: "trigger"
+  };
+
+
+  /**
+   * Allowed values for the <code>status</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.StatusEnum = {
+    /**
+     * value: "draft"
+     * @const
+     */
+    draft: "draft",
+
+    /**
+     * value: "sent"
+     * @const
+     */
+    sent: "sent",
+
+    /**
+     * value: "archive"
+     * @const
+     */
+    archive: "archive",
+
+    /**
+     * value: "queued"
+     * @const
+     */
+    queued: "queued",
+
+    /**
+     * value: "suspended"
+     * @const
+     */
+    suspended: "suspended",
+
+    /**
+     * value: "in_process"
+     * @const
+     */
+    inProcess: "in_process"
+  };
+
+  return exports;
+
+}));

package/src/model/GetCampaignRecipients.js

@@ -0,0 +1,83 @@
+/*
+ * 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.GetCampaignRecipients = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetCampaignRecipients model module.
+   * @module model/GetCampaignRecipients
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetCampaignRecipients</code>.
+   * @alias module:model/GetCampaignRecipients
+   * @class
+   * @param lists {Array.<Number>} 
+   * @param exclusionLists {Array.<Number>} 
+   */
+  var exports = function(lists, exclusionLists) {
+    this.lists = lists;
+    this.exclusionLists = exclusionLists;
+  };
+
+  /**
+   * Constructs a <code>GetCampaignRecipients</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/GetCampaignRecipients} obj Optional instance to populate.
+   * @return {module:model/GetCampaignRecipients} The populated <code>GetCampaignRecipients</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('lists'))
+        obj.lists = ApiClient.convertToType(data['lists'], ['Number']);
+      if (data.hasOwnProperty('exclusionLists'))
+        obj.exclusionLists = ApiClient.convertToType(data['exclusionLists'], ['Number']);
+    }
+    return obj;
+  }
+
+  /**
+   * @member {Array.<Number>} lists
+   */
+  exports.prototype.lists = undefined;
+
+  /**
+   * @member {Array.<Number>} exclusionLists
+   */
+  exports.prototype.exclusionLists = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetCampaignStats.js

@@ -0,0 +1,215 @@
+/*
+ * 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.GetCampaignStats = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetCampaignStats model module.
+   * @module model/GetCampaignStats
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetCampaignStats</code>.
+   * @alias module:model/GetCampaignStats
+   * @class
+   * @param uniqueClicks {Number} Number of unique clicks for the campaign
+   * @param clickers {Number} Number of total clicks for the campaign
+   * @param complaints {Number} Number of complaints (Spam reports) for the campaign
+   * @param delivered {Number} Number of delivered emails for the campaign
+   * @param sent {Number} Number of sent emails for the campaign
+   * @param softBounces {Number} Number of softbounce for the campaign
+   * @param hardBounces {Number} Number of harbounce for the campaign
+   * @param uniqueViews {Number} Number of unique openings for the campaign
+   * @param trackableViews {Number} Recipients without any privacy protection option enabled in their email client
+   * @param unsubscriptions {Number} Number of unsubscription for the campaign
+   * @param viewed {Number} Number of openings for the campaign
+   */
+  var exports = function(uniqueClicks, clickers, complaints, delivered, sent, softBounces, hardBounces, uniqueViews, trackableViews, unsubscriptions, viewed) {
+    this.uniqueClicks = uniqueClicks;
+    this.clickers = clickers;
+    this.complaints = complaints;
+    this.delivered = delivered;
+    this.sent = sent;
+    this.softBounces = softBounces;
+    this.hardBounces = hardBounces;
+    this.uniqueViews = uniqueViews;
+    this.trackableViews = trackableViews;
+    this.unsubscriptions = unsubscriptions;
+    this.viewed = viewed;
+  };
+
+  /**
+   * Constructs a <code>GetCampaignStats</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/GetCampaignStats} obj Optional instance to populate.
+   * @return {module:model/GetCampaignStats} The populated <code>GetCampaignStats</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('listId'))
+        obj.listId = ApiClient.convertToType(data['listId'], 'Number');
+      if (data.hasOwnProperty('uniqueClicks'))
+        obj.uniqueClicks = ApiClient.convertToType(data['uniqueClicks'], 'Number');
+      if (data.hasOwnProperty('clickers'))
+        obj.clickers = ApiClient.convertToType(data['clickers'], 'Number');
+      if (data.hasOwnProperty('complaints'))
+        obj.complaints = ApiClient.convertToType(data['complaints'], 'Number');
+      if (data.hasOwnProperty('delivered'))
+        obj.delivered = ApiClient.convertToType(data['delivered'], 'Number');
+      if (data.hasOwnProperty('sent'))
+        obj.sent = ApiClient.convertToType(data['sent'], 'Number');
+      if (data.hasOwnProperty('softBounces'))
+        obj.softBounces = ApiClient.convertToType(data['softBounces'], 'Number');
+      if (data.hasOwnProperty('hardBounces'))
+        obj.hardBounces = ApiClient.convertToType(data['hardBounces'], 'Number');
+      if (data.hasOwnProperty('uniqueViews'))
+        obj.uniqueViews = ApiClient.convertToType(data['uniqueViews'], 'Number');
+      if (data.hasOwnProperty('trackableViews'))
+        obj.trackableViews = ApiClient.convertToType(data['trackableViews'], 'Number');
+      if (data.hasOwnProperty('trackableViewsRate'))
+        obj.trackableViewsRate = ApiClient.convertToType(data['trackableViewsRate'], 'Number');
+      if (data.hasOwnProperty('estimatedViews'))
+        obj.estimatedViews = ApiClient.convertToType(data['estimatedViews'], 'Number');
+      if (data.hasOwnProperty('unsubscriptions'))
+        obj.unsubscriptions = ApiClient.convertToType(data['unsubscriptions'], 'Number');
+      if (data.hasOwnProperty('viewed'))
+        obj.viewed = ApiClient.convertToType(data['viewed'], 'Number');
+      if (data.hasOwnProperty('deferred'))
+        obj.deferred = ApiClient.convertToType(data['deferred'], 'Number');
+      if (data.hasOwnProperty('returnBounce'))
+        obj.returnBounce = ApiClient.convertToType(data['returnBounce'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * List Id of email campaign (only in case of get email campaign(s)(not for global stats))
+   * @member {Number} listId
+   */
+  exports.prototype.listId = undefined;
+
+  /**
+   * Number of unique clicks for the campaign
+   * @member {Number} uniqueClicks
+   */
+  exports.prototype.uniqueClicks = undefined;
+
+  /**
+   * Number of total clicks for the campaign
+   * @member {Number} clickers
+   */
+  exports.prototype.clickers = undefined;
+
+  /**
+   * Number of complaints (Spam reports) for the campaign
+   * @member {Number} complaints
+   */
+  exports.prototype.complaints = undefined;
+
+  /**
+   * Number of delivered emails for the campaign
+   * @member {Number} delivered
+   */
+  exports.prototype.delivered = undefined;
+
+  /**
+   * Number of sent emails for the campaign
+   * @member {Number} sent
+   */
+  exports.prototype.sent = undefined;
+
+  /**
+   * Number of softbounce for the campaign
+   * @member {Number} softBounces
+   */
+  exports.prototype.softBounces = undefined;
+
+  /**
+   * Number of harbounce for the campaign
+   * @member {Number} hardBounces
+   */
+  exports.prototype.hardBounces = undefined;
+
+  /**
+   * Number of unique openings for the campaign
+   * @member {Number} uniqueViews
+   */
+  exports.prototype.uniqueViews = undefined;
+
+  /**
+   * Recipients without any privacy protection option enabled in their email client
+   * @member {Number} trackableViews
+   */
+  exports.prototype.trackableViews = undefined;
+
+  /**
+   * Rate of recipients without any privacy protection option enabled in their email client
+   * @member {Number} trackableViewsRate
+   */
+  exports.prototype.trackableViewsRate = undefined;
+
+  /**
+   * Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails
+   * @member {Number} estimatedViews
+   */
+  exports.prototype.estimatedViews = undefined;
+
+  /**
+   * Number of unsubscription for the campaign
+   * @member {Number} unsubscriptions
+   */
+  exports.prototype.unsubscriptions = undefined;
+
+  /**
+   * Number of openings for the campaign
+   * @member {Number} viewed
+   */
+  exports.prototype.viewed = undefined;
+
+  /**
+   * Number of deferred emails for the campaign
+   * @member {Number} deferred
+   */
+  exports.prototype.deferred = undefined;
+
+  /**
+   * Total number of non-delivered campaigns for a particular campaign id.
+   * @member {Number} returnBounce
+   */
+  exports.prototype.returnBounce = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetCategories.js

@@ -0,0 +1,84 @@
+/*
+ * 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.GetCategories = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetCategories model module.
+   * @module model/GetCategories
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetCategories</code>.
+   * @alias module:model/GetCategories
+   * @class
+   * @param categories {Array.<Object>} 
+   * @param count {Number} Number of categories
+   */
+  var exports = function(categories, count) {
+    this.categories = categories;
+    this.count = count;
+  };
+
+  /**
+   * Constructs a <code>GetCategories</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/GetCategories} obj Optional instance to populate.
+   * @return {module:model/GetCategories} The populated <code>GetCategories</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('categories'))
+        obj.categories = ApiClient.convertToType(data['categories'], [Object]);
+      if (data.hasOwnProperty('count'))
+        obj.count = ApiClient.convertToType(data['count'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * @member {Array.<Object>} categories
+   */
+  exports.prototype.categories = undefined;
+
+  /**
+   * Number of categories
+   * @member {Number} count
+   */
+  exports.prototype.count = undefined;
+
+
+  return exports;
+
+}));