@keboola/api-client 27.0.0 → 29.0.0

package/dist/types-CjAia48k.d.ts

@@ -0,0 +1,386 @@
+import { c as OpenapiReturnType, n as ArrayElement, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-8pN6Emos.js";
+//#region src/clients/vault/__generated__/schema.d.ts
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+type paths = {
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Health-check endpoint
+     * @description Checks the service is up & running.
+     */
+    post: operations['healthCheck'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables
+     * @description Lists variables.
+     */
+    get: operations['listVariables'];
+    put?: never;
+    /**
+     * Create variable
+     * @description Creates a new variable.
+     */
+    post: operations['createVariable'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/{hash}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    post?: never;
+    /**
+     * Delete variable
+     * @description Deletes a variable.
+     */
+    delete: operations['deleteVariable'];
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/merged/branch': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables variables available in scope of the branch
+     * @deprecated
+     * @description List variables variables available in scope of the branch.
+     */
+    get: {
+      parameters: {
+        query: {
+          /** @description Branch ID */
+          branchId: string;
+        };
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['VariableWithHash'][];
+          };
+        };
+        401: components['responses']['401_Unauthorized'];
+        403: components['responses']['403_Forbidden'];
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/scoped/branch/{branchId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables variables available in scope of the branch
+     * @description List variables variables available in scope of the branch.
+     */
+    get: operations['listBranchVariables'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    Variable: {
+      /** @example mysql_host */
+      key: string;
+      value: string;
+      /** @default [] */
+      flags: ('encrypted' | 'oauthCredentialsId')[];
+      /** @example MySQL Credentials */
+      group?: string;
+      /**
+       * @description Key-value map of additional attributes.
+       *
+       *     Attributes are part of the variable identity, so two variables with the same key but different attributes
+       *     are considered different.
+       * @default {}
+       */
+      attributes: {
+        branchId?: string;
+      } & {
+        [key: string]: string;
+      };
+    };
+    VariableWithHash: components['schemas']['Variable'] & {
+      /** @description SHA-256 hash of the variable key + attributes */
+      hash?: string;
+    };
+    Error: {
+      error: string;
+      code: number;
+      exceptionId: string;
+      /** @enum {unknown} */
+      status: 'error';
+      context?: Record<string, never>;
+    };
+  };
+  responses: {
+    /** @description Bad request */
+    '400_BadRequest': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+    /** @description Unauthorized */
+    '401_Unauthorized': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+    /** @description Forbidden */
+    '403_Forbidden': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+interface operations {
+  healthCheck: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': {
+            api?: string;
+            /** Format: url */
+            documentation?: string;
+          };
+        };
+      };
+    };
+  };
+  listVariables: {
+    parameters: {
+      query?: {
+        /** @description Variable key */
+        key?: string;
+        /** @description Attributes to match */
+        attributes?: {
+          branchId?: string;
+        };
+        /** @description Pagination offset */
+        offset?: number;
+        /** @description Maximum number of items to return */
+        limit?: number;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'][];
+        };
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Invalid request parameters */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  createVariable: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        'application/json': components['schemas']['Variable'];
+      };
+    };
+    responses: {
+      /** @description Variable created */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'];
+        };
+      };
+      400: components['responses']['400_BadRequest'];
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Invalid request payload */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  deleteVariable: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Variable hash */
+        hash: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Variable deleted */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Variable not found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  listBranchVariables: {
+    parameters: {
+      query?: {
+        /** @description Variable key. If set, only variables with given key are returned. */
+        key?: string;
+        /**
+         * @description Other attributes to match.
+         *     * if attribute is set with value, only variables with given attribute value are returned
+         *     * if attribute is set without value (empty string), only variables without the attribute are returned
+         *     * any attribute not set is not matched, variables are returned regardless if they have the attribute or not
+         */
+        attributes?: Record<string, never>;
+      };
+      header?: never;
+      path: {
+        /** @description ID of the branch */
+        branchId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'][];
+        };
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+    };
+  };
+}
+//#endregion
+//#region src/clients/vault/types.d.ts
+type GetVariablesQuery = OpenapiQueryType<paths['/variables']['get']>;
+type DeleteVariablePath = OpenapiPathType<paths['/variables/{hash}']['delete']>;
+type CreateVariableBody = OpenapiBodyType<paths['/variables']['post']>;
+type GetVariablesByBranchId = OpenapiPathType<paths['/variables/scoped/branch/{branchId}']['get']>;
+type VariableWithHashRaw = ArrayElement<OpenapiReturnType<paths['/variables']['get']>>;
+type VariableWithHash = Omit<VariableWithHashRaw, 'hash'> & {
+  hash: string;
+};
+type AnyVariable = VariableWithHash | CreateVariableBody;
+//#endregion
+export { GetVariablesQuery as a, GetVariablesByBranchId as i, CreateVariableBody as n, VariableWithHash as o, DeleteVariablePath as r, AnyVariable as t };
+//# sourceMappingURL=types-CjAia48k.d.ts.map

package/dist/{types-ebolWqn1.d.ts → types-CtdyAkzI.d.cts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, O as OpenapiBodyType, c as OpenapiQueryType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-CLPrlyIz.cjs";
+//#region src/clients/queryService/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -917,13 +916,7 @@ type components = {
     /** @enum {string} */
     'models.JobState': 'created' | 'enqueued' | 'processing' | 'canceled' | 'completed' | 'failed';
     /** @enum {string} */
-    'models.StatementState':
-      | 'waiting'
-      | 'processing'
-      | 'canceled'
-      | 'completed'
-      | 'failed'
-      | 'notExecuted';
+    'models.StatementState': 'waiting' | 'processing' | 'canceled' | 'completed' | 'failed' | 'notExecuted';
   };
   responses: never;
   parameters: never;
@@ -931,7 +924,8 @@ type components = {
   headers: never;
   pathItems: never;
 };
-
+//#endregion
+//#region src/clients/queryService/types.d.ts
 type PostQueryPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['post']>;
 type GetQueriesPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
 type GetQueriesHistoryQuery = OpenapiQueryType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
@@ -941,13 +935,30 @@ type PostCancelQueryJobPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId
 type GetQueryResultsPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
 type GetQueryResutsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
 type JobStatusResponse = OpenapiReturnType<paths['/api/v1/queries/{queryJobId}']['get']>;
+/**
+ * The statuses a query job reports.
+ *
+ * - Terminal: `completed`, `failed`, `canceled` — one `l`, the backend's spelling.
+ * - In flight: `created`, `enqueued`, `processing`.
+ * - Overlaps the other services by label only: `processing` is a status of all three and `created`
+ *   of the queue too, while `canceled` and `failed` have no queue equivalent (it spells them
+ *   `cancelled` and `error`). A status is only meaningful against the service that reported it.
+ * - The states form a graph, not a flag set: `created` reaches only `enqueued` or `canceled`, and
+ *   `completed` is reachable only from `processing`. So a job that never started can't be `failed`.
+ * - `models.JobState` in `keboola/go-monorepo`
+ *   (`services/query/internal/repository/models/job_state.go`) is the source, and `IsTerminal()`
+ *   there is the terminal set above. Derived rather than written out, so a backend change to the
+ *   enum lands here through `pnpm gen:types`.
+ */
+type QueryJobStatus = JobStatusResponse['status'];
 type Statements = OpenapiReturnType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>['statements'];
 type GetExportResultsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/export']['get']>;
 type ExportResultsResponse = {
-    content: string;
-    fileName: string;
-    mimeType: string;
+  content: string;
+  fileName: string;
+  mimeType: string;
 };
 type QueryResult = OpenapiReturnType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
-
-export type { ExportResultsResponse as E, GetQueryJobPath as G, JobStatusResponse as J, PostQueryPath as P, QueryResult as Q, Statements as S, PostQueryBody as a, PostCancelQueryJobPath as b, components as c, GetQueryResultsPath as d, GetQueryResutsQuery as e, GetQueriesPath as f, GetQueriesHistoryQuery as g, GetExportResultsQuery as h };
+//#endregion
+export { GetQueryJobPath as a, JobStatusResponse as c, PostQueryPath as d, QueryJobStatus as f, components as h, GetQueriesPath as i, PostCancelQueryJobPath as l, Statements as m, GetExportResultsQuery as n, GetQueryResultsPath as o, QueryResult as p, GetQueriesHistoryQuery as r, GetQueryResutsQuery as s, ExportResultsResponse as t, PostQueryBody as u };
+//# sourceMappingURL=types-CtdyAkzI.d.cts.map

package/dist/{types-COti0FGo.d.ts → types-CvADp-x-.d.ts}

@@ -1,10 +1,9 @@
-import { c as OpenapiQueryType, d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-8pN6Emos.js";
+//#region src/clients/notifications/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/events/{eventName}': {
     parameters: {
@@ -126,9 +125,7 @@ type components = {
          */
         operator?: '==' | '>=';
       }[];
-      recipient:
-        | components['schemas']['RecipientChannel_Email']
-        | components['schemas']['RecipientChannel_Webhook'];
+      recipient: components['schemas']['RecipientChannel_Email'] | components['schemas']['RecipientChannel_Webhook'];
     };
     ProjectSubscription: {
       id: components['schemas']['NumericString'];
@@ -341,9 +338,7 @@ interface operations {
            * @enum {string}
            */
           type: 'direct-project-email' | 'direct-project-webhook';
-          recipient:
-            | components['schemas']['RecipientChannel_Email']
-            | components['schemas']['RecipientChannel_Webhook'];
+          recipient: components['schemas']['RecipientChannel_Email'] | components['schemas']['RecipientChannel_Webhook'];
           /** @description Event data according to notification type schema */
           data: {
             project: {
@@ -397,12 +392,14 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/notifications/types.d.ts
 type ListSubscriptionsQuery = OpenapiQueryType<paths['/project-subscriptions']['get']>;
 type CreateSubscriptionBody = OpenapiBodyType<paths['/project-subscriptions']['post']>;
 type ProjectSubscription = OpenapiReturnType<paths['/project-subscriptions/{subscriptionId}']['get']>;
 type SubscriptionId = OpenapiPathType<paths['/project-subscriptions/{subscriptionId}']['get']>['subscriptionId'];
 type SubscriptionRecipient = CreateSubscriptionBody['recipient'];
 type SubscriptionFilter = NonNullable<CreateSubscriptionBody['filters']>[number];
-
-export type { CreateSubscriptionBody as C, ListSubscriptionsQuery as L, ProjectSubscription as P, SubscriptionId as S, SubscriptionFilter as a, SubscriptionRecipient as b, components as c };
+//#endregion
+export { SubscriptionId as a, SubscriptionFilter as i, ListSubscriptionsQuery as n, SubscriptionRecipient as o, ProjectSubscription as r, components as s, CreateSubscriptionBody as t };
+//# sourceMappingURL=types-CvADp-x-.d.ts.map