tencentcloud-sdk-nodejs 4.0.411 → 4.0.414

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

@@ -425,24 +425,24 @@ export interface SignQrCode {
  */
 export interface GetTaskResultApiRequest {
   /**
-   * 任务Id
+   * 任务Id，通过CreateConvertTaskApi得到
    */
   TaskId: string
 
-  /**
-   * 企业信息
-   */
-  Organization?: OrganizationInfo
-
   /**
    * 操作人信息
    */
   Operator?: UserInfo
 
   /**
-   * 渠道信息
+   * 应用号信息
    */
   Agent?: Agent
+
+  /**
+   * 暂未开放
+   */
+  Organization?: OrganizationInfo
 }
 
 /**
@@ -451,8 +451,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
@@ -536,16 +536,22 @@ export interface DescribeFlowBriefsResponse {
  */
 export interface Component {
   /**
-      * 如果是 Component 控件类型，则可选类型为：
-TEXT - 单行文本
-MULTI_LINE_TEXT - 多行文本
-CHECK_BOX - 勾选框
-ATTACHMENT - 附件
-SELECTOR - 选择器
-如果是 SignComponent 控件类型，则可选类型为：
-SIGN_SEAL - 签署印章控件，静默签署时需要传入印章id作为ComponentValue
-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
 
@@ -617,8 +623,9 @@ ESIGN -- 个人印章类型
 TEXT - 文本内容
 MULTI_LINE_TEXT - 文本内容
 CHECK_BOX - true/false
-ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
 SELECTOR - 选项值
+DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
       */
   ComponentValue?: string
 
@@ -842,7 +849,7 @@ export interface DescribeFlowBriefsRequest {
   Operator: UserInfo
 
   /**
-   * 需要查询的流程ID列表
+   * 需要查询的流程ID列表，限制最大20个
    */
   FlowIds: Array<string>
 
@@ -1316,35 +1323,35 @@ export interface Filter {
  * 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
 }
 
 /**
@@ -1498,12 +1505,13 @@ export type Agent = null
  */
 export interface FormField {
   /**
-      * 控件填充value，ComponentType和传入值类型对应关系：
+      * 控件填充vaule，ComponentType和传入值类型对应关系：
 TEXT - 文本内容
 MULTI_LINE_TEXT - 文本内容
 CHECK_BOX - true/false
-ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
-SELECTOR - 模板中配置的选项值
+FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取
+SELECTOR - 选项值
+DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
       */
   ComponentValue: string
 
@@ -1533,7 +1541,7 @@ export interface DescribeFlowTemplatesRequest {
   Filters?: Array<Filter>
 
   /**
-   * 查询个数，默认20，最大100
+   * 查询个数，默认20，最大200
    */
   Limit?: number
 
@@ -1568,17 +1576,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

@@ -21,8 +21,8 @@ import {
   ResourceUrlInfo,
   SyncProxyOrganizationResponse,
   FlowApproverInfo,
-  PrepareFlowsResponse,
-  ProxyOrganizationOperator,
+  ChannelCreateConvertTaskApiResponse,
+  OperateChannelTemplateRequest,
   TemplateInfo,
   GetDownloadFlowUrlResponse,
   DescribeResourceUrlsByFlowsResponse,
@@ -30,20 +30,22 @@ import {
   Recipient,
   DescribeTemplatesResponse,
   OperateChannelTemplateResponse,
+  CreateSignUrlsResponse,
   CreateSignUrlsRequest,
   ChannelCreateMultiFlowSignQRCodeRequest,
   AuthFailMessage,
   DescribeFlowDetailInfoRequest,
-  SignQrCode,
+  ChannelGetTaskResultApiResponse,
   UploadFilesRequest,
-  DescribeResourceUrlsByFlowsRequest,
+  ChannelGetTaskResultApiRequest,
   UploadFile,
   Component,
   GetDownloadFlowUrlRequest,
-  ChannelCreateBatchCancelFlowUrlResponse,
   FlowDetailInfo,
   CreateConsoleLoginUrlRequest,
+  OrganizationInfo,
   CreateFlowsByTemplatesResponse,
+  ProxyOrganizationOperator,
   PrepareFlowsRequest,
   SyncProxyOrganizationOperatorsResponse,
   CreateSealByImageResponse,
@@ -55,14 +57,15 @@ import {
   CreateFlowsByTemplatesRequest,
   SyncProxyOrganizationRequest,
   CreateSealByImageRequest,
-  UserInfo,
+  SignQrCode,
   DescribeUsageResponse,
   UsageDetail,
-  CreateSignUrlsResponse,
-  OperateChannelTemplateRequest,
+  ChannelCreateBatchCancelFlowUrlResponse,
+  DescribeResourceUrlsByFlowsRequest,
   DownloadFlowInfo,
   ChannelCancelMultiFlowSignQRCodeRequest,
   SyncFailReason,
+  PrepareFlowsResponse,
   DescribeUsageRequest,
   ChannelCreateBatchCancelFlowUrlRequest,
   ApproverRestriction,
@@ -71,6 +74,8 @@ import {
   UploadFilesResponse,
   Agent,
   FormField,
+  UserInfo,
+  ChannelCreateConvertTaskApiRequest,
   FlowApproverDetail,
   FlowInfo,
   SignUrlInfo,
@@ -99,6 +104,16 @@ export class Client extends AbstractClient {
     return this.request("CreateFlowsByTemplates", req, cb)
   }
 
+  /**
+   * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
+   */
+  async DescribeResourceUrlsByFlows(
+    req: DescribeResourceUrlsByFlowsRequest,
+    cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void
+  ): Promise<DescribeResourceUrlsByFlowsResponse> {
+    return this.request("DescribeResourceUrlsByFlows", req, cb)
+  }
+
   /**
      * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
 当前接口限制最多合同（流程）50个.
@@ -220,8 +235,8 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 指定需要批量撤回的签署流程Id，获取批量撤销链接
-客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
+     * 指定需要批量撤销的签署流程Id，获取批量撤销链接
+客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销
      */
   async ChannelCreateBatchCancelFlowUrl(
     req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -230,6 +245,16 @@ export class Client extends AbstractClient {
     return this.request("ChannelCreateBatchCancelFlowUrl", req, cb)
   }
 
+  /**
+   * 渠道创建文件转换任务
+   */
+  async ChannelCreateConvertTaskApi(
+    req: ChannelCreateConvertTaskApiRequest,
+    cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void
+  ): Promise<ChannelCreateConvertTaskApiResponse> {
+    return this.request("ChannelCreateConvertTaskApi", req, cb)
+  }
+
   /**
      * 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。
  注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
@@ -242,13 +267,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
+   * 渠道版查询转换任务状态
    */
-  async DescribeFlowDetailInfo(
-    req: DescribeFlowDetailInfoRequest,
-    cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void
-  ): Promise<DescribeFlowDetailInfoResponse> {
-    return this.request("DescribeFlowDetailInfo", req, cb)
+  async ChannelGetTaskResultApi(
+    req: ChannelGetTaskResultApiRequest,
+    cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void
+  ): Promise<ChannelGetTaskResultApiResponse> {
+    return this.request("ChannelGetTaskResultApi", req, cb)
   }
 
   /**
@@ -262,13 +287,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
+   * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
    */
-  async DescribeResourceUrlsByFlows(
-    req: DescribeResourceUrlsByFlowsRequest,
-    cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void
-  ): Promise<DescribeResourceUrlsByFlowsResponse> {
-    return this.request("DescribeResourceUrlsByFlows", req, cb)
+  async DescribeFlowDetailInfo(
+    req: DescribeFlowDetailInfoRequest,
+    cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void
+  ): Promise<DescribeFlowDetailInfoResponse> {
+    return this.request("DescribeFlowDetailInfo", req, cb)
   }
 
   /**