@azure-rest/onlineexperimentation 1.0.0-alpha.20250613.5

package/review/onlineexperimentation.api.md

@@ -0,0 +1,612 @@
+## API Report File for "@azure-rest/onlineexperimentation"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Client } from '@azure-rest/core-client';
+import type { ClientOptions } from '@azure-rest/core-client';
+import type { ErrorResponse } from '@azure-rest/core-client';
+import type { HttpResponse } from '@azure-rest/core-client';
+import type { PathUncheckedResponse } from '@azure-rest/core-client';
+import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
+import type { RequestParameters } from '@azure-rest/core-client';
+import type { StreamableMethod } from '@azure-rest/core-client';
+import type { TokenCredential } from '@azure/core-auth';
+
+// @public
+export interface AggregatedValue {
+    eventName: string;
+    eventProperty: string;
+    filter?: string;
+}
+
+// @public
+export interface AggregatedValueOutput {
+    eventName: string;
+    eventProperty: string;
+    filter?: string;
+}
+
+// @public
+export interface AverageMetricDefinition extends ExperimentMetricDefinitionParent {
+    type: "Average";
+    value: AggregatedValue;
+}
+
+// @public
+export interface AverageMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    type: "Average";
+    value: AggregatedValueOutput;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetric200Headers {
+    "x-ms-client-request-id"?: string;
+    etag?: string;
+}
+
+// @public
+export interface CreateOrUpdateMetric200Response extends HttpResponse {
+    // (undocumented)
+    body: ExperimentMetricOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & CreateOrUpdateMetric200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetric201Headers {
+    "x-ms-client-request-id"?: string;
+    etag?: string;
+}
+
+// @public
+export interface CreateOrUpdateMetric201Response extends HttpResponse {
+    // (undocumented)
+    body: ExperimentMetricOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & CreateOrUpdateMetric201Headers;
+    // (undocumented)
+    status: "201";
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricBodyParam {
+    body: ExperimentMetricResourceMergeAndPatch;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & CreateOrUpdateMetricDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & CreateOrUpdateMetricHeaders;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricHeaders {
+    "If-Match"?: string;
+    "If-Modified-Since"?: string;
+    "If-None-Match"?: string;
+    "If-Unmodified-Since"?: string;
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export interface CreateOrUpdateMetricMediaTypesParam {
+    contentType: "application/merge-patch+json";
+}
+
+// @public (undocumented)
+export type CreateOrUpdateMetricParameters = CreateOrUpdateMetricHeaderParam & CreateOrUpdateMetricMediaTypesParam & CreateOrUpdateMetricBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface DeleteMetric204Headers {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface DeleteMetric204Response extends HttpResponse {
+    // (undocumented)
+    headers: RawHttpHeaders & DeleteMetric204Headers;
+    // (undocumented)
+    status: "204";
+}
+
+// @public (undocumented)
+export interface DeleteMetricDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface DeleteMetricDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & DeleteMetricDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface DeleteMetricHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & DeleteMetricHeaders;
+}
+
+// @public (undocumented)
+export interface DeleteMetricHeaders {
+    "If-Match"?: string;
+    "If-Modified-Since"?: string;
+    "If-None-Match"?: string;
+    "If-Unmodified-Since"?: string;
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type DeleteMetricParameters = DeleteMetricHeaderParam & RequestParameters;
+
+// @public
+export type DesiredDirection = string;
+
+// @public
+export type DesiredDirectionOutput = string;
+
+// @public
+export type DiagnosticCodeOutput = string;
+
+// @public
+export interface DiagnosticDetailOutput {
+    readonly code: DiagnosticCodeOutput;
+    readonly message: string;
+}
+
+// @public
+export interface EventCountMetricDefinition extends ExperimentMetricDefinitionParent {
+    event: ObservedEvent;
+    type: "EventCount";
+}
+
+// @public
+export interface EventCountMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    event: ObservedEventOutput;
+    type: "EventCount";
+}
+
+// @public
+export interface EventRateMetricDefinition extends ExperimentMetricDefinitionParent {
+    event: ObservedEvent;
+    rateCondition: string;
+    type: "EventRate";
+}
+
+// @public
+export interface EventRateMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    event: ObservedEventOutput;
+    rateCondition: string;
+    type: "EventRate";
+}
+
+// @public
+export interface ExperimentMetric {
+    categories: string[];
+    definition: ExperimentMetricDefinition;
+    description: string;
+    desiredDirection: DesiredDirection;
+    displayName: string;
+    lifecycle: LifecycleStage;
+}
+
+// @public
+export type ExperimentMetricDefinition = ExperimentMetricDefinitionParent | EventCountMetricDefinition | UserCountMetricDefinition | EventRateMetricDefinition | UserRateMetricDefinition | SumMetricDefinition | AverageMetricDefinition | PercentileMetricDefinition;
+
+// @public
+export type ExperimentMetricDefinitionOutput = ExperimentMetricDefinitionOutputParent | EventCountMetricDefinitionOutput | UserCountMetricDefinitionOutput | EventRateMetricDefinitionOutput | UserRateMetricDefinitionOutput | SumMetricDefinitionOutput | AverageMetricDefinitionOutput | PercentileMetricDefinitionOutput;
+
+// @public
+export interface ExperimentMetricDefinitionOutputParent {
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface ExperimentMetricDefinitionParent {
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface ExperimentMetricOutput {
+    categories: string[];
+    definition: ExperimentMetricDefinitionOutput;
+    description: string;
+    desiredDirection: DesiredDirectionOutput;
+    displayName: string;
+    readonly eTag: string;
+    readonly id: string;
+    readonly lastModifiedAt: string;
+    lifecycle: LifecycleStageOutput;
+}
+
+// @public
+export type ExperimentMetricResourceMergeAndPatch = Partial<ExperimentMetric>;
+
+// @public
+export interface ExperimentMetricValidationResultOutput {
+    readonly diagnostics: Array<DiagnosticDetailOutput>;
+    isValid: boolean;
+}
+
+// @public
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+
+// @public (undocumented)
+export interface GetMetric {
+    delete(options?: DeleteMetricParameters): StreamableMethod<DeleteMetric204Response | DeleteMetricDefaultResponse>;
+    get(options?: GetMetricParameters): StreamableMethod<GetMetric200Response | GetMetricDefaultResponse>;
+    patch(options: CreateOrUpdateMetricParameters): StreamableMethod<CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface GetMetric200Headers {
+    "x-ms-client-request-id"?: string;
+    etag?: string;
+}
+
+// @public
+export interface GetMetric200Response extends HttpResponse {
+    // (undocumented)
+    body: ExperimentMetricOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & GetMetric200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetMetricDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetMetricDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetMetricDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface GetMetricHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetMetricHeaders;
+}
+
+// @public (undocumented)
+export interface GetMetricHeaders {
+    "If-Match"?: string;
+    "If-Modified-Since"?: string;
+    "If-None-Match"?: string;
+    "If-Unmodified-Since"?: string;
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type GetMetricParameters = GetMetricHeaderParam & RequestParameters;
+
+// @public
+export type GetPage<TPage> = (pageLink: string) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+
+// @public (undocumented)
+export function isUnexpected(response: GetMetric200Response | GetMetricDefaultResponse): response is GetMetricDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: CreateOrUpdateMetric200Response | CreateOrUpdateMetric201Response | CreateOrUpdateMetricDefaultResponse): response is CreateOrUpdateMetricDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: DeleteMetric204Response | DeleteMetricDefaultResponse): response is DeleteMetricDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: ValidateMetric200Response | ValidateMetricDefaultResponse): response is ValidateMetricDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: ListMetrics200Response | ListMetricsDefaultResponse): response is ListMetricsDefaultResponse;
+
+// @public
+export enum KnownDesiredDirection {
+    Decrease = "Decrease",
+    Increase = "Increase",
+    Neutral = "Neutral"
+}
+
+// @public
+export enum KnownDiagnosticCode {
+    FailedSchemaValidation = "FailedSchemaValidation",
+    InvalidEventCondition = "InvalidEventCondition",
+    InvalidExperimentMetricDefinition = "InvalidExperimentMetricDefinition",
+    UnsupportedEventCondition = "UnsupportedEventCondition"
+}
+
+// @public
+export enum KnownExperimentMetricType {
+    Average = "Average",
+    EventCount = "EventCount",
+    EventRate = "EventRate",
+    Percentile = "Percentile",
+    Sum = "Sum",
+    UserCount = "UserCount",
+    UserRate = "UserRate"
+}
+
+// @public
+export enum KnownLifecycleStage {
+    Active = "Active",
+    Inactive = "Inactive"
+}
+
+// @public
+export enum KnownValidationResult {
+    Invalid = "Invalid",
+    Valid = "Valid"
+}
+
+// @public
+export type LifecycleStage = string;
+
+// @public
+export type LifecycleStageOutput = string;
+
+// @public (undocumented)
+export interface ListMetrics {
+    get(options?: ListMetricsParameters): StreamableMethod<ListMetrics200Response | ListMetricsDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface ListMetrics200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface ListMetrics200Response extends HttpResponse {
+    // (undocumented)
+    body: PagedExperimentMetricOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & ListMetrics200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface ListMetricsDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface ListMetricsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & ListMetricsDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface ListMetricsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ListMetricsHeaders;
+}
+
+// @public (undocumented)
+export interface ListMetricsHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ListMetricsParameters = ListMetricsQueryParam & ListMetricsHeaderParam & RequestParameters;
+
+// @public (undocumented)
+export interface ListMetricsQueryParam {
+    // (undocumented)
+    queryParameters?: ListMetricsQueryParamProperties;
+}
+
+// @public (undocumented)
+export interface ListMetricsQueryParamProperties {
+    maxpagesize?: number;
+    skip?: number;
+    top?: number;
+}
+
+// @public
+export interface ObservedEvent {
+    eventName: string;
+    filter?: string;
+}
+
+// @public
+export interface ObservedEventOutput {
+    eventName: string;
+    filter?: string;
+}
+
+// Warning: (ae-forgotten-export) The symbol "OnlineExperimentationClient_2" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function OnlineExperimentationClient(endpointParam: string, credentials: TokenCredential, { apiVersion, ...options }?: OnlineExperimentationClientOptions): OnlineExperimentationClient_2;
+
+// @public
+export interface OnlineExperimentationClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PagedExperimentMetricOutput {
+    nextLink?: string;
+    value: Array<ExperimentMetricOutput>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+
+// @public
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+
+// @public
+export interface PagingOptions<TResponse> {
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+
+// @public
+export interface PercentileMetricDefinition extends ExperimentMetricDefinitionParent {
+    percentile: number;
+    type: "Percentile";
+    value: AggregatedValue;
+}
+
+// @public
+export interface PercentileMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    percentile: number;
+    type: "Percentile";
+    value: AggregatedValueOutput;
+}
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/experiment-metrics/{experimentMetricId}", experimentMetricId: string): GetMetric;
+    (path: "/experiment-metrics:validate"): ValidateMetric;
+    (path: "/experiment-metrics"): ListMetrics;
+}
+
+// @public
+export interface SumMetricDefinition extends ExperimentMetricDefinitionParent {
+    type: "Sum";
+    value: AggregatedValue;
+}
+
+// @public
+export interface SumMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    type: "Sum";
+    value: AggregatedValueOutput;
+}
+
+// @public
+export interface UserCountMetricDefinition extends ExperimentMetricDefinitionParent {
+    event: ObservedEvent;
+    type: "UserCount";
+}
+
+// @public
+export interface UserCountMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    event: ObservedEventOutput;
+    type: "UserCount";
+}
+
+// @public
+export interface UserRateMetricDefinition extends ExperimentMetricDefinitionParent {
+    endEvent: ObservedEvent;
+    startEvent: ObservedEvent;
+    type: "UserRate";
+}
+
+// @public
+export interface UserRateMetricDefinitionOutput extends ExperimentMetricDefinitionOutputParent {
+    endEvent: ObservedEventOutput;
+    startEvent: ObservedEventOutput;
+    type: "UserRate";
+}
+
+// @public (undocumented)
+export interface ValidateMetric {
+    post(options: ValidateMetricParameters): StreamableMethod<ValidateMetric200Response | ValidateMetricDefaultResponse>;
+}
+
+// @public (undocumented)
+export interface ValidateMetric200Headers {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public
+export interface ValidateMetric200Response extends HttpResponse {
+    // (undocumented)
+    body: ExperimentMetricValidationResultOutput;
+    // (undocumented)
+    headers: RawHttpHeaders & ValidateMetric200Headers;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface ValidateMetricBodyParam {
+    body: ExperimentMetric;
+}
+
+// @public (undocumented)
+export interface ValidateMetricDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface ValidateMetricDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & ValidateMetricDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface ValidateMetricHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & ValidateMetricHeaders;
+}
+
+// @public (undocumented)
+export interface ValidateMetricHeaders {
+    "x-ms-client-request-id"?: string;
+}
+
+// @public (undocumented)
+export type ValidateMetricParameters = ValidateMetricHeaderParam & ValidateMetricBodyParam & RequestParameters;
+
+// (No @packageDocumentation comment for this package)
+
+```