@unkey/api 2.3.4 → 2.3.5

package/src/funcs/ratelimitListOverrides.ts

@@ -3,6 +3,7 @@
  */
 
 import { UnkeyCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
 import { encodeJSON } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
@@ -23,8 +24,15 @@ 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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
 
 /**
  * List ratelimit overrides
@@ -45,39 +53,9 @@ export function ratelimitListOverrides(
   request: components.V2RatelimitListOverridesRequestBody,
   options?: RequestOptions,
 ): APIPromise<
-  Result<
-    components.V2RatelimitListOverridesResponseBody,
-    | errors.BadRequestErrorResponse
-    | errors.UnauthorizedErrorResponse
-    | errors.ForbiddenErrorResponse
-    | errors.NotFoundErrorResponse
-    | errors.TooManyRequestsErrorResponse
-    | errors.InternalServerErrorResponse
-    | UnkeyError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: UnkeyCore,
-  request: components.V2RatelimitListOverridesRequestBody,
-  options?: RequestOptions,
-): Promise<
-  [
+  PageIterator<
     Result<
-      components.V2RatelimitListOverridesResponseBody,
+      operations.RatelimitListOverridesResponse,
       | errors.BadRequestErrorResponse
       | errors.UnauthorizedErrorResponse
       | errors.ForbiddenErrorResponse
@@ -93,6 +71,42 @@ async function $do(
       | UnexpectedClientError
       | SDKValidationError
     >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnkeyCore,
+  request: components.V2RatelimitListOverridesRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.RatelimitListOverridesResponse,
+        | errors.BadRequestErrorResponse
+        | errors.UnauthorizedErrorResponse
+        | errors.ForbiddenErrorResponse
+        | errors.NotFoundErrorResponse
+        | errors.TooManyRequestsErrorResponse
+        | errors.InternalServerErrorResponse
+        | UnkeyError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
     APICall,
   ]
 > {
@@ -105,7 +119,7 @@ async function $do(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
@@ -157,7 +171,7 @@ async function $do(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
+    return [haltIterator(requestRes), { status: "invalid" }];
   }
   const req = requestRes.value;
 
@@ -169,7 +183,7 @@ async function $do(
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
+    return [haltIterator(doResult), { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -177,8 +191,8 @@ async function $do(
     HttpMeta: { Response: response, Request: req },
   };
 
-  const [result] = await M.match<
-    components.V2RatelimitListOverridesResponseBody,
+  const [result, raw] = await M.match<
+    operations.RatelimitListOverridesResponse,
     | errors.BadRequestErrorResponse
     | errors.UnauthorizedErrorResponse
     | errors.ForbiddenErrorResponse
@@ -194,7 +208,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.V2RatelimitListOverridesResponseBody$inboundSchema),
+    M.json(200, operations.RatelimitListOverridesResponse$inboundSchema, {
+      key: "Result",
+    }),
     M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema),
     M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema),
     M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema),
@@ -207,8 +223,62 @@ async function $do(
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
   }
 
-  return [result, { status: "complete", request: req, response }];
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.RatelimitListOverridesResponse,
+        | errors.BadRequestErrorResponse
+        | errors.UnauthorizedErrorResponse
+        | errors.ForbiddenErrorResponse
+        | errors.NotFoundErrorResponse
+        | errors.TooManyRequestsErrorResponse
+        | errors.InternalServerErrorResponse
+        | UnkeyError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "pagination.cursor");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      ratelimitListOverrides(
+        client,
+        {
+          ...request,
+          cursor: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
 }

package/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0.0",
-  sdkVersion: "2.3.4",
-  genVersion: "2.882.0",
-  userAgent: "speakeasy-sdk/typescript 2.3.4 2.882.0 2.0.0 @unkey/api",
+  sdkVersion: "2.3.5",
+  genVersion: "2.887.0",
+  userAgent: "speakeasy-sdk/typescript 2.3.5 2.887.0 2.0.0 @unkey/api",
 } as const;

package/src/models/operations/apislistkeys.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 ApisListKeysResponse = {
+  result: components.V2ApisListKeysResponseBody;
+};
+
+/** @internal */
+export const ApisListKeysResponse$inboundSchema: z.ZodType<
+  ApisListKeysResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.V2ApisListKeysResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function apisListKeysResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ApisListKeysResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApisListKeysResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApisListKeysResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -2,6 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./apislistkeys.js";
 export * from "./identitieslistidentities.js";
+export * from "./permissionslistpermissions.js";
+export * from "./permissionslistroles.js";
 export * from "./portalcreatesession.js";
 export * from "./portalexchangesession.js";
+export * from "./ratelimitlistoverrides.js";

package/src/models/operations/permissionslistpermissions.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 PermissionsListPermissionsResponse = {
+  result: components.V2PermissionsListPermissionsResponseBody;
+};
+
+/** @internal */
+export const PermissionsListPermissionsResponse$inboundSchema: z.ZodType<
+  PermissionsListPermissionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.V2PermissionsListPermissionsResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function permissionsListPermissionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PermissionsListPermissionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PermissionsListPermissionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PermissionsListPermissionsResponse' from JSON`,
+  );
+}

package/src/models/operations/permissionslistroles.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 PermissionsListRolesResponse = {
+  result: components.V2PermissionsListRolesResponseBody;
+};
+
+/** @internal */
+export const PermissionsListRolesResponse$inboundSchema: z.ZodType<
+  PermissionsListRolesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.V2PermissionsListRolesResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function permissionsListRolesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PermissionsListRolesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PermissionsListRolesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PermissionsListRolesResponse' from JSON`,
+  );
+}

package/src/models/operations/ratelimitlistoverrides.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 RatelimitListOverridesResponse = {
+  result: components.V2RatelimitListOverridesResponseBody;
+};
+
+/** @internal */
+export const RatelimitListOverridesResponse$inboundSchema: z.ZodType<
+  RatelimitListOverridesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.V2RatelimitListOverridesResponseBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function ratelimitListOverridesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RatelimitListOverridesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RatelimitListOverridesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RatelimitListOverridesResponse' from JSON`,
+  );
+}

package/src/sdk/apis.ts

@@ -8,7 +8,9 @@ import { apisGetApi } from "../funcs/apisGetApi.js";
 import { apisListKeys } from "../funcs/apisListKeys.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Apis extends ClientSDK {
   /**
@@ -116,8 +118,10 @@ export class Apis extends ClientSDK {
   async listKeys(
     request: components.V2ApisListKeysRequestBody,
     options?: RequestOptions,
-  ): Promise<components.V2ApisListKeysResponseBody> {
-    return unwrapAsync(apisListKeys(
+  ): Promise<
+    PageIterator<operations.ApisListKeysResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(apisListKeys(
       this,
       request,
       options,

package/src/sdk/permissions.ts

@@ -12,7 +12,9 @@ import { permissionsListPermissions } from "../funcs/permissionsListPermissions.
 import { permissionsListRoles } from "../funcs/permissionsListRoles.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Permissions extends ClientSDK {
   /**
@@ -172,8 +174,13 @@ export class Permissions extends ClientSDK {
   async listPermissions(
     request: components.V2PermissionsListPermissionsRequestBody,
     options?: RequestOptions,
-  ): Promise<components.V2PermissionsListPermissionsResponseBody> {
-    return unwrapAsync(permissionsListPermissions(
+  ): Promise<
+    PageIterator<
+      operations.PermissionsListPermissionsResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(permissionsListPermissions(
       this,
       request,
       options,
@@ -195,8 +202,10 @@ export class Permissions extends ClientSDK {
   async listRoles(
     request: components.V2PermissionsListRolesRequestBody,
     options?: RequestOptions,
-  ): Promise<components.V2PermissionsListRolesResponseBody> {
-    return unwrapAsync(permissionsListRoles(
+  ): Promise<
+    PageIterator<operations.PermissionsListRolesResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(permissionsListRoles(
       this,
       request,
       options,

package/src/sdk/ratelimit.ts

@@ -10,7 +10,9 @@ import { ratelimitMultiLimit } from "../funcs/ratelimitMultiLimit.js";
 import { ratelimitSetOverride } from "../funcs/ratelimitSetOverride.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Ratelimit extends ClientSDK {
   /**
@@ -101,8 +103,10 @@ export class Ratelimit extends ClientSDK {
   async listOverrides(
     request: components.V2RatelimitListOverridesRequestBody,
     options?: RequestOptions,
-  ): Promise<components.V2RatelimitListOverridesResponseBody> {
-    return unwrapAsync(ratelimitListOverrides(
+  ): Promise<
+    PageIterator<operations.RatelimitListOverridesResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(ratelimitListOverrides(
       this,
       request,
       options,

package/src/types/async.ts

@@ -21,16 +21,17 @@ export type APICall =
 
 export class APIPromise<T> implements Promise<T> {
   readonly #promise: Promise<[T, APICall]>;
-  readonly #unwrapped: Promise<T>;
+  #unwrapped: Promise<T> | null;
 
   readonly [Symbol.toStringTag] = "APIPromise";
 
   constructor(p: [T, APICall] | Promise<[T, APICall]>) {
     this.#promise = p instanceof Promise ? p : Promise.resolve(p);
-    this.#unwrapped =
-      p instanceof Promise
-        ? this.#promise.then(([value]) => value)
-        : Promise.resolve(p[0]);
+    this.#unwrapped = p instanceof Promise ? null : Promise.resolve(p[0]);
+  }
+
+  #getUnwrapped(): Promise<T> {
+    return (this.#unwrapped ??= this.#promise.then(([value]) => value));
   }
 
   then<TResult1 = T, TResult2 = never>(
@@ -55,11 +56,11 @@ export class APIPromise<T> implements Promise<T> {
       | null
       | undefined,
   ): Promise<T | TResult> {
-    return this.#unwrapped.catch(onrejected);
+    return this.#getUnwrapped().catch(onrejected);
   }
 
   finally(onfinally?: (() => void) | null | undefined): Promise<T> {
-    return this.#unwrapped.finally(onfinally);
+    return this.#getUnwrapped().finally(onfinally);
   }
 
   $inspect(): Promise<[T, APICall]> {