@getbrevo/brevo 1.0.0

package/src/model/GetReportsReports.js

@@ -0,0 +1,195 @@
+/*
+ * 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.GetReportsReports = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetReportsReports model module.
+   * @module model/GetReportsReports
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetReportsReports</code>.
+   * @alias module:model/GetReportsReports
+   * @class
+   * @param _date {Date} Date of the statistics
+   * @param requests {Number} Number of requests for the date
+   * @param delivered {Number} Number of delivered emails for the date
+   * @param hardBounces {Number} Number of hardbounces for the date
+   * @param softBounces {Number} Number of softbounces for the date
+   * @param clicks {Number} Number of clicks for the date
+   * @param uniqueClicks {Number} Number of unique clicks for the date
+   * @param opens {Number} Number of openings for the date
+   * @param uniqueOpens {Number} Number of unique openings for the date
+   * @param spamReports {Number} Number of complaints (spam reports) for the date
+   * @param blocked {Number} Number of blocked emails for the date
+   * @param invalid {Number} Number of invalid emails for the date
+   * @param unsubscribed {Number} Number of unsubscribed emails for the date
+   */
+  var exports = function(_date, requests, delivered, hardBounces, softBounces, clicks, uniqueClicks, opens, uniqueOpens, spamReports, blocked, invalid, unsubscribed) {
+    this._date = _date;
+    this.requests = requests;
+    this.delivered = delivered;
+    this.hardBounces = hardBounces;
+    this.softBounces = softBounces;
+    this.clicks = clicks;
+    this.uniqueClicks = uniqueClicks;
+    this.opens = opens;
+    this.uniqueOpens = uniqueOpens;
+    this.spamReports = spamReports;
+    this.blocked = blocked;
+    this.invalid = invalid;
+    this.unsubscribed = unsubscribed;
+  };
+
+  /**
+   * Constructs a <code>GetReportsReports</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/GetReportsReports} obj Optional instance to populate.
+   * @return {module:model/GetReportsReports} The populated <code>GetReportsReports</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('date'))
+        obj._date = ApiClient.convertToType(data['date'], 'Date');
+      if (data.hasOwnProperty('requests'))
+        obj.requests = ApiClient.convertToType(data['requests'], 'Number');
+      if (data.hasOwnProperty('delivered'))
+        obj.delivered = ApiClient.convertToType(data['delivered'], 'Number');
+      if (data.hasOwnProperty('hardBounces'))
+        obj.hardBounces = ApiClient.convertToType(data['hardBounces'], 'Number');
+      if (data.hasOwnProperty('softBounces'))
+        obj.softBounces = ApiClient.convertToType(data['softBounces'], 'Number');
+      if (data.hasOwnProperty('clicks'))
+        obj.clicks = ApiClient.convertToType(data['clicks'], 'Number');
+      if (data.hasOwnProperty('uniqueClicks'))
+        obj.uniqueClicks = ApiClient.convertToType(data['uniqueClicks'], 'Number');
+      if (data.hasOwnProperty('opens'))
+        obj.opens = ApiClient.convertToType(data['opens'], 'Number');
+      if (data.hasOwnProperty('uniqueOpens'))
+        obj.uniqueOpens = ApiClient.convertToType(data['uniqueOpens'], 'Number');
+      if (data.hasOwnProperty('spamReports'))
+        obj.spamReports = ApiClient.convertToType(data['spamReports'], 'Number');
+      if (data.hasOwnProperty('blocked'))
+        obj.blocked = ApiClient.convertToType(data['blocked'], 'Number');
+      if (data.hasOwnProperty('invalid'))
+        obj.invalid = ApiClient.convertToType(data['invalid'], 'Number');
+      if (data.hasOwnProperty('unsubscribed'))
+        obj.unsubscribed = ApiClient.convertToType(data['unsubscribed'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Date of the statistics
+   * @member {Date} _date
+   */
+  exports.prototype._date = undefined;
+
+  /**
+   * Number of requests for the date
+   * @member {Number} requests
+   */
+  exports.prototype.requests = undefined;
+
+  /**
+   * Number of delivered emails for the date
+   * @member {Number} delivered
+   */
+  exports.prototype.delivered = undefined;
+
+  /**
+   * Number of hardbounces for the date
+   * @member {Number} hardBounces
+   */
+  exports.prototype.hardBounces = undefined;
+
+  /**
+   * Number of softbounces for the date
+   * @member {Number} softBounces
+   */
+  exports.prototype.softBounces = undefined;
+
+  /**
+   * Number of clicks for the date
+   * @member {Number} clicks
+   */
+  exports.prototype.clicks = undefined;
+
+  /**
+   * Number of unique clicks for the date
+   * @member {Number} uniqueClicks
+   */
+  exports.prototype.uniqueClicks = undefined;
+
+  /**
+   * Number of openings for the date
+   * @member {Number} opens
+   */
+  exports.prototype.opens = undefined;
+
+  /**
+   * Number of unique openings for the date
+   * @member {Number} uniqueOpens
+   */
+  exports.prototype.uniqueOpens = undefined;
+
+  /**
+   * Number of complaints (spam reports) for the date
+   * @member {Number} spamReports
+   */
+  exports.prototype.spamReports = undefined;
+
+  /**
+   * Number of blocked emails for the date
+   * @member {Number} blocked
+   */
+  exports.prototype.blocked = undefined;
+
+  /**
+   * Number of invalid emails for the date
+   * @member {Number} invalid
+   */
+  exports.prototype.invalid = undefined;
+
+  /**
+   * Number of unsubscribed emails for the date
+   * @member {Number} unsubscribed
+   */
+  exports.prototype.unsubscribed = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetScheduledEmailByBatchId.js

@@ -0,0 +1,80 @@
+/*
+ * 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/GetScheduledEmailByBatchIdBatches'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./GetScheduledEmailByBatchIdBatches'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.GetScheduledEmailByBatchId = factory(root.Brevo.ApiClient, root.Brevo.GetScheduledEmailByBatchIdBatches);
+  }
+}(this, function(ApiClient, GetScheduledEmailByBatchIdBatches) {
+  'use strict';
+
+  /**
+   * The GetScheduledEmailByBatchId model module.
+   * @module model/GetScheduledEmailByBatchId
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetScheduledEmailByBatchId</code>.
+   * @alias module:model/GetScheduledEmailByBatchId
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>GetScheduledEmailByBatchId</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/GetScheduledEmailByBatchId} obj Optional instance to populate.
+   * @return {module:model/GetScheduledEmailByBatchId} The populated <code>GetScheduledEmailByBatchId</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('count'))
+        obj.count = ApiClient.convertToType(data['count'], 'Number');
+      if (data.hasOwnProperty('batches'))
+        obj.batches = ApiClient.convertToType(data['batches'], [GetScheduledEmailByBatchIdBatches]);
+    }
+    return obj;
+  }
+
+  /**
+   * Total number of batches
+   * @member {Number} count
+   */
+  exports.prototype.count = undefined;
+
+  /**
+   * @member {Array.<module:model/GetScheduledEmailByBatchIdBatches>} batches
+   */
+  exports.prototype.batches = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetScheduledEmailByBatchIdBatches.js

@@ -0,0 +1,127 @@
+/*
+ * 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.GetScheduledEmailByBatchIdBatches = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetScheduledEmailByBatchIdBatches model module.
+   * @module model/GetScheduledEmailByBatchIdBatches
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetScheduledEmailByBatchIdBatches</code>.
+   * @alias module:model/GetScheduledEmailByBatchIdBatches
+   * @class
+   * @param scheduledAt {Date} Datetime for which the batch was scheduled
+   * @param createdAt {Date} Datetime on which the batch was scheduled
+   * @param status {module:model/GetScheduledEmailByBatchIdBatches.StatusEnum} Current status of the scheduled batch
+   */
+  var exports = function(scheduledAt, createdAt, status) {
+    this.scheduledAt = scheduledAt;
+    this.createdAt = createdAt;
+    this.status = status;
+  };
+
+  /**
+   * Constructs a <code>GetScheduledEmailByBatchIdBatches</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/GetScheduledEmailByBatchIdBatches} obj Optional instance to populate.
+   * @return {module:model/GetScheduledEmailByBatchIdBatches} The populated <code>GetScheduledEmailByBatchIdBatches</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('scheduledAt'))
+        obj.scheduledAt = ApiClient.convertToType(data['scheduledAt'], 'Date');
+      if (data.hasOwnProperty('createdAt'))
+        obj.createdAt = ApiClient.convertToType(data['createdAt'], 'Date');
+      if (data.hasOwnProperty('status'))
+        obj.status = ApiClient.convertToType(data['status'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * Datetime for which the batch was scheduled
+   * @member {Date} scheduledAt
+   */
+  exports.prototype.scheduledAt = undefined;
+
+  /**
+   * Datetime on which the batch was scheduled
+   * @member {Date} createdAt
+   */
+  exports.prototype.createdAt = undefined;
+
+  /**
+   * Current status of the scheduled batch
+   * @member {module:model/GetScheduledEmailByBatchIdBatches.StatusEnum} status
+   */
+  exports.prototype.status = undefined;
+
+
+
+  /**
+   * Allowed values for the <code>status</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.StatusEnum = {
+    /**
+     * value: "inProgress"
+     * @const
+     */
+    inProgress: "inProgress",
+
+    /**
+     * value: "queued"
+     * @const
+     */
+    queued: "queued",
+
+    /**
+     * value: "processed"
+     * @const
+     */
+    processed: "processed",
+
+    /**
+     * value: "error"
+     * @const
+     */
+    error: "error"
+  };
+
+  return exports;
+
+}));

package/src/model/GetScheduledEmailByMessageId.js

@@ -0,0 +1,127 @@
+/*
+ * 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.GetScheduledEmailByMessageId = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetScheduledEmailByMessageId model module.
+   * @module model/GetScheduledEmailByMessageId
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetScheduledEmailByMessageId</code>.
+   * @alias module:model/GetScheduledEmailByMessageId
+   * @class
+   * @param scheduledAt {Date} Datetime for which the email was scheduled
+   * @param createdAt {Date} Datetime on which the email was scheduled
+   * @param status {module:model/GetScheduledEmailByMessageId.StatusEnum} Current status of the scheduled email
+   */
+  var exports = function(scheduledAt, createdAt, status) {
+    this.scheduledAt = scheduledAt;
+    this.createdAt = createdAt;
+    this.status = status;
+  };
+
+  /**
+   * Constructs a <code>GetScheduledEmailByMessageId</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/GetScheduledEmailByMessageId} obj Optional instance to populate.
+   * @return {module:model/GetScheduledEmailByMessageId} The populated <code>GetScheduledEmailByMessageId</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('scheduledAt'))
+        obj.scheduledAt = ApiClient.convertToType(data['scheduledAt'], 'Date');
+      if (data.hasOwnProperty('createdAt'))
+        obj.createdAt = ApiClient.convertToType(data['createdAt'], 'Date');
+      if (data.hasOwnProperty('status'))
+        obj.status = ApiClient.convertToType(data['status'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * Datetime for which the email was scheduled
+   * @member {Date} scheduledAt
+   */
+  exports.prototype.scheduledAt = undefined;
+
+  /**
+   * Datetime on which the email was scheduled
+   * @member {Date} createdAt
+   */
+  exports.prototype.createdAt = undefined;
+
+  /**
+   * Current status of the scheduled email
+   * @member {module:model/GetScheduledEmailByMessageId.StatusEnum} status
+   */
+  exports.prototype.status = undefined;
+
+
+
+  /**
+   * Allowed values for the <code>status</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.StatusEnum = {
+    /**
+     * value: "inProgress"
+     * @const
+     */
+    inProgress: "inProgress",
+
+    /**
+     * value: "queued"
+     * @const
+     */
+    queued: "queued",
+
+    /**
+     * value: "processed"
+     * @const
+     */
+    processed: "processed",
+
+    /**
+     * value: "error"
+     * @const
+     */
+    error: "error"
+  };
+
+  return exports;
+
+}));

package/src/model/GetSegments.js

@@ -0,0 +1,80 @@
+/*
+ * 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/GetSegmentsSegments'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./GetSegmentsSegments'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.GetSegments = factory(root.Brevo.ApiClient, root.Brevo.GetSegmentsSegments);
+  }
+}(this, function(ApiClient, GetSegmentsSegments) {
+  'use strict';
+
+  /**
+   * The GetSegments model module.
+   * @module model/GetSegments
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSegments</code>.
+   * @alias module:model/GetSegments
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>GetSegments</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/GetSegments} obj Optional instance to populate.
+   * @return {module:model/GetSegments} The populated <code>GetSegments</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('segments'))
+        obj.segments = GetSegmentsSegments.constructFromObject(data['segments']);
+      if (data.hasOwnProperty('count'))
+        obj.count = ApiClient.convertToType(data['count'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * @member {module:model/GetSegmentsSegments} segments
+   */
+  exports.prototype.segments = undefined;
+
+  /**
+   * Number of Segments available in your account
+   * @member {Number} count
+   */
+  exports.prototype.count = undefined;
+
+
+  return exports;
+
+}));