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

package/responseModel/chatgpt/Multiplayer.json

@@ -1,634 +0,0 @@
-{
-  "requestType": "Multiplayer",
-  "description": "API endpoints for managing matchmaking, match creation, player ticketing, and multiplayer server metadata.",
-  "operations": [
-    {
-      "operationCode": "CancelAllMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "QueueName",
-              "description": "The name of the matchmaking queue in which the ticket resides.",
-              "type": "string"
-            }
-          ]
-        },
-        {
-           "role": "Server",
-          "requestData": [
-            {
-              "code": "UserId",
-              "description": "UserId parameter.",
-              "type": "string"
-            }
-          ]
-        }
-      ],
-      "description": "Cancels all matchmaking tickets associated with the player."
-    },
-    {
-      "operationCode": "CancelMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "TicketId",
-              "description": "The unique identifier of the matchmaking ticket.",
-              "type": "string"
-            }
-          ]
-        },
-        {
-           "role": "Server",
-          "requestData": [
-            {
-              "code": "UserId",
-              "description": "UserId parameter.",
-              "type": "string"
-            }
-          ]
-        }
-      ],
-      "description": "Cancels a specific matchmaking ticket by its unique ticket ID."
-    },
-    {
-      "operationCode": "CreateMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "GiveUpAfterSeconds",
-              "description": "The timeout duration after which the matchmaking ticket will expire.",
-              "type": "number"
-            },
-            {
-              "code": "QueueName",
-              "description": "The name of the matchmaking queue in which the ticket resides.",
-              "type": "string"
-            },
-            {
-              "code": "Attribute",
-              "description": "Attribute parameter.",
-              "type": "GNHashtable"
-            },
-            {
-              "code": "Members",
-              "description": "A list of players to include in the matchmaking request.",
-              "type": "Array<string>"
-            }
-          ]
-        },
-        {
-           "role": "Server",
-          "requestData": [
-            {
-              "code": "UserId",
-              "description": "UserId parameter.",
-              "type": "string"
-            }
-          ]
-        }
-      ],
-      "description": "Creates a new matchmaking ticket with specified members and configuration."
-    },
-    {
-      "operationCode": "GetAllMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "Status",
-              "description": "Status parameter.",
-              "type": "number"
-            },
-            {
-              "code": "ReturnMember",
-              "description": "ReturnMember parameter.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "Skip",
-              "description": "Skip parameter.",
-              "type": "number",
-              "defaultValue": "0"
-            },
-            {
-              "code": "Limit",
-              "description": "Limit parameter.",
-              "type": "number",
-              "defaultValue": "10"
-            }
-          ]
-        }
-      ],
-      "description": "Retrieves all active matchmaking tickets for the current player or context."
-    },
-    {
-      "operationCode": "GetAllMatch",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "ReturnMember",
-              "description": "ReturnMember parameter.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "Skip",
-              "description": "Skip parameter.",
-              "type": "number",
-              "defaultValue": "0"
-            },
-            {
-              "code": "Limit",
-              "description": "Limit parameter.",
-              "type": "number",
-              "defaultValue": "10"
-            }
-          ]
-        }
-      ],
-      "description": "Returns all active or available matches that can be joined or observed."
-    },
-    {
-      "operationCode": "GetMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "TicketId",
-              "description": "The unique identifier of the matchmaking ticket.",
-              "type": "string"
-            },
-            {
-              "code": "ReturnMember",
-              "description": "ReturnMember parameter.",
-              "type": "boolean",
-              "defaultValue": "false"
-            }
-          ]
-        }
-      ],
-      "description": "Fetches detailed information for a specific matchmaking ticket."
-    },
-    {
-      "operationCode": "GetMatch",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "MatchId",
-              "description": "The unique identifier of the match.",
-              "type": "string"
-            },
-            {
-              "code": "ReturnMember",
-              "description": "ReturnMember parameter.",
-              "type": "boolean",
-              "defaultValue": "false"
-            }
-          ]
-        }
-      ],
-      "description": "Retrieves full metadata and status of a match using its match ID."
-    },
-    {
-      "operationCode": "GetQueueStatistics",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "QueueName",
-              "description": "The name of the matchmaking queue in which the ticket resides.",
-              "type": "string"
-            },
-            {
-              "code": "TimeInSeconds",
-              "description": "TimeInSeconds parameter.",
-              "type": "number"
-            }
-          ]
-        }
-      ],
-      "description": "Returns statistics and metrics for a specific matchmaking queue."
-    },
-    {
-      "operationCode": "JoinMatchmakingTicket",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "TicketId",
-              "description": "The unique identifier of the matchmaking ticket.",
-              "type": "string"
-            },
-            {
-              "code": "Attribute",
-              "description": "Attribute parameter.",
-              "type": "GNHashtable"
-            }
-          ]
-        },
-        {
-           "role": "Server",
-          "requestData": [
-            {
-              "code": "UserId",
-              "description": "UserId parameter.",
-              "type": "string"
-            }
-          ]
-        }
-      ],
-      "description": "Adds a player to an existing matchmaking ticket."
-    },
-    {
-      "operationCode": "ListMatchmakingTicketsForPlayer",
-      "details": [
-        {
-           "role": "Client",
-          "requestData": [
-            {
-              "code": "QueueName",
-              "description": "The name of the matchmaking queue in which the ticket resides.",
-              "type": "string"
-            }
-          ]
-        },
-        {
-           "role": "Server",
-          "requestData": [
-            {
-              "code": "UserId",
-              "description": "UserId parameter.",
-              "type": "string"
-            }
-          ]
-        }
-      ],
-      "description": "Returns all tickets currently associated with a given player."
-    }
-  ],
-  "models": [
-    {
-      "name": "CancelAllMatchmakingTicketResponseData",
-      "details": [
-        {
-          "code": "TicketIds",
-          "description": "TicketIds field in CancelAllMatchmakingTicketResponseData.",
-          "type": "Array<string>"
-        }
-      ],
-      "extends": null,
-      "description": "Response returned after canceling all matchmaking tickets."
-    },
-    {
-      "name": "CreateMatchmakingTicketResponseData",
-      "details": [
-        {
-          "code": "TicketId",
-          "description": "Unique identifier of the matchmaking ticket.",
-          "type": "string"
-        }
-      ],
-      "extends": null,
-      "description": "Response containing the ticket ID of the newly created matchmaking ticket."
-    },
-    {
-      "name": "MatchmakingTicketMember",
-      "details": [
-        {
-          "code": "UserId",
-          "description": "UserId field in MatchmakingTicketMember.",
-          "type": "string"
-        },
-        {
-          "code": "Status",
-          "description": "Current status of the ticket or match.",
-          "type": "number"
-        },
-        {
-          "code": "Attribute",
-          "description": "Attribute field in MatchmakingTicketMember.",
-          "type": "GNHashtable"
-        }
-      ],
-      "extends": null,
-      "description": "Represents a single player participating in a matchmaking ticket."
-    },
-    {
-      "name": "MatchmakingTicketResponseData",
-      "details": [
-        {
-          "code": "TsCreate",
-          "description": "TsCreate field in MatchmakingTicketResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "CreatorId",
-          "description": "CreatorId field in MatchmakingTicketResponseData.",
-          "type": "string"
-        },
-        {
-          "code": "GiveUpAfterSeconds",
-          "description": "Maximum number of seconds the matchmaking system will search before expiring the ticket.",
-          "type": "number"
-        },
-        {
-          "code": "QueueName",
-          "description": "Name of the matchmaking queue.",
-          "type": "string"
-        },
-        {
-          "code": "Status",
-          "description": "Current status of the ticket or match.",
-          "type": "number"
-        },
-        {
-          "code": "MatchId",
-          "description": "Unique identifier of the match.",
-          "type": "string"
-        },
-        {
-          "code": "Members",
-          "description": "List of players included in the matchmaking ticket or match.",
-          "type": "Array<MatchmakingTicketMember>"
-        }
-      ],
-      "extends": null,
-      "description": "Metadata about a matchmaking ticket, including status and player info."
-    },
-    {
-      "name": "MatchmakingTicketWithTicketIdResponseData",
-      "details": [
-        {
-          "code": "TicketId",
-          "description": "Unique identifier of the matchmaking ticket.",
-          "type": "string"
-        },
-        {
-          "code": "TsCreate",
-          "description": "TsCreate field in MatchmakingTicketWithTicketIdResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "CreatorId",
-          "description": "CreatorId field in MatchmakingTicketWithTicketIdResponseData.",
-          "type": "string"
-        },
-        {
-          "code": "GiveUpAfterSeconds",
-          "description": "Maximum number of seconds the matchmaking system will search before expiring the ticket.",
-          "type": "number"
-        },
-        {
-          "code": "QueueName",
-          "description": "Name of the matchmaking queue.",
-          "type": "string"
-        },
-        {
-          "code": "Status",
-          "description": "Current status of the ticket or match.",
-          "type": "number"
-        },
-        {
-          "code": "MatchId",
-          "description": "Unique identifier of the match.",
-          "type": "string"
-        },
-        {
-          "code": "Members",
-          "description": "List of players included in the matchmaking ticket or match.",
-          "type": "Array<MatchmakingTicketMember>"
-        }
-      ],
-      "extends": null,
-      "description": "Matchmaking ticket information paired with its ticket ID."
-    },
-    {
-      "name": "GetMatchmakingTicketResponseData",
-      "details": [
-        {
-          "code": "MatchmakingTicket",
-          "description": "MatchmakingTicket field in GetMatchmakingTicketResponseData.",
-          "type": "MatchmakingTicketResponseData"
-        }
-      ],
-      "extends": null,
-      "description": "Full ticket detail returned by GetMatchmakingTicket."
-    },
-    {
-      "name": "MatchMember",
-      "details": [
-        {
-          "code": "UserId",
-          "description": "UserId field in MatchMember.",
-          "type": "string"
-        },
-        {
-          "code": "TeamId",
-          "description": "TeamId field in MatchMember.",
-          "type": "string"
-        },
-        {
-          "code": "Attribute",
-          "description": "Attribute field in MatchMember.",
-          "type": "GNHashtable"
-        }
-      ],
-      "extends": null,
-      "description": "Represents a participant in a match, including identifiers and attributes."
-    },
-    {
-      "name": "PortInfo",
-      "details": [
-        {
-          "code": "Name",
-          "description": "Name field in PortInfo.",
-          "type": "string"
-        },
-        {
-          "code": "PublicPort",
-          "description": "PublicPort field in PortInfo.",
-          "type": "number"
-        },
-        {
-          "code": "PrivatePort",
-          "description": "PrivatePort field in PortInfo.",
-          "type": "number"
-        },
-        {
-          "code": "Protocol",
-          "description": "Protocol field in PortInfo.",
-          "type": "number"
-        }
-      ],
-      "extends": null,
-      "description": "Networking port configuration for multiplayer server communication."
-    },
-    {
-      "name": "ServerDetail",
-      "details": [
-        {
-          "code": "IpV4Address",
-          "description": "IpV4Address field in ServerDetail.",
-          "type": "string"
-        },
-        {
-          "code": "Ports",
-          "description": "Network ports allocated for player-server communication.",
-          "type": "Array<PortInfo>"
-        }
-      ],
-      "extends": null,
-      "description": "Information about the allocated game server, including connection endpoints."
-    },
-    {
-      "name": "MatchResponseData",
-      "details": [
-        {
-          "code": "TsCreate",
-          "description": "TsCreate field in MatchResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "QueueName",
-          "description": "Name of the matchmaking queue.",
-          "type": "string"
-        },
-        {
-          "code": "Members",
-          "description": "List of players included in the matchmaking ticket or match.",
-          "type": "Array<MatchMember>"
-        },
-        {
-          "code": "TimeToMatchInSeconds",
-          "description": "TimeToMatchInSeconds field in MatchResponseData.",
-          "type": "number"
-        }
-      ],
-      "extends": null,
-      "description": "Metadata about a completed or ongoing match."
-    },
-    {
-      "name": "MatchWithMatchIdResponseData",
-      "details": [
-        {
-          "code": "MatchId",
-          "description": "Unique identifier of the match.",
-          "type": "string"
-        },
-        {
-          "code": "TsCreate",
-          "description": "TsCreate field in MatchWithMatchIdResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "QueueName",
-          "description": "Name of the matchmaking queue.",
-          "type": "string"
-        },
-        {
-          "code": "Members",
-          "description": "List of players included in the matchmaking ticket or match.",
-          "type": "Array<MatchMember>"
-        },
-        {
-          "code": "TimeToMatchInSeconds",
-          "description": "TimeToMatchInSeconds field in MatchWithMatchIdResponseData.",
-          "type": "number"
-        }
-      ],
-      "extends": null,
-      "description": "Match data referenced by its unique match ID."
-    },
-    {
-      "name": "GetMatchResponseData",
-      "details": [
-        {
-          "code": "Match",
-          "description": "Match field in GetMatchResponseData.",
-          "type": "MatchResponseData"
-        }
-      ],
-      "extends": null,
-      "description": "Response payload for GetMatch, including server and member info."
-    },
-    {
-      "name": "GetQueueStatisticsResponseData",
-      "details": [
-        {
-          "code": "PendingMemberCount",
-          "description": "PendingMemberCount field in GetQueueStatisticsResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "PendingTicketCount",
-          "description": "PendingTicketCount field in GetQueueStatisticsResponseData.",
-          "type": "number"
-        },
-        {
-          "code": "AverageMatchmakingTimeInSeconds",
-          "description": "AverageMatchmakingTimeInSeconds field in GetQueueStatisticsResponseData.",
-          "type": "number"
-        }
-      ],
-      "extends": null,
-      "description": "Statistics for a matchmaking queue, such as average wait times."
-    },
-    {
-      "name": "ListMatchmakingTicketsForPlayerResponseData",
-      "details": [
-        {
-          "code": "TicketIds",
-          "description": "TicketIds field in ListMatchmakingTicketsForPlayerResponseData.",
-          "type": "Array<string>"
-        }
-      ],
-      "extends": null,
-      "description": "List of all active or pending tickets for a player."
-    },
-    {
-      "name": "GetAllMatchResponseData",
-      "details": [
-        {
-          "code": "Results",
-          "description": "Results field in GetAllMatchResponseData.",
-          "type": "Array<MatchWithMatchIdResponseData>"
-        }
-      ],
-      "extends": null,
-      "description": "List of all available matches in the current environment."
-    },
-    {
-      "name": "GetAllMatchmakingTicketResponseData",
-      "details": [
-        {
-          "code": "Results",
-          "description": "Results field in GetAllMatchmakingTicketResponseData.",
-          "type": "Array<MatchmakingTicketWithTicketIdResponseData>"
-        }
-      ],
-      "extends": null,
-      "description": "Returns all matchmaking tickets in the environment."
-    },
-    {
-      "name": "EmptyResponseData",
-      "details": [],
-      "extends": null,
-      "description": "Standard response used when no data is returned upon success."
-    }
-  ]
-}