shcp-api-lib 1.0.2 → 1.0.5

package/dist/types/src/type/model/km-article-model.d.ts

@@ -1,4 +1,4 @@
-import { PageRequest } from './common-model';
+import { PageRequest } from "./common-model";
 /**
  * 请求文章分类树请求入参
  */
@@ -23,7 +23,7 @@ export interface ArticleCategoryDTO {
     /**
      * 分类id
      */
-    id?: number;
+    id?: number | string;
     /**
      * 分类名称
      */
@@ -116,7 +116,7 @@ export interface ArticleQuery extends PageRequest {
     /**
      * 分类ID列表
      */
-    categoryIdList?: number[];
+    categoryIdList?: (number | string)[];
     /**
      * 是否草稿 0,否;1,是
      */
@@ -133,7 +133,7 @@ export interface ArticleDTO {
     /**
      * 文章id
      */
-    id?: number;
+    id?: number | string;
     /**
      * 租户id
      */
@@ -206,7 +206,7 @@ export interface ArticleTagDTO {
     /**
      * 标签id
      */
-    id?: number;
+    id?: number | string;
     /**
      * 标签名称
      */
@@ -273,3 +273,577 @@ export interface ArticleTagQuery extends PageRequest {
      */
     articleType?: number;
 }
+/**
+ * 文章应用创建请求入参
+ */
+export interface ArticleApplyCreateRequest {
+    /**
+     * 文章id
+     */
+    articleId: number | string;
+    /**
+     * 应用类型
+     */
+    applyType?: number;
+    /**
+     * 应用id
+     */
+    applyId: number;
+    /**
+     * 应用名称
+     */
+    applyName: string;
+}
+/**
+ * 文章应用DTO
+ */
+export interface ArticleApplyDTO {
+    /**
+     * id
+     */
+    id?: number;
+    /**
+     * 租户id
+     */
+    tenantId?: string;
+    /**
+     * 文章id
+     */
+    articleId?: number | string;
+    /**
+     * 应用类型
+     */
+    applyType?: number;
+    /**
+     * 应用id
+     */
+    applyId?: number;
+    /**
+     * 应用名称
+     */
+    applyName?: string;
+}
+/**
+ * 文章标签删除请求
+ */
+export interface ArticleTagDeleteRequest {
+    /**
+     * id集合
+     */
+    ids: number[];
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章标签创建请求
+ */
+export interface ArticleTagCreateRequest {
+    /**
+     * 标签名称
+     */
+    name?: string;
+    /**
+     * 租户id
+     */
+    tenantId: string;
+    /**
+     * 标签备注
+     */
+    remark?: string;
+    /**
+     * 标签分类id
+     */
+    categoryIds?: number[];
+}
+/**
+ * 文章标签更新请求
+ */
+export interface ArticleTagUpdateRequest {
+    /**
+     * 标签id
+     */
+    id: number | string;
+    /**
+     * 前端可以忽略该参数，租户id
+     */
+    tenantId?: string;
+    /**
+     * 标签名称
+     */
+    name?: string;
+    /**
+     * 分类id
+     */
+    categoryIds?: number[];
+}
+/**
+ * 文章分类创建请求
+ */
+export interface ArticleCategoryCreateRequest {
+    /**
+     * 租户id
+     */
+    tenantId: string;
+    /**
+     * 分类的类型
+     */
+    type?: number;
+    /**
+     * 父分类id
+     */
+    parentId: number | string;
+    /**
+     * 分类名称
+     */
+    name?: string;
+    /**
+     * 分类备注
+     */
+    remark?: string;
+    /**
+     * 排序
+     */
+    sort?: number;
+}
+/**
+ * 文章分类删除请求
+ */
+export interface ArticleCategoryDeleteRequest {
+    /**
+     * id列表
+     */
+    ids: (number | string)[];
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+    /**
+     * 是否移动至待分类-true.是(默认值)，false.否
+     */
+    isMoveUnCategory?: boolean;
+}
+/**
+ * 文章分类重命名请求
+ */
+export interface ArticleCategoryRenameRequest {
+    /**
+     * id
+     */
+    id: number | string;
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章分类移动请求
+ */
+export interface ArticleCategoryMoveRequest {
+    /**
+     * 源分类id
+     */
+    sourceCategoryId: number | string;
+    /**
+     * 目标分类id
+     */
+    targetCategoryId: number | string;
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章分类批量更新请求入参
+ */
+export interface ArticleCategoryBashUpdateRequest {
+    /**
+     * 文章分类
+     */
+    articleCategoryDTOList: ArticleCategoryDTO[];
+}
+/**
+ * 文章草稿创建请求
+ */
+export interface ArticleDraftCreateRequest {
+    /**
+     * 文章id
+     */
+    articleId?: number | string;
+    /**
+     * 租户id
+     */
+    tenantId: string;
+    /**
+     * 标题
+     */
+    title?: string;
+    /**
+     * 副标题
+     */
+    subTitle?: string;
+    /**
+     * 摘要
+     */
+    remark?: string;
+    /**
+     * 封面
+     */
+    cover?: string;
+    /**
+     * 文章类型
+     */
+    type?: number;
+    /**
+     * 文章内容
+     */
+    content?: string;
+}
+/**
+ * 文章草稿DTO
+ */
+export interface ArticleDraftDTO {
+    /**
+     * 文章草稿id
+     */
+    id?: number | string;
+    /**
+     * 文章标题
+     */
+    title?: string;
+    /**
+     * 文章副标题
+     */
+    subTitle?: string;
+    /**
+     * 文章内容
+     */
+    content?: string;
+    /**
+     * 文章摘要
+     */
+    remark?: string;
+    /**
+     * 文章封面图片URL
+     */
+    cover?: string;
+    /**
+     * 文章状态
+     */
+    status?: number;
+    /**
+     * 文章浏览量
+     */
+    viewCount?: number;
+    /**
+     * 文章引用量
+     */
+    referenceCount?: number;
+    /**
+     * 文章类型
+     */
+    type?: number;
+    /**
+     * 创建人
+     */
+    createUser: number | string;
+    /**
+     * 创建时间
+     */
+    createTime?: string;
+    /**
+     * 文章标签
+     */
+    tags?: ArticleTagDTO[];
+    /**
+     * 关联分类
+     */
+    categoryList?: ArticleCategoryDTO[];
+}
+/**
+ * 文章草稿查询入参
+ */
+export interface ArticleDraftQuery {
+    /**
+     * 文章草稿id
+     */
+    id?: number | string;
+    /**
+     * 文章草稿id集合
+     */
+    idList?: (number | string)[];
+    /**
+     * 租户id
+     */
+    tenantId?: string;
+    /**
+     * 文章id
+     */
+    articleId?: number | string;
+    /**
+     * 文章id集合
+     */
+    articleIdList?: (number | string)[];
+    /**
+     * 标题-模糊查询
+     */
+    title?: string;
+    /**
+     * 标题-等值查询
+     */
+    titleExact?: string;
+}
+/**
+ * 文章草稿提交请求
+ */
+export interface ArticleDraftSubmitRequest {
+    /**
+     * 草稿id列表
+     */
+    articleDraftIdList: (number | string)[];
+    /**
+     * 前端可以忽略租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章草稿更新请求
+ */
+export interface ArticleDraftUpdateRequest {
+    /**
+     * 草稿id
+     */
+    id: number | string;
+    /**
+     * 前端忽略，租户id
+     */
+    tenantId?: string;
+    /**
+     * 文章id
+     */
+    articleId?: number | string;
+    /**
+     * 文章标题
+     */
+    title?: string;
+    /**
+     * 副标题
+     */
+    subTitle?: string;
+    /**
+     * 作者ID
+     */
+    authorId?: number | string;
+    /**
+     * 作者名称
+     */
+    authorName?: string;
+    /**
+     * 摘要
+     */
+    remark?: string;
+    /**
+     * 封面
+     */
+    cover?: string;
+    /**
+     * 文章内容类型
+     */
+    type?: number;
+    /**
+     * 文章内容
+     */
+    content?: string;
+    /**
+     * 标签id集合
+     */
+    articleTagIdList?: (number | string)[];
+    /**
+     * 修改人id
+     */
+    userId?: number | string;
+    /**
+     * 分类id集合
+     */
+    articleCategoryIdList?: (number | string)[];
+}
+/**
+ * 文章删除请求
+ */
+export interface ArticleDeleteRequest {
+    /**
+     * 文章id集合
+     */
+    idList: (number | string)[];
+    /**
+     * 前端忽略此参数，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章复制请求
+ */
+export interface ArticleCopyRequest {
+    /**
+     * 模版租户ID
+     */
+    templateTenantId: string;
+    /**
+     * 新租户ID
+     */
+    newTenantId: string;
+    /**
+     * 复制的文章ID
+     */
+    articleIds?: (number | string)[];
+}
+/**
+ * 文章创建请求
+ */
+export interface ArticleCreateRequest {
+    /**
+     * 租户id
+     */
+    tenantId: string;
+    /**
+     * 标题
+     */
+    title: string;
+    /**
+     * 副标题
+     */
+    subTitle?: string;
+    /**
+     * 作者id
+     */
+    authorId?: number | string;
+    /**
+     * 作者名称
+     */
+    authorName?: string;
+    /**
+     * 摘要
+     */
+    remark?: string;
+    /**
+     * 封面
+     */
+    cover?: string;
+    /**
+     * 文章类型
+     */
+    type: number;
+    /**
+     * 文章可见性
+     */
+    visibility?: string;
+    /**
+     * 文章内容
+     */
+    content: string;
+    /**
+     * 分类名称
+     */
+    categoryName?: string;
+    /**
+     * 分类id集合
+     */
+    categoryIdList?: (number | string)[];
+}
+/**
+ * 文章复制响应
+ */
+export interface ArticleCopyResponse {
+    /**
+     * 文章映射id
+     */
+    articleIdMapping?: Record<string, number | string>;
+}
+/**
+ * 文章归档请求
+ */
+export interface ArticleArchiveRequest {
+    /**
+     * 文章id集合
+     */
+    articleIdList: (number | string)[];
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章发布请求
+ */
+export interface ArticlePublishRequest {
+    /**
+     * 文章id集合
+     */
+    articleIdList: (number | string)[];
+    /**
+     * 前端无需理会，租户id
+     */
+    tenantId?: string;
+}
+/**
+ * 文章更新请求
+ */
+export interface ArticleUpdateRequest {
+    /**
+     * 文章id
+     */
+    id?: number | string;
+    /**
+     * 租户id
+     */
+    tenantId?: string;
+    /**
+     * 文章标题
+     */
+    title?: string;
+    /**
+     * 文章副标题
+     */
+    subTitle?: string;
+    /**
+     * 作者id
+     */
+    authorId?: number | string;
+    /**
+     * 作者名称
+     */
+    authorName?: string;
+    /**
+     * 文章摘要
+     */
+    remark?: string;
+    /**
+     * 文章封面图片URL
+     */
+    cover?: string;
+    /**
+     * 文章类型
+     */
+    type?: number;
+    /**
+     * 文章可见性
+     */
+    visibility?: string;
+    /**
+     * 文章内容
+     */
+    content?: string;
+    /**
+     * 分类名称
+     */
+    categoryName?: string;
+    /**
+     * 分类id集合
+     */
+    categoryIdList?: (number | string)[];
+}