@azure-rest/onlineexperimentation 1.0.0-alpha.20250613.5

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release History
+    
+## 1.0.0-beta.1 (2025-06-10)
+
+### Features Added
+
+Initial release of the @azure-rest/onlineexperimentation package

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,98 @@
+# Azure OnlineExperimentation REST client library for JavaScript
+
+Azure Online Experimentation Service
+
+**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+Key links:
+
+- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/onlineexperimentation/onlineexperimentation-rest)
+- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/onlineexperimentation)
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+
+### Install the `@azure-rest/onlineexperimentation` package
+
+Install the Azure OnlineExperimentation REST client REST client library for JavaScript with `npm`:
+
+```bash
+npm install @azure-rest/onlineexperimentation
+```
+
+### Create and authenticate a `OnlineExperimentationClient`
+
+The Azure Online Experimentation client library initialization requires two parameters:
+
+- The `endpoint` property value from the [`Microsoft.OnlineExperimentation/workspaces`](https://learn.microsoft.com/azure/templates/microsoft.onlineexperimentation/workspaces) resource.
+- A `TokenCredential` for authentication, the simplest approach is to use [`DefaultAzureCredential`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) from the `@azure/identity` library.
+
+```ts snippet:InitializeClient
+import { DefaultAzureCredential } from "@azure/identity";
+import { OnlineExperimentationClient } from "@azure-rest/onlineexperimentation";
+
+const endpoint = process.env.AZURE_ONLINEEXPERIMENTATION_ENDPOINT || "<endpoint>";
+const credential = new DefaultAzureCredential();
+// Initialize a client with default API version
+const client = OnlineExperimentationClient(endpoint, credential);
+```
+
+## Examples
+
+- Full set of [examples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/onlineexperimentation/onlineexperimentation-rest/EXAMPLES.md) demonstrating individual API operations.
+- Example demonstrating experiment metrics management lifecycle: [TypeScript](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/onlineexperimentation/onlineexperimentation-rest/samples/v1-beta/typescript/README.md) and [JavaScript](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/onlineexperimentation/onlineexperimentation-rest/samples/v1-beta/javascript/README.md).
+
+### Quick Start - Initialize Client and List Experiment Metrics
+
+The Azure OnlineExperimentation REST client library initialization requires two parameters:
+
+- The `endpoint` property value from the [`Microsoft.OnlineExperimentation/workspaces`](https://learn.microsoft.com/azure/templates/microsoft.onlineexperimentation/workspaces) resource.
+- A `TokenCredential` for authentication, the simplest approach is to use [`DefaultAzureCredential`](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md#defaultazurecredential).
+
+```ts snippet:ListExperimentMetrics
+import { DefaultAzureCredential } from "@azure/identity";
+import {
+  OnlineExperimentationClient,
+  isUnexpected,
+  paginate,
+} from "@azure-rest/onlineexperimentation";
+
+const endpoint = process.env.AZURE_ONLINEEXPERIMENTATION_ENDPOINT || "<endpoint>";
+const credential = new DefaultAzureCredential();
+const client = OnlineExperimentationClient(endpoint, credential);
+const listResponse = await client.path("/experiment-metrics").get({
+  queryParameters: {
+    top: 10,
+    skip: 0,
+  },
+});
+if (isUnexpected(listResponse)) {
+  throw listResponse;
+}
+for await (const metric of paginate(client, listResponse)) {
+  // Access metric properties
+  const id = metric.id;
+  const name = metric.displayName;
+}
+```
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/dist/browser/clientDefinitions.d.ts

@@ -0,0 +1,30 @@
+import type { GetMetricParameters, CreateOrUpdateMetricParameters, DeleteMetricParameters, ValidateMetricParameters, ListMetricsParameters } from "./parameters.js";
+import type { GetMetric200Response, GetMetricDefaultResponse, CreateOrUpdateMetric200Response, CreateOrUpdateMetric201Response, CreateOrUpdateMetricDefaultResponse, DeleteMetric204Response, DeleteMetricDefaultResponse, ValidateMetric200Response, ValidateMetricDefaultResponse, ListMetrics200Response, ListMetricsDefaultResponse } from "./responses.js";
+import type { Client, StreamableMethod } from "@azure-rest/core-client";
+export interface GetMetric {
+    /** Fetches an experiment metric by ID. */
+    get(options?: GetMetricParameters): StreamableMethod<GetMetric200Response | GetMetricDefaultResponse>;
+    /** Creates or updates an experiment metric. */
+    patch(options: CreateOrUpdateMetricParameters): StreamableMethod<CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse>;
+    /** Deletes an experiment metric. */
+    delete(options?: DeleteMetricParameters): StreamableMethod<DeleteMetric204Response | DeleteMetricDefaultResponse>;
+}
+export interface ValidateMetric {
+    /** Validates an experiment metric definition. */
+    post(options: ValidateMetricParameters): StreamableMethod<ValidateMetric200Response | ValidateMetricDefaultResponse>;
+}
+export interface ListMetrics {
+    /** Lists experiment metrics. */
+    get(options?: ListMetricsParameters): StreamableMethod<ListMetrics200Response | ListMetricsDefaultResponse>;
+}
+export interface Routes {
+    /** Resource for '/experiment-metrics/\{experimentMetricId\}' has methods for the following verbs: get, patch, delete */
+    (path: "/experiment-metrics/{experimentMetricId}", experimentMetricId: string): GetMetric;
+    /** Resource for '/experiment-metrics:validate' has methods for the following verbs: post */
+    (path: "/experiment-metrics:validate"): ValidateMetric;
+    /** Resource for '/experiment-metrics' has methods for the following verbs: get */
+    (path: "/experiment-metrics"): ListMetrics;
+}
+export type OnlineExperimentationClient = Client & {
+    path: Routes;
+};

package/dist/browser/clientDefinitions.js

@@ -0,0 +1,3 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};

package/dist/browser/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/browser/extensibleEnums.js

@@ -0,0 +1,106 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Desired direction for an experiment metric value.
+ */
+export 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 || (KnownDesiredDirection = {}));
+/**
+ * How the metric definition calculates metric values from event data.
+ */
+export 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 || (KnownExperimentMetricType = {}));
+/**
+ * Lifecycle stages of an experiment metric, determining whether the metric is included in experiment analysis.
+ */
+export 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 || (KnownLifecycleStage = {}));
+/**
+ * The diagnostic error codes.
+ */
+export 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 || (KnownDiagnosticCode = {}));
+/**
+ * The result of validating an experiment metric.
+ */
+export var KnownValidationResult;
+(function (KnownValidationResult) {
+    /**
+     * The experiment metric is valid.
+     */
+    KnownValidationResult["Valid"] = "Valid";
+    /**
+     * The experiment metric is invalid.
+     */
+    KnownValidationResult["Invalid"] = "Invalid";
+})(KnownValidationResult || (KnownValidationResult = {}));

package/dist/browser/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/browser/index.js

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+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/browser/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/browser/isUnexpected.js

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+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"],
+};
+export 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/browser/logger.d.ts

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

package/dist/browser/logger.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { createClientLogger } from "@azure/logger";
+export const logger = createClientLogger("onlineexperimentation");

package/dist/browser/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/browser/models.js

@@ -0,0 +1,3 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};

package/dist/browser/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/browser/onlineExperimentationClient.js

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { getClient } from "@azure-rest/core-client";
+import { logger } from "./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
+ */
+export default 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.info,
+        },
+        credentials: {
+            scopes: options.credentials?.scopes ?? ["https://exp.azure.net/.default"],
+        },
+    };
+    const client = 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;
+}