@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/dist/runtime/entity/models/ContentRequestModels.d.ts

@@ -2,103 +2,255 @@ import { RequestRole } from "./../../constant/enumType/RequestRole";
 import { RequestType } from "./../../constant/enumType/RequestType";
 import { CustomOperationRequestAbstract } from "./../request/CustomOperationRequest";
 import { ContentModels } from "./ContentModels";
+/**
+ * Typed request wrappers for the Content domain.
+ *
+ * Each class extends {@link CustomOperationRequestAbstract} and
+ * binds a typed `*RequestData` DTO from {@link ContentModels} to
+ * the matching {@link OperationCode}, the
+ * {@link RequestType.Content} domain, and one of the three
+ * {@link RequestRole} variants.
+ *
+ * The wrappers cover three role flavours:
+ * - **Client** — used from player-facing application code
+ *   (`GNNetwork.content.*`).
+ * - **Server** (`Server*OperationRequest`) — used from trusted
+ *   backend code (`GNNetwork.content.server.*`); accepts
+ *   additional `userId` / `ownerId` parameters so a backend can
+ *   act on behalf of any player.
+ * - **Admin** (`Admin*OperationRequest`) — used from dashboard /
+ *   backoffice tooling (`GNNetwork.content.admin.*`).
+ *
+ * Note that Content operations stay strictly HTTP — the binary
+ * upload / download bytes are transferred through the dedicated
+ * helpers {@link GNNetwork.uploadFile} and
+ * {@link GNNetwork.getDownloadFileUrl}, not through the typed
+ * operation layer. The `*FileUploadInfo*` operations only
+ * register / inspect / revoke the metadata slot.
+ */
 export declare namespace ContentRequestModels {
+    /**
+     * Maps the CreateNewFileUploadInfo operation to a typed request wrapper.
+     */
     class CreateNewFileUploadInfoOperationRequest extends CustomOperationRequestAbstract<ContentModels.CreateNewFileUploadInfoRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new CreateNewFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.CreateNewFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerCreateNewFileUploadInfo operation to a typed request wrapper.
+     */
     class ServerCreateNewFileUploadInfoOperationRequest extends CreateNewFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerCreateNewFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerCreateNewFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminCreateNewFileUploadInfo operation to a typed request wrapper.
+     */
     class AdminCreateNewFileUploadInfoOperationRequest extends CreateNewFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminCreateNewFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminCreateNewFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the GetContentData operation to a typed request wrapper.
+     */
     class GetContentDataOperationRequest extends CustomOperationRequestAbstract<ContentModels.GetContentDataRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.GetContentDataRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerGetContentData operation to a typed request wrapper.
+     */
     class ServerGetContentDataOperationRequest extends GetContentDataOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerGetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerGetContentDataRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminGetContentData operation to a typed request wrapper.
+     */
     class AdminGetContentDataOperationRequest extends GetContentDataOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminGetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminGetContentDataRequestData, timeout: number);
     }
+    /**
+     * Maps the GetFileUploadInfoList operation to a typed request wrapper.
+     */
     class GetFileUploadInfoListOperationRequest extends CustomOperationRequestAbstract<ContentModels.GetFileUploadInfoListRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetFileUploadInfoListOperationRequest instance.
+         */
         constructor(requestData: ContentModels.GetFileUploadInfoListRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerGetFileUploadInfoList operation to a typed request wrapper.
+     */
     class ServerGetFileUploadInfoListOperationRequest extends GetFileUploadInfoListOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerGetFileUploadInfoListOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerGetFileUploadInfoListRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminGetFileUploadInfoList operation to a typed request wrapper.
+     */
     class AdminGetFileUploadInfoListOperationRequest extends GetFileUploadInfoListOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminGetFileUploadInfoListOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminGetFileUploadInfoListRequestData, timeout: number);
     }
+    /**
+     * Maps the GetFileUploadInfo operation to a typed request wrapper.
+     */
     class GetFileUploadInfoOperationRequest extends CustomOperationRequestAbstract<ContentModels.GetFileUploadInfoRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.GetFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerGetFileUploadInfo operation to a typed request wrapper.
+     */
     class ServerGetFileUploadInfoOperationRequest extends GetFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerGetFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerGetFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminGetFileUploadInfo operation to a typed request wrapper.
+     */
     class AdminGetFileUploadInfoOperationRequest extends GetFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminGetFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminGetFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the RemoveFileUploadInfo operation to a typed request wrapper.
+     */
     class RemoveFileUploadInfoOperationRequest extends CustomOperationRequestAbstract<ContentModels.RemoveFileUploadInfoRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new RemoveFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.RemoveFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerRemoveFileUploadInfo operation to a typed request wrapper.
+     */
     class ServerRemoveFileUploadInfoOperationRequest extends RemoveFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerRemoveFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerRemoveFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminRemoveFileUploadInfo operation to a typed request wrapper.
+     */
     class AdminRemoveFileUploadInfoOperationRequest extends RemoveFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminRemoveFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminRemoveFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the RequestDownloadFileUploadInfo operation to a typed request wrapper.
+     */
     class RequestDownloadFileUploadInfoOperationRequest extends CustomOperationRequestAbstract<ContentModels.RequestDownloadFileUploadInfoRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new RequestDownloadFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.RequestDownloadFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerRequestDownloadFileUploadInfo operation to a typed request wrapper.
+     */
     class ServerRequestDownloadFileUploadInfoOperationRequest extends RequestDownloadFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerRequestDownloadFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerRequestDownloadFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminRequestDownloadFileUploadInfo operation to a typed request wrapper.
+     */
     class AdminRequestDownloadFileUploadInfoOperationRequest extends RequestDownloadFileUploadInfoOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminRequestDownloadFileUploadInfoOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminRequestDownloadFileUploadInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the SetContentData operation to a typed request wrapper.
+     */
     class SetContentDataOperationRequest extends CustomOperationRequestAbstract<ContentModels.SetContentDataRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.SetContentDataRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerSetContentData operation to a typed request wrapper.
+     */
     class ServerSetContentDataOperationRequest extends SetContentDataOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerSetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.ServerSetContentDataRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminSetContentData operation to a typed request wrapper.
+     */
     class AdminSetContentDataOperationRequest extends SetContentDataOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminSetContentDataOperationRequest instance.
+         */
         constructor(requestData: ContentModels.AdminSetContentDataRequestData, timeout: number);
     }
 }

package/dist/runtime/entity/models/ContentResponseModels.d.ts

@@ -1,25 +1,83 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { ContentModels } from "./ContentModels";
+/**
+ * Typed response wrappers for the Content domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract} and
+ * binds a response DTO from {@link ContentModels}. Most file
+ * operations resolve to lightweight responses that carry just
+ * the `fileId` plus the associated upload / download token —
+ * pair them with the byte-transfer helpers
+ * {@link GNNetwork.uploadFile} and
+ * {@link GNNetwork.getDownloadFileUrl} to complete the workflow.
+ *
+ * The same wrapper classes are reused across the
+ * client / server / admin role variants because the response
+ * shape is identical regardless of which role issued the
+ * request.
+ */
 export declare namespace ContentResponseModels {
+    /**
+     * Maps the CreateNewFileUploadInfo operation to a typed response wrapper.
+     */
     class CreateNewFileUploadInfoOperationResponse extends CustomOperationResponseAbstract<ContentModels.FileIdUploadResponseData> {
+        /**
+         * Creates a new CreateNewFileUploadInfoOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetContentData operation to a typed response wrapper.
+     */
     class GetContentDataOperationResponse extends CustomOperationResponseAbstract<ContentModels.GetContentDataResponseData> {
+        /**
+         * Creates a new GetContentDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFileUploadInfoList operation to a typed response wrapper.
+     */
     class GetFileUploadInfoListOperationResponse extends CustomOperationResponseAbstract<ContentModels.GetFileUploadInfoListResponseData> {
+        /**
+         * Creates a new GetFileUploadInfoListOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFileUploadInfo operation to a typed response wrapper.
+     */
     class GetFileUploadInfoOperationResponse extends CustomOperationResponseAbstract<ContentModels.GetFileUploadInfoResponseData> {
+        /**
+         * Creates a new GetFileUploadInfoOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveFileUploadInfo operation to a typed response wrapper.
+     */
     class RemoveFileUploadInfoOperationResponse extends CustomOperationResponseAbstract<ContentModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveFileUploadInfoOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RequestDownloadFileUploadInfo operation to a typed response wrapper.
+     */
     class RequestDownloadFileUploadInfoOperationResponse extends CustomOperationResponseAbstract<ContentModels.RequestDownloadFileUploadInfoResponseData> {
+        /**
+         * Creates a new RequestDownloadFileUploadInfoOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetContentData operation to a typed response wrapper.
+     */
     class SetContentDataOperationResponse extends CustomOperationResponseAbstract<ContentModels.EmptyResponseData> {
+        /**
+         * Creates a new SetContentDataOperationResponse instance.
+         */
         constructor();
     }
 }