@seamapi/blueprint/lib/openapi/schemas.d.ts

Build tools for the Seam API using this blueprint.

import { z } from 'zod';
export declare const ParameterSchema: z.ZodObject<{
    name: z.ZodString;
    in: z.ZodEnum<["query", "header", "path", "cookie"]>;
    description: z.ZodDefault<z.ZodString>;
    required: z.ZodDefault<z.ZodBoolean>;
    schema: z.ZodOptional<z.ZodObject<{
        type: z.ZodString;
        format: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        type: string;
        format?: string | undefined;
    }, {
        type: string;
        format?: string | undefined;
    }>>;
    deprecated: z.ZodDefault<z.ZodBoolean>;
    'x-undocumented': z.ZodDefault<z.ZodString>;
    'x-deprecated': z.ZodDefault<z.ZodString>;
    'x-draft': z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    description: string;
    required: boolean;
    deprecated: boolean;
    'x-undocumented': string;
    'x-deprecated': string;
    'x-draft': string;
    schema?: {
        type: string;
        format?: string | undefined;
    } | undefined;
}, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    description?: string | undefined;
    required?: boolean | undefined;
    schema?: {
        type: string;
        format?: string | undefined;
    } | undefined;
    deprecated?: boolean | undefined;
    'x-undocumented'?: string | undefined;
    'x-deprecated'?: string | undefined;
    'x-draft'?: string | undefined;
}>;
export declare const AuthMethodSchema: z.ZodCatch<z.ZodEnum<["api_key", "client_session", "client_session_with_customer", "console_session_token_with_workspace", "console_session_token_without_workspace", "pat_with_workspace", "pat_without_workspace", "publishable_key", "unknown"]>>;
export declare const OpenapiOperationSchema: z.ZodObject<{
    operationId: z.ZodString;
    summary: z.ZodOptional<z.ZodString>;
    description: z.ZodDefault<z.ZodString>;
    parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
        name: z.ZodString;
        in: z.ZodEnum<["query", "header", "path", "cookie"]>;
        description: z.ZodDefault<z.ZodString>;
        required: z.ZodDefault<z.ZodBoolean>;
        schema: z.ZodOptional<z.ZodObject<{
            type: z.ZodString;
            format: z.ZodOptional<z.ZodString>;
        }, "strip", z.ZodTypeAny, {
            type: string;
            format?: string | undefined;
        }, {
            type: string;
            format?: string | undefined;
        }>>;
        deprecated: z.ZodDefault<z.ZodBoolean>;
        'x-undocumented': z.ZodDefault<z.ZodString>;
        'x-deprecated': z.ZodDefault<z.ZodString>;
        'x-draft': z.ZodDefault<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        name: string;
        in: "path" | "query" | "header" | "cookie";
        description: string;
        required: boolean;
        deprecated: boolean;
        'x-undocumented': string;
        'x-deprecated': string;
        'x-draft': string;
        schema?: {
            type: string;
            format?: string | undefined;
        } | undefined;
    }, {
        name: string;
        in: "path" | "query" | "header" | "cookie";
        description?: string | undefined;
        required?: boolean | undefined;
        schema?: {
            type: string;
            format?: string | undefined;
        } | undefined;
        deprecated?: boolean | undefined;
        'x-undocumented'?: string | undefined;
        'x-deprecated'?: string | undefined;
        'x-draft'?: string | undefined;
    }>, "many">>;
    requestBody: z.ZodOptional<z.ZodObject<{
        content: z.ZodRecord<z.ZodString, z.ZodObject<{
            schema: z.ZodObject<{
                $ref: z.ZodOptional<z.ZodString>;
                type: z.ZodOptional<z.ZodString>;
            }, "strip", z.ZodTypeAny, {
                type?: string | undefined;
                $ref?: string | undefined;
            }, {
                type?: string | undefined;
                $ref?: string | undefined;
            }>;
        }, "strip", z.ZodTypeAny, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }>>;
    }, "strip", z.ZodTypeAny, {
        content: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }>;
    }, {
        content: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }>;
    }>>;
    responses: z.ZodRecord<z.ZodString, z.ZodObject<{
        description: z.ZodString;
        content: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
            schema: z.ZodObject<{
                $ref: z.ZodOptional<z.ZodString>;
                type: z.ZodOptional<z.ZodString>;
                items: z.ZodOptional<z.ZodObject<{
                    $ref: z.ZodString;
                }, "strip", z.ZodTypeAny, {
                    $ref: string;
                }, {
                    $ref: string;
                }>>;
            }, "strip", z.ZodTypeAny, {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            }, {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            }>;
        }, "strip", z.ZodTypeAny, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }>>>;
    }, "strip", z.ZodTypeAny, {
        description: string;
        content?: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }> | undefined;
    }, {
        description: string;
        content?: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }> | undefined;
    }>>;
    security: z.ZodDefault<z.ZodArray<z.ZodRecord<z.ZodPipeline<z.ZodString, z.ZodCatch<z.ZodEnum<["api_key", "client_session", "client_session_with_customer", "console_session_token_with_workspace", "console_session_token_without_workspace", "pat_with_workspace", "pat_without_workspace", "publishable_key", "unknown"]>>>, z.ZodArray<z.ZodNever, "many">>, "many">>;
    deprecated: z.ZodDefault<z.ZodBoolean>;
    'x-response-key': z.ZodOptional<z.ZodNullable<z.ZodString>>;
    'x-batch-keys': z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
    'x-title': z.ZodDefault<z.ZodString>;
    'x-undocumented': z.ZodDefault<z.ZodString>;
    'x-deprecated': z.ZodDefault<z.ZodString>;
    'x-draft': z.ZodDefault<z.ZodString>;
    'x-action-attempt-type': z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    description: string;
    deprecated: boolean;
    'x-undocumented': string;
    'x-deprecated': string;
    'x-draft': string;
    operationId: string;
    responses: Record<string, {
        description: string;
        content?: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }> | undefined;
    }>;
    security: Partial<Record<"unknown" | "api_key" | "client_session" | "client_session_with_customer" | "console_session_token_with_workspace" | "console_session_token_without_workspace" | "pat_with_workspace" | "pat_without_workspace" | "publishable_key", never[]>>[];
    'x-title': string;
    summary?: string | undefined;
    parameters?: {
        name: string;
        in: "path" | "query" | "header" | "cookie";
        description: string;
        required: boolean;
        deprecated: boolean;
        'x-undocumented': string;
        'x-deprecated': string;
        'x-draft': string;
        schema?: {
            type: string;
            format?: string | undefined;
        } | undefined;
    }[] | undefined;
    requestBody?: {
        content: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }>;
    } | undefined;
    'x-response-key'?: string | null | undefined;
    'x-batch-keys'?: string[] | undefined;
    'x-action-attempt-type'?: string | undefined;
}, {
    operationId: string;
    responses: Record<string, {
        description: string;
        content?: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
                items?: {
                    $ref: string;
                } | undefined;
            };
        }> | undefined;
    }>;
    description?: string | undefined;
    deprecated?: boolean | undefined;
    'x-undocumented'?: string | undefined;
    'x-deprecated'?: string | undefined;
    'x-draft'?: string | undefined;
    summary?: string | undefined;
    parameters?: {
        name: string;
        in: "path" | "query" | "header" | "cookie";
        description?: string | undefined;
        required?: boolean | undefined;
        schema?: {
            type: string;
            format?: string | undefined;
        } | undefined;
        deprecated?: boolean | undefined;
        'x-undocumented'?: string | undefined;
        'x-deprecated'?: string | undefined;
        'x-draft'?: string | undefined;
    }[] | undefined;
    requestBody?: {
        content: Record<string, {
            schema: {
                type?: string | undefined;
                $ref?: string | undefined;
            };
        }>;
    } | undefined;
    security?: Record<string, never[]>[] | undefined;
    'x-response-key'?: string | null | undefined;
    'x-batch-keys'?: string[] | undefined;
    'x-title'?: string | undefined;
    'x-action-attempt-type'?: string | undefined;
}>;
export declare const EnumValueSchema: z.ZodObject<{
    description: z.ZodDefault<z.ZodString>;
    undocumented: z.ZodDefault<z.ZodString>;
    deprecated: z.ZodDefault<z.ZodString>;
    draft: z.ZodDefault<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    description: string;
    deprecated: string;
    undocumented: string;
    draft: string;
}, {
    description?: string | undefined;
    deprecated?: string | undefined;
    undocumented?: string | undefined;
    draft?: string | undefined;
}>;
export declare const PropertySchema: z.ZodSchema;
export declare const ResourceSchema: z.ZodObject<{
    type: z.ZodLiteral<"object">;
    properties: z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>;
    required: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
    description: z.ZodDefault<z.ZodString>;
    'x-route-path': z.ZodDefault<z.ZodString>;
    'x-undocumented': z.ZodDefault<z.ZodString>;
    'x-deprecated': z.ZodDefault<z.ZodString>;
    'x-draft': z.ZodDefault<z.ZodString>;
    'x-property-groups': z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
        name: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        name: string;
    }, {
        name: string;
    }>>>;
    'x-variant-groups': z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
        name: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        name: string;
    }, {
        name: string;
    }>>>;
}, "strip", z.ZodTypeAny, {
    type: "object";
    description: string;
    required: string[];
    'x-undocumented': string;
    'x-deprecated': string;
    'x-draft': string;
    'x-property-groups': Record<string, {
        name: string;
    }>;
    'x-variant-groups': Record<string, {
        name: string;
    }>;
    properties: Record<string, any>;
    'x-route-path': string;
}, {
    type: "object";
    properties: Record<string, any>;
    description?: string | undefined;
    required?: string[] | undefined;
    'x-undocumented'?: string | undefined;
    'x-deprecated'?: string | undefined;
    'x-draft'?: string | undefined;
    'x-property-groups'?: Record<string, {
        name: string;
    }> | undefined;
    'x-variant-groups'?: Record<string, {
        name: string;
    }> | undefined;
    'x-route-path'?: string | undefined;
}>;
export declare const EventResourceSchema: z.ZodObject<{
    'x-route-path': z.ZodDefault<z.ZodString>;
    discriminator: z.ZodObject<{
        propertyName: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        propertyName: string;
    }, {
        propertyName: string;
    }>;
    oneOf: z.ZodArray<z.ZodObject<{
        type: z.ZodLiteral<"object">;
        properties: z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>;
        required: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
        description: z.ZodDefault<z.ZodString>;
        'x-route-path': z.ZodDefault<z.ZodString>;
        'x-undocumented': z.ZodDefault<z.ZodString>;
        'x-deprecated': z.ZodDefault<z.ZodString>;
        'x-draft': z.ZodDefault<z.ZodString>;
        'x-property-groups': z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
            name: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            name: string;
        }, {
            name: string;
        }>>>;
        'x-variant-groups': z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
            name: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            name: string;
        }, {
            name: string;
        }>>>;
    }, "strip", z.ZodTypeAny, {
        type: "object";
        description: string;
        required: string[];
        'x-undocumented': string;
        'x-deprecated': string;
        'x-draft': string;
        'x-property-groups': Record<string, {
            name: string;
        }>;
        'x-variant-groups': Record<string, {
            name: string;
        }>;
        properties: Record<string, any>;
        'x-route-path': string;
    }, {
        type: "object";
        properties: Record<string, any>;
        description?: string | undefined;
        required?: string[] | undefined;
        'x-undocumented'?: string | undefined;
        'x-deprecated'?: string | undefined;
        'x-draft'?: string | undefined;
        'x-property-groups'?: Record<string, {
            name: string;
        }> | undefined;
        'x-variant-groups'?: Record<string, {
            name: string;
        }> | undefined;
        'x-route-path'?: string | undefined;
    }>, "many">;
}, "strip", z.ZodTypeAny, {
    oneOf: {
        type: "object";
        description: string;
        required: string[];
        'x-undocumented': string;
        'x-deprecated': string;
        'x-draft': string;
        'x-property-groups': Record<string, {
            name: string;
        }>;
        'x-variant-groups': Record<string, {
            name: string;
        }>;
        properties: Record<string, any>;
        'x-route-path': string;
    }[];
    discriminator: {
        propertyName: string;
    };
    'x-route-path': string;
}, {
    oneOf: {
        type: "object";
        properties: Record<string, any>;
        description?: string | undefined;
        required?: string[] | undefined;
        'x-undocumented'?: string | undefined;
        'x-deprecated'?: string | undefined;
        'x-draft'?: string | undefined;
        'x-property-groups'?: Record<string, {
            name: string;
        }> | undefined;
        'x-variant-groups'?: Record<string, {
            name: string;
        }> | undefined;
        'x-route-path'?: string | undefined;
    }[];
    discriminator: {
        propertyName: string;
    };
    'x-route-path'?: string | undefined;
}>;