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

package/responseModel/chatgpt/CloudScript.json

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

package/responseModel/chatgpt/Content.json

@@ -0,0 +1,273 @@
+{
+  "requestType": "Content",
+  "description": "API requests for managing game-related content such as downloadable assets, thumbnails, and external catalog references.",
+  "operations": [
+    {
+      "operationCode": "CreateNewFileUploadInfo",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "FileName",
+              "description": "FileName used in this context.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: CreateNewFileUploadInfo"
+    },
+    {
+      "operationCode": "GetContentData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Keys",
+              "description": "Keys used in this context.",
+              "type": "Array<string>"
+            },
+            {
+              "code": "Label",
+              "description": "Label used in this context.",
+              "type": "string",
+              "defaultValue": "\"\""
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: GetContentData"
+    },
+    {
+      "operationCode": "GetFileUploadInfoList",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Skip",
+              "description": "Skip used in this context.",
+              "type": "number",
+              "defaultValue": "0"
+            },
+            {
+              "code": "Limit",
+              "description": "Limit used in this context.",
+              "type": "number",
+              "defaultValue": "10"
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: GetFileUploadInfoList"
+    },
+    {
+      "operationCode": "GetFileUploadInfo",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "FileId",
+              "description": "FileId used in this context.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: GetFileUploadInfo"
+    },
+    {
+      "operationCode": "RemoveFileUploadInfo",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "FileId",
+              "description": "FileId used in this context.",
+              "type": "string"
+            },
+            {
+              "code": "Reason",
+              "description": "Reason used in this context.",
+              "type": "string",
+              "defaultValue": "\"\""
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: RemoveFileUploadInfo"
+    },
+    {
+      "operationCode": "RequestDownloadFileUploadInfo",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "FileId",
+              "description": "FileId used in this context.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: RequestDownloadFileUploadInfo"
+    },
+    {
+      "operationCode": "SetContentData",
+      "details": [
+        {
+           "role": "Client",
+          "requestData": [
+            {
+              "code": "Configs",
+              "description": "Configs used in this context.",
+              "type": "Array<ContentDataParam>"
+            },
+            {
+              "code": "Label",
+              "description": "Label used in this context.",
+              "type": "string"
+            }
+          ]
+        }
+      ],
+      "description": "Perform operation: SetContentData"
+    }
+  ],
+  "models": [
+    {
+      "name": "ContentDataParam",
+      "details": [
+        {
+          "code": "Key",
+          "description": "Key field in ContentDataParam.",
+          "type": "string"
+        },
+        {
+          "code": "Data",
+          "description": "Data field in ContentDataParam.",
+          "type": "GNHashtable"
+        }
+      ],
+      "description": "Data model for ContentDataParam."
+    },
+    {
+      "name": "FileIdUploadResponseData",
+      "details": [
+        {
+          "code": "FileId",
+          "description": "FileId field in FileIdUploadResponseData.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for FileIdUploadResponseData."
+    },
+    {
+      "name": "GetContentDataResponseData",
+      "details": [
+        {
+          "code": "Configs",
+          "description": "Configs field in GetContentDataResponseData.",
+          "type": "Array<ContentDataParam>"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for GetContentDataResponseData."
+    },
+    {
+      "name": "GetFileUploadInfoListResponseData",
+      "details": [
+        {
+          "code": "Results",
+          "description": "Results field in GetFileUploadInfoListResponseData.",
+          "type": "Array<FileIdUploadResponseData>"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for GetFileUploadInfoListResponseData."
+    },
+    {
+      "name": "FileUploadItem",
+      "details": [
+        {
+          "code": "MimeType",
+          "description": "MimeType field in FileUploadItem.",
+          "type": "string"
+        },
+        {
+          "code": "Size",
+          "description": "Size field in FileUploadItem.",
+          "type": "number"
+        },
+        {
+          "code": "FolderFileName",
+          "description": "FolderFileName field in FileUploadItem.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for FileUploadItem."
+    },
+    {
+      "name": "GetFileUploadInfoResponseData",
+      "details": [
+        {
+          "code": "FileName",
+          "description": "FileName field in GetFileUploadInfoResponseData.",
+          "type": "string"
+        },
+        {
+          "code": "TsCreate",
+          "description": "TsCreate field in GetFileUploadInfoResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "RemoveStatus",
+          "description": "RemoveStatus field in GetFileUploadInfoResponseData.",
+          "type": "GenericModels.RemoveStatusItem"
+        },
+        {
+          "code": "TsUploadExpire",
+          "description": "TsUploadExpire field in GetFileUploadInfoResponseData.",
+          "type": "number"
+        },
+        {
+          "code": "FileUpload",
+          "description": "FileUpload field in GetFileUploadInfoResponseData.",
+          "type": "FileUploadItem"
+        },
+        {
+          "code": "FileId",
+          "description": "FileId field in GetFileUploadInfoResponseData.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for GetFileUploadInfoResponseData."
+    },
+    {
+      "name": "RequestDownloadFileUploadInfoResponseData",
+      "details": [
+        {
+          "code": "DownloadToken",
+          "description": "DownloadToken field in RequestDownloadFileUploadInfoResponseData.",
+          "type": "string"
+        }
+      ],
+      "extends": null,
+      "description": "Data model for RequestDownloadFileUploadInfoResponseData."
+    },
+    {
+      "name": "EmptyResponseData",
+      "details": [],
+      "extends": null,
+      "description": "Data model for EmptyResponseData."
+    }
+  ]
+}