tencentcloud-sdk-nodejs 4.0.688 → 4.0.689

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.
Files changed (80) hide show
  1. package/CHANGELOG.md +264 -0
  2. package/SERVICE_CHANGELOG.md +381 -364
  3. package/package.json +1 -1
  4. package/products.md +19 -19
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cvm/v20170312/cvm_client.ts +6 -3
  7. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  8. package/src/services/cynosdb/v20190107/cynosdb_client.ts +8 -6
  9. package/src/services/cynosdb/v20190107/cynosdb_models.ts +190 -74
  10. package/src/services/dlc/v20210125/dlc_client.ts +13 -1
  11. package/src/services/dlc/v20210125/dlc_models.ts +80 -39
  12. package/src/services/es/v20180416/es_models.ts +5 -5
  13. package/src/services/ess/v20201111/ess_client.ts +43 -43
  14. package/src/services/ess/v20201111/ess_models.ts +102 -124
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +52 -3
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +203 -9
  17. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  18. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -19
  19. package/src/services/mongodb/v20190725/mongodb_models.ts +46 -46
  20. package/src/services/monitor/v20180724/monitor_models.ts +6 -2
  21. package/src/services/nlp/v20190408/nlp_client.ts +0 -17
  22. package/src/services/nlp/v20190408/nlp_models.ts +0 -117
  23. package/src/services/omics/v20221128/omics_models.ts +1 -1
  24. package/src/services/postgres/v20170312/postgres_models.ts +33 -30
  25. package/src/services/ssa/v20180608/ssa_client.ts +16 -3
  26. package/src/services/ssa/v20180608/ssa_models.ts +94 -24
  27. package/src/services/ssl/v20191205/ssl_client.ts +26 -2
  28. package/src/services/ssl/v20191205/ssl_models.ts +64 -16
  29. package/src/services/vod/v20180717/vod_client.ts +3 -9
  30. package/src/services/vod/v20180717/vod_models.ts +243 -239
  31. package/src/services/vpc/v20170312/vpc_models.ts +40 -22
  32. package/src/services/waf/v20180125/waf_client.ts +41 -26
  33. package/src/services/waf/v20180125/waf_models.ts +212 -45
  34. package/tencentcloud/common/sdk_version.d.ts +1 -1
  35. package/tencentcloud/common/sdk_version.js +1 -1
  36. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -0
  37. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -0
  38. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  39. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -5
  40. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +4 -4
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +185 -71
  42. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  43. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  44. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +78 -39
  45. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -5
  46. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +36 -27
  47. package/tencentcloud/services/ess/v20201111/ess_client.js +36 -29
  48. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +102 -121
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -3
  50. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -2
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +195 -9
  52. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  53. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -19
  54. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +46 -46
  55. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +6 -2
  56. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -7
  57. package/tencentcloud/services/nlp/v20190408/nlp_client.js +0 -8
  58. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +0 -112
  59. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +1 -1
  60. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +33 -30
  61. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  62. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  63. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +91 -24
  64. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +9 -1
  65. package/tencentcloud/services/ssl/v20191205/ssl_client.js +12 -0
  66. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +60 -16
  67. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -7
  68. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -7
  69. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +243 -239
  70. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +40 -22
  71. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -9
  72. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -12
  73. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +207 -45
  74. package/test/dlc.v20210125.test.js +10 -0
  75. package/test/ess.v20201111.test.js +2 -12
  76. package/test/essbasic.v20210526.test.js +30 -0
  77. package/test/nlp.v20190408.test.js +0 -10
  78. package/test/ssa.v20180608.test.js +10 -0
  79. package/test/ssl.v20191205.test.js +20 -0
  80. package/test/waf.v20180125.test.js +18 -8
@@ -247,27 +247,6 @@ export interface DescribeIntegrationDepartmentsResponse {
247
247
  */
248
248
  RequestId?: string;
249
249
  }
250
- /**
251
- * 模板中文件的信息结构
252
- */
253
- export interface FileInfo {
254
- /**
255
- * 文件ID
256
- */
257
- FileId?: string;
258
- /**
259
- * 文件名
260
- */
261
- FileName?: string;
262
- /**
263
- * 文件大小,单位为Byte
264
- */
265
- FileSize?: number;
266
- /**
267
- * 文件上传时间,格式为Unix标准时间戳(秒)
268
- */
269
- CreatedOn?: number;
270
- }
271
250
  /**
272
251
  * CreateFlowApprovers返回参数结构体
273
252
  */
@@ -563,27 +542,36 @@ export interface ReleasedApprover {
563
542
  */
564
543
  export interface DescribeIntegrationRolesRequest {
565
544
  /**
566
- * 操作人信息,UserId必填
545
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
546
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
567
547
  */
568
548
  Operator: UserInfo;
569
549
  /**
570
- * 指定每页多少条数据,单页最大200
550
+ * 指定分页每页返回的数据条数,单页最大支持 200
571
551
  */
572
552
  Limit: number;
573
553
  /**
574
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
554
+ * 代理企业和员工的信息。
555
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
575
556
  */
576
557
  Agent?: Agent;
577
558
  /**
578
- * 查询的关键字段:
579
- Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
580
- Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
581
- Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
582
- Key:"IsReturnPermissionGroup"Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
559
+ * 查询的关键字段,支持Key-Value单值查询。可选键值对如下:
560
+ <ul>
561
+ <li>Key:"RoleType",查询角色类型,Values可选:
562
+ <ul><li>**"1"**:查询系统角色</li><li>**"2"**:查询自定义角色</li></ul>
563
+ </li><li>Key:"RoleStatus",查询角色状态,Values可选:
564
+ <ul><li>**"1"**:查询启用角色</li><li>**"2"**:查询禁用角色</li></ul>
565
+ </li><li>Key:"IsGroupRole",是否查询集团角色,Values可选:
566
+ <ul><li>**"0"**:查询非集团角色</li><li>**"1"**:查询集团角色</li></ul>
567
+ </li><li>Key:"IsReturnPermissionGroup",是否返回角色对应权限树,Values可选:
568
+ <ul><li>**"0"**:接口不返回角色对应的权限树字段</li><li>**"1"**:接口返回角色对应的权限树字段</li></ul>
569
+ </li>
570
+ </ul>
583
571
  */
584
572
  Filters?: Array<Filter>;
585
573
  /**
586
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
574
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
587
575
  */
588
576
  Offset?: number;
589
577
  }
@@ -1198,19 +1186,6 @@ export interface DescribeIntegrationEmployeesRequest {
1198
1186
  */
1199
1187
  Offset?: number;
1200
1188
  }
1201
- /**
1202
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1203
- */
1204
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1205
- /**
1206
- * 解绑是否成功,1表示成功,0表示失败
1207
- */
1208
- Status?: number;
1209
- /**
1210
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1211
- */
1212
- RequestId?: string;
1213
- }
1214
1189
  /**
1215
1190
  * CreateIntegrationUserRoles返回参数结构体
1216
1191
  */
@@ -1490,13 +1465,17 @@ export interface DescribeThirdPartyAuthCodeRequest {
1490
1465
  Agent?: Agent;
1491
1466
  }
1492
1467
  /**
1493
- * DescribeIntegrationMainOrganizationUser请求参数结构体
1468
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1494
1469
  */
1495
- export interface DescribeIntegrationMainOrganizationUserRequest {
1470
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1496
1471
  /**
1497
- * 操作人信息,userId必填
1472
+ * 解绑是否成功,1表示成功,0表示失败
1498
1473
  */
1499
- Operator: UserInfo;
1474
+ Status?: number;
1475
+ /**
1476
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1477
+ */
1478
+ RequestId?: string;
1500
1479
  }
1501
1480
  /**
1502
1481
  * CreateReleaseFlow返回参数结构体
@@ -1802,12 +1781,15 @@ export interface DescribeUserAutoSignStatusResponse {
1802
1781
  /**
1803
1782
  * 补充签署人信息
1804
1783
  - RecipientId 必须指定
1805
- - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1784
+ - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1806
1785
  - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
1807
1786
  */
1808
1787
  export interface FillApproverInfo {
1809
1788
  /**
1810
- * 对应模板中的参与方ID
1789
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
1790
+ 模板发起合同时,该参数为必填项。
1791
+ 文件发起合同是,该参数无需传值。
1792
+ 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
1811
1793
  */
1812
1794
  RecipientId: string;
1813
1795
  /**
@@ -1817,16 +1799,16 @@ export interface FillApproverInfo {
1817
1799
  */
1818
1800
  ApproverSource?: string;
1819
1801
  /**
1820
- * 企业自定义账号ID
1821
- <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
1802
+ * 企业微信UserId
1803
+ <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
1822
1804
  */
1823
1805
  CustomUserId?: string;
1824
1806
  /**
1825
- * 补充签署人姓名
1807
+ * 补充企业签署人员工姓名
1826
1808
  */
1827
1809
  ApproverName?: string;
1828
1810
  /**
1829
- * 补充签署人手机号
1811
+ * 补充企业签署人员工手机号
1830
1812
  */
1831
1813
  ApproverMobile?: string;
1832
1814
  }
@@ -2244,7 +2226,7 @@ export interface CreateSchemeUrlResponse {
2244
2226
  */
2245
2227
  export interface CreateUserAutoSignEnableUrlResponse {
2246
2228
  /**
2247
- * 个人用户自动签的开通链接, 短链形式
2229
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2248
2230
  */
2249
2231
  Url?: string;
2250
2232
  /**
@@ -2685,25 +2667,31 @@ export interface UserInfo {
2685
2667
  */
2686
2668
  export interface CreateFlowApproversRequest {
2687
2669
  /**
2688
- * 调用方用户信息,userId 必填
2670
+ * 执行本接口操作的员工信息。
2671
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2689
2672
  */
2690
2673
  Operator: UserInfo;
2691
2674
  /**
2692
- * 签署流程编号
2675
+ * 合同流程ID,为32位字符串。
2676
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2677
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2693
2678
  */
2694
2679
  FlowId: string;
2695
2680
  /**
2696
- * 补充签署人信息
2681
+ * 补充企业签署人信息。
2682
+
2683
+ - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
2684
+
2685
+ - 如果不指定,则使用姓名和手机号进行补充。
2697
2686
  */
2698
2687
  Approvers: Array<FillApproverInfo>;
2699
2688
  /**
2700
- * 企微消息中的发起人
2689
+ * 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
2701
2690
  */
2702
2691
  Initiator?: string;
2703
2692
  /**
2704
- * 代理相关应用信息,如集团主企业代子企业操作
2705
-
2706
-
2693
+ * 代理企业和员工的信息。
2694
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2707
2695
  */
2708
2696
  Agent?: Agent;
2709
2697
  }
@@ -2774,10 +2762,10 @@ export interface FlowCreateApprover {
2774
2762
  */
2775
2763
  ApproverIdCardNumber?: string;
2776
2764
  /**
2777
- * 签署方经办人在模板中的参与方ID
2778
- <br/>模板发起合同时,该参数为必填项
2779
- <br/>文件发起合同是,该参数无序传值
2780
-
2765
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
2766
+ 模板发起合同时,该参数为必填项。
2767
+ 文件发起合同是,该参数无需传值。
2768
+ 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
2781
2769
  */
2782
2770
  RecipientId?: string;
2783
2771
  /**
@@ -3299,24 +3287,23 @@ export interface CreateEmbedWebUrlRequest {
3299
3287
  */
3300
3288
  Operator: UserInfo;
3301
3289
  /**
3302
- * WEB嵌入资源类型。
3303
- <br/>CREATE_SEAL: 生成创建印章的嵌入页面
3304
- <br/>CREATE_TEMPLATE:生成创建模板的嵌入页面
3305
- <br/>MODIFY_TEMPLATE:生成编辑模板的嵌入页面
3306
- <br/>PREVIEW_TEMPLATE:生成预览模板的嵌入页面
3307
- <br/>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
3308
- <br/>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
3309
- <br/>EXTEND_SERVICE:生成拓展服务的嵌入页面
3310
- <br/>PREVIEW_FLOW:生成预览合同的嵌入页面
3311
- <br/>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面
3312
-
3290
+ * WEB嵌入资源类型,支持以下类型
3291
+ <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
3292
+ <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
3293
+ <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
3294
+ <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
3295
+ <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
3296
+ <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
3297
+ <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
3298
+ <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
3299
+ <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
3313
3300
  */
3314
3301
  EmbedType: string;
3315
3302
  /**
3316
3303
  * WEB嵌入的业务资源ID
3317
- <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
3318
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
3319
- <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
3304
+ <ul><li>PREVIEW_SEAL_DETAIL,必填,取值为印章id</li>
3305
+ <li>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id</li>
3306
+ <li>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id</li><ul>
3320
3307
  */
3321
3308
  BusinessId?: string;
3322
3309
  /**
@@ -3495,11 +3482,11 @@ export interface CreateIntegrationEmployeesResponse {
3495
3482
  */
3496
3483
  export interface DeleteIntegrationRoleUsersRequest {
3497
3484
  /**
3498
- * 操作人信息,userId必填
3485
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3499
3486
  */
3500
3487
  Operator: UserInfo;
3501
3488
  /**
3502
- * 角色id
3489
+ * 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3503
3490
  */
3504
3491
  RoleId: string;
3505
3492
  /**
@@ -3507,7 +3494,7 @@ export interface DeleteIntegrationRoleUsersRequest {
3507
3494
  */
3508
3495
  Users: Array<UserInfo>;
3509
3496
  /**
3510
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3497
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3511
3498
  */
3512
3499
  Agent?: Agent;
3513
3500
  }
@@ -3746,7 +3733,7 @@ export interface CreateReleaseFlowRequest {
3746
3733
  */
3747
3734
  export interface CreateIntegrationUserRolesRequest {
3748
3735
  /**
3749
- * 操作人信息,UserId必填
3736
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3750
3737
  */
3751
3738
  Operator: UserInfo;
3752
3739
  /**
@@ -3754,11 +3741,11 @@ export interface CreateIntegrationUserRolesRequest {
3754
3741
  */
3755
3742
  UserIds: Array<string>;
3756
3743
  /**
3757
- * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
3744
+ * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
3758
3745
  */
3759
3746
  RoleIds: Array<string>;
3760
3747
  /**
3761
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3748
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3762
3749
  */
3763
3750
  Agent?: Agent;
3764
3751
  }
@@ -4318,18 +4305,25 @@ export interface CreateOrganizationBatchSignUrlResponse {
4318
4305
  RequestId?: string;
4319
4306
  }
4320
4307
  /**
4321
- * DescribeIntegrationMainOrganizationUser返回参数结构体
4308
+ * 模板中文件的信息结构
4322
4309
  */
4323
- export interface DescribeIntegrationMainOrganizationUserResponse {
4310
+ export interface FileInfo {
4324
4311
  /**
4325
- * 主企业员工账号信息
4326
- 注意:此字段可能返回 null,表示取不到有效值。
4312
+ * 文件ID
4327
4313
  */
4328
- IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser;
4314
+ FileId?: string;
4329
4315
  /**
4330
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4316
+ * 文件名
4331
4317
  */
4332
- RequestId?: string;
4318
+ FileName?: string;
4319
+ /**
4320
+ * 文件大小,单位为Byte
4321
+ */
4322
+ FileSize?: number;
4323
+ /**
4324
+ * 文件上传时间,格式为Unix标准时间戳(秒)
4325
+ */
4326
+ CreatedOn?: number;
4333
4327
  }
4334
4328
  /**
4335
4329
  * CancelUserAutoSignEnableUrl请求参数结构体
@@ -4659,26 +4653,6 @@ export interface ModifyApplicationCallbackInfoRequest {
4659
4653
  */
4660
4654
  Agent?: Agent;
4661
4655
  }
4662
- /**
4663
- * 主企业员工账号信息
4664
- */
4665
- export interface IntegrationMainOrganizationUser {
4666
- /**
4667
- * 主企业id
4668
- 注意:此字段可能返回 null,表示取不到有效值。
4669
- */
4670
- MainOrganizationId?: string;
4671
- /**
4672
- * 主企业员工UserId
4673
- 注意:此字段可能返回 null,表示取不到有效值。
4674
- */
4675
- MainUserId?: string;
4676
- /**
4677
- * 主企业员工名
4678
- 注意:此字段可能返回 null,表示取不到有效值。
4679
- */
4680
- UserName?: string;
4681
- }
4682
4656
  /**
4683
4657
  * StartFlow请求参数结构体
4684
4658
  */
@@ -5318,19 +5292,19 @@ export interface DescribeExtendedServiceAuthInfosRequest {
5318
5292
  */
5319
5293
  export interface DescribeIntegrationRolesResponse {
5320
5294
  /**
5321
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
5295
+ * 指定分页返回的页码。页码从0开始,最大为2000
5322
5296
  */
5323
5297
  Offset?: number;
5324
5298
  /**
5325
- * 指定每页多少条数据,单页最大200
5299
+ * 指定分页每页返回的数据条数,单页最大支持 200
5326
5300
  */
5327
5301
  Limit?: number;
5328
5302
  /**
5329
- * 符合查询条件的总的角色数
5303
+ * 符合查询条件的总角色数。
5330
5304
  */
5331
5305
  TotalCount?: number;
5332
5306
  /**
5333
- * 企业角色信息列表
5307
+ * 企业角色信息列表。
5334
5308
  */
5335
5309
  IntegrateRoles?: Array<IntegrateRole>;
5336
5310
  /**
@@ -5403,23 +5377,30 @@ export interface DescribeFlowBriefsRequest {
5403
5377
  */
5404
5378
  export interface CreateFlowGroupByTemplatesRequest {
5405
5379
  /**
5406
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
5380
+ * 执行本接口操作的员工信息。
5381
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5407
5382
  */
5408
5383
  Operator: UserInfo;
5409
5384
  /**
5410
- * 合同组名称,最大长度200个字符
5385
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5411
5386
  */
5412
5387
  FlowGroupName: string;
5413
5388
  /**
5414
- * 合同组的子合同信息,支持2-50个子合同
5389
+ * 合同(流程)组的子合同信息,支持2-50个子合同
5415
5390
  */
5416
5391
  FlowGroupInfos: Array<FlowGroupInfo>;
5417
5392
  /**
5418
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5393
+ * 代理企业和员工的信息。
5394
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5419
5395
  */
5420
5396
  Agent?: Agent;
5421
5397
  /**
5422
- * 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
5398
+ * 合同(流程)组的配置项信息。
5399
+ 其中包括:
5400
+ <ul>
5401
+ <li>是否通知本企业签署方</li>
5402
+ <li>是否通知其他签署方</li>
5403
+ </ul>
5423
5404
  */
5424
5405
  FlowGroupOptions?: FlowGroupOptions;
5425
5406
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -36,6 +36,14 @@ export declare class Client extends AbstractClient {
36
36
  用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
37
37
  */
38
38
  ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
39
+ /**
40
+ * 此接口(ChannelModifyRole)用来更新企业自定义角色。
41
+
42
+ 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
43
+
44
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
45
+ */
46
+ ChannelModifyRole(req: ChannelModifyRoleRequest, cb?: (error: string, rep: ChannelModifyRoleResponse) => void): Promise<ChannelModifyRoleResponse>;
39
47
  /**
40
48
  * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
41
49
  */
@@ -81,6 +89,14 @@ export declare class Client extends AbstractClient {
81
89
  * 将指定印章授权给第三方平台子客企业下的某些员工
82
90
  */
83
91
  ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
92
+ /**
93
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
94
+
95
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
96
+
97
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
98
+ */
99
+ ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
84
100
  /**
85
101
  * 企业方可以通过此接口关闭个人的自动签功能
86
102
  */
@@ -178,6 +194,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
178
194
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
179
195
  */
180
196
  ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
197
+ /**
198
+ * 此接口(ChannelDeleteRole)用来删除企业自定义角色。
199
+
200
+ 注意:系统角色不可删除。
201
+ */
202
+ ChannelDeleteRole(req: ChannelDeleteRoleRequest, cb?: (error: string, rep: ChannelDeleteRoleResponse) => void): Promise<ChannelDeleteRoleResponse>;
181
203
  /**
182
204
  * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
183
205
  注意:大文件转换所需的时间可能会比较长。
@@ -205,7 +227,8 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
205
227
  */
206
228
  ChannelVerifyPdf(req: ChannelVerifyPdfRequest, cb?: (error: string, rep: ChannelVerifyPdfResponse) => void): Promise<ChannelVerifyPdfResponse>;
207
229
  /**
208
- * 生成页面主题配置
230
+ * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
231
+ 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准
209
232
  */
210
233
  ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
211
234
  /**
@@ -253,7 +276,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
253
276
  */
254
277
  CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
255
278
  /**
256
- * 查询角色列表,支持根据类型和状态过滤角色列表
279
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
257
280
  */
258
281
  ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
259
282
  /**
@@ -62,6 +62,16 @@ class Client extends abstract_client_1.AbstractClient {
62
62
  async ChannelCreateMultiFlowSignQRCode(req, cb) {
63
63
  return this.request("ChannelCreateMultiFlowSignQRCode", req, cb);
64
64
  }
65
+ /**
66
+ * 此接口(ChannelModifyRole)用来更新企业自定义角色。
67
+
68
+ 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
69
+
70
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
71
+ */
72
+ async ChannelModifyRole(req, cb) {
73
+ return this.request("ChannelModifyRole", req, cb);
74
+ }
65
75
  /**
66
76
  * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
67
77
  */
@@ -127,6 +137,16 @@ class Client extends abstract_client_1.AbstractClient {
127
137
  async ChannelCreateSealPolicy(req, cb) {
128
138
  return this.request("ChannelCreateSealPolicy", req, cb);
129
139
  }
140
+ /**
141
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
142
+
143
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
144
+
145
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
146
+ */
147
+ async ChannelCreateRole(req, cb) {
148
+ return this.request("ChannelCreateRole", req, cb);
149
+ }
130
150
  /**
131
151
  * 企业方可以通过此接口关闭个人的自动签功能
132
152
  */
@@ -242,6 +262,14 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
242
262
  async ChannelCreateBatchCancelFlowUrl(req, cb) {
243
263
  return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
244
264
  }
265
+ /**
266
+ * 此接口(ChannelDeleteRole)用来删除企业自定义角色。
267
+
268
+ 注意:系统角色不可删除。
269
+ */
270
+ async ChannelDeleteRole(req, cb) {
271
+ return this.request("ChannelDeleteRole", req, cb);
272
+ }
245
273
  /**
246
274
  * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
247
275
  注意:大文件转换所需的时间可能会比较长。
@@ -281,7 +309,8 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
281
309
  return this.request("ChannelVerifyPdf", req, cb);
282
310
  }
283
311
  /**
284
- * 生成页面主题配置
312
+ * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
313
+ 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准
285
314
  */
286
315
  async ChannelCreateWebThemeConfig(req, cb) {
287
316
  return this.request("ChannelCreateWebThemeConfig", req, cb);
@@ -343,7 +372,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
343
372
  return this.request("CreateFlowsByTemplates", req, cb);
344
373
  }
345
374
  /**
346
- * 查询角色列表,支持根据类型和状态过滤角色列表
375
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
347
376
  */
348
377
  async ChannelDescribeRoles(req, cb) {
349
378
  return this.request("ChannelDescribeRoles", req, cb);