asana 3.1.5 → 3.1.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/.github/workflows/publish.yaml +4 -18
- package/README.md +3 -3
- package/dist/ApiClient.js +3 -3
- package/dist/api/AccessRequestsApi.js +1 -1
- 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/BudgetsApi.js +1 -1
- package/dist/api/CustomFieldSettingsApi.js +9 -9
- package/dist/api/CustomFieldsApi.js +1 -1
- package/dist/api/CustomTypesApi.js +1 -1
- package/dist/api/EventsApi.js +1 -1
- package/dist/api/ExportsApi.js +1 -1
- package/dist/api/GoalRelationshipsApi.js +1 -1
- package/dist/api/GoalsApi.js +1 -1
- package/dist/api/JobsApi.js +3 -3
- package/dist/api/MembershipsApi.js +17 -15
- 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 +13 -13
- package/dist/api/RatesApi.js +1 -1
- package/dist/api/ReactionsApi.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 +5 -5
- 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 +3 -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 +1 -1
- 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/AccessRequestsApi.js +1 -1
- 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/BudgetsApi.js +1 -1
- package/src/api/CustomFieldSettingsApi.js +9 -9
- package/src/api/CustomFieldsApi.js +1 -1
- package/src/api/CustomTypesApi.js +1 -1
- package/src/api/EventsApi.js +1 -1
- package/src/api/ExportsApi.js +1 -1
- package/src/api/GoalRelationshipsApi.js +1 -1
- package/src/api/GoalsApi.js +1 -1
- package/src/api/JobsApi.js +3 -3
- package/src/api/MembershipsApi.js +17 -15
- 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 +13 -13
- package/src/api/RatesApi.js +1 -1
- package/src/api/ReactionsApi.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 +5 -5
- 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 +3 -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 +1 -1
- package/src/api/WorkspaceMembershipsApi.js +1 -1
- package/src/api/WorkspacesApi.js +1 -1
- package/src/index.js +1 -1
|
@@ -79,26 +79,14 @@ jobs:
|
|
|
79
79
|
name: Build and publish 📦 to npmjs
|
|
80
80
|
runs-on: ubuntu-latest
|
|
81
81
|
steps:
|
|
82
|
-
- name: Authenticate to AWS
|
|
83
|
-
uses: aws-actions/configure-aws-credentials@v4
|
|
84
|
-
with:
|
|
85
|
-
aws-region: us-east-1
|
|
86
|
-
role-to-assume: arn:aws:iam::403483446840:role/autogen_github_actions_beta_release_asana_node_client_library
|
|
87
|
-
- name: Load secrets
|
|
88
|
-
uses: aws-actions/aws-secretsmanager-get-secrets@v1
|
|
89
|
-
with:
|
|
90
|
-
secret-ids: NPM_API,npm_api_key
|
|
91
|
-
# npm_api_key secret is stored as {key:"***..."}.
|
|
92
|
-
# GitHub Actions environment variable name is NPM_API so to access "key" from the json we can use NPM_API_KEY
|
|
93
|
-
parse-json-secrets: true
|
|
94
82
|
- uses: actions/checkout@v4
|
|
95
83
|
with:
|
|
96
84
|
fetch-depth: 0
|
|
97
85
|
ref: master
|
|
98
86
|
- uses: actions/setup-node@v4
|
|
99
87
|
with:
|
|
100
|
-
node-version: "
|
|
101
|
-
registry-url: "https://registry.npmjs.
|
|
88
|
+
node-version: "24.x"
|
|
89
|
+
registry-url: "https://registry.npmjs.org"
|
|
102
90
|
- name: Build distribution
|
|
103
91
|
run: |
|
|
104
92
|
npm pkg set 'main'='dist/index.js'
|
|
@@ -106,8 +94,6 @@ jobs:
|
|
|
106
94
|
npm pkg set 'scripts.prepare'='npm run build'
|
|
107
95
|
npm install
|
|
108
96
|
npm publish
|
|
109
|
-
env:
|
|
110
|
-
NODE_AUTH_TOKEN: ${{ env.NPM_API_KEY }}
|
|
111
97
|
publish-to-github-releases:
|
|
112
98
|
needs: publish-to-npmjs
|
|
113
99
|
name: Build and publish to GitHub Releases
|
|
@@ -129,8 +115,8 @@ jobs:
|
|
|
129
115
|
ref: master
|
|
130
116
|
- uses: actions/setup-node@v4
|
|
131
117
|
with:
|
|
132
|
-
node-version: "
|
|
133
|
-
registry-url: "https://registry.npmjs.
|
|
118
|
+
node-version: "24.x"
|
|
119
|
+
registry-url: "https://registry.npmjs.org"
|
|
134
120
|
- name: Build distribution
|
|
135
121
|
run: |
|
|
136
122
|
npm pkg set 'main'='dist/index.js'
|
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.1.
|
|
4
|
+
- Package version: 3.1.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.1.
|
|
21
|
+
<script src="https://github.com/Asana/node-asana/releases/download/v3.1.9/asana-min.js"></script>
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Example usage (**NOTE**: be careful not to expose your access token):
|
|
@@ -1119,6 +1119,6 @@ client.callApi(
|
|
|
1119
1119
|
```
|
|
1120
1120
|
|
|
1121
1121
|
[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.
|
|
1122
|
+
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.1.9
|
|
1123
1123
|
[npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
|
|
1124
1124
|
[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.1.
|
|
31
|
+
* @version 3.1.9
|
|
32
32
|
*/
|
|
33
33
|
/**
|
|
34
34
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
@@ -405,14 +405,14 @@ var ApiClient = exports.ApiClient = /*#__PURE__*/function () {
|
|
|
405
405
|
// set header parameters
|
|
406
406
|
if (typeof navigator === 'undefined' || typeof window === 'undefined') {
|
|
407
407
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams({
|
|
408
|
-
'version': "3.1.
|
|
408
|
+
'version': "3.1.9",
|
|
409
409
|
'language': 'NodeJS',
|
|
410
410
|
'language_version': process.version,
|
|
411
411
|
'os': process.platform
|
|
412
412
|
}).toString();
|
|
413
413
|
} else {
|
|
414
414
|
headerParams['X-Asana-Client-Lib'] = new URLSearchParams({
|
|
415
|
-
'version': "3.1.
|
|
415
|
+
'version': "3.1.9",
|
|
416
416
|
'language': 'BrowserJS'
|
|
417
417
|
}).toString();
|
|
418
418
|
}
|
package/dist/api/BatchAPIApi.js
CHANGED
package/dist/api/BudgetsApi.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.1.
|
|
32
|
+
* @version 3.1.9
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -47,7 +47,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Get a goal's custom fields
|
|
50
|
-
* Returns a list of all of the custom fields settings on a goal, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
50
|
+
* <b>Required scope: </b><code>goals:read</code> Returns a list of all of the custom fields settings on a goal, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
51
51
|
* @param {String} goal_gid Globally unique identifier for the goal.
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -97,7 +97,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
97
97
|
|
|
98
98
|
/**
|
|
99
99
|
* Get a goal's custom fields
|
|
100
|
-
* Returns a list of all of the custom fields settings on a goal, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
100
|
+
* <b>Required scope: </b><code>goals:read</code> Returns a list of all of the custom fields settings on a goal, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
101
101
|
* @param {<&vendorExtensions.x-jsdoc-type>} goal_gid Globally unique identifier for the goal.
|
|
102
102
|
* @param {Object} opts Optional parameters
|
|
103
103
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -119,7 +119,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
119
119
|
|
|
120
120
|
/**
|
|
121
121
|
* Get a portfolio's custom fields
|
|
122
|
-
* Returns a list of all of the custom fields settings on a portfolio, in compact form.
|
|
122
|
+
* <b>Required scope: </b><code>portfolios:read</code> Returns a list of all of the custom fields settings on a portfolio, in compact form.
|
|
123
123
|
* @param {String} portfolio_gid Globally unique identifier for the portfolio.
|
|
124
124
|
* @param {Object} opts Optional parameters
|
|
125
125
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -169,7 +169,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* Get a portfolio's custom fields
|
|
172
|
-
* Returns a list of all of the custom fields settings on a portfolio, in compact form.
|
|
172
|
+
* <b>Required scope: </b><code>portfolios:read</code> Returns a list of all of the custom fields settings on a portfolio, in compact form.
|
|
173
173
|
* @param {<&vendorExtensions.x-jsdoc-type>} portfolio_gid Globally unique identifier for the portfolio.
|
|
174
174
|
* @param {Object} opts Optional parameters
|
|
175
175
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -191,7 +191,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
191
191
|
|
|
192
192
|
/**
|
|
193
193
|
* Get a project's custom fields
|
|
194
|
-
* Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
194
|
+
* <b>Required scope: </b><code>projects:read</code> Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
195
195
|
* @param {String} project_gid Globally unique identifier for the project.
|
|
196
196
|
* @param {Object} opts Optional parameters
|
|
197
197
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -241,7 +241,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
241
241
|
|
|
242
242
|
/**
|
|
243
243
|
* Get a project's custom fields
|
|
244
|
-
* Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
244
|
+
* <b>Required scope: </b><code>projects:read</code> Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
245
245
|
* @param {<&vendorExtensions.x-jsdoc-type>} project_gid Globally unique identifier for the project.
|
|
246
246
|
* @param {Object} opts Optional parameters
|
|
247
247
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -263,7 +263,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
263
263
|
|
|
264
264
|
/**
|
|
265
265
|
* Get a team's custom fields
|
|
266
|
-
* Returns a list of all of the custom fields settings on a team, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
266
|
+
* <b>Required scope: </b><code>teams:read</code> Returns a list of all of the custom fields settings on a team, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
267
267
|
* @param {String} team_gid Globally unique identifier for the team.
|
|
268
268
|
* @param {Object} opts Optional parameters
|
|
269
269
|
* @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.
|
|
@@ -311,7 +311,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
311
311
|
|
|
312
312
|
/**
|
|
313
313
|
* Get a team's custom fields
|
|
314
|
-
* Returns a list of all of the custom fields settings on a team, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
314
|
+
* <b>Required scope: </b><code>teams:read</code> Returns a list of all of the custom fields settings on a team, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information.
|
|
315
315
|
* @param {<&vendorExtensions.x-jsdoc-type>} team_gid Globally unique identifier for the team.
|
|
316
316
|
* @param {Object} opts Optional parameters
|
|
317
317
|
* @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/dist/api/EventsApi.js
CHANGED
package/dist/api/ExportsApi.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.1.
|
|
32
|
+
* @version 3.1.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
|
* Jobs service.
|
|
31
31
|
* @module api/JobsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.9
|
|
33
33
|
*/
|
|
34
34
|
var JobsApi = exports.JobsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -47,7 +47,7 @@ var JobsApi = exports.JobsApi = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Get a job by id
|
|
50
|
-
* Returns the full record for a job.
|
|
50
|
+
* <b>Required scope: </b><code>jobs:read</code> Returns the full record for a job.
|
|
51
51
|
* @param {String} job_gid Globally unique identifier for the job.
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @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.
|
|
@@ -79,7 +79,7 @@ var JobsApi = exports.JobsApi = /*#__PURE__*/function () {
|
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
81
|
* Get a job by id
|
|
82
|
-
* Returns the full record for a job.
|
|
82
|
+
* <b>Required scope: </b><code>jobs:read</code> Returns the full record for a job.
|
|
83
83
|
* @param {<&vendorExtensions.x-jsdoc-type>} job_gid Globally unique identifier for the job.
|
|
84
84
|
* @param {Object} opts Optional parameters
|
|
85
85
|
* @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.
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Memberships service.
|
|
31
31
|
* @module api/MembershipsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.9
|
|
33
33
|
*/
|
|
34
34
|
var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -47,7 +47,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Create a membership
|
|
50
|
-
* Creates a new membership in a `goal`, `project`, `portfolio`, or `custom_field`, where members can be Teams or Users. Returns the full record of the newly created membership.
|
|
50
|
+
* Creates a new membership in a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`, where members can be Teams or Users. Returns the full record of the newly created membership.
|
|
51
51
|
* @param {Object} opts Optional parameters
|
|
52
52
|
* @param {module:model/Object} opts.body The updated fields for the membership.
|
|
53
53
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
@@ -72,7 +72,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
74
|
* Create a membership
|
|
75
|
-
* Creates a new membership in a `goal`, `project`, `portfolio`, or `custom_field`, where members can be Teams or Users. Returns the full record of the newly created membership.
|
|
75
|
+
* Creates a new membership in a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`, where members can be Teams or Users. Returns the full record of the newly created membership.
|
|
76
76
|
* @param {Object} opts Optional parameters
|
|
77
77
|
* @param {module:model/Object} opts.body The updated fields for the membership.
|
|
78
78
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MembershipResponseData}
|
|
@@ -87,7 +87,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
89
|
* Delete a membership
|
|
90
|
-
* 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.
|
|
90
|
+
* A specific, existing membership for a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field` can be deleted by making a `DELETE` request on the URL for that membership. Returns an empty data record.
|
|
91
91
|
* @param {String} membership_gid Globally unique identifier for the membership.
|
|
92
92
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
93
93
|
*/
|
|
@@ -114,7 +114,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
116
|
* Delete a membership
|
|
117
|
-
* 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.
|
|
117
|
+
* A specific, existing membership for a `goal`, `project`, `portfolio`, `custom_type`, or `custom_field` can be deleted by making a `DELETE` request on the URL for that membership. Returns an empty data record.
|
|
118
118
|
* @param {<&vendorExtensions.x-jsdoc-type>} membership_gid Globally unique identifier for the membership.
|
|
119
119
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData}
|
|
120
120
|
*/
|
|
@@ -128,7 +128,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
130
|
* Get a membership
|
|
131
|
-
* Returns a `project_membership`, `goal_membership`, `portfolio_membership`, or `custom_field_membership` record for a membership id.
|
|
131
|
+
* Returns a `project_membership`, `goal_membership`, `portfolio_membership`, `custom_type_membership`, or `custom_field_membership` record for a membership id.
|
|
132
132
|
* @param {String} membership_gid Globally unique identifier for the membership.
|
|
133
133
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
134
134
|
*/
|
|
@@ -155,7 +155,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
155
155
|
|
|
156
156
|
/**
|
|
157
157
|
* Get a membership
|
|
158
|
-
* Returns a `project_membership`, `goal_membership`, `portfolio_membership`, or `custom_field_membership` record for a membership id.
|
|
158
|
+
* Returns a `project_membership`, `goal_membership`, `portfolio_membership`, `custom_type_membership`, or `custom_field_membership` record for a membership id.
|
|
159
159
|
* @param {<&vendorExtensions.x-jsdoc-type>} membership_gid Globally unique identifier for the membership.
|
|
160
160
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MembershipResponseData}
|
|
161
161
|
*/
|
|
@@ -169,10 +169,11 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* Get multiple memberships
|
|
172
|
-
* 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.
|
|
172
|
+
* Returns compact `goal_membership`, `project_membership`, `portfolio_membership`, `custom_type_membership`, or `custom_field_membership` records. The possible types for `parent` in this request are `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Alternatively, when `parent` is absent, you can use the `member` and `resource_subtype` parameters together to fetch all memberships of a specific type for a given member. For example, passing `member` as a team GID and `resource_subtype` as `project_membership` will return all project memberships for that team.
|
|
173
173
|
* @param {Object} opts Optional parameters
|
|
174
|
-
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, or `custom_field`.
|
|
175
|
-
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
174
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. This parameter is optional when `resource_subtype` is provided along with `member`.
|
|
175
|
+
* @param {String} opts.member Globally unique identifier for `team` or `user`. When used with `resource_subtype` and without `parent`, returns all memberships of the specified subtype for this member.
|
|
176
|
+
* @param {module:model/String} opts.resource_subtype The type of membership to return. Required when `parent` is absent. Currently supported value is `project_membership` (when `member` is a team GID, returns all project memberships for that team).
|
|
176
177
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
177
178
|
* @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.*
|
|
178
179
|
* @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.
|
|
@@ -214,10 +215,11 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
214
215
|
|
|
215
216
|
/**
|
|
216
217
|
* Get multiple memberships
|
|
217
|
-
* 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.
|
|
218
|
+
* Returns compact `goal_membership`, `project_membership`, `portfolio_membership`, `custom_type_membership`, or `custom_field_membership` records. The possible types for `parent` in this request are `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Alternatively, when `parent` is absent, you can use the `member` and `resource_subtype` parameters together to fetch all memberships of a specific type for a given member. For example, passing `member` as a team GID and `resource_subtype` as `project_membership` will return all project memberships for that team.
|
|
218
219
|
* @param {Object} opts Optional parameters
|
|
219
|
-
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, or `custom_field`.
|
|
220
|
-
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
220
|
+
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, `custom_type`, or `custom_field`. This parameter is optional when `resource_subtype` is provided along with `member`.
|
|
221
|
+
* @param {String} opts.member Globally unique identifier for `team` or `user`. When used with `resource_subtype` and without `parent`, returns all memberships of the specified subtype for this member.
|
|
222
|
+
* @param {module:model/String} opts.resource_subtype The type of membership to return. Required when `parent` is absent. Currently supported value is `project_membership` (when `member` is a team GID, returns all project memberships for that team).
|
|
221
223
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
222
224
|
* @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.*
|
|
223
225
|
* @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.
|
|
@@ -237,7 +239,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
237
239
|
|
|
238
240
|
/**
|
|
239
241
|
* Update a membership
|
|
240
|
-
* 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.
|
|
242
|
+
* 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`, `custom_types`, and `custom_fields` can be updated. Returns the full record of the updated membership.
|
|
241
243
|
* @param {module:model/Object} body The membership to update.
|
|
242
244
|
* @param {String} membership_gid Globally unique identifier for the membership.
|
|
243
245
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
@@ -269,7 +271,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
269
271
|
|
|
270
272
|
/**
|
|
271
273
|
* Update a membership
|
|
272
|
-
* 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.
|
|
274
|
+
* 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`, `custom_types`, and `custom_fields` can be updated. Returns the full record of the updated membership.
|
|
273
275
|
* @param {<&vendorExtensions.x-jsdoc-type>} body The membership to update.
|
|
274
276
|
* @param {<&vendorExtensions.x-jsdoc-type>} membership_gid Globally unique identifier for the membership.
|
|
275
277
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MembershipResponseData}
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* OrganizationExports service.
|
|
31
31
|
* @module api/OrganizationExportsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.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.1.
|
|
32
|
+
* @version 3.1.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.1.
|
|
32
|
+
* @version 3.1.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.1.
|
|
32
|
+
* @version 3.1.9
|
|
33
33
|
*/
|
|
34
34
|
var ProjectTemplatesApi = exports.ProjectTemplatesApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|