@useshortcut/client 1.0.0-beta.1 → 1.1.0
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 +19 -13
- package/lib/ShortcutClient.js +5 -36
- package/lib/generated/Api.d.ts +201 -119
- package/lib/generated/Api.js +184 -466
- package/lib/generated/data-contracts.d.ts +1489 -609
- package/lib/generated/http-client.d.ts +14 -12
- package/lib/generated/http-client.js +50 -90
- package/lib/index.js +5 -1
- package/package.json +33 -31
- package/lib/ShortcutApi.d.ts +0 -5
- package/lib/ShortcutApi.js +0 -45
package/lib/generated/Api.js
CHANGED
|
@@ -9,44 +9,16 @@
|
|
|
9
9
|
* ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
|
|
10
10
|
* ---------------------------------------------------------------
|
|
11
11
|
*/
|
|
12
|
-
var __extends = (this && this.__extends) || (function () {
|
|
13
|
-
var extendStatics = function (d, b) {
|
|
14
|
-
extendStatics = Object.setPrototypeOf ||
|
|
15
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
16
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
17
|
-
return extendStatics(d, b);
|
|
18
|
-
};
|
|
19
|
-
return function (d, b) {
|
|
20
|
-
if (typeof b !== "function" && b !== null)
|
|
21
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
22
|
-
extendStatics(d, b);
|
|
23
|
-
function __() { this.constructor = d; }
|
|
24
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
25
|
-
};
|
|
26
|
-
})();
|
|
27
|
-
var __assign = (this && this.__assign) || function () {
|
|
28
|
-
__assign = Object.assign || function(t) {
|
|
29
|
-
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
30
|
-
s = arguments[i];
|
|
31
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
32
|
-
t[p] = s[p];
|
|
33
|
-
}
|
|
34
|
-
return t;
|
|
35
|
-
};
|
|
36
|
-
return __assign.apply(this, arguments);
|
|
37
|
-
};
|
|
38
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
13
|
exports.Api = void 0;
|
|
40
|
-
|
|
14
|
+
const http_client_1 = require("./http-client");
|
|
41
15
|
/**
|
|
42
|
-
* Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization.
|
|
43
|
-
* @
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
function Api() {
|
|
49
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
16
|
+
* Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
|
|
17
|
+
* @private
|
|
18
|
+
*/
|
|
19
|
+
class Api extends http_client_1.HttpClient {
|
|
20
|
+
constructor() {
|
|
21
|
+
super(...arguments);
|
|
50
22
|
/**
|
|
51
23
|
* @description List Categories returns a list of all Categories and their attributes.
|
|
52
24
|
*
|
|
@@ -55,10 +27,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
55
27
|
* @request GET:/api/v3/categories
|
|
56
28
|
* @secure
|
|
57
29
|
*/
|
|
58
|
-
|
|
59
|
-
if (params === void 0) { params = {}; }
|
|
60
|
-
return _this.request(__assign({ path: "/api/v3/categories", method: "GET", secure: true, format: "json" }, params));
|
|
61
|
-
};
|
|
30
|
+
this.listCategories = (params = {}) => this.request(Object.assign({ path: `/api/v3/categories`, method: 'GET', secure: true, format: 'json' }, params));
|
|
62
31
|
/**
|
|
63
32
|
* @description Create Category allows you to create a new Category in Shortcut.
|
|
64
33
|
*
|
|
@@ -67,10 +36,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
67
36
|
* @request POST:/api/v3/categories
|
|
68
37
|
* @secure
|
|
69
38
|
*/
|
|
70
|
-
|
|
71
|
-
if (params === void 0) { params = {}; }
|
|
72
|
-
return _this.request(__assign({ path: "/api/v3/categories", method: "POST", body: CreateCategory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
73
|
-
};
|
|
39
|
+
this.createCategory = (CreateCategory, params = {}) => this.request(Object.assign({ path: `/api/v3/categories`, method: 'POST', body: CreateCategory, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
74
40
|
/**
|
|
75
41
|
* @description Get Category returns information about the selected Category.
|
|
76
42
|
*
|
|
@@ -79,10 +45,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
79
45
|
* @request GET:/api/v3/categories/{category-public-id}
|
|
80
46
|
* @secure
|
|
81
47
|
*/
|
|
82
|
-
|
|
83
|
-
if (params === void 0) { params = {}; }
|
|
84
|
-
return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
85
|
-
};
|
|
48
|
+
this.getCategory = (categoryPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/categories/${categoryPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
86
49
|
/**
|
|
87
50
|
* @description Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.
|
|
88
51
|
*
|
|
@@ -91,10 +54,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
91
54
|
* @request PUT:/api/v3/categories/{category-public-id}
|
|
92
55
|
* @secure
|
|
93
56
|
*/
|
|
94
|
-
|
|
95
|
-
if (params === void 0) { params = {}; }
|
|
96
|
-
return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "PUT", body: UpdateCategory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
97
|
-
};
|
|
57
|
+
this.updateCategory = (categoryPublicId, UpdateCategory, params = {}) => this.request(Object.assign({ path: `/api/v3/categories/${categoryPublicId}`, method: 'PUT', body: UpdateCategory, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
98
58
|
/**
|
|
99
59
|
* @description Delete Category can be used to delete any Category.
|
|
100
60
|
*
|
|
@@ -103,10 +63,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
103
63
|
* @request DELETE:/api/v3/categories/{category-public-id}
|
|
104
64
|
* @secure
|
|
105
65
|
*/
|
|
106
|
-
|
|
107
|
-
if (params === void 0) { params = {}; }
|
|
108
|
-
return _this.request(__assign({ path: "/api/v3/categories/" + categoryPublicId, method: "DELETE", secure: true }, params));
|
|
109
|
-
};
|
|
66
|
+
this.deleteCategory = (categoryPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/categories/${categoryPublicId}`, method: 'DELETE', secure: true }, params));
|
|
110
67
|
/**
|
|
111
68
|
* @description List Category Milestones returns a list of all Milestones with the Category.
|
|
112
69
|
*
|
|
@@ -115,58 +72,79 @@ var Api = /** @class */ (function (_super) {
|
|
|
115
72
|
* @request GET:/api/v3/categories/{category-public-id}/milestones
|
|
116
73
|
* @secure
|
|
117
74
|
*/
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
75
|
+
this.listCategoryMilestones = (categoryPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/categories/${categoryPublicId}/milestones`, method: 'GET', secure: true, format: 'json' }, params));
|
|
76
|
+
/**
|
|
77
|
+
* No description
|
|
78
|
+
*
|
|
79
|
+
* @name ListCustomFields
|
|
80
|
+
* @summary List Custom Fields
|
|
81
|
+
* @request GET:/api/v3/custom-fields
|
|
82
|
+
* @secure
|
|
83
|
+
*/
|
|
84
|
+
this.listCustomFields = (params = {}) => this.request(Object.assign({ path: `/api/v3/custom-fields`, method: 'GET', secure: true, format: 'json' }, params));
|
|
85
|
+
/**
|
|
86
|
+
* No description
|
|
87
|
+
*
|
|
88
|
+
* @name GetCustomField
|
|
89
|
+
* @summary Get Custom Field
|
|
90
|
+
* @request GET:/api/v3/custom-fields/{custom-field-public-id}
|
|
91
|
+
* @secure
|
|
92
|
+
*/
|
|
93
|
+
this.getCustomField = (customFieldPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/custom-fields/${customFieldPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
94
|
+
/**
|
|
95
|
+
* @description Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).
|
|
96
|
+
*
|
|
97
|
+
* @name UpdateCustomField
|
|
98
|
+
* @summary Update Custom Field
|
|
99
|
+
* @request PUT:/api/v3/custom-fields/{custom-field-public-id}
|
|
100
|
+
* @secure
|
|
101
|
+
*/
|
|
102
|
+
this.updateCustomField = (customFieldPublicId, UpdateCustomField, params = {}) => this.request(Object.assign({ path: `/api/v3/custom-fields/${customFieldPublicId}`, method: 'PUT', body: UpdateCustomField, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
103
|
+
/**
|
|
104
|
+
* No description
|
|
105
|
+
*
|
|
106
|
+
* @name DeleteCustomField
|
|
107
|
+
* @summary Delete Custom Field
|
|
108
|
+
* @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
|
|
109
|
+
* @secure
|
|
110
|
+
*/
|
|
111
|
+
this.deleteCustomField = (customFieldPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/custom-fields/${customFieldPublicId}`, method: 'DELETE', secure: true }, params));
|
|
122
112
|
/**
|
|
123
|
-
* @description List all the entity templates for
|
|
113
|
+
* @description List all the entity templates for the Workspace.
|
|
124
114
|
*
|
|
125
115
|
* @name ListEntityTemplates
|
|
126
116
|
* @summary List Entity Templates
|
|
127
117
|
* @request GET:/api/v3/entity-templates
|
|
128
118
|
* @secure
|
|
129
119
|
*/
|
|
130
|
-
|
|
131
|
-
if (params === void 0) { params = {}; }
|
|
132
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates", method: "GET", secure: true, format: "json" }, params));
|
|
133
|
-
};
|
|
120
|
+
this.listEntityTemplates = (params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates`, method: 'GET', secure: true, format: 'json' }, params));
|
|
134
121
|
/**
|
|
135
|
-
* @description Create a new entity template for
|
|
122
|
+
* @description Create a new entity template for the Workspace.
|
|
136
123
|
*
|
|
137
124
|
* @name CreateEntityTemplate
|
|
138
125
|
* @summary Create Entity Template
|
|
139
126
|
* @request POST:/api/v3/entity-templates
|
|
140
127
|
* @secure
|
|
141
128
|
*/
|
|
142
|
-
|
|
143
|
-
if (params === void 0) { params = {}; }
|
|
144
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates", method: "POST", body: CreateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
145
|
-
};
|
|
129
|
+
this.createEntityTemplate = (CreateEntityTemplate, params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates`, method: 'POST', body: CreateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
146
130
|
/**
|
|
147
|
-
* @description Disables the Story Template feature for the
|
|
131
|
+
* @description Disables the Story Template feature for the Workspace.
|
|
148
132
|
*
|
|
149
133
|
* @name DisableStoryTemplates
|
|
150
134
|
* @summary Disable Story Templates
|
|
151
135
|
* @request PUT:/api/v3/entity-templates/disable
|
|
152
136
|
* @secure
|
|
153
137
|
*/
|
|
154
|
-
|
|
155
|
-
if (params === void 0) { params = {}; }
|
|
156
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates/disable", method: "PUT", secure: true }, params));
|
|
157
|
-
};
|
|
138
|
+
this.disableStoryTemplates = (params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates/disable`, method: 'PUT', secure: true }, params));
|
|
158
139
|
/**
|
|
159
|
-
* @description Enables the Story Template feature for the
|
|
140
|
+
* @description Enables the Story Template feature for the Workspace.
|
|
160
141
|
*
|
|
161
142
|
* @name EnableStoryTemplates
|
|
162
143
|
* @summary Enable Story Templates
|
|
163
144
|
* @request PUT:/api/v3/entity-templates/enable
|
|
164
145
|
* @secure
|
|
165
146
|
*/
|
|
166
|
-
|
|
167
|
-
if (params === void 0) { params = {}; }
|
|
168
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates/enable", method: "PUT", secure: true }, params));
|
|
169
|
-
};
|
|
147
|
+
this.enableStoryTemplates = (params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates/enable`, method: 'PUT', secure: true }, params));
|
|
170
148
|
/**
|
|
171
149
|
* @description Get Entity Template returns information about a given entity template.
|
|
172
150
|
*
|
|
@@ -175,10 +153,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
175
153
|
* @request GET:/api/v3/entity-templates/{entity-template-public-id}
|
|
176
154
|
* @secure
|
|
177
155
|
*/
|
|
178
|
-
|
|
179
|
-
if (params === void 0) { params = {}; }
|
|
180
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "GET", secure: true, format: "json" }, params));
|
|
181
|
-
};
|
|
156
|
+
this.getEntityTemplate = (entityTemplatePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates/${entityTemplatePublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
182
157
|
/**
|
|
183
158
|
* @description Update an entity template's name or its contents.
|
|
184
159
|
*
|
|
@@ -187,10 +162,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
187
162
|
* @request PUT:/api/v3/entity-templates/{entity-template-public-id}
|
|
188
163
|
* @secure
|
|
189
164
|
*/
|
|
190
|
-
|
|
191
|
-
if (params === void 0) { params = {}; }
|
|
192
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "PUT", body: UpdateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
193
|
-
};
|
|
165
|
+
this.updateEntityTemplate = (entityTemplatePublicId, UpdateEntityTemplate, params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates/${entityTemplatePublicId}`, method: 'PUT', body: UpdateEntityTemplate, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
194
166
|
/**
|
|
195
167
|
* No description
|
|
196
168
|
*
|
|
@@ -199,22 +171,16 @@ var Api = /** @class */ (function (_super) {
|
|
|
199
171
|
* @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
|
|
200
172
|
* @secure
|
|
201
173
|
*/
|
|
202
|
-
|
|
203
|
-
if (params === void 0) { params = {}; }
|
|
204
|
-
return _this.request(__assign({ path: "/api/v3/entity-templates/" + entityTemplatePublicId, method: "DELETE", secure: true }, params));
|
|
205
|
-
};
|
|
174
|
+
this.deleteEntityTemplate = (entityTemplatePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/entity-templates/${entityTemplatePublicId}`, method: 'DELETE', secure: true }, params));
|
|
206
175
|
/**
|
|
207
|
-
* @description
|
|
176
|
+
* @description Returns the Epic Workflow for the Workspace.
|
|
208
177
|
*
|
|
209
178
|
* @name GetEpicWorkflow
|
|
210
179
|
* @summary Get Epic Workflow
|
|
211
180
|
* @request GET:/api/v3/epic-workflow
|
|
212
181
|
* @secure
|
|
213
182
|
*/
|
|
214
|
-
|
|
215
|
-
if (params === void 0) { params = {}; }
|
|
216
|
-
return _this.request(__assign({ path: "/api/v3/epic-workflow", method: "GET", secure: true, format: "json" }, params));
|
|
217
|
-
};
|
|
183
|
+
this.getEpicWorkflow = (params = {}) => this.request(Object.assign({ path: `/api/v3/epic-workflow`, method: 'GET', secure: true, format: 'json' }, params));
|
|
218
184
|
/**
|
|
219
185
|
* @description List Epics returns a list of all Epics and their attributes.
|
|
220
186
|
*
|
|
@@ -223,10 +189,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
223
189
|
* @request GET:/api/v3/epics
|
|
224
190
|
* @secure
|
|
225
191
|
*/
|
|
226
|
-
|
|
227
|
-
if (params === void 0) { params = {}; }
|
|
228
|
-
return _this.request(__assign({ path: "/api/v3/epics", method: "GET", body: ListEpics, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
229
|
-
};
|
|
192
|
+
this.listEpics = (ListEpics, params = {}) => this.request(Object.assign({ path: `/api/v3/epics`, method: 'GET', body: ListEpics, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
230
193
|
/**
|
|
231
194
|
* @description Create Epic allows you to create a new Epic in Shortcut.
|
|
232
195
|
*
|
|
@@ -235,10 +198,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
235
198
|
* @request POST:/api/v3/epics
|
|
236
199
|
* @secure
|
|
237
200
|
*/
|
|
238
|
-
|
|
239
|
-
if (params === void 0) { params = {}; }
|
|
240
|
-
return _this.request(__assign({ path: "/api/v3/epics", method: "POST", body: CreateEpic, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
241
|
-
};
|
|
201
|
+
this.createEpic = (CreateEpic, params = {}) => this.request(Object.assign({ path: `/api/v3/epics`, method: 'POST', body: CreateEpic, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
242
202
|
/**
|
|
243
203
|
* @description Get Epic returns information about the selected Epic.
|
|
244
204
|
*
|
|
@@ -247,10 +207,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
247
207
|
* @request GET:/api/v3/epics/{epic-public-id}
|
|
248
208
|
* @secure
|
|
249
209
|
*/
|
|
250
|
-
|
|
251
|
-
if (params === void 0) { params = {}; }
|
|
252
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
253
|
-
};
|
|
210
|
+
this.getEpic = (epicPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
254
211
|
/**
|
|
255
212
|
* @description Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
|
|
256
213
|
*
|
|
@@ -259,10 +216,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
259
216
|
* @request PUT:/api/v3/epics/{epic-public-id}
|
|
260
217
|
* @secure
|
|
261
218
|
*/
|
|
262
|
-
|
|
263
|
-
if (params === void 0) { params = {}; }
|
|
264
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "PUT", body: UpdateEpic, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
265
|
-
};
|
|
219
|
+
this.updateEpic = (epicPublicId, UpdateEpic, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}`, method: 'PUT', body: UpdateEpic, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
266
220
|
/**
|
|
267
221
|
* @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
|
|
268
222
|
*
|
|
@@ -271,10 +225,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
271
225
|
* @request DELETE:/api/v3/epics/{epic-public-id}
|
|
272
226
|
* @secure
|
|
273
227
|
*/
|
|
274
|
-
|
|
275
|
-
if (params === void 0) { params = {}; }
|
|
276
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId, method: "DELETE", secure: true }, params));
|
|
277
|
-
};
|
|
228
|
+
this.deleteEpic = (epicPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}`, method: 'DELETE', secure: true }, params));
|
|
278
229
|
/**
|
|
279
230
|
* @description Get a list of all Comments on an Epic.
|
|
280
231
|
*
|
|
@@ -283,10 +234,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
283
234
|
* @request GET:/api/v3/epics/{epic-public-id}/comments
|
|
284
235
|
* @secure
|
|
285
236
|
*/
|
|
286
|
-
|
|
287
|
-
if (params === void 0) { params = {}; }
|
|
288
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments", method: "GET", secure: true, format: "json" }, params));
|
|
289
|
-
};
|
|
237
|
+
this.listEpicComments = (epicPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments`, method: 'GET', secure: true, format: 'json' }, params));
|
|
290
238
|
/**
|
|
291
239
|
* @description This endpoint allows you to create a threaded Comment on an Epic.
|
|
292
240
|
*
|
|
@@ -295,10 +243,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
295
243
|
* @request POST:/api/v3/epics/{epic-public-id}/comments
|
|
296
244
|
* @secure
|
|
297
245
|
*/
|
|
298
|
-
|
|
299
|
-
if (params === void 0) { params = {}; }
|
|
300
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments", method: "POST", body: CreateEpicComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
301
|
-
};
|
|
246
|
+
this.createEpicComment = (epicPublicId, CreateEpicComment, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments`, method: 'POST', body: CreateEpicComment, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
302
247
|
/**
|
|
303
248
|
* @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
|
|
304
249
|
*
|
|
@@ -307,10 +252,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
307
252
|
* @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
308
253
|
* @secure
|
|
309
254
|
*/
|
|
310
|
-
|
|
311
|
-
if (params === void 0) { params = {}; }
|
|
312
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "POST", body: CreateCommentComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
313
|
-
};
|
|
255
|
+
this.createEpicCommentComment = (epicPublicId, commentPublicId, CreateCommentComment, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`, method: 'POST', body: CreateCommentComment, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
314
256
|
/**
|
|
315
257
|
* @description This endpoint returns information about the selected Epic Comment.
|
|
316
258
|
*
|
|
@@ -319,10 +261,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
319
261
|
* @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
320
262
|
* @secure
|
|
321
263
|
*/
|
|
322
|
-
|
|
323
|
-
if (params === void 0) { params = {}; }
|
|
324
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
325
|
-
};
|
|
264
|
+
this.getEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
326
265
|
/**
|
|
327
266
|
* @description This endpoint allows you to update a threaded Comment on an Epic.
|
|
328
267
|
*
|
|
@@ -331,10 +270,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
331
270
|
* @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
332
271
|
* @secure
|
|
333
272
|
*/
|
|
334
|
-
|
|
335
|
-
if (params === void 0) { params = {}; }
|
|
336
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "PUT", body: UpdateComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
337
|
-
};
|
|
273
|
+
this.updateEpicComment = (epicPublicId, commentPublicId, UpdateComment, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`, method: 'PUT', body: UpdateComment, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
338
274
|
/**
|
|
339
275
|
* @description This endpoint allows you to delete a Comment from an Epic.
|
|
340
276
|
*
|
|
@@ -343,10 +279,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
343
279
|
* @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
|
|
344
280
|
* @secure
|
|
345
281
|
*/
|
|
346
|
-
|
|
347
|
-
if (params === void 0) { params = {}; }
|
|
348
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/comments/" + commentPublicId, method: "DELETE", secure: true }, params));
|
|
349
|
-
};
|
|
282
|
+
this.deleteEpicComment = (epicPublicId, commentPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/comments/${commentPublicId}`, method: 'DELETE', secure: true }, params));
|
|
350
283
|
/**
|
|
351
284
|
* @description Get a list of all Stories in an Epic.
|
|
352
285
|
*
|
|
@@ -355,10 +288,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
355
288
|
* @request GET:/api/v3/epics/{epic-public-id}/stories
|
|
356
289
|
* @secure
|
|
357
290
|
*/
|
|
358
|
-
|
|
359
|
-
if (params === void 0) { params = {}; }
|
|
360
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/stories", method: "GET", body: GetEpicStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
361
|
-
};
|
|
291
|
+
this.listEpicStories = (epicPublicId, GetEpicStories, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/stories`, method: 'GET', body: GetEpicStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
362
292
|
/**
|
|
363
293
|
* @description This endpoint allows you to unlink a productboard epic.
|
|
364
294
|
*
|
|
@@ -367,10 +297,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
367
297
|
* @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
|
|
368
298
|
* @secure
|
|
369
299
|
*/
|
|
370
|
-
|
|
371
|
-
if (params === void 0) { params = {}; }
|
|
372
|
-
return _this.request(__assign({ path: "/api/v3/epics/" + epicPublicId + "/unlink-productboard", method: "POST", secure: true }, params));
|
|
373
|
-
};
|
|
300
|
+
this.unlinkProductboardFromEpic = (epicPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/epics/${epicPublicId}/unlink-productboard`, method: 'POST', secure: true }, params));
|
|
374
301
|
/**
|
|
375
302
|
* @description Get Stories which have a given External Link associated with them.
|
|
376
303
|
*
|
|
@@ -379,10 +306,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
379
306
|
* @request GET:/api/v3/external-link/stories
|
|
380
307
|
* @secure
|
|
381
308
|
*/
|
|
382
|
-
|
|
383
|
-
if (params === void 0) { params = {}; }
|
|
384
|
-
return _this.request(__assign({ path: "/api/v3/external-link/stories", method: "GET", body: GetExternalLinkStoriesParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
385
|
-
};
|
|
309
|
+
this.getExternalLinkStories = (GetExternalLinkStoriesParams, params = {}) => this.request(Object.assign({ path: `/api/v3/external-link/stories`, method: 'GET', body: GetExternalLinkStoriesParams, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
386
310
|
/**
|
|
387
311
|
* @description List Files returns a list of all UploadedFiles in the workspace.
|
|
388
312
|
*
|
|
@@ -391,10 +315,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
391
315
|
* @request GET:/api/v3/files
|
|
392
316
|
* @secure
|
|
393
317
|
*/
|
|
394
|
-
|
|
395
|
-
if (params === void 0) { params = {}; }
|
|
396
|
-
return _this.request(__assign({ path: "/api/v3/files", method: "GET", secure: true, format: "json" }, params));
|
|
397
|
-
};
|
|
318
|
+
this.listFiles = (params = {}) => this.request(Object.assign({ path: `/api/v3/files`, method: 'GET', secure: true, format: 'json' }, params));
|
|
398
319
|
/**
|
|
399
320
|
* @description Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.
|
|
400
321
|
*
|
|
@@ -403,10 +324,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
403
324
|
* @request POST:/api/v3/files
|
|
404
325
|
* @secure
|
|
405
326
|
*/
|
|
406
|
-
|
|
407
|
-
if (params === void 0) { params = {}; }
|
|
408
|
-
return _this.request(__assign({ path: "/api/v3/files", method: "POST", body: data, secure: true, type: http_client_1.ContentType.FormData, format: "json" }, params));
|
|
409
|
-
};
|
|
327
|
+
this.uploadFiles = (data, params = {}) => this.request(Object.assign({ path: `/api/v3/files`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.FormData, format: 'json' }, params));
|
|
410
328
|
/**
|
|
411
329
|
* @description Get File returns information about the selected UploadedFile.
|
|
412
330
|
*
|
|
@@ -415,10 +333,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
415
333
|
* @request GET:/api/v3/files/{file-public-id}
|
|
416
334
|
* @secure
|
|
417
335
|
*/
|
|
418
|
-
|
|
419
|
-
if (params === void 0) { params = {}; }
|
|
420
|
-
return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "GET", secure: true, format: "json" }, params));
|
|
421
|
-
};
|
|
336
|
+
this.getFile = (filePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/files/${filePublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
422
337
|
/**
|
|
423
338
|
* @description Update File updates the properties of an UploadedFile (but not its content).
|
|
424
339
|
*
|
|
@@ -427,10 +342,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
427
342
|
* @request PUT:/api/v3/files/{file-public-id}
|
|
428
343
|
* @secure
|
|
429
344
|
*/
|
|
430
|
-
|
|
431
|
-
if (params === void 0) { params = {}; }
|
|
432
|
-
return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "PUT", body: UpdateFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
433
|
-
};
|
|
345
|
+
this.updateFile = (filePublicId, UpdateFile, params = {}) => this.request(Object.assign({ path: `/api/v3/files/${filePublicId}`, method: 'PUT', body: UpdateFile, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
434
346
|
/**
|
|
435
347
|
* @description Delete File deletes a previously uploaded file.
|
|
436
348
|
*
|
|
@@ -439,10 +351,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
439
351
|
* @request DELETE:/api/v3/files/{file-public-id}
|
|
440
352
|
* @secure
|
|
441
353
|
*/
|
|
442
|
-
|
|
443
|
-
if (params === void 0) { params = {}; }
|
|
444
|
-
return _this.request(__assign({ path: "/api/v3/files/" + filePublicId, method: "DELETE", secure: true }, params));
|
|
445
|
-
};
|
|
354
|
+
this.deleteFile = (filePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/files/${filePublicId}`, method: 'DELETE', secure: true }, params));
|
|
446
355
|
/**
|
|
447
356
|
* @description A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
|
|
448
357
|
*
|
|
@@ -451,10 +360,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
451
360
|
* @request GET:/api/v3/groups
|
|
452
361
|
* @secure
|
|
453
362
|
*/
|
|
454
|
-
|
|
455
|
-
if (params === void 0) { params = {}; }
|
|
456
|
-
return _this.request(__assign({ path: "/api/v3/groups", method: "GET", secure: true, format: "json" }, params));
|
|
457
|
-
};
|
|
363
|
+
this.listGroups = (params = {}) => this.request(Object.assign({ path: `/api/v3/groups`, method: 'GET', secure: true, format: 'json' }, params));
|
|
458
364
|
/**
|
|
459
365
|
* No description
|
|
460
366
|
*
|
|
@@ -463,10 +369,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
463
369
|
* @request POST:/api/v3/groups
|
|
464
370
|
* @secure
|
|
465
371
|
*/
|
|
466
|
-
|
|
467
|
-
if (params === void 0) { params = {}; }
|
|
468
|
-
return _this.request(__assign({ path: "/api/v3/groups", method: "POST", body: CreateGroup, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
469
|
-
};
|
|
372
|
+
this.createGroup = (CreateGroup, params = {}) => this.request(Object.assign({ path: `/api/v3/groups`, method: 'POST', body: CreateGroup, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
470
373
|
/**
|
|
471
374
|
* @description Disables Groups for the current workspace2
|
|
472
375
|
*
|
|
@@ -475,10 +378,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
475
378
|
* @request PUT:/api/v3/groups/disable
|
|
476
379
|
* @secure
|
|
477
380
|
*/
|
|
478
|
-
|
|
479
|
-
if (params === void 0) { params = {}; }
|
|
480
|
-
return _this.request(__assign({ path: "/api/v3/groups/disable", method: "PUT", secure: true }, params));
|
|
481
|
-
};
|
|
381
|
+
this.disableGroups = (params = {}) => this.request(Object.assign({ path: `/api/v3/groups/disable`, method: 'PUT', secure: true }, params));
|
|
482
382
|
/**
|
|
483
383
|
* @description Enables Groups for the current workspace2
|
|
484
384
|
*
|
|
@@ -487,10 +387,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
487
387
|
* @request PUT:/api/v3/groups/enable
|
|
488
388
|
* @secure
|
|
489
389
|
*/
|
|
490
|
-
|
|
491
|
-
if (params === void 0) { params = {}; }
|
|
492
|
-
return _this.request(__assign({ path: "/api/v3/groups/enable", method: "PUT", secure: true }, params));
|
|
493
|
-
};
|
|
390
|
+
this.enableGroups = (params = {}) => this.request(Object.assign({ path: `/api/v3/groups/enable`, method: 'PUT', secure: true }, params));
|
|
494
391
|
/**
|
|
495
392
|
* No description
|
|
496
393
|
*
|
|
@@ -499,10 +396,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
499
396
|
* @request GET:/api/v3/groups/{group-public-id}
|
|
500
397
|
* @secure
|
|
501
398
|
*/
|
|
502
|
-
|
|
503
|
-
if (params === void 0) { params = {}; }
|
|
504
|
-
return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
505
|
-
};
|
|
399
|
+
this.getGroup = (groupPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/groups/${groupPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
506
400
|
/**
|
|
507
401
|
* No description
|
|
508
402
|
*
|
|
@@ -511,10 +405,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
511
405
|
* @request PUT:/api/v3/groups/{group-public-id}
|
|
512
406
|
* @secure
|
|
513
407
|
*/
|
|
514
|
-
|
|
515
|
-
if (params === void 0) { params = {}; }
|
|
516
|
-
return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId, method: "PUT", body: UpdateGroup, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
517
|
-
};
|
|
408
|
+
this.updateGroup = (groupPublicId, UpdateGroup, params = {}) => this.request(Object.assign({ path: `/api/v3/groups/${groupPublicId}`, method: 'PUT', body: UpdateGroup, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
518
409
|
/**
|
|
519
410
|
* @description List the Stories assigned to the Group. (By default, limited to 1,000).
|
|
520
411
|
*
|
|
@@ -523,10 +414,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
523
414
|
* @request GET:/api/v3/groups/{group-public-id}/stories
|
|
524
415
|
* @secure
|
|
525
416
|
*/
|
|
526
|
-
|
|
527
|
-
if (params === void 0) { params = {}; }
|
|
528
|
-
return _this.request(__assign({ path: "/api/v3/groups/" + groupPublicId + "/stories", method: "GET", body: ListGroupStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
529
|
-
};
|
|
417
|
+
this.listGroupStories = (groupPublicId, ListGroupStories, params = {}) => this.request(Object.assign({ path: `/api/v3/groups/${groupPublicId}/stories`, method: 'GET', body: ListGroupStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
530
418
|
/**
|
|
531
419
|
* No description
|
|
532
420
|
*
|
|
@@ -535,10 +423,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
535
423
|
* @request GET:/api/v3/iterations
|
|
536
424
|
* @secure
|
|
537
425
|
*/
|
|
538
|
-
|
|
539
|
-
if (params === void 0) { params = {}; }
|
|
540
|
-
return _this.request(__assign({ path: "/api/v3/iterations", method: "GET", secure: true, format: "json" }, params));
|
|
541
|
-
};
|
|
426
|
+
this.listIterations = (params = {}) => this.request(Object.assign({ path: `/api/v3/iterations`, method: 'GET', secure: true, format: 'json' }, params));
|
|
542
427
|
/**
|
|
543
428
|
* No description
|
|
544
429
|
*
|
|
@@ -547,10 +432,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
547
432
|
* @request POST:/api/v3/iterations
|
|
548
433
|
* @secure
|
|
549
434
|
*/
|
|
550
|
-
|
|
551
|
-
if (params === void 0) { params = {}; }
|
|
552
|
-
return _this.request(__assign({ path: "/api/v3/iterations", method: "POST", body: CreateIteration, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
553
|
-
};
|
|
435
|
+
this.createIteration = (CreateIteration, params = {}) => this.request(Object.assign({ path: `/api/v3/iterations`, method: 'POST', body: CreateIteration, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
554
436
|
/**
|
|
555
437
|
* @description Disables Iterations for the current workspace
|
|
556
438
|
*
|
|
@@ -559,10 +441,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
559
441
|
* @request PUT:/api/v3/iterations/disable
|
|
560
442
|
* @secure
|
|
561
443
|
*/
|
|
562
|
-
|
|
563
|
-
if (params === void 0) { params = {}; }
|
|
564
|
-
return _this.request(__assign({ path: "/api/v3/iterations/disable", method: "PUT", secure: true }, params));
|
|
565
|
-
};
|
|
444
|
+
this.disableIterations = (params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/disable`, method: 'PUT', secure: true }, params));
|
|
566
445
|
/**
|
|
567
446
|
* @description Enables Iterations for the current workspace
|
|
568
447
|
*
|
|
@@ -571,10 +450,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
571
450
|
* @request PUT:/api/v3/iterations/enable
|
|
572
451
|
* @secure
|
|
573
452
|
*/
|
|
574
|
-
|
|
575
|
-
if (params === void 0) { params = {}; }
|
|
576
|
-
return _this.request(__assign({ path: "/api/v3/iterations/enable", method: "PUT", secure: true }, params));
|
|
577
|
-
};
|
|
453
|
+
this.enableIterations = (params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/enable`, method: 'PUT', secure: true }, params));
|
|
578
454
|
/**
|
|
579
455
|
* No description
|
|
580
456
|
*
|
|
@@ -583,10 +459,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
583
459
|
* @request GET:/api/v3/iterations/{iteration-public-id}
|
|
584
460
|
* @secure
|
|
585
461
|
*/
|
|
586
|
-
|
|
587
|
-
if (params === void 0) { params = {}; }
|
|
588
|
-
return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
589
|
-
};
|
|
462
|
+
this.getIteration = (iterationPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/${iterationPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
590
463
|
/**
|
|
591
464
|
* No description
|
|
592
465
|
*
|
|
@@ -595,10 +468,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
595
468
|
* @request PUT:/api/v3/iterations/{iteration-public-id}
|
|
596
469
|
* @secure
|
|
597
470
|
*/
|
|
598
|
-
|
|
599
|
-
if (params === void 0) { params = {}; }
|
|
600
|
-
return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "PUT", body: UpdateIteration, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
601
|
-
};
|
|
471
|
+
this.updateIteration = (iterationPublicId, UpdateIteration, params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/${iterationPublicId}`, method: 'PUT', body: UpdateIteration, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
602
472
|
/**
|
|
603
473
|
* No description
|
|
604
474
|
*
|
|
@@ -607,10 +477,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
607
477
|
* @request DELETE:/api/v3/iterations/{iteration-public-id}
|
|
608
478
|
* @secure
|
|
609
479
|
*/
|
|
610
|
-
|
|
611
|
-
if (params === void 0) { params = {}; }
|
|
612
|
-
return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId, method: "DELETE", secure: true }, params));
|
|
613
|
-
};
|
|
480
|
+
this.deleteIteration = (iterationPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/${iterationPublicId}`, method: 'DELETE', secure: true }, params));
|
|
614
481
|
/**
|
|
615
482
|
* @description Get a list of all Stories in an Iteration.
|
|
616
483
|
*
|
|
@@ -619,10 +486,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
619
486
|
* @request GET:/api/v3/iterations/{iteration-public-id}/stories
|
|
620
487
|
* @secure
|
|
621
488
|
*/
|
|
622
|
-
|
|
623
|
-
if (params === void 0) { params = {}; }
|
|
624
|
-
return _this.request(__assign({ path: "/api/v3/iterations/" + iterationPublicId + "/stories", method: "GET", body: GetIterationStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
625
|
-
};
|
|
489
|
+
this.listIterationStories = (iterationPublicId, GetIterationStories, params = {}) => this.request(Object.assign({ path: `/api/v3/iterations/${iterationPublicId}/stories`, method: 'GET', body: GetIterationStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
626
490
|
/**
|
|
627
491
|
* @description List Labels returns a list of all Labels and their attributes.
|
|
628
492
|
*
|
|
@@ -631,10 +495,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
631
495
|
* @request GET:/api/v3/labels
|
|
632
496
|
* @secure
|
|
633
497
|
*/
|
|
634
|
-
|
|
635
|
-
if (params === void 0) { params = {}; }
|
|
636
|
-
return _this.request(__assign({ path: "/api/v3/labels", method: "GET", body: ListLabels, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
637
|
-
};
|
|
498
|
+
this.listLabels = (ListLabels, params = {}) => this.request(Object.assign({ path: `/api/v3/labels`, method: 'GET', body: ListLabels, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
638
499
|
/**
|
|
639
500
|
* @description Create Label allows you to create a new Label in Shortcut.
|
|
640
501
|
*
|
|
@@ -643,10 +504,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
643
504
|
* @request POST:/api/v3/labels
|
|
644
505
|
* @secure
|
|
645
506
|
*/
|
|
646
|
-
|
|
647
|
-
if (params === void 0) { params = {}; }
|
|
648
|
-
return _this.request(__assign({ path: "/api/v3/labels", method: "POST", body: CreateLabelParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
649
|
-
};
|
|
507
|
+
this.createLabel = (CreateLabelParams, params = {}) => this.request(Object.assign({ path: `/api/v3/labels`, method: 'POST', body: CreateLabelParams, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
650
508
|
/**
|
|
651
509
|
* @description Get Label returns information about the selected Label.
|
|
652
510
|
*
|
|
@@ -655,10 +513,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
655
513
|
* @request GET:/api/v3/labels/{label-public-id}
|
|
656
514
|
* @secure
|
|
657
515
|
*/
|
|
658
|
-
|
|
659
|
-
if (params === void 0) { params = {}; }
|
|
660
|
-
return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
661
|
-
};
|
|
516
|
+
this.getLabel = (labelPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/labels/${labelPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
662
517
|
/**
|
|
663
518
|
* @description Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
|
|
664
519
|
*
|
|
@@ -667,10 +522,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
667
522
|
* @request PUT:/api/v3/labels/{label-public-id}
|
|
668
523
|
* @secure
|
|
669
524
|
*/
|
|
670
|
-
|
|
671
|
-
if (params === void 0) { params = {}; }
|
|
672
|
-
return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "PUT", body: UpdateLabel, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
673
|
-
};
|
|
525
|
+
this.updateLabel = (labelPublicId, UpdateLabel, params = {}) => this.request(Object.assign({ path: `/api/v3/labels/${labelPublicId}`, method: 'PUT', body: UpdateLabel, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
674
526
|
/**
|
|
675
527
|
* @description Delete Label can be used to delete any Label.
|
|
676
528
|
*
|
|
@@ -679,10 +531,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
679
531
|
* @request DELETE:/api/v3/labels/{label-public-id}
|
|
680
532
|
* @secure
|
|
681
533
|
*/
|
|
682
|
-
|
|
683
|
-
if (params === void 0) { params = {}; }
|
|
684
|
-
return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId, method: "DELETE", secure: true }, params));
|
|
685
|
-
};
|
|
534
|
+
this.deleteLabel = (labelPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/labels/${labelPublicId}`, method: 'DELETE', secure: true }, params));
|
|
686
535
|
/**
|
|
687
536
|
* @description List all of the Epics with the Label.
|
|
688
537
|
*
|
|
@@ -691,10 +540,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
691
540
|
* @request GET:/api/v3/labels/{label-public-id}/epics
|
|
692
541
|
* @secure
|
|
693
542
|
*/
|
|
694
|
-
|
|
695
|
-
if (params === void 0) { params = {}; }
|
|
696
|
-
return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId + "/epics", method: "GET", secure: true, format: "json" }, params));
|
|
697
|
-
};
|
|
543
|
+
this.listLabelEpics = (labelPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/labels/${labelPublicId}/epics`, method: 'GET', secure: true, format: 'json' }, params));
|
|
698
544
|
/**
|
|
699
545
|
* @description List all of the Stories with the Label.
|
|
700
546
|
*
|
|
@@ -703,10 +549,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
703
549
|
* @request GET:/api/v3/labels/{label-public-id}/stories
|
|
704
550
|
* @secure
|
|
705
551
|
*/
|
|
706
|
-
|
|
707
|
-
if (params === void 0) { params = {}; }
|
|
708
|
-
return _this.request(__assign({ path: "/api/v3/labels/" + labelPublicId + "/stories", method: "GET", body: GetLabelStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
709
|
-
};
|
|
552
|
+
this.listLabelStories = (labelPublicId, GetLabelStories, params = {}) => this.request(Object.assign({ path: `/api/v3/labels/${labelPublicId}/stories`, method: 'GET', body: GetLabelStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
710
553
|
/**
|
|
711
554
|
* @description List Linked Files returns a list of all Linked-Files and their attributes.
|
|
712
555
|
*
|
|
@@ -715,10 +558,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
715
558
|
* @request GET:/api/v3/linked-files
|
|
716
559
|
* @secure
|
|
717
560
|
*/
|
|
718
|
-
|
|
719
|
-
if (params === void 0) { params = {}; }
|
|
720
|
-
return _this.request(__assign({ path: "/api/v3/linked-files", method: "GET", secure: true, format: "json" }, params));
|
|
721
|
-
};
|
|
561
|
+
this.listLinkedFiles = (params = {}) => this.request(Object.assign({ path: `/api/v3/linked-files`, method: 'GET', secure: true, format: 'json' }, params));
|
|
722
562
|
/**
|
|
723
563
|
* @description Create Linked File allows you to create a new Linked File in Shortcut.
|
|
724
564
|
*
|
|
@@ -727,10 +567,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
727
567
|
* @request POST:/api/v3/linked-files
|
|
728
568
|
* @secure
|
|
729
569
|
*/
|
|
730
|
-
|
|
731
|
-
if (params === void 0) { params = {}; }
|
|
732
|
-
return _this.request(__assign({ path: "/api/v3/linked-files", method: "POST", body: CreateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
733
|
-
};
|
|
570
|
+
this.createLinkedFile = (CreateLinkedFile, params = {}) => this.request(Object.assign({ path: `/api/v3/linked-files`, method: 'POST', body: CreateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
734
571
|
/**
|
|
735
572
|
* @description Get File returns information about the selected Linked File.
|
|
736
573
|
*
|
|
@@ -739,10 +576,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
739
576
|
* @request GET:/api/v3/linked-files/{linked-file-public-id}
|
|
740
577
|
* @secure
|
|
741
578
|
*/
|
|
742
|
-
|
|
743
|
-
if (params === void 0) { params = {}; }
|
|
744
|
-
return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "GET", secure: true, format: "json" }, params));
|
|
745
|
-
};
|
|
579
|
+
this.getLinkedFile = (linkedFilePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/linked-files/${linkedFilePublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
746
580
|
/**
|
|
747
581
|
* @description Updated Linked File allows you to update properties of a previously attached Linked-File.
|
|
748
582
|
*
|
|
@@ -751,10 +585,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
751
585
|
* @request PUT:/api/v3/linked-files/{linked-file-public-id}
|
|
752
586
|
* @secure
|
|
753
587
|
*/
|
|
754
|
-
|
|
755
|
-
if (params === void 0) { params = {}; }
|
|
756
|
-
return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "PUT", body: UpdateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
757
|
-
};
|
|
588
|
+
this.updateLinkedFile = (linkedFilePublicId, UpdateLinkedFile, params = {}) => this.request(Object.assign({ path: `/api/v3/linked-files/${linkedFilePublicId}`, method: 'PUT', body: UpdateLinkedFile, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
758
589
|
/**
|
|
759
590
|
* @description Delete Linked File can be used to delete any previously attached Linked-File.
|
|
760
591
|
*
|
|
@@ -763,10 +594,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
763
594
|
* @request DELETE:/api/v3/linked-files/{linked-file-public-id}
|
|
764
595
|
* @secure
|
|
765
596
|
*/
|
|
766
|
-
|
|
767
|
-
if (params === void 0) { params = {}; }
|
|
768
|
-
return _this.request(__assign({ path: "/api/v3/linked-files/" + linkedFilePublicId, method: "DELETE", secure: true }, params));
|
|
769
|
-
};
|
|
597
|
+
this.deleteLinkedFile = (linkedFilePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/linked-files/${linkedFilePublicId}`, method: 'DELETE', secure: true }, params));
|
|
770
598
|
/**
|
|
771
599
|
* @description Returns information about the authenticated member.
|
|
772
600
|
*
|
|
@@ -775,22 +603,16 @@ var Api = /** @class */ (function (_super) {
|
|
|
775
603
|
* @request GET:/api/v3/member
|
|
776
604
|
* @secure
|
|
777
605
|
*/
|
|
778
|
-
|
|
779
|
-
if (params === void 0) { params = {}; }
|
|
780
|
-
return _this.request(__assign({ path: "/api/v3/member", method: "GET", secure: true, format: "json" }, params));
|
|
781
|
-
};
|
|
606
|
+
this.getCurrentMemberInfo = (params = {}) => this.request(Object.assign({ path: `/api/v3/member`, method: 'GET', secure: true, format: 'json' }, params));
|
|
782
607
|
/**
|
|
783
|
-
* @description
|
|
608
|
+
* @description Returns information about members of the Workspace.
|
|
784
609
|
*
|
|
785
610
|
* @name ListMembers
|
|
786
611
|
* @summary List Members
|
|
787
612
|
* @request GET:/api/v3/members
|
|
788
613
|
* @secure
|
|
789
614
|
*/
|
|
790
|
-
|
|
791
|
-
if (params === void 0) { params = {}; }
|
|
792
|
-
return _this.request(__assign({ path: "/api/v3/members", method: "GET", body: ListMembers, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
793
|
-
};
|
|
615
|
+
this.listMembers = (ListMembers, params = {}) => this.request(Object.assign({ path: `/api/v3/members`, method: 'GET', body: ListMembers, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
794
616
|
/**
|
|
795
617
|
* @description Returns information about a Member.
|
|
796
618
|
*
|
|
@@ -799,10 +621,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
799
621
|
* @request GET:/api/v3/members/{member-public-id}
|
|
800
622
|
* @secure
|
|
801
623
|
*/
|
|
802
|
-
|
|
803
|
-
if (params === void 0) { params = {}; }
|
|
804
|
-
return _this.request(__assign({ path: "/api/v3/members/" + memberPublicId, method: "GET", body: GetMember, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
805
|
-
};
|
|
624
|
+
this.getMember = (memberPublicId, GetMember, params = {}) => this.request(Object.assign({ path: `/api/v3/members/${memberPublicId}`, method: 'GET', body: GetMember, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
806
625
|
/**
|
|
807
626
|
* @description List Milestones returns a list of all Milestones and their attributes.
|
|
808
627
|
*
|
|
@@ -811,10 +630,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
811
630
|
* @request GET:/api/v3/milestones
|
|
812
631
|
* @secure
|
|
813
632
|
*/
|
|
814
|
-
|
|
815
|
-
if (params === void 0) { params = {}; }
|
|
816
|
-
return _this.request(__assign({ path: "/api/v3/milestones", method: "GET", secure: true, format: "json" }, params));
|
|
817
|
-
};
|
|
633
|
+
this.listMilestones = (params = {}) => this.request(Object.assign({ path: `/api/v3/milestones`, method: 'GET', secure: true, format: 'json' }, params));
|
|
818
634
|
/**
|
|
819
635
|
* @description Create Milestone allows you to create a new Milestone in Shortcut.
|
|
820
636
|
*
|
|
@@ -823,10 +639,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
823
639
|
* @request POST:/api/v3/milestones
|
|
824
640
|
* @secure
|
|
825
641
|
*/
|
|
826
|
-
|
|
827
|
-
if (params === void 0) { params = {}; }
|
|
828
|
-
return _this.request(__assign({ path: "/api/v3/milestones", method: "POST", body: CreateMilestone, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
829
|
-
};
|
|
642
|
+
this.createMilestone = (CreateMilestone, params = {}) => this.request(Object.assign({ path: `/api/v3/milestones`, method: 'POST', body: CreateMilestone, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
830
643
|
/**
|
|
831
644
|
* @description Get Milestone returns information about a chosen Milestone.
|
|
832
645
|
*
|
|
@@ -835,10 +648,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
835
648
|
* @request GET:/api/v3/milestones/{milestone-public-id}
|
|
836
649
|
* @secure
|
|
837
650
|
*/
|
|
838
|
-
|
|
839
|
-
if (params === void 0) { params = {}; }
|
|
840
|
-
return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "GET", secure: true, format: "json" }, params));
|
|
841
|
-
};
|
|
651
|
+
this.getMilestone = (milestonePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/milestones/${milestonePublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
842
652
|
/**
|
|
843
653
|
* @description Update Milestone can be used to update Milestone properties.
|
|
844
654
|
*
|
|
@@ -847,10 +657,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
847
657
|
* @request PUT:/api/v3/milestones/{milestone-public-id}
|
|
848
658
|
* @secure
|
|
849
659
|
*/
|
|
850
|
-
|
|
851
|
-
if (params === void 0) { params = {}; }
|
|
852
|
-
return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "PUT", body: UpdateMilestone, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
853
|
-
};
|
|
660
|
+
this.updateMilestone = (milestonePublicId, UpdateMilestone, params = {}) => this.request(Object.assign({ path: `/api/v3/milestones/${milestonePublicId}`, method: 'PUT', body: UpdateMilestone, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
854
661
|
/**
|
|
855
662
|
* @description Delete Milestone can be used to delete any Milestone.
|
|
856
663
|
*
|
|
@@ -859,10 +666,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
859
666
|
* @request DELETE:/api/v3/milestones/{milestone-public-id}
|
|
860
667
|
* @secure
|
|
861
668
|
*/
|
|
862
|
-
|
|
863
|
-
if (params === void 0) { params = {}; }
|
|
864
|
-
return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId, method: "DELETE", secure: true }, params));
|
|
865
|
-
};
|
|
669
|
+
this.deleteMilestone = (milestonePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/milestones/${milestonePublicId}`, method: 'DELETE', secure: true }, params));
|
|
866
670
|
/**
|
|
867
671
|
* @description List all of the Epics within the Milestone.
|
|
868
672
|
*
|
|
@@ -871,10 +675,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
871
675
|
* @request GET:/api/v3/milestones/{milestone-public-id}/epics
|
|
872
676
|
* @secure
|
|
873
677
|
*/
|
|
874
|
-
|
|
875
|
-
if (params === void 0) { params = {}; }
|
|
876
|
-
return _this.request(__assign({ path: "/api/v3/milestones/" + milestonePublicId + "/epics", method: "GET", secure: true, format: "json" }, params));
|
|
877
|
-
};
|
|
678
|
+
this.listMilestoneEpics = (milestonePublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/milestones/${milestonePublicId}/epics`, method: 'GET', secure: true, format: 'json' }, params));
|
|
878
679
|
/**
|
|
879
680
|
* @description List Projects returns a list of all Projects and their attributes.
|
|
880
681
|
*
|
|
@@ -883,10 +684,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
883
684
|
* @request GET:/api/v3/projects
|
|
884
685
|
* @secure
|
|
885
686
|
*/
|
|
886
|
-
|
|
887
|
-
if (params === void 0) { params = {}; }
|
|
888
|
-
return _this.request(__assign({ path: "/api/v3/projects", method: "GET", secure: true, format: "json" }, params));
|
|
889
|
-
};
|
|
687
|
+
this.listProjects = (params = {}) => this.request(Object.assign({ path: `/api/v3/projects`, method: 'GET', secure: true, format: 'json' }, params));
|
|
890
688
|
/**
|
|
891
689
|
* @description Create Project is used to create a new Shortcut Project.
|
|
892
690
|
*
|
|
@@ -895,10 +693,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
895
693
|
* @request POST:/api/v3/projects
|
|
896
694
|
* @secure
|
|
897
695
|
*/
|
|
898
|
-
|
|
899
|
-
if (params === void 0) { params = {}; }
|
|
900
|
-
return _this.request(__assign({ path: "/api/v3/projects", method: "POST", body: CreateProject, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
901
|
-
};
|
|
696
|
+
this.createProject = (CreateProject, params = {}) => this.request(Object.assign({ path: `/api/v3/projects`, method: 'POST', body: CreateProject, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
902
697
|
/**
|
|
903
698
|
* @description Get Project returns information about the selected Project.
|
|
904
699
|
*
|
|
@@ -907,10 +702,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
907
702
|
* @request GET:/api/v3/projects/{project-public-id}
|
|
908
703
|
* @secure
|
|
909
704
|
*/
|
|
910
|
-
|
|
911
|
-
if (params === void 0) { params = {}; }
|
|
912
|
-
return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
913
|
-
};
|
|
705
|
+
this.getProject = (projectPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/projects/${projectPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
914
706
|
/**
|
|
915
707
|
* @description Update Project can be used to change properties of a Project.
|
|
916
708
|
*
|
|
@@ -919,10 +711,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
919
711
|
* @request PUT:/api/v3/projects/{project-public-id}
|
|
920
712
|
* @secure
|
|
921
713
|
*/
|
|
922
|
-
|
|
923
|
-
if (params === void 0) { params = {}; }
|
|
924
|
-
return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "PUT", body: UpdateProject, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
925
|
-
};
|
|
714
|
+
this.updateProject = (projectPublicId, UpdateProject, params = {}) => this.request(Object.assign({ path: `/api/v3/projects/${projectPublicId}`, method: 'PUT', body: UpdateProject, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
926
715
|
/**
|
|
927
716
|
* @description Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.
|
|
928
717
|
*
|
|
@@ -931,10 +720,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
931
720
|
* @request DELETE:/api/v3/projects/{project-public-id}
|
|
932
721
|
* @secure
|
|
933
722
|
*/
|
|
934
|
-
|
|
935
|
-
if (params === void 0) { params = {}; }
|
|
936
|
-
return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId, method: "DELETE", secure: true }, params));
|
|
937
|
-
};
|
|
723
|
+
this.deleteProject = (projectPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/projects/${projectPublicId}`, method: 'DELETE', secure: true }, params));
|
|
938
724
|
/**
|
|
939
725
|
* @description List Stories returns a list of all Stories in a selected Project and their attributes.
|
|
940
726
|
*
|
|
@@ -943,10 +729,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
943
729
|
* @request GET:/api/v3/projects/{project-public-id}/stories
|
|
944
730
|
* @secure
|
|
945
731
|
*/
|
|
946
|
-
|
|
947
|
-
if (params === void 0) { params = {}; }
|
|
948
|
-
return _this.request(__assign({ path: "/api/v3/projects/" + projectPublicId + "/stories", method: "GET", body: GetProjectStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
949
|
-
};
|
|
732
|
+
this.listStories = (projectPublicId, GetProjectStories, params = {}) => this.request(Object.assign({ path: `/api/v3/projects/${projectPublicId}/stories`, method: 'GET', body: GetProjectStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
950
733
|
/**
|
|
951
734
|
* @description List Repositories returns a list of all Repositories and their attributes.
|
|
952
735
|
*
|
|
@@ -955,10 +738,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
955
738
|
* @request GET:/api/v3/repositories
|
|
956
739
|
* @secure
|
|
957
740
|
*/
|
|
958
|
-
|
|
959
|
-
if (params === void 0) { params = {}; }
|
|
960
|
-
return _this.request(__assign({ path: "/api/v3/repositories", method: "GET", secure: true, format: "json" }, params));
|
|
961
|
-
};
|
|
741
|
+
this.listRepositories = (params = {}) => this.request(Object.assign({ path: `/api/v3/repositories`, method: 'GET', secure: true, format: 'json' }, params));
|
|
962
742
|
/**
|
|
963
743
|
* @description Get Repository returns information about the selected Repository.
|
|
964
744
|
*
|
|
@@ -967,10 +747,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
967
747
|
* @request GET:/api/v3/repositories/{repo-public-id}
|
|
968
748
|
* @secure
|
|
969
749
|
*/
|
|
970
|
-
|
|
971
|
-
if (params === void 0) { params = {}; }
|
|
972
|
-
return _this.request(__assign({ path: "/api/v3/repositories/" + repoPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
973
|
-
};
|
|
750
|
+
this.getRepository = (repoPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/repositories/${repoPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
974
751
|
/**
|
|
975
752
|
* @description Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
|
|
976
753
|
*
|
|
@@ -979,10 +756,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
979
756
|
* @request GET:/api/v3/search
|
|
980
757
|
* @secure
|
|
981
758
|
*/
|
|
982
|
-
|
|
983
|
-
if (params === void 0) { params = {}; }
|
|
984
|
-
return _this.request(__assign({ path: "/api/v3/search", method: "GET", body: Search, secure: true, format: "json" }, params));
|
|
985
|
-
};
|
|
759
|
+
this.search = (Search, params = {}) => this.request(Object.assign({ path: `/api/v3/search`, method: 'GET', body: Search, secure: true, format: 'json' }, params));
|
|
986
760
|
/**
|
|
987
761
|
* @description Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
|
|
988
762
|
*
|
|
@@ -991,10 +765,25 @@ var Api = /** @class */ (function (_super) {
|
|
|
991
765
|
* @request GET:/api/v3/search/epics
|
|
992
766
|
* @secure
|
|
993
767
|
*/
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
768
|
+
this.searchEpics = (Search, params = {}) => this.request(Object.assign({ path: `/api/v3/search/epics`, method: 'GET', body: Search, secure: true, format: 'json' }, params));
|
|
769
|
+
/**
|
|
770
|
+
* @description Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
|
|
771
|
+
*
|
|
772
|
+
* @name SearchIterations
|
|
773
|
+
* @summary Search Iterations
|
|
774
|
+
* @request GET:/api/v3/search/iterations
|
|
775
|
+
* @secure
|
|
776
|
+
*/
|
|
777
|
+
this.searchIterations = (Search, params = {}) => this.request(Object.assign({ path: `/api/v3/search/iterations`, method: 'GET', body: Search, secure: true, format: 'json' }, params));
|
|
778
|
+
/**
|
|
779
|
+
* @description Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
|
|
780
|
+
*
|
|
781
|
+
* @name SearchMilestones
|
|
782
|
+
* @summary Search Milestones
|
|
783
|
+
* @request GET:/api/v3/search/milestones
|
|
784
|
+
* @secure
|
|
785
|
+
*/
|
|
786
|
+
this.searchMilestones = (Search, params = {}) => this.request(Object.assign({ path: `/api/v3/search/milestones`, method: 'GET', body: Search, secure: true, format: 'json' }, params));
|
|
998
787
|
/**
|
|
999
788
|
* @description Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
|
|
1000
789
|
*
|
|
@@ -1003,10 +792,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1003
792
|
* @request GET:/api/v3/search/stories
|
|
1004
793
|
* @secure
|
|
1005
794
|
*/
|
|
1006
|
-
|
|
1007
|
-
if (params === void 0) { params = {}; }
|
|
1008
|
-
return _this.request(__assign({ path: "/api/v3/search/stories", method: "GET", body: Search, secure: true, format: "json" }, params));
|
|
1009
|
-
};
|
|
795
|
+
this.searchStories = (Search, params = {}) => this.request(Object.assign({ path: `/api/v3/search/stories`, method: 'GET', body: Search, secure: true, format: 'json' }, params));
|
|
1010
796
|
/**
|
|
1011
797
|
* @description Create Story is used to add a new story to your Shortcut.
|
|
1012
798
|
*
|
|
@@ -1015,22 +801,16 @@ var Api = /** @class */ (function (_super) {
|
|
|
1015
801
|
* @request POST:/api/v3/stories
|
|
1016
802
|
* @secure
|
|
1017
803
|
*/
|
|
1018
|
-
|
|
1019
|
-
if (params === void 0) { params = {}; }
|
|
1020
|
-
return _this.request(__assign({ path: "/api/v3/stories", method: "POST", body: CreateStoryParams, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1021
|
-
};
|
|
804
|
+
this.createStory = (CreateStoryParams, params = {}) => this.request(Object.assign({ path: `/api/v3/stories`, method: 'POST', body: CreateStoryParams, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1022
805
|
/**
|
|
1023
|
-
* @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://shortcut.com/api
|
|
806
|
+
* @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).
|
|
1024
807
|
*
|
|
1025
808
|
* @name CreateMultipleStories
|
|
1026
809
|
* @summary Create Multiple Stories
|
|
1027
810
|
* @request POST:/api/v3/stories/bulk
|
|
1028
811
|
* @secure
|
|
1029
812
|
*/
|
|
1030
|
-
|
|
1031
|
-
if (params === void 0) { params = {}; }
|
|
1032
|
-
return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "POST", body: CreateStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1033
|
-
};
|
|
813
|
+
this.createMultipleStories = (CreateStories, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/bulk`, method: 'POST', body: CreateStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1034
814
|
/**
|
|
1035
815
|
* @description Update Multiple Stories allows you to make changes to numerous stories at once.
|
|
1036
816
|
*
|
|
@@ -1039,10 +819,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1039
819
|
* @request PUT:/api/v3/stories/bulk
|
|
1040
820
|
* @secure
|
|
1041
821
|
*/
|
|
1042
|
-
|
|
1043
|
-
if (params === void 0) { params = {}; }
|
|
1044
|
-
return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "PUT", body: UpdateStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1045
|
-
};
|
|
822
|
+
this.updateMultipleStories = (UpdateStories, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/bulk`, method: 'PUT', body: UpdateStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1046
823
|
/**
|
|
1047
824
|
* @description Delete Multiple Stories allows you to delete multiple archived stories at once.
|
|
1048
825
|
*
|
|
@@ -1051,10 +828,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1051
828
|
* @request DELETE:/api/v3/stories/bulk
|
|
1052
829
|
* @secure
|
|
1053
830
|
*/
|
|
1054
|
-
|
|
1055
|
-
if (params === void 0) { params = {}; }
|
|
1056
|
-
return _this.request(__assign({ path: "/api/v3/stories/bulk", method: "DELETE", body: DeleteStories, secure: true, type: http_client_1.ContentType.Json }, params));
|
|
1057
|
-
};
|
|
831
|
+
this.deleteMultipleStories = (DeleteStories, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/bulk`, method: 'DELETE', body: DeleteStories, secure: true, type: http_client_1.ContentType.Json }, params));
|
|
1058
832
|
/**
|
|
1059
833
|
* @description Search Stories lets you search Stories based on desired parameters.
|
|
1060
834
|
*
|
|
@@ -1063,10 +837,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1063
837
|
* @request POST:/api/v3/stories/search
|
|
1064
838
|
* @secure
|
|
1065
839
|
*/
|
|
1066
|
-
|
|
1067
|
-
if (params === void 0) { params = {}; }
|
|
1068
|
-
return _this.request(__assign({ path: "/api/v3/stories/search", method: "POST", body: SearchStories, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1069
|
-
};
|
|
840
|
+
this.searchStoriesOld = (SearchStories, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/search`, method: 'POST', body: SearchStories, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1070
841
|
/**
|
|
1071
842
|
* @description Get Story returns information about a chosen Story.
|
|
1072
843
|
*
|
|
@@ -1075,10 +846,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1075
846
|
* @request GET:/api/v3/stories/{story-public-id}
|
|
1076
847
|
* @secure
|
|
1077
848
|
*/
|
|
1078
|
-
|
|
1079
|
-
if (params === void 0) { params = {}; }
|
|
1080
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
1081
|
-
};
|
|
849
|
+
this.getStory = (storyPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1082
850
|
/**
|
|
1083
851
|
* @description Update Story can be used to update Story properties.
|
|
1084
852
|
*
|
|
@@ -1087,10 +855,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1087
855
|
* @request PUT:/api/v3/stories/{story-public-id}
|
|
1088
856
|
* @secure
|
|
1089
857
|
*/
|
|
1090
|
-
|
|
1091
|
-
if (params === void 0) { params = {}; }
|
|
1092
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId, method: "PUT", body: UpdateStory, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1093
|
-
};
|
|
858
|
+
this.updateStory = (storyPublicId, UpdateStory, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}`, method: 'PUT', body: UpdateStory, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1094
859
|
/**
|
|
1095
860
|
* @description Delete Story can be used to delete any Story.
|
|
1096
861
|
*
|
|
@@ -1099,10 +864,16 @@ var Api = /** @class */ (function (_super) {
|
|
|
1099
864
|
* @request DELETE:/api/v3/stories/{story-public-id}
|
|
1100
865
|
* @secure
|
|
1101
866
|
*/
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
867
|
+
this.deleteStory = (storyPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}`, method: 'DELETE', secure: true }, params));
|
|
868
|
+
/**
|
|
869
|
+
* @description Lists Comments associated with a Story
|
|
870
|
+
*
|
|
871
|
+
* @name ListStoryComment
|
|
872
|
+
* @summary List Story Comment
|
|
873
|
+
* @request GET:/api/v3/stories/{story-public-id}/comments
|
|
874
|
+
* @secure
|
|
875
|
+
*/
|
|
876
|
+
this.listStoryComment = (storyPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1106
877
|
/**
|
|
1107
878
|
* @description Create Comment allows you to create a Comment on any Story.
|
|
1108
879
|
*
|
|
@@ -1111,10 +882,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1111
882
|
* @request POST:/api/v3/stories/{story-public-id}/comments
|
|
1112
883
|
* @secure
|
|
1113
884
|
*/
|
|
1114
|
-
|
|
1115
|
-
if (params === void 0) { params = {}; }
|
|
1116
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments", method: "POST", body: CreateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1117
|
-
};
|
|
885
|
+
this.createStoryComment = (storyPublicId, CreateStoryComment, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments`, method: 'POST', body: CreateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1118
886
|
/**
|
|
1119
887
|
* @description Get Comment is used to get Comment information.
|
|
1120
888
|
*
|
|
@@ -1123,10 +891,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1123
891
|
* @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1124
892
|
* @secure
|
|
1125
893
|
*/
|
|
1126
|
-
|
|
1127
|
-
if (params === void 0) { params = {}; }
|
|
1128
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
1129
|
-
};
|
|
894
|
+
this.getStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1130
895
|
/**
|
|
1131
896
|
* @description Update Comment replaces the text of the existing Comment.
|
|
1132
897
|
*
|
|
@@ -1135,10 +900,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1135
900
|
* @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1136
901
|
* @secure
|
|
1137
902
|
*/
|
|
1138
|
-
|
|
1139
|
-
if (params === void 0) { params = {}; }
|
|
1140
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "PUT", body: UpdateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1141
|
-
};
|
|
903
|
+
this.updateStoryComment = (storyPublicId, commentPublicId, UpdateStoryComment, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`, method: 'PUT', body: UpdateStoryComment, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1142
904
|
/**
|
|
1143
905
|
* @description Delete a Comment from any story.
|
|
1144
906
|
*
|
|
@@ -1147,10 +909,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1147
909
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
|
|
1148
910
|
* @secure
|
|
1149
911
|
*/
|
|
1150
|
-
|
|
1151
|
-
if (params === void 0) { params = {}; }
|
|
1152
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId, method: "DELETE", secure: true }, params));
|
|
1153
|
-
};
|
|
912
|
+
this.deleteStoryComment = (storyPublicId, commentPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}`, method: 'DELETE', secure: true }, params));
|
|
1154
913
|
/**
|
|
1155
914
|
* @description Create a reaction to a story comment.
|
|
1156
915
|
*
|
|
@@ -1159,10 +918,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1159
918
|
* @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1160
919
|
* @secure
|
|
1161
920
|
*/
|
|
1162
|
-
|
|
1163
|
-
if (params === void 0) { params = {}; }
|
|
1164
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId + "/reactions", method: "POST", body: CreateOrDeleteStoryReaction, secure: true, format: "json" }, params));
|
|
1165
|
-
};
|
|
921
|
+
this.createStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`, method: 'POST', body: CreateOrDeleteStoryReaction, secure: true, format: 'json' }, params));
|
|
1166
922
|
/**
|
|
1167
923
|
* @description Delete a reaction from any story comment.
|
|
1168
924
|
*
|
|
@@ -1171,10 +927,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1171
927
|
* @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
|
|
1172
928
|
* @secure
|
|
1173
929
|
*/
|
|
1174
|
-
|
|
1175
|
-
if (params === void 0) { params = {}; }
|
|
1176
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/comments/" + commentPublicId + "/reactions", method: "DELETE", body: CreateOrDeleteStoryReaction, secure: true }, params));
|
|
1177
|
-
};
|
|
930
|
+
this.deleteStoryReaction = (storyPublicId, commentPublicId, CreateOrDeleteStoryReaction, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/comments/${commentPublicId}/reactions`, method: 'DELETE', body: CreateOrDeleteStoryReaction, secure: true }, params));
|
|
1178
931
|
/**
|
|
1179
932
|
* No description
|
|
1180
933
|
*
|
|
@@ -1183,10 +936,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1183
936
|
* @request GET:/api/v3/stories/{story-public-id}/history
|
|
1184
937
|
* @secure
|
|
1185
938
|
*/
|
|
1186
|
-
|
|
1187
|
-
if (params === void 0) { params = {}; }
|
|
1188
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/history", method: "GET", secure: true, format: "json" }, params));
|
|
1189
|
-
};
|
|
939
|
+
this.storyHistory = (storyPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/history`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1190
940
|
/**
|
|
1191
941
|
* @description Create Task is used to create a new task in a Story.
|
|
1192
942
|
*
|
|
@@ -1195,10 +945,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1195
945
|
* @request POST:/api/v3/stories/{story-public-id}/tasks
|
|
1196
946
|
* @secure
|
|
1197
947
|
*/
|
|
1198
|
-
|
|
1199
|
-
if (params === void 0) { params = {}; }
|
|
1200
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks", method: "POST", body: CreateTask, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1201
|
-
};
|
|
948
|
+
this.createTask = (storyPublicId, CreateTask, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/tasks`, method: 'POST', body: CreateTask, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1202
949
|
/**
|
|
1203
950
|
* @description Returns information about a chosen Task.
|
|
1204
951
|
*
|
|
@@ -1207,10 +954,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1207
954
|
* @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1208
955
|
* @secure
|
|
1209
956
|
*/
|
|
1210
|
-
|
|
1211
|
-
if (params === void 0) { params = {}; }
|
|
1212
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
1213
|
-
};
|
|
957
|
+
this.getTask = (storyPublicId, taskPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1214
958
|
/**
|
|
1215
959
|
* @description Update Task can be used to update Task properties.
|
|
1216
960
|
*
|
|
@@ -1219,10 +963,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1219
963
|
* @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1220
964
|
* @secure
|
|
1221
965
|
*/
|
|
1222
|
-
|
|
1223
|
-
if (params === void 0) { params = {}; }
|
|
1224
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "PUT", body: UpdateTask, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1225
|
-
};
|
|
966
|
+
this.updateTask = (storyPublicId, taskPublicId, UpdateTask, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`, method: 'PUT', body: UpdateTask, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1226
967
|
/**
|
|
1227
968
|
* @description Delete Task can be used to delete any previously created Task on a Story.
|
|
1228
969
|
*
|
|
@@ -1231,10 +972,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1231
972
|
* @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
|
|
1232
973
|
* @secure
|
|
1233
974
|
*/
|
|
1234
|
-
|
|
1235
|
-
if (params === void 0) { params = {}; }
|
|
1236
|
-
return _this.request(__assign({ path: "/api/v3/stories/" + storyPublicId + "/tasks/" + taskPublicId, method: "DELETE", secure: true }, params));
|
|
1237
|
-
};
|
|
975
|
+
this.deleteTask = (storyPublicId, taskPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/stories/${storyPublicId}/tasks/${taskPublicId}`, method: 'DELETE', secure: true }, params));
|
|
1238
976
|
/**
|
|
1239
977
|
* @description Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence: subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story. Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”
|
|
1240
978
|
*
|
|
@@ -1243,10 +981,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1243
981
|
* @request POST:/api/v3/story-links
|
|
1244
982
|
* @secure
|
|
1245
983
|
*/
|
|
1246
|
-
|
|
1247
|
-
if (params === void 0) { params = {}; }
|
|
1248
|
-
return _this.request(__assign({ path: "/api/v3/story-links", method: "POST", body: CreateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1249
|
-
};
|
|
984
|
+
this.createStoryLink = (CreateStoryLink, params = {}) => this.request(Object.assign({ path: `/api/v3/story-links`, method: 'POST', body: CreateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1250
985
|
/**
|
|
1251
986
|
* @description Returns the stories and their relationship for the given Story Link.
|
|
1252
987
|
*
|
|
@@ -1255,10 +990,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1255
990
|
* @request GET:/api/v3/story-links/{story-link-public-id}
|
|
1256
991
|
* @secure
|
|
1257
992
|
*/
|
|
1258
|
-
|
|
1259
|
-
if (params === void 0) { params = {}; }
|
|
1260
|
-
return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
1261
|
-
};
|
|
993
|
+
this.getStoryLink = (storyLinkPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/story-links/${storyLinkPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1262
994
|
/**
|
|
1263
995
|
* @description Updates the stories and/or the relationship for the given Story Link.
|
|
1264
996
|
*
|
|
@@ -1267,10 +999,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1267
999
|
* @request PUT:/api/v3/story-links/{story-link-public-id}
|
|
1268
1000
|
* @secure
|
|
1269
1001
|
*/
|
|
1270
|
-
|
|
1271
|
-
if (params === void 0) { params = {}; }
|
|
1272
|
-
return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "PUT", body: UpdateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: "json" }, params));
|
|
1273
|
-
};
|
|
1002
|
+
this.updateStoryLink = (storyLinkPublicId, UpdateStoryLink, params = {}) => this.request(Object.assign({ path: `/api/v3/story-links/${storyLinkPublicId}`, method: 'PUT', body: UpdateStoryLink, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
|
|
1274
1003
|
/**
|
|
1275
1004
|
* @description Removes the relationship between the stories for the given Story Link.
|
|
1276
1005
|
*
|
|
@@ -1279,22 +1008,16 @@ var Api = /** @class */ (function (_super) {
|
|
|
1279
1008
|
* @request DELETE:/api/v3/story-links/{story-link-public-id}
|
|
1280
1009
|
* @secure
|
|
1281
1010
|
*/
|
|
1282
|
-
|
|
1283
|
-
if (params === void 0) { params = {}; }
|
|
1284
|
-
return _this.request(__assign({ path: "/api/v3/story-links/" + storyLinkPublicId, method: "DELETE", secure: true }, params));
|
|
1285
|
-
};
|
|
1011
|
+
this.deleteStoryLink = (storyLinkPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/story-links/${storyLinkPublicId}`, method: 'DELETE', secure: true }, params));
|
|
1286
1012
|
/**
|
|
1287
|
-
* @description
|
|
1013
|
+
* @description Returns a list of all Workflows in the Workspace.
|
|
1288
1014
|
*
|
|
1289
1015
|
* @name ListWorkflows
|
|
1290
1016
|
* @summary List Workflows
|
|
1291
1017
|
* @request GET:/api/v3/workflows
|
|
1292
1018
|
* @secure
|
|
1293
1019
|
*/
|
|
1294
|
-
|
|
1295
|
-
if (params === void 0) { params = {}; }
|
|
1296
|
-
return _this.request(__assign({ path: "/api/v3/workflows", method: "GET", secure: true, format: "json" }, params));
|
|
1297
|
-
};
|
|
1020
|
+
this.listWorkflows = (params = {}) => this.request(Object.assign({ path: `/api/v3/workflows`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1298
1021
|
/**
|
|
1299
1022
|
* @description Get Workflow returns information about a chosen Workflow.
|
|
1300
1023
|
*
|
|
@@ -1303,12 +1026,7 @@ var Api = /** @class */ (function (_super) {
|
|
|
1303
1026
|
* @request GET:/api/v3/workflows/{workflow-public-id}
|
|
1304
1027
|
* @secure
|
|
1305
1028
|
*/
|
|
1306
|
-
|
|
1307
|
-
if (params === void 0) { params = {}; }
|
|
1308
|
-
return _this.request(__assign({ path: "/api/v3/workflows/" + workflowPublicId, method: "GET", secure: true, format: "json" }, params));
|
|
1309
|
-
};
|
|
1310
|
-
return _this;
|
|
1029
|
+
this.getWorkflow = (workflowPublicId, params = {}) => this.request(Object.assign({ path: `/api/v3/workflows/${workflowPublicId}`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1311
1030
|
}
|
|
1312
|
-
|
|
1313
|
-
}(http_client_1.HttpClient));
|
|
1031
|
+
}
|
|
1314
1032
|
exports.Api = Api;
|