tencentcloud-sdk-nodejs 4.1.197 → 4.1.198
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/es/common/sdk_version.js +1 -1
- package/es/services/bh/v20230418/bh_client.js +20 -8
- package/es/services/cynosdb/v20190107/cynosdb_client.js +69 -27
- package/es/services/tcb/v20180608/tcb_client.js +50 -20
- package/es/services/tione/v20211111/tione_client.js +3 -0
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/ags/v20250920/ags_models.d.ts +26 -26
- package/tencentcloud/services/bh/v20230418/bh_client.d.ts +25 -9
- package/tencentcloud/services/bh/v20230418/bh_client.js +36 -12
- package/tencentcloud/services/bh/v20230418/bh_models.d.ts +172 -100
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +23 -15
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +8 -9
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +85 -29
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +126 -42
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1260 -456
- package/tencentcloud/services/emr/v20190103/emr_client.d.ts +2 -2
- package/tencentcloud/services/emr/v20190103/emr_client.js +2 -2
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +16 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +32 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +25 -88
- package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +9 -0
- package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +31 -31
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +56 -56
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +7 -7
- package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +60 -33
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +4 -5
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +21 -13
- package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +94 -37
- package/tencentcloud/services/tcb/v20180608/tcb_client.js +123 -46
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1076 -157
- package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
- package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +363 -48
- package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +1 -1
- package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +11 -11
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +11 -41
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +62 -0
|
@@ -150,8 +150,8 @@ export declare class Client extends AbstractClient {
|
|
|
150
150
|
*/
|
|
151
151
|
SyncPodState(req: SyncPodStateRequest, cb?: (error: string, rep: SyncPodStateResponse) => void): Promise<SyncPodStateResponse>;
|
|
152
152
|
/**
|
|
153
|
-
* 本接口(CreateSLInstance)用于创建Serverless
|
|
154
|
-
- 接口调用成功,会创建Serverless
|
|
153
|
+
* 本接口(CreateSLInstance)用于创建Serverless实例、如HBase、Starrocks、TCBase等
|
|
154
|
+
- 接口调用成功,会创建Serverless实例,创建实例请求成功会返回创建实例的InstaceId和请求的 RequestID。
|
|
155
155
|
- 接口为异步接口,接口返回时操作并未立即完成,实例操作结果可以通过调用DescribeInstancesList查看当前实例的StatusDesc状态。
|
|
156
156
|
*/
|
|
157
157
|
CreateSLInstance(req: CreateSLInstanceRequest, cb?: (error: string, rep: CreateSLInstanceResponse) => void): Promise<CreateSLInstanceResponse>;
|
|
@@ -240,8 +240,8 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
240
240
|
return this.request("SyncPodState", req, cb);
|
|
241
241
|
}
|
|
242
242
|
/**
|
|
243
|
-
* 本接口(CreateSLInstance)用于创建Serverless
|
|
244
|
-
- 接口调用成功,会创建Serverless
|
|
243
|
+
* 本接口(CreateSLInstance)用于创建Serverless实例、如HBase、Starrocks、TCBase等
|
|
244
|
+
- 接口调用成功,会创建Serverless实例,创建实例请求成功会返回创建实例的InstaceId和请求的 RequestID。
|
|
245
245
|
- 接口为异步接口,接口返回时操作并未立即完成,实例操作结果可以通过调用DescribeInstancesList查看当前实例的StatusDesc状态。
|
|
246
246
|
*/
|
|
247
247
|
async CreateSLInstance(req, cb) {
|
|
@@ -7913,6 +7913,10 @@ export interface CreateSLInstanceRequest {
|
|
|
7913
7913
|
* 部署模式
|
|
7914
7914
|
*/
|
|
7915
7915
|
DeploymentMode?: string;
|
|
7916
|
+
/**
|
|
7917
|
+
* 服务用户名,对不需要用户名的服务不用传,8-16个字符,支持大写字母、小写字母、数字
|
|
7918
|
+
*/
|
|
7919
|
+
UserName?: string;
|
|
7916
7920
|
}
|
|
7917
7921
|
/**
|
|
7918
7922
|
* 弹性扩缩容规格配置
|
|
@@ -8233,10 +8237,18 @@ export interface SLInstanceInfo {
|
|
|
8233
8237
|
* 主可用区私有网络ID
|
|
8234
8238
|
*/
|
|
8235
8239
|
VpcId?: number;
|
|
8240
|
+
/**
|
|
8241
|
+
* 主可用区私有网络名
|
|
8242
|
+
*/
|
|
8243
|
+
VpcName?: string;
|
|
8236
8244
|
/**
|
|
8237
8245
|
* 主可用区子网ID
|
|
8238
8246
|
*/
|
|
8239
8247
|
SubnetId?: number;
|
|
8248
|
+
/**
|
|
8249
|
+
* 主可用区子网名
|
|
8250
|
+
*/
|
|
8251
|
+
SubnetName?: string;
|
|
8240
8252
|
/**
|
|
8241
8253
|
* 状态码
|
|
8242
8254
|
*/
|
|
@@ -8275,6 +8287,10 @@ export interface SLInstanceInfo {
|
|
|
8275
8287
|
* 主备部署角色
|
|
8276
8288
|
*/
|
|
8277
8289
|
DeployRole?: string;
|
|
8290
|
+
/**
|
|
8291
|
+
* webui地址
|
|
8292
|
+
*/
|
|
8293
|
+
WebUIUrl?: string;
|
|
8278
8294
|
}
|
|
8279
8295
|
/**
|
|
8280
8296
|
* ModifyUserManagerPwd请求参数结构体
|
|
@@ -1109,6 +1109,11 @@ export interface AuthRecord {
|
|
|
1109
1109
|
<li> **5**:客户确认AI信息</li></ul>
|
|
1110
1110
|
*/
|
|
1111
1111
|
AuditStatus?: number;
|
|
1112
|
+
/**
|
|
1113
|
+
* 审核失败原因,
|
|
1114
|
+
当 AuditStatus 返回2时,则会返回具体的原因。
|
|
1115
|
+
*/
|
|
1116
|
+
Reason?: string;
|
|
1112
1117
|
}
|
|
1113
1118
|
/**
|
|
1114
1119
|
* UnbindEmployeeUserIdWithClientOpenId请求参数结构体
|
|
@@ -3407,6 +3412,10 @@ export interface CreateSchemeUrlRequest {
|
|
|
3407
3412
|
* 在动态签署人场景预设了“企业名称”时,可通过该参数控制“已认证身份才可领取”,即在加入了预设的企业后才可领取。默认值:false,无须先加入企业。
|
|
3408
3413
|
*/
|
|
3409
3414
|
PickUpAfterJoined?: boolean;
|
|
3415
|
+
/**
|
|
3416
|
+
* 是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注:`1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。`
|
|
3417
|
+
*/
|
|
3418
|
+
CanSkipReadFlow?: boolean;
|
|
3410
3419
|
}
|
|
3411
3420
|
/**
|
|
3412
3421
|
* 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
|
|
@@ -4283,6 +4292,10 @@ export interface BatchOrganizationRegistrationTasksDetails {
|
|
|
4283
4292
|
* 如果任务失败,会返回错误信息
|
|
4284
4293
|
*/
|
|
4285
4294
|
ErrorMessage?: string;
|
|
4295
|
+
/**
|
|
4296
|
+
* 认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。认证流 Id可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)
|
|
4297
|
+
*/
|
|
4298
|
+
AuthorizationInfoId?: string;
|
|
4286
4299
|
}
|
|
4287
4300
|
/**
|
|
4288
4301
|
* 参与方填写控件信息
|
|
@@ -4409,7 +4422,8 @@ export interface CreateBatchContractReviewTaskRequest {
|
|
|
4409
4422
|
*/
|
|
4410
4423
|
PolicyType?: number;
|
|
4411
4424
|
/**
|
|
4412
|
-
*
|
|
4425
|
+
* 该字段已不再使用!
|
|
4426
|
+
合同审查中的角色信息,通过明确入参角色的名称和描述,可以提高合同审查的效率和准确性。用户不做配置时大模型会根据合同内容推荐出风险识别角色的名称和描述信息。
|
|
4413
4427
|
*/
|
|
4414
4428
|
Role?: RiskIdentificationRoleInfo;
|
|
4415
4429
|
/**
|
|
@@ -4417,7 +4431,8 @@ export interface CreateBatchContractReviewTaskRequest {
|
|
|
4417
4431
|
*/
|
|
4418
4432
|
Roles?: Array<RiskIdentificationRoleInfo>;
|
|
4419
4433
|
/**
|
|
4420
|
-
*
|
|
4434
|
+
* 该字段已不再使用!
|
|
4435
|
+
用户配置的审查清单ID,基于此清单ID批量创建合同审查任务,为32位字符串。[点击查看审查清单ID在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/2c6588549e28ca49bd8bb7f4a072b19e.png)。如果用户不做此配置大模型会根据合同内容在当前企业下的审查清单和系统默认的清单中选择一个清单进行审查。
|
|
4421
4436
|
*/
|
|
4422
4437
|
ChecklistId?: string;
|
|
4423
4438
|
/**
|
|
@@ -9709,7 +9724,8 @@ export interface CreateSealPolicyRequest {
|
|
|
9709
9724
|
*/
|
|
9710
9725
|
export interface DescribeContractReviewTaskResponse {
|
|
9711
9726
|
/**
|
|
9712
|
-
*
|
|
9727
|
+
* 该字段已不再使用!
|
|
9728
|
+
用于审查任务的审查清单ID。注意:如果用户没有配置清单时此值可能为空,需要等大模型根据合同内容推荐出可以使用的审查清单。
|
|
9713
9729
|
*/
|
|
9714
9730
|
ChecklistId?: string;
|
|
9715
9731
|
/**
|
|
@@ -9746,7 +9762,8 @@ export interface DescribeContractReviewTaskResponse {
|
|
|
9746
9762
|
*/
|
|
9747
9763
|
Risks?: Array<OutputRisk>;
|
|
9748
9764
|
/**
|
|
9749
|
-
*
|
|
9765
|
+
* 该字段已不再使用!
|
|
9766
|
+
合同审查中的角色信息。注意: `如果用户没有配置审查角色时此值可能为null,需要等大模型根据合同内容推荐出审查角色信息。`
|
|
9750
9767
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
9751
9768
|
*/
|
|
9752
9769
|
Role?: RiskIdentificationRoleInfo;
|
|
@@ -11946,6 +11963,17 @@ export interface DescribeOrganizationAuthStatusRequest {
|
|
|
11946
11963
|
* 法人姓名
|
|
11947
11964
|
*/
|
|
11948
11965
|
LegalName?: string;
|
|
11966
|
+
/**
|
|
11967
|
+
* 认证流 Id 是指在企业认证过程中,当前操作人的认证流程的唯一标识。每个企业在认证过程中只能有一条认证流认证成功。这意味着在同一认证过程内,一个企业只能有一个认证流程处于成功状态,以确保认证的唯一性和有效性。
|
|
11968
|
+
|
|
11969
|
+
|
|
11970
|
+
认证流 Id可以通过回调[授权书认证审核结果回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E5%85%AD-%E6%8E%88%E6%9D%83%E4%B9%A6%E8%AE%A4%E8%AF%81%E5%AE%A1%E6%A0%B8%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)获取
|
|
11971
|
+
|
|
11972
|
+
注意:
|
|
11973
|
+
如果传递了认证流Id,则下面的参数 超管二要素不会生效
|
|
11974
|
+
示例值:yDCHHUUckpbdaiqbUxJVsHWy99WG6kTY
|
|
11975
|
+
*/
|
|
11976
|
+
AuthorizationInfoId?: string;
|
|
11949
11977
|
}
|
|
11950
11978
|
/**
|
|
11951
11979
|
* CreateUserAutoSignSealUrl请求参数结构体
|
|
@@ -5069,149 +5069,86 @@ export interface DescribeUsageResponse {
|
|
|
5069
5069
|
*/
|
|
5070
5070
|
export interface CreateSignUrlsRequest {
|
|
5071
5071
|
/**
|
|
5072
|
-
*
|
|
5073
|
-
|
|
5074
|
-
此接口下面信息必填。
|
|
5075
|
-
<ul>
|
|
5076
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
5077
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5078
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
5079
|
-
</ul>
|
|
5080
|
-
第三方平台子客企业和员工必须已经过实名认证
|
|
5072
|
+
* <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
|
|
5081
5073
|
*/
|
|
5082
5074
|
Agent: Agent;
|
|
5083
5075
|
/**
|
|
5084
|
-
*
|
|
5085
|
-
|
|
5086
|
-
注:
|
|
5087
|
-
1. 必须选择提供此参数或合同组编号中的一个。
|
|
5088
|
-
2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
|
|
5076
|
+
* <p>合同流程ID数组,最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。</li></ol>
|
|
5089
5077
|
*/
|
|
5090
5078
|
FlowIds?: Array<string>;
|
|
5091
5079
|
/**
|
|
5092
|
-
*
|
|
5093
|
-
注:`该参数和合同流程ID数组必须二选一`
|
|
5080
|
+
* <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
|
|
5094
5081
|
*/
|
|
5095
5082
|
FlowGroupId?: string;
|
|
5096
5083
|
/**
|
|
5097
|
-
*
|
|
5098
|
-
<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
|
|
5099
|
-
<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
|
|
5100
|
-
<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
|
|
5101
|
-
<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
|
|
5102
|
-
|
|
5103
|
-
**注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
|
|
5104
|
-
|
|
5105
|
-
详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
|
|
5106
|
-
|
|
5084
|
+
* <p>签署链接类型,可以设置的参数如下</p><ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li><li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li><li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li><li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul><p><strong>注:</strong>动态签署人场景,如果签署链接类型设置为<code>APP</code>,则仅支持跳转到封面页。</p><p>详细使用场景可以参考接口描述说明中的 <strong>主要使用场景EndPoint分类</strong></p>
|
|
5107
5085
|
*/
|
|
5108
5086
|
Endpoint?: string;
|
|
5109
5087
|
/**
|
|
5110
|
-
*
|
|
5111
|
-
|
|
5112
|
-
<ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
|
|
5113
|
-
<li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
|
|
5114
|
-
<li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
|
|
5115
|
-
<li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
|
|
5116
|
-
<li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
|
|
5117
|
-
<li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
|
|
5088
|
+
* <p>签署链接生成类型,可以选择的类型如下</p><ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li><li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li><li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li><li><strong>PERSON</strong>:适用于个人或自然人签署方。</li><li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li><li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
|
|
5118
5089
|
*/
|
|
5119
5090
|
GenerateType?: string;
|
|
5120
5091
|
/**
|
|
5121
|
-
* SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注:
|
|
5092
|
+
* <p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: <code>1.GenerateType为"NOT_CHANNEL"时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
|
|
5122
5093
|
*/
|
|
5123
5094
|
OrganizationName?: string;
|
|
5124
5095
|
/**
|
|
5125
|
-
*
|
|
5126
|
-
注:
|
|
5127
|
-
1. `GenerateType为"PERSON"(即个人签署方)时必填`。
|
|
5128
|
-
2. `在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
5096
|
+
* <p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为"PERSON"(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
|
|
5129
5097
|
*/
|
|
5130
5098
|
Name?: string;
|
|
5131
5099
|
/**
|
|
5132
|
-
*
|
|
5133
|
-
注:
|
|
5134
|
-
1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
|
|
5135
|
-
2. `在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
5100
|
+
* <p>合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注: </p><ol><li><code>GenerateType为"PERSON"或"FOLLOWER"时必填。</code></li><li><code>在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
|
|
5136
5101
|
*/
|
|
5137
5102
|
Mobile?: string;
|
|
5138
5103
|
/**
|
|
5139
|
-
*
|
|
5140
|
-
<ul><li>ID_CARD : 中国大陆居民身份证</li>
|
|
5141
|
-
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
|
|
5142
|
-
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
|
|
5143
|
-
|
|
5144
|
-
`注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
|
|
5104
|
+
* <p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p><code>注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。</code></p>
|
|
5145
5105
|
*/
|
|
5146
5106
|
IdCardType?: string;
|
|
5147
5107
|
/**
|
|
5148
|
-
*
|
|
5149
|
-
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
5150
|
-
<li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
5151
|
-
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
5152
|
-
|
|
5153
|
-
`注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
5108
|
+
* <p>证件号码,应符合以下规则</p><ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul><p><code>注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></p>
|
|
5154
5109
|
*/
|
|
5155
5110
|
IdCardNumber?: string;
|
|
5156
5111
|
/**
|
|
5157
|
-
*
|
|
5112
|
+
* <p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: <code>1.GenerateType为"CHANNEL"时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
|
|
5158
5113
|
*/
|
|
5159
5114
|
OrganizationOpenId?: string;
|
|
5160
5115
|
/**
|
|
5161
|
-
*
|
|
5162
|
-
|
|
5163
|
-
注:
|
|
5164
|
-
如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)
|
|
5116
|
+
* <p>第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注:<br>如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)</p>
|
|
5165
5117
|
*/
|
|
5166
5118
|
OpenId?: string;
|
|
5167
5119
|
/**
|
|
5168
|
-
*
|
|
5169
|
-
<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
|
|
5170
|
-
|
|
5171
|
-
注:
|
|
5172
|
-
1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
|
|
5173
|
-
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
5174
|
-
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
5120
|
+
* <p>签署完成后是否自动回跳</p><ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
|
|
5175
5121
|
*/
|
|
5176
5122
|
AutoJumpBack?: boolean;
|
|
5177
5123
|
/**
|
|
5178
|
-
*
|
|
5124
|
+
* <p>签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。</p>
|
|
5179
5125
|
*/
|
|
5180
5126
|
JumpUrl?: string;
|
|
5181
5127
|
/**
|
|
5182
|
-
*
|
|
5128
|
+
* <p>暂未开放</p>
|
|
5183
5129
|
* @deprecated
|
|
5184
5130
|
*/
|
|
5185
5131
|
Operator?: UserInfo;
|
|
5186
5132
|
/**
|
|
5187
|
-
*
|
|
5188
|
-
|
|
5189
|
-
<ul><li> **0** :合同签署页面更多操作按钮</li>
|
|
5190
|
-
<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
|
|
5191
|
-
<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
|
|
5192
|
-
<li> **3** :签署成功页的查看详情按钮</li>
|
|
5193
|
-
<li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
|
|
5194
|
-
<li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
|
|
5195
|
-
|
|
5196
|
-
注: `字段为数组, 可以传值隐藏多个按钮`
|
|
5133
|
+
* <p>生成的签署链接在签署页面隐藏的按钮列表,可设置如下:</p><ul><li> **0** :合同签署页面更多操作按钮</li><li> **1** :合同签署页面更多操作的拒绝签署按钮</li><li> **2** :合同签署页面更多操作的转他人处理按钮</li><li> **3** :签署成功页的查看详情按钮</li><li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li><li> **5** :合同签署页面更多操作的撤销按钮</li></ul><p>注: <code>字段为数组, 可以传值隐藏多个按钮</code></p>
|
|
5197
5134
|
*/
|
|
5198
5135
|
Hides?: Array<number | bigint>;
|
|
5199
5136
|
/**
|
|
5200
|
-
*
|
|
5201
|
-
|
|
5202
|
-
注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
|
|
5137
|
+
* <p>参与方角色ID,用于生成动态签署人链接完成领取。</p><p>注:<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>,</p>
|
|
5203
5138
|
*/
|
|
5204
5139
|
RecipientIds?: Array<string>;
|
|
5205
5140
|
/**
|
|
5206
|
-
*
|
|
5141
|
+
* <p>合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。</p>
|
|
5207
5142
|
*/
|
|
5208
5143
|
FlowGroupUrlInfo?: FlowGroupUrlInfo;
|
|
5209
5144
|
/**
|
|
5210
|
-
* <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为
|
|
5211
|
-
|
|
5212
|
-
参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
|
|
5145
|
+
* <p><font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 </p><p>参考 <a href="https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC">公众号 H5 跳转电子签小程序</a>。</p>
|
|
5213
5146
|
*/
|
|
5214
5147
|
UrlUseEnv?: string;
|
|
5148
|
+
/**
|
|
5149
|
+
* <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p><p>默认值:false</p>
|
|
5150
|
+
*/
|
|
5151
|
+
CanSkipReadFlow?: boolean;
|
|
5215
5152
|
}
|
|
5216
5153
|
/**
|
|
5217
5154
|
* 企业认证信息参数, 需要保证这些参数跟营业执照中的信息一致。
|
|
@@ -7013,11 +6950,11 @@ export interface ChannelOrganizationInfo {
|
|
|
7013
6950
|
*/
|
|
7014
6951
|
export interface CreateSignUrlsResponse {
|
|
7015
6952
|
/**
|
|
7016
|
-
*
|
|
6953
|
+
* <p>生成的签署参与者的签署链接信息数组。</p>
|
|
7017
6954
|
*/
|
|
7018
6955
|
SignUrlInfos?: Array<SignUrlInfo>;
|
|
7019
6956
|
/**
|
|
7020
|
-
*
|
|
6957
|
+
* <p>生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致</p>
|
|
7021
6958
|
*/
|
|
7022
6959
|
ErrorMessages?: Array<string>;
|
|
7023
6960
|
/**
|
|
@@ -208,6 +208,11 @@ export interface RulePayloadItem {
|
|
|
208
208
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
209
209
|
*/
|
|
210
210
|
RelateOption?: string;
|
|
211
|
+
/**
|
|
212
|
+
* 值类型
|
|
213
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
214
|
+
*/
|
|
215
|
+
ValueType?: string;
|
|
211
216
|
}
|
|
212
217
|
/**
|
|
213
218
|
* 终端详情响应对象集合
|
|
@@ -1275,6 +1280,10 @@ export interface AggrCategorySoftDetailRow {
|
|
|
1275
1280
|
* 有新版本可升级的设备数量
|
|
1276
1281
|
*/
|
|
1277
1282
|
UpgradableDeviceNum?: number;
|
|
1283
|
+
/**
|
|
1284
|
+
* 有新版本可升级的设备数量
|
|
1285
|
+
*/
|
|
1286
|
+
UpgradeDeviceNum?: number;
|
|
1278
1287
|
}
|
|
1279
1288
|
/**
|
|
1280
1289
|
* DescribeDeviceInfo返回参数结构体
|
|
@@ -325,82 +325,82 @@ TaskStatus定义如下:
|
|
|
325
325
|
*/
|
|
326
326
|
export interface TaskInfo {
|
|
327
327
|
/**
|
|
328
|
-
*
|
|
328
|
+
* <p>任务ID</p>
|
|
329
329
|
*/
|
|
330
330
|
TaskId?: string;
|
|
331
331
|
/**
|
|
332
|
-
*
|
|
332
|
+
* <p>描述任务名称,指定后可根据名称筛选</p>
|
|
333
333
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
334
334
|
*/
|
|
335
335
|
TaskName?: string;
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* <p>媒资文件ID</p>
|
|
338
338
|
*/
|
|
339
339
|
MediaId?: string;
|
|
340
340
|
/**
|
|
341
|
-
*
|
|
341
|
+
* <p>任务执行状态</p>
|
|
342
342
|
*/
|
|
343
343
|
TaskStatus?: number;
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* <p>任务进度,范围为[0,100]</p>
|
|
346
346
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
347
347
|
*/
|
|
348
348
|
TaskProgress?: number;
|
|
349
349
|
/**
|
|
350
|
-
*
|
|
350
|
+
* <p>任务执行时间</p><p>单位:秒</p>
|
|
351
351
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
352
352
|
*/
|
|
353
353
|
TaskTimeCost?: number;
|
|
354
354
|
/**
|
|
355
|
-
*
|
|
355
|
+
* <p>任务创建时间</p>
|
|
356
356
|
*/
|
|
357
357
|
TaskCreateTime?: string;
|
|
358
358
|
/**
|
|
359
|
-
*
|
|
359
|
+
* <p>任务开始执行时间</p>
|
|
360
360
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
361
361
|
*/
|
|
362
362
|
TaskStartTime?: string;
|
|
363
363
|
/**
|
|
364
|
-
*
|
|
364
|
+
* <p>任务失败原因</p>
|
|
365
365
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
366
366
|
*/
|
|
367
367
|
FailedReason?: string;
|
|
368
368
|
/**
|
|
369
|
-
*
|
|
369
|
+
* <p>任务执行时指定的先验知识</p>
|
|
370
370
|
*/
|
|
371
371
|
MediaPreknownInfo?: MediaPreknownInfo;
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* <p>媒资文件名称</p>
|
|
374
374
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
375
375
|
*/
|
|
376
376
|
MediaName?: string;
|
|
377
377
|
/**
|
|
378
|
-
*
|
|
378
|
+
* <p>媒资自定义标签</p>
|
|
379
379
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
380
380
|
*/
|
|
381
381
|
Label?: string;
|
|
382
382
|
/**
|
|
383
|
-
*
|
|
383
|
+
* <p>任务分析完成后的后调地址</p>
|
|
384
384
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
385
385
|
*/
|
|
386
386
|
CallbackURL?: string;
|
|
387
387
|
/**
|
|
388
|
-
*
|
|
388
|
+
* <p>任务对应的媒资文件元信息,仅在MediaType为Audio时有效</p>
|
|
389
389
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
390
390
|
*/
|
|
391
391
|
AudioMetadata?: AudioMetadata;
|
|
392
392
|
/**
|
|
393
|
-
*
|
|
393
|
+
* <p>任务对应的媒资文件元信息,仅在MediaType为Audio时有效</p>
|
|
394
394
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
395
395
|
*/
|
|
396
396
|
ImageMetadata?: ImageMetadata;
|
|
397
397
|
/**
|
|
398
|
-
*
|
|
398
|
+
* <p>任务对应的媒资文件元信息,仅在MediaType为Text时有效</p>
|
|
399
399
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
400
400
|
*/
|
|
401
401
|
TextMetadata?: TextMetadata;
|
|
402
402
|
/**
|
|
403
|
-
*
|
|
403
|
+
* <p>任务对应的媒资文件元信息,仅在MediaType为Video时有效</p>
|
|
404
404
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
405
405
|
*/
|
|
406
406
|
Metadata?: MediaMetadata;
|
|
@@ -563,27 +563,27 @@ export interface TextData {
|
|
|
563
563
|
*/
|
|
564
564
|
export interface ImageMetadata {
|
|
565
565
|
/**
|
|
566
|
-
*
|
|
566
|
+
* <p>媒资图片文件大小,单位为Byte</p>
|
|
567
567
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
568
568
|
*/
|
|
569
569
|
FileSize: number;
|
|
570
570
|
/**
|
|
571
|
-
*
|
|
571
|
+
* <p>媒资图片文件MD5</p>
|
|
572
572
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
573
573
|
*/
|
|
574
574
|
MD5: string;
|
|
575
575
|
/**
|
|
576
|
-
*
|
|
576
|
+
* <p>媒资图片文件宽度</p><p>单位:像素(px)</p>
|
|
577
577
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
578
578
|
*/
|
|
579
579
|
Width: number;
|
|
580
580
|
/**
|
|
581
|
-
*
|
|
581
|
+
* <p>媒资图片文件高度</p><p>单位:像素(px)</p>
|
|
582
582
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
583
583
|
*/
|
|
584
584
|
Height: number;
|
|
585
585
|
/**
|
|
586
|
-
*
|
|
586
|
+
* <p>媒资图片文件格式</p>
|
|
587
587
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
588
588
|
*/
|
|
589
589
|
Format: string;
|
|
@@ -602,27 +602,27 @@ export interface CreateCustomGroupRequest {
|
|
|
602
602
|
*/
|
|
603
603
|
export interface TextMetadata {
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* <p>媒资文本文件大小,单位为字节</p>
|
|
606
606
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
607
607
|
*/
|
|
608
608
|
FileSize?: number;
|
|
609
609
|
/**
|
|
610
|
-
*
|
|
610
|
+
* <p>媒资文本文件MD5</p>
|
|
611
611
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
612
612
|
*/
|
|
613
613
|
MD5?: string;
|
|
614
614
|
/**
|
|
615
|
-
*
|
|
615
|
+
* <p>媒资文本文件字符数</p><p>单位:字符</p>
|
|
616
616
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
617
617
|
*/
|
|
618
618
|
Length?: number;
|
|
619
619
|
/**
|
|
620
|
-
*
|
|
620
|
+
* <p>媒资文本文件格式</p>
|
|
621
621
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
622
622
|
*/
|
|
623
623
|
Format?: string;
|
|
624
624
|
/**
|
|
625
|
-
*
|
|
625
|
+
* <p>封装格式短后缀</p>
|
|
626
626
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
627
627
|
*/
|
|
628
628
|
ShortFormat?: string;
|
|
@@ -951,22 +951,22 @@ export interface DeleteMediaResponse {
|
|
|
951
951
|
*/
|
|
952
952
|
export interface Rectf {
|
|
953
953
|
/**
|
|
954
|
-
*
|
|
954
|
+
* <p>矩形框左上角水平座标</p>
|
|
955
955
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
956
956
|
*/
|
|
957
957
|
X: number;
|
|
958
958
|
/**
|
|
959
|
-
*
|
|
959
|
+
* <p>矩形框左上角竖直座标</p>
|
|
960
960
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
961
961
|
*/
|
|
962
962
|
Y: number;
|
|
963
963
|
/**
|
|
964
|
-
*
|
|
964
|
+
* <p>矩形框宽度</p><p>单位:像素(px)</p>
|
|
965
965
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
966
966
|
*/
|
|
967
967
|
Width: number;
|
|
968
968
|
/**
|
|
969
|
-
*
|
|
969
|
+
* <p>矩形框长度</p><p>单位:像素(px)</p>
|
|
970
970
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
971
971
|
*/
|
|
972
972
|
Height: number;
|