import * as z from "zod"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { ApiStatus } from "./apistatus.js"; import { ResourceStatus } from "./resourcestatus.js"; /** * Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API. */ export declare const ApiType: { readonly Platform: "platform"; readonly Unified: "unified"; }; /** * Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API. */ export type ApiType = ClosedEnum; export type Resources = { /** * ID of the resource, typically a lowercased version of its name. */ id?: string | undefined; /** * Name of the resource (plural) */ name?: string | undefined; /** * Status of the resource. Resources with status live or beta are callable. */ status?: ResourceStatus | undefined; /** * Exclude from mapping coverage */ excludedFromCoverage?: boolean | undefined; }; export type Api = { /** * ID of the API. */ id?: string | undefined; /** * Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API. */ type?: ApiType | undefined; /** * Name of the API. */ name?: string | undefined; /** * Description of the API. */ description?: string | null | undefined; /** * Status of the API. APIs with status live or beta are callable. */ status?: ApiStatus | undefined; /** * Link to the latest OpenAPI specification of the API. */ specUrl?: string | undefined; /** * Link to the API reference of the API. */ apiReferenceUrl?: string | undefined; /** * ID of the Postman collection of the API. */ postmanCollectionId?: string | null | undefined; /** * List of categories the API belongs to. */ categories?: Array | undefined; /** * List of resources supported in this API. */ resources?: Array | undefined; /** * List of event types this API supports. */ events?: Array | undefined; }; /** @internal */ export declare const ApiType$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ApiType$outboundSchema: z.ZodNativeEnum; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace ApiType$ { /** @deprecated use `ApiType$inboundSchema` instead. */ const inboundSchema: z.ZodNativeEnum<{ readonly Platform: "platform"; readonly Unified: "unified"; }>; /** @deprecated use `ApiType$outboundSchema` instead. */ const outboundSchema: z.ZodNativeEnum<{ readonly Platform: "platform"; readonly Unified: "unified"; }>; } /** @internal */ export declare const Resources$inboundSchema: z.ZodType; /** @internal */ export type Resources$Outbound = { id?: string | undefined; name?: string | undefined; status?: string | undefined; excluded_from_coverage?: boolean | undefined; }; /** @internal */ export declare const Resources$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace Resources$ { /** @deprecated use `Resources$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `Resources$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `Resources$Outbound` instead. */ type Outbound = Resources$Outbound; } export declare function resourcesToJSON(resources: Resources): string; export declare function resourcesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const Api$inboundSchema: z.ZodType; /** @internal */ export type Api$Outbound = { id?: string | undefined; type?: string | undefined; name?: string | undefined; description?: string | null | undefined; status?: string | undefined; spec_url?: string | undefined; api_reference_url?: string | undefined; postman_collection_id?: string | null | undefined; categories?: Array | undefined; resources?: Array | undefined; events?: Array | undefined; }; /** @internal */ export declare const Api$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace Api$ { /** @deprecated use `Api$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `Api$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `Api$Outbound` instead. */ type Outbound = Api$Outbound; } export declare function apiToJSON(api: Api): string; export declare function apiFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=api.d.ts.map