cloudflare/resources/api-gateway/user-schemas/user-schemas.mjs

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import * as HostsAPI from "./hosts.mjs";
import { BaseHosts, Hosts, } from "./hosts.mjs";
import * as OperationsAPI from "./operations.mjs";
import { BaseOperations, Operations, } from "./operations.mjs";
import { V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { multipartFormRequestOptions } from "../../../internal/uploads.mjs";
import { path } from "../../../internal/utils/path.mjs";
/**
 * @deprecated Please use the [Schema Validation](https://developers.cloudflare.com/api/resources/schema_validation/) APIs instead
 */
export var BaseUserSchemas = /* @__PURE__ */ (() => {
    /**
     * @deprecated Please use the [Schema Validation](https://developers.cloudflare.com/api/resources/schema_validation/) APIs instead
     */
    class BaseUserSchemas extends APIResource {
        /**
         * Uploads an OpenAPI schema that defines expected request formats for API
         * endpoints. Deprecated; use `/zones/{zone_id}/schema_validation/schemas` instead.
         *
         * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
         */
        create(params, options) {
            const { zone_id, ...body } = params;
            return this._client.post(path `/zones/${zone_id}/api_gateway/user_schemas`, multipartFormRequestOptions({ body, ...options }, this._client))._thenUnwrap((obj) => obj.result);
        }
        /**
         * Lists all OpenAPI schemas uploaded to API Shield for the zone, including their
         * validation status and associated operations. Deprecated; use
         * `/zones/{zone_id}/schema_validation/schemas` instead.
         *
         * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
         */
        list(params, options) {
            const { zone_id, ...query } = params;
            return this._client.getAPIList(path `/zones/${zone_id}/api_gateway/user_schemas`, (V4PagePaginationArray), { query, ...options });
        }
        /**
         * Permanently removes an uploaded OpenAPI schema from API Shield schema
         * validation. Operations using this schema will lose their validation rules.
         * Deprecated; use `/zones/{zone_id}/schema_validation/schemas/{schema_id}`
         * instead.
         *
         * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
         */
        delete(schemaID, params, options) {
            const { zone_id } = params;
            return this._client.delete(path `/zones/${zone_id}/api_gateway/user_schemas/${schemaID}`, options);
        }
        /**
         * Activates schema validation for an uploaded OpenAPI schema. Requests to matching
         * endpoints will be validated against the schema definitions. Deprecated; use
         * `/zones/{zone_id}/schema_validation/schemas/{schema_id}` instead.
         *
         * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
         */
        edit(schemaID, params, options) {
            const { zone_id, ...body } = params;
            return this._client.patch(path `/zones/${zone_id}/api_gateway/user_schemas/${schemaID}`, {
                body,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Gets detailed information about a specific uploaded OpenAPI schema, including
         * its contents and validation configuration. Deprecated; use
         * `/zones/{zone_id}/schema_validation/schemas/{schema_id}` instead.
         *
         * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
         */
        get(schemaID, params, options) {
            const { zone_id, ...query } = params;
            return this._client.get(path `/zones/${zone_id}/api_gateway/user_schemas/${schemaID}`, {
                query,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
    }
    BaseUserSchemas._key = Object.freeze([
        'apiGateway',
        'userSchemas',
    ]);
    return BaseUserSchemas;
})();
/**
 * @deprecated Please use the [Schema Validation](https://developers.cloudflare.com/api/resources/schema_validation/) APIs instead
 */
export var UserSchemas = /* @__PURE__ */ (() => {
    /**
     * @deprecated Please use the [Schema Validation](https://developers.cloudflare.com/api/resources/schema_validation/) APIs instead
     */
    class UserSchemas extends BaseUserSchemas {
        constructor() {
            super(...arguments);
            this.operations = new OperationsAPI.Operations(this._client);
            this.hosts = new HostsAPI.Hosts(this._client);
        }
    }
    UserSchemas.Operations = Operations;
    UserSchemas.BaseOperations = BaseOperations;
    UserSchemas.Hosts = Hosts;
    UserSchemas.BaseHosts = BaseHosts;
    return UserSchemas;
})();
//# sourceMappingURL=user-schemas.mjs.map