@getbrevo/brevo 1.0.0

package/src/model/GetSegmentsSegments.js

@@ -0,0 +1,97 @@
+/*
+ * 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.GetSegmentsSegments = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetSegmentsSegments model module.
+   * @module model/GetSegmentsSegments
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSegmentsSegments</code>.
+   * @alias module:model/GetSegmentsSegments
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>GetSegmentsSegments</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/GetSegmentsSegments} obj Optional instance to populate.
+   * @return {module:model/GetSegmentsSegments} The populated <code>GetSegmentsSegments</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('segmentName'))
+        obj.segmentName = ApiClient.convertToType(data['segmentName'], 'String');
+      if (data.hasOwnProperty('categoryName'))
+        obj.categoryName = ApiClient.convertToType(data['categoryName'], 'String');
+      if (data.hasOwnProperty('updatedAt'))
+        obj.updatedAt = ApiClient.convertToType(data['updatedAt'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * ID of the list
+   * @member {Number} id
+   */
+  exports.prototype.id = undefined;
+
+  /**
+   * Name of the Segment
+   * @member {String} segmentName
+   */
+  exports.prototype.segmentName = undefined;
+
+  /**
+   * Name of the Segment Category
+   * @member {String} categoryName
+   */
+  exports.prototype.categoryName = undefined;
+
+  /**
+   * Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @member {String} updatedAt
+   */
+  exports.prototype.updatedAt = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetSendersList.js

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

package/src/model/GetSendersListIps.js

@@ -0,0 +1,95 @@
+/*
+ * 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.GetSendersListIps = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetSendersListIps model module.
+   * @module model/GetSendersListIps
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSendersListIps</code>.
+   * @alias module:model/GetSendersListIps
+   * @class
+   * @param ip {String} Dedicated IP available in your account
+   * @param domain {String} Domain of the IP
+   * @param weight {Number} Weight of the IP for this sender
+   */
+  var exports = function(ip, domain, weight) {
+    this.ip = ip;
+    this.domain = domain;
+    this.weight = weight;
+  };
+
+  /**
+   * Constructs a <code>GetSendersListIps</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/GetSendersListIps} obj Optional instance to populate.
+   * @return {module:model/GetSendersListIps} The populated <code>GetSendersListIps</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('ip'))
+        obj.ip = ApiClient.convertToType(data['ip'], 'String');
+      if (data.hasOwnProperty('domain'))
+        obj.domain = ApiClient.convertToType(data['domain'], 'String');
+      if (data.hasOwnProperty('weight'))
+        obj.weight = ApiClient.convertToType(data['weight'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Dedicated IP available in your account
+   * @member {String} ip
+   */
+  exports.prototype.ip = undefined;
+
+  /**
+   * Domain of the IP
+   * @member {String} domain
+   */
+  exports.prototype.domain = undefined;
+
+  /**
+   * Weight of the IP for this sender
+   * @member {Number} weight
+   */
+  exports.prototype.weight = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetSendersListSenders.js

@@ -0,0 +1,113 @@
+/*
+ * 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/GetSendersListIps'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./GetSendersListIps'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.GetSendersListSenders = factory(root.Brevo.ApiClient, root.Brevo.GetSendersListIps);
+  }
+}(this, function(ApiClient, GetSendersListIps) {
+  'use strict';
+
+  /**
+   * The GetSendersListSenders model module.
+   * @module model/GetSendersListSenders
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSendersListSenders</code>.
+   * @alias module:model/GetSendersListSenders
+   * @class
+   * @param id {Number} Id of the sender
+   * @param name {String} From Name associated to the sender
+   * @param email {String} From Email associated to the sender
+   * @param active {Boolean} Status of sender (true=activated, false=deactivated)
+   */
+  var exports = function(id, name, email, active) {
+    this.id = id;
+    this.name = name;
+    this.email = email;
+    this.active = active;
+  };
+
+  /**
+   * Constructs a <code>GetSendersListSenders</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/GetSendersListSenders} obj Optional instance to populate.
+   * @return {module:model/GetSendersListSenders} The populated <code>GetSendersListSenders</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('email'))
+        obj.email = ApiClient.convertToType(data['email'], 'String');
+      if (data.hasOwnProperty('active'))
+        obj.active = ApiClient.convertToType(data['active'], 'Boolean');
+      if (data.hasOwnProperty('ips'))
+        obj.ips = ApiClient.convertToType(data['ips'], [GetSendersListIps]);
+    }
+    return obj;
+  }
+
+  /**
+   * Id of the sender
+   * @member {Number} id
+   */
+  exports.prototype.id = undefined;
+
+  /**
+   * From Name associated to the sender
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * From Email associated to the sender
+   * @member {String} email
+   */
+  exports.prototype.email = undefined;
+
+  /**
+   * Status of sender (true=activated, false=deactivated)
+   * @member {Boolean} active
+   */
+  exports.prototype.active = undefined;
+
+  /**
+   * List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs
+   * @member {Array.<module:model/GetSendersListIps>} ips
+   */
+  exports.prototype.ips = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetSharedTemplateUrl.js

@@ -0,0 +1,75 @@
+/*
+ * 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.GetSharedTemplateUrl = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The GetSharedTemplateUrl model module.
+   * @module model/GetSharedTemplateUrl
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSharedTemplateUrl</code>.
+   * @alias module:model/GetSharedTemplateUrl
+   * @class
+   * @param sharedUrl {String} A unique URL for the email campaign or transactional template. This URL can be shared with other Brevo users.
+   */
+  var exports = function(sharedUrl) {
+    this.sharedUrl = sharedUrl;
+  };
+
+  /**
+   * Constructs a <code>GetSharedTemplateUrl</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/GetSharedTemplateUrl} obj Optional instance to populate.
+   * @return {module:model/GetSharedTemplateUrl} The populated <code>GetSharedTemplateUrl</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('sharedUrl'))
+        obj.sharedUrl = ApiClient.convertToType(data['sharedUrl'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * A unique URL for the email campaign or transactional template. This URL can be shared with other Brevo users.
+   * @member {String} sharedUrl
+   */
+  exports.prototype.sharedUrl = undefined;
+
+
+  return exports;
+
+}));

package/src/model/GetSmsCampaign.js

@@ -0,0 +1,95 @@
+/*
+ * 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/GetSmsCampaignOverview', 'model/GetSmsCampaignRecipients'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./GetSmsCampaignOverview'), require('./GetSmsCampaignRecipients'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.GetSmsCampaign = factory(root.Brevo.ApiClient, root.Brevo.GetSmsCampaignOverview, root.Brevo.GetSmsCampaignRecipients);
+  }
+}(this, function(ApiClient, GetSmsCampaignOverview, GetSmsCampaignRecipients) {
+  'use strict';
+
+  /**
+   * The GetSmsCampaign model module.
+   * @module model/GetSmsCampaign
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>GetSmsCampaign</code>.
+   * @alias module:model/GetSmsCampaign
+   * @class
+   * @extends module:model/GetSmsCampaignOverview
+   * @param id {Number} ID of the SMS Campaign
+   * @param name {String} Name of the SMS Campaign
+   * @param status {module:model/GetSmsCampaignOverview.StatusEnum} Status of the SMS Campaign
+   * @param content {String} Content of the SMS Campaign
+   * @param sender {String} Sender of the SMS Campaign
+   * @param createdAt {String} Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @param modifiedAt {String} UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
+   * @param recipients {module:model/GetSmsCampaignRecipients} 
+   * @param statistics {module:model/GetSmsCampaignRecipients} 
+   */
+  var exports = function(id, name, status, content, sender, createdAt, modifiedAt, recipients, statistics) {
+    GetSmsCampaignOverview.call(this, id, name, status, content, sender, createdAt, modifiedAt);
+    this.recipients = recipients;
+    this.statistics = statistics;
+  };
+
+  /**
+   * Constructs a <code>GetSmsCampaign</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/GetSmsCampaign} obj Optional instance to populate.
+   * @return {module:model/GetSmsCampaign} The populated <code>GetSmsCampaign</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      GetSmsCampaignOverview.constructFromObject(data, obj);
+      if (data.hasOwnProperty('recipients'))
+        obj.recipients = GetSmsCampaignRecipients.constructFromObject(data['recipients']);
+      if (data.hasOwnProperty('statistics'))
+        obj.statistics = GetSmsCampaignRecipients.constructFromObject(data['statistics']);
+    }
+    return obj;
+  }
+
+  exports.prototype = Object.create(GetSmsCampaignOverview.prototype);
+  exports.prototype.constructor = exports;
+  /**
+   * @member {module:model/GetSmsCampaignRecipients} recipients
+   */
+  exports.prototype.recipients = undefined;
+
+  /**
+   * @member {module:model/GetSmsCampaignRecipients} statistics
+   */
+  exports.prototype.statistics = undefined;
+
+
+  return exports;
+
+}));