@epilot/kanban-client 1.1.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/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
  /**
@@ -29,18 +30,22 @@ declare namespace Components {
29
30
  updated_by?: string;
30
31
  shared_with?: string[];
31
32
  shared_with_org?: boolean;
33
+ /**
34
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
35
+ */
36
+ owners?: string[];
32
37
  config: {
33
38
  /**
34
39
  * example:
35
40
  * workflow_tasks_overview
36
41
  */
37
42
  dataset?: string;
38
- 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[];
39
44
  card_config?: {
40
45
  fields?: string[];
41
46
  };
42
- board_filter?: BoardFilter;
43
- 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;
44
49
  /**
45
50
  * example:
46
51
  * task 1
@@ -48,6 +53,9 @@ declare namespace Components {
48
53
  search_query?: string;
49
54
  };
50
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
+ */
51
59
  export interface BoardFilter {
52
60
  items: (FilterItem | FilterGroup)[];
53
61
  /**
@@ -56,6 +64,9 @@ declare namespace Components {
56
64
  */
57
65
  combination: "AND" | "OR";
58
66
  }
67
+ /**
68
+ * Summary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details.
69
+ */
59
70
  export interface BoardSummary {
60
71
  id?: string;
61
72
  /**
@@ -75,11 +86,32 @@ declare namespace Components {
75
86
  updated_by?: string;
76
87
  shared_with?: string[];
77
88
  shared_with_org?: boolean;
89
+ /**
90
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
91
+ */
92
+ owners?: string[];
78
93
  }
79
94
  /**
80
95
  * Dynamic date keywords that resolve to actual dates at runtime
81
96
  */
82
- 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
+ }
83
115
  export interface FilterGroup {
84
116
  items: FilterItem[];
85
117
  /**
@@ -115,22 +147,70 @@ declare namespace Components {
115
147
  * EQUALS
116
148
  */
117
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
+ */
118
153
  export interface FlowsQueryRequest {
119
- filters?: BoardFilter;
120
- sorting?: Sorting;
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
+ */
121
167
  from?: number;
168
+ /**
169
+ * Number of results to return per page.
170
+ * example:
171
+ * 10
172
+ */
122
173
  size?: number;
123
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
+ */
124
178
  export interface FlowsQueryResult {
125
179
  [name: string]: any;
180
+ /**
181
+ * Array of matching workflow task records. Fields vary based on the dataset and card configuration.
182
+ */
126
183
  results?: {
127
184
  [name: string]: any;
128
185
  }[];
186
+ /**
187
+ * Total number of records matching the query (across all pages).
188
+ * example:
189
+ * 42
190
+ */
129
191
  hits?: number;
192
+ /**
193
+ * Current page number (1-based).
194
+ * example:
195
+ * 1
196
+ */
130
197
  page_number?: number;
198
+ /**
199
+ * Number of results per page (matches the `size` request parameter).
200
+ * example:
201
+ * 10
202
+ */
131
203
  page_size?: number;
204
+ /**
205
+ * Total number of available pages based on `hits` and `page_size`.
206
+ * example:
207
+ * 5
208
+ */
132
209
  total_pages?: number;
133
210
  }
211
+ /**
212
+ * Defines how query results should be sorted. Specify a field name and sort direction.
213
+ */
134
214
  export interface Sorting {
135
215
  /**
136
216
  * example:
@@ -139,6 +219,9 @@ declare namespace Components {
139
219
  field: string;
140
220
  direction?: "asc" | "desc";
141
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
+ */
142
225
  export interface Swimlane {
143
226
  id?: string;
144
227
  /**
@@ -151,7 +234,7 @@ declare namespace Components {
151
234
  * 1
152
235
  */
153
236
  position?: number;
154
- 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;
155
238
  /**
156
239
  * example:
157
240
  * success
@@ -165,18 +248,25 @@ declare namespace Components {
165
248
  }
166
249
  }
167
250
  declare namespace Paths {
168
- namespace CreateKanbanBoard {
169
- export type RequestBody = Components.Schemas.Board;
251
+ namespace ClearDefaultKanbanBoard {
170
252
  namespace Responses {
171
- export type $200 = Components.Schemas.Board;
172
- export interface $400 {
173
- }
174
- export interface $401 {
175
- }
176
- export interface $403 {
177
- }
178
- export interface $500 {
253
+ export interface $200 {
254
+ message?: string;
255
+ default_board_id?: string | null;
179
256
  }
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;
260
+ }
261
+ }
262
+ namespace CreateKanbanBoard {
263
+ export type RequestBody = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
264
+ namespace Responses {
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;
180
270
  }
181
271
  }
182
272
  namespace DeleteKanbanBoard {
@@ -189,20 +279,20 @@ declare namespace Paths {
189
279
  namespace Responses {
190
280
  export interface $200 {
191
281
  }
192
- export interface $401 {
193
- }
194
- export interface $403 {
195
- }
196
- export interface $404 {
197
- }
198
- export interface $500 {
199
- }
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;
200
286
  }
201
287
  }
202
288
  namespace ExecuteFlowsQuery {
203
- 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;
204
290
  namespace Responses {
205
- 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;
206
296
  }
207
297
  }
208
298
  namespace FlowsAutocomplete {
@@ -244,6 +334,10 @@ declare namespace Paths {
244
334
  */
245
335
  hits: number;
246
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;
247
341
  }
248
342
  }
249
343
  namespace GetKanbanBoard {
@@ -254,15 +348,11 @@ declare namespace Paths {
254
348
  boardId: Parameters.BoardId;
255
349
  }
256
350
  namespace Responses {
257
- export type $200 = Components.Schemas.Board;
258
- export interface $401 {
259
- }
260
- export interface $403 {
261
- }
262
- export interface $404 {
263
- }
264
- export interface $500 {
265
- }
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;
266
356
  }
267
357
  }
268
358
  namespace GetKanbanBoards {
@@ -273,13 +363,10 @@ declare namespace Paths {
273
363
  filter?: Parameters.Filter;
274
364
  }
275
365
  namespace Responses {
276
- export type $200 = Components.Schemas.BoardSummary[];
277
- export interface $401 {
278
- }
279
- export interface $403 {
280
- }
281
- export interface $500 {
282
- }
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;
283
370
  }
284
371
  }
285
372
  namespace PatchKanbanBoard {
@@ -300,21 +387,45 @@ declare namespace Paths {
300
387
  * Board description
301
388
  */
302
389
  description?: string;
390
+ /**
391
+ * Array of user IDs to share the board with
392
+ */
303
393
  shared_with?: string[];
394
+ /**
395
+ * Whether the board is shared with the entire organization
396
+ */
304
397
  shared_with_org?: boolean;
398
+ /**
399
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
400
+ */
401
+ owners?: string[];
305
402
  }
306
403
  namespace Responses {
307
- export type $200 = Components.Schemas.Board;
308
- export interface $400 {
309
- }
310
- export interface $401 {
311
- }
312
- export interface $403 {
313
- }
314
- export interface $404 {
315
- }
316
- export interface $500 {
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;
410
+ }
411
+ }
412
+ namespace SetDefaultKanbanBoard {
413
+ namespace Parameters {
414
+ export type BoardId = string;
415
+ }
416
+ export interface QueryParameters {
417
+ boardId: Parameters.BoardId;
418
+ }
419
+ namespace Responses {
420
+ export interface $200 {
421
+ message?: string;
422
+ default_board_id?: string;
317
423
  }
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;
318
429
  }
319
430
  }
320
431
  namespace UpdateKanbanBoard {
@@ -324,19 +435,14 @@ declare namespace Paths {
324
435
  export interface PathParameters {
325
436
  boardId: Parameters.BoardId;
326
437
  }
327
- 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;
328
439
  namespace Responses {
329
- export type $200 = Components.Schemas.Board;
330
- export interface $400 {
331
- }
332
- export interface $401 {
333
- }
334
- export interface $403 {
335
- }
336
- export interface $404 {
337
- }
338
- export interface $500 {
339
- }
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;
340
446
  }
341
447
  }
342
448
  }
@@ -344,9 +450,12 @@ declare namespace Paths {
344
450
 
345
451
  export interface OperationMethods {
346
452
  /**
347
- * createKanbanBoard - Create a Kanban board
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.
348
458
  *
349
- * Create a Kanban board
350
459
  */
351
460
  'createKanbanBoard'(
352
461
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -354,9 +463,12 @@ export interface OperationMethods {
354
463
  config?: AxiosRequestConfig
355
464
  ): OperationResponse<Paths.CreateKanbanBoard.Responses.$200>
356
465
  /**
357
- * getKanbanBoards - Get all Kanban boards
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.
358
471
  *
359
- * Get all Kanban boards
360
472
  */
361
473
  'getKanbanBoards'(
362
474
  parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
@@ -364,9 +476,12 @@ export interface OperationMethods {
364
476
  config?: AxiosRequestConfig
365
477
  ): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
366
478
  /**
367
- * getKanbanBoard - Get a Kanban board
479
+ * getKanbanBoard - getKanbanBoard
480
+ *
481
+ * Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).
482
+ *
483
+ * Use `"default"` as the `boardId` to retrieve the organization's currently configured default board.
368
484
  *
369
- * Get a Kanban board
370
485
  */
371
486
  'getKanbanBoard'(
372
487
  parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
@@ -374,9 +489,12 @@ export interface OperationMethods {
374
489
  config?: AxiosRequestConfig
375
490
  ): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
376
491
  /**
377
- * updateKanbanBoard - Update a Kanban board
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.
378
497
  *
379
- * Update a Kanban board
380
498
  */
381
499
  'updateKanbanBoard'(
382
500
  parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
@@ -384,9 +502,12 @@ export interface OperationMethods {
384
502
  config?: AxiosRequestConfig
385
503
  ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
386
504
  /**
387
- * patchKanbanBoard - Patch a Kanban board
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.
388
510
  *
389
- * Patch a Kanban board
390
511
  */
391
512
  'patchKanbanBoard'(
392
513
  parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
@@ -394,19 +515,50 @@ export interface OperationMethods {
394
515
  config?: AxiosRequestConfig
395
516
  ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
396
517
  /**
397
- * deleteKanbanBoard - Delete a Kanban board
518
+ * deleteKanbanBoard - deleteKanbanBoard
398
519
  *
399
- * Delete a Kanban board
520
+ * Permanently deletes a Kanban board by ID. This action is irreversible.
400
521
  */
401
522
  'deleteKanbanBoard'(
402
523
  parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
403
524
  data?: any,
404
525
  config?: AxiosRequestConfig
405
526
  ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
527
+ /**
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.
534
+ *
535
+ */
536
+ 'setDefaultKanbanBoard'(
537
+ parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
538
+ data?: any,
539
+ config?: AxiosRequestConfig
540
+ ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
541
+ /**
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.
547
+ *
548
+ */
549
+ 'clearDefaultKanbanBoard'(
550
+ parameters?: Parameters<UnknownParamsObject> | null,
551
+ data?: any,
552
+ config?: AxiosRequestConfig
553
+ ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
406
554
  /**
407
555
  * flowsAutocomplete - flowsAutocomplete
408
556
  *
409
- * Autocomplete flows data
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.
410
562
  *
411
563
  */
412
564
  'flowsAutocomplete'(
@@ -417,7 +569,11 @@ export interface OperationMethods {
417
569
  /**
418
570
  * executeFlowsQuery - executeFlowsQuery
419
571
  *
420
- * Query Flows Data for Kanban View.
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
+ *
421
577
  */
422
578
  'executeFlowsQuery'(
423
579
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -429,9 +585,12 @@ export interface OperationMethods {
429
585
  export interface PathsDictionary {
430
586
  ['/v1/kanban/board']: {
431
587
  /**
432
- * createKanbanBoard - Create a Kanban board
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.
433
593
  *
434
- * Create a Kanban board
435
594
  */
436
595
  'post'(
437
596
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -441,9 +600,12 @@ export interface PathsDictionary {
441
600
  }
442
601
  ['/v1/kanban/boards']: {
443
602
  /**
444
- * getKanbanBoards - Get all Kanban boards
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.
445
608
  *
446
- * Get all Kanban boards
447
609
  */
448
610
  'get'(
449
611
  parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
@@ -453,9 +615,12 @@ export interface PathsDictionary {
453
615
  }
454
616
  ['/v1/kanban/board/{boardId}']: {
455
617
  /**
456
- * getKanbanBoard - Get a Kanban board
618
+ * getKanbanBoard - getKanbanBoard
619
+ *
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.
457
623
  *
458
- * Get a Kanban board
459
624
  */
460
625
  'get'(
461
626
  parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
@@ -463,9 +628,12 @@ export interface PathsDictionary {
463
628
  config?: AxiosRequestConfig
464
629
  ): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
465
630
  /**
466
- * updateKanbanBoard - Update a Kanban board
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.
467
636
  *
468
- * Update a Kanban board
469
637
  */
470
638
  'put'(
471
639
  parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
@@ -473,9 +641,12 @@ export interface PathsDictionary {
473
641
  config?: AxiosRequestConfig
474
642
  ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
475
643
  /**
476
- * patchKanbanBoard - Patch a Kanban board
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.
477
649
  *
478
- * Patch a Kanban board
479
650
  */
480
651
  'patch'(
481
652
  parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
@@ -483,9 +654,9 @@ export interface PathsDictionary {
483
654
  config?: AxiosRequestConfig
484
655
  ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
485
656
  /**
486
- * deleteKanbanBoard - Delete a Kanban board
657
+ * deleteKanbanBoard - deleteKanbanBoard
487
658
  *
488
- * Delete a Kanban board
659
+ * Permanently deletes a Kanban board by ID. This action is irreversible.
489
660
  */
490
661
  'delete'(
491
662
  parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
@@ -493,11 +664,44 @@ export interface PathsDictionary {
493
664
  config?: AxiosRequestConfig
494
665
  ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
495
666
  }
667
+ ['/v1/kanban/org/default-board']: {
668
+ /**
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.
675
+ *
676
+ */
677
+ 'put'(
678
+ parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
679
+ data?: any,
680
+ config?: AxiosRequestConfig
681
+ ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
682
+ /**
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.
688
+ *
689
+ */
690
+ 'delete'(
691
+ parameters?: Parameters<UnknownParamsObject> | null,
692
+ data?: any,
693
+ config?: AxiosRequestConfig
694
+ ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
695
+ }
496
696
  ['/v1/kanban/query/flows:autocomplete']: {
497
697
  /**
498
698
  * flowsAutocomplete - flowsAutocomplete
499
699
  *
500
- * Autocomplete flows data
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.
501
705
  *
502
706
  */
503
707
  'get'(
@@ -510,7 +714,11 @@ export interface PathsDictionary {
510
714
  /**
511
715
  * executeFlowsQuery - executeFlowsQuery
512
716
  *
513
- * Query Flows Data for Kanban View.
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
+ *
514
722
  */
515
723
  'post'(
516
724
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -527,6 +735,7 @@ export type Board = Components.Schemas.Board;
527
735
  export type BoardFilter = Components.Schemas.BoardFilter;
528
736
  export type BoardSummary = Components.Schemas.BoardSummary;
529
737
  export type DynamicDateValue = Components.Schemas.DynamicDateValue;
738
+ export type Error = Components.Schemas.Error;
530
739
  export type FilterGroup = Components.Schemas.FilterGroup;
531
740
  export type FilterItem = Components.Schemas.FilterItem;
532
741
  export type FilterOperator = Components.Schemas.FilterOperator;