async-playfab-web-sdk 1.192.250526-4 → 1.192.250526-5

package/dist/Economy.js

@@ -1,7 +1,7 @@
 import {
   PlayFabEconomyApi
-} from "./chunk-XM26BUTO.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-NFWQ4MMZ.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabEconomyApi as default
 };

package/dist/Events.d.ts

@@ -76,6 +76,16 @@ interface DeleteDataConnectionResponse extends IPlayFabResultCommon {
     /** Indicates whether or not the connection was deleted as part of the request. */
     WasDeleted: boolean;
 }
+interface DeleteEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+}
+interface DeleteEventSamplingRatioResult extends IPlayFabResultCommon {
+}
 interface DeleteTelemetryKeyRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -93,6 +103,11 @@ interface EntityKey {
     Id: string;
     /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
     Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
 }
 interface EventContents {
     /**
@@ -125,6 +140,11 @@ interface EventContents {
      */
     PayloadJSON?: string;
 }
+interface EventSamplingRatio {
+    EventName?: string;
+    EventNamespace?: string;
+    Ratio: number;
+}
 interface GetDataConnectionRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -135,6 +155,29 @@ interface GetDataConnectionResponse extends IPlayFabResultCommon {
     /** The details of the queried Data Connection. */
     DataConnection?: DataConnectionDetails;
 }
+interface GetEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+}
+interface GetEventSamplingRatioResult extends IPlayFabResultCommon {
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+    /** Sampling ratio of the event */
+    Ratio: number;
+}
+interface GetEventSamplingRatiosRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface GetEventSamplingRatiosResult extends IPlayFabResultCommon {
+    Ratios?: EventSamplingRatio[];
+}
 interface GetTelemetryKeyRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -198,6 +241,18 @@ interface SetDataConnectionResponse extends IPlayFabResultCommon {
     /** The details of the Data Connection to be created or updated. */
     DataConnection?: DataConnectionDetails;
 }
+interface SetEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+    /** Sampling ratio of the event */
+    Ratio: number;
+}
+interface SetEventSamplingRatioResult extends IPlayFabResultCommon {
+}
 interface SetTelemetryKeyActiveRequest extends IPlayFabRequestCommon {
     /** Whether to set the key to active (true) or deactivated (false). */
     Active: boolean;
@@ -243,63 +298,195 @@ interface WriteEventsResponse extends IPlayFabResultCommon {
 declare class PlayFabEventsApi extends PlayFabCommon {
     /**
      * Creates a new telemetry key for the title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/createtelemetrykey
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/createtelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.CreateTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
      */
     CreateTelemetryKey(request: CreateTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<CreateTelemetryKeyResponse>;
     /**
      * Deletes a Data Connection from a title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletedataconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletedataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.DeleteDataConnection({
+     *   "Name": "MyDataConnection"
+     * });
      */
     DeleteDataConnection(request: DeleteDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<DeleteDataConnectionResponse>;
+    /**
+     * Deletes the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/deleteeventsamplingratio Microsoft Documentation}
+     */
+    DeleteEventSamplingRatio(request: DeleteEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<DeleteEventSamplingRatioResult>;
     /**
      * Deletes a telemetry key configured for the title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletetelemetrykey
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletetelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.DeleteTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
      */
     DeleteTelemetryKey(request: DeleteTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<DeleteTelemetryKeyResponse>;
     /**
      * Retrieves a single Data Connection associated with a title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/getdataconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/getdataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.GetDataConnection({
+     *   "Name": "MyDataConnection"
+     * });
      */
     GetDataConnection(request: GetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<GetDataConnectionResponse>;
+    /**
+     * Gets the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratio Microsoft Documentation}
+     * @example
+     * await eventClient.GetEventSamplingRatio({
+     *   "EventNamespace": "com.playfab",
+     *   "EventName": "player_executed_cloudscript"
+     * });
+     */
+    GetEventSamplingRatio(request: GetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatioResult>;
+    /**
+     * Gets the event sampling ratios for a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratios Microsoft Documentation}
+     */
+    GetEventSamplingRatios(request: GetEventSamplingRatiosRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatiosResult>;
     /**
      * Gets information about a telemetry key configured for the title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/gettelemetrykey
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/gettelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.GetTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
      */
     GetTelemetryKey(request: GetTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTelemetryKeyResponse>;
     /**
      * Retrieves the list of Data Connections associated with a title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listdataconnections
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listdataconnections Microsoft Documentation}
+     * @example
+     * await eventClient.ListDataConnections({});
      */
     ListDataConnections(request: ListDataConnectionsRequest, extraHeaders?: Record<string, string>): Promise<ListDataConnectionsResponse>;
     /**
      * Lists all telemetry keys configured for the title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listtelemetrykeys
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listtelemetrykeys Microsoft Documentation}
+     * @example
+     * await eventClient.ListTelemetryKeys({});
      */
     ListTelemetryKeys(request: ListTelemetryKeysRequest, extraHeaders?: Record<string, string>): Promise<ListTelemetryKeysResponse>;
     /**
      * Creates or updates a Data Connection on a title.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.SetDataConnection({
+     *   "Name": "MyDataConnection",
+     *   "Type": "AzureDataExplorer",
+     *   "IsActive": true,
+     *   "ConnectionSettings": {
+     *     "AzureDataExplorerSettings": {
+     *       "ClusterUri": "https://myadxcluster.kusto.windows.net",
+     *       "Database": "MyDatabase",
+     *       "Table": "MyTable"
+     *     }
+     *   }
+     * });
      */
     SetDataConnection(request: SetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionResponse>;
     /**
      * Sets a Data Connection for the title to either the active or deactivated state.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnectionactive
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnectionactive Microsoft Documentation}
+     * @example
+     * await eventClient.SetDataConnectionActive({
+     *   "Name": "MyDataConnection",
+     *   "Active": false
+     * });
      */
     SetDataConnectionActive(request: SetDataConnectionActiveRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionActiveResponse>;
+    /**
+     * Sets the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/seteventsamplingratio Microsoft Documentation}
+     */
+    SetEventSamplingRatio(request: SetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<SetEventSamplingRatioResult>;
     /**
      * Sets a telemetry key to the active or deactivated state.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/settelemetrykeyactive
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/settelemetrykeyactive Microsoft Documentation}
+     * @example
+     * await eventClient.SetTelemetryKeyActive({
+     *   "KeyName": "MyTelemetryKey",
+     *   "Active": false
+     * });
      */
     SetTelemetryKeyActive(request: SetTelemetryKeyActiveRequest, extraHeaders?: Record<string, string>): Promise<SetTelemetryKeyActiveResponse>;
     /**
      * Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/writeevents
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writeevents Microsoft Documentation}
+     * @example
+     * await eventClient.WriteEvents({
+     *   "Events": [
+     *     {
+     *       "Entity": {
+     *         "Id": "A8140AB9109712B",
+     *         "Type": "title",
+     *         "TypeString": "title"
+     *       },
+     *       "EventNamespace": "com.playfab.events.example",
+     *       "Name": "something_happened",
+     *       "Payload": {
+     *         "Foo": "Bar",
+     *         "Nums": [
+     *           1,
+     *           2,
+     *           3
+     *         ]
+     *       }
+     *     }
+     *   ]
+     * });
      */
     WriteEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
     /**
      * Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start
      * with 'custom.'
-     * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/writetelemetryevents
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writetelemetryevents Microsoft Documentation}
+     * @example
+     * await eventClient.WriteTelemetryEvents({
+     *   "Events": [
+     *     {
+     *       "Entity": {
+     *         "Id": "A8140AB9109712B",
+     *         "Type": "title",
+     *         "TypeString": "title"
+     *       },
+     *       "EventNamespace": "com.playfab.events.example",
+     *       "Name": "something_happened",
+     *       "Payload": {
+     *         "Foo": "Bar",
+     *         "Nums": [
+     *           1,
+     *           2,
+     *           3
+     *         ]
+     *       }
+     *     }
+     *   ]
+     * });
      */
     WriteTelemetryEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
 }

package/dist/Events.js

@@ -1,7 +1,7 @@
 import {
   PlayFabEventsApi
-} from "./chunk-HKZJ4H4O.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-3I6ONUUQ.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabEventsApi as default
 };

package/dist/Experimentation.d.ts

@@ -17,6 +17,11 @@ interface CreateExperimentRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Description of the experiment. */
     Description?: string;
+    /**
+     * The duration of the experiment, in days.
+     * @deprecated Please use EndDate instead.
+     */
+    Duration?: number;
     /** When experiment should end. */
     EndDate?: string;
     /** Id of the exclusion group. */
@@ -27,7 +32,7 @@ interface CreateExperimentRequest extends IPlayFabRequestCommon {
     ExperimentType?: string;
     /** Friendly name of the experiment. */
     Name: string;
-    /** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
+    /** Id of the segment to which this experiment applies. Defaults to the &#39;All Players&#39; segment. */
     SegmentId?: string;
     /** When experiment should start. */
     StartDate: string;
@@ -60,6 +65,11 @@ interface EntityKey {
     Id: string;
     /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
     Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
 }
 interface ExclusionGroupTrafficAllocation {
     /** Id of the experiment. */
@@ -70,6 +80,11 @@ interface ExclusionGroupTrafficAllocation {
 interface Experiment {
     /** Description of the experiment. */
     Description?: string;
+    /**
+     * The duration of the experiment, in days.
+     * @deprecated Please use EndDate instead.
+     */
+    Duration?: number;
     /** When experiment should end/was ended. */
     EndDate?: string;
     /** Id of the exclusion group for this experiment. */
@@ -82,7 +97,7 @@ interface Experiment {
     Id?: string;
     /** Friendly name of the experiment. */
     Name?: string;
-    /** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
+    /** Id of the segment to which this experiment applies. Defaults to the &#39;All Players&#39; segment. */
     SegmentId?: string;
     /** When experiment should start/was started. */
     StartDate: string;
@@ -239,6 +254,11 @@ interface UpdateExperimentRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Description of the experiment. */
     Description?: string;
+    /**
+     * The duration of the experiment, in days.
+     * @deprecated Please use EndDate instead.
+     */
+    Duration?: number;
     /** When experiment should end. */
     EndDate?: string;
     /** Id of the exclusion group. */
@@ -251,7 +271,7 @@ interface UpdateExperimentRequest extends IPlayFabRequestCommon {
     Id: string;
     /** Friendly name of the experiment. */
     Name: string;
-    /** Id of the segment to which this experiment applies. Defaults to the 'All Players' segment. */
+    /** Id of the segment to which this experiment applies. Defaults to the &#39;All Players&#39; segment. */
     SegmentId?: string;
     /** When experiment should start. */
     StartDate: string;
@@ -278,6 +298,11 @@ interface Variant {
     IsControl: boolean;
     /** Name of the variant. */
     Name: string;
+    /**
+     * Id of the TitleDataOverrideGroup to use with this variant.
+     * @deprecated Do not use
+     */
+    TitleDataOverrideId?: string;
     /** Id of the TitleDataOverride to use with this variant. */
     TitleDataOverrideLabel?: string;
     /** Percentage of target audience traffic that will see this variant. */
@@ -289,67 +314,189 @@ interface Variant {
 declare class PlayFabExperimentationApi extends PlayFabCommon {
     /**
      * Creates a new experiment exclusion group for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexclusiongroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexclusiongroup Microsoft Documentation}
+     * @example
+     * await experimentationClient.CreateExclusionGroup({
+     *   "Name": "Commerce Exclusion Group",
+     *   "Description": "Exclusion group for independent, commerce-related experiments"
+     * });
      */
     CreateExclusionGroup(request: CreateExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateExclusionGroupResult>;
     /**
      * Creates a new experiment for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexperiment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexperiment Microsoft Documentation}
+     * @example
+     * await experimentationClient.CreateExperiment({
+     *   "Name": "BackgroundColor Experiment",
+     *   "Description": "Tests whether a green background color increases revenue",
+     *   "StartDate": "2019-10-25T20:37:00Z",
+     *   "EndDate": "2019-11-13T20:37:00Z",
+     *   "Variants": [
+     *     {
+     *       "Name": "Control",
+     *       "Description": "Control variant",
+     *       "TrafficPercentage": 10,
+     *       "Variables": [
+     *         {
+     *           "Name": "BackgroundColor",
+     *           "Value": "White"
+     *         }
+     *       ],
+     *       "IsControl": true
+     *     },
+     *     {
+     *       "Name": "Treatment",
+     *       "Description": "Treatment variant",
+     *       "TrafficPercentage": 90,
+     *       "Variables": [
+     *         {
+     *           "Name": "BackgroundColor",
+     *           "Value": "Green"
+     *         }
+     *       ],
+     *       "IsControl": false
+     *     }
+     *   ],
+     *   "ExperimentType": "Active"
+     * });
      */
     CreateExperiment(request: CreateExperimentRequest, extraHeaders?: Record<string, string>): Promise<CreateExperimentResult>;
     /**
      * Deletes an existing exclusion group for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexclusiongroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexclusiongroup Microsoft Documentation}
+     * @example
+     * await experimentationClient.DeleteExclusionGroup({
+     *   "ExclusionGroupId": "00000000-0000-0000-0000-000000000000"
+     * });
      */
     DeleteExclusionGroup(request: DeleteExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Deletes an existing experiment for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexperiment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexperiment Microsoft Documentation}
+     * @example
+     * await experimentationClient.DeleteExperiment({
+     *   "ExperimentId": "00000000-0000-0000-0000-000000000000"
+     * });
      */
     DeleteExperiment(request: DeleteExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Gets the details of all exclusion groups for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongroups
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongroups Microsoft Documentation}
+     * @example
+     * await experimentationClient.GetExclusionGroups({});
      */
     GetExclusionGroups(request: GetExclusionGroupsRequest, extraHeaders?: Record<string, string>): Promise<GetExclusionGroupsResult>;
     /**
      * Gets the details of all exclusion groups for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongrouptraffic
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongrouptraffic Microsoft Documentation}
+     * @example
+     * await experimentationClient.GetExclusionGroupTraffic({});
      */
     GetExclusionGroupTraffic(request: GetExclusionGroupTrafficRequest, extraHeaders?: Record<string, string>): Promise<GetExclusionGroupTrafficResult>;
     /**
      * Gets the details of all experiments for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexperiments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexperiments Microsoft Documentation}
+     * @example
+     * await experimentationClient.GetExperiments({});
      */
     GetExperiments(request: GetExperimentsRequest, extraHeaders?: Record<string, string>): Promise<GetExperimentsResult>;
     /**
      * Gets the latest scorecard of the experiment for the title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getlatestscorecard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getlatestscorecard Microsoft Documentation}
+     * @example
+     * await experimentationClient.GetLatestScorecard({
+     *   "ExperimentId": "00000000-0000-0000-0000-000000000000"
+     * });
      */
     GetLatestScorecard(request: GetLatestScorecardRequest, extraHeaders?: Record<string, string>): Promise<GetLatestScorecardResult>;
     /**
      * Gets the treatment assignments for a player for every running experiment in the title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/gettreatmentassignment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/gettreatmentassignment Microsoft Documentation}
+     * @example
+     * await experimentationClient.GetTreatmentAssignment({});
      */
     GetTreatmentAssignment(request: GetTreatmentAssignmentRequest, extraHeaders?: Record<string, string>): Promise<GetTreatmentAssignmentResult>;
     /**
      * Starts an existing experiment for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/startexperiment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/startexperiment Microsoft Documentation}
+     * @example
+     * await experimentationClient.StartExperiment({
+     *   "ExperimentId": "00000000-0000-0000-0000-000000000000"
+     * });
      */
     StartExperiment(request: StartExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Stops an existing experiment for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/stopexperiment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/stopexperiment Microsoft Documentation}
+     * @example
+     * await experimentationClient.StopExperiment({
+     *   "ExperimentId": "00000000-0000-0000-0000-000000000000"
+     * });
      */
     StopExperiment(request: StopExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates an existing exclusion group for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexclusiongroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexclusiongroup Microsoft Documentation}
+     * @example
+     * await experimentationClient.UpdateExclusionGroup({
+     *   "ExclusionGroupId": "00000000-0000-0000-0000-000000000000",
+     *   "Name": "Commerce Exclusion Group",
+     *   "Description": "Exclusion group for independent, commerce-related experiments"
+     * });
      */
     UpdateExclusionGroup(request: UpdateExclusionGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates an existing experiment for a title.
-     * https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexperiment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexperiment Microsoft Documentation}
+     * @example
+     * await experimentationClient.UpdateExperiment({
+     *   "Name": "BackgroundColor Experiment",
+     *   "Id": "B9A90E90-A009-4254-80A4-46B5933E9D26",
+     *   "Description": "Tests whether a green background color increases revenue",
+     *   "StartDate": "2019-10-25T20:37:00Z",
+     *   "EndDate": "2019-11-13T20:37:00Z",
+     *   "SegmentId": "0",
+     *   "Variants": [
+     *     {
+     *       "Name": "Control",
+     *       "Description": "Control variant",
+     *       "TrafficPercentage": 10,
+     *       "Variables": [
+     *         {
+     *           "Name": "BackgroundColor",
+     *           "Value": "White"
+     *         }
+     *       ],
+     *       "IsControl": true
+     *     },
+     *     {
+     *       "Name": "Treatment",
+     *       "Description": "Treatment variant",
+     *       "TrafficPercentage": 90,
+     *       "Variables": [
+     *         {
+     *           "Name": "BackgroundColor",
+     *           "Value": "Green"
+     *         }
+     *       ],
+     *       "IsControl": false
+     *     }
+     *   ],
+     *   "ExperimentType": "Active"
+     * });
      */
     UpdateExperiment(request: UpdateExperimentRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
 }

package/dist/Experimentation.js

@@ -1,7 +1,7 @@
 import {
   PlayFabExperimentationApi
-} from "./chunk-WROXLFDZ.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-ZW4TJ3MQ.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabExperimentationApi as default
 };