@getbrevo/brevo 1.0.0

package/src/api/DomainsApi.js

@@ -0,0 +1,297 @@
+/*
+ * 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/AuthenticateDomainModel', 'model/CreateDomain', 'model/CreateDomainModel', 'model/ErrorModel', 'model/GetDomainConfigurationModel', 'model/GetDomainsList'], factory);
+  } else if (typeof module === 'object' && module.exports) {
+    // CommonJS-like environments that support module.exports, like Node.
+    module.exports = factory(require('../ApiClient'), require('../model/AuthenticateDomainModel'), require('../model/CreateDomain'), require('../model/CreateDomainModel'), require('../model/ErrorModel'), require('../model/GetDomainConfigurationModel'), require('../model/GetDomainsList'));
+  } else {
+    // Browser globals (root is window)
+    if (!root.Brevo) {
+      root.Brevo = {};
+    }
+    root.Brevo.DomainsApi = factory(root.Brevo.ApiClient, root.Brevo.AuthenticateDomainModel, root.Brevo.CreateDomain, root.Brevo.CreateDomainModel, root.Brevo.ErrorModel, root.Brevo.GetDomainConfigurationModel, root.Brevo.GetDomainsList);
+  }
+}(this, function(ApiClient, AuthenticateDomainModel, CreateDomain, CreateDomainModel, ErrorModel, GetDomainConfigurationModel, GetDomainsList) {
+  'use strict';
+
+  /**
+   * Domains service.
+   * @module api/DomainsApi
+   * @version 1.0.0
+   */
+
+  /**
+   * Constructs a new DomainsApi. 
+   * @alias module:api/DomainsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  var exports = function(apiClient) {
+    this.apiClient = apiClient || ApiClient.instance;
+
+
+
+    /**
+     * Authenticate a domain
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AuthenticateDomainModel} and HTTP response
+     */
+    this.authenticateDomainWithHttpInfo = function(domainName) {
+      var postBody = null;
+
+      // verify the required parameter 'domainName' is set
+      if (domainName === undefined || domainName === null) {
+        throw new Error("Missing the required parameter 'domainName' when calling authenticateDomain");
+      }
+
+
+      var pathParams = {
+        'domainName': domainName
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key', 'partner-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = AuthenticateDomainModel;
+
+      return this.apiClient.callApi(
+        '/senders/domains/{domainName}/authenticate', 'PUT',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Authenticate a domain
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthenticateDomainModel}
+     */
+    this.authenticateDomain = function(domainName) {
+      return this.authenticateDomainWithHttpInfo(domainName)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Create a new domain
+     * @param {Object} opts Optional parameters
+     * @param {module:model/CreateDomain} opts.domainName domain's name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateDomainModel} and HTTP response
+     */
+    this.createDomainWithHttpInfo = function(opts) {
+      opts = opts || {};
+      var postBody = opts['domainName'];
+
+
+      var pathParams = {
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key', 'partner-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = CreateDomainModel;
+
+      return this.apiClient.callApi(
+        '/senders/domains', 'POST',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Create a new domain
+     * @param {Object} opts Optional parameters
+     * @param {module:model/CreateDomain} opts.domainName domain's name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateDomainModel}
+     */
+    this.createDomain = function(opts) {
+      return this.createDomainWithHttpInfo(opts)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Delete a domain
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    this.deleteDomainWithHttpInfo = function(domainName) {
+      var postBody = null;
+
+      // verify the required parameter 'domainName' is set
+      if (domainName === undefined || domainName === null) {
+        throw new Error("Missing the required parameter 'domainName' when calling deleteDomain");
+      }
+
+
+      var pathParams = {
+        'domainName': domainName
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key', 'partner-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = null;
+
+      return this.apiClient.callApi(
+        '/senders/domains/{domainName}', 'DELETE',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Delete a domain
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    this.deleteDomain = function(domainName) {
+      return this.deleteDomainWithHttpInfo(domainName)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Validate domain configuration
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDomainConfigurationModel} and HTTP response
+     */
+    this.getDomainConfigurationWithHttpInfo = function(domainName) {
+      var postBody = null;
+
+      // verify the required parameter 'domainName' is set
+      if (domainName === undefined || domainName === null) {
+        throw new Error("Missing the required parameter 'domainName' when calling getDomainConfiguration");
+      }
+
+
+      var pathParams = {
+        'domainName': domainName
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key', 'partner-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = GetDomainConfigurationModel;
+
+      return this.apiClient.callApi(
+        '/senders/domains/{domainName}', 'GET',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Validate domain configuration
+     * @param {String} domainName Domain name
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDomainConfigurationModel}
+     */
+    this.getDomainConfiguration = function(domainName) {
+      return this.getDomainConfigurationWithHttpInfo(domainName)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
+     * Get the list of all your domains
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDomainsList} and HTTP response
+     */
+    this.getDomainsWithHttpInfo = function() {
+      var postBody = null;
+
+
+      var pathParams = {
+      };
+      var queryParams = {
+      };
+      var collectionQueryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key', 'partner-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = GetDomainsList;
+
+      return this.apiClient.callApi(
+        '/senders/domains', 'GET',
+        pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Get the list of all your domains
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDomainsList}
+     */
+    this.getDomains = function() {
+      return this.getDomainsWithHttpInfo()
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+  };
+
+  return exports;
+}));