@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/api.ts
CHANGED
|
@@ -22,18 +22,20 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
23
|
import { AssigneesApi } from './api';
|
|
24
24
|
import { CategoriesApi } from './api';
|
|
25
|
-
import {
|
|
25
|
+
import { HealthApi } from './api';
|
|
26
26
|
import { HubSpotApi } from './api';
|
|
27
27
|
import { RemindersApi } from './api';
|
|
28
28
|
import { StatusesApi } from './api';
|
|
29
|
+
import { TaskClientApi } from './api';
|
|
29
30
|
import { TasksApi } from './api';
|
|
30
31
|
|
|
31
32
|
|
|
32
33
|
export * from './api/assignees-api';
|
|
33
34
|
export * from './api/categories-api';
|
|
34
|
-
export * from './api/
|
|
35
|
+
export * from './api/health-api';
|
|
35
36
|
export * from './api/hub-spot-api';
|
|
36
37
|
export * from './api/reminders-api';
|
|
37
38
|
export * from './api/statuses-api';
|
|
39
|
+
export * from './api/task-client-api';
|
|
38
40
|
export * from './api/tasks-api';
|
|
39
41
|
|
|
@@ -14,10 +14,10 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { InlineResponse200 } from '../models';
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* HealthApi - axios parameter creator
|
|
18
18
|
* @export
|
|
19
19
|
*/
|
|
20
|
-
export declare const
|
|
20
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
22
|
* 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.
|
|
23
23
|
* @summary Health Check
|
|
@@ -27,10 +27,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
27
27
|
check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* HealthApi - functional programming interface
|
|
31
31
|
* @export
|
|
32
32
|
*/
|
|
33
|
-
export declare const
|
|
33
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
35
|
* 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.
|
|
36
36
|
* @summary Health Check
|
|
@@ -40,10 +40,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
40
40
|
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* HealthApi - factory interface
|
|
44
44
|
* @export
|
|
45
45
|
*/
|
|
46
|
-
export declare const
|
|
46
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
47
47
|
/**
|
|
48
48
|
* 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.
|
|
49
49
|
* @summary Health Check
|
|
@@ -53,18 +53,18 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
53
53
|
check(options?: any): AxiosPromise<InlineResponse200>;
|
|
54
54
|
};
|
|
55
55
|
/**
|
|
56
|
-
*
|
|
56
|
+
* HealthApi - object-oriented interface
|
|
57
57
|
* @export
|
|
58
|
-
* @class
|
|
58
|
+
* @class HealthApi
|
|
59
59
|
* @extends {BaseAPI}
|
|
60
60
|
*/
|
|
61
|
-
export declare class
|
|
61
|
+
export declare class HealthApi extends BaseAPI {
|
|
62
62
|
/**
|
|
63
63
|
* 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.
|
|
64
64
|
* @summary Health Check
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
|
-
* @memberof
|
|
67
|
+
* @memberof HealthApi
|
|
68
68
|
*/
|
|
69
69
|
check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
|
|
70
70
|
}
|
|
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
78
78
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
79
|
};
|
|
80
80
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
-
exports.
|
|
81
|
+
exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = void 0;
|
|
82
82
|
var axios_1 = __importDefault(require("axios"));
|
|
83
83
|
// Some imports not used depending on template conditions
|
|
84
84
|
// @ts-ignore
|
|
@@ -86,10 +86,10 @@ var common_1 = require("../common");
|
|
|
86
86
|
// @ts-ignore
|
|
87
87
|
var base_1 = require("../base");
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* HealthApi - axios parameter creator
|
|
90
90
|
* @export
|
|
91
91
|
*/
|
|
92
|
-
var
|
|
92
|
+
var HealthApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
@@ -124,13 +124,13 @@ var DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
},
|
|
125
125
|
};
|
|
126
126
|
};
|
|
127
|
-
exports.
|
|
127
|
+
exports.HealthApiAxiosParamCreator = HealthApiAxiosParamCreator;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* HealthApi - functional programming interface
|
|
130
130
|
* @export
|
|
131
131
|
*/
|
|
132
|
-
var
|
|
133
|
-
var localVarAxiosParamCreator = (0, exports.
|
|
132
|
+
var HealthApiFp = function (configuration) {
|
|
133
|
+
var localVarAxiosParamCreator = (0, exports.HealthApiAxiosParamCreator)(configuration);
|
|
134
134
|
return {
|
|
135
135
|
/**
|
|
136
136
|
* 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.
|
|
@@ -153,13 +153,13 @@ var DefaultApiFp = function (configuration) {
|
|
|
153
153
|
},
|
|
154
154
|
};
|
|
155
155
|
};
|
|
156
|
-
exports.
|
|
156
|
+
exports.HealthApiFp = HealthApiFp;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* HealthApi - factory interface
|
|
159
159
|
* @export
|
|
160
160
|
*/
|
|
161
|
-
var
|
|
162
|
-
var localVarFp = (0, exports.
|
|
161
|
+
var HealthApiFactory = function (configuration, basePath, axios) {
|
|
162
|
+
var localVarFp = (0, exports.HealthApiFp)(configuration);
|
|
163
163
|
return {
|
|
164
164
|
/**
|
|
165
165
|
* 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.
|
|
@@ -172,16 +172,16 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
172
172
|
},
|
|
173
173
|
};
|
|
174
174
|
};
|
|
175
|
-
exports.
|
|
175
|
+
exports.HealthApiFactory = HealthApiFactory;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* HealthApi - object-oriented interface
|
|
178
178
|
* @export
|
|
179
|
-
* @class
|
|
179
|
+
* @class HealthApi
|
|
180
180
|
* @extends {BaseAPI}
|
|
181
181
|
*/
|
|
182
|
-
var
|
|
183
|
-
__extends(
|
|
184
|
-
function
|
|
182
|
+
var HealthApi = /** @class */ (function (_super) {
|
|
183
|
+
__extends(HealthApi, _super);
|
|
184
|
+
function HealthApi() {
|
|
185
185
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
@@ -189,12 +189,12 @@ var DefaultApi = /** @class */ (function (_super) {
|
|
|
189
189
|
* @summary Health Check
|
|
190
190
|
* @param {*} [options] Override http request option.
|
|
191
191
|
* @throws {RequiredError}
|
|
192
|
-
* @memberof
|
|
192
|
+
* @memberof HealthApi
|
|
193
193
|
*/
|
|
194
|
-
|
|
194
|
+
HealthApi.prototype.check = function (options) {
|
|
195
195
|
var _this = this;
|
|
196
|
-
return (0, exports.
|
|
196
|
+
return (0, exports.HealthApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
197
197
|
};
|
|
198
|
-
return
|
|
198
|
+
return HealthApi;
|
|
199
199
|
}(base_1.BaseAPI));
|
|
200
|
-
exports.
|
|
200
|
+
exports.HealthApi = HealthApi;
|
|
@@ -26,7 +26,7 @@ import { PatchReminderResponseClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const RemindersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* This will create a reminder.
|
|
29
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
30
30
|
* @summary Create the reminder
|
|
31
31
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
35
35
|
*/
|
|
36
36
|
createReminder: (createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
* This will delete a reminder.
|
|
38
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
39
39
|
* @summary Delete the reminder
|
|
40
40
|
* @param {string} code Unique identifier for the object.
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -44,7 +44,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44
44
|
*/
|
|
45
45
|
deleteReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* This will get a reminder by code.
|
|
47
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
48
48
|
* @summary Retrieve the reminder
|
|
49
49
|
* @param {string} code Unique identifier for the object.
|
|
50
50
|
* @param {string} expand
|
|
@@ -54,7 +54,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
54
54
|
*/
|
|
55
55
|
getReminder: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
56
|
/**
|
|
57
|
-
* This will get reminder counts by status.
|
|
57
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
58
58
|
* @summary Retrieve the reminder counts
|
|
59
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
60
|
* @param {*} [options] Override http request option.
|
|
@@ -62,22 +62,22 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
62
62
|
*/
|
|
63
63
|
getReminderCounts: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
|
-
* Retrieves a list of reminders.
|
|
65
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
66
66
|
* @summary List reminders
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
68
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
69
|
* @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.
|
|
70
|
-
* @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>
|
|
71
|
-
* @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>
|
|
72
|
-
* @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>
|
|
70
|
+
* @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>
|
|
71
|
+
* @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>
|
|
72
|
+
* @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>
|
|
73
73
|
* @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/>
|
|
74
|
-
* @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>
|
|
74
|
+
* @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>
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
77
77
|
*/
|
|
78
78
|
listReminders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
|
-
* This will mark a reminder as done.
|
|
80
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
81
81
|
* @summary Create the reminder done
|
|
82
82
|
* @param {string} code
|
|
83
83
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -86,7 +86,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
86
86
|
*/
|
|
87
87
|
markReminderDone: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
|
-
* This will patch a reminder.
|
|
89
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
90
90
|
* @summary Update the reminder
|
|
91
91
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
92
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -101,7 +101,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
101
101
|
*/
|
|
102
102
|
export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
103
103
|
/**
|
|
104
|
-
* This will create a reminder.
|
|
104
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
105
105
|
* @summary Create the reminder
|
|
106
106
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
107
107
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -110,7 +110,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
110
110
|
*/
|
|
111
111
|
createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReminderResponseClass>>;
|
|
112
112
|
/**
|
|
113
|
-
* This will delete a reminder.
|
|
113
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
114
114
|
* @summary Delete the reminder
|
|
115
115
|
* @param {string} code Unique identifier for the object.
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -119,7 +119,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
119
119
|
*/
|
|
120
120
|
deleteReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
121
121
|
/**
|
|
122
|
-
* This will get a reminder by code.
|
|
122
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
123
123
|
* @summary Retrieve the reminder
|
|
124
124
|
* @param {string} code Unique identifier for the object.
|
|
125
125
|
* @param {string} expand
|
|
@@ -129,7 +129,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
129
129
|
*/
|
|
130
130
|
getReminder(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderResponseClass>>;
|
|
131
131
|
/**
|
|
132
|
-
* This will get reminder counts by status.
|
|
132
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
133
133
|
* @summary Retrieve the reminder counts
|
|
134
134
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
@@ -137,22 +137,22 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
137
137
|
*/
|
|
138
138
|
getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>>;
|
|
139
139
|
/**
|
|
140
|
-
* Retrieves a list of reminders.
|
|
140
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
141
141
|
* @summary List reminders
|
|
142
142
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
143
143
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
144
144
|
* @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.
|
|
145
|
-
* @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>
|
|
146
|
-
* @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>
|
|
147
|
-
* @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>
|
|
145
|
+
* @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>
|
|
146
|
+
* @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>
|
|
147
|
+
* @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>
|
|
148
148
|
* @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/>
|
|
149
|
-
* @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>
|
|
149
|
+
* @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>
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
*/
|
|
153
153
|
listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRemindersResponseClass>>;
|
|
154
154
|
/**
|
|
155
|
-
* This will mark a reminder as done.
|
|
155
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
156
156
|
* @summary Create the reminder done
|
|
157
157
|
* @param {string} code
|
|
158
158
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -161,7 +161,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
161
161
|
*/
|
|
162
162
|
markReminderDone(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkReminderDoneResponseClass>>;
|
|
163
163
|
/**
|
|
164
|
-
* This will patch a reminder.
|
|
164
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
165
165
|
* @summary Update the reminder
|
|
166
166
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
167
167
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -176,7 +176,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
|
|
|
176
176
|
*/
|
|
177
177
|
export declare const RemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
178
178
|
/**
|
|
179
|
-
* This will create a reminder.
|
|
179
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
180
180
|
* @summary Create the reminder
|
|
181
181
|
* @param {CreateReminderRequestDto} createReminderRequestDto
|
|
182
182
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -185,7 +185,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
|
|
|
185
185
|
*/
|
|
186
186
|
createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReminderResponseClass>;
|
|
187
187
|
/**
|
|
188
|
-
* This will delete a reminder.
|
|
188
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
189
189
|
* @summary Delete the reminder
|
|
190
190
|
* @param {string} code Unique identifier for the object.
|
|
191
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -194,7 +194,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
|
|
|
194
194
|
*/
|
|
195
195
|
deleteReminder(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
196
196
|
/**
|
|
197
|
-
* This will get a reminder by code.
|
|
197
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
198
198
|
* @summary Retrieve the reminder
|
|
199
199
|
* @param {string} code Unique identifier for the object.
|
|
200
200
|
* @param {string} expand
|
|
@@ -204,7 +204,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
|
|
|
204
204
|
*/
|
|
205
205
|
getReminder(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetReminderResponseClass>;
|
|
206
206
|
/**
|
|
207
|
-
* This will get reminder counts by status.
|
|
207
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
208
208
|
* @summary Retrieve the reminder counts
|
|
209
209
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
@@ -212,22 +212,22 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
|
|
|
212
212
|
*/
|
|
213
213
|
getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass>;
|
|
214
214
|
/**
|
|
215
|
-
* Retrieves a list of reminders.
|
|
215
|
+
* Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
|
|
216
216
|
* @summary List reminders
|
|
217
217
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
218
218
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
219
219
|
* @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.
|
|
220
|
-
* @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>
|
|
221
|
-
* @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>
|
|
222
|
-
* @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>
|
|
220
|
+
* @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>
|
|
221
|
+
* @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>
|
|
222
|
+
* @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>
|
|
223
223
|
* @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/>
|
|
224
|
-
* @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>
|
|
224
|
+
* @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>
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
228
|
listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRemindersResponseClass>;
|
|
229
229
|
/**
|
|
230
|
-
* This will mark a reminder as done.
|
|
230
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
231
231
|
* @summary Create the reminder done
|
|
232
232
|
* @param {string} code
|
|
233
233
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -236,7 +236,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
|
|
|
236
236
|
*/
|
|
237
237
|
markReminderDone(code: string, authorization?: string, options?: any): AxiosPromise<MarkReminderDoneResponseClass>;
|
|
238
238
|
/**
|
|
239
|
-
* This will patch a reminder.
|
|
239
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
240
240
|
* @summary Update the reminder
|
|
241
241
|
* @param {PatchReminderRequestDto} patchReminderRequestDto
|
|
242
242
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -346,19 +346,19 @@ export interface RemindersApiListRemindersRequest {
|
|
|
346
346
|
*/
|
|
347
347
|
readonly pageToken?: string;
|
|
348
348
|
/**
|
|
349
|
-
* 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>
|
|
349
|
+
* 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>
|
|
350
350
|
* @type {string}
|
|
351
351
|
* @memberof RemindersApiListReminders
|
|
352
352
|
*/
|
|
353
353
|
readonly filter?: string;
|
|
354
354
|
/**
|
|
355
|
-
* 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>
|
|
355
|
+
* 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>
|
|
356
356
|
* @type {string}
|
|
357
357
|
* @memberof RemindersApiListReminders
|
|
358
358
|
*/
|
|
359
359
|
readonly search?: string;
|
|
360
360
|
/**
|
|
361
|
-
* 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>
|
|
361
|
+
* 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>
|
|
362
362
|
* @type {string}
|
|
363
363
|
* @memberof RemindersApiListReminders
|
|
364
364
|
*/
|
|
@@ -370,7 +370,7 @@ export interface RemindersApiListRemindersRequest {
|
|
|
370
370
|
*/
|
|
371
371
|
readonly expand?: string;
|
|
372
372
|
/**
|
|
373
|
-
* 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>
|
|
373
|
+
* 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>
|
|
374
374
|
* @type {string}
|
|
375
375
|
* @memberof RemindersApiListReminders
|
|
376
376
|
*/
|
|
@@ -422,7 +422,7 @@ export interface RemindersApiPatchReminderRequest {
|
|
|
422
422
|
*/
|
|
423
423
|
export declare class RemindersApi extends BaseAPI {
|
|
424
424
|
/**
|
|
425
|
-
* This will create a reminder.
|
|
425
|
+
* This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
|
|
426
426
|
* @summary Create the reminder
|
|
427
427
|
* @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
|
|
428
428
|
* @param {*} [options] Override http request option.
|
|
@@ -431,7 +431,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
431
431
|
*/
|
|
432
432
|
createReminder(requestParameters: RemindersApiCreateReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReminderResponseClass, any, {}>>;
|
|
433
433
|
/**
|
|
434
|
-
* This will delete a reminder.
|
|
434
|
+
* This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
|
|
435
435
|
* @summary Delete the reminder
|
|
436
436
|
* @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
@@ -440,7 +440,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
440
440
|
*/
|
|
441
441
|
deleteReminder(requestParameters: RemindersApiDeleteReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
442
442
|
/**
|
|
443
|
-
* This will get a reminder by code.
|
|
443
|
+
* This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
|
|
444
444
|
* @summary Retrieve the reminder
|
|
445
445
|
* @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
|
|
446
446
|
* @param {*} [options] Override http request option.
|
|
@@ -449,7 +449,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
449
449
|
*/
|
|
450
450
|
getReminder(requestParameters: RemindersApiGetReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderResponseClass, any, {}>>;
|
|
451
451
|
/**
|
|
452
|
-
* This will get reminder counts by status.
|
|
452
|
+
* This will get reminder counts by status. **Required Permissions** \"task-management.tasks.view\"
|
|
453
453
|
* @summary Retrieve the reminder counts
|
|
454
454
|
* @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
|
|
455
455
|
* @param {*} [options] Override http request option.
|
|
@@ -458,7 +458,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
458
458
|
*/
|
|
459
459
|
getReminderCounts(requestParameters?: RemindersApiGetReminderCountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderCountsResponseClass, any, {}>>;
|
|
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 {RemindersApiListRemindersRequest} requestParameters Request parameters.
|
|
464
464
|
* @param {*} [options] Override http request option.
|
|
@@ -467,7 +467,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
467
467
|
*/
|
|
468
468
|
listReminders(requestParameters?: RemindersApiListRemindersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRemindersResponseClass, any, {}>>;
|
|
469
469
|
/**
|
|
470
|
-
* This will mark a reminder as done.
|
|
470
|
+
* This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
|
|
471
471
|
* @summary Create the reminder done
|
|
472
472
|
* @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
|
|
473
473
|
* @param {*} [options] Override http request option.
|
|
@@ -476,7 +476,7 @@ export declare class RemindersApi extends BaseAPI {
|
|
|
476
476
|
*/
|
|
477
477
|
markReminderDone(requestParameters: RemindersApiMarkReminderDoneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MarkReminderDoneResponseClass, any, {}>>;
|
|
478
478
|
/**
|
|
479
|
-
* This will patch a reminder.
|
|
479
|
+
* This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
|
|
480
480
|
* @summary Update the reminder
|
|
481
481
|
* @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
|
|
482
482
|
* @param {*} [options] Override http request option.
|