asana 3.0.8 → 3.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/ApiClient.js +3 -3
- package/dist/api/AllocationsApi.js +1 -1
- package/dist/api/AttachmentsApi.js +1 -1
- package/dist/api/AuditLogAPIApi.js +1 -1
- package/dist/api/BatchAPIApi.js +1 -1
- package/dist/api/CustomFieldSettingsApi.js +1 -1
- package/dist/api/CustomFieldsApi.js +1 -1
- package/dist/api/EventsApi.js +1 -1
- package/dist/api/GoalRelationshipsApi.js +1 -1
- package/dist/api/GoalsApi.js +1 -1
- package/dist/api/JobsApi.js +1 -1
- package/dist/api/MembershipsApi.js +5 -5
- package/dist/api/OrganizationExportsApi.js +1 -1
- package/dist/api/PortfolioMembershipsApi.js +1 -1
- package/dist/api/PortfoliosApi.js +1 -1
- package/dist/api/ProjectBriefsApi.js +1 -1
- package/dist/api/ProjectMembershipsApi.js +1 -1
- package/dist/api/ProjectStatusesApi.js +1 -1
- package/dist/api/ProjectTemplatesApi.js +1 -1
- package/dist/api/ProjectsApi.js +1 -1
- package/dist/api/RulesApi.js +1 -1
- package/dist/api/SectionsApi.js +1 -1
- package/dist/api/StatusUpdatesApi.js +1 -1
- package/dist/api/StoriesApi.js +1 -1
- package/dist/api/TagsApi.js +1 -1
- package/dist/api/TaskTemplatesApi.js +1 -1
- package/dist/api/TasksApi.js +1 -1
- package/dist/api/TeamMembershipsApi.js +1 -1
- package/dist/api/TeamsApi.js +1 -1
- package/dist/api/TimePeriodsApi.js +1 -1
- package/dist/api/TimeTrackingEntriesApi.js +1 -1
- package/dist/api/TypeaheadApi.js +1 -1
- package/dist/api/UserTaskListsApi.js +1 -1
- package/dist/api/UsersApi.js +1 -1
- package/dist/api/WebhooksApi.js +3 -3
- package/dist/api/WorkspaceMembershipsApi.js +1 -1
- package/dist/api/WorkspacesApi.js +1 -1
- package/package.json +1 -1
- package/src/ApiClient.js +3 -3
- package/src/api/AllocationsApi.js +1 -1
- package/src/api/AttachmentsApi.js +1 -1
- package/src/api/AuditLogAPIApi.js +1 -1
- package/src/api/BatchAPIApi.js +1 -1
- package/src/api/CustomFieldSettingsApi.js +1 -1
- package/src/api/CustomFieldsApi.js +1 -1
- package/src/api/EventsApi.js +1 -1
- package/src/api/GoalRelationshipsApi.js +1 -1
- package/src/api/GoalsApi.js +1 -1
- package/src/api/JobsApi.js +1 -1
- package/src/api/MembershipsApi.js +5 -5
- package/src/api/OrganizationExportsApi.js +1 -1
- package/src/api/PortfolioMembershipsApi.js +1 -1
- package/src/api/PortfoliosApi.js +1 -1
- package/src/api/ProjectBriefsApi.js +1 -1
- package/src/api/ProjectMembershipsApi.js +1 -1
- package/src/api/ProjectStatusesApi.js +1 -1
- package/src/api/ProjectTemplatesApi.js +1 -1
- package/src/api/ProjectsApi.js +1 -1
- package/src/api/RulesApi.js +1 -1
- package/src/api/SectionsApi.js +1 -1
- package/src/api/StatusUpdatesApi.js +1 -1
- package/src/api/StoriesApi.js +1 -1
- package/src/api/TagsApi.js +1 -1
- package/src/api/TaskTemplatesApi.js +1 -1
- package/src/api/TasksApi.js +1 -1
- package/src/api/TeamMembershipsApi.js +1 -1
- package/src/api/TeamsApi.js +1 -1
- package/src/api/TimePeriodsApi.js +1 -1
- package/src/api/TimeTrackingEntriesApi.js +1 -1
- package/src/api/TypeaheadApi.js +1 -1
- package/src/api/UserTaskListsApi.js +1 -1
- package/src/api/UsersApi.js +1 -1
- package/src/api/WebhooksApi.js +3 -3
- package/src/api/WorkspaceMembershipsApi.js +1 -1
- package/src/api/WorkspacesApi.js +1 -1
- package/src/index.js +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# asana [![GitHub release][release-image]][release-url] [![NPM Version][npm-image]][npm-url]
|
|
2
2
|
|
|
3
3
|
- API version: 1.0
|
|
4
|
-
- Package version: 3.0.
|
|
4
|
+
- Package version: 3.0.9
|
|
5
5
|
|
|
6
6
|
## Installation
|
|
7
7
|
|
|
@@ -18,7 +18,7 @@ npm install asana --save
|
|
|
18
18
|
Include the latest release directly from GitHub:
|
|
19
19
|
|
|
20
20
|
```html
|
|
21
|
-
<script src="https://github.com/Asana/node-asana/releases/download/v3.0.
|
|
21
|
+
<script src="https://github.com/Asana/node-asana/releases/download/v3.0.9/asana-min.js"></script>
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Example usage (**NOTE**: be careful not to expose your access token):
|
|
@@ -1111,6 +1111,6 @@ client.callApi(
|
|
|
1111
1111
|
```
|
|
1112
1112
|
|
|
1113
1113
|
[release-image]: https://img.shields.io/github/release/asana/node-asana.svg
|
|
1114
|
-
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.
|
|
1114
|
+
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.9
|
|
1115
1115
|
[npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
|
|
1116
1116
|
[npm-url]: https://www.npmjs.org/package/asana
|
package/dist/ApiClient.js
CHANGED
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
28
|
*/
|
|
29
29
|
/**
|
|
30
30
|
* @module ApiClient
|
|
31
|
-
* @version 3.0.
|
|
31
|
+
* @version 3.0.9
|
|
32
32
|
*/
|
|
33
33
|
/**
|
|
34
34
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
@@ -400,14 +400,14 @@ var ApiClient = exports.ApiClient = /*#__PURE__*/function () {
|
|
|
400
400
|
// set header parameters
|
|
401
401
|
if (typeof navigator === 'undefined' || typeof window === 'undefined') {
|
|
402
402
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams({
|
|
403
|
-
'version': "3.0.
|
|
403
|
+
'version': "3.0.9",
|
|
404
404
|
'language': 'NodeJS',
|
|
405
405
|
'language_version': process.version,
|
|
406
406
|
'os': process.platform
|
|
407
407
|
}).toString();
|
|
408
408
|
} else {
|
|
409
409
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams({
|
|
410
|
-
'version': "3.0.
|
|
410
|
+
'version': "3.0.9",
|
|
411
411
|
'language': 'BrowserJS'
|
|
412
412
|
}).toString();
|
|
413
413
|
}
|
package/dist/api/BatchAPIApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* CustomFieldSettings service.
|
|
31
31
|
* @module api/CustomFieldSettingsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
package/dist/api/EventsApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* GoalRelationships service.
|
|
31
31
|
* @module api/GoalRelationshipsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var GoalRelationshipsApi = exports.GoalRelationshipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
package/dist/api/GoalsApi.js
CHANGED
package/dist/api/JobsApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Memberships service.
|
|
31
31
|
* @module api/MembershipsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -176,9 +176,9 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
176
176
|
|
|
177
177
|
/**
|
|
178
178
|
* Get multiple memberships
|
|
179
|
-
* Returns compact `goal_membership` or `
|
|
179
|
+
* 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.
|
|
180
180
|
* @param {Object} opts Optional parameters
|
|
181
|
-
* @param {String} opts.parent Globally unique identifier for `goal` or `
|
|
181
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, or `portfolio`.
|
|
182
182
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
183
183
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
184
184
|
* @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.*
|
|
@@ -221,9 +221,9 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
221
221
|
|
|
222
222
|
/**
|
|
223
223
|
* Get multiple memberships
|
|
224
|
-
* Returns compact `goal_membership` or `
|
|
224
|
+
* 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.
|
|
225
225
|
* @param {Object} opts Optional parameters
|
|
226
|
-
* @param {String} opts.parent Globally unique identifier for `goal` or `
|
|
226
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, or `portfolio`.
|
|
227
227
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
228
228
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
229
229
|
* @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.*
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* OrganizationExports service.
|
|
31
31
|
* @module api/OrganizationExportsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var OrganizationExportsApi = exports.OrganizationExportsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* PortfolioMemberships service.
|
|
31
31
|
* @module api/PortfolioMembershipsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var PortfolioMembershipsApi = exports.PortfolioMembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* ProjectMemberships service.
|
|
31
31
|
* @module api/ProjectMembershipsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var ProjectMembershipsApi = exports.ProjectMembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* ProjectTemplates service.
|
|
31
31
|
* @module api/ProjectTemplatesApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var ProjectTemplatesApi = exports.ProjectTemplatesApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
package/dist/api/ProjectsApi.js
CHANGED
package/dist/api/RulesApi.js
CHANGED
package/dist/api/SectionsApi.js
CHANGED
package/dist/api/StoriesApi.js
CHANGED
package/dist/api/TagsApi.js
CHANGED
package/dist/api/TasksApi.js
CHANGED
package/dist/api/TeamsApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* TimeTrackingEntries service.
|
|
31
31
|
* @module api/TimeTrackingEntriesApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var TimeTrackingEntriesApi = exports.TimeTrackingEntriesApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
package/dist/api/TypeaheadApi.js
CHANGED
package/dist/api/UsersApi.js
CHANGED
package/dist/api/WebhooksApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Webhooks service.
|
|
31
31
|
* @module api/WebhooksApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var WebhooksApi = exports.WebhooksApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -47,7 +47,7 @@ var WebhooksApi = exports.WebhooksApi = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Establish a webhook
|
|
50
|
-
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will
|
|
50
|
+
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will receive a 403 Forbidden status code. ``` # Request curl -H \"Authorization: Bearer <personal_access_token>\" \\ -X POST https://app.asana.com/api/1.0/webhooks \\ -d \"resource=8675309\" \\ -d \"target=https://example.com/receive-webhook/7654\" ``` ``` # Handshake sent to https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/1.1 201 { \"data\": { \"gid\": \"43214\", \"resource\": { \"gid\": \"8675309\", \"name\": \"Bugs\" }, \"target\": \"https://example.com/receive-webhook/7654\", \"active\": false, \"last_success_at\": null, \"last_failure_at\": null, \"last_failure_content\": null }, \"X-Hook-Secret\": \"b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81\" } ```
|
|
51
51
|
* @param {module:model/Object} body The webhook workspace and target.
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @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.
|
|
@@ -77,7 +77,7 @@ var WebhooksApi = exports.WebhooksApi = /*#__PURE__*/function () {
|
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
79
|
* Establish a webhook
|
|
80
|
-
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will
|
|
80
|
+
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will receive a 403 Forbidden status code. ``` # Request curl -H \"Authorization: Bearer <personal_access_token>\" \\ -X POST https://app.asana.com/api/1.0/webhooks \\ -d \"resource=8675309\" \\ -d \"target=https://example.com/receive-webhook/7654\" ``` ``` # Handshake sent to https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/1.1 201 { \"data\": { \"gid\": \"43214\", \"resource\": { \"gid\": \"8675309\", \"name\": \"Bugs\" }, \"target\": \"https://example.com/receive-webhook/7654\", \"active\": false, \"last_success_at\": null, \"last_failure_at\": null, \"last_failure_content\": null }, \"X-Hook-Secret\": \"b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81\" } ```
|
|
81
81
|
* @param {<&vendorExtensions.x-jsdoc-type>} body The webhook workspace and target.
|
|
82
82
|
* @param {Object} opts Optional parameters
|
|
83
83
|
* @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.
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* WorkspaceMemberships service.
|
|
31
31
|
* @module api/WorkspaceMembershipsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.9
|
|
33
33
|
*/
|
|
34
34
|
var WorkspaceMembershipsApi = exports.WorkspaceMembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "asana",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.9",
|
|
4
4
|
"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_",
|
|
5
5
|
"license": "Apache 2.0",
|
|
6
6
|
"main": "dist/index.js",
|
package/src/ApiClient.js
CHANGED
|
@@ -16,7 +16,7 @@ import superagent from "superagent";
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* @module ApiClient
|
|
19
|
-
* @version 3.0.
|
|
19
|
+
* @version 3.0.9
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
22
|
/**
|
|
@@ -412,7 +412,7 @@ export class ApiClient {
|
|
|
412
412
|
if (typeof(navigator) === 'undefined' || typeof(window) === 'undefined') {
|
|
413
413
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
|
|
414
414
|
{
|
|
415
|
-
'version': "3.0.
|
|
415
|
+
'version': "3.0.9",
|
|
416
416
|
'language': 'NodeJS',
|
|
417
417
|
'language_version': process.version,
|
|
418
418
|
'os': process.platform
|
|
@@ -421,7 +421,7 @@ export class ApiClient {
|
|
|
421
421
|
} else {
|
|
422
422
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
|
|
423
423
|
{
|
|
424
|
-
'version': "3.0.
|
|
424
|
+
'version': "3.0.9",
|
|
425
425
|
'language': 'BrowserJS'
|
|
426
426
|
}
|
|
427
427
|
).toString();
|
package/src/api/BatchAPIApi.js
CHANGED
package/src/api/EventsApi.js
CHANGED
package/src/api/GoalsApi.js
CHANGED
package/src/api/JobsApi.js
CHANGED
|
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
|
|
|
18
18
|
/**
|
|
19
19
|
* Memberships service.
|
|
20
20
|
* @module api/MembershipsApi
|
|
21
|
-
* @version 3.0.
|
|
21
|
+
* @version 3.0.9
|
|
22
22
|
*/
|
|
23
23
|
export class MembershipsApi {
|
|
24
24
|
|
|
@@ -203,9 +203,9 @@ export class MembershipsApi {
|
|
|
203
203
|
|
|
204
204
|
/**
|
|
205
205
|
* Get multiple memberships
|
|
206
|
-
* Returns compact `goal_membership` or `
|
|
206
|
+
* 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.
|
|
207
207
|
* @param {Object} opts Optional parameters
|
|
208
|
-
* @param {String} opts.parent Globally unique identifier for `goal` or `
|
|
208
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, or `portfolio`.
|
|
209
209
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
210
210
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
211
211
|
* @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.*
|
|
@@ -268,9 +268,9 @@ export class MembershipsApi {
|
|
|
268
268
|
|
|
269
269
|
/**
|
|
270
270
|
* Get multiple memberships
|
|
271
|
-
* Returns compact `goal_membership` or `
|
|
271
|
+
* 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.
|
|
272
272
|
* @param {Object} opts Optional parameters
|
|
273
|
-
* @param {String} opts.parent Globally unique identifier for `goal` or `
|
|
273
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, or `portfolio`.
|
|
274
274
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
275
275
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
276
276
|
* @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.*
|
package/src/api/PortfoliosApi.js
CHANGED
package/src/api/ProjectsApi.js
CHANGED
package/src/api/RulesApi.js
CHANGED
package/src/api/SectionsApi.js
CHANGED
package/src/api/StoriesApi.js
CHANGED
package/src/api/TagsApi.js
CHANGED
package/src/api/TasksApi.js
CHANGED
package/src/api/TeamsApi.js
CHANGED
package/src/api/TypeaheadApi.js
CHANGED
package/src/api/UsersApi.js
CHANGED
package/src/api/WebhooksApi.js
CHANGED
|
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
|
|
|
18
18
|
/**
|
|
19
19
|
* Webhooks service.
|
|
20
20
|
* @module api/WebhooksApi
|
|
21
|
-
* @version 3.0.
|
|
21
|
+
* @version 3.0.9
|
|
22
22
|
*/
|
|
23
23
|
export class WebhooksApi {
|
|
24
24
|
|
|
@@ -38,7 +38,7 @@ export class WebhooksApi {
|
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Establish a webhook
|
|
41
|
-
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will
|
|
41
|
+
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will receive a 403 Forbidden status code. ``` # Request curl -H \"Authorization: Bearer <personal_access_token>\" \\ -X POST https://app.asana.com/api/1.0/webhooks \\ -d \"resource=8675309\" \\ -d \"target=https://example.com/receive-webhook/7654\" ``` ``` # Handshake sent to https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/1.1 201 { \"data\": { \"gid\": \"43214\", \"resource\": { \"gid\": \"8675309\", \"name\": \"Bugs\" }, \"target\": \"https://example.com/receive-webhook/7654\", \"active\": false, \"last_success_at\": null, \"last_failure_at\": null, \"last_failure_content\": null }, \"X-Hook-Secret\": \"b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81\" } ```
|
|
42
42
|
* @param {module:model/Object} body The webhook workspace and target.
|
|
43
43
|
* @param {Object} opts Optional parameters
|
|
44
44
|
* @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.
|
|
@@ -80,7 +80,7 @@ export class WebhooksApi {
|
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
82
|
* Establish a webhook
|
|
83
|
-
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will
|
|
83
|
+
* Establishing a webhook is a two-part process. First, a simple HTTP POST request initiates the creation similar to creating any other resource. Next, in the middle of this request comes the confirmation handshake. When a webhook is created, we will send a test POST to the target with an `X-Hook-Secret` header. The target must respond with a `200 OK` or `204 No Content` and a matching `X-Hook-Secret` header to confirm that this webhook subscription is indeed expected. We strongly recommend storing this secret to be used to verify future webhook event signatures. The POST request to create the webhook will then return with the status of the request. If you do not acknowledge the webhook’s confirmation handshake it will fail to setup, and you will receive an error in response to your attempt to create it. This means you need to be able to receive and complete the webhook *while* the POST request is in-flight (in other words, have a server that can handle requests asynchronously). Invalid hostnames like localhost will receive a 403 Forbidden status code. ``` # Request curl -H \"Authorization: Bearer <personal_access_token>\" \\ -X POST https://app.asana.com/api/1.0/webhooks \\ -d \"resource=8675309\" \\ -d \"target=https://example.com/receive-webhook/7654\" ``` ``` # Handshake sent to https://example.com/ POST /receive-webhook/7654 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Handshake response sent by example.com HTTP/1.1 200 X-Hook-Secret: b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81 ``` ``` # Response HTTP/1.1 201 { \"data\": { \"gid\": \"43214\", \"resource\": { \"gid\": \"8675309\", \"name\": \"Bugs\" }, \"target\": \"https://example.com/receive-webhook/7654\", \"active\": false, \"last_success_at\": null, \"last_failure_at\": null, \"last_failure_content\": null }, \"X-Hook-Secret\": \"b537207f20cbfa02357cf448134da559e8bd39d61597dcd5631b8012eae53e81\" } ```
|
|
84
84
|
* @param {<&vendorExtensions.x-jsdoc-type>} body The webhook workspace and target.
|
|
85
85
|
* @param {Object} opts Optional parameters
|
|
86
86
|
* @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.
|
package/src/api/WorkspacesApi.js
CHANGED