@xmobitea/gn-typescript-client 2.6.13-tsc → 2.6.14

package/docs/reference/dto/CONTENT.md

@@ -0,0 +1,548 @@
+# DTO Reference: Content
+
+Content data key-value, file upload info, download token.
+
+Related API reference: [API_CONTENT.md](../API_CONTENT.md).
+
+Mỗi section bên dưới là 1 class DTO trong namespace `<Models>`. Field table cho biết: tên field, TS type, có `required` hay không (suy từ decorator `mustNonNull` / `isOptional` / dấu `?` trong declaration), doc comment, và ràng buộc length/range/default nếu có.
+
+> **Cách dùng**: khi gọi `*Async()`, bạn truyền object literal matching các field required (+ optional nếu cần). SDK sẽ serialize field dựa trên decorator `@<Type>DataMember({ code })`. Response class expose `responseData` là instance của class `*ResponseData` tương ứng, đọc theo field name dưới đây.
+
+## Danh sách
+
+- **ContentModels** (from `ContentModels.ts`)
+  - [ContentDataParam](#contentdataparam)
+  - [CreateNewFileUploadInfoRequestData](#createnewfileuploadinforequestdata)
+  - [ServerCreateNewFileUploadInfoRequestData](#servercreatenewfileuploadinforequestdata)
+  - [AdminCreateNewFileUploadInfoRequestData](#admincreatenewfileuploadinforequestdata)
+  - [GetContentDataRequestData](#getcontentdatarequestdata)
+  - [ServerGetContentDataRequestData](#servergetcontentdatarequestdata)
+  - [AdminGetContentDataRequestData](#admingetcontentdatarequestdata)
+  - [GetFileUploadInfoListRequestData](#getfileuploadinfolistrequestdata)
+  - [ServerGetFileUploadInfoListRequestData](#servergetfileuploadinfolistrequestdata)
+  - [AdminGetFileUploadInfoListRequestData](#admingetfileuploadinfolistrequestdata)
+  - [GetFileUploadInfoRequestData](#getfileuploadinforequestdata)
+  - [ServerGetFileUploadInfoRequestData](#servergetfileuploadinforequestdata)
+  - [AdminGetFileUploadInfoRequestData](#admingetfileuploadinforequestdata)
+  - [RemoveFileUploadInfoRequestData](#removefileuploadinforequestdata)
+  - [ServerRemoveFileUploadInfoRequestData](#serverremovefileuploadinforequestdata)
+  - [AdminRemoveFileUploadInfoRequestData](#adminremovefileuploadinforequestdata)
+  - [RequestDownloadFileUploadInfoRequestData](#requestdownloadfileuploadinforequestdata)
+  - [ServerRequestDownloadFileUploadInfoRequestData](#serverrequestdownloadfileuploadinforequestdata)
+  - [AdminRequestDownloadFileUploadInfoRequestData](#adminrequestdownloadfileuploadinforequestdata)
+  - [SetContentDataRequestData](#setcontentdatarequestdata)
+  - [ServerSetContentDataRequestData](#serversetcontentdatarequestdata)
+  - [AdminSetContentDataRequestData](#adminsetcontentdatarequestdata)
+  - [FileIdUploadResponseData](#fileiduploadresponsedata)
+  - [GetContentDataResponseData](#getcontentdataresponsedata)
+  - [GetFileUploadInfoListResponseData](#getfileuploadinfolistresponsedata)
+  - [FileUploadItem](#fileuploaditem)
+  - [GetFileUploadInfoResponseData](#getfileuploadinforesponsedata)
+  - [RequestDownloadFileUploadInfoResponseData](#requestdownloadfileuploadinforesponsedata)
+  - [EmptyResponseData](#emptyresponsedata)
+- **ContentRequestModels** (from `ContentRequestModels.ts`)
+  - [CreateNewFileUploadInfoOperationRequest](#createnewfileuploadinfooperationrequest)
+  - [ServerCreateNewFileUploadInfoOperationRequest](#servercreatenewfileuploadinfooperationrequest)
+  - [AdminCreateNewFileUploadInfoOperationRequest](#admincreatenewfileuploadinfooperationrequest)
+  - [GetContentDataOperationRequest](#getcontentdataoperationrequest)
+  - [ServerGetContentDataOperationRequest](#servergetcontentdataoperationrequest)
+  - [AdminGetContentDataOperationRequest](#admingetcontentdataoperationrequest)
+  - [GetFileUploadInfoListOperationRequest](#getfileuploadinfolistoperationrequest)
+  - [ServerGetFileUploadInfoListOperationRequest](#servergetfileuploadinfolistoperationrequest)
+  - [AdminGetFileUploadInfoListOperationRequest](#admingetfileuploadinfolistoperationrequest)
+  - [GetFileUploadInfoOperationRequest](#getfileuploadinfooperationrequest)
+  - [ServerGetFileUploadInfoOperationRequest](#servergetfileuploadinfooperationrequest)
+  - [AdminGetFileUploadInfoOperationRequest](#admingetfileuploadinfooperationrequest)
+  - [RemoveFileUploadInfoOperationRequest](#removefileuploadinfooperationrequest)
+  - [ServerRemoveFileUploadInfoOperationRequest](#serverremovefileuploadinfooperationrequest)
+  - [AdminRemoveFileUploadInfoOperationRequest](#adminremovefileuploadinfooperationrequest)
+  - [RequestDownloadFileUploadInfoOperationRequest](#requestdownloadfileuploadinfooperationrequest)
+  - [ServerRequestDownloadFileUploadInfoOperationRequest](#serverrequestdownloadfileuploadinfooperationrequest)
+  - [AdminRequestDownloadFileUploadInfoOperationRequest](#adminrequestdownloadfileuploadinfooperationrequest)
+  - [SetContentDataOperationRequest](#setcontentdataoperationrequest)
+  - [ServerSetContentDataOperationRequest](#serversetcontentdataoperationrequest)
+  - [AdminSetContentDataOperationRequest](#adminsetcontentdataoperationrequest)
+- **ContentResponseModels** (from `ContentResponseModels.ts`)
+  - [CreateNewFileUploadInfoOperationResponse](#createnewfileuploadinfooperationresponse)
+  - [GetContentDataOperationResponse](#getcontentdataoperationresponse)
+  - [GetFileUploadInfoListOperationResponse](#getfileuploadinfolistoperationresponse)
+  - [GetFileUploadInfoOperationResponse](#getfileuploadinfooperationresponse)
+  - [RemoveFileUploadInfoOperationResponse](#removefileuploadinfooperationresponse)
+  - [RequestDownloadFileUploadInfoOperationResponse](#requestdownloadfileuploadinfooperationresponse)
+  - [SetContentDataOperationResponse](#setcontentdataoperationresponse)
+
+---
+
+## Namespace `ContentModels`
+
+### ContentDataParam
+
+Defines the reusable parameter block ContentDataParam.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `key` | `string` | yes | _minLength=2, maxLength=32_ |
+| `data` | `GNHashtable` | yes | — |
+
+### CreateNewFileUploadInfoRequestData
+
+Allocates a new upload slot before the binary payload is uploaded through the separate upload helper.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileName` | `string` | yes | _minLength=5, maxLength=50_ |
+
+### ServerCreateNewFileUploadInfoRequestData
+
+Extends: `CreateNewFileUploadInfoRequestData`
+
+Defines the request payload for ServerCreateNewFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminCreateNewFileUploadInfoRequestData
+
+Extends: `ServerCreateNewFileUploadInfoRequestData`
+
+Defines the request payload for AdminCreateNewFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### GetContentDataRequestData
+
+Reads content configuration blobs, optionally filtered by key list and label.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `keys` | `Array<string>` | no | _elementCls=String_ |
+| `label` | `string` | no | _minLength=2, maxLength=32, default=""_ |
+
+### ServerGetContentDataRequestData
+
+Extends: `GetContentDataRequestData`
+
+Defines the request payload for ServerGetContentData.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetContentDataRequestData
+
+Extends: `ServerGetContentDataRequestData`
+
+Defines the request payload for AdminGetContentData.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoListRequestData
+
+Defines the request payload for GetFileUploadInfoList.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `skip` | `number` | no | _min=0, default=0_ |
+| `limit` | `number` | no | _min=1, max=100, default=10_ |
+
+### ServerGetFileUploadInfoListRequestData
+
+Extends: `GetFileUploadInfoListRequestData`
+
+Defines the request payload for ServerGetFileUploadInfoList.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetFileUploadInfoListRequestData
+
+Extends: `ServerGetFileUploadInfoListRequestData`
+
+Defines the request payload for AdminGetFileUploadInfoList.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoRequestData
+
+Defines the request payload for GetFileUploadInfo.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileId` | `string` | yes | _minLength=15, maxLength=15_ |
+
+### ServerGetFileUploadInfoRequestData
+
+Extends: `GetFileUploadInfoRequestData`
+
+Defines the request payload for ServerGetFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetFileUploadInfoRequestData
+
+Extends: `ServerGetFileUploadInfoRequestData`
+
+Defines the request payload for AdminGetFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### RemoveFileUploadInfoRequestData
+
+Defines the request payload for RemoveFileUploadInfo.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileId` | `string` | yes | _minLength=15, maxLength=15_ |
+| `reason` | `string` | no | _default=""_ |
+
+### ServerRemoveFileUploadInfoRequestData
+
+Extends: `RemoveFileUploadInfoRequestData`
+
+Defines the request payload for ServerRemoveFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminRemoveFileUploadInfoRequestData
+
+Extends: `ServerRemoveFileUploadInfoRequestData`
+
+Defines the request payload for AdminRemoveFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### RequestDownloadFileUploadInfoRequestData
+
+Requests a short-lived download token for an existing uploaded file.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileId` | `string` | yes | _minLength=15, maxLength=15_ |
+
+### ServerRequestDownloadFileUploadInfoRequestData
+
+Extends: `RequestDownloadFileUploadInfoRequestData`
+
+Defines the request payload for ServerRequestDownloadFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminRequestDownloadFileUploadInfoRequestData
+
+Extends: `ServerRequestDownloadFileUploadInfoRequestData`
+
+Defines the request payload for AdminRequestDownloadFileUploadInfo.
+
+_Không có field public (payload rỗng)._ 
+
+### SetContentDataRequestData
+
+Defines the request payload for SetContentData.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `configs` | `Array<ContentDataParam>` | yes | _elementCls=ContentDataParam_ |
+| `label` | `string` | no | _minLength=2, maxLength=32_ |
+
+### ServerSetContentDataRequestData
+
+Extends: `SetContentDataRequestData`
+
+Defines the request payload for ServerSetContentData.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminSetContentDataRequestData
+
+Extends: `ServerSetContentDataRequestData`
+
+Defines the request payload for AdminSetContentData.
+
+_Không có field public (payload rỗng)._ 
+
+### FileIdUploadResponseData
+
+Returns the backend-generated file ID for follow-up upload or download workflows.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileId` | `string` | yes | — |
+
+### GetContentDataResponseData
+
+Defines the response payload for GetContentData.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `configs` | `Array<ContentDataParam>` | yes | _elementCls=ContentDataParam_ |
+
+### GetFileUploadInfoListResponseData
+
+Defines the response payload for GetFileUploadInfoList.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `results` | `Array<FileIdUploadResponseData>` | yes | _elementCls=FileIdUploadResponseData_ |
+
+### FileUploadItem
+
+Describes upload metadata stored for one file entry.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `mimeType` | `string` | yes | — |
+| `size` | `number` | yes | — |
+| `folderFileName` | `string` | yes | — |
+
+### GetFileUploadInfoResponseData
+
+Extends: `FileIdUploadResponseData`
+
+Returns metadata for one uploaded file entry.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `fileName` | `string` | yes | — |
+| `tsCreate` | `number` | yes | — |
+| `removeStatus` | `GenericModels.RemoveStatusItem` | yes | — |
+| `tsUploadExpire` | `number` | no | Upload-expiration timestamp for unfinished uploads when present. |
+| `fileUpload` | `FileUploadItem` | no | — |
+
+### RequestDownloadFileUploadInfoResponseData
+
+Returns the download token consumed by the SDK download helper.
+
+| Field | Type | Required | Notes |
+|-------|------|----------|-------|
+| `downloadToken` | `string` | yes | — |
+
+### EmptyResponseData
+
+Defines an intentionally empty response payload.
+
+_Không có field public (payload rỗng)._ 
+
+## Namespace `ContentRequestModels`
+
+### CreateNewFileUploadInfoOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.CreateNewFileUploadInfoRequestData>`
+
+Maps the CreateNewFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerCreateNewFileUploadInfoOperationRequest
+
+Extends: `CreateNewFileUploadInfoOperationRequest`
+
+Maps the ServerCreateNewFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminCreateNewFileUploadInfoOperationRequest
+
+Extends: `CreateNewFileUploadInfoOperationRequest`
+
+Maps the AdminCreateNewFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetContentDataOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.GetContentDataRequestData>`
+
+Maps the GetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerGetContentDataOperationRequest
+
+Extends: `GetContentDataOperationRequest`
+
+Maps the ServerGetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetContentDataOperationRequest
+
+Extends: `GetContentDataOperationRequest`
+
+Maps the AdminGetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoListOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.GetFileUploadInfoListRequestData>`
+
+Maps the GetFileUploadInfoList operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerGetFileUploadInfoListOperationRequest
+
+Extends: `GetFileUploadInfoListOperationRequest`
+
+Maps the ServerGetFileUploadInfoList operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetFileUploadInfoListOperationRequest
+
+Extends: `GetFileUploadInfoListOperationRequest`
+
+Maps the AdminGetFileUploadInfoList operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.GetFileUploadInfoRequestData>`
+
+Maps the GetFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerGetFileUploadInfoOperationRequest
+
+Extends: `GetFileUploadInfoOperationRequest`
+
+Maps the ServerGetFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminGetFileUploadInfoOperationRequest
+
+Extends: `GetFileUploadInfoOperationRequest`
+
+Maps the AdminGetFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### RemoveFileUploadInfoOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.RemoveFileUploadInfoRequestData>`
+
+Maps the RemoveFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerRemoveFileUploadInfoOperationRequest
+
+Extends: `RemoveFileUploadInfoOperationRequest`
+
+Maps the ServerRemoveFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminRemoveFileUploadInfoOperationRequest
+
+Extends: `RemoveFileUploadInfoOperationRequest`
+
+Maps the AdminRemoveFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### RequestDownloadFileUploadInfoOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.RequestDownloadFileUploadInfoRequestData>`
+
+Maps the RequestDownloadFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerRequestDownloadFileUploadInfoOperationRequest
+
+Extends: `RequestDownloadFileUploadInfoOperationRequest`
+
+Maps the ServerRequestDownloadFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminRequestDownloadFileUploadInfoOperationRequest
+
+Extends: `RequestDownloadFileUploadInfoOperationRequest`
+
+Maps the AdminRequestDownloadFileUploadInfo operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### SetContentDataOperationRequest
+
+Extends: `CustomOperationRequestAbstract<ContentModels.SetContentDataRequestData>`
+
+Maps the SetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### ServerSetContentDataOperationRequest
+
+Extends: `SetContentDataOperationRequest`
+
+Maps the ServerSetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### AdminSetContentDataOperationRequest
+
+Extends: `SetContentDataOperationRequest`
+
+Maps the AdminSetContentData operation to a typed request wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+## Namespace `ContentResponseModels`
+
+### CreateNewFileUploadInfoOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.FileIdUploadResponseData>`
+
+Maps the CreateNewFileUploadInfo operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetContentDataOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.GetContentDataResponseData>`
+
+Maps the GetContentData operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoListOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.GetFileUploadInfoListResponseData>`
+
+Maps the GetFileUploadInfoList operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### GetFileUploadInfoOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.GetFileUploadInfoResponseData>`
+
+Maps the GetFileUploadInfo operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### RemoveFileUploadInfoOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.EmptyResponseData>`
+
+Maps the RemoveFileUploadInfo operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### RequestDownloadFileUploadInfoOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.RequestDownloadFileUploadInfoResponseData>`
+
+Maps the RequestDownloadFileUploadInfo operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+
+### SetContentDataOperationResponse
+
+Extends: `CustomOperationResponseAbstract<ContentModels.EmptyResponseData>`
+
+Maps the SetContentData operation to a typed response wrapper.
+
+_Không có field public (payload rỗng)._ 
+