asana 3.1.2 → 3.1.3

package/src/api/RatesApi.js

@@ -0,0 +1,363 @@
+/*
+ * 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.54
+ *
+ * Do not edit the class manually.
+ *
+ */
+import {ApiClient} from "../ApiClient";
+var Collection = require('../utils/collection');
+
+/**
+* Rates service.
+* @module api/RatesApi
+* @version 3.1.3
+*/
+export class RatesApi {
+
+    /**
+    * Constructs a new RatesApi. 
+    * @alias module:api/RatesApi
+    * @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;
+    }
+
+
+
+    /**
+     * Create a rate
+     * Creates a new rate for a `parent` + `resource` combination.
+     * @param {module:model/Object} body The rate to create.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
+     */
+    createRateWithHttpInfo(body, opts) {
+        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 createRate");
+        }
+
+        let pathParams = {
+            
+        };
+        let queryParams = {};
+        opts = opts || {};
+        queryParams = opts;
+
+        let headerParams = {
+            
+        };
+        let formParams = {
+            
+        };
+
+        let authNames = ['personalAccessToken'];
+        let contentTypes = ['application/json; charset=UTF-8'];
+        let accepts = ['application/json; charset=UTF-8'];
+        let returnType = 'Blob';
+
+        return this.apiClient.callApi(
+            '/rates', 'POST',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType
+        );
+    }
+
+    /**
+     * Create a rate
+     * Creates a new rate for a &#x60;parent&#x60; + &#x60;resource&#x60; combination.
+     * @param {<&vendorExtensions.x-jsdoc-type>} body The rate to create.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RateResponseData}
+     */
+    createRate(body, opts) {
+
+        return this.createRateWithHttpInfo(body, opts)
+            .then(function(response_and_data) {
+                return response_and_data.data;
+            });
+    }
+
+
+    /**
+     * Delete a rate
+     * Deletes a rate.
+     * @param {String} rate_gid Globally unique identifier for the rate.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
+     */
+    deleteRateWithHttpInfo(rate_gid) {
+        
+        let postBody = null;
+        // verify the required parameter 'rate_gid' is set
+        if (rate_gid === undefined || rate_gid === null) {
+            throw new Error("Missing the required parameter 'rate_gid' when calling deleteRate");
+        }
+
+        let pathParams = {
+            'rate_gid': rate_gid
+        };
+        let queryParams = {};
+
+        let headerParams = {
+            
+        };
+        let formParams = {
+            
+        };
+
+        let authNames = ['personalAccessToken'];
+        let contentTypes = [];
+        let accepts = ['application/json; charset=UTF-8'];
+        let returnType = 'Blob';
+
+        return this.apiClient.callApi(
+            '/rates/{rate_gid}', 'DELETE',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType
+        );
+    }
+
+    /**
+     * Delete a rate
+     * Deletes a rate.
+     * @param {<&vendorExtensions.x-jsdoc-type>} rate_gid Globally unique identifier for the rate.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData}
+     */
+    deleteRate(rate_gid) {
+
+        return this.deleteRateWithHttpInfo(rate_gid)
+            .then(function(response_and_data) {
+                return response_and_data.data;
+            });
+    }
+
+
+    /**
+     * Get a rate
+     * Returns the complete rate record for a single rate.
+     * @param {String} rate_gid Globally unique identifier for the rate.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
+     */
+    getRateWithHttpInfo(rate_gid, opts) {
+        opts = opts || {};
+        let postBody = null;
+        // verify the required parameter 'rate_gid' is set
+        if (rate_gid === undefined || rate_gid === null) {
+            throw new Error("Missing the required parameter 'rate_gid' when calling getRate");
+        }
+
+        let pathParams = {
+            'rate_gid': rate_gid
+        };
+        let queryParams = {};
+        opts = opts || {};
+        queryParams = opts;
+
+        let headerParams = {
+            
+        };
+        let formParams = {
+            
+        };
+
+        let authNames = ['personalAccessToken'];
+        let contentTypes = [];
+        let accepts = ['application/json; charset=UTF-8'];
+        let returnType = 'Blob';
+
+        return this.apiClient.callApi(
+            '/rates/{rate_gid}', 'GET',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType
+        );
+    }
+
+    /**
+     * Get a rate
+     * Returns the complete rate record for a single rate.
+     * @param {<&vendorExtensions.x-jsdoc-type>} rate_gid Globally unique identifier for the rate.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RateResponseData}
+     */
+    getRate(rate_gid, opts) {
+
+        return this.getRateWithHttpInfo(rate_gid, opts)
+            .then(function(response_and_data) {
+                return response_and_data.data;
+            });
+    }
+
+
+    /**
+     * Get multiple rates
+     * Returns a list of &#x60;rate&#x60; records. The possible types for &#x60;parent&#x60; in this request are &#x60;project&#x60;. An additional &#x60;resource&#x60; (&#x60;user&#x60; GID or &#x60;placeholder&#x60; GID) can be passed in to filter to a specific rate.  Modifying placeholder rates is only available for Enterprise and Enterprise+ users.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.parent Globally unique identifier for &#x60;project&#x60;.
+     * @param {String} opts.resource Globally unique identifier for &#x60;user&#x60; or &#x60;placeholder&#x60;.
+     * @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. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
+     */
+    getRatesWithHttpInfo(opts) {
+        opts = opts || {};
+        let postBody = null;
+
+        let pathParams = {
+            
+        };
+        let queryParams = {};
+        opts = opts || {};
+        queryParams = opts;
+
+        let headerParams = {
+            
+        };
+        let formParams = {
+            
+        };
+
+        let authNames = ['personalAccessToken'];
+        let contentTypes = [];
+        let accepts = ['application/json; charset=UTF-8'];
+        let returnType = 'Blob';
+        // Check if RETURN_COLLECTION is set and return a collection object if it is
+        if (this.apiClient.RETURN_COLLECTION) {
+            return Collection.fromApiClient(
+                this.apiClient.callApi(
+                    '/rates', 'GET',
+                    pathParams, queryParams, headerParams, formParams, postBody,
+                    authNames, contentTypes, accepts, returnType
+                ),
+                this.apiClient,
+                {
+                    'path': '/rates',
+                    'httpMethod': 'GET',
+                    'pathParams': pathParams,
+                    'queryParams': queryParams,
+                    'headerParams': headerParams,
+                    'formParams': formParams,
+                    'bodyParam': postBody,
+                    'authNames': authNames,
+                    'contentTypes': contentTypes,
+                    'accepts': accepts,
+                    'returnType': returnType
+                }
+            )
+        }
+
+        return this.apiClient.callApi(
+            '/rates', 'GET',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType
+        );
+    }
+
+    /**
+     * Get multiple rates
+     * Returns a list of &#x60;rate&#x60; records. The possible types for &#x60;parent&#x60; in this request are &#x60;project&#x60;. An additional &#x60;resource&#x60; (&#x60;user&#x60; GID or &#x60;placeholder&#x60; GID) can be passed in to filter to a specific rate.  Modifying placeholder rates is only available for Enterprise and Enterprise+ users.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.parent Globally unique identifier for &#x60;project&#x60;.
+     * @param {String} opts.resource Globally unique identifier for &#x60;user&#x60; or &#x60;placeholder&#x60;.
+     * @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. *Note: You can only pass in an offset that was returned to you via a previously paginated request.*
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RateOrPlaceholderCompactArray}
+     */
+    getRates(opts) {
+        // Check if RETURN_COLLECTION is set and return a collection object if it is
+        if (this.apiClient.RETURN_COLLECTION) {
+            return this.getRatesWithHttpInfo(opts)
+        }
+
+        return this.getRatesWithHttpInfo(opts)
+            .then(function(response_and_data) {
+                return response_and_data.data;
+            });
+    }
+
+
+    /**
+     * Update a rate
+     * An existing rate can be updated by making a PUT request on the URL for that rate. Only the fields provided in the &#x60;data&#x60; block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the &#x60;rate&#x60; field.)  Returns the complete updated rate record.
+     * @param {module:model/Object} body The updated fields for the rate.
+     * @param {String} rate_gid Globally unique identifier for the rate.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
+     */
+    updateRateWithHttpInfo(body, rate_gid, opts) {
+        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 updateRate");
+        }
+        // verify the required parameter 'rate_gid' is set
+        if (rate_gid === undefined || rate_gid === null) {
+            throw new Error("Missing the required parameter 'rate_gid' when calling updateRate");
+        }
+
+        let pathParams = {
+            'rate_gid': rate_gid
+        };
+        let queryParams = {};
+        opts = opts || {};
+        queryParams = opts;
+
+        let headerParams = {
+            
+        };
+        let formParams = {
+            
+        };
+
+        let authNames = ['personalAccessToken'];
+        let contentTypes = ['application/json; charset=UTF-8'];
+        let accepts = ['application/json; charset=UTF-8'];
+        let returnType = 'Blob';
+
+        return this.apiClient.callApi(
+            '/rates/{rate_gid}', 'PUT',
+            pathParams, queryParams, headerParams, formParams, postBody,
+            authNames, contentTypes, accepts, returnType
+        );
+    }
+
+    /**
+     * Update a rate
+     * An existing rate can be updated by making a PUT request on the URL for that rate. Only the fields provided in the &#x60;data&#x60; block will be updated; any unspecified fields will remain unchanged. (note that at this time, the only field that can be updated is the &#x60;rate&#x60; field.)  Returns the complete updated rate record.
+     * @param {<&vendorExtensions.x-jsdoc-type>} body The updated fields for the rate.
+     * @param {<&vendorExtensions.x-jsdoc-type>} rate_gid Globally unique identifier for the rate.
+     * @param {Object} opts Optional parameters
+     * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RateResponseData}
+     */
+    updateRate(body, rate_gid, opts) {
+
+        return this.updateRateWithHttpInfo(body, rate_gid, opts)
+            .then(function(response_and_data) {
+                return response_and_data.data;
+            });
+    }
+
+}

package/src/api/ReactionsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Reactions service.
 * @module api/ReactionsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class ReactionsApi {
 

package/src/api/RulesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Rules service.
 * @module api/RulesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class RulesApi {
 

package/src/api/SectionsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Sections service.
 * @module api/SectionsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class SectionsApi {
 

package/src/api/StatusUpdatesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * StatusUpdates service.
 * @module api/StatusUpdatesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class StatusUpdatesApi {
 

package/src/api/StoriesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Stories service.
 * @module api/StoriesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class StoriesApi {
 

package/src/api/TagsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Tags service.
 * @module api/TagsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TagsApi {
 

package/src/api/TaskTemplatesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * TaskTemplates service.
 * @module api/TaskTemplatesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TaskTemplatesApi {
 

package/src/api/TasksApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Tasks service.
 * @module api/TasksApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TasksApi {
 
@@ -1947,7 +1947,7 @@ export class TasksApi {
 
     /**
      * Set the parent of a task
-     * <b>Required scope: </b><code>tasks:write</code>  parent, or no parent task at all. Returns an empty data block. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent.
+     * <b>Required scope: </b><code>tasks:write</code>  Updates the parent of a given task. This endpoint can be used to make a task a subtask of another task, or to remove its existing parent. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent. Returns the complete, updated record of the affected [task](/reference/tasks#/task).
      * @param {module:model/Object} body The new parent of the subtask.
      * @param {String} task_gid The task to operate on.
      * @param {Object} opts Optional parameters
@@ -1994,7 +1994,7 @@ export class TasksApi {
 
     /**
      * Set the parent of a task
-     * <b>Required scope: </b><code>tasks:write</code>  parent, or no parent task at all. Returns an empty data block. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent.
+     * <b>Required scope: </b><code>tasks:write</code>  Updates the parent of a given task. This endpoint can be used to make a task a subtask of another task, or to remove its existing parent. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent. Returns the complete, updated record of the affected [task](/reference/tasks#/task).
      * @param {<&vendorExtensions.x-jsdoc-type>} body The new parent of the subtask.
      * @param {<&vendorExtensions.x-jsdoc-type>} task_gid The task to operate on.
      * @param {Object} opts Optional parameters

package/src/api/TeamMembershipsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * TeamMemberships service.
 * @module api/TeamMembershipsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TeamMembershipsApi {
 

package/src/api/TeamsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Teams service.
 * @module api/TeamsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TeamsApi {
 

package/src/api/TimePeriodsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * TimePeriods service.
 * @module api/TimePeriodsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TimePeriodsApi {
 

package/src/api/TimeTrackingEntriesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * TimeTrackingEntries service.
 * @module api/TimeTrackingEntriesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TimeTrackingEntriesApi {
 
@@ -156,7 +156,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get multiple time tracking entries
-     * Returns a list of time tracking entries filtered to a task, attributed project, portfolio or user.
+     * <b>Required scope: </b><code>time_tracking_entries:read</code>  Returns a list of time tracking entries filtered to a task, attributed project, portfolio or user.
      * @param {Object} opts Optional parameters
      * @param {String} opts.task Globally unique identifier for the task to filter time tracking entries by.
      * @param {String} opts.attributable_to Globally unique identifier for the project the time tracking entries are attributed to.
@@ -224,7 +224,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get multiple time tracking entries
-     * Returns a list of time tracking entries filtered to a task, attributed project, portfolio or user.
+     * <b>Required scope: </b><code>time_tracking_entries:read</code>  Returns a list of time tracking entries filtered to a task, attributed project, portfolio or user.
      * @param {Object} opts Optional parameters
      * @param {String} opts.task Globally unique identifier for the task to filter time tracking entries by.
      * @param {String} opts.attributable_to Globally unique identifier for the project the time tracking entries are attributed to.
@@ -251,7 +251,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get time tracking entries for a task
-     * Returns time tracking entries for a given task.
+     * <b>Required scope: </b><code>time_tracking_entries:read</code>  Returns time tracking entries for a given task.
      * @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.
@@ -319,7 +319,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get time tracking entries for a task
-     * Returns time tracking entries for a given task.
+     * <b>Required scope: </b><code>time_tracking_entries:read</code>  Returns time tracking entries for a given task.
      * @param {<&vendorExtensions.x-jsdoc-type>} 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.
@@ -342,7 +342,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get a time tracking entry
-     * Returns the complete time tracking entry record for a single time tracking entry.
+     * &lt;b&gt;Required scope: &lt;/b&gt;&lt;code&gt;time_tracking_entries:read&lt;/code&gt;  Returns the complete time tracking entry record for a single time tracking entry.
      * @param {String} time_tracking_entry_gid Globally unique identifier for the time tracking entry.
      * @param {Object} opts Optional parameters
      * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.
@@ -384,7 +384,7 @@ export class TimeTrackingEntriesApi {
 
     /**
      * Get a time tracking entry
-     * Returns the complete time tracking entry record for a single time tracking entry.
+     * &lt;b&gt;Required scope: &lt;/b&gt;&lt;code&gt;time_tracking_entries:read&lt;/code&gt;  Returns the complete time tracking entry record for a single time tracking entry.
      * @param {<&vendorExtensions.x-jsdoc-type>} time_tracking_entry_gid Globally unique identifier for the time tracking entry.
      * @param {Object} opts Optional parameters
      * @param {Array.<module:model/String>} opts.opt_fields This endpoint returns a 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.

package/src/api/TypeaheadApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Typeahead service.
 * @module api/TypeaheadApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class TypeaheadApi {
 

package/src/api/UserTaskListsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * UserTaskLists service.
 * @module api/UserTaskListsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class UserTaskListsApi {
 

package/src/api/UsersApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Users service.
 * @module api/UsersApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class UsersApi {
 

package/src/api/WebhooksApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Webhooks service.
 * @module api/WebhooksApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class WebhooksApi {
 

package/src/api/WorkspaceMembershipsApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * WorkspaceMemberships service.
 * @module api/WorkspaceMembershipsApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class WorkspaceMembershipsApi {
 

package/src/api/WorkspacesApi.js

@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Workspaces service.
 * @module api/WorkspacesApi
-* @version 3.1.2
+* @version 3.1.3
 */
 export class WorkspacesApi {
 
@@ -334,7 +334,7 @@ export class WorkspacesApi {
 
     /**
      * Remove a user from a workspace or organization
-     * Remove a user from a workspace or organization. The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address. Returns an empty data record.
+     * Remove a user from a workspace or organization.  The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address.  When invoked using a **Service Account Token (SAT)**, this endpoint follows the same behavior as the [SCIM API Delete endpoint](/docs/scim). To learn more about how Asana handles user deprovisioning, refer to our [Help Center article on deprovisioning users](https://help.asana.com/s/article/user-deprovisioning).  When invoked using a **Personal Access Token (PAT)**, the endpoint behaves similarly, except that ownership of the user’s resources is transferred to the **PAT owner** instead of the admin [specified in the Admin Console](https://help.asana.com/s/article/user-deprovisioning#gl-deprovisioning).  **Note:** If you wish to retain access to a user’s private resources (i.e., those visible only to that user), you have to make them public manually (or ask the user to do so) before removal.  Returns an empty data record.
      * @param {module:model/Object} body The user to remove from the workspace.
      * @param {String} workspace_gid Globally unique identifier for the workspace or organization.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
@@ -377,7 +377,7 @@ export class WorkspacesApi {
 
     /**
      * Remove a user from a workspace or organization
-     * Remove a user from a workspace or organization. The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address. Returns an empty data record.
+     * Remove a user from a workspace or organization.  The user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address.  When invoked using a **Service Account Token (SAT)**, this endpoint follows the same behavior as the [SCIM API Delete endpoint](/docs/scim). To learn more about how Asana handles user deprovisioning, refer to our [Help Center article on deprovisioning users](https://help.asana.com/s/article/user-deprovisioning).  When invoked using a **Personal Access Token (PAT)**, the endpoint behaves similarly, except that ownership of the user’s resources is transferred to the **PAT owner** instead of the admin [specified in the Admin Console](https://help.asana.com/s/article/user-deprovisioning#gl-deprovisioning).  **Note:** If you wish to retain access to a user’s private resources (i.e., those visible only to that user), you have to make them public manually (or ask the user to do so) before removal.  Returns an empty data record.
      * @param {<&vendorExtensions.x-jsdoc-type>} body The user to remove from the workspace.
      * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData}