@emilgroup/task-sdk-node 1.0.1-beta.1 → 1.0.1-beta.3
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 +0 -5
- package/README.md +2 -2
- package/api/categories-api.ts +44 -30
- package/api/statuses-api.ts +40 -26
- package/api/tasks-api.ts +48 -34
- package/api.ts +0 -2
- package/dist/api/categories-api.d.ts +36 -27
- package/dist/api/categories-api.js +33 -27
- package/dist/api/statuses-api.d.ts +32 -23
- package/dist/api/statuses-api.js +29 -23
- package/dist/api/tasks-api.d.ts +40 -31
- package/dist/api/tasks-api.js +36 -30
- 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 +0 -4
- package/dist/models/index.js +0 -4
- package/dist/models/status-class.d.ts +6 -0
- package/dist/models/task-class.d.ts +22 -5
- package/dist/models/task-class.js +6 -0
- package/dist/models/update-category-request-dto.d.ts +8 -2
- package/dist/models/update-status-request-dto.d.ts +8 -2
- package/dist/models/update-task-request-dto.d.ts +26 -14
- 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 +0 -4
- package/models/status-class.ts +6 -0
- package/models/task-class.ts +25 -5
- package/models/update-category-request-dto.ts +8 -2
- package/models/update-status-request-dto.ts +8 -2
- package/models/update-task-request-dto.ts +26 -14
- package/package.json +1 -1
- package/api/priorities-api.ts +0 -288
- package/dist/api/priorities-api.d.ts +0 -162
- package/dist/api/priorities-api.js +0 -328
- package/dist/models/create-priority-request-dto.d.ts +0 -24
- package/dist/models/create-priority-request-dto.js +0 -15
- package/dist/models/create-priority-response-class.d.ts +0 -25
- package/dist/models/create-priority-response-class.js +0 -15
- package/dist/models/get-priority-response-class.d.ts +0 -25
- package/dist/models/get-priority-response-class.js +0 -15
- package/dist/models/priority-class.d.ts +0 -60
- package/dist/models/priority-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/api/tasks-api.ts
CHANGED
|
@@ -90,7 +90,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* This will delete task.
|
|
93
|
+
* This will delete a task by code.
|
|
94
94
|
* @summary Delete the task
|
|
95
95
|
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,7 +135,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
* This will get task.
|
|
138
|
+
* This will get a task by code.
|
|
139
139
|
* @summary Retrieve the task
|
|
140
140
|
* @param {string} code
|
|
141
141
|
* @param {string} expand
|
|
@@ -190,14 +190,15 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
190
190
|
* Retrieves a list of tasks.
|
|
191
191
|
* @summary List tasks
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @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, categoryId, statusId,
|
|
194
|
-
* @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, categoryId, statusId,
|
|
195
|
-
* @param {string} [
|
|
196
|
-
* @param {string} [
|
|
193
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
194
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
195
|
+
* @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, subject, description, assignee, reporter</i>
|
|
196
|
+
* @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, assignee, reporter, dueDate</i>
|
|
197
|
+
* @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/> <i>Allowed values: category, status<i>
|
|
197
198
|
* @param {*} [options] Override http request option.
|
|
198
199
|
* @throws {RequiredError}
|
|
199
200
|
*/
|
|
200
|
-
listTasks: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
|
+
listTasks: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
202
|
const localVarPath = `/taskservice/v1/tasks`;
|
|
202
203
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
203
204
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -224,6 +225,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
224
225
|
localVarQueryParameter['filters'] = filters;
|
|
225
226
|
}
|
|
226
227
|
|
|
228
|
+
if (search !== undefined) {
|
|
229
|
+
localVarQueryParameter['search'] = search;
|
|
230
|
+
}
|
|
231
|
+
|
|
227
232
|
if (order !== undefined) {
|
|
228
233
|
localVarQueryParameter['order'] = order;
|
|
229
234
|
}
|
|
@@ -248,7 +253,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
248
253
|
};
|
|
249
254
|
},
|
|
250
255
|
/**
|
|
251
|
-
* This will update task.
|
|
256
|
+
* This will update a task by code.
|
|
252
257
|
* @summary Update the task
|
|
253
258
|
* @param {string} code
|
|
254
259
|
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
@@ -321,7 +326,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
321
326
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
322
327
|
},
|
|
323
328
|
/**
|
|
324
|
-
* This will delete task.
|
|
329
|
+
* This will delete a task by code.
|
|
325
330
|
* @summary Delete the task
|
|
326
331
|
* @param {string} code Unique identifier for the object.
|
|
327
332
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -333,7 +338,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
333
338
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
334
339
|
},
|
|
335
340
|
/**
|
|
336
|
-
* This will get task.
|
|
341
|
+
* This will get a task by code.
|
|
337
342
|
* @summary Retrieve the task
|
|
338
343
|
* @param {string} code
|
|
339
344
|
* @param {string} expand
|
|
@@ -349,19 +354,20 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
349
354
|
* Retrieves a list of tasks.
|
|
350
355
|
* @summary List tasks
|
|
351
356
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
352
|
-
* @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, categoryId, statusId,
|
|
353
|
-
* @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, categoryId, statusId,
|
|
354
|
-
* @param {string} [
|
|
355
|
-
* @param {string} [
|
|
357
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
358
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
359
|
+
* @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, subject, description, assignee, reporter</i>
|
|
360
|
+
* @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, assignee, reporter, dueDate</i>
|
|
361
|
+
* @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/> <i>Allowed values: category, status<i>
|
|
356
362
|
* @param {*} [options] Override http request option.
|
|
357
363
|
* @throws {RequiredError}
|
|
358
364
|
*/
|
|
359
|
-
async listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
|
|
360
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, filter, filters, order, expand, options);
|
|
365
|
+
async listTasks(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
|
|
366
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, filter, filters, search, order, expand, options);
|
|
361
367
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
368
|
},
|
|
363
369
|
/**
|
|
364
|
-
* This will update task.
|
|
370
|
+
* This will update a task by code.
|
|
365
371
|
* @summary Update the task
|
|
366
372
|
* @param {string} code
|
|
367
373
|
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
@@ -395,7 +401,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
395
401
|
return localVarFp.createTask(createTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
396
402
|
},
|
|
397
403
|
/**
|
|
398
|
-
* This will delete task.
|
|
404
|
+
* This will delete a task by code.
|
|
399
405
|
* @summary Delete the task
|
|
400
406
|
* @param {string} code Unique identifier for the object.
|
|
401
407
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -406,7 +412,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
406
412
|
return localVarFp.deleteTask(code, authorization, options).then((request) => request(axios, basePath));
|
|
407
413
|
},
|
|
408
414
|
/**
|
|
409
|
-
* This will get task.
|
|
415
|
+
* This will get a task by code.
|
|
410
416
|
* @summary Retrieve the task
|
|
411
417
|
* @param {string} code
|
|
412
418
|
* @param {string} expand
|
|
@@ -421,18 +427,19 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
421
427
|
* Retrieves a list of tasks.
|
|
422
428
|
* @summary List tasks
|
|
423
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
424
|
-
* @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, categoryId, statusId,
|
|
425
|
-
* @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, categoryId, statusId,
|
|
426
|
-
* @param {string} [
|
|
427
|
-
* @param {string} [
|
|
430
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
431
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
432
|
+
* @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, subject, description, assignee, reporter</i>
|
|
433
|
+
* @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, assignee, reporter, dueDate</i>
|
|
434
|
+
* @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/> <i>Allowed values: category, status<i>
|
|
428
435
|
* @param {*} [options] Override http request option.
|
|
429
436
|
* @throws {RequiredError}
|
|
430
437
|
*/
|
|
431
|
-
listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
432
|
-
return localVarFp.listTasks(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
438
|
+
listTasks(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
439
|
+
return localVarFp.listTasks(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
433
440
|
},
|
|
434
441
|
/**
|
|
435
|
-
* This will update task.
|
|
442
|
+
* This will update a task by code.
|
|
436
443
|
* @summary Update the task
|
|
437
444
|
* @param {string} code
|
|
438
445
|
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
@@ -530,28 +537,35 @@ export interface TasksApiListTasksRequest {
|
|
|
530
537
|
readonly authorization?: string
|
|
531
538
|
|
|
532
539
|
/**
|
|
533
|
-
* 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, categoryId, statusId,
|
|
540
|
+
* 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
534
541
|
* @type {string}
|
|
535
542
|
* @memberof TasksApiListTasks
|
|
536
543
|
*/
|
|
537
544
|
readonly filter?: string
|
|
538
545
|
|
|
539
546
|
/**
|
|
540
|
-
* 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, categoryId, statusId,
|
|
547
|
+
* 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
541
548
|
* @type {string}
|
|
542
549
|
* @memberof TasksApiListTasks
|
|
543
550
|
*/
|
|
544
551
|
readonly filters?: string
|
|
545
552
|
|
|
546
553
|
/**
|
|
547
|
-
*
|
|
554
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof TasksApiListTasks
|
|
557
|
+
*/
|
|
558
|
+
readonly search?: string
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* 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, assignee, reporter, dueDate</i>
|
|
548
562
|
* @type {string}
|
|
549
563
|
* @memberof TasksApiListTasks
|
|
550
564
|
*/
|
|
551
565
|
readonly order?: string
|
|
552
566
|
|
|
553
567
|
/**
|
|
554
|
-
* 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/> <i>Allowed values: category, status
|
|
568
|
+
* 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/> <i>Allowed values: category, status<i>
|
|
555
569
|
* @type {string}
|
|
556
570
|
* @memberof TasksApiListTasks
|
|
557
571
|
*/
|
|
@@ -606,7 +620,7 @@ export class TasksApi extends BaseAPI {
|
|
|
606
620
|
}
|
|
607
621
|
|
|
608
622
|
/**
|
|
609
|
-
* This will delete task.
|
|
623
|
+
* This will delete a task by code.
|
|
610
624
|
* @summary Delete the task
|
|
611
625
|
* @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
|
|
612
626
|
* @param {*} [options] Override http request option.
|
|
@@ -618,7 +632,7 @@ export class TasksApi extends BaseAPI {
|
|
|
618
632
|
}
|
|
619
633
|
|
|
620
634
|
/**
|
|
621
|
-
* This will get task.
|
|
635
|
+
* This will get a task by code.
|
|
622
636
|
* @summary Retrieve the task
|
|
623
637
|
* @param {TasksApiGetTaskRequest} requestParameters Request parameters.
|
|
624
638
|
* @param {*} [options] Override http request option.
|
|
@@ -638,11 +652,11 @@ export class TasksApi extends BaseAPI {
|
|
|
638
652
|
* @memberof TasksApi
|
|
639
653
|
*/
|
|
640
654
|
public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
|
|
641
|
-
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
655
|
+
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
642
656
|
}
|
|
643
657
|
|
|
644
658
|
/**
|
|
645
|
-
* This will update task.
|
|
659
|
+
* This will update a task by code.
|
|
646
660
|
* @summary Update the task
|
|
647
661
|
* @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
|
|
648
662
|
* @param {*} [options] Override http request option.
|
package/api.ts
CHANGED
|
@@ -27,7 +27,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
27
27
|
import { CategoriesApi } from './api';
|
|
28
28
|
import { DefaultApi } from './api';
|
|
29
29
|
import { HubSpotApi } from './api';
|
|
30
|
-
import { PrioritiesApi } from './api';
|
|
31
30
|
import { StatusesApi } from './api';
|
|
32
31
|
import { TasksApi } from './api';
|
|
33
32
|
|
|
@@ -35,7 +34,6 @@ import { TasksApi } from './api';
|
|
|
35
34
|
export * from './api/categories-api';
|
|
36
35
|
export * from './api/default-api';
|
|
37
36
|
export * from './api/hub-spot-api';
|
|
38
|
-
export * from './api/priorities-api';
|
|
39
37
|
export * from './api/statuses-api';
|
|
40
38
|
export * from './api/tasks-api';
|
|
41
39
|
|
|
@@ -24,7 +24,7 @@ import { UpdateCategoryResponseClass } from '../models';
|
|
|
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,14 +55,15 @@ 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
68
|
* This will update category.
|
|
68
69
|
* @summary Update the category
|
|
@@ -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,14 +112,15 @@ 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
125
|
* This will update category.
|
|
124
126
|
* @summary Update the category
|
|
@@ -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,14 +169,15 @@ 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
182
|
* This will update category.
|
|
180
183
|
* @summary Update the category
|
|
@@ -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
|
*/
|
|
@@ -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.
|