@keboola/api-client 4.0.0 → 6.0.0

package/dist/storageSdk-TDISOoqX.d.ts

@@ -0,0 +1,746 @@
+import { CreateTableAsyncBody, TableCreateJob, CreateTableDefinitionBody, Table, TableImportAsyncBody, TableImportJob, TableExportAsyncBody, TableExportJob, BucketListing, CreateBucketListingInput, UpdateBucketListingInput, ShareBucketToProjectsBody, ShareBucketToUsersBody, RegisterBucketBody, RefreshExternalBucketQuery, CreateSnapshotBody, AddTableColumnBody, DeleteTableColumnQuery, CreateTablePrimaryKeyBody } from './storage/types.js';
+import { c as createStorageClient } from './index-G9ZyDi7K.js';
+
+type Options = {
+    interval?: number;
+    maxAttempts?: number;
+    abortSignal?: AbortSignal;
+};
+type StorageSdkOptions = {
+    storageClient: ReturnType<typeof createStorageClient>;
+};
+declare const createStorageSdk: ({ storageClient }: StorageSdkOptions) => {
+    createTable: (bucketId: string, body: CreateTableAsyncBody, options?: Options) => Promise<TableCreateJob>;
+    createTableDefinition: (bucketId: string, body: CreateTableDefinitionBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tableDefinitionCreate";
+        operationParams: {
+            queue: string;
+        } & {
+            timestampType: string;
+            primaryKeysNames: string[];
+            name: string;
+            backendConfiguration: unknown[];
+            columns: unknown[];
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: Table;
+    })>;
+    importFromFile: (tableId: string, body: TableImportAsyncBody, options?: Options) => Promise<TableImportJob>;
+    exportToFile: (tableId: string, body?: TableExportAsyncBody, options?: Options) => Promise<TableExportJob>;
+    getBucketListing: (bucketId: string, signal?: AbortSignal) => Promise<BucketListing | null>;
+    listBucketListings: (signal?: AbortSignal) => Promise<BucketListing[]>;
+    createBucketListing: (bucketId: string, input: CreateBucketListingInput, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketListingCreate";
+        operationParams: {
+            queue: string;
+        } & {
+            bucketId: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    updateBucketListing: (bucketId: string, input: UpdateBucketListingInput, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketListingUpdate";
+        operationParams: {
+            queue: string;
+        } & {
+            bucketId: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    deleteBucketListing: (bucketId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketListingDelete";
+        operationParams: {
+            queue: string;
+        } & {
+            bucketId: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    shareBucketToOrganization: (bucketId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketShareToOrganization";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    shareBucketToOrganizationProject: (bucketId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketShareToOrganizationProject";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    shareBucketToProjects: (bucketId: string, body: ShareBucketToProjectsBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketShareToProjects";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    shareBucketToUsers: (bucketId: string, body: ShareBucketToUsersBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketShareToAdmins";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    unshareBucket: (bucketId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketRemoveShare";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    forceUnlinkBucket: (bucketId: string, linkedProjectId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketForceUnlink";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    registerBucket: (body: RegisterBucketBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketRegister";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    refreshExternalBucket: (bucketId: string, query?: RefreshExternalBucketQuery, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "bucketRefresh";
+        operationParams: {
+            queue: string;
+        } & Record<string, unknown>;
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    createSnapshot: (tableId: string, body?: CreateSnapshotBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tableSnapshotCreate";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    pullTable: (tableId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "devBranchTablePull";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    addTableColumn: (tableId: string, body: AddTableColumnBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tableColumnAdd";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    deleteTableColumn: (tableId: string, columnName: string, query?: DeleteTableColumnQuery, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tableColumnDelete";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    createTablePrimaryKey: (tableId: string, body: CreateTablePrimaryKeyBody, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tablePrimaryKeyAdd";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+    removeTablePrimaryKey: (tableId: string, options?: Options) => Promise<{
+        id: number;
+        tableId: string | null;
+        runId: string;
+        url: string;
+        createdTime: string;
+        creatorToken: {
+            id: string;
+            description: string;
+        };
+        endTime: string | null;
+        startTime: string | null;
+        operationName: "tablePrimaryKeyDelete";
+        operationParams: {
+            queue: string;
+        } & {
+            id: string;
+        };
+        metrics: {
+            inCompressed: boolean;
+            inBytes: number;
+            inBytesUncompressed: number;
+            outCompressed: boolean;
+            outBytes: number;
+            outBytesUncompressed: number;
+        };
+    } & ({
+        status: Exclude<"error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled", "success" | "error">;
+        results: null;
+    } | {
+        status: "error";
+        results: null;
+        error: {
+            code: string;
+            message: string;
+            exceptionId?: string;
+        };
+    } | {
+        status: "success";
+        results: null;
+    })>;
+};
+
+export { createStorageSdk as c };