@emilgroup/task-sdk 1.0.1-beta.9 → 1.1.1-beta.12
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 +3 -0
- package/README.md +2 -2
- package/api/assignees-api.ts +162 -0
- package/api/categories-api.ts +85 -59
- package/api/default-api.ts +1 -1
- package/api/hub-spot-api.ts +4 -4
- package/api/statuses-api.ts +45 -47
- package/api/tasks-api.ts +49 -51
- package/api.ts +2 -0
- package/dist/api/assignees-api.d.ts +96 -0
- package/dist/api/assignees-api.js +224 -0
- package/dist/api/categories-api.d.ts +65 -47
- package/dist/api/categories-api.js +59 -49
- package/dist/api/default-api.js +1 -1
- package/dist/api/hub-spot-api.d.ts +4 -4
- package/dist/api/hub-spot-api.js +4 -4
- package/dist/api/statuses-api.d.ts +42 -42
- package/dist/api/statuses-api.js +38 -40
- package/dist/api/tasks-api.d.ts +46 -46
- package/dist/api/tasks-api.js +41 -43
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/assignee-class.d.ts +24 -0
- package/dist/models/assignee-class.js +15 -0
- package/dist/models/create-status-request-dto.d.ts +6 -0
- package/dist/models/create-task-request-dto.d.ts +4 -4
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/list-assignees-response-class.d.ts +43 -0
- package/dist/models/list-assignees-response-class.js +15 -0
- package/dist/models/patch-status-request-dto.d.ts +6 -0
- package/dist/models/patch-task-request-dto.d.ts +11 -5
- package/dist/models/status-class.d.ts +6 -0
- package/dist/models/task-class.d.ts +16 -4
- package/models/assignee-class.ts +30 -0
- package/models/create-status-request-dto.ts +6 -0
- package/models/create-task-request-dto.ts +4 -4
- package/models/index.ts +2 -0
- package/models/list-assignees-response-class.ts +49 -0
- package/models/patch-status-request-dto.ts +6 -0
- package/models/patch-task-request-dto.ts +11 -5
- package/models/status-class.ts +6 -0
- package/models/task-class.ts +16 -4
- package/package.json +2 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
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
|
|
@@ -13,6 +14,7 @@ common.ts
|
|
|
13
14
|
configuration.ts
|
|
14
15
|
git_push.sh
|
|
15
16
|
index.ts
|
|
17
|
+
models/assignee-class.ts
|
|
16
18
|
models/category-class.ts
|
|
17
19
|
models/create-category-request-dto.ts
|
|
18
20
|
models/create-category-response-class.ts
|
|
@@ -31,6 +33,7 @@ models/hub-spot-ticket-name-value-dto.ts
|
|
|
31
33
|
models/index.ts
|
|
32
34
|
models/inline-response200.ts
|
|
33
35
|
models/inline-response503.ts
|
|
36
|
+
models/list-assignees-response-class.ts
|
|
34
37
|
models/list-categories-response-class.ts
|
|
35
38
|
models/list-statuses-response-class.ts
|
|
36
39
|
models/list-tasks-response-class.ts
|
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.
|
|
20
|
+
npm install @emilgroup/task-sdk@1.1.1-beta.12 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk@1.
|
|
24
|
+
yarn add @emilgroup/task-sdk@1.1.1-beta.12
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
|
@@ -0,0 +1,162 @@
|
|
|
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
|
+
/**
|
|
26
|
+
* AssigneesApi - axios parameter creator
|
|
27
|
+
* @export
|
|
28
|
+
*/
|
|
29
|
+
export const AssigneesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
30
|
+
return {
|
|
31
|
+
/**
|
|
32
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
33
|
+
* @summary List assignees
|
|
34
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
35
|
+
* @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/>
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
listAssignees: async (authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
|
+
const localVarPath = `/taskservice/v1/assignees`;
|
|
41
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43
|
+
let baseOptions;
|
|
44
|
+
let baseAccessToken;
|
|
45
|
+
if (configuration) {
|
|
46
|
+
baseOptions = configuration.baseOptions;
|
|
47
|
+
baseAccessToken = configuration.accessToken;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
51
|
+
const localVarHeaderParameter = {} as any;
|
|
52
|
+
const localVarQueryParameter = {} as any;
|
|
53
|
+
|
|
54
|
+
// authentication bearer required
|
|
55
|
+
// http bearer authentication required
|
|
56
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57
|
+
|
|
58
|
+
if (expand !== undefined) {
|
|
59
|
+
localVarQueryParameter['expand'] = expand;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
63
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
69
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
70
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71
|
+
|
|
72
|
+
return {
|
|
73
|
+
url: toPathString(localVarUrlObj),
|
|
74
|
+
options: localVarRequestOptions,
|
|
75
|
+
};
|
|
76
|
+
},
|
|
77
|
+
}
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* AssigneesApi - functional programming interface
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
export const AssigneesApiFp = function(configuration?: Configuration) {
|
|
85
|
+
const localVarAxiosParamCreator = AssigneesApiAxiosParamCreator(configuration)
|
|
86
|
+
return {
|
|
87
|
+
/**
|
|
88
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
89
|
+
* @summary List assignees
|
|
90
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
+
* @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/>
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
async listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>> {
|
|
96
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignees(authorization, expand, options);
|
|
97
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
98
|
+
},
|
|
99
|
+
}
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* AssigneesApi - factory interface
|
|
104
|
+
* @export
|
|
105
|
+
*/
|
|
106
|
+
export const AssigneesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
107
|
+
const localVarFp = AssigneesApiFp(configuration)
|
|
108
|
+
return {
|
|
109
|
+
/**
|
|
110
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
111
|
+
* @summary List assignees
|
|
112
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
+
* @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/>
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass> {
|
|
118
|
+
return localVarFp.listAssignees(authorization, expand, options).then((request) => request(axios, basePath));
|
|
119
|
+
},
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Request parameters for listAssignees operation in AssigneesApi.
|
|
125
|
+
* @export
|
|
126
|
+
* @interface AssigneesApiListAssigneesRequest
|
|
127
|
+
*/
|
|
128
|
+
export interface AssigneesApiListAssigneesRequest {
|
|
129
|
+
/**
|
|
130
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
131
|
+
* @type {string}
|
|
132
|
+
* @memberof AssigneesApiListAssignees
|
|
133
|
+
*/
|
|
134
|
+
readonly authorization?: string
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* 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/>
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof AssigneesApiListAssignees
|
|
140
|
+
*/
|
|
141
|
+
readonly expand?: string
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* AssigneesApi - object-oriented interface
|
|
146
|
+
* @export
|
|
147
|
+
* @class AssigneesApi
|
|
148
|
+
* @extends {BaseAPI}
|
|
149
|
+
*/
|
|
150
|
+
export class AssigneesApi extends BaseAPI {
|
|
151
|
+
/**
|
|
152
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
153
|
+
* @summary List assignees
|
|
154
|
+
* @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
* @memberof AssigneesApi
|
|
158
|
+
*/
|
|
159
|
+
public listAssignees(requestParameters: AssigneesApiListAssigneesRequest = {}, options?: AxiosRequestConfig) {
|
|
160
|
+
return AssigneesApiFp(this.configuration).listAssignees(requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
161
|
+
}
|
|
162
|
+
}
|
package/api/categories-api.ts
CHANGED
|
@@ -39,7 +39,7 @@ import { PatchCategoryResponseClass } from '../models';
|
|
|
39
39
|
export const CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
40
40
|
return {
|
|
41
41
|
/**
|
|
42
|
-
* This will create a category.
|
|
42
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
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 a task category by code.
|
|
89
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
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,19 +131,17 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
131
131
|
};
|
|
132
132
|
},
|
|
133
133
|
/**
|
|
134
|
-
* Get category by code.
|
|
134
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
135
135
|
* @summary Retrieve the category
|
|
136
136
|
* @param {string} code
|
|
137
|
-
* @param {string} expand
|
|
138
137
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
138
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
139
139
|
* @param {*} [options] Override http request option.
|
|
140
140
|
* @throws {RequiredError}
|
|
141
141
|
*/
|
|
142
|
-
getCategory: async (code: string,
|
|
142
|
+
getCategory: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
143
143
|
// verify required parameter 'code' is not null or undefined
|
|
144
144
|
assertParamExists('getCategory', 'code', code)
|
|
145
|
-
// verify required parameter 'expand' is not null or undefined
|
|
146
|
-
assertParamExists('getCategory', 'expand', expand)
|
|
147
145
|
const localVarPath = `/taskservice/v1/categories/{code}`
|
|
148
146
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
149
147
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -183,18 +181,20 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
183
181
|
};
|
|
184
182
|
},
|
|
185
183
|
/**
|
|
186
|
-
* Retrieves a list of categories.
|
|
184
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
187
185
|
* @summary List categories
|
|
188
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {string} [
|
|
191
|
-
* @param {string} [
|
|
187
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
188
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
192
191
|
* @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>
|
|
193
192
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
193
|
+
* @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>
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
195
195
|
* @throws {RequiredError}
|
|
196
196
|
*/
|
|
197
|
-
listCategories: async (authorization?: string,
|
|
197
|
+
listCategories: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
198
198
|
const localVarPath = `/taskservice/v1/categories`;
|
|
199
199
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
200
200
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -213,12 +213,16 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
213
213
|
// http bearer authentication required
|
|
214
214
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
215
215
|
|
|
216
|
-
if (
|
|
217
|
-
localVarQueryParameter['
|
|
216
|
+
if (pageSize !== undefined) {
|
|
217
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
218
218
|
}
|
|
219
219
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
220
|
+
if (pageToken !== undefined) {
|
|
221
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
if (filter !== undefined) {
|
|
225
|
+
localVarQueryParameter['filter'] = filter;
|
|
222
226
|
}
|
|
223
227
|
|
|
224
228
|
if (search !== undefined) {
|
|
@@ -233,6 +237,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
233
237
|
localVarQueryParameter['expand'] = expand;
|
|
234
238
|
}
|
|
235
239
|
|
|
240
|
+
if (filters !== undefined) {
|
|
241
|
+
localVarQueryParameter['filters'] = filters;
|
|
242
|
+
}
|
|
243
|
+
|
|
236
244
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
237
245
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
238
246
|
}
|
|
@@ -249,7 +257,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
249
257
|
};
|
|
250
258
|
},
|
|
251
259
|
/**
|
|
252
|
-
* This will partially update a category by code with the provided fields.
|
|
260
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
253
261
|
* @summary Update the category
|
|
254
262
|
* @param {string} code
|
|
255
263
|
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
@@ -310,7 +318,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
310
318
|
const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
|
|
311
319
|
return {
|
|
312
320
|
/**
|
|
313
|
-
* This will create a category.
|
|
321
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
314
322
|
* @summary Create the category
|
|
315
323
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
316
324
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -322,7 +330,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
322
330
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
323
331
|
},
|
|
324
332
|
/**
|
|
325
|
-
* This will delete a task category by code.
|
|
333
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
326
334
|
* @summary Delete the category
|
|
327
335
|
* @param {string} code Unique identifier for the object.
|
|
328
336
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -334,36 +342,38 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
334
342
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
335
343
|
},
|
|
336
344
|
/**
|
|
337
|
-
* Get category by code.
|
|
345
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
338
346
|
* @summary Retrieve the category
|
|
339
347
|
* @param {string} code
|
|
340
|
-
* @param {string} expand
|
|
341
348
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
349
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
342
350
|
* @param {*} [options] Override http request option.
|
|
343
351
|
* @throws {RequiredError}
|
|
344
352
|
*/
|
|
345
|
-
async getCategory(code: string,
|
|
346
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCategory(code,
|
|
353
|
+
async getCategory(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCategoryResponseClass>> {
|
|
354
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCategory(code, authorization, expand, options);
|
|
347
355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
348
356
|
},
|
|
349
357
|
/**
|
|
350
|
-
* Retrieves a list of categories.
|
|
358
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
351
359
|
* @summary List categories
|
|
352
360
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
-
* @param {
|
|
354
|
-
* @param {string} [
|
|
355
|
-
* @param {string} [
|
|
361
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
362
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
363
|
+
* @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>
|
|
364
|
+
* @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: name, slug</i>
|
|
356
365
|
* @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>
|
|
357
366
|
* @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/>
|
|
367
|
+
* @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>
|
|
358
368
|
* @param {*} [options] Override http request option.
|
|
359
369
|
* @throws {RequiredError}
|
|
360
370
|
*/
|
|
361
|
-
async listCategories(authorization?: string,
|
|
362
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization,
|
|
371
|
+
async listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
372
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
363
373
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
364
374
|
},
|
|
365
375
|
/**
|
|
366
|
-
* This will partially update a category by code with the provided fields.
|
|
376
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
367
377
|
* @summary Update the category
|
|
368
378
|
* @param {string} code
|
|
369
379
|
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
@@ -386,7 +396,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
386
396
|
const localVarFp = CategoriesApiFp(configuration)
|
|
387
397
|
return {
|
|
388
398
|
/**
|
|
389
|
-
* This will create a category.
|
|
399
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
390
400
|
* @summary Create the category
|
|
391
401
|
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
392
402
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -397,7 +407,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
397
407
|
return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
398
408
|
},
|
|
399
409
|
/**
|
|
400
|
-
* This will delete a task category by code.
|
|
410
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
401
411
|
* @summary Delete the category
|
|
402
412
|
* @param {string} code Unique identifier for the object.
|
|
403
413
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -408,34 +418,36 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
408
418
|
return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
|
|
409
419
|
},
|
|
410
420
|
/**
|
|
411
|
-
* Get category by code.
|
|
421
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
412
422
|
* @summary Retrieve the category
|
|
413
423
|
* @param {string} code
|
|
414
|
-
* @param {string} expand
|
|
415
424
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
425
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
416
426
|
* @param {*} [options] Override http request option.
|
|
417
427
|
* @throws {RequiredError}
|
|
418
428
|
*/
|
|
419
|
-
getCategory(code: string,
|
|
420
|
-
return localVarFp.getCategory(code,
|
|
429
|
+
getCategory(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCategoryResponseClass> {
|
|
430
|
+
return localVarFp.getCategory(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
421
431
|
},
|
|
422
432
|
/**
|
|
423
|
-
* Retrieves a list of categories.
|
|
433
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
424
434
|
* @summary List categories
|
|
425
435
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
|
-
* @param {
|
|
427
|
-
* @param {string} [
|
|
428
|
-
* @param {string} [
|
|
436
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
437
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
438
|
+
* @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>
|
|
439
|
+
* @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: name, slug</i>
|
|
429
440
|
* @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>
|
|
430
441
|
* @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/>
|
|
442
|
+
* @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>
|
|
431
443
|
* @param {*} [options] Override http request option.
|
|
432
444
|
* @throws {RequiredError}
|
|
433
445
|
*/
|
|
434
|
-
listCategories(authorization?: string,
|
|
435
|
-
return localVarFp.listCategories(authorization,
|
|
446
|
+
listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
447
|
+
return localVarFp.listCategories(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
436
448
|
},
|
|
437
449
|
/**
|
|
438
|
-
* This will partially update a category by code with the provided fields.
|
|
450
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
439
451
|
* @summary Update the category
|
|
440
452
|
* @param {string} code
|
|
441
453
|
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
@@ -505,18 +517,18 @@ export interface CategoriesApiGetCategoryRequest {
|
|
|
505
517
|
readonly code: string
|
|
506
518
|
|
|
507
519
|
/**
|
|
508
|
-
*
|
|
520
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
509
521
|
* @type {string}
|
|
510
522
|
* @memberof CategoriesApiGetCategory
|
|
511
523
|
*/
|
|
512
|
-
readonly
|
|
524
|
+
readonly authorization?: string
|
|
513
525
|
|
|
514
526
|
/**
|
|
515
|
-
*
|
|
527
|
+
* Expand to fetch additional information about the category.
|
|
516
528
|
* @type {string}
|
|
517
529
|
* @memberof CategoriesApiGetCategory
|
|
518
530
|
*/
|
|
519
|
-
readonly
|
|
531
|
+
readonly expand?: string
|
|
520
532
|
}
|
|
521
533
|
|
|
522
534
|
/**
|
|
@@ -533,21 +545,28 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
533
545
|
readonly authorization?: string
|
|
534
546
|
|
|
535
547
|
/**
|
|
536
|
-
*
|
|
548
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
549
|
+
* @type {number}
|
|
550
|
+
* @memberof CategoriesApiListCategories
|
|
551
|
+
*/
|
|
552
|
+
readonly pageSize?: number
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
537
556
|
* @type {string}
|
|
538
557
|
* @memberof CategoriesApiListCategories
|
|
539
558
|
*/
|
|
540
|
-
readonly
|
|
559
|
+
readonly pageToken?: string
|
|
541
560
|
|
|
542
561
|
/**
|
|
543
|
-
*
|
|
562
|
+
* 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>
|
|
544
563
|
* @type {string}
|
|
545
564
|
* @memberof CategoriesApiListCategories
|
|
546
565
|
*/
|
|
547
|
-
readonly
|
|
566
|
+
readonly filter?: string
|
|
548
567
|
|
|
549
568
|
/**
|
|
550
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields:
|
|
569
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
551
570
|
* @type {string}
|
|
552
571
|
* @memberof CategoriesApiListCategories
|
|
553
572
|
*/
|
|
@@ -566,6 +585,13 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
566
585
|
* @memberof CategoriesApiListCategories
|
|
567
586
|
*/
|
|
568
587
|
readonly expand?: string
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* 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>
|
|
591
|
+
* @type {string}
|
|
592
|
+
* @memberof CategoriesApiListCategories
|
|
593
|
+
*/
|
|
594
|
+
readonly filters?: string
|
|
569
595
|
}
|
|
570
596
|
|
|
571
597
|
/**
|
|
@@ -604,7 +630,7 @@ export interface CategoriesApiPatchCategoryRequest {
|
|
|
604
630
|
*/
|
|
605
631
|
export class CategoriesApi extends BaseAPI {
|
|
606
632
|
/**
|
|
607
|
-
* This will create a category.
|
|
633
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
608
634
|
* @summary Create the category
|
|
609
635
|
* @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
|
|
610
636
|
* @param {*} [options] Override http request option.
|
|
@@ -616,7 +642,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
616
642
|
}
|
|
617
643
|
|
|
618
644
|
/**
|
|
619
|
-
* This will delete a task category by code.
|
|
645
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
620
646
|
* @summary Delete the category
|
|
621
647
|
* @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
|
|
622
648
|
* @param {*} [options] Override http request option.
|
|
@@ -628,7 +654,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
628
654
|
}
|
|
629
655
|
|
|
630
656
|
/**
|
|
631
|
-
* Get category by code.
|
|
657
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
632
658
|
* @summary Retrieve the category
|
|
633
659
|
* @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
|
|
634
660
|
* @param {*} [options] Override http request option.
|
|
@@ -636,11 +662,11 @@ export class CategoriesApi extends BaseAPI {
|
|
|
636
662
|
* @memberof CategoriesApi
|
|
637
663
|
*/
|
|
638
664
|
public getCategory(requestParameters: CategoriesApiGetCategoryRequest, options?: AxiosRequestConfig) {
|
|
639
|
-
return CategoriesApiFp(this.configuration).getCategory(requestParameters.code, requestParameters.
|
|
665
|
+
return CategoriesApiFp(this.configuration).getCategory(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
640
666
|
}
|
|
641
667
|
|
|
642
668
|
/**
|
|
643
|
-
* Retrieves a list of categories.
|
|
669
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
644
670
|
* @summary List categories
|
|
645
671
|
* @param {CategoriesApiListCategoriesRequest} requestParameters Request parameters.
|
|
646
672
|
* @param {*} [options] Override http request option.
|
|
@@ -648,11 +674,11 @@ export class CategoriesApi extends BaseAPI {
|
|
|
648
674
|
* @memberof CategoriesApi
|
|
649
675
|
*/
|
|
650
676
|
public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
|
|
651
|
-
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.
|
|
677
|
+
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
652
678
|
}
|
|
653
679
|
|
|
654
680
|
/**
|
|
655
|
-
* This will partially update a category by code with the provided fields.
|
|
681
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
656
682
|
* @summary Update the category
|
|
657
683
|
* @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
|
|
658
684
|
* @param {*} [options] Override http request option.
|
package/api/default-api.ts
CHANGED
|
@@ -37,7 +37,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
39
|
check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
|
-
const localVarPath = `/
|
|
40
|
+
const localVarPath = `/taskservice/health`;
|
|
41
41
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42
42
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43
43
|
let baseOptions;
|
package/api/hub-spot-api.ts
CHANGED
|
@@ -31,7 +31,7 @@ import { CreateHubSpotTicketResponseClass } from '../models';
|
|
|
31
31
|
export const HubSpotApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
|
-
* This will create hub spot ticket.
|
|
34
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
35
35
|
* @summary Create the hub spot ticket
|
|
36
36
|
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
37
37
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -88,7 +88,7 @@ export const HubSpotApiFp = function(configuration?: Configuration) {
|
|
|
88
88
|
const localVarAxiosParamCreator = HubSpotApiAxiosParamCreator(configuration)
|
|
89
89
|
return {
|
|
90
90
|
/**
|
|
91
|
-
* This will create hub spot ticket.
|
|
91
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
92
92
|
* @summary Create the hub spot ticket
|
|
93
93
|
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
94
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -110,7 +110,7 @@ export const HubSpotApiFactory = function (configuration?: Configuration, basePa
|
|
|
110
110
|
const localVarFp = HubSpotApiFp(configuration)
|
|
111
111
|
return {
|
|
112
112
|
/**
|
|
113
|
-
* This will create hub spot ticket.
|
|
113
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
114
114
|
* @summary Create the hub spot ticket
|
|
115
115
|
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -152,7 +152,7 @@ export interface HubSpotApiCreateHubSpotTicketRequest {
|
|
|
152
152
|
*/
|
|
153
153
|
export class HubSpotApi extends BaseAPI {
|
|
154
154
|
/**
|
|
155
|
-
* This will create hub spot ticket.
|
|
155
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
156
156
|
* @summary Create the hub spot ticket
|
|
157
157
|
* @param {HubSpotApiCreateHubSpotTicketRequest} requestParameters Request parameters.
|
|
158
158
|
* @param {*} [options] Override http request option.
|