asana 1.0.2 → 2.0.0

package/src/api/TagsApi.js

@@ -0,0 +1,440 @@
+/*
+ * 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.
+ *
+ */
+import {ApiClient} from "../ApiClient";
+import {EmptyResponseData} from '../model/EmptyResponseData';
+import {ErrorResponse} from '../model/ErrorResponse';
+import {TagResponseArray} from '../model/TagResponseArray';
+import {TagResponseData} from '../model/TagResponseData';
+import {TagsBody} from '../model/TagsBody';
+import {WorkspaceGidTagsBody} from '../model/WorkspaceGidTagsBody';
+
+/**
+* Tags service.
+* @module api/TagsApi
+* @version 2.0.0
+*/
+export class TagsApi {
+
+    /**
+    * Constructs a new TagsApi. 
+    * @alias module:api/TagsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instanc
+    e} if unspecified.
+    */
+    constructor(apiClient) {
+        this.apiClient = apiClient || ApiClient.instance;
+    }
+
+    /**
+     * Callback function to receive the result of the createTag operation.
+     * @callback moduleapi/TagsApi~createTagCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Create a tag
+     * Creates a new tag in a workspace or organization.  Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.  Returns the full record of the newly created tag.
+     * @param {module:model/TagsBody} body The tag to create.
+     * @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/TagsApi~createTagCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    createTag(body, opts, callback) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling createTag");
+      }
+
+      let pathParams = {
+        
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = ['application/json; charset=UTF-8'];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseData;
+
+      return this.apiClient.callApi(
+        '/tags', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the createTagForWorkspace operation.
+     * @callback moduleapi/TagsApi~createTagForWorkspaceCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Create a tag in a workspace
+     * Creates a new tag in a workspace or organization.  Every tag is required to be created in a specific workspace or organization, and this cannot be changed once set. Note that you can use the workspace parameter regardless of whether or not it is an organization.  Returns the full record of the newly created tag.
+     * @param {module:model/WorkspaceGidTagsBody} body The tag to create.
+     * @param {String} workspace_gid Globally unique identifier for the workspace or organization.
+     * @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/TagsApi~createTagForWorkspaceCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    createTagForWorkspace(body, workspace_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = body;
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling createTagForWorkspace");
+      }
+      // verify the required parameter 'workspace_gid' is set
+      if (workspace_gid === undefined || workspace_gid === null) {
+        throw new Error("Missing the required parameter 'workspace_gid' when calling createTagForWorkspace");
+      }
+
+      let pathParams = {
+        'workspace_gid': workspace_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = ['application/json; charset=UTF-8'];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseData;
+
+      return this.apiClient.callApi(
+        '/workspaces/{workspace_gid}/tags', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the deleteTag operation.
+     * @callback moduleapi/TagsApi~deleteTagCallback
+     * @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 tag
+     * A specific, existing tag can be deleted by making a DELETE request on the URL for that tag.  Returns an empty data record.
+     * @param {String} tag_gid Globally unique identifier for the tag.
+     * @param {module:api/TagsApi~deleteTagCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    deleteTag(tag_gid, callback) {
+      
+      let postBody = null;
+      // verify the required parameter 'tag_gid' is set
+      if (tag_gid === undefined || tag_gid === null) {
+        throw new Error("Missing the required parameter 'tag_gid' when calling deleteTag");
+      }
+
+      let pathParams = {
+        'tag_gid': tag_gid
+      };
+      let queryParams = {
+        
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = EmptyResponseData;
+
+      return this.apiClient.callApi(
+        '/tags/{tag_gid}', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getTag operation.
+     * @callback moduleapi/TagsApi~getTagCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a tag
+     * Returns the complete tag record for a single tag.
+     * @param {String} tag_gid Globally unique identifier for the tag.
+     * @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/TagsApi~getTagCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getTag(tag_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'tag_gid' is set
+      if (tag_gid === undefined || tag_gid === null) {
+        throw new Error("Missing the required parameter 'tag_gid' when calling getTag");
+      }
+
+      let pathParams = {
+        'tag_gid': tag_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseData;
+
+      return this.apiClient.callApi(
+        '/tags/{tag_gid}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getTags operation.
+     * @callback moduleapi/TagsApi~getTagsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get multiple tags
+     * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
+     * @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 {String} opts.workspace The workspace to filter tags on.
+     * @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/TagsApi~getTagsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getTags(opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+
+      let pathParams = {
+        
+      };
+      let queryParams = {
+        'limit': opts['limit'],'offset': opts['offset'],'workspace': opts['workspace'],'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseArray;
+
+      return this.apiClient.callApi(
+        '/tags', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getTagsForTask operation.
+     * @callback moduleapi/TagsApi~getTagsForTaskCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a task&#x27;s tags
+     * Get a compact representation of all of the tags the task has.
+     * @param {String} task_gid The task to operate on.
+     * @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/TagsApi~getTagsForTaskCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getTagsForTask(task_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'task_gid' is set
+      if (task_gid === undefined || task_gid === null) {
+        throw new Error("Missing the required parameter 'task_gid' when calling getTagsForTask");
+      }
+
+      let pathParams = {
+        'task_gid': task_gid
+      };
+      let queryParams = {
+        'limit': opts['limit'],'offset': opts['offset'],'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseArray;
+
+      return this.apiClient.callApi(
+        '/tasks/{task_gid}/tags', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the getTagsForWorkspace operation.
+     * @callback moduleapi/TagsApi~getTagsForWorkspaceCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseArray{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get tags in a workspace
+     * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.
+     * @param {String} workspace_gid Globally unique identifier for the workspace or organization.
+     * @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/TagsApi~getTagsForWorkspaceCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    getTagsForWorkspace(workspace_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'workspace_gid' is set
+      if (workspace_gid === undefined || workspace_gid === null) {
+        throw new Error("Missing the required parameter 'workspace_gid' when calling getTagsForWorkspace");
+      }
+
+      let pathParams = {
+        'workspace_gid': workspace_gid
+      };
+      let queryParams = {
+        'limit': opts['limit'],'offset': opts['offset'],'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseArray;
+
+      return this.apiClient.callApi(
+        '/workspaces/{workspace_gid}/tags', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+    /**
+     * Callback function to receive the result of the updateTag operation.
+     * @callback moduleapi/TagsApi~updateTagCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TagResponseData{ data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Update a tag
+     * Updates the properties of a tag. Only the fields provided in the &#x60;data&#x60; block will be updated; any unspecified fields will remain unchanged.  When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the tag.  Returns the complete updated tag record.
+     * @param {String} tag_gid Globally unique identifier for the tag.
+     * @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/TagsApi~updateTagCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link <&vendorExtensions.x-jsdoc-type>}
+     */
+    updateTag(tag_gid, opts, callback) {
+      opts = opts || {};
+      let postBody = null;
+      // verify the required parameter 'tag_gid' is set
+      if (tag_gid === undefined || tag_gid === null) {
+        throw new Error("Missing the required parameter 'tag_gid' when calling updateTag");
+      }
+
+      let pathParams = {
+        'tag_gid': tag_gid
+      };
+      let queryParams = {
+        'opt_fields': this.apiClient.buildCollectionParam(opts['opt_fields'], 'csv')
+      };
+      let headerParams = {
+        
+      };
+      let formParams = {
+        
+      };
+
+      let authNames = ['oauth2'];
+      let contentTypes = [];
+      let accepts = ['application/json; charset=UTF-8'];
+      let returnType = TagResponseData;
+
+      return this.apiClient.callApi(
+        '/tags/{tag_gid}', 'PUT',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    }
+
+}