tencentcloud-sdk-nodejs-ess 4.0.432 → 4.0.437

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

@@ -459,74 +459,28 @@ export interface SignQrCode {
 }
 
 /**
- * GetTaskResultApi请求参数结构体
+ * CreateFlowApprovers返回参数结构体
  */
-export interface GetTaskResultApiRequest {
-  /**
-   * 任务Id，通过CreateConvertTaskApi得到
-   */
-  TaskId: string
-
-  /**
-   * 操作人信息
-   */
-  Operator?: UserInfo
-
-  /**
-   * 应用号信息
-   */
-  Agent?: Agent
-
+export interface CreateFlowApproversResponse {
   /**
-   * 暂未开放
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  Organization?: OrganizationInfo
+  RequestId?: string
 }
 
 /**
- * UploadFiles请求参数结构体
+ * DescribeFlowInfo请求参数结构体
  */
-export interface UploadFilesRequest {
-  /**
-      * 文件对应业务类型，用于区分文件存储路径：
-1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
-2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
-3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
-      */
-  BusinessType: string
-
-  /**
-   * 调用方信息
-   */
-  Caller?: Caller
-
+export interface DescribeFlowInfoRequest {
   /**
-   * 上传文件内容数组，最多支持20个文件
+   * 需要查询的流程ID列表，限制最大100个
    */
-  FileInfos?: Array<UploadFile>
-
-  /**
-   * 上传文件链接数组，最多支持20个URL
-   */
-  FileUrls?: string
-
-  /**
-      * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
-true--是，处理置白
-false--否，不处理
-      */
-  CoverRect?: boolean
-
-  /**
-      * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
-如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
-      */
-  FileType?: string
+  FlowIds: Array<string>
 
   /**
-   * 用户自定义ID数组，与上传文件一一对应
+   * 调用方用户信息
    */
-  CustomIds?: Array<string>
+  Operator?: UserInfo
 }
 
 /**
@@ -781,7 +735,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   PreReadTime?: number
 
   /**
-   * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
+   * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个。非企微场景不使用此字段
    */
   UserId?: string
 
@@ -789,6 +743,16 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
    * 当前只支持true，默认为true
    */
   Required?: boolean
+
+  /**
+   * 签署人用户来源,企微侧用户请传入：WEWORKAPP
+   */
+  ApproverSource?: string
+
+  /**
+   * 客户自定义签署人标识，64位长度，保证唯一。非企微场景不使用此字段
+   */
+  CustomApproverTag?: string
 }
 
 /**
@@ -826,6 +790,60 @@ export interface DescribeThirdPartyAuthCodeResponse {
   RequestId?: string
 }
 
+/**
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
+ */
+export interface FlowDetailInfo {
+  /**
+   * 合同(流程)的Id
+   */
+  FlowId: string
+
+  /**
+   * 合同(流程)的名字
+   */
+  FlowName: string
+
+  /**
+      * 合同(流程)的类型
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowType: string
+
+  /**
+      * 合同(流程)的状态
+1：未签署
+2：部分签署
+3：已退回
+4：完成签署
+5：已过期
+6：已取消
+      */
+  FlowStatus: number
+
+  /**
+      * 合同(流程)的信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowMessage: string
+
+  /**
+      * 流程的描述
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FlowDescription: string
+
+  /**
+   * 合同(流程)的创建时间戳
+   */
+  CreatedOn: number
+
+  /**
+   * 合同(流程)的签署人数组
+   */
+  FlowApproverInfos: Array<FlowApproverDetail>
+}
+
 /**
  * CreateFlowByFiles返回参数结构体
  */
@@ -997,6 +1015,28 @@ export interface UserInfo {
   ProxyIp?: string
 }
 
+/**
+ * 补充签署人信息
+ */
+export interface FillApproverInfo {
+  /**
+   * 签署人签署Id
+   */
+  RecipientId: string
+
+  /**
+      * 签署人来源
+WEWORKAPP: 企业微信
+      */
+  ApproverSource: string
+
+  /**
+      * 企业自定义账号Id
+WEWORKAPP场景下指企业自有应用获取企微明文的userid
+      */
+  CustomUserId: string
+}
+
 /**
  * 一码多扫签署二维码签署信息
  */
@@ -1147,6 +1187,21 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
    * 合同的强制预览时间：3~300s，未指定则按合同页数计算
    */
   PreReadTime?: number
+
+  /**
+   * 签署人userId，非企微场景不使用此字段
+   */
+  UserId?: string
+
+  /**
+   * 签署人用户来源,企微侧用户请传入：WEWORKAPP
+   */
+  ApproverSource?: string
+
+  /**
+   * 客户自定义签署人标识，64位长度，保证唯一，非企微场景不使用此字段
+   */
+  CustomApproverTag?: string
 }
 
 /**
@@ -1244,6 +1299,52 @@ export interface CreateBatchCancelFlowUrlResponse {
   RequestId?: string
 }
 
+/**
+ * UploadFiles请求参数结构体
+ */
+export interface UploadFilesRequest {
+  /**
+      * 文件对应业务类型，用于区分文件存储路径：
+1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
+2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
+3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
+      */
+  BusinessType: string
+
+  /**
+   * 调用方信息
+   */
+  Caller?: Caller
+
+  /**
+   * 上传文件内容数组，最多支持20个文件
+   */
+  FileInfos?: Array<UploadFile>
+
+  /**
+   * 不再使用，上传文件链接数组，最多支持20个URL
+   */
+  FileUrls?: string
+
+  /**
+      * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
+true--是，处理置白
+false--否，不处理
+      */
+  CoverRect?: boolean
+
+  /**
+      * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
+如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
+      */
+  FileType?: string
+
+  /**
+   * 用户自定义ID数组，与上传文件一一对应
+   */
+  CustomIds?: Array<string>
+}
+
 /**
  * StartFlow返回参数结构体
  */
@@ -1259,6 +1360,31 @@ export interface StartFlowResponse {
   RequestId?: string
 }
 
+/**
+ * GetTaskResultApi请求参数结构体
+ */
+export interface GetTaskResultApiRequest {
+  /**
+   * 任务Id，通过CreateConvertTaskApi得到
+   */
+  TaskId: string
+
+  /**
+   * 操作人信息
+   */
+  Operator?: UserInfo
+
+  /**
+   * 应用号信息
+   */
+  Agent?: Agent
+
+  /**
+   * 暂未开放
+   */
+  Organization?: OrganizationInfo
+}
+
 /**
  * 二期接口返回的模板中文件的信息结构
  */
@@ -1435,6 +1561,21 @@ export interface CreateConvertTaskApiRequest {
   Organization?: OrganizationInfo
 }
 
+/**
+ * DescribeFlowInfo返回参数结构体
+ */
+export interface DescribeFlowInfoResponse {
+  /**
+   * 签署流程信息
+   */
+  FlowDetailInfos: Array<FlowDetailInfo>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateSchemeUrl返回参数结构体
  */
@@ -1615,6 +1756,93 @@ DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
   ComponentName?: string
 }
 
+/**
+ * 签署人详情信息
+ */
+export interface FlowApproverDetail {
+  /**
+      * 签署人信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApproveMessage?: string
+
+  /**
+   * 签署人名字
+   */
+  ApproveName: string
+
+  /**
+      * 签署人的状态
+0：还没有发起
+1：流程中 没有开始处理
+2：待处理
+3：签署态
+4：拒绝态
+5：过期没人处理
+6：取消态
+7：还没有预发起
+8：待填写
+9：因为各种原因而终止
+      */
+  ApproveStatus: number
+
+  /**
+   * 模板配置时候的签署人id,与控件绑定
+   */
+  ReceiptId: string
+
+  /**
+      * 客户自定义userId
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CustomUserId: string
+
+  /**
+   * 签署人手机号
+   */
+  Mobile: string
+
+  /**
+   * 签署顺序
+   */
+  SignOrder: number
+
+  /**
+   * 签署人签署时间
+   */
+  ApproveTime: number
+
+  /**
+      * 参与者类型
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApproveType: string
+
+  /**
+      * 签署人侧用户来源
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ApproverSource: string
+
+  /**
+      * 客户自定义签署人标识
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CustomApproverTag: string
+
+  /**
+      * 签署人企业Id
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OrganizationId: string
+
+  /**
+      * 签署人企业名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OrganizationName: string
+}
+
 /**
  * DescribeFlowTemplates请求参数结构体
  */
@@ -1697,6 +1925,26 @@ ProcessTimeout - 转换文件超时
   RequestId?: string
 }
 
+/**
+ * CreateFlowApprovers请求参数结构体
+ */
+export interface CreateFlowApproversRequest {
+  /**
+   * 调用方用户信息，userId 必填
+   */
+  Operator: UserInfo
+
+  /**
+   * 签署流程编号
+   */
+  FlowId: string
+
+  /**
+   * 补充签署人信息
+   */
+  Approvers: Array<FillApproverInfo>
+}
+
 /**
  * 流程信息摘要
  */

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

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
+import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, UploadFilesRequest, StartFlowResponse, GetTaskResultApiRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, DescribeFlowInfoResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse, CreateFlowApproversRequest } from "./ess_models";
 /**
  * ess client
  * @class
@@ -11,6 +11,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
        */
     DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
+    /**
+       * 查询合同详情
+  适用场景：可用于主动查询某个合同详情信息。
+       */
+    DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
     /**
        * 此接口用于发起流程
   适用场景：见创建签署流程接口。
@@ -57,6 +62,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
        */
     CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
+    /**
+       * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
+  适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
+  适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
+  注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
+       */
+    CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
     /**
      * 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
      */
@@ -100,12 +112,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
     /**
-       * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
-  适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
-  适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
-  注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
+       * 补充签署流程本企业签署人信息
+  适用场景：在通过模版或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。
+  同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
+  
+  注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
        */
-    CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
+    CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
     /**
        * 此接口（UploadFiles）用于文件上传。
   适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。

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

@@ -34,6 +34,13 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeFileUrls(req, cb) {
         return this.request("DescribeFileUrls", req, cb);
     }
+    /**
+       * 查询合同详情
+  适用场景：可用于主动查询某个合同详情信息。
+       */
+    async DescribeFlowInfo(req, cb) {
+        return this.request("DescribeFlowInfo", req, cb);
+    }
     /**
        * 此接口用于发起流程
   适用场景：见创建签署流程接口。
@@ -96,6 +103,15 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateFlow(req, cb) {
         return this.request("CreateFlow", req, cb);
     }
+    /**
+       * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
+  适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
+  适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
+  注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
+       */
+    async CreateFlowByFiles(req, cb) {
+        return this.request("CreateFlowByFiles", req, cb);
+    }
     /**
      * 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
      */
@@ -153,13 +169,14 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeFlowBriefs", req, cb);
     }
     /**
-       * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
-  适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
-  适用场景2：可通过该接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
-  注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
+       * 补充签署流程本企业签署人信息
+  适用场景：在通过模版或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。
+  同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
+  
+  注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
        */
-    async CreateFlowByFiles(req, cb) {
-        return this.request("CreateFlowByFiles", req, cb);
+    async CreateFlowApprovers(req, cb) {
+        return this.request("CreateFlowApprovers", req, cb);
     }
     /**
        * 此接口（UploadFiles）用于文件上传。