@emilgroup/task-sdk-node 1.7.1-beta.3 → 1.7.1-beta.30
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 +8 -0
- package/README.md +2 -2
- package/api/filters-api.ts +131 -24
- package/api/task-client-api.ts +257 -8
- package/api/tasks-api.ts +257 -8
- package/dist/api/filters-api.d.ts +81 -24
- package/dist/api/filters-api.js +112 -19
- package/dist/api/task-client-api.d.ts +148 -8
- package/dist/api/task-client-api.js +209 -6
- package/dist/api/tasks-api.d.ts +148 -8
- package/dist/api/tasks-api.js +209 -6
- package/dist/models/add-secondary-link-response-class.d.ts +25 -0
- package/dist/models/add-secondary-link-response-class.js +15 -0
- package/dist/models/create-task-request-dto.d.ts +13 -0
- package/dist/models/dry-run-filter-clause-class.d.ts +42 -0
- package/dist/models/dry-run-filter-clause-class.js +15 -0
- package/dist/models/dry-run-filter-request-dto.d.ts +30 -0
- package/dist/models/dry-run-filter-request-dto.js +15 -0
- package/dist/models/dry-run-filter-response-class.d.ts +37 -0
- package/dist/models/dry-run-filter-response-class.js +15 -0
- package/dist/models/entity-ref-class.d.ts +34 -0
- package/dist/models/entity-ref-class.js +19 -0
- package/dist/models/entity-ref-dto.d.ts +34 -0
- package/dist/models/entity-ref-dto.js +19 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/patch-task-request-dto.d.ts +12 -0
- package/dist/models/remove-secondary-link-response-class.d.ts +25 -0
- package/dist/models/remove-secondary-link-response-class.js +15 -0
- package/dist/models/secondary-link-class.d.ts +31 -0
- package/dist/models/secondary-link-class.js +15 -0
- package/dist/models/task-class.d.ts +7 -0
- package/models/add-secondary-link-response-class.ts +31 -0
- package/models/create-task-request-dto.ts +13 -0
- package/models/dry-run-filter-clause-class.ts +48 -0
- package/models/dry-run-filter-request-dto.ts +36 -0
- package/models/dry-run-filter-response-class.ts +43 -0
- package/models/entity-ref-class.ts +43 -0
- package/models/entity-ref-dto.ts +43 -0
- package/models/index.ts +8 -0
- package/models/patch-task-request-dto.ts +12 -0
- package/models/remove-secondary-link-response-class.ts +31 -0
- package/models/secondary-link-class.ts +37 -0
- package/models/task-class.ts +7 -0
- package/package.json +1 -1
package/api/task-client-api.ts
CHANGED
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { AddSecondaryLinkResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { CreateCategoryRequestDto } from '../models';
|
|
25
27
|
// @ts-ignore
|
|
26
28
|
import { CreateCategoryResponseClass } from '../models';
|
|
@@ -37,6 +39,8 @@ import { CreateTaskRequestDto } from '../models';
|
|
|
37
39
|
// @ts-ignore
|
|
38
40
|
import { CreateTaskResponseClass } from '../models';
|
|
39
41
|
// @ts-ignore
|
|
42
|
+
import { EntityRefDto } from '../models';
|
|
43
|
+
// @ts-ignore
|
|
40
44
|
import { GetCategoryResponseClass } from '../models';
|
|
41
45
|
// @ts-ignore
|
|
42
46
|
import { GetStatusResponseClass } from '../models';
|
|
@@ -62,6 +66,8 @@ import { PatchStatusResponseClass } from '../models';
|
|
|
62
66
|
import { PatchTaskRequestDto } from '../models';
|
|
63
67
|
// @ts-ignore
|
|
64
68
|
import { PatchTaskResponseClass } from '../models';
|
|
69
|
+
// @ts-ignore
|
|
70
|
+
import { RemoveSecondaryLinkResponseClass } from '../models';
|
|
65
71
|
// URLSearchParams not necessarily used
|
|
66
72
|
// @ts-ignore
|
|
67
73
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -72,6 +78,57 @@ const FormData = require('form-data');
|
|
|
72
78
|
*/
|
|
73
79
|
export const TaskClientApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
74
80
|
return {
|
|
81
|
+
/**
|
|
82
|
+
* Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
83
|
+
* @summary Create the task secondary link
|
|
84
|
+
* @param {string} code
|
|
85
|
+
* @param {EntityRefDto} entityRefDto
|
|
86
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
addSecondaryLink: async (code: string, entityRefDto: EntityRefDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
91
|
+
// verify required parameter 'code' is not null or undefined
|
|
92
|
+
assertParamExists('addSecondaryLink', 'code', code)
|
|
93
|
+
// verify required parameter 'entityRefDto' is not null or undefined
|
|
94
|
+
assertParamExists('addSecondaryLink', 'entityRefDto', entityRefDto)
|
|
95
|
+
const localVarPath = `/taskservice/v1/tasks/{code}/secondary-links`
|
|
96
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
97
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
98
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
99
|
+
let baseOptions;
|
|
100
|
+
let baseAccessToken;
|
|
101
|
+
if (configuration) {
|
|
102
|
+
baseOptions = configuration.baseOptions;
|
|
103
|
+
baseAccessToken = configuration.accessToken;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
107
|
+
const localVarHeaderParameter = {} as any;
|
|
108
|
+
const localVarQueryParameter = {} as any;
|
|
109
|
+
|
|
110
|
+
// authentication bearer required
|
|
111
|
+
// http bearer authentication required
|
|
112
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
113
|
+
|
|
114
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
115
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
121
|
+
|
|
122
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
123
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
124
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
125
|
+
localVarRequestOptions.data = serializeDataIfNeeded(entityRefDto, localVarRequestOptions, configuration)
|
|
126
|
+
|
|
127
|
+
return {
|
|
128
|
+
url: toPathString(localVarUrlObj),
|
|
129
|
+
options: localVarRequestOptions,
|
|
130
|
+
};
|
|
131
|
+
},
|
|
75
132
|
/**
|
|
76
133
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
77
134
|
* @summary Create the category
|
|
@@ -739,11 +796,11 @@ export const TaskClientApiAxiosParamCreator = function (configuration?: Configur
|
|
|
739
796
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
740
797
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
741
798
|
* @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.
|
|
742
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
799
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
743
800
|
* @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: subject, description</i>
|
|
744
801
|
* @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, entityType, entityCode, status, priority</i>
|
|
745
802
|
* @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: categories, status<i>
|
|
746
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
803
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
747
804
|
* @param {*} [options] Override http request option.
|
|
748
805
|
* @throws {RequiredError}
|
|
749
806
|
*/
|
|
@@ -957,6 +1014,59 @@ export const TaskClientApiAxiosParamCreator = function (configuration?: Configur
|
|
|
957
1014
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
958
1015
|
localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
|
|
959
1016
|
|
|
1017
|
+
return {
|
|
1018
|
+
url: toPathString(localVarUrlObj),
|
|
1019
|
+
options: localVarRequestOptions,
|
|
1020
|
+
};
|
|
1021
|
+
},
|
|
1022
|
+
/**
|
|
1023
|
+
* Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
1024
|
+
* @summary Delete the task secondary link
|
|
1025
|
+
* @param {string} code
|
|
1026
|
+
* @param {string} linkType
|
|
1027
|
+
* @param {string} linkCode
|
|
1028
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1029
|
+
* @param {*} [options] Override http request option.
|
|
1030
|
+
* @throws {RequiredError}
|
|
1031
|
+
*/
|
|
1032
|
+
removeSecondaryLink: async (code: string, linkType: string, linkCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1033
|
+
// verify required parameter 'code' is not null or undefined
|
|
1034
|
+
assertParamExists('removeSecondaryLink', 'code', code)
|
|
1035
|
+
// verify required parameter 'linkType' is not null or undefined
|
|
1036
|
+
assertParamExists('removeSecondaryLink', 'linkType', linkType)
|
|
1037
|
+
// verify required parameter 'linkCode' is not null or undefined
|
|
1038
|
+
assertParamExists('removeSecondaryLink', 'linkCode', linkCode)
|
|
1039
|
+
const localVarPath = `/taskservice/v1/tasks/{code}/secondary-links/{linkType}/{linkCode}`
|
|
1040
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
1041
|
+
.replace(`{${"linkType"}}`, encodeURIComponent(String(linkType)))
|
|
1042
|
+
.replace(`{${"linkCode"}}`, encodeURIComponent(String(linkCode)));
|
|
1043
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1044
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1045
|
+
let baseOptions;
|
|
1046
|
+
let baseAccessToken;
|
|
1047
|
+
if (configuration) {
|
|
1048
|
+
baseOptions = configuration.baseOptions;
|
|
1049
|
+
baseAccessToken = configuration.accessToken;
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1053
|
+
const localVarHeaderParameter = {} as any;
|
|
1054
|
+
const localVarQueryParameter = {} as any;
|
|
1055
|
+
|
|
1056
|
+
// authentication bearer required
|
|
1057
|
+
// http bearer authentication required
|
|
1058
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1059
|
+
|
|
1060
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
1061
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
1062
|
+
}
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1067
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1068
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1069
|
+
|
|
960
1070
|
return {
|
|
961
1071
|
url: toPathString(localVarUrlObj),
|
|
962
1072
|
options: localVarRequestOptions,
|
|
@@ -972,6 +1082,19 @@ export const TaskClientApiAxiosParamCreator = function (configuration?: Configur
|
|
|
972
1082
|
export const TaskClientApiFp = function(configuration?: Configuration) {
|
|
973
1083
|
const localVarAxiosParamCreator = TaskClientApiAxiosParamCreator(configuration)
|
|
974
1084
|
return {
|
|
1085
|
+
/**
|
|
1086
|
+
* Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
1087
|
+
* @summary Create the task secondary link
|
|
1088
|
+
* @param {string} code
|
|
1089
|
+
* @param {EntityRefDto} entityRefDto
|
|
1090
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
*/
|
|
1094
|
+
async addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSecondaryLinkResponseClass>> {
|
|
1095
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addSecondaryLink(code, entityRefDto, authorization, options);
|
|
1096
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1097
|
+
},
|
|
975
1098
|
/**
|
|
976
1099
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
977
1100
|
* @summary Create the category
|
|
@@ -1147,11 +1270,11 @@ export const TaskClientApiFp = function(configuration?: Configuration) {
|
|
|
1147
1270
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1148
1271
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1149
1272
|
* @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.
|
|
1150
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
1273
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1151
1274
|
* @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: subject, description</i>
|
|
1152
1275
|
* @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, entityType, entityCode, status, priority</i>
|
|
1153
1276
|
* @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: categories, status<i>
|
|
1154
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
1277
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1155
1278
|
* @param {*} [options] Override http request option.
|
|
1156
1279
|
* @throws {RequiredError}
|
|
1157
1280
|
*/
|
|
@@ -1198,6 +1321,20 @@ export const TaskClientApiFp = function(configuration?: Configuration) {
|
|
|
1198
1321
|
const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
|
|
1199
1322
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1200
1323
|
},
|
|
1324
|
+
/**
|
|
1325
|
+
* Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
1326
|
+
* @summary Delete the task secondary link
|
|
1327
|
+
* @param {string} code
|
|
1328
|
+
* @param {string} linkType
|
|
1329
|
+
* @param {string} linkCode
|
|
1330
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1331
|
+
* @param {*} [options] Override http request option.
|
|
1332
|
+
* @throws {RequiredError}
|
|
1333
|
+
*/
|
|
1334
|
+
async removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveSecondaryLinkResponseClass>> {
|
|
1335
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeSecondaryLink(code, linkType, linkCode, authorization, options);
|
|
1336
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1337
|
+
},
|
|
1201
1338
|
}
|
|
1202
1339
|
};
|
|
1203
1340
|
|
|
@@ -1208,6 +1345,18 @@ export const TaskClientApiFp = function(configuration?: Configuration) {
|
|
|
1208
1345
|
export const TaskClientApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1209
1346
|
const localVarFp = TaskClientApiFp(configuration)
|
|
1210
1347
|
return {
|
|
1348
|
+
/**
|
|
1349
|
+
* Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
1350
|
+
* @summary Create the task secondary link
|
|
1351
|
+
* @param {string} code
|
|
1352
|
+
* @param {EntityRefDto} entityRefDto
|
|
1353
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1354
|
+
* @param {*} [options] Override http request option.
|
|
1355
|
+
* @throws {RequiredError}
|
|
1356
|
+
*/
|
|
1357
|
+
addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: any): AxiosPromise<AddSecondaryLinkResponseClass> {
|
|
1358
|
+
return localVarFp.addSecondaryLink(code, entityRefDto, authorization, options).then((request) => request(axios, basePath));
|
|
1359
|
+
},
|
|
1211
1360
|
/**
|
|
1212
1361
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
1213
1362
|
* @summary Create the category
|
|
@@ -1370,11 +1519,11 @@ export const TaskClientApiFactory = function (configuration?: Configuration, bas
|
|
|
1370
1519
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1371
1520
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1372
1521
|
* @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.
|
|
1373
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
1522
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1374
1523
|
* @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: subject, description</i>
|
|
1375
1524
|
* @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, entityType, entityCode, status, priority</i>
|
|
1376
1525
|
* @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: categories, status<i>
|
|
1377
|
-
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
1526
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1378
1527
|
* @param {*} [options] Override http request option.
|
|
1379
1528
|
* @throws {RequiredError}
|
|
1380
1529
|
*/
|
|
@@ -1417,9 +1566,50 @@ export const TaskClientApiFactory = function (configuration?: Configuration, bas
|
|
|
1417
1566
|
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
|
|
1418
1567
|
return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
1419
1568
|
},
|
|
1569
|
+
/**
|
|
1570
|
+
* Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
1571
|
+
* @summary Delete the task secondary link
|
|
1572
|
+
* @param {string} code
|
|
1573
|
+
* @param {string} linkType
|
|
1574
|
+
* @param {string} linkCode
|
|
1575
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1576
|
+
* @param {*} [options] Override http request option.
|
|
1577
|
+
* @throws {RequiredError}
|
|
1578
|
+
*/
|
|
1579
|
+
removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: any): AxiosPromise<RemoveSecondaryLinkResponseClass> {
|
|
1580
|
+
return localVarFp.removeSecondaryLink(code, linkType, linkCode, authorization, options).then((request) => request(axios, basePath));
|
|
1581
|
+
},
|
|
1420
1582
|
};
|
|
1421
1583
|
};
|
|
1422
1584
|
|
|
1585
|
+
/**
|
|
1586
|
+
* Request parameters for addSecondaryLink operation in TaskClientApi.
|
|
1587
|
+
* @export
|
|
1588
|
+
* @interface TaskClientApiAddSecondaryLinkRequest
|
|
1589
|
+
*/
|
|
1590
|
+
export interface TaskClientApiAddSecondaryLinkRequest {
|
|
1591
|
+
/**
|
|
1592
|
+
*
|
|
1593
|
+
* @type {string}
|
|
1594
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
1595
|
+
*/
|
|
1596
|
+
readonly code: string
|
|
1597
|
+
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @type {EntityRefDto}
|
|
1601
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
1602
|
+
*/
|
|
1603
|
+
readonly entityRefDto: EntityRefDto
|
|
1604
|
+
|
|
1605
|
+
/**
|
|
1606
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1607
|
+
* @type {string}
|
|
1608
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
1609
|
+
*/
|
|
1610
|
+
readonly authorization?: string
|
|
1611
|
+
}
|
|
1612
|
+
|
|
1423
1613
|
/**
|
|
1424
1614
|
* Request parameters for createCategory operation in TaskClientApi.
|
|
1425
1615
|
* @export
|
|
@@ -1812,7 +2002,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
1812
2002
|
readonly pageToken?: string
|
|
1813
2003
|
|
|
1814
2004
|
/**
|
|
1815
|
-
* 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
2005
|
+
* 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1816
2006
|
* @type {string}
|
|
1817
2007
|
* @memberof TaskClientApiListTasks
|
|
1818
2008
|
*/
|
|
@@ -1840,7 +2030,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
1840
2030
|
readonly expand?: string
|
|
1841
2031
|
|
|
1842
2032
|
/**
|
|
1843
|
-
* 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
2033
|
+
* 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
1844
2034
|
* @type {string}
|
|
1845
2035
|
* @memberof TaskClientApiListTasks
|
|
1846
2036
|
*/
|
|
@@ -1931,6 +2121,41 @@ export interface TaskClientApiPatchTaskRequest {
|
|
|
1931
2121
|
readonly authorization?: string
|
|
1932
2122
|
}
|
|
1933
2123
|
|
|
2124
|
+
/**
|
|
2125
|
+
* Request parameters for removeSecondaryLink operation in TaskClientApi.
|
|
2126
|
+
* @export
|
|
2127
|
+
* @interface TaskClientApiRemoveSecondaryLinkRequest
|
|
2128
|
+
*/
|
|
2129
|
+
export interface TaskClientApiRemoveSecondaryLinkRequest {
|
|
2130
|
+
/**
|
|
2131
|
+
*
|
|
2132
|
+
* @type {string}
|
|
2133
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
2134
|
+
*/
|
|
2135
|
+
readonly code: string
|
|
2136
|
+
|
|
2137
|
+
/**
|
|
2138
|
+
*
|
|
2139
|
+
* @type {string}
|
|
2140
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
2141
|
+
*/
|
|
2142
|
+
readonly linkType: string
|
|
2143
|
+
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
* @type {string}
|
|
2147
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
2148
|
+
*/
|
|
2149
|
+
readonly linkCode: string
|
|
2150
|
+
|
|
2151
|
+
/**
|
|
2152
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
2153
|
+
* @type {string}
|
|
2154
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
2155
|
+
*/
|
|
2156
|
+
readonly authorization?: string
|
|
2157
|
+
}
|
|
2158
|
+
|
|
1934
2159
|
/**
|
|
1935
2160
|
* TaskClientApi - object-oriented interface
|
|
1936
2161
|
* @export
|
|
@@ -1938,6 +2163,18 @@ export interface TaskClientApiPatchTaskRequest {
|
|
|
1938
2163
|
* @extends {BaseAPI}
|
|
1939
2164
|
*/
|
|
1940
2165
|
export class TaskClientApi extends BaseAPI {
|
|
2166
|
+
/**
|
|
2167
|
+
* Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
2168
|
+
* @summary Create the task secondary link
|
|
2169
|
+
* @param {TaskClientApiAddSecondaryLinkRequest} requestParameters Request parameters.
|
|
2170
|
+
* @param {*} [options] Override http request option.
|
|
2171
|
+
* @throws {RequiredError}
|
|
2172
|
+
* @memberof TaskClientApi
|
|
2173
|
+
*/
|
|
2174
|
+
public addSecondaryLink(requestParameters: TaskClientApiAddSecondaryLinkRequest, options?: AxiosRequestConfig) {
|
|
2175
|
+
return TaskClientApiFp(this.configuration).addSecondaryLink(requestParameters.code, requestParameters.entityRefDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
2176
|
+
}
|
|
2177
|
+
|
|
1941
2178
|
/**
|
|
1942
2179
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
1943
2180
|
* @summary Create the category
|
|
@@ -2141,4 +2378,16 @@ export class TaskClientApi extends BaseAPI {
|
|
|
2141
2378
|
public patchTask(requestParameters: TaskClientApiPatchTaskRequest, options?: AxiosRequestConfig) {
|
|
2142
2379
|
return TaskClientApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
2143
2380
|
}
|
|
2381
|
+
|
|
2382
|
+
/**
|
|
2383
|
+
* Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
|
|
2384
|
+
* @summary Delete the task secondary link
|
|
2385
|
+
* @param {TaskClientApiRemoveSecondaryLinkRequest} requestParameters Request parameters.
|
|
2386
|
+
* @param {*} [options] Override http request option.
|
|
2387
|
+
* @throws {RequiredError}
|
|
2388
|
+
* @memberof TaskClientApi
|
|
2389
|
+
*/
|
|
2390
|
+
public removeSecondaryLink(requestParameters: TaskClientApiRemoveSecondaryLinkRequest, options?: AxiosRequestConfig) {
|
|
2391
|
+
return TaskClientApiFp(this.configuration).removeSecondaryLink(requestParameters.code, requestParameters.linkType, requestParameters.linkCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
2392
|
+
}
|
|
2144
2393
|
}
|