tencentcloud-sdk-nodejs 4.0.653 → 4.0.654

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

@@ -340,8 +340,18 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板
-   */
+     * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
+
+> **适用场景** 
+>
+>  该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 
+>  一个模板通常会包含以下结构信息
+>- 模板基本信息
+>- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+>- 填写控件 Components
+>- 签署控件 SignComponents
+>- 生成模板的文件基础信息 FileInfos
+     */
   async DescribeTemplates(
     req: DescribeTemplatesRequest,
     cb?: (error: string, rep: DescribeTemplatesResponse) => void
@@ -437,8 +447,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-   * 通过发起转换任务接口（ChannelCreateConvertTaskApi）返回的任务Id查询转换任务状态，通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
-   */
+     * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。
+注意：大文件转换所需的时间可能会比较长。
+     */
   async ChannelGetTaskResultApi(
     req: ChannelGetTaskResultApiRequest,
     cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void

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

@@ -71,8 +71,7 @@ CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；
 
 注：
 当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。
-例：
-当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
+例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
 如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。
 
 创建控件时，此值为空
@@ -104,15 +103,16 @@ SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
    */
   ComponentType?: string
   /**
-   * 控件简称，不能超过30个字符
+   * 控件简称，不超过30个字符
    */
   ComponentName?: string
   /**
-   * 定义控件是否为必填项，默认为false
+   * 控件是否为必填项，
+默认为false-非必填
    */
   ComponentRequired?: boolean
   /**
-   * 控件关联的签署方id
+   * 控件关联的参与方ID，对应Recipient结构体中的RecipientId
    */
   ComponentRecipientId?: string
   /**
@@ -273,11 +273,11 @@ SIGN_PAGING_SEAL - 可以指定印章ID
    */
   ComponentDateFontSize?: number
   /**
-   * 控件所属文档的Id, 模块相关接口为空值
+   * 控件所属文档的Id, 模板相关接口为空值
    */
   DocumentId?: string
   /**
-   * 控件描述，不能超过30个字符
+   * 控件描述，不超过30个字符
    */
   ComponentDescription?: string
   /**
@@ -294,20 +294,31 @@ SIGN_PAGING_SEAL - 可以指定印章ID
    */
   ChannelComponentId?: string
   /**
-   * 指定关键字排序规则，Positive-正序，Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
+   * 指定关键字排序规则，
+Positive-正序，
+Reverse-倒序。
+传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。
 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
    */
   KeywordOrder?: string
   /**
-   * 指定关键字页码，可选参数，指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
+   * 指定关键字页码。
+指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
    */
   KeywordPage?: number
   /**
-   * 关键字位置模式，Middle-居中，Below-正下方，Right-正右方，LowerRight-右上角，UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
+   * 关键字位置模式，
+Middle-居中，
+Below-正下方，
+Right-正右方，
+LowerRight-右上角，
+UpperRight-右下角。
+示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
    */
   RelativeLocation?: string
   /**
-   * 关键字索引，可选参数，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
+   * 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。
+示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
    */
   KeywordIndexes?: Array<number>
   /**
@@ -610,12 +621,17 @@ export interface OperateChannelTemplateResponse {
    */
   TemplateId?: string
   /**
-   * 描述模板可见性更改的结果，和参数中Available无关，全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
+   * 描述模板可见性更改的结果，和参数中Available无关。
+全部成功-"all-success",
+部分成功-"part-success", 
+全部失败-"fail"，失败的会在FailMessageList中展示。
 注意：此字段可能返回 null，表示取不到有效值。
    */
   OperateResult?: string
   /**
-   * 模板可见性, 全部可见-"all", 部分可见-"part"
+   * 模板可见性, 
+全部可见-"all", 
+部分可见-"part"
 注意：此字段可能返回 null，表示取不到有效值。
    */
   AuthTag?: string
@@ -1463,36 +1479,44 @@ export interface PrepareFlowsResponse {
 
 /**
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
+
+> **模板组成** 
+>
+>  一个模板通常会包含以下结构信息
+>- 模板基本信息
+>- 签署参与方 Recipients，在模板发起合同时用于指定参与方
+>- 填写控件 Components
+>- 签署控件 SignComponents
  */
 export interface TemplateInfo {
   /**
-   * 模板ID
+   * 模板ID，模板的唯一标识
    */
-  TemplateId: string
+  TemplateId?: string
   /**
-   * 模板名字
+   * 模板名
    */
-  TemplateName: string
+  TemplateName?: string
   /**
    * 模板描述信息
    */
-  Description: string
+  Description?: string
   /**
-   * 模板的填充控件信息结构
+   * 模板的填充控件列表
    */
-  Components: Array<Component>
+  Components?: Array<Component>
   /**
-   * 模板中的流程参与人信息
+   * 模板中的签署参与方列表
    */
-  Recipients: Array<Recipient>
+  Recipients?: Array<Recipient>
   /**
-   * 模板中的签署控件信息结构
+   * 模板中的签署控件列表
    */
-  SignComponents: Array<Component>
+  SignComponents?: Array<Component>
   /**
    * 模板类型：1-静默签；3-普通模板
    */
-  TemplateType: number
+  TemplateType?: number
   /**
    * 是否是发起人 ,已弃用
    * @deprecated
@@ -1501,42 +1525,50 @@ export interface TemplateInfo {
   /**
    * 模板的创建者信息，电子签系统用户ID
    */
-  Creator: string
+  Creator?: string
   /**
-   * 模板创建的时间戳，单位秒
+   * 模板创建的时间戳，格式为Unix标准时间戳（秒）
    */
-  CreatedOn: number
+  CreatedOn?: number
   /**
-   * 模板的H5预览链接,可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回，有效期5分钟。
+   * 模板的H5预览链接,有效期5分钟。
+可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+（此功能开放需要联系客户经理）
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  PreviewUrl: string
+  PreviewUrl?: string
   /**
-   * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回（此功能开放需要联系客户经理），有效期5分钟。
+   * 第三方应用集成-模板PDF文件链接，有效期5分钟。
+请求参数WithPdfUrl=true时返回
+（此功能开放需要联系客户经理）。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  PdfUrl: string
+  PdfUrl?: string
   /**
-   * 关联的第三方应用平台企业模板ID
+   * 本模板关联的第三方应用平台企业模板ID
    */
-  ChannelTemplateId: string
+  ChannelTemplateId?: string
   /**
-   * 关联的三方应用平台平台企业模板名称
+   * 本模板关联的三方应用平台平台企业模板名称
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ChannelTemplateName: string
+  ChannelTemplateName?: string
   /**
-   * 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
+   * 0-需要子客企业手动领取平台企业的模板(默认); 
+1-平台自动设置子客模板
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  ChannelAutoSave: number
+  ChannelAutoSave?: number
   /**
-   * 模板版本，全数字字符。默认为空，初始版本为yyyyMMdd001。
+   * 模板版本，全数字字符。
+默认为空，初始版本为yyyyMMdd001。
 注意：此字段可能返回 null，表示取不到有效值。
    */
-  TemplateVersion: string
+  TemplateVersion?: string
   /**
-   * 模板可用状态，取值：1启用（默认），2停用
+   * 模板可用状态：
+1启用（默认）
+2停用
 注意：此字段可能返回 null，表示取不到有效值。
    */
   Available?: number
@@ -1584,35 +1616,42 @@ export interface Agent {
 }
 
 /**
- * 签署参与者信息
+ * 流程中参与方的信息结构
  */
 export interface Recipient {
   /**
-   * 签署人唯一标识，在通过模板发起合同的时候对应签署方Id
+   * 签署人唯一标识，在通过模板发起合同的时候对应签署方ID
    */
   RecipientId?: string
   /**
-   * 参与者类型。默认为空。ENTERPRISE-企业；INDIVIDUAL-个人；PROMOTER-发起方
+   * 参与者类型，默认为空。
+ENTERPRISE-企业；
+INDIVIDUAL-个人；
+PROMOTER-发起方
    */
   RecipientType?: string
   /**
-   * 描述
+   * 描述信息
    */
   Description?: string
   /**
-   * 签署方备注角色名
+   * 角色名称
    */
   RoleName?: string
   /**
-   * 是否需要校验，true-是，false-否
+   * 是否需要校验，
+true-是，
+false-否
    */
   RequireValidation?: boolean
   /**
-   * 是否必须填写，true-是，false-否
+   * 是否必须填写，
+true-是，
+false-否
    */
   RequireSign?: boolean
   /**
-   * 签署类型
+   * 内部字段，签署类型
    */
   SignType?: number
   /**
@@ -1620,7 +1659,9 @@ export interface Recipient {
    */
   RoutingOrder?: number
   /**
-   * 是否是发起方
+   * 是否是发起方，
+true-是 
+false-否
    */
   IsPromoter?: boolean
 }
@@ -1630,19 +1671,19 @@ export interface Recipient {
  */
 export interface DescribeTemplatesResponse {
   /**
-   * 模板详情
+   * 模板列表
    */
   Templates?: Array<TemplateInfo>
   /**
-   * 查询总数
+   * 查询到的总数
    */
   TotalCount?: number
   /**
-   * 查询数量
+   * 每页多少条数据
    */
   Limit?: number
   /**
-   * 查询起始偏移
+   * 查询结果分页返回，此处指定第几页。页码从0开始，即首页为0。
    */
   Offset?: number
   /**
@@ -3752,7 +3793,8 @@ export interface ChannelCancelFlowRequest {
  */
 export interface DescribeTemplatesRequest {
   /**
-   * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
+   * 应用相关信息。 
+此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
    */
   Agent: Agent
   /**
@@ -3760,19 +3802,23 @@ export interface DescribeTemplatesRequest {
    */
   TemplateId?: string
   /**
-   * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+   * 查询内容：
+0-模板列表及详情（默认），
+1-仅模板列表
    */
   ContentType?: number
   /**
-   * 查询个数，默认20，最大100；在查询列表的时候有效
+   * 指定每页多少条数据，如果不传默认为20，单页最大100。
    */
   Limit?: number
   /**
-   * 查询偏移位置，默认0；在查询列表的时候有效
+   * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
    */
   Offset?: number
   /**
-   * 是否返回所有组件信息。默认false，只返回发起方控件；true，返回所有签署方控件
+   * 是否返回所有组件信息。
+默认false，只返回发起方控件；
+true，返回所有签署方控件
    */
   QueryAllComponents?: boolean
   /**
@@ -3780,11 +3826,16 @@ export interface DescribeTemplatesRequest {
    */
   TemplateName?: string
   /**
-   * 是否获取模板预览链接
+   * 是否获取模板预览链接，
+默认false-不获取
+true-获取
    */
   WithPreviewUrl?: boolean
   /**
-   * 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
+   * 是否获取模板的PDF文件链接。
+默认false-不获取
+true-获取
+请联系客户经理开白后使用。
    */
   WithPdfUrl?: boolean
   /**
@@ -4013,11 +4064,15 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
  */
 export interface OperateChannelTemplateRequest {
   /**
-   * 应用相关信息。 此接口Agent.AppId必填。
+   * 应用相关信息。 
+此接口Agent.AppId必填。
    */
   Agent: Agent
   /**
-   * 操作类型，查询:"SELECT"，删除:"DELETE"，更新:"UPDATE"
+   * 操作类型，
+查询:"SELECT"，
+删除:"DELETE"，
+更新:"UPDATE"
    */
   OperateType: string
   /**
@@ -4025,23 +4080,29 @@ export interface OperateChannelTemplateRequest {
    */
   TemplateId: string
   /**
-   * 合作企业方第三方机构唯一标识数据，支持多个， 用","进行分隔
+   * 合作企业方第三方机构唯一标识数据.
+支持多个， 用","进行分隔
    */
   ProxyOrganizationOpenIds?: string
   /**
-   * 模板可见性, 全部可见-"all", 部分可见-"part"
+   * 模板可见性, 
+全部可见-"all",
+ 部分可见-"part"
    */
   AuthTag?: string
+  /**
+   * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。
+若此字段值为0，则不会修改模板Available，
+1为启用模板，
+2为停用模板。
+启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
+   */
+  Available?: number
   /**
    * 暂未开放
    * @deprecated
    */
   Operator?: UserInfo
-  /**
-   * 当OperateType=UPADATE时，可以通过设置此字段对模板启停用状态进行操作。若此字段值为0，则不会修改模板Available，1为启用模板，2为停用模板。
-启用后模板可以正常领取。停用后，推送方式为【自动推送】的模板则无法被子客使用，推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败，会直接返回错误。
-   */
-  Available?: number
 }
 
 /**

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

@@ -824,12 +824,13 @@ export interface BankCard4EVerificationResponse {
 '-4': '银行卡号码有误'
 '-5': '手机号码不合法'
 '-18': '验证中心服务繁忙'
+'-19': '验证次数超限，请次日重试'
    */
-  Result: string
+  Result?: string
   /**
    * 业务结果描述。
    */
-  Description: string
+  Description?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -1982,6 +1983,7 @@ export interface BankCardVerificationResponse {
 '-3': '身份证号码有误'
 '-4': '银行卡号码有误'
 '-17': '验证中心服务繁忙'
+'-18': '验证次数超限，请次日重试'
    */
   Result?: string
   /**
@@ -2209,12 +2211,14 @@ export interface BankCard2EVerificationResponse {
   '-2': '姓名校验不通过'
   '-3': '银行卡号码有误'
   '-16': '验证中心服务繁忙'
+  '-17': '验证次数超限，请次日重试'
+
    */
-  Result: string
+  Result?: string
   /**
    * 业务结果描述。
    */
-  Description: string
+  Description?: string
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

package/src/services/live/v20180801/live_client.ts

@@ -372,6 +372,7 @@ import {
   DescribeRecordTaskResponse,
   DescribeAreaBillBandwidthAndFluxListResponse,
   ForbidLiveDomainRequest,
+  MixPortraitSegmentParams,
   RecordParam,
   ModifyLiveRecordTemplateRequest,
   DescribeLiveDomainRefererRequest,

package/src/services/live/v20180801/live_models.ts

@@ -5673,6 +5673,10 @@ export interface CommonMixInputParam {
    * 输入流裁剪参数。
    */
   CropParams?: CommonMixCropParams
+  /**
+   * 抠图参数。
+   */
+  PortraitSegmentParams?: MixPortraitSegmentParams
 }
 
 /**
@@ -6495,7 +6499,7 @@ export interface CreateLiveRecordTemplateResponse {
   /**
    * 模板Id。
    */
-  TemplateId: number
+  TemplateId?: number
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -7241,6 +7245,7 @@ export interface CreateLiveRecordTemplateRequest {
   Mp3Param?: RecordParam
   /**
    * 是否去除水印，类型为慢直播时此参数无效。
+如果为false，则录制水印流或转码流；如果为true，则录制原始流。
    */
   RemoveWatermark?: boolean
   /**
@@ -8759,6 +8764,24 @@ export interface ForbidLiveDomainRequest {
   DomainName: string
 }
 
+/**
+ * 混流抠图参数
+ */
+export interface MixPortraitSegmentParams {
+  /**
+   * 抠图背景颜色，
+常用的颜色有：
+红色：0xcc0033。
+黄色：0xcc9900。
+绿色：0xcccc33。
+蓝色：0x99CCFF。
+黑色：0x000000。
+白色：0xFFFFFF。
+灰色：0x999999。
+   */
+  Color?: string
+}
+
 /**
  * 录制模板参数。
  */

package/src/services/mna/v20210119/mna_models.ts

@@ -696,15 +696,15 @@ export interface GetDevicesResponse {
   /**
    * 设备信息列表
    */
-  DeviceInfos: Array<DeviceBaseInfo>
+  DeviceInfos?: Array<DeviceBaseInfo>
   /**
    * 设备总记录条数
    */
-  Length: number
+  Length?: number
   /**
    * 总页数
    */
-  TotalPage: number
+  TotalPage?: number
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -823,6 +823,13 @@ export interface GetDevicesRequest {
    * 搜索设备的关键字（ID或者设备名），为空时匹配所有设备
    */
   Keyword?: string
+  /**
+   * DeviceType
+不传：返回所有设备；
+1:自有设备；
+2:三方设备
+   */
+  DeviceType?: number
 }
 
 /**