tencentcloud-sdk-nodejs-essbasic 4.0.700 → 4.0.702
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/CHANGELOG.md +946 -0
- package/SERVICE_CHANGELOG.md +1457 -79
- package/package.json +1 -1
- package/products.md +38 -39
- package/src/services/essbasic/v20210526/essbasic_client.ts +72 -18
- package/src/services/essbasic/v20210526/essbasic_models.ts +217 -30
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +38 -9
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +45 -10
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +210 -30
|
@@ -1305,29 +1305,30 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1305
1305
|
Operator?: UserInfo;
|
|
1306
1306
|
}
|
|
1307
1307
|
/**
|
|
1308
|
-
*
|
|
1308
|
+
* 应用相关信息
|
|
1309
1309
|
*/
|
|
1310
|
-
export interface
|
|
1310
|
+
export interface Agent {
|
|
1311
1311
|
/**
|
|
1312
|
-
*
|
|
1313
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1312
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1314
1313
|
*/
|
|
1315
|
-
|
|
1314
|
+
AppId: string;
|
|
1316
1315
|
/**
|
|
1317
|
-
*
|
|
1318
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1316
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
1319
1317
|
*/
|
|
1320
|
-
|
|
1318
|
+
ProxyOrganizationOpenId?: string;
|
|
1321
1319
|
/**
|
|
1322
|
-
*
|
|
1323
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1320
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
1324
1321
|
*/
|
|
1325
|
-
|
|
1322
|
+
ProxyOperator?: UserInfo;
|
|
1326
1323
|
/**
|
|
1327
|
-
*
|
|
1328
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1324
|
+
* 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1329
1325
|
*/
|
|
1330
|
-
|
|
1326
|
+
ProxyAppId?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* 内部参数,暂未开放使用
|
|
1329
|
+
* @deprecated
|
|
1330
|
+
*/
|
|
1331
|
+
ProxyOrganizationId?: string;
|
|
1331
1332
|
}
|
|
1332
1333
|
/**
|
|
1333
1334
|
* ChannelCreatePreparedPersonalEsign返回参数结构体
|
|
@@ -1690,6 +1691,34 @@ export interface TemplateInfo {
|
|
|
1690
1691
|
*/
|
|
1691
1692
|
Available?: number;
|
|
1692
1693
|
}
|
|
1694
|
+
/**
|
|
1695
|
+
* ChannelCreateOrganizationBatchSignUrl请求参数结构体
|
|
1696
|
+
*/
|
|
1697
|
+
export interface ChannelCreateOrganizationBatchSignUrlRequest {
|
|
1698
|
+
/**
|
|
1699
|
+
* 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1700
|
+
*/
|
|
1701
|
+
Agent: Agent;
|
|
1702
|
+
/**
|
|
1703
|
+
* 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
|
|
1704
|
+
*/
|
|
1705
|
+
FlowIds?: Array<string>;
|
|
1706
|
+
/**
|
|
1707
|
+
* 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
|
|
1708
|
+
*/
|
|
1709
|
+
OpenId?: string;
|
|
1710
|
+
/**
|
|
1711
|
+
* 签署方经办人的姓名。
|
|
1712
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1713
|
+
|
|
1714
|
+
注:`请确保和合同中填入的一致`
|
|
1715
|
+
*/
|
|
1716
|
+
Name?: string;
|
|
1717
|
+
/**
|
|
1718
|
+
* 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
1719
|
+
*/
|
|
1720
|
+
Mobile?: string;
|
|
1721
|
+
}
|
|
1693
1722
|
/**
|
|
1694
1723
|
* GetDownloadFlowUrl返回参数结构体
|
|
1695
1724
|
*/
|
|
@@ -1704,30 +1733,29 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
1704
1733
|
RequestId?: string;
|
|
1705
1734
|
}
|
|
1706
1735
|
/**
|
|
1707
|
-
*
|
|
1736
|
+
* 渠道角色信息
|
|
1708
1737
|
*/
|
|
1709
|
-
export interface
|
|
1710
|
-
/**
|
|
1711
|
-
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1712
|
-
*/
|
|
1713
|
-
AppId: string;
|
|
1738
|
+
export interface ChannelRole {
|
|
1714
1739
|
/**
|
|
1715
|
-
*
|
|
1740
|
+
* 角色id
|
|
1741
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1716
1742
|
*/
|
|
1717
|
-
|
|
1743
|
+
RoleId?: string;
|
|
1718
1744
|
/**
|
|
1719
|
-
*
|
|
1745
|
+
* 角色名
|
|
1746
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1720
1747
|
*/
|
|
1721
|
-
|
|
1748
|
+
RoleName?: string;
|
|
1722
1749
|
/**
|
|
1723
|
-
*
|
|
1750
|
+
* 角色状态:1-启用;2-禁用
|
|
1751
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1724
1752
|
*/
|
|
1725
|
-
|
|
1753
|
+
RoleStatus?: number;
|
|
1726
1754
|
/**
|
|
1727
|
-
*
|
|
1728
|
-
|
|
1755
|
+
* 权限树
|
|
1756
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1729
1757
|
*/
|
|
1730
|
-
|
|
1758
|
+
PermissionGroups?: Array<PermissionGroup>;
|
|
1731
1759
|
}
|
|
1732
1760
|
/**
|
|
1733
1761
|
* 流程中参与方的信息结构
|
|
@@ -2335,6 +2363,70 @@ export interface CommonFlowApprover {
|
|
|
2335
2363
|
*/
|
|
2336
2364
|
ApproverSignTypes?: Array<number | bigint>;
|
|
2337
2365
|
}
|
|
2366
|
+
/**
|
|
2367
|
+
* 指定补充签署人信息
|
|
2368
|
+
- RecipientId 必须指定
|
|
2369
|
+
*/
|
|
2370
|
+
export interface FillApproverInfo {
|
|
2371
|
+
/**
|
|
2372
|
+
* 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
|
|
2373
|
+
|
|
2374
|
+
*/
|
|
2375
|
+
RecipientId: string;
|
|
2376
|
+
/**
|
|
2377
|
+
* 指定企业经办签署人OpenId
|
|
2378
|
+
*/
|
|
2379
|
+
OpenId?: string;
|
|
2380
|
+
/**
|
|
2381
|
+
* 签署人姓名
|
|
2382
|
+
*/
|
|
2383
|
+
ApproverName?: string;
|
|
2384
|
+
/**
|
|
2385
|
+
* 签署人手机号码
|
|
2386
|
+
*/
|
|
2387
|
+
ApproverMobile?: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* 企业名称
|
|
2390
|
+
*/
|
|
2391
|
+
OrganizationName?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* 企业OpenId
|
|
2394
|
+
*/
|
|
2395
|
+
OrganizationOpenId?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
|
|
2398
|
+
*/
|
|
2399
|
+
NotChannelOrganization?: string;
|
|
2400
|
+
}
|
|
2401
|
+
/**
|
|
2402
|
+
* ChannelCreateUserAutoSignSealUrl请求参数结构体
|
|
2403
|
+
*/
|
|
2404
|
+
export interface ChannelCreateUserAutoSignSealUrlRequest {
|
|
2405
|
+
/**
|
|
2406
|
+
* 渠道应用相关信息。
|
|
2407
|
+
*/
|
|
2408
|
+
Agent: Agent;
|
|
2409
|
+
/**
|
|
2410
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
2411
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
2412
|
+
|
|
2413
|
+
注: `现在仅支持电子处方场景`
|
|
2414
|
+
*/
|
|
2415
|
+
SceneKey: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* 自动签开通个人用户信息,包括名字,身份证等。
|
|
2418
|
+
*/
|
|
2419
|
+
UserInfo: UserThreeFactor;
|
|
2420
|
+
/**
|
|
2421
|
+
* 执行本接口操作的员工信息。
|
|
2422
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2423
|
+
*/
|
|
2424
|
+
Operator?: UserInfo;
|
|
2425
|
+
/**
|
|
2426
|
+
* 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
|
2427
|
+
*/
|
|
2428
|
+
ExpiredTime?: number;
|
|
2429
|
+
}
|
|
2338
2430
|
/**
|
|
2339
2431
|
* 合同文件验签单个结果结构体
|
|
2340
2432
|
*/
|
|
@@ -2841,6 +2933,35 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2841
2933
|
*/
|
|
2842
2934
|
RequestId?: string;
|
|
2843
2935
|
}
|
|
2936
|
+
/**
|
|
2937
|
+
* ChannelCreateUserAutoSignSealUrl返回参数结构体
|
|
2938
|
+
*/
|
|
2939
|
+
export interface ChannelCreateUserAutoSignSealUrlResponse {
|
|
2940
|
+
/**
|
|
2941
|
+
* 腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
|
|
2942
|
+
*/
|
|
2943
|
+
AppId?: string;
|
|
2944
|
+
/**
|
|
2945
|
+
* 腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
|
|
2946
|
+
*/
|
|
2947
|
+
AppOriginalId?: string;
|
|
2948
|
+
/**
|
|
2949
|
+
* 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
|
|
2950
|
+
*/
|
|
2951
|
+
Url?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
|
|
2954
|
+
*/
|
|
2955
|
+
Path?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* base64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
2958
|
+
*/
|
|
2959
|
+
QrCode?: string;
|
|
2960
|
+
/**
|
|
2961
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2962
|
+
*/
|
|
2963
|
+
RequestId?: string;
|
|
2964
|
+
}
|
|
2844
2965
|
/**
|
|
2845
2966
|
* 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
|
|
2846
2967
|
*/
|
|
@@ -2973,6 +3094,15 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
2973
3094
|
*/
|
|
2974
3095
|
Operator?: UserInfo;
|
|
2975
3096
|
}
|
|
3097
|
+
/**
|
|
3098
|
+
* ChannelCreateFlowApprovers返回参数结构体
|
|
3099
|
+
*/
|
|
3100
|
+
export interface ChannelCreateFlowApproversResponse {
|
|
3101
|
+
/**
|
|
3102
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3103
|
+
*/
|
|
3104
|
+
RequestId?: string;
|
|
3105
|
+
}
|
|
2976
3106
|
/**
|
|
2977
3107
|
* CreateSignUrls请求参数结构体
|
|
2978
3108
|
*/
|
|
@@ -3006,6 +3136,7 @@ export interface CreateSignUrlsRequest {
|
|
|
3006
3136
|
- NOT_CHANNEL:非第三方平台子客企业企业
|
|
3007
3137
|
- PERSON:个人
|
|
3008
3138
|
- FOLLOWER:关注方,目前是合同抄送方
|
|
3139
|
+
- RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
|
|
3009
3140
|
*/
|
|
3010
3141
|
GenerateType?: string;
|
|
3011
3142
|
/**
|
|
@@ -3053,7 +3184,7 @@ export interface CreateSignUrlsRequest {
|
|
|
3053
3184
|
*/
|
|
3054
3185
|
Hides?: Array<number | bigint>;
|
|
3055
3186
|
/**
|
|
3056
|
-
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids
|
|
3187
|
+
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
|
|
3057
3188
|
*/
|
|
3058
3189
|
RecipientIds?: Array<string>;
|
|
3059
3190
|
}
|
|
@@ -4720,6 +4851,23 @@ export interface DescribeUsageResponse {
|
|
|
4720
4851
|
*/
|
|
4721
4852
|
RequestId?: string;
|
|
4722
4853
|
}
|
|
4854
|
+
/**
|
|
4855
|
+
* ChannelCreateOrganizationBatchSignUrl返回参数结构体
|
|
4856
|
+
*/
|
|
4857
|
+
export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
4858
|
+
/**
|
|
4859
|
+
* 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
|
|
4860
|
+
*/
|
|
4861
|
+
SignUrl?: string;
|
|
4862
|
+
/**
|
|
4863
|
+
* 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
|
|
4864
|
+
*/
|
|
4865
|
+
ExpiredTime?: number;
|
|
4866
|
+
/**
|
|
4867
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4868
|
+
*/
|
|
4869
|
+
RequestId?: string;
|
|
4870
|
+
}
|
|
4723
4871
|
/**
|
|
4724
4872
|
* 用量明细
|
|
4725
4873
|
*/
|
|
@@ -4889,6 +5037,38 @@ export interface ChannelDescribeEmployeesResponse {
|
|
|
4889
5037
|
*/
|
|
4890
5038
|
RequestId?: string;
|
|
4891
5039
|
}
|
|
5040
|
+
/**
|
|
5041
|
+
* ChannelCreateFlowApprovers请求参数结构体
|
|
5042
|
+
*/
|
|
5043
|
+
export interface ChannelCreateFlowApproversRequest {
|
|
5044
|
+
/**
|
|
5045
|
+
* 渠道应用相关信息
|
|
5046
|
+
*/
|
|
5047
|
+
Agent: Agent;
|
|
5048
|
+
/**
|
|
5049
|
+
* 合同唯一编号
|
|
5050
|
+
*/
|
|
5051
|
+
FlowId: string;
|
|
5052
|
+
/**
|
|
5053
|
+
* 补充企业签署人信息。
|
|
5054
|
+
|
|
5055
|
+
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
5056
|
+
|
|
5057
|
+
- 如果不指定,则使用姓名和手机号进行补充。
|
|
5058
|
+
*/
|
|
5059
|
+
Approvers: Array<FillApproverInfo>;
|
|
5060
|
+
/**
|
|
5061
|
+
* 操作人信息
|
|
5062
|
+
*/
|
|
5063
|
+
Operator?: UserInfo;
|
|
5064
|
+
/**
|
|
5065
|
+
* 签署人信息补充方式
|
|
5066
|
+
|
|
5067
|
+
<ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
|
|
5068
|
+
<li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
5069
|
+
*/
|
|
5070
|
+
FillApproverType?: number;
|
|
5071
|
+
}
|
|
4892
5072
|
/**
|
|
4893
5073
|
* ChannelDeleteRole返回参数结构体
|
|
4894
5074
|
*/
|