tencentcloud-sdk-nodejs 4.0.673 → 4.0.675

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

@@ -717,7 +717,8 @@ export interface DescribeIntegrationRolesRequest {
    * 查询的关键字段:
 Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
 Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
-Key:"IsGroupRole"，Values:["0"],查询非集团角色，Values:["1"]表示查询集团角色
+Key:"IsGroupRole"，Values:["0"]:查询非集团角色，Values:["1"]表示查询集团角色
+Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段
    */
   Filters?: Array<Filter>
   /**
@@ -867,8 +868,7 @@ export interface CreateConvertTaskApiRequest {
    */
   Operator?: UserInfo
   /**
-   * 应用号信息
-   * @deprecated
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
@@ -1654,6 +1654,67 @@ export interface DescribeIntegrationDepartmentsRequest {
   DeptOpenId?: string
 }
 
+/**
+ * 权限树节点权限
+ */
+export interface Permission {
+  /**
+   * 权限名称
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Name?: string
+  /**
+   * 权限key
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Key?: string
+  /**
+   * 权限类型 1前端，2后端
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Type?: number
+  /**
+   * 是否隐藏
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Hide?: number
+  /**
+   * 数据权限标签 1:表示根节点，2:表示叶子结点
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  DataLabel?: number
+  /**
+   * 数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  DataType?: number
+  /**
+   * 数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  DataRange?: number
+  /**
+   * 关联权限, 表示这个功能权限要受哪个数据权限管控
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  DataTo?: string
+  /**
+   * 父级权限key
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  ParentKey?: string
+  /**
+   * 是否选中
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  IsChecked?: boolean
+  /**
+   * 子权限集合
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Children?: Array<Permission>
+}
+
 /**
  * CreateIntegrationDepartment返回参数结构体
  */
@@ -2375,8 +2436,8 @@ export interface DescribeFileUrlsRequest {
    */
   Scene?: string
   /**
-   * 应用相关信息
-   * @deprecated
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -3173,8 +3234,7 @@ export interface GetTaskResultApiRequest {
    */
   Operator?: UserInfo
   /**
-   * 应用号信息
-   * @deprecated
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
@@ -3579,6 +3639,10 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
    * 身份证件号码
    */
   IdCardNumber: string
+  /**
+   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   */
+  Agent?: Agent
 }
 
 /**
@@ -3750,7 +3814,7 @@ export interface FailedCreateRoleData {
 }
 
 /**
- * 参与者信息
+ * 参与者信息。
  */
 export interface ApproverInfo {
   /**
@@ -4234,6 +4298,11 @@ export interface IntegrateRole {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   SubOrgIdList?: Array<string>
+  /**
+   * 权限树
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  PermissionGroups?: Array<PermissionGroup>
 }
 
 /**
@@ -4638,6 +4707,46 @@ LEGAL_PERSON_SEAL：法定代表人章
    * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
+  /**
+   * 查询的印章状态列表。
+取值为空，只查询启用状态的印章；
+取值ALL，查询所有状态的印章；
+取值CHECKING，查询待审核的印章；
+取值SUCCESS，查询启用状态的印章；
+取值FAIL，查询印章审核拒绝的印章；
+取值DISABLE，查询已停用的印章；
+取值STOPPED，查询已终止的印章；
+取值VOID，查询已作废的印章；
+取值INVALID，查询以失效的印章；
+
+   */
+  SealStatuses?: Array<string>
+}
+
+/**
+ * 权限树中的权限组
+ */
+export interface PermissionGroup {
+  /**
+   * 权限组名称
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  GroupName?: string
+  /**
+   * 权限组key
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  GroupKey?: string
+  /**
+   * 是否隐藏分组，0否1是
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Hide?: number
+  /**
+   * 权限集合
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Permissions?: Array<Permission>
 }
 
 /**
@@ -5123,7 +5232,7 @@ export interface VerifyPdfResponse {
    */
   VerifyResult?: number
   /**
-   * 验签结果详情,内部状态1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域；5-文件签名格式错误
+   * 验签结果详情，每个签名域对应的验签结果。状态值：1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域；5-文件签名格式错误
    */
   PdfVerifyResults?: Array<PdfVerifyResult>
   /**
@@ -5417,13 +5526,15 @@ export interface CreateMultiFlowSignQRCodeRequest {
    */
   UserData?: string
   /**
-   * 回调地址,最大长度1000字符串
-<br/>回调时机：用户通过签署二维码发起签署流程时，企业额度不足导致失败
+   * 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置 
+<br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
+<br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
+
+   * @deprecated
    */
   CallbackUrl?: string
   /**
-   * 应用信息
-   * @deprecated
+   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
   /**
@@ -5580,62 +5691,60 @@ export interface FileUrl {
 }
 
 /**
- * 流程信息摘要
+ * 合同流程的基础信息
  */
 export interface FlowBrief {
   /**
-   * 流程的编号ID
+   * 合同流程ID，为32位字符串。
    */
   FlowId?: string
   /**
-   * 流程的名称
+   * 合同流程的名称。
    */
   FlowName?: string
   /**
-   * 流程的描述信息
+   * 合同流程描述信息。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowDescription?: string
   /**
-   * 流程的类型
+   * 合同流程的类别分类（如销售合同/入职合同等）。
    */
   FlowType?: string
   /**
-   * 流程状态
-- 0 还没有发起
-- 1 待签署
-- 2 部分签署
-- 3 已拒签
-- 4 已签署
-- 5 已过期
-- 6 已撤销
-- 7 还没有预发起
-- 8 等待填写
-- 9 部分填写
-- 10 拒填
-- 21 已解除
+   * 合同流程当前的签署状态, 会存在下列的状态值
+<ul><li> **0** : 未开启流程(合同中不存在填写环节)</li>
+<li> **1** : 待签署</li>
+<li> **2** : 部分签署</li>
+<li> **3** : 已拒签</li>
+<li> **4** : 已签署</li>
+<li> **5** : 已过期</li>
+<li> **6** : 已撤销</li>
+<li> **7** : 未开启流程(合同中存在填写环节)</li>
+<li> **8** : 等待填写</li>
+<li> **9** : 部分填写</li>
+<li> **10** : 已拒填</li>
+<li> **21** : 已解除</li></ul>
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowStatus?: number
   /**
-   * 流程创建的时间戳，单位秒
+   * 合同流程创建时间，格式为Unix标准时间戳（秒）。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   CreatedOn?: number
   /**
-   * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
-此字段展示拒签或者取消的原因描述
-
+   * 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowMessage?: string
   /**
-   *  合同发起人userId
+   *  合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Creator?: string
   /**
-   * 合同过期时间，时间戳，单位秒
+   * 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Deadline?: number

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

@@ -218,6 +218,11 @@ export class Client extends AbstractClient {
 - 模板中配置的签署顺序是无序
 - B端企业的签署方式是静默签署
 - B端企业是非首位签署
+
+通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
+
+用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
      */
   async ChannelCreateMultiFlowSignQRCode(
     req: ChannelCreateMultiFlowSignQRCodeRequest,

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

@@ -816,6 +816,10 @@ export interface BaseFlowInfo {
 <br/>当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
    */
   NeedCreateReview?: boolean
+  /**
+   * 填写控件：文件发起使用
+   */
+  Components?: Array<Component>
 }
 
 /**
@@ -1006,7 +1010,7 @@ export interface ChannelCreatePrepareFlowRequest {
    */
   ResourceId: string
   /**
-   * 资源类型，1：模板，目前仅支持模板，与ResourceId对应
+   * 资源类型，与ResourceId对应1：模板   2: 文件
    */
   ResourceType: number
   /**
@@ -2142,6 +2146,10 @@ export interface CommonFlowApprover {
    * 签署人配置
    */
   ApproverOption?: CommonApproverOption
+  /**
+   * 签署控件：文件发起使用
+   */
+  SignComponents?: Array<Component>
 }
 
 /**
@@ -2940,9 +2948,10 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
    */
   Restrictions?: Array<ApproverRestriction>
   /**
-   * 回调地址，最大长度1000个字符
-不传默认使用第三方应用号配置的回调地址
-回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
+   * 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
+<br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
+<br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
+   * @deprecated
    */
   CallbackUrl?: string
   /**
@@ -2986,7 +2995,7 @@ export interface SignQrCode {
 4-非第三方平台子客企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
 
 RecipientId参数：
-从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId
+从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId。
  */
 export interface FlowApproverInfo {
   /**

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

@@ -2436,32 +2436,33 @@ export interface IntentionVerifyData {
    * 意愿确认环节中录制的视频（base64）。若不存在则为空字符串。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  IntentionVerifyVideo: string
+  IntentionVerifyVideo?: string
   /**
    * 意愿确认环节中用户语音转文字的识别结果。若不存在则为空字符串。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  AsrResult: string
+  AsrResult?: string
   /**
    * 意愿确认环节的结果码。当该结果码为0时，语音朗读的视频与语音识别结果才会返回。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ErrorCode: number
+  ErrorCode?: number
   /**
    * 意愿确认环节的结果信息。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ErrorMessage: string
+  ErrorMessage?: string
   /**
    * 意愿确认环节中录制视频的最佳帧（base64）。若不存在则为空字符串。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  IntentionVerifyBestFrame: string
+  IntentionVerifyBestFrame?: string
   /**
    * 本次流程用户语音与传入文本比对的相似度分值，取值范围 [0.00, 100.00]。只有配置了相似度阈值后才进行语音校验并返回相似度分值。
 注意：此字段可能返回 null，表示取不到有效值。
+   * @deprecated
    */
-  AsrResultSimilarity: string
+  AsrResultSimilarity?: string
 }
 
 /**

package/src/services/iss/v20230517/iss_client.ts

@@ -25,6 +25,7 @@ import {
   DescribeDeviceChannelData,
   ListOrganizationChannelsRequest,
   DescribeDevicePresetData,
+  ListSubTasksRequest,
   DescribeGatewayMonitor,
   DescribeAITaskResultRequest,
   DescribeCNAMERequest,
@@ -32,6 +33,7 @@ import {
   DeleteOrganizationRequest,
   OperTimeSlot,
   CheckDomainResponse,
+  SubTaskData,
   DescribeCNAMEResponse,
   UpdateOrganizationResponse,
   AddOrgData,
@@ -40,7 +42,7 @@ import {
   UpdateDeviceOrganizationRequest,
   UpdateDeviceOrganizationResponse,
   AddOrganizationResponse,
-  RecordTemplateInfo,
+  BatchOperateDeviceResponse,
   DescribeDeviceRegionResponse,
   ListRecordPlanChannelsData,
   DescribeDomainResponse,
@@ -51,6 +53,7 @@ import {
   DescribeUserDeviceResponse,
   DeleteRecordPlanResponse,
   DescribeOrganizationResponse,
+  UpgradeGatewayResponse,
   UpdateUserDeviceRequest,
   DescribeDeviceChannelResponse,
   AddRecordBackupTemplateRequest,
@@ -66,6 +69,7 @@ import {
   DeleteRecordTemplateRequest,
   DescribeGatewayResponse,
   ListRecordBackupPlanDevicesData,
+  TaskData,
   DescribeGatewayRequest,
   AddRecordBackupTemplateData,
   DeleteUserDeviceRequest,
@@ -76,7 +80,7 @@ import {
   UpdateRecordBackupPlanModify,
   UpdateAITaskRequest,
   FaceMaskAIResultInfo,
-  UpgradeGatewayResponse,
+  SmokingAIResultInfo,
   BaseAIResultInfo,
   DeleteDomainRequest,
   ListRecordRetrieveTasksRequest,
@@ -87,6 +91,7 @@ import {
   ListRecordPlansRequest,
   AddRecordBackupPlanResponse,
   SnapshotConfig,
+  ListSubTasksResponse,
   ListAITasksRequest,
   UpdateRecordPlanRequest,
   Location,
@@ -110,9 +115,12 @@ import {
   ChannelInfo,
   RecordRetrieveTaskChannelInfo,
   DescribeDomainRequest,
+  BatchOperateDeviceData,
   RecordPlaybackUrl,
   ListOrganizationChannelNumbersData,
+  ListSubTasksData,
   ListRecordPlanDevicesRequest,
+  ListTasksResponse,
   AddStreamAuthResponse,
   ListDevicesResponse,
   AddStreamAuthData,
@@ -164,7 +172,7 @@ import {
   DescribeVideoDownloadUrlRequest,
   DescribeGatewayVersionResponse,
   ListGatewaysRequest,
-  RecordPlanBaseInfo,
+  ListTasksRequest,
   DescribeGatewayVersionRequest,
   DescribeRecordBackupTemplateRequest,
   DescribeUserDeviceRequest,
@@ -183,6 +191,7 @@ import {
   ControlDevicePresetRequest,
   ControlDeviceStreamRequest,
   ListRecordRetrieveTasksResponse,
+  RecordPlanBaseInfo,
   ListRecordBackupPlanDevicesRequest,
   DeleteDomainResponse,
   AddRecordRetrieveTaskResponse,
@@ -198,6 +207,7 @@ import {
   DeleteRecordRetrieveTaskRequest,
   DescribeRecordBackupPlanData,
   UpdateRecordPlanResponse,
+  DescribeTaskResponse,
   DescribeGatewayVersion,
   RecordRetrieveTaskDetailsInfo,
   DeleteRecordBackupPlanRequest,
@@ -220,7 +230,7 @@ import {
   DeleteGatewayResponse,
   DescribeRecordPlaybackUrlResponse,
   UpdateRecordPlanData,
-  SmokingAIResultInfo,
+  DescribeTaskRequest,
   ListRecordPlanChannelsRequest,
   ListOrganizationChannelsResponse,
   UpdateOrganizationRequest,
@@ -231,10 +241,12 @@ import {
   DescribeRecordFileData,
   UpdateOrgData,
   DescribeDomainRegionResponse,
-  UpdateRecordBackupTemplateData,
+  BatchOperateDeviceRequest,
   ListOrganizationChannelsData,
   AddRecordBackupPlanRequest,
+  ListTasksData,
   ControlDeviceStreamData,
+  RecordTemplateInfo,
   UpdateRecordBackupTemplateRequest,
   UpdateDeviceStatusResponse,
   DeleteUserDeviceResponse,
@@ -248,6 +260,7 @@ import {
   UpdateRecordTemplateResponse,
   DescribeRecordRetrieveTaskResponse,
   DescribeStreamAuthRequest,
+  UpdateRecordBackupTemplateData,
   UpdateRecordBackupPlanData,
   AddDeviceData,
 } from "./iss_models"
@@ -431,6 +444,16 @@ export class Client extends AbstractClient {
     return this.request("UpdateAITask", req, cb)
   }
 
+  /**
+   * 用于查询任务的子任务列表
+   */
+  async ListSubTasks(
+    req: ListSubTasksRequest,
+    cb?: (error: string, rep: ListSubTasksResponse) => void
+  ): Promise<ListSubTasksResponse> {
+    return this.request("ListSubTasks", req, cb)
+  }
+
   /**
    * 用于查询用户下所有实时上云计划中的通道列表
    */
@@ -541,6 +564,16 @@ export class Client extends AbstractClient {
     return this.request("DescribeRecordTemplate", req, cb)
   }
 
+  /**
+   * 用于修改实时上云模板
+   */
+  async UpdateRecordTemplate(
+    req: UpdateRecordTemplateRequest,
+    cb?: (error: string, rep: UpdateRecordTemplateResponse) => void
+  ): Promise<UpdateRecordTemplateResponse> {
+    return this.request("UpdateRecordTemplate", req, cb)
+  }
+
   /**
    * 用于新建取回任务
    */
@@ -571,6 +604,16 @@ export class Client extends AbstractClient {
     return this.request("AddUserDevice", req, cb)
   }
 
+  /**
+   * 用于查询任务详情
+   */
+  async DescribeTask(
+    req: DescribeTaskRequest,
+    cb?: (error: string, rep: DescribeTaskResponse) => void
+  ): Promise<DescribeTaskResponse> {
+    return this.request("DescribeTask", req, cb)
+  }
+
   /**
    * 添加AI任务
    */
@@ -661,6 +704,16 @@ export class Client extends AbstractClient {
     return this.request("ControlDevicePreset", req, cb)
   }
 
+  /**
+   * 用于批量操作（启用，禁用，删除）设备
+   */
+  async BatchOperateDevice(
+    req: BatchOperateDeviceRequest,
+    cb?: (error: string, rep: BatchOperateDeviceResponse) => void
+  ): Promise<BatchOperateDeviceResponse> {
+    return this.request("BatchOperateDevice", req, cb)
+  }
+
   /**
    * 用于修改组织。
    */
@@ -902,13 +955,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 用于修改实时上云模板
+   * 用于查询批量任务和简单任务列表
    */
-  async UpdateRecordTemplate(
-    req: UpdateRecordTemplateRequest,
-    cb?: (error: string, rep: UpdateRecordTemplateResponse) => void
-  ): Promise<UpdateRecordTemplateResponse> {
-    return this.request("UpdateRecordTemplate", req, cb)
+  async ListTasks(
+    req: ListTasksRequest,
+    cb?: (error: string, rep: ListTasksResponse) => void
+  ): Promise<ListTasksResponse> {
+    return this.request("ListTasks", req, cb)
   }
 
   /**