@takeshape/schema 8.45.2 → 8.48.1

package/lib/project-schema/v3.12.0.d.ts

@@ -0,0 +1,1215 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "args".
+ */
+export declare type ArgsV3_12_0 = string | ObjectSchemaV3_12_0;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "objectSchema".
+ */
+export declare type ObjectSchemaV3_12_0 = PropertySchemaV3_12_0 & {
+    type: 'object';
+    properties: {
+        [k: string]: PropertySchemaV3_12_0;
+    };
+};
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "nonNegativeInteger".
+ */
+export declare type NonNegativeIntegerV3_12_0 = number;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "nonNegativeIntegerDefault0".
+ */
+export declare type NonNegativeIntegerDefault0V3_12_0 = NonNegativeIntegerV3_12_0;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "stringArray".
+ */
+export declare type StringArrayV3_12_0 = string[];
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "simpleTypes".
+ */
+export declare type SimpleTypesV3_12_0 = 'array' | 'boolean' | 'integer' | 'null' | 'number' | 'object' | 'string';
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "schemaArray".
+ */
+export declare type SchemaArrayV3_12_0 = PropertySchemaV3_12_0[];
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "fieldMapping".
+ */
+export declare type FieldMappingV3_12_0 = MappingStringV3_12_0 | MappingStringV3_12_0[];
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "mappingString".
+ */
+export declare type MappingStringV3_12_0 = string;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "resolver".
+ */
+export declare type ResolverV3_12_0 = BasicResolverV3_12_0 | ComposeResolverV3_12_0;
+/**
+ * A single resolver, can be composed with the ComposeResolver.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "basicResolver".
+ */
+export declare type BasicResolverV3_12_0 = UtilResolverV3_12_0 | TakeshapeResolverV3_12_0 | InternalTakeshapeResolverV3_12_0 | GraphqlResolverV3_12_0 | RestResolverV3_12_0 | AwsLambdaResolverV3_12_0;
+/**
+ * Name of the resolver function.
+ */
+export declare type UtilResolverNameV3_12_0 = 'debug:noop' | 'util:wrap';
+/**
+ * An object describing an operation to generate a parameter.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOp".
+ */
+export declare type ParameterOpV3_12_0 = ParameterOpNestedV3_12_0 | ParameterOpValueV3_12_0 | ParameterOpMappingV3_12_0 | ParameterOpOpV3_12_0;
+/**
+ * A tuple with a string directive name, and options to pass to the directive
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "directiveConfigItem".
+ */
+export declare type DirectiveConfigItemV3_12_0 = [DirectiveNameV3_12_0, DirectiveOptionsV3_12_0];
+export declare type DirectiveNameV3_12_0 = string;
+/**
+ * An array of individual directive config items to process in order
+ *
+ * This interface was referenced by `DirectiveMappingMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "directiveConfig".
+ */
+export declare type DirectiveConfigV3_12_0 = DirectiveConfigItemV3_12_0[];
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOpList".
+ */
+export declare type ParameterOpListV3_12_0 = ParameterOpV3_12_0[];
+/**
+ * Maps a query's input args to the input expected by the service's endpoint.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "argsMapping".
+ */
+export declare type ArgsMappingV3_12_0 = DirectiveMappingMapV3_12_0 | DirectiveConfigV3_12_0;
+/**
+ * Maps a service endpoint's response results to the expected shape of the query's response.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "resultsMapping".
+ */
+export declare type ResultsMappingV3_12_0 = DirectiveMappingMapV3_12_0 | DirectiveConfigV3_12_0;
+/**
+ * Name of the resolver function.
+ */
+export declare type TakeshapeResolverNameV3_12_0 = 'takeshape:get' | 'takeshape:create' | 'takeshape:update' | 'takeshape:delete' | 'takeshape:duplicate' | 'takeshape:find' | 'takeshape:queryApiIndex';
+/**
+ * Name of the resolver function.
+ */
+export declare type InternalTakeshapeResolverNameV3_12_0 = 'takeshape:getRelationship' | 'takeshape:taxonomySuggest' | 'takeshape:list' | 'takeshape:search';
+/**
+ * Name of the resolver function.
+ */
+export declare type GraphqlResolverNameV3_12_0 = 'graphql:query' | 'graphql:mutation';
+/**
+ * Name of the resolver function.
+ */
+export declare type RestResolverNameV3_12_0 = 'rest:get' | 'rest:head' | 'rest:post' | 'rest:put' | 'rest:patch' | 'rest:delete';
+/**
+ * A tuple with a string key and a directive config to evaluate
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "directiveMappingArrayItem".
+ */
+export declare type DirectiveMappingArrayItemV3_12_0 = [string, DirectiveConfigV3_12_0];
+/**
+ * An array of key / value or directive config tuples
+ */
+export declare type SearchParamsMappingV3_12_0 = DirectiveMappingArrayItemV3_12_0[];
+/**
+ * Name of the resolver function.
+ */
+export declare type AwsLambdaResolverNameV3_12_0 = 'awsLambda:invoke';
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "ref".
+ */
+export declare type RefV3_12_0 = string;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "returnShape".
+ */
+export declare type ReturnShapeV3_12_0 = string | ReturnShapeArraySchemaV3_12_0;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "returnShapeArraySchema".
+ */
+export declare type ReturnShapeArraySchemaV3_12_0 = PropertySchemaV3_12_0 & {
+    type: 'array';
+    items: RefSchemaV3_12_0 | {
+        type: 'boolean' | 'integer' | 'number' | 'string';
+        [k: string]: any;
+    };
+};
+export declare type ModelTypeV3_12_0 = 'single' | 'multiple' | 'taxonomy';
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeSchema".
+ */
+export declare type ShapeSchemaV3_12_0 = ShapeSchemaAllOfV3_12_0 | ShapeSchemaOneOfV3_12_0 | ShapeSchemaEnumV3_12_0 | ObjectSchemaV3_12_0;
+/**
+ * Human-readable id for use in the UI
+ */
+export declare type WorkflowNameV3_12_0 = string;
+/**
+ * machine-readable slug
+ */
+export declare type NameV3_12_0 = string;
+/**
+ * Human-readable id for use in the UI
+ */
+export declare type TitleV3_12_0 = string;
+export declare type DescriptionV3_12_0 = string;
+/**
+ * Hex color code
+ */
+export declare type ColorV3_12_0 = string;
+/**
+ * Value to indicate whether items in the state should be returned in list queries
+ */
+export declare type LiveV3_12_0 = boolean;
+/**
+ * machine-readable id
+ */
+export declare type KeyV3_12_0 = string;
+export declare type StepsV3_12_0 = WorkflowStepV3_12_0[];
+/**
+ * The general type of this service, specifying how and where it will be utilized.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "serviceType".
+ */
+export declare type ServiceTypeV3_12_0 = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "allOfSchema".
+ */
+export declare type AllOfSchemaV3_12_0 = PropertySchemaV3_12_0 & {
+    allOf: (RefSchemaV3_12_0 | RefSchemaLegacyV3_12_0 | ObjectSchemaV3_12_0)[];
+};
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "oneOfSchema".
+ */
+export declare type OneOfSchemaV3_12_0 = PropertySchemaV3_12_0 & {
+    oneOf: (RefSchemaV3_12_0 | RefSchemaLegacyV3_12_0 | ObjectSchemaV3_12_0)[];
+};
+/**
+ * Options to be passed to the serialization routine.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeOptions".
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "^[^\n\r]*$".
+ */
+export declare type ParameterSerializeOptionsV3_12_0 = ParameterSerializeStyleOptionsV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+/**
+ * An array of key / value or directive config tuples
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "directiveMappingArray".
+ */
+export declare type DirectiveMappingArrayV3_12_0 = DirectiveMappingArrayItemV3_12_0[];
+/**
+ * An array of key / value or directive config tuples
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "searchParamsMapping".
+ */
+export declare type SearchParamsMappingV3_12_01 = DirectiveMappingArrayItemV3_12_0[];
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeWithObjectSchema".
+ */
+export declare type ShapeWithObjectSchemaV3_12_0 = ShapeV3_12_0 & {
+    schema: ObjectSchemaV3_12_0;
+};
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "serviceAuthentication".
+ */
+export declare type ServiceAuthenticationV3_12_0 = OAuth2AuthenticationV3_12_0 | OAuth2BearerAuthenticationV3_12_0 | BearerAuthenticationV3_12_0 | BasicAuthenticationV3_12_0 | SearchParamsAuthenticationV3_12_0 | AWSAuthenticationV3_12_0 | CustomAuthenticationV3_12_0;
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "anyServiceConfig".
+ */
+export declare type AnyServiceConfigV3_12_0 = StoredServiceConfigV3_12_0 | ServiceConfigV3_12_0;
+export interface ProjectSchemaV3_12_0 {
+    $schema?: string;
+    /**
+     * This is the revision number of your schema. Every time your project schema is updated, this value should be incremented.
+     */
+    version: number;
+    /**
+     * The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints.
+     */
+    apiVersion: string;
+    /**
+     * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
+     */
+    schemaVersion: '3.12.0';
+    /**
+     * The ID of the TakeShape project this schema belongs to.
+     */
+    projectId: string;
+    /**
+     * The ID of the TakeShape user who created the schema.
+     */
+    author?: string;
+    /**
+     * The date the schema was created
+     */
+    created: string;
+    /**
+     * The date the schema was last updated
+     */
+    updated: string;
+    deactivated?: number;
+    /**
+     * The locale that should be preferred when creating new Shape items. This must be an entry in the locales array.
+     */
+    defaultLocale: string;
+    locales: string[];
+    queries: QueryMapV3_12_0;
+    mutations: QueryMapV3_12_0;
+    shapes: ShapeMapV3_12_0;
+    indexedShapes?: IndexedShapeMapV3_12_0;
+    forms?: FormMapV3_12_0;
+    workflows: WorkflowMapV3_12_0;
+    dataKey: string;
+    services?: StoredServiceMapV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "queryMap".
+ */
+export interface QueryMapV3_12_0 {
+    [k: string]: QueryV3_12_0;
+}
+/**
+ * This interface was referenced by `QueryMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "query".
+ */
+export interface QueryV3_12_0 {
+    args?: ArgsV3_12_0;
+    resolver: ResolverV3_12_0;
+    shape: ReturnShapeV3_12_0;
+    /**
+     * Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs.
+     */
+    description?: string;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "propertySchema".
+ */
+export interface PropertySchemaV3_12_0 {
+    $ref?: string;
+    title?: string;
+    description?: string;
+    default?: any;
+    readOnly?: boolean;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: number;
+    minimum?: number;
+    exclusiveMinimum?: number;
+    maxLength?: NonNegativeIntegerV3_12_0;
+    minLength?: NonNegativeIntegerDefault0V3_12_0;
+    pattern?: string;
+    additionalItems?: PropertySchemaV3_12_0;
+    items?: PropertySchemaV3_12_0;
+    maxItems?: NonNegativeIntegerV3_12_0;
+    minItems?: NonNegativeIntegerDefault0V3_12_0;
+    uniqueItems?: boolean;
+    contains?: PropertySchemaV3_12_0;
+    maxProperties?: NonNegativeIntegerV3_12_0;
+    minProperties?: NonNegativeIntegerDefault0V3_12_0;
+    required?: StringArrayV3_12_0;
+    additionalProperties?: PropertySchemaV3_12_0 | false;
+    definitions?: {
+        [k: string]: PropertySchemaV3_12_0;
+    };
+    properties?: {
+        [k: string]: PropertySchemaV3_12_0;
+    };
+    const?: any;
+    enum?: any[];
+    type?: SimpleTypesV3_12_0 | SimpleTypesV3_12_0[];
+    format?: string;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    allOf?: SchemaArrayV3_12_0;
+    oneOf?: SchemaArrayV3_12_0;
+    '@relationship'?: RelationshipV3_12_0;
+    '@syncLocaleStructure'?: boolean;
+    '@sensitive'?: boolean;
+    '@draftjs'?: boolean;
+    '@l10n'?: boolean;
+    '@key'?: string;
+    '@workflow'?: string;
+    '@mapping'?: FieldMappingV3_12_0;
+    '@tag'?: string;
+    '@tags'?: string[];
+    '@deprecationReason'?: string;
+    '@user'?: boolean;
+    '@args'?: ArgsV3_12_0;
+    '@resolver'?: ResolverV3_12_0;
+    '@ref'?: RefV3_12_0;
+    '@derivedFrom'?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "relationship".
+ */
+export interface RelationshipV3_12_0 {
+    shapeIds: string[];
+    type?: string;
+    relatedName?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "utilResolver".
+ */
+export interface UtilResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: UtilResolverNameV3_12_0;
+    /**
+     * Configuration for a service to use with this resolver.
+     */
+    service: string;
+    options?: UtilResolverOptionsV3_12_0;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+    argsMapping?: ArgsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+}
+export interface UtilResolverOptionsV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForJson".
+ */
+export interface ParameterConfigForJsonV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+}
+/**
+ * An object describing an operation to generate a parameter, using a nested OpList.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOpNested".
+ */
+export interface ParameterOpNestedV3_12_0 {
+    /**
+     * A path to the parameter for this operation.
+     */
+    path: string;
+    /**
+     * A mode for this parameter's operation.
+     */
+    op?: 'set' | 'concat' | 'extend' | 'remove';
+    ops: ParameterOpListV3_12_0;
+}
+/**
+ * An object describing an operation to generate a parameter using a value.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOpValue".
+ */
+export interface ParameterOpValueV3_12_0 {
+    /**
+     * A path to the parameter for this operation.
+     */
+    path: string;
+    /**
+     * A mode for this parameter's operation.
+     */
+    op?: 'set' | 'concat' | 'extend' | 'remove';
+    /**
+     * A value to set directly at this path.
+     */
+    value: number | string | boolean | {
+        [k: string]: any;
+    } | any[] | null;
+}
+/**
+ * An object describing an operation to generate a parameter using a mapping.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOpMapping".
+ */
+export interface ParameterOpMappingV3_12_0 {
+    /**
+     * A path to the parameter for this operation.
+     */
+    path: string;
+    /**
+     * A mode for this parameter's operation.
+     */
+    op?: 'set' | 'concat' | 'extend' | 'remove';
+    /**
+     * Either a valid JSONPath or a directive pipeline to evaluate against the query context.
+     */
+    mapping: string | DirectiveConfigV3_12_0;
+}
+export interface DirectiveOptionsV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * An object describing an operation to generate a parameter using a mapping.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterOpOp".
+ */
+export interface ParameterOpOpV3_12_0 {
+    /**
+     * A path to the parameter for this operation.
+     */
+    path: string;
+    /**
+     * A mode for this parameter's operation.
+     */
+    op: 'set' | 'concat' | 'extend' | 'remove';
+}
+/**
+ * An map of object keys / key paths to directive configs
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "directiveMappingMap".
+ */
+export interface DirectiveMappingMapV3_12_0 {
+    [k: string]: DirectiveConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "takeshapeResolver".
+ */
+export interface TakeshapeResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: TakeshapeResolverNameV3_12_0;
+    /**
+     * Internal service identifier.
+     */
+    service: 'takeshape:local';
+    options?: TakeshapeResolverOptionsV3_12_0;
+    argsMapping?: ArgsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+    /**
+     * A Shape name for the resolver to use.
+     */
+    shapeName: string;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+}
+export interface TakeshapeResolverOptionsV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "internalTakeshapeResolver".
+ */
+export interface InternalTakeshapeResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: InternalTakeshapeResolverNameV3_12_0;
+    /**
+     * Internal service identifier.
+     */
+    service: 'takeshape:local';
+    options?: TakeshapeResolverOptionsV3_12_01;
+    /**
+     * An optional Shape name for the resolver.
+     */
+    shapeName?: string;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+    argsMapping?: ArgsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+}
+export interface TakeshapeResolverOptionsV3_12_01 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "graphqlResolver".
+ */
+export interface GraphqlResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: GraphqlResolverNameV3_12_0;
+    /**
+     * Configuration for a service to use with this resolver.
+     */
+    service: string;
+    argsMapping?: ArgsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+    options?: GraphqlResolverOptionsV3_12_0;
+    /**
+     * A fieldname to use in queries.
+     */
+    fieldName: string;
+    headers?: ParameterConfigForHeadersV3_12_0;
+    searchParams?: ParameterConfigForSearchParamsV3_12_0;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+}
+export interface GraphqlResolverOptionsV3_12_0 {
+    selectionSet?: string;
+    unboxParentSelectionSet?: boolean;
+    ignoreErrors?: boolean;
+    skipWhenMissingArgs?: boolean;
+    ttl?: number;
+    timeout?: number;
+    retry?: number | {
+        [k: string]: any;
+    };
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForHeaders".
+ */
+export interface ParameterConfigForHeadersV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize?: ParameterSerializeConfigForHeadersV3_12_0;
+}
+/**
+ * Top-level paths to use headers serialization options for.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeConfigForHeaders".
+ */
+export interface ParameterSerializeConfigForHeadersV3_12_0 {
+    defaults?: ParameterSerializeStyleOptionsForHeadersV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    paths?: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[^\n\r]*$".
+         */
+        [k: string]: ParameterSerializeStyleOptionsForHeadersV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    };
+}
+/**
+ * Options to be passed to the serialization routine.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeStyleOptionsForHeaders".
+ */
+export interface ParameterSerializeStyleOptionsForHeadersV3_12_0 {
+    style: 'simple' | 'none';
+    explode?: boolean;
+}
+/**
+ * Options to be passed to the serialization routine.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeContentOptions".
+ */
+export interface ParameterSerializeContentOptionsV3_12_0 {
+    contentType: string;
+    /**
+     * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
+     */
+    allowReserved?: boolean;
+    skipEncoding?: boolean;
+    /**
+     * Options to be passed directly to the content serializer library. Valid options depend upon your contentType.
+     */
+    options?: {
+        [k: string]: any;
+    };
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForSearchParams".
+ */
+export interface ParameterConfigForSearchParamsV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize?: ParameterSerializeConfigForSearchParamsV3_12_0;
+}
+/**
+ * Top-level paths to use search params serialization options for.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeConfigForSearchParams".
+ */
+export interface ParameterSerializeConfigForSearchParamsV3_12_0 {
+    defaults?: ParameterSerializeStyleOptionsForSearchParamsV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    paths?: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[^\n\r]*$".
+         */
+        [k: string]: ParameterSerializeStyleOptionsForSearchParamsV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    };
+}
+/**
+ * Options to be passed to the serialization routine.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeStyleOptionsForSearchParams".
+ */
+export interface ParameterSerializeStyleOptionsForSearchParamsV3_12_0 {
+    style: 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
+    explode?: boolean;
+    allowEmptyValue?: boolean;
+    /**
+     * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
+     */
+    allowReserved?: boolean;
+    skipEncoding?: boolean;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "restResolver".
+ */
+export interface RestResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: RestResolverNameV3_12_0;
+    /**
+     * Configuration for a service to use with this resolver.
+     */
+    service: string;
+    argsMapping?: ArgsMappingV3_12_0;
+    searchParamsMapping?: SearchParamsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+    options?: RestResolverOptionsV3_12_0;
+    body?: ParameterConfigForBodyV3_12_0;
+    form?: ParameterConfigForSearchParamsV3_12_0;
+    headers?: ParameterConfigForHeadersV3_12_0;
+    json?: ParameterConfigForJsonV3_12_0;
+    /**
+     * Mapping and serialization configuration for the path, or a simple string.
+     */
+    path: ParameterConfigForPathParamsV3_12_0 | string;
+    searchParams?: ParameterConfigForSearchParamsV3_12_0;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+}
+export interface RestResolverOptionsV3_12_0 {
+    trailingSlash?: boolean;
+    ttl?: number;
+    timeout?: number;
+    retry?: number | {
+        [k: string]: any;
+    };
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForBody".
+ */
+export interface ParameterConfigForBodyV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize?: ParameterSerializeConfigForBodyV3_12_0;
+}
+/**
+ * Top-level paths to use serialization options for.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeConfigForBody".
+ */
+export interface ParameterSerializeConfigForBodyV3_12_0 {
+    content?: ParameterSerializeContentOptionsV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForPathParams".
+ */
+export interface ParameterConfigForPathParamsV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize: ParameterSerializeConfigForPathParamsV3_12_0;
+}
+/**
+ * Top-level paths to use path params serialization options for.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeConfigForPathParams".
+ */
+export interface ParameterSerializeConfigForPathParamsV3_12_0 {
+    /**
+     * For generating the path using tokens frpm the ParameterOps, e.g., '/products/{productId}'
+     */
+    template: string;
+    defaults?: ParameterSerializeStyleOptionsForPathParamsV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    paths?: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[^\n\r]*$".
+         */
+        [k: string]: ParameterSerializeStyleOptionsForPathParamsV3_12_0 | ParameterSerializeContentOptionsV3_12_0;
+    };
+}
+/**
+ * Options to be passed to the serialization routine.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeStyleOptionsForPathParams".
+ */
+export interface ParameterSerializeStyleOptionsForPathParamsV3_12_0 {
+    style: 'simple' | 'label' | 'matrix' | 'none';
+    explode?: boolean;
+    allowEmptyValue?: boolean;
+    /**
+     * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
+     */
+    allowReserved?: boolean;
+    skipEncoding?: boolean;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "awsLambdaResolver".
+ */
+export interface AwsLambdaResolverV3_12_0 {
+    if?: string;
+    id?: string;
+    name: AwsLambdaResolverNameV3_12_0;
+    /**
+     * Configuration for a service to use with this resolver.
+     */
+    service: string;
+    options?: AwsLambdaResolverOptionsV3_12_0;
+    payload?: ParameterConfigForJsonV3_12_0;
+    /**
+     * Mapping configuration for the FunctionName.
+     */
+    functionName: string | ParameterConfigForAwsLambdaV3_12_0;
+    clientContext?: ParameterConfigForJsonV3_12_0;
+    args?: ParameterConfigForJsonV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+    argsMapping?: ArgsMappingV3_12_0;
+    searchParamsMapping?: SearchParamsMappingV3_12_0;
+    resultsMapping?: ResultsMappingV3_12_0;
+}
+export interface AwsLambdaResolverOptionsV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfigForAwsLambda".
+ */
+export interface ParameterConfigForAwsLambdaV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize: ParameterSerializeConfigForPathParamsV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "composeResolver".
+ */
+export interface ComposeResolverV3_12_0 {
+    compose: BasicResolverV3_12_0[];
+    resultsMapping?: DirectiveMappingMapV3_12_0 | DirectiveConfigV3_12_0;
+    results?: ParameterConfigForJsonV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "refSchema".
+ */
+export interface RefSchemaV3_12_0 {
+    '@ref': RefV3_12_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeMap".
+ */
+export interface ShapeMapV3_12_0 {
+    [k: string]: ShapeV3_12_0;
+}
+/**
+ * A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services
+ *
+ * This interface was referenced by `ShapeMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shape".
+ */
+export interface ShapeV3_12_0 {
+    /**
+     * The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations
+     */
+    name: string;
+    /**
+     * The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used  database as a stable "table name" and changing it will result in orphaning that data.
+     */
+    id: string;
+    /**
+     * The human-readable name for a Shape for use in a UI.
+     */
+    title: string;
+    description?: string;
+    /**
+     * Specifying a model type allows Shape data to be stored in TakeShape's built-in database
+     */
+    model?: {
+        type: ModelTypeV3_12_0;
+    };
+    workflow?: string;
+    schema: ShapeSchemaV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeSchemaAllOf".
+ */
+export interface ShapeSchemaAllOfV3_12_0 {
+    allOf: (RefSchemaV3_12_0 | RefSchemaLegacyV3_12_0 | ObjectSchemaV3_12_0)[];
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "refSchemaLegacy".
+ */
+export interface RefSchemaLegacyV3_12_0 {
+    $ref: RefV3_12_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeSchemaOneOf".
+ */
+export interface ShapeSchemaOneOfV3_12_0 {
+    oneOf: (RefSchemaV3_12_0 | RefSchemaLegacyV3_12_0 | ObjectSchemaV3_12_0)[];
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "shapeSchemaEnum".
+ */
+export interface ShapeSchemaEnumV3_12_0 {
+    enum: string[];
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "indexedShapeMap".
+ */
+export interface IndexedShapeMapV3_12_0 {
+    [k: string]: IndexedShapeConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `IndexedShapeMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "indexedShapeConfig".
+ */
+export interface IndexedShapeConfigV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formMap".
+ */
+export interface FormMapV3_12_0 {
+    [k: string]: FormsConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `FormMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formsConfig".
+ */
+export interface FormsConfigV3_12_0 {
+    default: FormConfigV3_12_0;
+    [k: string]: FormConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `FormsConfigV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formConfig".
+ */
+export interface FormConfigV3_12_0 {
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "workflowMap".
+ */
+export interface WorkflowMapV3_12_0 {
+    [k: string]: WorkflowV3_12_0;
+}
+/**
+ * This interface was referenced by `WorkflowMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "workflow".
+ */
+export interface WorkflowV3_12_0 {
+    /**
+     * machine-readable id
+     */
+    name: string;
+    title: WorkflowNameV3_12_0;
+    steps: StepsV3_12_0;
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "workflowStep".
+ */
+export interface WorkflowStepV3_12_0 {
+    name: NameV3_12_0;
+    title: TitleV3_12_0;
+    description?: DescriptionV3_12_0;
+    color: ColorV3_12_0;
+    live: LiveV3_12_0;
+    key: KeyV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "storedServiceMap".
+ */
+export interface StoredServiceMapV3_12_0 {
+    [k: string]: StoredServiceConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `StoredServiceMapV3_12_0`'s JSON-Schema definition
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "storedServiceConfig".
+ */
+export interface StoredServiceConfigV3_12_0 {
+    /**
+     * Machine-readable identifier, should typically be the same as the property name on the services object.
+     */
+    id: string;
+    /**
+     * Human-readable name for this service.
+     */
+    title: string;
+    /**
+     * The service provider id.
+     */
+    provider: string;
+    /**
+     * A namespace to use for the imported types tied to this service.
+     */
+    namespace?: string;
+    serviceType: ServiceTypeV3_12_0;
+    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
+    authentication?: string;
+    webhookId?: string;
+    /**
+     * Configuration options passed to and handled by the provider.
+     */
+    options?: {
+        [k: string]: any;
+    };
+}
+/**
+ * All possible options for the more specific ParameterSerializeStyleOptions types.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeStyleOptions".
+ */
+export interface ParameterSerializeStyleOptionsV3_12_0 {
+    style: 'simple' | 'label' | 'matrix' | 'form' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'none';
+    explode?: boolean;
+    allowEmptyValue?: boolean;
+    /**
+     * The allowReserved keyword specifies whether the reserved characters :/?#[]@!$&'()*+,;= in parameter values are allowed to be sent as they are.
+     */
+    allowReserved?: boolean;
+    skipEncoding?: boolean;
+}
+/**
+ * All possible options for the more specific ParameterSerializeConfig types.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterSerializeConfig".
+ */
+export interface ParameterSerializeConfigV3_12_0 {
+    content?: ParameterSerializeContentOptionsV3_12_0;
+    defaults?: ParameterSerializeOptionsV3_12_0;
+    paths?: {
+        [k: string]: ParameterSerializeOptionsV3_12_0;
+    };
+}
+/**
+ * All possible options for the more specific ParameterConfig types.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "parameterConfig".
+ */
+export interface ParameterConfigV3_12_0 {
+    ops: ParameterOpListV3_12_0;
+    serialize?: ParameterSerializeConfigV3_12_0;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formScalarConfig".
+ */
+export interface FormScalarConfigV3_12_0 {
+    widget: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formObjectConfig".
+ */
+export interface FormObjectConfigV3_12_0 {
+    widget?: string;
+    order?: string[];
+    properties?: {
+        [k: string]: FormConfigV3_12_0;
+    };
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "formArrayConfig".
+ */
+export interface FormArrayConfigV3_12_0 {
+    widget: string;
+    items: FormConfigV3_12_0;
+}
+/**
+ * For use with a custom auth handler on a service provider.
+ *
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "customAuthentication".
+ */
+export interface CustomAuthenticationV3_12_0 {
+    type: 'custom';
+    [k: string]: any;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "searchParamsAuthentication".
+ */
+export interface SearchParamsAuthenticationV3_12_0 {
+    type: 'searchParams';
+    params: {
+        name: string;
+        value: string;
+    }[];
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "bearerAuthentication".
+ */
+export interface BearerAuthenticationV3_12_0 {
+    type: 'bearer';
+    token: string;
+    prefix?: string;
+    header?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "oauth2BearerAuthentication".
+ */
+export interface OAuth2BearerAuthenticationV3_12_0 {
+    type: 'oauth2Bearer';
+    token: string;
+    prefix?: string;
+    header?: string;
+    scope?: string;
+    expiresAt?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "basicAuthentication".
+ */
+export interface BasicAuthenticationV3_12_0 {
+    type: 'basic';
+    username: string;
+    password: string;
+    useIso8859?: boolean;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "oauth2Authentication".
+ */
+export interface OAuth2AuthenticationV3_12_0 {
+    type: 'oauth2';
+    grantType: 'authorizationCode' | 'clientCredentials';
+    authorizationUrl?: string;
+    accessTokenUrl?: string;
+    clientId: string;
+    clientSecret?: string;
+    scope?: string;
+    usePkce?: boolean;
+    redirectUrl?: string;
+    headerPrefix?: string;
+    audience?: string;
+    resource?: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "awsAuthentication".
+ */
+export interface AWSAuthenticationV3_12_0 {
+    type: 'aws';
+    awsAccessKeyId: string;
+    awsSecretAccessKey: string;
+}
+/**
+ * This interface was referenced by `ProjectSchemaV3_12_0`'s JSON-Schema
+ * via the `definition` "serviceConfig".
+ */
+export interface ServiceConfigV3_12_0 {
+    /**
+     * Machine-readable identifier, should typically be the same as the property name on the services object.
+     */
+    id: string;
+    /**
+     * Human-readable name for this service.
+     */
+    title: string;
+    /**
+     * The service provider id.
+     */
+    provider: string;
+    /**
+     * A namespace to use for the imported types tied to this service.
+     */
+    namespace?: string;
+    serviceType: ServiceTypeV3_12_0;
+    authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'none' | 'unknown';
+    authentication?: ServiceAuthenticationV3_12_0;
+    webhookId?: string;
+    /**
+     * Configuration options passed to and handled by the provider.
+     */
+    options?: {
+        [k: string]: any;
+    };
+}
+//# sourceMappingURL=v3.12.0.d.ts.map