tencentcloud-sdk-nodejs-ess 4.0.550 → 4.0.553

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

@@ -294,6 +294,16 @@ export interface DescribeThirdPartyAuthCodeResponse {
   RequestId?: string
 }
 
+/**
+ * DisableUserAutoSign返回参数结构体
+ */
+export interface DisableUserAutoSignResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateIntegrationEmployees请求参数结构体
  */
@@ -906,19 +916,44 @@ false：有序签
 }
 
 /**
- * 下载文件的URL信息
+ * 自动签开启、签署相关配置
  */
-export interface FileUrl {
+export interface AutoSignConfig {
   /**
-   * 下载文件的URL
-   */
-  Url: string
+      * 自动签开通个人用户的三要素
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserInfo: UserThreeFactor
 
   /**
-      * 下载文件的附加信息
+      * 回调链接
 注意：此字段可能返回 null，表示取不到有效值。
       */
-  Option: string
+  CallbackUrl: string
+
+  /**
+      * 是否回调证书信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CertInfoCallback?: boolean
+
+  /**
+      * 是否支持用户自定义签名印章
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  UserDefineSeal?: boolean
+
+  /**
+      * 是否需要回调的时候返回印章(签名) 图片的 base64
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SealImgCallback?: boolean
+
+  /**
+      * 开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  VerifyChannels?: Array<string>
 }
 
 /**
@@ -991,6 +1026,21 @@ export interface OrganizationInfo {
   ProxyIp?: string
 }
 
+/**
+ * DescribeUserAutoSignStatus返回参数结构体
+ */
+export interface DescribeUserAutoSignStatusResponse {
+  /**
+   * 是否开通
+   */
+  IsOpen?: boolean
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 补充签署人信息
  */
@@ -1192,6 +1242,32 @@ export interface CreateBatchCancelFlowUrlResponse {
   RequestId?: string
 }
 
+/**
+ * 用户的三要素：姓名，证件号，证件类型
+ */
+export interface UserThreeFactor {
+  /**
+      * 姓名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Name: string
+
+  /**
+      * 证件类型: 
+ID_CARD 身份证
+HONGKONG_AND_MACAO 港澳居民来往内地通行证
+HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdCardType: string
+
+  /**
+      * 证件号，如果有 X 请大写
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdCardNumber: string
+}
+
 /**
  * CreateSealPolicy返回参数结构体
  */
@@ -1207,6 +1283,27 @@ export interface CreateSealPolicyResponse {
   RequestId?: string
 }
 
+/**
+ * DisableUserAutoSign请求参数结构体
+ */
+export interface DisableUserAutoSignRequest {
+  /**
+   * 操作人信息
+   */
+  Operator: UserInfo
+
+  /**
+      * 自动签场景:
+E_PRESCRIPTION_AUTO_SIGN 电子处方
+      */
+  SceneKey: string
+
+  /**
+   * 关闭自动签的个人的三要素
+   */
+  UserInfo: UserThreeFactor
+}
+
 /**
  * DescribeIntegrationEmployees返回参数结构体
  */
@@ -1328,112 +1425,43 @@ export interface FailedCreateStaffData {
 }
 
 /**
- * CreateFlowByFiles请求参数结构体
+ * CreateUserAutoSignEnableUrl返回参数结构体
  */
-export interface CreateFlowByFilesRequest {
-  /**
-   * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId 代发合同
-   */
-  Operator: UserInfo
-
-  /**
-   * 签署流程名称,最大长度200个字符
-   */
-  FlowName: string
-
-  /**
-   * 签署参与者信息，最大限制50方
-   */
-  Approvers: Array<ApproverInfo>
-
-  /**
-   * 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
-   */
-  FileIds: Array<string>
-
-  /**
-   * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
-   */
-  FlowType?: string
-
+export interface CreateUserAutoSignEnableUrlResponse {
   /**
-   * 经办人内容控件配置
+   * 跳转短链
    */
-  Components?: Array<Component>
-
-  /**
-      * 被抄送人的信息列表。
-注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
-      */
-  CcInfos?: Array<CcInfo>
-
-  /**
-      * 是否需要预览，true：预览模式，false：非预览（默认）；
-预览链接有效期300秒；
-
-注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
-      */
-  NeedPreview?: boolean
+  Url?: string
 
   /**
-   * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
+   * 小程序AppId
    */
-  PreviewType?: number
-
-  /**
-      * 签署流程的签署截止时间。
-值为unix时间戳,精确到秒,不传默认为当前时间一年后
-      */
-  Deadline?: number
-
-  /**
-      * 发送类型：
-true：无序签
-false：有序签
-注：默认为false（有序签）
-      */
-  Unordered?: boolean
+  AppId?: string
 
   /**
-   * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+   * 小程序 原始 Id
    */
-  CustomShowMap?: string
-
-  /**
-      * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
-若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
-
-注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
-      */
-  NeedSignReview?: boolean
+  AppOriginalId?: string
 
   /**
-   * 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+   * 跳转路径
    */
-  UserData?: string
-
-  /**
-      * 签署人校验方式
-VerifyCheck: 人脸识别（默认）
-MobileCheck：手机号验证
-参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
-      */
-  ApproverVerifyType?: string
+  Path?: string
 
   /**
-   * 签署流程描述,最大长度1000个字符
+   * base64格式跳转二维码
    */
-  FlowDescription?: string
+  QrCode?: string
 
   /**
-   * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
+   * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
    */
-  SignBeanTag?: number
+  UrlType?: string
 
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  Agent?: Agent
+  RequestId?: string
 }
 
 /**
@@ -2448,6 +2476,32 @@ export interface CreateStaffResult {
   FailedEmployeeData: Array<FailedCreateStaffData>
 }
 
+/**
+ * CreateUserAutoSignEnableUrl请求参数结构体
+ */
+export interface CreateUserAutoSignEnableUrlRequest {
+  /**
+   * 操作人信息
+   */
+  Operator: UserInfo
+
+  /**
+      * 自动签场景:
+E_PRESCRIPTION_AUTO_SIGN 电子处方
+      */
+  SceneKey: string
+
+  /**
+   * 自动签开通，签署相关配置
+   */
+  AutoSignConfig: AutoSignConfig
+
+  /**
+   * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+   */
+  UrlType?: string
+}
+
 /**
  * DescribeIntegrationMainOrganizationUser返回参数结构体
  */
@@ -2534,6 +2588,115 @@ export interface DeleteSealPoliciesRequest {
   UserIds?: Array<string>
 }
 
+/**
+ * CreateFlowByFiles请求参数结构体
+ */
+export interface CreateFlowByFilesRequest {
+  /**
+   * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId 代发合同
+   */
+  Operator: UserInfo
+
+  /**
+   * 签署流程名称,最大长度200个字符
+   */
+  FlowName: string
+
+  /**
+   * 签署参与者信息，最大限制50方
+   */
+  Approvers: Array<ApproverInfo>
+
+  /**
+   * 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
+   */
+  FileIds: Array<string>
+
+  /**
+   * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
+   */
+  FlowType?: string
+
+  /**
+   * 经办人内容控件配置
+   */
+  Components?: Array<Component>
+
+  /**
+      * 被抄送人的信息列表。
+注:此功能为白名单功能，若有需要，请联系电子签客服开白使用
+      */
+  CcInfos?: Array<CcInfo>
+
+  /**
+      * 是否需要预览，true：预览模式，false：非预览（默认）；
+预览链接有效期300秒；
+
+注：如果使用“预览模式”，出参会返回合同预览链接 PreviewUrl，不会正式发起合同，且出参不会返回签署流程编号 FlowId；如果使用“非预览”，则会正常返回签署流程编号 FlowId，不会生成合同预览链接 PreviewUrl。
+      */
+  NeedPreview?: boolean
+
+  /**
+   * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
+   */
+  PreviewType?: number
+
+  /**
+      * 签署流程的签署截止时间。
+值为unix时间戳,精确到秒,不传默认为当前时间一年后
+      */
+  Deadline?: number
+
+  /**
+      * 发送类型：
+true：无序签
+false：有序签
+注：默认为false（有序签）
+      */
+  Unordered?: boolean
+
+  /**
+   * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+   */
+  CustomShowMap?: string
+
+  /**
+      * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
+若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+      */
+  NeedSignReview?: boolean
+
+  /**
+   * 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+   */
+  UserData?: string
+
+  /**
+      * 签署人校验方式
+VerifyCheck: 人脸识别（默认）
+MobileCheck：手机号验证
+参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
+      */
+  ApproverVerifyType?: string
+
+  /**
+   * 签署流程描述,最大长度1000个字符
+   */
+  FlowDescription?: string
+
+  /**
+   * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
+   */
+  SignBeanTag?: number
+
+  /**
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   */
+  Agent?: Agent
+}
+
 /**
  * CreatePrepareFlow返回参数结构体
  */
@@ -2725,6 +2888,22 @@ export interface ApproverOption {
   NoTransfer?: boolean
 }
 
+/**
+ * 下载文件的URL信息
+ */
+export interface FileUrl {
+  /**
+   * 下载文件的URL
+   */
+  Url: string
+
+  /**
+      * 下载文件的附加信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Option: string
+}
+
 /**
  * CreateSealPolicy请求参数结构体
  */
@@ -3442,6 +3621,27 @@ export interface CreateFlowResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeUserAutoSignStatus请求参数结构体
+ */
+export interface DescribeUserAutoSignStatusRequest {
+  /**
+   * 操作人信息
+   */
+  Operator: UserInfo
+
+  /**
+      * 自动签场景:
+E_PRESCRIPTION_AUTO_SIGN 电子处方
+      */
+  SceneKey: string
+
+  /**
+   * 查询开启状态的用户信息
+   */
+  UserInfo: UserThreeFactor
+}
+
 /**
  * 流程信息摘要
  */

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

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, DeleteSealPoliciesResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, DescribeIntegrationMainOrganizationUserResponse, CreateSchemeUrlResponse, DeleteSealPoliciesRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreatePrepareFlowRequest, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, DeleteIntegrationEmployeesResponse, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, DescribeOrganizationGroupOrganizationsResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
+import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateUserAutoSignEnableUrlRequest, DescribeIntegrationMainOrganizationUserResponse, CreateSchemeUrlResponse, DeleteSealPoliciesRequest, CreateFlowByFilesRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreatePrepareFlowRequest, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, DeleteIntegrationEmployeesResponse, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
 /**
  * ess client
  * @class
@@ -41,6 +41,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
        */
     DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
+    /**
+     * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
+     */
+    CreateUserAutoSignEnableUrl(req: CreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CreateUserAutoSignEnableUrlResponse) => void): Promise<CreateUserAutoSignEnableUrlResponse>;
     /**
        * 创建出证报告，返回报告 ID。需要配合出证套餐才能调用。
   出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
@@ -63,6 +67,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
        */
     CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
+    /**
+     * 企业方可以通过此接口关闭个人的自动签功能
+     */
+    DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
     /**
        * 提交企业签署流程审批结果
   适用场景:
@@ -98,6 +106,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
        */
     CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
+    /**
+     * 企业方可以通过此接口查询个人用户自动签开启状态
+     */
+    DescribeUserAutoSignStatus(req: DescribeUserAutoSignStatusRequest, cb?: (error: string, rep: DescribeUserAutoSignStatusResponse) => void): Promise<DescribeUserAutoSignStatusResponse>;
     /**
      * 查询出证报告，返回报告 URL。
      */

package/tencentcloud/services/ess/v20201111/ess_client.js

@@ -76,6 +76,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeFileUrls(req, cb) {
         return this.request("DescribeFileUrls", req, cb);
     }
+    /**
+     * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
+     */
+    async CreateUserAutoSignEnableUrl(req, cb) {
+        return this.request("CreateUserAutoSignEnableUrl", req, cb);
+    }
     /**
        * 创建出证报告，返回报告 ID。需要配合出证套餐才能调用。
   出证需要一定时间，建议调用创建出证24小时之后再通过DescribeFlowEvidenceReport进行查询。
@@ -106,6 +112,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateFlowApprovers(req, cb) {
         return this.request("CreateFlowApprovers", req, cb);
     }
+    /**
+     * 企业方可以通过此接口关闭个人的自动签功能
+     */
+    async DisableUserAutoSign(req, cb) {
+        return this.request("DisableUserAutoSign", req, cb);
+    }
     /**
        * 提交企业签署流程审批结果
   适用场景:
@@ -153,6 +165,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateFlow(req, cb) {
         return this.request("CreateFlow", req, cb);
     }
+    /**
+     * 企业方可以通过此接口查询个人用户自动签开启状态
+     */
+    async DescribeUserAutoSignStatus(req, cb) {
+        return this.request("DescribeUserAutoSignStatus", req, cb);
+    }
     /**
      * 查询出证报告，返回报告 URL。
      */