tencentcloud-sdk-nodejs 4.0.409 → 4.0.412

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
 }
@@ -670,6 +706,7 @@ export interface UploadFile {
 
 /**
  * 此结构体 (Component) 用于描述控件属性。
+
  */
 export interface Component {
   /**
@@ -689,12 +726,18 @@ export interface Component {
   /**
       * 如果是Component控件类型，则可选的字段为：
 TEXT - 普通文本控件；
-DATE - 普通日期控件；跟TEXT相比会有校验逻辑
+MULTI_LINE_TEXT - 多行文本控件；
+CHECK_BOX - 勾选框控件；
+FILL_IMAGE - 图片控件；
+DYNAMIC_TABLE - 动态表格控件；
+ATTACHMENT - 附件控件；
+SELECTOR - 选择器控件；
+
 如果是SignComponent控件类型，则可选的字段为
 SIGN_SEAL - 签署印章控件；
 SIGN_DATE - 签署日期控件；
 SIGN_SIGNATURE - 用户签名控件；
-SIGN_PERSONAL_SEAL - 个人签署印章控件；
+SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；
 
 表单域的控件不能作为印章和签名控件
       */
@@ -759,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
 
@@ -812,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)描述的是合同(流程)的详细信息
  */
@@ -933,6 +956,36 @@ export interface CreateConsoleLoginUrlRequest {
   Operator?: UserInfo
 }
 
+/**
+ * 机构信息
+ */
+export interface OrganizationInfo {
+  /**
+   * 用户在渠道的机构编号
+   */
+  OrganizationOpenId: string
+
+  /**
+   * 用户真实的IP
+   */
+  ClientIp: string
+
+  /**
+   * 机构的代理IP
+   */
+  ProxyIp: string
+
+  /**
+   * 机构在平台的编号
+   */
+  OrganizationId?: string
+
+  /**
+   * 用户渠道
+   */
+  Channel?: string
+}
+
 /**
  * CreateFlowsByTemplates返回参数结构体
  */
@@ -964,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请求参数结构体
  */
@@ -1229,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
 }
 
 /**
@@ -1313,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。
@@ -1333,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>
 
   /**
    * 操作者的信息
@@ -1419,6 +1486,21 @@ export interface SyncFailReason {
   Message: string
 }
 
+/**
+ * PrepareFlows返回参数结构体
+ */
+export interface PrepareFlowsResponse {
+  /**
+   * 待发起文件确认页
+   */
+  ConfirmUrl: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DescribeUsage请求参数结构体
  */
@@ -1650,11 +1732,18 @@ export interface Agent {
 
 /**
  * 此结构 (FormField) 用于描述内容控件填充结构。
+
  */
 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
 
   /**
@@ -1670,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
+}
+
 /**
  * 签署人的流程信息明细
  */
@@ -1737,6 +1891,66 @@ export interface FlowApproverDetail {
 
 /**
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
+
+【动态表格传参说明】
+当模板的 ComponentType='DYNAMIC_TABLE'时（渠道版），FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充动态表格（支持内容的单元格合并）
+输入示例
+
+```
+{
+    "headers":[
+        {
+            "content":"head1"
+        },
+        {
+            "content":"head2"
+        },
+        {
+            "content":"head3"
+        }
+    ],
+    "rowCount":3,
+    "body":{
+        "cells":[
+            {
+                "rowStart":1,
+                "rowEnd":1,
+                "columnStart":1,
+                "columnEnd":1,
+                "content":"123"
+            },
+            {
+                "rowStart":2,
+                "rowEnd":3,
+                "columnStart":1,
+                "columnEnd":2,
+                "content":"456"
+            },
+            {
+                "rowStart":3,
+                "rowEnd":3,
+                "columnStart":3,
+                "columnEnd":3,
+                "content":"789"
+            }
+        ]
+    }
+}
+
+```
+
+表格参数说明
+
+| 名称                | 类型    | 描述                                              |
+| ------------------- | ------- | ------------------------------------------------- |
+| headers             | Array   | 表头：不超过10列，不支持单元格合并，字数不超过100 |
+| rowCount            | Integer | 表格内容最大行数                                  |
+| cells.N.rowStart    | Integer | 单元格坐标：行起始index                           |
+| cells.N.rowEnd      | Integer | 单元格坐标：行结束index                           |
+| cells.N.columnStart | Integer | 单元格坐标：列起始index                           |
+| cells.N.columnEnd   | Integer | 单元格坐标：列结束index                           |
+| cells.N.content     | String  | 单元格内容，字数不超过100                         |
+
  */
 export interface FlowInfo {
   /**

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

@@ -395,9 +395,19 @@ export interface GetEidTokenConfig {
   UseIntentionVerify?: boolean
 
   /**
-   * 意愿核身使用的文案，若未使用意愿核身功能，该字段无需传入。默认为空，最长可接受120的字符串长度。
+   * 意愿核身模式。枚举值：1( 朗读模式)，2（问答模式） 。默认值1
+   */
+  IntentionMode?: string
+
+  /**
+   * 意愿核身朗读模式使用的文案，若未使用意愿核身朗读功能，该字段无需传入。默认为空，最长可接受120的字符串长度。
    */
   IntentionVerifyText?: string
+
+  /**
+   * 意愿核身问答模式的配置列表。当前仅支持一个问答。
+   */
+  IntentionQuestions?: Array<IntentionQuestion>
 }
 
 /**
@@ -607,7 +617,7 @@ export interface GetEidResultRequest {
   EidToken: string
 
   /**
-      * 指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证信息；3：最佳截图信息；5：意愿核身相关结果；）。
+      * 指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证信息；3：最佳截图信息；5：意愿核身朗读模式相关结果；6：意愿核身问答模式相关结果）。
 如 13表示拉取文本类、最佳截图信息。
 默认值：0
       */
@@ -1874,11 +1884,17 @@ export interface GetEidResultResponse {
   EidInfo: EidInfo
 
   /**
-      * 意愿核身相关信息。若未使用意愿核身功能，该字段返回值可以不处理。
+      * 意愿核身朗读模式相关信息。若未使用意愿核身朗读功能，该字段返回值可以不处理。
 注意：此字段可能返回 null，表示取不到有效值。
       */
   IntentionVerifyData: IntentionVerifyData
 
+  /**
+      * 意愿核身问答模式相关信息。若未使用意愿核身问答模式功能，该字段返回值可以不处理。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IntentionQuestionResult: IntentionQuestionResult
+
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

package/src/services/gaap/v20180529/gaap_models.ts

@@ -5815,7 +5815,7 @@ export interface ProxyInfo {
   Bandwidth: number
 
   /**
-   * 并发，单位：个/秒。
+   * 并发，单位：万个/秒。
    */
   Concurrent: number
 

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