tencentcloud-sdk-nodejs 4.0.413 → 4.0.416

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

@@ -262,7 +262,7 @@ export interface CreateFlowRequest {
   FlowName: string
 
   /**
-   * 签署流程参与者信息
+   * 签署流程参与者信息，最大限制50方
    */
   Approvers: Array<FlowCreateApprover>
 
@@ -310,6 +310,14 @@ false：有序签
    */
   CustomShowMap?: string
 
+  /**
+      * 发起方企业的签署人进行签署操作是否需要企业内部审批。
+若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+      */
+  NeedSignReview?: boolean
+
   /**
    * 暂未开放
    */
@@ -400,6 +408,21 @@ export interface DescribeThirdPartyAuthCodeRequest {
   AuthCode: string
 }
 
+/**
+ * 查询过滤条件
+ */
+export interface Filter {
+  /**
+   * 查询过滤条件的Key
+   */
+  Key: string
+
+  /**
+   * 查询过滤条件的Value列表
+   */
+  Values: Array<string>
+}
+
 /**
  * 一码多扫签署二维码对象
  */
@@ -425,24 +448,24 @@ export interface SignQrCode {
  */
 export interface GetTaskResultApiRequest {
   /**
-   * 任务Id
+   * 任务Id，通过CreateConvertTaskApi得到
    */
   TaskId: string
 
-  /**
-   * 企业信息
-   */
-  Organization?: OrganizationInfo
-
   /**
    * 操作人信息
    */
   Operator?: UserInfo
 
   /**
-   * 渠道信息
+   * 应用号信息
    */
   Agent?: Agent
+
+  /**
+   * 暂未开放
+   */
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -451,8 +474,8 @@ export interface GetTaskResultApiRequest {
 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
@@ -849,7 +872,7 @@ export interface DescribeFlowBriefsRequest {
   Operator: UserInfo
 
   /**
-   * 需要查询的流程ID列表
+   * 需要查询的流程ID列表，限制最大20个
    */
   FlowIds: Array<string>
 
@@ -1111,6 +1134,16 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   PreReadTime?: number
 }
 
+/**
+ * CreateFlowSignReview返回参数结构体
+ */
+export interface CreateFlowSignReviewResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 此结构体 (Caller) 用于描述调用方属性。
  */
@@ -1305,53 +1338,71 @@ export interface CreateConvertTaskApiResponse {
 }
 
 /**
- * 查询过滤条件
+ * CreateFlowSignReview请求参数结构体
  */
-export interface Filter {
+export interface CreateFlowSignReviewRequest {
   /**
-   * 查询过滤条件的Key
+   * 调用方用户信息，userId 必填
    */
-  Key: string
+  Operator: UserInfo
 
   /**
-   * 查询过滤条件的Value列表
+   * 签署流程编号
    */
-  Values: Array<string>
+  FlowId: string
+
+  /**
+      * 企业内部审核结果
+PASS: 通过 
+REJECT: 拒绝
+      */
+  ReviewType: string
+
+  /**
+      * 审核原因 
+当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
+      */
+  ReviewMessage?: string
+
+  /**
+   * 应用相关信息
+   */
+  Agent?: Agent
 }
 
 /**
  * CreateConvertTaskApi请求参数结构体
  */
 export interface CreateConvertTaskApiRequest {
-  /**
-   * 资源Id
-   */
-  ResourceId: string
-
   /**
    * 资源类型 取值范围doc,docx,html之一
    */
   ResourceType: string
 
   /**
-   * 资源名称
+   * 资源名称，长度限制为256字符
    */
   ResourceName: string
 
   /**
-   * 无
+   * 资源Id，通过UploadFiles获取
    */
-  Organization?: OrganizationInfo
+  ResourceId: string
 
   /**
-   * 无
+   * 操作者信息
    */
   Operator?: UserInfo
 
   /**
-   * 无
+   * 应用号信息
    */
   Agent?: Agent
+
+  /**
+   * 暂未开放
+   */
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -1384,7 +1435,7 @@ export interface CreateFlowByFilesRequest {
   FlowName: string
 
   /**
-   * 签署参与者信息
+   * 签署参与者信息，最大限制50方
    */
   Approvers: Array<ApproverInfo>
 
@@ -1439,6 +1490,14 @@ false：有序签
    */
   CustomShowMap?: string
 
+  /**
+      * 发起方企业的签署人进行签署操作是否需要企业内部审批。
+若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+      */
+  NeedSignReview?: boolean
+
   /**
    * 应用号信息
    */
@@ -1541,7 +1600,7 @@ export interface DescribeFlowTemplatesRequest {
   Filters?: Array<Filter>
 
   /**
-   * 查询个数，默认20，最大100
+   * 查询个数，默认20，最大200
    */
   Limit?: number
 
@@ -1576,17 +1635,29 @@ export interface GetTaskResultApiResponse {
   TaskId: string
 
   /**
-   * 任务状态
-   */
+      * 任务状态，需要关注的状态
+0  :NeedTranform   - 任务已提交
+4  :Processing     - 文档转换中
+8  :TaskEnd        - 任务处理完成
+-2 :DownloadFailed - 下载失败
+-6 :ProcessFailed  - 转换失败
+-13:ProcessTimeout - 转换文件超时
+      */
   TaskStatus: number
 
   /**
-   * 状态描述
-   */
+      * 状态描述，需要关注的状态
+NeedTranform   - 任务已提交
+Processing     - 文档转换中
+TaskEnd        - 任务处理完成
+DownloadFailed - 下载失败
+ProcessFailed  - 转换失败
+ProcessTimeout - 转换文件超时
+      */
   TaskMessage: string
 
   /**
-   * 资源Id
+   * 资源Id，也是FileId，用于文件发起使用
    */
   ResourceId: string
 

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

@@ -24,6 +24,7 @@ import {
   ChannelCreateConvertTaskApiResponse,
   OperateChannelTemplateRequest,
   TemplateInfo,
+  UploadFilesRequest,
   GetDownloadFlowUrlResponse,
   DescribeResourceUrlsByFlowsResponse,
   ChannelCreateMultiFlowSignQRCodeResponse,
@@ -36,7 +37,7 @@ import {
   AuthFailMessage,
   DescribeFlowDetailInfoRequest,
   ChannelGetTaskResultApiResponse,
-  UploadFilesRequest,
+  ProxyOrganizationOperator,
   ChannelGetTaskResultApiRequest,
   UploadFile,
   Component,
@@ -45,7 +46,7 @@ import {
   CreateConsoleLoginUrlRequest,
   OrganizationInfo,
   CreateFlowsByTemplatesResponse,
-  ProxyOrganizationOperator,
+  ChannelCreateFlowSignReviewRequest,
   PrepareFlowsRequest,
   SyncProxyOrganizationOperatorsResponse,
   CreateSealByImageResponse,
@@ -72,6 +73,7 @@ import {
   ChannelCreateFlowByFilesRequest,
   ChannelCreateFlowByFilesResponse,
   UploadFilesResponse,
+  ChannelCreateFlowSignReviewResponse,
   Agent,
   FormField,
   UserInfo,
@@ -93,6 +95,17 @@ export class Client extends AbstractClient {
     super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig)
   }
 
+  /**
+     * 此接口（UploadFiles）用于文件上传。
+调用时需要设置Domain 为 file.ess.tencent.cn
+     */
+  async UploadFiles(
+    req: UploadFilesRequest,
+    cb?: (error: string, rep: UploadFilesResponse) => void
+  ): Promise<UploadFilesResponse> {
+    return this.request("UploadFiles", req, cb)
+  }
+
   /**
      * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
 
@@ -115,15 +128,16 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
-当前接口限制最多合同（流程）50个.
+     * 提交企业签署流程审批结果
 
+在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
+若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
      */
-  async GetDownloadFlowUrl(
-    req: GetDownloadFlowUrlRequest,
-    cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void
-  ): Promise<GetDownloadFlowUrlResponse> {
-    return this.request("GetDownloadFlowUrl", req, cb)
+  async ChannelCreateFlowSignReview(
+    req: ChannelCreateFlowSignReviewRequest,
+    cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void
+  ): Promise<ChannelCreateFlowSignReviewResponse> {
+    return this.request("ChannelCreateFlowSignReview", req, cb)
   }
 
   /**
@@ -235,8 +249,8 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 指定需要批量撤回的签署流程Id，获取批量撤销链接
-客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
+     * 指定需要批量撤销的签署流程Id，获取批量撤销链接
+客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销
      */
   async ChannelCreateBatchCancelFlowUrl(
     req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -297,13 +311,14 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 此接口（UploadFiles）用于文件上传。
-调用时需要设置Domain 为 file.ess.tencent.cn
+     * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
+当前接口限制最多合同（流程）50个.
+
      */
-  async UploadFiles(
-    req: UploadFilesRequest,
-    cb?: (error: string, rep: UploadFilesResponse) => void
-  ): Promise<UploadFilesResponse> {
-    return this.request("UploadFiles", req, cb)
+  async GetDownloadFlowUrl(
+    req: GetDownloadFlowUrlRequest,
+    cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void
+  ): Promise<GetDownloadFlowUrlResponse> {
+    return this.request("GetDownloadFlowUrl", req, cb)
   }
 }

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

@@ -246,6 +246,33 @@ export interface TemplateInfo {
   CreatedOn: number
 }
 
+/**
+ * UploadFiles请求参数结构体
+ */
+export interface UploadFilesRequest {
+  /**
+   * 应用相关信息，若是渠道版调用 appid 和proxyappid 必填
+   */
+  Agent: Agent
+
+  /**
+      * 文件对应业务类型，用于区分文件存储路径：
+1. TEMPLATE - 模板； 文件类型：.pdf .doc .docx .html
+2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
+      */
+  BusinessType: string
+
+  /**
+   * 上传文件内容数组，最多支持20个文件
+   */
+  FileInfos?: Array<UploadFile>
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
+}
+
 /**
  * GetDownloadFlowUrl返回参数结构体
  */
@@ -617,17 +644,29 @@ export interface ChannelGetTaskResultApiResponse {
   TaskId: string
 
   /**
-   * 任务状态
-   */
+      * 任务状态，需要关注的状态
+0  :NeedTranform   - 任务已提交
+4  :Processing     - 文档转换中
+8  :TaskEnd        - 任务处理完成
+-2 :DownloadFailed - 下载失败
+-6 :ProcessFailed  - 转换失败
+-13:ProcessTimeout - 转换文件超时
+      */
   TaskStatus: number
 
   /**
-   * 状态描述
-   */
+      * 状态描述，需要关注的状态
+NeedTranform   - 任务已提交
+Processing     - 文档转换中
+TaskEnd        - 任务处理完成
+DownloadFailed - 下载失败
+ProcessFailed  - 转换失败
+ProcessTimeout - 转换文件超时
+      */
   TaskMessage: string
 
   /**
-   * 资源Id
+   * 资源Id，也是FileId，用于文件发起使用
    */
   ResourceId: string
 
@@ -638,30 +677,36 @@ export interface ChannelGetTaskResultApiResponse {
 }
 
 /**
- * UploadFiles请求参数结构体
+ * 合作企业经办人列表信息
  */
-export interface UploadFilesRequest {
+export interface ProxyOrganizationOperator {
   /**
-   * 应用相关信息，若是渠道版调用 appid 和proxyappid 必填
+   * 经办人ID（渠道颁发），最大长度64个字符
    */
-  Agent: Agent
+  Id: string
 
   /**
-      * 文件对应业务类型，用于区分文件存储路径：
-1. TEMPLATE - 模板； 文件类型：.pdf
-2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型：.pdf/.jpg/.png
+   * 经办人姓名，最大长度50个字符
+   */
+  Name?: string
+
+  /**
+      * 经办人身份证件类型
+1.ID_CARD 居民身份证
+2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
+3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
       */
-  BusinessType: string
+  IdCardType?: string
 
   /**
-   * 上传文件内容数组，最多支持20个文件
+   * 经办人证件号
    */
-  FileInfos?: Array<UploadFile>
+  IdCardNumber?: string
 
   /**
-   * 操作者的信息
+   * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
    */
-  Operator?: UserInfo
+  Mobile?: string
 }
 
 /**
@@ -669,24 +714,24 @@ export interface UploadFilesRequest {
  */
 export interface ChannelGetTaskResultApiRequest {
   /**
-   * 渠道信息
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
   Agent: Agent
 
   /**
-   * 任务Id
+   * 任务Id，通过ChannelCreateConvertTaskApi接口获得
    */
   TaskId: string
 
   /**
-   * 企业信息
+   * 操作者的信息
    */
-  Organization?: OrganizationInfo
+  Operator?: UserInfo
 
   /**
-   * 操作人信息
+   * 暂未开放
    */
-  Operator?: UserInfo
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -1018,36 +1063,31 @@ export interface CreateFlowsByTemplatesResponse {
 }
 
 /**
- * 合作企业经办人列表信息
+ * ChannelCreateFlowSignReview请求参数结构体
  */
-export interface ProxyOrganizationOperator {
+export interface ChannelCreateFlowSignReviewRequest {
   /**
-   * 经办人ID（渠道颁发），最大长度64个字符
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
-  Id: string
+  Agent: Agent
 
   /**
-   * 经办人姓名，最大长度50个字符
+   * 签署流程编号
    */
-  Name?: string
+  FlowId: string
 
   /**
-      * 经办人身份证件类型
-1.ID_CARD 居民身份证
-2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
-3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+      * 企业内部审核结果
+PASS: 通过
+REJECT: 拒绝
       */
-  IdCardType?: string
+  ReviewType: string
 
   /**
-   * 经办人证件号
-   */
-  IdCardNumber?: string
-
-  /**
-   * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
-   */
-  Mobile?: string
+      * 审核原因 
+当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
+      */
+  ReviewMessage?: string
 }
 
 /**
@@ -1393,17 +1433,17 @@ export interface UsageDetail {
  */
 export interface ChannelCreateBatchCancelFlowUrlResponse {
   /**
-   * 批量撤回url
+   * 批量撤销url
    */
   BatchCancelFlowUrl: string
 
   /**
-   * 签署流程批量撤回失败原因
+   * 签署流程批量撤销失败原因
    */
   FailMessages: Array<string>
 
   /**
-   * 签署撤回url过期时间-年月日-时分秒
+   * 签署撤销url过期时间-年月日-时分秒
    */
   UrlExpireOn: string
 
@@ -1594,7 +1634,7 @@ export interface ApproverRestriction {
  */
 export interface ChannelCreateFlowByFilesRequest {
   /**
-   * 渠道应用相关信息
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
   Agent?: Agent
 
@@ -1653,6 +1693,11 @@ export interface ChannelCreateFlowByFilesRequest {
    */
   CustomerData?: string
 
+  /**
+   * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。  注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+   */
+  NeedSignReview?: boolean
+
   /**
    * 操作者的信息
    */
@@ -1700,6 +1745,16 @@ export interface UploadFilesResponse {
   RequestId?: string
 }
 
+/**
+ * ChannelCreateFlowSignReview返回参数结构体
+ */
+export interface ChannelCreateFlowSignReviewResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 应用相关信息
  */
@@ -1794,34 +1849,34 @@ export interface UserInfo {
  */
 export interface ChannelCreateConvertTaskApiRequest {
   /**
-   * 无
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
   Agent: Agent
 
-  /**
-   * 资源Id
-   */
-  ResourceId: string
-
   /**
    * 资源类型 取值范围doc,docx,html之一
    */
   ResourceType: string
 
   /**
-   * 资源名称
+   * 资源名称，长度限制为256字符
    */
   ResourceName: string
 
   /**
-   * 无
+   * 资源Id，通过UploadFiles获取
    */
-  Organization?: OrganizationInfo
+  ResourceId: string
 
   /**
-   * 无
+   * 操作者信息
    */
   Operator?: UserInfo
+
+  /**
+   * 暂未开放
+   */
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -2007,6 +2062,14 @@ export interface FlowInfo {
    * 被抄送人的信息列表，抄送功能暂不开放
    */
   CcInfos?: Array<CcInfo>
+
+  /**
+      * 发起方企业的签署人进行签署操作是否需要企业内部审批。
+若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
+
+注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+      */
+  NeedSignReview?: boolean
 }
 
 /**

package/src/services/faceid/v20180301/faceid_models.ts

@@ -732,7 +732,7 @@ export interface GetEidTokenRequest {
 export interface IntentionQuestionResult {
   /**
       * 意愿核身最终结果：
-0：通过，-1：未通过
+0：认证通过，-1：认证未通过，-2：浏览器内核不兼容，无法进行意愿校验
 注意：此字段可能返回 null，表示取不到有效值。
       */
   FinalResultCode: string