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
@@ -26,7 +26,6 @@ import {
26
26
  Department,
27
27
  CreatePreparedPersonalEsignRequest,
28
28
  DescribeIntegrationDepartmentsResponse,
29
- FileInfo,
30
29
  CreateFlowApproversResponse,
31
30
  DescribeFileUrlsResponse,
32
31
  ModifyApplicationCallbackInfoResponse,
@@ -62,14 +61,13 @@ import {
62
61
  TemplateInfo,
63
62
  CreateDocumentResponse,
64
63
  DescribeIntegrationEmployeesRequest,
65
- UnbindEmployeeUserIdWithClientOpenIdResponse,
66
64
  CreateIntegrationUserRolesResponse,
67
65
  CreateFlowRequest,
68
66
  CreateSchemeUrlRequest,
69
67
  DeleteIntegrationDepartmentResponse,
70
68
  AutoSignConfig,
71
69
  DescribeThirdPartyAuthCodeRequest,
72
- DescribeIntegrationMainOrganizationUserRequest,
70
+ UnbindEmployeeUserIdWithClientOpenIdResponse,
73
71
  CreateReleaseFlowResponse,
74
72
  CreateWebThemeConfigResponse,
75
73
  BindEmployeeUserIdWithClientOpenIdRequest,
@@ -148,7 +146,7 @@ import {
148
146
  CreateStaffResult,
149
147
  CreateUserAutoSignEnableUrlRequest,
150
148
  CreateOrganizationBatchSignUrlResponse,
151
- DescribeIntegrationMainOrganizationUserResponse,
149
+ FileInfo,
152
150
  CancelUserAutoSignEnableUrlRequest,
153
151
  FailedCreateStaffData,
154
152
  ApproverRestriction,
@@ -162,7 +160,6 @@ import {
162
160
  DeleteIntegrationDepartmentRequest,
163
161
  WebThemeConfig,
164
162
  ModifyApplicationCallbackInfoRequest,
165
- IntegrationMainOrganizationUser,
166
163
  StartFlowRequest,
167
164
  CreateSealResponse,
168
165
  CreatePrepareFlowRequest,
@@ -340,8 +337,15 @@ export class Client extends AbstractClient {
340
337
  }
341
338
 
342
339
  /**
343
- * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
344
- */
340
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
341
+ 1. 创建印章
342
+ 2. 创建模板
343
+ 3. 修改模板
344
+ 4. 预览模板
345
+ 5. 预览合同流程
346
+
347
+ 用户可以通过这些链接快速将其集成到自己的系统中。
348
+ */
345
349
  async CreateEmbedWebUrl(
346
350
  req: CreateEmbedWebUrlRequest,
347
351
  cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void
@@ -412,12 +416,13 @@ export class Client extends AbstractClient {
412
416
  }
413
417
 
414
418
  /**
415
- * ### 适用场景
416
- 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
417
- 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
418
- ### 限制条件
419
- - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
420
- - 他方企业仅支持通过姓名+手机号补充
419
+ * 适用场景:
420
+ 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
421
+
422
+ 限制条件:
423
+ 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
424
+ 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
425
+ 3. 他方企业仅支持通过姓名+手机号进行补充。
421
426
  */
422
427
  async CreateFlowApprovers(
423
428
  req: CreateFlowApproversRequest,
@@ -437,23 +442,7 @@ export class Client extends AbstractClient {
437
442
  }
438
443
 
439
444
  /**
440
- * 通过此接口可以关闭个人用户自动签功能。
441
- 无需对应的用户刷脸等方式同意即可关闭。
442
-
443
- 注意:
444
-
445
- <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
446
- <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
447
- */
448
- async DisableUserAutoSign(
449
- req: DisableUserAutoSignRequest,
450
- cb?: (error: string, rep: DisableUserAutoSignResponse) => void
451
- ): Promise<DisableUserAutoSignResponse> {
452
- return this.request("DisableUserAutoSign", req, cb)
453
- }
454
-
455
- /**
456
- * 解绑员工与对应角色关系
445
+ * 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
457
446
  */
458
447
  async DeleteIntegrationRoleUsers(
459
448
  req: DeleteIntegrationRoleUsersRequest,
@@ -589,8 +578,9 @@ export class Client extends AbstractClient {
589
578
  }
590
579
 
591
580
  /**
592
- * 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
593
- 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
581
+ * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
582
+
583
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
594
584
  */
595
585
  async CreateFlowGroupByTemplates(
596
586
  req: CreateFlowGroupByTemplatesRequest,
@@ -672,8 +662,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
672
662
  }
673
663
 
674
664
  /**
675
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
676
- */
665
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
666
+
667
+ 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
668
+ */
677
669
  async DescribeIntegrationRoles(
678
670
  req: DescribeIntegrationRolesRequest,
679
671
  cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void
@@ -748,7 +740,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
748
740
 
749
741
  ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
750
742
 
751
- 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
743
+ 注:
744
+ <ul>
745
+ <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
746
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
747
+ </ul>
752
748
  */
753
749
  async CreatePersonAuthCertificateImage(
754
750
  req: CreatePersonAuthCertificateImageRequest,
@@ -788,7 +784,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
788
784
  }
789
785
 
790
786
  /**
791
- * 绑定员工与对应角色
787
+ * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
792
788
  */
793
789
  async CreateIntegrationUserRoles(
794
790
  req: CreateIntegrationUserRolesRequest,
@@ -866,15 +862,19 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
866
862
  }
867
863
 
868
864
  /**
869
- * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
865
+ * 通过此接口可以关闭个人用户自动签功能。
866
+ 无需对应的用户刷脸等方式同意即可关闭。
867
+
868
+ 注意:
870
869
 
871
- 通过子企业影子账号查询主企业员工账号
870
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
871
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
872
872
  */
873
- async DescribeIntegrationMainOrganizationUser(
874
- req: DescribeIntegrationMainOrganizationUserRequest,
875
- cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void
876
- ): Promise<DescribeIntegrationMainOrganizationUserResponse> {
877
- return this.request("DescribeIntegrationMainOrganizationUser", req, cb)
873
+ async DisableUserAutoSign(
874
+ req: DisableUserAutoSignRequest,
875
+ cb?: (error: string, rep: DisableUserAutoSignResponse) => void
876
+ ): Promise<DisableUserAutoSignResponse> {
877
+ return this.request("DisableUserAutoSign", req, cb)
878
878
  }
879
879
 
880
880
  /**
@@ -272,28 +272,6 @@ export interface DescribeIntegrationDepartmentsResponse {
272
272
  RequestId?: string
273
273
  }
274
274
 
275
- /**
276
- * 模板中文件的信息结构
277
- */
278
- export interface FileInfo {
279
- /**
280
- * 文件ID
281
- */
282
- FileId?: string
283
- /**
284
- * 文件名
285
- */
286
- FileName?: string
287
- /**
288
- * 文件大小,单位为Byte
289
- */
290
- FileSize?: number
291
- /**
292
- * 文件上传时间,格式为Unix标准时间戳(秒)
293
- */
294
- CreatedOn?: number
295
- }
296
-
297
275
  /**
298
276
  * CreateFlowApprovers返回参数结构体
299
277
  */
@@ -603,27 +581,36 @@ export interface ReleasedApprover {
603
581
  */
604
582
  export interface DescribeIntegrationRolesRequest {
605
583
  /**
606
- * 操作人信息,UserId必填
584
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
585
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
607
586
  */
608
587
  Operator: UserInfo
609
588
  /**
610
- * 指定每页多少条数据,单页最大200
589
+ * 指定分页每页返回的数据条数,单页最大支持 200
611
590
  */
612
591
  Limit: number
613
592
  /**
614
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
593
+ * 代理企业和员工的信息。
594
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
615
595
  */
616
596
  Agent?: Agent
617
597
  /**
618
- * 查询的关键字段:
619
- Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
620
- Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
621
- Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
622
- Key:"IsReturnPermissionGroup"Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
598
+ * 查询的关键字段,支持Key-Value单值查询。可选键值对如下:
599
+ <ul>
600
+ <li>Key:"RoleType",查询角色类型,Values可选:
601
+ <ul><li>**"1"**:查询系统角色</li><li>**"2"**:查询自定义角色</li></ul>
602
+ </li><li>Key:"RoleStatus",查询角色状态,Values可选:
603
+ <ul><li>**"1"**:查询启用角色</li><li>**"2"**:查询禁用角色</li></ul>
604
+ </li><li>Key:"IsGroupRole",是否查询集团角色,Values可选:
605
+ <ul><li>**"0"**:查询非集团角色</li><li>**"1"**:查询集团角色</li></ul>
606
+ </li><li>Key:"IsReturnPermissionGroup",是否返回角色对应权限树,Values可选:
607
+ <ul><li>**"0"**:接口不返回角色对应的权限树字段</li><li>**"1"**:接口返回角色对应的权限树字段</li></ul>
608
+ </li>
609
+ </ul>
623
610
  */
624
611
  Filters?: Array<Filter>
625
612
  /**
626
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
613
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大2000
627
614
  */
628
615
  Offset?: number
629
616
  }
@@ -1259,20 +1246,6 @@ export interface DescribeIntegrationEmployeesRequest {
1259
1246
  Offset?: number
1260
1247
  }
1261
1248
 
1262
- /**
1263
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1264
- */
1265
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1266
- /**
1267
- * 解绑是否成功,1表示成功,0表示失败
1268
- */
1269
- Status?: number
1270
- /**
1271
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1272
- */
1273
- RequestId?: string
1274
- }
1275
-
1276
1249
  /**
1277
1250
  * CreateIntegrationUserRoles返回参数结构体
1278
1251
  */
@@ -1558,13 +1531,17 @@ export interface DescribeThirdPartyAuthCodeRequest {
1558
1531
  }
1559
1532
 
1560
1533
  /**
1561
- * DescribeIntegrationMainOrganizationUser请求参数结构体
1534
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1562
1535
  */
1563
- export interface DescribeIntegrationMainOrganizationUserRequest {
1536
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1564
1537
  /**
1565
- * 操作人信息,userId必填
1538
+ * 解绑是否成功,1表示成功,0表示失败
1566
1539
  */
1567
- Operator: UserInfo
1540
+ Status?: number
1541
+ /**
1542
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1543
+ */
1544
+ RequestId?: string
1568
1545
  }
1569
1546
 
1570
1547
  /**
@@ -1882,12 +1859,15 @@ export interface DescribeUserAutoSignStatusResponse {
1882
1859
  /**
1883
1860
  * 补充签署人信息
1884
1861
  - RecipientId 必须指定
1885
- - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1862
+ - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1886
1863
  - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
1887
1864
  */
1888
1865
  export interface FillApproverInfo {
1889
1866
  /**
1890
- * 对应模板中的参与方ID
1867
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
1868
+ 模板发起合同时,该参数为必填项。
1869
+ 文件发起合同是,该参数无需传值。
1870
+ 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
1891
1871
  */
1892
1872
  RecipientId: string
1893
1873
  /**
@@ -1897,16 +1877,16 @@ WEWORKAPP: 企业微信
1897
1877
  */
1898
1878
  ApproverSource?: string
1899
1879
  /**
1900
- * 企业自定义账号ID
1901
- <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
1880
+ * 企业微信UserId
1881
+ <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
1902
1882
  */
1903
1883
  CustomUserId?: string
1904
1884
  /**
1905
- * 补充签署人姓名
1885
+ * 补充企业签署人员工姓名
1906
1886
  */
1907
1887
  ApproverName?: string
1908
1888
  /**
1909
- * 补充签署人手机号
1889
+ * 补充企业签署人员工手机号
1910
1890
  */
1911
1891
  ApproverMobile?: string
1912
1892
  }
@@ -2340,7 +2320,7 @@ export interface CreateSchemeUrlResponse {
2340
2320
  */
2341
2321
  export interface CreateUserAutoSignEnableUrlResponse {
2342
2322
  /**
2343
- * 个人用户自动签的开通链接, 短链形式
2323
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2344
2324
  */
2345
2325
  Url?: string
2346
2326
  /**
@@ -2788,25 +2768,31 @@ export interface UserInfo {
2788
2768
  */
2789
2769
  export interface CreateFlowApproversRequest {
2790
2770
  /**
2791
- * 调用方用户信息,userId 必填
2771
+ * 执行本接口操作的员工信息。
2772
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2792
2773
  */
2793
2774
  Operator: UserInfo
2794
2775
  /**
2795
- * 签署流程编号
2776
+ * 合同流程ID,为32位字符串。
2777
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2778
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2796
2779
  */
2797
2780
  FlowId: string
2798
2781
  /**
2799
- * 补充签署人信息
2782
+ * 补充企业签署人信息。
2783
+
2784
+ - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
2785
+
2786
+ - 如果不指定,则使用姓名和手机号进行补充。
2800
2787
  */
2801
2788
  Approvers: Array<FillApproverInfo>
2802
2789
  /**
2803
- * 企微消息中的发起人
2790
+ * 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
2804
2791
  */
2805
2792
  Initiator?: string
2806
2793
  /**
2807
- * 代理相关应用信息,如集团主企业代子企业操作
2808
-
2809
-
2794
+ * 代理企业和员工的信息。
2795
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2810
2796
  */
2811
2797
  Agent?: Agent
2812
2798
  }
@@ -2879,10 +2865,10 @@ export interface FlowCreateApprover {
2879
2865
  */
2880
2866
  ApproverIdCardNumber?: string
2881
2867
  /**
2882
- * 签署方经办人在模板中的参与方ID
2883
- <br/>模板发起合同时,该参数为必填项
2884
- <br/>文件发起合同是,该参数无序传值
2885
-
2868
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
2869
+ 模板发起合同时,该参数为必填项。
2870
+ 文件发起合同是,该参数无需传值。
2871
+ 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
2886
2872
  */
2887
2873
  RecipientId?: string
2888
2874
  /**
@@ -3417,24 +3403,23 @@ export interface CreateEmbedWebUrlRequest {
3417
3403
  */
3418
3404
  Operator: UserInfo
3419
3405
  /**
3420
- * WEB嵌入资源类型。
3421
- <br/>CREATE_SEAL: 生成创建印章的嵌入页面
3422
- <br/>CREATE_TEMPLATE:生成创建模板的嵌入页面
3423
- <br/>MODIFY_TEMPLATE:生成编辑模板的嵌入页面
3424
- <br/>PREVIEW_TEMPLATE:生成预览模板的嵌入页面
3425
- <br/>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
3426
- <br/>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
3427
- <br/>EXTEND_SERVICE:生成拓展服务的嵌入页面
3428
- <br/>PREVIEW_FLOW:生成预览合同的嵌入页面
3429
- <br/>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面
3430
-
3406
+ * WEB嵌入资源类型,支持以下类型
3407
+ <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
3408
+ <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
3409
+ <li>MODIFY_TEMPLATE:生成编辑模板的嵌入页面</li>
3410
+ <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
3411
+ <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
3412
+ <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
3413
+ <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
3414
+ <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
3415
+ <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
3431
3416
  */
3432
3417
  EmbedType: string
3433
3418
  /**
3434
3419
  * WEB嵌入的业务资源ID
3435
- <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
3436
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
3437
- <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
3420
+ <ul><li>PREVIEW_SEAL_DETAIL,必填,取值为印章id</li>
3421
+ <li>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id</li>
3422
+ <li>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id</li><ul>
3438
3423
  */
3439
3424
  BusinessId?: string
3440
3425
  /**
@@ -3621,11 +3606,11 @@ export interface CreateIntegrationEmployeesResponse {
3621
3606
  */
3622
3607
  export interface DeleteIntegrationRoleUsersRequest {
3623
3608
  /**
3624
- * 操作人信息,userId必填
3609
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3625
3610
  */
3626
3611
  Operator: UserInfo
3627
3612
  /**
3628
- * 角色id
3613
+ * 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3629
3614
  */
3630
3615
  RoleId: string
3631
3616
  /**
@@ -3633,7 +3618,7 @@ export interface DeleteIntegrationRoleUsersRequest {
3633
3618
  */
3634
3619
  Users: Array<UserInfo>
3635
3620
  /**
3636
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3621
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3637
3622
  */
3638
3623
  Agent?: Agent
3639
3624
  }
@@ -3876,7 +3861,7 @@ export interface CreateReleaseFlowRequest {
3876
3861
  */
3877
3862
  export interface CreateIntegrationUserRolesRequest {
3878
3863
  /**
3879
- * 操作人信息,UserId必填
3864
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3880
3865
  */
3881
3866
  Operator: UserInfo
3882
3867
  /**
@@ -3884,11 +3869,11 @@ export interface CreateIntegrationUserRolesRequest {
3884
3869
  */
3885
3870
  UserIds: Array<string>
3886
3871
  /**
3887
- * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
3872
+ * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
3888
3873
  */
3889
3874
  RoleIds: Array<string>
3890
3875
  /**
3891
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3876
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3892
3877
  */
3893
3878
  Agent?: Agent
3894
3879
  }
@@ -4465,18 +4450,25 @@ export interface CreateOrganizationBatchSignUrlResponse {
4465
4450
  }
4466
4451
 
4467
4452
  /**
4468
- * DescribeIntegrationMainOrganizationUser返回参数结构体
4453
+ * 模板中文件的信息结构
4469
4454
  */
4470
- export interface DescribeIntegrationMainOrganizationUserResponse {
4455
+ export interface FileInfo {
4471
4456
  /**
4472
- * 主企业员工账号信息
4473
- 注意:此字段可能返回 null,表示取不到有效值。
4457
+ * 文件ID
4474
4458
  */
4475
- IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser
4459
+ FileId?: string
4476
4460
  /**
4477
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4461
+ * 文件名
4478
4462
  */
4479
- RequestId?: string
4463
+ FileName?: string
4464
+ /**
4465
+ * 文件大小,单位为Byte
4466
+ */
4467
+ FileSize?: number
4468
+ /**
4469
+ * 文件上传时间,格式为Unix标准时间戳(秒)
4470
+ */
4471
+ CreatedOn?: number
4480
4472
  }
4481
4473
 
4482
4474
  /**
@@ -4820,27 +4812,6 @@ export interface ModifyApplicationCallbackInfoRequest {
4820
4812
  Agent?: Agent
4821
4813
  }
4822
4814
 
4823
- /**
4824
- * 主企业员工账号信息
4825
- */
4826
- export interface IntegrationMainOrganizationUser {
4827
- /**
4828
- * 主企业id
4829
- 注意:此字段可能返回 null,表示取不到有效值。
4830
- */
4831
- MainOrganizationId?: string
4832
- /**
4833
- * 主企业员工UserId
4834
- 注意:此字段可能返回 null,表示取不到有效值。
4835
- */
4836
- MainUserId?: string
4837
- /**
4838
- * 主企业员工名
4839
- 注意:此字段可能返回 null,表示取不到有效值。
4840
- */
4841
- UserName?: string
4842
- }
4843
-
4844
4815
  /**
4845
4816
  * StartFlow请求参数结构体
4846
4817
  */
@@ -5493,19 +5464,19 @@ export interface DescribeExtendedServiceAuthInfosRequest {
5493
5464
  */
5494
5465
  export interface DescribeIntegrationRolesResponse {
5495
5466
  /**
5496
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
5467
+ * 指定分页返回的页码。页码从0开始,最大为2000
5497
5468
  */
5498
5469
  Offset?: number
5499
5470
  /**
5500
- * 指定每页多少条数据,单页最大200
5471
+ * 指定分页每页返回的数据条数,单页最大支持 200
5501
5472
  */
5502
5473
  Limit?: number
5503
5474
  /**
5504
- * 符合查询条件的总的角色数
5475
+ * 符合查询条件的总角色数。
5505
5476
  */
5506
5477
  TotalCount?: number
5507
5478
  /**
5508
- * 企业角色信息列表
5479
+ * 企业角色信息列表。
5509
5480
  */
5510
5481
  IntegrateRoles?: Array<IntegrateRole>
5511
5482
  /**
@@ -5582,23 +5553,30 @@ export interface DescribeFlowBriefsRequest {
5582
5553
  */
5583
5554
  export interface CreateFlowGroupByTemplatesRequest {
5584
5555
  /**
5585
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
5556
+ * 执行本接口操作的员工信息。
5557
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5586
5558
  */
5587
5559
  Operator: UserInfo
5588
5560
  /**
5589
- * 合同组名称,最大长度200个字符
5561
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5590
5562
  */
5591
5563
  FlowGroupName: string
5592
5564
  /**
5593
- * 合同组的子合同信息,支持2-50个子合同
5565
+ * 合同(流程)组的子合同信息,支持2-50个子合同
5594
5566
  */
5595
5567
  FlowGroupInfos: Array<FlowGroupInfo>
5596
5568
  /**
5597
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5569
+ * 代理企业和员工的信息。
5570
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5598
5571
  */
5599
5572
  Agent?: Agent
5600
5573
  /**
5601
- * 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
5574
+ * 合同(流程)组的配置项信息。
5575
+ 其中包括:
5576
+ <ul>
5577
+ <li>是否通知本企业签署方</li>
5578
+ <li>是否通知其他签署方</li>
5579
+ </ul>
5602
5580
  */
5603
5581
  FlowGroupOptions?: FlowGroupOptions
5604
5582
  }