@emilgroup/task-sdk-node 1.2.1-beta.1 → 1.2.1-beta.4
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 +2 -1
- package/README.md +2 -2
- package/api/{default-api.ts → health-api.ts} +13 -13
- package/api/reminders-api.ts +44 -44
- package/api/task-client-api.ts +2144 -0
- package/api.ts +4 -2
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api/reminders-api.d.ts +44 -44
- package/dist/api/reminders-api.js +40 -40
- package/dist/api/task-client-api.d.ts +1194 -0
- package/dist/api/task-client-api.js +1842 -0
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/models/create-reminder-request-dto.d.ts +9 -2
- package/dist/models/create-reminder-request-dto.js +7 -0
- package/dist/models/patch-reminder-request-dto.d.ts +25 -0
- package/dist/models/patch-reminder-request-dto.js +7 -0
- package/models/create-reminder-request-dto.ts +12 -2
- package/models/patch-reminder-request-dto.ts +28 -0
- package/package.json +2 -2
package/.openapi-generator/FILES
CHANGED
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.
|
|
20
|
+
npm install @emilgroup/task-sdk-node@1.2.1-beta.4 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk-node@1.2.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk-node@1.2.1-beta.4
|
|
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
|
-
*
|
|
32
|
+
* HealthApi - axios parameter creator
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export const
|
|
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
|
-
*
|
|
73
|
+
* HealthApi - functional programming interface
|
|
74
74
|
* @export
|
|
75
75
|
*/
|
|
76
|
-
export const
|
|
77
|
-
const localVarAxiosParamCreator =
|
|
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
|
-
*
|
|
93
|
+
* HealthApi - factory interface
|
|
94
94
|
* @export
|
|
95
95
|
*/
|
|
96
|
-
export const
|
|
97
|
-
const localVarFp =
|
|
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
|
-
*
|
|
112
|
+
* HealthApi - object-oriented interface
|
|
113
113
|
* @export
|
|
114
|
-
* @class
|
|
114
|
+
* @class HealthApi
|
|
115
115
|
* @extends {BaseAPI}
|
|
116
116
|
*/
|
|
117
|
-
export class
|
|
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
|
|
123
|
+
* @memberof HealthApi
|
|
124
124
|
*/
|
|
125
125
|
public check(options?: AxiosRequestConfig) {
|
|
126
|
-
return
|
|
126
|
+
return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
127
127
|
}
|
|
128
128
|
}
|
package/api/reminders-api.ts
CHANGED
|
@@ -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.tasks.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.tasks.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.tasks.view\"
|
|
143
143
|
* @summary Retrieve the reminder
|
|
144
144
|
* @param {string} code Unique identifier for the object.
|
|
145
145
|
* @param {string} expand
|
|
@@ -191,7 +191,7 @@ 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. **Required Permissions** \"task-management.tasks.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
197
|
* @param {*} [options] Override http request option.
|
|
@@ -232,16 +232,16 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
232
232
|
};
|
|
233
233
|
},
|
|
234
234
|
/**
|
|
235
|
-
* Retrieves a list of reminders.
|
|
235
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
236
236
|
* @summary List reminders
|
|
237
237
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
238
238
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
239
239
|
* @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.
|
|
240
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
241
|
-
* @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: title, description</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
|
|
240
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
241
|
+
* @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: code, title, description, entityCode, entityNumber, userSub, userName</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
|
|
243
243
|
* @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/>
|
|
244
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
244
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
245
245
|
* @param {*} [options] Override http request option.
|
|
246
246
|
* @throws {RequiredError}
|
|
247
247
|
*/
|
|
@@ -308,7 +308,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
308
308
|
};
|
|
309
309
|
},
|
|
310
310
|
/**
|
|
311
|
-
* This will mark a reminder as done.
|
|
311
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
312
312
|
* @summary Create the reminder done
|
|
313
313
|
* @param {string} code
|
|
314
314
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -353,7 +353,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
353
353
|
};
|
|
354
354
|
},
|
|
355
355
|
/**
|
|
356
|
-
* This will patch a reminder.
|
|
356
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
357
357
|
* @summary Update the reminder
|
|
358
358
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
359
359
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -410,7 +410,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
410
410
|
const localVarAxiosParamCreator = RemindersApiAxiosParamCreator(configuration)
|
|
411
411
|
return {
|
|
412
412
|
/**
|
|
413
|
-
* This will create a reminder.
|
|
413
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
414
414
|
* @summary Create the reminder
|
|
415
415
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
416
416
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -422,7 +422,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
422
422
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
423
423
|
},
|
|
424
424
|
/**
|
|
425
|
-
* This will delete a reminder.
|
|
425
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
426
426
|
* @summary Delete the reminder
|
|
427
427
|
* @param {string} code Unique identifier for the object.
|
|
428
428
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -434,7 +434,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
434
434
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
435
435
|
},
|
|
436
436
|
/**
|
|
437
|
-
* This will get a reminder by code.
|
|
437
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
438
438
|
* @summary Retrieve the reminder
|
|
439
439
|
* @param {string} code Unique identifier for the object.
|
|
440
440
|
* @param {string} expand
|
|
@@ -447,7 +447,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
447
447
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
448
448
|
},
|
|
449
449
|
/**
|
|
450
|
-
* This will get reminder counts by status.
|
|
450
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
451
451
|
* @summary Retrieve the reminder counts
|
|
452
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
@@ -458,16 +458,16 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
458
458
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
459
459
|
},
|
|
460
460
|
/**
|
|
461
|
-
* Retrieves a list of reminders.
|
|
461
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
462
462
|
* @summary List reminders
|
|
463
463
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
464
464
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
465
465
|
* @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.
|
|
466
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
467
|
-
* @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: title, description</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
|
|
466
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
467
|
+
* @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: code, title, description, entityCode, entityNumber, userSub, userName</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
|
|
469
469
|
* @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/>
|
|
470
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
470
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
471
471
|
* @param {*} [options] Override http request option.
|
|
472
472
|
* @throws {RequiredError}
|
|
473
473
|
*/
|
|
@@ -476,7 +476,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
476
476
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
477
477
|
},
|
|
478
478
|
/**
|
|
479
|
-
* This will mark a reminder as done.
|
|
479
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
480
480
|
* @summary Create the reminder done
|
|
481
481
|
* @param {string} code
|
|
482
482
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -488,7 +488,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
488
488
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
489
489
|
},
|
|
490
490
|
/**
|
|
491
|
-
* This will patch a reminder.
|
|
491
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
492
492
|
* @summary Update the reminder
|
|
493
493
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
494
494
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -510,7 +510,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
510
510
|
const localVarFp = RemindersApiFp(configuration)
|
|
511
511
|
return {
|
|
512
512
|
/**
|
|
513
|
-
* This will create a reminder.
|
|
513
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
514
514
|
* @summary Create the reminder
|
|
515
515
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
516
516
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -521,7 +521,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
521
521
|
return localVarFp.createReminder(createReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
522
522
|
},
|
|
523
523
|
/**
|
|
524
|
-
* This will delete a reminder.
|
|
524
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
525
525
|
* @summary Delete the reminder
|
|
526
526
|
* @param {string} code Unique identifier for the object.
|
|
527
527
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -532,7 +532,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
532
532
|
return localVarFp.deleteReminder(code, authorization, options).then((request) => request(axios, basePath));
|
|
533
533
|
},
|
|
534
534
|
/**
|
|
535
|
-
* This will get a reminder by code.
|
|
535
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
536
536
|
* @summary Retrieve the reminder
|
|
537
537
|
* @param {string} code Unique identifier for the object.
|
|
538
538
|
* @param {string} expand
|
|
@@ -544,7 +544,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
544
544
|
return localVarFp.getReminder(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
545
545
|
},
|
|
546
546
|
/**
|
|
547
|
-
* This will get reminder counts by status.
|
|
547
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
548
548
|
* @summary Retrieve the reminder counts
|
|
549
549
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
550
550
|
* @param {*} [options] Override http request option.
|
|
@@ -554,16 +554,16 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
554
554
|
return localVarFp.getReminderCounts(authorization, options).then((request) => request(axios, basePath));
|
|
555
555
|
},
|
|
556
556
|
/**
|
|
557
|
-
* Retrieves a list of reminders.
|
|
557
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
558
558
|
* @summary List reminders
|
|
559
559
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
560
560
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
561
561
|
* @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.
|
|
562
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
563
|
-
* @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: title, description</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
|
|
562
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
563
|
+
* @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: code, title, description, entityCode, entityNumber, userSub, userName</i>
|
|
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.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
|
|
565
565
|
* @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/>
|
|
566
|
-
* @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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
566
|
+
* @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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
567
567
|
* @param {*} [options] Override http request option.
|
|
568
568
|
* @throws {RequiredError}
|
|
569
569
|
*/
|
|
@@ -571,7 +571,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
571
571
|
return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
572
572
|
},
|
|
573
573
|
/**
|
|
574
|
-
* This will mark a reminder as done.
|
|
574
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
575
575
|
* @summary Create the reminder done
|
|
576
576
|
* @param {string} code
|
|
577
577
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -582,7 +582,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
582
582
|
return localVarFp.markReminderDone(code, authorization, options).then((request) => request(axios, basePath));
|
|
583
583
|
},
|
|
584
584
|
/**
|
|
585
|
-
* This will patch a reminder.
|
|
585
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
586
586
|
* @summary Update the reminder
|
|
587
587
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
588
588
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -707,21 +707,21 @@ export interface RemindersApiListRemindersRequest {
|
|
|
707
707
|
readonly pageToken?: string
|
|
708
708
|
|
|
709
709
|
/**
|
|
710
|
-
* 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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
710
|
+
* 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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
711
711
|
* @type {string}
|
|
712
712
|
* @memberof RemindersApiListReminders
|
|
713
713
|
*/
|
|
714
714
|
readonly filter?: string
|
|
715
715
|
|
|
716
716
|
/**
|
|
717
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: title, description</i>
|
|
717
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, title, description, entityCode, entityNumber, userSub, userName</i>
|
|
718
718
|
* @type {string}
|
|
719
719
|
* @memberof RemindersApiListReminders
|
|
720
720
|
*/
|
|
721
721
|
readonly search?: string
|
|
722
722
|
|
|
723
723
|
/**
|
|
724
|
-
* 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, dueAt, isDone</i>
|
|
724
|
+
* 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, dueAt, isDone, status</i>
|
|
725
725
|
* @type {string}
|
|
726
726
|
* @memberof RemindersApiListReminders
|
|
727
727
|
*/
|
|
@@ -735,7 +735,7 @@ export interface RemindersApiListRemindersRequest {
|
|
|
735
735
|
readonly expand?: string
|
|
736
736
|
|
|
737
737
|
/**
|
|
738
|
-
* 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, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
|
|
738
|
+
* 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, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
|
|
739
739
|
* @type {string}
|
|
740
740
|
* @memberof RemindersApiListReminders
|
|
741
741
|
*/
|
|
@@ -792,7 +792,7 @@ export interface RemindersApiPatchReminderRequest {
|
|
|
792
792
|
*/
|
|
793
793
|
export class RemindersApi extends BaseAPI {
|
|
794
794
|
/**
|
|
795
|
-
* This will create a reminder.
|
|
795
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
796
796
|
* @summary Create the reminder
|
|
797
797
|
* @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
|
|
798
798
|
* @param {*} [options] Override http request option.
|
|
@@ -804,7 +804,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
804
804
|
}
|
|
805
805
|
|
|
806
806
|
/**
|
|
807
|
-
* This will delete a reminder.
|
|
807
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
808
808
|
* @summary Delete the reminder
|
|
809
809
|
* @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
|
|
810
810
|
* @param {*} [options] Override http request option.
|
|
@@ -816,7 +816,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
816
816
|
}
|
|
817
817
|
|
|
818
818
|
/**
|
|
819
|
-
* This will get a reminder by code.
|
|
819
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
820
820
|
* @summary Retrieve the reminder
|
|
821
821
|
* @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
|
|
822
822
|
* @param {*} [options] Override http request option.
|
|
@@ -828,7 +828,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
828
828
|
}
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
|
-
* This will get reminder counts by status.
|
|
831
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
832
832
|
* @summary Retrieve the reminder counts
|
|
833
833
|
* @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
|
|
834
834
|
* @param {*} [options] Override http request option.
|
|
@@ -840,7 +840,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
840
840
|
}
|
|
841
841
|
|
|
842
842
|
/**
|
|
843
|
-
* Retrieves a list of reminders.
|
|
843
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
844
844
|
* @summary List reminders
|
|
845
845
|
* @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
|
|
846
846
|
* @param {*} [options] Override http request option.
|
|
@@ -852,7 +852,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
852
852
|
}
|
|
853
853
|
|
|
854
854
|
/**
|
|
855
|
-
* This will mark a reminder as done.
|
|
855
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
856
856
|
* @summary Create the reminder done
|
|
857
857
|
* @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
|
|
858
858
|
* @param {*} [options] Override http request option.
|
|
@@ -864,7 +864,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
864
864
|
}
|
|
865
865
|
|
|
866
866
|
/**
|
|
867
|
-
* This will patch a reminder.
|
|
867
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
868
868
|
* @summary Update the reminder
|
|
869
869
|
* @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
|
|
870
870
|
* @param {*} [options] Override http request option.
|