@unkey/api 0.38.0 → 2.0.0-alpha.11

package/src/funcs/ratelimitSetOverride.ts

@@ -0,0 +1,202 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { UnkeyCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Set ratelimit override
+ *
+ * @remarks
+ * Create or update a custom rate limit for specific identifiers, bypassing the namespace default.
+ *
+ * Use this to create premium tiers with higher limits, apply stricter limits to specific users, or implement emergency throttling.
+ *
+ * **Important:** Overrides take effect immediately and completely replace the default limit for matching identifiers. Use wildcard patterns (e.g., `premium_*`) to match multiple identifiers.
+ *
+ * **Permissions:** Requires `ratelimit.*.set_override` or `ratelimit.<namespace_id>.set_override`
+ */
+export function ratelimitSetOverride(
+  client: UnkeyCore,
+  request: components.V2RatelimitSetOverrideRequestBody,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.V2RatelimitSetOverrideResponseBody,
+    | errors.BadRequestErrorResponse
+    | errors.UnauthorizedErrorResponse
+    | errors.ForbiddenErrorResponse
+    | errors.NotFoundErrorResponse
+    | errors.InternalServerErrorResponse
+    | UnkeyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: UnkeyCore,
+  request: components.V2RatelimitSetOverrideRequestBody,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.V2RatelimitSetOverrideResponseBody,
+      | errors.BadRequestErrorResponse
+      | errors.UnauthorizedErrorResponse
+      | errors.ForbiddenErrorResponse
+      | errors.NotFoundErrorResponse
+      | errors.InternalServerErrorResponse
+      | UnkeyError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.V2RatelimitSetOverrideRequestBody$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/ratelimit.setOverride")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.rootKey);
+  const securityInput = secConfig == null ? {} : { rootKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "ratelimit.setOverride",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.rootKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 50,
+          maxInterval: 1000,
+          exponent: 1.5,
+          maxElapsedTime: 10000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.V2RatelimitSetOverrideResponseBody,
+    | errors.BadRequestErrorResponse
+    | errors.UnauthorizedErrorResponse
+    | errors.ForbiddenErrorResponse
+    | errors.NotFoundErrorResponse
+    | errors.InternalServerErrorResponse
+    | UnkeyError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.V2RatelimitSetOverrideResponseBody$inboundSchema),
+    M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema),
+    M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema),
+    M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema),
+    M.jsonErr(404, errors.NotFoundErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.InternalServerErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/hooks/hooks.ts

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { RequestInput } from "../lib/http.js";
+import {
+  AfterErrorContext,
+  AfterErrorHook,
+  AfterSuccessContext,
+  AfterSuccessHook,
+  BeforeCreateRequestContext,
+  BeforeCreateRequestHook,
+  BeforeRequestContext,
+  BeforeRequestHook,
+  Hook,
+  Hooks,
+  SDKInitHook,
+  SDKInitOptions,
+} from "./types.js";
+
+import { initHooks } from "./registration.js";
+
+export class SDKHooks implements Hooks {
+  sdkInitHooks: SDKInitHook[] = [];
+  beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
+  beforeRequestHooks: BeforeRequestHook[] = [];
+  afterSuccessHooks: AfterSuccessHook[] = [];
+  afterErrorHooks: AfterErrorHook[] = [];
+
+  constructor() {
+    const presetHooks: Array<Hook> = [];
+
+    for (const hook of presetHooks) {
+      if ("sdkInit" in hook) {
+        this.registerSDKInitHook(hook);
+      }
+      if ("beforeCreateRequest" in hook) {
+        this.registerBeforeCreateRequestHook(hook);
+      }
+      if ("beforeRequest" in hook) {
+        this.registerBeforeRequestHook(hook);
+      }
+      if ("afterSuccess" in hook) {
+        this.registerAfterSuccessHook(hook);
+      }
+      if ("afterError" in hook) {
+        this.registerAfterErrorHook(hook);
+      }
+    }
+    initHooks(this);
+  }
+
+  registerSDKInitHook(hook: SDKInitHook) {
+    this.sdkInitHooks.push(hook);
+  }
+
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) {
+    this.beforeCreateRequestHooks.push(hook);
+  }
+
+  registerBeforeRequestHook(hook: BeforeRequestHook) {
+    this.beforeRequestHooks.push(hook);
+  }
+
+  registerAfterSuccessHook(hook: AfterSuccessHook) {
+    this.afterSuccessHooks.push(hook);
+  }
+
+  registerAfterErrorHook(hook: AfterErrorHook) {
+    this.afterErrorHooks.push(hook);
+  }
+
+  sdkInit(opts: SDKInitOptions): SDKInitOptions {
+    return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
+  }
+
+  beforeCreateRequest(
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ): RequestInput {
+    let inp = input;
+
+    for (const hook of this.beforeCreateRequestHooks) {
+      inp = hook.beforeCreateRequest(hookCtx, inp);
+    }
+
+    return inp;
+  }
+
+  async beforeRequest(
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ): Promise<Request> {
+    let req = request;
+
+    for (const hook of this.beforeRequestHooks) {
+      req = await hook.beforeRequest(hookCtx, req);
+    }
+
+    return req;
+  }
+
+  async afterSuccess(
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ): Promise<Response> {
+    let res = response;
+
+    for (const hook of this.afterSuccessHooks) {
+      res = await hook.afterSuccess(hookCtx, res);
+    }
+
+    return res;
+  }
+
+  async afterError(
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ): Promise<{ response: Response | null; error: unknown }> {
+    let res = response;
+    let err = error;
+
+    for (const hook of this.afterErrorHooks) {
+      const result = await hook.afterError(hookCtx, res, err);
+      res = result.response;
+      err = result.error;
+    }
+
+    return { response: res, error: err };
+  }
+}

package/src/hooks/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./hooks.js";
+export * from "./types.js";

package/src/hooks/registration.ts

@@ -0,0 +1,14 @@
+import { Hooks } from "./types.js";
+
+/*
+ * This file is only ever generated once on the first generation and then is free to be modified.
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
+ * in this file or in separate files in the hooks folder.
+ */
+
+// @ts-expect-error remove this line when you add your first hook and hooks is used
+export function initHooks(hooks: Hooks) {
+  // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
+  // with an instance of a hook that implements that specific Hook interface
+  // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+}

package/src/hooks/types.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKOptions } from "../lib/config.js";
+import { HTTPClient, RequestInput } from "../lib/http.js";
+import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
+
+export type HookContext = {
+  baseURL: string | URL;
+  operationID: string;
+  oAuth2Scopes: string[] | null;
+  securitySource?: any | (() => Promise<any>);
+  retryConfig: RetryConfig;
+  resolvedSecurity: SecurityState | null;
+  options: SDKOptions;
+};
+
+export type Awaitable<T> = T | Promise<T>;
+
+export type SDKInitOptions = {
+  baseURL: URL | null;
+  client: HTTPClient;
+};
+
+export type BeforeCreateRequestContext = HookContext & {};
+export type BeforeRequestContext = HookContext & {};
+export type AfterSuccessContext = HookContext & {};
+export type AfterErrorContext = HookContext & {};
+
+/**
+ * SDKInitHook is called when the SDK is initializing. The
+ * hook can return a new baseURL and HTTP client to be used by the SDK.
+ */
+export interface SDKInitHook {
+  sdkInit: (opts: SDKInitOptions) => SDKInitOptions;
+}
+
+export interface BeforeCreateRequestHook {
+  /**
+   * A hook that is called before the SDK creates a `Request` object. The hook
+   * can modify how a request is constructed since certain modifications, like
+   * changing the request URL, cannot be done on a request object directly.
+   */
+  beforeCreateRequest: (
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ) => RequestInput;
+}
+
+export interface BeforeRequestHook {
+  /**
+   * A hook that is called before the SDK sends a request. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * replace the request before it is sent or throw an error to stop the
+   * request from being sent.
+   */
+  beforeRequest: (
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ) => Awaitable<Request>;
+}
+
+export interface AfterSuccessHook {
+  /**
+   * A hook that is called after the SDK receives a response. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * modify the response before it is handled or throw an error to stop the
+   * response from being handled.
+   */
+  afterSuccess: (
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ) => Awaitable<Response>;
+}
+
+export interface AfterErrorHook {
+  /**
+   * A hook that is called after the SDK encounters an error, or a
+   * non-successful response. The hook can introduce instrumentation code such
+   * as logging, tracing and metrics or modify the response or error values.
+   */
+  afterError: (
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ) => Awaitable<{
+    response: Response | null;
+    error: unknown;
+  }>;
+}
+
+export interface Hooks {
+  /** Registers a hook to be used by the SDK for initialization event. */
+  registerSDKInitHook(hook: SDKInitHook): void;
+  /** Registers a hook to be used by the SDK for to modify `Request` construction. */
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
+  /** Registers a hook to be used by the SDK for the before request event. */
+  registerBeforeRequestHook(hook: BeforeRequestHook): void;
+  /** Registers a hook to be used by the SDK for the after success event. */
+  registerAfterSuccessHook(hook: AfterSuccessHook): void;
+  /** Registers a hook to be used by the SDK for the after error event. */
+  registerAfterErrorHook(hook: AfterErrorHook): void;
+}
+
+export type Hook =
+  | SDKInitHook
+  | BeforeCreateRequestHook
+  | BeforeRequestHook
+  | AfterSuccessHook
+  | AfterErrorHook;

package/src/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./lib/config.js";
+export * as files from "./lib/files.js";
+export { HTTPClient } from "./lib/http.js";
+export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
+export * from "./sdk/sdk.js";

package/src/lib/base64.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function bytesToBase64(u8arr: Uint8Array): string {
+  return btoa(String.fromCodePoint(...u8arr));
+}
+
+export function bytesFromBase64(encoded: string): Uint8Array {
+  return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+}
+
+export function stringToBytes(str: string): Uint8Array {
+  return new TextEncoder().encode(str);
+}
+
+export function stringFromBytes(u8arr: Uint8Array): string {
+  return new TextDecoder().decode(u8arr);
+}
+
+export function stringToBase64(str: string): string {
+  return bytesToBase64(stringToBytes(str));
+}
+
+export function stringFromBase64(b64str: string): string {
+  return stringFromBytes(bytesFromBase64(b64str));
+}
+
+export const zodOutbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(stringToBytes));
+
+export const zodInbound = z
+  .instanceof(Uint8Array)
+  .or(z.string().transform(bytesFromBase64));

package/src/lib/config.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
+import { RetryConfig } from "./retries.js";
+import { Params, pathToFunc } from "./url.js";
+
+/**
+ * Contains the list of servers available to the SDK
+ */
+export const ServerList = [
+  "https://api.unkey.com",
+] as const;
+
+export type SDKOptions = {
+  rootKey?: string | (() => Promise<string>) | undefined;
+
+  httpClient?: HTTPClient;
+  /**
+   * Allows overriding the default server used by the SDK
+   */
+  serverIdx?: number | undefined;
+  /**
+   * Allows overriding the default server URL used by the SDK
+   */
+  serverURL?: string | undefined;
+  /**
+   * Allows overriding the default user agent used by the SDK
+   */
+  userAgent?: string | undefined;
+  /**
+   * Allows overriding the default retry config used by the SDK
+   */
+  retryConfig?: RetryConfig;
+  timeoutMs?: number;
+  debugLogger?: Logger;
+};
+
+export function serverURLFromOptions(options: SDKOptions): URL | null {
+  let serverURL = options.serverURL;
+
+  const params: Params = {};
+
+  if (!serverURL) {
+    const serverIdx = options.serverIdx ?? 0;
+    if (serverIdx < 0 || serverIdx >= ServerList.length) {
+      throw new Error(`Invalid server index ${serverIdx}`);
+    }
+    serverURL = ServerList[serverIdx] || "";
+  }
+
+  const u = pathToFunc(serverURL)(params);
+  return new URL(u);
+}
+
+export const SDK_METADATA = {
+  language: "typescript",
+  openapiDocVersion: "2.0.0",
+  sdkVersion: "2.0.0-alpha.10",
+  genVersion: "2.667.0",
+  userAgent: "speakeasy-sdk/typescript 2.0.0-alpha.10 2.667.0 2.0.0 @unkey/api",
+} as const;

package/src/lib/dlv.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/*
+MIT License
+
+Copyright (c) 2024 Jason Miller <jason@developit.ca> (http://jasonformat.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+/**
+ * @param obj The object to walk
+ * @param key The key path to walk the object with
+ * @param def A default value to return if the result is undefined
+ *
+ * @example
+ * dlv(obj, "a.b.c.d")
+ * @example
+ * dlv(object, ["a", "b", "c", "d"])
+ * @example
+ * dlv(object, "foo.bar.baz", "Hello, default value!")
+ */
+export function dlv<T = any>(
+  obj: any,
+  key: string | string[],
+  def?: T,
+  p?: number,
+  undef?: never,
+): T | undefined {
+  key = Array.isArray(key) ? key : key.split(".");
+  for (p = 0; p < key.length; p++) {
+    const k = key[p];
+    obj = k != null && obj ? obj[k] : undef;
+  }
+  return obj === undef ? def : obj;
+}