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

package/dist/Groups.d.ts

@@ -107,7 +107,7 @@ interface CreateGroupRoleRequest extends IPlayFabRequestCommon {
     Group: EntityKey;
     /**
      * The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64
-     * characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
+     * characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
      */
     RoleId: string;
     /**
@@ -143,6 +143,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 EntityMemberRole {
     /** The list of members in the role */
@@ -234,7 +239,7 @@ interface InviteToGroupRequest extends IPlayFabRequestCommon {
     /** The identifier of the group */
     Group: EntityKey;
     /**
-     * Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
+     * Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
      * is not specified. Role IDs must be between 1 and 64 characters long.
      */
     RoleId?: string;
@@ -418,127 +423,361 @@ interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
 declare class PlayFabGroupsApi extends PlayFabCommon {
     /**
      * Accepts an outstanding invitation to to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupapplication
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupapplication Microsoft Documentation}
+     * @example
+     * await groupClient.AcceptGroupApplication({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     AcceptGroupApplication(request: AcceptGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Accepts an invitation to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupinvitation
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupinvitation Microsoft Documentation}
+     * @example
+     * await groupClient.AcceptGroupInvitation({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     AcceptGroupInvitation(request: AcceptGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Adds members to a group or role.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/addmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/addmembers Microsoft Documentation}
+     * @example
+     * await groupClient.AddMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
      */
     AddMembers(request: AddMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Applies to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/applytogroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/applytogroup Microsoft Documentation}
+     * @example
+     * await groupClient.ApplyToGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     ApplyToGroup(request: ApplyToGroupRequest, extraHeaders?: Record<string, string>): Promise<ApplyToGroupResponse>;
     /**
      * Blocks a list of entities from joining a group.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/blockentity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/blockentity Microsoft Documentation}
+     * @example
+     * await groupClient.BlockEntity({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     BlockEntity(request: BlockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Changes the role membership of a list of entities from one role to another.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/changememberrole
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/changememberrole Microsoft Documentation}
+     * @example
+     * await groupClient.ChangeMemberRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "OriginRoleId": "awesomepeople",
+     *   "DestinationRoleId": "members",
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
      */
     ChangeMemberRole(request: ChangeMemberRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Creates a new group.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/creategroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/creategroup Microsoft Documentation}
+     * @example
+     * await groupClient.CreateGroup({
+     *   "GroupName": "Example Group"
+     * });
      */
     CreateGroup(request: CreateGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupResponse>;
     /**
      * Creates a new group role.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/createrole
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/createrole Microsoft Documentation}
+     * @example
+     * await groupClient.CreateRole({
+     *   "RoleId": "example",
+     *   "RoleName": "Example Role",
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     CreateRole(request: CreateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupRoleResponse>;
     /**
      * Deletes a group and all roles, invitations, join requests, and blocks associated with it.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/deletegroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deletegroup Microsoft Documentation}
+     * @example
+     * await groupClient.DeleteGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     DeleteGroup(request: DeleteGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Deletes an existing role in a group.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/deleterole
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deleterole Microsoft Documentation}
+     * @example
+     * await groupClient.DeleteRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF"
+     * });
      */
     DeleteRole(request: DeleteRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Gets information about a group and its roles
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/getgroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/getgroup Microsoft Documentation}
+     * @example
+     * await groupClient.GetGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     GetGroup(request: GetGroupRequest, extraHeaders?: Record<string, string>): Promise<GetGroupResponse>;
     /**
      * Invites a player to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/invitetogroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/invitetogroup Microsoft Documentation}
+     * @example
+     * await groupClient.InviteToGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "awesomepeople",
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     InviteToGroup(request: InviteToGroupRequest, extraHeaders?: Record<string, string>): Promise<InviteToGroupResponse>;
     /**
      * Checks to see if an entity is a member of a group or role within the group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/ismember
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/ismember Microsoft Documentation}
+     * @example
+     * await groupClient.IsMember({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     IsMember(request: IsMemberRequest, extraHeaders?: Record<string, string>): Promise<IsMemberResponse>;
     /**
      * Lists all outstanding requests to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupapplications
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupapplications Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupApplications({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     ListGroupApplications(request: ListGroupApplicationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupApplicationsResponse>;
     /**
      * Lists all entities blocked from joining a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupblocks
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupblocks Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupBlocks({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     ListGroupBlocks(request: ListGroupBlocksRequest, extraHeaders?: Record<string, string>): Promise<ListGroupBlocksResponse>;
     /**
      * Lists all outstanding invitations for a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupinvitations
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupinvitations Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupInvitations({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     ListGroupInvitations(request: ListGroupInvitationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupInvitationsResponse>;
     /**
      * Lists all members for a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupmembers Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
      */
     ListGroupMembers(request: ListGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<ListGroupMembersResponse>;
     /**
      * Lists all groups and roles for an entity
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembership
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembership Microsoft Documentation}
+     * @example
+     * await groupClient.ListMembership({});
      */
     ListMembership(request: ListMembershipRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipResponse>;
     /**
      * Lists all outstanding invitations and group applications for an entity
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembershipopportunities
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembershipopportunities Microsoft Documentation}
+     * @example
+     * await groupClient.ListMembershipOpportunities({});
      */
     ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipOpportunitiesResponse>;
     /**
      * Removes an application to join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupapplication
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupapplication Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveGroupApplication({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     RemoveGroupApplication(request: RemoveGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Removes an invitation join a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupinvitation
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupinvitation Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveGroupInvitation({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     RemoveGroupInvitation(request: RemoveGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Removes members from a group.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/removemembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removemembers Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
      */
     RemoveMembers(request: RemoveMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unblocks a list of entities from joining a group
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/unblockentity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/unblockentity Microsoft Documentation}
+     * @example
+     * await groupClient.UnblockEntity({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     UnblockEntity(request: UnblockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates non-membership data about a group.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/updategroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updategroup Microsoft Documentation}
+     * @example
+     * await groupClient.UpdateGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "GroupName": "My New Group Name",
+     *   "ExpectedProfileVersion": 17
+     * });
      */
     UpdateGroup(request: UpdateGroupRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupResponse>;
     /**
      * Updates metadata about a role.
-     * https://docs.microsoft.com/rest/api/playfab/groups/groups/updaterole
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updaterole Microsoft Documentation}
+     * @example
+     * await groupClient.UpdateRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "RoleName": "My New Role Name",
+     *   "ExpectedProfileVersion": 17
+     * });
      */
     UpdateRole(request: UpdateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupRoleResponse>;
 }

package/dist/Groups.js

@@ -1,7 +1,7 @@
 import {
   PlayFabGroupsApi
-} from "./chunk-XAI5IWL4.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-57KYHGBO.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabGroupsApi as default
 };

package/dist/Insights.d.ts

@@ -107,33 +107,59 @@ declare class PlayFabInsightsApi extends PlayFabCommon {
     /**
      * Gets the current values for the Insights performance and data storage retention, list of pending operations, and the
      * performance and data storage retention limits.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails Microsoft Documentation}
+     * @example
+     * await insightsClient.GetDetails({});
      */
     GetDetails(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetDetailsResponse>;
     /**
      * Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details
      * for each performance level.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits Microsoft Documentation}
+     * @example
+     * await insightsClient.GetLimits({});
      */
     GetLimits(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetLimitsResponse>;
     /**
      * Gets the status of a SetPerformance or SetStorageRetention operation.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus Microsoft Documentation}
+     * @example
+     * await insightsClient.GetOperationStatus({
+     *   "OperationId": "3ee468c4-ad09-4bb1-bccf-209ef5abfb96"
+     * });
      */
     GetOperationStatus(request: InsightsGetOperationStatusRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetOperationStatusResponse>;
     /**
      * Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations Microsoft Documentation}
+     * @example
+     * await insightsClient.GetPendingOperations({
+     *   "OperationType": "SetPerformance"
+     * });
      */
     GetPendingOperations(request: InsightsGetPendingOperationsRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetPendingOperationsResponse>;
     /**
      * Sets the Insights performance level value for the title.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance Microsoft Documentation}
+     * @example
+     * await insightsClient.SetPerformance({
+     *   "PerformanceLevel": 3
+     * });
      */
     SetPerformance(request: InsightsSetPerformanceRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
     /**
      * Sets the Insights data storage retention days value for the title.
-     * https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention Microsoft Documentation}
+     * @example
+     * await insightsClient.SetStorageRetention({
+     *   "RetentionDays": 30
+     * });
      */
     SetStorageRetention(request: InsightsSetStorageRetentionRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
 }

package/dist/Insights.js

@@ -1,7 +1,7 @@
 import {
   PlayFabInsightsApi
-} from "./chunk-PXPOK2QU.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-GAZYZIK2.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabInsightsApi as default
 };

package/dist/Localization.d.ts

@@ -12,7 +12,10 @@ interface GetLanguageListResponse extends IPlayFabResultCommon {
 declare class PlayFabLocalizationApi extends PlayFabCommon {
     /**
      * Retrieves the list of allowed languages, only accessible by title entities
-     * https://docs.microsoft.com/rest/api/playfab/localization/localization/getlanguagelist
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/locale/localization/getlanguagelist Microsoft Documentation}
+     * @example
+     * await localeClient.GetLanguageList({});
      */
     GetLanguageList(request: GetLanguageListRequest, extraHeaders?: Record<string, string>): Promise<GetLanguageListResponse>;
 }

package/dist/Localization.js

@@ -1,7 +1,7 @@
 import {
   PlayFabLocalizationApi
-} from "./chunk-CLMINF57.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-5CWZN75H.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabLocalizationApi as default
 };