asana 3.0.3 → 3.0.5
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 +8 -3
- package/dist/ApiClient.js +3 -3
- package/dist/api/AllocationsApi.js +307 -0
- package/dist/api/AttachmentsApi.js +3 -3
- package/dist/api/AuditLogAPIApi.js +3 -3
- package/dist/api/BatchAPIApi.js +1 -1
- package/dist/api/CustomFieldSettingsApi.js +5 -5
- package/dist/api/CustomFieldsApi.js +3 -3
- package/dist/api/EventsApi.js +1 -1
- package/dist/api/GoalRelationshipsApi.js +3 -3
- package/dist/api/GoalsApi.js +3 -3
- package/dist/api/JobsApi.js +1 -1
- package/dist/api/MembershipsApi.js +3 -3
- package/dist/api/OrganizationExportsApi.js +1 -1
- package/dist/api/PortfolioMembershipsApi.js +5 -5
- package/dist/api/PortfoliosApi.js +5 -5
- package/dist/api/ProjectBriefsApi.js +1 -1
- package/dist/api/ProjectMembershipsApi.js +3 -3
- package/dist/api/ProjectStatusesApi.js +3 -3
- package/dist/api/ProjectTemplatesApi.js +5 -5
- package/dist/api/ProjectsApi.js +9 -9
- package/dist/api/RulesApi.js +1 -1
- package/dist/api/SectionsApi.js +3 -3
- package/dist/api/StatusUpdatesApi.js +5 -5
- package/dist/api/StoriesApi.js +3 -3
- package/dist/api/TagsApi.js +7 -7
- package/dist/api/TaskTemplatesApi.js +3 -3
- package/dist/api/TasksApi.js +19 -19
- package/dist/api/TeamMembershipsApi.js +7 -7
- package/dist/api/TeamsApi.js +5 -5
- package/dist/api/TimePeriodsApi.js +3 -3
- package/dist/api/TimeTrackingEntriesApi.js +3 -3
- package/dist/api/TypeaheadApi.js +1 -1
- package/dist/api/UserTaskListsApi.js +1 -1
- package/dist/api/UsersApi.js +9 -9
- package/dist/api/WebhooksApi.js +3 -3
- package/dist/api/WorkspaceMembershipsApi.js +5 -5
- package/dist/api/WorkspacesApi.js +3 -3
- package/dist/index.js +7 -0
- package/package.json +1 -1
- package/src/ApiClient.js +3 -3
- package/src/api/AllocationsApi.js +365 -0
- package/src/api/AttachmentsApi.js +3 -3
- package/src/api/AuditLogAPIApi.js +3 -3
- package/src/api/BatchAPIApi.js +1 -1
- package/src/api/CustomFieldSettingsApi.js +5 -5
- package/src/api/CustomFieldsApi.js +3 -3
- package/src/api/EventsApi.js +1 -1
- package/src/api/GoalRelationshipsApi.js +3 -3
- package/src/api/GoalsApi.js +3 -3
- package/src/api/JobsApi.js +1 -1
- package/src/api/MembershipsApi.js +3 -3
- package/src/api/OrganizationExportsApi.js +1 -1
- package/src/api/PortfolioMembershipsApi.js +5 -5
- package/src/api/PortfoliosApi.js +5 -5
- package/src/api/ProjectBriefsApi.js +1 -1
- package/src/api/ProjectMembershipsApi.js +3 -3
- package/src/api/ProjectStatusesApi.js +3 -3
- package/src/api/ProjectTemplatesApi.js +5 -5
- package/src/api/ProjectsApi.js +9 -9
- package/src/api/RulesApi.js +1 -1
- package/src/api/SectionsApi.js +3 -3
- package/src/api/StatusUpdatesApi.js +5 -5
- package/src/api/StoriesApi.js +3 -3
- package/src/api/TagsApi.js +7 -7
- package/src/api/TaskTemplatesApi.js +3 -3
- package/src/api/TasksApi.js +19 -19
- package/src/api/TeamMembershipsApi.js +7 -7
- package/src/api/TeamsApi.js +5 -5
- package/src/api/TimePeriodsApi.js +3 -3
- package/src/api/TimeTrackingEntriesApi.js +3 -3
- package/src/api/TypeaheadApi.js +1 -1
- package/src/api/UserTaskListsApi.js +1 -1
- package/src/api/UsersApi.js +9 -9
- package/src/api/WebhooksApi.js +3 -3
- package/src/api/WorkspaceMembershipsApi.js +5 -5
- package/src/api/WorkspacesApi.js +3 -3
- package/src/index.js +8 -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.5
|
|
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.5/asana-min.js"></script>
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Example usage (**NOTE**: be careful not to expose your access token):
|
|
@@ -195,6 +195,11 @@ All URIs are relative to *https://app.asana.com/api/1.0*
|
|
|
195
195
|
|
|
196
196
|
Class | Method | HTTP request | Description
|
|
197
197
|
------------ | ------------- | ------------- | -------------
|
|
198
|
+
*Asana.AllocationsApi* | [**createAllocation**](docs/AllocationsApi.md#createAllocation) | **POST** /allocations | Create an allocation
|
|
199
|
+
*Asana.AllocationsApi* | [**deleteAllocation**](docs/AllocationsApi.md#deleteAllocation) | **DELETE** /allocations/{allocation_gid} | Delete an allocation
|
|
200
|
+
*Asana.AllocationsApi* | [**getAllocation**](docs/AllocationsApi.md#getAllocation) | **GET** /allocations/{allocation_gid} | Get an allocation
|
|
201
|
+
*Asana.AllocationsApi* | [**getAllocations**](docs/AllocationsApi.md#getAllocations) | **GET** /allocations | Get multiple allocations
|
|
202
|
+
*Asana.AllocationsApi* | [**updateAllocation**](docs/AllocationsApi.md#updateAllocation) | **PUT** /allocations/{allocation_gid} | Update an allocation
|
|
198
203
|
*Asana.AttachmentsApi* | [**createAttachmentForObject**](docs/AttachmentsApi.md#createAttachmentForObject) | **POST** /attachments | Upload an attachment
|
|
199
204
|
*Asana.AttachmentsApi* | [**deleteAttachment**](docs/AttachmentsApi.md#deleteAttachment) | **DELETE** /attachments/{attachment_gid} | Delete an attachment
|
|
200
205
|
*Asana.AttachmentsApi* | [**getAttachment**](docs/AttachmentsApi.md#getAttachment) | **GET** /attachments/{attachment_gid} | Get an attachment
|
|
@@ -1106,6 +1111,6 @@ client.callApi(
|
|
|
1106
1111
|
```
|
|
1107
1112
|
|
|
1108
1113
|
[release-image]: https://img.shields.io/github/release/asana/node-asana.svg
|
|
1109
|
-
[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.5
|
|
1110
1115
|
[npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
|
|
1111
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.5
|
|
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.5",
|
|
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.5",
|
|
411
411
|
'language': 'BrowserJS'
|
|
412
412
|
}).toString();
|
|
413
413
|
}
|
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.AllocationsApi = void 0;
|
|
7
|
+
var _ApiClient = require("../ApiClient");
|
|
8
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
9
|
+
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
|
|
10
|
+
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
|
|
11
|
+
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
|
|
12
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
13
|
+
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
|
|
14
|
+
* Asana
|
|
15
|
+
* This is the interface for interacting with the [Asana Platform](https://developers.asana.com). Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).
|
|
16
|
+
*
|
|
17
|
+
* OpenAPI spec version: 1.0
|
|
18
|
+
*
|
|
19
|
+
* NOTE: This class is auto generated by the swagger code generator program.
|
|
20
|
+
* https://github.com/swagger-api/swagger-codegen.git
|
|
21
|
+
*
|
|
22
|
+
* Swagger Codegen version: 3.0.54
|
|
23
|
+
*
|
|
24
|
+
* Do not edit the class manually.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
var Collection = require('../utils/collection');
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Allocations service.
|
|
31
|
+
* @module api/AllocationsApi
|
|
32
|
+
* @version 3.0.5
|
|
33
|
+
*/
|
|
34
|
+
var AllocationsApi = exports.AllocationsApi = /*#__PURE__*/function () {
|
|
35
|
+
/**
|
|
36
|
+
* Constructs a new AllocationsApi.
|
|
37
|
+
* @alias module:api/AllocationsApi
|
|
38
|
+
* @class
|
|
39
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
40
|
+
* default to {@link module:ApiClient#instanc
|
|
41
|
+
e} if unspecified.
|
|
42
|
+
*/
|
|
43
|
+
function AllocationsApi(apiClient) {
|
|
44
|
+
_classCallCheck(this, AllocationsApi);
|
|
45
|
+
this.apiClient = apiClient || _ApiClient.ApiClient.instance;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Create an allocation
|
|
50
|
+
* Creates a new allocation. Returns the full record of the newly created allocation.
|
|
51
|
+
* @param {module:model/Object} body The allocation to create.
|
|
52
|
+
* @param {Object} opts Optional parameters
|
|
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.
|
|
54
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
55
|
+
*/
|
|
56
|
+
return _createClass(AllocationsApi, [{
|
|
57
|
+
key: "createAllocationWithHttpInfo",
|
|
58
|
+
value: function createAllocationWithHttpInfo(body, opts) {
|
|
59
|
+
opts = opts || {};
|
|
60
|
+
var postBody = body;
|
|
61
|
+
// verify the required parameter 'body' is set
|
|
62
|
+
if (body === undefined || body === null) {
|
|
63
|
+
throw new Error("Missing the required parameter 'body' when calling createAllocation");
|
|
64
|
+
}
|
|
65
|
+
var pathParams = {};
|
|
66
|
+
var queryParams = {};
|
|
67
|
+
opts = opts || {};
|
|
68
|
+
queryParams = opts;
|
|
69
|
+
var headerParams = {};
|
|
70
|
+
var formParams = {};
|
|
71
|
+
var authNames = ['personalAccessToken'];
|
|
72
|
+
var contentTypes = ['application/json; charset=UTF-8'];
|
|
73
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
74
|
+
var returnType = 'Blob';
|
|
75
|
+
return this.apiClient.callApi('/allocations', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Create an allocation
|
|
80
|
+
* Creates a new allocation. Returns the full record of the newly created allocation.
|
|
81
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} body The allocation to create.
|
|
82
|
+
* @param {Object} opts Optional parameters
|
|
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.
|
|
84
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AllocationResponseData}
|
|
85
|
+
*/
|
|
86
|
+
}, {
|
|
87
|
+
key: "createAllocation",
|
|
88
|
+
value: function createAllocation(body, opts) {
|
|
89
|
+
return this.createAllocationWithHttpInfo(body, opts).then(function (response_and_data) {
|
|
90
|
+
return response_and_data.data;
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Delete an allocation
|
|
96
|
+
* A specific, existing allocation can be deleted by making a DELETE request on the URL for that allocation. Returns an empty data record.
|
|
97
|
+
* @param {String} allocation_gid Globally unique identifier for the allocation.
|
|
98
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
99
|
+
*/
|
|
100
|
+
}, {
|
|
101
|
+
key: "deleteAllocationWithHttpInfo",
|
|
102
|
+
value: function deleteAllocationWithHttpInfo(allocation_gid) {
|
|
103
|
+
var postBody = null;
|
|
104
|
+
// verify the required parameter 'allocation_gid' is set
|
|
105
|
+
if (allocation_gid === undefined || allocation_gid === null) {
|
|
106
|
+
throw new Error("Missing the required parameter 'allocation_gid' when calling deleteAllocation");
|
|
107
|
+
}
|
|
108
|
+
var pathParams = {
|
|
109
|
+
'allocation_gid': allocation_gid
|
|
110
|
+
};
|
|
111
|
+
var queryParams = {};
|
|
112
|
+
var headerParams = {};
|
|
113
|
+
var formParams = {};
|
|
114
|
+
var authNames = ['personalAccessToken'];
|
|
115
|
+
var contentTypes = [];
|
|
116
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
117
|
+
var returnType = 'Blob';
|
|
118
|
+
return this.apiClient.callApi('/allocations/{allocation_gid}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Delete an allocation
|
|
123
|
+
* A specific, existing allocation can be deleted by making a DELETE request on the URL for that allocation. Returns an empty data record.
|
|
124
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} allocation_gid Globally unique identifier for the allocation.
|
|
125
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmptyResponseData}
|
|
126
|
+
*/
|
|
127
|
+
}, {
|
|
128
|
+
key: "deleteAllocation",
|
|
129
|
+
value: function deleteAllocation(allocation_gid) {
|
|
130
|
+
return this.deleteAllocationWithHttpInfo(allocation_gid).then(function (response_and_data) {
|
|
131
|
+
return response_and_data.data;
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Get an allocation
|
|
137
|
+
* Returns the complete allocation record for a single allocation.
|
|
138
|
+
* @param {String} allocation_gid Globally unique identifier for the allocation.
|
|
139
|
+
* @param {Object} opts Optional parameters
|
|
140
|
+
* @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.
|
|
141
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
142
|
+
*/
|
|
143
|
+
}, {
|
|
144
|
+
key: "getAllocationWithHttpInfo",
|
|
145
|
+
value: function getAllocationWithHttpInfo(allocation_gid, opts) {
|
|
146
|
+
opts = opts || {};
|
|
147
|
+
var postBody = null;
|
|
148
|
+
// verify the required parameter 'allocation_gid' is set
|
|
149
|
+
if (allocation_gid === undefined || allocation_gid === null) {
|
|
150
|
+
throw new Error("Missing the required parameter 'allocation_gid' when calling getAllocation");
|
|
151
|
+
}
|
|
152
|
+
var pathParams = {
|
|
153
|
+
'allocation_gid': allocation_gid
|
|
154
|
+
};
|
|
155
|
+
var queryParams = {};
|
|
156
|
+
opts = opts || {};
|
|
157
|
+
queryParams = opts;
|
|
158
|
+
var headerParams = {};
|
|
159
|
+
var formParams = {};
|
|
160
|
+
var authNames = ['personalAccessToken'];
|
|
161
|
+
var contentTypes = [];
|
|
162
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
163
|
+
var returnType = 'Blob';
|
|
164
|
+
return this.apiClient.callApi('/allocations/{allocation_gid}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Get an allocation
|
|
169
|
+
* Returns the complete allocation record for a single allocation.
|
|
170
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} allocation_gid Globally unique identifier for the allocation.
|
|
171
|
+
* @param {Object} opts Optional parameters
|
|
172
|
+
* @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.
|
|
173
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AllocationResponseData}
|
|
174
|
+
*/
|
|
175
|
+
}, {
|
|
176
|
+
key: "getAllocation",
|
|
177
|
+
value: function getAllocation(allocation_gid, opts) {
|
|
178
|
+
return this.getAllocationWithHttpInfo(allocation_gid, opts).then(function (response_and_data) {
|
|
179
|
+
return response_and_data.data;
|
|
180
|
+
});
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Get multiple allocations
|
|
185
|
+
* Returns a list of allocations filtered to a specific project or user.
|
|
186
|
+
* @param {Object} opts Optional parameters
|
|
187
|
+
* @param {String} opts.parent Globally unique identifier for the project to filter allocations by.
|
|
188
|
+
* @param {String} opts.assignee Globally unique identifier for the user the allocation is assigned to.
|
|
189
|
+
* @param {String} opts.workspace Globally unique identifier for the workspace.
|
|
190
|
+
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
191
|
+
* @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.*
|
|
192
|
+
* @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.
|
|
193
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
194
|
+
*/
|
|
195
|
+
}, {
|
|
196
|
+
key: "getAllocationsWithHttpInfo",
|
|
197
|
+
value: function getAllocationsWithHttpInfo(opts) {
|
|
198
|
+
opts = opts || {};
|
|
199
|
+
var postBody = null;
|
|
200
|
+
var pathParams = {};
|
|
201
|
+
var queryParams = {};
|
|
202
|
+
opts = opts || {};
|
|
203
|
+
queryParams = opts;
|
|
204
|
+
var headerParams = {};
|
|
205
|
+
var formParams = {};
|
|
206
|
+
var authNames = ['personalAccessToken'];
|
|
207
|
+
var contentTypes = [];
|
|
208
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
209
|
+
var returnType = 'Blob';
|
|
210
|
+
// Check if RETURN_COLLECTION is set and return a collection object if it is
|
|
211
|
+
if (this.apiClient.RETURN_COLLECTION) {
|
|
212
|
+
return Collection.fromApiClient(this.apiClient.callApi('/allocations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType), this.apiClient, {
|
|
213
|
+
'path': '/allocations',
|
|
214
|
+
'httpMethod': 'GET',
|
|
215
|
+
'pathParams': pathParams,
|
|
216
|
+
'queryParams': queryParams,
|
|
217
|
+
'headerParams': headerParams,
|
|
218
|
+
'formParams': formParams,
|
|
219
|
+
'bodyParam': postBody,
|
|
220
|
+
'authNames': authNames,
|
|
221
|
+
'contentTypes': contentTypes,
|
|
222
|
+
'accepts': accepts,
|
|
223
|
+
'returnType': returnType
|
|
224
|
+
});
|
|
225
|
+
}
|
|
226
|
+
return this.apiClient.callApi('/allocations', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Get multiple allocations
|
|
231
|
+
* Returns a list of allocations filtered to a specific project or user.
|
|
232
|
+
* @param {Object} opts Optional parameters
|
|
233
|
+
* @param {String} opts.parent Globally unique identifier for the project to filter allocations by.
|
|
234
|
+
* @param {String} opts.assignee Globally unique identifier for the user the allocation is assigned to.
|
|
235
|
+
* @param {String} opts.workspace Globally unique identifier for the workspace.
|
|
236
|
+
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
237
|
+
* @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.*
|
|
238
|
+
* @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.
|
|
239
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AllocationResponseArray}
|
|
240
|
+
*/
|
|
241
|
+
}, {
|
|
242
|
+
key: "getAllocations",
|
|
243
|
+
value: function getAllocations(opts) {
|
|
244
|
+
// Check if RETURN_COLLECTION is set and return a collection object if it is
|
|
245
|
+
if (this.apiClient.RETURN_COLLECTION) {
|
|
246
|
+
return this.getAllocationsWithHttpInfo(opts);
|
|
247
|
+
}
|
|
248
|
+
return this.getAllocationsWithHttpInfo(opts).then(function (response_and_data) {
|
|
249
|
+
return response_and_data.data;
|
|
250
|
+
});
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Update an allocation
|
|
255
|
+
* An existing allocation can be updated by making a PUT request on the URL for that allocation. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated allocation record.
|
|
256
|
+
* @param {module:model/Object} body The updated fields for the allocation.
|
|
257
|
+
* @param {String} allocation_gid Globally unique identifier for the allocation.
|
|
258
|
+
* @param {Object} opts Optional parameters
|
|
259
|
+
* @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.
|
|
260
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
261
|
+
*/
|
|
262
|
+
}, {
|
|
263
|
+
key: "updateAllocationWithHttpInfo",
|
|
264
|
+
value: function updateAllocationWithHttpInfo(body, allocation_gid, opts) {
|
|
265
|
+
opts = opts || {};
|
|
266
|
+
var postBody = body;
|
|
267
|
+
// verify the required parameter 'body' is set
|
|
268
|
+
if (body === undefined || body === null) {
|
|
269
|
+
throw new Error("Missing the required parameter 'body' when calling updateAllocation");
|
|
270
|
+
}
|
|
271
|
+
// verify the required parameter 'allocation_gid' is set
|
|
272
|
+
if (allocation_gid === undefined || allocation_gid === null) {
|
|
273
|
+
throw new Error("Missing the required parameter 'allocation_gid' when calling updateAllocation");
|
|
274
|
+
}
|
|
275
|
+
var pathParams = {
|
|
276
|
+
'allocation_gid': allocation_gid
|
|
277
|
+
};
|
|
278
|
+
var queryParams = {};
|
|
279
|
+
opts = opts || {};
|
|
280
|
+
queryParams = opts;
|
|
281
|
+
var headerParams = {};
|
|
282
|
+
var formParams = {};
|
|
283
|
+
var authNames = ['personalAccessToken'];
|
|
284
|
+
var contentTypes = ['application/json; charset=UTF-8'];
|
|
285
|
+
var accepts = ['application/json; charset=UTF-8'];
|
|
286
|
+
var returnType = 'Blob';
|
|
287
|
+
return this.apiClient.callApi('/allocations/{allocation_gid}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Update an allocation
|
|
292
|
+
* An existing allocation can be updated by making a PUT request on the URL for that allocation. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged. Returns the complete updated allocation record.
|
|
293
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} body The updated fields for the allocation.
|
|
294
|
+
* @param {<&vendorExtensions.x-jsdoc-type>} allocation_gid Globally unique identifier for the allocation.
|
|
295
|
+
* @param {Object} opts Optional parameters
|
|
296
|
+
* @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.
|
|
297
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AllocationResponseData}
|
|
298
|
+
*/
|
|
299
|
+
}, {
|
|
300
|
+
key: "updateAllocation",
|
|
301
|
+
value: function updateAllocation(body, allocation_gid, opts) {
|
|
302
|
+
return this.updateAllocationWithHttpInfo(body, allocation_gid, opts).then(function (response_and_data) {
|
|
303
|
+
return response_and_data.data;
|
|
304
|
+
});
|
|
305
|
+
}
|
|
306
|
+
}]);
|
|
307
|
+
}();
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Attachments service.
|
|
31
31
|
* @module api/AttachmentsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.5
|
|
33
33
|
*/
|
|
34
34
|
var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -199,7 +199,7 @@ var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
|
199
199
|
* @param {String} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`.
|
|
200
200
|
* @param {Object} opts Optional parameters
|
|
201
201
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
202
|
-
* @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.
|
|
202
|
+
* @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.*
|
|
203
203
|
* @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.
|
|
204
204
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
205
205
|
*/
|
|
@@ -248,7 +248,7 @@ var AttachmentsApi = exports.AttachmentsApi = /*#__PURE__*/function () {
|
|
|
248
248
|
* @param {<&vendorExtensions.x-jsdoc-type>} parent Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`.
|
|
249
249
|
* @param {Object} opts Optional parameters
|
|
250
250
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
251
|
-
* @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.
|
|
251
|
+
* @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.*
|
|
252
252
|
* @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.
|
|
253
253
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AttachmentResponseArray}
|
|
254
254
|
*/
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* AuditLogAPI service.
|
|
31
31
|
* @module api/AuditLogAPIApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.5
|
|
33
33
|
*/
|
|
34
34
|
var AuditLogAPIApi = exports.AuditLogAPIApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -57,7 +57,7 @@ var AuditLogAPIApi = exports.AuditLogAPIApi = /*#__PURE__*/function () {
|
|
|
57
57
|
* @param {String} opts.actor_gid Filter to events triggered by the actor with this ID.
|
|
58
58
|
* @param {String} opts.resource_gid Filter to events with this resource ID.
|
|
59
59
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
60
|
-
* @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.
|
|
60
|
+
* @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.*
|
|
61
61
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
62
62
|
*/
|
|
63
63
|
return _createClass(AuditLogAPIApi, [{
|
|
@@ -112,7 +112,7 @@ var AuditLogAPIApi = exports.AuditLogAPIApi = /*#__PURE__*/function () {
|
|
|
112
112
|
* @param {String} opts.actor_gid Filter to events triggered by the actor with this ID.
|
|
113
113
|
* @param {String} opts.resource_gid Filter to events with this resource ID.
|
|
114
114
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
115
|
-
* @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.
|
|
115
|
+
* @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.*
|
|
116
116
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuditLogEventArray}
|
|
117
117
|
*/
|
|
118
118
|
}, {
|
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.5
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -51,7 +51,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
51
51
|
* @param {String} portfolio_gid Globally unique identifier for the portfolio.
|
|
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.
|
|
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.
|
|
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
55
|
* @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.
|
|
56
56
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
57
57
|
*/
|
|
@@ -101,7 +101,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
101
101
|
* @param {<&vendorExtensions.x-jsdoc-type>} portfolio_gid Globally unique identifier for the portfolio.
|
|
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.
|
|
104
|
-
* @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.
|
|
104
|
+
* @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.*
|
|
105
105
|
* @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.
|
|
106
106
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldSettingResponseArray}
|
|
107
107
|
*/
|
|
@@ -123,7 +123,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
123
123
|
* @param {String} project_gid Globally unique identifier for the project.
|
|
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.
|
|
126
|
-
* @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.
|
|
126
|
+
* @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.*
|
|
127
127
|
* @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.
|
|
128
128
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
129
129
|
*/
|
|
@@ -173,7 +173,7 @@ var CustomFieldSettingsApi = exports.CustomFieldSettingsApi = /*#__PURE__*/funct
|
|
|
173
173
|
* @param {<&vendorExtensions.x-jsdoc-type>} project_gid Globally unique identifier for the project.
|
|
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.
|
|
176
|
-
* @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.
|
|
176
|
+
* @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.*
|
|
177
177
|
* @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.
|
|
178
178
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldSettingResponseArray}
|
|
179
179
|
*/
|
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* CustomFields service.
|
|
31
31
|
* @module api/CustomFieldsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.5
|
|
33
33
|
*/
|
|
34
34
|
var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -236,7 +236,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
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.
|
|
239
|
-
* @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.
|
|
239
|
+
* @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.*
|
|
240
240
|
* @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.
|
|
241
241
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
242
242
|
*/
|
|
@@ -286,7 +286,7 @@ var CustomFieldsApi = exports.CustomFieldsApi = /*#__PURE__*/function () {
|
|
|
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.
|
|
289
|
-
* @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.
|
|
289
|
+
* @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.*
|
|
290
290
|
* @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.
|
|
291
291
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CustomFieldResponseArray}
|
|
292
292
|
*/
|
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.5
|
|
33
33
|
*/
|
|
34
34
|
var GoalRelationshipsApi = exports.GoalRelationshipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -153,7 +153,7 @@ var GoalRelationshipsApi = exports.GoalRelationshipsApi = /*#__PURE__*/function
|
|
|
153
153
|
* @param {String} supported_goal Globally unique identifier for the supported goal in the goal relationship.
|
|
154
154
|
* @param {Object} opts Optional parameters
|
|
155
155
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
156
|
-
* @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.
|
|
156
|
+
* @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.*
|
|
157
157
|
* @param {String} opts.resource_subtype If provided, filter to goal relationships with a given resource_subtype.
|
|
158
158
|
* @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.
|
|
159
159
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
@@ -203,7 +203,7 @@ var GoalRelationshipsApi = exports.GoalRelationshipsApi = /*#__PURE__*/function
|
|
|
203
203
|
* @param {<&vendorExtensions.x-jsdoc-type>} supported_goal Globally unique identifier for the supported goal in the goal relationship.
|
|
204
204
|
* @param {Object} opts Optional parameters
|
|
205
205
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
206
|
-
* @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.
|
|
206
|
+
* @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.*
|
|
207
207
|
* @param {String} opts.resource_subtype If provided, filter to goal relationships with a given resource_subtype.
|
|
208
208
|
* @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.
|
|
209
209
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GoalRelationshipResponseArray}
|
package/dist/api/GoalsApi.js
CHANGED
|
@@ -29,7 +29,7 @@ var Collection = require('../utils/collection');
|
|
|
29
29
|
/**
|
|
30
30
|
* Goals service.
|
|
31
31
|
* @module api/GoalsApi
|
|
32
|
-
* @version 3.0.
|
|
32
|
+
* @version 3.0.5
|
|
33
33
|
*/
|
|
34
34
|
var GoalsApi = exports.GoalsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -300,7 +300,7 @@ var GoalsApi = exports.GoalsApi = /*#__PURE__*/function () {
|
|
|
300
300
|
* @param {String} opts.workspace Globally unique identifier for the workspace.
|
|
301
301
|
* @param {Array.<String>} opts.time_periods Globally unique identifiers for the time periods.
|
|
302
302
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
303
|
-
* @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.
|
|
303
|
+
* @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.*
|
|
304
304
|
* @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.
|
|
305
305
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
306
306
|
*/
|
|
@@ -350,7 +350,7 @@ var GoalsApi = exports.GoalsApi = /*#__PURE__*/function () {
|
|
|
350
350
|
* @param {String} opts.workspace Globally unique identifier for the workspace.
|
|
351
351
|
* @param {Array.<String>} opts.time_periods Globally unique identifiers for the time periods.
|
|
352
352
|
* @param {Number} opts.limit Results per page. The number of objects to return per page. The value must be between 1 and 100.
|
|
353
|
-
* @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.
|
|
353
|
+
* @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.*
|
|
354
354
|
* @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.
|
|
355
355
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GoalResponseArray}
|
|
356
356
|
*/
|
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.5
|
|
33
33
|
*/
|
|
34
34
|
var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -181,7 +181,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
181
181
|
* @param {String} opts.parent Globally unique identifier for `goal` or `project`.
|
|
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
|
-
* @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.
|
|
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.*
|
|
185
185
|
* @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.
|
|
186
186
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data and HTTP response
|
|
187
187
|
*/
|
|
@@ -226,7 +226,7 @@ var MembershipsApi = exports.MembershipsApi = /*#__PURE__*/function () {
|
|
|
226
226
|
* @param {String} opts.parent Globally unique identifier for `goal` or `project`.
|
|
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
|
-
* @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.
|
|
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.*
|
|
230
230
|
* @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.
|
|
231
231
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MembershipResponseArray}
|
|
232
232
|
*/
|