tencentcloud-sdk-nodejs-essbasic 4.0.653 → 4.0.654

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>;
     /**
@@ -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;
@@ -1401,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
@@ -1439,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;
@@ -1519,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;
     /**
@@ -1555,7 +1594,9 @@ export interface Recipient {
      */
     RoutingOrder?: number;
     /**
-     * 是否是发起方
+     * 是否是发起方，
+  true-是
+  false-否
      */
     IsPromoter?: boolean;
 }
@@ -1564,19 +1605,19 @@ export interface Recipient {
  */
 export interface DescribeTemplatesResponse {
     /**
-     * 模板详情
+     * 模板列表
      */
     Templates?: Array<TemplateInfo>;
     /**
-     * 查询总数
+     * 查询到的总数
      */
     TotalCount?: number;
     /**
-     * 查询数量
+     * 每页多少条数据
      */
     Limit?: number;
     /**
-     * 查询起始偏移
+     * 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
      */
     Offset?: number;
     /**
@@ -3614,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;
     /**
@@ -3622,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;
     /**
@@ -3642,11 +3688,16 @@ export interface DescribeTemplatesRequest {
      */
     TemplateName?: string;
     /**
-     * 是否获取模板预览链接
+     * 是否获取模板预览链接，
+  默认false-不获取
+  true-获取
      */
     WithPreviewUrl?: boolean;
     /**
-     * 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
+     * 是否获取模板的PDF文件链接。
+  默认false-不获取
+  true-获取
+  请联系客户经理开白后使用。
      */
     WithPdfUrl?: boolean;
     /**
@@ -3867,11 +3918,15 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
  */
 export interface OperateChannelTemplateRequest {
     /**
-     * 应用相关信息。 此接口Agent.AppId必填。
+     * 应用相关信息。
+  此接口Agent.AppId必填。
      */
     Agent: Agent;
     /**
-     * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
+     * 操作类型，
+  查询:"SELECT"，
+  删除:"DELETE"，
+  更新:"UPDATE"
      */
     OperateType: string;
     /**
@@ -3879,23 +3934,29 @@ 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返回参数结构体