tencentcloud-sdk-nodejs 4.0.654 → 4.0.656

package/src/services/ess/v20201111/ess_models.ts

@@ -318,8 +318,11 @@ export interface FlowCreateApprover {
    * 参与者类型：
 0：企业
 1：个人
-3：企业静默签署
-注：类型为3（企业静默签署）时，会默认完成该签署方的签署。静默签署仅进行盖章操作，不能是手写签名。
+3：企业自动签署
+注：类型为3（企业自动签署）时，会自动完成该签署方的签署。
+自动签署仅进行盖章操作，不能是手写签名。
+本方企业自动签署的签署人会默认是当前的发起人
+他方企业自动签署的签署人是自动签模板的他方企业授权人
    */
   ApproverType: number
   /**
@@ -352,7 +355,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   ApproverIdCardNumber?: string
   /**
    * 签署方经办人在模板中的参与方ID
-<br/>模版发起合同时，该参数为必填项
+<br/>模板发起合同时，该参数为必填项
 <br/>文件发起合同是，该参数无序传值
 
    */
@@ -563,10 +566,10 @@ export interface CreateFlowOption {
    */
   CanEditFlow?: boolean
   /**
-   * 是否允许编辑模版控件
-<br/>true:允许编辑模版控件信息
-<br/>false:不允许编辑模版控件信息
-<br/>默认false:不允许编辑模版控件信息
+   * 是否允许编辑模板控件
+<br/>true:允许编辑模板控件信息
+<br/>false:不允许编辑模板控件信息
+<br/>默认false:不允许编辑模板控件信息
    */
   CanEditFormField?: boolean
   /**
@@ -653,7 +656,7 @@ ENTERPRISESERVER-企业静默签
    */
   ApproverSignComponentType?: string
   /**
-   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推.  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
+   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
    */
   ApproverSignRole?: string
 }
@@ -1053,7 +1056,7 @@ export interface DescribeFlowEvidenceReportResponse {
 
 EvidenceStatusExecuting  出证任务在执行中
 EvidenceStatusSuccess  出证任务执行成功
-EvidenceStatusFailed  出征任务执行失败
+EvidenceStatusFailed  出证任务执行失败
    */
   Status?: string
   /**
@@ -1299,6 +1302,7 @@ export interface CreateFlowRequest {
   FlowName: string
   /**
    * 签署流程参与者信息，最大限制50方
+注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
    */
   Approvers: Array<FlowCreateApprover>
   /**
@@ -1451,7 +1455,7 @@ export interface AutoSignConfig {
   /**
    * 接受回调URL地址。支持http://或者https://协议
 
-Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
+Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
    */
   CallbackUrl: string
   /**
@@ -1470,7 +1474,7 @@ true-需要
    * 是否需要回调的时候返回印章(签名) 图片的 base64
 
 false-不需要(默认)
-true-需要(
+true-需要
    */
   SealImgCallback?: boolean
   /**
@@ -1811,6 +1815,20 @@ export interface OccupiedSeal {
   AuthorizedUsers: Array<AuthorizedUser>
 }
 
+/**
+ * CreatePersonAuthCertificateImage返回参数结构体
+ */
+export interface CreatePersonAuthCertificateImageResponse {
+  /**
+   * 个人用户证明证书的下载链接
+   */
+  AuthCertUrl?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 删除员工失败数据
  */
@@ -2298,8 +2316,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：
 
 ```
@@ -2925,17 +3007,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
   /**
@@ -3345,6 +3433,33 @@ 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返回参数结构体
  */
@@ -5032,10 +5147,10 @@ export interface EmbedUrlOption {
    */
   ShowFlowDetailComponent?: boolean
   /**
-   * 模版预览，允许展示模版控件信息
-<br/>true：允许在模版预览页展示控件
-<br/>false：不允许在模版预览页展示控件
-<br/>默认false，模版预览页不展示控件
+   * 模板预览，允许展示模板控件信息
+<br/>true：允许在模板预览页展示控件
+<br/>false：不允许在模板预览页展示控件
+<br/>默认false，模板预览页不展示控件
    */
   ShowTemplateComponent?: boolean
 }
@@ -5078,11 +5193,13 @@ export interface CreateMultiFlowSignQRCodeRequest {
   FlowName: string
   /**
    * 最大可发起签署流程份数，默认5份 
-发起流程数量超过此上限后二维码自动失效
+<br/>发起流程数量超过此上限后二维码自动失效
    */
   MaxFlowNum?: number
   /**
-   * 签署流程有效天数 默认7天 最高设置不超过30天
+   * 签署流程有效天数 
+<br/>默认7天 
+<br/>最高设置不超过30天
    */
   FlowEffectiveDay?: number
   /**
@@ -5090,17 +5207,18 @@ export interface CreateMultiFlowSignQRCodeRequest {
    */
   QrEffectiveDay?: number
   /**
-   * 限制二维码用户条件
+   * 指定的签署人信息
+<br/>指定后，则只允许指定的签署人扫码签署
    */
   Restrictions?: Array<ApproverRestriction>
   /**
-   * 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+   * 用户自定义字段
+<br/>回调的时候会进行透传，长度需要小于20480
    */
   UserData?: string
   /**
    * 回调地址,最大长度1000字符串
-回调时机：
-用户通过签署二维码发起签署流程时，企业额度不足导致失败
+<br/>回调时机：用户通过签署二维码发起签署流程时，企业额度不足导致失败
    */
   CallbackUrl?: string
   /**
@@ -5338,8 +5456,9 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
    */
   JoinedTotal?: number
   /**
-   * 已加入的企业数量
+   * 已加入的企业数量(废弃,请使用ActivatedTotal)
 注意：此字段可能返回 null，表示取不到有效值。
+   * @deprecated
    */
   ActivedTotal?: number
   /**
@@ -5352,6 +5471,11 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   List?: Array<GroupOrganization>
+  /**
+   * 已加入的企业数量
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  ActivatedTotal?: number
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -689,11 +689,23 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-     * 此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置，不会直接分配第三方应用平台模板给子客企业。
-1、OperateType=select时：
-查询第三方应用平台模板库
-2、OperateType=update或者delete时：
-对子客企业进行模板库中模板可见性的修改、删除操作。
+     * 此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。
+
+> **使用场景**
+>
+>  1：查询 OperateType=SELECT
+> - 查询第三方应用平台模板库的可见性以及授权的子客列表。
+>
+>  2：修改部分子客授权 OperateType=UPDATE
+> - 对子客企业进行模板库中模板可见性的进行修改操作。
+>- 当模板未发布时，可以修改可见性AuthTag（part/all），当模板发布后，不可做此修改
+> - 若模板已发布且可见性AuthTag是part，可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板，增加授权范围后会自动下发。
+>
+>  3：取消部分子客授权 OperateType=DELETE
+> - 对子客企业进行模板库中模板可见性的进行删除操作。
+> - 主要对于手动领取的模板，去除授权后子客在在模板库中看不到，就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
+> - 对于自动领取的模板，由于已经下发，更改授权不会影响。
+> - 如果要同步删除子客自有模板库中的模板，请使用OperateType=UPDATE+Available参数处理。
      */
   async OperateChannelTemplate(
     req: OperateChannelTemplateRequest,

package/src/services/essbasic/v20210526/essbasic_models.ts

@@ -482,11 +482,12 @@ export interface DescribeFlowDetailInfoRequest {
   Agent: Agent
   /**
    * 合同(流程)编号数组，最多支持100个。
-（备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参）
+<br/>备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参
    */
   FlowIds?: Array<string>
   /**
-   * 合同组编号（备注：该参数和合同(流程)编号数组必须二选一）
+   * 合同组编号
+<br/>备注：该参数和合同(流程)编号数组必须二选一
    */
   FlowGroupId?: string
   /**
@@ -1254,66 +1255,67 @@ export interface FlowApproverDetail {
   /**
    * 模板配置时候的签署人id,与控件绑定
    */
-  ReceiptId: string
+  ReceiptId?: string
   /**
    * 平台企业的第三方id
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ProxyOrganizationOpenId: string
+  ProxyOrganizationOpenId?: string
   /**
    * 平台企业操作人的第三方id
    */
-  ProxyOperatorOpenId: string
+  ProxyOperatorOpenId?: string
   /**
    * 平台企业名称
    */
-  ProxyOrganizationName: string
+  ProxyOrganizationName?: string
   /**
    * 签署人手机号
    */
-  Mobile: string
+  Mobile?: string
   /**
    * 签署人签署顺序
    */
-  SignOrder: number
+  SignOrder?: number
   /**
    * 签署人姓名
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproveName: string
+  ApproveName?: string
   /**
    * 当前签署人的状态, 状态如下
-
-PENDING 待签署	
-FILLPENDING 待填写
-FILLACCEPT 填写完成	
-FILLREJECT 拒绝填写	
-WAITPICKUP 待领取	
-ACCEPT 已签署	
-REJECT 拒签 
-DEADLINE 过期没人处理 
-CANCEL 流程已撤回	
-FORWARD 已经转他人处理
-STOP 流程已终止	
-RELIEVED 解除协议（已解除）
+<br/>PENDING 待签署	
+<br/>FILLPENDING 待填写
+<br/>FILLACCEPT 填写完成	
+<br/>FILLREJECT 拒绝填写	
+<br/>WAITPICKUP 待领取	
+<br/>ACCEPT 已签署	
+<br/>REJECT 拒签 
+<br/>DEADLINE 过期没人处理 
+<br/>CANCEL 流程已撤回	
+<br/>FORWARD 已经转他人处理
+<br/>STOP 流程已终止	
+<br/>RELIEVED 解除协议（已解除）
 
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproveStatus: string
+  ApproveStatus?: string
   /**
-   * 签署人信息
+   * 签署人自定义信息
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproveMessage: string
+  ApproveMessage?: string
   /**
    * 签署人签署时间戳，单位秒
    */
-  ApproveTime: number
+  ApproveTime?: number
   /**
-   * 参与者类型 (ORGANIZATION企业/PERSON个人)
+   * 参与者类型 
+<br/>ORGANIZATION：企业签署人
+<br/>PERSON：个人签署人
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ApproveType: string
+  ApproveType?: string
 }
 
 /**
@@ -2704,7 +2706,9 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
    */
   FlowName: string
   /**
-   * 最大可发起签署流程份数，默认5份；发起签署流程数量超过此上限后，二维码自动失效。
+   * 最大可发起签署流程份数
+<br/>默认5份
+<br/>备注：发起签署流程数量超过此上限后，二维码自动失效。
    */
   MaxFlowNum?: number
   /**
@@ -2716,7 +2720,8 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
    */
   QrEffectiveDay?: number
   /**
-   * 限制二维码用户条件
+   * 指定的签署二维码签署人
+<br/>指定后，只允许知道的人操作和签署
    */
   Restrictions?: Array<ApproverRestriction>
   /**
@@ -4091,7 +4096,7 @@ export interface OperateChannelTemplateRequest {
    */
   AuthTag?: string
   /**
-   * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。
+   * 当OperateType=UPDATE时，可以通过设置此字段对模板启停用状态进行操作。
 若此字段值为0，则不会修改模板Available，
 1为启用模板，
 2为停用模板。