@xmobitea/gn-typescript-client 2.6.13-tsc → 2.6.14

package/dist/runtime/entity/models/MasterPlayerModels.d.ts

@@ -1,49 +1,165 @@
 import { GNHashtable } from "./../../common/GNData";
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the MasterPlayer
+ * domain.
+ *
+ * MasterPlayer operations target the **account-level** record
+ * — the top-level user identity. Client variants imply the
+ * authenticated user (`userId` omitted); Server / Admin
+ * variants require an explicit `userId`.
+ *
+ * Three role variants per operation:
+ * - **Client** (no prefix): routed through
+ *   `GNNetwork.masterPlayer`, `userId` is implicit.
+ * - **`Server*`**: routed through
+ *   `GNNetwork.masterPlayer.server`, requires explicit
+ *   `userId` and a server `secretKey`.
+ * - **`Admin*`**: routed through
+ *   `GNNetwork.masterPlayer.admin`, plus admin-only knobs
+ *   (force overrides, bypass-validation flags).
+ *
+ * Identity link / unlink DTOs follow the convention
+ * `Link<Provider>RequestData` / `Unlink<Provider>RequestData`
+ * — there is one pair per supported provider (Apple, Google,
+ * Facebook, Game Center, ten device-id flavours, custom-id,
+ * generic-service). Each maps onto the matching `loginBy*`
+ * flow on {@link AuthenticateApi}.
+ *
+ * Validation rules declared on each `@*DataMember` decorator
+ * are enforced server-side; failures surface as
+ * {@link InvalidMember} entries with the matching
+ * {@link InvalidMemberType} code.
+ */
 export declare namespace MasterPlayerModels {
+    /**
+     * Defines the reusable parameter block CustomDataParam.
+     */
     class CustomDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Selects which optional master-player fields should be returned in `infoResponseParameters`.
+     * Boolean flags default to `false`; key arrays narrow list-style fields to specific keys only.
+     */
     class InfoRequestParam {
+        /**
+         * Includes linked external identities such as account, device, Google, Facebook, or Apple.
+         */
         external?: boolean;
+        /**
+         * Includes the segment names currently attached to the player.
+         */
         segments?: boolean;
+        /**
+         * Includes custom data entries.
+         */
         customDatas?: boolean;
+        /**
+         * Includes the player's display name.
+         */
         displayName?: boolean;
+        /**
+         * Includes the avatar descriptor.
+         */
         avatar?: boolean;
+        /**
+         * Includes the creation timestamp.
+         */
         tsCreate?: boolean;
+        /**
+         * Includes tag entries.
+         */
         tags?: boolean;
+        /**
+         * Includes the active ban state when present.
+         */
         playerBan?: boolean;
+        /**
+         * Includes player currency entries.
+         */
         playerCurrencies?: boolean;
+        /**
+         * Includes player statistics entries.
+         */
         playerStatistics?: boolean;
+        /**
+         * Includes player data entries.
+         */
         playerDatas?: boolean;
+        /**
+         * Includes the creation IP address.
+         */
         ipAddressCreate?: boolean;
+        /**
+         * Includes the country code currently stored for the player.
+         */
         countryCode?: boolean;
+        /**
+         * Includes the email currently stored for the player.
+         */
         email?: boolean;
+        /**
+         * Includes the last-login timestamp.
+         */
         tsLastLogin?: boolean;
+        /**
+         * Includes registered push-notification endpoints.
+         */
         pushNotifications?: boolean;
+        /**
+         * Restricts `playerDatas` to the specified keys when that field is requested.
+         */
         playerDataKeys?: Array<string>;
+        /**
+         * Restricts `playerCurrencies` to the specified currency keys when that field is requested.
+         */
         playerCurrencyKeys?: Array<string>;
+        /**
+         * Restricts `playerStatistics` to the specified statistic keys when that field is requested.
+         */
         playerStatisticsKeys?: Array<string>;
+        /**
+         * Restricts `customDatas` to the specified keys when that field is requested.
+         */
         customDataKeys?: Array<string>;
+        /**
+         * Restricts `tags` to the specified tag keys when that field is requested.
+         */
         tagKeys?: Array<string>;
     }
+    /**
+     * Defines the reusable parameter block PlayerCurrencyParam.
+     */
     class PlayerCurrencyParam {
         key: string;
         amount: number;
     }
+    /**
+     * Defines the reusable parameter block PlayerDataParam.
+     */
     class PlayerDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Defines the reusable parameter block PlayerStatisticsParam.
+     */
     class PlayerStatisticsParam {
         key: string;
         value: number;
     }
+    /**
+     * Represents GenericService.
+     */
     class GenericService {
         serviceName: string;
         serviceId: string;
     }
+    /**
+     * Represents Device.
+     */
     class Device {
         customDeviceId?: string;
         androidDeviceId?: string;
@@ -54,36 +170,60 @@ export declare namespace MasterPlayerModels {
         macOSDeviceId?: string;
         editorDeviceId?: string;
     }
+    /**
+     * Represents Account.
+     */
     class Account {
         username?: string;
     }
+    /**
+     * Represents Custom.
+     */
     class Custom {
         customId?: string;
     }
+    /**
+     * Represents Apple.
+     */
     class Apple {
         appleId: string;
         email: string;
     }
+    /**
+     * Represents Google.
+     */
     class Google {
         googleId: string;
         displayName: string;
         email: string;
     }
+    /**
+     * Represents Facebook.
+     */
     class Facebook {
         facebookId: string;
         displayName: string;
         email: string;
     }
+    /**
+     * Represents GooglePlayGameService.
+     */
     class GooglePlayGameService {
         playerId: string;
         displayName: string;
         email: string;
     }
+    /**
+     * Represents GameCenter.
+     */
     class GameCenter {
         playerId: string;
         displayName: string;
         email: string;
     }
+    /**
+     * Groups all external identities that may be linked to one master player.
+     */
     class ExternalItem {
         device?: Device;
         account?: Account;
@@ -95,190 +235,392 @@ export declare namespace MasterPlayerModels {
         googlePlayGameService?: GooglePlayGameService;
         gameCenter?: GameCenter;
     }
+    /**
+     * Defines the request payload for AddSegment.
+     */
     class AddSegmentRequestData {
         userId?: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerAddSegment.
+     */
     class ServerAddSegmentRequestData extends AddSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminAddSegment.
+     */
     class AdminAddSegmentRequestData extends ServerAddSegmentRequestData {
     }
+    /**
+     * Defines the request payload for ChangeAccountPassword.
+     */
     class ChangeAccountPasswordRequestData {
         userId?: string;
         currentPassword: string;
         password: string;
     }
+    /**
+     * Defines the request payload for GetAvatar.
+     */
     class GetAvatarRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetAvatar.
+     */
     class ServerGetAvatarRequestData extends GetAvatarRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetAvatar.
+     */
     class AdminGetAvatarRequestData extends ServerGetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for GetCountryCode.
+     */
     class GetCountryCodeRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetCountryCode.
+     */
     class ServerGetCountryCodeRequestData extends GetCountryCodeRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetCountryCode.
+     */
     class AdminGetCountryCodeRequestData extends ServerGetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for GetCustomData.
+     */
     class GetCustomDataRequestData {
         userId?: string;
         customDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetCustomData.
+     */
     class ServerGetCustomDataRequestData extends GetCustomDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetCustomData.
+     */
     class AdminGetCustomDataRequestData extends ServerGetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for GetDisplayName.
+     */
     class GetDisplayNameRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetDisplayName.
+     */
     class ServerGetDisplayNameRequestData extends GetDisplayNameRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetDisplayName.
+     */
     class AdminGetDisplayNameRequestData extends ServerGetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetEmail.
+     */
     class GetEmailRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetEmail.
+     */
     class ServerGetEmailRequestData extends GetEmailRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetEmail.
+     */
     class AdminGetEmailRequestData extends ServerGetEmailRequestData {
     }
+    /**
+     * Defines the request payload for GetExternal.
+     */
     class GetExternalRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetExternal.
+     */
     class ServerGetExternalRequestData extends GetExternalRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetExternal.
+     */
     class AdminGetExternalRequestData extends ServerGetExternalRequestData {
     }
+    /**
+     * Defines the request payload for GetIpAddressCreate.
+     */
     class GetIpAddressCreateRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetIpAddressCreate.
+     */
     class ServerGetIpAddressCreateRequestData extends GetIpAddressCreateRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetIpAddressCreate.
+     */
     class AdminGetIpAddressCreateRequestData extends ServerGetIpAddressCreateRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerBan.
+     */
     class GetPlayerBanRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerBan.
+     */
     class ServerGetPlayerBanRequestData extends GetPlayerBanRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerBan.
+     */
     class AdminGetPlayerBanRequestData extends ServerGetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerCurrency.
+     */
     class GetPlayerCurrencyRequestData {
         userId?: string;
         playerCurrencyKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerCurrency.
+     */
     class ServerGetPlayerCurrencyRequestData extends GetPlayerCurrencyRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerCurrency.
+     */
     class AdminGetPlayerCurrencyRequestData extends ServerGetPlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerData.
+     */
     class GetPlayerDataRequestData {
         userId?: string;
         playerDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerData.
+     */
     class ServerGetPlayerDataRequestData extends GetPlayerDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerData.
+     */
     class AdminGetPlayerDataRequestData extends ServerGetPlayerDataRequestData {
     }
+    /**
+     * Reads the current or target master-player profile using the requested projection.
+     * On the client route, omit `userId` to target the authenticated player itself.
+     */
     class GetPlayerInformationRequestData {
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
+        /**
+         * Required field projection that controls which optional data is returned.
+         */
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Reads a specific target master player on a trusted route.
+     */
     class ServerGetPlayerInformationRequestData extends GetPlayerInformationRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerInformation.
+     */
     class AdminGetPlayerInformationRequestData extends ServerGetPlayerInformationRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerStatistics.
+     */
     class GetPlayerStatisticsRequestData {
         userId?: string;
         playerStatisticsKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerStatistics.
+     */
     class ServerGetPlayerStatisticsRequestData extends GetPlayerStatisticsRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerStatistics.
+     */
     class AdminGetPlayerStatisticsRequestData extends ServerGetPlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithApple.
+     */
     class GetPlayersWithAppleRequestData {
         appleIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithApple.
+     */
     class ServerGetPlayersWithAppleRequestData extends GetPlayersWithAppleRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithApple.
+     */
     class AdminGetPlayersWithAppleRequestData extends ServerGetPlayersWithAppleRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithDisplayName.
+     */
     class GetPlayersWithDisplayNameRequestData {
         keyword: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithDisplayName.
+     */
     class ServerGetPlayersWithDisplayNameRequestData extends GetPlayersWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithDisplayName.
+     */
     class AdminGetPlayersWithDisplayNameRequestData extends ServerGetPlayersWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithFacebook.
+     */
     class GetPlayersWithFacebookRequestData {
         facebookIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithFacebook.
+     */
     class ServerGetPlayersWithFacebookRequestData extends GetPlayersWithFacebookRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithFacebook.
+     */
     class AdminGetPlayersWithFacebookRequestData extends ServerGetPlayersWithFacebookRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithGenericService.
+     */
     class GetPlayersWithGenericServiceRequestData {
         serviceName: string;
         genericIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithGenericService.
+     */
     class ServerGetPlayersWithGenericServiceRequestData extends GetPlayersWithGenericServiceRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithGenericService.
+     */
     class AdminGetPlayersWithGenericServiceRequestData extends ServerGetPlayersWithGenericServiceRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithGoogle.
+     */
     class GetPlayersWithGoogleRequestData {
         googleIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithGoogle.
+     */
     class ServerGetPlayersWithGoogleRequestData extends GetPlayersWithGoogleRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithGoogle.
+     */
     class AdminGetPlayersWithGoogleRequestData extends ServerGetPlayersWithGoogleRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithGooglePlayGameService.
+     */
     class GetPlayersWithGooglePlayGameServiceRequestData {
         playerIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithGooglePlayGameService.
+     */
     class ServerGetPlayersWithGooglePlayGameServiceRequestData extends GetPlayersWithGooglePlayGameServiceRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithGooglePlayGameService.
+     */
     class AdminGetPlayersWithGooglePlayGameServiceRequestData extends ServerGetPlayersWithGooglePlayGameServiceRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithGameCenter.
+     */
     class GetPlayersWithGameCenterRequestData {
         playerIds: Array<string>;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithGameCenter.
+     */
     class ServerGetPlayersWithGameCenterRequestData extends GetPlayersWithGameCenterRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithGameCenter.
+     */
     class AdminGetPlayersWithGameCenterRequestData extends ServerGetPlayersWithGameCenterRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithSegment.
+     */
     class GetPlayersWithSegmentRequestData {
         value: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithSegment.
+     */
     class ServerGetPlayersWithSegmentRequestData extends GetPlayersWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithSegment.
+     */
     class AdminGetPlayersWithSegmentRequestData extends ServerGetPlayersWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithTag.
+     */
     class GetPlayersWithTagRequestData {
         key: string;
         value: string;
@@ -286,18 +628,36 @@ export declare namespace MasterPlayerModels {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithTag.
+     */
     class ServerGetPlayersWithTagRequestData extends GetPlayersWithTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithTag.
+     */
     class AdminGetPlayersWithTagRequestData extends ServerGetPlayersWithTagRequestData {
     }
+    /**
+     * Defines the request payload for GetSegment.
+     */
     class GetSegmentRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetSegment.
+     */
     class ServerGetSegmentRequestData extends GetSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetSegment.
+     */
     class AdminGetSegmentRequestData extends ServerGetSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboardAroundPlayer.
+     */
     class GetStatisticsLeaderboardAroundPlayerRequestData {
         userId?: string;
         key: string;
@@ -306,11 +666,20 @@ export declare namespace MasterPlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboardAroundPlayer.
+     */
     class ServerGetStatisticsLeaderboardAroundPlayerRequestData extends GetStatisticsLeaderboardAroundPlayerRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboardAroundPlayer.
+     */
     class AdminGetStatisticsLeaderboardAroundPlayerRequestData extends ServerGetStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -319,158 +688,302 @@ export declare namespace MasterPlayerModels {
         loadFromCache?: boolean;
         version?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboard.
+     */
     class ServerGetStatisticsLeaderboardRequestData extends GetStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboard.
+     */
     class AdminGetStatisticsLeaderboardRequestData extends ServerGetStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardRequestData {
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetCreateLeaderboard.
+     */
     class ServerGetCreateLeaderboardRequestData extends GetCreateLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCreateLeaderboard.
+     */
     class AdminGetCreateLeaderboardRequestData extends ServerGetCreateLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetLastLoginLeaderboard.
+     */
     class GetLastLoginLeaderboardRequestData {
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetLastLoginLeaderboard.
+     */
     class ServerGetLastLoginLeaderboardRequestData extends GetLastLoginLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetLastLoginLeaderboard.
+     */
     class AdminGetLastLoginLeaderboardRequestData extends ServerGetLastLoginLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetTag.
+     */
     class GetTagRequestData {
         userId?: string;
         tagKeys: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetTag.
+     */
     class ServerGetTagRequestData extends GetTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTag.
+     */
     class AdminGetTagRequestData extends ServerGetTagRequestData {
     }
+    /**
+     * Defines the request payload for GetTsCreate.
+     */
     class GetTsCreateRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsCreate.
+     */
     class ServerGetTsCreateRequestData extends GetTsCreateRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTsCreate.
+     */
     class AdminGetTsCreateRequestData extends ServerGetTsCreateRequestData {
     }
+    /**
+     * Defines the request payload for GetTsLastLogin.
+     */
     class GetTsLastLoginRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsLastLogin.
+     */
     class ServerGetTsLastLoginRequestData extends GetTsLastLoginRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTsLastLogin.
+     */
     class AdminGetTsLastLoginRequestData extends ServerGetTsLastLoginRequestData {
     }
+    /**
+     * Defines the request payload for LinkAccount.
+     */
     class LinkAccountRequestData {
         userId?: string;
         username: string;
         password: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkAccount.
+     */
     class ServerLinkAccountRequestData extends LinkAccountRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkAccount.
+     */
     class AdminLinkAccountRequestData extends ServerLinkAccountRequestData {
     }
+    /**
+     * Defines the request payload for LinkAndroidDeviceId.
+     */
     class LinkAndroidDeviceIdRequestData {
         userId?: string;
         androidDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkAndroidDeviceId.
+     */
     class ServerLinkAndroidDeviceIdRequestData extends LinkAndroidDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkAndroidDeviceId.
+     */
     class AdminLinkAndroidDeviceIdRequestData extends ServerLinkAndroidDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkApple.
+     */
     class LinkAppleRequestData {
         userId?: string;
         token: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkApple.
+     */
     class ServerLinkAppleRequestData extends LinkAppleRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkApple.
+     */
     class AdminLinkAppleRequestData extends ServerLinkAppleRequestData {
     }
+    /**
+     * Defines the request payload for LinkCustomDeviceId.
+     */
     class LinkCustomDeviceIdRequestData {
         userId?: string;
         customDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkCustomDeviceId.
+     */
     class ServerLinkCustomDeviceIdRequestData extends LinkCustomDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkCustomDeviceId.
+     */
     class AdminLinkCustomDeviceIdRequestData extends ServerLinkCustomDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkCustomId.
+     */
     class LinkCustomIdRequestData {
         userId?: string;
         customId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkCustomId.
+     */
     class ServerLinkCustomIdRequestData extends LinkCustomIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkCustomId.
+     */
     class AdminLinkCustomIdRequestData extends ServerLinkCustomIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkEditorDeviceId.
+     */
     class LinkEditorDeviceIdRequestData {
         userId?: string;
         editorDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkEditorDeviceId.
+     */
     class ServerLinkEditorDeviceIdRequestData extends LinkEditorDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkEditorDeviceId.
+     */
     class AdminLinkEditorDeviceIdRequestData extends ServerLinkEditorDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkFacebook.
+     */
     class LinkFacebookRequestData {
         userId?: string;
         token: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkFacebook.
+     */
     class ServerLinkFacebookRequestData extends LinkFacebookRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkFacebook.
+     */
     class AdminLinkFacebookRequestData extends ServerLinkFacebookRequestData {
     }
+    /**
+     * Defines the request payload for LinkGenericService.
+     */
     class LinkGenericServiceRequestData {
         userId?: string;
         serviceName: string;
         serviceData: GNHashtable;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkGenericService.
+     */
     class ServerLinkGenericServiceRequestData extends LinkGenericServiceRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkGenericService.
+     */
     class AdminLinkGenericServiceRequestData extends ServerLinkGenericServiceRequestData {
     }
+    /**
+     * Defines the request payload for LinkGoogle.
+     */
     class LinkGoogleRequestData {
         userId?: string;
         token: string;
         type: number;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkGoogle.
+     */
     class ServerLinkGoogleRequestData extends LinkGoogleRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkGoogle.
+     */
     class AdminLinkGoogleRequestData extends ServerLinkGoogleRequestData {
     }
+    /**
+     * Defines the request payload for LinkGooglePlayGameService.
+     */
     class LinkGooglePlayGameServiceRequestData {
         userId?: string;
         token: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkGooglePlayGameService.
+     */
     class ServerLinkGooglePlayGameServiceRequestData extends LinkGooglePlayGameServiceRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkGooglePlayGameService.
+     */
     class AdminLinkGooglePlayGameServiceRequestData extends ServerLinkGooglePlayGameServiceRequestData {
     }
+    /**
+     * Defines the request payload for LinkGameCenter.
+     */
     class LinkGameCenterRequestData {
         userId?: string;
         playerId: string;
@@ -481,404 +994,821 @@ export declare namespace MasterPlayerModels {
         timestamp: number;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkGameCenter.
+     */
     class ServerLinkGameCenterRequestData extends LinkGameCenterRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkGameCenter.
+     */
     class AdminLinkGameCenterRequestData extends ServerLinkGameCenterRequestData {
     }
+    /**
+     * Defines the request payload for LinkiOSDeviceId.
+     */
     class LinkiOSDeviceIdRequestData {
         userId?: string;
         iOSDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkiOSDeviceId.
+     */
     class ServerLinkiOSDeviceIdRequestData extends LinkiOSDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkiOSDeviceId.
+     */
     class AdminLinkiOSDeviceIdRequestData extends ServerLinkiOSDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkLinuxDeviceId.
+     */
     class LinkLinuxDeviceIdRequestData {
         userId?: string;
         linuxDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkLinuxDeviceId.
+     */
     class ServerLinkLinuxDeviceIdRequestData extends LinkLinuxDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkLinuxDeviceId.
+     */
     class AdminLinkLinuxDeviceIdRequestData extends ServerLinkLinuxDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkMacOSDeviceId.
+     */
     class LinkMacOSDeviceIdRequestData {
         userId?: string;
         macOSDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkMacOSDeviceId.
+     */
     class ServerLinkMacOSDeviceIdRequestData extends LinkMacOSDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkMacOSDeviceId.
+     */
     class AdminLinkMacOSDeviceIdRequestData extends ServerLinkMacOSDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkWindowsDeviceId.
+     */
     class LinkWindowsDeviceIdRequestData {
         userId?: string;
         windowsDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkWindowsDeviceId.
+     */
     class ServerLinkWindowsDeviceIdRequestData extends LinkWindowsDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkWindowsDeviceId.
+     */
     class AdminLinkWindowsDeviceIdRequestData extends ServerLinkWindowsDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for LinkWindowsPhoneDeviceId.
+     */
     class LinkWindowsPhoneDeviceIdRequestData {
         userId?: string;
         windowsPhoneDeviceId: string;
         forceLink?: boolean;
     }
+    /**
+     * Defines the request payload for ServerLinkWindowsPhoneDeviceId.
+     */
     class ServerLinkWindowsPhoneDeviceIdRequestData extends LinkWindowsPhoneDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLinkWindowsPhoneDeviceId.
+     */
     class AdminLinkWindowsPhoneDeviceIdRequestData extends ServerLinkWindowsPhoneDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for RemoveSegment.
+     */
     class RemoveSegmentRequestData {
         userId?: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveSegment.
+     */
     class ServerRemoveSegmentRequestData extends RemoveSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemoveSegment.
+     */
     class AdminRemoveSegmentRequestData extends ServerRemoveSegmentRequestData {
     }
+    /**
+     * Defines the request payload for RemoveTag.
+     */
     class RemoveTagRequestData {
         userId?: string;
         key: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveTag.
+     */
     class ServerRemoveTagRequestData extends RemoveTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemoveTag.
+     */
     class AdminRemoveTagRequestData extends ServerRemoveTagRequestData {
     }
+    /**
+     * Defines the request payload for ResetAccountPassword.
+     */
     class ResetAccountPasswordRequestData {
         userId?: string;
         password: string;
     }
+    /**
+     * Defines the request payload for ServerResetAccountPassword.
+     */
     class ServerResetAccountPasswordRequestData extends ResetAccountPasswordRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminResetAccountPassword.
+     */
     class AdminResetAccountPasswordRequestData extends ServerResetAccountPasswordRequestData {
     }
+    /**
+     * Defines the request payload for SetAvatar.
+     */
     class SetAvatarRequestData {
         userId?: string;
         type: number;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetAvatar.
+     */
     class ServerSetAvatarRequestData extends SetAvatarRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetAvatar.
+     */
     class AdminSetAvatarRequestData extends ServerSetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for SetCountryCode.
+     */
     class SetCountryCodeRequestData {
         userId?: string;
         countryCode: string;
     }
+    /**
+     * Defines the request payload for ServerSetCountryCode.
+     */
     class ServerSetCountryCodeRequestData extends SetCountryCodeRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetCountryCode.
+     */
     class AdminSetCountryCodeRequestData extends ServerSetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for SetCustomData.
+     */
     class SetCustomDataRequestData {
         userId?: string;
         customDatas: Array<CustomDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetCustomData.
+     */
     class ServerSetCustomDataRequestData extends SetCustomDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetCustomData.
+     */
     class AdminSetCustomDataRequestData extends ServerSetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for SetDisplayName.
+     */
     class SetDisplayNameRequestData {
         userId?: string;
         displayName: string;
         uniqueDisplayName?: boolean;
     }
+    /**
+     * Defines the request payload for ServerSetDisplayName.
+     */
     class ServerSetDisplayNameRequestData extends SetDisplayNameRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetDisplayName.
+     */
     class AdminSetDisplayNameRequestData extends ServerSetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for SetEmail.
+     */
     class SetEmailRequestData {
         userId?: string;
         email: string;
     }
+    /**
+     * Defines the request payload for ServerSetEmail.
+     */
     class ServerSetEmailRequestData extends SetEmailRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetEmail.
+     */
     class AdminSetEmailRequestData extends ServerSetEmailRequestData {
     }
+    /**
+     * Defines the request payload for SetPlayerBan.
+     */
     class SetPlayerBanRequestData {
         userId?: string;
         tsExpire: number;
         reason: string;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerBan.
+     */
     class ServerSetPlayerBanRequestData extends SetPlayerBanRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetPlayerBan.
+     */
     class AdminSetPlayerBanRequestData extends ServerSetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerCurrency.
+     */
     class ChangePlayerCurrencyRequestData {
         userId?: string;
         playerCurrencies: Array<PlayerCurrencyParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerCurrency.
+     */
     class ServerChangePlayerCurrencyRequestData extends ChangePlayerCurrencyRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminChangePlayerCurrency.
+     */
     class AdminChangePlayerCurrencyRequestData extends ServerChangePlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for SetPlayerData.
+     */
     class SetPlayerDataRequestData {
         userId?: string;
         playerDatas: Array<PlayerDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerData.
+     */
     class ServerSetPlayerDataRequestData extends SetPlayerDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetPlayerData.
+     */
     class AdminSetPlayerDataRequestData extends ServerSetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerStatistics.
+     */
     class ChangePlayerStatisticsRequestData {
         userId?: string;
         playerStatistics: Array<PlayerStatisticsParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerStatistics.
+     */
     class ServerChangePlayerStatisticsRequestData extends ChangePlayerStatisticsRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminChangePlayerStatistics.
+     */
     class AdminChangePlayerStatisticsRequestData extends ServerChangePlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for SetTag.
+     */
     class SetTagRequestData {
         userId?: string;
         key: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetTag.
+     */
     class ServerSetTagRequestData extends SetTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetTag.
+     */
     class AdminSetTagRequestData extends ServerSetTagRequestData {
     }
+    /**
+     * Reads currency change logs for the current or target master player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetCurrencyLogRequestData {
         keys?: Array<string>;
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
         limit?: number;
+        /**
+         * Continuation token returned by the previous page.
+         */
         token?: string;
     }
+    /**
+     * Defines the request payload for ServerGetCurrencyLog.
+     */
     class ServerGetCurrencyLogRequestData extends GetCurrencyLogRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCurrencyLog.
+     */
     class AdminGetCurrencyLogRequestData extends ServerGetCurrencyLogRequestData {
     }
+    /**
+     * Reads statistic change logs for the current or target master player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetStatisticsLogRequestData {
         keys?: Array<string>;
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
         limit?: number;
+        /**
+         * Continuation token returned by the previous page.
+         */
         token?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLog.
+     */
     class ServerGetStatisticsLogRequestData extends GetStatisticsLogRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLog.
+     */
     class AdminGetStatisticsLogRequestData extends ServerGetStatisticsLogRequestData {
     }
-    class SetTsLastLoginRequestData {
+    /**
+     * Defines the request payload for UpdateTsLastLogin.
+     */
+    class UpdateTsLastLoginRequestData {
         userId?: string;
     }
-    class ServerSetTsLastLoginRequestData extends SetTsLastLoginRequestData {
+    /**
+     * Defines the request payload for ServerUpdateTsLastLogin.
+     */
+    class ServerUpdateTsLastLoginRequestData extends UpdateTsLastLoginRequestData {
         userId: string;
     }
-    class AdminSetTsLastLoginRequestData extends ServerSetTsLastLoginRequestData {
+    /**
+     * Defines the request payload for AdminUpdateTsLastLogin.
+     */
+    class AdminUpdateTsLastLoginRequestData extends ServerUpdateTsLastLoginRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkAccount.
+     */
     class UnlinkAccountRequestData {
         userId?: string;
         username: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkAccount.
+     */
     class ServerUnlinkAccountRequestData extends UnlinkAccountRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkAccount.
+     */
     class AdminUnlinkAccountRequestData extends ServerUnlinkAccountRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkAndroidDeviceId.
+     */
     class UnlinkAndroidDeviceIdRequestData {
         userId?: string;
         androidDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkAndroidDeviceId.
+     */
     class ServerUnlinkAndroidDeviceIdRequestData extends UnlinkAndroidDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkAndroidDeviceId.
+     */
     class AdminUnlinkAndroidDeviceIdRequestData extends ServerUnlinkAndroidDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkApple.
+     */
     class UnlinkAppleRequestData {
         userId?: string;
         appleId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkApple.
+     */
     class ServerUnlinkAppleRequestData extends UnlinkAppleRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkApple.
+     */
     class AdminUnlinkAppleRequestData extends ServerUnlinkAppleRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkCustomDeviceId.
+     */
     class UnlinkCustomDeviceIdRequestData {
         userId?: string;
         customDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkCustomDeviceId.
+     */
     class ServerUnlinkCustomDeviceIdRequestData extends UnlinkCustomDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkCustomDeviceId.
+     */
     class AdminUnlinkCustomDeviceIdRequestData extends ServerUnlinkCustomDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkCustomId.
+     */
     class UnlinkCustomIdRequestData {
         userId?: string;
         customId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkCustomId.
+     */
     class ServerUnlinkCustomIdRequestData extends UnlinkCustomIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkCustomId.
+     */
     class AdminUnlinkCustomIdRequestData extends ServerUnlinkCustomIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkEditorDeviceId.
+     */
     class UnlinkEditorDeviceIdRequestData {
         userId?: string;
         editorDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkEditorDeviceId.
+     */
     class ServerUnlinkEditorDeviceIdRequestData extends UnlinkEditorDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkEditorDeviceId.
+     */
     class AdminUnlinkEditorDeviceIdRequestData extends ServerUnlinkEditorDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkFacebook.
+     */
     class UnlinkFacebookRequestData {
         userId?: string;
         facebookId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkFacebook.
+     */
     class ServerUnlinkFacebookRequestData extends UnlinkFacebookRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkFacebook.
+     */
     class AdminUnlinkFacebookRequestData extends ServerUnlinkFacebookRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkGenericService.
+     */
     class UnlinkGenericServiceRequestData {
         userId?: string;
         serviceName: string;
         serviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkGenericService.
+     */
     class ServerUnlinkGenericServiceRequestData extends UnlinkGenericServiceRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkGenericService.
+     */
     class AdminUnlinkGenericServiceRequestData extends ServerUnlinkGenericServiceRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkGoogle.
+     */
     class UnlinkGoogleRequestData {
         userId?: string;
         googleId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkGoogle.
+     */
     class ServerUnlinkGoogleRequestData extends UnlinkGoogleRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkGoogle.
+     */
     class AdminUnlinkGoogleRequestData extends ServerUnlinkGoogleRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkGooglePlayGameService.
+     */
     class UnlinkGooglePlayGameServiceRequestData {
         userId?: string;
         playerId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkGooglePlayGameService.
+     */
     class ServerUnlinkGooglePlayGameServiceRequestData extends UnlinkGooglePlayGameServiceRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkGooglePlayGameService.
+     */
     class AdminUnlinkGooglePlayGameServiceRequestData extends ServerUnlinkGooglePlayGameServiceRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkGameCenter.
+     */
     class UnlinkGameCenterRequestData {
         userId?: string;
         playerId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkGameCenter.
+     */
     class ServerUnlinkGameCenterRequestData extends UnlinkGameCenterRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkGameCenter.
+     */
     class AdminUnlinkGameCenterRequestData extends ServerUnlinkGameCenterRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkiOSDeviceId.
+     */
     class UnlinkiOSDeviceIdRequestData {
         userId?: string;
         iOSDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkiOSDeviceId.
+     */
     class ServerUnlinkiOSDeviceIdRequestData extends UnlinkiOSDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkiOSDeviceId.
+     */
     class AdminUnlinkiOSDeviceIdRequestData extends ServerUnlinkiOSDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkLinuxDeviceId.
+     */
     class UnlinkLinuxDeviceIdRequestData {
         userId?: string;
         linuxDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkLinuxDeviceId.
+     */
     class ServerUnlinkLinuxDeviceIdRequestData extends UnlinkLinuxDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkLinuxDeviceId.
+     */
     class AdminUnlinkLinuxDeviceIdRequestData extends ServerUnlinkLinuxDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkMacOSDeviceId.
+     */
     class UnlinkMacOSDeviceIdRequestData {
         userId?: string;
         macOSDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkMacOSDeviceId.
+     */
     class ServerUnlinkMacOSDeviceIdRequestData extends UnlinkMacOSDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkMacOSDeviceId.
+     */
     class AdminUnlinkMacOSDeviceIdRequestData extends ServerUnlinkMacOSDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkWindowsDeviceId.
+     */
     class UnlinkWindowsDeviceIdRequestData {
         userId?: string;
         windowsDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkWindowsDeviceId.
+     */
     class ServerUnlinkWindowsDeviceIdRequestData extends UnlinkWindowsDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkWindowsDeviceId.
+     */
     class AdminUnlinkWindowsDeviceIdRequestData extends ServerUnlinkWindowsDeviceIdRequestData {
     }
+    /**
+     * Defines the request payload for UnlinkWindowsPhoneDeviceId.
+     */
     class UnlinkWindowsPhoneDeviceIdRequestData {
         userId?: string;
         windowsPhoneDeviceId: string;
     }
+    /**
+     * Defines the request payload for ServerUnlinkWindowsPhoneDeviceId.
+     */
     class ServerUnlinkWindowsPhoneDeviceIdRequestData extends UnlinkWindowsPhoneDeviceIdRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminUnlinkWindowsPhoneDeviceId.
+     */
     class AdminUnlinkWindowsPhoneDeviceIdRequestData extends ServerUnlinkWindowsPhoneDeviceIdRequestData {
     }
+    /**
+     * Sends a backend-routed socket event to the current or target player's active socket session.
+     * This is still an HTTP MasterPlayer operation, not a raw socket transport call.
+     */
     class SendSocketOperationEventRequestData {
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
+        /**
+         * Backend-defined event code forwarded to socket listeners.
+         */
         eventCode: string;
+        /**
+         * Optional raw event payload delivered with the socket event.
+         */
         eventParameters?: GNHashtable;
     }
+    /**
+     * Defines the request payload for ServerSendSocketOperationEvent.
+     */
     class ServerSendSocketOperationEventRequestData extends SendSocketOperationEventRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSendSocketOperationEvent.
+     */
     class AdminSendSocketOperationEventRequestData extends ServerSendSocketOperationEventRequestData {
     }
+    /**
+     * Defines the request payload for SendEmail.
+     */
     class SendEmailRequestData {
         userId?: string;
         subject: string;
         contentHtml: string;
     }
+    /**
+     * Defines the request payload for ServerSendEmail.
+     */
     class ServerSendEmailRequestData extends SendEmailRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSendEmail.
+     */
     class AdminSendEmailRequestData extends ServerSendEmailRequestData {
     }
+    /**
+     * Registers a push-notification endpoint for the current or target master player.
+     */
     class AddPushNotificationRequestData {
         userId?: string;
+        /**
+         * Device push token issued by the push provider.
+         */
         token: string;
+        /**
+         * Push platform mapped by the public `PushPlatformType` enum.
+         */
         platformType: number;
     }
+    /**
+     * Defines the request payload for ServerAddPushNotification.
+     */
     class ServerAddPushNotificationRequestData extends AddPushNotificationRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminAddPushNotification.
+     */
     class AdminAddPushNotificationRequestData extends ServerAddPushNotificationRequestData {
     }
+    /**
+     * Reads registered push-notification endpoints for the current or target master player.
+     */
     class GetPushNotificationRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetPushNotification.
+     */
     class ServerGetPushNotificationRequestData extends GetPushNotificationRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPushNotification.
+     */
     class AdminGetPushNotificationRequestData extends ServerGetPushNotificationRequestData {
     }
+    /**
+     * Defines the request payload for RemovePushNotification.
+     */
     class RemovePushNotificationRequestData {
         userId?: string;
         pushId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePushNotification.
+     */
     class ServerRemovePushNotificationRequestData extends RemovePushNotificationRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemovePushNotification.
+     */
     class AdminRemovePushNotificationRequestData extends ServerRemovePushNotificationRequestData {
     }
+    /**
+     * Triggers a push-notification send workflow for the current or target master player.
+     */
     class SendPushNotificationRequestData {
         userId?: string;
         title: string;
@@ -886,19 +1816,40 @@ export declare namespace MasterPlayerModels {
         badge?: number;
         sound?: string;
         icon?: string;
+        /**
+         * Platform-specific custom payload forwarded to the push provider.
+         */
         data?: GNHashtable;
     }
+    /**
+     * Defines the request payload for ServerSendPushNotification.
+     */
     class ServerSendPushNotificationRequestData extends SendPushNotificationRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSendPushNotification.
+     */
     class AdminSendPushNotificationRequestData extends ServerSendPushNotificationRequestData {
     }
+    /**
+     * Describes one registered push endpoint stored for a player.
+     */
     class PushNotificationItem {
         token: string;
         pushId: string;
+        /**
+         * Push platform mapped by the public `PushPlatformType` enum.
+         */
         platformType: number;
     }
+    /**
+     * Contains the optional fields requested through `InfoRequestParam`.
+     */
     class InfoResponseParameters {
+        /**
+         * Linked external identity snapshot.
+         */
         external?: ExternalItem;
         segments?: Array<string>;
         customDatas?: Array<GenericModels.DataItem>;
@@ -914,57 +1865,123 @@ export declare namespace MasterPlayerModels {
         ipAddressCreate?: string;
         countryCode?: string;
         email?: string;
+        /**
+         * Registered push endpoints when `pushNotifications` was requested.
+         */
         pushNotifications?: Array<MasterPlayerModels.PushNotificationItem>;
     }
+    /**
+     * Base master-player response envelope.
+     */
     class MasterPlayerResponseData {
+        /**
+         * Optional field bag controlled by the corresponding `InfoRequestParam`.
+         */
         infoResponseParameters: InfoResponseParameters;
     }
+    /**
+     * Master-player envelope for generic-service link or lookup flows.
+     */
     class GenericServiceMasterPlayerResponseData extends MasterPlayerResponseData {
+        /**
+         * Provider-specific error text returned by the backend when available.
+         */
         errorMessage?: string;
     }
+    /**
+     * Master-player envelope that also exposes the resolved master-player user ID.
+     */
     class MasterPlayerWithUserIdResponseData extends MasterPlayerResponseData {
         userId: string;
     }
+    /**
+     * Defines the response payload for MasterPlayerWithAppleId.
+     */
     class MasterPlayerWithAppleIdResponseData extends MasterPlayerWithUserIdResponseData {
         appleId: string;
     }
+    /**
+     * Defines the response payload for GetPlayersWithApple.
+     */
     class GetPlayersWithAppleResponseData {
         results: Array<MasterPlayerWithAppleIdResponseData>;
     }
+    /**
+     * Defines the response payload for MasterPlayersWithUserId.
+     */
     class MasterPlayersWithUserIdResponseData {
         results: Array<MasterPlayerWithUserIdResponseData>;
     }
+    /**
+     * Defines the response payload for MasterPlayerWithFacebookId.
+     */
     class MasterPlayerWithFacebookIdResponseData extends MasterPlayerWithUserIdResponseData {
         facebookId: string;
     }
+    /**
+     * Defines the response payload for GetPlayersWithFacebook.
+     */
     class GetPlayersWithFacebookResponseData {
         results: Array<MasterPlayerWithFacebookIdResponseData>;
     }
+    /**
+     * Defines the response payload for MasterPlayerWithGenericServiceId.
+     */
     class MasterPlayerWithGenericServiceIdResponseData extends MasterPlayerWithUserIdResponseData {
         serviceId: string;
     }
+    /**
+     * Defines the response payload for GetPlayersWithGenericService.
+     */
     class GetPlayersWithGenericServiceResponseData {
         results: Array<MasterPlayerWithGenericServiceIdResponseData>;
     }
+    /**
+     * Defines the response payload for MasterPlayerWithGoogleId.
+     */
     class MasterPlayerWithGoogleIdResponseData extends MasterPlayerWithUserIdResponseData {
         googleId: string;
     }
+    /**
+     * Defines the response payload for GetPlayersWithGoogle.
+     */
     class GetPlayersWithGoogleResponseData {
         results: Array<MasterPlayerWithGoogleIdResponseData>;
     }
+    /**
+     * Defines the response payload for MasterPlayerWithPlayerId.
+     */
     class MasterPlayerWithPlayerIdResponseData extends MasterPlayerWithUserIdResponseData {
         playerId: string;
     }
+    /**
+     * Defines the response payload for GetPlayersWithGooglePlayGameService.
+     */
     class GetPlayersWithGooglePlayGameServiceResponseData {
         results: Array<MasterPlayerWithPlayerIdResponseData>;
     }
+    /**
+     * Defines the response payload for GetPlayersWithGameCenter.
+     */
     class GetPlayersWithGameCenterResponseData {
         results: Array<MasterPlayerWithPlayerIdResponseData>;
     }
+    /**
+     * One leaderboard row for master-player ranking endpoints.
+     */
     class MasterPlayerLeaderboardResponseData extends MasterPlayerWithUserIdResponseData {
+        /**
+         * Ranking position returned by the backend leaderboard implementation.
+         */
         position: number;
+        /**
+         * Optional archived score value from the last leaderboard backup.
+         */
         backupValue?: number;
     }
+    /**
+     * Describes one statistics or currency change log entry.
+     */
     class MasterPlayerLogResponseData {
         userId: string;
         tsCreate: number;
@@ -974,19 +1991,37 @@ export declare namespace MasterPlayerModels {
         startValue: number;
         finalValue: number;
     }
+    /**
+     * Returns a statistics leaderboard page plus its optional snapshot timestamp.
+     */
     class GetStatisticsLeaderboardResponseData {
         results: Array<MasterPlayerLeaderboardResponseData>;
+        /**
+         * Snapshot timestamp used for this leaderboard page when returned by the backend.
+         */
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardResponseData {
         results: Array<MasterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardResponseData {
         results: Array<MasterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetLastLoginLeaderboard.
+     */
     class GetLastLoginLeaderboardResponseData {
         results: Array<MasterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the request payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -994,24 +2029,51 @@ export declare namespace MasterPlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetCurrencyLeaderboard.
+     */
     class ServerGetCurrencyLeaderboardRequestData extends GetCurrencyLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCurrencyLeaderboard.
+     */
     class AdminGetCurrencyLeaderboardRequestData extends ServerGetCurrencyLeaderboardRequestData {
     }
+    /**
+     * Returns one page of statistics logs.
+     */
     class GetStatisticsLogResponseData {
         results: Array<MasterPlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Returns one page of currency logs.
+     */
     class GetCurrencyLogResponseData {
         results: Array<MasterPlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Returns the backend-generated push endpoint ID.
+     */
     class AddPushNotificationResponseData {
         pushId: string;
     }
+    /**
+     * Returns the backend send status message for push-dispatch workflows.
+     */
     class SendPushNotificationResponseData {
         message: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }