@roarkanalytics/sdk 3.5.0 → 3.7.0

package/resources/metric-variant.d.ts

@@ -0,0 +1,357 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class MetricVariant extends APIResource {
+    /**
+     * Add a configuration of this metric for your organization, seeded from its
+     * Default. Edit it with PUT to change what it measures, then pin it where you want
+     * it used.
+     *
+     * Threshold metrics have no variants: their configuration comes from the metric
+     * they derive from. Metrics in a package that manages its own variants reject this
+     * too.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.create(
+     *   'idOrSlug',
+     *   { name: 'Strict' },
+     * );
+     * ```
+     */
+    create(idOrSlug: string, body: MetricVariantCreateParams, options?: RequestOptions): APIPromise<MetricVariantCreateResponse>;
+    /**
+     * Rename a variant, change its configuration, or both. Every configuration change
+     * creates a new immutable version and advances `versionId`; the response carries
+     * the advanced value.
+     *
+     * **Editing one of Roark’s own variants forks it for your organization.** The
+     * response carries the new variant’s `id`, which will differ from the one in the
+     * path, and `isSystem` becomes false. Roark’s variant is untouched and other
+     * organizations keep it. DELETE your fork to go back to it.
+     *
+     * Which fields are editable depends on the metric: some Roark metrics lock their
+     * prompt or output configuration, and a locked field is rejected rather than
+     * ignored.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    update(variantID: string, params: MetricVariantUpdateParams, options?: RequestOptions): APIPromise<MetricVariantUpdateResponse>;
+    /**
+     * Every configuration of this metric your organization can use: Roark’s own
+     * variants and any your organization has added or forked. `isDefault` marks the
+     * one the metric is scored with when nothing pins another; pass any variant’s `id`
+     * as `sourceVariantId` to pin it on a derived metric.
+     *
+     * Auto-managed variants (the ones a package materializes for you) are not listed:
+     * they are engine state, not configuration you author.
+     *
+     * @example
+     * ```ts
+     * const metricVariants =
+     *   await client.metricVariant.list('idOrSlug');
+     * ```
+     */
+    list(idOrSlug: string, options?: RequestOptions): APIPromise<MetricVariantListResponse>;
+    /**
+     * Remove one of your organization’s variants. Anything pinned to it falls back to
+     * the Default, so deleting a fork of a Roark variant returns you to Roark’s
+     * configuration.
+     *
+     * Roark’s own variants cannot be deleted, and neither can a Default. Values
+     * already collected under the deleted variant are retained.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    delete(variantID: string, params: MetricVariantDeleteParams, options?: RequestOptions): APIPromise<MetricVariantDeleteResponse>;
+    /**
+     * One configuration of this metric, by id.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricVariant.getByID(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    getByID(variantID: string, params: MetricVariantGetByIDParams, options?: RequestOptions): APIPromise<MetricVariantGetByIDResponse>;
+}
+export interface MetricVariantCreateResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    data: MetricVariantCreateResponse.Data;
+}
+export declare namespace MetricVariantCreateResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    interface Data {
+        /**
+         * Unique identifier for the variant.
+         */
+        id: string;
+        /**
+         * When the variant was created.
+         */
+        createdAt: string;
+        /**
+         * Whether this is the variant a metric is scored with when nothing pins another.
+         */
+        isDefault: boolean;
+        /**
+         * True for Roark's own variant, shared by every organization. Editing one forks it
+         * for yours; the original is left alone.
+         */
+        isSystem: boolean;
+        /**
+         * The metric this variant configures.
+         */
+        metricDefinitionId: string;
+        /**
+         * Name of the variant. "Default" is the one a metric is scored with unless
+         * something pins another.
+         */
+        name: string;
+        /**
+         * When the variant was last changed.
+         */
+        updatedAt: string;
+        /**
+         * The variant's current version: an immutable snapshot of its configuration.
+         * Editing the variant advances this. Null only for a variant left without one,
+         * which cannot be scored until it is configured.
+         */
+        versionId: string | null;
+    }
+}
+export interface MetricVariantUpdateResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    data: MetricVariantUpdateResponse.Data;
+}
+export declare namespace MetricVariantUpdateResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    interface Data {
+        /**
+         * Unique identifier for the variant.
+         */
+        id: string;
+        /**
+         * When the variant was created.
+         */
+        createdAt: string;
+        /**
+         * Whether this is the variant a metric is scored with when nothing pins another.
+         */
+        isDefault: boolean;
+        /**
+         * True for Roark's own variant, shared by every organization. Editing one forks it
+         * for yours; the original is left alone.
+         */
+        isSystem: boolean;
+        /**
+         * The metric this variant configures.
+         */
+        metricDefinitionId: string;
+        /**
+         * Name of the variant. "Default" is the one a metric is scored with unless
+         * something pins another.
+         */
+        name: string;
+        /**
+         * When the variant was last changed.
+         */
+        updatedAt: string;
+        /**
+         * The variant's current version: an immutable snapshot of its configuration.
+         * Editing the variant advances this. Null only for a variant left without one,
+         * which cannot be scored until it is configured.
+         */
+        versionId: string | null;
+    }
+}
+export interface MetricVariantListResponse {
+    data: Array<MetricVariantListResponse.Data>;
+}
+export declare namespace MetricVariantListResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    interface Data {
+        /**
+         * Unique identifier for the variant.
+         */
+        id: string;
+        /**
+         * When the variant was created.
+         */
+        createdAt: string;
+        /**
+         * Whether this is the variant a metric is scored with when nothing pins another.
+         */
+        isDefault: boolean;
+        /**
+         * True for Roark's own variant, shared by every organization. Editing one forks it
+         * for yours; the original is left alone.
+         */
+        isSystem: boolean;
+        /**
+         * The metric this variant configures.
+         */
+        metricDefinitionId: string;
+        /**
+         * Name of the variant. "Default" is the one a metric is scored with unless
+         * something pins another.
+         */
+        name: string;
+        /**
+         * When the variant was last changed.
+         */
+        updatedAt: string;
+        /**
+         * The variant's current version: an immutable snapshot of its configuration.
+         * Editing the variant advances this. Null only for a variant left without one,
+         * which cannot be scored until it is configured.
+         */
+        versionId: string | null;
+    }
+}
+export interface MetricVariantDeleteResponse {
+    data: MetricVariantDeleteResponse.Data;
+}
+export declare namespace MetricVariantDeleteResponse {
+    interface Data {
+        id: string;
+        deleted: true;
+    }
+}
+export interface MetricVariantGetByIDResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    data: MetricVariantGetByIDResponse.Data;
+}
+export declare namespace MetricVariantGetByIDResponse {
+    /**
+     * One named configuration of a metric.
+     */
+    interface Data {
+        /**
+         * Unique identifier for the variant.
+         */
+        id: string;
+        /**
+         * When the variant was created.
+         */
+        createdAt: string;
+        /**
+         * Whether this is the variant a metric is scored with when nothing pins another.
+         */
+        isDefault: boolean;
+        /**
+         * True for Roark's own variant, shared by every organization. Editing one forks it
+         * for yours; the original is left alone.
+         */
+        isSystem: boolean;
+        /**
+         * The metric this variant configures.
+         */
+        metricDefinitionId: string;
+        /**
+         * Name of the variant. "Default" is the one a metric is scored with unless
+         * something pins another.
+         */
+        name: string;
+        /**
+         * When the variant was last changed.
+         */
+        updatedAt: string;
+        /**
+         * The variant's current version: an immutable snapshot of its configuration.
+         * Editing the variant advances this. Null only for a variant left without one,
+         * which cannot be scored until it is configured.
+         */
+        versionId: string | null;
+    }
+}
+export interface MetricVariantCreateParams {
+    /**
+     * Name for the new variant. Must be unique for this metric within your
+     * organization and cannot be `Default`.
+     */
+    name: string;
+}
+export interface MetricVariantUpdateParams {
+    /**
+     * Path param: Metric definition UUID or its stable slug.
+     */
+    idOrSlug: string;
+    /**
+     * Body param: What a `false` value means. Given to the judge as its polarity rule,
+     * so keep it accurate.
+     */
+    booleanFalseLabel?: string;
+    /**
+     * Body param: What a `true` value means. Given to the judge as its polarity rule,
+     * so keep it accurate.
+     */
+    booleanTrueLabel?: string;
+    /**
+     * Body param: Free-text audit note recorded on the new version.
+     */
+    changeReason?: string;
+    /**
+     * Body param: The rubric this variant applies. LLM judge metrics only.
+     */
+    llmPrompt?: string;
+    /**
+     * Body param: Maximum classifications returned. CLASSIFICATION output only.
+     */
+    maxClassifications?: number;
+    /**
+     * Body param: Rename the variant. Does not change its configuration, so
+     * `versionId` is unaffected. `Default` is reserved.
+     */
+    name?: string;
+    /**
+     * Body param: Scale maximum. SCALE output only.
+     */
+    scaleMax?: number;
+    /**
+     * Body param: Scale minimum. SCALE output only.
+     */
+    scaleMin?: number;
+}
+export interface MetricVariantDeleteParams {
+    /**
+     * Metric definition UUID or its stable slug.
+     */
+    idOrSlug: string;
+}
+export interface MetricVariantGetByIDParams {
+    /**
+     * Metric definition UUID or its stable slug.
+     */
+    idOrSlug: string;
+}
+export declare namespace MetricVariant {
+    export { type MetricVariantCreateResponse as MetricVariantCreateResponse, type MetricVariantUpdateResponse as MetricVariantUpdateResponse, type MetricVariantListResponse as MetricVariantListResponse, type MetricVariantDeleteResponse as MetricVariantDeleteResponse, type MetricVariantGetByIDResponse as MetricVariantGetByIDResponse, type MetricVariantCreateParams as MetricVariantCreateParams, type MetricVariantUpdateParams as MetricVariantUpdateParams, type MetricVariantDeleteParams as MetricVariantDeleteParams, type MetricVariantGetByIDParams as MetricVariantGetByIDParams, };
+}
+//# sourceMappingURL=metric-variant.d.ts.map

package/resources/metric-variant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-variant.d.ts","sourceRoot":"","sources":["../src/resources/metric-variant.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAQ1C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIvF;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;OAUG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAI5C;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,IAAI,CAAC;KACf;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/metric-variant.js

@@ -0,0 +1,112 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricVariant = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class MetricVariant extends resource_1.APIResource {
+    /**
+     * Add a configuration of this metric for your organization, seeded from its
+     * Default. Edit it with PUT to change what it measures, then pin it where you want
+     * it used.
+     *
+     * Threshold metrics have no variants: their configuration comes from the metric
+     * they derive from. Metrics in a package that manages its own variants reject this
+     * too.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.create(
+     *   'idOrSlug',
+     *   { name: 'Strict' },
+     * );
+     * ```
+     */
+    create(idOrSlug, body, options) {
+        return this._client.post((0, path_1.path) `/v1/metric/definitions/${idOrSlug}/variants`, { body, ...options });
+    }
+    /**
+     * Rename a variant, change its configuration, or both. Every configuration change
+     * creates a new immutable version and advances `versionId`; the response carries
+     * the advanced value.
+     *
+     * **Editing one of Roark’s own variants forks it for your organization.** The
+     * response carries the new variant’s `id`, which will differ from the one in the
+     * path, and `isSystem` becomes false. Roark’s variant is untouched and other
+     * organizations keep it. DELETE your fork to go back to it.
+     *
+     * Which fields are editable depends on the metric: some Roark metrics lock their
+     * prompt or output configuration, and a locked field is rejected rather than
+     * ignored.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    update(variantID, params, options) {
+        const { idOrSlug, ...body } = params;
+        return this._client.put((0, path_1.path) `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Every configuration of this metric your organization can use: Roark’s own
+     * variants and any your organization has added or forked. `isDefault` marks the
+     * one the metric is scored with when nothing pins another; pass any variant’s `id`
+     * as `sourceVariantId` to pin it on a derived metric.
+     *
+     * Auto-managed variants (the ones a package materializes for you) are not listed:
+     * they are engine state, not configuration you author.
+     *
+     * @example
+     * ```ts
+     * const metricVariants =
+     *   await client.metricVariant.list('idOrSlug');
+     * ```
+     */
+    list(idOrSlug, options) {
+        return this._client.get((0, path_1.path) `/v1/metric/definitions/${idOrSlug}/variants`, options);
+    }
+    /**
+     * Remove one of your organization’s variants. Anything pinned to it falls back to
+     * the Default, so deleting a fork of a Roark variant returns you to Roark’s
+     * configuration.
+     *
+     * Roark’s own variants cannot be deleted, and neither can a Default. Values
+     * already collected under the deleted variant are retained.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    delete(variantID, params, options) {
+        const { idOrSlug } = params;
+        return this._client.delete((0, path_1.path) `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, options);
+    }
+    /**
+     * One configuration of this metric, by id.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricVariant.getByID(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    getByID(variantID, params, options) {
+        const { idOrSlug } = params;
+        return this._client.get((0, path_1.path) `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, options);
+    }
+}
+exports.MetricVariant = MetricVariant;
+//# sourceMappingURL=metric-variant.js.map

package/resources/metric-variant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-variant.js","sourceRoot":"","sources":["../src/resources/metric-variant.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,0BAA0B,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,QAAgB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,QAAQ,WAAW,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF;AA3HD,sCA2HC"}

package/resources/metric-variant.mjs

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class MetricVariant extends APIResource {
+    /**
+     * Add a configuration of this metric for your organization, seeded from its
+     * Default. Edit it with PUT to change what it measures, then pin it where you want
+     * it used.
+     *
+     * Threshold metrics have no variants: their configuration comes from the metric
+     * they derive from. Metrics in a package that manages its own variants reject this
+     * too.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.create(
+     *   'idOrSlug',
+     *   { name: 'Strict' },
+     * );
+     * ```
+     */
+    create(idOrSlug, body, options) {
+        return this._client.post(path `/v1/metric/definitions/${idOrSlug}/variants`, { body, ...options });
+    }
+    /**
+     * Rename a variant, change its configuration, or both. Every configuration change
+     * creates a new immutable version and advances `versionId`; the response carries
+     * the advanced value.
+     *
+     * **Editing one of Roark’s own variants forks it for your organization.** The
+     * response carries the new variant’s `id`, which will differ from the one in the
+     * path, and `isSystem` becomes false. Roark’s variant is untouched and other
+     * organizations keep it. DELETE your fork to go back to it.
+     *
+     * Which fields are editable depends on the metric: some Roark metrics lock their
+     * prompt or output configuration, and a locked field is rejected rather than
+     * ignored.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    update(variantID, params, options) {
+        const { idOrSlug, ...body } = params;
+        return this._client.put(path `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Every configuration of this metric your organization can use: Roark’s own
+     * variants and any your organization has added or forked. `isDefault` marks the
+     * one the metric is scored with when nothing pins another; pass any variant’s `id`
+     * as `sourceVariantId` to pin it on a derived metric.
+     *
+     * Auto-managed variants (the ones a package materializes for you) are not listed:
+     * they are engine state, not configuration you author.
+     *
+     * @example
+     * ```ts
+     * const metricVariants =
+     *   await client.metricVariant.list('idOrSlug');
+     * ```
+     */
+    list(idOrSlug, options) {
+        return this._client.get(path `/v1/metric/definitions/${idOrSlug}/variants`, options);
+    }
+    /**
+     * Remove one of your organization’s variants. Anything pinned to it falls back to
+     * the Default, so deleting a fork of a Roark variant returns you to Roark’s
+     * configuration.
+     *
+     * Roark’s own variants cannot be deleted, and neither can a Default. Values
+     * already collected under the deleted variant are retained.
+     *
+     * @example
+     * ```ts
+     * const metricVariant = await client.metricVariant.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    delete(variantID, params, options) {
+        const { idOrSlug } = params;
+        return this._client.delete(path `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, options);
+    }
+    /**
+     * One configuration of this metric, by id.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricVariant.getByID(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   { idOrSlug: 'idOrSlug' },
+     * );
+     * ```
+     */
+    getByID(variantID, params, options) {
+        const { idOrSlug } = params;
+        return this._client.get(path `/v1/metric/definitions/${idOrSlug}/variants/${variantID}`, options);
+    }
+}
+//# sourceMappingURL=metric-variant.mjs.map

package/resources/metric-variant.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-variant.mjs","sourceRoot":"","sources":["../src/resources/metric-variant.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,0BAA0B,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,QAAgB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,QAAQ,WAAW,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,SAAiB,EACjB,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,QAAQ,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF"}