@xmobitea/gn-typescript-client 2.6.8-tsc → 2.6.9-tsc

package/responseModel/chatgpt/Group.json

@@ -0,0 +1,1509 @@
+{
+  "requestType": "Group",
+  "description": "API endpoints for managing player groups, including membership, group inventory, virtual currencies, statistics, custom data, and messaging.",
+  "operations": [
+    {
+      "operationCode": "AddMember",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "UserId",
+              "description": "Unique identifier of the player to be added, removed, or referenced in group operations.",
+              "type": "string"
+            },
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Add a new member to an existing player group."
+    },
+    {
+      "operationCode": "AddSegment",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Assign a segment tag to the specified group."
+    },
+    {
+      "operationCode": "ChangeGroupCurrency",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "GroupCurrencies",
+              "description": "List of currency modifications to apply to the group account.",
+              "type": "Array<GroupCurrencyParam>"
+            },
+            {
+              "code": "Log",
+              "description": "Optional message or metadata explaining the reason for the update.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Modify the virtual currency balance for the group."
+    },
+    {
+      "operationCode": "ChangeGroupStatistics",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "GroupStatistics",
+              "description": "List of group statistics and their intended modifications.",
+              "type": "Array<GroupStatisticsParam>"
+            },
+            {
+              "code": "Log",
+              "description": "Optional message or metadata explaining the reason for the update.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Update one or more statistics associated with the group."
+    },
+    {
+      "operationCode": "CreateGroupItem",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "CatalogId",
+              "description": "Identifier of the item catalog used for inventory operations.",
+              "type": "string"
+            },
+            {
+              "code": "ClassId",
+              "description": "ClassId parameter.",
+              "type": "string"
+            },
+            {
+              "code": "DisplayName",
+              "description": "The display name of the group shown in listings and leaderboards.",
+              "type": "string",
+              "defaultValue": "\"\""
+            },
+            {
+              "code": "Amount",
+              "description": "Amount parameter.",
+              "type": "number",
+              "defaultValue": "1"
+            }
+          ]
+        }
+      ],
+      "description": "Add a new item to the group’s inventory."
+    },
+    {
+      "operationCode": "GetAvatar",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve the avatar image of the group."
+    },
+    {
+      "operationCode": "GetCatalogId",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve the catalog ID currently associated with the group."
+    },
+    {
+      "operationCode": "GetCreateLeaderboard",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "LoadFromCache",
+              "description": "LoadFromCache parameter.",
+              "type": "boolean",
+              "defaultValue": "true"
+            }
+          ]
+        }
+      ],
+      "description": "Get leaderboard data ranked by group creation timestamps."
+    },
+    {
+      "operationCode": "GetCurrencyLeaderboard",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "LoadFromCache",
+              "description": "LoadFromCache parameter.",
+              "type": "boolean",
+              "defaultValue": "true"
+            },
+            {
+              "code": "CatalogId",
+              "description": "Identifier of the item catalog used for inventory operations.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve leaderboard ranked by group currency balances."
+    },
+    {
+      "operationCode": "GetCurrencyLog",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Keys",
+              "description": "List of keys used to access specific custom data entries.",
+              "type": "Array<string>"
+            },
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "Token",
+              "description": "Token parameter.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Fetch historical logs of group currency transactions."
+    },
+    {
+      "operationCode": "GetCustomData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "CustomDataKeys",
+              "description": "CustomDataKeys parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve key-value custom data entries defined for the group."
+    },
+    {
+      "operationCode": "GetDisplayName",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Fetch the display name associated with the group."
+    },
+    {
+      "operationCode": "GetGroupCurrency",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "GroupCurrencyKeys",
+              "description": "GroupCurrencyKeys parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve the current virtual currency balances of the group."
+    },
+    {
+      "operationCode": "GetGroupData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "GroupDataKeys",
+              "description": "GroupDataKeys parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve key-value data entries stored under the group profile."
+    },
+    {
+      "operationCode": "GetGroupInformation",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            }
+          ]
+        }
+      ],
+      "description": "Fetch detailed metadata and profile fields associated with the group."
+    },
+    {
+      "operationCode": "GetGroupInventory",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "ItemCatalogIds",
+              "description": "ItemCatalogIds parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve a list of items currently held in the group's inventory."
+    },
+    {
+      "operationCode": "GetGroupMessage",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve a specific message sent to or by the group."
+    },
+    {
+      "operationCode": "GetGroupStatistics",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "StatisticsKeys",
+              "description": "StatisticsKeys parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve statistical data associated with the group."
+    },
+    {
+      "operationCode": "GetGroupsWithDisplayName",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Keyword",
+              "description": "Keyword parameter.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            }
+          ]
+        }
+      ],
+      "description": "Search for groups whose display names match a given pattern."
+    },
+    {
+      "operationCode": "GetGroupsWithSegment",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            }
+          ]
+        }
+      ],
+      "description": "List all groups assigned to a particular segment."
+    },
+    {
+      "operationCode": "GetGroupsWithTag",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            },
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            }
+          ]
+        }
+      ],
+      "description": "Return a list of groups that share a specific tag."
+    },
+    {
+      "operationCode": "GetMembers",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve a list of all members currently in the group."
+    },
+    {
+      "operationCode": "GetRemoveStatus",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Check whether the group is flagged for removal."
+    },
+    {
+      "operationCode": "GetSegment",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve all available group segment definitions."
+    },
+    {
+      "operationCode": "GetStatisticsLeaderboardAroundGroup",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "LoadFromCache",
+              "description": "LoadFromCache parameter.",
+              "type": "boolean",
+              "defaultValue": "true"
+            },
+            {
+              "code": "CatalogId",
+              "description": "Identifier of the item catalog used for inventory operations.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Get a leaderboard centered around the group’s rank for a specific statistic."
+    },
+    {
+      "operationCode": "GetStatisticsLeaderboard",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            },
+            {
+              "code": "InfoRequestParam",
+              "description": "InfoRequestParam parameter.",
+              "type": "InfoRequestParam"
+            },
+            {
+              "code": "Skip",
+              "description": "Skip parameter.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "LoadFromCache",
+              "description": "LoadFromCache parameter.",
+              "type": "boolean",
+              "defaultValue": "true"
+            },
+            {
+              "code": "Version",
+              "description": "Version parameter.",
+              "type": "string"
+            },
+            {
+              "code": "CatalogId",
+              "description": "Identifier of the item catalog used for inventory operations.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Return the full leaderboard for a group-specific statistic."
+    },
+    {
+      "operationCode": "GetStatisticsLog",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Keys",
+              "description": "List of keys used to access specific custom data entries.",
+              "type": "Array<string>"
+            },
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit parameter.",
+              "type": "number",
+              "defaultValue": "10"
+            },
+            {
+              "code": "Token",
+              "description": "Token parameter.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Fetch a history of statistic modifications made to the group."
+    },
+    {
+      "operationCode": "GetTag",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "TagKeys",
+              "description": "TagKeys parameter.",
+              "type": "Array<string>"
+            }
+          ]
+        }
+      ],
+      "description": "List all tags currently associated with the group."
+    },
+    {
+      "operationCode": "GetTsCreate",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Retrieve the timestamp when the group was created."
+    },
+    {
+      "operationCode": "RemoveGroupItem",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "ItemId",
+              "description": "ID of the item to be created, modified, or removed in the group inventory.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Delete a specific item from the group's inventory."
+    },
+    {
+      "operationCode": "RemoveMember",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "UserId",
+              "description": "Unique identifier of the player to be added, removed, or referenced in group operations.",
+              "type": "string"
+            },
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Remove a member from the group."
+    },
+    {
+      "operationCode": "RemoveSegment",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Remove a segment tag previously assigned to the group."
+    },
+    {
+      "operationCode": "RemoveTag",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Delete a tag previously associated with the group."
+    },
+    {
+      "operationCode": "SendGroupMessage",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "SenderId",
+              "description": "SenderId parameter.",
+              "type": "string"
+            },
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Message",
+              "description": "Text or structured message content to be delivered to the group.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Send a message to all or specific members of the group."
+    },
+    {
+      "operationCode": "SetAvatar",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Type",
+              "description": "Type parameter.",
+              "type": "number"
+            },
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Update the group’s avatar image."
+    },
+    {
+      "operationCode": "SetCustomData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "CustomDatas",
+              "description": "CustomDatas parameter.",
+              "type": "Array<CustomDataParam>"
+            }
+          ]
+        }
+      ],
+      "description": "Create or update custom key-value data entries for the group."
+    },
+    {
+      "operationCode": "SetDisplayName",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "DisplayName",
+              "description": "The display name of the group shown in listings and leaderboards.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Change the display name associated with the group."
+    },
+    {
+      "operationCode": "SetGroupData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "GroupDatas",
+              "description": "GroupDatas parameter.",
+              "type": "Array<GroupDataParam>"
+            }
+          ]
+        }
+      ],
+      "description": "Modify or replace structured key-value data for the group."
+    },
+    {
+      "operationCode": "SetRemoveStatus",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Reason",
+              "description": "Reason parameter.",
+              "type": "string",
+              "defaultValue": "\"\""
+            }
+          ]
+        }
+      ],
+      "description": "Mark the group for deletion or cancel a previous remove request."
+    },
+    {
+      "operationCode": "SetTag",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "GroupId",
+              "description": "Unique identifier of the group targeted by the request.",
+              "type": "string"
+            },
+            {
+              "code": "Key",
+              "description": "Key parameter.",
+              "type": "string"
+            },
+            {
+              "code": "Value",
+              "description": "The segment or tag value to be assigned to the group.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Assign a tag to the group for organizational or filtering purposes."
+    }
+  ],
+  "models": [
+    {
+      "name": "CustomDataParam",
+      "details": [
+        {
+          "code": "Key",
+          "description": "Name of the key used for storing custom or structured data.",
+          "type": "string"
+        },
+        {
+          "code": "Value",
+          "description": "Value assigned to the key in structured or custom data.",
+          "type": "any"
+        }
+      ],
+      "description": "Represents a key-value pair used for storing custom data on a group profile."
+    },
+    {
+      "name": "GroupCurrencyParam",
+      "details": [
+        {
+          "code": "Key",
+          "description": "Name of the key used for storing custom or structured data.",
+          "type": "string"
+        },
+        {
+          "code": "Amount",
+          "description": "Amount of currency to add or remove.",
+          "type": "number"
+        }
+      ],
+      "description": "Defines a currency type and amount to be modified in the group's balance."
+    },
+    {
+      "name": "GroupDataParam",
+      "details": [
+        {
+          "code": "Key",
+          "description": "Name of the key used for storing custom or structured data.",
+          "type": "string"
+        },
+        {
+          "code": "Value",
+          "description": "Value assigned to the key in structured or custom data.",
+          "type": "any"
+        }
+      ],
+      "description": "Represents a structured key-value entry stored on the group profile."
+    },
+    {
+      "name": "GroupMemberParam",
+      "details": [
+        {
+          "code": "UserId",
+          "description": "Unique identifier for a group member or user.",
+          "type": "string"
+        }
+      ],
+      "description": "Identifies a player to be added to or removed from the group."
+    },
+    {
+      "name": "GroupStatisticsParam",
+      "details": [
+        {
+          "code": "Key",
+          "description": "Name of the key used for storing custom or structured data.",
+          "type": "string"
+        },
+        {
+          "code": "Value",
+          "description": "Value assigned to the key in structured or custom data.",
+          "type": "number"
+        }
+      ],
+      "description": "Defines a statistic name and the value to be updated or set for a group."
+    },
+    {
+      "name": "InfoRequestParam",
+      "details": [
+        {
+          "code": "CatalogId",
+          "description": "CatalogId field in InfoRequestParam.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "Members",
+          "description": "Members field in InfoRequestParam.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "RemoveStatus",
+          "description": "RemoveStatus field in InfoRequestParam.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "Segments",
+          "description": "Include group segments in the response.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "CustomDatas",
+          "description": "Include custom key-value data in the response.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "DisplayName",
+          "description": "Include the group’s display name in the response.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "Avatar",
+          "description": "Include the group’s avatar reference or URL.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "TsCreate",
+          "description": "Include the timestamp of group creation.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "Tags",
+          "description": "Include tags assigned to the group.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "GroupCurrencies",
+          "description": "Include current virtual currency balances of the group.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "GroupStatistics",
+          "description": "Include statistics stored on the group profile.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "GroupDatas",
+          "description": "GroupDatas field in InfoRequestParam.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "GroupInventories",
+          "description": "GroupInventories field in InfoRequestParam.",
+          "type": "boolean",
+          "defaultValue": "false"
+        },
+        {
+          "code": "GroupDataKeys",
+          "description": "GroupDataKeys field in InfoRequestParam.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "GroupCurrencyKeys",
+          "description": "GroupCurrencyKeys field in InfoRequestParam.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "GroupStatisticsKeys",
+          "description": "GroupStatisticsKeys field in InfoRequestParam.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "CustomDataKeys",
+          "description": "CustomDataKeys field in InfoRequestParam.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "TagKeys",
+          "description": "TagKeys field in InfoRequestParam.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "ItemCatalogIds",
+          "description": "ItemCatalogIds field in InfoRequestParam.",
+          "type": "Array<string>"
+        }
+      ],
+      "description": "Flags to specify which optional fields should be included in the group response."
+    },
+    {
+      "name": "InfoResponseParameters",
+      "details": [
+        {
+          "code": "CatalogId",
+          "description": "CatalogId field in InfoResponseParameters.",
+          "type": "string"
+        },
+        {
+          "code": "Members",
+          "description": "Members field in InfoResponseParameters.",
+          "type": "Array<GenericModels.MemberItem>"
+        },
+        {
+          "code": "RemoveStatus",
+          "description": "RemoveStatus field in InfoResponseParameters.",
+          "type": "GenericModels.RemoveStatusItem"
+        },
+        {
+          "code": "Segments",
+          "description": "Include group segments in the response.",
+          "type": "Array<string>"
+        },
+        {
+          "code": "CustomDatas",
+          "description": "Include custom key-value data in the response.",
+          "type": "Array<GenericModels.DataItem>"
+        },
+        {
+          "code": "DisplayName",
+          "description": "Include the group’s display name in the response.",
+          "type": "string"
+        },
+        {
+          "code": "Avatar",
+          "description": "Include the group’s avatar reference or URL.",
+          "type": "GenericModels.AvatarItem"
+        },
+        {
+          "code": "TsCreate",
+          "description": "Include the timestamp of group creation.",
+          "type": "number"
+        },
+        {
+          "code": "Tags",
+          "description": "Include tags assigned to the group.",
+          "type": "Array<GenericModels.TagItem>"
+        },
+        {
+          "code": "GroupDatas",
+          "description": "GroupDatas field in InfoResponseParameters.",
+          "type": "Array<GenericModels.DataItem>"
+        },
+        {
+          "code": "GroupCurrencies",
+          "description": "Include current virtual currency balances of the group.",
+          "type": "Array<GenericModels.CurrencyItem>"
+        },
+        {
+          "code": "GroupStatistics",
+          "description": "Include statistics stored on the group profile.",
+          "type": "Array<GenericModels.StatisticsItem>"
+        },
+        {
+          "code": "GroupInventories",
+          "description": "GroupInventories field in InfoResponseParameters.",
+          "type": "Array<GenericModels.InventoryItem>"
+        }
+      ],
+      "extends": null,
+      "description": "Contains optional metadata fields returned in group data responses."
+    },
+    {
+      "name": "GroupResponseData",
+      "details": [
+        {
+          "code": "InfoResponseParameters",
+          "description": "InfoResponseParameters field in GroupResponseData.",
+          "type": "InfoResponseParameters"
+        }
+      ],
+      "extends": null,
+      "description": "Contains detailed information about a single group entity."
+    },
+    {
+      "name": "GroupWithGroupIdResponseData",
+      "details": [
+        {
+          "code": "GroupId",
+          "description": "Unique identifier for the group.",
+          "type": "string"
+        },
+        {
+          "code": "InfoResponseParameters",
+          "description": "InfoResponseParameters field in GroupWithGroupIdResponseData.",
+          "type": "InfoResponseParameters"
+        }
+      ],
+      "extends": null,
+      "description": "Group profile data resolved using a GroupId query."
+    },
+    {
+      "name": "GroupLeaderboardResponseData",
+      "details": [
+        {
+          "code": "Position",
+          "description": "Position field in GroupLeaderboardResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "BackupValue",
+          "description": "BackupValue field in GroupLeaderboardResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "GroupId",
+          "description": "Unique identifier for the group.",
+          "type": "string"
+        },
+        {
+          "code": "InfoResponseParameters",
+          "description": "InfoResponseParameters field in GroupLeaderboardResponseData.",
+          "type": "InfoResponseParameters"
+        }
+      ],
+      "extends": null,
+      "description": "Entry in a leaderboard containing rank and score information for a group."
+    },
+    {
+      "name": "GroupLogResponseData",
+      "details": [
+        {
+          "code": "GroupId",
+          "description": "Unique identifier for the group.",
+          "type": "string"
+        },
+        {
+          "code": "TsCreate",
+          "description": "Include the timestamp of group creation.",
+          "type": "number"
+        },
+        {
+          "code": "Log",
+          "description": "Log field in GroupLogResponseData.",
+          "type": "string"
+        },
+        {
+          "code": "Key",
+          "description": "Name of the key used for storing custom or structured data.",
+          "type": "string"
+        },
+        {
+          "code": "Amount",
+          "description": "Amount of currency to add or remove.",
+          "type": "number"
+        },
+        {
+          "code": "StartValue",
+          "description": "StartValue field in GroupLogResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "FinalValue",
+          "description": "FinalValue field in GroupLogResponseData.",
+          "type": "number"
+        }
+      ],
+      "extends": null,
+      "description": "Single record from the group's log history, including timestamp and description."
+    },
+    {
+      "name": "GetStatisticsLeaderboardResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetStatisticsLeaderboardResponseData.",
+          "type": "Array<GroupLeaderboardResponseData>"
+        },
+        {
+          "code": "TsCreate",
+          "description": "Include the timestamp of group creation.",
+          "type": "number"
+        }
+      ],
+      "extends": null,
+      "description": "Leaderboard entries for a specified statistic across groups."
+    },
+    {
+      "name": "GroupsWithGroupIdResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GroupsWithGroupIdResponseData.",
+          "type": "Array<GroupWithGroupIdResponseData>"
+        }
+      ],
+      "extends": null,
+      "description": "List of groups retrieved based on GroupId filtering."
+    },
+    {
+      "name": "GroupMessageResponseData",
+      "details": [
+        {
+          "code": "Message",
+          "description": "Text content of the message sent or received by the group.",
+          "type": "string"
+        },
+        {
+          "code": "SenderId",
+          "description": "SenderId field in GroupMessageResponseData.",
+          "type": "string"
+        },
+        {
+          "code": "SenderType",
+          "description": "SenderType field in GroupMessageResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "TsCreate",
+          "description": "Include the timestamp of group creation.",
+          "type": "number"
+        }
+      ],
+      "extends": null,
+      "description": "Represents a single message sent to or by a group."
+    },
+    {
+      "name": "GroupMessagesResponseData",
+      "details": [
+        {
+          "code": "GroupMessages",
+          "description": "GroupMessages field in GroupMessagesResponseData.",
+          "type": "Array<GroupMessageResponseData>"
+        }
+      ],
+      "extends": null,
+      "description": "List of all messages associated with a group."
+    },
+    {
+      "name": "GetCurrencyLeaderboardResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetCurrencyLeaderboardResponseData.",
+          "type": "Array<GroupLeaderboardResponseData>"
+        }
+      ],
+      "extends": null,
+      "description": "Leaderboard entries ranked by group currency balances."
+    },
+    {
+      "name": "GetCreateLeaderboardResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetCreateLeaderboardResponseData.",
+          "type": "Array<GroupLeaderboardResponseData>"
+        }
+      ],
+      "extends": null,
+      "description": "Leaderboard entries ranked by group creation times."
+    },
+    {
+      "name": "GetStatisticsLogResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetStatisticsLogResponseData.",
+          "type": "Array<GroupLogResponseData>"
+        },
+        {
+          "code": "Token",
+          "description": "Token field in GetStatisticsLogResponseData.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "Historical records of updates to group statistics."
+    },
+    {
+      "name": "GetCurrencyLogResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetCurrencyLogResponseData.",
+          "type": "Array<GroupLogResponseData>"
+        },
+        {
+          "code": "Token",
+          "description": "Token field in GetCurrencyLogResponseData.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "History of currency transactions for the group."
+    },
+    {
+      "name": "EmptyResponseData",
+      "details": [],
+      "extends": null,
+      "description": "Empty response returned when no content is needed for success acknowledgment."
+    }
+  ]
+}