@community-fabs/playfab-web-sdk 1.193.250606-1

package/dist/Experimentation.d.ts

@@ -0,0 +1,504 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
+
+interface CreateExclusionGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Description of the exclusion group. */
+    Description?: string;
+    /** Friendly name of the exclusion group. */
+    Name: string;
+}
+interface CreateExclusionGroupResult extends IPlayFabResultCommon {
+    /** Identifier of the exclusion group. */
+    ExclusionGroupId?: string;
+}
+interface CreateExperimentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    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. */
+    ExclusionGroupId?: string;
+    /** Percentage of exclusion group traffic that will see this experiment. */
+    ExclusionGroupTrafficAllocation?: number;
+    /** Type of experiment. */
+    ExperimentType?: string;
+    /** Friendly name of the experiment. */
+    Name: string;
+    /** 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;
+    /**
+     * List of title player account IDs that automatically receive treatments in the experiment, but are not included when
+     * calculating experiment metrics.
+     */
+    TitlePlayerAccountTestIds?: string[];
+    /** List of variants for the experiment. */
+    Variants: Variant[];
+}
+interface CreateExperimentResult extends IPlayFabResultCommon {
+    /** The ID of the new experiment. */
+    ExperimentId?: string;
+}
+interface DeleteExclusionGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the exclusion group to delete. */
+    ExclusionGroupId: string;
+}
+interface DeleteExperimentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the experiment to delete. */
+    ExperimentId: string;
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    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. */
+    ExperimentId?: string;
+    /** Percentage of exclusion group traffic that will see this experiment. */
+    TrafficAllocation: number;
+}
+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. */
+    ExclusionGroupId?: string;
+    /** Percentage of exclusion group traffic that will see this experiment. */
+    ExclusionGroupTrafficAllocation?: number;
+    /** Type of experiment. */
+    ExperimentType?: string;
+    /** Id of the experiment. */
+    Id?: string;
+    /** Friendly name of the experiment. */
+    Name?: string;
+    /** 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;
+    /** State experiment is currently in. */
+    State?: string;
+    /**
+     * List of title player account IDs that automatically receive treatments in the experiment, but are not included when
+     * calculating experiment metrics.
+     */
+    TitlePlayerAccountTestIds?: string[];
+    /** List of variants for the experiment. */
+    Variants?: Variant[];
+}
+interface ExperimentExclusionGroup {
+    /** Description of the exclusion group. */
+    Description?: string;
+    /** Id of the exclusion group. */
+    ExclusionGroupId?: string;
+    /** Friendly name of the exclusion group. */
+    Name?: string;
+}
+interface GetExclusionGroupsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface GetExclusionGroupsResult extends IPlayFabResultCommon {
+    /** List of exclusion groups for the title. */
+    ExclusionGroups?: ExperimentExclusionGroup[];
+}
+interface GetExclusionGroupTrafficRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the exclusion group. */
+    ExclusionGroupId: string;
+}
+interface GetExclusionGroupTrafficResult extends IPlayFabResultCommon {
+    /** List of traffic allocations for the exclusion group. */
+    TrafficAllocations?: ExclusionGroupTrafficAllocation[];
+}
+interface GetExperimentsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface GetExperimentsResult extends IPlayFabResultCommon {
+    /** List of experiments for the title. */
+    Experiments?: Experiment[];
+}
+interface GetLatestScorecardRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the experiment. */
+    ExperimentId?: string;
+}
+interface GetLatestScorecardResult extends IPlayFabResultCommon {
+    /** Scorecard for the experiment of the title. */
+    Scorecard?: Scorecard;
+}
+interface GetTreatmentAssignmentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface GetTreatmentAssignmentResult extends IPlayFabResultCommon {
+    /** Treatment assignment for the entity. */
+    TreatmentAssignment?: TreatmentAssignment;
+}
+interface MetricData {
+    /** The upper bound of the confidence interval for the relative delta (Delta.RelativeValue). */
+    ConfidenceIntervalEnd: number;
+    /** The lower bound of the confidence interval for the relative delta (Delta.RelativeValue). */
+    ConfidenceIntervalStart: number;
+    /** The absolute delta between TreatmentStats.Average and ControlStats.Average. */
+    DeltaAbsoluteChange: number;
+    /** The relative delta ratio between TreatmentStats.Average and ControlStats.Average. */
+    DeltaRelativeChange: number;
+    /** The machine name of the metric. */
+    InternalName?: string;
+    /** Indicates if a movement was detected on that metric. */
+    Movement?: string;
+    /** The readable name of the metric. */
+    Name?: string;
+    /** The expectation that a movement is real */
+    PMove: number;
+    /** The p-value resulting from the statistical test run for this metric */
+    PValue: number;
+    /** The threshold for observing sample ratio mismatch. */
+    PValueThreshold: number;
+    /** Indicates if the movement is statistically significant. */
+    StatSigLevel?: string;
+    /** Observed standard deviation value of the metric. */
+    StdDev: number;
+    /** Observed average value of the metric. */
+    Value: number;
+}
+interface Scorecard {
+    /** Represents the date the scorecard was generated. */
+    DateGenerated?: string;
+    /** Represents the duration of scorecard analysis. */
+    Duration?: string;
+    /** Represents the number of events processed for the generation of this scorecard */
+    EventsProcessed: number;
+    /** Id of the experiment. */
+    ExperimentId?: string;
+    /** Friendly name of the experiment. */
+    ExperimentName?: string;
+    /** Represents the latest compute job status. */
+    LatestJobStatus?: string;
+    /** Represents the presence of a sample ratio mismatch in the scorecard data. */
+    SampleRatioMismatch: boolean;
+    /** Scorecard containing list of analysis. */
+    ScorecardDataRows?: ScorecardDataRow[];
+}
+interface ScorecardDataRow {
+    /** Represents whether the variant is control or not. */
+    IsControl: boolean;
+    /** Data of the analysis with the internal name of the metric as the key and an object of metric data as value. */
+    MetricDataRows?: Record<string, MetricData>;
+    /** Represents the player count in the variant. */
+    PlayerCount: number;
+    /** Name of the variant of analysis. */
+    VariantName?: string;
+}
+interface StartExperimentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the experiment to start. */
+    ExperimentId: string;
+}
+interface StopExperimentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The ID of the experiment to stop. */
+    ExperimentId: string;
+}
+interface TreatmentAssignment {
+    /** List of the experiment variables. */
+    Variables?: Variable[];
+    /** List of the experiment variants. */
+    Variants?: string[];
+}
+interface UpdateExclusionGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Description of the exclusion group. */
+    Description?: string;
+    /** The ID of the exclusion group to update. */
+    ExclusionGroupId: string;
+    /** Friendly name of the exclusion group. */
+    Name: string;
+}
+interface UpdateExperimentRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    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. */
+    ExclusionGroupId?: string;
+    /** Percentage of exclusion group traffic that will see this experiment. */
+    ExclusionGroupTrafficAllocation?: number;
+    /** Type of experiment. */
+    ExperimentType?: string;
+    /** Id of the experiment. */
+    Id: string;
+    /** Friendly name of the experiment. */
+    Name: string;
+    /** 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;
+    /**
+     * List of title player account IDs that automatically receive treatments in the experiment, but are not included when
+     * calculating experiment metrics.
+     */
+    TitlePlayerAccountTestIds?: string[];
+    /** List of variants for the experiment. */
+    Variants: Variant[];
+}
+interface Variable {
+    /** Name of the variable. */
+    Name: string;
+    /** Value of the variable. */
+    Value?: string;
+}
+interface Variant {
+    /** Description of the variant. */
+    Description?: string;
+    /** Id of the variant. */
+    Id?: string;
+    /** Specifies if variant is control for experiment. */
+    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. */
+    TrafficPercentage: number;
+    /** Variables returned by this variant. */
+    Variables?: Variable[];
+}
+
+declare class PlayFabExperimentationApi extends PlayFabCommon {
+    /**
+     * Creates a new experiment exclusion group for a title.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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.
+     *
+     * {@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>;
+}
+
+export { PlayFabExperimentationApi as default };

package/dist/Experimentation.js

@@ -0,0 +1,8 @@
+import {
+  PlayFabExperimentationApi
+} from "./chunk-SF5NNTLE.js";
+import "./chunk-6OZSERVG.js";
+export {
+  PlayFabExperimentationApi as default
+};
+//# sourceMappingURL=Experimentation.js.map

package/dist/Experimentation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}