@emilgroup/task-sdk-node 1.0.1-beta.1 → 1.0.1-beta.11
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/.openapi-generator/FILES +9 -11
- package/README.md +2 -2
- package/api/assignees-api.ts +166 -0
- package/api/categories-api.ts +74 -60
- package/api/statuses-api.ts +70 -56
- package/api/tasks-api.ts +105 -63
- package/api.ts +2 -2
- package/dist/api/assignees-api.d.ts +96 -0
- package/dist/api/{priorities-api.js → assignees-api.js} +41 -141
- package/dist/api/categories-api.d.ts +58 -49
- package/dist/api/categories-api.js +53 -47
- package/dist/api/statuses-api.d.ts +54 -45
- package/dist/api/statuses-api.js +49 -43
- package/dist/api/tasks-api.d.ts +77 -50
- package/dist/api/tasks-api.js +66 -48
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/models/{create-priority-request-dto.d.ts → assignee-class.d.ts} +5 -5
- package/dist/models/category-class.d.ts +6 -0
- package/dist/models/create-category-request-dto.d.ts +7 -1
- package/dist/models/create-status-request-dto.d.ts +7 -1
- package/dist/models/create-task-request-dto.d.ts +31 -13
- package/dist/models/create-task-request-dto.js +6 -0
- package/dist/models/index.d.ts +8 -10
- package/dist/models/index.js +8 -10
- package/dist/models/list-assignees-response-class.d.ts +43 -0
- package/dist/models/patch-category-request-dto.d.ts +36 -0
- package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
- package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +13 -7
- package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
- package/dist/models/patch-task-request-dto.d.ts +108 -0
- package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
- package/dist/models/status-class.d.ts +6 -0
- package/dist/models/task-class.d.ts +25 -8
- package/dist/models/task-class.js +6 -0
- package/models/{create-priority-request-dto.ts → assignee-class.ts} +5 -5
- package/models/category-class.ts +6 -0
- package/models/create-category-request-dto.ts +7 -1
- package/models/create-status-request-dto.ts +7 -1
- package/models/create-task-request-dto.ts +34 -13
- package/models/index.ts +8 -10
- package/models/list-assignees-response-class.ts +49 -0
- package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +13 -7
- package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
- package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +13 -7
- package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
- package/models/patch-task-request-dto.ts +114 -0
- package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
- package/models/status-class.ts +6 -0
- package/models/task-class.ts +28 -8
- package/package.json +1 -1
- package/api/priorities-api.ts +0 -288
- package/dist/api/priorities-api.d.ts +0 -162
- package/dist/models/create-priority-response-class.d.ts +0 -25
- package/dist/models/get-priority-response-class.d.ts +0 -25
- package/dist/models/priority-class.d.ts +0 -60
- package/dist/models/update-category-request-dto.d.ts +0 -30
- package/dist/models/update-task-request-dto.d.ts +0 -60
- package/dist/models/update-task-request-dto.js +0 -15
- package/dist/models/update-task-response-class.js +0 -15
- package/models/create-priority-response-class.ts +0 -31
- package/models/get-priority-response-class.ts +0 -31
- package/models/priority-class.ts +0 -66
- package/models/update-task-request-dto.ts +0 -66
- /package/dist/models/{create-priority-request-dto.js → assignee-class.js} +0 -0
- /package/dist/models/{create-priority-response-class.js → list-assignees-response-class.js} +0 -0
- /package/dist/models/{get-priority-response-class.js → patch-category-request-dto.js} +0 -0
- /package/dist/models/{priority-class.js → patch-category-response-class.js} +0 -0
- /package/dist/models/{update-category-request-dto.js → patch-status-request-dto.js} +0 -0
- /package/dist/models/{update-category-response-class.js → patch-status-response-class.js} +0 -0
- /package/dist/models/{update-status-request-dto.js → patch-task-request-dto.js} +0 -0
- /package/dist/models/{update-status-response-class.js → patch-task-response-class.js} +0 -0
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.
|
|
81
|
+
exports.AssigneesApi = exports.AssigneesApiFactory = exports.AssigneesApiFp = exports.AssigneesApiAxiosParamCreator = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -90,83 +90,28 @@ var base_1 = require("../base");
|
|
|
90
90
|
var url_1 = require("url");
|
|
91
91
|
var FormData = require('form-data');
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* AssigneesApi - axios parameter creator
|
|
94
94
|
* @export
|
|
95
95
|
*/
|
|
96
|
-
var
|
|
96
|
+
var AssigneesApiAxiosParamCreator = function (configuration) {
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
101
|
-
* @summary
|
|
102
|
-
* @param {CreatePriorityRequestDto} createPriorityRequestDto
|
|
100
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
101
|
+
* @summary List assignees
|
|
103
102
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
listAssignees: function (authorization, expand, options) {
|
|
108
108
|
if (options === void 0) { options = {}; }
|
|
109
109
|
return __awaiter(_this, void 0, void 0, function () {
|
|
110
110
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
111
111
|
return __generator(this, function (_a) {
|
|
112
112
|
switch (_a.label) {
|
|
113
113
|
case 0:
|
|
114
|
-
|
|
115
|
-
(0, common_1.assertParamExists)('createPriority', 'createPriorityRequestDto', createPriorityRequestDto);
|
|
116
|
-
localVarPath = "/taskservice/v1/priorities";
|
|
117
|
-
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
|
-
if (configuration) {
|
|
119
|
-
baseOptions = configuration.baseOptions;
|
|
120
|
-
baseAccessToken = configuration.accessToken;
|
|
121
|
-
}
|
|
122
|
-
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
123
|
-
localVarHeaderParameter = {};
|
|
124
|
-
localVarQueryParameter = {};
|
|
125
|
-
// authentication bearer required
|
|
126
|
-
// http bearer authentication required
|
|
127
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
128
|
-
case 1:
|
|
129
|
-
// authentication bearer required
|
|
130
|
-
// http bearer authentication required
|
|
131
|
-
_a.sent();
|
|
132
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
133
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
134
|
-
}
|
|
135
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
136
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPriorityRequestDto, localVarRequestOptions, configuration);
|
|
140
|
-
return [2 /*return*/, {
|
|
141
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
142
|
-
options: localVarRequestOptions,
|
|
143
|
-
}];
|
|
144
|
-
}
|
|
145
|
-
});
|
|
146
|
-
});
|
|
147
|
-
},
|
|
148
|
-
/**
|
|
149
|
-
* This will get priority.
|
|
150
|
-
* @summary Retrieve the priority
|
|
151
|
-
* @param {string} code
|
|
152
|
-
* @param {string} expand
|
|
153
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
-
* @param {*} [options] Override http request option.
|
|
155
|
-
* @throws {RequiredError}
|
|
156
|
-
*/
|
|
157
|
-
getPriority: function (code, expand, authorization, options) {
|
|
158
|
-
if (options === void 0) { options = {}; }
|
|
159
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
160
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
161
|
-
return __generator(this, function (_a) {
|
|
162
|
-
switch (_a.label) {
|
|
163
|
-
case 0:
|
|
164
|
-
// verify required parameter 'code' is not null or undefined
|
|
165
|
-
(0, common_1.assertParamExists)('getPriority', 'code', code);
|
|
166
|
-
// verify required parameter 'expand' is not null or undefined
|
|
167
|
-
(0, common_1.assertParamExists)('getPriority', 'expand', expand);
|
|
168
|
-
localVarPath = "/taskservice/v1/priorities/{code}"
|
|
169
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
114
|
+
localVarPath = "/taskservice/v1/assignees";
|
|
170
115
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
171
116
|
if (configuration) {
|
|
172
117
|
baseOptions = configuration.baseOptions;
|
|
@@ -201,50 +146,28 @@ var PrioritiesApiAxiosParamCreator = function (configuration) {
|
|
|
201
146
|
},
|
|
202
147
|
};
|
|
203
148
|
};
|
|
204
|
-
exports.
|
|
149
|
+
exports.AssigneesApiAxiosParamCreator = AssigneesApiAxiosParamCreator;
|
|
205
150
|
/**
|
|
206
|
-
*
|
|
151
|
+
* AssigneesApi - functional programming interface
|
|
207
152
|
* @export
|
|
208
153
|
*/
|
|
209
|
-
var
|
|
210
|
-
var localVarAxiosParamCreator = (0, exports.
|
|
154
|
+
var AssigneesApiFp = function (configuration) {
|
|
155
|
+
var localVarAxiosParamCreator = (0, exports.AssigneesApiAxiosParamCreator)(configuration);
|
|
211
156
|
return {
|
|
212
157
|
/**
|
|
213
|
-
*
|
|
214
|
-
* @summary
|
|
215
|
-
* @param {CreatePriorityRequestDto} createPriorityRequestDto
|
|
158
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
159
|
+
* @summary List assignees
|
|
216
160
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
217
162
|
* @param {*} [options] Override http request option.
|
|
218
163
|
* @throws {RequiredError}
|
|
219
164
|
*/
|
|
220
|
-
|
|
165
|
+
listAssignees: function (authorization, expand, options) {
|
|
221
166
|
return __awaiter(this, void 0, void 0, function () {
|
|
222
167
|
var localVarAxiosArgs;
|
|
223
168
|
return __generator(this, function (_a) {
|
|
224
169
|
switch (_a.label) {
|
|
225
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
226
|
-
case 1:
|
|
227
|
-
localVarAxiosArgs = _a.sent();
|
|
228
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
229
|
-
}
|
|
230
|
-
});
|
|
231
|
-
});
|
|
232
|
-
},
|
|
233
|
-
/**
|
|
234
|
-
* This will get priority.
|
|
235
|
-
* @summary Retrieve the priority
|
|
236
|
-
* @param {string} code
|
|
237
|
-
* @param {string} expand
|
|
238
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
239
|
-
* @param {*} [options] Override http request option.
|
|
240
|
-
* @throws {RequiredError}
|
|
241
|
-
*/
|
|
242
|
-
getPriority: function (code, expand, authorization, options) {
|
|
243
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
244
|
-
var localVarAxiosArgs;
|
|
245
|
-
return __generator(this, function (_a) {
|
|
246
|
-
switch (_a.label) {
|
|
247
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPriority(code, expand, authorization, options)];
|
|
170
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listAssignees(authorization, expand, options)];
|
|
248
171
|
case 1:
|
|
249
172
|
localVarAxiosArgs = _a.sent();
|
|
250
173
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -254,75 +177,52 @@ var PrioritiesApiFp = function (configuration) {
|
|
|
254
177
|
},
|
|
255
178
|
};
|
|
256
179
|
};
|
|
257
|
-
exports.
|
|
180
|
+
exports.AssigneesApiFp = AssigneesApiFp;
|
|
258
181
|
/**
|
|
259
|
-
*
|
|
182
|
+
* AssigneesApi - factory interface
|
|
260
183
|
* @export
|
|
261
184
|
*/
|
|
262
|
-
var
|
|
263
|
-
var localVarFp = (0, exports.
|
|
185
|
+
var AssigneesApiFactory = function (configuration, basePath, axios) {
|
|
186
|
+
var localVarFp = (0, exports.AssigneesApiFp)(configuration);
|
|
264
187
|
return {
|
|
265
188
|
/**
|
|
266
|
-
*
|
|
267
|
-
* @summary
|
|
268
|
-
* @param {CreatePriorityRequestDto} createPriorityRequestDto
|
|
269
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
-
* @param {*} [options] Override http request option.
|
|
271
|
-
* @throws {RequiredError}
|
|
272
|
-
*/
|
|
273
|
-
createPriority: function (createPriorityRequestDto, authorization, options) {
|
|
274
|
-
return localVarFp.createPriority(createPriorityRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
275
|
-
},
|
|
276
|
-
/**
|
|
277
|
-
* This will get priority.
|
|
278
|
-
* @summary Retrieve the priority
|
|
279
|
-
* @param {string} code
|
|
280
|
-
* @param {string} expand
|
|
189
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
190
|
+
* @summary List assignees
|
|
281
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
282
193
|
* @param {*} [options] Override http request option.
|
|
283
194
|
* @throws {RequiredError}
|
|
284
195
|
*/
|
|
285
|
-
|
|
286
|
-
return localVarFp.
|
|
196
|
+
listAssignees: function (authorization, expand, options) {
|
|
197
|
+
return localVarFp.listAssignees(authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
287
198
|
},
|
|
288
199
|
};
|
|
289
200
|
};
|
|
290
|
-
exports.
|
|
201
|
+
exports.AssigneesApiFactory = AssigneesApiFactory;
|
|
291
202
|
/**
|
|
292
|
-
*
|
|
203
|
+
* AssigneesApi - object-oriented interface
|
|
293
204
|
* @export
|
|
294
|
-
* @class
|
|
205
|
+
* @class AssigneesApi
|
|
295
206
|
* @extends {BaseAPI}
|
|
296
207
|
*/
|
|
297
|
-
var
|
|
298
|
-
__extends(
|
|
299
|
-
function
|
|
208
|
+
var AssigneesApi = /** @class */ (function (_super) {
|
|
209
|
+
__extends(AssigneesApi, _super);
|
|
210
|
+
function AssigneesApi() {
|
|
300
211
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
301
212
|
}
|
|
302
213
|
/**
|
|
303
|
-
*
|
|
304
|
-
* @summary
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {*} [options] Override http request option.
|
|
307
|
-
* @throws {RequiredError}
|
|
308
|
-
* @memberof PrioritiesApi
|
|
309
|
-
*/
|
|
310
|
-
PrioritiesApi.prototype.createPriority = function (requestParameters, options) {
|
|
311
|
-
var _this = this;
|
|
312
|
-
return (0, exports.PrioritiesApiFp)(this.configuration).createPriority(requestParameters.createPriorityRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
313
|
-
};
|
|
314
|
-
/**
|
|
315
|
-
* This will get priority.
|
|
316
|
-
* @summary Retrieve the priority
|
|
317
|
-
* @param {PrioritiesApiGetPriorityRequest} requestParameters Request parameters.
|
|
214
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
215
|
+
* @summary List assignees
|
|
216
|
+
* @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
|
|
318
217
|
* @param {*} [options] Override http request option.
|
|
319
218
|
* @throws {RequiredError}
|
|
320
|
-
* @memberof
|
|
219
|
+
* @memberof AssigneesApi
|
|
321
220
|
*/
|
|
322
|
-
|
|
221
|
+
AssigneesApi.prototype.listAssignees = function (requestParameters, options) {
|
|
323
222
|
var _this = this;
|
|
324
|
-
|
|
223
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
224
|
+
return (0, exports.AssigneesApiFp)(this.configuration).listAssignees(requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
325
225
|
};
|
|
326
|
-
return
|
|
226
|
+
return AssigneesApi;
|
|
327
227
|
}(base_1.BaseAPI));
|
|
328
|
-
exports.
|
|
228
|
+
exports.AssigneesApi = AssigneesApi;
|
|
@@ -16,15 +16,15 @@ import { CreateCategoryRequestDto } from '../models';
|
|
|
16
16
|
import { CreateCategoryResponseClass } from '../models';
|
|
17
17
|
import { GetCategoryResponseClass } from '../models';
|
|
18
18
|
import { ListCategoriesResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { PatchCategoryRequestDto } from '../models';
|
|
20
|
+
import { PatchCategoryResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* CategoriesApi - axios parameter creator
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
export declare const CategoriesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create category.
|
|
27
|
+
* This will create a category.
|
|
28
28
|
* @summary Create the category
|
|
29
29
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -33,7 +33,7 @@ export declare const CategoriesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
33
33
|
*/
|
|
34
34
|
createCategory: (createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* This will delete category.
|
|
36
|
+
* This will delete a task category by code.
|
|
37
37
|
* @summary Delete the category
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -42,7 +42,7 @@ export declare const CategoriesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
42
42
|
*/
|
|
43
43
|
deleteCategory: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Get category by code.
|
|
46
46
|
* @summary Retrieve the category
|
|
47
47
|
* @param {string} code
|
|
48
48
|
* @param {string} expand
|
|
@@ -55,24 +55,25 @@ export declare const CategoriesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
55
55
|
* Retrieves a list of categories.
|
|
56
56
|
* @summary List categories
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
59
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
60
|
-
* @param {string} [
|
|
58
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
59
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
60
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, name, slug</i>
|
|
61
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug</i>
|
|
61
62
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
62
63
|
* @param {*} [options] Override http request option.
|
|
63
64
|
* @throws {RequiredError}
|
|
64
65
|
*/
|
|
65
|
-
listCategories: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
listCategories: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
67
|
/**
|
|
67
|
-
* This will update category.
|
|
68
|
+
* This will partially update a category by code with the provided fields.
|
|
68
69
|
* @summary Update the category
|
|
69
70
|
* @param {string} code
|
|
70
|
-
* @param {
|
|
71
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
71
72
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
72
73
|
* @param {*} [options] Override http request option.
|
|
73
74
|
* @throws {RequiredError}
|
|
74
75
|
*/
|
|
75
|
-
|
|
76
|
+
patchCategory: (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
77
|
};
|
|
77
78
|
/**
|
|
78
79
|
* CategoriesApi - functional programming interface
|
|
@@ -80,7 +81,7 @@ export declare const CategoriesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
80
81
|
*/
|
|
81
82
|
export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
82
83
|
/**
|
|
83
|
-
* This will create category.
|
|
84
|
+
* This will create a category.
|
|
84
85
|
* @summary Create the category
|
|
85
86
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
86
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -89,7 +90,7 @@ export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
|
89
90
|
*/
|
|
90
91
|
createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCategoryResponseClass>>;
|
|
91
92
|
/**
|
|
92
|
-
* This will delete category.
|
|
93
|
+
* This will delete a task category by code.
|
|
93
94
|
* @summary Delete the category
|
|
94
95
|
* @param {string} code Unique identifier for the object.
|
|
95
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -98,7 +99,7 @@ export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
|
98
99
|
*/
|
|
99
100
|
deleteCategory(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
100
101
|
/**
|
|
101
|
-
*
|
|
102
|
+
* Get category by code.
|
|
102
103
|
* @summary Retrieve the category
|
|
103
104
|
* @param {string} code
|
|
104
105
|
* @param {string} expand
|
|
@@ -111,24 +112,25 @@ export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
|
111
112
|
* Retrieves a list of categories.
|
|
112
113
|
* @summary List categories
|
|
113
114
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
114
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
115
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
116
|
-
* @param {string} [
|
|
115
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
116
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
117
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, name, slug</i>
|
|
118
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug</i>
|
|
117
119
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
118
120
|
* @param {*} [options] Override http request option.
|
|
119
121
|
* @throws {RequiredError}
|
|
120
122
|
*/
|
|
121
|
-
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>>;
|
|
123
|
+
listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>>;
|
|
122
124
|
/**
|
|
123
|
-
* This will update category.
|
|
125
|
+
* This will partially update a category by code with the provided fields.
|
|
124
126
|
* @summary Update the category
|
|
125
127
|
* @param {string} code
|
|
126
|
-
* @param {
|
|
128
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
127
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
128
130
|
* @param {*} [options] Override http request option.
|
|
129
131
|
* @throws {RequiredError}
|
|
130
132
|
*/
|
|
131
|
-
|
|
133
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>>;
|
|
132
134
|
};
|
|
133
135
|
/**
|
|
134
136
|
* CategoriesApi - factory interface
|
|
@@ -136,7 +138,7 @@ export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
|
136
138
|
*/
|
|
137
139
|
export declare const CategoriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
138
140
|
/**
|
|
139
|
-
* This will create category.
|
|
141
|
+
* This will create a category.
|
|
140
142
|
* @summary Create the category
|
|
141
143
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
142
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -145,7 +147,7 @@ export declare const CategoriesApiFactory: (configuration?: Configuration, baseP
|
|
|
145
147
|
*/
|
|
146
148
|
createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCategoryResponseClass>;
|
|
147
149
|
/**
|
|
148
|
-
* This will delete category.
|
|
150
|
+
* This will delete a task category by code.
|
|
149
151
|
* @summary Delete the category
|
|
150
152
|
* @param {string} code Unique identifier for the object.
|
|
151
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -154,7 +156,7 @@ export declare const CategoriesApiFactory: (configuration?: Configuration, baseP
|
|
|
154
156
|
*/
|
|
155
157
|
deleteCategory(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
156
158
|
/**
|
|
157
|
-
*
|
|
159
|
+
* Get category by code.
|
|
158
160
|
* @summary Retrieve the category
|
|
159
161
|
* @param {string} code
|
|
160
162
|
* @param {string} expand
|
|
@@ -167,24 +169,25 @@ export declare const CategoriesApiFactory: (configuration?: Configuration, baseP
|
|
|
167
169
|
* Retrieves a list of categories.
|
|
168
170
|
* @summary List categories
|
|
169
171
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
171
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
172
|
-
* @param {string} [
|
|
172
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
173
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
174
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, name, slug</i>
|
|
175
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug</i>
|
|
173
176
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
174
177
|
* @param {*} [options] Override http request option.
|
|
175
178
|
* @throws {RequiredError}
|
|
176
179
|
*/
|
|
177
|
-
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass>;
|
|
180
|
+
listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass>;
|
|
178
181
|
/**
|
|
179
|
-
* This will update category.
|
|
182
|
+
* This will partially update a category by code with the provided fields.
|
|
180
183
|
* @summary Update the category
|
|
181
184
|
* @param {string} code
|
|
182
|
-
* @param {
|
|
185
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
183
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
184
187
|
* @param {*} [options] Override http request option.
|
|
185
188
|
* @throws {RequiredError}
|
|
186
189
|
*/
|
|
187
|
-
|
|
190
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass>;
|
|
188
191
|
};
|
|
189
192
|
/**
|
|
190
193
|
* Request parameters for createCategory operation in CategoriesApi.
|
|
@@ -262,19 +265,25 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
262
265
|
*/
|
|
263
266
|
readonly authorization?: string;
|
|
264
267
|
/**
|
|
265
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
268
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
266
269
|
* @type {string}
|
|
267
270
|
* @memberof CategoriesApiListCategories
|
|
268
271
|
*/
|
|
269
272
|
readonly filter?: string;
|
|
270
273
|
/**
|
|
271
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
274
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, createdAt, updatedAt</i>
|
|
272
275
|
* @type {string}
|
|
273
276
|
* @memberof CategoriesApiListCategories
|
|
274
277
|
*/
|
|
275
278
|
readonly filters?: string;
|
|
276
279
|
/**
|
|
277
|
-
*
|
|
280
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, name, slug</i>
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof CategoriesApiListCategories
|
|
283
|
+
*/
|
|
284
|
+
readonly search?: string;
|
|
285
|
+
/**
|
|
286
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug</i>
|
|
278
287
|
* @type {string}
|
|
279
288
|
* @memberof CategoriesApiListCategories
|
|
280
289
|
*/
|
|
@@ -287,27 +296,27 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
287
296
|
readonly expand?: string;
|
|
288
297
|
}
|
|
289
298
|
/**
|
|
290
|
-
* Request parameters for
|
|
299
|
+
* Request parameters for patchCategory operation in CategoriesApi.
|
|
291
300
|
* @export
|
|
292
|
-
* @interface
|
|
301
|
+
* @interface CategoriesApiPatchCategoryRequest
|
|
293
302
|
*/
|
|
294
|
-
export interface
|
|
303
|
+
export interface CategoriesApiPatchCategoryRequest {
|
|
295
304
|
/**
|
|
296
305
|
*
|
|
297
306
|
* @type {string}
|
|
298
|
-
* @memberof
|
|
307
|
+
* @memberof CategoriesApiPatchCategory
|
|
299
308
|
*/
|
|
300
309
|
readonly code: string;
|
|
301
310
|
/**
|
|
302
311
|
*
|
|
303
|
-
* @type {
|
|
304
|
-
* @memberof
|
|
312
|
+
* @type {PatchCategoryRequestDto}
|
|
313
|
+
* @memberof CategoriesApiPatchCategory
|
|
305
314
|
*/
|
|
306
|
-
readonly
|
|
315
|
+
readonly patchCategoryRequestDto: PatchCategoryRequestDto;
|
|
307
316
|
/**
|
|
308
317
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
309
318
|
* @type {string}
|
|
310
|
-
* @memberof
|
|
319
|
+
* @memberof CategoriesApiPatchCategory
|
|
311
320
|
*/
|
|
312
321
|
readonly authorization?: string;
|
|
313
322
|
}
|
|
@@ -319,7 +328,7 @@ export interface CategoriesApiUpdateCategoryRequest {
|
|
|
319
328
|
*/
|
|
320
329
|
export declare class CategoriesApi extends BaseAPI {
|
|
321
330
|
/**
|
|
322
|
-
* This will create category.
|
|
331
|
+
* This will create a category.
|
|
323
332
|
* @summary Create the category
|
|
324
333
|
* @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
|
|
325
334
|
* @param {*} [options] Override http request option.
|
|
@@ -328,7 +337,7 @@ export declare class CategoriesApi extends BaseAPI {
|
|
|
328
337
|
*/
|
|
329
338
|
createCategory(requestParameters: CategoriesApiCreateCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCategoryResponseClass, any, {}>>;
|
|
330
339
|
/**
|
|
331
|
-
* This will delete category.
|
|
340
|
+
* This will delete a task category by code.
|
|
332
341
|
* @summary Delete the category
|
|
333
342
|
* @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
|
|
334
343
|
* @param {*} [options] Override http request option.
|
|
@@ -337,7 +346,7 @@ export declare class CategoriesApi extends BaseAPI {
|
|
|
337
346
|
*/
|
|
338
347
|
deleteCategory(requestParameters: CategoriesApiDeleteCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
339
348
|
/**
|
|
340
|
-
*
|
|
349
|
+
* Get category by code.
|
|
341
350
|
* @summary Retrieve the category
|
|
342
351
|
* @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
|
|
343
352
|
* @param {*} [options] Override http request option.
|
|
@@ -355,12 +364,12 @@ export declare class CategoriesApi extends BaseAPI {
|
|
|
355
364
|
*/
|
|
356
365
|
listCategories(requestParameters?: CategoriesApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}>>;
|
|
357
366
|
/**
|
|
358
|
-
* This will update category.
|
|
367
|
+
* This will partially update a category by code with the provided fields.
|
|
359
368
|
* @summary Update the category
|
|
360
|
-
* @param {
|
|
369
|
+
* @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
|
|
361
370
|
* @param {*} [options] Override http request option.
|
|
362
371
|
* @throws {RequiredError}
|
|
363
372
|
* @memberof CategoriesApi
|
|
364
373
|
*/
|
|
365
|
-
|
|
374
|
+
patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}>>;
|
|
366
375
|
}
|