@keboola/api-client 45.0.0 → 46.0.0

package/dist/{types-CN6huo55.d.ts → types-BtII5RSD.d.ts}

@@ -1,4 +1,4 @@
-import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-BgR5zcjJ.js";
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-PyTPrtaL.js";
 //#region src/clients/auth/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
@@ -182,7 +182,19 @@ type paths = {
     };
     /**
      * List the caller's maintainers
-     * @description Returns one page of the maintainers the caller belongs to. For a project-restricted session only the maintainers of its reachable organizations appear.
+     * @description Returns a cursor-paginated collection of the maintainers the caller belongs to: `data` holds the page, `meta` the `total`, the `limit` and the cursor structure, `links` the `self`, `first` and `next` URLs. For a project-restricted session only the maintainers of its reachable organizations appear.
+     *
+     *     #### Pagination
+     *
+     *     Rows are ordered `name ASC NULLS FIRST, id ASC`; a maintainer without a name comes first. Names compare case- and accent-insensitively (ICU root collation, primary strength) and the id breaks ties.
+     *
+     *     * *page[limit]* - number of returned rows
+     *     * *page[after]* - cursor of the last row already read; omit it for the first page.
+     *       It is the base64url (padding optional) of the JSON object `{"name": <string|null>, "id": <integer>}`
+     *       holding that row's `name` (`null` when the maintainer has no name) and `id`, e.g. `{"name":"Acme","id":12}` → `eyJuYW1lIjoiQWNtZSIsImlkIjoxMn0`.
+     *       `links.next` already carries the cursor of the page's last row and is `null` on the last page; `meta.cursor` repeats this structure.
+     *
+     *     Bare `limit` / `offset`, `page[offset]` and an undecodable cursor are rejected with a validation error.
      */
     get: operations['get_/v1/auth/me/maintainers'];
     put?: never;
@@ -202,7 +214,25 @@ type paths = {
     };
     /**
      * List the caller's organizations
-     * @description Returns one page of the organizations the caller can reach, with the number of projects they can open in each.
+     * @description Returns a cursor-paginated collection of the organizations the caller can reach, with the number of projects they can open in each: `data` holds the page, `meta` the `total` matching the filters, the `limit` and the cursor structure, `links` the `self`, `first` and `next` URLs, which keep every active filter.
+     *
+     *     #### Filtering
+     *
+     *     * *filter[maintainerId]* - keep only organizations of this maintainer
+     *
+     *     Bare `maintainerId` and unknown `filter[...]` members are rejected with a validation error.
+     *
+     *     #### Pagination
+     *
+     *     Rows are ordered `name ASC, id ASC`; names compare case- and accent-insensitively (ICU root collation, primary strength) and the id breaks ties.
+     *
+     *     * *page[limit]* - number of returned rows
+     *     * *page[after]* - cursor of the last row already read; omit it for the first page.
+     *       It is the base64url (padding optional) of the JSON object `{"name": <string>, "id": <integer>}`
+     *       holding that row's `name` and `id`, e.g. `{"name":"Acme","id":12}` → `eyJuYW1lIjoiQWNtZSIsImlkIjoxMn0`.
+     *       `links.next` already carries the cursor of the page's last row and is `null` on the last page; `meta.cursor` repeats this structure.
+     *
+     *     Bare `limit` / `offset`, `page[offset]` and an undecodable cursor are rejected with a validation error.
      */
     get: operations['get_/v1/auth/me/organizations'];
     put?: never;
@@ -222,7 +252,26 @@ type paths = {
     };
     /**
      * List the caller's projects
-     * @description Returns one page of the projects the caller can open, each with the id of its organization.
+     * @description Returns a cursor-paginated collection of the projects the caller can open, each with the id of its organization: `data` holds the page, `meta` the `total` matching the filters, the `limit` and the cursor structure, `links` the `self`, `first` and `next` URLs, which keep every active filter.
+     *
+     *     #### Filtering
+     *
+     *     * *filter[organizationId]* - keep only projects of this organization
+     *     * *filter[name]* - case-insensitive substring of the project name; empty means no filter
+     *
+     *     Bare `organizationId` / `name` / `q` and unknown `filter[...]` members are rejected with a validation error.
+     *
+     *     #### Pagination
+     *
+     *     Rows are ordered `name ASC, id ASC`; names compare case- and accent-insensitively (ICU root collation, primary strength) and the id breaks ties.
+     *
+     *     * *page[limit]* - number of returned rows
+     *     * *page[after]* - cursor of the last row already read; omit it for the first page.
+     *       It is the base64url (padding optional) of the JSON object `{"name": <string>, "id": <integer>}`
+     *       holding that row's `name` and `id`, e.g. `{"name":"Acme","id":12}` → `eyJuYW1lIjoiQWNtZSIsImlkIjoxMn0`.
+     *       `links.next` already carries the cursor of the page's last row and is `null` on the last page; `meta.cursor` repeats this structure.
+     *
+     *     Bare `limit` / `offset`, `page[offset]` and an undecodable cursor are rejected with a validation error.
      */
     get: operations['get_/v1/auth/me/projects'];
     put?: never;
@@ -820,7 +869,7 @@ type components = {
     DeviceAuthorizationCreateRequest: {
       /** @description Public CLI client identifier. */
       clientId: string;
-      scope: {
+      scope?: {
         /** @enum {string} */
         credentialType?: 'session';
       };
@@ -850,9 +899,9 @@ type components = {
        */
       type: 'totp' | 'recovery_code' | 'webauthn';
       /** @description Verification code: 6-digit TOTP for type=totp, recovery code string for type=recovery_code. Required when type is totp or recovery_code. */
-      code: string;
+      code?: string;
       /** @description WebAuthn assertion response as JSON string. Required when type is webauthn. */
-      assertion: string;
+      assertion?: string;
     };
     PasswordChangeRequest: {
       /**
@@ -908,13 +957,13 @@ type components = {
       /** @description User-facing label. */
       name: string;
       /** @description Requested lifetime in seconds. Capped at the org policy maximum. Omit (do not send `null`) to default to the cap. */
-      expiresIn: number;
-      scope: components['schemas']['ScopeRequestPayload'];
+      expiresIn?: number;
+      scope?: components['schemas']['ScopeRequestPayload'];
     };
     PatExchangeRequest: {
       /** @description Requested lifetime in seconds. Capped at the parent-type maximum. Omit (do not send `null`) to use the parent-type TTL cap as the lifetime. */
-      expiresIn: number;
-      scope: components['schemas']['ScopeRequestPayload'];
+      expiresIn?: number;
+      scope?: components['schemas']['ScopeRequestPayload'];
     };
     PkceAuthorizationTokenRequest: {
       clientId: string;
@@ -955,9 +1004,9 @@ type components = {
     };
     TokenRefreshRequest: {
       /** @description API mode: refresh token to exchange for a new token pair. Mutually exclusive with sessionId — submit exactly one. */
-      refreshToken: string;
+      refreshToken?: string;
       /** @description Browser/cookie mode: session id from the login response. The refresh token itself lives in a server-side channel bound to the session cookie and is never submitted by the client. Mutually exclusive with refreshToken — submit exactly one. */
-      sessionId: string;
+      sessionId?: string;
     };
     TokenRevokeRequest: {
       /** @description Token to revoke (access or refresh token). */
@@ -981,7 +1030,7 @@ type components = {
       /** @description WebAuthn attestation response as returned by navigator.credentials.create(), serialized as a JSON string. */
       credential: string;
       /** @description Optional human-readable device name. Defaults to "Device <timestamp>" when omitted. */
-      deviceName: string;
+      deviceName?: string;
       /**
        * @description When true, revokes every other session of the admin and the tokens derived from them (the calling session and any long-lived personal access token stay valid). Defaults to false.
        * @default false
@@ -1072,8 +1121,8 @@ type components = {
     LoginResponse: {
       /** @description Opaque bearer access token for API authentication (format: kbc_at_{sessionId}_{secret}). */
       accessToken: string;
-      /** @description Refresh token for obtaining new access tokens. Absent in browser mode, where the refresh token lives in a server-side cookie-bound channel instead. */
-      refreshToken?: string | null;
+      /** @description Refresh token for obtaining new access tokens. Present only in API mode; in browser mode it lives in a server-side cookie-bound channel instead. */
+      refreshToken?: string;
       /** @description Token type. Always "Bearer". */
       tokenType: string;
       /** @description Remaining access token lifetime in seconds. */
@@ -1118,16 +1167,16 @@ type components = {
       /** @enum {string} */
       status: 'approved' | 'denied';
       idempotent: boolean;
-      decision: components['schemas']['DeviceApprovalDecision'];
+      decision?: components['schemas']['DeviceApprovalDecision'];
     };
     DeviceAuthorizationCreateRequest2: {
       /** @description Public CLI client identifier. */
       clientId: string;
-      scope: {
+      scope?: {
         /** @enum {string} */
         credentialType?: 'session';
       };
-      requestedCredentialType: string;
+      requestedCredentialType?: string;
     };
     DeviceAuthorizationCreateResponse: {
       deviceCode: string;
@@ -1143,9 +1192,10 @@ type components = {
       code: string;
       uuid: string;
       params: {
-        /** @description Device-flow error token such as authorization_pending, slow_down, or expired_token. */
-        error: string;
-        interval?: number | null;
+        /** @description Device-flow error token such as authorization_pending, slow_down, or expired_token. Present only for CLI authorization errors, not for request-validation errors. */
+        error?: string;
+        /** @description Present only when `error` is `slow_down` or `temporarily_unavailable`. */
+        interval?: number;
       };
       exceptionDetailUrl: string;
     };
@@ -1223,17 +1273,17 @@ type components = {
        * Format: date-time
        * @description `null` for legacy rows whose creation time was never recorded.
        */
-      createdAt?: string | null;
+      createdAt: string | null;
       /**
        * Format: date-time
        * @description `null` means the token never expires.
        */
-      expiresAt?: string | null;
+      expiresAt: string | null;
       /**
        * Format: date-time
        * @description `null` means the token was never used.
        */
-      lastUsedAt?: string | null;
+      lastUsedAt: string | null;
     };
     ManageTokenListResponse: {
       /** @description User-created Manage API tokens, newest first. */
@@ -1322,15 +1372,59 @@ type components = {
         hasMore: boolean;
       };
     };
+    PaginationMeta: {
+      /** @description Number of items matching the filters, ignoring pagination. */
+      total: number;
+      /** @description Page size applied (`page[limit]`). */
+      limit: number;
+      /** @description How to build the `page[after]` cursor from the last row read, without another call. */
+      cursor: {
+        /**
+         * @description Query parameter the cursor goes in.
+         * @example page[after]
+         */
+        param: string;
+        /**
+         * @description base64url (RFC 4648 §5, padding optional) of a JSON object.
+         * @example base64url(json)
+         */
+        encoding: string;
+        /** @description Keys of the JSON object, each the last row's value of the item field of the same name. */
+        fields: {
+          name: string;
+          /** @enum {string} */
+          type: 'integer' | 'string' | 'date-time';
+          nullable: boolean;
+        }[];
+        /**
+         * @description Order of the rows; the cursor keys follow it.
+         * @example deletedTime DESC NULLS LAST, id DESC
+         */
+        order: string;
+      };
+    };
+    PaginationLinks: {
+      /**
+       * Format: uri
+       * @description This page.
+       */
+      self: string;
+      /**
+       * Format: uri
+       * @description The first page (no `page[after]`).
+       */
+      first: string;
+      /**
+       * Format: uri
+       * @description The page after this one; `null` on the last page.
+       */
+      next: string | null;
+    };
     MePageResponse: {
-      /** @description Size of the whole filtered collection. */
-      count: number;
       /** @description The items of this page; each endpoint documents their shape. */
-      items: Record<string, never>[];
-      limit: number;
-      offset: number;
-      /** @description Whether items exist beyond this page. */
-      hasMore: boolean;
+      data: Record<string, never>[];
+      meta: components['schemas']['PaginationMeta'];
+      links: components['schemas']['PaginationLinks'];
     };
     MfaRequest2: {
       /** @description MFA challenge token from login response. */
@@ -1368,13 +1462,13 @@ type components = {
       /** @description Projects the token has rights to. Resolved live for an "all" scope; for a frozen subset scope the issued allow-list is echoed verbatim (a purged project yields name=null, a lost membership yields role=null). */
       projects: components['schemas']['ProjectAccessItem'][];
       readOnly: boolean;
-      parentTokenId?: string | null;
+      parentTokenId: string | null;
       /** @enum {string|null} */
-      parentTokenType?: 'session' | 'pat' | null;
+      parentTokenType: 'session' | 'pat' | null;
       /** Format: date-time */
       expiresAt: string;
       /** Format: date-time */
-      lastUsedAt?: string | null;
+      lastUsedAt: string | null;
       /** Format: date-time */
       createdAt: string;
     };
@@ -1470,13 +1564,13 @@ type components = {
       /** @description OAuth client identifier. */
       id: string;
       /** @description Client display name, null when the client no longer exists. */
-      name?: string | null;
+      name: string | null;
     };
     SessionProjectResponse: {
       /** @description Project identifier. */
       id: string;
       /** @description Project name, null when the project no longer exists. */
-      name?: string | null;
+      name: string | null;
     };
     SessionItemResponse: {
       /** @description Session identifier. */
@@ -1484,7 +1578,7 @@ type components = {
       /** @description Grant type used to create the session. */
       grantType: string;
       /** @description OAuth client the session was granted to, null for grant types with no client. */
-      client?: components['schemas']['SessionClientResponse'] | null;
+      client: components['schemas']['SessionClientResponse'] | null;
       /** @description True when the session is not restricted to a project subset; `projects` is then empty. */
       allProjects: boolean;
       /** @description Projects the session was granted, as frozen at issuance. Empty when `allProjects` is true. */
@@ -1498,11 +1592,11 @@ type components = {
        * Format: date-time
        * @description Last time the session was used.
        */
-      lastUsedAt?: string | null;
+      lastUsedAt: string | null;
       /** @description IP address of last usage. */
-      lastUsedIp?: string | null;
+      lastUsedIp: string | null;
       /** @description User agent of the client. */
-      userAgent?: string | null;
+      userAgent: string | null;
       /**
        * Format: date-time
        * @description Access token expiration timestamp.
@@ -1519,9 +1613,9 @@ type components = {
     OAuthSessionItemResponse: {
       client: components['schemas']['SessionClientResponse'];
       /** @description Project the grant is bound to, null for a project-less grant. */
-      project?: components['schemas']['SessionProjectResponse'] | null;
+      project: components['schemas']['SessionProjectResponse'] | null;
       /** @description Storage token the grant is bound to, null for a project-less grant. */
-      tokenId?: number | null;
+      tokenId: number | null;
       /** @description True when the grant reaches every project the admin is a member of, now and in the future; `projects` is then empty. */
       allProjects: boolean;
       /** @description Projects the grant reaches, as consented — not intersected with the admin's current project membership, so a project the admin has since lost access to is still listed. Empty when `allProjects` is true. */
@@ -1532,7 +1626,7 @@ type components = {
        * Format: date-time
        * @description When the admin first authorized this client, null for a grant predating consent records.
        */
-      authorizedAt?: string | null;
+      authorizedAt: string | null;
       /**
        * Format: date-time
        * @description Access token expiration timestamp.
@@ -1565,7 +1659,7 @@ type components = {
        * @default null
        */
       password: string | null;
-      type: string;
+      type?: string;
     };
     SudoResponse: {
       /** @description Whether step-up authentication was successful. */
@@ -1608,11 +1702,11 @@ type components = {
        * Format: date-time
        * @description Last time the session was used.
        */
-      lastUsedAt?: string | null;
+      lastUsedAt: string | null;
       /** @description IP address of last usage. */
-      lastUsedIp?: string | null;
+      lastUsedIp: string | null;
       /** @description User agent of the client. */
-      userAgent?: string | null;
+      userAgent: string | null;
       /** @description Projects the session has rights to (live access set). */
       projects: components['schemas']['ProjectAccessItem'][];
     };
@@ -1650,8 +1744,8 @@ type components = {
        * @example TOTP
        */
       mfaType: string;
-      /** @description Plaintext recovery codes, present only when this enrollment enabled the first MFA factor. */
-      recoveryCodes?: string[] | null;
+      /** @description Plaintext recovery codes. Present only when this enrollment enabled the first MFA factor. */
+      recoveryCodes?: string[];
     };
     WebAuthnCredentialItemResponse: {
       /** @description Credential identifier. */
@@ -1688,8 +1782,8 @@ type components = {
        * @description Registration timestamp.
        */
       created: string;
-      /** @description Freshly generated MFA recovery codes, present only when this was the first MFA factor enabled for the account. */
-      recoveryCodes?: string[] | null;
+      /** @description Freshly generated MFA recovery codes. Present only when this was the first MFA factor enabled for the account. */
+      recoveryCodes?: string[];
     };
     WebAuthnRegisterOptionsResponse: {
       /** @description Serialized WebAuthn PublicKeyCredentialCreationOptions, consumable by navigator.credentials.create({publicKey: options}). */
@@ -2162,10 +2256,12 @@ interface operations {
   'get_/v1/auth/me/maintainers': {
     parameters: {
       query?: {
-        /** @description Page size, from 1 up to the configured maximum. Defaults to the configured default page size. */
-        limit?: number;
-        /** @description Number of items to skip. Defaults to 0. */
-        offset?: number;
+        /** @description Pagination: `page[limit]` (default and maximum are configured on the server) and `page[after]`, the cursor of the last row read — base64url(json) of `{"name": string|null, "id": integer}`, rows ordered `name ASC NULLS FIRST, id ASC`. Omit `page[after]` for the first page; `links.next` carries the next one. */
+        page?: {
+          /** @description base64url(json) of `{"name": string|null, "id": integer}`. */
+          after?: string;
+          limit?: number;
+        };
       };
       header?: never;
       path?: never;
@@ -2180,11 +2276,11 @@ interface operations {
         };
         content: {
           'application/json': components['schemas']['MePageResponse'] & {
-            items?: components['schemas']['OrganizationMaintainerReference'][];
+            data?: components['schemas']['OrganizationMaintainerReference'][];
           };
         };
       };
-      /** @description A paging parameter is not a single integer value, or is out of range. */
+      /** @description A `page[...]` parameter is invalid: out of range, not a single value of the right type, an undecodable cursor, or a bare `limit` / `offset` or `page[offset]` is sent. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -2217,12 +2313,17 @@ interface operations {
   'get_/v1/auth/me/organizations': {
     parameters: {
       query?: {
-        /** @description Page size, from 1 up to the configured maximum. Defaults to the configured default page size. */
-        limit?: number;
-        /** @description Number of items to skip. Defaults to 0. */
-        offset?: number;
-        /** @description Keep only organizations of this maintainer. */
-        maintainerId?: number;
+        /** @description Pagination: `page[limit]` (default and maximum are configured on the server) and `page[after]`, the cursor of the last row read — base64url(json) of `{"name": string, "id": integer}`, rows ordered `name ASC, id ASC`. Omit `page[after]` for the first page; `links.next` carries the next one. */
+        page?: {
+          /** @description base64url(json) of `{"name": string, "id": integer}`. */
+          after?: string;
+          limit?: number;
+        };
+        /** @description Filters, JSON:API style: `filter[<name>]=<value>`. Filters combine with AND. */
+        filter?: {
+          /** @description Keep only organizations of this maintainer. */
+          maintainerId?: number;
+        };
       };
       header?: never;
       path?: never;
@@ -2237,11 +2338,11 @@ interface operations {
         };
         content: {
           'application/json': components['schemas']['MePageResponse'] & {
-            items?: components['schemas']['OrganizationAccessItem'][];
+            data?: components['schemas']['OrganizationAccessItem'][];
           };
         };
       };
-      /** @description A paging or filter parameter is not a single integer value, or is out of range. */
+      /** @description A `page[...]` or `filter[...]` parameter is invalid: out of range, not a single value of the right type, an undecodable cursor, or a bare `limit`, `offset`, `maintainerId` or `page[offset]` is sent. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -2274,14 +2375,19 @@ interface operations {
   'get_/v1/auth/me/projects': {
     parameters: {
       query?: {
-        /** @description Page size, from 1 up to the configured maximum. Defaults to the configured default page size. */
-        limit?: number;
-        /** @description Number of items to skip. Defaults to 0. */
-        offset?: number;
-        /** @description Keep only projects of this organization. */
-        organizationId?: number;
-        /** @description Case-insensitive substring of the project name. Empty means no filter; longer than the configured maximum is rejected. */
-        q?: string;
+        /** @description Pagination: `page[limit]` (default and maximum are configured on the server) and `page[after]`, the cursor of the last row read — base64url(json) of `{"name": string, "id": integer}`, rows ordered `name ASC, id ASC`. Omit `page[after]` for the first page; `links.next` carries the next one. */
+        page?: {
+          /** @description base64url(json) of `{"name": string, "id": integer}`. */
+          after?: string;
+          limit?: number;
+        };
+        /** @description Filters, JSON:API style: `filter[<name>]=<value>`. Filters combine with AND. */
+        filter?: {
+          /** @description Keep only projects of this organization. */
+          organizationId?: number;
+          /** @description Case-insensitive substring of the project name. Empty means no filter; longer than the configured maximum is rejected. */
+          name?: string;
+        };
       };
       header?: never;
       path?: never;
@@ -2296,11 +2402,11 @@ interface operations {
         };
         content: {
           'application/json': components['schemas']['MePageResponse'] & {
-            items?: components['schemas']['OrganizationProjectItem'][];
+            data?: components['schemas']['OrganizationProjectItem'][];
           };
         };
       };
-      /** @description A paging or filter parameter is not a single value of the right type, or is out of range or too long. */
+      /** @description A `page[...]` or `filter[...]` parameter is invalid: out of range, too long, not a single value of the right type, an undecodable cursor, or a bare `limit`, `offset`, `organizationId`, `name`, `q` or `page[offset]` is sent. */
       400: {
         headers: {
           [name: string]: unknown;
@@ -3766,4 +3872,4 @@ type RemoveWebauthnQuery = NonNullable<OpenapiQueryType<paths['/v1/auth/webauthn
 type RemoveWebauthnInput = RemoveWebauthnPath & RemoveWebauthnQuery;
 //#endregion
 export { PatScopeInput as A, GetMeOrganizationsQuery as B, GetPkceTokenResult as C, ExchangePatBodyRaw as D, CreatePatResult as E, TotpVerifyResult as F, CreateDeviceAuthorizationBody as G, LoginBody as H, VerifyMfaBody as I, GetDeviceAuthorizationTokenResult as J, CreateDeviceAuthorizationResult as K, VerifyMfaResult as L, DisableTotpPath as M, RegenerateRecoveryCodesResult as N, ExchangePatInput as O, TotpSetupResult as P, VerifyMfaType as R, GetPkceTokenBody as S, CreatePatInput as T, ApproveDeviceAuthorizationBody as U, GetMeProjectsQuery as V, ApproveDeviceAuthorizationResult as W, paths as X, components as Y, RevokeSessionPath as _, RemoveWebauthnInput as a, InitiateSamlBody as b, IntrospectTokenResult as c, RefreshTokenResult as d, RevokeTokenBody as f, SudoResult as g, SudoChallengeResult as h, RegisterWebauthnResult as i, RevokePatPath as j, ListPatsResult as k, RefreshTokenBody as l, SudoBodyRaw as m, RegisterWebauthnInput as n, RemoveWebauthnPath as o, SudoBody as p, GetDeviceAuthorizationTokenBody as q, RegisterWebauthnOptionsResult as r, RemoveWebauthnQuery as s, ListWebauthnCredentialsResult as t, RefreshTokenPartialBody as u, AssertSamlBody as v, CreatePatBodyRaw as w, InitiateSamlResult as x, AssertSamlResult as y, GetMeMaintainersQuery as z };
-//# sourceMappingURL=types-CN6huo55.d.ts.map
+//# sourceMappingURL=types-BtII5RSD.d.ts.map