tencentcloud-sdk-nodejs 4.1.40 → 4.1.42

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -378,9 +378,7 @@ export interface CreatePreparedPersonalEsignRequest {
      */
     IdCardType?: string;
     /**
-     * 印章图片的base64
-  注：已废弃
-  请先通过UploadFiles接口上传文件，获取 FileId
+     * 该字段已不再使用
      * @deprecated
      */
     SealImage?: string;
@@ -393,7 +391,7 @@ export interface CreatePreparedPersonalEsignRequest {
      */
     Mobile?: string;
     /**
-     * 此字段已废弃，请勿继续使用。
+     * 该字段已不再使用
      */
     EnableAutoSign?: boolean;
     /**
@@ -1246,6 +1244,11 @@ export interface CreateFlowOption {
    - 签署控件 是否默认展示日期.
      */
     SignComponentConfig?: SignComponentConfig;
+    /**
+     * 是否禁止编辑（展示）水印控件属性
+  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+     */
+    ForbidEditWatermark?: boolean;
 }
 /**
  * CreateOrganizationAuthFile返回参数结构体
@@ -2751,7 +2754,7 @@ export interface CreateFlowRequest {
      */
     FlowType?: string;
     /**
-     * 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
+     * 该字段已不再使用
      */
     ClientToken?: string;
     /**
@@ -3243,6 +3246,31 @@ export interface DescribeExtendedServiceAuthDetailRequest {
      */
     Offset?: number;
 }
+/**
+ * CreateUserNameChangeUrl请求参数结构体
+ */
+export interface CreateUserNameChangeUrlRequest {
+    /**
+     * 操作人信息
+     */
+    Operator: UserInfo;
+    /**
+     * 要跳转的链接类型
+  
+  <ul>
+  <li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
+  <li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
+  <li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>
+  </ul>
+  
+  注：如果不传递，默认值是 <font color="red"> HTTP </font>
+     */
+    Endpoint?: string;
+    /**
+     * 在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
+     */
+    UserData?: string;
+}
 /**
  * CreateOrganizationAuthFile请求参数结构体
  */
@@ -6133,7 +6161,7 @@ export interface CreateDocumentRequest {
      */
     Agent?: Agent;
     /**
-     * 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
+     * 该字段已不再使用
      */
     ClientToken?: string;
 }
@@ -7180,9 +7208,9 @@ export interface ApproverInfo {
      */
     ApproverRoleName?: string;
     /**
-     * <font coloe="red">【已废弃】</font>签署意愿确认渠道，默认为WEIXINAPP:人脸识别
+     * <font color="red">【已不再使用】</font>签署意愿确认渠道，默认为WEIXINAPP:人脸识别
   
-  注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
+  注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
      */
     VerifyChannel?: Array<string>;
     /**
@@ -7550,6 +7578,36 @@ export interface DeleteOrganizationAuthorizationsRequest {
      */
     Agent?: Agent;
 }
+/**
+ * StartFlow请求参数结构体
+ */
+export interface StartFlowRequest {
+    /**
+     * 本合同的发起人，<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
+     */
+    Operator: UserInfo;
+    /**
+     * 合同流程ID，为32位字符串。
+  此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
+     */
+    FlowId: string;
+    /**
+     * 客户端Token，保持接口幂等性,最大长度64个字符
+     * @deprecated
+     */
+    ClientToken?: string;
+    /**
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+     */
+    Agent?: Agent;
+    /**
+     * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
+  <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
+  <li> **1** : 签署完成后通知对方来查看合同</li></ul>
+     */
+    CcNotifyType?: number;
+}
 /**
  * CreateBatchOrganizationRegistrationTasks请求参数结构体
  */
@@ -8190,34 +8248,38 @@ export interface VerifyDigitFileResult {
     SignerName?: string;
 }
 /**
- * StartFlow请求参数结构体
+ * CreateUserNameChangeUrl返回参数结构体
  */
-export interface StartFlowRequest {
-    /**
-     * 本合同的发起人，<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
-     */
-    Operator: UserInfo;
+export interface CreateUserNameChangeUrlResponse {
     /**
-     * 合同流程ID，为32位字符串。
-  此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
+     * 腾讯电子签小程序的个人更名链接。
+  如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
+  
+  <strong>1.如果EndPoint是APP</strong>：
+  得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
+  
+  <strong>2.如果EndPoint是HTTP</strong>：
+  得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署
+  
+  <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：
+  得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署
+  
+  
+  `注：` <font color="red">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>
      */
-    FlowId: string;
+    UserVerifyUrl?: string;
     /**
-     * 客户端Token，保持接口幂等性,最大长度64个字符
-     * @deprecated
+     * 链接过期时间，为Unix时间戳（单位为秒）。
      */
-    ClientToken?: string;
+    ExpireTime?: number;
     /**
-     * 代理企业和员工的信息。
-  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+     * 小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回
      */
-    Agent?: Agent;
+    MiniAppId?: string;
     /**
-     * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
-  <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
-  <li> **1** : 签署完成后通知对方来查看合同</li></ul>
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    CcNotifyType?: number;
+    RequestId?: string;
 }
 /**
  * CreateSeal返回参数结构体
@@ -8301,7 +8363,7 @@ export interface CreatePrepareFlowRequest {
      */
     IntelligentStatus?: string;
     /**
-     * 该字段已废弃，请使用InitiatorComponents
+     * 该字段已不再使用，请使用InitiatorComponents
      */
     Components?: Component;
     /**
@@ -8359,7 +8421,7 @@ export interface CreatePrepareFlowRequest {
      */
     FlowDisplayType?: number;
     /**
-     * <font color="red">此参数已经废弃，请使用 CreateFlowOption 里面的 SignComponentConfig</font>
+     * <font color="red">此字段已不再使用，请使用 CreateFlowOption 里面的 SignComponentConfig</font>
   签署控件的配置信息，用在嵌入式发起的页面配置，
   包括
   
@@ -9778,9 +9840,7 @@ export interface UploadFilesRequest {
      */
     CoverRect?: boolean;
     /**
-     * 用户自定义ID数组，与上传文件一一对应
-  
-  注: `历史遗留问题，已经废弃，调用接口时不用赋值`
+     * 该字段已不再使用
      */
     CustomIds?: Array<string>;
     /**
@@ -9945,6 +10005,12 @@ export interface EmbedUrlOption {
   注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，
      */
     SkipUploadFile?: boolean;
+    /**
+     * 是否禁止编辑（展示）水印控件属性
+  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+  
+     */
+    ForbidEditWatermark?: boolean;
 }
 /**
  * CreateBatchOrganizationAuthorizationUrl请求参数结构体

package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts

@@ -471,7 +471,7 @@ Agent参数中的OpenId 必须为审批者的openId，且链接必须由审批
     /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
+目前该接口只支持B2C，<font color='red'> **不建议使用**</font>。
      */
     PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
     /**

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -559,7 +559,7 @@ Agent参数中的OpenId 必须为审批者的openId，且链接必须由审批
     /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
+目前该接口只支持B2C，<font color='red'> **不建议使用**</font>。
      */
     async PrepareFlows(req, cb) {
         return this.request("PrepareFlows", req, cb);

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -1189,6 +1189,11 @@ export interface CreateFlowOption {
    - 签署控件 是否默认展示日期.
      */
     SignComponentConfig?: SignComponentConfig;
+    /**
+     * 是否禁止编辑（展示）水印控件属性
+  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+     */
+    ForbidEditWatermark?: boolean;
 }
 /**
  * ChannelCreateRole请求参数结构体
@@ -1630,7 +1635,7 @@ export interface ChannelCreateFlowSignUrlRequest {
     /**
      * 流程签署人列表，其中结构体的ApproverType必传。
   若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
-  若为子客企业签署方则需传OpenId、OrganizationOpenId，OrganizationName 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
+  若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName， 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
   
   此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有：
   1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。
@@ -3766,6 +3771,8 @@ export interface SignUrlInfo {
     FlowGroupId?: string;
     /**
      * 二维码，在生成动态签署人跳转封面页链接时返回
+  
+  注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`
      */
     SignQrcodeUrl?: string;
 }
@@ -3912,6 +3919,8 @@ export interface FillApproverInfo {
     RecipientId: string;
     /**
      * 指定企业经办签署人OpenId
+  
+  注: `签署人OpenId未实名时，需要传入签署人姓名以及手机号码。`
      */
     OpenId?: string;
     /**
@@ -4755,7 +4764,7 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
      * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
   <ul>
   <li>若为个人参与方：ApproverType:"PERSON"</li>
-  <li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
+  <li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。（如果OrganizationOpenId对应子客企业已经认证激活，则可以省略OrganizationName参数）</li>
   </ul>
   
   注:
@@ -5910,7 +5919,7 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
      */
     Mobile?: string;
     /**
-     * 此字段已废弃，请勿继续使用。
+     * 该字段已不再使用
      */
     EnableAutoSign?: boolean;
     /**
@@ -8927,6 +8936,11 @@ export interface EmbedUrlOption {
   注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
      */
     SkipUploadFile?: string;
+    /**
+     * 是否禁止编辑（展示）水印控件属性
+  <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+     */
+    ForbidEditWatermark?: boolean;
 }
 /**
  * CreateBatchOrganizationAuthorizationUrl请求参数结构体

package/tencentcloud/services/gs/v20191118/gs_models.d.ts

@@ -1649,6 +1649,14 @@ export interface AndroidInstance {
      * 内网 IP
      */
     PrivateIP?: string;
+    /**
+     * 创建时间
+     */
+    CreateTime?: string;
+    /**
+     * 机箱 ID
+     */
+    HostServerSerialNumber?: string;
 }
 /**
  * RebootAndroidInstanceHosts请求参数结构体

package/tencentcloud/services/hai/v20230812/hai_client.d.ts

@@ -8,11 +8,11 @@ import { InquirePriceRunInstancesResponse, StopInstanceRequest, DescribeServiceL
 export declare class Client extends AbstractClient {
     constructor(clientConfig: ClientConfig);
     /**
-     * 查询实例
+     * 本接口（DescribeInstances）用户查询实例
      */
     DescribeInstances(req: DescribeInstancesRequest, cb?: (error: string, rep: DescribeInstancesResponse) => void): Promise<DescribeInstancesResponse>;
     /**
-     * 查询应用
+     * 本接口（DescribeApplications）用于查询应用
      */
     DescribeApplications(req: DescribeApplicationsRequest, cb?: (error: string, rep: DescribeApplicationsResponse) => void): Promise<DescribeApplicationsResponse>;
     /**
@@ -20,11 +20,11 @@ export declare class Client extends AbstractClient {
      */
     DescribeMuskPrompts(req: DescribeMuskPromptsRequest, cb?: (error: string, rep: DescribeMuskPromptsResponse) => void): Promise<DescribeMuskPromptsResponse>;
     /**
-     * 查询场景
+     * 本接口（DescribeScenes）用于查询场景
      */
     DescribeScenes(req: DescribeScenesRequest, cb?: (error: string, rep: DescribeScenesResponse) => void): Promise<DescribeScenesResponse>;
     /**
-     * 查询地域列表
+     * 本接口（DescribeRegions）用于查询地域列表
      */
     DescribeRegions(req?: DescribeRegionsRequest, cb?: (error: string, rep: DescribeRegionsResponse) => void): Promise<DescribeRegionsResponse>;
     /**
@@ -33,6 +33,7 @@ export declare class Client extends AbstractClient {
     RunInstances(req: RunInstancesRequest, cb?: (error: string, rep: RunInstancesResponse) => void): Promise<RunInstancesResponse>;
     /**
      * 本接口 (StartInstance) 用于主动启动实例。
+‘运行中’、‘预付费’的实例不支持启动实例
      */
     StartInstance(req: StartInstanceRequest, cb?: (error: string, rep: StartInstanceResponse) => void): Promise<StartInstanceResponse>;
     /**
@@ -44,11 +45,11 @@ export declare class Client extends AbstractClient {
      */
     TerminateInstances(req: TerminateInstancesRequest, cb?: (error: string, rep: TerminateInstancesResponse) => void): Promise<TerminateInstancesResponse>;
     /**
-     * 查询实例的网络配置及消耗情况
+     * 本接口（DescribeInstanceNetworkStatus）用于查询实例的网络配置及消耗情况
      */
     DescribeInstanceNetworkStatus(req: DescribeInstanceNetworkStatusRequest, cb?: (error: string, rep: DescribeInstanceNetworkStatusResponse) => void): Promise<DescribeInstanceNetworkStatusResponse>;
     /**
-     * 查询服务登录配置
+     * 本接口（DescribeServiceLoginSettings）用于查询服务登录配置
      */
     DescribeServiceLoginSettings(req: DescribeServiceLoginSettingsRequest, cb?: (error: string, rep: DescribeServiceLoginSettingsResponse) => void): Promise<DescribeServiceLoginSettingsResponse>;
     /**
@@ -57,10 +58,11 @@ export declare class Client extends AbstractClient {
     InquirePriceRunInstances(req: InquirePriceRunInstancesRequest, cb?: (error: string, rep: InquirePriceRunInstancesResponse) => void): Promise<InquirePriceRunInstancesResponse>;
     /**
      * 本接口 (StopInstance) 用于主动关闭实例。
+‘已关机’、‘预付费’的实例不支持关机
      */
     StopInstance(req: StopInstanceRequest, cb?: (error: string, rep: StopInstanceResponse) => void): Promise<StopInstanceResponse>;
     /**
-     * 本接口（CreateApplicaiton）用于对HAI实例制作自定义应用。
+     * 本接口（CreateApplication）用于对HAI实例制作自定义应用。
      */
     CreateApplication(req: CreateApplicationRequest, cb?: (error: string, rep: CreateApplicationResponse) => void): Promise<CreateApplicationResponse>;
 }

package/tencentcloud/services/hai/v20230812/hai_client.js

@@ -28,13 +28,13 @@ class Client extends abstract_client_1.AbstractClient {
         super("hai.tencentcloudapi.com", "2023-08-12", clientConfig);
     }
     /**
-     * 查询实例
+     * 本接口（DescribeInstances）用户查询实例
      */
     async DescribeInstances(req, cb) {
         return this.request("DescribeInstances", req, cb);
     }
     /**
-     * 查询应用
+     * 本接口（DescribeApplications）用于查询应用
      */
     async DescribeApplications(req, cb) {
         return this.request("DescribeApplications", req, cb);
@@ -46,13 +46,13 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("DescribeMuskPrompts", req, cb);
     }
     /**
-     * 查询场景
+     * 本接口（DescribeScenes）用于查询场景
      */
     async DescribeScenes(req, cb) {
         return this.request("DescribeScenes", req, cb);
     }
     /**
-     * 查询地域列表
+     * 本接口（DescribeRegions）用于查询地域列表
      */
     async DescribeRegions(req, cb) {
         return this.request("DescribeRegions", req, cb);
@@ -65,6 +65,7 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 本接口 (StartInstance) 用于主动启动实例。
+‘运行中’、‘预付费’的实例不支持启动实例
      */
     async StartInstance(req, cb) {
         return this.request("StartInstance", req, cb);
@@ -82,13 +83,13 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("TerminateInstances", req, cb);
     }
     /**
-     * 查询实例的网络配置及消耗情况
+     * 本接口（DescribeInstanceNetworkStatus）用于查询实例的网络配置及消耗情况
      */
     async DescribeInstanceNetworkStatus(req, cb) {
         return this.request("DescribeInstanceNetworkStatus", req, cb);
     }
     /**
-     * 查询服务登录配置
+     * 本接口（DescribeServiceLoginSettings）用于查询服务登录配置
      */
     async DescribeServiceLoginSettings(req, cb) {
         return this.request("DescribeServiceLoginSettings", req, cb);
@@ -101,12 +102,13 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 本接口 (StopInstance) 用于主动关闭实例。
+‘已关机’、‘预付费’的实例不支持关机
      */
     async StopInstance(req, cb) {
         return this.request("StopInstance", req, cb);
     }
     /**
-     * 本接口（CreateApplicaiton）用于对HAI实例制作自定义应用。
+     * 本接口（CreateApplication）用于对HAI实例制作自定义应用。
      */
     async CreateApplication(req, cb) {
         return this.request("CreateApplication", req, cb);