@keboola/api-client 21.0.0 → 24.0.0

package/dist/types-BfuVN8Pk.d.cts

@@ -0,0 +1,468 @@
+import { e as OpenapiFormDataType } from './types-gcShAmmi.cjs';
+
+type UploadProgress = {
+    loaded: number;
+    total: number;
+    percent: number;
+};
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+type paths = {
+  '/': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Service information
+     * @description Returns the service name, deployed version and the URL of this API documentation.
+     */
+    get: operations['index'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Health check
+     * @description Liveness probe used by the platform.
+     */
+    get: operations['healthCheck'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/write-table': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Import data to a table
+     * @description Import CSV data to an existing table in Storage. Use the Storage API to create [buckets](https://keboola.docs.apiary.io/#reference/buckets/create-or-list-buckets/create-bucket) and [tables](https://keboola.docs.apiary.io/#reference/tables/create-table-asynchronously/create-new-table-from-csv-file-asynchronously).
+     */
+    post: operations['writeTable'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/upload-file': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Upload a file to Storage Files
+     * @description Upload a file to Storage Files
+     */
+    post: operations['uploadFile'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    ServiceInfo: {
+      /** @example sapi-importer */
+      appName: string;
+      /** @example production-e77e4b549135286eff11f0dab955dc7a57bcb9ae */
+      appVersion: string;
+      /** @example https://import.keboola.com/docs/swagger.yaml */
+      apiDocs: string;
+    };
+    HealthCheck: {
+      /** @enum {string} */
+      status: 'ok';
+    };
+    FileResource: {
+      /** @example 537806841 */
+      id: number;
+      /**
+       * Format: date-time
+       * @example 2019-09-18T17:43:13+0200
+       */
+      created: string;
+      /** @example false */
+      isPublic: boolean;
+      /** @example false */
+      isSliced: boolean;
+      /** @example true */
+      isEncrypted: boolean;
+      /** @example my-file.zip */
+      name: string;
+      /** @example csv */
+      fileType: string;
+      /** @example https://kbc-sapi-files.s3.amazonaws.com/exp-180/123/files/2019/09/18/537806841.my-file.zip?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ZZZ&X-Amz-Date=20190918T154315Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=ZZZ */
+      url: string;
+      /** @example aws */
+      provider: string;
+      /** @example us-east-1 */
+      region: string;
+      /** @example 1234 */
+      sizeBytes: number;
+      /**
+       * @example [
+       *       "my-tag1",
+       *       "my-tag2"
+       *     ]
+       */
+      tags: string[];
+      /**
+       * @description Number of days after which the file expires; null for permanent files
+       * @example 180
+       */
+      maxAgeDays: number | null;
+      /**
+       * @description Run id of the request (`X-KBC-RunId` header), null when not set
+       * @example null
+       */
+      runId: string | null;
+      /** @example [] */
+      runIds: string[];
+      creatorToken: {
+        /** @example 1234 */
+        id: number;
+        /** @example My API token */
+        description: string;
+      };
+    };
+    TableResource: {
+      /** @example null */
+      transaction: string | null;
+      /** @example [] */
+      warnings: string[];
+      /**
+       * @description Columns added to the table by this import
+       * @example []
+       */
+      newColumns: string[];
+      /**
+       * @example [
+       *       "col1",
+       *       "col2"
+       *     ]
+       */
+      importedColumns: string[];
+      /**
+       * @description Number of rows imported by this request
+       * @example 1234
+       */
+      importedRowsCount: number;
+      /**
+       * @description Number of rows in the table after the import
+       * @example 1234
+       */
+      totalRowsCount: number;
+      /** @example 12345678 */
+      totalDataSizeBytes: number;
+    };
+    Error: {
+      /** @example Invalid access token */
+      error: string;
+      /** @enum {string} */
+      status: 'error';
+      /** @example 401 */
+      code: number;
+      /** @example exception-93ea8793d558859581b7e93529980d11 */
+      exceptionId?: string;
+      /** @description Additional error context; present for user/HTTP errors ({} when empty). */
+      context?: Record<string, never>;
+    };
+  };
+  responses: never;
+  parameters: {
+    /**
+     * @description Storage run id propagated to the Storage API events created by the import, so the import can be tracked as part of a parent job.
+     * @example 1234567890.1234567891
+     */
+    RunId: string;
+  };
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+type operations = {
+  index: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Service information */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ServiceInfo'];
+        };
+      };
+    };
+  };
+  healthCheck: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Service is healthy */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['HealthCheck'];
+        };
+      };
+    };
+  };
+  writeTable: {
+    parameters: {
+      query?: never;
+      header?: {
+        /**
+         * @description Storage run id propagated to the Storage API events created by the import, so the import can be tracked as part of a parent job.
+         * @example 1234567890.1234567891
+         */
+        'X-KBC-RunId'?: components['parameters']['RunId'];
+      };
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'multipart/form-data': {
+          /**
+           * Format: binary
+           * @description CSV data
+           */
+          data: string;
+          /**
+           * @description Id of an existing table in Storage
+           * @example in.c-main.my-table
+           */
+          tableId: string;
+          /**
+           * @description Id of the development branch in Storage. If not set, data will be imported into default branch.
+           * @example 1234
+           */
+          branchId?: string;
+          /**
+           * @description Turns on [incremenal loading](https://help.keboola.com/storage/tables/#incremental-loading)
+           * @example false
+           */
+          incremental?: boolean;
+          /**
+           * @description Columns of the table. If not specified, the first row of the CSV is assumed to be header. If specified, the CSV is assumed to be headless. Due to [bug](https://github.com/swagger-api/swagger-ui/issues/5106) in Swagger, this is incorrectly handled in **Try it out**. Columns should be encoded as `columns[]=col1&columns[]=col2`. Due to Swagger [bug](https://github.com/swagger-api/swagger-ui/issues/5303) the empty column field is added to the request, while it must not be present at all
+           * @example [
+           *       "col1",
+           *       "col2"
+           *     ]
+           */
+          'columns[]'?: string[];
+          /**
+           * @description CSV data delimiter
+           * @default ,
+           * @example |
+           */
+          delimiter?: string;
+          /**
+           * @description CSV data enclosure
+           * @default "
+           * @example "
+           */
+          enclosure?: string;
+          /**
+           * @description CSV data enclosure escape character, if not present a double enclosure is assumed for escaping.
+           * @default null
+           * @example \
+           */
+          escapedBy?: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Table Resource */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['TableResource'];
+        };
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+  uploadFile: {
+    parameters: {
+      query?: never;
+      header?: {
+        /**
+         * @description Storage run id propagated to the Storage API events created by the import, so the import can be tracked as part of a parent job.
+         * @example 1234567890.1234567891
+         */
+        'X-KBC-RunId'?: components['parameters']['RunId'];
+      };
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'multipart/form-data': {
+          /**
+           * Format: binary
+           * @description Uploaded file
+           */
+          data: string;
+          /**
+           * @description Id of the development branch in Storage. If not set, data will be imported into default branch.
+           * @example 1234
+           */
+          branchId?: string;
+          /**
+           * @description Due to [bug](https://github.com/swagger-api/swagger-ui/issues/5106) in Swagger, this is incorrectly handled in **Try it out**. Tags should be encoded as `tags[]=tag1&tags[]=tag2`
+           * @example [
+           *       "tag1",
+           *       "tag2"
+           *     ]
+           */
+          'tags[]'?: string[];
+          /**
+           * @description When true, the file will be accessible on the returned URL for anyone. Supported only on the AWS S3 file storage backend; ignored on other backends, where the response always reports `isPublic: false`
+           * @example false
+           */
+          isPublic?: boolean;
+          /**
+           * @description When false, the file will expire after the number of days reported in `maxAgeDays`
+           * @example false
+           */
+          isPermanent?: boolean;
+          /**
+           * @description When true, members of the project will be notified of the file upload
+           * @example false
+           */
+          notify?: boolean;
+        };
+        'application/x-www-form-urlencoded': {
+          /**
+           * @description File data
+           * @example Some data
+           */
+          data: string;
+          /**
+           * @description File name
+           * @example file-name.txt
+           */
+          name: string;
+          /**
+           * @description Id of the development branch in Storage. If not set, data will be imported into default branch.
+           * @example 1234
+           */
+          branchId?: string;
+          /**
+           * @description Due to [bug](https://github.com/swagger-api/swagger-ui/issues/5106) in Swagger, this is incorrectly handled in **Try it out**. Tags should be encoded as `tags[]=tag1&tags[]=tag2`
+           * @example [
+           *       "tag1",
+           *       "tag2"
+           *     ]
+           */
+          'tags[]'?: string[];
+          /**
+           * @description When true, the file will be accessible on the returned URL for anyone. Supported only on the AWS S3 file storage backend; ignored on other backends, where the response always reports `isPublic: false`
+           * @example false
+           */
+          isPublic?: boolean;
+          /**
+           * @description When false, the file will expire after the number of days reported in `maxAgeDays`
+           * @example false
+           */
+          isPermanent?: boolean;
+          /**
+           * @description When true, members of the project will be notified of the file upload
+           * @example false
+           */
+          notify?: boolean;
+        };
+      };
+    };
+    responses: {
+      /** @description File Resource */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['FileResource'];
+        };
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+};
+
+type UploadFileFormData = OpenapiFormDataType<paths['/upload-file']['post']>;
+type UploadFileInput = Omit<UploadFileFormData, 'data'> & {
+    file: File;
+};
+type WriteTableFormData = OpenapiFormDataType<paths['/write-table']['post']>;
+type WriteTableInput = Omit<WriteTableFormData, 'data'> & {
+    file: File;
+};
+
+export type { UploadFileInput as U, WriteTableInput as W, UploadProgress as a };