@emilgroup/task-sdk-node 1.0.1-beta.3 → 1.0.1-beta.35
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 +9 -6
- package/README.md +2 -2
- package/api/assignees-api.ts +166 -0
- package/api/categories-api.ts +111 -85
- package/api/default-api.ts +1 -1
- package/api/hub-spot-api.ts +4 -4
- package/api/statuses-api.ts +71 -73
- package/api/tasks-api.ts +119 -93
- package/api.ts +2 -0
- package/dist/api/assignees-api.d.ts +96 -0
- package/dist/api/assignees-api.js +228 -0
- package/dist/api/categories-api.d.ts +83 -65
- package/dist/api/categories-api.js +75 -65
- package/dist/api/default-api.js +1 -1
- package/dist/api/hub-spot-api.d.ts +4 -4
- package/dist/api/hub-spot-api.js +4 -4
- package/dist/api/statuses-api.d.ts +60 -60
- package/dist/api/statuses-api.js +54 -56
- package/dist/api/tasks-api.d.ts +91 -73
- package/dist/api/tasks-api.js +81 -71
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/assignee-class.d.ts +24 -0
- package/dist/models/create-status-request-dto.d.ts +6 -0
- package/dist/models/create-task-request-dto.d.ts +23 -4
- package/dist/models/create-task-request-dto.js +7 -1
- package/dist/models/index.d.ts +8 -6
- package/dist/models/index.js +8 -6
- package/dist/models/list-assignees-response-class.d.ts +43 -0
- package/dist/models/{update-category-request-dto.d.ts → patch-category-request-dto.d.ts} +7 -7
- package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
- package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +13 -7
- package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
- package/dist/models/patch-task-request-dto.d.ts +139 -0
- package/dist/models/patch-task-request-dto.js +22 -0
- package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
- package/dist/models/patch-task-response-class.js +15 -0
- package/dist/models/status-class.d.ts +6 -0
- package/dist/models/task-class.d.ts +34 -4
- package/models/assignee-class.ts +30 -0
- package/models/create-status-request-dto.ts +6 -0
- package/models/create-task-request-dto.ts +24 -4
- package/models/index.ts +8 -6
- package/models/list-assignees-response-class.ts +49 -0
- package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +7 -7
- package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
- package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +13 -7
- package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
- package/models/patch-task-request-dto.ts +148 -0
- package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
- package/models/status-class.ts +6 -0
- package/models/task-class.ts +34 -4
- package/package.json +2 -2
- package/dist/models/update-task-request-dto.d.ts +0 -72
- package/models/update-task-request-dto.ts +0 -78
- /package/dist/models/{update-category-request-dto.js → assignee-class.js} +0 -0
- /package/dist/models/{update-category-response-class.js → list-assignees-response-class.js} +0 -0
- /package/dist/models/{update-status-request-dto.js → patch-category-request-dto.js} +0 -0
- /package/dist/models/{update-status-response-class.js → patch-category-response-class.js} +0 -0
- /package/dist/models/{update-task-request-dto.js → patch-status-request-dto.js} +0 -0
- /package/dist/models/{update-task-response-class.js → patch-status-response-class.js} +0 -0
package/dist/api/tasks-api.d.ts
CHANGED
|
@@ -16,15 +16,15 @@ import { CreateTaskRequestDto } from '../models';
|
|
|
16
16
|
import { CreateTaskResponseClass } from '../models';
|
|
17
17
|
import { GetTaskResponseClass } from '../models';
|
|
18
18
|
import { ListTasksResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { PatchTaskRequestDto } from '../models';
|
|
20
|
+
import { PatchTaskResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* TasksApi - axios parameter creator
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
25
|
export declare const TasksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create task.
|
|
27
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
28
28
|
* @summary Create the task
|
|
29
29
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -33,7 +33,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
33
33
|
*/
|
|
34
34
|
createTask: (createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* This will delete a task by code.
|
|
36
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
37
37
|
* @summary Delete the task
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -42,38 +42,40 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
42
42
|
*/
|
|
43
43
|
deleteTask: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
* This will get a task by code.
|
|
45
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
46
46
|
* @summary Retrieve the task
|
|
47
47
|
* @param {string} code
|
|
48
|
-
* @param {string} expand
|
|
49
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
|
-
getTask: (code: string,
|
|
53
|
+
getTask: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Retrieves a list of tasks.
|
|
55
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
56
56
|
* @summary List tasks
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {string} [
|
|
60
|
-
* @param {string} [
|
|
61
|
-
* @param {string} [
|
|
62
|
-
* @param {string} [
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
61
|
+
* @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: subject, description</i>
|
|
62
|
+
* @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
|
|
63
|
+
* @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/> <i>Allowed values: categories, status<i>
|
|
64
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
|
-
listTasks: (authorization?: string,
|
|
68
|
+
listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
69
|
/**
|
|
68
|
-
* This will update a task by code.
|
|
70
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
69
71
|
* @summary Update the task
|
|
70
72
|
* @param {string} code
|
|
71
|
-
* @param {
|
|
73
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
72
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
75
|
* @param {*} [options] Override http request option.
|
|
74
76
|
* @throws {RequiredError}
|
|
75
77
|
*/
|
|
76
|
-
|
|
78
|
+
patchTask: (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
79
|
};
|
|
78
80
|
/**
|
|
79
81
|
* TasksApi - functional programming interface
|
|
@@ -81,7 +83,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
81
83
|
*/
|
|
82
84
|
export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
83
85
|
/**
|
|
84
|
-
* This will create task.
|
|
86
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
85
87
|
* @summary Create the task
|
|
86
88
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
87
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +92,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
90
92
|
*/
|
|
91
93
|
createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponseClass>>;
|
|
92
94
|
/**
|
|
93
|
-
* This will delete a task by code.
|
|
95
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
94
96
|
* @summary Delete the task
|
|
95
97
|
* @param {string} code Unique identifier for the object.
|
|
96
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -99,38 +101,40 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
99
101
|
*/
|
|
100
102
|
deleteTask(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
101
103
|
/**
|
|
102
|
-
* This will get a task by code.
|
|
104
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
103
105
|
* @summary Retrieve the task
|
|
104
106
|
* @param {string} code
|
|
105
|
-
* @param {string} expand
|
|
106
107
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
108
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
107
109
|
* @param {*} [options] Override http request option.
|
|
108
110
|
* @throws {RequiredError}
|
|
109
111
|
*/
|
|
110
|
-
getTask(code: string,
|
|
112
|
+
getTask(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>>;
|
|
111
113
|
/**
|
|
112
|
-
* Retrieves a list of tasks.
|
|
114
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
113
115
|
* @summary List tasks
|
|
114
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
|
-
* @param {
|
|
116
|
-
* @param {string} [
|
|
117
|
-
* @param {string} [
|
|
118
|
-
* @param {string} [
|
|
119
|
-
* @param {string} [
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @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.
|
|
119
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
120
|
+
* @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: subject, description</i>
|
|
121
|
+
* @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
|
|
122
|
+
* @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/> <i>Allowed values: categories, status<i>
|
|
123
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
120
124
|
* @param {*} [options] Override http request option.
|
|
121
125
|
* @throws {RequiredError}
|
|
122
126
|
*/
|
|
123
|
-
listTasks(authorization?: string,
|
|
127
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
|
|
124
128
|
/**
|
|
125
|
-
* This will update a task by code.
|
|
129
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
126
130
|
* @summary Update the task
|
|
127
131
|
* @param {string} code
|
|
128
|
-
* @param {
|
|
132
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
129
133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
134
|
* @param {*} [options] Override http request option.
|
|
131
135
|
* @throws {RequiredError}
|
|
132
136
|
*/
|
|
133
|
-
|
|
137
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>>;
|
|
134
138
|
};
|
|
135
139
|
/**
|
|
136
140
|
* TasksApi - factory interface
|
|
@@ -138,7 +142,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
138
142
|
*/
|
|
139
143
|
export declare const TasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
144
|
/**
|
|
141
|
-
* This will create task.
|
|
145
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
142
146
|
* @summary Create the task
|
|
143
147
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
144
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -147,7 +151,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
147
151
|
*/
|
|
148
152
|
createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTaskResponseClass>;
|
|
149
153
|
/**
|
|
150
|
-
* This will delete a task by code.
|
|
154
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
151
155
|
* @summary Delete the task
|
|
152
156
|
* @param {string} code Unique identifier for the object.
|
|
153
157
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -156,38 +160,40 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
156
160
|
*/
|
|
157
161
|
deleteTask(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
158
162
|
/**
|
|
159
|
-
* This will get a task by code.
|
|
163
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
160
164
|
* @summary Retrieve the task
|
|
161
165
|
* @param {string} code
|
|
162
|
-
* @param {string} expand
|
|
163
166
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
167
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
164
168
|
* @param {*} [options] Override http request option.
|
|
165
169
|
* @throws {RequiredError}
|
|
166
170
|
*/
|
|
167
|
-
getTask(code: string,
|
|
171
|
+
getTask(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTaskResponseClass>;
|
|
168
172
|
/**
|
|
169
|
-
* Retrieves a list of tasks.
|
|
173
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
170
174
|
* @summary List tasks
|
|
171
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
172
|
-
* @param {
|
|
173
|
-
* @param {string} [
|
|
174
|
-
* @param {string} [
|
|
175
|
-
* @param {string} [
|
|
176
|
-
* @param {string} [
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @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.
|
|
178
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
179
|
+
* @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: subject, description</i>
|
|
180
|
+
* @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
|
|
181
|
+
* @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/> <i>Allowed values: categories, status<i>
|
|
182
|
+
* @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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
177
183
|
* @param {*} [options] Override http request option.
|
|
178
184
|
* @throws {RequiredError}
|
|
179
185
|
*/
|
|
180
|
-
listTasks(authorization?: string,
|
|
186
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
|
|
181
187
|
/**
|
|
182
|
-
* This will update a task by code.
|
|
188
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
183
189
|
* @summary Update the task
|
|
184
190
|
* @param {string} code
|
|
185
|
-
* @param {
|
|
191
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
186
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
193
|
* @param {*} [options] Override http request option.
|
|
188
194
|
* @throws {RequiredError}
|
|
189
195
|
*/
|
|
190
|
-
|
|
196
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass>;
|
|
191
197
|
};
|
|
192
198
|
/**
|
|
193
199
|
* Request parameters for createTask operation in TasksApi.
|
|
@@ -240,17 +246,17 @@ export interface TasksApiGetTaskRequest {
|
|
|
240
246
|
*/
|
|
241
247
|
readonly code: string;
|
|
242
248
|
/**
|
|
243
|
-
*
|
|
249
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
250
|
* @type {string}
|
|
245
251
|
* @memberof TasksApiGetTask
|
|
246
252
|
*/
|
|
247
|
-
readonly
|
|
253
|
+
readonly authorization?: string;
|
|
248
254
|
/**
|
|
249
|
-
*
|
|
255
|
+
* Expand to fetch additional information about the task.
|
|
250
256
|
* @type {string}
|
|
251
257
|
* @memberof TasksApiGetTask
|
|
252
258
|
*/
|
|
253
|
-
readonly
|
|
259
|
+
readonly expand?: string;
|
|
254
260
|
}
|
|
255
261
|
/**
|
|
256
262
|
* Request parameters for listTasks operation in TasksApi.
|
|
@@ -265,58 +271,70 @@ export interface TasksApiListTasksRequest {
|
|
|
265
271
|
*/
|
|
266
272
|
readonly authorization?: string;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof TasksApiListTasks
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* 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.
|
|
269
281
|
* @type {string}
|
|
270
282
|
* @memberof TasksApiListTasks
|
|
271
283
|
*/
|
|
272
|
-
readonly
|
|
284
|
+
readonly pageToken?: string;
|
|
273
285
|
/**
|
|
274
|
-
*
|
|
286
|
+
* 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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
275
287
|
* @type {string}
|
|
276
288
|
* @memberof TasksApiListTasks
|
|
277
289
|
*/
|
|
278
|
-
readonly
|
|
290
|
+
readonly filter?: string;
|
|
279
291
|
/**
|
|
280
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields:
|
|
292
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
281
293
|
* @type {string}
|
|
282
294
|
* @memberof TasksApiListTasks
|
|
283
295
|
*/
|
|
284
296
|
readonly search?: string;
|
|
285
297
|
/**
|
|
286
|
-
* 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, assignee, reporter, dueDate</i>
|
|
298
|
+
* 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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
|
|
287
299
|
* @type {string}
|
|
288
300
|
* @memberof TasksApiListTasks
|
|
289
301
|
*/
|
|
290
302
|
readonly order?: string;
|
|
291
303
|
/**
|
|
292
|
-
* 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/> <i>Allowed values:
|
|
304
|
+
* 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/> <i>Allowed values: categories, status<i>
|
|
293
305
|
* @type {string}
|
|
294
306
|
* @memberof TasksApiListTasks
|
|
295
307
|
*/
|
|
296
308
|
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* 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, statusId, priority, assignee, reporter, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof TasksApiListTasks
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
297
315
|
}
|
|
298
316
|
/**
|
|
299
|
-
* Request parameters for
|
|
317
|
+
* Request parameters for patchTask operation in TasksApi.
|
|
300
318
|
* @export
|
|
301
|
-
* @interface
|
|
319
|
+
* @interface TasksApiPatchTaskRequest
|
|
302
320
|
*/
|
|
303
|
-
export interface
|
|
321
|
+
export interface TasksApiPatchTaskRequest {
|
|
304
322
|
/**
|
|
305
323
|
*
|
|
306
324
|
* @type {string}
|
|
307
|
-
* @memberof
|
|
325
|
+
* @memberof TasksApiPatchTask
|
|
308
326
|
*/
|
|
309
327
|
readonly code: string;
|
|
310
328
|
/**
|
|
311
329
|
*
|
|
312
|
-
* @type {
|
|
313
|
-
* @memberof
|
|
330
|
+
* @type {PatchTaskRequestDto}
|
|
331
|
+
* @memberof TasksApiPatchTask
|
|
314
332
|
*/
|
|
315
|
-
readonly
|
|
333
|
+
readonly patchTaskRequestDto: PatchTaskRequestDto;
|
|
316
334
|
/**
|
|
317
335
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
336
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
337
|
+
* @memberof TasksApiPatchTask
|
|
320
338
|
*/
|
|
321
339
|
readonly authorization?: string;
|
|
322
340
|
}
|
|
@@ -328,7 +346,7 @@ export interface TasksApiUpdateTaskRequest {
|
|
|
328
346
|
*/
|
|
329
347
|
export declare class TasksApi extends BaseAPI {
|
|
330
348
|
/**
|
|
331
|
-
* This will create task.
|
|
349
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
332
350
|
* @summary Create the task
|
|
333
351
|
* @param {TasksApiCreateTaskRequest} requestParameters Request parameters.
|
|
334
352
|
* @param {*} [options] Override http request option.
|
|
@@ -337,7 +355,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
337
355
|
*/
|
|
338
356
|
createTask(requestParameters: TasksApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}>>;
|
|
339
357
|
/**
|
|
340
|
-
* This will delete a task by code.
|
|
358
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
341
359
|
* @summary Delete the task
|
|
342
360
|
* @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
|
|
343
361
|
* @param {*} [options] Override http request option.
|
|
@@ -346,7 +364,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
346
364
|
*/
|
|
347
365
|
deleteTask(requestParameters: TasksApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
348
366
|
/**
|
|
349
|
-
* This will get a task by code.
|
|
367
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
350
368
|
* @summary Retrieve the task
|
|
351
369
|
* @param {TasksApiGetTaskRequest} requestParameters Request parameters.
|
|
352
370
|
* @param {*} [options] Override http request option.
|
|
@@ -355,7 +373,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
355
373
|
*/
|
|
356
374
|
getTask(requestParameters: TasksApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponseClass, any, {}>>;
|
|
357
375
|
/**
|
|
358
|
-
* Retrieves a list of tasks.
|
|
376
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
359
377
|
* @summary List tasks
|
|
360
378
|
* @param {TasksApiListTasksRequest} requestParameters Request parameters.
|
|
361
379
|
* @param {*} [options] Override http request option.
|
|
@@ -364,12 +382,12 @@ export declare class TasksApi extends BaseAPI {
|
|
|
364
382
|
*/
|
|
365
383
|
listTasks(requestParameters?: TasksApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
|
|
366
384
|
/**
|
|
367
|
-
* This will update a task by code.
|
|
385
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
368
386
|
* @summary Update the task
|
|
369
|
-
* @param {
|
|
387
|
+
* @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
|
|
370
388
|
* @param {*} [options] Override http request option.
|
|
371
389
|
* @throws {RequiredError}
|
|
372
390
|
* @memberof TasksApi
|
|
373
391
|
*/
|
|
374
|
-
|
|
392
|
+
patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}>>;
|
|
375
393
|
}
|