@getbrevo/brevo 1.0.0

package/src/model/GetAccountPlan.js

@@ -0,0 +1,171 @@
+/*
+ * 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.GetAccountPlan = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetAccountPlan model module.
+   * @module model/GetAccountPlan
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetAccountPlan</code>.
+   * @alias module:model/GetAccountPlan
+   * @class
+   * @param type {module:model/GetAccountPlan.TypeEnum} Displays the plan type of the user
+   * @param creditsType {module:model/GetAccountPlan.CreditsTypeEnum} This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
+   * @param credits {Number} Remaining credits of the user
+   */
+  var exports = function(type, creditsType, credits) {
+    this.type = type;
+    this.creditsType = creditsType;
+    this.credits = credits;
+  };
+
+  /**
+   * Constructs a <code>GetAccountPlan</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/GetAccountPlan} obj Optional instance to populate.
+   * @return {module:model/GetAccountPlan} The populated <code>GetAccountPlan</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('type'))
+        obj.type = ApiClient.convertToType(data['type'], 'String');
+      if (data.hasOwnProperty('creditsType'))
+        obj.creditsType = ApiClient.convertToType(data['creditsType'], 'String');
+      if (data.hasOwnProperty('credits'))
+        obj.credits = ApiClient.convertToType(data['credits'], 'Number');
+      if (data.hasOwnProperty('startDate'))
+        obj.startDate = ApiClient.convertToType(data['startDate'], 'Date');
+      if (data.hasOwnProperty('endDate'))
+        obj.endDate = ApiClient.convertToType(data['endDate'], 'Date');
+      if (data.hasOwnProperty('userLimit'))
+        obj.userLimit = ApiClient.convertToType(data['userLimit'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Displays the plan type of the user
+   * @member {module:model/GetAccountPlan.TypeEnum} type
+   */
+  exports.prototype.type = undefined;
+
+  /**
+   * This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
+   * @member {module:model/GetAccountPlan.CreditsTypeEnum} creditsType
+   */
+  exports.prototype.creditsType = undefined;
+
+  /**
+   * Remaining credits of the user
+   * @member {Number} credits
+   */
+  exports.prototype.credits = undefined;
+
+  /**
+   * Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type)
+   * @member {Date} startDate
+   */
+  exports.prototype.startDate = undefined;
+
+  /**
+   * Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type)
+   * @member {Date} endDate
+   */
+  exports.prototype.endDate = undefined;
+
+  /**
+   * Only in case of reseller account. It implies the total number of child accounts you can add to your account.
+   * @member {Number} userLimit
+   */
+  exports.prototype.userLimit = undefined;
+
+
+
+  /**
+   * Allowed values for the <code>type</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.TypeEnum = {
+    /**
+     * value: "payAsYouGo"
+     * @const
+     */
+    payAsYouGo: "payAsYouGo",
+
+    /**
+     * value: "free"
+     * @const
+     */
+    free: "free",
+
+    /**
+     * value: "subscription"
+     * @const
+     */
+    subscription: "subscription",
+
+    /**
+     * value: "sms"
+     * @const
+     */
+    sms: "sms",
+
+    /**
+     * value: "reseller"
+     * @const
+     */
+    reseller: "reseller"
+  };
+
+
+  /**
+   * Allowed values for the <code>creditsType</code> property.
+   * @enum {String}
+   * @readonly
+   */
+  exports.CreditsTypeEnum = {
+    /**
+     * value: "sendLimit"
+     * @const
+     */
+    sendLimit: "sendLimit"
+  };
+
+  return exports;
+
+}));

package/src/model/GetAccountRelay.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', 'model/GetAccountRelayData'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./GetAccountRelayData'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.GetAccountRelay = factory(root.Brevo.ApiClient, root.Brevo.GetAccountRelayData);
+  }
+}(this, function(ApiClient, GetAccountRelayData) {
+  'use strict';
+
+  /**
+   * The GetAccountRelay model module.
+   * @module model/GetAccountRelay
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetAccountRelay</code>.
+   * Information about your transactional email account
+   * @alias module:model/GetAccountRelay
+   * @class
+   * @param enabled {Boolean} Status of your transactional email Account (true=Enabled, false=Disabled)
+   * @param data {module:model/GetAccountRelayData} 
+   */
+  var exports = function(enabled, data) {
+    this.enabled = enabled;
+    this.data = data;
+  };
+
+  /**
+   * Constructs a <code>GetAccountRelay</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/GetAccountRelay} obj Optional instance to populate.
+   * @return {module:model/GetAccountRelay} The populated <code>GetAccountRelay</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('enabled'))
+        obj.enabled = ApiClient.convertToType(data['enabled'], 'Boolean');
+      if (data.hasOwnProperty('data'))
+        obj.data = GetAccountRelayData.constructFromObject(data['data']);
+    }
+    return obj;
+  }
+
+  /**
+   * Status of your transactional email Account (true=Enabled, false=Disabled)
+   * @member {Boolean} enabled
+   */
+  exports.prototype.enabled = undefined;
+
+  /**
+   * @member {module:model/GetAccountRelayData} data
+   */
+  exports.prototype.data = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetAccountRelayData.js

@@ -0,0 +1,96 @@
+/*
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * 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.GetAccountRelayData = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetAccountRelayData model module.
+   * @module model/GetAccountRelayData
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetAccountRelayData</code>.
+   * Data regarding the transactional email account
+   * @alias module:model/GetAccountRelayData
+   * @class
+   * @param userName {String} Email to use as login on transactional platform
+   * @param relay {String} URL of the SMTP Relay
+   * @param port {Number} Port used for SMTP Relay
+   */
+  var exports = function(userName, relay, port) {
+    this.userName = userName;
+    this.relay = relay;
+    this.port = port;
+  };
+
+  /**
+   * Constructs a <code>GetAccountRelayData</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/GetAccountRelayData} obj Optional instance to populate.
+   * @return {module:model/GetAccountRelayData} The populated <code>GetAccountRelayData</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('userName'))
+        obj.userName = ApiClient.convertToType(data['userName'], 'String');
+      if (data.hasOwnProperty('relay'))
+        obj.relay = ApiClient.convertToType(data['relay'], 'String');
+      if (data.hasOwnProperty('port'))
+        obj.port = ApiClient.convertToType(data['port'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Email to use as login on transactional platform
+   * @member {String} userName
+   */
+  exports.prototype.userName = undefined;
+
+  /**
+   * URL of the SMTP Relay
+   * @member {String} relay
+   */
+  exports.prototype.relay = undefined;
+
+  /**
+   * Port used for SMTP Relay
+   * @member {Number} port
+   */
+  exports.prototype.port = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetAggregatedReport.js

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

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