@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -1,124 +1,378 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { GroupModels } from "./GroupModels";
+/**
+ * Typed response wrappers for the Group domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link GroupModels}. The same
+ * wrapper class is reused across the client / server / admin
+ * role variants because the response shape does not depend on
+ * the role.
+ *
+ * Many read operations resolve to a profile-style envelope
+ * (`GroupResponseData` or a derived shape) whose
+ * `infoResponseParameters` field is gated by the matching
+ * request DTO's `infoRequestParam` flags.
+ */
 export declare namespace GroupResponseModels {
+    /**
+     * Maps the AddMember operation to a typed response wrapper.
+     */
     class AddMemberOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new AddMemberOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the AddSegment operation to a typed response wrapper.
+     */
     class AddSegmentOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new AddSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAvatar operation to a typed response wrapper.
+     */
     class GetAvatarOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCatalogId operation to a typed response wrapper.
+     */
     class GetCatalogIdOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetCatalogIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCustomData operation to a typed response wrapper.
+     */
     class GetCustomDataOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetDisplayName operation to a typed response wrapper.
+     */
     class GetDisplayNameOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupCurrency operation to a typed response wrapper.
+     */
     class GetGroupCurrencyOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetGroupCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupData operation to a typed response wrapper.
+     */
     class GetGroupDataOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetGroupDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupInformation operation to a typed response wrapper.
+     */
     class GetGroupInformationOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetGroupInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupInventory operation to a typed response wrapper.
+     */
     class GetGroupInventoryOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetGroupInventoryOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupMessage operation to a typed response wrapper.
+     */
     class GetGroupMessageOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupMessagesResponseData> {
+        /**
+         * Creates a new GetGroupMessageOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupStatistics operation to a typed response wrapper.
+     */
     class GetGroupStatisticsOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetGroupStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupsWithDisplayName operation to a typed response wrapper.
+     */
     class GetGroupsWithDisplayNameOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupsWithGroupIdResponseData> {
+        /**
+         * Creates a new GetGroupsWithDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupsWithSegment operation to a typed response wrapper.
+     */
     class GetGroupsWithSegmentOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupsWithGroupIdResponseData> {
+        /**
+         * Creates a new GetGroupsWithSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGroupsWithTag operation to a typed response wrapper.
+     */
     class GetGroupsWithTagOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupsWithGroupIdResponseData> {
+        /**
+         * Creates a new GetGroupsWithTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetMembers operation to a typed response wrapper.
+     */
     class GetMembersOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetMembersOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetRemoveStatus operation to a typed response wrapper.
+     */
     class GetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSegment operation to a typed response wrapper.
+     */
     class GetSegmentOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboardAroundGroup operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardAroundGroupOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardAroundGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTag operation to a typed response wrapper.
+     */
     class GetTagOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsCreate operation to a typed response wrapper.
+     */
     class GetTsCreateOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new GetTsCreateOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateGroupItem operation to a typed response wrapper.
+     */
     class CreateGroupItemOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new CreateGroupItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveGroupItem operation to a typed response wrapper.
+     */
     class RemoveGroupItemOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveGroupItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveMember operation to a typed response wrapper.
+     */
     class RemoveMemberOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveMemberOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveSegment operation to a typed response wrapper.
+     */
     class RemoveSegmentOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveTag operation to a typed response wrapper.
+     */
     class RemoveTagOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SendGroupMessage operation to a typed response wrapper.
+     */
     class SendGroupMessageOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupMessagesResponseData> {
+        /**
+         * Creates a new SendGroupMessageOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetAvatar operation to a typed response wrapper.
+     */
     class SetAvatarOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new SetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCustomData operation to a typed response wrapper.
+     */
     class SetCustomDataOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new SetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetDisplayName operation to a typed response wrapper.
+     */
     class SetDisplayNameOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new SetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangeGroupCurrency operation to a typed response wrapper.
+     */
     class ChangeGroupCurrencyOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new ChangeGroupCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetGroupData operation to a typed response wrapper.
+     */
     class SetGroupDataOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new SetGroupDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangeGroupStatistics operation to a typed response wrapper.
+     */
     class ChangeGroupStatisticsOperationResponse extends CustomOperationResponseAbstract<GroupModels.GroupResponseData> {
+        /**
+         * Creates a new ChangeGroupStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetRemoveStatus operation to a typed response wrapper.
+     */
     class SetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new SetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetTag operation to a typed response wrapper.
+     */
     class SetTagOperationResponse extends CustomOperationResponseAbstract<GroupModels.EmptyResponseData> {
+        /**
+         * Creates a new SetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLeaderboard operation to a typed response wrapper.
+     */
     class GetCurrencyLeaderboardOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetCurrencyLeaderboardResponseData> {
+        /**
+         * Creates a new GetCurrencyLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCreateLeaderboard operation to a typed response wrapper.
+     */
     class GetCreateLeaderboardOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetCreateLeaderboardResponseData> {
+        /**
+         * Creates a new GetCreateLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLog operation to a typed response wrapper.
+     */
     class GetStatisticsLogOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetStatisticsLogResponseData> {
+        /**
+         * Creates a new GetStatisticsLogOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLog operation to a typed response wrapper.
+     */
     class GetCurrencyLogOperationResponse extends CustomOperationResponseAbstract<GroupModels.GetCurrencyLogResponseData> {
+        /**
+         * Creates a new GetCurrencyLogOperationResponse instance.
+         */
         constructor();
     }
 }