Updated JavaScript SDK: v3.0.15

Asana · Jan 17, 2025 · 2bdb2fd · 2bdb2fd
1 parent 23a247e
commit 2bdb2fd
Show file tree

Hide file tree

Showing 44 changed files with 76 additions and 82 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # asana [![GitHub release][release-image]][release-url] [![NPM Version][npm-image]][npm-url]
 
 - API version: 1.0
-- Package version: v3.0.14
+- Package version: 3.0.15
 
 ## Installation
 
@@ -18,7 +18,7 @@ npm install asana --save
 Include the latest release directly from GitHub:
 
 ```html
-<script src="https://github.com/Asana/node-asana/releases/download/vv3.0.14/asana-min.js"></script>
+<script src="https://github.com/Asana/node-asana/releases/download/v3.0.15/asana-min.js"></script>
 ```
 
 Example usage (**NOTE**: be careful not to expose your access token):
@@ -1111,6 +1111,6 @@ client.callApi(
 ```
 
 [release-image]: https://img.shields.io/github/release/asana/node-asana.svg
-[release-url]: https://github.com/Asana/node-asana/releases/tag/vv3.0.14
+[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.15
 [npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
 [npm-url]: https://www.npmjs.org/package/asana
diff --git a/docs/MembershipsApi.md b/docs/MembershipsApi.md
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 Create a membership
 
-Creates a new membership in a `goal`, `project`, or `portfolio`. Teams or users can be members of `goals` or `projects`. Portfolios only support `users` as members.  Returns the full record of the newly created membership.
+Creates a new membership in a `goal`, `project`, `portfolio`, or `custom_field`. Teams or Users can be members of `goals` or `projects`. Portfolios and custom fields only support `users` as members.  Returns the full record of the newly created membership.
 
 ([more information](https://developers.asana.com/reference/createmembership))
 
@@ -59,7 +59,7 @@ object
 
 Delete a membership
 
-A specific, existing membership for a `goal`, `project` and `portfolio` can be deleted by making a `DELETE` request on the URL for that membership.  Returns an empty data record.
+A specific, existing membership for a `goal`, `project`, `portfolio` or `custom_field` can be deleted by making a `DELETE` request on the URL for that membership.  Returns an empty data record.
 
 ([more information](https://developers.asana.com/reference/deletemembership))
 
@@ -102,7 +102,7 @@ object
 
 Get a membership
 
-Returns compact `project_membership` record for a single membership. `GET` only supports project memberships currently
+Returns a `project_membership`, `goal_membership`, `portfolio_membership`, or `custom_field_membership` record for a membership id.
 
 ([more information](https://developers.asana.com/reference/getmembership))
 
@@ -116,10 +116,8 @@ token.accessToken = '<YOUR_ACCESS_TOKEN>';
 
 let membershipsApiInstance = new Asana.MembershipsApi();
 let membership_gid = "12345"; // String | Globally unique identifier for the membership.
-let opts = { 
-    'opt_fields': "access_level,member,member.name,parent,parent.name,resource_subtype"
-};
-membershipsApiInstance.getMembership(membership_gid, opts).then((result) => {
+
+membershipsApiInstance.getMembership(membership_gid).then((result) => {
     console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
 }, (error) => {
     console.error(error.response.body);
@@ -132,7 +130,6 @@ membershipsApiInstance.getMembership(membership_gid, opts).then((result) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **membership_gid** | **String**| Globally unique identifier for the membership. | 
- **opt_fields** | **Object**| 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. | [optional] 
 
 ### Return type
 
@@ -148,7 +145,7 @@ object
 
 Get multiple memberships
 
-Returns compact `goal_membership`, `project_membership`, or `portfolio_membership` records. The possible types for `parent` in this request are `goal`, `project`, or `portfolio`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Teams are not supported for portfolios yet.
+Returns compact `goal_membership`, `project_membership`, `portfolio_membership`, or `custom_field_membership` records. The possible types for `parent` in this request are `goal`, `project`, `portfolio`, or `custom_field`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Team as members are not supported for portfolios or custom fields yet.
 
 ([more information](https://developers.asana.com/reference/getmemberships))
 
@@ -180,7 +177,7 @@ membershipsApiInstance.getMemberships(opts).then((result) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **parent** | **String**| Globally unique identifier for &#x60;goal&#x60;, &#x60;project&#x60;, or &#x60;portfolio&#x60;. | [optional] 
+ **parent** | **String**| Globally unique identifier for &#x60;goal&#x60;, &#x60;project&#x60;, &#x60;portfolio&#x60;, or &#x60;custom_field&#x60;. | [optional] 
  **member** | **String**| Globally unique identifier for &#x60;team&#x60; or &#x60;user&#x60;. | [optional] 
  **limit** | **Number**| Results per page. The number of objects to return per page. The value must be between 1 and 100. | [optional] 
  **offset** | **String**| 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.* | [optional] 
@@ -200,7 +197,7 @@ object
 
 Update a membership
 
-An existing membership can be updated by making a `PUT` request on the membership. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Memberships on `goals`, `projects` and `portfolios` can be updated.  Returns the full record of the updated membership.
+An existing membership can be updated by making a `PUT` request on the membership. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Memberships on `goals`, `projects`, `portfolios`, and `custom_fields` can be updated.  Returns the full record of the updated membership.
 
 ([more information](https://developers.asana.com/reference/updatemembership))
 

diff --git a/docs/MembershipsApi.yaml b/docs/MembershipsApi.yaml
@@ -41,10 +41,8 @@ MembershipsApi:
     
     let membershipsApiInstance = new Asana.MembershipsApi();
     let membership_gid = "12345"; // String | Globally unique identifier for the membership.
-    let opts = { 
-        'opt_fields': "access_level,member,member.name,parent,parent.name,resource_subtype"
-    };
-    membershipsApiInstance.getMembership(membership_gid, opts).then((result) => {
+
+    membershipsApiInstance.getMembership(membership_gid).then((result) => {
         console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
     }, (error) => {
         console.error(error.response.body);

diff --git a/docs/TasksApi.md b/docs/TasksApi.md
@@ -1215,6 +1215,7 @@ let opts = {
     'tags.not': "12345,23456,34567", 
     'tags.all': "12345,23456,34567", 
     'teams.any': "12345,23456,34567", 
+    'followers.any': "12345,23456,34567", 
     'followers.not': "12345,23456,34567", 
     'created_by.any': "12345,23456,34567", 
     'created_by.not': "12345,23456,34567", 
@@ -1290,6 +1291,7 @@ Name | Type | Description  | Notes
  **tags.not** | **String**| Comma-separated list of tag IDs | [optional] 
  **tags.all** | **String**| Comma-separated list of tag IDs | [optional] 
  **teams.any** | **String**| Comma-separated list of team IDs | [optional] 
+ **followers.any** | **String**| Comma-separated list of user identifiers | [optional] 
  **followers.not** | **String**| Comma-separated list of user identifiers | [optional] 
  **created_by.any** | **String**| Comma-separated list of user identifiers | [optional] 
  **created_by.not** | **String**| Comma-separated list of user identifiers | [optional] 

diff --git a/docs/TasksApi.yaml b/docs/TasksApi.yaml
@@ -473,6 +473,7 @@ TasksApi:
         'tags.not': "12345,23456,34567", 
         'tags.all': "12345,23456,34567", 
         'teams.any': "12345,23456,34567", 
+        'followers.any': "12345,23456,34567", 
         'followers.not': "12345,23456,34567", 
         'created_by.any': "12345,23456,34567", 
         'created_by.not': "12345,23456,34567", 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "asana",
-  "version": "v3.0.14",
+  "version": "3.0.15",
   "description": "This_is_the_interface_for_interacting_with_the__Asana_Platform_httpsdevelopers_asana_com__Our_API_reference_is_generated_from_our__OpenAPI_spec__httpsraw_githubusercontent_comAsanaopenapimasterdefsasana_oas_yaml_",
   "license": "Apache 2.0",
   "main": "src/index.js",

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -16,7 +16,7 @@ import superagent from "superagent";
 
 /**
 * @module ApiClient
-* @version v3.0.14
+* @version 3.0.15
 */
 
 /**
@@ -412,7 +412,7 @@ export class ApiClient {
         if (typeof(navigator) === 'undefined' || typeof(window) === 'undefined') {
             headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
                 {
-                    'version': "v3.0.14",
+                    'version': "3.0.15",
                     'language': 'NodeJS',
                     'language_version': process.version,
                     'os': process.platform
@@ -421,7 +421,7 @@ export class ApiClient {
         } else {
             headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
                 {
-                    'version': "v3.0.14",
+                    'version': "3.0.15",
                     'language': 'BrowserJS'
                 }
             ).toString();

diff --git a/src/api/AllocationsApi.js b/src/api/AllocationsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Allocations service.
 * @module api/AllocationsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class AllocationsApi {
 

diff --git a/src/api/AttachmentsApi.js b/src/api/AttachmentsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Attachments service.
 * @module api/AttachmentsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class AttachmentsApi {
 

diff --git a/src/api/AuditLogAPIApi.js b/src/api/AuditLogAPIApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * AuditLogAPI service.
 * @module api/AuditLogAPIApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class AuditLogAPIApi {
 

diff --git a/src/api/BatchAPIApi.js b/src/api/BatchAPIApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * BatchAPI service.
 * @module api/BatchAPIApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class BatchAPIApi {
 

diff --git a/src/api/CustomFieldSettingsApi.js b/src/api/CustomFieldSettingsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * CustomFieldSettings service.
 * @module api/CustomFieldSettingsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class CustomFieldSettingsApi {
 

diff --git a/src/api/CustomFieldsApi.js b/src/api/CustomFieldsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * CustomFields service.
 * @module api/CustomFieldsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class CustomFieldsApi {
 

diff --git a/src/api/EventsApi.js b/src/api/EventsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Events service.
 * @module api/EventsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class EventsApi {
 

diff --git a/src/api/GoalRelationshipsApi.js b/src/api/GoalRelationshipsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * GoalRelationships service.
 * @module api/GoalRelationshipsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class GoalRelationshipsApi {
 

diff --git a/src/api/GoalsApi.js b/src/api/GoalsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Goals service.
 * @module api/GoalsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class GoalsApi {
 

diff --git a/src/api/JobsApi.js b/src/api/JobsApi.js
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
 /**
 * Jobs service.
 * @module api/JobsApi
-* @version v3.0.14
+* @version 3.0.15
 */
 export class JobsApi {