@emilgroup/task-sdk 1.0.1-beta.1 → 1.0.1-beta.10
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 +6 -11
- package/README.md +2 -2
- package/api/categories-api.ts +74 -60
- package/api/statuses-api.ts +70 -56
- package/api/tasks-api.ts +105 -63
- package/api.ts +0 -2
- 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 +0 -1
- package/dist/api.js +0 -1
- 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 +6 -10
- package/dist/models/index.js +6 -10
- 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/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 +6 -10
- 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 -284
- package/dist/api/priorities-api.d.ts +0 -162
- package/dist/api/priorities-api.js +0 -324
- package/dist/models/create-priority-request-dto.d.ts +0 -24
- 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-status-request-dto.js +0 -15
- package/dist/models/update-status-response-class.js +0 -15
- 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-request-dto.ts +0 -30
- 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 → patch-category-request-dto.js} +0 -0
- /package/dist/models/{create-priority-response-class.js → patch-category-response-class.js} +0 -0
- /package/dist/models/{get-priority-response-class.js → patch-status-request-dto.js} +0 -0
- /package/dist/models/{priority-class.js → patch-status-response-class.js} +0 -0
- /package/dist/models/{update-category-request-dto.js → patch-task-request-dto.js} +0 -0
- /package/dist/models/{update-category-response-class.js → patch-task-response-class.js} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -6,7 +6,6 @@ api.ts
|
|
|
6
6
|
api/categories-api.ts
|
|
7
7
|
api/default-api.ts
|
|
8
8
|
api/hub-spot-api.ts
|
|
9
|
-
api/priorities-api.ts
|
|
10
9
|
api/statuses-api.ts
|
|
11
10
|
api/tasks-api.ts
|
|
12
11
|
base.ts
|
|
@@ -19,14 +18,11 @@ models/create-category-request-dto.ts
|
|
|
19
18
|
models/create-category-response-class.ts
|
|
20
19
|
models/create-hub-spot-ticket-request-dto.ts
|
|
21
20
|
models/create-hub-spot-ticket-response-class.ts
|
|
22
|
-
models/create-priority-request-dto.ts
|
|
23
|
-
models/create-priority-response-class.ts
|
|
24
21
|
models/create-status-request-dto.ts
|
|
25
22
|
models/create-status-response-class.ts
|
|
26
23
|
models/create-task-request-dto.ts
|
|
27
24
|
models/create-task-response-class.ts
|
|
28
25
|
models/get-category-response-class.ts
|
|
29
|
-
models/get-priority-response-class.ts
|
|
30
26
|
models/get-status-response-class.ts
|
|
31
27
|
models/get-task-response-class.ts
|
|
32
28
|
models/hub-spot-ticket-class.ts
|
|
@@ -38,14 +34,13 @@ models/inline-response503.ts
|
|
|
38
34
|
models/list-categories-response-class.ts
|
|
39
35
|
models/list-statuses-response-class.ts
|
|
40
36
|
models/list-tasks-response-class.ts
|
|
41
|
-
models/
|
|
37
|
+
models/patch-category-request-dto.ts
|
|
38
|
+
models/patch-category-response-class.ts
|
|
39
|
+
models/patch-status-request-dto.ts
|
|
40
|
+
models/patch-status-response-class.ts
|
|
41
|
+
models/patch-task-request-dto.ts
|
|
42
|
+
models/patch-task-response-class.ts
|
|
42
43
|
models/status-class.ts
|
|
43
44
|
models/task-class.ts
|
|
44
|
-
models/update-category-request-dto.ts
|
|
45
|
-
models/update-category-response-class.ts
|
|
46
|
-
models/update-status-request-dto.ts
|
|
47
|
-
models/update-status-response-class.ts
|
|
48
|
-
models/update-task-request-dto.ts
|
|
49
|
-
models/update-task-response-class.ts
|
|
50
45
|
package.json
|
|
51
46
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/task-sdk@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk@1.0.1-beta.10 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk@1.0.1-beta.10
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
package/api/categories-api.ts
CHANGED
|
@@ -29,9 +29,9 @@ import { GetCategoryResponseClass } from '../models';
|
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { ListCategoriesResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
32
|
-
import {
|
|
32
|
+
import { PatchCategoryRequestDto } from '../models';
|
|
33
33
|
// @ts-ignore
|
|
34
|
-
import {
|
|
34
|
+
import { PatchCategoryResponseClass } from '../models';
|
|
35
35
|
/**
|
|
36
36
|
* CategoriesApi - axios parameter creator
|
|
37
37
|
* @export
|
|
@@ -39,7 +39,7 @@ import { UpdateCategoryResponseClass } from '../models';
|
|
|
39
39
|
export const CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* This will create category.
|
|
42
|
+
* This will create a category.
|
|
43
43
|
* @summary Create the category
|
|
44
44
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
45
45
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -86,7 +86,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* This will delete category.
|
|
89
|
+
* This will delete a task category by code.
|
|
90
90
|
* @summary Delete the category
|
|
91
91
|
* @param {string} code Unique identifier for the object.
|
|
92
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -131,7 +131,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
*
|
|
134
|
+
* Get category by code.
|
|
135
135
|
* @summary Retrieve the category
|
|
136
136
|
* @param {string} code
|
|
137
137
|
* @param {string} expand
|
|
@@ -186,14 +186,15 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
186
186
|
* Retrieves a list of categories.
|
|
187
187
|
* @summary List categories
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @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>
|
|
190
|
-
* @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>
|
|
191
|
-
* @param {string} [
|
|
189
|
+
* @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>
|
|
190
|
+
* @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>
|
|
191
|
+
* @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>
|
|
192
|
+
* @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>
|
|
192
193
|
* @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/>
|
|
193
194
|
* @param {*} [options] Override http request option.
|
|
194
195
|
* @throws {RequiredError}
|
|
195
196
|
*/
|
|
196
|
-
listCategories: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
197
|
+
listCategories: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
197
198
|
const localVarPath = `/taskservice/v1/categories`;
|
|
198
199
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
199
200
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -220,6 +221,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
220
221
|
localVarQueryParameter['filters'] = filters;
|
|
221
222
|
}
|
|
222
223
|
|
|
224
|
+
if (search !== undefined) {
|
|
225
|
+
localVarQueryParameter['search'] = search;
|
|
226
|
+
}
|
|
227
|
+
|
|
223
228
|
if (order !== undefined) {
|
|
224
229
|
localVarQueryParameter['order'] = order;
|
|
225
230
|
}
|
|
@@ -244,19 +249,19 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
244
249
|
};
|
|
245
250
|
},
|
|
246
251
|
/**
|
|
247
|
-
* This will update category.
|
|
252
|
+
* This will partially update a category by code with the provided fields.
|
|
248
253
|
* @summary Update the category
|
|
249
254
|
* @param {string} code
|
|
250
|
-
* @param {
|
|
255
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
251
256
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
257
|
* @param {*} [options] Override http request option.
|
|
253
258
|
* @throws {RequiredError}
|
|
254
259
|
*/
|
|
255
|
-
|
|
260
|
+
patchCategory: async (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
256
261
|
// verify required parameter 'code' is not null or undefined
|
|
257
|
-
assertParamExists('
|
|
258
|
-
// verify required parameter '
|
|
259
|
-
assertParamExists('
|
|
262
|
+
assertParamExists('patchCategory', 'code', code)
|
|
263
|
+
// verify required parameter 'patchCategoryRequestDto' is not null or undefined
|
|
264
|
+
assertParamExists('patchCategory', 'patchCategoryRequestDto', patchCategoryRequestDto)
|
|
260
265
|
const localVarPath = `/taskservice/v1/categories/{code}`
|
|
261
266
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
262
267
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -268,7 +273,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
268
273
|
baseAccessToken = configuration.accessToken;
|
|
269
274
|
}
|
|
270
275
|
|
|
271
|
-
const localVarRequestOptions = { method: '
|
|
276
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
272
277
|
const localVarHeaderParameter = {} as any;
|
|
273
278
|
const localVarQueryParameter = {} as any;
|
|
274
279
|
|
|
@@ -287,7 +292,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
287
292
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
288
293
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
289
294
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
290
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
295
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchCategoryRequestDto, localVarRequestOptions, configuration)
|
|
291
296
|
|
|
292
297
|
return {
|
|
293
298
|
url: toPathString(localVarUrlObj),
|
|
@@ -305,7 +310,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
305
310
|
const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
|
|
306
311
|
return {
|
|
307
312
|
/**
|
|
308
|
-
* This will create category.
|
|
313
|
+
* This will create a category.
|
|
309
314
|
* @summary Create the category
|
|
310
315
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
311
316
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -317,7 +322,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
317
322
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
318
323
|
},
|
|
319
324
|
/**
|
|
320
|
-
* This will delete category.
|
|
325
|
+
* This will delete a task category by code.
|
|
321
326
|
* @summary Delete the category
|
|
322
327
|
* @param {string} code Unique identifier for the object.
|
|
323
328
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -329,7 +334,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
329
334
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
330
335
|
},
|
|
331
336
|
/**
|
|
332
|
-
*
|
|
337
|
+
* Get category by code.
|
|
333
338
|
* @summary Retrieve the category
|
|
334
339
|
* @param {string} code
|
|
335
340
|
* @param {string} expand
|
|
@@ -345,28 +350,29 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
345
350
|
* Retrieves a list of categories.
|
|
346
351
|
* @summary List categories
|
|
347
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
|
-
* @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>
|
|
349
|
-
* @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>
|
|
350
|
-
* @param {string} [
|
|
353
|
+
* @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>
|
|
354
|
+
* @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>
|
|
355
|
+
* @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>
|
|
356
|
+
* @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>
|
|
351
357
|
* @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/>
|
|
352
358
|
* @param {*} [options] Override http request option.
|
|
353
359
|
* @throws {RequiredError}
|
|
354
360
|
*/
|
|
355
|
-
async listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
356
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, order, expand, options);
|
|
361
|
+
async listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
362
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, search, order, expand, options);
|
|
357
363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
364
|
},
|
|
359
365
|
/**
|
|
360
|
-
* This will update category.
|
|
366
|
+
* This will partially update a category by code with the provided fields.
|
|
361
367
|
* @summary Update the category
|
|
362
368
|
* @param {string} code
|
|
363
|
-
* @param {
|
|
369
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
364
370
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
371
|
* @param {*} [options] Override http request option.
|
|
366
372
|
* @throws {RequiredError}
|
|
367
373
|
*/
|
|
368
|
-
async
|
|
369
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
374
|
+
async patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>> {
|
|
375
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCategory(code, patchCategoryRequestDto, authorization, options);
|
|
370
376
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
371
377
|
},
|
|
372
378
|
}
|
|
@@ -380,7 +386,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
380
386
|
const localVarFp = CategoriesApiFp(configuration)
|
|
381
387
|
return {
|
|
382
388
|
/**
|
|
383
|
-
* This will create category.
|
|
389
|
+
* This will create a category.
|
|
384
390
|
* @summary Create the category
|
|
385
391
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
386
392
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -391,7 +397,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
391
397
|
return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
392
398
|
},
|
|
393
399
|
/**
|
|
394
|
-
* This will delete category.
|
|
400
|
+
* This will delete a task category by code.
|
|
395
401
|
* @summary Delete the category
|
|
396
402
|
* @param {string} code Unique identifier for the object.
|
|
397
403
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -402,7 +408,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
402
408
|
return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
|
|
403
409
|
},
|
|
404
410
|
/**
|
|
405
|
-
*
|
|
411
|
+
* Get category by code.
|
|
406
412
|
* @summary Retrieve the category
|
|
407
413
|
* @param {string} code
|
|
408
414
|
* @param {string} expand
|
|
@@ -417,27 +423,28 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
417
423
|
* Retrieves a list of categories.
|
|
418
424
|
* @summary List categories
|
|
419
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
|
-
* @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>
|
|
421
|
-
* @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>
|
|
422
|
-
* @param {string} [
|
|
426
|
+
* @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>
|
|
427
|
+
* @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>
|
|
428
|
+
* @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>
|
|
429
|
+
* @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>
|
|
423
430
|
* @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/>
|
|
424
431
|
* @param {*} [options] Override http request option.
|
|
425
432
|
* @throws {RequiredError}
|
|
426
433
|
*/
|
|
427
|
-
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
428
|
-
return localVarFp.listCategories(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
434
|
+
listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
435
|
+
return localVarFp.listCategories(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
429
436
|
},
|
|
430
437
|
/**
|
|
431
|
-
* This will update category.
|
|
438
|
+
* This will partially update a category by code with the provided fields.
|
|
432
439
|
* @summary Update the category
|
|
433
440
|
* @param {string} code
|
|
434
|
-
* @param {
|
|
441
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
435
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
436
443
|
* @param {*} [options] Override http request option.
|
|
437
444
|
* @throws {RequiredError}
|
|
438
445
|
*/
|
|
439
|
-
|
|
440
|
-
return localVarFp.
|
|
446
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass> {
|
|
447
|
+
return localVarFp.patchCategory(code, patchCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
441
448
|
},
|
|
442
449
|
};
|
|
443
450
|
};
|
|
@@ -526,21 +533,28 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
526
533
|
readonly authorization?: string
|
|
527
534
|
|
|
528
535
|
/**
|
|
529
|
-
* 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>
|
|
536
|
+
* 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>
|
|
530
537
|
* @type {string}
|
|
531
538
|
* @memberof CategoriesApiListCategories
|
|
532
539
|
*/
|
|
533
540
|
readonly filter?: string
|
|
534
541
|
|
|
535
542
|
/**
|
|
536
|
-
* 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>
|
|
543
|
+
* 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>
|
|
537
544
|
* @type {string}
|
|
538
545
|
* @memberof CategoriesApiListCategories
|
|
539
546
|
*/
|
|
540
547
|
readonly filters?: string
|
|
541
548
|
|
|
542
549
|
/**
|
|
543
|
-
*
|
|
550
|
+
* 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>
|
|
551
|
+
* @type {string}
|
|
552
|
+
* @memberof CategoriesApiListCategories
|
|
553
|
+
*/
|
|
554
|
+
readonly search?: string
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* 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>
|
|
544
558
|
* @type {string}
|
|
545
559
|
* @memberof CategoriesApiListCategories
|
|
546
560
|
*/
|
|
@@ -555,29 +569,29 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
555
569
|
}
|
|
556
570
|
|
|
557
571
|
/**
|
|
558
|
-
* Request parameters for
|
|
572
|
+
* Request parameters for patchCategory operation in CategoriesApi.
|
|
559
573
|
* @export
|
|
560
|
-
* @interface
|
|
574
|
+
* @interface CategoriesApiPatchCategoryRequest
|
|
561
575
|
*/
|
|
562
|
-
export interface
|
|
576
|
+
export interface CategoriesApiPatchCategoryRequest {
|
|
563
577
|
/**
|
|
564
578
|
*
|
|
565
579
|
* @type {string}
|
|
566
|
-
* @memberof
|
|
580
|
+
* @memberof CategoriesApiPatchCategory
|
|
567
581
|
*/
|
|
568
582
|
readonly code: string
|
|
569
583
|
|
|
570
584
|
/**
|
|
571
585
|
*
|
|
572
|
-
* @type {
|
|
573
|
-
* @memberof
|
|
586
|
+
* @type {PatchCategoryRequestDto}
|
|
587
|
+
* @memberof CategoriesApiPatchCategory
|
|
574
588
|
*/
|
|
575
|
-
readonly
|
|
589
|
+
readonly patchCategoryRequestDto: PatchCategoryRequestDto
|
|
576
590
|
|
|
577
591
|
/**
|
|
578
592
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
579
593
|
* @type {string}
|
|
580
|
-
* @memberof
|
|
594
|
+
* @memberof CategoriesApiPatchCategory
|
|
581
595
|
*/
|
|
582
596
|
readonly authorization?: string
|
|
583
597
|
}
|
|
@@ -590,7 +604,7 @@ export interface CategoriesApiUpdateCategoryRequest {
|
|
|
590
604
|
*/
|
|
591
605
|
export class CategoriesApi extends BaseAPI {
|
|
592
606
|
/**
|
|
593
|
-
* This will create category.
|
|
607
|
+
* This will create a category.
|
|
594
608
|
* @summary Create the category
|
|
595
609
|
* @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
|
|
596
610
|
* @param {*} [options] Override http request option.
|
|
@@ -602,7 +616,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
602
616
|
}
|
|
603
617
|
|
|
604
618
|
/**
|
|
605
|
-
* This will delete category.
|
|
619
|
+
* This will delete a task category by code.
|
|
606
620
|
* @summary Delete the category
|
|
607
621
|
* @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
|
|
608
622
|
* @param {*} [options] Override http request option.
|
|
@@ -614,7 +628,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
614
628
|
}
|
|
615
629
|
|
|
616
630
|
/**
|
|
617
|
-
*
|
|
631
|
+
* Get category by code.
|
|
618
632
|
* @summary Retrieve the category
|
|
619
633
|
* @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
|
|
620
634
|
* @param {*} [options] Override http request option.
|
|
@@ -634,18 +648,18 @@ export class CategoriesApi extends BaseAPI {
|
|
|
634
648
|
* @memberof CategoriesApi
|
|
635
649
|
*/
|
|
636
650
|
public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
|
|
637
|
-
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
651
|
+
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
638
652
|
}
|
|
639
653
|
|
|
640
654
|
/**
|
|
641
|
-
* This will update category.
|
|
655
|
+
* This will partially update a category by code with the provided fields.
|
|
642
656
|
* @summary Update the category
|
|
643
|
-
* @param {
|
|
657
|
+
* @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
|
|
644
658
|
* @param {*} [options] Override http request option.
|
|
645
659
|
* @throws {RequiredError}
|
|
646
660
|
* @memberof CategoriesApi
|
|
647
661
|
*/
|
|
648
|
-
public
|
|
649
|
-
return CategoriesApiFp(this.configuration).
|
|
662
|
+
public patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig) {
|
|
663
|
+
return CategoriesApiFp(this.configuration).patchCategory(requestParameters.code, requestParameters.patchCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
650
664
|
}
|
|
651
665
|
}
|