@keboola/api-client 4.0.0 → 6.0.0

package/dist/types-CS8MYc2k.d.ts

@@ -0,0 +1,404 @@
+import { c as OpenapiQueryType, d as OpenapiPathType, b as OpenapiBodyType, a as OpenapiReturnType } from './types-jKnx7Tm_.js';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+type paths = {
+  '/events/{eventName}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Notify the service about an event
+     * @description Notify service about an event. The event is stored in the service and processes asynchronously later.
+     *
+     *     Requires a Manage API application token (or ServiceAccount JWT) carrying the
+     *     `notifications:push-event` scope.
+     */
+    post: operations['postEvent'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/project-subscriptions': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List existing project-level subscriptions
+     * @description List all existing subscriptions for the project (project is resolved from the request authorization token).
+     */
+    get: operations['listSubscriptions'];
+    put?: never;
+    /**
+     * Create a new project-level notification subscription
+     * @description Subscribe a recipient for notifictions on given event type.
+     *
+     *     By default, a notification is sent to all occurences of the event. You can set `filters` which are then matched
+     *     against event data to subscribe to more specific situations.
+     */
+    post: operations['createSubscription'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/project-subscriptions/{subscriptionId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get subscription details
+     * @description Get subscription details.
+     */
+    get: operations['getSubscription'];
+    put?: never;
+    post?: never;
+    /**
+     * Delete existing subscription
+     * @description Delete existing subscription.
+     */
+    delete: operations['deleteSubscription'];
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/notifications': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Send a direct notification
+     * @description Send a direct notification to a specific recipient email without requiring a subscription.
+     *
+     *     Requires a Manage API application token (or ServiceAccount JWT) carrying the
+     *     `notifications:send-notification` scope.
+     */
+    post: operations['postNotification'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    /** @example 1234 */
+    NumericString: string;
+    Notification: {
+      id: components['schemas']['NumericString'];
+    };
+    /** @example job-failed */
+    EventName: string;
+    NewProjectSubscription: {
+      event: components['schemas']['EventName'];
+      /** @example 2023-01-07T14:00:00+01:00 */
+      expiresAt?: string;
+      /** @example 1234 */
+      projectId: string;
+      filters?: {
+        field?: string;
+        value?: string | number | boolean;
+      }[];
+      recipient:
+        | components['schemas']['RecipientChannel_Email']
+        | components['schemas']['RecipientChannel_Webhook'];
+    };
+    ProjectSubscription: {
+      id?: components['schemas']['NumericString'];
+    } & components['schemas']['NewProjectSubscription'];
+    RecipientChannel_Email: {
+      /**
+       * @description discriminator enum property added by openapi-typescript
+       * @enum {string}
+       */
+      channel: 'RecipientChannel_Email';
+      /** Format: email */
+      address: string;
+    };
+    RecipientChannel_Webhook: {
+      /**
+       * @description discriminator enum property added by openapi-typescript
+       * @enum {string}
+       */
+      channel: 'RecipientChannel_Webhook';
+      /** Format: uri */
+      url: string;
+    };
+    Error: {
+      /** @example The value foobar is invalid */
+      error: string;
+      /** @example 400 */
+      code: number;
+      /** @enum {string} */
+      status: 'error';
+      /** @example job-runner-1234567890 */
+      exceptionId?: string;
+    };
+  };
+  responses: {
+    /** @description Invalid input data */
+    BadRequest: {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+    /** @description Unauthorized request */
+    Unauthorized: {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+type operations = {
+  postEvent: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Name of the event */
+        eventName: components['schemas']['EventName'];
+      };
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': Record<string, never>;
+      };
+    };
+    responses: {
+      /** @description Event accepted for processing */
+      202: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      400: components['responses']['BadRequest'];
+      401: components['responses']['Unauthorized'];
+    };
+  };
+  listSubscriptions: {
+    parameters: {
+      query?: {
+        /** @description Name of the event */
+        event?: components['schemas']['EventName'];
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Subscriptions list. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ProjectSubscription'][];
+        };
+      };
+      400: components['responses']['BadRequest'];
+      401: components['responses']['Unauthorized'];
+    };
+  };
+  createSubscription: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': components['schemas']['NewProjectSubscription'];
+      };
+    };
+    responses: {
+      /** @description Subscription created */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ProjectSubscription'];
+        };
+      };
+      400: components['responses']['BadRequest'];
+      401: components['responses']['Unauthorized'];
+    };
+  };
+  getSubscription: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description ID of the subscription */
+        subscriptionId: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Subscription deleted. */
+      204: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['ProjectSubscription'];
+        };
+      };
+      401: components['responses']['Unauthorized'];
+      /** @description Subscription does not exist for the current project. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  deleteSubscription: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description ID of the subscription */
+        subscriptionId: number;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Subscription deleted. */
+      204: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      401: components['responses']['Unauthorized'];
+      /** @description Subscription does not exist for the current project. */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  postNotification: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: {
+      content: {
+        'application/json': {
+          /**
+           * @description Type of notification to send
+           * @enum {string}
+           */
+          type: 'direct-project-email' | 'direct-project-webhook';
+          recipient:
+            | components['schemas']['RecipientChannel_Email']
+            | components['schemas']['RecipientChannel_Webhook'];
+          /** @description Event data according to notification type schema */
+          data: {
+            project: {
+              /** @description Project ID */
+              id: string;
+              /** @description Project name */
+              name: string;
+            };
+            /** @description Optional flow information */
+            flow?: {
+              /** @description Flow ID */
+              id: string;
+              /** @description Flow name */
+              name: string;
+              /**
+               * Format: url
+               * @description Flow URL
+               */
+              url: string;
+            };
+            /** @description Optional job information */
+            job?: {
+              /** @description Job ID */
+              id: string;
+              /**
+               * Format: url
+               * @description Job URL
+               */
+              url: string;
+            };
+            /** @description Notification title */
+            title: string;
+            /** @description Notification message */
+            message: string;
+          };
+        };
+      };
+    };
+    responses: {
+      /** @description Notification accepted for processing */
+      202: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Notification'];
+        };
+      };
+      400: components['responses']['BadRequest'];
+      401: components['responses']['Unauthorized'];
+    };
+  };
+};
+
+type ListSubscriptionsQuery = OpenapiQueryType<paths['/project-subscriptions']['get']>;
+type CreateSubscriptionBody = OpenapiBodyType<paths['/project-subscriptions']['post']>;
+type ProjectSubscription = OpenapiReturnType<paths['/project-subscriptions/{subscriptionId}']['get']>;
+type GetSubscriptionPath = OpenapiPathType<paths['/project-subscriptions/{subscriptionId}']['get']>;
+type DeleteSubscriptionPath = OpenapiPathType<paths['/project-subscriptions/{subscriptionId}']['delete']>;
+
+export type { CreateSubscriptionBody as C, DeleteSubscriptionPath as D, GetSubscriptionPath as G, ListSubscriptionsQuery as L, ProjectSubscription as P, components as c };

package/dist/{types-DBVQGCI1.d.cts → types-CWebeQXy.d.cts}

@@ -1,4 +1,4 @@
-import { b as OpenapiBodyType, d as OpenapiPathType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-C7mpAfq-.cjs';
+import { b as OpenapiBodyType, d as OpenapiPathType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-jKnx7Tm_.cjs';
 
 /**
  * This file was auto-generated by openapi-typescript.

package/dist/{types-Brx8PoEB.d.cts → types-CfEvz7zi.d.cts}

@@ -1,10 +1,11 @@
 import { createEncryptionClient } from './encryption/index.cjs';
+import { P as ProjectId } from './types-DJbXfC2q.cjs';
 import { createVaultClient } from './vault/index.cjs';
 
 type VaultClient = ReturnType<typeof createVaultClient>;
 type EncryptionClient = ReturnType<typeof createEncryptionClient>;
 type EncryptionCtx = {
-    projectId: string;
+    projectId: ProjectId;
     defaultBranchId: string;
 };
 

package/dist/{types-Dws8mFNY.d.cts → types-CvHPHNH0.d.cts}

@@ -1,4 +1,4 @@
-import { b as OpenapiBodyType, a as OpenapiReturnType } from './types-C7mpAfq-.cjs';
+import { b as OpenapiBodyType, a as OpenapiReturnType } from './types-jKnx7Tm_.cjs';
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -1404,5 +1404,8 @@ type SuggestComponentBody = OpenapiBodyType<paths['/suggest/component']['post']>
 type ComponentSuggestion = OpenapiReturnType<paths['/suggest/component']['post']>;
 type DescribeConfigurationBody = OpenapiBodyType<paths['/describe/configuration']['post']>;
 type ObjectDescription = OpenapiReturnType<paths['/describe/configuration']['post']>;
+type DocsQuestionBody = OpenapiBodyType<paths['/docs/question']['post']>;
+type DocsAnswer = OpenapiReturnType<paths['/docs/question']['post']>;
+type ComponentDocsDetail = OpenapiReturnType<paths['/docs/components/{componentId}']['get']>;
 
-export type { ComponentSuggestion as C, DescribeConfigurationVersionBody as D, ExplainErrorBody as E, FeedbackBody as F, ObjectDescription as O, SuggestComponentBody as S, DescribeConfigurationMergeBody as a, DescribeConfigurationBody as b, components as c, ErrorExplanation as d };
+export type { ComponentDocsDetail as C, DescribeConfigurationVersionBody as D, ExplainErrorBody as E, FeedbackBody as F, ObjectDescription as O, SuggestComponentBody as S, DescribeConfigurationMergeBody as a, DescribeConfigurationBody as b, components as c, DocsQuestionBody as d, ComponentSuggestion as e, DocsAnswer as f, ErrorExplanation as g };

package/dist/{types-B51cQMrX.d.ts → types-D3Kkh6yW.d.ts}

@@ -1,4 +1,4 @@
-import { b as OpenapiBodyType, a as OpenapiReturnType } from './types-C7mpAfq-.js';
+import { b as OpenapiBodyType, a as OpenapiReturnType } from './types-jKnx7Tm_.js';
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -1404,5 +1404,8 @@ type SuggestComponentBody = OpenapiBodyType<paths['/suggest/component']['post']>
 type ComponentSuggestion = OpenapiReturnType<paths['/suggest/component']['post']>;
 type DescribeConfigurationBody = OpenapiBodyType<paths['/describe/configuration']['post']>;
 type ObjectDescription = OpenapiReturnType<paths['/describe/configuration']['post']>;
+type DocsQuestionBody = OpenapiBodyType<paths['/docs/question']['post']>;
+type DocsAnswer = OpenapiReturnType<paths['/docs/question']['post']>;
+type ComponentDocsDetail = OpenapiReturnType<paths['/docs/components/{componentId}']['get']>;
 
-export type { ComponentSuggestion as C, DescribeConfigurationVersionBody as D, ExplainErrorBody as E, FeedbackBody as F, ObjectDescription as O, SuggestComponentBody as S, DescribeConfigurationMergeBody as a, DescribeConfigurationBody as b, components as c, ErrorExplanation as d };
+export type { ComponentDocsDetail as C, DescribeConfigurationVersionBody as D, ExplainErrorBody as E, FeedbackBody as F, ObjectDescription as O, SuggestComponentBody as S, DescribeConfigurationMergeBody as a, DescribeConfigurationBody as b, components as c, DocsQuestionBody as d, ComponentSuggestion as e, DocsAnswer as f, ErrorExplanation as g };

package/dist/{types-DJkU9gvB.d.cts → types-D9cNOf-3.d.cts}

@@ -1,4 +1,4 @@
-import { d as OpenapiPathType, b as OpenapiBodyType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-C7mpAfq-.cjs';
+import { d as OpenapiPathType, b as OpenapiBodyType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-jKnx7Tm_.cjs';
 
 /**
  * This file was auto-generated by openapi-typescript.