tencentcloud-sdk-nodejs 4.0.687 → 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 (124) hide show
  1. package/CHANGELOG.md +786 -0
  2. package/SERVICE_CHANGELOG.md +867 -69
  3. package/package.json +1 -1
  4. package/products.md +33 -33
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/advisor/v20200721/advisor_client.ts +2 -2
  7. package/src/services/advisor/v20200721/advisor_models.ts +53 -53
  8. package/src/services/apigateway/v20180808/apigateway_models.ts +20 -0
  9. package/src/services/asr/v20190614/asr_models.ts +64 -63
  10. package/src/services/cdb/v20170320/cdb_client.ts +1 -0
  11. package/src/services/cdb/v20170320/cdb_models.ts +40 -4
  12. package/src/services/ckafka/v20190819/ckafka_client.ts +13 -0
  13. package/src/services/ckafka/v20190819/ckafka_models.ts +35 -0
  14. package/src/services/cvm/v20170312/cvm_client.ts +6 -3
  15. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  16. package/src/services/cynosdb/v20190107/cynosdb_client.ts +9 -7
  17. package/src/services/cynosdb/v20190107/cynosdb_models.ts +198 -77
  18. package/src/services/dlc/v20210125/dlc_client.ts +13 -1
  19. package/src/services/dlc/v20210125/dlc_models.ts +80 -39
  20. package/src/services/es/v20180416/es_client.ts +2 -1
  21. package/src/services/es/v20180416/es_models.ts +214 -175
  22. package/src/services/ess/v20201111/ess_client.ts +71 -54
  23. package/src/services/ess/v20201111/ess_models.ts +192 -180
  24. package/src/services/essbasic/v20210526/essbasic_client.ts +52 -3
  25. package/src/services/essbasic/v20210526/essbasic_models.ts +206 -12
  26. package/src/services/ims/v20201229/ims_client.ts +2 -2
  27. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  28. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -19
  29. package/src/services/mongodb/v20190725/mongodb_models.ts +46 -46
  30. package/src/services/monitor/v20180724/monitor_models.ts +6 -2
  31. package/src/services/nlp/v20190408/nlp_client.ts +0 -15
  32. package/src/services/nlp/v20190408/nlp_models.ts +0 -117
  33. package/src/services/ocr/v20181119/ocr_models.ts +1 -1
  34. package/src/services/omics/v20221128/omics_models.ts +1 -1
  35. package/src/services/postgres/v20170312/postgres_models.ts +33 -30
  36. package/src/services/ses/v20201002/ses_models.ts +9 -4
  37. package/src/services/ssa/v20180608/ssa_client.ts +16 -3
  38. package/src/services/ssa/v20180608/ssa_models.ts +94 -24
  39. package/src/services/ssl/v20191205/ssl_client.ts +26 -2
  40. package/src/services/ssl/v20191205/ssl_models.ts +64 -16
  41. package/src/services/tcss/v20201101/tcss_client.ts +3 -2
  42. package/src/services/tcss/v20201101/tcss_models.ts +278 -113
  43. package/src/services/teo/v20220901/teo_models.ts +2 -2
  44. package/src/services/thpc/v20230321/thpc_models.ts +4 -0
  45. package/src/services/tse/v20201207/tse_client.ts +40 -25
  46. package/src/services/tse/v20201207/tse_models.ts +184 -6
  47. package/src/services/vm/v20201229/vm_client.ts +6 -6
  48. package/src/services/vm/v20201229/vm_models.ts +2 -2
  49. package/src/services/vod/v20180717/vod_client.ts +6 -10
  50. package/src/services/vod/v20180717/vod_models.ts +755 -663
  51. package/src/services/vpc/v20170312/vpc_models.ts +40 -22
  52. package/src/services/waf/v20180125/waf_client.ts +54 -26
  53. package/src/services/waf/v20180125/waf_models.ts +330 -68
  54. package/tencentcloud/common/sdk_version.d.ts +1 -1
  55. package/tencentcloud/common/sdk_version.js +1 -1
  56. package/tencentcloud/services/advisor/v20200721/advisor_models.d.ts +52 -52
  57. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +20 -0
  58. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +64 -63
  59. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +39 -4
  60. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  61. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  62. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +32 -0
  63. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -0
  64. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -0
  65. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  66. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +6 -6
  67. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +5 -5
  68. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +193 -74
  69. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  70. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  71. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +78 -39
  72. package/tencentcloud/services/es/v20180416/es_models.d.ts +205 -167
  73. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +62 -36
  74. package/tencentcloud/services/ess/v20201111/ess_client.js +62 -38
  75. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +192 -177
  76. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -3
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -2
  78. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +198 -12
  79. package/tencentcloud/services/ims/v20201229/ims_client.d.ts +2 -2
  80. package/tencentcloud/services/ims/v20201229/ims_client.js +2 -2
  81. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  82. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -19
  83. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +46 -46
  84. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +6 -2
  85. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -5
  86. package/tencentcloud/services/nlp/v20190408/nlp_client.js +0 -6
  87. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +0 -112
  88. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +1 -1
  89. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +1 -1
  90. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +33 -30
  91. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +9 -4
  92. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  93. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  94. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +91 -24
  95. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +9 -1
  96. package/tencentcloud/services/ssl/v20191205/ssl_client.js +12 -0
  97. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +60 -16
  98. package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +2 -2
  99. package/tencentcloud/services/tcss/v20201101/tcss_client.js +1 -1
  100. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +277 -113
  101. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +2 -2
  102. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +4 -0
  103. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +13 -9
  104. package/tencentcloud/services/tse/v20201207/tse_client.js +18 -12
  105. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +179 -6
  106. package/tencentcloud/services/vm/v20201229/vm_client.d.ts +6 -6
  107. package/tencentcloud/services/vm/v20201229/vm_client.js +6 -6
  108. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +2 -2
  109. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -8
  110. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -7
  111. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +753 -663
  112. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +40 -22
  113. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +17 -9
  114. package/tencentcloud/services/waf/v20180125/waf_client.js +24 -12
  115. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +322 -68
  116. package/test/ckafka.v20190819.test.js +10 -0
  117. package/test/dlc.v20210125.test.js +10 -0
  118. package/test/ess.v20201111.test.js +2 -12
  119. package/test/essbasic.v20210526.test.js +30 -0
  120. package/test/nlp.v20190408.test.js +0 -10
  121. package/test/ssa.v20180608.test.js +10 -0
  122. package/test/ssl.v20191205.test.js +20 -0
  123. package/test/tse.v20201207.test.js +18 -8
  124. package/test/waf.v20180125.test.js +28 -8
@@ -116,7 +116,7 @@ export interface DescribeFlowEvidenceReportRequest {
116
116
  */
117
117
  Operator: UserInfo;
118
118
  /**
119
- * 签署报告编号
119
+ * 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
120
120
  */
121
121
  ReportId: string;
122
122
  /**
@@ -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
  }
@@ -924,11 +912,12 @@ export interface FlowApproverDetail {
924
912
  */
925
913
  export interface CreateFlowGroupByFilesRequest {
926
914
  /**
927
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
915
+ * 执行本接口操作的员工信息。
916
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
928
917
  */
929
918
  Operator: UserInfo;
930
919
  /**
931
- * 合同(流程)组名称,最大长度200个字符
920
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
932
921
  */
933
922
  FlowGroupName: string;
934
923
  /**
@@ -936,11 +925,17 @@ export interface CreateFlowGroupByFilesRequest {
936
925
  */
937
926
  FlowGroupInfos: Array<FlowGroupInfo>;
938
927
  /**
939
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
928
+ * 代理企业和员工的信息。
929
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
940
930
  */
941
931
  Agent?: Agent;
942
932
  /**
943
- * 合同(流程)组的配置项信息。包括是否通知本企业签署方,是否通知其他签署方
933
+ * 合同(流程)组的配置项信息。
934
+ 其中包括:
935
+ <ul>
936
+ <li>是否通知本企业签署方</li>
937
+ <li>是否通知其他签署方</li>
938
+ </ul>
944
939
  */
945
940
  FlowGroupOptions?: FlowGroupOptions;
946
941
  }
@@ -963,17 +958,16 @@ export interface DescribeFlowComponentsResponse {
963
958
  */
964
959
  export interface DescribeFlowEvidenceReportResponse {
965
960
  /**
966
- * 出证报告PDF的下载 URL
961
+ * 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
967
962
  注意:此字段可能返回 null,表示取不到有效值。
968
963
  */
969
964
  ReportUrl?: string;
970
965
  /**
971
- * 签署报告出证任务的状态
972
- <ul>
973
- <li>EvidenceStatusExecuting : 出证任务在执行中</li>
974
- <li>EvidenceStatusSuccess : 出证任务执行成功</li>
975
- <li>EvidenceStatusFailed : 出证任务执行失败</li>
976
- </ul>
966
+ * 出证任务执行的状态, 状态含义如下:
967
+
968
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
969
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
970
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
977
971
  */
978
972
  Status?: string;
979
973
  /**
@@ -1192,19 +1186,6 @@ export interface DescribeIntegrationEmployeesRequest {
1192
1186
  */
1193
1187
  Offset?: number;
1194
1188
  }
1195
- /**
1196
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1197
- */
1198
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1199
- /**
1200
- * 解绑是否成功,1表示成功,0表示失败
1201
- */
1202
- Status?: number;
1203
- /**
1204
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1205
- */
1206
- RequestId?: string;
1207
- }
1208
1189
  /**
1209
1190
  * CreateIntegrationUserRoles返回参数结构体
1210
1191
  */
@@ -1460,8 +1441,7 @@ export interface AutoSignConfig {
1460
1441
  * 设置用户开通自动签时是否绑定个人自动签账号许可。
1461
1442
 
1462
1443
  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1463
- <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
1464
-
1444
+ </ul>
1465
1445
  */
1466
1446
  LicenseType?: number;
1467
1447
  }
@@ -1485,13 +1465,17 @@ export interface DescribeThirdPartyAuthCodeRequest {
1485
1465
  Agent?: Agent;
1486
1466
  }
1487
1467
  /**
1488
- * DescribeIntegrationMainOrganizationUser请求参数结构体
1468
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1489
1469
  */
1490
- export interface DescribeIntegrationMainOrganizationUserRequest {
1470
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1491
1471
  /**
1492
- * 操作人信息,userId必填
1472
+ * 解绑是否成功,1表示成功,0表示失败
1493
1473
  */
1494
- Operator: UserInfo;
1474
+ Status?: number;
1475
+ /**
1476
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1477
+ */
1478
+ RequestId?: string;
1495
1479
  }
1496
1480
  /**
1497
1481
  * CreateReleaseFlow返回参数结构体
@@ -1786,9 +1770,7 @@ export interface DescribeUserAutoSignStatusResponse {
1786
1770
  /**
1787
1771
  * 设置用户开通自动签时是否绑定个人自动签账号许可。
1788
1772
 
1789
- <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1790
- <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
1791
-
1773
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
1792
1774
  */
1793
1775
  LicenseType?: number;
1794
1776
  /**
@@ -1799,12 +1781,15 @@ export interface DescribeUserAutoSignStatusResponse {
1799
1781
  /**
1800
1782
  * 补充签署人信息
1801
1783
  - RecipientId 必须指定
1802
- - 通过企业自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1784
+ - 通过企业微信自定义账号ID补充签署人时,ApproverSource 和 CustomUserId 必填,ApproverSource取值:WEWORKAPP
1803
1785
  - 通过二要素(姓名/手机号)补充签署人时,ApproverName 和 ApproverMobile 必填,ApproverSource设置为空
1804
1786
  */
1805
1787
  export interface FillApproverInfo {
1806
1788
  /**
1807
- * 对应模板中的参与方ID
1789
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
1790
+ 模板发起合同时,该参数为必填项。
1791
+ 文件发起合同是,该参数无需传值。
1792
+ 如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
1808
1793
  */
1809
1794
  RecipientId: string;
1810
1795
  /**
@@ -1814,16 +1799,16 @@ export interface FillApproverInfo {
1814
1799
  */
1815
1800
  ApproverSource?: string;
1816
1801
  /**
1817
- * 企业自定义账号ID
1818
- <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企微明文的userid
1802
+ * 企业微信UserId
1803
+ <br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
1819
1804
  */
1820
1805
  CustomUserId?: string;
1821
1806
  /**
1822
- * 补充签署人姓名
1807
+ * 补充企业签署人员工姓名
1823
1808
  */
1824
1809
  ApproverName?: string;
1825
1810
  /**
1826
- * 补充签署人手机号
1811
+ * 补充企业签署人员工手机号
1827
1812
  */
1828
1813
  ApproverMobile?: string;
1829
1814
  }
@@ -2241,7 +2226,7 @@ export interface CreateSchemeUrlResponse {
2241
2226
  */
2242
2227
  export interface CreateUserAutoSignEnableUrlResponse {
2243
2228
  /**
2244
- * 个人用户自动签的开通链接, 短链形式
2229
+ * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
2245
2230
  */
2246
2231
  Url?: string;
2247
2232
  /**
@@ -2284,55 +2269,82 @@ export interface CreateUserAutoSignEnableUrlResponse {
2284
2269
  */
2285
2270
  export interface FlowGroupInfo {
2286
2271
  /**
2287
- * 合同(流程)的名称
2272
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
2273
+ 该名称还将用于合同签署完成后的下载文件名。
2288
2274
  */
2289
2275
  FlowName: string;
2290
2276
  /**
2291
- * 合同(流程)的签署方信息
2277
+ * 签署流程参与者信息,最大限制50方
2278
+ 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
2292
2279
  */
2293
2280
  Approvers: Array<ApproverInfo>;
2294
2281
  /**
2295
- * 发起合同(流程)的资源Id,此资源必须是PDF文件,来自UploadFiles,使用文件发起合同(流程)组时必传
2282
+ * 文件资源ID,通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得,为32位字符串。
2283
+ 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
2296
2284
  */
2297
2285
  FileIds?: Array<string>;
2298
2286
  /**
2299
- * 发起合同(流程)的模板Id,用模板发起合同(流程)组时必填
2287
+ * 合同模板ID,为32位字符串。
2288
+ 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
2289
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
2300
2290
  */
2301
2291
  TemplateId?: string;
2302
2292
  /**
2303
- * 合同(流程)的类型
2293
+ * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
2294
+ 示例值:劳务合同
2304
2295
  */
2305
2296
  FlowType?: string;
2306
2297
  /**
2307
- * 合同(流程)的描述
2298
+ * 签署流程描述,最大长度1000个字符
2308
2299
  */
2309
2300
  FlowDescription?: string;
2310
2301
  /**
2311
- * 合同(流程)的截止时间戳,单位秒。默认是一年
2302
+ * 签署流程的签署截止时间。
2303
+
2304
+ 值为unix时间戳,精确到秒,不传默认为当前时间一年后
2305
+ 示例值:1604912664
2312
2306
  */
2313
2307
  Deadline?: number;
2314
2308
  /**
2315
2309
  * 合同(流程)的回调地址
2310
+ * @deprecated
2316
2311
  */
2317
2312
  CallbackUrl?: string;
2318
2313
  /**
2319
- * 第三方平台传递过来的信息, 限制1024字符 格式必须是base64的
2314
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
2315
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
2316
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
2320
2317
  */
2321
2318
  UserData?: string;
2322
2319
  /**
2323
- * 合同(流程)的签署是否是无序签, true - 无序。 false - 有序, 默认
2320
+ * 发送类型:
2321
+ true:无序签
2322
+ false:有序签
2323
+ 注:默认为false(有序签),请和模板中的配置保持一致
2324
+ 示例值:true
2324
2325
  */
2325
2326
  Unordered?: boolean;
2326
2327
  /**
2327
- * 合同(流程)发起方的填写控件, 由发起方进行在发起时进行填充
2328
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2329
+ <ul><li>单行文本控件</li>
2330
+ <li>多行文本控件</li>
2331
+ <li>勾选框控件</li>
2332
+ <li>数字控件</li>
2333
+ <li>图片控件</li>
2334
+ <li>动态表格等填写控件</li></ul>
2328
2335
  */
2329
2336
  Components?: Array<Component>;
2330
2337
  /**
2331
- * 本企业(发起方)是否需要签署审批,若需要审批则只允许查看不允许签署,需要您调用接口CreateFlowSignReview提交审批结果。
2338
+ * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
2339
+ 若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
2340
+
2341
+ 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2342
+ 示例值:true
2332
2343
  */
2333
2344
  NeedSignReview?: boolean;
2334
2345
  /**
2335
- * 本企业(发起方)自动签署,需要您在发起合同时给印章控件指定自动签的印章。
2346
+ * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2347
+ 示例值:E_PRESCRIPTION_AUTO_SIGN
2336
2348
  */
2337
2349
  AutoSignScene?: string;
2338
2350
  }
@@ -2655,25 +2667,31 @@ export interface UserInfo {
2655
2667
  */
2656
2668
  export interface CreateFlowApproversRequest {
2657
2669
  /**
2658
- * 调用方用户信息,userId 必填
2670
+ * 执行本接口操作的员工信息。
2671
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2659
2672
  */
2660
2673
  Operator: UserInfo;
2661
2674
  /**
2662
- * 签署流程编号
2675
+ * 合同流程ID,为32位字符串。
2676
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2677
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2663
2678
  */
2664
2679
  FlowId: string;
2665
2680
  /**
2666
- * 补充签署人信息
2681
+ * 补充企业签署人信息。
2682
+
2683
+ - 如果发起方指定的补充签署人是企业微信签署人(ApproverSource=WEWORKAPP),则需要提供企业微信UserId进行补充;
2684
+
2685
+ - 如果不指定,则使用姓名和手机号进行补充。
2667
2686
  */
2668
2687
  Approvers: Array<FillApproverInfo>;
2669
2688
  /**
2670
- * 企微消息中的发起人
2689
+ * 在可定制的企业微信通知中,发起人可以根据具体需求进行自定义设置。
2671
2690
  */
2672
2691
  Initiator?: string;
2673
2692
  /**
2674
- * 代理相关应用信息,如集团主企业代子企业操作
2675
-
2676
-
2693
+ * 代理企业和员工的信息。
2694
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2677
2695
  */
2678
2696
  Agent?: Agent;
2679
2697
  }
@@ -2744,10 +2762,10 @@ export interface FlowCreateApprover {
2744
2762
  */
2745
2763
  ApproverIdCardNumber?: string;
2746
2764
  /**
2747
- * 签署方经办人在模板中的参与方ID
2748
- <br/>模板发起合同时,该参数为必填项
2749
- <br/>文件发起合同是,该参数无序传值
2750
-
2765
+ * 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
2766
+ 模板发起合同时,该参数为必填项。
2767
+ 文件发起合同是,该参数无需传值。
2768
+ 如果开发者后续用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
2751
2769
  */
2752
2770
  RecipientId?: string;
2753
2771
  /**
@@ -2993,16 +3011,16 @@ export interface RecipientComponentInfo {
2993
3011
  */
2994
3012
  export interface CreateFlowEvidenceReportResponse {
2995
3013
  /**
2996
- * 出证报告 ID,可用于DescribeFlowEvidenceReport接口查询出证PDF的下载地址
3014
+ * 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
2997
3015
  注意:此字段可能返回 null,表示取不到有效值。
2998
3016
  */
2999
3017
  ReportId?: string;
3000
3018
  /**
3001
- * 出证任务执行的状态, 可能会有以下状态:
3019
+ * 出证任务执行的状态, 状态含义如下:
3002
3020
 
3003
- <ul><li>EvidenceStatusExecuting 出证任务在执行中</li>
3004
- <li>EvidenceStatusSuccess 出证任务执行成功</li>
3005
- <li>EvidenceStatusFailed : 出征任务执行失败</li></ul>
3021
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
3022
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
3023
+ <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
3006
3024
  */
3007
3025
  Status?: string;
3008
3026
  /**
@@ -3269,24 +3287,23 @@ export interface CreateEmbedWebUrlRequest {
3269
3287
  */
3270
3288
  Operator: UserInfo;
3271
3289
  /**
3272
- * WEB嵌入资源类型。
3273
- <br/>CREATE_SEAL: 生成创建印章的嵌入页面
3274
- <br/>CREATE_TEMPLATE:生成创建模板的嵌入页面
3275
- <br/>MODIFY_TEMPLATE:生成编辑模板的嵌入页面
3276
- <br/>PREVIEW_TEMPLATE:生成预览模板的嵌入页面
3277
- <br/>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
3278
- <br/>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
3279
- <br/>EXTEND_SERVICE:生成拓展服务的嵌入页面
3280
- <br/>PREVIEW_FLOW:生成预览合同的嵌入页面
3281
- <br/>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面
3282
-
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>
3283
3300
  */
3284
3301
  EmbedType: string;
3285
3302
  /**
3286
3303
  * WEB嵌入的业务资源ID
3287
- <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
3288
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
3289
- <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>
3290
3307
  */
3291
3308
  BusinessId?: string;
3292
3309
  /**
@@ -3372,20 +3389,22 @@ export interface GetTaskResultApiRequest {
3372
3389
  */
3373
3390
  export interface FlowGroupOptions {
3374
3391
  /**
3375
- * 发起合同(流程)组的合同(流程)签署人校验方式
3376
- VerifyCheck: 人脸识别(默认)
3377
- MobileCheck:手机号验证
3392
+ * 签署人校验方式,支持以下类型
3393
+ <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
3394
+ <li>MobileCheck : 手机号验证</li></ul>
3378
3395
  参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3379
3396
  */
3380
3397
  ApproverVerifyType?: string;
3381
3398
  /**
3382
3399
  * 发起合同(流程)组本方企业经办人通知方式
3383
- 签署通知类型:sms--短信,none--不通知
3400
+ 签署通知类型,支持以下类型
3401
+ <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
3384
3402
  */
3385
3403
  SelfOrganizationApproverNotifyType?: string;
3386
3404
  /**
3387
3405
  * 发起合同(流程)组他方经办人通知方式
3388
- 签署通知类型:sms--短信,none--不通知
3406
+ 签署通知类型,支持以下类型
3407
+ <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
3389
3408
  */
3390
3409
  OtherApproverNotifyType?: string;
3391
3410
  }
@@ -3463,11 +3482,11 @@ export interface CreateIntegrationEmployeesResponse {
3463
3482
  */
3464
3483
  export interface DeleteIntegrationRoleUsersRequest {
3465
3484
  /**
3466
- * 操作人信息,userId必填
3485
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3467
3486
  */
3468
3487
  Operator: UserInfo;
3469
3488
  /**
3470
- * 角色id
3489
+ * 角色id,可以通过DescribeIntegrationRoles接口获取角色信息
3471
3490
  */
3472
3491
  RoleId: string;
3473
3492
  /**
@@ -3475,7 +3494,7 @@ export interface DeleteIntegrationRoleUsersRequest {
3475
3494
  */
3476
3495
  Users: Array<UserInfo>;
3477
3496
  /**
3478
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3497
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3479
3498
  */
3480
3499
  Agent?: Agent;
3481
3500
  }
@@ -3714,7 +3733,7 @@ export interface CreateReleaseFlowRequest {
3714
3733
  */
3715
3734
  export interface CreateIntegrationUserRolesRequest {
3716
3735
  /**
3717
- * 操作人信息,UserId必填
3736
+ * 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3718
3737
  */
3719
3738
  Operator: UserInfo;
3720
3739
  /**
@@ -3722,11 +3741,11 @@ export interface CreateIntegrationUserRolesRequest {
3722
3741
  */
3723
3742
  UserIds: Array<string>;
3724
3743
  /**
3725
- * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
3744
+ * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息
3726
3745
  */
3727
3746
  RoleIds: Array<string>;
3728
3747
  /**
3729
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3748
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3730
3749
  */
3731
3750
  Agent?: Agent;
3732
3751
  }
@@ -4286,18 +4305,25 @@ export interface CreateOrganizationBatchSignUrlResponse {
4286
4305
  RequestId?: string;
4287
4306
  }
4288
4307
  /**
4289
- * DescribeIntegrationMainOrganizationUser返回参数结构体
4308
+ * 模板中文件的信息结构
4290
4309
  */
4291
- export interface DescribeIntegrationMainOrganizationUserResponse {
4310
+ export interface FileInfo {
4292
4311
  /**
4293
- * 主企业员工账号信息
4294
- 注意:此字段可能返回 null,表示取不到有效值。
4312
+ * 文件ID
4295
4313
  */
4296
- IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser;
4314
+ FileId?: string;
4297
4315
  /**
4298
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4316
+ * 文件名
4299
4317
  */
4300
- RequestId?: string;
4318
+ FileName?: string;
4319
+ /**
4320
+ * 文件大小,单位为Byte
4321
+ */
4322
+ FileSize?: number;
4323
+ /**
4324
+ * 文件上传时间,格式为Unix标准时间戳(秒)
4325
+ */
4326
+ CreatedOn?: number;
4301
4327
  }
4302
4328
  /**
4303
4329
  * CancelUserAutoSignEnableUrl请求参数结构体
@@ -4373,13 +4399,13 @@ export interface ApproverRestriction {
4373
4399
  */
4374
4400
  export interface CreateWebThemeConfigRequest {
4375
4401
  /**
4376
- * 操作人信息
4402
+ * 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4377
4403
  */
4378
4404
  Operator: UserInfo;
4379
4405
  /**
4380
- * 主题类型
4381
- <br/>EMBED_WEB_THEME:嵌入式主题
4382
- <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
4406
+ * 主题类型,取值如下:
4407
+ <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
4408
+ </ul>
4383
4409
  */
4384
4410
  ThemeType: string;
4385
4411
  /**
@@ -4387,7 +4413,8 @@ export interface CreateWebThemeConfigRequest {
4387
4413
  */
4388
4414
  WebThemeConfig: WebThemeConfig;
4389
4415
  /**
4390
- * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4416
+ * 代理企业和员工的信息。
4417
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4391
4418
  */
4392
4419
  Agent?: Agent;
4393
4420
  }
@@ -4428,8 +4455,8 @@ export interface CreateOrganizationBatchSignUrlRequest {
4428
4455
  */
4429
4456
  Operator: UserInfo;
4430
4457
  /**
4431
- * 请指定需执行批量签署的流程ID,数量范围为1-100。</br>
4432
- 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。</br>
4458
+ * 请指定需执行批量签署的流程ID,数量范围为1-100
4459
+ 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。
4433
4460
  用户将利用链接对这些合同实施批量操作。
4434
4461
  */
4435
4462
  FlowIds: Array<string>;
@@ -4439,19 +4466,21 @@ export interface CreateOrganizationBatchSignUrlRequest {
4439
4466
  */
4440
4467
  Agent?: Agent;
4441
4468
  /**
4442
- * 员工在腾讯电子签平台的独特身份标识,为32位字符串。</br>
4443
- 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。</br>
4469
+ * 员工在腾讯电子签平台的独特身份标识,为32位字符串。
4470
+ 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
4444
4471
  UserId必须是传入合同(FlowId)中的签署人。
4445
4472
  - 1. 若UserId为空,Name和Mobile 必须提供。
4446
4473
  - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
4447
4474
  */
4448
4475
  UserId?: string;
4449
4476
  /**
4450
- * 员工姓名,必须与手机号码一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4477
+ * 员工姓名,必须与手机号码一起使用。
4478
+ 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4451
4479
  */
4452
4480
  Name?: string;
4453
4481
  /**
4454
- * 员工手机号,必须与姓名一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4482
+ * 员工手机号,必须与姓名一起使用。
4483
+ 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4455
4484
  */
4456
4485
  Mobile?: string;
4457
4486
  }
@@ -4588,15 +4617,14 @@ export interface DeleteIntegrationDepartmentRequest {
4588
4617
  export interface WebThemeConfig {
4589
4618
  /**
4590
4619
  * 是否显示页面底部电子签logo,取值如下:
4591
- <ul>
4592
- <li> **true**:页面底部显示电子签logo</li>
4593
- <li> **false**:页面底部不显示电子签logo(默认)</li>
4594
- </ul>
4620
+ <ul><li> **true**:页面底部显示电子签logo</li>
4621
+ <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
4595
4622
  */
4596
4623
  DisplaySignBrandLogo?: boolean;
4597
4624
  /**
4598
- * 主题颜色
4599
- <br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
4625
+ * 主题颜色:
4626
+ 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
4627
+ <br/>
4600
4628
  */
4601
4629
  WebEmbedThemeColor?: string;
4602
4630
  }
@@ -4625,26 +4653,6 @@ export interface ModifyApplicationCallbackInfoRequest {
4625
4653
  */
4626
4654
  Agent?: Agent;
4627
4655
  }
4628
- /**
4629
- * 主企业员工账号信息
4630
- */
4631
- export interface IntegrationMainOrganizationUser {
4632
- /**
4633
- * 主企业id
4634
- 注意:此字段可能返回 null,表示取不到有效值。
4635
- */
4636
- MainOrganizationId?: string;
4637
- /**
4638
- * 主企业员工UserId
4639
- 注意:此字段可能返回 null,表示取不到有效值。
4640
- */
4641
- MainUserId?: string;
4642
- /**
4643
- * 主企业员工名
4644
- 注意:此字段可能返回 null,表示取不到有效值。
4645
- */
4646
- UserName?: string;
4647
- }
4648
4656
  /**
4649
4657
  * StartFlow请求参数结构体
4650
4658
  */
@@ -5284,19 +5292,19 @@ export interface DescribeExtendedServiceAuthInfosRequest {
5284
5292
  */
5285
5293
  export interface DescribeIntegrationRolesResponse {
5286
5294
  /**
5287
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
5295
+ * 指定分页返回的页码。页码从0开始,最大为2000
5288
5296
  */
5289
5297
  Offset?: number;
5290
5298
  /**
5291
- * 指定每页多少条数据,单页最大200
5299
+ * 指定分页每页返回的数据条数,单页最大支持 200
5292
5300
  */
5293
5301
  Limit?: number;
5294
5302
  /**
5295
- * 符合查询条件的总的角色数
5303
+ * 符合查询条件的总角色数。
5296
5304
  */
5297
5305
  TotalCount?: number;
5298
5306
  /**
5299
- * 企业角色信息列表
5307
+ * 企业角色信息列表。
5300
5308
  */
5301
5309
  IntegrateRoles?: Array<IntegrateRole>;
5302
5310
  /**
@@ -5369,23 +5377,30 @@ export interface DescribeFlowBriefsRequest {
5369
5377
  */
5370
5378
  export interface CreateFlowGroupByTemplatesRequest {
5371
5379
  /**
5372
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
5380
+ * 执行本接口操作的员工信息。
5381
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5373
5382
  */
5374
5383
  Operator: UserInfo;
5375
5384
  /**
5376
- * 合同组名称,最大长度200个字符
5385
+ * 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5377
5386
  */
5378
5387
  FlowGroupName: string;
5379
5388
  /**
5380
- * 合同组的子合同信息,支持2-50个子合同
5389
+ * 合同(流程)组的子合同信息,支持2-50个子合同
5381
5390
  */
5382
5391
  FlowGroupInfos: Array<FlowGroupInfo>;
5383
5392
  /**
5384
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5393
+ * 代理企业和员工的信息。
5394
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5385
5395
  */
5386
5396
  Agent?: Agent;
5387
5397
  /**
5388
- * 合同组的配置信息。包括是否通知本企业签署方,是否通知其他签署方
5398
+ * 合同(流程)组的配置项信息。
5399
+ 其中包括:
5400
+ <ul>
5401
+ <li>是否通知本企业签署方</li>
5402
+ <li>是否通知其他签署方</li>
5403
+ </ul>
5389
5404
  */
5390
5405
  FlowGroupOptions?: FlowGroupOptions;
5391
5406
  }