@emilgroup/task-sdk-node 1.2.1-beta.1 → 1.2.1-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +64 -50
- package/api/task-client-api.ts +2144 -0
- package/api.ts +4 -2
- package/dist/api/{default-api.d.ts → health-api.d.ts} +10 -10
- package/dist/api/{default-api.js → health-api.js} +22 -22
- package/dist/api/reminders-api.d.ts +56 -47
- package/dist/api/reminders-api.js +52 -46
- package/dist/api/task-client-api.d.ts +1194 -0
- package/dist/api/task-client-api.js +1842 -0
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/models/create-reminder-request-dto.d.ts +9 -2
- package/dist/models/create-reminder-request-dto.js +7 -0
- package/dist/models/get-reminder-counts-response-class.d.ts +12 -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/get-reminder-counts-response-class.ts +12 -0
- package/models/patch-reminder-request-dto.ts +28 -0
- package/package.json +2 -2
|
@@ -0,0 +1,1194 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL TaskService
|
|
3
|
+
* The EMIL Task API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateCategoryRequestDto } from '../models';
|
|
16
|
+
import { CreateCategoryResponseClass } from '../models';
|
|
17
|
+
import { CreateHubSpotTicketRequestDto } from '../models';
|
|
18
|
+
import { CreateHubSpotTicketResponseClass } from '../models';
|
|
19
|
+
import { CreateStatusRequestDto } from '../models';
|
|
20
|
+
import { CreateStatusResponseClass } from '../models';
|
|
21
|
+
import { CreateTaskRequestDto } from '../models';
|
|
22
|
+
import { CreateTaskResponseClass } from '../models';
|
|
23
|
+
import { GetCategoryResponseClass } from '../models';
|
|
24
|
+
import { GetStatusResponseClass } from '../models';
|
|
25
|
+
import { GetTaskResponseClass } from '../models';
|
|
26
|
+
import { ListAssigneesResponseClass } from '../models';
|
|
27
|
+
import { ListCategoriesResponseClass } from '../models';
|
|
28
|
+
import { ListStatusesResponseClass } from '../models';
|
|
29
|
+
import { ListTasksResponseClass } from '../models';
|
|
30
|
+
import { PatchCategoryRequestDto } from '../models';
|
|
31
|
+
import { PatchCategoryResponseClass } from '../models';
|
|
32
|
+
import { PatchStatusRequestDto } from '../models';
|
|
33
|
+
import { PatchStatusResponseClass } from '../models';
|
|
34
|
+
import { PatchTaskRequestDto } from '../models';
|
|
35
|
+
import { PatchTaskResponseClass } from '../models';
|
|
36
|
+
/**
|
|
37
|
+
* TaskClientApi - axios parameter creator
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const TaskClientApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
41
|
+
/**
|
|
42
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
43
|
+
* @summary Create the category
|
|
44
|
+
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
45
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
createCategory: (createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
52
|
+
* @summary Create the hub spot ticket
|
|
53
|
+
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
54
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
createHubSpotTicket: (createHubSpotTicketRequestDto: CreateHubSpotTicketRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* This will create a status. **Required Permissions** \"task-management.tasks.create\"
|
|
61
|
+
* @summary Create the status
|
|
62
|
+
* @param {CreateStatusRequestDto} createStatusRequestDto
|
|
63
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
createStatus: (createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
70
|
+
* @summary Create the task
|
|
71
|
+
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
72
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
createTask: (createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
/**
|
|
78
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
79
|
+
* @summary Delete the category
|
|
80
|
+
* @param {string} code Unique identifier for the object.
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
deleteCategory: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
/**
|
|
87
|
+
* This will delete status. **Required Permissions** \"task-management.tasks.delete\"
|
|
88
|
+
* @summary Delete the status
|
|
89
|
+
* @param {string} code Unique identifier for the object.
|
|
90
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
deleteStatus: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
|
+
/**
|
|
96
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
97
|
+
* @summary Delete the task
|
|
98
|
+
* @param {string} code Unique identifier for the object.
|
|
99
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
deleteTask: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
106
|
+
* @summary Retrieve the category
|
|
107
|
+
* @param {string} code
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
getCategory: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
+
/**
|
|
115
|
+
* Get status by code. **Required Permissions** \"task-management.tasks.view\"
|
|
116
|
+
* @summary Retrieve the status
|
|
117
|
+
* @param {string} code
|
|
118
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
119
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
getStatus: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
|
+
/**
|
|
125
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
126
|
+
* @summary Retrieve the task
|
|
127
|
+
* @param {string} code
|
|
128
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
getTask: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
134
|
+
/**
|
|
135
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
136
|
+
* @summary List assignees
|
|
137
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
138
|
+
* @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/>
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
listAssignees: (authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
143
|
+
/**
|
|
144
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
145
|
+
* @summary List categories
|
|
146
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
|
+
* @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.
|
|
149
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
150
|
+
* @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: name, slug</i>
|
|
151
|
+
* @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, name, slug</i>
|
|
152
|
+
* @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/>
|
|
153
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
listCategories: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
158
|
+
/**
|
|
159
|
+
* Retrieves a list of statuses. **Required Permissions** \"task-management.tasks.view\"
|
|
160
|
+
* @summary List statuses
|
|
161
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
163
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
164
|
+
* @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, name, slug</i>
|
|
165
|
+
* @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, name, slug</i>
|
|
166
|
+
* @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/>
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
listStatuses: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
171
|
+
/**
|
|
172
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
173
|
+
* @summary List tasks
|
|
174
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
175
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
176
|
+
* @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.
|
|
177
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
178
|
+
* @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>
|
|
179
|
+
* @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>
|
|
180
|
+
* @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>
|
|
181
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
*/
|
|
185
|
+
listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
186
|
+
/**
|
|
187
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
188
|
+
* @summary Update the category
|
|
189
|
+
* @param {string} code
|
|
190
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
191
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
patchCategory: (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
196
|
+
/**
|
|
197
|
+
* This will partially update a status by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
198
|
+
* @summary Update the status
|
|
199
|
+
* @param {string} code
|
|
200
|
+
* @param {PatchStatusRequestDto} patchStatusRequestDto
|
|
201
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
patchStatus: (code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
206
|
+
/**
|
|
207
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
208
|
+
* @summary Update the task
|
|
209
|
+
* @param {string} code
|
|
210
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
211
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
+
* @param {*} [options] Override http request option.
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
patchTask: (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
216
|
+
};
|
|
217
|
+
/**
|
|
218
|
+
* TaskClientApi - functional programming interface
|
|
219
|
+
* @export
|
|
220
|
+
*/
|
|
221
|
+
export declare const TaskClientApiFp: (configuration?: Configuration) => {
|
|
222
|
+
/**
|
|
223
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
224
|
+
* @summary Create the category
|
|
225
|
+
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
226
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCategoryResponseClass>>;
|
|
231
|
+
/**
|
|
232
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
233
|
+
* @summary Create the hub spot ticket
|
|
234
|
+
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
235
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
createHubSpotTicket(createHubSpotTicketRequestDto: CreateHubSpotTicketRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateHubSpotTicketResponseClass>>;
|
|
240
|
+
/**
|
|
241
|
+
* This will create a status. **Required Permissions** \"task-management.tasks.create\"
|
|
242
|
+
* @summary Create the status
|
|
243
|
+
* @param {CreateStatusRequestDto} createStatusRequestDto
|
|
244
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
createStatus(createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStatusResponseClass>>;
|
|
249
|
+
/**
|
|
250
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
251
|
+
* @summary Create the task
|
|
252
|
+
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
253
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponseClass>>;
|
|
258
|
+
/**
|
|
259
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
260
|
+
* @summary Delete the category
|
|
261
|
+
* @param {string} code Unique identifier for the object.
|
|
262
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
deleteCategory(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
267
|
+
/**
|
|
268
|
+
* This will delete status. **Required Permissions** \"task-management.tasks.delete\"
|
|
269
|
+
* @summary Delete the status
|
|
270
|
+
* @param {string} code Unique identifier for the object.
|
|
271
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
*/
|
|
275
|
+
deleteStatus(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
276
|
+
/**
|
|
277
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
278
|
+
* @summary Delete the task
|
|
279
|
+
* @param {string} code Unique identifier for the object.
|
|
280
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
deleteTask(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
285
|
+
/**
|
|
286
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
287
|
+
* @summary Retrieve the category
|
|
288
|
+
* @param {string} code
|
|
289
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
290
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
291
|
+
* @param {*} [options] Override http request option.
|
|
292
|
+
* @throws {RequiredError}
|
|
293
|
+
*/
|
|
294
|
+
getCategory(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCategoryResponseClass>>;
|
|
295
|
+
/**
|
|
296
|
+
* Get status by code. **Required Permissions** \"task-management.tasks.view\"
|
|
297
|
+
* @summary Retrieve the status
|
|
298
|
+
* @param {string} code
|
|
299
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
300
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
301
|
+
* @param {*} [options] Override http request option.
|
|
302
|
+
* @throws {RequiredError}
|
|
303
|
+
*/
|
|
304
|
+
getStatus(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatusResponseClass>>;
|
|
305
|
+
/**
|
|
306
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
307
|
+
* @summary Retrieve the task
|
|
308
|
+
* @param {string} code
|
|
309
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
310
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
*/
|
|
314
|
+
getTask(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>>;
|
|
315
|
+
/**
|
|
316
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
317
|
+
* @summary List assignees
|
|
318
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
319
|
+
* @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/>
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>>;
|
|
324
|
+
/**
|
|
325
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
326
|
+
* @summary List categories
|
|
327
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
328
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
329
|
+
* @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.
|
|
330
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
331
|
+
* @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: name, slug</i>
|
|
332
|
+
* @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, name, slug</i>
|
|
333
|
+
* @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/>
|
|
334
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
335
|
+
* @param {*} [options] Override http request option.
|
|
336
|
+
* @throws {RequiredError}
|
|
337
|
+
*/
|
|
338
|
+
listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>>;
|
|
339
|
+
/**
|
|
340
|
+
* Retrieves a list of statuses. **Required Permissions** \"task-management.tasks.view\"
|
|
341
|
+
* @summary List statuses
|
|
342
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
344
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
345
|
+
* @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, name, slug</i>
|
|
346
|
+
* @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, name, slug</i>
|
|
347
|
+
* @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/>
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatusesResponseClass>>;
|
|
352
|
+
/**
|
|
353
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
354
|
+
* @summary List tasks
|
|
355
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
356
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
357
|
+
* @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.
|
|
358
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
359
|
+
* @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>
|
|
360
|
+
* @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>
|
|
361
|
+
* @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>
|
|
362
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
363
|
+
* @param {*} [options] Override http request option.
|
|
364
|
+
* @throws {RequiredError}
|
|
365
|
+
*/
|
|
366
|
+
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>>;
|
|
367
|
+
/**
|
|
368
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
369
|
+
* @summary Update the category
|
|
370
|
+
* @param {string} code
|
|
371
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
372
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>>;
|
|
377
|
+
/**
|
|
378
|
+
* This will partially update a status by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
379
|
+
* @summary Update the status
|
|
380
|
+
* @param {string} code
|
|
381
|
+
* @param {PatchStatusRequestDto} patchStatusRequestDto
|
|
382
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
383
|
+
* @param {*} [options] Override http request option.
|
|
384
|
+
* @throws {RequiredError}
|
|
385
|
+
*/
|
|
386
|
+
patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStatusResponseClass>>;
|
|
387
|
+
/**
|
|
388
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
389
|
+
* @summary Update the task
|
|
390
|
+
* @param {string} code
|
|
391
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
392
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
393
|
+
* @param {*} [options] Override http request option.
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
*/
|
|
396
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>>;
|
|
397
|
+
};
|
|
398
|
+
/**
|
|
399
|
+
* TaskClientApi - factory interface
|
|
400
|
+
* @export
|
|
401
|
+
*/
|
|
402
|
+
export declare const TaskClientApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
403
|
+
/**
|
|
404
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
405
|
+
* @summary Create the category
|
|
406
|
+
* @param {CreateCategoryRequestDto} createCategoryRequestDto
|
|
407
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
408
|
+
* @param {*} [options] Override http request option.
|
|
409
|
+
* @throws {RequiredError}
|
|
410
|
+
*/
|
|
411
|
+
createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCategoryResponseClass>;
|
|
412
|
+
/**
|
|
413
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
414
|
+
* @summary Create the hub spot ticket
|
|
415
|
+
* @param {CreateHubSpotTicketRequestDto} createHubSpotTicketRequestDto
|
|
416
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
417
|
+
* @param {*} [options] Override http request option.
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
createHubSpotTicket(createHubSpotTicketRequestDto: CreateHubSpotTicketRequestDto, authorization?: string, options?: any): AxiosPromise<CreateHubSpotTicketResponseClass>;
|
|
421
|
+
/**
|
|
422
|
+
* This will create a status. **Required Permissions** \"task-management.tasks.create\"
|
|
423
|
+
* @summary Create the status
|
|
424
|
+
* @param {CreateStatusRequestDto} createStatusRequestDto
|
|
425
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
|
+
* @param {*} [options] Override http request option.
|
|
427
|
+
* @throws {RequiredError}
|
|
428
|
+
*/
|
|
429
|
+
createStatus(createStatusRequestDto: CreateStatusRequestDto, authorization?: string, options?: any): AxiosPromise<CreateStatusResponseClass>;
|
|
430
|
+
/**
|
|
431
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
432
|
+
* @summary Create the task
|
|
433
|
+
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
434
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
|
+
* @param {*} [options] Override http request option.
|
|
436
|
+
* @throws {RequiredError}
|
|
437
|
+
*/
|
|
438
|
+
createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTaskResponseClass>;
|
|
439
|
+
/**
|
|
440
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
441
|
+
* @summary Delete the category
|
|
442
|
+
* @param {string} code Unique identifier for the object.
|
|
443
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
444
|
+
* @param {*} [options] Override http request option.
|
|
445
|
+
* @throws {RequiredError}
|
|
446
|
+
*/
|
|
447
|
+
deleteCategory(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
448
|
+
/**
|
|
449
|
+
* This will delete status. **Required Permissions** \"task-management.tasks.delete\"
|
|
450
|
+
* @summary Delete the status
|
|
451
|
+
* @param {string} code Unique identifier for the object.
|
|
452
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
|
+
* @param {*} [options] Override http request option.
|
|
454
|
+
* @throws {RequiredError}
|
|
455
|
+
*/
|
|
456
|
+
deleteStatus(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
457
|
+
/**
|
|
458
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
459
|
+
* @summary Delete the task
|
|
460
|
+
* @param {string} code Unique identifier for the object.
|
|
461
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
*/
|
|
465
|
+
deleteTask(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
466
|
+
/**
|
|
467
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
468
|
+
* @summary Retrieve the category
|
|
469
|
+
* @param {string} code
|
|
470
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
471
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
getCategory(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCategoryResponseClass>;
|
|
476
|
+
/**
|
|
477
|
+
* Get status by code. **Required Permissions** \"task-management.tasks.view\"
|
|
478
|
+
* @summary Retrieve the status
|
|
479
|
+
* @param {string} code
|
|
480
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
481
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
482
|
+
* @param {*} [options] Override http request option.
|
|
483
|
+
* @throws {RequiredError}
|
|
484
|
+
*/
|
|
485
|
+
getStatus(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetStatusResponseClass>;
|
|
486
|
+
/**
|
|
487
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
488
|
+
* @summary Retrieve the task
|
|
489
|
+
* @param {string} code
|
|
490
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
491
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
492
|
+
* @param {*} [options] Override http request option.
|
|
493
|
+
* @throws {RequiredError}
|
|
494
|
+
*/
|
|
495
|
+
getTask(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTaskResponseClass>;
|
|
496
|
+
/**
|
|
497
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
498
|
+
* @summary List assignees
|
|
499
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
500
|
+
* @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/>
|
|
501
|
+
* @param {*} [options] Override http request option.
|
|
502
|
+
* @throws {RequiredError}
|
|
503
|
+
*/
|
|
504
|
+
listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass>;
|
|
505
|
+
/**
|
|
506
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
507
|
+
* @summary List categories
|
|
508
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
509
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
510
|
+
* @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.
|
|
511
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
512
|
+
* @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: name, slug</i>
|
|
513
|
+
* @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, name, slug</i>
|
|
514
|
+
* @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/>
|
|
515
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
516
|
+
* @param {*} [options] Override http request option.
|
|
517
|
+
* @throws {RequiredError}
|
|
518
|
+
*/
|
|
519
|
+
listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCategoriesResponseClass>;
|
|
520
|
+
/**
|
|
521
|
+
* Retrieves a list of statuses. **Required Permissions** \"task-management.tasks.view\"
|
|
522
|
+
* @summary List statuses
|
|
523
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
525
|
+
* @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, slug, name, createdAt, updatedAt</i>
|
|
526
|
+
* @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, name, slug</i>
|
|
527
|
+
* @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, name, slug</i>
|
|
528
|
+
* @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/>
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
*/
|
|
532
|
+
listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListStatusesResponseClass>;
|
|
533
|
+
/**
|
|
534
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
535
|
+
* @summary List tasks
|
|
536
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
537
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
538
|
+
* @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.
|
|
539
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
540
|
+
* @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>
|
|
541
|
+
* @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>
|
|
542
|
+
* @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>
|
|
543
|
+
* @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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
544
|
+
* @param {*} [options] Override http request option.
|
|
545
|
+
* @throws {RequiredError}
|
|
546
|
+
*/
|
|
547
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
|
|
548
|
+
/**
|
|
549
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
550
|
+
* @summary Update the category
|
|
551
|
+
* @param {string} code
|
|
552
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
553
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
*/
|
|
557
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass>;
|
|
558
|
+
/**
|
|
559
|
+
* This will partially update a status by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
560
|
+
* @summary Update the status
|
|
561
|
+
* @param {string} code
|
|
562
|
+
* @param {PatchStatusRequestDto} patchStatusRequestDto
|
|
563
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
564
|
+
* @param {*} [options] Override http request option.
|
|
565
|
+
* @throws {RequiredError}
|
|
566
|
+
*/
|
|
567
|
+
patchStatus(code: string, patchStatusRequestDto: PatchStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchStatusResponseClass>;
|
|
568
|
+
/**
|
|
569
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
570
|
+
* @summary Update the task
|
|
571
|
+
* @param {string} code
|
|
572
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
573
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
574
|
+
* @param {*} [options] Override http request option.
|
|
575
|
+
* @throws {RequiredError}
|
|
576
|
+
*/
|
|
577
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass>;
|
|
578
|
+
};
|
|
579
|
+
/**
|
|
580
|
+
* Request parameters for createCategory operation in TaskClientApi.
|
|
581
|
+
* @export
|
|
582
|
+
* @interface TaskClientApiCreateCategoryRequest
|
|
583
|
+
*/
|
|
584
|
+
export interface TaskClientApiCreateCategoryRequest {
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @type {CreateCategoryRequestDto}
|
|
588
|
+
* @memberof TaskClientApiCreateCategory
|
|
589
|
+
*/
|
|
590
|
+
readonly createCategoryRequestDto: CreateCategoryRequestDto;
|
|
591
|
+
/**
|
|
592
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof TaskClientApiCreateCategory
|
|
595
|
+
*/
|
|
596
|
+
readonly authorization?: string;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Request parameters for createHubSpotTicket operation in TaskClientApi.
|
|
600
|
+
* @export
|
|
601
|
+
* @interface TaskClientApiCreateHubSpotTicketRequest
|
|
602
|
+
*/
|
|
603
|
+
export interface TaskClientApiCreateHubSpotTicketRequest {
|
|
604
|
+
/**
|
|
605
|
+
*
|
|
606
|
+
* @type {CreateHubSpotTicketRequestDto}
|
|
607
|
+
* @memberof TaskClientApiCreateHubSpotTicket
|
|
608
|
+
*/
|
|
609
|
+
readonly createHubSpotTicketRequestDto: CreateHubSpotTicketRequestDto;
|
|
610
|
+
/**
|
|
611
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
612
|
+
* @type {string}
|
|
613
|
+
* @memberof TaskClientApiCreateHubSpotTicket
|
|
614
|
+
*/
|
|
615
|
+
readonly authorization?: string;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* Request parameters for createStatus operation in TaskClientApi.
|
|
619
|
+
* @export
|
|
620
|
+
* @interface TaskClientApiCreateStatusRequest
|
|
621
|
+
*/
|
|
622
|
+
export interface TaskClientApiCreateStatusRequest {
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {CreateStatusRequestDto}
|
|
626
|
+
* @memberof TaskClientApiCreateStatus
|
|
627
|
+
*/
|
|
628
|
+
readonly createStatusRequestDto: CreateStatusRequestDto;
|
|
629
|
+
/**
|
|
630
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
631
|
+
* @type {string}
|
|
632
|
+
* @memberof TaskClientApiCreateStatus
|
|
633
|
+
*/
|
|
634
|
+
readonly authorization?: string;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* Request parameters for createTask operation in TaskClientApi.
|
|
638
|
+
* @export
|
|
639
|
+
* @interface TaskClientApiCreateTaskRequest
|
|
640
|
+
*/
|
|
641
|
+
export interface TaskClientApiCreateTaskRequest {
|
|
642
|
+
/**
|
|
643
|
+
*
|
|
644
|
+
* @type {CreateTaskRequestDto}
|
|
645
|
+
* @memberof TaskClientApiCreateTask
|
|
646
|
+
*/
|
|
647
|
+
readonly createTaskRequestDto: CreateTaskRequestDto;
|
|
648
|
+
/**
|
|
649
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
650
|
+
* @type {string}
|
|
651
|
+
* @memberof TaskClientApiCreateTask
|
|
652
|
+
*/
|
|
653
|
+
readonly authorization?: string;
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* Request parameters for deleteCategory operation in TaskClientApi.
|
|
657
|
+
* @export
|
|
658
|
+
* @interface TaskClientApiDeleteCategoryRequest
|
|
659
|
+
*/
|
|
660
|
+
export interface TaskClientApiDeleteCategoryRequest {
|
|
661
|
+
/**
|
|
662
|
+
* Unique identifier for the object.
|
|
663
|
+
* @type {string}
|
|
664
|
+
* @memberof TaskClientApiDeleteCategory
|
|
665
|
+
*/
|
|
666
|
+
readonly code: string;
|
|
667
|
+
/**
|
|
668
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
669
|
+
* @type {string}
|
|
670
|
+
* @memberof TaskClientApiDeleteCategory
|
|
671
|
+
*/
|
|
672
|
+
readonly authorization?: string;
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* Request parameters for deleteStatus operation in TaskClientApi.
|
|
676
|
+
* @export
|
|
677
|
+
* @interface TaskClientApiDeleteStatusRequest
|
|
678
|
+
*/
|
|
679
|
+
export interface TaskClientApiDeleteStatusRequest {
|
|
680
|
+
/**
|
|
681
|
+
* Unique identifier for the object.
|
|
682
|
+
* @type {string}
|
|
683
|
+
* @memberof TaskClientApiDeleteStatus
|
|
684
|
+
*/
|
|
685
|
+
readonly code: string;
|
|
686
|
+
/**
|
|
687
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
688
|
+
* @type {string}
|
|
689
|
+
* @memberof TaskClientApiDeleteStatus
|
|
690
|
+
*/
|
|
691
|
+
readonly authorization?: string;
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* Request parameters for deleteTask operation in TaskClientApi.
|
|
695
|
+
* @export
|
|
696
|
+
* @interface TaskClientApiDeleteTaskRequest
|
|
697
|
+
*/
|
|
698
|
+
export interface TaskClientApiDeleteTaskRequest {
|
|
699
|
+
/**
|
|
700
|
+
* Unique identifier for the object.
|
|
701
|
+
* @type {string}
|
|
702
|
+
* @memberof TaskClientApiDeleteTask
|
|
703
|
+
*/
|
|
704
|
+
readonly code: string;
|
|
705
|
+
/**
|
|
706
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
707
|
+
* @type {string}
|
|
708
|
+
* @memberof TaskClientApiDeleteTask
|
|
709
|
+
*/
|
|
710
|
+
readonly authorization?: string;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Request parameters for getCategory operation in TaskClientApi.
|
|
714
|
+
* @export
|
|
715
|
+
* @interface TaskClientApiGetCategoryRequest
|
|
716
|
+
*/
|
|
717
|
+
export interface TaskClientApiGetCategoryRequest {
|
|
718
|
+
/**
|
|
719
|
+
*
|
|
720
|
+
* @type {string}
|
|
721
|
+
* @memberof TaskClientApiGetCategory
|
|
722
|
+
*/
|
|
723
|
+
readonly code: string;
|
|
724
|
+
/**
|
|
725
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
726
|
+
* @type {string}
|
|
727
|
+
* @memberof TaskClientApiGetCategory
|
|
728
|
+
*/
|
|
729
|
+
readonly authorization?: string;
|
|
730
|
+
/**
|
|
731
|
+
* Expand to fetch additional information about the category.
|
|
732
|
+
* @type {string}
|
|
733
|
+
* @memberof TaskClientApiGetCategory
|
|
734
|
+
*/
|
|
735
|
+
readonly expand?: string;
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* Request parameters for getStatus operation in TaskClientApi.
|
|
739
|
+
* @export
|
|
740
|
+
* @interface TaskClientApiGetStatusRequest
|
|
741
|
+
*/
|
|
742
|
+
export interface TaskClientApiGetStatusRequest {
|
|
743
|
+
/**
|
|
744
|
+
*
|
|
745
|
+
* @type {string}
|
|
746
|
+
* @memberof TaskClientApiGetStatus
|
|
747
|
+
*/
|
|
748
|
+
readonly code: string;
|
|
749
|
+
/**
|
|
750
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
751
|
+
* @type {string}
|
|
752
|
+
* @memberof TaskClientApiGetStatus
|
|
753
|
+
*/
|
|
754
|
+
readonly authorization?: string;
|
|
755
|
+
/**
|
|
756
|
+
* Expand to fetch additional information about the status.
|
|
757
|
+
* @type {string}
|
|
758
|
+
* @memberof TaskClientApiGetStatus
|
|
759
|
+
*/
|
|
760
|
+
readonly expand?: string;
|
|
761
|
+
}
|
|
762
|
+
/**
|
|
763
|
+
* Request parameters for getTask operation in TaskClientApi.
|
|
764
|
+
* @export
|
|
765
|
+
* @interface TaskClientApiGetTaskRequest
|
|
766
|
+
*/
|
|
767
|
+
export interface TaskClientApiGetTaskRequest {
|
|
768
|
+
/**
|
|
769
|
+
*
|
|
770
|
+
* @type {string}
|
|
771
|
+
* @memberof TaskClientApiGetTask
|
|
772
|
+
*/
|
|
773
|
+
readonly code: string;
|
|
774
|
+
/**
|
|
775
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
776
|
+
* @type {string}
|
|
777
|
+
* @memberof TaskClientApiGetTask
|
|
778
|
+
*/
|
|
779
|
+
readonly authorization?: string;
|
|
780
|
+
/**
|
|
781
|
+
* Expand to fetch additional information about the task.
|
|
782
|
+
* @type {string}
|
|
783
|
+
* @memberof TaskClientApiGetTask
|
|
784
|
+
*/
|
|
785
|
+
readonly expand?: string;
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* Request parameters for listAssignees operation in TaskClientApi.
|
|
789
|
+
* @export
|
|
790
|
+
* @interface TaskClientApiListAssigneesRequest
|
|
791
|
+
*/
|
|
792
|
+
export interface TaskClientApiListAssigneesRequest {
|
|
793
|
+
/**
|
|
794
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
795
|
+
* @type {string}
|
|
796
|
+
* @memberof TaskClientApiListAssignees
|
|
797
|
+
*/
|
|
798
|
+
readonly authorization?: string;
|
|
799
|
+
/**
|
|
800
|
+
* 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/>
|
|
801
|
+
* @type {string}
|
|
802
|
+
* @memberof TaskClientApiListAssignees
|
|
803
|
+
*/
|
|
804
|
+
readonly expand?: string;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* Request parameters for listCategories operation in TaskClientApi.
|
|
808
|
+
* @export
|
|
809
|
+
* @interface TaskClientApiListCategoriesRequest
|
|
810
|
+
*/
|
|
811
|
+
export interface TaskClientApiListCategoriesRequest {
|
|
812
|
+
/**
|
|
813
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
814
|
+
* @type {string}
|
|
815
|
+
* @memberof TaskClientApiListCategories
|
|
816
|
+
*/
|
|
817
|
+
readonly authorization?: string;
|
|
818
|
+
/**
|
|
819
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
820
|
+
* @type {number}
|
|
821
|
+
* @memberof TaskClientApiListCategories
|
|
822
|
+
*/
|
|
823
|
+
readonly pageSize?: number;
|
|
824
|
+
/**
|
|
825
|
+
* 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.
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof TaskClientApiListCategories
|
|
828
|
+
*/
|
|
829
|
+
readonly pageToken?: string;
|
|
830
|
+
/**
|
|
831
|
+
* 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, slug, name, createdAt, updatedAt</i>
|
|
832
|
+
* @type {string}
|
|
833
|
+
* @memberof TaskClientApiListCategories
|
|
834
|
+
*/
|
|
835
|
+
readonly filter?: string;
|
|
836
|
+
/**
|
|
837
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
838
|
+
* @type {string}
|
|
839
|
+
* @memberof TaskClientApiListCategories
|
|
840
|
+
*/
|
|
841
|
+
readonly search?: string;
|
|
842
|
+
/**
|
|
843
|
+
* 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, name, slug</i>
|
|
844
|
+
* @type {string}
|
|
845
|
+
* @memberof TaskClientApiListCategories
|
|
846
|
+
*/
|
|
847
|
+
readonly order?: string;
|
|
848
|
+
/**
|
|
849
|
+
* 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/>
|
|
850
|
+
* @type {string}
|
|
851
|
+
* @memberof TaskClientApiListCategories
|
|
852
|
+
*/
|
|
853
|
+
readonly expand?: string;
|
|
854
|
+
/**
|
|
855
|
+
* 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, slug, name, createdAt, updatedAt</i>
|
|
856
|
+
* @type {string}
|
|
857
|
+
* @memberof TaskClientApiListCategories
|
|
858
|
+
*/
|
|
859
|
+
readonly filters?: string;
|
|
860
|
+
}
|
|
861
|
+
/**
|
|
862
|
+
* Request parameters for listStatuses operation in TaskClientApi.
|
|
863
|
+
* @export
|
|
864
|
+
* @interface TaskClientApiListStatusesRequest
|
|
865
|
+
*/
|
|
866
|
+
export interface TaskClientApiListStatusesRequest {
|
|
867
|
+
/**
|
|
868
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
869
|
+
* @type {string}
|
|
870
|
+
* @memberof TaskClientApiListStatuses
|
|
871
|
+
*/
|
|
872
|
+
readonly authorization?: string;
|
|
873
|
+
/**
|
|
874
|
+
* 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, slug, name, createdAt, updatedAt</i>
|
|
875
|
+
* @type {string}
|
|
876
|
+
* @memberof TaskClientApiListStatuses
|
|
877
|
+
*/
|
|
878
|
+
readonly filter?: string;
|
|
879
|
+
/**
|
|
880
|
+
* 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, slug, name, createdAt, updatedAt</i>
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof TaskClientApiListStatuses
|
|
883
|
+
*/
|
|
884
|
+
readonly filters?: string;
|
|
885
|
+
/**
|
|
886
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, name, slug</i>
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof TaskClientApiListStatuses
|
|
889
|
+
*/
|
|
890
|
+
readonly search?: string;
|
|
891
|
+
/**
|
|
892
|
+
* 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, name, slug</i>
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof TaskClientApiListStatuses
|
|
895
|
+
*/
|
|
896
|
+
readonly order?: string;
|
|
897
|
+
/**
|
|
898
|
+
* 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/>
|
|
899
|
+
* @type {string}
|
|
900
|
+
* @memberof TaskClientApiListStatuses
|
|
901
|
+
*/
|
|
902
|
+
readonly expand?: string;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* Request parameters for listTasks operation in TaskClientApi.
|
|
906
|
+
* @export
|
|
907
|
+
* @interface TaskClientApiListTasksRequest
|
|
908
|
+
*/
|
|
909
|
+
export interface TaskClientApiListTasksRequest {
|
|
910
|
+
/**
|
|
911
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof TaskClientApiListTasks
|
|
914
|
+
*/
|
|
915
|
+
readonly authorization?: string;
|
|
916
|
+
/**
|
|
917
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
918
|
+
* @type {number}
|
|
919
|
+
* @memberof TaskClientApiListTasks
|
|
920
|
+
*/
|
|
921
|
+
readonly pageSize?: number;
|
|
922
|
+
/**
|
|
923
|
+
* 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.
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof TaskClientApiListTasks
|
|
926
|
+
*/
|
|
927
|
+
readonly pageToken?: string;
|
|
928
|
+
/**
|
|
929
|
+
* 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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof TaskClientApiListTasks
|
|
932
|
+
*/
|
|
933
|
+
readonly filter?: string;
|
|
934
|
+
/**
|
|
935
|
+
* 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>
|
|
936
|
+
* @type {string}
|
|
937
|
+
* @memberof TaskClientApiListTasks
|
|
938
|
+
*/
|
|
939
|
+
readonly search?: string;
|
|
940
|
+
/**
|
|
941
|
+
* 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>
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof TaskClientApiListTasks
|
|
944
|
+
*/
|
|
945
|
+
readonly order?: string;
|
|
946
|
+
/**
|
|
947
|
+
* 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>
|
|
948
|
+
* @type {string}
|
|
949
|
+
* @memberof TaskClientApiListTasks
|
|
950
|
+
*/
|
|
951
|
+
readonly expand?: string;
|
|
952
|
+
/**
|
|
953
|
+
* 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, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof TaskClientApiListTasks
|
|
956
|
+
*/
|
|
957
|
+
readonly filters?: string;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* Request parameters for patchCategory operation in TaskClientApi.
|
|
961
|
+
* @export
|
|
962
|
+
* @interface TaskClientApiPatchCategoryRequest
|
|
963
|
+
*/
|
|
964
|
+
export interface TaskClientApiPatchCategoryRequest {
|
|
965
|
+
/**
|
|
966
|
+
*
|
|
967
|
+
* @type {string}
|
|
968
|
+
* @memberof TaskClientApiPatchCategory
|
|
969
|
+
*/
|
|
970
|
+
readonly code: string;
|
|
971
|
+
/**
|
|
972
|
+
*
|
|
973
|
+
* @type {PatchCategoryRequestDto}
|
|
974
|
+
* @memberof TaskClientApiPatchCategory
|
|
975
|
+
*/
|
|
976
|
+
readonly patchCategoryRequestDto: PatchCategoryRequestDto;
|
|
977
|
+
/**
|
|
978
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
979
|
+
* @type {string}
|
|
980
|
+
* @memberof TaskClientApiPatchCategory
|
|
981
|
+
*/
|
|
982
|
+
readonly authorization?: string;
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* Request parameters for patchStatus operation in TaskClientApi.
|
|
986
|
+
* @export
|
|
987
|
+
* @interface TaskClientApiPatchStatusRequest
|
|
988
|
+
*/
|
|
989
|
+
export interface TaskClientApiPatchStatusRequest {
|
|
990
|
+
/**
|
|
991
|
+
*
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof TaskClientApiPatchStatus
|
|
994
|
+
*/
|
|
995
|
+
readonly code: string;
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @type {PatchStatusRequestDto}
|
|
999
|
+
* @memberof TaskClientApiPatchStatus
|
|
1000
|
+
*/
|
|
1001
|
+
readonly patchStatusRequestDto: PatchStatusRequestDto;
|
|
1002
|
+
/**
|
|
1003
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1004
|
+
* @type {string}
|
|
1005
|
+
* @memberof TaskClientApiPatchStatus
|
|
1006
|
+
*/
|
|
1007
|
+
readonly authorization?: string;
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* Request parameters for patchTask operation in TaskClientApi.
|
|
1011
|
+
* @export
|
|
1012
|
+
* @interface TaskClientApiPatchTaskRequest
|
|
1013
|
+
*/
|
|
1014
|
+
export interface TaskClientApiPatchTaskRequest {
|
|
1015
|
+
/**
|
|
1016
|
+
*
|
|
1017
|
+
* @type {string}
|
|
1018
|
+
* @memberof TaskClientApiPatchTask
|
|
1019
|
+
*/
|
|
1020
|
+
readonly code: string;
|
|
1021
|
+
/**
|
|
1022
|
+
*
|
|
1023
|
+
* @type {PatchTaskRequestDto}
|
|
1024
|
+
* @memberof TaskClientApiPatchTask
|
|
1025
|
+
*/
|
|
1026
|
+
readonly patchTaskRequestDto: PatchTaskRequestDto;
|
|
1027
|
+
/**
|
|
1028
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1029
|
+
* @type {string}
|
|
1030
|
+
* @memberof TaskClientApiPatchTask
|
|
1031
|
+
*/
|
|
1032
|
+
readonly authorization?: string;
|
|
1033
|
+
}
|
|
1034
|
+
/**
|
|
1035
|
+
* TaskClientApi - object-oriented interface
|
|
1036
|
+
* @export
|
|
1037
|
+
* @class TaskClientApi
|
|
1038
|
+
* @extends {BaseAPI}
|
|
1039
|
+
*/
|
|
1040
|
+
export declare class TaskClientApi extends BaseAPI {
|
|
1041
|
+
/**
|
|
1042
|
+
* This will create a category. **Required Permissions** \"task-management.tasks.create\"
|
|
1043
|
+
* @summary Create the category
|
|
1044
|
+
* @param {TaskClientApiCreateCategoryRequest} requestParameters Request parameters.
|
|
1045
|
+
* @param {*} [options] Override http request option.
|
|
1046
|
+
* @throws {RequiredError}
|
|
1047
|
+
* @memberof TaskClientApi
|
|
1048
|
+
*/
|
|
1049
|
+
createCategory(requestParameters: TaskClientApiCreateCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCategoryResponseClass, any, {}>>;
|
|
1050
|
+
/**
|
|
1051
|
+
* This will create hub spot ticket. **Required Permissions** \"task-management.tasks.create\"
|
|
1052
|
+
* @summary Create the hub spot ticket
|
|
1053
|
+
* @param {TaskClientApiCreateHubSpotTicketRequest} requestParameters Request parameters.
|
|
1054
|
+
* @param {*} [options] Override http request option.
|
|
1055
|
+
* @throws {RequiredError}
|
|
1056
|
+
* @memberof TaskClientApi
|
|
1057
|
+
*/
|
|
1058
|
+
createHubSpotTicket(requestParameters: TaskClientApiCreateHubSpotTicketRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateHubSpotTicketResponseClass, any, {}>>;
|
|
1059
|
+
/**
|
|
1060
|
+
* This will create a status. **Required Permissions** \"task-management.tasks.create\"
|
|
1061
|
+
* @summary Create the status
|
|
1062
|
+
* @param {TaskClientApiCreateStatusRequest} requestParameters Request parameters.
|
|
1063
|
+
* @param {*} [options] Override http request option.
|
|
1064
|
+
* @throws {RequiredError}
|
|
1065
|
+
* @memberof TaskClientApi
|
|
1066
|
+
*/
|
|
1067
|
+
createStatus(requestParameters: TaskClientApiCreateStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStatusResponseClass, any, {}>>;
|
|
1068
|
+
/**
|
|
1069
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
1070
|
+
* @summary Create the task
|
|
1071
|
+
* @param {TaskClientApiCreateTaskRequest} requestParameters Request parameters.
|
|
1072
|
+
* @param {*} [options] Override http request option.
|
|
1073
|
+
* @throws {RequiredError}
|
|
1074
|
+
* @memberof TaskClientApi
|
|
1075
|
+
*/
|
|
1076
|
+
createTask(requestParameters: TaskClientApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponseClass, any, {}>>;
|
|
1077
|
+
/**
|
|
1078
|
+
* This will delete a task category by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
1079
|
+
* @summary Delete the category
|
|
1080
|
+
* @param {TaskClientApiDeleteCategoryRequest} requestParameters Request parameters.
|
|
1081
|
+
* @param {*} [options] Override http request option.
|
|
1082
|
+
* @throws {RequiredError}
|
|
1083
|
+
* @memberof TaskClientApi
|
|
1084
|
+
*/
|
|
1085
|
+
deleteCategory(requestParameters: TaskClientApiDeleteCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1086
|
+
/**
|
|
1087
|
+
* This will delete status. **Required Permissions** \"task-management.tasks.delete\"
|
|
1088
|
+
* @summary Delete the status
|
|
1089
|
+
* @param {TaskClientApiDeleteStatusRequest} requestParameters Request parameters.
|
|
1090
|
+
* @param {*} [options] Override http request option.
|
|
1091
|
+
* @throws {RequiredError}
|
|
1092
|
+
* @memberof TaskClientApi
|
|
1093
|
+
*/
|
|
1094
|
+
deleteStatus(requestParameters: TaskClientApiDeleteStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1095
|
+
/**
|
|
1096
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
1097
|
+
* @summary Delete the task
|
|
1098
|
+
* @param {TaskClientApiDeleteTaskRequest} requestParameters Request parameters.
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
* @memberof TaskClientApi
|
|
1102
|
+
*/
|
|
1103
|
+
deleteTask(requestParameters: TaskClientApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Get category by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1106
|
+
* @summary Retrieve the category
|
|
1107
|
+
* @param {TaskClientApiGetCategoryRequest} requestParameters Request parameters.
|
|
1108
|
+
* @param {*} [options] Override http request option.
|
|
1109
|
+
* @throws {RequiredError}
|
|
1110
|
+
* @memberof TaskClientApi
|
|
1111
|
+
*/
|
|
1112
|
+
getCategory(requestParameters: TaskClientApiGetCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCategoryResponseClass, any, {}>>;
|
|
1113
|
+
/**
|
|
1114
|
+
* Get status by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1115
|
+
* @summary Retrieve the status
|
|
1116
|
+
* @param {TaskClientApiGetStatusRequest} requestParameters Request parameters.
|
|
1117
|
+
* @param {*} [options] Override http request option.
|
|
1118
|
+
* @throws {RequiredError}
|
|
1119
|
+
* @memberof TaskClientApi
|
|
1120
|
+
*/
|
|
1121
|
+
getStatus(requestParameters: TaskClientApiGetStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatusResponseClass, any, {}>>;
|
|
1122
|
+
/**
|
|
1123
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
1124
|
+
* @summary Retrieve the task
|
|
1125
|
+
* @param {TaskClientApiGetTaskRequest} requestParameters Request parameters.
|
|
1126
|
+
* @param {*} [options] Override http request option.
|
|
1127
|
+
* @throws {RequiredError}
|
|
1128
|
+
* @memberof TaskClientApi
|
|
1129
|
+
*/
|
|
1130
|
+
getTask(requestParameters: TaskClientApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponseClass, any, {}>>;
|
|
1131
|
+
/**
|
|
1132
|
+
* Retrieves a list of distinct assignees from tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
1133
|
+
* @summary List assignees
|
|
1134
|
+
* @param {TaskClientApiListAssigneesRequest} requestParameters Request parameters.
|
|
1135
|
+
* @param {*} [options] Override http request option.
|
|
1136
|
+
* @throws {RequiredError}
|
|
1137
|
+
* @memberof TaskClientApi
|
|
1138
|
+
*/
|
|
1139
|
+
listAssignees(requestParameters?: TaskClientApiListAssigneesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAssigneesResponseClass, any, {}>>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Retrieves a list of categories. **Required Permissions** \"task-management.tasks.view\"
|
|
1142
|
+
* @summary List categories
|
|
1143
|
+
* @param {TaskClientApiListCategoriesRequest} requestParameters Request parameters.
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
* @memberof TaskClientApi
|
|
1147
|
+
*/
|
|
1148
|
+
listCategories(requestParameters?: TaskClientApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}>>;
|
|
1149
|
+
/**
|
|
1150
|
+
* Retrieves a list of statuses. **Required Permissions** \"task-management.tasks.view\"
|
|
1151
|
+
* @summary List statuses
|
|
1152
|
+
* @param {TaskClientApiListStatusesRequest} requestParameters Request parameters.
|
|
1153
|
+
* @param {*} [options] Override http request option.
|
|
1154
|
+
* @throws {RequiredError}
|
|
1155
|
+
* @memberof TaskClientApi
|
|
1156
|
+
*/
|
|
1157
|
+
listStatuses(requestParameters?: TaskClientApiListStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatusesResponseClass, any, {}>>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
1160
|
+
* @summary List tasks
|
|
1161
|
+
* @param {TaskClientApiListTasksRequest} requestParameters Request parameters.
|
|
1162
|
+
* @param {*} [options] Override http request option.
|
|
1163
|
+
* @throws {RequiredError}
|
|
1164
|
+
* @memberof TaskClientApi
|
|
1165
|
+
*/
|
|
1166
|
+
listTasks(requestParameters?: TaskClientApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
|
|
1167
|
+
/**
|
|
1168
|
+
* This will partially update a category by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1169
|
+
* @summary Update the category
|
|
1170
|
+
* @param {TaskClientApiPatchCategoryRequest} requestParameters Request parameters.
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
* @memberof TaskClientApi
|
|
1174
|
+
*/
|
|
1175
|
+
patchCategory(requestParameters: TaskClientApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}>>;
|
|
1176
|
+
/**
|
|
1177
|
+
* This will partially update a status by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1178
|
+
* @summary Update the status
|
|
1179
|
+
* @param {TaskClientApiPatchStatusRequest} requestParameters Request parameters.
|
|
1180
|
+
* @param {*} [options] Override http request option.
|
|
1181
|
+
* @throws {RequiredError}
|
|
1182
|
+
* @memberof TaskClientApi
|
|
1183
|
+
*/
|
|
1184
|
+
patchStatus(requestParameters: TaskClientApiPatchStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchStatusResponseClass, any, {}>>;
|
|
1185
|
+
/**
|
|
1186
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
1187
|
+
* @summary Update the task
|
|
1188
|
+
* @param {TaskClientApiPatchTaskRequest} requestParameters Request parameters.
|
|
1189
|
+
* @param {*} [options] Override http request option.
|
|
1190
|
+
* @throws {RequiredError}
|
|
1191
|
+
* @memberof TaskClientApi
|
|
1192
|
+
*/
|
|
1193
|
+
patchTask(requestParameters: TaskClientApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}>>;
|
|
1194
|
+
}
|