@keboola/api-client 45.0.0 → 47.0.0

package/dist/types-gcAb6olM.d.ts

@@ -1,749 +0,0 @@
-import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType } from "./index-BgR5zcjJ.js";
-//#region src/clients/oauth/__generated__/schema.d.ts
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-type paths = {
-  '/authorize/{componentId}': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    get?: never;
-    put?: never;
-    /**
-     * Authorization init
-     * @description Call the endpoint to initiate the authorization process. It starts the authorization sessions and redirects
-     *     client to the OAuth provider.
-     */
-    post: operations['authorizeInit'];
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/authorize/{componentId}/callback': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Authorization callback
-     * @description The endpoint is called by OAuth provider after the authorization process is finished. It uses parameters passed
-     *     in query to retrieve the access token and stores the authorization. Finally it redirects the client back to the
-     *     return URL.
-     */
-    get: operations['authorizeCallback'];
-    put?: never;
-    post?: never;
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/credentials': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Credentials list
-     * @description Returns list of component credentials.
-     */
-    get: operations['credentialsList'];
-    put?: never;
-    post?: never;
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/credentials/{componentId}': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Component credentials list
-     * @description Returns list of component credentials.
-     */
-    get: operations['componentCredentialsList'];
-    put?: never;
-    /**
-     * Create credentials
-     * @description Call the endpoint to create new credentials for given component.
-     */
-    post: operations['componentCredentialsCreate'];
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/credentials/{componentId}/{name}': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Credentials detail
-     * @description Returns the credentials detail.
-     */
-    get: operations['credentialsDetail'];
-    put?: never;
-    post?: never;
-    /**
-     * Delete credentials
-     * @description Delete existing credentials.
-     */
-    delete: operations['credentialsDelete'];
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/manage': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * List consumers
-     * @description Returns list of all registered consumers.
-     */
-    get: operations['consumersList'];
-    put?: never;
-    /**
-     * Create consumer
-     * @description Register a new OAuth consumer (component).
-     */
-    post: operations['consumerCreate'];
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-  '/manage/{componentId}': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Consumer detail
-     * @description Returns the consumer detail for given component.
-     */
-    get: operations['consumerDetail'];
-    put?: never;
-    post?: never;
-    /**
-     * Delete consumer
-     * @description Delete an existing consumer.
-     */
-    delete: operations['consumerDelete'];
-    options?: never;
-    head?: never;
-    /**
-     * Update consumer
-     * @description Update an existing consumer. All fields are optional.
-     */
-    patch: operations['consumerUpdate'];
-    trace?: never;
-  };
-  '/health-check': {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    /**
-     * Health-check endpoint
-     * @description Checks the service is up & running.
-     */
-    get: operations['healthCheck'];
-    put?: never;
-    post?: never;
-    delete?: never;
-    options?: never;
-    head?: never;
-    patch?: never;
-    trace?: never;
-  };
-};
-type components = {
-  schemas: {
-    Error: {
-      error: string;
-      code: number;
-      exceptionId: string;
-      /** @enum {unknown} */
-      status: 'error';
-      context?: Record<string, never>;
-    };
-    /** @description Returned when a request payload fails validation. The top-level `error` stays a short human-readable string; `context` lists every failing field exactly once. */
-    ValidationError: {
-      /** @example Request contents is not valid */
-      error: string;
-      /** @example 422 */
-      code: number;
-      exceptionId: string;
-      /** @enum {unknown} */
-      status: 'error';
-      /** @description One entry per payload field that failed mapping or validation, keyed by index ("0", "1", …). Each failing field appears exactly once. */
-      context: {
-        [key: string]: {
-          /**
-           * @description Name of the payload field that failed, as sent by the client — encrypted fields are reported under their `#`-prefixed key (e.g. `#data`).
-           * @example authorizedFor
-           */
-          path: string;
-          /** @example Value '' is not a valid non-empty string. */
-          message: string;
-        };
-      };
-    };
-    Consumer: {
-      componentId: string;
-      friendlyName: string;
-      oauthVersion: string;
-      authUrl: string;
-      tokenUrl: string;
-      requestTokenUrl: string | null;
-      appKey: string;
-      appSecret: string;
-      appSecretDocker: string;
-      allowedEndpointHosts: string[];
-    };
-    Credentials: {
-      id: string;
-      branchId: string | null;
-      authorizedFor: string;
-      creator: {
-        id: string;
-        description: string | null;
-      };
-      /** Format: date-time */
-      created: string;
-      oauthVersion: string;
-      appKey: string;
-      '#appSecret': string;
-      '#data': string;
-    };
-  };
-  responses: {
-    /** @description Bad request */
-    '400_BadRequest': {
-      headers: {
-        [name: string]: unknown;
-      };
-      content: {
-        'application/json': components['schemas']['Error'];
-      };
-    };
-    /** @description Validation failed - see `context` for the list of failing fields */
-    '422_UnprocessableEntity': {
-      headers: {
-        [name: string]: unknown;
-      };
-      content: {
-        'application/json': components['schemas']['ValidationError'];
-      };
-    };
-    /** @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'];
-      };
-    };
-    /** @description Forbidden */
-    '404_NotFound': {
-      headers: {
-        [name: string]: unknown;
-      };
-      content: {
-        'application/json': components['schemas']['Error'];
-      };
-    };
-  };
-  parameters: never;
-  requestBodies: never;
-  headers: never;
-  pathItems: never;
-};
-interface operations {
-  authorizeInit: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody: {
-      content: {
-        'application/x-www-form-urlencoded': {
-          /** @description Authorization ID */
-          id: string;
-          /** @description Authorization description */
-          authorizedFor: string;
-          /** @description Storage token of the requester */
-          token: string;
-          /** @description URL where to redirect the client after authorization */
-          returnUrl: string;
-          /** @description Custom application key */
-          appKey?: string | null;
-          /** @description Custom application secret */
-          appSecret?: string | null;
-          /** @description Custom authorization URL */
-          authUrl?: string | null;
-          /** @description Custom token URL */
-          tokenUrl?: string | null;
-          /**
-           * @description ID of the branch where the credentials should live. If not specified, the credentials will be
-           *     considered as project-wide.
-           *
-           *     The property is not required for now, to keep compatibility with existing clients. But it will be
-           *     required in the future (but still nullable), to ensure the client has considered if they want to
-           *     create project-wide or branch-specific credentials.
-           */
-          branchId?: string | null;
-        };
-      };
-    };
-    responses: {
-      /** @description Redirect to OAuth provider */
-      302: {
-        headers: {
-          /** @description URL to follow to authorize the component */
-          Location?: string;
-          [name: string]: unknown;
-        };
-        content?: never;
-      };
-      400: components['responses']['400_BadRequest'];
-      422: components['responses']['422_UnprocessableEntity'];
-    };
-  };
-  authorizeCallback: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description Redirect client back to Keboola */
-      302: {
-        headers: {
-          Location?: string;
-          [name: string]: unknown;
-        };
-        content?: never;
-      };
-      400: components['responses']['400_BadRequest'];
-    };
-  };
-  credentialsList: {
-    parameters: {
-      query?: {
-        /** @description Component ID */
-        componentId?: string;
-        /**
-         * @description Branch ID
-         *
-         *     Use value `null` to get credentials without branchId.
-         */
-        branchId?: string;
-      };
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description OK */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Credentials'][];
-        };
-      };
-      400: components['responses']['400_BadRequest'];
-      401: components['responses']['401_Unauthorized'];
-      403: components['responses']['403_Forbidden'];
-    };
-  };
-  componentCredentialsList: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description OK */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Credentials'][];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-      403: components['responses']['403_Forbidden'];
-    };
-  };
-  componentCredentialsCreate: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody: {
-      content: {
-        'application/x-www-form-urlencoded': {
-          /** @description Credentials ID */
-          id: string;
-          /** @description Authorization description */
-          authorizedFor: string;
-          /** @description Encrypted data, e.g. OAuth token */
-          '#data': string;
-          /**
-           * @description ID of the branch where the credentials should live. If not specified, the credentials will be
-           *     considered as project-wide.
-           *
-           *     The property is not required for now, to keep compatibility with existing clients. But it will be
-           *     required in the future (but still nullable), to ensure the client has considered if they want to
-           *     create project-wide or branch-specific credentials.
-           */
-          branchId?: string | null;
-        };
-      };
-    };
-    responses: {
-      /** @description Credentials created */
-      201: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Credentials'];
-        };
-      };
-      400: components['responses']['400_BadRequest'];
-      404: components['responses']['404_NotFound'];
-      422: components['responses']['422_UnprocessableEntity'];
-    };
-  };
-  credentialsDetail: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-        /** @description Credentials name (authorization ID) */
-        name: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description OK */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Credentials'];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-      403: components['responses']['403_Forbidden'];
-    };
-  };
-  credentialsDelete: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-        /** @description Credentials name (authorization ID) */
-        name: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description Credentials deleted */
-      204: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content?: never;
-      };
-      401: components['responses']['401_Unauthorized'];
-      404: components['responses']['404_NotFound'];
-    };
-  };
-  consumersList: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description OK */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Consumer'][];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-    };
-  };
-  consumerCreate: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path?: never;
-      cookie?: never;
-    };
-    requestBody: {
-      content: {
-        'application/json': {
-          componentId: string;
-          friendlyName: string;
-          oauthVersion: string;
-          authUrl: string;
-          tokenUrl: string;
-          requestTokenUrl?: string | null;
-          appKey: string;
-          appSecret: string;
-          allowedEndpointHosts?: string[];
-        };
-      };
-    };
-    responses: {
-      /** @description Consumer created */
-      201: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Consumer'];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-      422: components['responses']['422_UnprocessableEntity'];
-    };
-  };
-  consumerDetail: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description OK */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Consumer'];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-      404: components['responses']['404_NotFound'];
-    };
-  };
-  consumerDelete: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody?: never;
-    responses: {
-      /** @description Consumer deleted */
-      204: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content?: never;
-      };
-      401: components['responses']['401_Unauthorized'];
-      404: components['responses']['404_NotFound'];
-    };
-  };
-  consumerUpdate: {
-    parameters: {
-      query?: never;
-      header?: never;
-      path: {
-        /** @description Component ID */
-        componentId: string;
-      };
-      cookie?: never;
-    };
-    requestBody: {
-      content: {
-        'application/json': {
-          friendlyName?: string | null;
-          authUrl?: string | null;
-          tokenUrl?: string | null;
-          requestTokenUrl?: string | null;
-          appKey?: string | null;
-          appSecret?: string | null;
-          allowedEndpointHosts?: string[] | null;
-        };
-      };
-    };
-    responses: {
-      /** @description Consumer updated */
-      200: {
-        headers: {
-          [name: string]: unknown;
-        };
-        content: {
-          'application/json': components['schemas']['Consumer'];
-        };
-      };
-      401: components['responses']['401_Unauthorized'];
-      404: components['responses']['404_NotFound'];
-      422: components['responses']['422_UnprocessableEntity'];
-    };
-  };
-  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;
-          };
-        };
-      };
-    };
-  };
-}
-//#endregion
-//#region src/clients/oauth/utils.d.ts
-/**
- * Which credentials to list:
- *
- * - `all` — the whole project: branch-scoped and branchless alike.
- * - `branchless` — only what is tied to no branch at all, not even the default one.
- * - `branched` — only the branch whose id it carries.
- *
- * Discriminated on `scope`, not on `branchId` being present: a `string | 'all' | 'branchless'` union
- * collapses to `string`, so a mistyped scope would silently become a branch-id filter.
- */
-type GetCredentialsInput = {
-  scope: 'all';
-  componentId?: string;
-} | {
-  scope: 'branchless';
-  componentId?: string;
-} | {
-  scope: 'branched';
-  branchId: string;
-  componentId?: string;
-};
-//#endregion
-//#region src/clients/oauth/types.d.ts
-type Credential = OpenapiReturnType<paths['/credentials/{componentId}/{name}']['get']>;
-type CreateCredentialBody = OpenapiBodyType<paths['/credentials/{componentId}']['post']>;
-type CredentialPath = OpenapiPathType<paths['/credentials/{componentId}/{name}']['get']>;
-type ComponentPath = OpenapiPathType<paths['/credentials/{componentId}']['post']>;
-/** Addresses one credential. The spec calls the second segment `name`; every caller calls it `id`. */
-type CredentialInput = ComponentPath & {
-  id: CredentialPath['name'];
-};
-/**
- * `data` is the pre-`#data` create shape, accepted only by OAuth services predating this spec, so it
- * has no schema to generate from. The client takes the plain object either way and picks the wire
- * shape the stack accepts.
- */
-type CreateCredentialInput = ComponentPath & Omit<CreateCredentialBody, '#data'> & {
-  data: Record<string, unknown>;
-};
-//#endregion
-export { CredentialInput as a, Credential as i, CreateCredentialBody as n, CredentialPath as o, CreateCredentialInput as r, GetCredentialsInput as s, ComponentPath as t };
-//# sourceMappingURL=types-gcAb6olM.d.ts.map