@unkey/api/dist/commonjs/funcs/portalExchangeSession.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

import { UnkeyCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { UnkeyError } from "../models/errors/unkeyerror.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Exchange session token
 *
 * @remarks
 * Exchange a short-lived session token for a long-lived browser session.
 *
 * This endpoint is unauthenticated. The session token itself serves as proof of authorization.
 * Each token can only be exchanged once; subsequent attempts return 401.
 *
 * The returned browser session token is valid for 24 hours and should be stored as an
 * httpOnly cookie or used in the Authorization header for subsequent API calls.
 */
export declare function portalExchangeSession(client: UnkeyCore, request: components.V2PortalExchangeSessionRequestBody, options?: RequestOptions): APIPromise<Result<operations.PortalExchangeSessionResponse, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=portalExchangeSession.d.ts.map