@keboola/api-client 27.0.0 → 31.0.0

package/dist/{types-DrGnvgkB.d.ts → types-DSBNqF1J.d.cts}

@@ -1,16 +1,9 @@
-import { e as OpenapiFormDataType } from './types-f8dUjMX4.js';
-
-type UploadProgress = {
-    loaded: number;
-    total: number;
-    percent: number;
-};
-
+import { i as OpenapiFormDataType } from "./index-B-frWtGW.cjs";
+//#region src/clients/import/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -455,14 +448,16 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/import/types.d.ts
 type UploadFileFormData = OpenapiFormDataType<paths['/upload-file']['post']>;
 type UploadFileInput = Omit<UploadFileFormData, 'data'> & {
-    file: File;
+  file: File;
 };
 type WriteTableFormData = OpenapiFormDataType<paths['/write-table']['post']>;
 type WriteTableInput = Omit<WriteTableFormData, 'data'> & {
-    file: File;
+  file: File;
 };
-
-export type { UploadFileInput as U, WriteTableInput as W, UploadProgress as a };
+//#endregion
+export { WriteTableInput as n, UploadFileInput as t };
+//# sourceMappingURL=types-DSBNqF1J.d.cts.map

package/dist/{types-BCBF_5cU.d.cts → types-DWUd__fe.d.ts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.cjs';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType } from "./index-Ds8e0l7-.js";
+//#region src/clients/metastore/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -1429,25 +1428,23 @@ type components = {
   headers: never;
   pathItems: never;
 };
-
-type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
-type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
-
+//#endregion
+//#region src/clients/metastore/repository/types.d.ts
 type MetaObjectMeta = NonNullable<components['schemas']['handlers.JSONAPIMetaObjectResource']['meta']>;
 type MetaObject<TData extends Record<string, unknown>, TDataOptional extends boolean = false> = {
-    uuid: string;
-    meta: MetaObjectMeta;
+  uuid: string;
+  meta: MetaObjectMeta;
 } & (TDataOptional extends true ? {
-    data?: TData;
+  data?: TData;
 } : {
-    data: TData;
+  data: TData;
 });
 type GetMetaObjectsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['get']>;
 type CreateMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectReturn = OpenapiReturnType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = CreateMetaObjectPath & Omit<CreateMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['get']>;
 type DeleteMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['delete']>;
@@ -1459,18 +1456,18 @@ type UpdateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectTyp
  * patch stays unrepresentable because each branch requires its lead field.
  */
 type UpdateMetaObjectContentPatch<TData extends Record<string, unknown>> = {
-    data: Partial<TData>;
-    name?: UpdateMetaObjectBody['name'];
-    scope?: never;
+  data: Partial<TData>;
+  name?: UpdateMetaObjectBody['name'];
+  scope?: never;
 } | {
-    name: NonNullable<UpdateMetaObjectBody['name']>;
-    data?: Partial<TData>;
-    scope?: never;
+  name: NonNullable<UpdateMetaObjectBody['name']>;
+  data?: Partial<TData>;
+  scope?: never;
 };
 type UpdateMetaObjectScopeStepUp = {
-    scope: NonNullable<UpdateMetaObjectBody['scope']>;
-    data?: never;
-    name?: never;
+  scope: NonNullable<UpdateMetaObjectBody['scope']>;
+  data?: never;
+  name?: never;
 };
 /**
  * A PATCH is exactly one of two operations, and the metastore enforces the split server-side: a
@@ -1487,22 +1484,27 @@ type ReplaceTargetProjectsInput = ReplaceTargetProjectsPath & ReplaceTargetProje
 type ReplaceMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = ReplaceMetaObjectPath & Omit<ReplaceMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectRevisionsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/revisions']['get']>;
 type GetMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['get']>;
 type DeleteMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['delete']>;
 type RawMetaObject<TData extends Record<string, unknown>> = {
-    type: string;
-    id: string;
-    attributes: TData;
-    meta: MetaObjectMeta;
+  type: string;
+  id: string;
+  attributes: TData;
+  meta: MetaObjectMeta;
 };
 type MetaStoreObjectResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>;
+  data: RawMetaObject<TData>;
 };
 type MetaStoreListResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>[];
+  data: RawMetaObject<TData>[];
 };
-
-export type { CreateMetaObjectInput as C, DeleteMetaObjectPath as D, GetMetaObjectsPath as G, MetaObject as M, ReplaceMetaObjectInput as R, UpdateMetaObjectInput as U, MetaStoreListResponse as a, GetMetaObjectRevisionsPath as b, GetMetaObjectPath as c, MetaStoreObjectResponse as d, ReplaceTargetProjectsInput as e, GetMetaObjectRevisionPath as f, DeleteMetaObjectRevisionPath as g, GetSchemaPath as h, components as i, GetVersionedSchemaPath as j, CreateMetaObjectBody as k, CreateMetaObjectPath as l, CreateMetaObjectReturn as m, MetaObjectMeta as n, RawMetaObject as o, ReplaceMetaObjectBody as p, ReplaceMetaObjectPath as q, ReplaceTargetProjectsBody as r, ReplaceTargetProjectsPath as s, UpdateMetaObjectBody as t, UpdateMetaObjectPath as u };
+//#endregion
+//#region src/clients/metastore/schema/types.d.ts
+type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
+type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
+//#endregion
+export { ReplaceTargetProjectsPath as C, components as D, UpdateMetaObjectPath as E, paths as O, ReplaceTargetProjectsInput as S, UpdateMetaObjectInput as T, RawMetaObject as _, CreateMetaObjectPath as a, ReplaceMetaObjectPath as b, DeleteMetaObjectRevisionPath as c, GetMetaObjectRevisionsPath as d, GetMetaObjectsPath as f, MetaStoreObjectResponse as g, MetaStoreListResponse as h, CreateMetaObjectInput as i, GetMetaObjectPath as l, MetaObjectMeta as m, GetVersionedSchemaPath as n, CreateMetaObjectReturn as o, MetaObject as p, CreateMetaObjectBody as r, DeleteMetaObjectPath as s, GetSchemaPath as t, GetMetaObjectRevisionPath as u, ReplaceMetaObjectBody as v, UpdateMetaObjectBody as w, ReplaceTargetProjectsBody as x, ReplaceMetaObjectInput as y };
+//# sourceMappingURL=types-DWUd__fe.d.ts.map

package/dist/types-DdeZK3BO.d.ts

@@ -0,0 +1,386 @@
+import { c as OpenapiReturnType, n as ArrayElement, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.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-DdeZK3BO.d.ts.map

package/dist/types-Dirp9mni.d.ts

@@ -0,0 +1,66 @@
+import { a as ProjectId } from "./types-X-gQF8F8.js";
+import "./types-DMMMQuNt.js";
+//#region src/clients/encryption/types.d.ts
+type BranchType = 'default' | 'dev';
+type EncryptParamsByScope = {
+  /** `KBC::ComponentSecure::` — any config of the component, in any project. */
+  ComponentSecure: {
+    componentId: string;
+  };
+  /** `KBC::ProjectSecure::` — the component within one project. */
+  ProjectSecure: {
+    componentId: string;
+    projectId: ProjectId;
+  };
+  /** `KBC::ConfigSecure::` — one specific configuration. */
+  ConfigSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    configId: string;
+  };
+  /** `KBC::ProjectWideSecure::` — anywhere in one project (component-agnostic). */
+  ProjectWideSecure: {
+    projectId: ProjectId;
+  };
+  /** `KBC::BranchTypeSecure::` — the component within a project, scoped to a branch type. */
+  BranchTypeSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    branchType: BranchType;
+  };
+  /** `KBC::BranchTypeConfigSecure::` — one config, scoped to a branch type. */
+  BranchTypeConfigSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    configId: string;
+    branchType: BranchType;
+  };
+  /** `KBC::ProjectWideBranchTypeSecure::` — project-wide, scoped to a branch type. */
+  ProjectWideBranchTypeSecure: {
+    projectId: ProjectId;
+    branchType: BranchType;
+  };
+};
+type EncryptionScope = keyof EncryptParamsByScope;
+/** The required query params for a given encryption scope. */
+type EncryptParams<Scope extends EncryptionScope> = EncryptParamsByScope[Scope];
+/**
+ * Discriminated-union input for `encryptScopedSecrets`: a `scope` plus exactly the
+ * params that scope requires, plus the `data` to encrypt. The discriminant makes
+ * mismatched params (e.g. a `componentId` on a `ProjectWideSecure` call) a compile error.
+ */
+type ScopedSecrets<T extends Record<string, unknown>> = { [Scope in EncryptionScope]: {
+  scope: Scope;
+} & EncryptParams<Scope> & {
+  data: T;
+}; }[EncryptionScope];
+type EncryptQuery = {
+  projectId?: ProjectId | null;
+  branchType?: BranchType | null;
+  componentId?: string | null;
+  configId?: string | null;
+};
+type EncryptBody = string | Record<string, unknown>;
+//#endregion
+export { EncryptQuery as a, EncryptParamsByScope as i, EncryptBody as n, EncryptionScope as o, EncryptParams as r, ScopedSecrets as s, BranchType as t };
+//# sourceMappingURL=types-Dirp9mni.d.ts.map

package/dist/{types-CfzHhZVG.d.ts → types-DkoyCUqv.d.ts}

@@ -1,10 +1,9 @@
-import { c as OpenapiQueryType, O as OpenapiBodyType, b as OpenapiReturnType, A as ArrayElement } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, n as ArrayElement, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.js";
+//#region src/clients/stream/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -7490,7 +7489,8 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/stream/types.d.ts
 type schemas = components['schemas'];
 type Source = OpenapiReturnType<paths['/v1/branches/{branchId}/sources/{sourceId}']['get']>;
 type SourcesList = OpenapiReturnType<paths['/v1/branches/{branchId}/sources']['get']>;
@@ -7519,5 +7519,6 @@ type PaginationQuery = OpenapiQueryType<paths['/v1/branches/{branchId}/sources']
 type DeleteSourceQuery = OpenapiQueryType<paths['/v1/branches/{branchId}/sources/{sourceId}']['delete']>;
 type SinkStatisticsFilesQuery = OpenapiQueryType<paths['/v1/branches/{branchId}/sources/{sourceId}/sinks/{sinkId}/statistics/files']['get']>;
 type TestSourceQuery = OpenapiQueryType<paths['/v1/branches/{branchId}/sources/{sourceId}/test']['post']>;
-
-export type { CreateSourceRequestBody as C, DeleteSourceQuery as D, OTLPSignal as O, PaginationQuery as P, SinkStatisticsFilesQuery as S, TestSourceQuery as T, UpdateSourceRequestBody as U, UpdateSourceSettingsRequestBody as a, CreateSinkRequestBody as b, components as c, UpdateSinkRequestBody as d, UpdateSinkSettingsRequestBody as e, OTLPSource as f, SettingResult as g, SettingsResult as h, Sink as i, SinkFile as j, SinkStatisticsFilesResult as k, SinkStatisticsTotalResult as l, SinksList as m, Source as n, SourcesList as o, TableColumn as p, TableSinkCreate as q, Task as r, TestResult as s };
+//#endregion
+export { UpdateSinkSettingsRequestBody as C, components as E, UpdateSinkRequestBody as S, UpdateSourceSettingsRequestBody as T, TableColumn as _, OTLPSource as a, TestResult as b, SettingsResult as c, SinkStatisticsFilesQuery as d, SinkStatisticsFilesResult as f, SourcesList as g, Source as h, OTLPSignal as i, Sink as l, SinksList as m, CreateSourceRequestBody as n, PaginationQuery as o, SinkStatisticsTotalResult as p, DeleteSourceQuery as r, SettingResult as s, CreateSinkRequestBody as t, SinkFile as u, TableSinkCreate as v, UpdateSourceRequestBody as w, TestSourceQuery as x, Task as y };
+//# sourceMappingURL=types-DkoyCUqv.d.ts.map