@emilgroup/task-sdk 1.3.1-beta.1 → 1.3.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 +2140 -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 +1838 -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@1.3.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk@1.3.1-beta.4 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk@1.3.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk@1.3.1-beta.4
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
|
@@ -25,10 +25,10 @@ import { InlineResponse200 } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { InlineResponse503 } from '../models';
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* HealthApi - axios parameter creator
|
|
29
29
|
* @export
|
|
30
30
|
*/
|
|
31
|
-
export const
|
|
31
|
+
export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
34
|
* 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.
|
|
@@ -66,11 +66,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
66
66
|
};
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* HealthApi - functional programming interface
|
|
70
70
|
* @export
|
|
71
71
|
*/
|
|
72
|
-
export const
|
|
73
|
-
const localVarAxiosParamCreator =
|
|
72
|
+
export const HealthApiFp = function(configuration?: Configuration) {
|
|
73
|
+
const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
|
|
74
74
|
return {
|
|
75
75
|
/**
|
|
76
76
|
* 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.
|
|
@@ -86,11 +86,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* HealthApi - factory interface
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
export const
|
|
93
|
-
const localVarFp =
|
|
92
|
+
export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
93
|
+
const localVarFp = HealthApiFp(configuration)
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
* 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.
|
|
@@ -105,20 +105,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
105
105
|
};
|
|
106
106
|
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* HealthApi - object-oriented interface
|
|
109
109
|
* @export
|
|
110
|
-
* @class
|
|
110
|
+
* @class HealthApi
|
|
111
111
|
* @extends {BaseAPI}
|
|
112
112
|
*/
|
|
113
|
-
export class
|
|
113
|
+
export class HealthApi extends BaseAPI {
|
|
114
114
|
/**
|
|
115
115
|
* 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.
|
|
116
116
|
* @summary Health Check
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
|
-
* @memberof
|
|
119
|
+
* @memberof HealthApi
|
|
120
120
|
*/
|
|
121
121
|
public check(options?: AxiosRequestConfig) {
|
|
122
|
-
return
|
|
122
|
+
return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
|
|
123
123
|
}
|
|
124
124
|
}
|
package/api/reminders-api.ts
CHANGED
|
@@ -43,7 +43,7 @@ import { PatchReminderResponseClass } from '../models';
|
|
|
43
43
|
export const RemindersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* This will create a reminder.
|
|
46
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
47
47
|
* @summary Create the reminder
|
|
48
48
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* This will delete a reminder.
|
|
93
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
94
94
|
* @summary Delete the reminder
|
|
95
95
|
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,7 +135,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
* This will get a reminder by code.
|
|
138
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
139
139
|
* @summary Retrieve the reminder
|
|
140
140
|
* @param {string} code Unique identifier for the object.
|
|
141
141
|
* @param {string} expand
|
|
@@ -187,7 +187,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
187
187
|
};
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* This will get reminder counts by status.
|
|
190
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
191
191
|
* @summary Retrieve the reminder counts
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
@@ -228,16 +228,16 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
228
228
|
};
|
|
229
229
|
},
|
|
230
230
|
/**
|
|
231
|
-
* Retrieves a list of reminders.
|
|
231
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
232
232
|
* @summary List reminders
|
|
233
233
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
234
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
235
235
|
* @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.
|
|
236
|
-
* @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>
|
|
237
|
-
* @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>
|
|
238
|
-
* @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>
|
|
236
|
+
* @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>
|
|
237
|
+
* @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>
|
|
238
|
+
* @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>
|
|
239
239
|
* @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/>
|
|
240
|
-
* @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>
|
|
240
|
+
* @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>
|
|
241
241
|
* @param {*} [options] Override http request option.
|
|
242
242
|
* @throws {RequiredError}
|
|
243
243
|
*/
|
|
@@ -304,7 +304,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
304
304
|
};
|
|
305
305
|
},
|
|
306
306
|
/**
|
|
307
|
-
* This will mark a reminder as done.
|
|
307
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
308
308
|
* @summary Create the reminder done
|
|
309
309
|
* @param {string} code
|
|
310
310
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -349,7 +349,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
349
349
|
};
|
|
350
350
|
},
|
|
351
351
|
/**
|
|
352
|
-
* This will patch a reminder.
|
|
352
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
353
353
|
* @summary Update the reminder
|
|
354
354
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
355
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -406,7 +406,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
406
406
|
const localVarAxiosParamCreator = RemindersApiAxiosParamCreator(configuration)
|
|
407
407
|
return {
|
|
408
408
|
/**
|
|
409
|
-
* This will create a reminder.
|
|
409
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
410
410
|
* @summary Create the reminder
|
|
411
411
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
412
412
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -418,7 +418,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
418
418
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
419
419
|
},
|
|
420
420
|
/**
|
|
421
|
-
* This will delete a reminder.
|
|
421
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
422
422
|
* @summary Delete the reminder
|
|
423
423
|
* @param {string} code Unique identifier for the object.
|
|
424
424
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -430,7 +430,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
430
430
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* This will get a reminder by code.
|
|
433
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
434
434
|
* @summary Retrieve the reminder
|
|
435
435
|
* @param {string} code Unique identifier for the object.
|
|
436
436
|
* @param {string} expand
|
|
@@ -443,7 +443,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
443
443
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
444
444
|
},
|
|
445
445
|
/**
|
|
446
|
-
* This will get reminder counts by status.
|
|
446
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
447
447
|
* @summary Retrieve the reminder counts
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
@@ -454,16 +454,16 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
454
454
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
455
455
|
},
|
|
456
456
|
/**
|
|
457
|
-
* Retrieves a list of reminders.
|
|
457
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
458
458
|
* @summary List reminders
|
|
459
459
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
460
460
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
461
461
|
* @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.
|
|
462
|
-
* @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>
|
|
463
|
-
* @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>
|
|
464
|
-
* @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>
|
|
462
|
+
* @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>
|
|
463
|
+
* @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>
|
|
464
|
+
* @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>
|
|
465
465
|
* @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/>
|
|
466
|
-
* @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>
|
|
466
|
+
* @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>
|
|
467
467
|
* @param {*} [options] Override http request option.
|
|
468
468
|
* @throws {RequiredError}
|
|
469
469
|
*/
|
|
@@ -472,7 +472,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
472
472
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
473
473
|
},
|
|
474
474
|
/**
|
|
475
|
-
* This will mark a reminder as done.
|
|
475
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
476
476
|
* @summary Create the reminder done
|
|
477
477
|
* @param {string} code
|
|
478
478
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -484,7 +484,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
|
|
|
484
484
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
485
485
|
},
|
|
486
486
|
/**
|
|
487
|
-
* This will patch a reminder.
|
|
487
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
488
488
|
* @summary Update the reminder
|
|
489
489
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
490
490
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -506,7 +506,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
506
506
|
const localVarFp = RemindersApiFp(configuration)
|
|
507
507
|
return {
|
|
508
508
|
/**
|
|
509
|
-
* This will create a reminder.
|
|
509
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
510
510
|
* @summary Create the reminder
|
|
511
511
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
512
512
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -517,7 +517,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
517
517
|
return localVarFp.createReminder(createReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
518
518
|
},
|
|
519
519
|
/**
|
|
520
|
-
* This will delete a reminder.
|
|
520
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
521
521
|
* @summary Delete the reminder
|
|
522
522
|
* @param {string} code Unique identifier for the object.
|
|
523
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -528,7 +528,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
528
528
|
return localVarFp.deleteReminder(code, authorization, options).then((request) => request(axios, basePath));
|
|
529
529
|
},
|
|
530
530
|
/**
|
|
531
|
-
* This will get a reminder by code.
|
|
531
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
532
532
|
* @summary Retrieve the reminder
|
|
533
533
|
* @param {string} code Unique identifier for the object.
|
|
534
534
|
* @param {string} expand
|
|
@@ -540,7 +540,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
540
540
|
return localVarFp.getReminder(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
541
541
|
},
|
|
542
542
|
/**
|
|
543
|
-
* This will get reminder counts by status.
|
|
543
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
544
544
|
* @summary Retrieve the reminder counts
|
|
545
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
@@ -550,16 +550,16 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
550
550
|
return localVarFp.getReminderCounts(authorization, options).then((request) => request(axios, basePath));
|
|
551
551
|
},
|
|
552
552
|
/**
|
|
553
|
-
* Retrieves a list of reminders.
|
|
553
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
554
554
|
* @summary List reminders
|
|
555
555
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
556
556
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
557
557
|
* @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.
|
|
558
|
-
* @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>
|
|
559
|
-
* @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>
|
|
560
|
-
* @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>
|
|
558
|
+
* @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>
|
|
559
|
+
* @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>
|
|
560
|
+
* @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>
|
|
561
561
|
* @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/>
|
|
562
|
-
* @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>
|
|
562
|
+
* @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>
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
565
565
|
*/
|
|
@@ -567,7 +567,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
567
567
|
return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
568
568
|
},
|
|
569
569
|
/**
|
|
570
|
-
* This will mark a reminder as done.
|
|
570
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
571
571
|
* @summary Create the reminder done
|
|
572
572
|
* @param {string} code
|
|
573
573
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -578,7 +578,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
|
|
|
578
578
|
return localVarFp.markReminderDone(code, authorization, options).then((request) => request(axios, basePath));
|
|
579
579
|
},
|
|
580
580
|
/**
|
|
581
|
-
* This will patch a reminder.
|
|
581
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
582
582
|
* @summary Update the reminder
|
|
583
583
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
584
584
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -703,21 +703,21 @@ export interface RemindersApiListRemindersRequest {
|
|
|
703
703
|
readonly pageToken?: string
|
|
704
704
|
|
|
705
705
|
/**
|
|
706
|
-
* 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>
|
|
706
|
+
* 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>
|
|
707
707
|
* @type {string}
|
|
708
708
|
* @memberof RemindersApiListReminders
|
|
709
709
|
*/
|
|
710
710
|
readonly filter?: string
|
|
711
711
|
|
|
712
712
|
/**
|
|
713
|
-
* 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>
|
|
713
|
+
* 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>
|
|
714
714
|
* @type {string}
|
|
715
715
|
* @memberof RemindersApiListReminders
|
|
716
716
|
*/
|
|
717
717
|
readonly search?: string
|
|
718
718
|
|
|
719
719
|
/**
|
|
720
|
-
* 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>
|
|
720
|
+
* 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>
|
|
721
721
|
* @type {string}
|
|
722
722
|
* @memberof RemindersApiListReminders
|
|
723
723
|
*/
|
|
@@ -731,7 +731,7 @@ export interface RemindersApiListRemindersRequest {
|
|
|
731
731
|
readonly expand?: string
|
|
732
732
|
|
|
733
733
|
/**
|
|
734
|
-
* 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>
|
|
734
|
+
* 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>
|
|
735
735
|
* @type {string}
|
|
736
736
|
* @memberof RemindersApiListReminders
|
|
737
737
|
*/
|
|
@@ -788,7 +788,7 @@ export interface RemindersApiPatchReminderRequest {
|
|
|
788
788
|
*/
|
|
789
789
|
export class RemindersApi extends BaseAPI {
|
|
790
790
|
/**
|
|
791
|
-
* This will create a reminder.
|
|
791
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
792
792
|
* @summary Create the reminder
|
|
793
793
|
* @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
|
|
794
794
|
* @param {*} [options] Override http request option.
|
|
@@ -800,7 +800,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
800
800
|
}
|
|
801
801
|
|
|
802
802
|
/**
|
|
803
|
-
* This will delete a reminder.
|
|
803
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
804
804
|
* @summary Delete the reminder
|
|
805
805
|
* @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
|
|
806
806
|
* @param {*} [options] Override http request option.
|
|
@@ -812,7 +812,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
812
812
|
}
|
|
813
813
|
|
|
814
814
|
/**
|
|
815
|
-
* This will get a reminder by code.
|
|
815
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
816
816
|
* @summary Retrieve the reminder
|
|
817
817
|
* @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
|
|
818
818
|
* @param {*} [options] Override http request option.
|
|
@@ -824,7 +824,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
824
824
|
}
|
|
825
825
|
|
|
826
826
|
/**
|
|
827
|
-
* This will get reminder counts by status.
|
|
827
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
828
828
|
* @summary Retrieve the reminder counts
|
|
829
829
|
* @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
|
|
830
830
|
* @param {*} [options] Override http request option.
|
|
@@ -836,7 +836,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
836
836
|
}
|
|
837
837
|
|
|
838
838
|
/**
|
|
839
|
-
* Retrieves a list of reminders.
|
|
839
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
840
840
|
* @summary List reminders
|
|
841
841
|
* @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
|
|
842
842
|
* @param {*} [options] Override http request option.
|
|
@@ -848,7 +848,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
848
848
|
}
|
|
849
849
|
|
|
850
850
|
/**
|
|
851
|
-
* This will mark a reminder as done.
|
|
851
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
852
852
|
* @summary Create the reminder done
|
|
853
853
|
* @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
|
|
854
854
|
* @param {*} [options] Override http request option.
|
|
@@ -860,7 +860,7 @@ export class RemindersApi extends BaseAPI {
|
|
|
860
860
|
}
|
|
861
861
|
|
|
862
862
|
/**
|
|
863
|
-
* This will patch a reminder.
|
|
863
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
864
864
|
* @summary Update the reminder
|
|
865
865
|
* @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
|
|
866
866
|
* @param {*} [options] Override http request option.
|