tencentcloud-sdk-nodejs 4.0.659 → 4.0.661

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 (101) hide show
  1. package/CHANGELOG.md +690 -0
  2. package/SERVICE_CHANGELOG.md +873 -214
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +14 -1
  7. package/src/services/asr/v20190614/asr_models.ts +41 -11
  8. package/src/services/ccc/v20200210/ccc_client.ts +25 -13
  9. package/src/services/ccc/v20200210/ccc_models.ts +32 -4
  10. package/src/services/cls/v20201016/cls_client.ts +2 -1
  11. package/src/services/cls/v20201016/cls_models.ts +46 -6
  12. package/src/services/cme/v20191029/cme_models.ts +4 -0
  13. package/src/services/csip/v20221121/csip_client.ts +13 -0
  14. package/src/services/csip/v20221121/csip_models.ts +169 -2
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +54 -54
  16. package/src/services/dasb/v20191018/dasb_models.ts +6 -2
  17. package/src/services/dlc/v20210125/dlc_models.ts +8 -0
  18. package/src/services/dts/v20211206/dts_client.ts +6 -4
  19. package/src/services/dts/v20211206/dts_models.ts +308 -168
  20. package/src/services/eis/v20210601/eis_models.ts +17 -8
  21. package/src/services/ess/v20201111/ess_client.ts +16 -10
  22. package/src/services/ess/v20201111/ess_models.ts +57 -42
  23. package/src/services/essbasic/v20210526/essbasic_client.ts +4 -4
  24. package/src/services/essbasic/v20210526/essbasic_models.ts +20 -19
  25. package/src/services/iotcloud/v20210408/iotcloud_models.ts +79 -59
  26. package/src/services/iotvideo/v20211125/iotvideo_client.ts +18 -6
  27. package/src/services/iotvideo/v20211125/iotvideo_models.ts +28 -0
  28. package/src/services/live/v20180801/live_client.ts +43 -30
  29. package/src/services/live/v20180801/live_models.ts +123 -82
  30. package/src/services/ms/v20180408/ms_client.ts +1 -1
  31. package/src/services/ocr/v20181119/ocr_client.ts +3 -38
  32. package/src/services/ocr/v20181119/ocr_models.ts +42 -381
  33. package/src/services/organization/v20210331/organization_client.ts +40 -16
  34. package/src/services/organization/v20210331/organization_models.ts +156 -112
  35. package/src/services/rum/v20210622/rum_models.ts +6 -1
  36. package/src/services/ssl/v20191205/ssl_client.ts +1 -1
  37. package/src/services/ssl/v20191205/ssl_models.ts +76 -42
  38. package/src/services/tdmq/v20200217/tdmq_models.ts +32 -0
  39. package/src/services/tione/v20211111/tione_client.ts +20 -5
  40. package/src/services/tione/v20211111/tione_models.ts +182 -72
  41. package/src/services/vpc/v20170312/vpc_client.ts +2 -2
  42. package/src/services/vpc/v20170312/vpc_models.ts +12 -2
  43. package/src/services/wedata/v20210820/wedata_models.ts +127 -5
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +5 -1
  47. package/tencentcloud/services/asr/v20190614/asr_client.js +6 -0
  48. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +38 -11
  49. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +9 -5
  50. package/tencentcloud/services/ccc/v20200210/ccc_client.js +12 -6
  51. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +30 -4
  52. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +45 -6
  53. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +4 -0
  54. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +5 -1
  55. package/tencentcloud/services/csip/v20221121/csip_client.js +6 -0
  56. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +166 -2
  57. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +54 -54
  58. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +6 -2
  59. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +8 -0
  60. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +1 -1
  61. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +305 -167
  62. package/tencentcloud/services/eis/v20210601/eis_models.d.ts +17 -8
  63. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +10 -4
  64. package/tencentcloud/services/ess/v20201111/ess_client.js +10 -4
  65. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +57 -42
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +4 -4
  67. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +4 -4
  68. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +20 -19
  69. package/tencentcloud/services/iotcloud/v20210408/iotcloud_models.d.ts +79 -59
  70. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +7 -3
  71. package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +9 -3
  72. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +26 -0
  73. package/tencentcloud/services/live/v20180801/live_client.d.ts +30 -17
  74. package/tencentcloud/services/live/v20180801/live_client.js +30 -17
  75. package/tencentcloud/services/live/v20180801/live_models.d.ts +123 -82
  76. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +1 -1
  77. package/tencentcloud/services/ms/v20180408/ms_client.js +1 -1
  78. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -19
  79. package/tencentcloud/services/ocr/v20181119/ocr_client.js +0 -22
  80. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +42 -376
  81. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +13 -5
  82. package/tencentcloud/services/organization/v20210331/organization_client.js +18 -6
  83. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +152 -112
  84. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +6 -1
  85. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +1 -1
  86. package/tencentcloud/services/ssl/v20191205/ssl_client.js +1 -1
  87. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +76 -42
  88. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +32 -0
  89. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  90. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  91. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +177 -72
  92. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  93. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +12 -2
  94. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +127 -5
  95. package/test/asr.v20190614.test.js +10 -0
  96. package/test/ccc.v20200210.test.js +14 -4
  97. package/test/csip.v20221121.test.js +10 -0
  98. package/test/iotvideo.v20211125.test.js +12 -2
  99. package/test/ocr.v20181119.test.js +0 -20
  100. package/test/organization.v20210331.test.js +24 -4
  101. package/test/tione.v20211111.test.js +10 -0
@@ -200,7 +200,7 @@ callbackinfo包含: 回调地址和签名key
200
200
  */
201
201
  CreateSeal(req: CreateSealRequest, cb?: (error: string, rep: CreateSealResponse) => void): Promise<CreateSealResponse>;
202
202
  /**
203
- * 查询企业角色列表
203
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
204
204
  */
205
205
  DescribeIntegrationRoles(req: DescribeIntegrationRolesRequest, cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void): Promise<DescribeIntegrationRolesResponse>;
206
206
  /**
@@ -236,12 +236,13 @@ callbackinfo包含: 回调地址和签名key
236
236
  CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
237
237
  /**
238
238
  * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。
239
+ 注:如果是集团代子企业发起任务场景,可以通过对Agent参数(未列在入参列表)设置代理的相关应用信息来支持,Agent参数设置可以参考CreateFlow接口的Agent相关说明。
239
240
  */
240
241
  CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
241
242
  /**
242
243
  * 查询流程基础信息
243
244
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
244
- 每个企业限制日调用量限制:10W,当日超过此限制后再调用接口返回错误
245
+ 每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误
245
246
  */
246
247
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
247
248
  /**
@@ -272,7 +273,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
272
273
  */
273
274
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
274
275
  /**
275
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
276
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
277
+ 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
276
278
  */
277
279
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
278
280
  /**
@@ -296,6 +298,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
296
298
  DescribeOrganizationSeals(req: DescribeOrganizationSealsRequest, cb?: (error: string, rep: DescribeOrganizationSealsResponse) => void): Promise<DescribeOrganizationSealsResponse>;
297
299
  /**
298
300
  * 移除员工
301
+ 这里分两个场景
302
+ 如果不传交接人的ReceiveUserId或者ReceiveOpenId,则会直接把这个人进行离职
303
+ 如果传了交接人,会把离职人未处理完的合同交接给交接人后再离职
299
304
  */
300
305
  DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
301
306
  /**
@@ -331,7 +336,8 @@ PDF资源Id 通过上传文件接口获取
331
336
  */
332
337
  DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
333
338
  /**
334
- * 创建员工,此接口会发送提醒员工实名的短信
339
+ * 创建员工,此接口会发送提醒员工实名的短信,如果通过手机号发现员工已经创建,则不会重新创建,会发送短信提醒员工实名
340
+ 注意:此接口支持企微组织架构的 openid 创建员工,这种场景下传递明文的企微 openid 到WeworkOpenId字段即可(企微明文的 openid 一定要在应用的可见范围内才行),通过企微创建的员工,会发送企微消息去提醒实名
335
341
  */
336
342
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
337
343
  /**
@@ -288,7 +288,7 @@ callbackinfo包含: 回调地址和签名key
288
288
  return this.request("CreateSeal", req, cb);
289
289
  }
290
290
  /**
291
- * 查询企业角色列表
291
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
292
292
  */
293
293
  async DescribeIntegrationRoles(req, cb) {
294
294
  return this.request("DescribeIntegrationRoles", req, cb);
@@ -338,6 +338,7 @@ callbackinfo包含: 回调地址和签名key
338
338
  }
339
339
  /**
340
340
  * 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。
341
+ 注:如果是集团代子企业发起任务场景,可以通过对Agent参数(未列在入参列表)设置代理的相关应用信息来支持,Agent参数设置可以参考CreateFlow接口的Agent相关说明。
341
342
  */
342
343
  async CreateConvertTaskApi(req, cb) {
343
344
  return this.request("CreateConvertTaskApi", req, cb);
@@ -345,7 +346,7 @@ callbackinfo包含: 回调地址和签名key
345
346
  /**
346
347
  * 查询流程基础信息
347
348
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
348
- 每个企业限制日调用量限制:10W,当日超过此限制后再调用接口返回错误
349
+ 每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误
349
350
  */
350
351
  async DescribeFlowBriefs(req, cb) {
351
352
  return this.request("DescribeFlowBriefs", req, cb);
@@ -386,7 +387,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
386
387
  return this.request("CreateFlowReminds", req, cb);
387
388
  }
388
389
  /**
389
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
390
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
391
+ 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
390
392
  */
391
393
  async DescribeFlowComponents(req, cb) {
392
394
  return this.request("DescribeFlowComponents", req, cb);
@@ -420,6 +422,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
420
422
  }
421
423
  /**
422
424
  * 移除员工
425
+ 这里分两个场景
426
+ 如果不传交接人的ReceiveUserId或者ReceiveOpenId,则会直接把这个人进行离职
427
+ 如果传了交接人,会把离职人未处理完的合同交接给交接人后再离职
423
428
  */
424
429
  async DeleteIntegrationEmployees(req, cb) {
425
430
  return this.request("DeleteIntegrationEmployees", req, cb);
@@ -467,7 +472,8 @@ PDF资源Id 通过上传文件接口获取
467
472
  return this.request("DescribeOrganizationGroupOrganizations", req, cb);
468
473
  }
469
474
  /**
470
- * 创建员工,此接口会发送提醒员工实名的短信
475
+ * 创建员工,此接口会发送提醒员工实名的短信,如果通过手机号发现员工已经创建,则不会重新创建,会发送短信提醒员工实名
476
+ 注意:此接口支持企微组织架构的 openid 创建员工,这种场景下传递明文的企微 openid 到WeworkOpenId字段即可(企微明文的 openid 一定要在应用的可见范围内才行),通过企微创建的员工,会发送企微消息去提醒实名
471
477
  */
472
478
  async CreateIntegrationEmployees(req, cb) {
473
479
  return this.request("CreateIntegrationEmployees", req, cb);
@@ -201,6 +201,10 @@ export interface CreatePreparedPersonalEsignRequest {
201
201
  填写的FileId通过UploadFiles接口上传文件获取。
202
202
  */
203
203
  FileId?: string;
204
+ /**
205
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
206
+ */
207
+ Agent?: Agent;
204
208
  }
205
209
  /**
206
210
  * DescribeIntegrationDepartments返回参数结构体
@@ -314,13 +318,15 @@ export interface FlowCreateApprover {
314
318
  */
315
319
  ApproverMobile?: string;
316
320
  /**
317
- * 签署方经办人证件类型ID_CARD 身份证
321
+ * 签署人的证件类型
322
+ ID_CARD 身份证
318
323
  HONGKONG_AND_MACAO 港澳居民来往内地通行证
319
324
  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
325
+ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
320
326
  */
321
327
  ApproverIdCardType?: string;
322
328
  /**
323
- * 签署方经办人证件号码
329
+ * 签署人证件号(长度不超过18位)
324
330
  */
325
331
  ApproverIdCardNumber?: string;
326
332
  /**
@@ -630,7 +636,7 @@ export interface DescribeIntegrationRolesRequest {
630
636
  */
631
637
  Operator: UserInfo;
632
638
  /**
633
- * 返回最大数量,最大为200
639
+ * 指定每页多少条数据,单页最大200
634
640
  */
635
641
  Limit: number;
636
642
  /**
@@ -645,7 +651,7 @@ export interface DescribeIntegrationRolesRequest {
645
651
  */
646
652
  Filters?: Array<Filter>;
647
653
  /**
648
- * 偏移量,默认为0,最大为2000
654
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
649
655
  */
650
656
  Offset?: number;
651
657
  }
@@ -823,11 +829,11 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
823
829
  */
824
830
  Operator: UserInfo;
825
831
  /**
826
- * 单次查询成员企业最大返回数量
832
+ * 指定每页多少条数据,单页最大1000
827
833
  */
828
834
  Limit: number;
829
835
  /**
830
- * 页面偏移量
836
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
831
837
  */
832
838
  Offset: number;
833
839
  /**
@@ -843,7 +849,7 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
843
849
  */
844
850
  Export?: boolean;
845
851
  /**
846
- * 成员企业id
852
+ * 成员企业机构 ID,在PC控制台 集团管理可获取
847
853
  */
848
854
  Id?: string;
849
855
  }
@@ -978,7 +984,7 @@ export interface CreateFlowGroupByFilesRequest {
978
984
  */
979
985
  export interface DescribeFlowComponentsResponse {
980
986
  /**
981
- * 流程关联的填写控件信息
987
+ * 流程关联的填写控件信息,按照参与方进行分类返回。
982
988
  注意:此字段可能返回 null,表示取不到有效值。
983
989
  */
984
990
  RecipientComponentInfos?: Array<RecipientComponentInfo>;
@@ -1196,7 +1202,7 @@ export interface DescribeIntegrationEmployeesRequest {
1196
1202
  */
1197
1203
  Operator: UserInfo;
1198
1204
  /**
1199
- * 返回最大数量,最大为20
1205
+ * 指定每页多少条数据,单页最大20
1200
1206
  */
1201
1207
  Limit: number;
1202
1208
  /**
@@ -1209,7 +1215,7 @@ export interface DescribeIntegrationEmployeesRequest {
1209
1215
  */
1210
1216
  Filters?: Array<Filter>;
1211
1217
  /**
1212
- * 偏移量,默认为0,最大为20000
1218
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1213
1219
  */
1214
1220
  Offset?: number;
1215
1221
  }
@@ -1331,10 +1337,11 @@ export interface CreateSchemeUrlRequest {
1331
1337
  */
1332
1338
  Mobile?: string;
1333
1339
  /**
1334
- * 链接类型
1335
- HTTP:跳转电子签小程序的http_url,
1336
- APP:第三方APP或小程序跳转电子签小程序的path。
1337
- 默认为HTTP类型
1340
+ * 要跳转的链接类型
1341
+
1342
+ - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认)
1343
+ - APP: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
1344
+
1338
1345
  */
1339
1346
  EndPoint?: string;
1340
1347
  /**
@@ -1346,7 +1353,12 @@ export interface CreateSchemeUrlRequest {
1346
1353
  */
1347
1354
  FlowGroupId?: string;
1348
1355
  /**
1349
- * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
1356
+ * 要跳转到的页面类型
1357
+
1358
+ - 0: 不传, 主页 (默认)
1359
+ - 1: 小程序合同详情
1360
+ - 2: 小程序合同列表页
1361
+
1350
1362
  */
1351
1363
  PathType?: number;
1352
1364
  /**
@@ -1363,10 +1375,10 @@ export interface CreateSchemeUrlRequest {
1363
1375
  /**
1364
1376
  * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
1365
1377
 
1366
- 0:合同签署页面更多操作按钮
1367
- 1:合同签署页面更多操作的拒绝签署按钮
1368
- 2:合同签署页面更多操作的转他人处理按钮
1369
- 3:签署成功页的查看详情按钮
1378
+ - 0:合同签署页面更多操作按钮
1379
+ - 1:合同签署页面更多操作的拒绝签署按钮
1380
+ - 2:合同签署页面更多操作的转他人处理按钮
1381
+ - 3:签署成功页的查看详情按钮
1370
1382
  */
1371
1383
  Hides?: Array<number>;
1372
1384
  }
@@ -1931,12 +1943,12 @@ export interface DescribeIntegrationEmployeesResponse {
1931
1943
  */
1932
1944
  Employees?: Array<Staff>;
1933
1945
  /**
1934
- * 偏移量,默认为0,最大为20000
1946
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1935
1947
  注意:此字段可能返回 null,表示取不到有效值。
1936
1948
  */
1937
1949
  Offset?: number;
1938
1950
  /**
1939
- * 返回最大数量,最大为20
1951
+ * 指定每页多少条数据,单页最大20
1940
1952
  */
1941
1953
  Limit?: number;
1942
1954
  /**
@@ -2570,16 +2582,18 @@ export interface RecipientComponentInfo {
2570
2582
  RecipientId?: string;
2571
2583
  /**
2572
2584
  * 参与方填写状态
2585
+ 0-未填写
2586
+ 1-已填写
2573
2587
  注意:此字段可能返回 null,表示取不到有效值。
2574
2588
  */
2575
2589
  RecipientFillStatus?: string;
2576
2590
  /**
2577
- * 是否发起方
2591
+ * 是否为发起方
2578
2592
  注意:此字段可能返回 null,表示取不到有效值。
2579
2593
  */
2580
2594
  IsPromoter?: boolean;
2581
2595
  /**
2582
- * 填写控件内容
2596
+ * 填写控件列表
2583
2597
  注意:此字段可能返回 null,表示取不到有效值。
2584
2598
  */
2585
2599
  Components?: Array<FilledComponent>;
@@ -2636,11 +2650,11 @@ export interface DescribeFlowComponentsRequest {
2636
2650
  */
2637
2651
  Operator: UserInfo;
2638
2652
  /**
2639
- * 电子签流程的Id
2653
+ * 流程(合同)的编号
2640
2654
  */
2641
2655
  FlowId: string;
2642
2656
  /**
2643
- * 应用相关信息
2657
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2644
2658
  */
2645
2659
  Agent?: Agent;
2646
2660
  }
@@ -2733,7 +2747,7 @@ export interface GroupOrganization {
2733
2747
  */
2734
2748
  JoinTime?: number;
2735
2749
  /**
2736
- * 是否使用审批流引擎,true-是,false-否
2750
+ * 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
2737
2751
  注意:此字段可能返回 null,表示取不到有效值。
2738
2752
  */
2739
2753
  FlowEngineEnable?: boolean;
@@ -2935,7 +2949,7 @@ export interface DeleteIntegrationEmployeesRequest {
2935
2949
  */
2936
2950
  Operator: UserInfo;
2937
2951
  /**
2938
- * 待移除员工的信息,userId和openId二选一,必填一个
2952
+ * 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
2939
2953
  */
2940
2954
  Employees: Array<Staff>;
2941
2955
  /**
@@ -3076,7 +3090,7 @@ export interface DeleteIntegrationRoleUsersRequest {
3076
3090
  */
3077
3091
  RoleId: string;
3078
3092
  /**
3079
- * 用户信息
3093
+ * 用户信息,最多 200 个用户,并且 UserId 和 OpenId 二选一,其他字段不需要传
3080
3094
  */
3081
3095
  Users: Array<UserInfo>;
3082
3096
  /**
@@ -3259,11 +3273,11 @@ export interface CreateIntegrationUserRolesRequest {
3259
3273
  */
3260
3274
  Operator: UserInfo;
3261
3275
  /**
3262
- * 绑定角色的用户id列表
3276
+ * 绑定角色的用户id列表,不能重复,不能大于 100 个
3263
3277
  */
3264
3278
  UserIds: Array<string>;
3265
3279
  /**
3266
- * 绑定角色的角色id列表
3280
+ * 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取
3267
3281
  */
3268
3282
  RoleIds: Array<string>;
3269
3283
  /**
@@ -3520,16 +3534,17 @@ export interface ApproverInfo {
3520
3534
  */
3521
3535
  SignComponents?: Array<Component>;
3522
3536
  /**
3523
- * 签署人的身份证号
3524
- */
3525
- ApproverIdCardNumber?: string;
3526
- /**
3527
- * 签署人的身份证件类型
3537
+ * 签署人的证件类型
3528
3538
  ID_CARD 身份证
3529
3539
  HONGKONG_AND_MACAO 港澳居民来往内地通行证
3530
3540
  HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3541
+ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3531
3542
  */
3532
3543
  ApproverIdCardType?: string;
3544
+ /**
3545
+ * 签署人证件号(长度不超过18位)
3546
+ */
3547
+ ApproverIdCardNumber?: string;
3533
3548
  /**
3534
3549
  * 签署通知类型:sms--短信,none--不通知
3535
3550
  */
@@ -3599,11 +3614,11 @@ export interface ModifyIntegrationDepartmentRequest {
3599
3614
  */
3600
3615
  Operator: UserInfo;
3601
3616
  /**
3602
- * 电子签部门ID
3617
+ * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
3603
3618
  */
3604
3619
  DeptId: string;
3605
3620
  /**
3606
- * 电子签父部门ID
3621
+ * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
3607
3622
  */
3608
3623
  ParentDeptId?: string;
3609
3624
  /**
@@ -3977,7 +3992,7 @@ export interface DeleteIntegrationDepartmentRequest {
3977
3992
  */
3978
3993
  Operator: UserInfo;
3979
3994
  /**
3980
- * 电子签中的部门id
3995
+ * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
3981
3996
  */
3982
3997
  DeptId: string;
3983
3998
  /**
@@ -4623,11 +4638,11 @@ export interface DescribeExtendedServiceAuthInfosRequest {
4623
4638
  */
4624
4639
  export interface DescribeIntegrationRolesResponse {
4625
4640
  /**
4626
- * 偏移量,默认为0,最大为2000
4641
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
4627
4642
  */
4628
4643
  Offset?: number;
4629
4644
  /**
4630
- * 返回最大数量,最大为200
4645
+ * 指定每页多少条数据,单页最大200
4631
4646
  */
4632
4647
  Limit?: number;
4633
4648
  /**
@@ -4665,7 +4680,7 @@ export interface CreateFlowRemindsRequest {
4665
4680
  */
4666
4681
  export interface UpdateIntegrationEmployeesRequest {
4667
4682
  /**
4668
- * 当前用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为YUFU;
4683
+ * 当前用户信息,UserId必填
4669
4684
  */
4670
4685
  Operator: UserInfo;
4671
4686
  /**
@@ -5266,7 +5281,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5266
5281
  */
5267
5282
  ActivedTotal?: number;
5268
5283
  /**
5269
- * 导出文件的url
5284
+ * 如果入参Export为 true 时使用,表示导出Excel的url
5270
5285
  注意:此字段可能返回 null,表示取不到有效值。
5271
5286
  */
5272
5287
  ExportUrl?: string;
@@ -57,7 +57,7 @@ export declare class Client extends AbstractClient {
57
57
  ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
58
58
  /**
59
59
  * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
60
- 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
60
+ 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
61
61
  */
62
62
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
63
63
  /**
@@ -78,7 +78,7 @@ export declare class Client extends AbstractClient {
78
78
  ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
79
79
  /**
80
80
  * 查询子客企业电子印章,需要操作者具有管理印章权限
81
- 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
81
+ 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数,只返回启用的印章。
82
82
  */
83
83
  ChannelDescribeOrganizationSeals(req: ChannelDescribeOrganizationSealsRequest, cb?: (error: string, rep: ChannelDescribeOrganizationSealsResponse) => void): Promise<ChannelDescribeOrganizationSealsResponse>;
84
84
  /**
@@ -175,7 +175,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
175
175
  */
176
176
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
177
177
  /**
178
- * 对流程的合同文件进行验证,判断文件是否合法。
178
+ * 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
179
179
  */
180
180
  ChannelVerifyPdf(req: ChannelVerifyPdfRequest, cb?: (error: string, rep: ChannelVerifyPdfResponse) => void): Promise<ChannelVerifyPdfResponse>;
181
181
  /**
@@ -307,7 +307,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
307
307
  */
308
308
  DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
309
309
  /**
310
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
310
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
311
311
  */
312
312
  ChannelDescribeFlowComponents(req: ChannelDescribeFlowComponentsRequest, cb?: (error: string, rep: ChannelDescribeFlowComponentsResponse) => void): Promise<ChannelDescribeFlowComponentsResponse>;
313
313
  }
@@ -95,7 +95,7 @@ class Client extends abstract_client_1.AbstractClient {
95
95
  }
96
96
  /**
97
97
  * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
98
- 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
98
+ 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
99
99
  */
100
100
  async DescribeUsage(req, cb) {
101
101
  return this.request("DescribeUsage", req, cb);
@@ -124,7 +124,7 @@ class Client extends abstract_client_1.AbstractClient {
124
124
  }
125
125
  /**
126
126
  * 查询子客企业电子印章,需要操作者具有管理印章权限
127
- 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
127
+ 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数,只返回启用的印章。
128
128
  */
129
129
  async ChannelDescribeOrganizationSeals(req, cb) {
130
130
  return this.request("ChannelDescribeOrganizationSeals", req, cb);
@@ -245,7 +245,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
245
245
  return this.request("ChannelCreateBoundFlows", req, cb);
246
246
  }
247
247
  /**
248
- * 对流程的合同文件进行验证,判断文件是否合法。
248
+ * 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
249
249
  */
250
250
  async ChannelVerifyPdf(req, cb) {
251
251
  return this.request("ChannelVerifyPdf", req, cb);
@@ -419,7 +419,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
419
419
  return this.request("DescribeFlowDetailInfo", req, cb);
420
420
  }
421
421
  /**
422
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
422
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
423
423
  */
424
424
  async ChannelDescribeFlowComponents(req, cb) {
425
425
  return this.request("ChannelDescribeFlowComponents", req, cb);
@@ -860,7 +860,7 @@ export interface ChannelDeleteRoleUsersRequest {
860
860
  */
861
861
  RoleId: string;
862
862
  /**
863
- * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
863
+ * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数,最多两百
864
864
  */
865
865
  UserIds?: Array<string>;
866
866
  /**
@@ -869,7 +869,7 @@ export interface ChannelDeleteRoleUsersRequest {
869
869
  */
870
870
  Operator?: UserInfo;
871
871
  /**
872
- * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
872
+ * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数,最多两百
873
873
  */
874
874
  OpenIds?: Array<string>;
875
875
  }
@@ -1385,11 +1385,11 @@ export interface ChannelDescribeRolesRequest {
1385
1385
  */
1386
1386
  Agent: Agent;
1387
1387
  /**
1388
- * 查询起始偏移,最大2000
1388
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
1389
1389
  */
1390
1390
  Offset: number;
1391
1391
  /**
1392
- * 查询数量,最大200
1392
+ * 指定每页多少条数据,单页最大200
1393
1393
  */
1394
1394
  Limit: string;
1395
1395
  /**
@@ -2454,13 +2454,13 @@ export interface ChannelCreateBoundFlowsRequest {
2454
2454
  */
2455
2455
  export interface ChannelDescribeEmployeesRequest {
2456
2456
  /**
2457
- * 返回最大数量,最大为20
2457
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2458
2458
  */
2459
- Limit: number;
2459
+ Agent: Agent;
2460
2460
  /**
2461
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2461
+ * 指定每页多少条数据,单页最大20
2462
2462
  */
2463
- Agent?: Agent;
2463
+ Limit: number;
2464
2464
  /**
2465
2465
  * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
2466
2466
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
@@ -2468,7 +2468,7 @@ export interface ChannelDescribeEmployeesRequest {
2468
2468
  */
2469
2469
  Filters?: Array<Filter>;
2470
2470
  /**
2471
- * 偏移量,默认为0,最大为20000
2471
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大为20000
2472
2472
  */
2473
2473
  Offset?: number;
2474
2474
  /**
@@ -2683,14 +2683,15 @@ export interface FlowApproverInfo {
2683
2683
  */
2684
2684
  Name?: string;
2685
2685
  /**
2686
- * 签署人身份证件类型
2686
+ * 签署人的证件类型
2687
2687
  1.ID_CARD 居民身份证
2688
2688
  2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
2689
2689
  3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
2690
+ 4.OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
2690
2691
  */
2691
2692
  IdCardType?: string;
2692
2693
  /**
2693
- * 签署人证件号
2694
+ * 签署人证件号(长度不超过18位)
2694
2695
  */
2695
2696
  IdCardNumber?: string;
2696
2697
  /**
@@ -3227,11 +3228,11 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
3227
3228
  */
3228
3229
  export interface ChannelDescribeRolesResponse {
3229
3230
  /**
3230
- * 页面偏移量,最大2000
3231
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
3231
3232
  */
3232
3233
  Offset?: number;
3233
3234
  /**
3234
- * 查询数量,最大200
3235
+ * 指定每页多少条数据,单页最大200
3235
3236
  */
3236
3237
  Limit?: number;
3237
3238
  /**
@@ -3292,7 +3293,7 @@ export interface ChannelCreateReleaseFlowRequest {
3292
3293
  */
3293
3294
  export interface ChannelDescribeFlowComponentsResponse {
3294
3295
  /**
3295
- * 流程关联的填写控件信息
3296
+ * 流程关联的填写控件信息,控件会按照参与方进行分类。
3296
3297
  注意:此字段可能返回 null,表示取不到有效值。
3297
3298
  */
3298
3299
  RecipientComponentInfos?: Array<RecipientComponentInfo>;
@@ -3407,15 +3408,15 @@ export interface ChannelCreateUserRolesRequest {
3407
3408
  */
3408
3409
  Agent: Agent;
3409
3410
  /**
3410
- * 绑定角色的角色id列表
3411
+ * 绑定角色的角色id列表,最多 100 个
3411
3412
  */
3412
3413
  RoleIds: Array<string>;
3413
3414
  /**
3414
- * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
3415
+ * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数,最多 100 个
3415
3416
  */
3416
3417
  UserIds?: Array<string>;
3417
3418
  /**
3418
- * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
3419
+ * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数,最多 100 个
3419
3420
  */
3420
3421
  OpenIds?: Array<string>;
3421
3422
  /**
@@ -4016,12 +4017,12 @@ export interface ChannelDescribeEmployeesResponse {
4016
4017
  */
4017
4018
  Employees?: Array<Staff>;
4018
4019
  /**
4019
- * 偏移量,默认为0,最大为20000
4020
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
4020
4021
  注意:此字段可能返回 null,表示取不到有效值。
4021
4022
  */
4022
4023
  Offset?: number;
4023
4024
  /**
4024
- * 返回最大数量,最大为20
4025
+ * 指定每页多少条数据,单页最大20
4025
4026
  */
4026
4027
  Limit?: number;
4027
4028
  /**