@getbrevo/brevo 1.0.0

package/src/model/UpdateList.js

@@ -0,0 +1,81 @@
+/*
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.UpdateList = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The UpdateList model module.
+   * @module model/UpdateList
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>UpdateList</code>.
+   * @alias module:model/UpdateList
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>UpdateList</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/UpdateList} obj Optional instance to populate.
+   * @return {module:model/UpdateList} The populated <code>UpdateList</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('name'))
+        obj.name = ApiClient.convertToType(data['name'], 'String');
+      if (data.hasOwnProperty('folderId'))
+        obj.folderId = ApiClient.convertToType(data['folderId'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Name of the list. Either of the two parameters (name, folderId) can be updated at a time.
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.
+   * @member {Number} folderId
+   */
+  exports.prototype.folderId = undefined;
+
+
+  return exports;
+
+}));

package/src/model/UpdateSender.js

@@ -0,0 +1,89 @@
+/*
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient', 'model/CreateSenderIps'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./CreateSenderIps'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.UpdateSender = factory(root.Brevo.ApiClient, root.Brevo.CreateSenderIps);
+  }
+}(this, function(ApiClient, CreateSenderIps) {
+  'use strict';
+
+  /**
+   * The UpdateSender model module.
+   * @module model/UpdateSender
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>UpdateSender</code>.
+   * @alias module:model/UpdateSender
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>UpdateSender</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/UpdateSender} obj Optional instance to populate.
+   * @return {module:model/UpdateSender} The populated <code>UpdateSender</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      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('ips'))
+        obj.ips = ApiClient.convertToType(data['ips'], [CreateSenderIps]);
+    }
+    return obj;
+  }
+
+  /**
+   * From Name to update the sender
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * From Email to update the sender
+   * @member {String} email
+   */
+  exports.prototype.email = undefined;
+
+  /**
+   * Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs.
+   * @member {Array.<module:model/CreateSenderIps>} ips
+   */
+  exports.prototype.ips = undefined;
+
+
+  return exports;
+
+}));

package/src/model/UpdateSmsCampaign.js

@@ -0,0 +1,129 @@
+/*
+ * 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/CreateSmsCampaignRecipients'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./CreateSmsCampaignRecipients'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.UpdateSmsCampaign = factory(root.Brevo.ApiClient, root.Brevo.CreateSmsCampaignRecipients);
+  }
+}(this, function(ApiClient, CreateSmsCampaignRecipients) {
+  'use strict';
+
+  /**
+   * The UpdateSmsCampaign model module.
+   * @module model/UpdateSmsCampaign
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>UpdateSmsCampaign</code>.
+   * @alias module:model/UpdateSmsCampaign
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>UpdateSmsCampaign</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/UpdateSmsCampaign} obj Optional instance to populate.
+   * @return {module:model/UpdateSmsCampaign} The populated <code>UpdateSmsCampaign</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('name'))
+        obj.name = ApiClient.convertToType(data['name'], 'String');
+      if (data.hasOwnProperty('sender'))
+        obj.sender = ApiClient.convertToType(data['sender'], 'String');
+      if (data.hasOwnProperty('content'))
+        obj.content = ApiClient.convertToType(data['content'], 'String');
+      if (data.hasOwnProperty('recipients'))
+        obj.recipients = CreateSmsCampaignRecipients.constructFromObject(data['recipients']);
+      if (data.hasOwnProperty('scheduledAt'))
+        obj.scheduledAt = ApiClient.convertToType(data['scheduledAt'], 'String');
+      if (data.hasOwnProperty('unicodeEnabled'))
+        obj.unicodeEnabled = ApiClient.convertToType(data['unicodeEnabled'], 'Boolean');
+      if (data.hasOwnProperty('organisationPrefix'))
+        obj.organisationPrefix = ApiClient.convertToType(data['organisationPrefix'], 'String');
+      if (data.hasOwnProperty('unsubscribeInstruction'))
+        obj.unsubscribeInstruction = ApiClient.convertToType(data['unsubscribeInstruction'], 'String');
+    }
+    return obj;
+  }
+
+  /**
+   * Name of the campaign
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
+   * @member {String} sender
+   */
+  exports.prototype.sender = undefined;
+
+  /**
+   * Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS
+   * @member {String} content
+   */
+  exports.prototype.content = undefined;
+
+  /**
+   * @member {module:model/CreateSmsCampaignRecipients} recipients
+   */
+  exports.prototype.recipients = undefined;
+
+  /**
+   * UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+   * @member {String} scheduledAt
+   */
+  exports.prototype.scheduledAt = undefined;
+
+  /**
+   * Format of the message. It indicates whether the content should be treated as unicode or not.
+   * @member {Boolean} unicodeEnabled
+   * @default false
+   */
+  exports.prototype.unicodeEnabled = false;
+
+  /**
+   * A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
+   * @member {String} organisationPrefix
+   */
+  exports.prototype.organisationPrefix = undefined;
+
+  /**
+   * Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
+   * @member {String} unsubscribeInstruction
+   */
+  exports.prototype.unsubscribeInstruction = undefined;
+
+
+  return exports;
+
+}));

package/src/model/UpdateSmtpTemplate.js

@@ -0,0 +1,144 @@
+/*
+ * 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/UpdateSmtpTemplateSender'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('./UpdateSmtpTemplateSender'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.UpdateSmtpTemplate = factory(root.Brevo.ApiClient, root.Brevo.UpdateSmtpTemplateSender);
+  }
+}(this, function(ApiClient, UpdateSmtpTemplateSender) {
+  'use strict';
+
+  /**
+   * The UpdateSmtpTemplate model module.
+   * @module model/UpdateSmtpTemplate
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>UpdateSmtpTemplate</code>.
+   * @alias module:model/UpdateSmtpTemplate
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>UpdateSmtpTemplate</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/UpdateSmtpTemplate} obj Optional instance to populate.
+   * @return {module:model/UpdateSmtpTemplate} The populated <code>UpdateSmtpTemplate</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      if (data.hasOwnProperty('tag'))
+        obj.tag = ApiClient.convertToType(data['tag'], 'String');
+      if (data.hasOwnProperty('sender'))
+        obj.sender = UpdateSmtpTemplateSender.constructFromObject(data['sender']);
+      if (data.hasOwnProperty('templateName'))
+        obj.templateName = ApiClient.convertToType(data['templateName'], 'String');
+      if (data.hasOwnProperty('htmlContent'))
+        obj.htmlContent = ApiClient.convertToType(data['htmlContent'], 'String');
+      if (data.hasOwnProperty('htmlUrl'))
+        obj.htmlUrl = ApiClient.convertToType(data['htmlUrl'], 'String');
+      if (data.hasOwnProperty('subject'))
+        obj.subject = ApiClient.convertToType(data['subject'], 'String');
+      if (data.hasOwnProperty('replyTo'))
+        obj.replyTo = ApiClient.convertToType(data['replyTo'], 'String');
+      if (data.hasOwnProperty('toField'))
+        obj.toField = ApiClient.convertToType(data['toField'], 'String');
+      if (data.hasOwnProperty('attachmentUrl'))
+        obj.attachmentUrl = ApiClient.convertToType(data['attachmentUrl'], 'String');
+      if (data.hasOwnProperty('isActive'))
+        obj.isActive = ApiClient.convertToType(data['isActive'], 'Boolean');
+    }
+    return obj;
+  }
+
+  /**
+   * Tag of the template
+   * @member {String} tag
+   */
+  exports.prototype.tag = undefined;
+
+  /**
+   * @member {module:model/UpdateSmtpTemplateSender} sender
+   */
+  exports.prototype.sender = undefined;
+
+  /**
+   * Name of the template
+   * @member {String} templateName
+   */
+  exports.prototype.templateName = undefined;
+
+  /**
+   * Required if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)
+   * @member {String} htmlContent
+   */
+  exports.prototype.htmlContent = undefined;
+
+  /**
+   * Required if htmlContent is empty. URL to the body of the email (HTML)
+   * @member {String} htmlUrl
+   */
+  exports.prototype.htmlUrl = undefined;
+
+  /**
+   * Subject of the email
+   * @member {String} subject
+   */
+  exports.prototype.subject = undefined;
+
+  /**
+   * Email on which campaign recipients will be able to reply to
+   * @member {String} replyTo
+   */
+  exports.prototype.replyTo = undefined;
+
+  /**
+   * To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
+   * @member {String} toField
+   */
+  exports.prototype.toField = undefined;
+
+  /**
+   * Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
+   * @member {String} attachmentUrl
+   */
+  exports.prototype.attachmentUrl = undefined;
+
+  /**
+   * Status of the template. isActive = false means template is inactive, isActive = true means template is active
+   * @member {Boolean} isActive
+   */
+  exports.prototype.isActive = undefined;
+
+
+  return exports;
+
+}));

package/src/model/UpdateSmtpTemplateSender.js

@@ -0,0 +1,90 @@
+/*
+ * Brevo API
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+ *
+ * OpenAPI spec version: 3.0.0
+ * Contact: contact@brevo.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.4.32
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+(function(root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define(['ApiClient'], 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.UpdateSmtpTemplateSender = factory(root.Brevo.ApiClient);
+  }
+}(this, function(ApiClient) {
+  'use strict';
+
+  /**
+   * The UpdateSmtpTemplateSender model module.
+   * @module model/UpdateSmtpTemplateSender
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new <code>UpdateSmtpTemplateSender</code>.
+   * Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` , `{\"name\":\"xyz\", \"id\":123}`
+   * @alias module:model/UpdateSmtpTemplateSender
+   * @class
+   */
+  var exports = function() {
+  };
+
+  /**
+   * Constructs a <code>UpdateSmtpTemplateSender</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/UpdateSmtpTemplateSender} obj Optional instance to populate.
+   * @return {module:model/UpdateSmtpTemplateSender} The populated <code>UpdateSmtpTemplateSender</code> instance.
+   */
+  exports.constructFromObject = function(data, obj) {
+    if (data) {
+      obj = obj || new exports();
+      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('id'))
+        obj.id = ApiClient.convertToType(data['id'], 'Number');
+    }
+    return obj;
+  }
+
+  /**
+   * Name of the sender
+   * @member {String} name
+   */
+  exports.prototype.name = undefined;
+
+  /**
+   * Email of the sender
+   * @member {String} email
+   */
+  exports.prototype.email = undefined;
+
+  /**
+   * Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email).
+   * @member {Number} id
+   */
+  exports.prototype.id = undefined;
+
+
+  return exports;
+
+}));