@unkey/api 2.3.3 → 2.3.4

package/src/models/components/v2portalcreatesessionrequestbody.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2PortalCreateSessionRequestBody = {
+  /**
+   * The human-readable slug of the portal configuration to create the session against.
+   *
+   * @remarks
+   * Identifies which app's portal the end user will access.
+   * Must be 3-64 characters, lowercase alphanumeric and hyphens only,
+   * must not start or end with a hyphen, and must not contain consecutive hyphens.
+   */
+  slug: string;
+  /**
+   * The end user's identifier in the customer's system.
+   *
+   * @remarks
+   * Accepts arbitrary string values (user IDs, emails, UUIDs, etc.).
+   */
+  externalId: string;
+  /**
+   * List of RBAC tuple permissions defining what the end user can do in the Portal.
+   *
+   * @remarks
+   * Each permission is a string in the format `{resourceType}.{resourceId}.{action}`.
+   * Use `*` as resourceId to grant access to all resources of that type.
+   *
+   * Tab visibility is derived from the action segment:
+   * - Keys tab: `read_key`, `create_key`, `update_key`, `delete_key`
+   * - Analytics tab: `read_analytics`
+   * - Docs tab: visible when any permission is present
+   */
+  permissions: Array<string>;
+  /**
+   * When true, creates a preview session for testing the portal experience.
+   *
+   * @remarks
+   */
+  preview?: boolean | undefined;
+};
+
+/** @internal */
+export type V2PortalCreateSessionRequestBody$Outbound = {
+  slug: string;
+  externalId: string;
+  permissions: Array<string>;
+  preview: boolean;
+};
+
+/** @internal */
+export const V2PortalCreateSessionRequestBody$outboundSchema: z.ZodType<
+  V2PortalCreateSessionRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2PortalCreateSessionRequestBody
+> = z.object({
+  slug: z.string(),
+  externalId: z.string(),
+  permissions: z.array(z.string()),
+  preview: z.boolean().default(false),
+});
+
+export function v2PortalCreateSessionRequestBodyToJSON(
+  v2PortalCreateSessionRequestBody: V2PortalCreateSessionRequestBody,
+): string {
+  return JSON.stringify(
+    V2PortalCreateSessionRequestBody$outboundSchema.parse(
+      v2PortalCreateSessionRequestBody,
+    ),
+  );
+}

package/src/models/components/v2portalcreatesessionresponsebody.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Meta, Meta$inboundSchema } from "./meta.js";
+import {
+  V2PortalCreateSessionResponseData,
+  V2PortalCreateSessionResponseData$inboundSchema,
+} from "./v2portalcreatesessionresponsedata.js";
+
+export type V2PortalCreateSessionResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  data: V2PortalCreateSessionResponseData;
+};
+
+/** @internal */
+export const V2PortalCreateSessionResponseBody$inboundSchema: z.ZodType<
+  V2PortalCreateSessionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2PortalCreateSessionResponseData$inboundSchema,
+});
+
+export function v2PortalCreateSessionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2PortalCreateSessionResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2PortalCreateSessionResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2PortalCreateSessionResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2portalcreatesessionresponsedata.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2PortalCreateSessionResponseData = {
+  /**
+   * The short-lived session token ID. Valid for 15 minutes and can be exchanged once for a browser session.
+   *
+   * @remarks
+   */
+  sessionId: string;
+  /**
+   * The full portal URL with the session parameter. Redirect the end user to this URL.
+   *
+   * @remarks
+   */
+  url: string;
+};
+
+/** @internal */
+export const V2PortalCreateSessionResponseData$inboundSchema: z.ZodType<
+  V2PortalCreateSessionResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sessionId: z.string(),
+  url: z.string(),
+});
+
+export function v2PortalCreateSessionResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2PortalCreateSessionResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V2PortalCreateSessionResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2PortalCreateSessionResponseData' from JSON`,
+  );
+}

package/src/models/components/v2portalexchangesessionrequestbody.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type V2PortalExchangeSessionRequestBody = {
+  /**
+   * The session token ID received from `portal.createSession`.
+   *
+   * @remarks
+   * Must be valid, unexpired, and not previously exchanged.
+   */
+  sessionId: string;
+};
+
+/** @internal */
+export type V2PortalExchangeSessionRequestBody$Outbound = {
+  sessionId: string;
+};
+
+/** @internal */
+export const V2PortalExchangeSessionRequestBody$outboundSchema: z.ZodType<
+  V2PortalExchangeSessionRequestBody$Outbound,
+  z.ZodTypeDef,
+  V2PortalExchangeSessionRequestBody
+> = z.object({
+  sessionId: z.string(),
+});
+
+export function v2PortalExchangeSessionRequestBodyToJSON(
+  v2PortalExchangeSessionRequestBody: V2PortalExchangeSessionRequestBody,
+): string {
+  return JSON.stringify(
+    V2PortalExchangeSessionRequestBody$outboundSchema.parse(
+      v2PortalExchangeSessionRequestBody,
+    ),
+  );
+}

package/src/models/components/v2portalexchangesessionresponsebody.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Meta, Meta$inboundSchema } from "./meta.js";
+import {
+  V2PortalExchangeSessionResponseData,
+  V2PortalExchangeSessionResponseData$inboundSchema,
+} from "./v2portalexchangesessionresponsedata.js";
+
+export type V2PortalExchangeSessionResponseBody = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: Meta;
+  data: V2PortalExchangeSessionResponseData;
+};
+
+/** @internal */
+export const V2PortalExchangeSessionResponseBody$inboundSchema: z.ZodType<
+  V2PortalExchangeSessionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: Meta$inboundSchema,
+  data: V2PortalExchangeSessionResponseData$inboundSchema,
+});
+
+export function v2PortalExchangeSessionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<V2PortalExchangeSessionResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2PortalExchangeSessionResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2PortalExchangeSessionResponseBody' from JSON`,
+  );
+}

package/src/models/components/v2portalexchangesessionresponsedata.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V2PortalExchangeSessionResponseData = {
+  /**
+   * The browser session token. Store this as an httpOnly cookie for subsequent portal requests.
+   *
+   * @remarks
+   */
+  token: string;
+  /**
+   * Unix timestamp in milliseconds when the browser session expires (24 hours from creation).
+   *
+   * @remarks
+   */
+  expiresAt: number;
+};
+
+/** @internal */
+export const V2PortalExchangeSessionResponseData$inboundSchema: z.ZodType<
+  V2PortalExchangeSessionResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string(),
+  expiresAt: z.number().int(),
+});
+
+export function v2PortalExchangeSessionResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<V2PortalExchangeSessionResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V2PortalExchangeSessionResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V2PortalExchangeSessionResponseData' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -3,3 +3,5 @@
  */
 
 export * from "./identitieslistidentities.js";
+export * from "./portalcreatesession.js";
+export * from "./portalexchangesession.js";

package/src/models/operations/portalcreatesession.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PortalCreateSessionResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.V2PortalCreateSessionResponseBody;
+};
+
+/** @internal */
+export const PortalCreateSessionResponse$inboundSchema: z.ZodType<
+  PortalCreateSessionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.V2PortalCreateSessionResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function portalCreateSessionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PortalCreateSessionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PortalCreateSessionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PortalCreateSessionResponse' from JSON`,
+  );
+}

package/src/models/operations/portalexchangesession.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PortalExchangeSessionResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.V2PortalExchangeSessionResponseBody;
+};
+
+/** @internal */
+export const PortalExchangeSessionResponse$inboundSchema: z.ZodType<
+  PortalExchangeSessionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.V2PortalExchangeSessionResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function portalExchangeSessionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PortalExchangeSessionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PortalExchangeSessionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PortalExchangeSessionResponse' from JSON`,
+  );
+}

package/src/sdk/portal.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { portalCreateSession } from "../funcs/portalCreateSession.js";
+import { portalExchangeSession } from "../funcs/portalExchangeSession.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Portal extends ClientSDK {
+  /**
+   * Create portal session
+   *
+   * @remarks
+   * Create a short-lived session token for an end user to access the Customer Portal.
+   *
+   * The returned session ID is valid for 15 minutes and can be exchanged exactly once
+   * for a 24-hour browser session via `portal.exchangeSession`. Redirect the end user
+   * to the returned URL to start the portal experience.
+   *
+   * **Required Permissions**
+   *
+   * Your root key must be associated with a workspace that has an enabled portal configuration.
+   */
+  async createSession(
+    request: components.V2PortalCreateSessionRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PortalCreateSessionResponse> {
+    return unwrapAsync(portalCreateSession(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async exchangeSession(
+    request: components.V2PortalExchangeSessionRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PortalExchangeSessionResponse> {
+    return unwrapAsync(portalExchangeSession(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -9,6 +9,7 @@ import { Identities } from "./identities.js";
 import { Internal } from "./internal.js";
 import { Keys } from "./keys.js";
 import { Permissions } from "./permissions.js";
+import { Portal } from "./portal.js";
 import { Ratelimit } from "./ratelimit.js";
 
 export class Unkey extends ClientSDK {
@@ -42,6 +43,11 @@ export class Unkey extends ClientSDK {
     return (this._permissions ??= new Permissions(this._options));
   }
 
+  private _portal?: Portal;
+  get portal(): Portal {
+    return (this._portal ??= new Portal(this._options));
+  }
+
   private _ratelimit?: Ratelimit;
   get ratelimit(): Ratelimit {
     return (this._ratelimit ??= new Ratelimit(this._options));