tencentcloud-sdk-nodejs-essbasic 4.0.652 → 4.0.654

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -136,8 +136,18 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelDeleteRoleUsers", req, cb);
     }
     /**
-     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
-     */
+       * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
+  
+  > **适用场景**
+  >
+  >  该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
+  >  一个模板通常会包含以下结构信息
+  >- 模板基本信息
+  >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+  >- 填写控件 Components
+  >- 签署控件 SignComponents
+  >- 生成模板的文件基础信息 FileInfos
+       */
     async DescribeTemplates(req, cb) {
         return this.request("DescribeTemplates", req, cb);
     }
@@ -198,7 +208,10 @@ class Client extends TencentCloudCommon.AbstractClient {
        * 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
   客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
   接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
-  可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。
+  
+  可以撤回：未全部签署完成
+   不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+  
   注意:
   能撤回合同的只能是合同的发起人或者发起企业的超管、法人
        */
@@ -206,8 +219,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
     }
     /**
-     * 通过发起转换任务接口（ChannelCreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
-     */
+       * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。
+  注意：大文件转换所需的时间可能会比较长。
+       */
     async ChannelGetTaskResultApi(req, cb) {
         return this.request("ChannelGetTaskResultApi", req, cb);
     }
@@ -269,6 +283,9 @@ class Client extends TencentCloudCommon.AbstractClient {
        * 指定需要批量撤销的签署流程Id，批量撤销合同
   客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
   
+  可以撤回：未全部签署完成
+   不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+  
   **满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
   
   **合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -51,8 +51,7 @@ export interface Component {
   
   注：
   当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。
-  例：
-  当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
+  例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
   如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。
   
   创建控件时，此值为空
@@ -84,15 +83,16 @@ export interface Component {
      */
     ComponentType?: string;
     /**
-     * 控件简称，不能超过30个字符
+     * 控件简称，不超过30个字符
      */
     ComponentName?: string;
     /**
-     * 定义控件是否为必填项，默认为false
+     * 控件是否为必填项，
+  默认为false-非必填
      */
     ComponentRequired?: boolean;
     /**
-     * 控件关联的签署方id
+     * 控件关联的参与方ID，对应Recipient结构体中的RecipientId
      */
     ComponentRecipientId?: string;
     /**
@@ -253,11 +253,11 @@ export interface Component {
      */
     ComponentDateFontSize?: number;
     /**
-     * 控件所属文档的Id, 模块相关接口为空值
+     * 控件所属文档的Id, 模板相关接口为空值
      */
     DocumentId?: string;
     /**
-     * 控件描述，不能超过30个字符
+     * 控件描述，不超过30个字符
      */
     ComponentDescription?: string;
     /**
@@ -274,20 +274,31 @@ export interface Component {
      */
     ChannelComponentId?: string;
     /**
-     * 指定关键字排序规则，Positive-正序，Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
+     * 指定关键字排序规则，
+  Positive-正序，
+  Reverse-倒序。
+  传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
   传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
      */
     KeywordOrder?: string;
     /**
-     * 指定关键字页码，可选参数，指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
+     * 指定关键字页码。
+  指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
      */
     KeywordPage?: number;
     /**
-     * 关键字位置模式，Middle-居中，Below-正下方，Right-正右方，LowerRight-右上角，UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
+     * 关键字位置模式，
+  Middle-居中，
+  Below-正下方，
+  Right-正右方，
+  LowerRight-右上角，
+  UpperRight-右下角。
+  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
      */
     RelativeLocation?: string;
     /**
-     * 关键字索引，可选参数，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
+     * 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。
+  示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
      */
     KeywordIndexes?: Array<number>;
     /**
@@ -416,7 +427,7 @@ export interface ChannelCreateFlowSignReviewRequest {
   注：接口通过该字段区分操作类型
   该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程
   若想使用发起审核，请指定该字段为：CreateReview
-  若发起个人审核，则指定该字段为：SignReview（注意，给个人审核时，需联系客户经理开白使用）
+  若发起个人审核，则指定该字段为：SignReview
      */
     OperateType?: string;
 }
@@ -443,7 +454,7 @@ export interface DescribeFlowDetailInfoRequest {
     Agent: Agent;
     /**
      * 合同(流程)编号数组，最多支持100个。
-  （备注：该参数和合同组编号必须二选一）
+  （备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参）
      */
     FlowIds?: Array<string>;
     /**
@@ -575,12 +586,17 @@ export interface OperateChannelTemplateResponse {
      */
     TemplateId?: string;
     /**
-     * 描述模板可见性更改的结果，和参数中Available无关，全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
+     * 描述模板可见性更改的结果，和参数中Available无关。
+  全部成功-"all-success",
+  部分成功-"part-success",
+  全部失败-"fail"，失败的会在FailMessageList中展示。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     OperateResult?: string;
     /**
-     * 模板可见性, 全部可见-"all", 部分可见-"part"
+     * 模板可见性,
+  全部可见-"all",
+  部分可见-"part"
   注意：此字段可能返回 null，表示取不到有效值。
      */
     AuthTag?: string;
@@ -691,6 +707,7 @@ export interface BaseFlowInfo {
     FlowName: string;
     /**
      * 合同流程类型
+  <br/>客户自定义，用于合同分类展示
      */
     FlowType: string;
     /**
@@ -703,6 +720,7 @@ export interface BaseFlowInfo {
     Deadline: number;
     /**
      * 是否顺序签署(true:无序签,false:顺序签)
+  <br/>默认false，有序签署合同
      */
     Unordered?: boolean;
     /**
@@ -714,7 +732,10 @@ export interface BaseFlowInfo {
      */
     FormFields?: Array<FormField>;
     /**
-     * 本企业(发起方企业)是否需要签署审批，true：开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
+     * 本企业(发起方企业)是否需要签署审批
+  <br/>true：开启发起方签署审批
+  <br/>false：不开启发起方签署审批
+  <br/>开启后，使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
      */
     NeedSignReview?: boolean;
     /**
@@ -726,7 +747,10 @@ export interface BaseFlowInfo {
      */
     CcInfos?: Array<CcInfo>;
     /**
-     * 是否需要发起前审核，当指定NeedCreateReview=true，则发起后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
+     * 是否需要开启发起方发起前审核
+  <br/>true：开启发起方发起前审核
+  <br/>false：不开启发起方发起前审核
+  <br/>当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
      */
     NeedCreateReview?: boolean;
 }
@@ -908,10 +932,6 @@ export interface ChannelCreatePrepareFlowRequest {
      * 合同流程基础信息
      */
     FlowInfo: BaseFlowInfo;
-    /**
-     * 合同签署人信息
-     */
-    FlowApproverList: Array<CommonFlowApprover>;
     /**
      * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
      */
@@ -920,6 +940,10 @@ export interface ChannelCreatePrepareFlowRequest {
      * 合同流程配置信息，用于配置发起合同时定制化
      */
     FlowOption?: CreateFlowOption;
+    /**
+     * 合同签署人信息
+     */
+    FlowApproverList?: Array<CommonFlowApprover>;
     /**
      * 通过flowid快速获得之前成功通过页面发起的合同生成链接
      */
@@ -1393,36 +1417,44 @@ export interface PrepareFlowsResponse {
 }
 /**
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
+
+> **模板组成**
+>
+>  一个模板通常会包含以下结构信息
+>- 模板基本信息
+>- 签署参与方 Recipients，在模板发起合同时用于指定参与方
+>- 填写控件 Components
+>- 签署控件 SignComponents
  */
 export interface TemplateInfo {
     /**
-     * 模板ID
+     * 模板ID，模板的唯一标识
      */
-    TemplateId: string;
+    TemplateId?: string;
     /**
-     * 模板名字
+     * 模板名
      */
-    TemplateName: string;
+    TemplateName?: string;
     /**
      * 模板描述信息
      */
-    Description: string;
+    Description?: string;
     /**
-     * 模板的填充控件信息结构
+     * 模板的填充控件列表
      */
-    Components: Array<Component>;
+    Components?: Array<Component>;
     /**
-     * 模板中的流程参与人信息
+     * 模板中的签署参与方列表
      */
-    Recipients: Array<Recipient>;
+    Recipients?: Array<Recipient>;
     /**
-     * 模板中的签署控件信息结构
+     * 模板中的签署控件列表
      */
-    SignComponents: Array<Component>;
+    SignComponents?: Array<Component>;
     /**
      * 模板类型：1-静默签；3-普通模板
      */
-    TemplateType: number;
+    TemplateType?: number;
     /**
      * 是否是发起人 ,已弃用
      * @deprecated
@@ -1431,42 +1463,50 @@ export interface TemplateInfo {
     /**
      * 模板的创建者信息，电子签系统用户ID
      */
-    Creator: string;
+    Creator?: string;
     /**
-     * 模板创建的时间戳，单位秒
+     * 模板创建的时间戳，格式为Unix标准时间戳（秒）
      */
-    CreatedOn: number;
+    CreatedOn?: number;
     /**
-     * 模板的H5预览链接,可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回，有效期5分钟。
+     * 模板的H5预览链接,有效期5分钟。
+  可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+  （此功能开放需要联系客户经理）
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    PreviewUrl: string;
+    PreviewUrl?: string;
     /**
-     * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理），有效期5分钟。
+     * 第三方应用集成-模板PDF文件链接，有效期5分钟。
+  请求参数WithPdfUrl=true时返回
+  （此功能开放需要联系客户经理）。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    PdfUrl: string;
+    PdfUrl?: string;
     /**
-     * 关联的第三方应用平台企业模板ID
+     * 本模板关联的第三方应用平台企业模板ID
      */
-    ChannelTemplateId: string;
+    ChannelTemplateId?: string;
     /**
-     * 关联的三方应用平台平台企业模板名称
+     * 本模板关联的三方应用平台平台企业模板名称
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ChannelTemplateName: string;
+    ChannelTemplateName?: string;
     /**
-     * 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
+     * 0-需要子客企业手动领取平台企业的模板(默认);
+  1-平台自动设置子客模板
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    ChannelAutoSave: number;
+    ChannelAutoSave?: number;
     /**
-     * 模板版本，全数字字符。默认为空，初始版本为yyyyMMdd001。
+     * 模板版本，全数字字符。
+  默认为空，初始版本为yyyyMMdd001。
   注意：此字段可能返回 null，表示取不到有效值。
      */
-    TemplateVersion: string;
+    TemplateVersion?: string;
     /**
-     * 模板可用状态，取值：1启用（默认），2停用
+     * 模板可用状态：
+  1启用（默认）
+  2停用
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Available?: number;
@@ -1511,35 +1551,42 @@ export interface Agent {
     ProxyOrganizationId?: string;
 }
 /**
- * 签署参与者信息
+ * 流程中参与方的信息结构
  */
 export interface Recipient {
     /**
-     * 签署人唯一标识，在通过模板发起合同的时候对应签署方Id
+     * 签署人唯一标识，在通过模板发起合同的时候对应签署方ID
      */
     RecipientId?: string;
     /**
-     * 参与者类型。默认为空。ENTERPRISE-企业；INDIVIDUAL-个人；PROMOTER-发起方
+     * 参与者类型，默认为空。
+  ENTERPRISE-企业；
+  INDIVIDUAL-个人；
+  PROMOTER-发起方
      */
     RecipientType?: string;
     /**
-     * 描述
+     * 描述信息
      */
     Description?: string;
     /**
-     * 签署方备注角色名
+     * 角色名称
      */
     RoleName?: string;
     /**
-     * 是否需要校验，true-是，false-否
+     * 是否需要校验，
+  true-是，
+  false-否
      */
     RequireValidation?: boolean;
     /**
-     * 是否必须填写，true-是，false-否
+     * 是否必须填写，
+  true-是，
+  false-否
      */
     RequireSign?: boolean;
     /**
-     * 签署类型
+     * 内部字段，签署类型
      */
     SignType?: number;
     /**
@@ -1547,7 +1594,9 @@ export interface Recipient {
      */
     RoutingOrder?: number;
     /**
-     * 是否是发起方
+     * 是否是发起方，
+  true-是
+  false-否
      */
     IsPromoter?: boolean;
 }
@@ -1556,19 +1605,19 @@ export interface Recipient {
  */
 export interface DescribeTemplatesResponse {
     /**
-     * 模板详情
+     * 模板列表
      */
     Templates?: Array<TemplateInfo>;
     /**
-     * 查询总数
+     * 查询到的总数
      */
     TotalCount?: number;
     /**
-     * 查询数量
+     * 每页多少条数据
      */
     Limit?: number;
     /**
-     * 查询起始偏移
+     * 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
      */
     Offset?: number;
     /**
@@ -3498,10 +3547,11 @@ export interface ChannelBatchCancelFlowsRequest {
     CancelMessage?: string;
     /**
      * 撤销理由自定义格式；选项：
-  0 默认格式
-  1 只保留身份信息：展示为【发起方】
-  2 保留身份信息+企业名称：展示为【发起方xxx公司】
-  3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+  
+  - 0 默认格式
+  - 1 只保留身份信息：展示为【发起方】
+  - 2 保留身份信息+企业名称：展示为【发起方xxx公司】
+  - 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
      */
     CancelMessageFormat?: number;
     /**
@@ -3605,7 +3655,8 @@ export interface ChannelCancelFlowRequest {
  */
 export interface DescribeTemplatesRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
+     * 应用相关信息。
+  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
      */
     Agent: Agent;
     /**
@@ -3613,19 +3664,23 @@ export interface DescribeTemplatesRequest {
      */
     TemplateId?: string;
     /**
-     * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+     * 查询内容：
+  0-模板列表及详情（默认），
+  1-仅模板列表
      */
     ContentType?: number;
     /**
-     * 查询个数，默认20，最大100；在查询列表的时候有效
+     * 指定每页多少条数据，如果不传默认为20，单页最大100。
      */
     Limit?: number;
     /**
-     * 查询偏移位置，默认0；在查询列表的时候有效
+     * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
      */
     Offset?: number;
     /**
-     * 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件
+     * 是否返回所有组件信息。
+  默认false，只返回发起方控件；
+  true，返回所有签署方控件
      */
     QueryAllComponents?: boolean;
     /**
@@ -3633,11 +3688,16 @@ export interface DescribeTemplatesRequest {
      */
     TemplateName?: string;
     /**
-     * 是否获取模板预览链接
+     * 是否获取模板预览链接，
+  默认false-不获取
+  true-获取
      */
     WithPreviewUrl?: boolean;
     /**
-     * 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
+     * 是否获取模板的PDF文件链接。
+  默认false-不获取
+  true-获取
+  请联系客户经理开白后使用。
      */
     WithPdfUrl?: boolean;
     /**
@@ -3858,11 +3918,15 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
  */
 export interface OperateChannelTemplateRequest {
     /**
-     * 应用相关信息。 此接口Agent.AppId必填。
+     * 应用相关信息。
+  此接口Agent.AppId必填。
      */
     Agent: Agent;
     /**
-     * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
+     * 操作类型，
+  查询:"SELECT"，
+  删除:"DELETE"，
+  更新:"UPDATE"
      */
     OperateType: string;
     /**
@@ -3870,37 +3934,46 @@ export interface OperateChannelTemplateRequest {
      */
     TemplateId: string;
     /**
-     * 合作企业方第三方机构唯一标识数据，支持多个， 用","进行分隔
+     * 合作企业方第三方机构唯一标识数据.
+  支持多个， 用","进行分隔
      */
     ProxyOrganizationOpenIds?: string;
     /**
-     * 模板可见性, 全部可见-"all", 部分可见-"part"
+     * 模板可见性,
+  全部可见-"all",
+   部分可见-"part"
      */
     AuthTag?: string;
+    /**
+     * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。
+  若此字段值为0，则不会修改模板Available，
+  1为启用模板，
+  2为停用模板。
+  启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
+     */
+    Available?: number;
     /**
      * 暂未开放
      * @deprecated
      */
     Operator?: UserInfo;
-    /**
-     * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。若此字段值为0，则不会修改模板Available，1为启用模板，2为停用模板。
-  启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
-     */
-    Available?: number;
 }
 /**
  * CreateChannelFlowEvidenceReport返回参数结构体
  */
 export interface CreateChannelFlowEvidenceReportResponse {
     /**
-     * 出证报告 ID，用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
+     * 出证报告 ID，可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
+  
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ReportId?: string;
     /**
-     * 执行中：EvidenceStatusExecuting
-  成功：EvidenceStatusSuccess
-  失败：EvidenceStatusFailed
+     * 出征任务的执行状态,状态列表如下
+  
+  - EvidenceStatusExecuting : 出征任务正在执行中
+  - EvidenceStatusSuccess : 出征任务执行成功
+  - EvidenceStatusFailed : 出征任务执行失败
      */
     Status?: string;
     /**
@@ -3973,14 +4046,16 @@ export interface ChannelCreateReleaseFlowResponse {
  */
 export interface DescribeChannelFlowEvidenceReportResponse {
     /**
-     * 出证报告 URL
+     * 出证报告下载 URL
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ReportUrl?: string;
     /**
-     * 执行中：EvidenceStatusExecuting
-  成功：EvidenceStatusSuccess
-  失败：EvidenceStatusFailed
+     * 出征任务的执行状态,状态列表如下
+  
+  - EvidenceStatusExecuting : 出征任务正在执行中
+  - EvidenceStatusSuccess : 出征任务执行成功
+  - EvidenceStatusFailed : 出征任务执行失败
      */
     Status?: string;
     /**
@@ -4073,23 +4148,25 @@ export interface ChannelCreateEmbedWebUrlRequest {
      */
     Agent: Agent;
     /**
-     * WEB嵌入资源类型。
-  CREATE_SEAL: 创建印章
-  CREATE_TEMPLATE：创建模板
-  MODIFY_TEMPLATE：修改模板
-  PREVIEW_TEMPLATE：预览模板
-  PREVIEW_FLOW：预览合同文档
-  PREVIEW_FLOW_DETAIL：预览合同详情
-  PREVIEW_SEAL_LIST：预览印章列表
-  PREVIEW_SEAL_DETAIL：预览印章详情
-  EXTEND_SERVICE：扩展服务
+     * 要生成WEB嵌入界面的类型, 可以选择的值如下:
+  
+  - CREATE_SEAL: 生成创建印章的嵌入页面
+  - CREATE_TEMPLATE：生成创建模板的嵌入页面
+  - MODIFY_TEMPLATE：生成修改模板的嵌入页面
+  - PREVIEW_TEMPLATE：生成预览模板的嵌入页面
+  - PREVIEW_FLOW：生成预览合同文档的嵌入页面
+  - PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面
+  - PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
+  - PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
+  - EXTEND_SERVICE：生成扩展服务的嵌入页面
      */
     EmbedType: string;
     /**
      * WEB嵌入的业务资源ID
-  EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时必填，取值为模板id
-  PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时必填，取值为合同id
-  PREVIEW_SEAL_DETAIL，必填，取值为印章id
+  
+  - 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
+  - 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
+  - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
      */
     BusinessId?: string;
     /**