Skip to content

Commit 84c3a4d

Browse files
Updated JavaScript SDK: v3.1.8
1 parent fb2bdfa commit 84c3a4d

47 files changed

Lines changed: 53 additions & 53 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# asana [![GitHub release][release-image]][release-url] [![NPM Version][npm-image]][npm-url]
22

33
- API version: 1.0
4-
- Package version: 3.1.7
4+
- Package version: 3.1.8
55

66
## Installation
77

@@ -18,7 +18,7 @@ npm install asana --save
1818
Include the latest release directly from GitHub:
1919

2020
```html
21-
<script src="https://github.com/Asana/node-asana/releases/download/v3.1.7/asana-min.js"></script>
21+
<script src="https://github.com/Asana/node-asana/releases/download/v3.1.8/asana-min.js"></script>
2222
```
2323

2424
Example usage (**NOTE**: be careful not to expose your access token):
@@ -1119,6 +1119,6 @@ client.callApi(
11191119
```
11201120

11211121
[release-image]: https://img.shields.io/github/release/asana/node-asana.svg
1122-
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.1.7
1122+
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.1.8
11231123
[npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
11241124
[npm-url]: https://www.npmjs.org/package/asana

docs/TasksApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1161,7 +1161,7 @@ object
11611161

11621162
Search tasks in a workspace
11631163

1164-
<b>Required scope: </b><code>tasks:read</code> To mirror the functionality of the Asana web app's advanced search feature, the Asana API has a task search endpoint that allows you to build complex filters to find and retrieve the exact data you need. #### Premium access Like the Asana web product's advance search feature, this search endpoint will only be available to premium Asana users. A user is premium if any of the following is true: - The workspace in which the search is being performed is a premium workspace - The user is a member of a premium team inside the workspace Even if a user is only a member of a premium team inside a non-premium workspace, search will allow them to find data anywhere in the workspace, not just inside the premium team. Making a search request using credentials of a non-premium user will result in a `402 Payment Required` error. #### Pagination Search results are not stable; repeating the same query multiple times may return the data in a different order, even if the data do not change. Because of this, the traditional [pagination](https://developers.asana.com/docs/#pagination) available elsewhere in the Asana API is not available here. However, you can paginate manually by sorting the search results by their creation time and then modifying each subsequent query to exclude data you have already seen. Page sizes are limited to a maximum of 100 items, and can be specified by the `limit` query parameter. #### Eventual consistency Changes in Asana (regardless of whether they’re made though the web product or the API) are forwarded to our search infrastructure to be indexed. This process can take between 10 and 60 seconds to complete under normal operation, and longer during some production incidents. Making a change to a task that would alter its presence in a particular search query will not be reflected immediately. This is also true of the advanced search feature in the web product. #### Rate limits You may receive a `429 Too Many Requests` response if you hit any of our [rate limits](https://developers.asana.com/docs/#rate-limits). #### Custom field parameters | Parameter name | Custom field type | Accepted type | |---|---|---| | custom_fields.{gid}.is_set | All | Boolean | | custom_fields.{gid}.value | Text | String | | custom_fields.{gid}.value | Number | Number | | custom_fields.{gid}.value | Enum | Enum option ID | | custom_fields.{gid}.starts_with | Text only | String | | custom_fields.{gid}.ends_with | Text only | String | | custom_fields.{gid}.contains | Text only | String | | custom_fields.{gid}.less_than | Number only | Number | | custom_fields.{gid}.greater_than | Number only | Number | For example, if the gid of the custom field is 12345, these query parameter to find tasks where it is set would be `custom_fields.12345.is_set=true`. To match an exact value for an enum custom field, use the gid of the desired enum option and not the name of the enum option: `custom_fields.12345.value=67890`. **Not Supported**: searching for multiple exact matches of a custom field, searching for multi-enum custom field *Note: If you specify `projects.any` and `sections.any`, you will receive tasks for the project **and** tasks for the section. If you're looking for only tasks in a section, omit the `projects.any` from the request.*
1164+
<b>Required scope: </b><code>tasks:read</code> To mirror the functionality of the Asana web app's advanced search feature, the Asana API has a task search endpoint that allows you to build complex filters to find and retrieve the exact data you need. #### Premium access Like the Asana web product's advance search feature, this search endpoint will only be available to premium Asana users. A user is premium if any of the following is true: - The workspace in which the search is being performed is a premium workspace - The user is a member of a premium team inside the workspace Even if a user is only a member of a premium team inside a non-premium workspace, search will allow them to find data anywhere in the workspace, not just inside the premium team. Making a search request using credentials of a non-premium user will result in a `402 Payment Required` error. #### Pagination Search results are not stable; repeating the same query multiple times may return the data in a different order, even if the data do not change. Because of this, the traditional [pagination](https://developers.asana.com/docs/#pagination) available elsewhere in the Asana API is not available here. However, you can paginate manually by sorting the search results by their creation time and then modifying each subsequent query to exclude data you have already seen. Page sizes are limited to a maximum of 100 items, and can be specified by the `limit` query parameter. #### Eventual consistency Changes in Asana (regardless of whether they’re made though the web product or the API) are forwarded to our search infrastructure to be indexed. This process can take between 10 and 60 seconds to complete under normal operation, and longer during some production incidents. Making a change to a task that would alter its presence in a particular search query will not be reflected immediately. This is also true of the advanced search feature in the web product. Because of this delay, the search endpoint is not suited for use cases that require immediate consistency after writes. If you need read-your-write behavior or strongly consistent results, we recommend using [Get multiple tasks](/reference/gettasks) instead. #### Rate limits You may receive a `429 Too Many Requests` response if you hit any of our [rate limits](https://developers.asana.com/docs/#rate-limits). #### Custom field parameters | Parameter name | Custom field type | Accepted type | |---|---|---| | custom_fields.{gid}.is_set | All | Boolean | | custom_fields.{gid}.value | Text | String | | custom_fields.{gid}.value | Number | Number | | custom_fields.{gid}.value | Enum | Enum option ID | | custom_fields.{gid}.starts_with | Text only | String | | custom_fields.{gid}.ends_with | Text only | String | | custom_fields.{gid}.contains | Text only | String | | custom_fields.{gid}.less_than | Number only | Number | | custom_fields.{gid}.greater_than | Number only | Number | For example, if the gid of the custom field is 12345, these query parameter to find tasks where it is set would be `custom_fields.12345.is_set=true`. To match an exact value for an enum custom field, use the gid of the desired enum option and not the name of the enum option: `custom_fields.12345.value=67890`. **Not Supported**: searching for multiple exact matches of a custom field, searching for multi-enum custom field *Note: If you specify `projects.any` and `sections.any`, you will receive tasks for the project **and** tasks for the section. If you're looking for only tasks in a section, omit the `projects.any` from the request.*
11651165

11661166
([more information](https://developers.asana.com/reference/searchtasksforworkspace))
11671167

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "asana",
3-
"version": "3.1.7",
3+
"version": "3.1.8",
44
"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_",
55
"license": "Apache 2.0",
66
"main": "src/index.js",

src/ApiClient.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import superagent from "superagent";
1616

1717
/**
1818
* @module ApiClient
19-
* @version 3.1.7
19+
* @version 3.1.8
2020
*/
2121

2222
/**
@@ -417,7 +417,7 @@ export class ApiClient {
417417
if (typeof(navigator) === 'undefined' || typeof(window) === 'undefined') {
418418
headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
419419
{
420-
'version': "3.1.7",
420+
'version': "3.1.8",
421421
'language': 'NodeJS',
422422
'language_version': process.version,
423423
'os': process.platform
@@ -426,7 +426,7 @@ export class ApiClient {
426426
} else {
427427
headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
428428
{
429-
'version': "3.1.7",
429+
'version': "3.1.8",
430430
'language': 'BrowserJS'
431431
}
432432
).toString();

src/api/AccessRequestsApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* AccessRequests service.
2020
* @module api/AccessRequestsApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class AccessRequestsApi {
2424

src/api/AllocationsApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* Allocations service.
2020
* @module api/AllocationsApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class AllocationsApi {
2424

src/api/AttachmentsApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* Attachments service.
2020
* @module api/AttachmentsApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class AttachmentsApi {
2424

src/api/AuditLogAPIApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* AuditLogAPI service.
2020
* @module api/AuditLogAPIApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class AuditLogAPIApi {
2424

src/api/BatchAPIApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* BatchAPI service.
2020
* @module api/BatchAPIApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class BatchAPIApi {
2424

src/api/BudgetsApi.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
1818
/**
1919
* Budgets service.
2020
* @module api/BudgetsApi
21-
* @version 3.1.7
21+
* @version 3.1.8
2222
*/
2323
export class BudgetsApi {
2424

0 commit comments

Comments
 (0)