@epilot/kanban-client 0.2.1 → 1.0.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/definition.js +1 -1
- package/dist/openapi-runtime.json +7 -0
- package/dist/openapi.d.ts +16 -5
- package/dist/openapi.json +54 -4
- package/package.json +3 -3
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={390:function(e,r,a){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var
|
|
1
|
+
(()=>{"use strict";var e={390:function(e,r,a){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(a(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/kanban/board":{"post":{"operationId":"createKanbanBoard","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/kanban/boards":{"get":{"operationId":"getKanbanBoards","parameters":[{"name":"filter","in":"query","required":false}],"responses":{}}},"/v1/kanban/board/{boardId}":{"get":{"operationId":"getKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteKanbanBoard","parameters":[{"name":"boardId","in":"path","required":true}],"responses":{}}},"/v1/kanban/query/flows:autocomplete":{"get":{"operationId":"flowsAutocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"size","in":"query"}],"responses":{}}},"/v1/kanban/query/flows:execute":{"post":{"operationId":"executeFlowsQuery","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{},"servers":[{"url":"https://kanban.sls.epilot.io"}]}')}},r={},a=function a(t){var n=r[t];if(void 0!==n)return n.exports;var o=r[t]={exports:{}};return e[t].call(o.exports,o,o.exports,a),o.exports}(390),t=exports;for(var n in a)t[n]=a[n];a.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -76,6 +76,10 @@ declare namespace Components {
|
|
|
76
76
|
shared_with?: string[];
|
|
77
77
|
shared_with_org?: boolean;
|
|
78
78
|
}
|
|
79
|
+
/**
|
|
80
|
+
* Dynamic date keywords that resolve to actual dates at runtime
|
|
81
|
+
*/
|
|
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";
|
|
79
83
|
export interface FilterGroup {
|
|
80
84
|
items: FilterItem[];
|
|
81
85
|
/**
|
|
@@ -97,7 +101,7 @@ declare namespace Components {
|
|
|
97
101
|
* EQUALS
|
|
98
102
|
*/
|
|
99
103
|
FilterOperator;
|
|
100
|
-
value?: /* The value to compare against - can be a single value (string, number, boolean) or an array of values */ ValueType;
|
|
104
|
+
value?: /* The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values */ ValueType;
|
|
101
105
|
/**
|
|
102
106
|
* The data type of the field
|
|
103
107
|
* example:
|
|
@@ -155,9 +159,9 @@ declare namespace Components {
|
|
|
155
159
|
title_chip_variant?: string;
|
|
156
160
|
}
|
|
157
161
|
/**
|
|
158
|
-
* The value to compare against - can be a single value (string, number, boolean) or an array of values
|
|
162
|
+
* The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values
|
|
159
163
|
*/
|
|
160
|
-
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)[];
|
|
164
|
+
export type ValueType = /* The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values */ string | /* Dynamic date keywords that resolve to actual dates at runtime */ DynamicDateValue | number | boolean | (string | /* Dynamic date keywords that resolve to actual dates at runtime */ DynamicDateValue | number | boolean)[];
|
|
161
165
|
}
|
|
162
166
|
}
|
|
163
167
|
declare namespace Paths {
|
|
@@ -254,6 +258,12 @@ declare namespace Paths {
|
|
|
254
258
|
}
|
|
255
259
|
}
|
|
256
260
|
namespace GetKanbanBoards {
|
|
261
|
+
namespace Parameters {
|
|
262
|
+
export type Filter = "owned" | "shared";
|
|
263
|
+
}
|
|
264
|
+
export interface QueryParameters {
|
|
265
|
+
filter?: Parameters.Filter;
|
|
266
|
+
}
|
|
257
267
|
namespace Responses {
|
|
258
268
|
export type $200 = Components.Schemas.BoardSummary[];
|
|
259
269
|
export interface $401 {
|
|
@@ -341,7 +351,7 @@ export interface OperationMethods {
|
|
|
341
351
|
* Get all Kanban boards
|
|
342
352
|
*/
|
|
343
353
|
'getKanbanBoards'(
|
|
344
|
-
parameters?: Parameters<
|
|
354
|
+
parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
|
|
345
355
|
data?: any,
|
|
346
356
|
config?: AxiosRequestConfig
|
|
347
357
|
): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
|
|
@@ -428,7 +438,7 @@ export interface PathsDictionary {
|
|
|
428
438
|
* Get all Kanban boards
|
|
429
439
|
*/
|
|
430
440
|
'get'(
|
|
431
|
-
parameters?: Parameters<
|
|
441
|
+
parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
|
|
432
442
|
data?: any,
|
|
433
443
|
config?: AxiosRequestConfig
|
|
434
444
|
): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
|
|
@@ -508,6 +518,7 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
508
518
|
export type Board = Components.Schemas.Board;
|
|
509
519
|
export type BoardFilter = Components.Schemas.BoardFilter;
|
|
510
520
|
export type BoardSummary = Components.Schemas.BoardSummary;
|
|
521
|
+
export type DynamicDateValue = Components.Schemas.DynamicDateValue;
|
|
511
522
|
export type FilterGroup = Components.Schemas.FilterGroup;
|
|
512
523
|
export type FilterItem = Components.Schemas.FilterItem;
|
|
513
524
|
export type FilterOperator = Components.Schemas.FilterOperator;
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Kanban API",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.2.1"
|
|
6
6
|
},
|
|
7
7
|
"tags": [
|
|
8
8
|
{
|
|
@@ -13,6 +13,9 @@
|
|
|
13
13
|
"security": [
|
|
14
14
|
{
|
|
15
15
|
"EpilotAuth": []
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"EpilotOrg": []
|
|
16
19
|
}
|
|
17
20
|
],
|
|
18
21
|
"paths": {
|
|
@@ -67,6 +70,21 @@
|
|
|
67
70
|
"tags": [
|
|
68
71
|
"Kanban"
|
|
69
72
|
],
|
|
73
|
+
"parameters": [
|
|
74
|
+
{
|
|
75
|
+
"name": "filter",
|
|
76
|
+
"in": "query",
|
|
77
|
+
"description": "Filter boards by ownership type. If not provided, returns all accessible boards.",
|
|
78
|
+
"schema": {
|
|
79
|
+
"type": "string",
|
|
80
|
+
"enum": [
|
|
81
|
+
"owned",
|
|
82
|
+
"shared"
|
|
83
|
+
]
|
|
84
|
+
},
|
|
85
|
+
"required": false
|
|
86
|
+
}
|
|
87
|
+
],
|
|
70
88
|
"responses": {
|
|
71
89
|
"200": {
|
|
72
90
|
"description": "Successfully retrieved boards",
|
|
@@ -413,6 +431,12 @@
|
|
|
413
431
|
"scheme": "bearer",
|
|
414
432
|
"description": "Authorization header with epilot OAuth2 bearer token",
|
|
415
433
|
"bearerFormat": "JWT"
|
|
434
|
+
},
|
|
435
|
+
"EpilotOrg": {
|
|
436
|
+
"description": "Overrides the target organization to allow shared tenantaccess",
|
|
437
|
+
"name": "x-epilot-org-id",
|
|
438
|
+
"in": "header",
|
|
439
|
+
"type": "apiKey"
|
|
416
440
|
}
|
|
417
441
|
},
|
|
418
442
|
"schemas": {
|
|
@@ -626,12 +650,32 @@
|
|
|
626
650
|
"example": "EQUALS",
|
|
627
651
|
"description": "The comparison operator for filtering"
|
|
628
652
|
},
|
|
653
|
+
"DynamicDateValue": {
|
|
654
|
+
"type": "string",
|
|
655
|
+
"enum": [
|
|
656
|
+
"TODAY",
|
|
657
|
+
"TOMORROW",
|
|
658
|
+
"YESTERDAY",
|
|
659
|
+
"IN_THE_FUTURE",
|
|
660
|
+
"IN_THE_PAST",
|
|
661
|
+
"THIS_WEEK",
|
|
662
|
+
"NEXT_WEEK",
|
|
663
|
+
"LAST_WEEK",
|
|
664
|
+
"THIS_MONTH",
|
|
665
|
+
"NEXT_MONTH",
|
|
666
|
+
"LAST_MONTH"
|
|
667
|
+
],
|
|
668
|
+
"description": "Dynamic date keywords that resolve to actual dates at runtime"
|
|
669
|
+
},
|
|
629
670
|
"ValueType": {
|
|
630
|
-
"
|
|
671
|
+
"anyOf": [
|
|
631
672
|
{
|
|
632
673
|
"type": "string",
|
|
633
674
|
"example": "100020"
|
|
634
675
|
},
|
|
676
|
+
{
|
|
677
|
+
"$ref": "#/components/schemas/DynamicDateValue"
|
|
678
|
+
},
|
|
635
679
|
{
|
|
636
680
|
"type": "number",
|
|
637
681
|
"example": 42
|
|
@@ -643,10 +687,13 @@
|
|
|
643
687
|
{
|
|
644
688
|
"type": "array",
|
|
645
689
|
"items": {
|
|
646
|
-
"
|
|
690
|
+
"anyOf": [
|
|
647
691
|
{
|
|
648
692
|
"type": "string"
|
|
649
693
|
},
|
|
694
|
+
{
|
|
695
|
+
"$ref": "#/components/schemas/DynamicDateValue"
|
|
696
|
+
},
|
|
650
697
|
{
|
|
651
698
|
"type": "number"
|
|
652
699
|
},
|
|
@@ -663,7 +710,7 @@
|
|
|
663
710
|
]
|
|
664
711
|
}
|
|
665
712
|
],
|
|
666
|
-
"description": "The value to compare against - can be a single value (string, number, boolean) or an array of values"
|
|
713
|
+
"description": "The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values"
|
|
667
714
|
},
|
|
668
715
|
"FlowsQueryRequest": {
|
|
669
716
|
"type": "object",
|
|
@@ -743,6 +790,9 @@
|
|
|
743
790
|
}
|
|
744
791
|
},
|
|
745
792
|
"servers": [
|
|
793
|
+
{
|
|
794
|
+
"url": "https://kanban.sls.epilot.io"
|
|
795
|
+
},
|
|
746
796
|
{
|
|
747
797
|
"url": "https://kanban.sls.epilot.io"
|
|
748
798
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/kanban-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Client library for epilot Kanban API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -50,10 +50,10 @@
|
|
|
50
50
|
"@types/jest": "^26.0.20",
|
|
51
51
|
"axios": "^1.11.0",
|
|
52
52
|
"copy-webpack-plugin": "^7.0.0",
|
|
53
|
-
"jest": "^
|
|
53
|
+
"jest": "^29.6.2",
|
|
54
54
|
"json-loader": "^0.5.7",
|
|
55
55
|
"openapicmd": "^2.7.0",
|
|
56
|
-
"ts-jest": "^
|
|
56
|
+
"ts-jest": "^29.4.1",
|
|
57
57
|
"ts-loader": "^8.0.14",
|
|
58
58
|
"ts-node": "^10.9.1",
|
|
59
59
|
"typescript": "^4.1.3",
|