@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -1,163 +1,495 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { CharacterPlayerModels } from "./CharacterPlayerModels";
+/**
+ * Typed response wrappers for the CharacterPlayer domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link CharacterPlayerModels}.
+ * The same wrapper class is reused across the
+ * client / server / admin role variants because the response
+ * shape does not depend on which role issued the request.
+ *
+ * Many read operations resolve to a profile-style envelope
+ * (`CharacterPlayerResponseData` or a derived shape) whose
+ * `infoResponseParameters` field is gated by the matching
+ * request DTO's `infoRequestParam` flags.
+ */
 export declare namespace CharacterPlayerResponseModels {
+    /**
+     * Maps the AddPlayerFriend operation to a typed response wrapper.
+     */
     class AddPlayerFriendOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new AddPlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the AddSegment operation to a typed response wrapper.
+     */
     class AddSegmentOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new AddSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAvatar operation to a typed response wrapper.
+     */
     class GetAvatarOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCatalogId operation to a typed response wrapper.
+     */
     class GetCatalogIdOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetCatalogIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCountryCode operation to a typed response wrapper.
+     */
     class GetCountryCodeOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetCountryCodeOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCustomData operation to a typed response wrapper.
+     */
     class GetCustomDataOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetDisplayName operation to a typed response wrapper.
+     */
     class GetDisplayNameOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFriendStatisticsLeaderboardAroundPlayer operation to a typed response wrapper.
+     */
     class GetFriendStatisticsLeaderboardAroundPlayerOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetFriendStatisticsLeaderboardAroundPlayerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFriendStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetFriendStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetFriendStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetIpAddressCreate operation to a typed response wrapper.
+     */
     class GetIpAddressCreateOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetIpAddressCreateOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetOwner operation to a typed response wrapper.
+     */
     class GetOwnerOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetOwnerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerBan operation to a typed response wrapper.
+     */
     class GetPlayerBanOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerBanOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerCurrency operation to a typed response wrapper.
+     */
     class GetPlayerCurrencyOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerData operation to a typed response wrapper.
+     */
     class GetPlayerDataOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerFriend operation to a typed response wrapper.
+     */
     class GetPlayerFriendOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerGroup operation to a typed response wrapper.
+     */
     class GetPlayerGroupOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerInformation operation to a typed response wrapper.
+     */
     class GetPlayerInformationOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerInventory operation to a typed response wrapper.
+     */
     class GetPlayerInventoryOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerInventoryOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerStatistics operation to a typed response wrapper.
+     */
     class GetPlayerStatisticsOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetPlayerStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithDisplayName operation to a typed response wrapper.
+     */
     class GetPlayersWithDisplayNameOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayersWithCharacterIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithSegment operation to a typed response wrapper.
+     */
     class GetPlayersWithSegmentOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayersWithCharacterIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithTag operation to a typed response wrapper.
+     */
     class GetPlayersWithTagOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayersWithCharacterIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetRemoveStatus operation to a typed response wrapper.
+     */
     class GetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSegment operation to a typed response wrapper.
+     */
     class GetSegmentOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboardAroundPlayer operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardAroundPlayerOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardAroundPlayerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTag operation to a typed response wrapper.
+     */
     class GetTagOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsCreate operation to a typed response wrapper.
+     */
     class GetTsCreateOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetTsCreateOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsLastLogin operation to a typed response wrapper.
+     */
     class GetTsLastLoginOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new GetTsLastLoginOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateGroup operation to a typed response wrapper.
+     */
     class CreateGroupOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new CreateGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreatePlayerItem operation to a typed response wrapper.
+     */
     class CreatePlayerItemOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new CreatePlayerItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the JoinGroup operation to a typed response wrapper.
+     */
     class JoinGroupOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new JoinGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LeaveGroup operation to a typed response wrapper.
+     */
     class LeaveGroupOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new LeaveGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemovePlayerFriend operation to a typed response wrapper.
+     */
     class RemovePlayerFriendOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemovePlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemovePlayerItem operation to a typed response wrapper.
+     */
     class RemovePlayerItemOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemovePlayerItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveSegment operation to a typed response wrapper.
+     */
     class RemoveSegmentOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveTag operation to a typed response wrapper.
+     */
     class RemoveTagOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetAvatar operation to a typed response wrapper.
+     */
     class SetAvatarOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCountryCode operation to a typed response wrapper.
+     */
     class SetCountryCodeOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetCountryCodeOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCustomData operation to a typed response wrapper.
+     */
     class SetCustomDataOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new SetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetDisplayName operation to a typed response wrapper.
+     */
     class SetDisplayNameOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetOwner operation to a typed response wrapper.
+     */
     class SetOwnerOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetOwnerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetPlayerBan operation to a typed response wrapper.
+     */
     class SetPlayerBanOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetPlayerBanOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangePlayerCurrency operation to a typed response wrapper.
+     */
     class ChangePlayerCurrencyOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new ChangePlayerCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetPlayerData operation to a typed response wrapper.
+     */
     class SetPlayerDataOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new SetPlayerDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangePlayerStatistics operation to a typed response wrapper.
+     */
     class ChangePlayerStatisticsOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.CharacterPlayerResponseData> {
+        /**
+         * Creates a new ChangePlayerStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetRemoveStatus operation to a typed response wrapper.
+     */
     class SetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetTag operation to a typed response wrapper.
+     */
     class SetTagOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLeaderboard operation to a typed response wrapper.
+     */
     class GetCurrencyLeaderboardOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetCurrencyLeaderboardResponseData> {
+        /**
+         * Creates a new GetCurrencyLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCreateLeaderboard operation to a typed response wrapper.
+     */
     class GetCreateLeaderboardOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetCreateLeaderboardResponseData> {
+        /**
+         * Creates a new GetCreateLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetLastLoginLeaderboard operation to a typed response wrapper.
+     */
     class GetLastLoginLeaderboardOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetLastLoginLeaderboardResponseData> {
+        /**
+         * Creates a new GetLastLoginLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLog operation to a typed response wrapper.
+     */
     class GetStatisticsLogOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetStatisticsLogResponseData> {
+        /**
+         * Creates a new GetStatisticsLogOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLog operation to a typed response wrapper.
+     */
     class GetCurrencyLogOperationResponse extends CustomOperationResponseAbstract<CharacterPlayerModels.GetCurrencyLogResponseData> {
+        /**
+         * Creates a new GetCurrencyLogOperationResponse instance.
+         */
         constructor();
     }
 }

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

@@ -1,71 +1,180 @@
+/**
+ * Reusable request and response DTOs for the CloudScript
+ * domain.
+ *
+ * Two distinct flows live here:
+ *
+ * 1. **Function execution** — `ExecuteFunctionRequestData` /
+ *    `ExecuteFunctionResponseData`. The application invokes a
+ *    named function inside a specific script version and
+ *    receives the result, which carries an
+ *    {@link ExecuteResponseStatus} discriminator. Available to
+ *    Client / Server / Admin roles depending on the backend
+ *    permission table.
+ *
+ * 2. **Function management** — `AddFunctionRequestData` /
+ *    `SetFunctionRequestData` / `RemoveFunctionRequestData` /
+ *    version-management DTOs. Reserved for Server / Admin
+ *    callers in practice; the dashboard is the primary
+ *    consumer.
+ *
+ * Validation rules declared on each `@*DataMember` decorator
+ * are enforced server-side; failures surface as
+ * {@link InvalidMember} entries.
+ */
 export declare namespace CloudScriptModels {
+    /**
+     * Creates a new CloudScript version from raw script source.
+     */
     class AddFunctionRequestData {
         script: string;
         canExecute: boolean;
         isLive: boolean;
     }
+    /**
+     * Defines the request payload for ServerAddFunction.
+     */
     class ServerAddFunctionRequestData extends AddFunctionRequestData {
     }
+    /**
+     * Defines the request payload for AdminAddFunction.
+     */
     class AdminAddFunctionRequestData extends ServerAddFunctionRequestData {
     }
+    /**
+     * Updates execution flags for an existing CloudScript version without changing its source code.
+     */
     class EditFunctionRequestData {
         version: string;
         canExecute: boolean;
         isLive: boolean;
     }
+    /**
+     * Defines the request payload for ServerEditFunction.
+     */
     class ServerEditFunctionRequestData extends EditFunctionRequestData {
     }
+    /**
+     * Defines the request payload for AdminEditFunction.
+     */
     class AdminEditFunctionRequestData extends ServerEditFunctionRequestData {
     }
+    /**
+     * Executes one function from the selected CloudScript version.
+     */
     class ExecuteFunctionRequestData {
+        /**
+         * Optional self-target shortcut on the client route; trusted routes require it through derived classes.
+         */
         userId?: string;
+        /**
+         * Function name inside the script version, not the version identifier itself.
+         */
         functionName: string;
+        /**
+         * Arbitrary payload forwarded to the CloudScript function.
+         */
         functionParameters?: any;
+        /**
+         * Optional version override; when omitted, backend execution rules decide which live version is used.
+         */
         version?: string;
     }
+    /**
+     * Defines the request payload for ServerExecuteFunction.
+     */
     class ServerExecuteFunctionRequestData extends ExecuteFunctionRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminExecuteFunction.
+     */
     class AdminExecuteFunctionRequestData extends ServerExecuteFunctionRequestData {
     }
+    /**
+     * Defines the request payload for GetFunction.
+     */
     class GetFunctionRequestData {
         version: string;
     }
+    /**
+     * Defines the request payload for ServerGetFunction.
+     */
     class ServerGetFunctionRequestData extends GetFunctionRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFunction.
+     */
     class AdminGetFunctionRequestData extends ServerGetFunctionRequestData {
     }
+    /**
+     * Defines the request payload for GetFunctions.
+     */
     class GetFunctionsRequestData {
     }
+    /**
+     * Defines the request payload for ServerGetFunctions.
+     */
     class ServerGetFunctionsRequestData extends GetFunctionsRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFunctions.
+     */
     class AdminGetFunctionsRequestData extends ServerGetFunctionsRequestData {
     }
+    /**
+     * Returns the created version plus backend validation feedback.
+     */
     class AddFunctionResponseData {
         version: string;
         errorMessage: string;
     }
+    /**
+     * Returns backend validation feedback for an edit workflow.
+     */
     class EditFunctionResponseData {
         errorMessage: string;
     }
+    /**
+     * Returns runtime telemetry and function output for one execution.
+     */
     class ExecuteFunctionResponseData {
+        /**
+         * Raw execution status code returned by the backend.
+         * The public package does not currently expose a dedicated enum for this field.
+         */
         status: number;
         executionTimeInMs: number;
         memoryUsedInBytes: number;
+        /**
+         * Arbitrary function return value.
+         */
         functionResult: any;
         errorMessage: string;
+        /**
+         * Ordered execution logs captured during the function run.
+         */
         functionLogs: Array<string>;
     }
+    /**
+     * Returns one full CloudScript version snapshot.
+     */
     class GetFunctionResponseData {
         script: string;
         canExecute: boolean;
         isLive: boolean;
         tsCreate: number;
     }
+    /**
+     * Describes one lightweight function-version summary.
+     */
     class FunctionResponseData {
         version: string;
         canExecute: boolean;
     }
+    /**
+     * Returns the available function-version list plus latest/live pointers.
+     */
     class GetFunctionsResponseData {
         results: Array<FunctionResponseData>;
         latestVersion: string;