@epilot/kanban-client 0.1.0 → 0.1.2-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 +69 -19
- package/dist/openapi.json +176 -46
- package/package.json +3 -2
package/dist/openapi.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ import type {
|
|
|
11
11
|
declare namespace Components {
|
|
12
12
|
namespace Schemas {
|
|
13
13
|
export interface Board {
|
|
14
|
-
id?: string;
|
|
14
|
+
id?: string;
|
|
15
15
|
/**
|
|
16
16
|
* example:
|
|
17
17
|
* Board 1
|
|
@@ -26,6 +26,7 @@ declare namespace Components {
|
|
|
26
26
|
updated_at?: string; // date-time
|
|
27
27
|
created_by?: string;
|
|
28
28
|
updated_by?: string;
|
|
29
|
+
shared_with?: string[];
|
|
29
30
|
config: {
|
|
30
31
|
/**
|
|
31
32
|
* example:
|
|
@@ -33,20 +34,28 @@ declare namespace Components {
|
|
|
33
34
|
*/
|
|
34
35
|
dataset?: string;
|
|
35
36
|
swimlanes?: Swimlane[];
|
|
36
|
-
|
|
37
|
+
card_config?: {
|
|
38
|
+
fields?: string[];
|
|
39
|
+
};
|
|
40
|
+
board_filter?: BoardFilter;
|
|
37
41
|
sorting?: Sorting;
|
|
42
|
+
/**
|
|
43
|
+
* example:
|
|
44
|
+
* task 1
|
|
45
|
+
*/
|
|
46
|
+
search_query?: string;
|
|
38
47
|
};
|
|
39
48
|
}
|
|
40
49
|
export interface BoardFilter {
|
|
50
|
+
items: (FilterItem | FilterGroup)[];
|
|
41
51
|
/**
|
|
42
52
|
* example:
|
|
43
|
-
*
|
|
53
|
+
* OR
|
|
44
54
|
*/
|
|
45
|
-
|
|
46
|
-
filter_values: string[];
|
|
55
|
+
combination: "AND" | "OR";
|
|
47
56
|
}
|
|
48
57
|
export interface BoardSummary {
|
|
49
|
-
id?: string;
|
|
58
|
+
id?: string;
|
|
50
59
|
/**
|
|
51
60
|
* example:
|
|
52
61
|
* Board 1
|
|
@@ -61,7 +70,43 @@ declare namespace Components {
|
|
|
61
70
|
updated_at?: string; // date-time
|
|
62
71
|
created_by?: string;
|
|
63
72
|
updated_by?: string;
|
|
73
|
+
shared_with?: string[];
|
|
64
74
|
}
|
|
75
|
+
export interface FilterGroup {
|
|
76
|
+
items: FilterItem[];
|
|
77
|
+
/**
|
|
78
|
+
* example:
|
|
79
|
+
* AND
|
|
80
|
+
*/
|
|
81
|
+
combination: "AND" | "OR";
|
|
82
|
+
}
|
|
83
|
+
export interface FilterItem {
|
|
84
|
+
/**
|
|
85
|
+
* The field key to filter on
|
|
86
|
+
* example:
|
|
87
|
+
* assignee
|
|
88
|
+
*/
|
|
89
|
+
key: string;
|
|
90
|
+
operator: /**
|
|
91
|
+
* The comparison operator for filtering
|
|
92
|
+
* example:
|
|
93
|
+
* EQUALS
|
|
94
|
+
*/
|
|
95
|
+
FilterOperator;
|
|
96
|
+
value: /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ ValueType;
|
|
97
|
+
/**
|
|
98
|
+
* The data type of the field
|
|
99
|
+
* example:
|
|
100
|
+
* string
|
|
101
|
+
*/
|
|
102
|
+
data_type?: "string" | "number" | "boolean" | "date";
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* The comparison operator for filtering
|
|
106
|
+
* example:
|
|
107
|
+
* EQUALS
|
|
108
|
+
*/
|
|
109
|
+
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";
|
|
65
110
|
export interface Sorting {
|
|
66
111
|
/**
|
|
67
112
|
* example:
|
|
@@ -71,13 +116,7 @@ declare namespace Components {
|
|
|
71
116
|
direction?: "asc" | "desc";
|
|
72
117
|
}
|
|
73
118
|
export interface Swimlane {
|
|
74
|
-
|
|
75
|
-
* example:
|
|
76
|
-
* status
|
|
77
|
-
*/
|
|
78
|
-
filter_field: string;
|
|
79
|
-
filter_values: string[];
|
|
80
|
-
id?: string; // uuid
|
|
119
|
+
id?: string;
|
|
81
120
|
/**
|
|
82
121
|
* example:
|
|
83
122
|
* Swimlane 1
|
|
@@ -88,12 +127,17 @@ declare namespace Components {
|
|
|
88
127
|
* 1
|
|
89
128
|
*/
|
|
90
129
|
position?: number;
|
|
130
|
+
filter?: BoardFilter;
|
|
91
131
|
/**
|
|
92
132
|
* example:
|
|
93
133
|
* success
|
|
94
134
|
*/
|
|
95
135
|
title_chip_variant?: string;
|
|
96
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* The value to compare against - can be a single value (string, number, boolean) or an array of values
|
|
139
|
+
*/
|
|
140
|
+
export type ValueType = /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ string | number | boolean | (string | number | boolean)[];
|
|
97
141
|
}
|
|
98
142
|
}
|
|
99
143
|
declare namespace Paths {
|
|
@@ -113,10 +157,10 @@ declare namespace Paths {
|
|
|
113
157
|
}
|
|
114
158
|
namespace DeleteKanbanBoard {
|
|
115
159
|
namespace Parameters {
|
|
116
|
-
export type BoardId = string;
|
|
160
|
+
export type BoardId = string;
|
|
117
161
|
}
|
|
118
162
|
export interface PathParameters {
|
|
119
|
-
boardId: Parameters.BoardId
|
|
163
|
+
boardId: Parameters.BoardId;
|
|
120
164
|
}
|
|
121
165
|
namespace Responses {
|
|
122
166
|
export interface $200 {
|
|
@@ -133,10 +177,10 @@ declare namespace Paths {
|
|
|
133
177
|
}
|
|
134
178
|
namespace GetKanbanBoard {
|
|
135
179
|
namespace Parameters {
|
|
136
|
-
export type BoardId = string;
|
|
180
|
+
export type BoardId = string;
|
|
137
181
|
}
|
|
138
182
|
export interface PathParameters {
|
|
139
|
-
boardId: Parameters.BoardId
|
|
183
|
+
boardId: Parameters.BoardId;
|
|
140
184
|
}
|
|
141
185
|
namespace Responses {
|
|
142
186
|
export type $200 = Components.Schemas.Board;
|
|
@@ -163,10 +207,10 @@ declare namespace Paths {
|
|
|
163
207
|
}
|
|
164
208
|
namespace UpdateKanbanBoard {
|
|
165
209
|
namespace Parameters {
|
|
166
|
-
export type BoardId = string;
|
|
210
|
+
export type BoardId = string;
|
|
167
211
|
}
|
|
168
212
|
export interface PathParameters {
|
|
169
|
-
boardId: Parameters.BoardId
|
|
213
|
+
boardId: Parameters.BoardId;
|
|
170
214
|
}
|
|
171
215
|
export type RequestBody = Components.Schemas.Board;
|
|
172
216
|
namespace Responses {
|
|
@@ -185,6 +229,7 @@ declare namespace Paths {
|
|
|
185
229
|
}
|
|
186
230
|
}
|
|
187
231
|
|
|
232
|
+
|
|
188
233
|
export interface OperationMethods {
|
|
189
234
|
/**
|
|
190
235
|
* createKanbanBoard - Create a Kanban board
|
|
@@ -299,8 +344,13 @@ export interface PathsDictionary {
|
|
|
299
344
|
|
|
300
345
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
301
346
|
|
|
347
|
+
|
|
302
348
|
export type Board = Components.Schemas.Board;
|
|
303
349
|
export type BoardFilter = Components.Schemas.BoardFilter;
|
|
304
350
|
export type BoardSummary = Components.Schemas.BoardSummary;
|
|
351
|
+
export type FilterGroup = Components.Schemas.FilterGroup;
|
|
352
|
+
export type FilterItem = Components.Schemas.FilterItem;
|
|
353
|
+
export type FilterOperator = Components.Schemas.FilterOperator;
|
|
305
354
|
export type Sorting = Components.Schemas.Sorting;
|
|
306
355
|
export type Swimlane = Components.Schemas.Swimlane;
|
|
356
|
+
export type ValueType = Components.Schemas.ValueType;
|
package/dist/openapi.json
CHANGED
|
@@ -107,8 +107,7 @@
|
|
|
107
107
|
"in": "path",
|
|
108
108
|
"required": true,
|
|
109
109
|
"schema": {
|
|
110
|
-
"type": "string"
|
|
111
|
-
"format": "uuid"
|
|
110
|
+
"type": "string"
|
|
112
111
|
}
|
|
113
112
|
}
|
|
114
113
|
],
|
|
@@ -150,8 +149,7 @@
|
|
|
150
149
|
"in": "path",
|
|
151
150
|
"required": true,
|
|
152
151
|
"schema": {
|
|
153
|
-
"type": "string"
|
|
154
|
-
"format": "uuid"
|
|
152
|
+
"type": "string"
|
|
155
153
|
}
|
|
156
154
|
}
|
|
157
155
|
],
|
|
@@ -205,8 +203,7 @@
|
|
|
205
203
|
"in": "path",
|
|
206
204
|
"required": true,
|
|
207
205
|
"schema": {
|
|
208
|
-
"type": "string"
|
|
209
|
-
"format": "uuid"
|
|
206
|
+
"type": "string"
|
|
210
207
|
}
|
|
211
208
|
}
|
|
212
209
|
],
|
|
@@ -250,8 +247,7 @@
|
|
|
250
247
|
"type": "object",
|
|
251
248
|
"properties": {
|
|
252
249
|
"id": {
|
|
253
|
-
"type": "string"
|
|
254
|
-
"format": "uuid"
|
|
250
|
+
"type": "string"
|
|
255
251
|
},
|
|
256
252
|
"title": {
|
|
257
253
|
"type": "string",
|
|
@@ -274,6 +270,12 @@
|
|
|
274
270
|
},
|
|
275
271
|
"updated_by": {
|
|
276
272
|
"type": "string"
|
|
273
|
+
},
|
|
274
|
+
"shared_with": {
|
|
275
|
+
"type": "array",
|
|
276
|
+
"items": {
|
|
277
|
+
"type": "string"
|
|
278
|
+
}
|
|
277
279
|
}
|
|
278
280
|
}
|
|
279
281
|
},
|
|
@@ -298,14 +300,27 @@
|
|
|
298
300
|
"$ref": "#/components/schemas/Swimlane"
|
|
299
301
|
}
|
|
300
302
|
},
|
|
301
|
-
"
|
|
302
|
-
"type": "
|
|
303
|
-
"
|
|
304
|
-
"
|
|
303
|
+
"card_config": {
|
|
304
|
+
"type": "object",
|
|
305
|
+
"properties": {
|
|
306
|
+
"fields": {
|
|
307
|
+
"type": "array",
|
|
308
|
+
"items": {
|
|
309
|
+
"type": "string",
|
|
310
|
+
"example": "assignee"
|
|
311
|
+
}
|
|
312
|
+
}
|
|
305
313
|
}
|
|
306
314
|
},
|
|
315
|
+
"board_filter": {
|
|
316
|
+
"$ref": "#/components/schemas/BoardFilter"
|
|
317
|
+
},
|
|
307
318
|
"sorting": {
|
|
308
319
|
"$ref": "#/components/schemas/Sorting"
|
|
320
|
+
},
|
|
321
|
+
"search_query": {
|
|
322
|
+
"type": "string",
|
|
323
|
+
"example": "task 1"
|
|
309
324
|
}
|
|
310
325
|
}
|
|
311
326
|
}
|
|
@@ -318,32 +333,27 @@
|
|
|
318
333
|
]
|
|
319
334
|
},
|
|
320
335
|
"Swimlane": {
|
|
321
|
-
"
|
|
322
|
-
|
|
336
|
+
"type": "object",
|
|
337
|
+
"properties": {
|
|
338
|
+
"id": {
|
|
339
|
+
"type": "string"
|
|
340
|
+
},
|
|
341
|
+
"title": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"example": "Swimlane 1"
|
|
344
|
+
},
|
|
345
|
+
"position": {
|
|
346
|
+
"type": "number",
|
|
347
|
+
"example": 1
|
|
348
|
+
},
|
|
349
|
+
"filter": {
|
|
323
350
|
"$ref": "#/components/schemas/BoardFilter"
|
|
324
351
|
},
|
|
325
|
-
{
|
|
326
|
-
"type": "
|
|
327
|
-
"
|
|
328
|
-
"id": {
|
|
329
|
-
"type": "string",
|
|
330
|
-
"format": "uuid"
|
|
331
|
-
},
|
|
332
|
-
"title": {
|
|
333
|
-
"type": "string",
|
|
334
|
-
"example": "Swimlane 1"
|
|
335
|
-
},
|
|
336
|
-
"position": {
|
|
337
|
-
"type": "number",
|
|
338
|
-
"example": 1
|
|
339
|
-
},
|
|
340
|
-
"title_chip_variant": {
|
|
341
|
-
"type": "string",
|
|
342
|
-
"example": "success"
|
|
343
|
-
}
|
|
344
|
-
}
|
|
352
|
+
"title_chip_variant": {
|
|
353
|
+
"type": "string",
|
|
354
|
+
"example": "success"
|
|
345
355
|
}
|
|
346
|
-
|
|
356
|
+
}
|
|
347
357
|
},
|
|
348
358
|
"Sorting": {
|
|
349
359
|
"type": "object",
|
|
@@ -368,29 +378,149 @@
|
|
|
368
378
|
"BoardFilter": {
|
|
369
379
|
"type": "object",
|
|
370
380
|
"properties": {
|
|
371
|
-
"
|
|
372
|
-
"type": "
|
|
373
|
-
"
|
|
381
|
+
"items": {
|
|
382
|
+
"type": "array",
|
|
383
|
+
"items": {
|
|
384
|
+
"oneOf": [
|
|
385
|
+
{
|
|
386
|
+
"$ref": "#/components/schemas/FilterItem"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"$ref": "#/components/schemas/FilterGroup"
|
|
390
|
+
}
|
|
391
|
+
]
|
|
392
|
+
}
|
|
374
393
|
},
|
|
375
|
-
"
|
|
394
|
+
"combination": {
|
|
395
|
+
"type": "string",
|
|
396
|
+
"enum": [
|
|
397
|
+
"AND",
|
|
398
|
+
"OR"
|
|
399
|
+
],
|
|
400
|
+
"example": "OR"
|
|
401
|
+
}
|
|
402
|
+
},
|
|
403
|
+
"required": [
|
|
404
|
+
"items",
|
|
405
|
+
"combination"
|
|
406
|
+
]
|
|
407
|
+
},
|
|
408
|
+
"FilterGroup": {
|
|
409
|
+
"type": "object",
|
|
410
|
+
"properties": {
|
|
411
|
+
"items": {
|
|
376
412
|
"type": "array",
|
|
377
413
|
"items": {
|
|
378
|
-
"
|
|
379
|
-
"example": "SKIPPED"
|
|
414
|
+
"$ref": "#/components/schemas/FilterItem"
|
|
380
415
|
}
|
|
416
|
+
},
|
|
417
|
+
"combination": {
|
|
418
|
+
"type": "string",
|
|
419
|
+
"enum": [
|
|
420
|
+
"AND",
|
|
421
|
+
"OR"
|
|
422
|
+
],
|
|
423
|
+
"example": "AND"
|
|
424
|
+
}
|
|
425
|
+
},
|
|
426
|
+
"required": [
|
|
427
|
+
"items",
|
|
428
|
+
"combination"
|
|
429
|
+
]
|
|
430
|
+
},
|
|
431
|
+
"FilterOperator": {
|
|
432
|
+
"type": "string",
|
|
433
|
+
"enum": [
|
|
434
|
+
"EQUALS",
|
|
435
|
+
"NOT_EQUALS",
|
|
436
|
+
"EMPTY",
|
|
437
|
+
"NOT_EMPTY",
|
|
438
|
+
"CONTAINS",
|
|
439
|
+
"NOT_CONTAINS",
|
|
440
|
+
"IS_ONE_OF",
|
|
441
|
+
"IS_NONE_OF",
|
|
442
|
+
"GREATER_THAN",
|
|
443
|
+
"LESS_THAN",
|
|
444
|
+
"GREATER_THAN_OR_EQUAL",
|
|
445
|
+
"LESS_THAN_OR_EQUAL"
|
|
446
|
+
],
|
|
447
|
+
"example": "EQUALS",
|
|
448
|
+
"description": "The comparison operator for filtering"
|
|
449
|
+
},
|
|
450
|
+
"ValueType": {
|
|
451
|
+
"oneOf": [
|
|
452
|
+
{
|
|
453
|
+
"type": "string",
|
|
454
|
+
"example": "100020"
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"type": "number",
|
|
458
|
+
"example": 42
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"type": "boolean",
|
|
462
|
+
"example": true
|
|
463
|
+
},
|
|
464
|
+
{
|
|
465
|
+
"type": "array",
|
|
466
|
+
"items": {
|
|
467
|
+
"oneOf": [
|
|
468
|
+
{
|
|
469
|
+
"type": "string"
|
|
470
|
+
},
|
|
471
|
+
{
|
|
472
|
+
"type": "number"
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
"type": "boolean"
|
|
476
|
+
}
|
|
477
|
+
]
|
|
478
|
+
},
|
|
479
|
+
"example": [
|
|
480
|
+
"value1",
|
|
481
|
+
"value2",
|
|
482
|
+
123,
|
|
483
|
+
true
|
|
484
|
+
]
|
|
485
|
+
}
|
|
486
|
+
],
|
|
487
|
+
"description": "The value to compare against - can be a single value (string, number, boolean) or an array of values"
|
|
488
|
+
},
|
|
489
|
+
"FilterItem": {
|
|
490
|
+
"type": "object",
|
|
491
|
+
"properties": {
|
|
492
|
+
"key": {
|
|
493
|
+
"type": "string",
|
|
494
|
+
"example": "assignee",
|
|
495
|
+
"description": "The field key to filter on"
|
|
496
|
+
},
|
|
497
|
+
"operator": {
|
|
498
|
+
"$ref": "#/components/schemas/FilterOperator"
|
|
499
|
+
},
|
|
500
|
+
"value": {
|
|
501
|
+
"$ref": "#/components/schemas/ValueType"
|
|
502
|
+
},
|
|
503
|
+
"data_type": {
|
|
504
|
+
"type": "string",
|
|
505
|
+
"enum": [
|
|
506
|
+
"string",
|
|
507
|
+
"number",
|
|
508
|
+
"boolean",
|
|
509
|
+
"date"
|
|
510
|
+
],
|
|
511
|
+
"example": "string",
|
|
512
|
+
"description": "The data type of the field"
|
|
381
513
|
}
|
|
382
514
|
},
|
|
383
515
|
"required": [
|
|
384
|
-
"
|
|
385
|
-
"
|
|
516
|
+
"key",
|
|
517
|
+
"operator",
|
|
518
|
+
"value"
|
|
386
519
|
]
|
|
387
520
|
}
|
|
388
521
|
}
|
|
389
522
|
},
|
|
390
523
|
"servers": [
|
|
391
|
-
{
|
|
392
|
-
"url": "https://kanban.sls.epilot.io"
|
|
393
|
-
},
|
|
394
524
|
{
|
|
395
525
|
"url": "https://kanban.sls.epilot.io"
|
|
396
526
|
}
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/kanban-client",
|
|
3
|
-
"version": "0.1.0",
|
|
3
|
+
"version": "0.1.2-0",
|
|
4
4
|
"description": "Client library for epilot Kanban API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"author": "epilot GmbH",
|
|
8
8
|
"license": "MIT",
|
|
9
|
+
"private": false,
|
|
9
10
|
"repository": {
|
|
10
11
|
"type": "git",
|
|
11
12
|
"url": "git+https://github.com/epilot-dev/sdk-js.git",
|
|
@@ -63,7 +64,7 @@
|
|
|
63
64
|
"copy-webpack-plugin": "^7.0.0",
|
|
64
65
|
"jest": "^26.6.3",
|
|
65
66
|
"json-loader": "^0.5.7",
|
|
66
|
-
"openapicmd": "^2.6.
|
|
67
|
+
"openapicmd": "^2.6.2",
|
|
67
68
|
"ts-jest": "^26.5.0",
|
|
68
69
|
"ts-loader": "^8.0.14",
|
|
69
70
|
"ts-node": "^10.9.1",
|