@azure-rest/onlineexperimentation 1.0.0-alpha.20250613.5

package/dist/commonjs/extensibleEnums.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Desired direction for an experiment metric value.
+ */
+export declare enum KnownDesiredDirection {
+    /**
+     * An increase to the metric value is desired. E.g., Success rate, Total revenue.
+     */
+    Increase = "Increase",
+    /**
+     * A decrease to the metric value is desired. E.g., Error rate, Latency.
+     */
+    Decrease = "Decrease",
+    /**
+     * Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks
+     */
+    Neutral = "Neutral"
+}
+/**
+ * How the metric definition calculates metric values from event data.
+ */
+export declare enum KnownExperimentMetricType {
+    /**
+     * Counts the occurrences of an event. Experiment analysis accounts for unequal traffic allocation.
+     */
+    EventCount = "EventCount",
+    /**
+     * Counts the number of unique users who encounter an event. Experiment analysis accounts for unequal traffic allocation.
+     */
+    UserCount = "UserCount",
+    /**
+     * Calculates the percentage of events that satisfy a specified condition.
+     */
+    EventRate = "EventRate",
+    /**
+     * Calculates the percentage of users who encounter a start event and subsequently encounter an end event. Users must encounter the start event before the end event to be counted.
+     */
+    UserRate = "UserRate",
+    /**
+     * Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation.
+     */
+    Sum = "Sum",
+    /**
+     * Calculates the average value of a specified event property.
+     */
+    Average = "Average",
+    /**
+     * Calculates a specified percentile of an event property.
+     */
+    Percentile = "Percentile"
+}
+/**
+ * Lifecycle stages of an experiment metric, determining whether the metric is included in experiment analysis.
+ */
+export declare enum KnownLifecycleStage {
+    /**
+     * The metric is included in experiment analysis.
+     */
+    Active = "Active",
+    /**
+     * The metric is excluded from experiment analysis but remains available for future use.
+     */
+    Inactive = "Inactive"
+}
+/**
+ * The diagnostic error codes.
+ */
+export declare enum KnownDiagnosticCode {
+    /**
+     * The metric definition does not conform to the JSON schema.
+     */
+    FailedSchemaValidation = "FailedSchemaValidation",
+    /**
+     * The event filter condition is invalid.
+     */
+    InvalidEventCondition = "InvalidEventCondition",
+    /**
+     * Event filter condition has valid syntax but is not currently supported.
+     */
+    UnsupportedEventCondition = "UnsupportedEventCondition",
+    /**
+     * The provided experiment metric definition is invalid.
+     * For example, defining a metric to calculate the average of a numeric property but
+     * including a filter condition that compares it to a string value creates a type mismatch.
+     */
+    InvalidExperimentMetricDefinition = "InvalidExperimentMetricDefinition"
+}
+/**
+ * The result of validating an experiment metric.
+ */
+export declare enum KnownValidationResult {
+    /**
+     * The experiment metric is valid.
+     */
+    Valid = "Valid",
+    /**
+     * The experiment metric is invalid.
+     */
+    Invalid = "Invalid"
+}

package/dist/commonjs/extensibleEnums.js

@@ -0,0 +1,109 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnownValidationResult = exports.KnownDiagnosticCode = exports.KnownLifecycleStage = exports.KnownExperimentMetricType = exports.KnownDesiredDirection = void 0;
+/**
+ * Desired direction for an experiment metric value.
+ */
+var KnownDesiredDirection;
+(function (KnownDesiredDirection) {
+    /**
+     * An increase to the metric value is desired. E.g., Success rate, Total revenue.
+     */
+    KnownDesiredDirection["Increase"] = "Increase";
+    /**
+     * A decrease to the metric value is desired. E.g., Error rate, Latency.
+     */
+    KnownDesiredDirection["Decrease"] = "Decrease";
+    /**
+     * Neither an increase nor a decrease to the metric value is desired, or the desired direction depends on other factors. E.g., Number of video play attempts, Number of user feedbacks
+     */
+    KnownDesiredDirection["Neutral"] = "Neutral";
+})(KnownDesiredDirection || (exports.KnownDesiredDirection = KnownDesiredDirection = {}));
+/**
+ * How the metric definition calculates metric values from event data.
+ */
+var KnownExperimentMetricType;
+(function (KnownExperimentMetricType) {
+    /**
+     * Counts the occurrences of an event. Experiment analysis accounts for unequal traffic allocation.
+     */
+    KnownExperimentMetricType["EventCount"] = "EventCount";
+    /**
+     * Counts the number of unique users who encounter an event. Experiment analysis accounts for unequal traffic allocation.
+     */
+    KnownExperimentMetricType["UserCount"] = "UserCount";
+    /**
+     * Calculates the percentage of events that satisfy a specified condition.
+     */
+    KnownExperimentMetricType["EventRate"] = "EventRate";
+    /**
+     * Calculates the percentage of users who encounter a start event and subsequently encounter an end event. Users must encounter the start event before the end event to be counted.
+     */
+    KnownExperimentMetricType["UserRate"] = "UserRate";
+    /**
+     * Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation.
+     */
+    KnownExperimentMetricType["Sum"] = "Sum";
+    /**
+     * Calculates the average value of a specified event property.
+     */
+    KnownExperimentMetricType["Average"] = "Average";
+    /**
+     * Calculates a specified percentile of an event property.
+     */
+    KnownExperimentMetricType["Percentile"] = "Percentile";
+})(KnownExperimentMetricType || (exports.KnownExperimentMetricType = KnownExperimentMetricType = {}));
+/**
+ * Lifecycle stages of an experiment metric, determining whether the metric is included in experiment analysis.
+ */
+var KnownLifecycleStage;
+(function (KnownLifecycleStage) {
+    /**
+     * The metric is included in experiment analysis.
+     */
+    KnownLifecycleStage["Active"] = "Active";
+    /**
+     * The metric is excluded from experiment analysis but remains available for future use.
+     */
+    KnownLifecycleStage["Inactive"] = "Inactive";
+})(KnownLifecycleStage || (exports.KnownLifecycleStage = KnownLifecycleStage = {}));
+/**
+ * The diagnostic error codes.
+ */
+var KnownDiagnosticCode;
+(function (KnownDiagnosticCode) {
+    /**
+     * The metric definition does not conform to the JSON schema.
+     */
+    KnownDiagnosticCode["FailedSchemaValidation"] = "FailedSchemaValidation";
+    /**
+     * The event filter condition is invalid.
+     */
+    KnownDiagnosticCode["InvalidEventCondition"] = "InvalidEventCondition";
+    /**
+     * Event filter condition has valid syntax but is not currently supported.
+     */
+    KnownDiagnosticCode["UnsupportedEventCondition"] = "UnsupportedEventCondition";
+    /**
+     * The provided experiment metric definition is invalid.
+     * For example, defining a metric to calculate the average of a numeric property but
+     * including a filter condition that compares it to a string value creates a type mismatch.
+     */
+    KnownDiagnosticCode["InvalidExperimentMetricDefinition"] = "InvalidExperimentMetricDefinition";
+})(KnownDiagnosticCode || (exports.KnownDiagnosticCode = KnownDiagnosticCode = {}));
+/**
+ * The result of validating an experiment metric.
+ */
+var KnownValidationResult;
+(function (KnownValidationResult) {
+    /**
+     * The experiment metric is valid.
+     */
+    KnownValidationResult["Valid"] = "Valid";
+    /**
+     * The experiment metric is invalid.
+     */
+    KnownValidationResult["Invalid"] = "Invalid";
+})(KnownValidationResult || (exports.KnownValidationResult = KnownValidationResult = {}));

package/dist/commonjs/index.d.ts

@@ -0,0 +1,11 @@
+import OnlineExperimentationClient from "./onlineExperimentationClient.js";
+export * from "./onlineExperimentationClient.js";
+export * from "./parameters.js";
+export * from "./responses.js";
+export * from "./clientDefinitions.js";
+export * from "./isUnexpected.js";
+export * from "./models.js";
+export * from "./outputModels.js";
+export * from "./paginateHelper.js";
+export * from "./extensibleEnums.js";
+export { OnlineExperimentationClient };

package/dist/commonjs/index.js

@@ -0,0 +1,33 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnlineExperimentationClient = void 0;
+const onlineExperimentationClient_js_1 = __importDefault(require("./onlineExperimentationClient.js"));
+exports.OnlineExperimentationClient = onlineExperimentationClient_js_1.default;
+__exportStar(require("./onlineExperimentationClient.js"), exports);
+__exportStar(require("./parameters.js"), exports);
+__exportStar(require("./responses.js"), exports);
+__exportStar(require("./clientDefinitions.js"), exports);
+__exportStar(require("./isUnexpected.js"), exports);
+__exportStar(require("./models.js"), exports);
+__exportStar(require("./outputModels.js"), exports);
+__exportStar(require("./paginateHelper.js"), exports);
+__exportStar(require("./extensibleEnums.js"), exports);

package/dist/commonjs/isUnexpected.d.ts

@@ -0,0 +1,6 @@
+import type { GetMetric200Response, GetMetricDefaultResponse, CreateOrUpdateMetric200Response, CreateOrUpdateMetric201Response, CreateOrUpdateMetricDefaultResponse, DeleteMetric204Response, DeleteMetricDefaultResponse, ValidateMetric200Response, ValidateMetricDefaultResponse, ListMetrics200Response, ListMetricsDefaultResponse } from "./responses.js";
+export declare function isUnexpected(response: GetMetric200Response | GetMetricDefaultResponse): response is GetMetricDefaultResponse;
+export declare function isUnexpected(response: CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse): response is CreateOrUpdateMetricDefaultResponse;
+export declare function isUnexpected(response: DeleteMetric204Response | DeleteMetricDefaultResponse): response is DeleteMetricDefaultResponse;
+export declare function isUnexpected(response: ValidateMetric200Response | ValidateMetricDefaultResponse): response is ValidateMetricDefaultResponse;
+export declare function isUnexpected(response: ListMetrics200Response | ListMetricsDefaultResponse): response is ListMetricsDefaultResponse;

package/dist/commonjs/isUnexpected.js

@@ -0,0 +1,75 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUnexpected = isUnexpected;
+const responseMap = {
+    "GET /experiment-metrics/{experimentMetricId}": ["200"],
+    "PATCH /experiment-metrics/{experimentMetricId}": ["200", "201"],
+    "DELETE /experiment-metrics/{experimentMetricId}": ["204"],
+    "POST /experiment-metrics:validate": ["200"],
+    "GET /experiment-metrics": ["200"],
+};
+function isUnexpected(response) {
+    const lroOriginal = response.headers["x-ms-original-url"];
+    const url = new URL(lroOriginal ?? response.request.url);
+    const method = response.request.method;
+    let pathDetails = responseMap[`${method} ${url.pathname}`];
+    if (!pathDetails) {
+        pathDetails = getParametrizedPathSuccess(method, url.pathname);
+    }
+    return !pathDetails.includes(response.status);
+}
+function getParametrizedPathSuccess(method, path) {
+    const pathParts = path.split("/");
+    // Traverse list to match the longest candidate
+    // matchedLen: the length of candidate path
+    // matchedValue: the matched status code array
+    let matchedLen = -1, matchedValue = [];
+    // Iterate the responseMap to find a match
+    for (const [key, value] of Object.entries(responseMap)) {
+        // Extracting the path from the map key which is in format
+        // GET /path/foo
+        if (!key.startsWith(method)) {
+            continue;
+        }
+        const candidatePath = getPathFromMapKey(key);
+        // Get each part of the url path
+        const candidateParts = candidatePath.split("/");
+        // track if we have found a match to return the values found.
+        let found = true;
+        for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
+            if (candidateParts[i]?.startsWith("{") && candidateParts[i]?.indexOf("}") !== -1) {
+                const start = candidateParts[i].indexOf("}") + 1, end = candidateParts[i]?.length;
+                // If the current part of the candidate is a "template" part
+                // Try to use the suffix of pattern to match the path
+                // {guid} ==> $
+                // {guid}:export ==> :export$
+                const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(pathParts[j] || "");
+                if (!isMatched) {
+                    found = false;
+                    break;
+                }
+                continue;
+            }
+            // If the candidate part is not a template and
+            // the parts don't match mark the candidate as not found
+            // to move on with the next candidate path.
+            if (candidateParts[i] !== pathParts[j]) {
+                found = false;
+                break;
+            }
+        }
+        // We finished evaluating the current candidate parts
+        // Update the matched value if and only if we found the longer pattern
+        if (found && candidatePath.length > matchedLen) {
+            matchedLen = candidatePath.length;
+            matchedValue = value;
+        }
+    }
+    return matchedValue;
+}
+function getPathFromMapKey(mapKey) {
+    const pathStart = mapKey.indexOf("/");
+    return mapKey.slice(pathStart);
+}

package/dist/commonjs/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("@azure/logger").AzureLogger;

package/dist/commonjs/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger_1 = require("@azure/logger");
+exports.logger = (0, logger_1.createClientLogger)("onlineexperimentation");

package/dist/commonjs/models.d.ts

@@ -0,0 +1,104 @@
+/** Defines experiment metric metadata and computation details. */
+export interface ExperimentMetric {
+    /**
+     * Determines whether it is included in experiment analysis.
+     *
+     * Possible values: "Active", "Inactive"
+     */
+    lifecycle: LifecycleStage;
+    /** A user-friendly display name for the experiment metric shown in reports and dashboards. */
+    displayName: string;
+    /** A detailed description of the experiment metric. */
+    description: string;
+    /** Categories associated with the experiment metric. Used for organizing and filtering metrics. */
+    categories: string[];
+    /**
+     * The desired direction for changes in the metric value.
+     *
+     * Possible values: "Increase", "Decrease", "Neutral"
+     */
+    desiredDirection: DesiredDirection;
+    /** The metric definition specifying how the metric value is calculated from event data. */
+    definition: ExperimentMetricDefinition;
+}
+/** The metric definition, which determines how the metric value is calculated from event data. */
+export interface ExperimentMetricDefinitionParent {
+    type: string;
+}
+/** The definition of an EventCount metric definition. Counts the occurrences of a specified event. */
+export interface EventCountMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "EventCount";
+    /** Event to observe. */
+    event: ObservedEvent;
+}
+/** An event observed by a metric. */
+export interface ObservedEvent {
+    /** The name of the event. */
+    eventName: string;
+    /** [Optional] A condition to filter events. */
+    filter?: string;
+}
+/** The definition of a UserCount metric definition. Counts unique users who encounter a specified event. */
+export interface UserCountMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "UserCount";
+    /** Event to observe. */
+    event: ObservedEvent;
+}
+/** The definition of an EventRate metric definition. Calculates the percentage of events satisfying a specified condition. */
+export interface EventRateMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "EventRate";
+    /** Event to observe as the rate denominator. */
+    event: ObservedEvent;
+    /** The event contributes to the rate numerator if it satisfies this condition. */
+    rateCondition: string;
+}
+/** The definition of a UserRate metric definition. Calculates the percentage of users who encounter a start event and subsequently an end event. Users must encounter events in the specified order. */
+export interface UserRateMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "UserRate";
+    /** The start event to observe as the rate denominator. */
+    startEvent: ObservedEvent;
+    /** The end event to observe, which is a condition for the rate numerator. */
+    endEvent: ObservedEvent;
+}
+/** The definition of a Sum metric definition. Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation. */
+export interface SumMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "Sum";
+    /** The value to aggregate. */
+    value: AggregatedValue;
+}
+/** An event property value aggregated by a metric. */
+export interface AggregatedValue {
+    /** The name of the event. */
+    eventName: string;
+    /** [Optional] A condition to filter events. */
+    filter?: string;
+    /** The key of the event property to aggregate. */
+    eventProperty: string;
+}
+/** The definition of an Average metric definition. Calculates the average value of a specified event property. */
+export interface AverageMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "Average";
+    /** The value to aggregate. */
+    value: AggregatedValue;
+}
+/** The definition of a Percentile metric definition. Calculates a specified percentile of an event property. */
+export interface PercentileMetricDefinition extends ExperimentMetricDefinitionParent {
+    /** The type of metric. */
+    type: "Percentile";
+    /** The value to aggregate, including the event name and property to measure. */
+    value: AggregatedValue;
+    /** The percentile to measure. */
+    percentile: number;
+}
+/** The metric definition, which determines how the metric value is calculated from event data. */
+export type ExperimentMetricDefinition = ExperimentMetricDefinitionParent | EventCountMetricDefinition | UserCountMetricDefinition | EventRateMetricDefinition | UserRateMetricDefinition | SumMetricDefinition | AverageMetricDefinition | PercentileMetricDefinition;
+/** Alias for LifecycleStage */
+export type LifecycleStage = string;
+/** Alias for DesiredDirection */
+export type DesiredDirection = string;

package/dist/commonjs/models.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commonjs/onlineExperimentationClient.d.ts

@@ -0,0 +1,15 @@
+import type { ClientOptions } from "@azure-rest/core-client";
+import type { TokenCredential } from "@azure/core-auth";
+import type { OnlineExperimentationClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface OnlineExperimentationClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `OnlineExperimentationClient`
+ * @param endpointParam - Endpoint URL for the Online Experimentation workspace.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(endpointParam: string, credentials: TokenCredential, { apiVersion, ...options }?: OnlineExperimentationClientOptions): OnlineExperimentationClient;

package/dist/commonjs/onlineExperimentationClient.js

@@ -0,0 +1,48 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createClient;
+const core_client_1 = require("@azure-rest/core-client");
+const logger_js_1 = require("./logger.js");
+/**
+ * Initialize a new instance of `OnlineExperimentationClient`
+ * @param endpointParam - Endpoint URL for the Online Experimentation workspace.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+function createClient(endpointParam, credentials, { apiVersion = "2025-05-31-preview", ...options } = {}) {
+    const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;
+    const userAgentInfo = `azsdk-js-@azure-rest/onlineexperimentation/1.0.0-beta.1`;
+    const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
+        : `${userAgentInfo}`;
+    const clientOptions = {
+        ...options,
+        userAgentOptions: {
+            userAgentPrefix,
+        },
+        loggingOptions: {
+            logger: options.loggingOptions?.logger ?? logger_js_1.logger.info,
+        },
+        credentials: {
+            scopes: options.credentials?.scopes ?? ["https://exp.azure.net/.default"],
+        },
+    };
+    const client = (0, core_client_1.getClient)(endpointUrl, credentials, clientOptions);
+    client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
+    client.pipeline.addPolicy({
+        name: "ClientApiVersionPolicy",
+        sendRequest: (req, next) => {
+            // Use the apiVersion defined in request url directly
+            // Append one if there is no apiVersion and we have one at client options
+            const url = new URL(req.url);
+            if (!url.searchParams.get("api-version") && apiVersion) {
+                // eslint-disable-next-line no-param-reassign
+                req.url = `${req.url}${Array.from(url.searchParams.keys()).length > 0 ? "&" : "?"}api-version=${apiVersion}`;
+            }
+            return next(req);
+        },
+    });
+    return client;
+}

package/dist/commonjs/outputModels.d.ts

@@ -0,0 +1,137 @@
+/** Defines experiment metric metadata and computation details. */
+export interface ExperimentMetricOutput {
+    /** Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. */
+    readonly id: string;
+    /**
+     * Determines whether it is included in experiment analysis.
+     *
+     * Possible values: "Active", "Inactive"
+     */
+    lifecycle: LifecycleStageOutput;
+    /** A user-friendly display name for the experiment metric shown in reports and dashboards. */
+    displayName: string;
+    /** A detailed description of the experiment metric. */
+    description: string;
+    /** Categories associated with the experiment metric. Used for organizing and filtering metrics. */
+    categories: string[];
+    /**
+     * The desired direction for changes in the metric value.
+     *
+     * Possible values: "Increase", "Decrease", "Neutral"
+     */
+    desiredDirection: DesiredDirectionOutput;
+    /** The metric definition specifying how the metric value is calculated from event data. */
+    definition: ExperimentMetricDefinitionOutput;
+    /** ETag of the experiment metric. */
+    readonly eTag: string;
+    /** The timestamp (UTC) of the last modification to the experiment metric resource. */
+    readonly lastModifiedAt: string;
+}
+/** The metric definition, which determines how the metric value is calculated from event data. */
+export interface ExperimentMetricDefinitionOutputParent {
+    type: string;
+}
+/** The definition of an EventCount metric definition. Counts the occurrences of a specified event. */
+export interface EventCountMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "EventCount";
+    /** Event to observe. */
+    event: ObservedEventOutput;
+}
+/** An event observed by a metric. */
+export interface ObservedEventOutput {
+    /** The name of the event. */
+    eventName: string;
+    /** [Optional] A condition to filter events. */
+    filter?: string;
+}
+/** The definition of a UserCount metric definition. Counts unique users who encounter a specified event. */
+export interface UserCountMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "UserCount";
+    /** Event to observe. */
+    event: ObservedEventOutput;
+}
+/** The definition of an EventRate metric definition. Calculates the percentage of events satisfying a specified condition. */
+export interface EventRateMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "EventRate";
+    /** Event to observe as the rate denominator. */
+    event: ObservedEventOutput;
+    /** The event contributes to the rate numerator if it satisfies this condition. */
+    rateCondition: string;
+}
+/** The definition of a UserRate metric definition. Calculates the percentage of users who encounter a start event and subsequently an end event. Users must encounter events in the specified order. */
+export interface UserRateMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "UserRate";
+    /** The start event to observe as the rate denominator. */
+    startEvent: ObservedEventOutput;
+    /** The end event to observe, which is a condition for the rate numerator. */
+    endEvent: ObservedEventOutput;
+}
+/** The definition of a Sum metric definition. Calculates the sum of a specified event property. Experiment analysis accounts for unequal traffic allocation. */
+export interface SumMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "Sum";
+    /** The value to aggregate. */
+    value: AggregatedValueOutput;
+}
+/** An event property value aggregated by a metric. */
+export interface AggregatedValueOutput {
+    /** The name of the event. */
+    eventName: string;
+    /** [Optional] A condition to filter events. */
+    filter?: string;
+    /** The key of the event property to aggregate. */
+    eventProperty: string;
+}
+/** The definition of an Average metric definition. Calculates the average value of a specified event property. */
+export interface AverageMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "Average";
+    /** The value to aggregate. */
+    value: AggregatedValueOutput;
+}
+/** The definition of a Percentile metric definition. Calculates a specified percentile of an event property. */
+export interface PercentileMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    /** The type of metric. */
+    type: "Percentile";
+    /** The value to aggregate, including the event name and property to measure. */
+    value: AggregatedValueOutput;
+    /** The percentile to measure. */
+    percentile: number;
+}
+/** The result of validating an experiment metric. */
+export interface ExperimentMetricValidationResultOutput {
+    /** Indicates whether the experiment metric is valid. */
+    isValid: boolean;
+    /** Diagnostic details from the validation process. */
+    readonly diagnostics: Array<DiagnosticDetailOutput>;
+}
+/** Diagnostic details for validation errors. */
+export interface DiagnosticDetailOutput {
+    /** A human-readable error message. */
+    readonly message: string;
+    /**
+     * The diagnostic error code.
+     *
+     * Possible values: "FailedSchemaValidation", "InvalidEventCondition", "UnsupportedEventCondition", "InvalidExperimentMetricDefinition"
+     */
+    readonly code: DiagnosticCodeOutput;
+}
+/** Paged collection of ExperimentMetric items */
+export interface PagedExperimentMetricOutput {
+    /** The ExperimentMetric items on this page */
+    value: Array<ExperimentMetricOutput>;
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+/** The metric definition, which determines how the metric value is calculated from event data. */
+export type ExperimentMetricDefinitionOutput = ExperimentMetricDefinitionOutputParent | EventCountMetricDefinitionOutput | UserCountMetricDefinitionOutput | EventRateMetricDefinitionOutput | UserRateMetricDefinitionOutput | SumMetricDefinitionOutput | AverageMetricDefinitionOutput | PercentileMetricDefinitionOutput;
+/** Alias for LifecycleStageOutput */
+export type LifecycleStageOutput = string;
+/** Alias for DesiredDirectionOutput */
+export type DesiredDirectionOutput = string;
+/** Alias for DiagnosticCodeOutput */
+export type DiagnosticCodeOutput = string;

package/dist/commonjs/outputModels.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });