@emilgroup/task-sdk-node 1.7.1-beta.3 → 1.7.1-beta.31

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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/filters-api.ts +131 -24
  4. package/api/task-client-api.ts +257 -8
  5. package/api/tasks-api.ts +257 -8
  6. package/dist/api/filters-api.d.ts +81 -24
  7. package/dist/api/filters-api.js +112 -19
  8. package/dist/api/task-client-api.d.ts +148 -8
  9. package/dist/api/task-client-api.js +209 -6
  10. package/dist/api/tasks-api.d.ts +148 -8
  11. package/dist/api/tasks-api.js +209 -6
  12. package/dist/models/add-secondary-link-response-class.d.ts +25 -0
  13. package/dist/models/add-secondary-link-response-class.js +15 -0
  14. package/dist/models/create-task-request-dto.d.ts +13 -0
  15. package/dist/models/dry-run-filter-clause-class.d.ts +42 -0
  16. package/dist/models/dry-run-filter-clause-class.js +15 -0
  17. package/dist/models/dry-run-filter-request-dto.d.ts +30 -0
  18. package/dist/models/dry-run-filter-request-dto.js +15 -0
  19. package/dist/models/dry-run-filter-response-class.d.ts +37 -0
  20. package/dist/models/dry-run-filter-response-class.js +15 -0
  21. package/dist/models/entity-ref-class.d.ts +34 -0
  22. package/dist/models/entity-ref-class.js +19 -0
  23. package/dist/models/entity-ref-dto.d.ts +34 -0
  24. package/dist/models/entity-ref-dto.js +19 -0
  25. package/dist/models/index.d.ts +8 -0
  26. package/dist/models/index.js +8 -0
  27. package/dist/models/patch-task-request-dto.d.ts +12 -0
  28. package/dist/models/remove-secondary-link-response-class.d.ts +25 -0
  29. package/dist/models/remove-secondary-link-response-class.js +15 -0
  30. package/dist/models/secondary-link-class.d.ts +31 -0
  31. package/dist/models/secondary-link-class.js +15 -0
  32. package/dist/models/task-class.d.ts +7 -0
  33. package/models/add-secondary-link-response-class.ts +31 -0
  34. package/models/create-task-request-dto.ts +13 -0
  35. package/models/dry-run-filter-clause-class.ts +48 -0
  36. package/models/dry-run-filter-request-dto.ts +36 -0
  37. package/models/dry-run-filter-response-class.ts +43 -0
  38. package/models/entity-ref-class.ts +43 -0
  39. package/models/entity-ref-dto.ts +43 -0
  40. package/models/index.ts +8 -0
  41. package/models/patch-task-request-dto.ts +12 -0
  42. package/models/remove-secondary-link-response-class.ts +31 -0
  43. package/models/secondary-link-class.ts +37 -0
  44. package/models/task-class.ts +7 -0
  45. package/package.json +1 -1
@@ -193,6 +193,55 @@ var FiltersApiAxiosParamCreator = function (configuration) {
193
193
  });
194
194
  });
195
195
  },
196
+ /**
197
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
198
+ * @summary Create the filter dry-run
199
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
200
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
205
+ if (options === void 0) { options = {}; }
206
+ return __awaiter(_this, void 0, void 0, function () {
207
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
208
+ return __generator(this, function (_a) {
209
+ switch (_a.label) {
210
+ case 0:
211
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
212
+ (0, common_1.assertParamExists)('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto);
213
+ localVarPath = "/taskservice/v1/filters/dry-run";
214
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
215
+ if (configuration) {
216
+ baseOptions = configuration.baseOptions;
217
+ baseAccessToken = configuration.accessToken;
218
+ }
219
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
220
+ localVarHeaderParameter = {};
221
+ localVarQueryParameter = {};
222
+ // authentication bearer required
223
+ // http bearer authentication required
224
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
225
+ case 1:
226
+ // authentication bearer required
227
+ // http bearer authentication required
228
+ _a.sent();
229
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
230
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
231
+ }
232
+ localVarHeaderParameter['Content-Type'] = 'application/json';
233
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
234
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
235
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
236
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dryRunFilterRequestDto, localVarRequestOptions, configuration);
237
+ return [2 /*return*/, {
238
+ url: (0, common_1.toPathString)(localVarUrlObj),
239
+ options: localVarRequestOptions,
240
+ }];
241
+ }
242
+ });
243
+ });
244
+ },
196
245
  /**
197
246
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
198
247
  * @summary Retrieve the filter
@@ -242,16 +291,16 @@ var FiltersApiAxiosParamCreator = function (configuration) {
242
291
  });
243
292
  },
244
293
  /**
245
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
294
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
246
295
  * @summary List filters
247
296
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
248
297
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
249
298
  * @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.
250
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
251
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
252
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
253
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
254
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
299
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
300
+ * @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>
301
+ * @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, priority</i>
302
+ * @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/>
303
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
255
304
  * @param {*} [options] Override http request option.
256
305
  * @throws {RequiredError}
257
306
  */
@@ -418,6 +467,27 @@ var FiltersApiFp = function (configuration) {
418
467
  });
419
468
  });
420
469
  },
470
+ /**
471
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
472
+ * @summary Create the filter dry-run
473
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
474
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
475
+ * @param {*} [options] Override http request option.
476
+ * @throws {RequiredError}
477
+ */
478
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
479
+ return __awaiter(this, void 0, void 0, function () {
480
+ var localVarAxiosArgs;
481
+ return __generator(this, function (_a) {
482
+ switch (_a.label) {
483
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options)];
484
+ case 1:
485
+ localVarAxiosArgs = _a.sent();
486
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
487
+ }
488
+ });
489
+ });
490
+ },
421
491
  /**
422
492
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
423
493
  * @summary Retrieve the filter
@@ -440,16 +510,16 @@ var FiltersApiFp = function (configuration) {
440
510
  });
441
511
  },
442
512
  /**
443
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
513
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
444
514
  * @summary List filters
445
515
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
446
516
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
447
517
  * @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.
448
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
449
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
450
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
451
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
452
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
518
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
519
+ * @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>
520
+ * @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, priority</i>
521
+ * @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/>
522
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
453
523
  * @param {*} [options] Override http request option.
454
524
  * @throws {RequiredError}
455
525
  */
@@ -520,6 +590,17 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
520
590
  deleteFilter: function (code, authorization, options) {
521
591
  return localVarFp.deleteFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
522
592
  },
593
+ /**
594
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
595
+ * @summary Create the filter dry-run
596
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
597
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
602
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
603
+ },
523
604
  /**
524
605
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
525
606
  * @summary Retrieve the filter
@@ -532,16 +613,16 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
532
613
  return localVarFp.getFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
533
614
  },
534
615
  /**
535
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
616
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
536
617
  * @summary List filters
537
618
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
538
619
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
620
  * @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.
540
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
542
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
543
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
544
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
621
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
622
+ * @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>
623
+ * @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, priority</i>
624
+ * @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/>
625
+ * @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, targetUserGroupCode, isActive, isFallback, priority</i>
545
626
  * @param {*} [options] Override http request option.
546
627
  * @throws {RequiredError}
547
628
  */
@@ -598,6 +679,18 @@ var FiltersApi = /** @class */ (function (_super) {
598
679
  var _this = this;
599
680
  return (0, exports.FiltersApiFp)(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
600
681
  };
682
+ /**
683
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
684
+ * @summary Create the filter dry-run
685
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
686
+ * @param {*} [options] Override http request option.
687
+ * @throws {RequiredError}
688
+ * @memberof FiltersApi
689
+ */
690
+ FiltersApi.prototype.dryRunFilter = function (requestParameters, options) {
691
+ var _this = this;
692
+ return (0, exports.FiltersApiFp)(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
693
+ };
601
694
  /**
602
695
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
603
696
  * @summary Retrieve the filter
@@ -611,7 +704,7 @@ var FiltersApi = /** @class */ (function (_super) {
611
704
  return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
612
705
  };
613
706
  /**
614
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
707
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
615
708
  * @summary List filters
616
709
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
617
710
  * @param {*} [options] Override http request option.
@@ -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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
190
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
178
191
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
181
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
194
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
392
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
359
393
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
362
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
396
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
594
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
540
595
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
543
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
598
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
1020
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
1044
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
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, {}>>;
1041
1172
  /**
1042
1173
  * This will create a category. **Required Permissions** \"task-management.tasks.create\"
1043
1174
  * @summary Create the category
@@ -1191,4 +1322,13 @@ export declare class TaskClientApi extends BaseAPI {
1191
1322
  * @memberof TaskClientApi
1192
1323
  */
1193
1324
  patchTask(requestParameters: TaskClientApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, 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, {}>>;
1194
1334
  }