@epilot/kanban-client 1.2.0 → 1.4.0
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/LICENSE +1 -1
- package/dist/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +4 -0
- package/dist/openapi.d.ts +250 -120
- package/dist/openapi.json +654 -78
- package/package.json +4 -7
package/dist/openapi.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
|
|
3
1
|
import type {
|
|
4
2
|
OpenAPIClient,
|
|
5
3
|
Parameters,
|
|
@@ -10,6 +8,9 @@ import type {
|
|
|
10
8
|
|
|
11
9
|
declare namespace Components {
|
|
12
10
|
namespace Schemas {
|
|
11
|
+
/**
|
|
12
|
+
* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options.
|
|
13
|
+
*/
|
|
13
14
|
export interface Board {
|
|
14
15
|
id?: string;
|
|
15
16
|
/**
|
|
@@ -39,12 +40,13 @@ declare namespace Components {
|
|
|
39
40
|
* workflow_tasks_overview
|
|
40
41
|
*/
|
|
41
42
|
dataset?: string;
|
|
42
|
-
swimlanes?: Swimlane[];
|
|
43
|
+
swimlanes?: /* A vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position. */ Swimlane[];
|
|
43
44
|
card_config?: {
|
|
44
45
|
fields?: string[];
|
|
45
46
|
};
|
|
46
|
-
board_filter?: BoardFilter;
|
|
47
|
-
sorting?: Sorting;
|
|
47
|
+
board_filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
|
|
48
|
+
sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
|
|
49
|
+
group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
|
|
48
50
|
/**
|
|
49
51
|
* example:
|
|
50
52
|
* task 1
|
|
@@ -52,6 +54,9 @@ declare namespace Components {
|
|
|
52
54
|
search_query?: string;
|
|
53
55
|
};
|
|
54
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR).
|
|
59
|
+
*/
|
|
55
60
|
export interface BoardFilter {
|
|
56
61
|
items: (FilterItem | FilterGroup)[];
|
|
57
62
|
/**
|
|
@@ -60,6 +65,9 @@ declare namespace Components {
|
|
|
60
65
|
*/
|
|
61
66
|
combination: "AND" | "OR";
|
|
62
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Summary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details.
|
|
70
|
+
*/
|
|
63
71
|
export interface BoardSummary {
|
|
64
72
|
id?: string;
|
|
65
73
|
/**
|
|
@@ -87,7 +95,24 @@ declare namespace Components {
|
|
|
87
95
|
/**
|
|
88
96
|
* Dynamic date keywords that resolve to actual dates at runtime
|
|
89
97
|
*/
|
|
90
|
-
export type DynamicDateValue = "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH";
|
|
98
|
+
export type DynamicDateValue = "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER";
|
|
99
|
+
/**
|
|
100
|
+
* Standard error response
|
|
101
|
+
*/
|
|
102
|
+
export interface Error {
|
|
103
|
+
/**
|
|
104
|
+
* Human-readable error message
|
|
105
|
+
* example:
|
|
106
|
+
* Board not found
|
|
107
|
+
*/
|
|
108
|
+
message?: string;
|
|
109
|
+
/**
|
|
110
|
+
* HTTP status code
|
|
111
|
+
* example:
|
|
112
|
+
* 404
|
|
113
|
+
*/
|
|
114
|
+
status?: number;
|
|
115
|
+
}
|
|
91
116
|
export interface FilterGroup {
|
|
92
117
|
items: FilterItem[];
|
|
93
118
|
/**
|
|
@@ -123,22 +148,83 @@ declare namespace Components {
|
|
|
123
148
|
* EQUALS
|
|
124
149
|
*/
|
|
125
150
|
export type FilterOperator = "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL";
|
|
151
|
+
/**
|
|
152
|
+
* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.
|
|
153
|
+
*/
|
|
126
154
|
export interface FlowsQueryRequest {
|
|
127
|
-
|
|
128
|
-
|
|
155
|
+
/**
|
|
156
|
+
* Optional filter conditions to narrow the result set using AND/OR logic.
|
|
157
|
+
*/
|
|
158
|
+
filters?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
|
|
159
|
+
/**
|
|
160
|
+
* Sort the results by a specific field and direction.
|
|
161
|
+
*/
|
|
162
|
+
sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
|
|
163
|
+
/**
|
|
164
|
+
* Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set.
|
|
165
|
+
*/
|
|
166
|
+
group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
|
|
167
|
+
/**
|
|
168
|
+
* Zero-based offset for pagination. Use with `size` to paginate through results.
|
|
169
|
+
* example:
|
|
170
|
+
* 0
|
|
171
|
+
*/
|
|
129
172
|
from?: number;
|
|
173
|
+
/**
|
|
174
|
+
* Number of results to return per page.
|
|
175
|
+
* example:
|
|
176
|
+
* 10
|
|
177
|
+
*/
|
|
130
178
|
size?: number;
|
|
131
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration.
|
|
182
|
+
*/
|
|
132
183
|
export interface FlowsQueryResult {
|
|
133
184
|
[name: string]: any;
|
|
185
|
+
/**
|
|
186
|
+
* Array of matching workflow task records. Fields vary based on the dataset and card configuration.
|
|
187
|
+
*/
|
|
134
188
|
results?: {
|
|
135
189
|
[name: string]: any;
|
|
136
190
|
}[];
|
|
191
|
+
/**
|
|
192
|
+
* Total number of records matching the query (across all pages).
|
|
193
|
+
* example:
|
|
194
|
+
* 42
|
|
195
|
+
*/
|
|
137
196
|
hits?: number;
|
|
197
|
+
/**
|
|
198
|
+
* Current page number (1-based).
|
|
199
|
+
* example:
|
|
200
|
+
* 1
|
|
201
|
+
*/
|
|
138
202
|
page_number?: number;
|
|
203
|
+
/**
|
|
204
|
+
* Number of results per page (matches the `size` request parameter).
|
|
205
|
+
* example:
|
|
206
|
+
* 10
|
|
207
|
+
*/
|
|
139
208
|
page_size?: number;
|
|
209
|
+
/**
|
|
210
|
+
* Total number of available pages based on `hits` and `page_size`.
|
|
211
|
+
* example:
|
|
212
|
+
* 5
|
|
213
|
+
*/
|
|
140
214
|
total_pages?: number;
|
|
141
215
|
}
|
|
216
|
+
/**
|
|
217
|
+
* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.
|
|
218
|
+
*/
|
|
219
|
+
export interface GroupBy {
|
|
220
|
+
/**
|
|
221
|
+
* Property to group tasks by within each swimlane
|
|
222
|
+
*/
|
|
223
|
+
field: "context_entity" | "phase";
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Defines how query results should be sorted. Specify a field name and sort direction.
|
|
227
|
+
*/
|
|
142
228
|
export interface Sorting {
|
|
143
229
|
/**
|
|
144
230
|
* example:
|
|
@@ -147,6 +233,9 @@ declare namespace Components {
|
|
|
147
233
|
field: string;
|
|
148
234
|
direction?: "asc" | "desc";
|
|
149
235
|
}
|
|
236
|
+
/**
|
|
237
|
+
* A vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position.
|
|
238
|
+
*/
|
|
150
239
|
export interface Swimlane {
|
|
151
240
|
id?: string;
|
|
152
241
|
/**
|
|
@@ -159,7 +248,7 @@ declare namespace Components {
|
|
|
159
248
|
* 1
|
|
160
249
|
*/
|
|
161
250
|
position?: number;
|
|
162
|
-
filter?: BoardFilter;
|
|
251
|
+
filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
|
|
163
252
|
/**
|
|
164
253
|
* example:
|
|
165
254
|
* success
|
|
@@ -179,26 +268,19 @@ declare namespace Paths {
|
|
|
179
268
|
message?: string;
|
|
180
269
|
default_board_id?: string | null;
|
|
181
270
|
}
|
|
182
|
-
export
|
|
183
|
-
|
|
184
|
-
export
|
|
185
|
-
}
|
|
186
|
-
export interface $500 {
|
|
187
|
-
}
|
|
271
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
272
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
273
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
188
274
|
}
|
|
189
275
|
}
|
|
190
276
|
namespace CreateKanbanBoard {
|
|
191
|
-
export type RequestBody = Components.Schemas.Board;
|
|
277
|
+
export type RequestBody = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
192
278
|
namespace Responses {
|
|
193
|
-
export type $200 = Components.Schemas.Board;
|
|
194
|
-
export
|
|
195
|
-
|
|
196
|
-
export
|
|
197
|
-
|
|
198
|
-
export interface $403 {
|
|
199
|
-
}
|
|
200
|
-
export interface $500 {
|
|
201
|
-
}
|
|
279
|
+
export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
280
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
281
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
282
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
283
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
202
284
|
}
|
|
203
285
|
}
|
|
204
286
|
namespace DeleteKanbanBoard {
|
|
@@ -211,20 +293,20 @@ declare namespace Paths {
|
|
|
211
293
|
namespace Responses {
|
|
212
294
|
export interface $200 {
|
|
213
295
|
}
|
|
214
|
-
export
|
|
215
|
-
|
|
216
|
-
export
|
|
217
|
-
|
|
218
|
-
export interface $404 {
|
|
219
|
-
}
|
|
220
|
-
export interface $500 {
|
|
221
|
-
}
|
|
296
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
297
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
298
|
+
export type $404 = /* Standard error response */ Components.Schemas.Error;
|
|
299
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
222
300
|
}
|
|
223
301
|
}
|
|
224
302
|
namespace ExecuteFlowsQuery {
|
|
225
|
-
export type RequestBody = Components.Schemas.FlowsQueryRequest;
|
|
303
|
+
export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
|
|
226
304
|
namespace Responses {
|
|
227
|
-
export type $200 = Components.Schemas.FlowsQueryResult;
|
|
305
|
+
export type $200 = /* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration. */ Components.Schemas.FlowsQueryResult;
|
|
306
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
307
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
308
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
309
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
228
310
|
}
|
|
229
311
|
}
|
|
230
312
|
namespace FlowsAutocomplete {
|
|
@@ -266,6 +348,10 @@ declare namespace Paths {
|
|
|
266
348
|
*/
|
|
267
349
|
hits: number;
|
|
268
350
|
}
|
|
351
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
352
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
353
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
354
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
269
355
|
}
|
|
270
356
|
}
|
|
271
357
|
namespace GetKanbanBoard {
|
|
@@ -276,15 +362,11 @@ declare namespace Paths {
|
|
|
276
362
|
boardId: Parameters.BoardId;
|
|
277
363
|
}
|
|
278
364
|
namespace Responses {
|
|
279
|
-
export type $200 = Components.Schemas.Board;
|
|
280
|
-
export
|
|
281
|
-
|
|
282
|
-
export
|
|
283
|
-
|
|
284
|
-
export interface $404 {
|
|
285
|
-
}
|
|
286
|
-
export interface $500 {
|
|
287
|
-
}
|
|
365
|
+
export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
366
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
367
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
368
|
+
export type $404 = /* Standard error response */ Components.Schemas.Error;
|
|
369
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
288
370
|
}
|
|
289
371
|
}
|
|
290
372
|
namespace GetKanbanBoards {
|
|
@@ -295,13 +377,10 @@ declare namespace Paths {
|
|
|
295
377
|
filter?: Parameters.Filter;
|
|
296
378
|
}
|
|
297
379
|
namespace Responses {
|
|
298
|
-
export type $200 = Components.Schemas.BoardSummary[];
|
|
299
|
-
export
|
|
300
|
-
|
|
301
|
-
export
|
|
302
|
-
}
|
|
303
|
-
export interface $500 {
|
|
304
|
-
}
|
|
380
|
+
export type $200 = /* Summary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details. */ Components.Schemas.BoardSummary[];
|
|
381
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
382
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
383
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
305
384
|
}
|
|
306
385
|
}
|
|
307
386
|
namespace PatchKanbanBoard {
|
|
@@ -322,7 +401,13 @@ declare namespace Paths {
|
|
|
322
401
|
* Board description
|
|
323
402
|
*/
|
|
324
403
|
description?: string;
|
|
404
|
+
/**
|
|
405
|
+
* Array of user IDs to share the board with
|
|
406
|
+
*/
|
|
325
407
|
shared_with?: string[];
|
|
408
|
+
/**
|
|
409
|
+
* Whether the board is shared with the entire organization
|
|
410
|
+
*/
|
|
326
411
|
shared_with_org?: boolean;
|
|
327
412
|
/**
|
|
328
413
|
* Array of user IDs who have full ownership rights for this board (view, edit, delete)
|
|
@@ -330,17 +415,12 @@ declare namespace Paths {
|
|
|
330
415
|
owners?: string[];
|
|
331
416
|
}
|
|
332
417
|
namespace Responses {
|
|
333
|
-
export type $200 = Components.Schemas.Board;
|
|
334
|
-
export
|
|
335
|
-
|
|
336
|
-
export
|
|
337
|
-
|
|
338
|
-
export
|
|
339
|
-
}
|
|
340
|
-
export interface $404 {
|
|
341
|
-
}
|
|
342
|
-
export interface $500 {
|
|
343
|
-
}
|
|
418
|
+
export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
419
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
420
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
421
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
422
|
+
export type $404 = /* Standard error response */ Components.Schemas.Error;
|
|
423
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
344
424
|
}
|
|
345
425
|
}
|
|
346
426
|
namespace SetDefaultKanbanBoard {
|
|
@@ -355,16 +435,11 @@ declare namespace Paths {
|
|
|
355
435
|
message?: string;
|
|
356
436
|
default_board_id?: string;
|
|
357
437
|
}
|
|
358
|
-
export
|
|
359
|
-
|
|
360
|
-
export
|
|
361
|
-
|
|
362
|
-
export
|
|
363
|
-
}
|
|
364
|
-
export interface $404 {
|
|
365
|
-
}
|
|
366
|
-
export interface $500 {
|
|
367
|
-
}
|
|
438
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
439
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
440
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
441
|
+
export type $404 = /* Standard error response */ Components.Schemas.Error;
|
|
442
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
368
443
|
}
|
|
369
444
|
}
|
|
370
445
|
namespace UpdateKanbanBoard {
|
|
@@ -374,19 +449,14 @@ declare namespace Paths {
|
|
|
374
449
|
export interface PathParameters {
|
|
375
450
|
boardId: Parameters.BoardId;
|
|
376
451
|
}
|
|
377
|
-
export type RequestBody = Components.Schemas.Board;
|
|
452
|
+
export type RequestBody = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
378
453
|
namespace Responses {
|
|
379
|
-
export type $200 = Components.Schemas.Board;
|
|
380
|
-
export
|
|
381
|
-
|
|
382
|
-
export
|
|
383
|
-
|
|
384
|
-
export
|
|
385
|
-
}
|
|
386
|
-
export interface $404 {
|
|
387
|
-
}
|
|
388
|
-
export interface $500 {
|
|
389
|
-
}
|
|
454
|
+
export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
|
|
455
|
+
export type $400 = /* Standard error response */ Components.Schemas.Error;
|
|
456
|
+
export type $401 = /* Standard error response */ Components.Schemas.Error;
|
|
457
|
+
export type $403 = /* Standard error response */ Components.Schemas.Error;
|
|
458
|
+
export type $404 = /* Standard error response */ Components.Schemas.Error;
|
|
459
|
+
export type $500 = /* Standard error response */ Components.Schemas.Error;
|
|
390
460
|
}
|
|
391
461
|
}
|
|
392
462
|
}
|
|
@@ -394,9 +464,12 @@ declare namespace Paths {
|
|
|
394
464
|
|
|
395
465
|
export interface OperationMethods {
|
|
396
466
|
/**
|
|
397
|
-
* createKanbanBoard -
|
|
467
|
+
* createKanbanBoard - createKanbanBoard
|
|
468
|
+
*
|
|
469
|
+
* Creates a new Kanban board with the provided configuration.
|
|
470
|
+
*
|
|
471
|
+
* A board must have a title and a config containing at least one dataset. Swimlanes and filters can be configured to display specific subsets of workflow tasks or entities.
|
|
398
472
|
*
|
|
399
|
-
* Create a Kanban board
|
|
400
473
|
*/
|
|
401
474
|
'createKanbanBoard'(
|
|
402
475
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -404,9 +477,12 @@ export interface OperationMethods {
|
|
|
404
477
|
config?: AxiosRequestConfig
|
|
405
478
|
): OperationResponse<Paths.CreateKanbanBoard.Responses.$200>
|
|
406
479
|
/**
|
|
407
|
-
* getKanbanBoards -
|
|
480
|
+
* getKanbanBoards - getKanbanBoards
|
|
481
|
+
*
|
|
482
|
+
* Returns a list of all Kanban boards accessible to the authenticated user.
|
|
483
|
+
*
|
|
484
|
+
* Use the `filter` query parameter to narrow results to boards the user owns (`owned`) or boards shared with them (`shared`). When omitted, all accessible boards are returned.
|
|
408
485
|
*
|
|
409
|
-
* Get all Kanban boards
|
|
410
486
|
*/
|
|
411
487
|
'getKanbanBoards'(
|
|
412
488
|
parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
|
|
@@ -414,9 +490,11 @@ export interface OperationMethods {
|
|
|
414
490
|
config?: AxiosRequestConfig
|
|
415
491
|
): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
|
|
416
492
|
/**
|
|
417
|
-
* getKanbanBoard -
|
|
493
|
+
* getKanbanBoard - getKanbanBoard
|
|
494
|
+
*
|
|
495
|
+
* Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).
|
|
418
496
|
*
|
|
419
|
-
*
|
|
497
|
+
* Use `"default"` as the `boardId` to retrieve the organization's currently configured default board.
|
|
420
498
|
*
|
|
421
499
|
*/
|
|
422
500
|
'getKanbanBoard'(
|
|
@@ -425,9 +503,12 @@ export interface OperationMethods {
|
|
|
425
503
|
config?: AxiosRequestConfig
|
|
426
504
|
): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
|
|
427
505
|
/**
|
|
428
|
-
* updateKanbanBoard -
|
|
506
|
+
* updateKanbanBoard - updateKanbanBoard
|
|
507
|
+
*
|
|
508
|
+
* Fully replaces the configuration of an existing Kanban board by ID.
|
|
509
|
+
*
|
|
510
|
+
* All board fields (title, config, swimlanes, filters) must be provided. Use PATCH for partial updates.
|
|
429
511
|
*
|
|
430
|
-
* Update a Kanban board
|
|
431
512
|
*/
|
|
432
513
|
'updateKanbanBoard'(
|
|
433
514
|
parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
|
|
@@ -435,9 +516,12 @@ export interface OperationMethods {
|
|
|
435
516
|
config?: AxiosRequestConfig
|
|
436
517
|
): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
|
|
437
518
|
/**
|
|
438
|
-
* patchKanbanBoard -
|
|
519
|
+
* patchKanbanBoard - patchKanbanBoard
|
|
520
|
+
*
|
|
521
|
+
* Partially updates fields of an existing Kanban board by ID.
|
|
522
|
+
*
|
|
523
|
+
* Only the fields provided in the request body will be updated. Useful for updating sharing settings, ownership, or title without replacing the full board configuration.
|
|
439
524
|
*
|
|
440
|
-
* Patch a Kanban board
|
|
441
525
|
*/
|
|
442
526
|
'patchKanbanBoard'(
|
|
443
527
|
parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
|
|
@@ -445,9 +529,9 @@ export interface OperationMethods {
|
|
|
445
529
|
config?: AxiosRequestConfig
|
|
446
530
|
): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
|
|
447
531
|
/**
|
|
448
|
-
* deleteKanbanBoard -
|
|
532
|
+
* deleteKanbanBoard - deleteKanbanBoard
|
|
449
533
|
*
|
|
450
|
-
*
|
|
534
|
+
* Permanently deletes a Kanban board by ID. This action is irreversible.
|
|
451
535
|
*/
|
|
452
536
|
'deleteKanbanBoard'(
|
|
453
537
|
parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
|
|
@@ -455,9 +539,13 @@ export interface OperationMethods {
|
|
|
455
539
|
config?: AxiosRequestConfig
|
|
456
540
|
): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
|
|
457
541
|
/**
|
|
458
|
-
* setDefaultKanbanBoard -
|
|
542
|
+
* setDefaultKanbanBoard - setDefaultKanbanBoard
|
|
543
|
+
*
|
|
544
|
+
* Sets a Kanban board as the default board for the organization.
|
|
545
|
+
*
|
|
546
|
+
* The default board is shown to users who access the Kanban view without specifying a specific board ID.
|
|
547
|
+
* Pass `boardId` as a query parameter to identify the board to set as default.
|
|
459
548
|
*
|
|
460
|
-
* Set a board as the default board for the organization
|
|
461
549
|
*/
|
|
462
550
|
'setDefaultKanbanBoard'(
|
|
463
551
|
parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
|
|
@@ -465,9 +553,12 @@ export interface OperationMethods {
|
|
|
465
553
|
config?: AxiosRequestConfig
|
|
466
554
|
): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
|
|
467
555
|
/**
|
|
468
|
-
* clearDefaultKanbanBoard -
|
|
556
|
+
* clearDefaultKanbanBoard - clearDefaultKanbanBoard
|
|
557
|
+
*
|
|
558
|
+
* Removes the default board configuration for the organization.
|
|
559
|
+
*
|
|
560
|
+
* After calling this endpoint, `getKanbanBoard` with `boardId=default` will return a 404 until a new default is set.
|
|
469
561
|
*
|
|
470
|
-
* Remove the default board setting for the organization
|
|
471
562
|
*/
|
|
472
563
|
'clearDefaultKanbanBoard'(
|
|
473
564
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -477,7 +568,11 @@ export interface OperationMethods {
|
|
|
477
568
|
/**
|
|
478
569
|
* flowsAutocomplete - flowsAutocomplete
|
|
479
570
|
*
|
|
480
|
-
*
|
|
571
|
+
* Returns autocomplete suggestions for a given attribute in the Flows dataset.
|
|
572
|
+
*
|
|
573
|
+
* Use this endpoint to power filter dropdowns and search inputs in the Kanban board configuration UI.
|
|
574
|
+
* The `attribute` parameter specifies which field to autocomplete (e.g. `name`, `assignee`, `status`).
|
|
575
|
+
* The optional `input` parameter filters results to those matching the typed prefix.
|
|
481
576
|
*
|
|
482
577
|
*/
|
|
483
578
|
'flowsAutocomplete'(
|
|
@@ -488,7 +583,11 @@ export interface OperationMethods {
|
|
|
488
583
|
/**
|
|
489
584
|
* executeFlowsQuery - executeFlowsQuery
|
|
490
585
|
*
|
|
491
|
-
*
|
|
586
|
+
* Executes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.
|
|
587
|
+
*
|
|
588
|
+
* Supports filtering with complex AND/OR logic, sorting, and offset-based pagination.
|
|
589
|
+
* Results are used to populate Kanban swimlane cards with real-time workflow task data.
|
|
590
|
+
*
|
|
492
591
|
*/
|
|
493
592
|
'executeFlowsQuery'(
|
|
494
593
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -500,9 +599,12 @@ export interface OperationMethods {
|
|
|
500
599
|
export interface PathsDictionary {
|
|
501
600
|
['/v1/kanban/board']: {
|
|
502
601
|
/**
|
|
503
|
-
* createKanbanBoard -
|
|
602
|
+
* createKanbanBoard - createKanbanBoard
|
|
603
|
+
*
|
|
604
|
+
* Creates a new Kanban board with the provided configuration.
|
|
605
|
+
*
|
|
606
|
+
* A board must have a title and a config containing at least one dataset. Swimlanes and filters can be configured to display specific subsets of workflow tasks or entities.
|
|
504
607
|
*
|
|
505
|
-
* Create a Kanban board
|
|
506
608
|
*/
|
|
507
609
|
'post'(
|
|
508
610
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -512,9 +614,12 @@ export interface PathsDictionary {
|
|
|
512
614
|
}
|
|
513
615
|
['/v1/kanban/boards']: {
|
|
514
616
|
/**
|
|
515
|
-
* getKanbanBoards -
|
|
617
|
+
* getKanbanBoards - getKanbanBoards
|
|
618
|
+
*
|
|
619
|
+
* Returns a list of all Kanban boards accessible to the authenticated user.
|
|
620
|
+
*
|
|
621
|
+
* Use the `filter` query parameter to narrow results to boards the user owns (`owned`) or boards shared with them (`shared`). When omitted, all accessible boards are returned.
|
|
516
622
|
*
|
|
517
|
-
* Get all Kanban boards
|
|
518
623
|
*/
|
|
519
624
|
'get'(
|
|
520
625
|
parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
|
|
@@ -524,9 +629,11 @@ export interface PathsDictionary {
|
|
|
524
629
|
}
|
|
525
630
|
['/v1/kanban/board/{boardId}']: {
|
|
526
631
|
/**
|
|
527
|
-
* getKanbanBoard -
|
|
632
|
+
* getKanbanBoard - getKanbanBoard
|
|
633
|
+
*
|
|
634
|
+
* Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).
|
|
528
635
|
*
|
|
529
|
-
*
|
|
636
|
+
* Use `"default"` as the `boardId` to retrieve the organization's currently configured default board.
|
|
530
637
|
*
|
|
531
638
|
*/
|
|
532
639
|
'get'(
|
|
@@ -535,9 +642,12 @@ export interface PathsDictionary {
|
|
|
535
642
|
config?: AxiosRequestConfig
|
|
536
643
|
): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
|
|
537
644
|
/**
|
|
538
|
-
* updateKanbanBoard -
|
|
645
|
+
* updateKanbanBoard - updateKanbanBoard
|
|
646
|
+
*
|
|
647
|
+
* Fully replaces the configuration of an existing Kanban board by ID.
|
|
648
|
+
*
|
|
649
|
+
* All board fields (title, config, swimlanes, filters) must be provided. Use PATCH for partial updates.
|
|
539
650
|
*
|
|
540
|
-
* Update a Kanban board
|
|
541
651
|
*/
|
|
542
652
|
'put'(
|
|
543
653
|
parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
|
|
@@ -545,9 +655,12 @@ export interface PathsDictionary {
|
|
|
545
655
|
config?: AxiosRequestConfig
|
|
546
656
|
): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
|
|
547
657
|
/**
|
|
548
|
-
* patchKanbanBoard -
|
|
658
|
+
* patchKanbanBoard - patchKanbanBoard
|
|
659
|
+
*
|
|
660
|
+
* Partially updates fields of an existing Kanban board by ID.
|
|
661
|
+
*
|
|
662
|
+
* Only the fields provided in the request body will be updated. Useful for updating sharing settings, ownership, or title without replacing the full board configuration.
|
|
549
663
|
*
|
|
550
|
-
* Patch a Kanban board
|
|
551
664
|
*/
|
|
552
665
|
'patch'(
|
|
553
666
|
parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
|
|
@@ -555,9 +668,9 @@ export interface PathsDictionary {
|
|
|
555
668
|
config?: AxiosRequestConfig
|
|
556
669
|
): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
|
|
557
670
|
/**
|
|
558
|
-
* deleteKanbanBoard -
|
|
671
|
+
* deleteKanbanBoard - deleteKanbanBoard
|
|
559
672
|
*
|
|
560
|
-
*
|
|
673
|
+
* Permanently deletes a Kanban board by ID. This action is irreversible.
|
|
561
674
|
*/
|
|
562
675
|
'delete'(
|
|
563
676
|
parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
|
|
@@ -567,9 +680,13 @@ export interface PathsDictionary {
|
|
|
567
680
|
}
|
|
568
681
|
['/v1/kanban/org/default-board']: {
|
|
569
682
|
/**
|
|
570
|
-
* setDefaultKanbanBoard -
|
|
683
|
+
* setDefaultKanbanBoard - setDefaultKanbanBoard
|
|
684
|
+
*
|
|
685
|
+
* Sets a Kanban board as the default board for the organization.
|
|
686
|
+
*
|
|
687
|
+
* The default board is shown to users who access the Kanban view without specifying a specific board ID.
|
|
688
|
+
* Pass `boardId` as a query parameter to identify the board to set as default.
|
|
571
689
|
*
|
|
572
|
-
* Set a board as the default board for the organization
|
|
573
690
|
*/
|
|
574
691
|
'put'(
|
|
575
692
|
parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
|
|
@@ -577,9 +694,12 @@ export interface PathsDictionary {
|
|
|
577
694
|
config?: AxiosRequestConfig
|
|
578
695
|
): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
|
|
579
696
|
/**
|
|
580
|
-
* clearDefaultKanbanBoard -
|
|
697
|
+
* clearDefaultKanbanBoard - clearDefaultKanbanBoard
|
|
698
|
+
*
|
|
699
|
+
* Removes the default board configuration for the organization.
|
|
700
|
+
*
|
|
701
|
+
* After calling this endpoint, `getKanbanBoard` with `boardId=default` will return a 404 until a new default is set.
|
|
581
702
|
*
|
|
582
|
-
* Remove the default board setting for the organization
|
|
583
703
|
*/
|
|
584
704
|
'delete'(
|
|
585
705
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -591,7 +711,11 @@ export interface PathsDictionary {
|
|
|
591
711
|
/**
|
|
592
712
|
* flowsAutocomplete - flowsAutocomplete
|
|
593
713
|
*
|
|
594
|
-
*
|
|
714
|
+
* Returns autocomplete suggestions for a given attribute in the Flows dataset.
|
|
715
|
+
*
|
|
716
|
+
* Use this endpoint to power filter dropdowns and search inputs in the Kanban board configuration UI.
|
|
717
|
+
* The `attribute` parameter specifies which field to autocomplete (e.g. `name`, `assignee`, `status`).
|
|
718
|
+
* The optional `input` parameter filters results to those matching the typed prefix.
|
|
595
719
|
*
|
|
596
720
|
*/
|
|
597
721
|
'get'(
|
|
@@ -604,7 +728,11 @@ export interface PathsDictionary {
|
|
|
604
728
|
/**
|
|
605
729
|
* executeFlowsQuery - executeFlowsQuery
|
|
606
730
|
*
|
|
607
|
-
*
|
|
731
|
+
* Executes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.
|
|
732
|
+
*
|
|
733
|
+
* Supports filtering with complex AND/OR logic, sorting, and offset-based pagination.
|
|
734
|
+
* Results are used to populate Kanban swimlane cards with real-time workflow task data.
|
|
735
|
+
*
|
|
608
736
|
*/
|
|
609
737
|
'post'(
|
|
610
738
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -621,11 +749,13 @@ export type Board = Components.Schemas.Board;
|
|
|
621
749
|
export type BoardFilter = Components.Schemas.BoardFilter;
|
|
622
750
|
export type BoardSummary = Components.Schemas.BoardSummary;
|
|
623
751
|
export type DynamicDateValue = Components.Schemas.DynamicDateValue;
|
|
752
|
+
export type Error = Components.Schemas.Error;
|
|
624
753
|
export type FilterGroup = Components.Schemas.FilterGroup;
|
|
625
754
|
export type FilterItem = Components.Schemas.FilterItem;
|
|
626
755
|
export type FilterOperator = Components.Schemas.FilterOperator;
|
|
627
756
|
export type FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
|
|
628
757
|
export type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
|
|
758
|
+
export type GroupBy = Components.Schemas.GroupBy;
|
|
629
759
|
export type Sorting = Components.Schemas.Sorting;
|
|
630
760
|
export type Swimlane = Components.Schemas.Swimlane;
|
|
631
761
|
export type ValueType = Components.Schemas.ValueType;
|