tencentcloud-sdk-nodejs-essbasic 4.1.134 → 4.1.137
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/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export declare const essbasic: {
|
|
2
|
-
v20201222: {
|
|
3
|
-
Client: typeof import("./v20201222/essbasic_client").Client;
|
|
4
|
-
Models: typeof import("./v20201222/essbasic_models");
|
|
5
|
-
};
|
|
6
2
|
v20210526: {
|
|
7
3
|
Client: typeof import("./v20210526/essbasic_client").Client;
|
|
8
4
|
Models: typeof import("./v20210526/essbasic_models");
|
|
9
5
|
};
|
|
6
|
+
v20201222: {
|
|
7
|
+
Client: typeof import("./v20201222/essbasic_client").Client;
|
|
8
|
+
Models: typeof import("./v20201222/essbasic_models");
|
|
9
|
+
};
|
|
10
10
|
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.essbasic = void 0;
|
|
4
|
-
const v20201222_1 = require("./v20201222");
|
|
5
4
|
const v20210526_1 = require("./v20210526");
|
|
5
|
+
const v20201222_1 = require("./v20201222");
|
|
6
6
|
exports.essbasic = {
|
|
7
|
-
v20201222: v20201222_1.v20201222,
|
|
8
7
|
v20210526: v20210526_1.v20210526,
|
|
8
|
+
v20201222: v20201222_1.v20201222,
|
|
9
9
|
};
|
|
@@ -248,6 +248,11 @@ export interface Component {
|
|
|
248
248
|
<ul><li> <b>UseSealSize</b>:使用印章设置的大小盖章,true表示使用印章设置的大小盖章,false表示使用签署控件的大小进行盖章;不传则为false</li></ul>
|
|
249
249
|
<b>参数样例</b>:`{"UseSealSize":true}`
|
|
250
250
|
|
|
251
|
+
<font color="red">签署意见功能设置,</font>当ComponentType为SIGN_OPINION时,可以通过以下参数设置签署意见的相关内容:
|
|
252
|
+
<ul><li> <b>Values</b>:签署意见预设的需要用户填写的文本</li>
|
|
253
|
+
<li> <b>ValuesArray</b>:签署意见需要用户按顺序点击的分词(组合后应和Values内容一致)</li></ul>
|
|
254
|
+
<b>参数样例</b>:`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`
|
|
255
|
+
|
|
251
256
|
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
|
|
252
257
|
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
|
|
253
258
|
场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
|
|
@@ -1256,6 +1261,34 @@ export interface CreateFlowOption {
|
|
|
1256
1261
|
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
|
1257
1262
|
*/
|
|
1258
1263
|
ForbidEditWatermark?: boolean;
|
|
1264
|
+
/**
|
|
1265
|
+
* 发起成功后是否预览合同
|
|
1266
|
+
<ul><li>(默认) false -否</li> <li> true - 展示预览按钮</li></ul>
|
|
1267
|
+
*/
|
|
1268
|
+
PreviewAfterStart?: boolean;
|
|
1269
|
+
/**
|
|
1270
|
+
* 发起成功之后是否签署合同,仅当前经办人作为签署人时生效
|
|
1271
|
+
<ul><li>(默认) false -否</li> <li> true - 展示签署按钮</li></ul>
|
|
1272
|
+
*/
|
|
1273
|
+
SignAfterStart?: boolean;
|
|
1274
|
+
/**
|
|
1275
|
+
* 隐藏操作步骤: 具体的控件类型如下
|
|
1276
|
+
|
|
1277
|
+
<ul><li>1 : 选择文件及签署方</li>
|
|
1278
|
+
<li>2 : 补充文件内容</li>
|
|
1279
|
+
<li>4 : 发起前合同信息与设置确认</li>
|
|
1280
|
+
</ul>
|
|
1281
|
+
注:仅对新版页面生效
|
|
1282
|
+
*/
|
|
1283
|
+
HideOperationSteps?: Array<number | bigint>;
|
|
1284
|
+
/**
|
|
1285
|
+
* 本企业简称,注:仅对新版页面生效
|
|
1286
|
+
*/
|
|
1287
|
+
SelfName?: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* 发起后签署码隐藏,默认false,注:仅对新版页面生效
|
|
1290
|
+
*/
|
|
1291
|
+
HideSignCodeAfterStart?: boolean;
|
|
1259
1292
|
}
|
|
1260
1293
|
/**
|
|
1261
1294
|
* ChannelCreateRole请求参数结构体
|
|
@@ -1671,6 +1704,10 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
1671
1704
|
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
1672
1705
|
*/
|
|
1673
1706
|
FlowApproverInfos?: Array<FlowApproverInfo>;
|
|
1707
|
+
/**
|
|
1708
|
+
* 用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。
|
|
1709
|
+
*/
|
|
1710
|
+
VideoVerifyTimesLimit?: number;
|
|
1674
1711
|
/**
|
|
1675
1712
|
* 用户信息,暂未开放
|
|
1676
1713
|
* @deprecated
|
|
@@ -3535,6 +3572,25 @@ export interface OrganizationCommonInfo {
|
|
|
3535
3572
|
*/
|
|
3536
3573
|
OldAdminIdCardNumber?: string;
|
|
3537
3574
|
}
|
|
3575
|
+
/**
|
|
3576
|
+
* 跳转事件的结构体,其中包括认证期间收录,授权书审核,企业认证的回跳事件。
|
|
3577
|
+
*/
|
|
3578
|
+
export interface JumpEvent {
|
|
3579
|
+
/**
|
|
3580
|
+
* 跳转事件枚举,
|
|
3581
|
+
* 1 - 企业收录。
|
|
3582
|
+
* 2 - 超管授权书审核。
|
|
3583
|
+
* 3 - 认证完成。
|
|
3584
|
+
*/
|
|
3585
|
+
JumpEventType?: number;
|
|
3586
|
+
/**
|
|
3587
|
+
* 为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。
|
|
3588
|
+
Endpoint如果是APP 类型,请传递<font color="red">"true"</font>
|
|
3589
|
+
如果 Endpoint 是 H5 类型,请参考文档[跳转电子签H5](https://qian.tencent.com/developers/partner/openqianh5)
|
|
3590
|
+
p.s. 如果Endpoint是 APP,传递的跳转地址无效,不会进行跳转,仅会进行回跳。
|
|
3591
|
+
*/
|
|
3592
|
+
JumpUrl?: string;
|
|
3593
|
+
}
|
|
3538
3594
|
/**
|
|
3539
3595
|
* ArchiveDynamicFlow返回参数结构体
|
|
3540
3596
|
*/
|
|
@@ -3671,7 +3727,8 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3671
3727
|
*/
|
|
3672
3728
|
Endpoint?: string;
|
|
3673
3729
|
/**
|
|
3674
|
-
*
|
|
3730
|
+
* <font color="red">已废弃</font> 请使用 JumpEvents 参数,进行替换。
|
|
3731
|
+
触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
|
|
3675
3732
|
<ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
|
|
3676
3733
|
*/
|
|
3677
3734
|
AutoJumpBackEvent?: string;
|
|
@@ -3689,7 +3746,8 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3689
3746
|
*/
|
|
3690
3747
|
ProxyOperatorIdCardNumber?: string;
|
|
3691
3748
|
/**
|
|
3692
|
-
*
|
|
3749
|
+
* <font color="red">已废弃</font> 请使用 JumpEvents 参数,进行替换。
|
|
3750
|
+
认证完成跳转链接。
|
|
3693
3751
|
注意:`此功能仅在Endpoint参数设置成 H5 或 PC时才有效`。
|
|
3694
3752
|
*/
|
|
3695
3753
|
AutoJumpUrl?: string;
|
|
@@ -3745,6 +3803,12 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3745
3803
|
* @deprecated
|
|
3746
3804
|
*/
|
|
3747
3805
|
Operator?: UserInfo;
|
|
3806
|
+
/**
|
|
3807
|
+
* 跳转事件,其中包括认证期间收录,授权书审核,企业认证的回跳事件。
|
|
3808
|
+
p.s.Endpoint如果是APP 类型,请传递JumpUrl为<font color="red">"true" </font>
|
|
3809
|
+
如果 Endpoint 是 H5 类型,请参考文档跳转电子签H5 p.s. 如果Endpoint是 APP,传递的跳转地址无效,不会进行跳转,仅会进行回跳。
|
|
3810
|
+
*/
|
|
3811
|
+
JumpEvents?: Array<JumpEvent>;
|
|
3748
3812
|
}
|
|
3749
3813
|
/**
|
|
3750
3814
|
* CreateLegalSealQrCode请求参数结构体
|
|
@@ -4995,6 +5059,10 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
4995
5059
|
* <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 注意: 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
4996
5060
|
*/
|
|
4997
5061
|
Intention?: Intention;
|
|
5062
|
+
/**
|
|
5063
|
+
* 用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。
|
|
5064
|
+
*/
|
|
5065
|
+
VideoVerifyTimesLimit?: number;
|
|
4998
5066
|
/**
|
|
4999
5067
|
* 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
|
|
5000
5068
|
|
|
@@ -7295,6 +7363,7 @@ export interface CreatePartnerAutoSignAuthUrlRequest {
|
|
|
7295
7363
|
* 被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。
|
|
7296
7364
|
|
|
7297
7365
|
注:`被授权企业必须和当前企业在同一应用号下`
|
|
7366
|
+
* @deprecated
|
|
7298
7367
|
*/
|
|
7299
7368
|
AuthorizedOrganizationId?: string;
|
|
7300
7369
|
/**
|
|
@@ -7303,13 +7372,14 @@ export interface CreatePartnerAutoSignAuthUrlRequest {
|
|
|
7303
7372
|
注:
|
|
7304
7373
|
1. 如果名称中包含英文括号(),请使用中文括号()代替。
|
|
7305
7374
|
2. 被授权企业必须和当前企业在同一应用号下
|
|
7375
|
+
* @deprecated
|
|
7306
7376
|
*/
|
|
7307
7377
|
AuthorizedOrganizationName?: string;
|
|
7308
7378
|
/**
|
|
7309
7379
|
* 是否给平台应用授权
|
|
7310
7380
|
|
|
7311
7381
|
<ul>
|
|
7312
|
-
<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>
|
|
7382
|
+
<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationIds</code>和<code>AuthorizedOrganizationNames</code>。</li>
|
|
7313
7383
|
<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>
|
|
7314
7384
|
</ul>
|
|
7315
7385
|
|
|
@@ -7330,11 +7400,19 @@ export interface CreatePartnerAutoSignAuthUrlRequest {
|
|
|
7330
7400
|
/**
|
|
7331
7401
|
* 在处理授权关系时,授权的方向
|
|
7332
7402
|
<ul>
|
|
7333
|
-
<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>
|
|
7334
|
-
<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>
|
|
7403
|
+
<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationNames</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
|
|
7404
|
+
<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationNames</code> 代表的是【授权方】的企业名称,即提供授权的企业。此场景下不支持批量</li>
|
|
7335
7405
|
</ul>
|
|
7336
7406
|
*/
|
|
7337
7407
|
AuthToMe?: boolean;
|
|
7408
|
+
/**
|
|
7409
|
+
* 被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationNames二选一传入,最大支持50个,注:`被授权企业必须和当前企业在同一应用号下`
|
|
7410
|
+
*/
|
|
7411
|
+
AuthorizedOrganizationIds?: Array<string>;
|
|
7412
|
+
/**
|
|
7413
|
+
* 被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationIds二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。注: 1. 如果名称中包含英文括号(),请使用中文括号()代替。2. 被授权企业必须和当前企业在同一应用号下 3. 数组最大长度50
|
|
7414
|
+
*/
|
|
7415
|
+
AuthorizedOrganizationNames?: Array<string>;
|
|
7338
7416
|
}
|
|
7339
7417
|
/**
|
|
7340
7418
|
* DescribeBatchOrganizationRegistrationTasks返回参数结构体
|