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

package/resources/metadata/component-schemas.d.ts

@@ -0,0 +1,93 @@
+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 ComponentSchemas extends APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentSchema =
+     *   await client.metadata.componentSchemas.get({
+     *     type: 'type',
+     *   });
+     * ```
+     */
+    get(query: ComponentSchemaGetParams, options?: RequestOptions): APIPromise<ComponentSchemaGetResponse>;
+}
+export interface ComponentSchemaGetResponse {
+    /**
+     * 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<ComponentSchemaGetResponse.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 ComponentSchemaGetResponse {
+    interface CommonMistake {
+        /**
+         * Explanation of the correction.
+         */
+        message: string;
+        /**
+         * Corrected example.
+         */
+        right: string;
+        /**
+         * Invalid or discouraged example.
+         */
+        wrong: string;
+    }
+}
+export interface ComponentSchemaGetParams {
+    /**
+     * Component type returned by list-metadata-component-types.
+     */
+    type: string;
+}
+export declare namespace ComponentSchemas {
+    export { type ComponentSchemaGetResponse as ComponentSchemaGetResponse, type ComponentSchemaGetParams as ComponentSchemaGetParams, };
+}
+//# sourceMappingURL=component-schemas.d.ts.map

package/resources/metadata/component-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-schemas.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/component-schemas.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,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,KAAK,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGvG;AAED,MAAM,WAAW,0BAA0B;IACzC;;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,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAElE;;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,0BAA0B,CAAC;IAC1C,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,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/metadata/component-schemas.js

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

package/resources/metadata/component-schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-schemas.js","sourceRoot":"","sources":["../../src/resources/metadata/component-schemas.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,KAA+B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAjBD,4CAiBC"}

package/resources/metadata/component-schemas.mjs

@@ -0,0 +1,24 @@
+// 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 ComponentSchemas extends APIResource {
+    /**
+     * Return the JSON schema for one supported metadata component type.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentSchema =
+     *   await client.metadata.componentSchemas.get({
+     *     type: 'type',
+     *   });
+     * ```
+     */
+    get(query, options) {
+        return this._client.get('/metadata/v2/schema/', { query, ...options });
+    }
+}
+//# sourceMappingURL=component-schemas.mjs.map

package/resources/metadata/component-schemas.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-schemas.mjs","sourceRoot":"","sources":["../../src/resources/metadata/component-schemas.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,KAA+B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}

package/resources/metadata/component-types.d.mts

@@ -0,0 +1,47 @@
+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 ComponentTypes extends APIResource {
+    /**
+     * List component types that can be described, validated, and deployed by metadata
+     * composer.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentTypes =
+     *   await client.metadata.componentTypes.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<ComponentTypeListResponse>;
+}
+export interface ComponentTypeListResponse {
+    /**
+     * Composer-enabled metadata component types.
+     */
+    types: Array<ComponentTypeListResponse.Type>;
+}
+export declare namespace ComponentTypeListResponse {
+    interface Type {
+        /**
+         * Short description of the component type.
+         */
+        description: string;
+        /**
+         * Human-readable component type name.
+         */
+        display_name: string;
+        /**
+         * Metadata component type.
+         */
+        type: string;
+    }
+}
+export declare namespace ComponentTypes {
+    export { type ComponentTypeListResponse as ComponentTypeListResponse };
+}
+//# sourceMappingURL=component-types.d.mts.map

package/resources/metadata/component-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.d.mts","sourceRoot":"","sources":["../../src/resources/metadata/component-types.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,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGtE;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;CAC9C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}

package/resources/metadata/component-types.d.ts

@@ -0,0 +1,47 @@
+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 ComponentTypes extends APIResource {
+    /**
+     * List component types that can be described, validated, and deployed by metadata
+     * composer.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentTypes =
+     *   await client.metadata.componentTypes.list();
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<ComponentTypeListResponse>;
+}
+export interface ComponentTypeListResponse {
+    /**
+     * Composer-enabled metadata component types.
+     */
+    types: Array<ComponentTypeListResponse.Type>;
+}
+export declare namespace ComponentTypeListResponse {
+    interface Type {
+        /**
+         * Short description of the component type.
+         */
+        description: string;
+        /**
+         * Human-readable component type name.
+         */
+        display_name: string;
+        /**
+         * Metadata component type.
+         */
+        type: string;
+    }
+}
+export declare namespace ComponentTypes {
+    export { type ComponentTypeListResponse as ComponentTypeListResponse };
+}
+//# sourceMappingURL=component-types.d.ts.map

package/resources/metadata/component-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.d.ts","sourceRoot":"","sources":["../../src/resources/metadata/component-types.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,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGtE;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;CAC9C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CACxE"}

package/resources/metadata/component-types.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.ComponentTypes = void 0;
+const resource_1 = require("../../core/resource.js");
+/**
+ * Custom objects defined by the company
+ */
+class ComponentTypes extends resource_1.APIResource {
+    /**
+     * List component types that can be described, validated, and deployed by metadata
+     * composer.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentTypes =
+     *   await client.metadata.componentTypes.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/metadata/v2/types/', options);
+    }
+}
+exports.ComponentTypes = ComponentTypes;
+//# sourceMappingURL=component-types.js.map

package/resources/metadata/component-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.js","sourceRoot":"","sources":["../../src/resources/metadata/component-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD;;GAEG;AACH,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF;AAhBD,wCAgBC"}

package/resources/metadata/component-types.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 ComponentTypes extends APIResource {
+    /**
+     * List component types that can be described, validated, and deployed by metadata
+     * composer.
+     *
+     * Requires the Metadata entitlement.
+     *
+     * @example
+     * ```ts
+     * const componentTypes =
+     *   await client.metadata.componentTypes.list();
+     * ```
+     */
+    list(options) {
+        return this._client.get('/metadata/v2/types/', options);
+    }
+}
+//# sourceMappingURL=component-types.mjs.map

package/resources/metadata/component-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-types.mjs","sourceRoot":"","sources":["../../src/resources/metadata/component-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF"}