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