@emilgroup/task-sdk-node 1.7.1-beta.4 → 1.7.1-beta.41
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/assignees-api.ts +4 -2
- package/api/categories-api.ts +20 -10
- package/api/filters-api.ts +153 -34
- package/api/hub-spot-api.ts +4 -2
- package/api/reminders-api.ts +28 -14
- package/api/statuses-api.ts +20 -10
- package/api/task-client-api.ts +329 -42
- package/api/tasks-api.ts +281 -18
- package/common.ts +3 -2
- package/dist/api/assignees-api.d.ts +1 -1
- package/dist/api/assignees-api.js +4 -3
- package/dist/api/categories-api.d.ts +5 -5
- package/dist/api/categories-api.js +29 -18
- package/dist/api/filters-api.d.ts +86 -29
- package/dist/api/filters-api.js +147 -38
- package/dist/api/health-api.d.ts +1 -1
- package/dist/api/hub-spot-api.d.ts +1 -1
- package/dist/api/hub-spot-api.js +7 -4
- package/dist/api/reminders-api.d.ts +7 -7
- package/dist/api/reminders-api.js +40 -25
- package/dist/api/statuses-api.d.ts +5 -5
- package/dist/api/statuses-api.js +29 -18
- package/dist/api/task-client-api.d.ts +165 -25
- package/dist/api/task-client-api.js +313 -67
- package/dist/api/tasks-api.d.ts +153 -13
- package/dist/api/tasks-api.js +244 -24
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- 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 +2 -2
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AddSecondaryLinkResponseClass } from '../models';
|
|
15
16
|
import { CreateCategoryRequestDto } from '../models';
|
|
16
17
|
import { CreateCategoryResponseClass } from '../models';
|
|
17
18
|
import { CreateHubSpotTicketRequestDto } from '../models';
|
|
@@ -20,6 +21,7 @@ import { CreateStatusRequestDto } from '../models';
|
|
|
20
21
|
import { CreateStatusResponseClass } from '../models';
|
|
21
22
|
import { CreateTaskRequestDto } from '../models';
|
|
22
23
|
import { CreateTaskResponseClass } from '../models';
|
|
24
|
+
import { EntityRefDto } from '../models';
|
|
23
25
|
import { GetCategoryResponseClass } from '../models';
|
|
24
26
|
import { GetStatusResponseClass } from '../models';
|
|
25
27
|
import { GetTaskResponseClass } from '../models';
|
|
@@ -33,11 +35,22 @@ import { PatchStatusRequestDto } from '../models';
|
|
|
33
35
|
import { PatchStatusResponseClass } from '../models';
|
|
34
36
|
import { PatchTaskRequestDto } from '../models';
|
|
35
37
|
import { PatchTaskResponseClass } from '../models';
|
|
38
|
+
import { RemoveSecondaryLinkResponseClass } from '../models';
|
|
36
39
|
/**
|
|
37
40
|
* TaskClientApi - axios parameter creator
|
|
38
41
|
* @export
|
|
39
42
|
*/
|
|
40
43
|
export declare const TaskClientApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
44
|
+
/**
|
|
45
|
+
* 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\"
|
|
46
|
+
* @summary Create the task secondary link
|
|
47
|
+
* @param {string} code
|
|
48
|
+
* @param {EntityRefDto} entityRefDto
|
|
49
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
addSecondaryLink: (code: string, entityRefDto: EntityRefDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
54
|
/**
|
|
42
55
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
43
56
|
* @summary Create the category
|
|
@@ -174,11 +187,11 @@ export declare const TaskClientApiAxiosParamCreator: (configuration?: Configurat
|
|
|
174
187
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
175
188
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
176
189
|
* @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.
|
|
177
|
-
* @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>
|
|
190
|
+
* @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>
|
|
178
191
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
179
192
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
|
|
180
193
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: categories, status<i>
|
|
181
|
-
* @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>
|
|
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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code</i>
|
|
182
195
|
* @param {*} [options] Override http request option.
|
|
183
196
|
* @throws {RequiredError}
|
|
184
197
|
*/
|
|
@@ -213,12 +226,33 @@ export declare const TaskClientApiAxiosParamCreator: (configuration?: Configurat
|
|
|
213
226
|
* @throws {RequiredError}
|
|
214
227
|
*/
|
|
215
228
|
patchTask: (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
229
|
+
/**
|
|
230
|
+
* 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\"
|
|
231
|
+
* @summary Delete the task secondary link
|
|
232
|
+
* @param {string} code
|
|
233
|
+
* @param {string} linkType
|
|
234
|
+
* @param {string} linkCode
|
|
235
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
removeSecondaryLink: (code: string, linkType: string, linkCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
216
240
|
};
|
|
217
241
|
/**
|
|
218
242
|
* TaskClientApi - functional programming interface
|
|
219
243
|
* @export
|
|
220
244
|
*/
|
|
221
245
|
export declare const TaskClientApiFp: (configuration?: Configuration) => {
|
|
246
|
+
/**
|
|
247
|
+
* 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\"
|
|
248
|
+
* @summary Create the task secondary link
|
|
249
|
+
* @param {string} code
|
|
250
|
+
* @param {EntityRefDto} entityRefDto
|
|
251
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
|
+
* @param {*} [options] Override http request option.
|
|
253
|
+
* @throws {RequiredError}
|
|
254
|
+
*/
|
|
255
|
+
addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSecondaryLinkResponseClass>>;
|
|
222
256
|
/**
|
|
223
257
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
224
258
|
* @summary Create the category
|
|
@@ -355,11 +389,11 @@ export declare const TaskClientApiFp: (configuration?: Configuration) => {
|
|
|
355
389
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
356
390
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
357
391
|
* @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.
|
|
358
|
-
* @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>
|
|
392
|
+
* @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>
|
|
359
393
|
* @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>
|
|
360
394
|
* @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>
|
|
361
395
|
* @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>
|
|
362
|
-
* @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>
|
|
396
|
+
* @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>
|
|
363
397
|
* @param {*} [options] Override http request option.
|
|
364
398
|
* @throws {RequiredError}
|
|
365
399
|
*/
|
|
@@ -394,12 +428,33 @@ export declare const TaskClientApiFp: (configuration?: Configuration) => {
|
|
|
394
428
|
* @throws {RequiredError}
|
|
395
429
|
*/
|
|
396
430
|
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>>;
|
|
431
|
+
/**
|
|
432
|
+
* 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\"
|
|
433
|
+
* @summary Delete the task secondary link
|
|
434
|
+
* @param {string} code
|
|
435
|
+
* @param {string} linkType
|
|
436
|
+
* @param {string} linkCode
|
|
437
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
*/
|
|
441
|
+
removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveSecondaryLinkResponseClass>>;
|
|
397
442
|
};
|
|
398
443
|
/**
|
|
399
444
|
* TaskClientApi - factory interface
|
|
400
445
|
* @export
|
|
401
446
|
*/
|
|
402
447
|
export declare const TaskClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
448
|
+
/**
|
|
449
|
+
* 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\"
|
|
450
|
+
* @summary Create the task secondary link
|
|
451
|
+
* @param {string} code
|
|
452
|
+
* @param {EntityRefDto} entityRefDto
|
|
453
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
454
|
+
* @param {*} [options] Override http request option.
|
|
455
|
+
* @throws {RequiredError}
|
|
456
|
+
*/
|
|
457
|
+
addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: any): AxiosPromise<AddSecondaryLinkResponseClass>;
|
|
403
458
|
/**
|
|
404
459
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
405
460
|
* @summary Create the category
|
|
@@ -536,11 +591,11 @@ export declare const TaskClientApiFactory: (configuration?: Configuration, baseP
|
|
|
536
591
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
537
592
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
538
593
|
* @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.
|
|
539
|
-
* @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>
|
|
594
|
+
* @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>
|
|
540
595
|
* @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>
|
|
541
596
|
* @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>
|
|
542
597
|
* @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>
|
|
543
|
-
* @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>
|
|
598
|
+
* @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>
|
|
544
599
|
* @param {*} [options] Override http request option.
|
|
545
600
|
* @throws {RequiredError}
|
|
546
601
|
*/
|
|
@@ -575,7 +630,43 @@ export declare const TaskClientApiFactory: (configuration?: Configuration, baseP
|
|
|
575
630
|
* @throws {RequiredError}
|
|
576
631
|
*/
|
|
577
632
|
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass>;
|
|
633
|
+
/**
|
|
634
|
+
* 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\"
|
|
635
|
+
* @summary Delete the task secondary link
|
|
636
|
+
* @param {string} code
|
|
637
|
+
* @param {string} linkType
|
|
638
|
+
* @param {string} linkCode
|
|
639
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
640
|
+
* @param {*} [options] Override http request option.
|
|
641
|
+
* @throws {RequiredError}
|
|
642
|
+
*/
|
|
643
|
+
removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: any): AxiosPromise<RemoveSecondaryLinkResponseClass>;
|
|
578
644
|
};
|
|
645
|
+
/**
|
|
646
|
+
* Request parameters for addSecondaryLink operation in TaskClientApi.
|
|
647
|
+
* @export
|
|
648
|
+
* @interface TaskClientApiAddSecondaryLinkRequest
|
|
649
|
+
*/
|
|
650
|
+
export interface TaskClientApiAddSecondaryLinkRequest {
|
|
651
|
+
/**
|
|
652
|
+
*
|
|
653
|
+
* @type {string}
|
|
654
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
655
|
+
*/
|
|
656
|
+
readonly code: string;
|
|
657
|
+
/**
|
|
658
|
+
*
|
|
659
|
+
* @type {EntityRefDto}
|
|
660
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
661
|
+
*/
|
|
662
|
+
readonly entityRefDto: EntityRefDto;
|
|
663
|
+
/**
|
|
664
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
665
|
+
* @type {string}
|
|
666
|
+
* @memberof TaskClientApiAddSecondaryLink
|
|
667
|
+
*/
|
|
668
|
+
readonly authorization?: string;
|
|
669
|
+
}
|
|
579
670
|
/**
|
|
580
671
|
* Request parameters for createCategory operation in TaskClientApi.
|
|
581
672
|
* @export
|
|
@@ -926,7 +1017,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
926
1017
|
*/
|
|
927
1018
|
readonly pageToken?: string;
|
|
928
1019
|
/**
|
|
929
|
-
* 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>
|
|
1020
|
+
* 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>
|
|
930
1021
|
* @type {string}
|
|
931
1022
|
* @memberof TaskClientApiListTasks
|
|
932
1023
|
*/
|
|
@@ -950,7 +1041,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
950
1041
|
*/
|
|
951
1042
|
readonly expand?: string;
|
|
952
1043
|
/**
|
|
953
|
-
* 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>
|
|
1044
|
+
* 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>
|
|
954
1045
|
* @type {string}
|
|
955
1046
|
* @memberof TaskClientApiListTasks
|
|
956
1047
|
*/
|
|
@@ -1031,6 +1122,37 @@ export interface TaskClientApiPatchTaskRequest {
|
|
|
1031
1122
|
*/
|
|
1032
1123
|
readonly authorization?: string;
|
|
1033
1124
|
}
|
|
1125
|
+
/**
|
|
1126
|
+
* Request parameters for removeSecondaryLink operation in TaskClientApi.
|
|
1127
|
+
* @export
|
|
1128
|
+
* @interface TaskClientApiRemoveSecondaryLinkRequest
|
|
1129
|
+
*/
|
|
1130
|
+
export interface TaskClientApiRemoveSecondaryLinkRequest {
|
|
1131
|
+
/**
|
|
1132
|
+
*
|
|
1133
|
+
* @type {string}
|
|
1134
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
1135
|
+
*/
|
|
1136
|
+
readonly code: string;
|
|
1137
|
+
/**
|
|
1138
|
+
*
|
|
1139
|
+
* @type {string}
|
|
1140
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
1141
|
+
*/
|
|
1142
|
+
readonly linkType: string;
|
|
1143
|
+
/**
|
|
1144
|
+
*
|
|
1145
|
+
* @type {string}
|
|
1146
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
1147
|
+
*/
|
|
1148
|
+
readonly linkCode: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1151
|
+
* @type {string}
|
|
1152
|
+
* @memberof TaskClientApiRemoveSecondaryLink
|
|
1153
|
+
*/
|
|
1154
|
+
readonly authorization?: string;
|
|
1155
|
+
}
|
|
1034
1156
|
/**
|
|
1035
1157
|
* TaskClientApi - object-oriented interface
|
|
1036
1158
|
* @export
|
|
@@ -1038,6 +1160,15 @@ export interface TaskClientApiPatchTaskRequest {
|
|
|
1038
1160
|
* @extends {BaseAPI}
|
|
1039
1161
|
*/
|
|
1040
1162
|
export declare class TaskClientApi extends BaseAPI {
|
|
1163
|
+
/**
|
|
1164
|
+
* 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\"
|
|
1165
|
+
* @summary Create the task secondary link
|
|
1166
|
+
* @param {TaskClientApiAddSecondaryLinkRequest} requestParameters Request parameters.
|
|
1167
|
+
* @param {*} [options] Override http request option.
|
|
1168
|
+
* @throws {RequiredError}
|
|
1169
|
+
* @memberof TaskClientApi
|
|
1170
|
+
*/
|
|
1171
|
+
addSecondaryLink(requestParameters: TaskClientApiAddSecondaryLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddSecondaryLinkResponseClass, any, {}, any>>;
|
|
1041
1172
|
/**
|
|
1042
1173
|
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
1043
1174
|
* @summary Create the category
|
|
@@ -1046,7 +1177,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1046
1177
|
* @throws {RequiredError}
|
|
1047
1178
|
* @memberof TaskClientApi
|
|
1048
1179
|
*/
|
|
1049
|
-
createCategory(requestParameters: TaskClientApiCreateCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCategoryResponseClass, any, {}>>;
|
|
1180
|
+
createCategory(requestParameters: TaskClientApiCreateCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCategoryResponseClass, any, {}, any>>;
|
|
1050
1181
|
/**
|
|
1051
1182
|
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
1052
1183
|
* @summary Create the hub spot ticket
|
|
@@ -1055,7 +1186,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1055
1186
|
* @throws {RequiredError}
|
|
1056
1187
|
* @memberof TaskClientApi
|
|
1057
1188
|
*/
|
|
1058
|
-
createHubSpotTicket(requestParameters: TaskClientApiCreateHubSpotTicketRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateHubSpotTicketResponseClass, any, {}>>;
|
|
1189
|
+
createHubSpotTicket(requestParameters: TaskClientApiCreateHubSpotTicketRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateHubSpotTicketResponseClass, any, {}, any>>;
|
|
1059
1190
|
/**
|
|
1060
1191
|
* This will create a status. **Required Permissions** \"task-management.tasks.create\"
|
|
1061
1192
|
* @summary Create the status
|
|
@@ -1064,7 +1195,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1064
1195
|
* @throws {RequiredError}
|
|
1065
1196
|
* @memberof TaskClientApi
|
|
1066
1197
|
*/
|
|
1067
|
-
createStatus(requestParameters: TaskClientApiCreateStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStatusResponseClass, any, {}>>;
|
|
1198
|
+
createStatus(requestParameters: TaskClientApiCreateStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStatusResponseClass, any, {}, any>>;
|
|
1068
1199
|
/**
|
|
1069
1200
|
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
1070
1201
|
* @summary Create the task
|
|
@@ -1073,7 +1204,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1073
1204
|
* @throws {RequiredError}
|
|
1074
1205
|
* @memberof TaskClientApi
|
|
1075
1206
|
*/
|
|
1076
|
-
createTask(requestParameters: TaskClientApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}>>;
|
|
1207
|
+
createTask(requestParameters: TaskClientApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}, any>>;
|
|
1077
1208
|
/**
|
|
1078
1209
|
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
1079
1210
|
* @summary Delete the category
|
|
@@ -1082,7 +1213,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1082
1213
|
* @throws {RequiredError}
|
|
1083
1214
|
* @memberof TaskClientApi
|
|
1084
1215
|
*/
|
|
1085
|
-
deleteCategory(requestParameters: TaskClientApiDeleteCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1216
|
+
deleteCategory(requestParameters: TaskClientApiDeleteCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
1086
1217
|
/**
|
|
1087
1218
|
* This will delete status. **Required Permissions** \"task-management.tasks.delete\"
|
|
1088
1219
|
* @summary Delete the status
|
|
@@ -1091,7 +1222,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1091
1222
|
* @throws {RequiredError}
|
|
1092
1223
|
* @memberof TaskClientApi
|
|
1093
1224
|
*/
|
|
1094
|
-
deleteStatus(requestParameters: TaskClientApiDeleteStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1225
|
+
deleteStatus(requestParameters: TaskClientApiDeleteStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
1095
1226
|
/**
|
|
1096
1227
|
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
1097
1228
|
* @summary Delete the task
|
|
@@ -1100,7 +1231,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1100
1231
|
* @throws {RequiredError}
|
|
1101
1232
|
* @memberof TaskClientApi
|
|
1102
1233
|
*/
|
|
1103
|
-
deleteTask(requestParameters: TaskClientApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1234
|
+
deleteTask(requestParameters: TaskClientApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
1104
1235
|
/**
|
|
1105
1236
|
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1106
1237
|
* @summary Retrieve the category
|
|
@@ -1109,7 +1240,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1109
1240
|
* @throws {RequiredError}
|
|
1110
1241
|
* @memberof TaskClientApi
|
|
1111
1242
|
*/
|
|
1112
|
-
getCategory(requestParameters: TaskClientApiGetCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCategoryResponseClass, any, {}>>;
|
|
1243
|
+
getCategory(requestParameters: TaskClientApiGetCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCategoryResponseClass, any, {}, any>>;
|
|
1113
1244
|
/**
|
|
1114
1245
|
* Get status by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1115
1246
|
* @summary Retrieve the status
|
|
@@ -1118,7 +1249,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1118
1249
|
* @throws {RequiredError}
|
|
1119
1250
|
* @memberof TaskClientApi
|
|
1120
1251
|
*/
|
|
1121
|
-
getStatus(requestParameters: TaskClientApiGetStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatusResponseClass, any, {}>>;
|
|
1252
|
+
getStatus(requestParameters: TaskClientApiGetStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatusResponseClass, any, {}, any>>;
|
|
1122
1253
|
/**
|
|
1123
1254
|
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1124
1255
|
* @summary Retrieve the task
|
|
@@ -1127,7 +1258,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1127
1258
|
* @throws {RequiredError}
|
|
1128
1259
|
* @memberof TaskClientApi
|
|
1129
1260
|
*/
|
|
1130
|
-
getTask(requestParameters: TaskClientApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponseClass, any, {}>>;
|
|
1261
|
+
getTask(requestParameters: TaskClientApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponseClass, any, {}, any>>;
|
|
1131
1262
|
/**
|
|
1132
1263
|
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
1133
1264
|
* @summary List assignees
|
|
@@ -1136,7 +1267,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1136
1267
|
* @throws {RequiredError}
|
|
1137
1268
|
* @memberof TaskClientApi
|
|
1138
1269
|
*/
|
|
1139
|
-
listAssignees(requestParameters?: TaskClientApiListAssigneesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAssigneesResponseClass, any, {}>>;
|
|
1270
|
+
listAssignees(requestParameters?: TaskClientApiListAssigneesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAssigneesResponseClass, any, {}, any>>;
|
|
1140
1271
|
/**
|
|
1141
1272
|
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
1142
1273
|
* @summary List categories
|
|
@@ -1145,7 +1276,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1145
1276
|
* @throws {RequiredError}
|
|
1146
1277
|
* @memberof TaskClientApi
|
|
1147
1278
|
*/
|
|
1148
|
-
listCategories(requestParameters?: TaskClientApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}>>;
|
|
1279
|
+
listCategories(requestParameters?: TaskClientApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}, any>>;
|
|
1149
1280
|
/**
|
|
1150
1281
|
* Retrieves a list of statuses. **Required Permissions** \"task-management.tasks.view\"
|
|
1151
1282
|
* @summary List statuses
|
|
@@ -1154,7 +1285,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1154
1285
|
* @throws {RequiredError}
|
|
1155
1286
|
* @memberof TaskClientApi
|
|
1156
1287
|
*/
|
|
1157
|
-
listStatuses(requestParameters?: TaskClientApiListStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatusesResponseClass, any, {}>>;
|
|
1288
|
+
listStatuses(requestParameters?: TaskClientApiListStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatusesResponseClass, any, {}, any>>;
|
|
1158
1289
|
/**
|
|
1159
1290
|
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
1160
1291
|
* @summary List tasks
|
|
@@ -1163,7 +1294,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1163
1294
|
* @throws {RequiredError}
|
|
1164
1295
|
* @memberof TaskClientApi
|
|
1165
1296
|
*/
|
|
1166
|
-
listTasks(requestParameters?: TaskClientApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
|
|
1297
|
+
listTasks(requestParameters?: TaskClientApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}, any>>;
|
|
1167
1298
|
/**
|
|
1168
1299
|
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1169
1300
|
* @summary Update the category
|
|
@@ -1172,7 +1303,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1172
1303
|
* @throws {RequiredError}
|
|
1173
1304
|
* @memberof TaskClientApi
|
|
1174
1305
|
*/
|
|
1175
|
-
patchCategory(requestParameters: TaskClientApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}>>;
|
|
1306
|
+
patchCategory(requestParameters: TaskClientApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}, any>>;
|
|
1176
1307
|
/**
|
|
1177
1308
|
* This will partially update a status by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1178
1309
|
* @summary Update the status
|
|
@@ -1181,7 +1312,7 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1181
1312
|
* @throws {RequiredError}
|
|
1182
1313
|
* @memberof TaskClientApi
|
|
1183
1314
|
*/
|
|
1184
|
-
patchStatus(requestParameters: TaskClientApiPatchStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchStatusResponseClass, any, {}>>;
|
|
1315
|
+
patchStatus(requestParameters: TaskClientApiPatchStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchStatusResponseClass, any, {}, any>>;
|
|
1185
1316
|
/**
|
|
1186
1317
|
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1187
1318
|
* @summary Update the task
|
|
@@ -1190,5 +1321,14 @@ export declare class TaskClientApi extends BaseAPI {
|
|
|
1190
1321
|
* @throws {RequiredError}
|
|
1191
1322
|
* @memberof TaskClientApi
|
|
1192
1323
|
*/
|
|
1193
|
-
patchTask(requestParameters: TaskClientApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}>>;
|
|
1324
|
+
patchTask(requestParameters: TaskClientApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}, any>>;
|
|
1325
|
+
/**
|
|
1326
|
+
* 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\"
|
|
1327
|
+
* @summary Delete the task secondary link
|
|
1328
|
+
* @param {TaskClientApiRemoveSecondaryLinkRequest} requestParameters Request parameters.
|
|
1329
|
+
* @param {*} [options] Override http request option.
|
|
1330
|
+
* @throws {RequiredError}
|
|
1331
|
+
* @memberof TaskClientApi
|
|
1332
|
+
*/
|
|
1333
|
+
removeSecondaryLink(requestParameters: TaskClientApiRemoveSecondaryLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoveSecondaryLinkResponseClass, any, {}, any>>;
|
|
1194
1334
|
}
|