@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
package/.openapi-generator/FILES
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
+
api/assignees-api.ts
|
|
6
7
|
api/categories-api.ts
|
|
7
8
|
api/default-api.ts
|
|
8
9
|
api/hub-spot-api.ts
|
|
9
|
-
api/priorities-api.ts
|
|
10
10
|
api/statuses-api.ts
|
|
11
11
|
api/tasks-api.ts
|
|
12
12
|
base.ts
|
|
@@ -14,19 +14,17 @@ common.ts
|
|
|
14
14
|
configuration.ts
|
|
15
15
|
git_push.sh
|
|
16
16
|
index.ts
|
|
17
|
+
models/assignee-class.ts
|
|
17
18
|
models/category-class.ts
|
|
18
19
|
models/create-category-request-dto.ts
|
|
19
20
|
models/create-category-response-class.ts
|
|
20
21
|
models/create-hub-spot-ticket-request-dto.ts
|
|
21
22
|
models/create-hub-spot-ticket-response-class.ts
|
|
22
|
-
models/create-priority-request-dto.ts
|
|
23
|
-
models/create-priority-response-class.ts
|
|
24
23
|
models/create-status-request-dto.ts
|
|
25
24
|
models/create-status-response-class.ts
|
|
26
25
|
models/create-task-request-dto.ts
|
|
27
26
|
models/create-task-response-class.ts
|
|
28
27
|
models/get-category-response-class.ts
|
|
29
|
-
models/get-priority-response-class.ts
|
|
30
28
|
models/get-status-response-class.ts
|
|
31
29
|
models/get-task-response-class.ts
|
|
32
30
|
models/hub-spot-ticket-class.ts
|
|
@@ -35,17 +33,17 @@ models/hub-spot-ticket-name-value-dto.ts
|
|
|
35
33
|
models/index.ts
|
|
36
34
|
models/inline-response200.ts
|
|
37
35
|
models/inline-response503.ts
|
|
36
|
+
models/list-assignees-response-class.ts
|
|
38
37
|
models/list-categories-response-class.ts
|
|
39
38
|
models/list-statuses-response-class.ts
|
|
40
39
|
models/list-tasks-response-class.ts
|
|
41
|
-
models/
|
|
40
|
+
models/patch-category-request-dto.ts
|
|
41
|
+
models/patch-category-response-class.ts
|
|
42
|
+
models/patch-status-request-dto.ts
|
|
43
|
+
models/patch-status-response-class.ts
|
|
44
|
+
models/patch-task-request-dto.ts
|
|
45
|
+
models/patch-task-response-class.ts
|
|
42
46
|
models/status-class.ts
|
|
43
47
|
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
48
|
package.json
|
|
51
49
|
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-node@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk-node@1.0.1-beta.11 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk-node@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk-node@1.0.1-beta.11
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL TaskService
|
|
5
|
+
* The EMIL Task API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { ListAssigneesResponseClass } from '../models';
|
|
25
|
+
// URLSearchParams not necessarily used
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import { URL, URLSearchParams } from 'url';
|
|
28
|
+
const FormData = require('form-data');
|
|
29
|
+
/**
|
|
30
|
+
* AssigneesApi - axios parameter creator
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
export const AssigneesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
|
+
return {
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
37
|
+
* @summary List assignees
|
|
38
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
+
* @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/>
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
listAssignees: async (authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44
|
+
const localVarPath = `/taskservice/v1/assignees`;
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
let baseAccessToken;
|
|
49
|
+
if (configuration) {
|
|
50
|
+
baseOptions = configuration.baseOptions;
|
|
51
|
+
baseAccessToken = configuration.accessToken;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
55
|
+
const localVarHeaderParameter = {} as any;
|
|
56
|
+
const localVarQueryParameter = {} as any;
|
|
57
|
+
|
|
58
|
+
// authentication bearer required
|
|
59
|
+
// http bearer authentication required
|
|
60
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
61
|
+
|
|
62
|
+
if (expand !== undefined) {
|
|
63
|
+
localVarQueryParameter['expand'] = expand;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
67
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
73
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
74
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
75
|
+
|
|
76
|
+
return {
|
|
77
|
+
url: toPathString(localVarUrlObj),
|
|
78
|
+
options: localVarRequestOptions,
|
|
79
|
+
};
|
|
80
|
+
},
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* AssigneesApi - functional programming interface
|
|
86
|
+
* @export
|
|
87
|
+
*/
|
|
88
|
+
export const AssigneesApiFp = function(configuration?: Configuration) {
|
|
89
|
+
const localVarAxiosParamCreator = AssigneesApiAxiosParamCreator(configuration)
|
|
90
|
+
return {
|
|
91
|
+
/**
|
|
92
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
93
|
+
* @summary List assignees
|
|
94
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
|
+
* @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/>
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
async listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>> {
|
|
100
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignees(authorization, expand, options);
|
|
101
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
102
|
+
},
|
|
103
|
+
}
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* AssigneesApi - factory interface
|
|
108
|
+
* @export
|
|
109
|
+
*/
|
|
110
|
+
export const AssigneesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
111
|
+
const localVarFp = AssigneesApiFp(configuration)
|
|
112
|
+
return {
|
|
113
|
+
/**
|
|
114
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
115
|
+
* @summary List assignees
|
|
116
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
+
* @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
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass> {
|
|
122
|
+
return localVarFp.listAssignees(authorization, expand, options).then((request) => request(axios, basePath));
|
|
123
|
+
},
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Request parameters for listAssignees operation in AssigneesApi.
|
|
129
|
+
* @export
|
|
130
|
+
* @interface AssigneesApiListAssigneesRequest
|
|
131
|
+
*/
|
|
132
|
+
export interface AssigneesApiListAssigneesRequest {
|
|
133
|
+
/**
|
|
134
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof AssigneesApiListAssignees
|
|
137
|
+
*/
|
|
138
|
+
readonly authorization?: string
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* 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/>
|
|
142
|
+
* @type {string}
|
|
143
|
+
* @memberof AssigneesApiListAssignees
|
|
144
|
+
*/
|
|
145
|
+
readonly expand?: string
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* AssigneesApi - object-oriented interface
|
|
150
|
+
* @export
|
|
151
|
+
* @class AssigneesApi
|
|
152
|
+
* @extends {BaseAPI}
|
|
153
|
+
*/
|
|
154
|
+
export class AssigneesApi extends BaseAPI {
|
|
155
|
+
/**
|
|
156
|
+
* Retrieves a list of distinct assignees from tasks.
|
|
157
|
+
* @summary List assignees
|
|
158
|
+
* @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
* @memberof AssigneesApi
|
|
162
|
+
*/
|
|
163
|
+
public listAssignees(requestParameters: AssigneesApiListAssigneesRequest = {}, options?: AxiosRequestConfig) {
|
|
164
|
+
return AssigneesApiFp(this.configuration).listAssignees(requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
165
|
+
}
|
|
166
|
+
}
|
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
|
// URLSearchParams not necessarily used
|
|
36
36
|
// @ts-ignore
|
|
37
37
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -43,7 +43,7 @@ const FormData = require('form-data');
|
|
|
43
43
|
export const CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* This will create category.
|
|
46
|
+
* This will create a category.
|
|
47
47
|
* @summary Create the category
|
|
48
48
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* This will delete category.
|
|
93
|
+
* This will delete a task category by code.
|
|
94
94
|
* @summary Delete the category
|
|
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 CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* Get category by code.
|
|
139
139
|
* @summary Retrieve the category
|
|
140
140
|
* @param {string} code
|
|
141
141
|
* @param {string} expand
|
|
@@ -190,14 +190,15 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
190
190
|
* Retrieves a list of categories.
|
|
191
191
|
* @summary List categories
|
|
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, createdAt</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, createdAt</i>
|
|
195
|
-
* @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</i>
|
|
196
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/>
|
|
197
198
|
* @param {*} [options] Override http request option.
|
|
198
199
|
* @throws {RequiredError}
|
|
199
200
|
*/
|
|
200
|
-
listCategories: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
|
+
listCategories: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
202
|
const localVarPath = `/taskservice/v1/categories`;
|
|
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 CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
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,19 +253,19 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
248
253
|
};
|
|
249
254
|
},
|
|
250
255
|
/**
|
|
251
|
-
* This will update category.
|
|
256
|
+
* This will partially update a category by code with the provided fields.
|
|
252
257
|
* @summary Update the category
|
|
253
258
|
* @param {string} code
|
|
254
|
-
* @param {
|
|
259
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
255
260
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
261
|
* @param {*} [options] Override http request option.
|
|
257
262
|
* @throws {RequiredError}
|
|
258
263
|
*/
|
|
259
|
-
|
|
264
|
+
patchCategory: async (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
260
265
|
// verify required parameter 'code' is not null or undefined
|
|
261
|
-
assertParamExists('
|
|
262
|
-
// verify required parameter '
|
|
263
|
-
assertParamExists('
|
|
266
|
+
assertParamExists('patchCategory', 'code', code)
|
|
267
|
+
// verify required parameter 'patchCategoryRequestDto' is not null or undefined
|
|
268
|
+
assertParamExists('patchCategory', 'patchCategoryRequestDto', patchCategoryRequestDto)
|
|
264
269
|
const localVarPath = `/taskservice/v1/categories/{code}`
|
|
265
270
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
266
271
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -272,7 +277,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
272
277
|
baseAccessToken = configuration.accessToken;
|
|
273
278
|
}
|
|
274
279
|
|
|
275
|
-
const localVarRequestOptions = { method: '
|
|
280
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
276
281
|
const localVarHeaderParameter = {} as any;
|
|
277
282
|
const localVarQueryParameter = {} as any;
|
|
278
283
|
|
|
@@ -291,7 +296,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
291
296
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
292
297
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
293
298
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
294
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
299
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchCategoryRequestDto, localVarRequestOptions, configuration)
|
|
295
300
|
|
|
296
301
|
return {
|
|
297
302
|
url: toPathString(localVarUrlObj),
|
|
@@ -309,7 +314,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
309
314
|
const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
|
|
310
315
|
return {
|
|
311
316
|
/**
|
|
312
|
-
* This will create category.
|
|
317
|
+
* This will create a category.
|
|
313
318
|
* @summary Create the category
|
|
314
319
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
315
320
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -321,7 +326,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
321
326
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
322
327
|
},
|
|
323
328
|
/**
|
|
324
|
-
* This will delete category.
|
|
329
|
+
* This will delete a task category by code.
|
|
325
330
|
* @summary Delete the category
|
|
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 CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
333
338
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
334
339
|
},
|
|
335
340
|
/**
|
|
336
|
-
*
|
|
341
|
+
* Get category by code.
|
|
337
342
|
* @summary Retrieve the category
|
|
338
343
|
* @param {string} code
|
|
339
344
|
* @param {string} expand
|
|
@@ -349,28 +354,29 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
349
354
|
* Retrieves a list of categories.
|
|
350
355
|
* @summary List categories
|
|
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, createdAt</i>
|
|
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, createdAt</i>
|
|
354
|
-
* @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</i>
|
|
355
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/>
|
|
356
362
|
* @param {*} [options] Override http request option.
|
|
357
363
|
* @throws {RequiredError}
|
|
358
364
|
*/
|
|
359
|
-
async listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
360
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, order, expand, options);
|
|
365
|
+
async listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
366
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, search, order, expand, options);
|
|
361
367
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
368
|
},
|
|
363
369
|
/**
|
|
364
|
-
* This will update category.
|
|
370
|
+
* This will partially update a category by code with the provided fields.
|
|
365
371
|
* @summary Update the category
|
|
366
372
|
* @param {string} code
|
|
367
|
-
* @param {
|
|
373
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
368
374
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
369
375
|
* @param {*} [options] Override http request option.
|
|
370
376
|
* @throws {RequiredError}
|
|
371
377
|
*/
|
|
372
|
-
async
|
|
373
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
378
|
+
async patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>> {
|
|
379
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCategory(code, patchCategoryRequestDto, authorization, options);
|
|
374
380
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
375
381
|
},
|
|
376
382
|
}
|
|
@@ -384,7 +390,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
384
390
|
const localVarFp = CategoriesApiFp(configuration)
|
|
385
391
|
return {
|
|
386
392
|
/**
|
|
387
|
-
* This will create category.
|
|
393
|
+
* This will create a category.
|
|
388
394
|
* @summary Create the category
|
|
389
395
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
390
396
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -395,7 +401,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
395
401
|
return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
396
402
|
},
|
|
397
403
|
/**
|
|
398
|
-
* This will delete category.
|
|
404
|
+
* This will delete a task category by code.
|
|
399
405
|
* @summary Delete the category
|
|
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 CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
406
412
|
return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
|
|
407
413
|
},
|
|
408
414
|
/**
|
|
409
|
-
*
|
|
415
|
+
* Get category by code.
|
|
410
416
|
* @summary Retrieve the category
|
|
411
417
|
* @param {string} code
|
|
412
418
|
* @param {string} expand
|
|
@@ -421,27 +427,28 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
421
427
|
* Retrieves a list of categories.
|
|
422
428
|
* @summary List categories
|
|
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, createdAt</i>
|
|
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, createdAt</i>
|
|
426
|
-
* @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</i>
|
|
427
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/>
|
|
428
435
|
* @param {*} [options] Override http request option.
|
|
429
436
|
* @throws {RequiredError}
|
|
430
437
|
*/
|
|
431
|
-
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
432
|
-
return localVarFp.listCategories(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
438
|
+
listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
439
|
+
return localVarFp.listCategories(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
433
440
|
},
|
|
434
441
|
/**
|
|
435
|
-
* This will update category.
|
|
442
|
+
* This will partially update a category by code with the provided fields.
|
|
436
443
|
* @summary Update the category
|
|
437
444
|
* @param {string} code
|
|
438
|
-
* @param {
|
|
445
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
439
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
440
447
|
* @param {*} [options] Override http request option.
|
|
441
448
|
* @throws {RequiredError}
|
|
442
449
|
*/
|
|
443
|
-
|
|
444
|
-
return localVarFp.
|
|
450
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass> {
|
|
451
|
+
return localVarFp.patchCategory(code, patchCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
445
452
|
},
|
|
446
453
|
};
|
|
447
454
|
};
|
|
@@ -530,21 +537,28 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
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, createdAt</i>
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
534
541
|
* @type {string}
|
|
535
542
|
* @memberof CategoriesApiListCategories
|
|
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, createdAt</i>
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
541
548
|
* @type {string}
|
|
542
549
|
* @memberof CategoriesApiListCategories
|
|
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, name, slug</i>
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof CategoriesApiListCategories
|
|
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, name, slug</i>
|
|
548
562
|
* @type {string}
|
|
549
563
|
* @memberof CategoriesApiListCategories
|
|
550
564
|
*/
|
|
@@ -559,29 +573,29 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
559
573
|
}
|
|
560
574
|
|
|
561
575
|
/**
|
|
562
|
-
* Request parameters for
|
|
576
|
+
* Request parameters for patchCategory operation in CategoriesApi.
|
|
563
577
|
* @export
|
|
564
|
-
* @interface
|
|
578
|
+
* @interface CategoriesApiPatchCategoryRequest
|
|
565
579
|
*/
|
|
566
|
-
export interface
|
|
580
|
+
export interface CategoriesApiPatchCategoryRequest {
|
|
567
581
|
/**
|
|
568
582
|
*
|
|
569
583
|
* @type {string}
|
|
570
|
-
* @memberof
|
|
584
|
+
* @memberof CategoriesApiPatchCategory
|
|
571
585
|
*/
|
|
572
586
|
readonly code: string
|
|
573
587
|
|
|
574
588
|
/**
|
|
575
589
|
*
|
|
576
|
-
* @type {
|
|
577
|
-
* @memberof
|
|
590
|
+
* @type {PatchCategoryRequestDto}
|
|
591
|
+
* @memberof CategoriesApiPatchCategory
|
|
578
592
|
*/
|
|
579
|
-
readonly
|
|
593
|
+
readonly patchCategoryRequestDto: PatchCategoryRequestDto
|
|
580
594
|
|
|
581
595
|
/**
|
|
582
596
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
583
597
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
598
|
+
* @memberof CategoriesApiPatchCategory
|
|
585
599
|
*/
|
|
586
600
|
readonly authorization?: string
|
|
587
601
|
}
|
|
@@ -594,7 +608,7 @@ export interface CategoriesApiUpdateCategoryRequest {
|
|
|
594
608
|
*/
|
|
595
609
|
export class CategoriesApi extends BaseAPI {
|
|
596
610
|
/**
|
|
597
|
-
* This will create category.
|
|
611
|
+
* This will create a category.
|
|
598
612
|
* @summary Create the category
|
|
599
613
|
* @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
|
|
600
614
|
* @param {*} [options] Override http request option.
|
|
@@ -606,7 +620,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
606
620
|
}
|
|
607
621
|
|
|
608
622
|
/**
|
|
609
|
-
* This will delete category.
|
|
623
|
+
* This will delete a task category by code.
|
|
610
624
|
* @summary Delete the category
|
|
611
625
|
* @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
|
|
612
626
|
* @param {*} [options] Override http request option.
|
|
@@ -618,7 +632,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
618
632
|
}
|
|
619
633
|
|
|
620
634
|
/**
|
|
621
|
-
*
|
|
635
|
+
* Get category by code.
|
|
622
636
|
* @summary Retrieve the category
|
|
623
637
|
* @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
|
|
624
638
|
* @param {*} [options] Override http request option.
|
|
@@ -638,18 +652,18 @@ export class CategoriesApi extends BaseAPI {
|
|
|
638
652
|
* @memberof CategoriesApi
|
|
639
653
|
*/
|
|
640
654
|
public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
|
|
641
|
-
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
655
|
+
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));
|
|
642
656
|
}
|
|
643
657
|
|
|
644
658
|
/**
|
|
645
|
-
* This will update category.
|
|
659
|
+
* This will partially update a category by code with the provided fields.
|
|
646
660
|
* @summary Update the category
|
|
647
|
-
* @param {
|
|
661
|
+
* @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
|
|
648
662
|
* @param {*} [options] Override http request option.
|
|
649
663
|
* @throws {RequiredError}
|
|
650
664
|
* @memberof CategoriesApi
|
|
651
665
|
*/
|
|
652
|
-
public
|
|
653
|
-
return CategoriesApiFp(this.configuration).
|
|
666
|
+
public patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig) {
|
|
667
|
+
return CategoriesApiFp(this.configuration).patchCategory(requestParameters.code, requestParameters.patchCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
654
668
|
}
|
|
655
669
|
}
|