@keboola/api-client 27.0.0 → 31.0.0

package/dist/{types-D6dnnju2.d.ts → types-CuAoZH8w.d.cts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType } from "./index-B-frWtGW.cjs";
+//#region src/clients/metastore/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -1429,25 +1428,23 @@ type components = {
   headers: never;
   pathItems: never;
 };
-
-type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
-type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
-
+//#endregion
+//#region src/clients/metastore/repository/types.d.ts
 type MetaObjectMeta = NonNullable<components['schemas']['handlers.JSONAPIMetaObjectResource']['meta']>;
 type MetaObject<TData extends Record<string, unknown>, TDataOptional extends boolean = false> = {
-    uuid: string;
-    meta: MetaObjectMeta;
+  uuid: string;
+  meta: MetaObjectMeta;
 } & (TDataOptional extends true ? {
-    data?: TData;
+  data?: TData;
 } : {
-    data: TData;
+  data: TData;
 });
 type GetMetaObjectsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['get']>;
 type CreateMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectReturn = OpenapiReturnType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = CreateMetaObjectPath & Omit<CreateMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['get']>;
 type DeleteMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['delete']>;
@@ -1459,18 +1456,18 @@ type UpdateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectTyp
  * patch stays unrepresentable because each branch requires its lead field.
  */
 type UpdateMetaObjectContentPatch<TData extends Record<string, unknown>> = {
-    data: Partial<TData>;
-    name?: UpdateMetaObjectBody['name'];
-    scope?: never;
+  data: Partial<TData>;
+  name?: UpdateMetaObjectBody['name'];
+  scope?: never;
 } | {
-    name: NonNullable<UpdateMetaObjectBody['name']>;
-    data?: Partial<TData>;
-    scope?: never;
+  name: NonNullable<UpdateMetaObjectBody['name']>;
+  data?: Partial<TData>;
+  scope?: never;
 };
 type UpdateMetaObjectScopeStepUp = {
-    scope: NonNullable<UpdateMetaObjectBody['scope']>;
-    data?: never;
-    name?: never;
+  scope: NonNullable<UpdateMetaObjectBody['scope']>;
+  data?: never;
+  name?: never;
 };
 /**
  * A PATCH is exactly one of two operations, and the metastore enforces the split server-side: a
@@ -1487,22 +1484,27 @@ type ReplaceTargetProjectsInput = ReplaceTargetProjectsPath & ReplaceTargetProje
 type ReplaceMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = ReplaceMetaObjectPath & Omit<ReplaceMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectRevisionsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/revisions']['get']>;
 type GetMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['get']>;
 type DeleteMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['delete']>;
 type RawMetaObject<TData extends Record<string, unknown>> = {
-    type: string;
-    id: string;
-    attributes: TData;
-    meta: MetaObjectMeta;
+  type: string;
+  id: string;
+  attributes: TData;
+  meta: MetaObjectMeta;
 };
 type MetaStoreObjectResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>;
+  data: RawMetaObject<TData>;
 };
 type MetaStoreListResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>[];
+  data: RawMetaObject<TData>[];
 };
-
-export type { CreateMetaObjectInput as C, DeleteMetaObjectPath as D, GetMetaObjectsPath as G, MetaObject as M, ReplaceMetaObjectInput as R, UpdateMetaObjectInput as U, MetaStoreListResponse as a, GetMetaObjectRevisionsPath as b, GetMetaObjectPath as c, MetaStoreObjectResponse as d, ReplaceTargetProjectsInput as e, GetMetaObjectRevisionPath as f, DeleteMetaObjectRevisionPath as g, GetSchemaPath as h, components as i, GetVersionedSchemaPath as j, CreateMetaObjectBody as k, CreateMetaObjectPath as l, CreateMetaObjectReturn as m, MetaObjectMeta as n, RawMetaObject as o, ReplaceMetaObjectBody as p, ReplaceMetaObjectPath as q, ReplaceTargetProjectsBody as r, ReplaceTargetProjectsPath as s, UpdateMetaObjectBody as t, UpdateMetaObjectPath as u };
+//#endregion
+//#region src/clients/metastore/schema/types.d.ts
+type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
+type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
+//#endregion
+export { ReplaceTargetProjectsPath as C, components as D, UpdateMetaObjectPath as E, paths as O, ReplaceTargetProjectsInput as S, UpdateMetaObjectInput as T, RawMetaObject as _, CreateMetaObjectPath as a, ReplaceMetaObjectPath as b, DeleteMetaObjectRevisionPath as c, GetMetaObjectRevisionsPath as d, GetMetaObjectsPath as f, MetaStoreObjectResponse as g, MetaStoreListResponse as h, CreateMetaObjectInput as i, GetMetaObjectPath as l, MetaObjectMeta as m, GetVersionedSchemaPath as n, CreateMetaObjectReturn as o, MetaObject as p, CreateMetaObjectBody as r, DeleteMetaObjectPath as s, GetSchemaPath as t, GetMetaObjectRevisionPath as u, ReplaceMetaObjectBody as v, UpdateMetaObjectBody as w, ReplaceTargetProjectsBody as x, ReplaceMetaObjectInput as y };
+//# sourceMappingURL=types-CuAoZH8w.d.cts.map

package/dist/{types-BsejtGjZ.d.ts → types-Culr5v8R.d.ts}

@@ -1,11 +1,10 @@
-import { c as OpenapiQueryType, d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-import './appLogs-BbgAJ5I8.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.js";
+import "./appLogs-BdMG6Cvn.js";
+//#region src/clients/apps/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -815,14 +814,7 @@ type components = {
        *     becomes worth shipping once builds make `buildState` vary.
        * @enum {string}
        */
-      runState:
-        | 'NEVER_RUN'
-        | 'PENDING'
-        | 'STARTING'
-        | 'RUNNING'
-        | 'STOPPING'
-        | 'STOPPED'
-        | 'FAILED';
+      runState: 'NEVER_RUN' | 'PENDING' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'FAILED';
       /** @description `true` once retired (member CR + rendered-config Secret deleted); the row remains in history and is re-materializable. */
       archived: boolean;
       /**
@@ -2104,7 +2096,8 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/apps/types.d.ts
 type App = components['schemas']['App'];
 type AppState = App['state'];
 type Deployment = components['schemas']['Deployment'];
@@ -2126,5 +2119,6 @@ type GetLogsTailQuery = OpenapiQueryType<paths['/apps/{appId}/logs/tail']['get']
 type CreateAppBody = OpenapiBodyType<paths['/apps']['post']>;
 type CreateDeploymentBody = OpenapiBodyType<paths['/apps/{appId}/deployments']['post']>;
 type CreateCredentialBody = OpenapiBodyType<paths['/apps/{appId}/git-repo/credentials']['post']>;
-
-export type { AppId as A, CreateAppBody as C, DeploymentId as D, GetAppsQuery as G, RunId as R, App as a, GetAppRunsQuery as b, CreateDeploymentBody as c, GetLogsTailQuery as d, components as e, CredentialId as f, CreateCredentialBody as g, AppGitRepo as h, AppPassword as i, AppRun as j, AppState as k, CreatedCredential as l, Credential as m, CredentialList as n, Deployment as o, DeploymentBuildState as p, DeploymentRunState as q };
+//#endregion
+export { components as S, DeploymentRunState as _, AppRun as a, GetLogsTailQuery as b, CreateCredentialBody as c, Credential as d, CredentialId as f, DeploymentId as g, DeploymentBuildState as h, AppPassword as i, CreateDeploymentBody as l, Deployment as m, AppGitRepo as n, AppState as o, CredentialList as p, AppId as r, CreateAppBody as s, App as t, CreatedCredential as u, GetAppRunsQuery as v, RunId as x, GetAppsQuery as y };
+//# sourceMappingURL=types-Culr5v8R.d.ts.map

package/dist/{types-Y1ynT2PH.d.cts → types-D5VvEdOv.d.ts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, c as OpenapiQueryType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.cjs';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.js";
+//#region src/clients/queue/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/jobs': {
     parameters: {
@@ -48,12 +47,7 @@ type paths = {
           /** @description Search jobs by *status*. You can set multiple values. */
           status?: components['schemas']['JobStatus'][];
           /** @description Filter jobs by job *type*. */
-          type?:
-            | 'standard'
-            | 'container'
-            | 'phaseContainer'
-            | 'orchestrationContainer'
-            | 'retryContainer';
+          type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
           /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
           componentProps?: {
             type?: string;
@@ -88,25 +82,7 @@ type paths = {
            * @description Sort the jobs by specified attribute.
            * @example runId
            */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'branchId'
-            | 'projectId'
-            | 'projectName'
-            | 'tokenId'
-            | 'tokenDescription'
-            | 'componentId'
-            | 'configId'
-            | 'configRowIds'
-            | 'tag'
-            | 'mode'
-            | 'status'
-            | 'startTime'
-            | 'createdTime'
-            | 'endTime'
-            | 'durationSeconds'
-            | 'result';
+          sortBy?: 'id' | 'runId' | 'branchId' | 'projectId' | 'projectName' | 'tokenId' | 'tokenDescription' | 'componentId' | 'configId' | 'configRowIds' | 'tag' | 'mode' | 'status' | 'startTime' | 'createdTime' | 'endTime' | 'durationSeconds' | 'result';
           /**
            * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
            * @example asc
@@ -350,12 +326,7 @@ type paths = {
           /** @description Search jobs by *status*. You can set multiple values. */
           status?: components['schemas']['JobStatus'][];
           /** @description Filter jobs by job *type*. */
-          type?:
-            | 'standard'
-            | 'container'
-            | 'phaseContainer'
-            | 'orchestrationContainer'
-            | 'retryContainer';
+          type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
           /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
           componentProps?: {
             type?: string;
@@ -390,20 +361,7 @@ type paths = {
            * @description Sort the jobs by specified attribute.
            * @example runId
            */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'projectId'
-            | 'branchId'
-            | 'componentId'
-            | 'configId'
-            | 'tokenDescription'
-            | 'status'
-            | 'createdTime'
-            | 'updatedTime'
-            | 'startTime'
-            | 'endTime'
-            | 'durationSeconds';
+          sortBy?: 'id' | 'runId' | 'projectId' | 'branchId' | 'componentId' | 'configId' | 'tokenDescription' | 'status' | 'createdTime' | 'updatedTime' | 'startTime' | 'endTime' | 'durationSeconds';
           /**
            * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
            * @example asc
@@ -467,20 +425,7 @@ type paths = {
           /** @description Number of jobs per group. */
           jobsPerGroup?: number;
           /** @description Field to sort the results by. */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'projectId'
-            | 'branchId'
-            | 'componentId'
-            | 'configId'
-            | 'tokenDescription'
-            | 'status'
-            | 'createdTime'
-            | 'updatedTime'
-            | 'startTime'
-            | 'endTime'
-            | 'durationSeconds';
+          sortBy?: 'id' | 'runId' | 'projectId' | 'branchId' | 'componentId' | 'configId' | 'tokenDescription' | 'status' | 'createdTime' | 'updatedTime' | 'startTime' | 'endTime' | 'durationSeconds';
           /** @description Order of sorting (asc or desc). */
           sortOrder?: 'asc' | 'desc';
           /** @description Maximum number of results to return. */
@@ -733,23 +678,9 @@ type components = {
       onlyFlowTaskIds?: string[] | null;
     };
     /** @enum {string} */
-    JobStatus:
-      | 'created'
-      | 'waiting'
-      | 'processing'
-      | 'success'
-      | 'warning'
-      | 'error'
-      | 'terminating'
-      | 'terminated'
-      | 'cancelled';
+    JobStatus: 'created' | 'waiting' | 'processing' | 'success' | 'warning' | 'error' | 'terminating' | 'terminated' | 'cancelled';
     /** @enum {string} */
-    JobType:
-      | 'standard'
-      | 'container'
-      | 'phaseContainer'
-      | 'orchestrationContainer'
-      | 'retryContainer';
+    JobType: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
     ProjectStats: {
       jobs?: {
         /**
@@ -761,9 +692,7 @@ type components = {
     };
     /** @description OpenLineage event list */
     OpenLineageEventList: components['schemas']['OpenLineageEvent'][];
-    OpenLineageEvent:
-      | components['schemas']['OpenLineageStartEvent']
-      | components['schemas']['OpenLineageCompleteEvent'];
+    OpenLineageEvent: components['schemas']['OpenLineageStartEvent'] | components['schemas']['OpenLineageCompleteEvent'];
     /** @description Job execution start event, including information about input mapping tables. */
     OpenLineageStartEvent: {
       /** @example START */
@@ -1146,30 +1075,14 @@ interface operations {
          * @description Filter jobs by job *type*.
          * @example standard
          */
-        type?:
-          | 'standard'
-          | 'container'
-          | 'phaseContainer'
-          | 'orchestrationContainer'
-          | 'retryContainer';
+        type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
         /** @description Number of jobs of each configuration to list */
         jobsPerConfiguration?: number;
         /**
          * @description Attribute to sort results by
          * @example startTime
          */
-        sortBy?:
-          | 'id'
-          | 'configId'
-          | 'configRowId'
-          | 'projectId'
-          | 'componentId'
-          | 'status'
-          | 'desiredStatus'
-          | 'mode'
-          | 'startTime'
-          | 'createdTime'
-          | 'endTime';
+        sortBy?: 'id' | 'configId' | 'configRowId' | 'projectId' | 'componentId' | 'status' | 'desiredStatus' | 'mode' | 'startTime' | 'createdTime' | 'endTime';
         /**
          * @description Order of the sorting, must be used with the "sortBy" parameter
          * @example asc
@@ -1328,14 +1241,25 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/queue/types.d.ts
 type QueueJob = OpenapiReturnType<paths['/jobs/{jobId}']['get']>;
 type GetQueueJobPath = OpenapiPathType<paths['/jobs/{jobId}']['get']>;
-type Flatten<T> = T extends unknown ? {
-    [K in keyof T]: T[K];
-} : never;
+/**
+ * The statuses a queue job reports.
+ *
+ * - Terminal: `success`, `warning`, `error`, `cancelled`, `terminated`.
+ * - Killable: `created`, `waiting`, `processing`. A kill is rejected in any other status.
+ * - `terminating` is neither: the kill has been accepted and the daemon is still shutting the job
+ *   down. A caller waiting for a job to stop must not treat it as an end state.
+ * - `desiredStatus` is a separate, two-value field — `processing` or `terminating` — and is what a
+ *   kill request sets. `terminating` appearing there does not mean `status` has reached it yet.
+ * - `PlainJobInterface::STATUSES_ALL` in `job-queue-internal-api-php-client` is the backend source.
+ */
+type QueueJobStatus = QueueJob['status'];
+type Flatten<T> = T extends unknown ? { [K in keyof T]: T[K]; } : never;
 type SearchJobsQuery = Flatten<OpenapiQueryType<paths['/search/jobs']['get']> & {
-    parentRunId?: string;
+  parentRunId?: string;
 }>;
 type SearchJobsResponse = OpenapiReturnType<paths['/search/jobs']['get']>;
 type SearchAllJobsQuery = Flatten<Omit<SearchJobsQuery, 'offset'>>;
@@ -1345,5 +1269,6 @@ type SearchGroupedJobsQuery = OpenapiQueryType<paths['/search/grouped-jobs']['ge
 type SearchGroupedJobsResponse = OpenapiReturnType<paths['/search/grouped-jobs']['get']>;
 type OrchestrationRerunPlanPath = OpenapiPathType<paths['/orchestration-rerun-plan/{jobId}']['get']>;
 type OrchestrationRerunPlan = OpenapiReturnType<paths['/orchestration-rerun-plan/{jobId}']['get']>;
-
-export type { CreateJobBody as C, GetQueueJobPath as G, KillJobPath as K, OrchestrationRerunPlanPath as O, QueueJob as Q, SearchJobsQuery as S, SearchAllJobsQuery as a, SearchGroupedJobsQuery as b, components as c, OrchestrationRerunPlan as d, SearchGroupedJobsResponse as e, SearchJobsResponse as f };
+//#endregion
+export { OrchestrationRerunPlanPath as a, SearchAllJobsQuery as c, SearchJobsQuery as d, SearchJobsResponse as f, OrchestrationRerunPlan as i, SearchGroupedJobsQuery as l, GetQueueJobPath as n, QueueJob as o, components as p, KillJobPath as r, QueueJobStatus as s, CreateJobBody as t, SearchGroupedJobsResponse as u };
+//# sourceMappingURL=types-D5VvEdOv.d.ts.map