@emilgroup/task-sdk-node 1.2.1-beta.1 → 1.2.1-beta.10

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.
@@ -5,10 +5,11 @@ README.md
5
5
  api.ts
6
6
  api/assignees-api.ts
7
7
  api/categories-api.ts
8
- api/default-api.ts
8
+ api/health-api.ts
9
9
  api/hub-spot-api.ts
10
10
  api/reminders-api.ts
11
11
  api/statuses-api.ts
12
+ api/task-client-api.ts
12
13
  api/tasks-api.ts
13
14
  base.ts
14
15
  common.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk-node@1.2.1-beta.1 --save
20
+ npm install @emilgroup/task-sdk-node@1.2.1-beta.10 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk-node@1.2.1-beta.1
24
+ yarn add @emilgroup/task-sdk-node@1.2.1-beta.10
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -29,10 +29,10 @@ import { InlineResponse503 } from '../models';
29
29
  import { URL, URLSearchParams } from 'url';
30
30
  const FormData = require('form-data');
31
31
  /**
32
- * DefaultApi - axios parameter creator
32
+ * HealthApi - axios parameter creator
33
33
  * @export
34
34
  */
35
- export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
35
+ export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
38
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -70,11 +70,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
70
70
  };
71
71
 
72
72
  /**
73
- * DefaultApi - functional programming interface
73
+ * HealthApi - functional programming interface
74
74
  * @export
75
75
  */
76
- export const DefaultApiFp = function(configuration?: Configuration) {
77
- const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
76
+ export const HealthApiFp = function(configuration?: Configuration) {
77
+ const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
78
78
  return {
79
79
  /**
80
80
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -90,11 +90,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
90
90
  };
91
91
 
92
92
  /**
93
- * DefaultApi - factory interface
93
+ * HealthApi - factory interface
94
94
  * @export
95
95
  */
96
- export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
97
- const localVarFp = DefaultApiFp(configuration)
96
+ export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
97
+ const localVarFp = HealthApiFp(configuration)
98
98
  return {
99
99
  /**
100
100
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -109,20 +109,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
109
109
  };
110
110
 
111
111
  /**
112
- * DefaultApi - object-oriented interface
112
+ * HealthApi - object-oriented interface
113
113
  * @export
114
- * @class DefaultApi
114
+ * @class HealthApi
115
115
  * @extends {BaseAPI}
116
116
  */
117
- export class DefaultApi extends BaseAPI {
117
+ export class HealthApi extends BaseAPI {
118
118
  /**
119
119
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
120
120
  * @summary Health Check
121
121
  * @param {*} [options] Override http request option.
122
122
  * @throws {RequiredError}
123
- * @memberof DefaultApi
123
+ * @memberof HealthApi
124
124
  */
125
125
  public check(options?: AxiosRequestConfig) {
126
- return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
126
+ return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
127
127
  }
128
128
  }
@@ -47,7 +47,7 @@ const FormData = require('form-data');
47
47
  export const RemindersApiAxiosParamCreator = function (configuration?: Configuration) {
48
48
  return {
49
49
  /**
50
- * This will create a reminder.
50
+ * This will create a reminder. **Required Permissions** \"task-management.reminders.create\"
51
51
  * @summary Create the reminder
52
52
  * @param {CreateReminderRequestDto} createReminderRequestDto
53
53
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -94,7 +94,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
94
94
  };
95
95
  },
96
96
  /**
97
- * This will delete a reminder.
97
+ * This will delete a reminder. **Required Permissions** \"task-management.reminders.delete\"
98
98
  * @summary Delete the reminder
99
99
  * @param {string} code Unique identifier for the object.
100
100
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -139,7 +139,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
139
139
  };
140
140
  },
141
141
  /**
142
- * This will get a reminder by code.
142
+ * This will get a reminder by code. **Required Permissions** \"task-management.reminders.view\"
143
143
  * @summary Retrieve the reminder
144
144
  * @param {string} code Unique identifier for the object.
145
145
  * @param {string} expand
@@ -191,13 +191,14 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
191
191
  };
192
192
  },
193
193
  /**
194
- * This will get reminder counts by status.
194
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.reminders.view\"
195
195
  * @summary Retrieve the reminder counts
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
+ * @param {string} [filters] Filters the response by one or multiple fields using the advanced filter syntax (same as the list reminders endpoint). Counts are computed over the filtered set.
197
198
  * @param {*} [options] Override http request option.
198
199
  * @throws {RequiredError}
199
200
  */
200
- getReminderCounts: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ getReminderCounts: async (authorization?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
202
  const localVarPath = `/taskservice/v1/reminders/counts`;
202
203
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
204
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -216,6 +217,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
216
217
  // http bearer authentication required
217
218
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
218
219
 
220
+ if (filters !== undefined) {
221
+ localVarQueryParameter['filters'] = filters;
222
+ }
223
+
219
224
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
220
225
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
221
226
  }
@@ -232,16 +237,16 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
232
237
  };
233
238
  },
234
239
  /**
235
- * Retrieves a list of reminders.
240
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.reminders.view\"
236
241
  * @summary List reminders
237
242
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
238
243
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
239
244
  * @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.
240
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
241
- * @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: title, description&lt;/i&gt;
242
- * @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, dueAt, isDone&lt;/i&gt;
245
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
246
+ * @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: code, title, description, entityCode, entityNumber, userSub, userName&lt;/i&gt;
247
+ * @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, dueAt, isDone, status&lt;/i&gt;
243
248
  * @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;
244
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
249
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
245
250
  * @param {*} [options] Override http request option.
246
251
  * @throws {RequiredError}
247
252
  */
@@ -308,7 +313,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
308
313
  };
309
314
  },
310
315
  /**
311
- * This will mark a reminder as done.
316
+ * This will mark a reminder as done. **Required Permissions** \"task-management.reminders.update\"
312
317
  * @summary Create the reminder done
313
318
  * @param {string} code
314
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -353,7 +358,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
353
358
  };
354
359
  },
355
360
  /**
356
- * This will patch a reminder.
361
+ * This will patch a reminder. **Required Permissions** \"task-management.reminders.update\"
357
362
  * @summary Update the reminder
358
363
  * @param {PatchReminderRequestDto} patchReminderRequestDto
359
364
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -410,7 +415,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
410
415
  const localVarAxiosParamCreator = RemindersApiAxiosParamCreator(configuration)
411
416
  return {
412
417
  /**
413
- * This will create a reminder.
418
+ * This will create a reminder. **Required Permissions** \"task-management.reminders.create\"
414
419
  * @summary Create the reminder
415
420
  * @param {CreateReminderRequestDto} createReminderRequestDto
416
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -422,7 +427,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
422
427
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
423
428
  },
424
429
  /**
425
- * This will delete a reminder.
430
+ * This will delete a reminder. **Required Permissions** \"task-management.reminders.delete\"
426
431
  * @summary Delete the reminder
427
432
  * @param {string} code Unique identifier for the object.
428
433
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -434,7 +439,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
434
439
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
435
440
  },
436
441
  /**
437
- * This will get a reminder by code.
442
+ * This will get a reminder by code. **Required Permissions** \"task-management.reminders.view\"
438
443
  * @summary Retrieve the reminder
439
444
  * @param {string} code Unique identifier for the object.
440
445
  * @param {string} expand
@@ -447,27 +452,28 @@ export const RemindersApiFp = function(configuration?: Configuration) {
447
452
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
448
453
  },
449
454
  /**
450
- * This will get reminder counts by status.
455
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.reminders.view\"
451
456
  * @summary Retrieve the reminder counts
452
457
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
458
+ * @param {string} [filters] Filters the response by one or multiple fields using the advanced filter syntax (same as the list reminders endpoint). Counts are computed over the filtered set.
453
459
  * @param {*} [options] Override http request option.
454
460
  * @throws {RequiredError}
455
461
  */
456
- async getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>> {
457
- const localVarAxiosArgs = await localVarAxiosParamCreator.getReminderCounts(authorization, options);
462
+ async getReminderCounts(authorization?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>> {
463
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReminderCounts(authorization, filters, options);
458
464
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
459
465
  },
460
466
  /**
461
- * Retrieves a list of reminders.
467
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.reminders.view\"
462
468
  * @summary List reminders
463
469
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
464
470
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
465
471
  * @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.
466
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
467
- * @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: title, description&lt;/i&gt;
468
- * @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, dueAt, isDone&lt;/i&gt;
472
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
473
+ * @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: code, title, description, entityCode, entityNumber, userSub, userName&lt;/i&gt;
474
+ * @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, dueAt, isDone, status&lt;/i&gt;
469
475
  * @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;
470
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
476
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
471
477
  * @param {*} [options] Override http request option.
472
478
  * @throws {RequiredError}
473
479
  */
@@ -476,7 +482,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
476
482
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
477
483
  },
478
484
  /**
479
- * This will mark a reminder as done.
485
+ * This will mark a reminder as done. **Required Permissions** \"task-management.reminders.update\"
480
486
  * @summary Create the reminder done
481
487
  * @param {string} code
482
488
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -488,7 +494,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
488
494
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
489
495
  },
490
496
  /**
491
- * This will patch a reminder.
497
+ * This will patch a reminder. **Required Permissions** \"task-management.reminders.update\"
492
498
  * @summary Update the reminder
493
499
  * @param {PatchReminderRequestDto} patchReminderRequestDto
494
500
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -510,7 +516,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
510
516
  const localVarFp = RemindersApiFp(configuration)
511
517
  return {
512
518
  /**
513
- * This will create a reminder.
519
+ * This will create a reminder. **Required Permissions** \"task-management.reminders.create\"
514
520
  * @summary Create the reminder
515
521
  * @param {CreateReminderRequestDto} createReminderRequestDto
516
522
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -521,7 +527,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
521
527
  return localVarFp.createReminder(createReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
522
528
  },
523
529
  /**
524
- * This will delete a reminder.
530
+ * This will delete a reminder. **Required Permissions** \"task-management.reminders.delete\"
525
531
  * @summary Delete the reminder
526
532
  * @param {string} code Unique identifier for the object.
527
533
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -532,7 +538,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
532
538
  return localVarFp.deleteReminder(code, authorization, options).then((request) => request(axios, basePath));
533
539
  },
534
540
  /**
535
- * This will get a reminder by code.
541
+ * This will get a reminder by code. **Required Permissions** \"task-management.reminders.view\"
536
542
  * @summary Retrieve the reminder
537
543
  * @param {string} code Unique identifier for the object.
538
544
  * @param {string} expand
@@ -544,26 +550,27 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
544
550
  return localVarFp.getReminder(code, expand, authorization, options).then((request) => request(axios, basePath));
545
551
  },
546
552
  /**
547
- * This will get reminder counts by status.
553
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.reminders.view\"
548
554
  * @summary Retrieve the reminder counts
549
555
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
556
+ * @param {string} [filters] Filters the response by one or multiple fields using the advanced filter syntax (same as the list reminders endpoint). Counts are computed over the filtered set.
550
557
  * @param {*} [options] Override http request option.
551
558
  * @throws {RequiredError}
552
559
  */
553
- getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass> {
554
- return localVarFp.getReminderCounts(authorization, options).then((request) => request(axios, basePath));
560
+ getReminderCounts(authorization?: string, filters?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass> {
561
+ return localVarFp.getReminderCounts(authorization, filters, options).then((request) => request(axios, basePath));
555
562
  },
556
563
  /**
557
- * Retrieves a list of reminders.
564
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.reminders.view\"
558
565
  * @summary List reminders
559
566
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
560
567
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
561
568
  * @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.
562
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
563
- * @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: title, description&lt;/i&gt;
564
- * @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, dueAt, isDone&lt;/i&gt;
569
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
570
+ * @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: code, title, description, entityCode, entityNumber, userSub, userName&lt;/i&gt;
571
+ * @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, dueAt, isDone, status&lt;/i&gt;
565
572
  * @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;
566
- * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
573
+ * @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
567
574
  * @param {*} [options] Override http request option.
568
575
  * @throws {RequiredError}
569
576
  */
@@ -571,7 +578,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
571
578
  return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
572
579
  },
573
580
  /**
574
- * This will mark a reminder as done.
581
+ * This will mark a reminder as done. **Required Permissions** \"task-management.reminders.update\"
575
582
  * @summary Create the reminder done
576
583
  * @param {string} code
577
584
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -582,7 +589,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
582
589
  return localVarFp.markReminderDone(code, authorization, options).then((request) => request(axios, basePath));
583
590
  },
584
591
  /**
585
- * This will patch a reminder.
592
+ * This will patch a reminder. **Required Permissions** \"task-management.reminders.update\"
586
593
  * @summary Update the reminder
587
594
  * @param {PatchReminderRequestDto} patchReminderRequestDto
588
595
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -677,6 +684,13 @@ export interface RemindersApiGetReminderCountsRequest {
677
684
  * @memberof RemindersApiGetReminderCounts
678
685
  */
679
686
  readonly authorization?: string
687
+
688
+ /**
689
+ * Filters the response by one or multiple fields using the advanced filter syntax (same as the list reminders endpoint). Counts are computed over the filtered set.
690
+ * @type {string}
691
+ * @memberof RemindersApiGetReminderCounts
692
+ */
693
+ readonly filters?: string
680
694
  }
681
695
 
682
696
  /**
@@ -707,21 +721,21 @@ export interface RemindersApiListRemindersRequest {
707
721
  readonly pageToken?: string
708
722
 
709
723
  /**
710
- * 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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
724
+ * 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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
711
725
  * @type {string}
712
726
  * @memberof RemindersApiListReminders
713
727
  */
714
728
  readonly filter?: string
715
729
 
716
730
  /**
717
- * 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: title, description&lt;/i&gt;
731
+ * 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: code, title, description, entityCode, entityNumber, userSub, userName&lt;/i&gt;
718
732
  * @type {string}
719
733
  * @memberof RemindersApiListReminders
720
734
  */
721
735
  readonly search?: string
722
736
 
723
737
  /**
724
- * 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, dueAt, isDone&lt;/i&gt;
738
+ * 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, dueAt, isDone, status&lt;/i&gt;
725
739
  * @type {string}
726
740
  * @memberof RemindersApiListReminders
727
741
  */
@@ -735,7 +749,7 @@ export interface RemindersApiListRemindersRequest {
735
749
  readonly expand?: string
736
750
 
737
751
  /**
738
- * 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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
752
+ * 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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt&lt;/i&gt;
739
753
  * @type {string}
740
754
  * @memberof RemindersApiListReminders
741
755
  */
@@ -792,7 +806,7 @@ export interface RemindersApiPatchReminderRequest {
792
806
  */
793
807
  export class RemindersApi extends BaseAPI {
794
808
  /**
795
- * This will create a reminder.
809
+ * This will create a reminder. **Required Permissions** \"task-management.reminders.create\"
796
810
  * @summary Create the reminder
797
811
  * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
798
812
  * @param {*} [options] Override http request option.
@@ -804,7 +818,7 @@ export class RemindersApi extends BaseAPI {
804
818
  }
805
819
 
806
820
  /**
807
- * This will delete a reminder.
821
+ * This will delete a reminder. **Required Permissions** \"task-management.reminders.delete\"
808
822
  * @summary Delete the reminder
809
823
  * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
810
824
  * @param {*} [options] Override http request option.
@@ -816,7 +830,7 @@ export class RemindersApi extends BaseAPI {
816
830
  }
817
831
 
818
832
  /**
819
- * This will get a reminder by code.
833
+ * This will get a reminder by code. **Required Permissions** \"task-management.reminders.view\"
820
834
  * @summary Retrieve the reminder
821
835
  * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
822
836
  * @param {*} [options] Override http request option.
@@ -828,7 +842,7 @@ export class RemindersApi extends BaseAPI {
828
842
  }
829
843
 
830
844
  /**
831
- * This will get reminder counts by status.
845
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.reminders.view\"
832
846
  * @summary Retrieve the reminder counts
833
847
  * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
834
848
  * @param {*} [options] Override http request option.
@@ -836,11 +850,11 @@ export class RemindersApi extends BaseAPI {
836
850
  * @memberof RemindersApi
837
851
  */
838
852
  public getReminderCounts(requestParameters: RemindersApiGetReminderCountsRequest = {}, options?: AxiosRequestConfig) {
839
- return RemindersApiFp(this.configuration).getReminderCounts(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
853
+ return RemindersApiFp(this.configuration).getReminderCounts(requestParameters.authorization, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
840
854
  }
841
855
 
842
856
  /**
843
- * Retrieves a list of reminders.
857
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.reminders.view\"
844
858
  * @summary List reminders
845
859
  * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
846
860
  * @param {*} [options] Override http request option.
@@ -852,7 +866,7 @@ export class RemindersApi extends BaseAPI {
852
866
  }
853
867
 
854
868
  /**
855
- * This will mark a reminder as done.
869
+ * This will mark a reminder as done. **Required Permissions** \"task-management.reminders.update\"
856
870
  * @summary Create the reminder done
857
871
  * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
858
872
  * @param {*} [options] Override http request option.
@@ -864,7 +878,7 @@ export class RemindersApi extends BaseAPI {
864
878
  }
865
879
 
866
880
  /**
867
- * This will patch a reminder.
881
+ * This will patch a reminder. **Required Permissions** \"task-management.reminders.update\"
868
882
  * @summary Update the reminder
869
883
  * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
870
884
  * @param {*} [options] Override http request option.