asana 3.1.0 → 3.1.1
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 +7 -4
- package/dist/ApiClient.js +3 -3
- package/dist/api/AllocationsApi.js +1 -1
- package/dist/api/AttachmentsApi.js +3 -3
- 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 +15 -15
- package/dist/api/CustomTypesApi.js +54 -6
- package/dist/api/EventsApi.js +1 -1
- package/dist/api/ExportsApi.js +42 -3
- 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 +13 -13
- 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 +5 -5
- package/dist/api/TagsApi.js +15 -15
- 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 +75 -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 +11 -11
- 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 +3 -3
- 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 +15 -15
- package/src/api/CustomTypesApi.js +60 -1
- package/src/api/EventsApi.js +1 -1
- package/src/api/ExportsApi.js +56 -3
- 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 +13 -13
- 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 +5 -5
- package/src/api/TagsApi.js +15 -15
- 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 +96 -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 +11 -11
- 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.1.
|
|
4
|
+
- Package version: 3.1.1
|
|
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.1/asana-min.js"></script>
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Example usage (**NOTE**: be careful not to expose your access token):
|
|
@@ -216,9 +216,11 @@ Class | Method | HTTP request | Description
|
|
|
216
216
|
*Asana.CustomFieldsApi* | [**insertEnumOptionForCustomField**](docs/CustomFieldsApi.md#insertEnumOptionForCustomField) | **POST** /custom_fields/{custom_field_gid}/enum_options/insert | Reorder a custom field's enum
|
|
217
217
|
*Asana.CustomFieldsApi* | [**updateCustomField**](docs/CustomFieldsApi.md#updateCustomField) | **PUT** /custom_fields/{custom_field_gid} | Update a custom field
|
|
218
218
|
*Asana.CustomFieldsApi* | [**updateEnumOption**](docs/CustomFieldsApi.md#updateEnumOption) | **PUT** /enum_options/{enum_option_gid} | Update an enum option
|
|
219
|
+
*Asana.CustomTypesApi* | [**getCustomType**](docs/CustomTypesApi.md#getCustomType) | **GET** /custom_types/{custom_type_gid} | Get a custom type
|
|
219
220
|
*Asana.CustomTypesApi* | [**getCustomTypes**](docs/CustomTypesApi.md#getCustomTypes) | **GET** /custom_types | Get all custom types associated with an object
|
|
220
221
|
*Asana.EventsApi* | [**getEvents**](docs/EventsApi.md#getEvents) | **GET** /events | Get events on a resource
|
|
221
|
-
*Asana.ExportsApi* | [**createGraphExport**](docs/ExportsApi.md#createGraphExport) | **POST** /exports/graph | Initiate graph export
|
|
222
|
+
*Asana.ExportsApi* | [**createGraphExport**](docs/ExportsApi.md#createGraphExport) | **POST** /exports/graph | Initiate a graph export
|
|
223
|
+
*Asana.ExportsApi* | [**createResourceExport**](docs/ExportsApi.md#createResourceExport) | **POST** /exports/resource | Initiate a resource export
|
|
222
224
|
*Asana.GoalRelationshipsApi* | [**addSupportingRelationship**](docs/GoalRelationshipsApi.md#addSupportingRelationship) | **POST** /goals/{goal_gid}/addSupportingRelationship | Add a supporting goal relationship
|
|
223
225
|
*Asana.GoalRelationshipsApi* | [**getGoalRelationship**](docs/GoalRelationshipsApi.md#getGoalRelationship) | **GET** /goal_relationships/{goal_relationship_gid} | Get a goal relationship
|
|
224
226
|
*Asana.GoalRelationshipsApi* | [**getGoalRelationships**](docs/GoalRelationshipsApi.md#getGoalRelationships) | **GET** /goal_relationships | Get goal relationships
|
|
@@ -362,6 +364,7 @@ Class | Method | HTTP request | Description
|
|
|
362
364
|
*Asana.TimePeriodsApi* | [**getTimePeriods**](docs/TimePeriodsApi.md#getTimePeriods) | **GET** /time_periods | Get time periods
|
|
363
365
|
*Asana.TimeTrackingEntriesApi* | [**createTimeTrackingEntry**](docs/TimeTrackingEntriesApi.md#createTimeTrackingEntry) | **POST** /tasks/{task_gid}/time_tracking_entries | Create a time tracking entry
|
|
364
366
|
*Asana.TimeTrackingEntriesApi* | [**deleteTimeTrackingEntry**](docs/TimeTrackingEntriesApi.md#deleteTimeTrackingEntry) | **DELETE** /time_tracking_entries/{time_tracking_entry_gid} | Delete a time tracking entry
|
|
367
|
+
*Asana.TimeTrackingEntriesApi* | [**getTimeTrackingEntries**](docs/TimeTrackingEntriesApi.md#getTimeTrackingEntries) | **GET** /time_tracking_entries | Get multiple time tracking entries
|
|
365
368
|
*Asana.TimeTrackingEntriesApi* | [**getTimeTrackingEntriesForTask**](docs/TimeTrackingEntriesApi.md#getTimeTrackingEntriesForTask) | **GET** /tasks/{task_gid}/time_tracking_entries | Get time tracking entries for a task
|
|
366
369
|
*Asana.TimeTrackingEntriesApi* | [**getTimeTrackingEntry**](docs/TimeTrackingEntriesApi.md#getTimeTrackingEntry) | **GET** /time_tracking_entries/{time_tracking_entry_gid} | Get a time tracking entry
|
|
367
370
|
*Asana.TimeTrackingEntriesApi* | [**updateTimeTrackingEntry**](docs/TimeTrackingEntriesApi.md#updateTimeTrackingEntry) | **PUT** /time_tracking_entries/{time_tracking_entry_gid} | Update a time tracking entry
|
|
@@ -1114,6 +1117,6 @@ client.callApi(
|
|
|
1114
1117
|
```
|
|
1115
1118
|
|
|
1116
1119
|
[release-image]: https://img.shields.io/github/release/asana/node-asana.svg
|
|
1117
|
-
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.1.
|
|
1120
|
+
[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.1.1
|
|
1118
1121
|
[npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
|
|
1119
1122
|
[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.1
|
|
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.1.
|
|
403
|
+
'version': "3.1.1",
|
|
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.1.
|
|
410
|
+
'version': "3.1.1",
|
|
411
411
|
'language': 'BrowserJS'
|
|
412
412
|
}).toString();
|
|
413
413
|
}
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Attachments service.
|
|
31
31
|
* @module api/AttachmentsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.1
|
|
33
33
|
*/
|
|
34
34
|
var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -106,7 +106,7 @@ var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
108
|
* Delete an attachment
|
|
109
|
-
* Deletes a specific, existing attachment. Returns an empty data record.
|
|
109
|
+
* <b>Required scope: </b><code>attachments:delete</code> Deletes a specific, existing attachment. Returns an empty data record.
|
|
110
110
|
* @param {String} attachment_gid Globally unique identifier for the attachment.
|
|
111
111
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
112
112
|
*/
|
|
@@ -133,7 +133,7 @@ var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
|
133
133
|
|
|
134
134
|
/**
|
|
135
135
|
* Delete an attachment
|
|
136
|
-
* Deletes a specific, existing attachment. Returns an empty data record.
|
|
136
|
+
* <b>Required scope: </b><code>attachments:delete</code> Deletes a specific, existing attachment. Returns an empty data record.
|
|
137
137
|
* @param {<&vendorExtensions.x-jsdoc-type>} attachment_gid Globally unique identifier for the attachment.
|
|
138
138
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData}
|
|
139
139
|
*/
|
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.1.
|
|
32
|
+
* @version 3.1.1
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* CustomFields service.
|
|
31
31
|
* @module api/CustomFieldsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.1
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -47,7 +47,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Create a custom field
|
|
50
|
-
* Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.
|
|
50
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.
|
|
51
51
|
* @param {module:model/Object} body The custom field object to create.
|
|
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.
|
|
@@ -77,7 +77,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
79
|
* Create a custom field
|
|
80
|
-
* Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.
|
|
80
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Creates a new custom field in a workspace. Every custom field is required to be created in a specific workspace, and this workspace cannot be changed once set. A custom field’s name must be unique within a workspace and not conflict with names of existing task properties such as `Due Date` or `Assignee`. A custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`, `date`, or `people`. Returns the full record of the newly created custom field.
|
|
81
81
|
* @param {<&vendorExtensions.x-jsdoc-type>} body The custom field object to create.
|
|
82
82
|
* @param {Object} opts Optional parameters
|
|
83
83
|
* @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.
|
|
@@ -93,7 +93,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
95
|
* Create an enum option
|
|
96
|
-
* Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
|
|
96
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
|
|
97
97
|
* @param {String} custom_field_gid Globally unique identifier for the custom field.
|
|
98
98
|
* @param {Object} opts Optional parameters
|
|
99
99
|
* @param {module:model/Object} opts.body The enum option object to create.
|
|
@@ -126,7 +126,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
128
|
* Create an enum option
|
|
129
|
-
* Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
|
|
129
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list. Locked custom fields can only have enum options added by the user who locked the field. Returns the full record of the newly created enum option.
|
|
130
130
|
* @param {<&vendorExtensions.x-jsdoc-type>} custom_field_gid Globally unique identifier for the custom field.
|
|
131
131
|
* @param {Object} opts Optional parameters
|
|
132
132
|
* @param {module:model/Object} opts.body The enum option object to create.
|
|
@@ -184,7 +184,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
186
|
* Get a custom field
|
|
187
|
-
* Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
|
|
187
|
+
* <b>Required scope: </b><code>custom_fields:read</code> Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
|
|
188
188
|
* @param {String} custom_field_gid Globally unique identifier for the custom field.
|
|
189
189
|
* @param {Object} opts Optional parameters
|
|
190
190
|
* @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.
|
|
@@ -216,7 +216,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
216
216
|
|
|
217
217
|
/**
|
|
218
218
|
* Get a custom field
|
|
219
|
-
* Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
|
|
219
|
+
* <b>Required scope: </b><code>custom_fields:read</code> Get the complete definition of a custom field’s metadata. Since custom fields can be defined for one of a number of types, and these types have different data and behaviors, there are fields that are relevant to a particular type. For instance, as noted above, enum_options is only relevant for the enum type and defines the set of choices that the enum could represent. The examples below show some of these type-specific custom field definitions.
|
|
220
220
|
* @param {<&vendorExtensions.x-jsdoc-type>} custom_field_gid Globally unique identifier for the custom field.
|
|
221
221
|
* @param {Object} opts Optional parameters
|
|
222
222
|
* @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.
|
|
@@ -232,7 +232,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
234
|
* Get a workspace's custom fields
|
|
235
|
-
* Returns a list of the compact representation of all of the custom fields in a workspace.
|
|
235
|
+
* <b>Required scope: </b><code>custom_fields:read</code> Returns a list of the compact representation of all of the custom fields in a workspace.
|
|
236
236
|
* @param {String} workspace_gid Globally unique identifier for the workspace or organization.
|
|
237
237
|
* @param {Object} opts Optional parameters
|
|
238
238
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -282,7 +282,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
282
282
|
|
|
283
283
|
/**
|
|
284
284
|
* Get a workspace's custom fields
|
|
285
|
-
* Returns a list of the compact representation of all of the custom fields in a workspace.
|
|
285
|
+
* <b>Required scope: </b><code>custom_fields:read</code> Returns a list of the compact representation of all of the custom fields in a workspace.
|
|
286
286
|
* @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization.
|
|
287
287
|
* @param {Object} opts Optional parameters
|
|
288
288
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
@@ -304,7 +304,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
304
304
|
|
|
305
305
|
/**
|
|
306
306
|
* Reorder a custom field's enum
|
|
307
|
-
* Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
|
|
307
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
|
|
308
308
|
* @param {String} custom_field_gid Globally unique identifier for the custom field.
|
|
309
309
|
* @param {Object} opts Optional parameters
|
|
310
310
|
* @param {module:model/Object} opts.body The enum option object to create.
|
|
@@ -337,7 +337,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
337
337
|
|
|
338
338
|
/**
|
|
339
339
|
* Reorder a custom field's enum
|
|
340
|
-
* Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
|
|
340
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.
|
|
341
341
|
* @param {<&vendorExtensions.x-jsdoc-type>} custom_field_gid Globally unique identifier for the custom field.
|
|
342
342
|
* @param {Object} opts Optional parameters
|
|
343
343
|
* @param {module:model/Object} opts.body The enum option object to create.
|
|
@@ -354,7 +354,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
354
354
|
|
|
355
355
|
/**
|
|
356
356
|
* Update a custom field
|
|
357
|
-
* A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
|
|
357
|
+
* <b>Required scope: </b><code>custom_fields:write</code> A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
|
|
358
358
|
* @param {String} custom_field_gid Globally unique identifier for the custom field.
|
|
359
359
|
* @param {Object} opts Optional parameters
|
|
360
360
|
* @param {module:model/Object} opts.body The custom field object with all updated properties.
|
|
@@ -387,7 +387,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
387
387
|
|
|
388
388
|
/**
|
|
389
389
|
* Update a custom field
|
|
390
|
-
* A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
|
|
390
|
+
* <b>Required scope: </b><code>custom_fields:write</code> A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field. A custom field’s `type` cannot be updated. An enum custom field’s `enum_options` cannot be updated with this endpoint. Instead see “Work With Enum Options” for information on how to update `enum_options`. Locked custom fields can only be updated by the user who locked the field. Returns the complete updated custom field record.
|
|
391
391
|
* @param {<&vendorExtensions.x-jsdoc-type>} custom_field_gid Globally unique identifier for the custom field.
|
|
392
392
|
* @param {Object} opts Optional parameters
|
|
393
393
|
* @param {module:model/Object} opts.body The custom field object with all updated properties.
|
|
@@ -404,7 +404,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
404
404
|
|
|
405
405
|
/**
|
|
406
406
|
* Update an enum option
|
|
407
|
-
* Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
|
|
407
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
|
|
408
408
|
* @param {String} enum_option_gid Globally unique identifier for the enum option.
|
|
409
409
|
* @param {Object} opts Optional parameters
|
|
410
410
|
* @param {module:model/Object} opts.body The enum option object to update
|
|
@@ -437,7 +437,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
437
437
|
|
|
438
438
|
/**
|
|
439
439
|
* Update an enum option
|
|
440
|
-
* Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
|
|
440
|
+
* <b>Required scope: </b><code>custom_fields:write</code> Updates an existing enum option. Enum custom fields require at least one enabled enum option. Locked custom fields can only be updated by the user who locked the field. Returns the full record of the updated enum option.
|
|
441
441
|
* @param {<&vendorExtensions.x-jsdoc-type>} enum_option_gid Globally unique identifier for the enum option.
|
|
442
442
|
* @param {Object} opts Optional parameters
|
|
443
443
|
* @param {module:model/Object} opts.body The enum option object to update
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* CustomTypes service.
|
|
31
31
|
* @module api/CustomTypesApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.1
|
|
33
33
|
*/
|
|
34
34
|
var CustomTypesApi = exports.CustomTypesApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -46,16 +46,64 @@ var CustomTypesApi = exports.CustomTypesApi = /*#__PURE__*/function () {
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* Get
|
|
50
|
-
* Returns
|
|
51
|
-
* @param {String}
|
|
49
|
+
* Get a custom type
|
|
50
|
+
* Returns the complete custom type record for a single custom type.
|
|
51
|
+
* @param {String} custom_type_gid Globally unique identifier for the custom type.
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
|
-
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
54
|
-
* @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.*
|
|
55
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.
|
|
56
54
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
57
55
|
*/
|
|
58
56
|
return _createClass(CustomTypesApi, [{
|
|
57
|
+
key: "getCustomTypeWithHttpInfo",
|
|
58
|
+
value: function getCustomTypeWithHttpInfo(custom_type_gid, opts) {
|
|
59
|
+
opts = opts || {};
|
|
60
|
+
var postBody = null;
|
|
61
|
+
// verify the required parameter 'custom_type_gid' is set
|
|
62
|
+
if (custom_type_gid === undefined || custom_type_gid === null) {
|
|
63
|
+
throw new Error("Missing the required parameter 'custom_type_gid' when calling getCustomType");
|
|
64
|
+
}
|
|
65
|
+
var pathParams = {
|
|
66
|
+
'custom_type_gid': custom_type_gid
|
|
67
|
+
};
|
|
68
|
+
var queryParams = {};
|
|
69
|
+
opts = opts || {};
|
|
70
|
+
queryParams = opts;
|
|
71
|
+
var headerParams = {};
|
|
72
|
+
var formParams = {};
|
|
73
|
+
var authNames = ['personalAccessToken'];
|
|
74
|
+
var contentTypes = [];
|
|
75
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
76
|
+
var returnType = 'Blob';
|
|
77
|
+
return this.apiClient.callApi('/custom_types/{custom_type_gid}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Get a custom type
|
|
82
|
+
* Returns the complete custom type record for a single custom type.
|
|
83
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} custom_type_gid Globally unique identifier for the custom type.
|
|
84
|
+
* @param {Object} opts Optional parameters
|
|
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.
|
|
86
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomTypeResponseData}
|
|
87
|
+
*/
|
|
88
|
+
}, {
|
|
89
|
+
key: "getCustomType",
|
|
90
|
+
value: function getCustomType(custom_type_gid, opts) {
|
|
91
|
+
return this.getCustomTypeWithHttpInfo(custom_type_gid, opts).then(function (response_and_data) {
|
|
92
|
+
return response_and_data.data;
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Get all custom types associated with an object
|
|
98
|
+
* Returns a list of all of the custom types associated with an object. Currently, only projects are supported. 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.
|
|
99
|
+
* @param {String} project Globally unique identifier for the project, which is used as a filter when retrieving all custom types.
|
|
100
|
+
* @param {Object} opts Optional parameters
|
|
101
|
+
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
102
|
+
* @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.*
|
|
103
|
+
* @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.
|
|
104
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
105
|
+
*/
|
|
106
|
+
}, {
|
|
59
107
|
key: "getCustomTypesWithHttpInfo",
|
|
60
108
|
value: function getCustomTypesWithHttpInfo(project, opts) {
|
|
61
109
|
opts = opts || {};
|
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
|
* Exports service.
|
|
31
31
|
* @module api/ExportsApi
|
|
32
|
-
* @version 3.1.
|
|
32
|
+
* @version 3.1.1
|
|
33
33
|
*/
|
|
34
34
|
var ExportsApi = exports.ExportsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -46,7 +46,7 @@ var ExportsApi = exports.ExportsApi = /*#__PURE__*/function () {
|
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
|
-
* Initiate graph export
|
|
49
|
+
* Initiate a graph export
|
|
50
50
|
* Initiates a graph export job for a given parent object (team, portfolio, or project). The export will be processed asynchronously. Once initiated, use the [jobs](/reference/getjob) endpoint to monitor progress. **Export Caching:** When exporting more than 1,000 tasks, the results are cached for 4 hours. Any new export requests made within this 4-hour window will return the same cached results rather than generating a fresh export.
|
|
51
51
|
* @param {module:model/Object} body A JSON payload specifying the parent object to export.
|
|
52
52
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
@@ -71,7 +71,7 @@ var ExportsApi = exports.ExportsApi = /*#__PURE__*/function () {
|
|
|
71
71
|
}
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* Initiate graph export
|
|
74
|
+
* Initiate a graph export
|
|
75
75
|
* Initiates a graph export job for a given parent object (team, portfolio, or project). The export will be processed asynchronously. Once initiated, use the [jobs](/reference/getjob) endpoint to monitor progress. **Export Caching:** When exporting more than 1,000 tasks, the results are cached for 4 hours. Any new export requests made within this 4-hour window will return the same cached results rather than generating a fresh export.
|
|
76
76
|
* @param {<&vendorExtensions.x-jsdoc-type>} body A JSON payload specifying the parent object to export.
|
|
77
77
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GraphExportResponseData}
|
|
@@ -83,5 +83,44 @@ var ExportsApi = exports.ExportsApi = /*#__PURE__*/function () {
|
|
|
83
83
|
return response_and_data.data;
|
|
84
84
|
});
|
|
85
85
|
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Initiate a resource export
|
|
89
|
+
* Initiates a bulk export of resources for a workspace. The export will be processed asynchronously. Once the export has been requested, its progress can be monitored using the [jobs](/reference/getjob) endpoint. ## Supported resource types This endpoint currently supports exporting tasks, teams and messages within a workspace. Resources can be requested to be part of the export by providing the `export_request_parameters` parameter. The following resource types are supported: ### Tasks: Tasks are formatted for exports with some differences from their documented [schema](/reference/tasks): - `attachments` are included by default and returns an array of associated attachments. - Attachment objects do not include `download_url` or `view_url`. The `attachments` [endpoint](/reference/attachment) should be queried for up-to-date URLs. - `stories` are included by default and returns an array of comments and other changes made to a task ### Teams: Teams are formatted for exports with these differences from their documented [schema](/reference/teams): - `members` are included by default and returns an array of Users that are members of the team - Filtering is not supported for teams. ### Messages: The returned schema encompasses both default messages and status updates and is similar to the status update schema. The available fields for messages are: - `gid` - The globally unique identifier for the message. - `resource_type` - The type of resource, which is always \"message\". - `resource_subtype` - Optional. The subtype of the message, which can be \"default\" or \"status_update\". - `status_type` - The type associated with the status update. This can be one of: “on_track”, “at_risk”, “off_track”, “on_hold”, “complete”, “achieved”, “partial”, “missed”, “dropped” - `created_by` - The user who created the message. - `created_at` - The time at which this resource was created and sent available to other users. - `modified_at` - The time at which this resource was last modified. - `title` - The title of the message. - `text` - The text content of the message. - `html_notes` - The text content of the message with formatting as HTML. Not included by default. Can be included by using “fields” in the initial request. - `num_likes` - The number of users who have liked this message. - `likes` - An array of users who have liked this message. - `stories` - Optional. Array of stories applied to the message. - `attachments` - Optional. Array of attachments added to the message. - `followers` - Optional. Array of users currently following the message. Users that were sent the message are treated as followers. - `parents` - Array of objects the message was sent to. Can be a Project, Portfolio, Team or Goal. Limited to a single object for status updates. ## Export file The final export file will be in JSON Lines format and compressed in a gzip container. Objects are formatted according to their corresponding API schema, or limited to the fields included in the `fields` parameter. Exports currently include undeleted objects. An object in the export will be up to date anywhere between the exports `created_at` and `completed_at`. There is no guaranteed ordering of objects in the export. Access to the export file expires 30 days after its completion. ## Exporting specific fields By default, each object in an export includes a predefined set of fields based on its schema. If a more limited set of fields or fields not included by default are required, the Export API allows for specifying which fields to include in the requested export. Fields can be specified using the `fields` parameter. The fields parameter conforms to the fields optional parameter available for all Asana endpoints which is documented [here](https://developers.asana.com/docs/inputoutput-options). Utilizing the `fields` parameter is recommended if the full object is not required, especially when a large number of objects are being exported, to reduce the overall export time. ## Filtering resources A disjunction of two or more filters can be achieved by providing multiple `export_request_parameters` for the same resource, each with different filters. However, this approach may result in duplicate resources being returned. ## Rate Limits A workspace is currently limited to *one* in progress export request at a given time. The request will return with a 403 Forbidden status code if the limit is exceeded.
|
|
90
|
+
* @param {module:model/Object} body A JSON payload specifying the resources to export, including filters to apply and fields to be exported.
|
|
91
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
92
|
+
*/
|
|
93
|
+
}, {
|
|
94
|
+
key: "createResourceExportWithHttpInfo",
|
|
95
|
+
value: function createResourceExportWithHttpInfo(body) {
|
|
96
|
+
var postBody = body;
|
|
97
|
+
// verify the required parameter 'body' is set
|
|
98
|
+
if (body === undefined || body === null) {
|
|
99
|
+
throw new Error("Missing the required parameter 'body' when calling createResourceExport");
|
|
100
|
+
}
|
|
101
|
+
var pathParams = {};
|
|
102
|
+
var queryParams = {};
|
|
103
|
+
var headerParams = {};
|
|
104
|
+
var formParams = {};
|
|
105
|
+
var authNames = ['personalAccessToken'];
|
|
106
|
+
var contentTypes = ['application/json; charset=UTF-8'];
|
|
107
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
108
|
+
var returnType = 'Blob';
|
|
109
|
+
return this.apiClient.callApi('/exports/resource', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Initiate a resource export
|
|
114
|
+
* Initiates a bulk export of resources for a workspace. The export will be processed asynchronously. Once the export has been requested, its progress can be monitored using the [jobs](/reference/getjob) endpoint. ## Supported resource types This endpoint currently supports exporting tasks, teams and messages within a workspace. Resources can be requested to be part of the export by providing the `export_request_parameters` parameter. The following resource types are supported: ### Tasks: Tasks are formatted for exports with some differences from their documented [schema](/reference/tasks): - `attachments` are included by default and returns an array of associated attachments. - Attachment objects do not include `download_url` or `view_url`. The `attachments` [endpoint](/reference/attachment) should be queried for up-to-date URLs. - `stories` are included by default and returns an array of comments and other changes made to a task ### Teams: Teams are formatted for exports with these differences from their documented [schema](/reference/teams): - `members` are included by default and returns an array of Users that are members of the team - Filtering is not supported for teams. ### Messages: The returned schema encompasses both default messages and status updates and is similar to the status update schema. The available fields for messages are: - `gid` - The globally unique identifier for the message. - `resource_type` - The type of resource, which is always \"message\". - `resource_subtype` - Optional. The subtype of the message, which can be \"default\" or \"status_update\". - `status_type` - The type associated with the status update. This can be one of: “on_track”, “at_risk”, “off_track”, “on_hold”, “complete”, “achieved”, “partial”, “missed”, “dropped” - `created_by` - The user who created the message. - `created_at` - The time at which this resource was created and sent available to other users. - `modified_at` - The time at which this resource was last modified. - `title` - The title of the message. - `text` - The text content of the message. - `html_notes` - The text content of the message with formatting as HTML. Not included by default. Can be included by using “fields” in the initial request. - `num_likes` - The number of users who have liked this message. - `likes` - An array of users who have liked this message. - `stories` - Optional. Array of stories applied to the message. - `attachments` - Optional. Array of attachments added to the message. - `followers` - Optional. Array of users currently following the message. Users that were sent the message are treated as followers. - `parents` - Array of objects the message was sent to. Can be a Project, Portfolio, Team or Goal. Limited to a single object for status updates. ## Export file The final export file will be in JSON Lines format and compressed in a gzip container. Objects are formatted according to their corresponding API schema, or limited to the fields included in the `fields` parameter. Exports currently include undeleted objects. An object in the export will be up to date anywhere between the exports `created_at` and `completed_at`. There is no guaranteed ordering of objects in the export. Access to the export file expires 30 days after its completion. ## Exporting specific fields By default, each object in an export includes a predefined set of fields based on its schema. If a more limited set of fields or fields not included by default are required, the Export API allows for specifying which fields to include in the requested export. Fields can be specified using the `fields` parameter. The fields parameter conforms to the fields optional parameter available for all Asana endpoints which is documented [here](https://developers.asana.com/docs/inputoutput-options). Utilizing the `fields` parameter is recommended if the full object is not required, especially when a large number of objects are being exported, to reduce the overall export time. ## Filtering resources A disjunction of two or more filters can be achieved by providing multiple `export_request_parameters` for the same resource, each with different filters. However, this approach may result in duplicate resources being returned. ## Rate Limits A workspace is currently limited to *one* in progress export request at a given time. The request will return with a 403 Forbidden status code if the limit is exceeded.
|
|
115
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} body A JSON payload specifying the resources to export, including filters to apply and fields to be exported.
|
|
116
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ResourceExportResponseData}
|
|
117
|
+
*/
|
|
118
|
+
}, {
|
|
119
|
+
key: "createResourceExport",
|
|
120
|
+
value: function createResourceExport(body) {
|
|
121
|
+
return this.createResourceExportWithHttpInfo(body).then(function (response_and_data) {
|
|
122
|
+
return response_and_data.data;
|
|
123
|
+
});
|
|
124
|
+
}
|
|
86
125
|
}]);
|
|
87
126
|
}();
|
|
@@ -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.1
|
|
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.1.
|
|
32
|
+
* @version 3.1.1
|
|
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`
|
|
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.
|
|
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`
|
|
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.
|
|
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}
|
|
@@ -169,7 +169,7 @@ 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`, 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.
|
|
173
173
|
* @param {Object} opts Optional parameters
|
|
174
174
|
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, or `custom_field`.
|
|
175
175
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
@@ -214,7 +214,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
216
|
* 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.
|
|
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
218
|
* @param {Object} opts Optional parameters
|
|
219
219
|
* @param {String} opts.parent Globally unique identifier for `goal`, `project`, `portfolio`, or `custom_field`.
|
|
220
220
|
* @param {String} opts.member Globally unique identifier for `team` or `user`.
|
|
@@ -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.1
|
|
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.1
|
|
33
33
|
*/
|
|
34
34
|
var PortfolioMembershipsApi = exports.PortfolioMembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|