tencentcloud-sdk-nodejs 4.0.674 → 4.0.676

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 (78) hide show
  1. package/CHANGELOG.md +461 -0
  2. package/SERVICE_CHANGELOG.md +554 -73
  3. package/package.json +1 -1
  4. package/products.md +29 -29
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/billing/v20180709/billing_client.ts +197 -160
  7. package/src/services/billing/v20180709/billing_models.ts +1761 -1649
  8. package/src/services/cdwch/v20200915/cdwch_models.ts +20 -0
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +4 -0
  10. package/src/services/cvm/v20170312/cvm_client.ts +2 -2
  11. package/src/services/cvm/v20170312/cvm_models.ts +6 -1
  12. package/src/services/cwp/v20180228/cwp_models.ts +21 -15
  13. package/src/services/dcdb/v20180411/dcdb_models.ts +5 -1
  14. package/src/services/es/v20180416/es_models.ts +100 -86
  15. package/src/services/ess/v20201111/ess_client.ts +75 -28
  16. package/src/services/ess/v20201111/ess_models.ts +533 -296
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +5 -0
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +14 -5
  19. package/src/services/faceid/v20180301/faceid_models.ts +7 -6
  20. package/src/services/iotvideo/v20201215/iotvideo_models.ts +9 -5
  21. package/src/services/iotvideo/v20211125/iotvideo_models.ts +19 -7
  22. package/src/services/iss/v20230517/iss_models.ts +4 -4
  23. package/src/services/lcic/v20220817/lcic_models.ts +14 -4
  24. package/src/services/mariadb/v20170312/mariadb_models.ts +5 -1
  25. package/src/services/memcached/v20190318/memcached_models.ts +1 -1
  26. package/src/services/mna/v20210119/mna_models.ts +1 -1
  27. package/src/services/ms/v20180408/ms_client.ts +3 -3
  28. package/src/services/nlp/v20190408/nlp_client.ts +1 -1
  29. package/src/services/ocr/v20181119/ocr_models.ts +2 -0
  30. package/src/services/redis/v20180412/redis_models.ts +1 -1
  31. package/src/services/ssl/v20191205/ssl_models.ts +30 -8
  32. package/src/services/tem/v20210701/tem_models.ts +8 -8
  33. package/src/services/teo/v20220901/teo_client.ts +1 -1
  34. package/src/services/teo/v20220901/teo_models.ts +1 -1
  35. package/src/services/tse/v20201207/tse_models.ts +2 -2
  36. package/src/services/wedata/v20210820/wedata_models.ts +90 -90
  37. package/tencentcloud/common/sdk_version.d.ts +1 -1
  38. package/tencentcloud/common/sdk_version.js +1 -1
  39. package/tencentcloud/services/billing/v20180709/billing_client.d.ts +47 -35
  40. package/tencentcloud/services/billing/v20180709/billing_client.js +69 -51
  41. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +1687 -1582
  42. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +20 -0
  43. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -0
  44. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +2 -2
  45. package/tencentcloud/services/cvm/v20170312/cvm_client.js +2 -2
  46. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +6 -1
  47. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +21 -15
  48. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +5 -1
  49. package/tencentcloud/services/es/v20180416/es_models.d.ts +100 -86
  50. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +41 -12
  51. package/tencentcloud/services/ess/v20201111/ess_client.js +46 -13
  52. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +520 -289
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -0
  54. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +5 -0
  55. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +14 -5
  56. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +7 -6
  57. package/tencentcloud/services/iotvideo/v20201215/iotvideo_models.d.ts +9 -5
  58. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +19 -7
  59. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +4 -4
  60. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +14 -4
  61. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +5 -1
  62. package/tencentcloud/services/memcached/v20190318/memcached_models.d.ts +1 -1
  63. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +1 -1
  64. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +3 -3
  65. package/tencentcloud/services/ms/v20180408/ms_client.js +3 -3
  66. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -1
  67. package/tencentcloud/services/nlp/v20190408/nlp_client.js +1 -1
  68. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -0
  69. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -1
  70. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +30 -8
  71. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +8 -8
  72. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +1 -1
  73. package/tencentcloud/services/teo/v20220901/teo_client.js +1 -1
  74. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -1
  75. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
  76. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +90 -90
  77. package/test/billing.v20180709.test.js +64 -34
  78. package/test/ess.v20201111.test.js +24 -4
@@ -277,13 +277,22 @@ export interface CreateFlowApproversResponse {
277
277
  RequestId?: string;
278
278
  }
279
279
  /**
280
- * DescribeIntegrationMainOrganizationUser请求参数结构体
280
+ * DescribeFileUrls返回参数结构体
281
281
  */
282
- export interface DescribeIntegrationMainOrganizationUserRequest {
282
+ export interface DescribeFileUrlsResponse {
283
283
  /**
284
- * 操作人信息,userId必填
284
+ * 文件URL信息;
285
+ 链接不是永久链接,有效期5分钟后链接失效。
285
286
  */
286
- Operator: UserInfo;
287
+ FileUrls?: Array<FileUrl>;
288
+ /**
289
+ * URL数量
290
+ */
291
+ TotalCount?: number;
292
+ /**
293
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
+ */
295
+ RequestId?: string;
287
296
  }
288
297
  /**
289
298
  * ModifyApplicationCallbackInfo返回参数结构体
@@ -312,154 +321,34 @@ export interface CreateMultiFlowSignQRCodeResponse {
312
321
  RequestId?: string;
313
322
  }
314
323
  /**
315
- * 创建流程的签署方信息
324
+ * 签署链接信息
316
325
  */
317
- export interface FlowCreateApprover {
326
+ export interface FlowApproverUrlInfo {
318
327
  /**
319
- * 参与者类型:
320
- 0:企业
321
- 1:个人
322
- 3:企业自动签署
323
- 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
324
- 自动签署仅进行盖章操作,不能是手写签名。
325
- 本方企业自动签署的签署人会默认是当前的发起人
326
- 他方企业自动签署的签署人是自动签模板的他方企业授权人
327
- 7: 个人自动签署,适用于个人自动签场景。
328
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
328
+ * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
329
+ 注意:此字段可能返回 null,表示取不到有效值。
329
330
  */
330
- ApproverType: number;
331
+ SignUrl?: string;
331
332
  /**
332
- * 签署人企业名称
333
- <br/>当approverType=1 或 approverType=3时,必须指定
334
-
335
-
333
+ * 签署人类型 1-个人
334
+ 注意:此字段可能返回 null,表示取不到有效值。
336
335
  */
337
- OrganizationName?: string;
336
+ ApproverType?: number;
338
337
  /**
339
- * 签署方经办人姓名
340
- <br/>在未指定签署人电子签UserId情况下,为必填参数
338
+ * 签署人姓名
339
+ 注意:此字段可能返回 null,表示取不到有效值。
341
340
  */
342
341
  ApproverName?: string;
343
342
  /**
344
- * 签署方经办人手机号码
345
- <br/>在未指定签署人电子签UserId情况下,为必填参数
346
-
343
+ * 签署人手机号
344
+ 注意:此字段可能返回 null,表示取不到有效值。
347
345
  */
348
346
  ApproverMobile?: string;
349
347
  /**
350
- * 签署人的证件类型
351
- ID_CARD 身份证
352
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
353
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
354
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
355
- */
356
- ApproverIdCardType?: string;
357
- /**
358
- * 签署人证件号(长度不超过18位)
359
- */
360
- ApproverIdCardNumber?: string;
361
- /**
362
- * 签署方经办人在模板中的参与方ID
363
- <br/>模板发起合同时,该参数为必填项
364
- <br/>文件发起合同是,该参数无序传值
365
-
366
- */
367
- RecipientId?: string;
368
- /**
369
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
370
- */
371
- VerifyChannel?: Array<string>;
372
- /**
373
- * 是否发送短信
374
- <br/>sms--短信通知
375
- <br/>none--不通知
376
- <br/>默认为sms
377
- <br/>发起方=签署方时不发送短信
378
- */
379
- NotifyType?: string;
380
- /**
381
- * 合同强制需要阅读全文,无需传此参数
382
- */
383
- IsFullText?: boolean;
384
- /**
385
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
386
- */
387
- PreReadTime?: number;
388
- /**
389
- * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
390
-
391
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
392
- */
393
- UserId?: string;
394
- /**
395
- * 当前只支持true,默认为true
396
- */
397
- Required?: boolean;
398
- /**
399
- * 签署人用户来源,此参数仅针对企微用户开放
400
-
401
- 企微侧用户请传入:WEWORKAPP
402
- */
403
- ApproverSource?: string;
404
- /**
405
- * 企业签署方或签标识,客户自定义,64位长度
406
- <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
407
- <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
408
- <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
409
- */
410
- CustomApproverTag?: string;
411
- /**
412
- * 快速注册相关信息,目前暂未开放!
413
- */
414
- RegisterInfo?: RegisterInfo;
415
- /**
416
- * 签署人个性化能力值
417
- */
418
- ApproverOption?: ApproverOption;
419
- /**
420
- * 签署完前端跳转的url,暂未使用
421
- * @deprecated
422
- */
423
- JumpUrl?: string;
424
- /**
425
- * 签署ID
426
- - 发起流程时系统自动补充
427
- - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
428
- */
429
- SignId?: string;
430
- /**
431
- * 当前签署方进行签署操作是否需要企业内部审批
432
- <br>true 则为需要
433
- <br/>false,无序企业内部审批(默认)
434
- <br/>为个人签署方时则由发起方企业审核。
435
- */
436
- ApproverNeedSignReview?: boolean;
437
- /**
438
- * 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
439
- <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
440
- */
441
- SignComponents?: Array<Component>;
442
- /**
443
- * 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
444
- <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
445
- */
446
- Components?: Array<Component>;
447
- /**
448
- * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
449
- HANDWRITE – 手写签名
450
- OCR_ESIGN -- AI智能识别手写签名
451
- ESIGN -- 个人印章类型
452
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
453
- */
454
- ComponentLimitType?: Array<string>;
455
- /**
456
- * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
457
- */
458
- ApproverVerifyTypes?: Array<number | bigint>;
459
- /**
460
- * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
348
+ * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
349
+ 注意:此字段可能返回 null,表示取不到有效值。
461
350
  */
462
- ApproverSignTypes?: Array<number | bigint>;
351
+ LongUrl?: string;
463
352
  }
464
353
  /**
465
354
  * 关注方信息
@@ -677,7 +566,8 @@ export interface DescribeIntegrationRolesRequest {
677
566
  * 查询的关键字段:
678
567
  Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
679
568
  Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
680
- Key:"IsGroupRole",Values:["0"],查询非集团角色,Values:["1"]表示查询集团角色
569
+ Key:"IsGroupRole",Values:["0"]:查询非集团角色,Values:["1"]表示查询集团角色
570
+ Key:"IsReturnPermissionGroup",Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
681
571
  */
682
572
  Filters?: Array<Filter>;
683
573
  /**
@@ -761,34 +651,42 @@ export interface StaffRole {
761
651
  RoleName?: string;
762
652
  }
763
653
  /**
764
- * 签署链接信息
654
+ * CreateIntegrationRole请求参数结构体
765
655
  */
766
- export interface FlowApproverUrlInfo {
656
+ export interface CreateIntegrationRoleRequest {
767
657
  /**
768
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
769
- 注意:此字段可能返回 null,表示取不到有效值。
658
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
770
659
  */
771
- SignUrl?: string;
660
+ Name: string;
772
661
  /**
773
- * 签署人类型 1-个人
774
- 注意:此字段可能返回 null,表示取不到有效值。
662
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
663
+ 支持填入集团子公司经办人 userId 代发合同。
664
+
665
+ 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
775
666
  */
776
- ApproverType?: number;
667
+ Operator: UserInfo;
777
668
  /**
778
- * 签署人姓名
779
- 注意:此字段可能返回 null,表示取不到有效值。
669
+ * 角色描述,最大长度为50个字符
780
670
  */
781
- ApproverName?: string;
671
+ Description?: string;
782
672
  /**
783
- * 签署人手机号
784
- 注意:此字段可能返回 null,表示取不到有效值。
673
+ * 角色类型,0:saas角色,1:集团角色
674
+ 默认0,saas角色
785
675
  */
786
- ApproverMobile?: string;
676
+ IsGroupRole?: number;
787
677
  /**
788
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
789
- 注意:此字段可能返回 null,表示取不到有效值。
678
+ * 权限树
790
679
  */
791
- LongUrl?: string;
680
+ PermissionGroups?: Array<PermissionGroup>;
681
+ /**
682
+ * 集团角色的话,需要传递集团子企业列表,如果是全选,则传1
683
+ */
684
+ SubOrganizationIds?: string;
685
+ /**
686
+ * 代理企业和员工的信息。
687
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
688
+ */
689
+ Agent?: Agent;
792
690
  }
793
691
  /**
794
692
  * 授权用户
@@ -820,8 +718,7 @@ export interface CreateConvertTaskApiRequest {
820
718
  */
821
719
  Operator?: UserInfo;
822
720
  /**
823
- * 应用号信息
824
- * @deprecated
721
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
825
722
  */
826
723
  Agent?: Agent;
827
724
  /**
@@ -1255,6 +1152,19 @@ export interface DescribeIntegrationEmployeesRequest {
1255
1152
  */
1256
1153
  Offset?: number;
1257
1154
  }
1155
+ /**
1156
+ * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1157
+ */
1158
+ export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1159
+ /**
1160
+ * 解绑是否成功,1表示成功,0表示失败
1161
+ */
1162
+ Status?: number;
1163
+ /**
1164
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1165
+ */
1166
+ RequestId?: string;
1167
+ }
1258
1168
  /**
1259
1169
  * CreateIntegrationUserRoles返回参数结构体
1260
1170
  */
@@ -1499,17 +1409,13 @@ export interface DescribeThirdPartyAuthCodeRequest {
1499
1409
  Agent?: Agent;
1500
1410
  }
1501
1411
  /**
1502
- * UnbindEmployeeUserIdWithClientOpenId返回参数结构体
1412
+ * DescribeIntegrationMainOrganizationUser请求参数结构体
1503
1413
  */
1504
- export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1505
- /**
1506
- * 解绑是否成功,1表示成功,0表示失败
1507
- */
1508
- Status?: number;
1414
+ export interface DescribeIntegrationMainOrganizationUserRequest {
1509
1415
  /**
1510
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1416
+ * 操作人信息,userId必填
1511
1417
  */
1512
- RequestId?: string;
1418
+ Operator: UserInfo;
1513
1419
  }
1514
1420
  /**
1515
1421
  * CreateReleaseFlow返回参数结构体
@@ -1582,6 +1488,66 @@ export interface DescribeIntegrationDepartmentsRequest {
1582
1488
  */
1583
1489
  DeptOpenId?: string;
1584
1490
  }
1491
+ /**
1492
+ * 权限树节点权限
1493
+ */
1494
+ export interface Permission {
1495
+ /**
1496
+ * 权限名称
1497
+ 注意:此字段可能返回 null,表示取不到有效值。
1498
+ */
1499
+ Name?: string;
1500
+ /**
1501
+ * 权限key
1502
+ 注意:此字段可能返回 null,表示取不到有效值。
1503
+ */
1504
+ Key?: string;
1505
+ /**
1506
+ * 权限类型 1前端,2后端
1507
+ 注意:此字段可能返回 null,表示取不到有效值。
1508
+ */
1509
+ Type?: number;
1510
+ /**
1511
+ * 是否隐藏
1512
+ 注意:此字段可能返回 null,表示取不到有效值。
1513
+ */
1514
+ Hide?: number;
1515
+ /**
1516
+ * 数据权限标签 1:表示根节点,2:表示叶子结点
1517
+ 注意:此字段可能返回 null,表示取不到有效值。
1518
+ */
1519
+ DataLabel?: number;
1520
+ /**
1521
+ * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
1522
+ 注意:此字段可能返回 null,表示取不到有效值。
1523
+ */
1524
+ DataType?: number;
1525
+ /**
1526
+ * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
1527
+ 注意:此字段可能返回 null,表示取不到有效值。
1528
+ */
1529
+ DataRange?: number;
1530
+ /**
1531
+ * 关联权限, 表示这个功能权限要受哪个数据权限管控
1532
+ 注意:此字段可能返回 null,表示取不到有效值。
1533
+ */
1534
+ DataTo?: string;
1535
+ /**
1536
+ * 父级权限key
1537
+ 注意:此字段可能返回 null,表示取不到有效值。
1538
+ */
1539
+ ParentKey?: string;
1540
+ /**
1541
+ * 是否选中
1542
+ 注意:此字段可能返回 null,表示取不到有效值。
1543
+ */
1544
+ IsChecked?: boolean;
1545
+ /**
1546
+ * 子权限集合
1547
+ 注意:此字段可能返回 null,表示取不到有效值。
1548
+ */
1549
+ Children?: Array<Permission>;
1550
+ }
1585
1551
  /**
1586
1552
  * CreateIntegrationDepartment返回参数结构体
1587
1553
  */
@@ -1812,6 +1778,26 @@ export interface CreatePersonAuthCertificateImageResponse {
1812
1778
  * 个人用户证明证书的下载链接
1813
1779
  */
1814
1780
  AuthCertUrl?: string;
1781
+ /**
1782
+ * 证书图片上的证书编号,20位数字
1783
+ 注意:此字段可能返回 null,表示取不到有效值。
1784
+ */
1785
+ ImageCertId?: string;
1786
+ /**
1787
+ * 图片证明对应的CA证书序列号
1788
+ 注意:此字段可能返回 null,表示取不到有效值。
1789
+ */
1790
+ SerialNumber?: string;
1791
+ /**
1792
+ * CA证书颁发时间戳
1793
+ 注意:此字段可能返回 null,表示取不到有效值。
1794
+ */
1795
+ ValidFrom?: number;
1796
+ /**
1797
+ * CA证书有效截止时间戳
1798
+ 注意:此字段可能返回 null,表示取不到有效值。
1799
+ */
1800
+ ValidTo?: number;
1815
1801
  /**
1816
1802
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1817
1803
  */
@@ -2227,6 +2213,24 @@ export interface CreateFlowSignUrlResponse {
2227
2213
  */
2228
2214
  RequestId?: string;
2229
2215
  }
2216
+ /**
2217
+ * 发起流程快速注册相关信息
2218
+ */
2219
+ export interface RegisterInfo {
2220
+ /**
2221
+ * 法人姓名
2222
+ */
2223
+ LegalName: string;
2224
+ /**
2225
+ * 社会统一信用代码
2226
+ * @deprecated
2227
+ */
2228
+ Uscc?: string;
2229
+ /**
2230
+ * 社会统一信用代码
2231
+ */
2232
+ UnifiedSocialCreditCode?: string;
2233
+ }
2230
2234
  /**
2231
2235
  * DescribeFileUrls请求参数结构体
2232
2236
  */
@@ -2279,8 +2283,8 @@ export interface DescribeFileUrlsRequest {
2279
2283
  */
2280
2284
  Scene?: string;
2281
2285
  /**
2282
- * 应用相关信息
2283
- * @deprecated
2286
+ * 代理企业和员工的信息。
2287
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2284
2288
  */
2285
2289
  Agent?: Agent;
2286
2290
  }
@@ -2463,92 +2467,259 @@ content String 表头单元格内容,字数不超过100
2463
2467
  */
2464
2468
  export interface FormField {
2465
2469
  /**
2466
- * 控件填充vaule,ComponentType和传入值类型对应关系:
2467
- TEXT - 文本内容
2468
- MULTI_LINE_TEXT - 文本内容
2469
- CHECK_BOX - true/false
2470
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2471
- SELECTOR - 选项值
2472
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2470
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
2471
+ TEXT - 文本内容
2472
+ MULTI_LINE_TEXT - 文本内容
2473
+ CHECK_BOX - true/false
2474
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
2475
+ SELECTOR - 选项值
2476
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
2477
+ */
2478
+ ComponentValue: string;
2479
+ /**
2480
+ * 控件id,和ComponentName选择一项传入即可
2481
+ */
2482
+ ComponentId?: string;
2483
+ /**
2484
+ * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
2485
+ */
2486
+ ComponentName?: string;
2487
+ }
2488
+ /**
2489
+ * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2490
+ */
2491
+ export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2492
+ /**
2493
+ * 操作人信息,userId必填
2494
+ */
2495
+ Operator: UserInfo;
2496
+ /**
2497
+ * 应用编号
2498
+ */
2499
+ ApplicationId: string;
2500
+ }
2501
+ /**
2502
+ * 用户信息
2503
+ */
2504
+ export interface UserInfo {
2505
+ /**
2506
+ * 用户在平台的编号
2507
+ */
2508
+ UserId?: string;
2509
+ /**
2510
+ * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
2511
+ * @deprecated
2512
+ */
2513
+ Channel?: string;
2514
+ /**
2515
+ * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
2516
+ * @deprecated
2517
+ */
2518
+ OpenId?: string;
2519
+ /**
2520
+ * 用户真实IP,内部字段,暂未开放
2521
+ * @deprecated
2522
+ */
2523
+ ClientIp?: string;
2524
+ /**
2525
+ * 用户代理IP,内部字段,暂未开放
2526
+ * @deprecated
2527
+ */
2528
+ ProxyIp?: string;
2529
+ }
2530
+ /**
2531
+ * CreateFlowApprovers请求参数结构体
2532
+ */
2533
+ export interface CreateFlowApproversRequest {
2534
+ /**
2535
+ * 调用方用户信息,userId 必填
2536
+ */
2537
+ Operator: UserInfo;
2538
+ /**
2539
+ * 签署流程编号
2540
+ */
2541
+ FlowId: string;
2542
+ /**
2543
+ * 补充签署人信息
2544
+ */
2545
+ Approvers: Array<FillApproverInfo>;
2546
+ /**
2547
+ * 企微消息中的发起人
2548
+ */
2549
+ Initiator?: string;
2550
+ /**
2551
+ * 代理相关应用信息,如集团主企业代子企业操作
2552
+
2553
+
2554
+ */
2555
+ Agent?: Agent;
2556
+ }
2557
+ /**
2558
+ * ModifyIntegrationRole返回参数结构体
2559
+ */
2560
+ export interface ModifyIntegrationRoleResponse {
2561
+ /**
2562
+ * 角色id
2563
+ */
2564
+ RoleId?: string;
2565
+ /**
2566
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2567
+ */
2568
+ RequestId?: string;
2569
+ }
2570
+ /**
2571
+ * 创建流程的签署方信息
2572
+ */
2573
+ export interface FlowCreateApprover {
2574
+ /**
2575
+ * 参与者类型:
2576
+ 0:企业
2577
+ 1:个人
2578
+ 3:企业自动签署
2579
+ 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
2580
+ 自动签署仅进行盖章操作,不能是手写签名。
2581
+ 本方企业自动签署的签署人会默认是当前的发起人
2582
+ 他方企业自动签署的签署人是自动签模板的他方企业授权人
2583
+ 7: 个人自动签署,适用于个人自动签场景。
2584
+ 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
2585
+ */
2586
+ ApproverType: number;
2587
+ /**
2588
+ * 签署人企业名称
2589
+ 当approverType=0 或 approverType=3时,必须指定
2590
+
2591
+
2473
2592
  */
2474
- ComponentValue: string;
2593
+ OrganizationName?: string;
2475
2594
  /**
2476
- * 控件id,和ComponentName选择一项传入即可
2595
+ * 签署方经办人姓名
2596
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
2477
2597
  */
2478
- ComponentId?: string;
2598
+ ApproverName?: string;
2479
2599
  /**
2480
- * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
2600
+ * 签署方经办人手机号码
2601
+ <br/>在未指定签署人电子签UserId情况下,为必填参数
2602
+
2481
2603
  */
2482
- ComponentName?: string;
2483
- }
2484
- /**
2485
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2486
- */
2487
- export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2604
+ ApproverMobile?: string;
2488
2605
  /**
2489
- * 操作人信息,userId必填
2606
+ * 签署人的证件类型
2607
+ ID_CARD 身份证
2608
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
2609
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2610
+ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
2490
2611
  */
2491
- Operator: UserInfo;
2612
+ ApproverIdCardType?: string;
2492
2613
  /**
2493
- * 应用编号
2614
+ * 签署人证件号(长度不超过18位)
2494
2615
  */
2495
- ApplicationId: string;
2496
- }
2497
- /**
2498
- * 用户信息
2499
- */
2500
- export interface UserInfo {
2616
+ ApproverIdCardNumber?: string;
2501
2617
  /**
2502
- * 用户在平台的编号
2618
+ * 签署方经办人在模板中的参与方ID
2619
+ <br/>模板发起合同时,该参数为必填项
2620
+ <br/>文件发起合同是,该参数无序传值
2621
+
2622
+ */
2623
+ RecipientId?: string;
2624
+ /**
2625
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
2626
+ */
2627
+ VerifyChannel?: Array<string>;
2628
+ /**
2629
+ * 是否发送短信
2630
+ <br/>sms--短信通知
2631
+ <br/>none--不通知
2632
+ <br/>默认为sms
2633
+ <br/>发起方=签署方时不发送短信
2634
+ */
2635
+ NotifyType?: string;
2636
+ /**
2637
+ * 合同强制需要阅读全文,无需传此参数
2638
+ */
2639
+ IsFullText?: boolean;
2640
+ /**
2641
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
2642
+ */
2643
+ PreReadTime?: number;
2644
+ /**
2645
+ * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
2646
+
2647
+ 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
2503
2648
  */
2504
2649
  UserId?: string;
2505
2650
  /**
2506
- * 用户的来源渠道,一般不用传,特定场景根据接口说明传值
2507
- * @deprecated
2651
+ * 当前只支持true,默认为true
2508
2652
  */
2509
- Channel?: string;
2653
+ Required?: boolean;
2510
2654
  /**
2511
- * 用户在渠道的编号,一般不用传,特定场景根据接口说明传值
2512
- * @deprecated
2655
+ * 签署人用户来源,此参数仅针对企微用户开放
2656
+
2657
+ 企微侧用户请传入:WEWORKAPP
2513
2658
  */
2514
- OpenId?: string;
2659
+ ApproverSource?: string;
2515
2660
  /**
2516
- * 用户真实IP,内部字段,暂未开放
2517
- * @deprecated
2661
+ * 企业签署方或签标识,客户自定义,64位长度
2662
+ <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
2663
+ <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
2664
+ <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
2518
2665
  */
2519
- ClientIp?: string;
2666
+ CustomApproverTag?: string;
2520
2667
  /**
2521
- * 用户代理IP,内部字段,暂未开放
2668
+ * 快速注册相关信息,目前暂未开放!
2669
+ */
2670
+ RegisterInfo?: RegisterInfo;
2671
+ /**
2672
+ * 签署人个性化能力值
2673
+ */
2674
+ ApproverOption?: ApproverOption;
2675
+ /**
2676
+ * 签署完前端跳转的url,暂未使用
2522
2677
  * @deprecated
2523
2678
  */
2524
- ProxyIp?: string;
2525
- }
2526
- /**
2527
- * CreateFlowApprovers请求参数结构体
2528
- */
2529
- export interface CreateFlowApproversRequest {
2679
+ JumpUrl?: string;
2530
2680
  /**
2531
- * 调用方用户信息,userId 必填
2681
+ * 签署ID
2682
+ - 发起流程时系统自动补充
2683
+ - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
2532
2684
  */
2533
- Operator: UserInfo;
2685
+ SignId?: string;
2534
2686
  /**
2535
- * 签署流程编号
2687
+ * 当前签署方进行签署操作是否需要企业内部审批
2688
+ <br>true 则为需要
2689
+ <br/>false,无序企业内部审批(默认)
2690
+ <br/>为个人签署方时则由发起方企业审核。
2536
2691
  */
2537
- FlowId: string;
2692
+ ApproverNeedSignReview?: boolean;
2538
2693
  /**
2539
- * 补充签署人信息
2694
+ * 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
2695
+ <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
2540
2696
  */
2541
- Approvers: Array<FillApproverInfo>;
2697
+ SignComponents?: Array<Component>;
2542
2698
  /**
2543
- * 企微消息中的发起人
2699
+ * 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
2700
+ <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
2544
2701
  */
2545
- Initiator?: string;
2702
+ Components?: Array<Component>;
2546
2703
  /**
2547
- * 代理相关应用信息,如集团主企业代子企业操作
2704
+ * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
2705
+ HANDWRITE – 手写签名
2706
+ OCR_ESIGN -- AI智能识别手写签名
2707
+ ESIGN -- 个人印章类型
2708
+ SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
2709
+ */
2710
+ ComponentLimitType?: Array<string>;
2711
+ /**
2712
+ * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
2548
2713
 
2714
+ > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2715
+ */
2716
+ ApproverVerifyTypes?: Array<number | bigint>;
2717
+ /**
2718
+ * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
2549
2719
 
2720
+ > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2550
2721
  */
2551
- Agent?: Agent;
2722
+ ApproverSignTypes?: Array<number | bigint>;
2552
2723
  }
2553
2724
  /**
2554
2725
  * 企业员工信息
@@ -2680,18 +2851,13 @@ export interface CreateFlowEvidenceReportResponse {
2680
2851
  RequestId?: string;
2681
2852
  }
2682
2853
  /**
2683
- * DescribeFileUrls返回参数结构体
2854
+ * CreateIntegrationRole返回参数结构体
2684
2855
  */
2685
- export interface DescribeFileUrlsResponse {
2856
+ export interface CreateIntegrationRoleResponse {
2686
2857
  /**
2687
- * 文件URL信息;
2688
- 链接不是永久链接,有效期5分钟后链接失效。
2689
- */
2690
- FileUrls?: Array<FileUrl>;
2691
- /**
2692
- * URL数量
2858
+ * 角色id
2693
2859
  */
2694
- TotalCount?: number;
2860
+ RoleId?: string;
2695
2861
  /**
2696
2862
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2697
2863
  */
@@ -3057,8 +3223,7 @@ export interface GetTaskResultApiRequest {
3057
3223
  */
3058
3224
  Operator?: UserInfo;
3059
3225
  /**
3060
- * 应用号信息
3061
- * @deprecated
3226
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3062
3227
  */
3063
3228
  Agent?: Agent;
3064
3229
  /**
@@ -3090,22 +3255,41 @@ export interface FlowGroupOptions {
3090
3255
  OtherApproverNotifyType?: string;
3091
3256
  }
3092
3257
  /**
3093
- * 发起流程快速注册相关信息
3258
+ * ModifyIntegrationRole请求参数结构体
3094
3259
  */
3095
- export interface RegisterInfo {
3260
+ export interface ModifyIntegrationRoleRequest {
3096
3261
  /**
3097
- * 法人姓名
3262
+ * 角色Id,可通过接口 DescribeIntegrationRoles 查询获取
3098
3263
  */
3099
- LegalName: string;
3264
+ RoleId: string;
3100
3265
  /**
3101
- * 社会统一信用代码
3102
- * @deprecated
3266
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
3103
3267
  */
3104
- Uscc?: string;
3268
+ Name: string;
3105
3269
  /**
3106
- * 社会统一信用代码
3270
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。
3271
+ 支持填入集团子公司经办人 userId 代发合同。
3272
+
3273
+ 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3107
3274
  */
3108
- UnifiedSocialCreditCode?: string;
3275
+ Operator: UserInfo;
3276
+ /**
3277
+ * 角色描述,最大长度为50个字符
3278
+ */
3279
+ Description?: string;
3280
+ /**
3281
+ * 权限树
3282
+ */
3283
+ PermissionGroups?: Array<PermissionGroup>;
3284
+ /**
3285
+ * 集团角色的话,需要传递集团子企业列表,如果是全选,则传1
3286
+ */
3287
+ SubOrganizationIds?: Array<string>;
3288
+ /**
3289
+ * 代理企业和员工的信息。
3290
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3291
+ */
3292
+ Agent?: Agent;
3109
3293
  }
3110
3294
  /**
3111
3295
  * CreateFlowGroupByFiles返回参数结构体
@@ -3451,6 +3635,10 @@ export interface CreatePersonAuthCertificateImageRequest {
3451
3635
  * 身份证件号码
3452
3636
  */
3453
3637
  IdCardNumber: string;
3638
+ /**
3639
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3640
+ */
3641
+ Agent?: Agent;
3454
3642
  }
3455
3643
  /**
3456
3644
  * CreateFlowByFiles返回参数结构体
@@ -3615,7 +3803,7 @@ export interface FailedCreateRoleData {
3615
3803
  RoleIds?: Array<string>;
3616
3804
  }
3617
3805
  /**
3618
- * 参与者信息
3806
+ * 参与者信息。
3619
3807
  */
3620
3808
  export interface ApproverInfo {
3621
3809
  /**
@@ -3634,10 +3822,8 @@ export interface ApproverInfo {
3634
3822
  */
3635
3823
  ApproverName: string;
3636
3824
  /**
3637
- * 本企业的签署方经办人的员工UserId
3638
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3639
-
3640
- 注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
3825
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
3826
+ 请确认手机号所有方为此合同签署方。
3641
3827
  */
3642
3828
  ApproverMobile: string;
3643
3829
  /**
@@ -4084,6 +4270,11 @@ export interface IntegrateRole {
4084
4270
  注意:此字段可能返回 null,表示取不到有效值。
4085
4271
  */
4086
4272
  SubOrgIdList?: Array<string>;
4273
+ /**
4274
+ * 权限树
4275
+ 注意:此字段可能返回 null,表示取不到有效值。
4276
+ */
4277
+ PermissionGroups?: Array<PermissionGroup>;
4087
4278
  }
4088
4279
  /**
4089
4280
  * CreatePrepareFlow返回参数结构体
@@ -4284,7 +4475,7 @@ export interface CreatePrepareFlowRequest {
4284
4475
  */
4285
4476
  Operator: UserInfo;
4286
4477
  /**
4287
- * 资源Id,通过多文件上传(UploadFiles)接口获得
4478
+ * 资源id,与ResourceType对应
4288
4479
  */
4289
4480
  ResourceId: string;
4290
4481
  /**
@@ -4305,25 +4496,32 @@ export interface CreatePrepareFlowRequest {
4305
4496
  Deadline?: number;
4306
4497
  /**
4307
4498
  * 用户自定义合同类型Id
4308
- 该id为电子签企业内的合同类型id
4499
+
4500
+ 该id为电子签企业内的合同类型id, 可以在自定义合同类型处获取
4309
4501
  */
4310
4502
  UserFlowTypeId?: string;
4503
+ /**
4504
+ * 合同类型名称
4505
+ 该字段用于客户自定义合同类型
4506
+ 建议使用时指定合同类型,便于之后合同分类以及查看
4507
+ 如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
4508
+ */
4509
+ FlowType?: string;
4311
4510
  /**
4312
4511
  * 签署流程参与者信息,最大限制50方
4313
4512
  */
4314
4513
  Approvers?: Array<FlowCreateApprover>;
4315
4514
  /**
4316
4515
  * 打开智能添加填写区
4317
- (默认开启,打开:"OPEN"
4516
+ 默认开启,打开:"OPEN"
4318
4517
  关闭:"CLOSE"
4319
4518
  */
4320
4519
  IntelligentStatus?: string;
4321
4520
  /**
4322
4521
  * 资源类型,
4323
- 1:文件,
4324
- 2:模板
4325
- 不传默认为1:文件
4326
- 目前仅支持文件
4522
+ 1:模板
4523
+ 2:文件,
4524
+ 不传默认为2:文件
4327
4525
  */
4328
4526
  ResourceType?: number;
4329
4527
  /**
@@ -4359,12 +4557,6 @@ export interface CreatePrepareFlowRequest {
4359
4557
  * 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
4360
4558
  */
4361
4559
  FlowId?: string;
4362
- /**
4363
- * 合同类型名称
4364
- 该字段用于客户自定义合同类型
4365
- 建议使用时指定合同类型,便于之后合同分类以及查看
4366
- */
4367
- FlowType?: string;
4368
4560
  /**
4369
4561
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4370
4562
  */
@@ -4474,6 +4666,45 @@ export interface DescribeOrganizationSealsRequest {
4474
4666
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4475
4667
  */
4476
4668
  Agent?: Agent;
4669
+ /**
4670
+ * 查询的印章状态列表。
4671
+ 取值为空,只查询启用状态的印章;
4672
+ 取值ALL,查询所有状态的印章;
4673
+ 取值CHECKING,查询待审核的印章;
4674
+ 取值SUCCESS,查询启用状态的印章;
4675
+ 取值FAIL,查询印章审核拒绝的印章;
4676
+ 取值DISABLE,查询已停用的印章;
4677
+ 取值STOPPED,查询已终止的印章;
4678
+ 取值VOID,查询已作废的印章;
4679
+ 取值INVALID,查询以失效的印章;
4680
+
4681
+ */
4682
+ SealStatuses?: Array<string>;
4683
+ }
4684
+ /**
4685
+ * 权限树中的权限组
4686
+ */
4687
+ export interface PermissionGroup {
4688
+ /**
4689
+ * 权限组名称
4690
+ 注意:此字段可能返回 null,表示取不到有效值。
4691
+ */
4692
+ GroupName?: string;
4693
+ /**
4694
+ * 权限组key
4695
+ 注意:此字段可能返回 null,表示取不到有效值。
4696
+ */
4697
+ GroupKey?: string;
4698
+ /**
4699
+ * 是否隐藏分组,0否1是
4700
+ 注意:此字段可能返回 null,表示取不到有效值。
4701
+ */
4702
+ Hide?: number;
4703
+ /**
4704
+ * 权限集合
4705
+ 注意:此字段可能返回 null,表示取不到有效值。
4706
+ */
4707
+ Permissions?: Array<Permission>;
4477
4708
  }
4478
4709
  /**
4479
4710
  * CancelFlow请求参数结构体
@@ -4947,7 +5178,7 @@ export interface VerifyPdfResponse {
4947
5178
  */
4948
5179
  VerifyResult?: number;
4949
5180
  /**
4950
- * 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
5181
+ * 验签结果详情,每个签名域对应的验签结果。状态值:1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
4951
5182
  */
4952
5183
  PdfVerifyResults?: Array<PdfVerifyResult>;
4953
5184
  /**
@@ -5230,13 +5461,15 @@ export interface CreateMultiFlowSignQRCodeRequest {
5230
5461
  */
5231
5462
  UserData?: string;
5232
5463
  /**
5233
- * 回调地址,最大长度1000字符串
5234
- <br/>回调时机:用户通过签署二维码发起签署流程时,企业额度不足导致失败
5464
+ * 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
5465
+ <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
5466
+ <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/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
5467
+
5468
+ * @deprecated
5235
5469
  */
5236
5470
  CallbackUrl?: string;
5237
5471
  /**
5238
- * 应用信息
5239
- * @deprecated
5472
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5240
5473
  */
5241
5474
  Agent?: Agent;
5242
5475
  /**
@@ -5385,62 +5618,60 @@ export interface FileUrl {
5385
5618
  Option: string;
5386
5619
  }
5387
5620
  /**
5388
- * 流程信息摘要
5621
+ * 合同流程的基础信息
5389
5622
  */
5390
5623
  export interface FlowBrief {
5391
5624
  /**
5392
- * 流程的编号ID
5625
+ * 合同流程ID,为32位字符串。
5393
5626
  */
5394
5627
  FlowId?: string;
5395
5628
  /**
5396
- * 流程的名称
5629
+ * 合同流程的名称。
5397
5630
  */
5398
5631
  FlowName?: string;
5399
5632
  /**
5400
- * 流程的描述信息
5633
+ * 合同流程描述信息。
5401
5634
  注意:此字段可能返回 null,表示取不到有效值。
5402
5635
  */
5403
5636
  FlowDescription?: string;
5404
5637
  /**
5405
- * 流程的类型
5638
+ * 合同流程的类别分类(如销售合同/入职合同等)。
5406
5639
  */
5407
5640
  FlowType?: string;
5408
5641
  /**
5409
- * 流程状态
5410
- - 0 还没有发起
5411
- - 1 待签署
5412
- - 2 部分签署
5413
- - 3 已拒签
5414
- - 4 已签署
5415
- - 5 已过期
5416
- - 6 已撤销
5417
- - 7 还没有预发起
5418
- - 8 等待填写
5419
- - 9 部分填写
5420
- - 10 拒填
5421
- - 21 已解除
5642
+ * 合同流程当前的签署状态, 会存在下列的状态值
5643
+ <ul><li> **0** : 未开启流程(合同中不存在填写环节)</li>
5644
+ <li> **1** : 待签署</li>
5645
+ <li> **2** : 部分签署</li>
5646
+ <li> **3** : 已拒签</li>
5647
+ <li> **4** : 已签署</li>
5648
+ <li> **5** : 已过期</li>
5649
+ <li> **6** : 已撤销</li>
5650
+ <li> **7** : 未开启流程(合同中存在填写环节)</li>
5651
+ <li> **8** : 等待填写</li>
5652
+ <li> **9** : 部分填写</li>
5653
+ <li> **10** : 已拒填</li>
5654
+ <li> **21** : 已解除</li></ul>
5422
5655
  注意:此字段可能返回 null,表示取不到有效值。
5423
5656
  */
5424
5657
  FlowStatus?: number;
5425
5658
  /**
5426
- * 流程创建的时间戳,单位秒
5659
+ * 合同流程创建时间,格式为Unix标准时间戳(秒)。
5427
5660
  注意:此字段可能返回 null,表示取不到有效值。
5428
5661
  */
5429
5662
  CreatedOn?: number;
5430
5663
  /**
5431
- * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
5432
- 此字段展示拒签或者取消的原因描述
5433
-
5664
+ * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
5434
5665
  注意:此字段可能返回 null,表示取不到有效值。
5435
5666
  */
5436
5667
  FlowMessage?: string;
5437
5668
  /**
5438
- * 合同发起人userId
5669
+ * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
5439
5670
  注意:此字段可能返回 null,表示取不到有效值。
5440
5671
  */
5441
5672
  Creator?: string;
5442
5673
  /**
5443
- * 合同过期时间,时间戳,单位秒
5674
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒)。
5444
5675
  注意:此字段可能返回 null,表示取不到有效值。
5445
5676
  */
5446
5677
  Deadline?: number;