@rippling/rippling-sdk 0.2.0-alpha.87 → 0.2.0-alpha.89

package/resources/metadata/metadata.d.mts

@@ -0,0 +1,125 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ComponentSchemasAPI from "./component-schemas.mjs";
+import { ComponentSchemaGetParams, ComponentSchemaGetResponse, ComponentSchemas } from "./component-schemas.mjs";
+import * as ComponentTypesAPI from "./component-types.mjs";
+import { ComponentTypeListResponse, ComponentTypes } from "./component-types.mjs";
+import * as ComponentsAPI from "./components.mjs";
+import { ComponentDeployParams, ComponentDeployResponse, ComponentExtractParams, ComponentExtractResponse, ComponentValidateParams, ComponentValidateResponse, ComponentValidateV2Params, ComponentValidateV2Response, Components } from "./components.mjs";
+import * as DeploymentRunsAPI from "./deployment-runs.mjs";
+import { DeploymentRunCreateParams, DeploymentRunCreateResponse, DeploymentRunCreateV2Params, DeploymentRunCreateV2Response, DeploymentRunGetResponse, DeploymentRunGetV2Response, DeploymentRuns } from "./deployment-runs.mjs";
+import * as SchemaAPI from "./schema.mjs";
+import { Schema, SchemaGetParams, SchemaGetResponse } from "./schema.mjs";
+import * as TypesAPI from "./types.mjs";
+import { TypeListResponse, Types } from "./types.mjs";
+import * as ValidationRunsAPI from "./validation-runs.mjs";
+import { ValidationRunCreateParams, ValidationRunCreateResponse, ValidationRunCreateV2Params, ValidationRunCreateV2Response, ValidationRunGetResponse, ValidationRunGetV2Response, ValidationRuns } from "./validation-runs.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export declare class Metadata extends APIResource {
+    types: TypesAPI.Types;
+    schema: SchemaAPI.Schema;
+    componentTypes: ComponentTypesAPI.ComponentTypes;
+    componentSchemas: ComponentSchemasAPI.ComponentSchemas;
+    components: ComponentsAPI.Components;
+    validationRuns: ValidationRunsAPI.ValidationRuns;
+    deploymentRuns: DeploymentRunsAPI.DeploymentRuns;
+    /**
+     * Extract the company's selectable metadata components, optionally filtered by a
+     * search query.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.extract();
+     * ```
+     */
+    extract(query?: MetadataExtractParams | null | undefined, options?: RequestOptions): APIPromise<MetadataExtractResponse>;
+}
+export interface MetadataExtractResponse {
+    /**
+     * Full component configs needed to recreate the selected roots.
+     */
+    component_configs: Array<MetadataExtractResponse.ComponentConfig>;
+    /**
+     * Serialized dependency graph for the extracted package.
+     */
+    dependency_graph: {
+        [key: string]: unknown;
+    };
+    /**
+     * Topological install order for the extracted package.
+     */
+    install_order: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Components selected as extraction roots.
+     */
+    root_components: Array<MetadataExtractResponse.RootComponent>;
+    /**
+     * For search-backed extraction, whether contextual expansion completed.
+     */
+    context_complete?: boolean;
+    /**
+     * Warnings from search-backed contextual expansion.
+     */
+    context_warnings?: Array<string>;
+    external_managed_dependencies?: Array<{
+        [key: string]: unknown;
+    }>;
+    [k: string]: unknown;
+}
+export declare namespace MetadataExtractResponse {
+    /**
+     * A metadata component config. The `type` field selects the concrete component
+     * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+     */
+    interface ComponentConfig {
+        /**
+         * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+    /**
+     * Selectable package root returned by metadata extraction.
+     */
+    interface RootComponent {
+        /**
+         * Identifier for the selected component.
+         */
+        identifier?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Display name for the selectable component.
+         */
+        name?: string;
+        [k: string]: unknown;
+    }
+}
+export interface MetadataExtractParams {
+    /**
+     * Maximum search results to return when q is provided.
+     */
+    limit?: number;
+    /**
+     * Optional text search over selectable components.
+     */
+    q?: string;
+}
+export declare namespace Metadata {
+    export { type MetadataExtractResponse as MetadataExtractResponse, type MetadataExtractParams as MetadataExtractParams, };
+    export { Types as Types, type TypeListResponse as TypeListResponse };
+    export { Schema as Schema, type SchemaGetResponse as SchemaGetResponse, type SchemaGetParams as SchemaGetParams, };
+    export { ComponentTypes as ComponentTypes, type ComponentTypeListResponse as ComponentTypeListResponse };
+    export { ComponentSchemas as ComponentSchemas, type ComponentSchemaGetResponse as ComponentSchemaGetResponse, type ComponentSchemaGetParams as ComponentSchemaGetParams, };
+    export { Components as Components, type ComponentExtractResponse as ComponentExtractResponse, type ComponentValidateV2Response as ComponentValidateV2Response, type ComponentValidateResponse as ComponentValidateResponse, type ComponentDeployResponse as ComponentDeployResponse, type ComponentExtractParams as ComponentExtractParams, type ComponentValidateV2Params as ComponentValidateV2Params, type ComponentValidateParams as ComponentValidateParams, type ComponentDeployParams as ComponentDeployParams, };
+    export { ValidationRuns as ValidationRuns, type ValidationRunCreateV2Response as ValidationRunCreateV2Response, type ValidationRunGetV2Response as ValidationRunGetV2Response, type ValidationRunCreateResponse as ValidationRunCreateResponse, type ValidationRunGetResponse as ValidationRunGetResponse, type ValidationRunCreateV2Params as ValidationRunCreateV2Params, type ValidationRunCreateParams as ValidationRunCreateParams, };
+    export { DeploymentRuns as DeploymentRuns, type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response, type DeploymentRunGetV2Response as DeploymentRunGetV2Response, type DeploymentRunCreateResponse as DeploymentRunCreateResponse, type DeploymentRunGetResponse as DeploymentRunGetResponse, type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params, type DeploymentRunCreateParams as DeploymentRunCreateParams, };
+}
+//# sourceMappingURL=metadata.d.mts.map

package/resources/metadata/metadata.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,gCAA4B;AAC7G,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,8BAA0B;AAC9E,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,2BAA2B,EAC3B,UAAU,EACX,yBAAqB;AACtB,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,EACf,8BAA0B;AAC3B,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,qBAAiB;AACtE,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,oBAAgB;AAClD,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,EACf,8BAA0B;AAC3B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IACtG,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IACF,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAClF,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IACtG,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IAEtG;;;;;;;;;;OAUG;IACH,OAAO,CACL,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAElE;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC,6BAA6B,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAElE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAUD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAErE,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,cAAc,IAAI,cAAc,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;IAEzG,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/metadata/metadata.d.ts

@@ -0,0 +1,125 @@
+import { APIResource } from "../../core/resource.js";
+import * as ComponentSchemasAPI from "./component-schemas.js";
+import { ComponentSchemaGetParams, ComponentSchemaGetResponse, ComponentSchemas } from "./component-schemas.js";
+import * as ComponentTypesAPI from "./component-types.js";
+import { ComponentTypeListResponse, ComponentTypes } from "./component-types.js";
+import * as ComponentsAPI from "./components.js";
+import { ComponentDeployParams, ComponentDeployResponse, ComponentExtractParams, ComponentExtractResponse, ComponentValidateParams, ComponentValidateResponse, ComponentValidateV2Params, ComponentValidateV2Response, Components } from "./components.js";
+import * as DeploymentRunsAPI from "./deployment-runs.js";
+import { DeploymentRunCreateParams, DeploymentRunCreateResponse, DeploymentRunCreateV2Params, DeploymentRunCreateV2Response, DeploymentRunGetResponse, DeploymentRunGetV2Response, DeploymentRuns } from "./deployment-runs.js";
+import * as SchemaAPI from "./schema.js";
+import { Schema, SchemaGetParams, SchemaGetResponse } from "./schema.js";
+import * as TypesAPI from "./types.js";
+import { TypeListResponse, Types } from "./types.js";
+import * as ValidationRunsAPI from "./validation-runs.js";
+import { ValidationRunCreateParams, ValidationRunCreateResponse, ValidationRunCreateV2Params, ValidationRunCreateV2Response, ValidationRunGetResponse, ValidationRunGetV2Response, ValidationRuns } from "./validation-runs.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Custom objects defined by the company
+ */
+export declare class Metadata extends APIResource {
+    types: TypesAPI.Types;
+    schema: SchemaAPI.Schema;
+    componentTypes: ComponentTypesAPI.ComponentTypes;
+    componentSchemas: ComponentSchemasAPI.ComponentSchemas;
+    components: ComponentsAPI.Components;
+    validationRuns: ValidationRunsAPI.ValidationRuns;
+    deploymentRuns: DeploymentRunsAPI.DeploymentRuns;
+    /**
+     * Extract the company's selectable metadata components, optionally filtered by a
+     * search query.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.extract();
+     * ```
+     */
+    extract(query?: MetadataExtractParams | null | undefined, options?: RequestOptions): APIPromise<MetadataExtractResponse>;
+}
+export interface MetadataExtractResponse {
+    /**
+     * Full component configs needed to recreate the selected roots.
+     */
+    component_configs: Array<MetadataExtractResponse.ComponentConfig>;
+    /**
+     * Serialized dependency graph for the extracted package.
+     */
+    dependency_graph: {
+        [key: string]: unknown;
+    };
+    /**
+     * Topological install order for the extracted package.
+     */
+    install_order: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Components selected as extraction roots.
+     */
+    root_components: Array<MetadataExtractResponse.RootComponent>;
+    /**
+     * For search-backed extraction, whether contextual expansion completed.
+     */
+    context_complete?: boolean;
+    /**
+     * Warnings from search-backed contextual expansion.
+     */
+    context_warnings?: Array<string>;
+    external_managed_dependencies?: Array<{
+        [key: string]: unknown;
+    }>;
+    [k: string]: unknown;
+}
+export declare namespace MetadataExtractResponse {
+    /**
+     * A metadata component config. The `type` field selects the concrete component
+     * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+     */
+    interface ComponentConfig {
+        /**
+         * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+         */
+        type: string;
+        [k: string]: unknown;
+    }
+    /**
+     * Selectable package root returned by metadata extraction.
+     */
+    interface RootComponent {
+        /**
+         * Identifier for the selected component.
+         */
+        identifier?: {
+            [key: string]: unknown;
+        };
+        /**
+         * Display name for the selectable component.
+         */
+        name?: string;
+        [k: string]: unknown;
+    }
+}
+export interface MetadataExtractParams {
+    /**
+     * Maximum search results to return when q is provided.
+     */
+    limit?: number;
+    /**
+     * Optional text search over selectable components.
+     */
+    q?: string;
+}
+export declare namespace Metadata {
+    export { type MetadataExtractResponse as MetadataExtractResponse, type MetadataExtractParams as MetadataExtractParams, };
+    export { Types as Types, type TypeListResponse as TypeListResponse };
+    export { Schema as Schema, type SchemaGetResponse as SchemaGetResponse, type SchemaGetParams as SchemaGetParams, };
+    export { ComponentTypes as ComponentTypes, type ComponentTypeListResponse as ComponentTypeListResponse };
+    export { ComponentSchemas as ComponentSchemas, type ComponentSchemaGetResponse as ComponentSchemaGetResponse, type ComponentSchemaGetParams as ComponentSchemaGetParams, };
+    export { Components as Components, type ComponentExtractResponse as ComponentExtractResponse, type ComponentValidateV2Response as ComponentValidateV2Response, type ComponentValidateResponse as ComponentValidateResponse, type ComponentDeployResponse as ComponentDeployResponse, type ComponentExtractParams as ComponentExtractParams, type ComponentValidateV2Params as ComponentValidateV2Params, type ComponentValidateParams as ComponentValidateParams, type ComponentDeployParams as ComponentDeployParams, };
+    export { ValidationRuns as ValidationRuns, type ValidationRunCreateV2Response as ValidationRunCreateV2Response, type ValidationRunGetV2Response as ValidationRunGetV2Response, type ValidationRunCreateResponse as ValidationRunCreateResponse, type ValidationRunGetResponse as ValidationRunGetResponse, type ValidationRunCreateV2Params as ValidationRunCreateV2Params, type ValidationRunCreateParams as ValidationRunCreateParams, };
+    export { DeploymentRuns as DeploymentRuns, type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response, type DeploymentRunGetV2Response as DeploymentRunGetV2Response, type DeploymentRunCreateResponse as DeploymentRunCreateResponse, type DeploymentRunGetResponse as DeploymentRunGetResponse, type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params, type DeploymentRunCreateParams as DeploymentRunCreateParams, };
+}
+//# sourceMappingURL=metadata.d.ts.map

package/resources/metadata/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/metadata.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,gBAAgB,EAAE,+BAA4B;AAC7G,OAAO,KAAK,iBAAiB,6BAA0B;AACvD,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,6BAA0B;AAC9E,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,2BAA2B,EAC3B,UAAU,EACX,wBAAqB;AACtB,OAAO,KAAK,iBAAiB,6BAA0B;AACvD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,EACf,6BAA0B;AAC3B,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,oBAAiB;AACtE,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,mBAAgB;AAClD,OAAO,KAAK,iBAAiB,6BAA0B;AACvD,OAAO,EACL,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,EACf,6BAA0B;AAC3B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IACtG,gBAAgB,EAAE,mBAAmB,CAAC,gBAAgB,CAEpD;IACF,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAClF,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IACtG,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IAEtG;;;;;;;;;;OAUG;IACH,OAAO,CACL,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;IAElE;;OAEG;IACH,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAEjD;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC,6BAA6B,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAElE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;OAGG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAUD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;IAErE,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EAAE,cAAc,IAAI,cAAc,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;IAEzG,OAAO,EACL,gBAAgB,IAAI,gBAAgB,EACpC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/metadata/metadata.js

@@ -0,0 +1,58 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metadata = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const ComponentSchemasAPI = tslib_1.__importStar(require("./component-schemas.js"));
+const component_schemas_1 = require("./component-schemas.js");
+const ComponentTypesAPI = tslib_1.__importStar(require("./component-types.js"));
+const component_types_1 = require("./component-types.js");
+const ComponentsAPI = tslib_1.__importStar(require("./components.js"));
+const components_1 = require("./components.js");
+const DeploymentRunsAPI = tslib_1.__importStar(require("./deployment-runs.js"));
+const deployment_runs_1 = require("./deployment-runs.js");
+const SchemaAPI = tslib_1.__importStar(require("./schema.js"));
+const schema_1 = require("./schema.js");
+const TypesAPI = tslib_1.__importStar(require("./types.js"));
+const types_1 = require("./types.js");
+const ValidationRunsAPI = tslib_1.__importStar(require("./validation-runs.js"));
+const validation_runs_1 = require("./validation-runs.js");
+/**
+ * Custom objects defined by the company
+ */
+class Metadata extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.types = new TypesAPI.Types(this._client);
+        this.schema = new SchemaAPI.Schema(this._client);
+        this.componentTypes = new ComponentTypesAPI.ComponentTypes(this._client);
+        this.componentSchemas = new ComponentSchemasAPI.ComponentSchemas(this._client);
+        this.components = new ComponentsAPI.Components(this._client);
+        this.validationRuns = new ValidationRunsAPI.ValidationRuns(this._client);
+        this.deploymentRuns = new DeploymentRunsAPI.DeploymentRuns(this._client);
+    }
+    /**
+     * Extract the company's selectable metadata components, optionally filtered by a
+     * search query.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.extract();
+     * ```
+     */
+    extract(query = {}, options) {
+        return this._client.get('/metadata/extract/', { query, ...options });
+    }
+}
+exports.Metadata = Metadata;
+Metadata.Types = types_1.Types;
+Metadata.Schema = schema_1.Schema;
+Metadata.ComponentTypes = component_types_1.ComponentTypes;
+Metadata.ComponentSchemas = component_schemas_1.ComponentSchemas;
+Metadata.Components = components_1.Components;
+Metadata.ValidationRuns = validation_runs_1.ValidationRuns;
+Metadata.DeploymentRuns = deployment_runs_1.DeploymentRuns;
+//# sourceMappingURL=metadata.js.map

package/resources/metadata/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/resources/metadata/metadata.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,oFAA2D;AAC3D,8DAA6G;AAC7G,gFAAuD;AACvD,0DAA8E;AAC9E,uEAA8C;AAC9C,gDAUsB;AACtB,gFAAuD;AACvD,0DAQ2B;AAC3B,+DAAsC;AACtC,wCAAsE;AACtE,6DAAoC;AACpC,sCAAkD;AAClD,gFAAuD;AACvD,0DAQ2B;AAI3B;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmBxG,CAAC;IAjBC;;;;;;;;;;OAUG;IACH,OAAO,CACL,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AA5BD,4BA4BC;AAkFD,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC;AACvB,QAAQ,CAAC,MAAM,GAAG,eAAM,CAAC;AACzB,QAAQ,CAAC,cAAc,GAAG,gCAAc,CAAC;AACzC,QAAQ,CAAC,gBAAgB,GAAG,oCAAgB,CAAC;AAC7C,QAAQ,CAAC,UAAU,GAAG,uBAAU,CAAC;AACjC,QAAQ,CAAC,cAAc,GAAG,gCAAc,CAAC;AACzC,QAAQ,CAAC,cAAc,GAAG,gCAAc,CAAC"}

package/resources/metadata/metadata.mjs

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as ComponentSchemasAPI from "./component-schemas.mjs";
+import { ComponentSchemas } from "./component-schemas.mjs";
+import * as ComponentTypesAPI from "./component-types.mjs";
+import { ComponentTypes } from "./component-types.mjs";
+import * as ComponentsAPI from "./components.mjs";
+import { Components, } from "./components.mjs";
+import * as DeploymentRunsAPI from "./deployment-runs.mjs";
+import { DeploymentRuns, } from "./deployment-runs.mjs";
+import * as SchemaAPI from "./schema.mjs";
+import { Schema } from "./schema.mjs";
+import * as TypesAPI from "./types.mjs";
+import { Types } from "./types.mjs";
+import * as ValidationRunsAPI from "./validation-runs.mjs";
+import { ValidationRuns, } from "./validation-runs.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export class Metadata extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.types = new TypesAPI.Types(this._client);
+        this.schema = new SchemaAPI.Schema(this._client);
+        this.componentTypes = new ComponentTypesAPI.ComponentTypes(this._client);
+        this.componentSchemas = new ComponentSchemasAPI.ComponentSchemas(this._client);
+        this.components = new ComponentsAPI.Components(this._client);
+        this.validationRuns = new ValidationRunsAPI.ValidationRuns(this._client);
+        this.deploymentRuns = new DeploymentRunsAPI.DeploymentRuns(this._client);
+    }
+    /**
+     * Extract the company's selectable metadata components, optionally filtered by a
+     * search query.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metadata.extract();
+     * ```
+     */
+    extract(query = {}, options) {
+        return this._client.get('/metadata/extract/', { query, ...options });
+    }
+}
+Metadata.Types = Types;
+Metadata.Schema = Schema;
+Metadata.ComponentTypes = ComponentTypes;
+Metadata.ComponentSchemas = ComponentSchemas;
+Metadata.Components = Components;
+Metadata.ValidationRuns = ValidationRuns;
+Metadata.DeploymentRuns = DeploymentRuns;
+//# sourceMappingURL=metadata.mjs.map

package/resources/metadata/metadata.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.mjs","sourceRoot":"","sources":["../../src/resources/metadata/metadata.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAwD,gBAAgB,EAAE,gCAA4B;AAC7G,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EAA6B,cAAc,EAAE,8BAA0B;AAC9E,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EASL,UAAU,GACX,yBAAqB;AACtB,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EAOL,cAAc,GACf,8BAA0B;AAC3B,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAsC,qBAAiB;AACtE,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAoB,KAAK,EAAE,oBAAgB;AAClD,OAAO,KAAK,iBAAiB,8BAA0B;AACvD,OAAO,EAOL,cAAc,GACf,8BAA0B;AAI3B;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmBxG,CAAC;IAjBC;;;;;;;;;;OAUG;IACH,OAAO,CACL,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAkFD,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;AACvB,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;AACzB,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;AACzC,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AAC7C,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;AACjC,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;AACzC,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC"}

package/resources/metadata/schema.d.mts

@@ -0,0 +1,92 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export declare class Schema extends APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const schema = await client.metadata.schema.get({
+     *   type: 'type',
+     * });
+     * ```
+     */
+    get(query: SchemaGetParams, options?: RequestOptions): APIPromise<SchemaGetResponse>;
+}
+export interface SchemaGetResponse {
+    /**
+     * JSON Schema for a full deployable component config.
+     */
+    config_schema: {
+        [key: string]: unknown;
+    };
+    /**
+     * JSON Schema for identifying an existing component.
+     */
+    identifier_schema: {
+        [key: string]: unknown;
+    };
+    /**
+     * Metadata component type.
+     */
+    type: string;
+    /**
+     * Type-specific implementation guidance.
+     */
+    best_practices?: string;
+    /**
+     * Common invalid inputs and their corrections.
+     */
+    common_mistakes?: Array<SchemaGetResponse.CommonMistake>;
+    /**
+     * Short description of the component type.
+     */
+    description?: string;
+    /**
+     * Human-readable component type name.
+     */
+    display_name?: string;
+    /**
+     * Valid example configs for this component type.
+     */
+    examples?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Type-specific authoring guidance.
+     */
+    usage_guide?: string;
+    [k: string]: unknown;
+}
+export declare namespace SchemaGetResponse {
+    interface CommonMistake {
+        /**
+         * Explanation of the correction.
+         */
+        message: string;
+        /**
+         * Corrected example.
+         */
+        right: string;
+        /**
+         * Invalid or discouraged example.
+         */
+        wrong: string;
+    }
+}
+export interface SchemaGetParams {
+    /**
+     * Component type returned by list-metadata-types.
+     */
+    type: string;
+}
+export declare namespace Schema {
+    export { type SchemaGetResponse as SchemaGetResponse, type SchemaGetParams as SchemaGetParams };
+}
+//# sourceMappingURL=schema.d.mts.map

package/resources/metadata/schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGrF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,iBAAiB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAEzD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE7C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,aAAa;QAC5B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}

package/resources/metadata/schema.d.ts

@@ -0,0 +1,92 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Custom objects defined by the company
+ */
+export declare class Schema extends APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const schema = await client.metadata.schema.get({
+     *   type: 'type',
+     * });
+     * ```
+     */
+    get(query: SchemaGetParams, options?: RequestOptions): APIPromise<SchemaGetResponse>;
+}
+export interface SchemaGetResponse {
+    /**
+     * JSON Schema for a full deployable component config.
+     */
+    config_schema: {
+        [key: string]: unknown;
+    };
+    /**
+     * JSON Schema for identifying an existing component.
+     */
+    identifier_schema: {
+        [key: string]: unknown;
+    };
+    /**
+     * Metadata component type.
+     */
+    type: string;
+    /**
+     * Type-specific implementation guidance.
+     */
+    best_practices?: string;
+    /**
+     * Common invalid inputs and their corrections.
+     */
+    common_mistakes?: Array<SchemaGetResponse.CommonMistake>;
+    /**
+     * Short description of the component type.
+     */
+    description?: string;
+    /**
+     * Human-readable component type name.
+     */
+    display_name?: string;
+    /**
+     * Valid example configs for this component type.
+     */
+    examples?: Array<{
+        [key: string]: unknown;
+    }>;
+    /**
+     * Type-specific authoring guidance.
+     */
+    usage_guide?: string;
+    [k: string]: unknown;
+}
+export declare namespace SchemaGetResponse {
+    interface CommonMistake {
+        /**
+         * Explanation of the correction.
+         */
+        message: string;
+        /**
+         * Corrected example.
+         */
+        right: string;
+        /**
+         * Invalid or discouraged example.
+         */
+        wrong: string;
+    }
+}
+export interface SchemaGetParams {
+    /**
+     * Component type returned by list-metadata-types.
+     */
+    type: string;
+}
+export declare namespace Schema {
+    export { type SchemaGetResponse as SchemaGetResponse, type SchemaGetParams as SchemaGetParams };
+}
+//# sourceMappingURL=schema.d.ts.map

package/resources/metadata/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGrF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,iBAAiB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAEzD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE7C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,aAAa;QAC5B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACjG"}

package/resources/metadata/schema.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+const resource_1 = require("../../core/resource.js");
+/**
+ * Custom objects defined by the company
+ */
+class Schema extends resource_1.APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const schema = await client.metadata.schema.get({
+     *   type: 'type',
+     * });
+     * ```
+     */
+    get(query, options) {
+        return this._client.get('/metadata/schema/', { query, ...options });
+    }
+}
+exports.Schema = Schema;
+//# sourceMappingURL=schema.js.map

package/resources/metadata/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/resources/metadata/schema.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,KAAsB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAhBD,wBAgBC"}

package/resources/metadata/schema.mjs

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+/**
+ * Custom objects defined by the company
+ */
+export class Schema extends APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const schema = await client.metadata.schema.get({
+     *   type: 'type',
+     * });
+     * ```
+     */
+    get(query, options) {
+        return this._client.get('/metadata/schema/', { query, ...options });
+    }
+}
+//# sourceMappingURL=schema.mjs.map

package/resources/metadata/schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.mjs","sourceRoot":"","sources":["../../src/resources/metadata/schema.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,KAAsB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}