tencentcloud-sdk-nodejs 4.0.411 → 4.0.412

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个.
@@ -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)
   }
 
   /**

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

@@ -142,13 +142,13 @@ ENTERPRISESERVER-企业静默签;
 }
 
 /**
- * PrepareFlows返回参数结构体
+ * ChannelCreateConvertTaskApi返回参数结构体
  */
-export interface PrepareFlowsResponse {
+export interface ChannelCreateConvertTaskApiResponse {
   /**
-   * 待发起文件确认页
+   * 任务id
    */
-  ConfirmUrl: string
+  TaskId: string
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -157,36 +157,38 @@ export interface PrepareFlowsResponse {
 }
 
 /**
- * 合作企业经办人列表信息
+ * OperateChannelTemplate请求参数结构体
  */
-export interface ProxyOrganizationOperator {
+export interface OperateChannelTemplateRequest {
   /**
-   * 经办人ID（渠道颁发），最大长度64个字符
+   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
    */
-  Id: string
+  Agent: Agent
 
   /**
-   * 经办人姓名，最大长度50个字符
+   * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
    */
-  Name?: string
+  OperateType: string
 
   /**
-      * 经办人身份证件类型
-1.ID_CARD 居民身份证
-2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
-3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
-      */
-  IdCardType?: string
+   * 渠道方模板库模板唯一标识
+   */
+  TemplateId: string
 
   /**
-   * 经办人证件号
+   * 合作企业方第三方机构唯一标识数据，支持多个， 用","进行分隔
    */
-  IdCardNumber?: string
+  ProxyOrganizationOpenIds?: string
 
   /**
-   * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
+   * 模板可见性, 全部可见-"all", 部分可见-"part"
    */
-  Mobile?: string
+  AuthTag?: string
+
+  /**
+   * 操作者的信息
+   */
+  Operator?: UserInfo
 }
 
 /**
@@ -426,6 +428,26 @@ export interface OperateChannelTemplateResponse {
   RequestId?: string
 }
 
+/**
+ * CreateSignUrls返回参数结构体
+ */
+export interface CreateSignUrlsResponse {
+  /**
+   * 签署参与者签署H5链接信息数组
+   */
+  SignUrlInfos: Array<SignUrlInfo>
+
+  /**
+   * 生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
+   */
+  ErrorMessages: Array<string>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateSignUrls请求参数结构体
  */
@@ -586,23 +608,33 @@ export interface DescribeFlowDetailInfoRequest {
 }
 
 /**
- * 一码多扫签署二维码对象
+ * ChannelGetTaskResultApi返回参数结构体
  */
-export interface SignQrCode {
+export interface ChannelGetTaskResultApiResponse {
   /**
-   * 二维码id
+   * 任务Id
    */
-  QrCodeId: string
+  TaskId: string
 
   /**
-   * 二维码url
+   * 任务状态
    */
-  QrCodeUrl: string
+  TaskStatus: number
 
   /**
-   * 二维码过期时间
+   * 状态描述
    */
-  ExpiredTime: number
+  TaskMessage: string
+
+  /**
+   * 资源Id
+   */
+  ResourceId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -633,22 +665,26 @@ export interface UploadFilesRequest {
 }
 
 /**
- * DescribeResourceUrlsByFlows请求参数结构体
+ * ChannelGetTaskResultApi请求参数结构体
  */
-export interface DescribeResourceUrlsByFlowsRequest {
+export interface ChannelGetTaskResultApiRequest {
   /**
-      * 渠道应用相关信息。
-此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
-      */
+   * 渠道信息
+   */
   Agent: Agent
 
   /**
-   * 查询资源所对应的签署流程Id，最多支持50个。
+   * 任务Id
    */
-  FlowIds?: Array<string>
+  TaskId: string
 
   /**
-   * 操作者的信息
+   * 企业信息
+   */
+  Organization?: OrganizationInfo
+
+  /**
+   * 操作人信息
    */
   Operator?: UserInfo
 }
@@ -690,13 +726,18 @@ export interface Component {
   /**
       * 如果是Component控件类型，则可选的字段为：
 TEXT - 普通文本控件；
-DATE - 普通日期控件；跟TEXT相比会有校验逻辑
-DYNAMIC_TABLE-动态表格控件；
+MULTI_LINE_TEXT - 多行文本控件；
+CHECK_BOX - 勾选框控件；
+FILL_IMAGE - 图片控件；
+DYNAMIC_TABLE - 动态表格控件；
+ATTACHMENT - 附件控件；
+SELECTOR - 选择器控件；
+
 如果是SignComponent控件类型，则可选的字段为
 SIGN_SEAL - 签署印章控件；
 SIGN_DATE - 签署日期控件；
 SIGN_SIGNATURE - 用户签名控件；
-SIGN_PERSONAL_SEAL - 个人签署印章控件；
+SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
 
 表单域的控件不能作为印章和签名控件
       */
@@ -761,8 +802,13 @@ TEXT控件可以指定字体
   ComponentExtra?: string
 
   /**
-      * 印章 ID，传参 DEFAULT_COMPANY_SEAL 表示使用默认印章。
-控件填入内容，印章控件里面，如果是手写签名内容为PNG图片格式的base64编码
+      * 控件填充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
 
@@ -814,31 +860,6 @@ export interface GetDownloadFlowUrlRequest {
   Operator?: UserInfo
 }
 
-/**
- * ChannelCreateBatchCancelFlowUrl返回参数结构体
- */
-export interface ChannelCreateBatchCancelFlowUrlResponse {
-  /**
-   * 批量撤回url
-   */
-  BatchCancelFlowUrl: string
-
-  /**
-   * 签署流程批量撤回失败原因
-   */
-  FailMessages: Array<string>
-
-  /**
-   * 签署撤回url过期时间-年月日-时分秒
-   */
-  UrlExpireOn: string
-
-  /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
-}
-
 /**
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
  */
@@ -935,6 +956,36 @@ export interface CreateConsoleLoginUrlRequest {
   Operator?: UserInfo
 }
 
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+  /**
+   * 用户在渠道的机构编号
+   */
+  OrganizationOpenId: string
+
+  /**
+   * 用户真实的IP
+   */
+  ClientIp: string
+
+  /**
+   * 机构的代理IP
+   */
+  ProxyIp: string
+
+  /**
+   * 机构在平台的编号
+   */
+  OrganizationId?: string
+
+  /**
+   * 用户渠道
+   */
+  Channel?: string
+}
+
 /**
  * CreateFlowsByTemplates返回参数结构体
  */
@@ -966,6 +1017,39 @@ export interface CreateFlowsByTemplatesResponse {
   RequestId?: string
 }
 
+/**
+ * 合作企业经办人列表信息
+ */
+export interface ProxyOrganizationOperator {
+  /**
+   * 经办人ID（渠道颁发），最大长度64个字符
+   */
+  Id: string
+
+  /**
+   * 经办人姓名，最大长度50个字符
+   */
+  Name?: string
+
+  /**
+      * 经办人身份证件类型
+1.ID_CARD 居民身份证
+2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
+3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
+      */
+  IdCardType?: string
+
+  /**
+   * 经办人证件号
+   */
+  IdCardNumber?: string
+
+  /**
+   * 经办人手机号，大陆手机号输入11位，暂不支持海外手机号。
+   */
+  Mobile?: string
+}
+
 /**
  * PrepareFlows请求参数结构体
  */
@@ -1231,33 +1315,23 @@ export interface CreateSealByImageRequest {
 }
 
 /**
- * 接口调用者信息
+ * 一码多扫签署二维码对象
  */
-export interface UserInfo {
-  /**
-   * 用户在渠道的编号，最大64位字符串
-   */
-  OpenId?: string
-
-  /**
-   * 用户的来源渠道
-   */
-  Channel?: string
-
+export interface SignQrCode {
   /**
-   * 自定义用户编号
+   * 二维码id
    */
-  CustomUserId?: string
+  QrCodeId: string
 
   /**
-   * 用户真实IP
+   * 二维码url
    */
-  ClientIp?: string
+  QrCodeUrl: string
 
   /**
-   * 用户代理IP
+   * 二维码过期时间
    */
-  ProxyIp?: string
+  ExpiredTime: number
 }
 
 /**
@@ -1315,18 +1389,23 @@ export interface UsageDetail {
 }
 
 /**
- * CreateSignUrls返回参数结构体
+ * ChannelCreateBatchCancelFlowUrl返回参数结构体
  */
-export interface CreateSignUrlsResponse {
+export interface ChannelCreateBatchCancelFlowUrlResponse {
   /**
-   * 签署参与者签署H5链接信息数组
+   * 批量撤回url
    */
-  SignUrlInfos: Array<SignUrlInfo>
+  BatchCancelFlowUrl: string
 
   /**
-   * 生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
+   * 签署流程批量撤回失败原因
    */
-  ErrorMessages: Array<string>
+  FailMessages: Array<string>
+
+  /**
+   * 签署撤回url过期时间-年月日-时分秒
+   */
+  UrlExpireOn: string
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1335,33 +1414,19 @@ export interface CreateSignUrlsResponse {
 }
 
 /**
- * OperateChannelTemplate请求参数结构体
+ * DescribeResourceUrlsByFlows请求参数结构体
  */
-export interface OperateChannelTemplateRequest {
+export interface DescribeResourceUrlsByFlowsRequest {
   /**
-   * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
-   */
+      * 渠道应用相关信息。
+此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
+      */
   Agent: Agent
 
   /**
-   * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
-   */
-  OperateType: string
-
-  /**
-   * 渠道方模板库模板唯一标识
-   */
-  TemplateId: string
-
-  /**
-   * 合作企业方第三方机构唯一标识数据，支持多个， 用","进行分隔
-   */
-  ProxyOrganizationOpenIds?: string
-
-  /**
-   * 模板可见性, 全部可见-"all", 部分可见-"part"
+   * 查询资源所对应的签署流程Id，最多支持50个。
    */
-  AuthTag?: string
+  FlowIds?: Array<string>
 
   /**
    * 操作者的信息
@@ -1421,6 +1486,21 @@ export interface SyncFailReason {
   Message: string
 }
 
+/**
+ * PrepareFlows返回参数结构体
+ */
+export interface PrepareFlowsResponse {
+  /**
+   * 待发起文件确认页
+   */
+  ConfirmUrl: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeUsage请求参数结构体
  */
@@ -1656,8 +1736,14 @@ export interface Agent {
  */
 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
 
   /**
@@ -1673,6 +1759,71 @@ export interface FormField {
   ComponentName?: string
 }
 
+/**
+ * 接口调用者信息
+ */
+export interface UserInfo {
+  /**
+   * 用户在渠道的编号，最大64位字符串
+   */
+  OpenId?: string
+
+  /**
+   * 用户的来源渠道
+   */
+  Channel?: string
+
+  /**
+   * 自定义用户编号
+   */
+  CustomUserId?: string
+
+  /**
+   * 用户真实IP
+   */
+  ClientIp?: string
+
+  /**
+   * 用户代理IP
+   */
+  ProxyIp?: string
+}
+
+/**
+ * ChannelCreateConvertTaskApi请求参数结构体
+ */
+export interface ChannelCreateConvertTaskApiRequest {
+  /**
+   * 无
+   */
+  Agent: Agent
+
+  /**
+   * 资源Id
+   */
+  ResourceId: string
+
+  /**
+   * 资源类型 取值范围doc,docx,html之一
+   */
+  ResourceType: string
+
+  /**
+   * 资源名称
+   */
+  ResourceName: string
+
+  /**
+   * 无
+   */
+  Organization?: OrganizationInfo
+
+  /**
+   * 无
+   */
+  Operator?: UserInfo
+}
+
 /**
  * 签署人的流程信息明细
  */

package/src/services/iai/v20180301/iai_models.ts

@@ -54,7 +54,7 @@ export interface Candidate {
   PersonId: string
 
   /**
-   * 人脸ID
+   * 人脸ID，仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。人员搜索类接口采用融合特征方式检索，该字段无意义
    */
   FaceId: string
 
@@ -1538,7 +1538,7 @@ MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要
 
   /**
       * 被检测到的人脸，对应最多返回的最相似人员数目。默认值为5，最大值为10。  
-例，设MaxFaceNum为3，MaxPersonNum为5，则最多可能返回3*5=15个人员。
+例，设MaxFaceNum为3，MaxPersonNumPerGroup为5，GroupIds长度为3，则最多可能返回3*5*3=45个人员。
       */
   MaxPersonNumPerGroup?: number