tencentcloud-sdk-nodejs 4.0.651 → 4.0.653

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

@@ -562,7 +562,7 @@ ENTERPRISESERVER-企业静默签
    */
   ApproverSignComponentType?: string
   /**
-   * 签署方自定义控件别名，最大长度20个字符
+   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推.  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
    */
   ApproverSignRole?: string
 }
@@ -934,14 +934,16 @@ export interface DescribeFlowComponentsResponse {
  */
 export interface DescribeFlowEvidenceReportResponse {
   /**
-   * 报告 URL
+   * 出证报告PDF的下载 URL
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ReportUrl?: string
   /**
-   * 执行中：EvidenceStatusExecuting
-成功：EvidenceStatusSuccess
-失败：EvidenceStatusFailed
+   * 出证任务执行的状态, 分布表示下面的含义
+
+EvidenceStatusExecuting  出证任务在执行中
+EvidenceStatusSuccess  出证任务执行成功
+EvidenceStatusFailed  出征任务执行失败
    */
   Status?: string
   /**
@@ -1280,7 +1282,10 @@ APP：第三方APP或小程序跳转电子签小程序的path。
    */
   PathType?: number
   /**
-   * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+   * 是否自动回跳
+true：是，
+false：否。
+该参数只针对"APP" 类型的签署链接有效
    */
   AutoJumpBack?: boolean
   /**
@@ -1317,23 +1322,40 @@ export interface AutoSignConfig {
    */
   UserInfo: UserThreeFactor
   /**
-   * 接受自动签开启的回调地址。需要保证post返回200
+   * 接受回调URL地址。支持http://或者https://协议
+
+Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
    */
   CallbackUrl: string
   /**
-   * 是否回调证书信息，默认false-不需要
+   * 是否回调证书信息
+false-不需要 (默认值)
+true-需要
    */
   CertInfoCallback?: boolean
   /**
-   * 是否支持用户自定义签名印章，默认false-不需要
+   * 是否支持用户自定义签名印章
+false-不需要(默认)
+true-需要
    */
   UserDefineSeal?: boolean
   /**
-   * 是否需要回调的时候返回印章(签名) 图片的 base64，默认false-不需要
+   * 是否需要回调的时候返回印章(签名) 图片的 base64
+
+false-不需要(默认)
+true-需要(
    */
   SealImgCallback?: boolean
   /**
-   * 开通时候的验证方式，取值：WEIXINAPP（微信人脸识别），INSIGHT（慧眼人脸认别），TELECOM（运营商三要素验证）。如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
+   * 开通时候的验证方式, 分布为
+
+WEIXINAPP : 微信人脸识别
+INSIGHT : 慧眼人脸认别
+TELECOM : 运营商三要素验证
+
+如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。
+
+如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
    */
   VerifyChannels?: Array<string>
 }
@@ -1458,31 +1480,39 @@ export interface CreateIntegrationDepartmentResponse {
  */
 export interface DescribeFlowTemplatesRequest {
   /**
-   * 调用方用户信息，userId 必填
+   * 调用方员工/经办人信息
+UserId 必填，在企业控制台组织架构中可以查到员工的UserId
+注：请保证对应
    */
   Operator: UserInfo
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理相关应用信息
+如集团主企业代子企业操作的场景中ProxyOrganizationId必填
    */
   Agent?: Agent
   /**
-   * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+   * 查询内容类型
+0-模板列表及详情（默认）
+1-仅模板列表
    */
   ContentType?: number
   /**
-   * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
+   * 搜索条件，本字段用于指定模板Id进行查询。
+Key：template-id
+Values：需要查询的模板Id列表
    */
   Filters?: Array<Filter>
   /**
-   * 查询偏移位置，默认0
+   * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
    */
   Offset?: number
   /**
-   * 查询个数，默认20，最大200
+   * 指定每页多少条数据，如果不传默认为20，单页最大200。
    */
   Limit?: number
   /**
-   * ApplicationId不为空，查询指定应用下的模板列表
+   * 用于查询指定应用号下单模板列表。
+ApplicationId不为空，查询指定应用下的模板列表
 ApplicationId为空，查询所有应用下的模板列表
    */
   ApplicationId?: string
@@ -1550,15 +1580,18 @@ export interface OrganizationInfo {
  */
 export interface DescribeUserAutoSignStatusResponse {
   /**
-   * 是否已开通自动签
+   * 查询用户是否已开通自动签
    */
   IsOpen?: boolean
   /**
    * 自动签许可生效时间。当且仅当已开通自动签时有值。
+
+值为unix时间戳,单位为秒。
    */
   LicenseFrom?: number
   /**
    * 自动签许可到期时间。当且仅当已开通自动签时有值。
+值为unix时间戳,单位为秒。
    */
   LicenseTo?: number
   /**
@@ -1738,10 +1771,13 @@ export interface CreateBatchCancelFlowUrlResponse {
   BatchCancelFlowUrl?: string
   /**
    * 签署流程撤回失败信息
+数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
    */
   FailMessages?: Array<string>
   /**
    * 签署连接过期时间字符串：年月日-时分秒
+
+例如:2023-07-28 17:25:59
    */
   UrlExpireOn?: string
   /**
@@ -1926,7 +1962,7 @@ CreateReview:发起审核
 默认：SignReview；SignReview:签署审核
 
 该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程
-若发起个人审核，则指定该字段为：SignReview（注意，给个人审核时，需联系客户经理开白使用）
+若发起个人审核，则指定该字段为：SignReview
    */
   OperateType?: string
 }
@@ -1988,7 +2024,7 @@ export interface CreateUserAutoSignEnableUrlResponse {
    */
   Path?: string
   /**
-   * base64格式跳转二维码
+   * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
    */
   QrCode?: string
   /**
@@ -2832,7 +2868,7 @@ export interface FailedUpdateStaffData {
  */
 export interface GetTaskResultApiRequest {
   /**
-   * 任务Id，通过CreateConvertTaskApi得到
+   * 任务Id，通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
    */
   TaskId: string
   /**
@@ -3062,7 +3098,9 @@ export interface CreateFlowSignUrlRequest {
    */
   FlowId: string
   /**
-   * 流程签署人，其中ApproverName，ApproverMobile和ApproverType必传，其他可不传，ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
+   * 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，ApproverType目前只支持个人类型的签署人。
+
+签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
    */
   FlowApproverInfos: Array<FlowCreateApprover>
   /**
@@ -3509,15 +3547,20 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
    */
   AutoSignConfig: AutoSignConfig
   /**
-   * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+   * 链接类型，
+空-默认小程序端链接
+H5SIGN-h5端链接
    */
   UrlType?: string
   /**
-   * 通知类型，默认不填为不通知开通方，填写 SMS 为短信通知。
+   * 通知类型
+
+默认不设置为不通知开通方，
+SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
    */
   NotifyType?: string
   /**
-   * 若上方填写为 SMS，则此处为手机号
+   * 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
    */
   NotifyAddress?: string
   /**
@@ -3794,7 +3837,7 @@ ProcessTimeout - 转换文件超时
    */
   TaskMessage?: string
   /**
-   * 资源Id，也是FileId，用于文件发起使用
+   * 资源Id，也是FileId，用于文件发起时使用
    */
   ResourceId?: string
   /**
@@ -4763,7 +4806,8 @@ export interface CreateBatchCancelFlowUrlRequest {
    */
   Operator: UserInfo
   /**
-   * 需要执行撤回的签署流程id数组，最多100个
+   * 需要执行撤回的流程(合同)的编号列表，最多100个.
+列表中的流程(合同)编号不要重复.
    */
   FlowIds: Array<string>
   /**
@@ -4838,6 +4882,8 @@ export interface DescribeFlowInfoRequest {
   Operator?: UserInfo
   /**
    * 需要查询的流程ID列表，限制最大100个
+
+如果查询合同组的信息,不要传此参数
    */
   FlowIds?: Array<string>
   /**
@@ -4845,7 +4891,9 @@ export interface DescribeFlowInfoRequest {
    */
   Agent?: Agent
   /**
-   * 合同组ID
+   * 合同组ID, 如果传此参数会忽略FlowIds入参
+ 所以如传此参数不要传FlowIds参数
+
    */
   FlowGroupId?: string
 }
@@ -4910,7 +4958,7 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
    */
   SceneKey: string
   /**
-   * 查询开启状态的用户信息
+   * 要查询开启状态的用户信息
    */
   UserInfo: UserThreeFactor
   /**
@@ -4977,20 +5025,20 @@ export interface FlowBrief {
   /**
    * 流程的编号ID
    */
-  FlowId: string
+  FlowId?: string
   /**
    * 流程的名称
    */
-  FlowName: string
+  FlowName?: string
   /**
    * 流程的描述信息
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  FlowDescription: string
+  FlowDescription?: string
   /**
    * 流程的类型
    */
-  FlowType: string
+  FlowType?: string
   /**
    * 流程状态
 - 0 还没有发起
@@ -5007,17 +5055,19 @@ export interface FlowBrief {
 - 21 已解除
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  FlowStatus: number
+  FlowStatus?: number
   /**
    * 流程创建的时间戳，单位秒
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  CreatedOn: number
+  CreatedOn?: number
   /**
-   * 拒签或者取消的原因描述
+   * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
+此字段展示拒签或者取消的原因描述
+
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  FlowMessage: string
+  FlowMessage?: string
   /**
    *  合同发起人userId
 注意：此字段可能返回 null，表示取不到有效值。

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

@@ -422,7 +422,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
      * 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
 接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
-可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。
+
+可以撤回：未全部签署完成
+ 不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
 注意:
 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
      */
@@ -533,6 +536,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
      * 指定需要批量撤销的签署流程Id，批量撤销合同
 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
 
+可以撤回：未全部签署完成
+ 不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
 **满足撤销条件的合同会发起异步撤销流程，不满足撤销条件的合同返回失败原因。**
 
 **合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**

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

@@ -442,7 +442,7 @@ SIGN_REJECT:拒签(流程结束)
 注：接口通过该字段区分操作类型
 该字段不传或者为空，则默认为SignReview签署审核，走签署审核流程
 若想使用发起审核，请指定该字段为：CreateReview
-若发起个人审核，则指定该字段为：SignReview（注意，给个人审核时，需联系客户经理开白使用）
+若发起个人审核，则指定该字段为：SignReview
    */
   OperateType?: string
 }
@@ -471,7 +471,7 @@ export interface DescribeFlowDetailInfoRequest {
   Agent: Agent
   /**
    * 合同(流程)编号数组，最多支持100个。
-（备注：该参数和合同组编号必须二选一）
+（备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参）
    */
   FlowIds?: Array<string>
   /**
@@ -729,6 +729,7 @@ export interface BaseFlowInfo {
   FlowName: string
   /**
    * 合同流程类型
+<br/>客户自定义，用于合同分类展示
    */
   FlowType: string
   /**
@@ -741,6 +742,7 @@ export interface BaseFlowInfo {
   Deadline: number
   /**
    * 是否顺序签署(true:无序签,false:顺序签)
+<br/>默认false，有序签署合同
    */
   Unordered?: boolean
   /**
@@ -752,7 +754,10 @@ export interface BaseFlowInfo {
    */
   FormFields?: Array<FormField>
   /**
-   * 本企业(发起方企业)是否需要签署审批，true：开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
+   * 本企业(发起方企业)是否需要签署审批
+<br/>true：开启发起方签署审批
+<br/>false：不开启发起方签署审批
+<br/>开启后，使用ChannelCreateFlowSignReview接口提交审批结果，才能继续完成签署
    */
   NeedSignReview?: boolean
   /**
@@ -764,7 +769,10 @@ export interface BaseFlowInfo {
    */
   CcInfos?: Array<CcInfo>
   /**
-   * 是否需要发起前审核，当指定NeedCreateReview=true，则发起后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
+   * 是否需要开启发起方发起前审核
+<br/>true：开启发起方发起前审核
+<br/>false：不开启发起方发起前审核
+<br/>当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
    */
   NeedCreateReview?: boolean
 }
@@ -952,10 +960,6 @@ export interface ChannelCreatePrepareFlowRequest {
    * 合同流程基础信息
    */
   FlowInfo: BaseFlowInfo
-  /**
-   * 合同签署人信息
-   */
-  FlowApproverList: Array<CommonFlowApprover>
   /**
    * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
    */
@@ -964,6 +968,10 @@ export interface ChannelCreatePrepareFlowRequest {
    * 合同流程配置信息，用于配置发起合同时定制化
    */
   FlowOption?: CreateFlowOption
+  /**
+   * 合同签署人信息
+   */
+  FlowApproverList?: Array<CommonFlowApprover>
   /**
    * 通过flowid快速获得之前成功通过页面发起的合同生成链接
    */
@@ -3631,10 +3639,11 @@ export interface ChannelBatchCancelFlowsRequest {
   CancelMessage?: string
   /**
    * 撤销理由自定义格式；选项：
-0 默认格式
-1 只保留身份信息：展示为【发起方】
-2 保留身份信息+企业名称：展示为【发起方xxx公司】
-3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
+
+- 0 默认格式
+- 1 只保留身份信息：展示为【发起方】
+- 2 保留身份信息+企业名称：展示为【发起方xxx公司】
+- 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】
    */
   CancelMessageFormat?: number
   /**
@@ -4040,14 +4049,17 @@ export interface OperateChannelTemplateRequest {
  */
 export interface CreateChannelFlowEvidenceReportResponse {
   /**
-   * 出证报告 ID，用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
+   * 出证报告 ID，可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
+
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ReportId?: string
   /**
-   * 执行中：EvidenceStatusExecuting
-成功：EvidenceStatusSuccess
-失败：EvidenceStatusFailed
+   * 出征任务的执行状态,状态列表如下
+
+- EvidenceStatusExecuting : 出征任务正在执行中
+- EvidenceStatusSuccess : 出征任务执行成功
+- EvidenceStatusFailed : 出征任务执行失败
    */
   Status?: string
   /**
@@ -4124,14 +4136,16 @@ export interface ChannelCreateReleaseFlowResponse {
  */
 export interface DescribeChannelFlowEvidenceReportResponse {
   /**
-   * 出证报告 URL
+   * 出证报告下载 URL
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ReportUrl?: string
   /**
-   * 执行中：EvidenceStatusExecuting
-成功：EvidenceStatusSuccess
-失败：EvidenceStatusFailed
+   * 出征任务的执行状态,状态列表如下
+
+- EvidenceStatusExecuting : 出征任务正在执行中
+- EvidenceStatusSuccess : 出征任务执行成功
+- EvidenceStatusFailed : 出征任务执行失败
    */
   Status?: string
   /**
@@ -4229,23 +4243,25 @@ export interface ChannelCreateEmbedWebUrlRequest {
    */
   Agent: Agent
   /**
-   * WEB嵌入资源类型。
-CREATE_SEAL: 创建印章
-CREATE_TEMPLATE：创建模板
-MODIFY_TEMPLATE：修改模板
-PREVIEW_TEMPLATE：预览模板
-PREVIEW_FLOW：预览合同文档
-PREVIEW_FLOW_DETAIL：预览合同详情
-PREVIEW_SEAL_LIST：预览印章列表
-PREVIEW_SEAL_DETAIL：预览印章详情
-EXTEND_SERVICE：扩展服务
+   * 要生成WEB嵌入界面的类型, 可以选择的值如下: 
+
+- CREATE_SEAL: 生成创建印章的嵌入页面
+- CREATE_TEMPLATE：生成创建模板的嵌入页面
+- MODIFY_TEMPLATE：生成修改模板的嵌入页面
+- PREVIEW_TEMPLATE：生成预览模板的嵌入页面
+- PREVIEW_FLOW：生成预览合同文档的嵌入页面
+- PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面
+- PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面
+- PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面
+- EXTEND_SERVICE：生成扩展服务的嵌入页面
    */
   EmbedType: string
   /**
    * WEB嵌入的业务资源ID
-EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时必填，取值为模板id
-PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时必填，取值为合同id
-PREVIEW_SEAL_DETAIL，必填，取值为印章id
+
+- 当EmbedType取值MODIFY_TEMPLATE，PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
+- 当EmbedType取值PREVIEW_FLOW，PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
+- 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
    */
   BusinessId?: string
   /**

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

@@ -1863,11 +1863,11 @@ export interface DescribeAccessRegionsByDestRegionResponse {
   /**
    * 可用加速区域数量
    */
-  TotalCount: number
+  TotalCount?: number
   /**
    * 可用加速区域信息列表
    */
-  AccessRegionSet: Array<AccessRegionDetial>
+  AccessRegionSet?: Array<AccessRegionDetial>
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

package/src/services/lcic/v20220817/lcic_models.ts

@@ -693,6 +693,16 @@ export interface RoomItem {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   VideoOrientation?: number
+  /**
+   * 开启课后评分。 0：不开启(默认)  1：开启
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  IsGradingRequiredPostClass?: number
+  /**
+   * 房间类型。0:小班课（默认值）；1:大班课；2:1V1（后续扩展）
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  RoomType?: number
 }
 
 /**
@@ -1330,6 +1340,14 @@ RoomEnd:房间结束
 MemberJoin:成员加入
 MemberQuit:成员退出
 RecordFinish:录制结束
+CameraOn: 摄像头打开
+CameraOff: 摄像头关闭
+MicOn: 麦克风打开
+MicOff: 麦克风关闭
+ScreenOn: 屏幕共享打开
+ScreenOff: 屏幕共享关闭
+VisibleOn: 页面可见
+VisibleOff: 页面不可见
    */
   Keyword?: string
 }
@@ -1833,6 +1851,10 @@ export interface DescribeRoomResponse {
    * 低代码互动课堂的SdkAppId。
    */
   SdkAppId?: number
+  /**
+   * 观看类型。互动观看 （默认）
+   */
+  AudienceType?: number
   /**
    * 分辨率。可以有如下取值：
 1 标清

package/src/services/nlp/v20190408/nlp_models.ts

@@ -1188,7 +1188,7 @@ export interface ComposeCoupletRequest {
  */
 export interface EvaluateSentenceSimilarityRequest {
   /**
-   * 待分析的句子对数组。句子对应不超过1对，仅支持中文文本，原句子与目标句子均应不超过64字符。
+   * 待分析的句子对数组。句子对应不超过1对，仅支持中文文本，原句子与目标句子均应不超过500字符。
    */
   SentencePairList: Array<SentencePair>
 }