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

package/responseModel/chatgpt/Authenticate.json

@@ -1,724 +0,0 @@
-{
-  "requestType": "Authenticate",
-  "description": "API requests related to user authentication.",
-  "operations": [
-    {
-      "operationCode": "LoginByAccount",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Username",
-              "description": "The username used for account authentication.",
-              "type": "string"
-            },
-            {
-              "code": "Password",
-              "description": "The password associated with the username.",
-              "type": "string"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a username and password."
-    },
-    {
-      "operationCode": "LoginByAndroidDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "AndroidDeviceId",
-              "description": "The device ID of the Android device.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using an Android device ID."
-    },
-    {
-      "operationCode": "LoginByApple",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Token",
-              "description": "Authentication token from the identity provider.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using an Apple sign-in token."
-    },
-    {
-      "operationCode": "LoginByCustomDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "CustomDeviceId",
-              "description": "A developer-defined device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a custom device ID."
-    },
-    {
-      "operationCode": "LoginByCustomId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "CustomId",
-              "description": "A developer-defined custom user ID.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a custom user-defined ID."
-    },
-    {
-      "operationCode": "LoginByEditorDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "EditorDeviceId",
-              "description": "The unique device ID from the Unity Editor.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Unity Editor device ID."
-    },
-    {
-      "operationCode": "LoginByFacebook",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Token",
-              "description": "Authentication token from the identity provider.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Facebook access token."
-    },
-    {
-      "operationCode": "LoginByGameCenter",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "PlayerId",
-              "description": "The Game Center player ID.",
-              "type": "string"
-            },
-            {
-              "code": "Name",
-              "description": "The Game Center player's display name.",
-              "type": "string"
-            },
-            {
-              "code": "PublicKeyUrl",
-              "description": "The URL to the Game Center public key.",
-              "type": "string"
-            },
-            {
-              "code": "Signature",
-              "description": "The Game Center signature string.",
-              "type": "string"
-            },
-            {
-              "code": "Salt",
-              "description": "The cryptographic salt from Game Center.",
-              "type": "string"
-            },
-            {
-              "code": "Timestamp",
-              "description": "The timestamp used for Game Center verification.",
-              "type": "number"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using Apple Game Center credentials."
-    },
-    {
-      "operationCode": "LoginByGenericService",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "ServiceName",
-              "description": "The name of the external generic service.",
-              "type": "string"
-            },
-            {
-              "code": "ServiceData",
-              "description": "The payload or authentication data from the external service.",
-              "type": "GNHashtable"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a generic external service and custom data."
-    },
-    {
-      "operationCode": "LoginByGooglePlayGameService",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Token",
-              "description": "Authentication token from the identity provider.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Google Play Games Services token."
-    },
-    {
-      "operationCode": "LoginByGoogle",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Token",
-              "description": "Authentication token from the identity provider.",
-              "type": "string"
-            },
-            {
-              "code": "Type",
-              "description": "The login method type used by Google services.",
-              "type": "number"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Google access token."
-    },
-    {
-      "operationCode": "LoginByiOSDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "iOSDeviceId",
-              "description": "The iOS device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using an iOS device ID."
-    },
-    {
-      "operationCode": "LoginByLinuxDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "LinuxDeviceId",
-              "description": "The Linux device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Linux device ID."
-    },
-    {
-      "operationCode": "LoginByMacOSDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "MacOSDeviceId",
-              "description": "The macOS device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a macOS device ID."
-    },
-    {
-      "operationCode": "LoginByWindowsDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "WindowsDeviceId",
-              "description": "The Windows device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Windows device ID."
-    },
-    {
-      "operationCode": "LoginByWindowsPhoneDeviceId",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "WindowsPhoneDeviceId",
-              "description": "The Windows Phone device identifier.",
-              "type": "string"
-            },
-            {
-              "code": "CreatePlayerIfNotExists",
-              "description": "Whether to create a new player profile if one does not exist. Defaults to false.",
-              "type": "boolean",
-              "defaultValue": "false"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Authenticate using a Windows Phone device ID."
-    },
-    {
-      "operationCode": "RefreshAuthToken",
-      "details": [],
-      "description": "Refresh the user's authentication token."
-    },
-    {
-      "operationCode": "RegisterAccount",
-      "details": [
-        {
-          "role": "Client",
-          "requestData": [
-            {
-              "code": "Username",
-              "description": "The username used for account authentication.",
-              "type": "string"
-            },
-            {
-              "code": "Password",
-              "description": "The password associated with the username.",
-              "type": "string"
-            },
-            {
-              "code": "InfoRequestParam",
-              "description": "Flags and filters that specify which additional profile fields to include in the response.",
-              "type": "InfoRequestParam"
-            }
-          ]
-        }
-      ],
-      "description": "Register a new account using a username and password."
-    }
-  ],
-  "models": [
-    {
-      "name": "InfoRequestParam",
-      "details": [
-        {
-          "code": "External",
-          "description": "Include external ID information. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "Segments",
-          "description": "Include segment membership data. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "CustomDatas",
-          "description": "Include custom data values. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "DisplayName",
-          "description": "Include the player's display name. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "Avatar",
-          "description": "Include the player's avatar data. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "TsCreate",
-          "description": "Include the account creation timestamp. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "Tags",
-          "description": "Include tag metadata associated with the player. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PlayerBan",
-          "description": "Include ban status and reasons. Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PlayerCurrencies",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PlayerStatistics",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PlayerDatas",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "IpAddressCreate",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "CountryCode",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "Email",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "TsLastLogin",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PushNotifications",
-          "description": " Defaults to false.",
-          "type": "boolean",
-          "defaultValue": "false"
-        },
-        {
-          "code": "PlayerDataKeys",
-          "description": "List of player data keys to retrieve.",
-          "type": "Array<string>"
-        },
-        {
-          "code": "PlayerCurrencyKeys",
-          "description": "List of player currency keys to retrieve.",
-          "type": "Array<string>"
-        },
-        {
-          "code": "PlayerStatisticsKeys",
-          "description": "List of player statistics keys to retrieve.",
-          "type": "Array<string>"
-        },
-        {
-          "code": "CustomDataKeys",
-          "description": "List of custom data keys to retrieve.",
-          "type": "Array<string>"
-        },
-        {
-          "code": "TagKeys",
-          "description": "List of tag keys to retrieve.",
-          "type": "Array<string>"
-        }
-      ],
-      "description": "Flags used to specify which additional fields to return in the player profile response."
-    },
-    {
-      "name": "AuthenticateResponseData",
-      "details": [
-        {
-          "code": "NewlyCreated",
-          "description": "Indicates whether the player account was newly created.",
-          "type": "boolean"
-        },
-        {
-          "code": "AuthToken",
-          "description": "The authentication token issued to the player.",
-          "type": "string"
-        },
-        {
-          "code": "PlayerBan",
-          "description": "Ban status information for the player.",
-          "type": "GenericModels.BanItem"
-        },
-        {
-          "code": "UserId",
-          "description": "The unique identifier of the authenticated user.",
-          "type": "string"
-        },
-        {
-          "code": "InfoResponseParameters",
-          "description": "Profile data returned according to InfoRequestParam filters.",
-          "type": "InfoResponseParameters"
-        }
-      ],
-      "extends": null,
-      "description": "Response data returned after a successful authentication request."
-    },
-    {
-      "name": "GenericServiceAuthenticateResponseData",
-      "details": [
-        {
-          "code": "ErrorMessage",
-          "description": "Error message returned by the external service, if any.",
-          "type": "string"
-        },
-        {
-          "code": "NewlyCreated",
-          "description": "Indicates whether the player account was newly created.",
-          "type": "boolean"
-        },
-        {
-          "code": "AuthToken",
-          "description": "The authentication token issued to the player.",
-          "type": "string"
-        },
-        {
-          "code": "PlayerBan",
-          "description": "Ban status information for the player.",
-          "type": "GenericModels.BanItem"
-        },
-        {
-          "code": "UserId",
-          "description": "The unique identifier of the authenticated user.",
-          "type": "string"
-        },
-        {
-          "code": "InfoResponseParameters",
-          "description": "Profile data returned according to InfoRequestParam filters.",
-          "type": "InfoResponseParameters"
-        }
-      ],
-      "extends": null,
-      "description": "Response data from authentication via a generic external service."
-    },
-    {
-      "name": "RefreshAuthTokenResponseData",
-      "details": [
-        {
-          "code": "AuthToken",
-          "description": "The newly issued authentication token.",
-          "type": "string"
-        },
-        {
-          "code": "PlayerBan",
-          "description": "Ban status information for the player.",
-          "type": "GenericModels.BanItem"
-        }
-      ],
-      "extends": null,
-      "description": "Response containing the refreshed authentication token."
-    },
-    {
-      "name": "EmptyResponseData",
-      "details": [],
-      "extends": null,
-      "description": "Empty response object used for operations that return no data."
-    }
-  ]
-}