asana 1.0.2 → 2.0.0

package/dist/api/ProjectTemplatesApi.js

@@ -0,0 +1,256 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ProjectTemplatesApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _EmptyResponseData = require("../model/EmptyResponseData");
+var _ErrorResponse = require("../model/ErrorResponse");
+var _JobResponseData = require("../model/JobResponseData");
+var _ProjectTemplateGidInstantiateProjectBody = require("../model/ProjectTemplateGidInstantiateProjectBody");
+var _ProjectTemplateResponseArray = require("../model/ProjectTemplateResponseArray");
+var _ProjectTemplateResponseData = require("../model/ProjectTemplateResponseData");
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
+                                                                                                                                                                                                                                                                                                                                                                                               * Asana
+                                                                                                                                                                                                                                                                                                                                                                                               * This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * OpenAPI spec version: 1.0
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * NOTE: This class is auto generated by the swagger code generator program.
+                                                                                                                                                                                                                                                                                                                                                                                               * https://github.com/swagger-api/swagger-codegen.git
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * Swagger Codegen version: 3.0.46
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * Do not edit the class manually.
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               */
+/**
+* ProjectTemplates service.
+* @module api/ProjectTemplatesApi
+* @version 2.0.0
+*/
+var ProjectTemplatesApi = /*#__PURE__*/function () {
+  /**
+  * Constructs a new ProjectTemplatesApi. 
+  * @alias module:api/ProjectTemplatesApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instanc
+  e} if unspecified.
+  */
+  function ProjectTemplatesApi(apiClient) {
+    _classCallCheck(this, ProjectTemplatesApi);
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+  }
+
+  /**
+   * Callback function to receive the result of the deleteProjectTemplate operation.
+   * @callback moduleapi/ProjectTemplatesApi~deleteProjectTemplateCallback
+   * @param {String} error Error message, if any.
+   * @param {module:model/EmptyResponseData{ data The data returned by the service call.
+   * @param {String} response The complete HTTP response.
+   */
+
+  /**
+   * Delete a project template
+   * A specific, existing project template can be deleted by making a DELETE request on the URL for that project template.  Returns an empty data record.
+   * @param {String} project_template_gid Globally unique identifier for the project template.
+   * @param {module:api/ProjectTemplatesApi~deleteProjectTemplateCallback} callback The callback function, accepting three arguments: error, data, response
+   * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+   */
+  _createClass(ProjectTemplatesApi, [{
+    key: "deleteProjectTemplate",
+    value: function deleteProjectTemplate(project_template_gid, callback) {
+      var postBody = null;
+      // verify the required parameter 'project_template_gid' is set
+      if (project_template_gid === undefined || project_template_gid === null) {
+        throw new Error("Missing the required parameter 'project_template_gid' when calling deleteProjectTemplate");
+      }
+      var pathParams = {
+        'project_template_gid': project_template_gid
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['oauth2'];
+      var contentTypes = [];
+      var accepts = ['application/json; charset=UTF-8'];
+      var returnType = _EmptyResponseData.EmptyResponseData;
+      return this.apiClient.callApi('/project_templates/{project_template_gid}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, callback);
+    }
+    /**
+     * Callback function to receive the result of the getProjectTemplate operation.
+     * @callback moduleapi/ProjectTemplatesApi~getProjectTemplateCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ProjectTemplateResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a project template
+     * Returns the complete project template record for a single project template.
+     * @param {String} project_template_gid Globally unique identifier for the project template.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/ProjectTemplatesApi~getProjectTemplateCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+  }, {
+    key: "getProjectTemplate",
+    value: function getProjectTemplate(project_template_gid, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'project_template_gid' is set
+      if (project_template_gid === undefined || project_template_gid === null) {
+        throw new Error("Missing the required parameter 'project_template_gid' when calling getProjectTemplate");
+      }
+      var pathParams = {
+        'project_template_gid': project_template_gid
+      };
+      var queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['oauth2'];
+      var contentTypes = [];
+      var accepts = ['application/json; charset=UTF-8'];
+      var returnType = _ProjectTemplateResponseData.ProjectTemplateResponseData;
+      return this.apiClient.callApi('/project_templates/{project_template_gid}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, callback);
+    }
+    /**
+     * Callback function to receive the result of the getProjectTemplates operation.
+     * @callback moduleapi/ProjectTemplatesApi~getProjectTemplatesCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ProjectTemplateResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get multiple project templates
+     * Returns the compact project template records for all project templates in the given team or workspace.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.workspace The workspace to filter results on.
+     * @param {String} opts.team The team to filter projects on.
+     * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
+     * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. &#x27;Note: You can only pass in an offset that was returned to you via a previously paginated request.&#x27;
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/ProjectTemplatesApi~getProjectTemplatesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+  }, {
+    key: "getProjectTemplates",
+    value: function getProjectTemplates(opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {
+        'workspace': opts['workspace'],
+        'team': opts['team'],
+        'limit': opts['limit'],
+        'offset': opts['offset'],
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['oauth2'];
+      var contentTypes = [];
+      var accepts = ['application/json; charset=UTF-8'];
+      var returnType = _ProjectTemplateResponseArray.ProjectTemplateResponseArray;
+      return this.apiClient.callApi('/project_templates', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, callback);
+    }
+    /**
+     * Callback function to receive the result of the getProjectTemplatesForTeam operation.
+     * @callback moduleapi/ProjectTemplatesApi~getProjectTemplatesForTeamCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ProjectTemplateResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a team&#x27;s project templates
+     * Returns the compact project template records for all project templates in the team.
+     * @param {String} team_gid Globally unique identifier for the team.
+     * @param {Object} opts Optional parameters
+     * @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
+     * @param {String} opts.offset Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. &#x27;Note: You can only pass in an offset that was returned to you via a previously paginated request.&#x27;
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/ProjectTemplatesApi~getProjectTemplatesForTeamCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+  }, {
+    key: "getProjectTemplatesForTeam",
+    value: function getProjectTemplatesForTeam(team_gid, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'team_gid' is set
+      if (team_gid === undefined || team_gid === null) {
+        throw new Error("Missing the required parameter 'team_gid' when calling getProjectTemplatesForTeam");
+      }
+      var pathParams = {
+        'team_gid': team_gid
+      };
+      var queryParams = {
+        'limit': opts['limit'],
+        'offset': opts['offset'],
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['oauth2'];
+      var contentTypes = [];
+      var accepts = ['application/json; charset=UTF-8'];
+      var returnType = _ProjectTemplateResponseArray.ProjectTemplateResponseArray;
+      return this.apiClient.callApi('/teams/{team_gid}/project_templates', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, callback);
+    }
+    /**
+     * Callback function to receive the result of the instantiateProject operation.
+     * @callback moduleapi/ProjectTemplatesApi~instantiateProjectCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/JobResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Instantiate a project from a project template
+     * Creates and returns a job that will asynchronously handle the project instantiation.  To form this request, it is recommended to first make a request to [get a project template](/reference/getprojecttemplate). Then, from the response, copy the &#x60;gid&#x60; from the object in the &#x60;requested_dates&#x60; array. This &#x60;gid&#x60; should be used in &#x60;requested_dates&#x60; to instantiate a project.  _Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organization, use the [is_organization](/reference/workspaces) parameter._
+     * @param {String} project_template_gid Globally unique identifier for the project template.
+     * @param {Object} opts Optional parameters
+     * @param {module:model/ProjectTemplateGidInstantiateProjectBody} opts.body Describes the inputs used for instantiating a project, such as the resulting project&#x27;s name, which team it should be created in, and values for date variables.
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
+     * @param {module:api/ProjectTemplatesApi~instantiateProjectCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+  }, {
+    key: "instantiateProject",
+    value: function instantiateProject(project_template_gid, opts, callback) {
+      opts = opts || {};
+      var postBody = opts['body'];
+      // verify the required parameter 'project_template_gid' is set
+      if (project_template_gid === undefined || project_template_gid === null) {
+        throw new Error("Missing the required parameter 'project_template_gid' when calling instantiateProject");
+      }
+      var pathParams = {
+        'project_template_gid': project_template_gid
+      };
+      var queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['oauth2'];
+      var contentTypes = ['application/json; charset=UTF-8'];
+      var accepts = ['application/json; charset=UTF-8'];
+      var returnType = _JobResponseData.JobResponseData;
+      return this.apiClient.callApi('/project_templates/{project_template_gid}/instantiateProject', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, callback);
+    }
+  }]);
+  return ProjectTemplatesApi;
+}();
+exports.ProjectTemplatesApi = ProjectTemplatesApi;