tencentcloud-sdk-nodejs-ess 4.0.389 → 4.0.432

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

@@ -28,6 +28,19 @@ export interface CancelMultiFlowSignQRCodeRequest {
      */
     Agent?: Agent;
 }
+/**
+ * CreateFlowEvidenceReport返回参数结构体
+ */
+export interface CreateFlowEvidenceReportResponse {
+    /**
+     * 出证报告 URL（有效期5分钟）
+     */
+    ReportUrl: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeFileUrls返回参数结构体
  */
@@ -171,7 +184,7 @@ export interface CreateDocumentRequest {
      */
     TemplateId: string;
     /**
-     * 文件名列表,单个文件名最大长度200个字符
+     * 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起
      */
     FileNames: Array<string>;
     /**
@@ -205,7 +218,7 @@ export interface CreateFlowRequest {
      */
     FlowName: string;
     /**
-     * 签署流程参与者信息
+     * 签署流程参与者信息，最大限制50方
      */
     Approvers: Array<FlowCreateApprover>;
     /**
@@ -244,6 +257,13 @@ export interface CreateFlowRequest {
      * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
      */
     CustomShowMap?: string;
+    /**
+        * 发起方企业的签署人进行签署操作是否需要企业内部审批。
+  若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+  
+  注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        */
+    NeedSignReview?: boolean;
     /**
      * 暂未开放
      */
@@ -320,6 +340,19 @@ export interface DescribeThirdPartyAuthCodeRequest {
      */
     AuthCode: string;
 }
+/**
+ * 查询过滤条件
+ */
+export interface Filter {
+    /**
+     * 查询过滤条件的Key
+     */
+    Key: string;
+    /**
+     * 查询过滤条件的Value列表
+     */
+    Values: Array<string>;
+}
 /**
  * 一码多扫签署二维码对象
  */
@@ -337,14 +370,35 @@ export interface SignQrCode {
      */
     ExpiredTime: number;
 }
+/**
+ * GetTaskResultApi请求参数结构体
+ */
+export interface GetTaskResultApiRequest {
+    /**
+     * 任务Id，通过CreateConvertTaskApi得到
+     */
+    TaskId: string;
+    /**
+     * 操作人信息
+     */
+    Operator?: UserInfo;
+    /**
+     * 应用号信息
+     */
+    Agent?: Agent;
+    /**
+     * 暂未开放
+     */
+    Organization?: OrganizationInfo;
+}
 /**
  * UploadFiles请求参数结构体
  */
 export interface UploadFilesRequest {
     /**
         * 文件对应业务类型，用于区分文件存储路径：
-  1. TEMPLATE - 模板； 文件类型：.pdf/.html
-  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
+  1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
+  2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
   3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
         */
     BusinessType: string;
@@ -415,14 +469,22 @@ export interface DescribeFlowBriefsResponse {
  */
 export interface Component {
     /**
-        * 如果是 Component 控件类型，则可选类型为：
-  TEXT - 内容文本控件
-  DATE - 内容日期控件
-  CHECK_BOX - 勾选框控件
-  如果是 SignComponent 控件类型，则可选类型为：
-  SIGN_SEAL - 签署印章控件
-  SIGN_DATE - 签署日期控件
-  SIGN_SIGNATURE - 手写签名控件
+        * 如果是Component控件类型，则可选的字段为：
+  TEXT - 普通文本控件；
+  MULTI_LINE_TEXT - 多行文本控件；
+  CHECK_BOX - 勾选框控件；
+  FILL_IMAGE - 图片控件；
+  DYNAMIC_TABLE - 动态表格控件；
+  ATTACHMENT - 附件控件；
+  SELECTOR - 选择器控件；
+  
+  如果是SignComponent控件类型，则可选的字段为
+  SIGN_SEAL - 签署印章控件；
+  SIGN_DATE - 签署日期控件；
+  SIGN_SIGNATURE - 用户签名控件；
+  SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
+  
+  表单域的控件不能作为印章和签名控件
         */
     ComponentType: string;
     /**
@@ -478,8 +540,14 @@ export interface Component {
      */
     ComponentRecipientId?: string;
     /**
-     * 控件所填写的内容
-     */
+        * 控件填充vaule，ComponentType和传入值类型对应关系：
+  TEXT - 文本内容
+  MULTI_LINE_TEXT - 文本内容
+  CHECK_BOX - true/false
+  FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+  SELECTOR - 选项值
+  DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
+        */
     ComponentValue?: string;
     /**
      * 是否是表单域类型，默认不存在
@@ -512,6 +580,10 @@ export interface CreateMultiFlowSignQRCodeResponse {
      * 签署二维码对象
      */
     QrCode: SignQrCode;
+    /**
+     * 签署链接对象
+     */
+    SignUrls: SignUrl;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -628,6 +700,31 @@ export interface CreateFlowByFilesResponse {
      */
     RequestId?: string;
 }
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+    /**
+     * 机构在平台的编号
+     */
+    OrganizationId?: string;
+    /**
+     * 用户渠道
+     */
+    Channel?: string;
+    /**
+     * 用户在渠道的机构编号
+     */
+    OrganizationOpenId?: string;
+    /**
+     * 用户真实的IP
+     */
+    ClientIp?: string;
+    /**
+     * 机构的代理IP
+     */
+    ProxyIp?: string;
+}
 /**
  * DescribeFlowBriefs请求参数结构体
  */
@@ -637,7 +734,7 @@ export interface DescribeFlowBriefsRequest {
      */
     Operator: UserInfo;
     /**
-     * 需要查询的流程ID列表
+     * 需要查询的流程ID列表，限制最大20个
      */
     FlowIds: Array<string>;
     /**
@@ -702,6 +799,48 @@ export interface Recipient {
      */
     RecipientExtra?: string;
 }
+/**
+ * 用户信息
+ */
+export interface UserInfo {
+    /**
+     * 用户在平台的编号
+     */
+    UserId?: string;
+    /**
+     * 用户的来源渠道
+     */
+    Channel?: string;
+    /**
+     * 用户在渠道的编号
+     */
+    OpenId?: string;
+    /**
+     * 用户真实IP
+     */
+    ClientIp?: string;
+    /**
+     * 用户代理IP
+     */
+    ProxyIp?: string;
+}
+/**
+ * 一码多扫签署二维码签署信息
+ */
+export interface SignUrl {
+    /**
+     * 小程序签署链接
+     */
+    AppSignUrl: string;
+    /**
+     * 签署链接有效时间
+     */
+    EffectiveTime: string;
+    /**
+     * 移动端签署链接
+     */
+    HttpSignUrl: string;
+}
 /**
  * DescribeFileUrls请求参数结构体
  */
@@ -777,7 +916,7 @@ export interface ApproverInfo {
      */
     ApproverMobile: string;
     /**
-     * 本环节操作人签署控件配置，为企业静默签署时，只允许类型为SIGN_SEAL（印章）和SIGN_DATE（日期）控件，并且传入印章编号。
+     * 本环节操作人签署控件配置
      */
     SignComponents: Array<Component>;
     /**
@@ -812,6 +951,15 @@ export interface ApproverInfo {
      */
     PreReadTime?: number;
 }
+/**
+ * CreateFlowSignReview返回参数结构体
+ */
+export interface CreateFlowSignReviewResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 此结构体 (Caller) 用于描述调用方属性。
  */
@@ -851,17 +999,51 @@ export interface DescribeFlowTemplatesResponse {
     RequestId?: string;
 }
 /**
- * 查询过滤条件
+ * CreateFlowEvidenceReport请求参数结构体
  */
-export interface Filter {
+export interface CreateFlowEvidenceReportRequest {
     /**
-     * 查询过滤条件的Key
+     * 调用方用户信息，userId 必填
      */
-    Key: string;
+    Operator: UserInfo;
     /**
-     * 查询过滤条件的Value列表
+     * 签署流程编号
      */
-    Values: Array<string>;
+    FlowId: string;
+}
+/**
+ * CreateBatchCancelFlowUrl返回参数结构体
+ */
+export interface CreateBatchCancelFlowUrlResponse {
+    /**
+     * 批量撤回签署流程链接
+     */
+    BatchCancelFlowUrl: string;
+    /**
+     * 签署流程撤回失败信息
+     */
+    FailMessages: Array<string>;
+    /**
+     * 签署连接过期时间字符串：年月日-时分秒
+     */
+    UrlExpireOn: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * StartFlow返回参数结构体
+ */
+export interface StartFlowResponse {
+    /**
+     * 返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
+     */
+    Status: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * 二期接口返回的模板中文件的信息结构
@@ -884,6 +1066,19 @@ export interface FileInfo {
      */
     CreatedOn?: number;
 }
+/**
+ * CreateBatchCancelFlowUrl请求参数结构体
+ */
+export interface CreateBatchCancelFlowUrlRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
+    /**
+     * 需要执行撤回的签署流程id数组，最多100个
+     */
+    FlowIds: Array<string>;
+}
 /**
  * CreateMultiFlowSignQRCode请求参数结构体
  */
@@ -923,20 +1118,81 @@ export interface CreateMultiFlowSignQRCodeRequest {
      * 二维码有效天数 默认7天 最高设置不超过90天
      */
     QrEffectiveDay?: number;
+    /**
+     * 限制二维码用户条件
+     */
+    ApproverRestrictions?: ApproverRestriction;
 }
 /**
- * StartFlow返回参数结构体
+ * CreateConvertTaskApi返回参数结构体
  */
-export interface StartFlowResponse {
+export interface CreateConvertTaskApiResponse {
     /**
-     * 返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
+     * 转换任务Id
      */
-    Status: string;
+    TaskId: string;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
     RequestId?: string;
 }
+/**
+ * CreateFlowSignReview请求参数结构体
+ */
+export interface CreateFlowSignReviewRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
+    /**
+     * 签署流程编号
+     */
+    FlowId: string;
+    /**
+        * 企业内部审核结果
+  PASS: 通过
+  REJECT: 拒绝
+        */
+    ReviewType: string;
+    /**
+        * 审核原因
+  当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
+        */
+    ReviewMessage?: string;
+    /**
+     * 应用相关信息
+     */
+    Agent?: Agent;
+}
+/**
+ * CreateConvertTaskApi请求参数结构体
+ */
+export interface CreateConvertTaskApiRequest {
+    /**
+     * 资源类型 取值范围doc,docx,html之一
+     */
+    ResourceType: string;
+    /**
+     * 资源名称，长度限制为256字符
+     */
+    ResourceName: string;
+    /**
+     * 资源Id，通过UploadFiles获取
+     */
+    ResourceId: string;
+    /**
+     * 操作者信息
+     */
+    Operator?: UserInfo;
+    /**
+     * 应用号信息
+     */
+    Agent?: Agent;
+    /**
+     * 暂未开放
+     */
+    Organization?: OrganizationInfo;
+}
 /**
  * CreateSchemeUrl返回参数结构体
  */
@@ -963,11 +1219,11 @@ export interface CreateFlowByFilesRequest {
      */
     FlowName: string;
     /**
-     * 签署参与者信息
+     * 签署参与者信息，最大限制50方
      */
     Approvers: Array<ApproverInfo>;
     /**
-     * 签署pdf文件的资源编号列表，通过UploadFiles接口获取
+     * 签署pdf文件的资源编号列表，通过UploadFiles接口获取，暂时仅支持单文件发起
      */
     FileIds: Array<string>;
     /**
@@ -975,13 +1231,8 @@ export interface CreateFlowByFilesRequest {
      */
     FlowType?: string;
     /**
-        * 经办人内容控件配置。可选类型为：
-  TEXT - 内容文本控件
-  MULTI_LINE_TEXT - 多行文本控件
-  CHECK_BOX - 勾选框控件
-  ATTACHMENT - 附件
-  注：默认字体大小为 字号12
-        */
+     * 经办人内容控件配置
+     */
     Components?: Array<Component>;
     /**
         * 被抄送人的信息列表。
@@ -1013,11 +1264,39 @@ export interface CreateFlowByFilesRequest {
      * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
      */
     CustomShowMap?: string;
+    /**
+        * 发起方企业的签署人进行签署操作是否需要企业内部审批。
+  若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+  
+  注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+        */
+    NeedSignReview?: boolean;
     /**
      * 应用号信息
      */
     Agent?: Agent;
 }
+/**
+ * 指定签署人限制项
+ */
+export interface ApproverRestriction {
+    /**
+     * 指定签署人名字
+     */
+    Name?: string;
+    /**
+     * 指定签署人手机号
+     */
+    Mobile?: string;
+    /**
+     * 指定签署人证件类型
+     */
+    IdCardType?: string;
+    /**
+     * 指定签署人证件号码
+     */
+    IdCardNumber?: string;
+}
 /**
  * CancelMultiFlowSignQRCode返回参数结构体
  */
@@ -1049,15 +1328,21 @@ export declare type Agent = null;
  */
 export interface FormField {
     /**
-     * 控件填充value
-     */
+        * 控件填充vaule，ComponentType和传入值类型对应关系：
+  TEXT - 文本内容
+  MULTI_LINE_TEXT - 文本内容
+  CHECK_BOX - true/false
+  FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+  SELECTOR - 选项值
+  DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
+        */
     ComponentValue: string;
     /**
-     * 控件id
+     * 控件id，和ComponentName选择一项传入即可
      */
     ComponentId?: string;
     /**
-     * 控件名字，最大长度不超过30字符
+     * 控件名字，最大长度不超过30字符，和ComponentId选择一项传入即可
      */
     ComponentName?: string;
 }
@@ -1074,7 +1359,7 @@ export interface DescribeFlowTemplatesRequest {
      */
     Filters?: Array<Filter>;
     /**
-     * 查询个数，默认20，最大100
+     * 查询个数，默认20，最大200
      */
     Limit?: number;
     /**
@@ -1095,29 +1380,41 @@ export interface DescribeFlowTemplatesRequest {
     Agent?: Agent;
 }
 /**
- * 用户信息
+ * GetTaskResultApi返回参数结构体
  */
-export interface UserInfo {
-    /**
-     * 用户在平台的编号
-     */
-    UserId?: string;
+export interface GetTaskResultApiResponse {
     /**
-     * 用户的来源渠道
+     * 任务Id
      */
-    Channel?: string;
+    TaskId: string;
     /**
-     * 用户在渠道的编号
-     */
-    OpenId?: string;
+        * 任务状态，需要关注的状态
+  0  :NeedTranform   - 任务已提交
+  4  :Processing     - 文档转换中
+  8  :TaskEnd        - 任务处理完成
+  -2 :DownloadFailed - 下载失败
+  -6 :ProcessFailed  - 转换失败
+  -13:ProcessTimeout - 转换文件超时
+        */
+    TaskStatus: number;
+    /**
+        * 状态描述，需要关注的状态
+  NeedTranform   - 任务已提交
+  Processing     - 文档转换中
+  TaskEnd        - 任务处理完成
+  DownloadFailed - 下载失败
+  ProcessFailed  - 转换失败
+  ProcessTimeout - 转换文件超时
+        */
+    TaskMessage: string;
     /**
-     * 用户真实IP
+     * 资源Id，也是FileId，用于文件发起使用
      */
-    ClientIp?: string;
+    ResourceId: string;
     /**
-     * 用户代理IP
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    ProxyIp?: string;
+    RequestId?: string;
 }
 /**
  * 流程信息摘要
@@ -1142,12 +1439,17 @@ export interface FlowBrief {
     FlowType: string;
     /**
         * 流程状态
-  - `1` 未签署
+  - `0`  还没有发起
+  - `1`  未签署
   - `2`  部分签署
   - `3`  已退回
   - `4`  完成签署
   - `5`  已过期
   - `6`  已取消
+  - `7`  还没有预发起
+  - `8`  等待填写
+  - `9`  部分填写
+  - `10`  拒填
   注意：此字段可能返回 null，表示取不到有效值。
         */
     FlowStatus: number;