tencentcloud-sdk-nodejs-essbasic 4.0.699 → 4.0.701
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 +322 -0
- package/SERVICE_CHANGELOG.md +410 -154
- package/package.json +1 -1
- package/products.md +25 -25
- package/src/services/essbasic/v20210526/essbasic_client.ts +58 -23
- package/src/services/essbasic/v20210526/essbasic_models.ts +176 -31
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +32 -14
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +36 -14
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +171 -31
|
@@ -551,6 +551,14 @@ export interface DescribeResourceUrlsByFlowsRequest {
|
|
|
551
551
|
* CreateChannelOrganizationInfoChangeUrl返回参数结构体
|
|
552
552
|
*/
|
|
553
553
|
export interface CreateChannelOrganizationInfoChangeUrlResponse {
|
|
554
|
+
/**
|
|
555
|
+
* 创建的企业信息变更链接。
|
|
556
|
+
*/
|
|
557
|
+
Url?: string;
|
|
558
|
+
/**
|
|
559
|
+
* 链接过期时间。链接7天有效。
|
|
560
|
+
*/
|
|
561
|
+
ExpiredTime?: number;
|
|
554
562
|
/**
|
|
555
563
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
556
564
|
*/
|
|
@@ -1297,29 +1305,30 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
1297
1305
|
Operator?: UserInfo;
|
|
1298
1306
|
}
|
|
1299
1307
|
/**
|
|
1300
|
-
*
|
|
1308
|
+
* 应用相关信息
|
|
1301
1309
|
*/
|
|
1302
|
-
export interface
|
|
1310
|
+
export interface Agent {
|
|
1303
1311
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1312
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1306
1313
|
*/
|
|
1307
|
-
|
|
1314
|
+
AppId: string;
|
|
1308
1315
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1316
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
1311
1317
|
*/
|
|
1312
|
-
|
|
1318
|
+
ProxyOrganizationOpenId?: string;
|
|
1313
1319
|
/**
|
|
1314
|
-
*
|
|
1315
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1320
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
1316
1321
|
*/
|
|
1317
|
-
|
|
1322
|
+
ProxyOperator?: UserInfo;
|
|
1318
1323
|
/**
|
|
1319
|
-
*
|
|
1320
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1324
|
+
* 非必需参数,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1321
1325
|
*/
|
|
1322
|
-
|
|
1326
|
+
ProxyAppId?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* 内部参数,暂未开放使用
|
|
1329
|
+
* @deprecated
|
|
1330
|
+
*/
|
|
1331
|
+
ProxyOrganizationId?: string;
|
|
1323
1332
|
}
|
|
1324
1333
|
/**
|
|
1325
1334
|
* ChannelCreatePreparedPersonalEsign返回参数结构体
|
|
@@ -1682,6 +1691,34 @@ export interface TemplateInfo {
|
|
|
1682
1691
|
*/
|
|
1683
1692
|
Available?: number;
|
|
1684
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
|
+
}
|
|
1685
1722
|
/**
|
|
1686
1723
|
* GetDownloadFlowUrl返回参数结构体
|
|
1687
1724
|
*/
|
|
@@ -1696,30 +1733,29 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
1696
1733
|
RequestId?: string;
|
|
1697
1734
|
}
|
|
1698
1735
|
/**
|
|
1699
|
-
*
|
|
1736
|
+
* 渠道角色信息
|
|
1700
1737
|
*/
|
|
1701
|
-
export interface
|
|
1702
|
-
/**
|
|
1703
|
-
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1704
|
-
*/
|
|
1705
|
-
AppId: string;
|
|
1738
|
+
export interface ChannelRole {
|
|
1706
1739
|
/**
|
|
1707
|
-
*
|
|
1740
|
+
* 角色id
|
|
1741
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1708
1742
|
*/
|
|
1709
|
-
|
|
1743
|
+
RoleId?: string;
|
|
1710
1744
|
/**
|
|
1711
|
-
*
|
|
1745
|
+
* 角色名
|
|
1746
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1712
1747
|
*/
|
|
1713
|
-
|
|
1748
|
+
RoleName?: string;
|
|
1714
1749
|
/**
|
|
1715
|
-
*
|
|
1750
|
+
* 角色状态:1-启用;2-禁用
|
|
1751
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1716
1752
|
*/
|
|
1717
|
-
|
|
1753
|
+
RoleStatus?: number;
|
|
1718
1754
|
/**
|
|
1719
|
-
*
|
|
1720
|
-
|
|
1755
|
+
* 权限树
|
|
1756
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1721
1757
|
*/
|
|
1722
|
-
|
|
1758
|
+
PermissionGroups?: Array<PermissionGroup>;
|
|
1723
1759
|
}
|
|
1724
1760
|
/**
|
|
1725
1761
|
* 流程中参与方的信息结构
|
|
@@ -2327,6 +2363,41 @@ export interface CommonFlowApprover {
|
|
|
2327
2363
|
*/
|
|
2328
2364
|
ApproverSignTypes?: Array<number | bigint>;
|
|
2329
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
|
+
}
|
|
2330
2401
|
/**
|
|
2331
2402
|
* 合同文件验签单个结果结构体
|
|
2332
2403
|
*/
|
|
@@ -2833,6 +2904,38 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2833
2904
|
*/
|
|
2834
2905
|
RequestId?: string;
|
|
2835
2906
|
}
|
|
2907
|
+
/**
|
|
2908
|
+
* ChannelCreateFlowApprovers请求参数结构体
|
|
2909
|
+
*/
|
|
2910
|
+
export interface ChannelCreateFlowApproversRequest {
|
|
2911
|
+
/**
|
|
2912
|
+
* 渠道应用相关信息
|
|
2913
|
+
*/
|
|
2914
|
+
Agent: Agent;
|
|
2915
|
+
/**
|
|
2916
|
+
* 合同唯一编号
|
|
2917
|
+
*/
|
|
2918
|
+
FlowId: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* 补充企业签署人信息。
|
|
2921
|
+
|
|
2922
|
+
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
2923
|
+
|
|
2924
|
+
- 如果不指定,则使用姓名和手机号进行补充。
|
|
2925
|
+
*/
|
|
2926
|
+
Approvers: Array<FillApproverInfo>;
|
|
2927
|
+
/**
|
|
2928
|
+
* 操作人信息
|
|
2929
|
+
*/
|
|
2930
|
+
Operator?: UserInfo;
|
|
2931
|
+
/**
|
|
2932
|
+
* 签署人信息补充方式
|
|
2933
|
+
|
|
2934
|
+
<ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
|
|
2935
|
+
<li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
2936
|
+
*/
|
|
2937
|
+
FillApproverType?: number;
|
|
2938
|
+
}
|
|
2836
2939
|
/**
|
|
2837
2940
|
* 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
|
|
2838
2941
|
*/
|
|
@@ -2965,6 +3068,15 @@ export interface SyncProxyOrganizationOperatorsRequest {
|
|
|
2965
3068
|
*/
|
|
2966
3069
|
Operator?: UserInfo;
|
|
2967
3070
|
}
|
|
3071
|
+
/**
|
|
3072
|
+
* ChannelCreateFlowApprovers返回参数结构体
|
|
3073
|
+
*/
|
|
3074
|
+
export interface ChannelCreateFlowApproversResponse {
|
|
3075
|
+
/**
|
|
3076
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3077
|
+
*/
|
|
3078
|
+
RequestId?: string;
|
|
3079
|
+
}
|
|
2968
3080
|
/**
|
|
2969
3081
|
* CreateSignUrls请求参数结构体
|
|
2970
3082
|
*/
|
|
@@ -2998,6 +3110,7 @@ export interface CreateSignUrlsRequest {
|
|
|
2998
3110
|
- NOT_CHANNEL:非第三方平台子客企业企业
|
|
2999
3111
|
- PERSON:个人
|
|
3000
3112
|
- FOLLOWER:关注方,目前是合同抄送方
|
|
3113
|
+
- RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
|
|
3001
3114
|
*/
|
|
3002
3115
|
GenerateType?: string;
|
|
3003
3116
|
/**
|
|
@@ -3045,7 +3158,7 @@ export interface CreateSignUrlsRequest {
|
|
|
3045
3158
|
*/
|
|
3046
3159
|
Hides?: Array<number | bigint>;
|
|
3047
3160
|
/**
|
|
3048
|
-
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids
|
|
3161
|
+
* 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
|
|
3049
3162
|
*/
|
|
3050
3163
|
RecipientIds?: Array<string>;
|
|
3051
3164
|
}
|
|
@@ -4353,7 +4466,17 @@ export interface ChannelBatchCancelFlowsRequest {
|
|
|
4353
4466
|
/**
|
|
4354
4467
|
* CreateChannelOrganizationInfoChangeUrl请求参数结构体
|
|
4355
4468
|
*/
|
|
4356
|
-
export
|
|
4469
|
+
export interface CreateChannelOrganizationInfoChangeUrlRequest {
|
|
4470
|
+
/**
|
|
4471
|
+
* 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4472
|
+
*/
|
|
4473
|
+
Agent: Agent;
|
|
4474
|
+
/**
|
|
4475
|
+
* 企业信息变更类型,可选类型如下:
|
|
4476
|
+
<ul><li>**1**:企业超管变更</li><li>**2**:企业基础信息变更</li></ul>
|
|
4477
|
+
*/
|
|
4478
|
+
ChangeType: number;
|
|
4479
|
+
}
|
|
4357
4480
|
/**
|
|
4358
4481
|
* ChannelModifyRole请求参数结构体
|
|
4359
4482
|
*/
|
|
@@ -4702,6 +4825,23 @@ export interface DescribeUsageResponse {
|
|
|
4702
4825
|
*/
|
|
4703
4826
|
RequestId?: string;
|
|
4704
4827
|
}
|
|
4828
|
+
/**
|
|
4829
|
+
* ChannelCreateOrganizationBatchSignUrl返回参数结构体
|
|
4830
|
+
*/
|
|
4831
|
+
export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
4832
|
+
/**
|
|
4833
|
+
* 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
|
|
4834
|
+
*/
|
|
4835
|
+
SignUrl?: string;
|
|
4836
|
+
/**
|
|
4837
|
+
* 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
|
|
4838
|
+
*/
|
|
4839
|
+
ExpiredTime?: number;
|
|
4840
|
+
/**
|
|
4841
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4842
|
+
*/
|
|
4843
|
+
RequestId?: string;
|
|
4844
|
+
}
|
|
4705
4845
|
/**
|
|
4706
4846
|
* 用量明细
|
|
4707
4847
|
*/
|