@xmobitea/gn-typescript-client 2.6.8 → 2.6.9

package/responseModel/finalChatgpt/CloudScript.json

@@ -0,0 +1,515 @@
+{
+  "requestType": "CloudScript",
+  "operations": [
+    {
+      "operationCode": "AddFunction",
+      "details": [
+        {
+          "role": "Client",
+          "requestData": [
+            {
+              "code": "Script",
+              "description": "The full JavaScript or TypeScript source code of the CloudScript function.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 0,
+                "maxLength": null
+              }
+            },
+            {
+              "code": "CanExecute",
+              "description": "Indicates whether this function can be invoked by clients.",
+              "optional": false,
+              "type": "boolean",
+              "gnType": "Boolean",
+              "conditions": {}
+            },
+            {
+              "code": "IsLive",
+              "description": "Whether this function version is live and callable in production.",
+              "optional": false,
+              "type": "boolean",
+              "gnType": "Boolean",
+              "conditions": {}
+            }
+          ]
+        },
+        {
+          "role": "Server",
+          "requestData": []
+        },
+        {
+          "role": "Admin",
+          "requestData": []
+        }
+      ],
+      "responseData": [
+        {
+          "code": "ErrorCode",
+          "value": [
+            "GameNotFound",
+            "ExecuteError",
+            "Ok"
+          ]
+        },
+        {
+          "code": "ErrorMessage"
+        },
+        {
+          "code": "Version"
+        }
+      ],
+      "description": "Deploy a new CloudScript function to the server, including its code and access configuration.",
+      "operationResponse": "AddFunctionResponseData"
+    },
+    {
+      "operationCode": "EditFunction",
+      "details": [
+        {
+          "role": "Client",
+          "requestData": [
+            {
+              "code": "Version",
+              "description": "The version identifier of the CloudScript function.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 7,
+                "maxLength": 7
+              }
+            },
+            {
+              "code": "CanExecute",
+              "description": "Indicates whether this function can be invoked by clients.",
+              "optional": false,
+              "type": "boolean",
+              "gnType": "Boolean",
+              "conditions": {}
+            },
+            {
+              "code": "IsLive",
+              "description": "Whether this function version is live and callable in production.",
+              "optional": false,
+              "type": "boolean",
+              "gnType": "Boolean",
+              "conditions": {}
+            }
+          ]
+        },
+        {
+          "role": "Server",
+          "requestData": []
+        },
+        {
+          "role": "Admin",
+          "requestData": []
+        }
+      ],
+      "responseData": [
+        {
+          "code": "ErrorCode",
+          "value": [
+            "GameNotFound",
+            "Ok",
+            "ExecuteError"
+          ]
+        },
+        {
+          "code": "ErrorMessage"
+        }
+      ],
+      "description": "Modify the code or metadata of an existing CloudScript function by version.",
+      "operationResponse": "EditFunctionResponseData"
+    },
+    {
+      "operationCode": "ExecuteFunction",
+      "details": [
+        {
+          "role": "Client",
+          "requestData": [
+            {
+              "code": "UserId",
+              "description": "The unique identifier of the player for whom the function is being executed.",
+              "optional": true,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "minLength": 10,
+                "maxLength": 10
+              }
+            },
+            {
+              "code": "FunctionName",
+              "description": "The name of the function to be executed.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 3,
+                "maxLength": 30
+              }
+            },
+            {
+              "code": "FunctionParameters",
+              "description": "A JSON object containing input arguments to pass to the function.",
+              "optional": true,
+              "type": "object",
+              "gnType": "DataMember",
+              "conditions": {}
+            },
+            {
+              "code": "Version",
+              "description": "The version identifier of the CloudScript function.",
+              "optional": true,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "minLength": 7,
+                "maxLength": 7
+              }
+            }
+          ]
+        },
+        {
+          "role": "Server",
+          "requestData": [
+            {
+              "code": "UserId",
+              "description": "The unique identifier of the player for whom the function is being executed.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 10,
+                "maxLength": 10
+              }
+            }
+          ]
+        },
+        {
+          "role": "Admin",
+          "requestData": [
+            {
+              "code": "UserId",
+              "description": "The unique identifier of the player for whom the function is being executed.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 10,
+                "maxLength": 10
+              }
+            }
+          ]
+        }
+      ],
+      "responseData": [
+        {
+          "code": "ErrorCode",
+          "value": [
+            "GameNotFound",
+            "Ok",
+            "ExecuteError"
+          ]
+        },
+        {
+          "code": "FunctionLogs"
+        },
+        {
+          "code": "Status"
+        },
+        {
+          "code": "ExecutionTimeInMs"
+        },
+        {
+          "code": "MemoryUsedInBytes"
+        },
+        {
+          "code": "FunctionResult"
+        },
+        {
+          "code": "ErrorMessage"
+        }
+      ],
+      "description": "Run a deployed CloudScript function with optional input parameters.",
+      "operationResponse": "ExecuteFunctionResponseData"
+    },
+    {
+      "operationCode": "GetFunction",
+      "details": [
+        {
+          "role": "Client",
+          "requestData": [
+            {
+              "code": "Version",
+              "description": "The version identifier of the CloudScript function.",
+              "optional": false,
+              "type": "string",
+              "gnType": "String",
+              "conditions": {
+                "mustNonNull": true,
+                "minLength": 7,
+                "maxLength": 7
+              }
+            }
+          ]
+        },
+        {
+          "role": "Server",
+          "requestData": []
+        },
+        {
+          "role": "Admin",
+          "requestData": []
+        }
+      ],
+      "responseData": [
+        {
+          "code": "ErrorCode",
+          "value": [
+            "GameNotFound",
+            "Ok"
+          ]
+        },
+        {
+          "code": "Script"
+        },
+        {
+          "code": "CanExecute"
+        },
+        {
+          "code": "IsLive"
+        },
+        {
+          "code": "TsCreate"
+        }
+      ],
+      "description": "Retrieve the source code and metadata of a specific CloudScript function version.",
+      "operationResponse": "GetFunctionResponseData"
+    },
+    {
+      "operationCode": "GetFunctions",
+      "details": [
+        {
+          "role": "Server",
+          "requestData": []
+        },
+        {
+          "role": "Admin",
+          "requestData": []
+        }
+      ],
+      "responseData": [
+        {
+          "code": "ErrorCode",
+          "value": [
+            "GameNotFound",
+            "Ok"
+          ]
+        },
+        {
+          "code": "Results"
+        },
+        {
+          "code": "LatestVersion"
+        },
+        {
+          "code": "LiveLatestVersion"
+        }
+      ],
+      "description": "List all available versions of deployed CloudScript functions.",
+      "operationResponse": "GetFunctionsResponseData"
+    }
+  ],
+  "models": [
+    {
+      "name": "AddFunctionResponseData",
+      "details": [
+        {
+          "code": "Version",
+          "description": "The version assigned to the CloudScript function.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        },
+        {
+          "code": "ErrorMessage",
+          "description": "The error message if the operation failed.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        }
+      ],
+      "description": "Contains metadata about the newly deployed CloudScript function."
+    },
+    {
+      "name": "EditFunctionResponseData",
+      "details": [
+        {
+          "code": "ErrorMessage",
+          "description": "The error message if the operation failed.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        }
+      ],
+      "description": "Result of a CloudScript function code update operation."
+    },
+    {
+      "name": "ExecuteFunctionResponseData",
+      "details": [
+        {
+          "code": "Status",
+          "description": "The numeric status code returned from execution.",
+          "optional": false,
+          "type": "number",
+          "gnType": "Number",
+          "conditions": {}
+        },
+        {
+          "code": "ExecutionTimeInMs",
+          "description": "Time in milliseconds taken to execute the function.",
+          "optional": false,
+          "type": "number",
+          "gnType": "Number",
+          "conditions": {}
+        },
+        {
+          "code": "MemoryUsedInBytes",
+          "description": "Amount of memory used during function execution.",
+          "optional": false,
+          "type": "number",
+          "gnType": "Number",
+          "conditions": {}
+        },
+        {
+          "code": "FunctionResult",
+          "description": "The returned output from the executed function.",
+          "optional": false,
+          "type": "any",
+          "gnType": "DataMember",
+          "conditions": {}
+        },
+        {
+          "code": "ErrorMessage",
+          "description": "The error message if the operation failed.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        },
+        {
+          "code": "FunctionLogs",
+          "description": "A list of log messages generated during execution.",
+          "optional": false,
+          "type": "string",
+          "gnType": "GNArray",
+          "conditions": {}
+        }
+      ],
+      "description": "Result of executing a CloudScript function, including return value and metrics."
+    },
+    {
+      "name": "GetFunctionResponseData",
+      "details": [
+        {
+          "code": "Script",
+          "description": "The JavaScript or TypeScript source code of the function.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        },
+        {
+          "code": "CanExecute",
+          "description": "Whether this function version can be executed.",
+          "optional": false,
+          "type": "boolean",
+          "gnType": "Boolean",
+          "conditions": {}
+        },
+        {
+          "code": "IsLive",
+          "description": "Whether this function version is currently live.",
+          "optional": false,
+          "type": "boolean",
+          "gnType": "Boolean",
+          "conditions": {}
+        },
+        {
+          "code": "TsCreate",
+          "description": "The timestamp when the function version was created.",
+          "optional": false,
+          "type": "number",
+          "gnType": "Number",
+          "conditions": {}
+        }
+      ],
+      "description": "Details of a specific CloudScript function, including source and flags."
+    },
+    {
+      "name": "FunctionResponseData",
+      "details": [
+        {
+          "code": "Version",
+          "description": "The version assigned to the CloudScript function.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        },
+        {
+          "code": "CanExecute",
+          "description": "Whether this function version can be executed.",
+          "optional": false,
+          "type": "boolean",
+          "gnType": "Boolean",
+          "conditions": {}
+        }
+      ],
+      "description": "Metadata for a CloudScript function version."
+    },
+    {
+      "name": "GetFunctionsResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "A list of available function versions.",
+          "optional": false,
+          "type": "FunctionResponseData",
+          "gnType": "GNArray",
+          "conditions": {}
+        },
+        {
+          "code": "LatestVersion",
+          "description": "The latest version number of the function.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        },
+        {
+          "code": "LiveLatestVersion",
+          "description": "The latest version number currently marked as live.",
+          "optional": false,
+          "type": "string",
+          "gnType": "String",
+          "conditions": {}
+        }
+      ],
+      "description": "List of all versions of deployed CloudScript functions."
+    }
+  ],
+  "description": "API requests related to managing and executing server-side CloudScript functions."
+}