@epilot/kanban-client 1.0.1 → 1.2.0

package/dist/definition.js

@@ -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 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})})();
+(()=>{"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/org/default-board":{"put":{"operationId":"setDefaultKanbanBoard","parameters":[{"name":"boardId","in":"query","required":true}],"responses":{}},"delete":{"operationId":"clearDefaultKanbanBoard","responses":{}}},"/v1/kanban/query/flows:autocomplete":{"get":{"operationId":"flowsAutocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"size","in":"query"},{"name":"from","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-runtime.json

@@ -85,6 +85,23 @@
         "responses": {}
       }
     },
+    "/v1/kanban/org/default-board": {
+      "put": {
+        "operationId": "setDefaultKanbanBoard",
+        "parameters": [
+          {
+            "name": "boardId",
+            "in": "query",
+            "required": true
+          }
+        ],
+        "responses": {}
+      },
+      "delete": {
+        "operationId": "clearDefaultKanbanBoard",
+        "responses": {}
+      }
+    },
     "/v1/kanban/query/flows:autocomplete": {
       "get": {
         "operationId": "flowsAutocomplete",
@@ -101,6 +118,10 @@
           {
             "name": "size",
             "in": "query"
+          },
+          {
+            "name": "from",
+            "in": "query"
           }
         ],
         "responses": {}

package/dist/openapi.d.ts

@@ -29,6 +29,10 @@ declare namespace Components {
             updated_by?: string;
             shared_with?: string[];
             shared_with_org?: boolean;
+            /**
+             * Array of user IDs who have full ownership rights for this board (view, edit, delete)
+             */
+            owners?: string[];
             config: {
                 /**
                  * example:
@@ -75,6 +79,10 @@ declare namespace Components {
             updated_by?: string;
             shared_with?: string[];
             shared_with_org?: boolean;
+            /**
+             * Array of user IDs who have full ownership rights for this board (view, edit, delete)
+             */
+            owners?: string[];
         }
         /**
          * Dynamic date keywords that resolve to actual dates at runtime
@@ -165,6 +173,20 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace ClearDefaultKanbanBoard {
+        namespace Responses {
+            export interface $200 {
+                message?: string;
+                default_board_id?: string | null;
+            }
+            export interface $401 {
+            }
+            export interface $403 {
+            }
+            export interface $500 {
+            }
+        }
+    }
     namespace CreateKanbanBoard {
         export type RequestBody = Components.Schemas.Board;
         namespace Responses {
@@ -212,6 +234,7 @@ declare namespace Paths {
              * name
              */
             export type Attribute = string;
+            export type From = number;
             export type Input = string;
             export type Size = number;
         }
@@ -223,6 +246,7 @@ declare namespace Paths {
              */
             Parameters.Attribute;
             size?: Parameters.Size;
+            from?: Parameters.From;
         }
         namespace Responses {
             export interface $200 {
@@ -232,9 +256,15 @@ declare namespace Paths {
                  *   "value"
                  * ]
                  */
-                results?: (string | boolean | {
+                results: (string | boolean | {
                     [name: string]: any;
                 })[];
+                /**
+                 * Total number of matching items available
+                 * example:
+                 * 42
+                 */
+                hits: number;
             }
         }
     }
@@ -294,6 +324,10 @@ declare namespace Paths {
             description?: string;
             shared_with?: string[];
             shared_with_org?: boolean;
+            /**
+             * Array of user IDs who have full ownership rights for this board (view, edit, delete)
+             */
+            owners?: string[];
         }
         namespace Responses {
             export type $200 = Components.Schemas.Board;
@@ -309,6 +343,30 @@ declare namespace Paths {
             }
         }
     }
+    namespace SetDefaultKanbanBoard {
+        namespace Parameters {
+            export type BoardId = string;
+        }
+        export interface QueryParameters {
+            boardId: Parameters.BoardId;
+        }
+        namespace Responses {
+            export interface $200 {
+                message?: string;
+                default_board_id?: string;
+            }
+            export interface $400 {
+            }
+            export interface $401 {
+            }
+            export interface $403 {
+            }
+            export interface $404 {
+            }
+            export interface $500 {
+            }
+        }
+    }
     namespace UpdateKanbanBoard {
         namespace Parameters {
             export type BoardId = string;
@@ -358,7 +416,8 @@ export interface OperationMethods {
   /**
    * getKanbanBoard - Get a Kanban board
    * 
-   * Get a Kanban board
+   * Get a Kanban board by ID. Use "default" as the boardId to get the organization's default board.
+   * 
    */
   'getKanbanBoard'(
     parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
@@ -395,6 +454,26 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
+  /**
+   * setDefaultKanbanBoard - Set default board for organization
+   * 
+   * Set a board as the default board for the organization
+   */
+  'setDefaultKanbanBoard'(
+    parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
+  /**
+   * clearDefaultKanbanBoard - Clear default board for organization
+   * 
+   * Remove the default board setting for the organization
+   */
+  'clearDefaultKanbanBoard'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
   /**
    * flowsAutocomplete - flowsAutocomplete
    * 
@@ -447,7 +526,8 @@ export interface PathsDictionary {
     /**
      * getKanbanBoard - Get a Kanban board
      * 
-     * Get a Kanban board
+     * Get a Kanban board by ID. Use "default" as the boardId to get the organization's default board.
+     * 
      */
     'get'(
       parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
@@ -485,6 +565,28 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
   }
+  ['/v1/kanban/org/default-board']: {
+    /**
+     * setDefaultKanbanBoard - Set default board for organization
+     * 
+     * Set a board as the default board for the organization
+     */
+    'put'(
+      parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
+    /**
+     * clearDefaultKanbanBoard - Clear default board for organization
+     * 
+     * Remove the default board setting for the organization
+     */
+    'delete'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
+  }
   ['/v1/kanban/query/flows:autocomplete']: {
     /**
      * flowsAutocomplete - flowsAutocomplete

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Kanban API",
-    "version": "1.2.1"
+    "version": "1.2.3"
   },
   "tags": [
     {
@@ -115,7 +115,7 @@
       "get": {
         "operationId": "getKanbanBoard",
         "summary": "Get a Kanban board",
-        "description": "Get a Kanban board",
+        "description": "Get a Kanban board by ID. Use \"default\" as the boardId to get the organization's default board.\n",
         "tags": [
           "Kanban"
         ],
@@ -126,7 +126,9 @@
             "required": true,
             "schema": {
               "type": "string"
-            }
+            },
+            "description": "The board ID, or \"default\" to get the organization's default board.\n",
+            "example": "board-123"
           }
         ],
         "responses": {
@@ -247,6 +249,13 @@
                   },
                   "shared_with_org": {
                     "type": "boolean"
+                  },
+                  "owners": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Array of user IDs who have full ownership rights for this board (view, edit, delete)"
                   }
                 }
               }
@@ -317,6 +326,100 @@
         }
       }
     },
+    "/v1/kanban/org/default-board": {
+      "put": {
+        "operationId": "setDefaultKanbanBoard",
+        "summary": "Set default board for organization",
+        "description": "Set a board as the default board for the organization",
+        "tags": [
+          "Kanban"
+        ],
+        "parameters": [
+          {
+            "name": "boardId",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The ID of the board to set as default"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successfully set default board",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "default_board_id": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request - Invalid input data or boardId missing"
+          },
+          "401": {
+            "description": "Unauthorized - Authentication required"
+          },
+          "403": {
+            "description": "Forbidden - Insufficient permissions"
+          },
+          "404": {
+            "description": "Board not found"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "clearDefaultKanbanBoard",
+        "summary": "Clear default board for organization",
+        "description": "Remove the default board setting for the organization",
+        "tags": [
+          "Kanban"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successfully cleared default board",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "default_board_id": {
+                      "type": "string",
+                      "nullable": true
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized - Authentication required"
+          },
+          "403": {
+            "description": "Forbidden - Insufficient permissions"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    },
     "/v1/kanban/query/flows:autocomplete": {
       "get": {
         "operationId": "flowsAutocomplete",
@@ -354,6 +457,16 @@
               "minimum": 1,
               "maximum": 250
             }
+          },
+          {
+            "name": "from",
+            "in": "query",
+            "description": "Starting offset for pagination",
+            "schema": {
+              "type": "integer",
+              "default": 0,
+              "minimum": 0
+            }
           }
         ],
         "responses": {
@@ -383,8 +496,17 @@
                       "example": [
                         "value"
                       ]
+                    },
+                    "hits": {
+                      "type": "number",
+                      "description": "Total number of matching items available",
+                      "example": 42
                     }
-                  }
+                  },
+                  "required": [
+                    "results",
+                    "hits"
+                  ]
                 }
               }
             }
@@ -479,6 +601,13 @@
           },
           "shared_with_org": {
             "type": "boolean"
+          },
+          "owners": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array of user IDs who have full ownership rights for this board (view, edit, delete)"
           }
         }
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/kanban-client",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Client library for epilot Kanban API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",