tencentcloud-sdk-nodejs-ess 4.0.654 → 4.0.656

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -288,8 +288,11 @@ export interface FlowCreateApprover {
      * 参与者类型：
   0：企业
   1：个人
-  3：企业静默签署
-  注：类型为3（企业静默签署）时，会默认完成该签署方的签署。静默签署仅进行盖章操作，不能是手写签名。
+  3：企业自动签署
+  注：类型为3（企业自动签署）时，会自动完成该签署方的签署。
+  自动签署仅进行盖章操作，不能是手写签名。
+  本方企业自动签署的签署人会默认是当前的发起人
+  他方企业自动签署的签署人是自动签模板的他方企业授权人
      */
     ApproverType: number;
     /**
@@ -322,7 +325,7 @@ export interface FlowCreateApprover {
     ApproverIdCardNumber?: string;
     /**
      * 签署方经办人在模板中的参与方ID
-  <br/>模版发起合同时，该参数为必填项
+  <br/>模板发起合同时，该参数为必填项
   <br/>文件发起合同是，该参数无序传值
   
      */
@@ -525,10 +528,10 @@ export interface CreateFlowOption {
      */
     CanEditFlow?: boolean;
     /**
-     * 是否允许编辑模版控件
-  <br/>true:允许编辑模版控件信息
-  <br/>false:不允许编辑模版控件信息
-  <br/>默认false:不允许编辑模版控件信息
+     * 是否允许编辑模板控件
+  <br/>true:允许编辑模板控件信息
+  <br/>false:不允许编辑模板控件信息
+  <br/>默认false:不允许编辑模板控件信息
      */
     CanEditFormField?: boolean;
     /**
@@ -614,7 +617,7 @@ export interface ReleasedApprover {
      */
     ApproverSignComponentType?: string;
     /**
-     * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推.  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
+     * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
      */
     ApproverSignRole?: string;
 }
@@ -998,7 +1001,7 @@ export interface DescribeFlowEvidenceReportResponse {
   
   EvidenceStatusExecuting  出证任务在执行中
   EvidenceStatusSuccess  出证任务执行成功
-  EvidenceStatusFailed  出征任务执行失败
+  EvidenceStatusFailed  出证任务执行失败
      */
     Status?: string;
     /**
@@ -1237,6 +1240,7 @@ export interface CreateFlowRequest {
     FlowName: string;
     /**
      * 签署流程参与者信息，最大限制50方
+  注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
      */
     Approvers: Array<FlowCreateApprover>;
     /**
@@ -1386,7 +1390,7 @@ export interface AutoSignConfig {
     /**
      * 接受回调URL地址。支持http://或者https://协议
   
-  Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
+  Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
      */
     CallbackUrl: string;
     /**
@@ -1405,7 +1409,7 @@ export interface AutoSignConfig {
      * 是否需要回调的时候返回印章(签名) 图片的 base64
   
   false-不需要(默认)
-  true-需要(
+  true-需要
      */
     SealImgCallback?: boolean;
     /**
@@ -1732,6 +1736,19 @@ export interface OccupiedSeal {
      */
     AuthorizedUsers: Array<AuthorizedUser>;
 }
+/**
+ * CreatePersonAuthCertificateImage返回参数结构体
+ */
+export interface CreatePersonAuthCertificateImageResponse {
+    /**
+     * 个人用户证明证书的下载链接
+     */
+    AuthCertUrl?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 删除员工失败数据
  */
@@ -2202,8 +2219,72 @@ export interface DescribeFileUrlsRequest {
 /**
  * 电子文档的控件填充信息。按照控件类型进行相应的填充。
 
+当控件的 ComponentType='TEXT'时，FormField.ComponentValue填入文本内容
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "文本内容"
+}
+```
+当控件的 ComponentType='MULTI_LINE_TEXT'时，FormField.ComponentValue填入文本内容，支持自动换行。
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "多行文本内容"
+}
+```
+当控件的 ComponentType='CHECK_BOX'时，FormField.ComponentValue填入true或false文本
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "true"
+}
+```
+当控件的 ComponentType='FILL_IMAGE'时，FormField.ComponentValue填入图片的资源ID
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+}
+```
+当控件的 ComponentType='ATTACHMENT'时，FormField.ComponentValue填入附件图片的资源ID列表，以逗号分隔，单个附件控件最多支持6个资源ID；
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
+}
+```
+当控件的 ComponentType='SELECTOR'时，FormField.ComponentValue填入选择的选项内容；
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "选择的内容"
+}
+```
+当控件的 ComponentType='DATE'时，FormField.ComponentValue填入日期内容；
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "2023年01月01日"
+}
+```
+当控件的 ComponentType='DISTRICT'时，FormField.ComponentValue填入省市区内容；
+```
+FormFiled输入示例：
+{
+    "ComponentId": "componentId1",
+    "ComponentValue": "广东省深圳市福田区"
+}
+```
 【数据表格传参说明】
-当模板的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
+当控件的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
 输入示例1：
 
 ```
@@ -2813,17 +2894,23 @@ export interface CreateEmbedWebUrlRequest {
     Operator: UserInfo;
     /**
      * WEB嵌入资源类型。
-  <br/>CREATE_SEAL: 创建印章
-  <br/>PREVIEW_SEAL_LIST：预览印章列表
-  <br/>PREVIEW_SEAL_DETAIL：预览印章详情
-  <br/>EXTEND_SERVICE：拓展服务
-  <br/>PREVIEW_FLOW：预览合同
-  <br/>PREVIEW_FLOW_DETAIL：查看合同详情
+  <br/>CREATE_SEAL: 生成创建印章的嵌入页面
+  <br/>CREATE_TEMPLATE：生成创建模板的嵌入页面
+  <br/>MODIFY_TEMPLATE：生成编辑模板的嵌入页面
+  <br/>PREVIEW_TEMPLATE：生成预览模板的嵌入页面
+  <br/>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
+  <br/>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
+  <br/>EXTEND_SERVICE：生成拓展服务的嵌入页面
+  <br/>PREVIEW_FLOW：生成预览合同的嵌入页面
+  <br/>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面
+  
      */
     EmbedType: string;
     /**
      * WEB嵌入的业务资源ID
   <br/>PREVIEW_SEAL_DETAIL，必填，取值为印章id
+  <br/>MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模版id
+  <br/>PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id
      */
     BusinessId?: string;
     /**
@@ -3218,6 +3305,32 @@ export interface SuccessUpdateStaffData {
      */
     UserId?: string;
 }
+/**
+ * CreatePersonAuthCertificateImage请求参数结构体
+ */
+export interface CreatePersonAuthCertificateImageRequest {
+    /**
+     * 操作人信息
+     */
+    Operator: UserInfo;
+    /**
+     * 个人用户名称
+     */
+    UserName: string;
+    /**
+     * 身份证件类型取值：
+  ID_CARD 身居民身份证
+  PASSPORT 护照
+  HONGKONG_AND_MACAO 港澳居民来往内地通行证
+  FOREIGN_ID_CARD 外国人永久居留身份证
+  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+     */
+    IdCardType: string;
+    /**
+     * 身份证件号码
+     */
+    IdCardNumber: string;
+}
 /**
  * CreateFlowByFiles返回参数结构体
  */
@@ -4849,10 +4962,10 @@ export interface EmbedUrlOption {
      */
     ShowFlowDetailComponent?: boolean;
     /**
-     * 模版预览，允许展示模版控件信息
-  <br/>true：允许在模版预览页展示控件
-  <br/>false：不允许在模版预览页展示控件
-  <br/>默认false，模版预览页不展示控件
+     * 模板预览，允许展示模板控件信息
+  <br/>true：允许在模板预览页展示控件
+  <br/>false：不允许在模板预览页展示控件
+  <br/>默认false，模板预览页不展示控件
      */
     ShowTemplateComponent?: boolean;
 }
@@ -4893,11 +5006,13 @@ export interface CreateMultiFlowSignQRCodeRequest {
     FlowName: string;
     /**
      * 最大可发起签署流程份数，默认5份
-  发起流程数量超过此上限后二维码自动失效
+  <br/>发起流程数量超过此上限后二维码自动失效
      */
     MaxFlowNum?: number;
     /**
-     * 签署流程有效天数 默认7天 最高设置不超过30天
+     * 签署流程有效天数
+  <br/>默认7天
+  <br/>最高设置不超过30天
      */
     FlowEffectiveDay?: number;
     /**
@@ -4905,17 +5020,18 @@ export interface CreateMultiFlowSignQRCodeRequest {
      */
     QrEffectiveDay?: number;
     /**
-     * 限制二维码用户条件
+     * 指定的签署人信息
+  <br/>指定后，则只允许指定的签署人扫码签署
      */
     Restrictions?: Array<ApproverRestriction>;
     /**
-     * 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+     * 用户自定义字段
+  <br/>回调的时候会进行透传，长度需要小于20480
      */
     UserData?: string;
     /**
      * 回调地址,最大长度1000字符串
-  回调时机：
-  用户通过签署二维码发起签署流程时，企业额度不足导致失败
+  <br/>回调时机：用户通过签署二维码发起签署流程时，企业额度不足导致失败
      */
     CallbackUrl?: string;
     /**
@@ -5144,8 +5260,9 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
      */
     JoinedTotal?: number;
     /**
-     * 已加入的企业数量
+     * 已加入的企业数量(废弃,请使用ActivatedTotal)
   注意：此字段可能返回 null，表示取不到有效值。
+     * @deprecated
      */
     ActivedTotal?: number;
     /**
@@ -5158,6 +5275,11 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     List?: Array<GroupOrganization>;
+    /**
+     * 已加入的企业数量
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ActivatedTotal?: number;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */