@keboola/api-client 4.0.0 → 6.0.0

package/dist/scheduler/types.d.cts

@@ -0,0 +1,372 @@
+import { c as OpenapiQueryType, b as OpenapiBodyType, d as OpenapiPathType, a as OpenapiReturnType } from '../types-jKnx7Tm_.cjs';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+type paths = {
+  '/schedules': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List schedules
+     * @description Lists activated configurations of schedules
+     */
+    get: {
+      parameters: {
+        query?: {
+          /** @description List schedules for a given *Component ID*. If used, must be combined with configurationId. */
+          componentId?: string;
+          /** @description List schedules for a given *Configuration ID*. If used, must be combined with ComponentId. */
+          configurationId?: string;
+        };
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description Success response */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Schedule'][];
+          };
+        };
+        /** @description Error response */
+        default: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['Error'];
+          };
+        };
+      };
+    };
+    put?: never;
+    /**
+     * Activate Schedule
+     * @description Activates and existing configuration of `keboola.scheduler` so that it becomes an active schedule.
+     */
+    post: operations['activate'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/schedules/{scheduleId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * Get schedule detail
+     * @description Get details of a specified schedule
+     */
+    get: operations['getSchedule'];
+    put?: never;
+    post?: never;
+    /**
+     * Delete schedule
+     * @description Permanently deactivate a specified schedule. The schedule configuration of the `keboola.scheduler` component will not be touched.
+     */
+    delete: operations['deleteSchedule'];
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/schedules/{scheduleId}/refreshToken': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Refresh the schedule token
+     * @description Refresh the the token associated with the schedule, if the token is refreshed directly in Storage API, the schedule won't work.
+     */
+    post: operations['refreshToken'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/configurations/{configurationId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    post?: never;
+    /**
+     * Delete schedules for configuration
+     * @description Permanently deactivate schedules for given configuration. The schedule configurations of the `keboola.scheduler` component will not be touched.
+     */
+    delete: operations['deleteSchedulesForConfiguration'];
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    Schedule: {
+      /** @example 123456789 */
+      id: string;
+      /**
+       * @description ID of Storage token used to execute the schedule.
+       * @example 123456790
+       */
+      tokenId: string;
+      /**
+       * @description ID of the configuration of the schedule.
+       * @example 123456790
+       */
+      configurationId: string;
+      /**
+       * @description Version of the configuration of the schedule.
+       * @example 123456790
+       */
+      configurationVersionId: string;
+      schedule: {
+        /**
+         * @description Cron expression describing the schedule
+         * @example *\/2 * * * *
+         */
+        cronTab: string;
+        /**
+         * @description Timezone of the cron expression evaluation, either (UTC) a name of offset (+0100).
+         * @example UTC
+         */
+        timezone: string;
+        /** @enum {string} */
+        state: 'enabled' | 'disabled';
+      };
+      target: {
+        /** @example keboola.ex-db-snowflake */
+        componentId: string;
+        /** @example 12345 */
+        configurationId: string;
+        /** @example run */
+        mode: string;
+        /** @example 1.2.3 */
+        tag: string;
+      };
+      executions: {
+        /** @example 12345 */
+        jobId: string;
+        /**
+         * Format: date-time
+         * @example 2019-06-21T09:12:33.001Z
+         */
+        executionTime: string;
+      }[];
+    };
+    Error: {
+      /** @example The value foobar is invalid */
+      error: string;
+      /** @example 400 */
+      code: number;
+      /** @enum {string} */
+      status: 'error';
+      /** @example scheduler-1234567890 */
+      exceptionId?: string;
+      context: Record<string, never>;
+    };
+  };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+type operations = {
+  activate: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /** @description This will read the configuration (identified by the given `configurationId` and optionally `configurationVersionId`) of a `keboola.scheduler` component and read the scheduler configuration from there. The activated configuration data is returned in the response. The read configuration version is recorded in the schedule and will be used until another configuration version is activated using this API call. */
+    requestBody?: {
+      content: {
+        'application/json': {
+          configurationId: string;
+          configurationVersionId?: string;
+        };
+      };
+    };
+    responses: {
+      /** @description Schedule Activated */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Schedule'];
+        };
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+  getSchedule: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Schedule ID */
+        scheduleId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Success response */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Schedule'];
+        };
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+  deleteSchedule: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Schedule ID */
+        scheduleId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Success response */
+      204: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+  refreshToken: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Schedule ID */
+        scheduleId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Success response */
+      202: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+  deleteSchedulesForConfiguration: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Configuration ID */
+        configurationId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Success response */
+      204: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      /** @description Error response */
+      default: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Error'];
+        };
+      };
+    };
+  };
+};
+
+type Schedule = OpenapiReturnType<paths['/schedules/{scheduleId}']['get']>;
+type Schedules = OpenapiReturnType<paths['/schedules']['get']>;
+type GetSchedulesQuery = OpenapiQueryType<paths['/schedules']['get']>;
+type ActivateScheduleBody = OpenapiBodyType<paths['/schedules']['post']>;
+type SchedulePath = OpenapiPathType<paths['/schedules/{scheduleId}']['get']>;
+type ConfigurationPath = OpenapiPathType<paths['/configurations/{configurationId}']['delete']>;
+
+export type { ActivateScheduleBody, ConfigurationPath, GetSchedulesQuery, Schedule, SchedulePath, Schedules };