import { type XInternal } from '../../../schemas/extensions/document/x-internal.js';
import { type XScalarIgnore } from '../../../schemas/extensions/document/x-scalar-ignore.js';
import type { ExampleObject } from '../../../schemas/v3.1/strict/example.js';
import type { MediaTypeObject } from '../../../schemas/v3.1/strict/media-type.js';
import { type ReferenceType } from '../../../schemas/v3.1/strict/reference.js';
import type { SchemaObject } from '../../../schemas/v3.1/strict/schema.js';
type ParameterObjectBase = {
    /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
     *    - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
     *    - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
     *    - For all other cases, the name corresponds to the parameter name used by the in field. */
    name: string;
    /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
    in: 'query' | 'header' | 'path' | 'cookie';
    /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
    description?: string;
    /** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
    required?: boolean;
    /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
    deprecated?: boolean;
    /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
    allowEmptyValue?: boolean;
    /** Determines whether the parameter value SHOULD allow reserved characters without percent-encoding. This field is valid only for query parameters. Default value is false. */
    allowReserved?: boolean;
    /**
     * OpenAPI extension used by the api-client application to determine if a parameter is considered global in scope
     * for the entire workspace. When set, this parameter will be injected into every request automatically.
     */
    'x-global'?: boolean;
} & XInternal & XScalarIgnore;
export type ParameterWithSchemaObject = ParameterObjectBase & {
    /** Describes how the header value will be serialized. The default (and only legal value for headers) is "simple". */
    style?: string;
    /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */
    explode?: boolean;
    /** The schema defining the type used for the header. */
    schema?: ReferenceType<SchemaObject>;
    /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
    example?: any;
    /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
    examples?: Record<string, ReferenceType<ExampleObject>>;
};
export type ParameterWithContentObject = ParameterObjectBase & {
    content?: Record<string, MediaTypeObject>;
};
/**
 * Describes a single operation parameter.
 *
 * A unique parameter is defined by a combination of a name and location.
 *
 * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.
 */
export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
    /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
     *    - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
     *    - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
     *    - For all other cases, the name corresponds to the parameter name used by the in field. */
    name: import("@scalar/typebox").TString;
    /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
    in: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"query">, import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"path">, import("@scalar/typebox").TLiteral<"cookie">]>;
    /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
    description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
    /** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
    required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
    deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
    allowEmptyValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570, which allows RFC3986's reserved character set, as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including % outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are not allowed in the query string ([, ], #), or have a special meaning in application/x-www-form-urlencoded (-, &, +); see Appendices C and E for details. This field only applies to parameters with an in value of query. The default value is false. */
    allowReserved: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-global': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>]>, import("@scalar/typebox").TObject<{
    /** Describes how the header value will be serialized. The default (and only legal value for headers) is "simple". */
    style: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
    /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */
    explode: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** The schema defining the type used for the header. */
    schema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
        $ref: import("@scalar/typebox").TString;
        summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
        description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
    }>, import("@scalar/typebox").TObject<{
        $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
        $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    }>]>, import("@scalar/typebox").TObject<{
        '$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"SchemaObject">>;
    }>]>]>>;
    /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
    example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TAny>;
    /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
    examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"ExampleObject">, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
        $ref: import("@scalar/typebox").TString;
        summary: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
        description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
    }>, import("@scalar/typebox").TObject<{
        $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
        $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    }>]>, import("@scalar/typebox").TObject<{
        '$ref-value': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExampleObject">>;
    }>]>]>>>;
}>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
    /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
     *    - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
     *    - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
     *    - For all other cases, the name corresponds to the parameter name used by the in field. */
    name: import("@scalar/typebox").TString;
    /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
    in: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"query">, import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"path">, import("@scalar/typebox").TLiteral<"cookie">]>;
    /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
    description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
    /** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
    required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
    deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
    allowEmptyValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
    /** When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570, which allows RFC3986's reserved character set, as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including % outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are not allowed in the query string ([, ], #), or have a special meaning in application/x-www-form-urlencoded (-, &, +); see Appendices C and E for details. This field only applies to parameters with an in value of query. The default value is false. */
    allowReserved: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-global': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>, import("@scalar/typebox").TObject<{
    'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
}>]>, import("@scalar/typebox").TObject<{
    content: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>>;
}>]>]>;
/**
 * Describes a single operation parameter.
 *
 * A unique parameter is defined by a combination of a name and location.
 *
 * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.
 */
export type ParameterObject = ParameterWithSchemaObject | ParameterWithContentObject;
export {};
//# sourceMappingURL=parameter.d.ts.map