@unkey/api/src/models/components/v2apiscreateapiresponsedata.ts

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

/*
 * 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 V2ApisCreateApiResponseData = {
  /**
   * The unique identifier assigned to the newly created API.
   *
   * @remarks
   * Use this ID for all subsequent operations including key creation, verification, and API management.
   * Always begins with 'api_' followed by a unique alphanumeric sequence.
   *
   * Store this ID securely as it's required when:
   * - Creating API keys within this namespace
   * - Verifying keys associated with this API
   * - Managing API settings and metadata
   * - Listing keys belonging to this API
   *
   * This identifier is permanent and cannot be changed after creation.
   */
  apiId: string;
};

/** @internal */
export const V2ApisCreateApiResponseData$inboundSchema: z.ZodType<
  V2ApisCreateApiResponseData,
  z.ZodTypeDef,
  unknown
> = z.object({
  apiId: z.string(),
});

export function v2ApisCreateApiResponseDataFromJSON(
  jsonString: string,
): SafeParseResult<V2ApisCreateApiResponseData, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => V2ApisCreateApiResponseData$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'V2ApisCreateApiResponseData' from JSON`,
  );
}