tencentcloud-sdk-nodejs 4.0.766 → 4.0.767

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 (51) hide show
  1. package/CHANGELOG.md +251 -0
  2. package/SERVICE_CHANGELOG.md +390 -84
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/billing/v20180709/billing_models.ts +15 -4
  7. package/src/services/cbs/v20170312/cbs_models.ts +4 -4
  8. package/src/services/cwp/v20180228/cwp_models.ts +17 -23
  9. package/src/services/dts/v20211206/dts_models.ts +97 -97
  10. package/src/services/ess/v20201111/ess_client.ts +64 -17
  11. package/src/services/ess/v20201111/ess_models.ts +127 -24
  12. package/src/services/essbasic/v20210526/essbasic_client.ts +34 -5
  13. package/src/services/essbasic/v20210526/essbasic_models.ts +131 -15
  14. package/src/services/faceid/v20180301/faceid_models.ts +8 -8
  15. package/src/services/iss/v20230517/iss_models.ts +12 -8
  16. package/src/services/mongodb/v20190725/mongodb_client.ts +3 -1
  17. package/src/services/mongodb/v20190725/mongodb_models.ts +57 -4
  18. package/src/services/monitor/v20180724/monitor_models.ts +7 -7
  19. package/src/services/sqlserver/v20180328/sqlserver_client.ts +6 -6
  20. package/src/services/sqlserver/v20180328/sqlserver_models.ts +2 -2
  21. package/src/services/tcb/v20180608/tcb_models.ts +3 -3
  22. package/src/services/vod/v20180717/vod_client.ts +4 -3
  23. package/src/services/vod/v20180717/vod_models.ts +131 -132
  24. package/src/services/vpc/v20170312/vpc_models.ts +8 -0
  25. package/tencentcloud/common/sdk_version.d.ts +1 -1
  26. package/tencentcloud/common/sdk_version.js +1 -1
  27. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +15 -4
  28. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -4
  29. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +17 -23
  30. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +97 -97
  31. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +51 -13
  32. package/tencentcloud/services/ess/v20201111/ess_client.js +53 -13
  33. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +124 -24
  34. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +25 -5
  35. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +26 -4
  36. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +128 -15
  37. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +8 -8
  38. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +12 -8
  39. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +1 -1
  40. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +55 -4
  41. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +7 -7
  42. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +6 -6
  43. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +6 -6
  44. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +2 -2
  45. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +3 -3
  46. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -1
  47. package/tencentcloud/services/vod/v20180717/vod_client.js +2 -1
  48. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +131 -132
  49. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +8 -0
  50. package/test/ess.v20201111.test.js +12 -2
  51. package/test/essbasic.v20210526.test.js +10 -0
@@ -27,6 +27,7 @@ import {
27
27
  UpdateIntegrationEmployeesResponse,
28
28
  Department,
29
29
  CreatePreparedPersonalEsignRequest,
30
+ DeleteStaffsResult,
30
31
  DescribeIntegrationDepartmentsResponse,
31
32
  DeleteExtendedServiceAuthInfosResponse,
32
33
  CreateFlowApproversResponse,
@@ -56,6 +57,8 @@ import {
56
57
  DeleteIntegrationRoleUsersResponse,
57
58
  CreateConvertTaskApiRequest,
58
59
  DeleteIntegrationEmployeesResponse,
60
+ NeedReviewApproverInfo,
61
+ CreateFlowGroupSignReviewResponse,
59
62
  CreateBatchSignUrlResponse,
60
63
  CreateFlowRemindsResponse,
61
64
  DescribeOrganizationGroupOrganizationsRequest,
@@ -200,7 +203,7 @@ import {
200
203
  CreateUserAutoSignEnableUrlResponse,
201
204
  SignUrl,
202
205
  VerifyPdfResponse,
203
- DeleteStaffsResult,
206
+ CreateFlowGroupSignReviewRequest,
204
207
  DescribeBillUsageDetailRequest,
205
208
  Admin,
206
209
  Caller,
@@ -389,23 +392,20 @@ export class Client extends AbstractClient {
389
392
  }
390
393
 
391
394
  /**
392
- * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
393
-
394
- 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
395
-
396
- 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
395
+ * 提交合同组签署流程审批结果的适用场景包括:
397
396
 
398
- 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
397
+ 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时,若指定了以下参数 为true,则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
398
+ - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
399
+ - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
399
400
 
400
- 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
401
401
 
402
- 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
402
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
403
403
  */
404
- async CreateIntegrationRole(
405
- req: CreateIntegrationRoleRequest,
406
- cb?: (error: string, rep: CreateIntegrationRoleResponse) => void
407
- ): Promise<CreateIntegrationRoleResponse> {
408
- return this.request("CreateIntegrationRole", req, cb)
404
+ async CreateFlowGroupSignReview(
405
+ req: CreateFlowGroupSignReviewRequest,
406
+ cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void
407
+ ): Promise<CreateFlowGroupSignReviewResponse> {
408
+ return this.request("CreateFlowGroupSignReview", req, cb)
409
409
  }
410
410
 
411
411
  /**
@@ -526,9 +526,36 @@ export class Client extends AbstractClient {
526
526
  }
527
527
 
528
528
  /**
529
- * 提交签署流程审批结果的适用场景包括:
530
- 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
531
- 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
529
+ * 提交企业流程审批结果
530
+ **当前存在两种审核操作:**
531
+ <ul>
532
+ <li>签署审核
533
+ <ul>
534
+ <li>在通过接口<ul>
535
+ <li>CreateFlowByFiles</li>
536
+ <li>CreateFlow</li>
537
+ <li>CreateFlowGroupByTemplates</li>
538
+ <li>CreateFlowGroupByFiles</li>
539
+ <li>CreatePrepareFlow</li>
540
+ </ul>
541
+ 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
542
+ <li>在通过接口
543
+ <ul>
544
+ <li>CreateFlowByFiles</li>
545
+ <li>CreateFlow</li>
546
+ <li>CreateFlowGroupByTemplates</li>
547
+ <li>CreateFlowGroupByFiles</li>
548
+ </ul>
549
+ 发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
550
+ </ul>
551
+ </li>
552
+ <li>发起审核
553
+ <ul>
554
+ <li>通过接口CreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
555
+ </li>
556
+ </ul>
557
+ </li>
558
+ </ul>
532
559
  */
533
560
  async CreateFlowSignReview(
534
561
  req: CreateFlowSignReviewRequest,
@@ -997,6 +1024,26 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
997
1024
  return this.request("DescribeFlowBriefs", req, cb)
998
1025
  }
999
1026
 
1027
+ /**
1028
+ * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
1029
+
1030
+ 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
1031
+
1032
+ 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
1033
+
1034
+ 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
1035
+
1036
+ 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
1037
+
1038
+ 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
1039
+ */
1040
+ async CreateIntegrationRole(
1041
+ req: CreateIntegrationRoleRequest,
1042
+ cb?: (error: string, rep: CreateIntegrationRoleResponse) => void
1043
+ ): Promise<CreateIntegrationRoleResponse> {
1044
+ return this.request("CreateIntegrationRole", req, cb)
1045
+ }
1046
+
1000
1047
  /**
1001
1048
  * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
1002
1049
  */
@@ -382,6 +382,22 @@ BLUE 蓝色。
382
382
  SceneKey?: string
383
383
  }
384
384
 
385
+ /**
386
+ * 删除员工结果
387
+ */
388
+ export interface DeleteStaffsResult {
389
+ /**
390
+ * 删除员工的成功数据
391
+ 注意:此字段可能返回 null,表示取不到有效值。
392
+ */
393
+ SuccessEmployeeData: Array<SuccessDeleteStaffData>
394
+ /**
395
+ * 删除员工的失败数据
396
+ 注意:此字段可能返回 null,表示取不到有效值。
397
+ */
398
+ FailedEmployeeData: Array<FailedDeleteStaffData>
399
+ }
400
+
385
401
  /**
386
402
  * DescribeIntegrationDepartments返回参数结构体
387
403
  */
@@ -1098,6 +1114,61 @@ export interface DeleteIntegrationEmployeesResponse {
1098
1114
  RequestId?: string
1099
1115
  }
1100
1116
 
1117
+ /**
1118
+ * 需要进行签署审核的签署人信息
1119
+ */
1120
+ export interface NeedReviewApproverInfo {
1121
+ /**
1122
+ * 签署方经办人的类型,支持以下类型
1123
+ <ul><li> ORGANIZATION 企业(含企业自动签)</li>
1124
+ <li>PERSON 个人(含个人自动签)</li></ul>
1125
+ */
1126
+ ApproverType: string
1127
+ /**
1128
+ * 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1129
+ */
1130
+ ApproverName: string
1131
+ /**
1132
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
1133
+ */
1134
+ ApproverMobile?: string
1135
+ /**
1136
+ * 签署方经办人的证件类型,支持以下类型
1137
+ <ul><li>ID_CARD 居民身份证 (默认值)</li>
1138
+ <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
1139
+ <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
1140
+ <li>OTHER_CARD_TYPE 其他证件</li></ul>
1141
+
1142
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
1143
+ */
1144
+ ApproverIdCardType?: string
1145
+ /**
1146
+ * 签署方经办人的证件号码,应符合以下规则
1147
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1148
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1149
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1150
+ */
1151
+ ApproverIdCardNumber?: string
1152
+ /**
1153
+ * 组织机构名称。
1154
+ 请确认该名称与企业营业执照中注册的名称一致。
1155
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1156
+ 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
1157
+
1158
+ */
1159
+ OrganizationName?: string
1160
+ }
1161
+
1162
+ /**
1163
+ * CreateFlowGroupSignReview返回参数结构体
1164
+ */
1165
+ export interface CreateFlowGroupSignReviewResponse {
1166
+ /**
1167
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1168
+ */
1169
+ RequestId?: string
1170
+ }
1171
+
1101
1172
  /**
1102
1173
  * CreateBatchSignUrl返回参数结构体
1103
1174
  */
@@ -2807,31 +2878,24 @@ export interface CreateFlowSignReviewRequest {
2807
2878
  Operator: UserInfo
2808
2879
  /**
2809
2880
  * 合同流程ID,为32位字符串。
2810
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2811
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)
2881
+ <ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
2882
+ <li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
2812
2883
  */
2813
2884
  FlowId: string
2814
2885
  /**
2815
- * 企业审核结果
2816
- <ul><li>PASS: 通过</li>
2817
- <li>REJECT: 拒绝</li></ul>
2886
+ * 企业内部审核结果
2887
+ <ul><li>PASS: 审核通过</li>
2888
+ <li>REJECT: 审核拒绝</li>
2889
+ <li>SIGN_REJECT:拒签(流程结束)</li></ul>
2818
2890
  */
2819
2891
  ReviewType: string
2820
- /**
2821
- * 审核结果原因,
2822
- 字符串长度不超过200
2823
- 当ReviewType 是拒绝(REJECT) 时此字段必填。
2824
-
2825
- */
2826
- ReviewMessage?: string
2827
2892
  /**
2828
2893
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2829
2894
  */
2830
2895
  Agent?: Agent
2831
2896
  /**
2832
- * 审核签署节点人标识,
2833
- 用来标识审核的签署方。
2834
- 如果签署审核节点是个人, 此参数必填。
2897
+ * 审核节点的签署人标志,用于指定当前审核的签署方
2898
+ <ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
2835
2899
  */
2836
2900
  RecipientId?: string
2837
2901
  /**
@@ -2843,6 +2907,15 @@ export interface CreateFlowSignReviewRequest {
2843
2907
  如果审核节点是个人,则操作类型只能为SignReview。
2844
2908
  */
2845
2909
  OperateType?: string
2910
+ /**
2911
+ * 审核结果原因
2912
+ <ul><li>字符串长度不超过200</li>
2913
+ <li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
2914
+ <li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
2915
+
2916
+
2917
+ */
2918
+ ReviewMessage?: string
2846
2919
  }
2847
2920
 
2848
2921
  /**
@@ -3287,7 +3360,8 @@ FormField输入示例:
3287
3360
  }
3288
3361
  ```
3289
3362
 
3290
- 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
3363
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue支持填入附件图片或者文件的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
3364
+ 支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf
3291
3365
 
3292
3366
  ```
3293
3367
  FormField输入示例:
@@ -6642,19 +6716,48 @@ export interface VerifyPdfResponse {
6642
6716
  }
6643
6717
 
6644
6718
  /**
6645
- * 删除员工结果
6719
+ * CreateFlowGroupSignReview请求参数结构体
6646
6720
  */
6647
- export interface DeleteStaffsResult {
6721
+ export interface CreateFlowGroupSignReviewRequest {
6648
6722
  /**
6649
- * 删除员工的成功数据
6650
- 注意:此字段可能返回 null,表示取不到有效值。
6723
+ * 执行本接口操作的员工信息。
6724
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6651
6725
  */
6652
- SuccessEmployeeData: Array<SuccessDeleteStaffData>
6726
+ Operator: UserInfo
6653
6727
  /**
6654
- * 删除员工的失败数据
6655
- 注意:此字段可能返回 null,表示取不到有效值。
6728
+ * 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
6656
6729
  */
6657
- FailedEmployeeData: Array<FailedDeleteStaffData>
6730
+ FlowGroupId: string
6731
+ /**
6732
+ * 提交的审核结果,审核结果有下面三种情况
6733
+ <ul><li><b>PASS</b>: 审核通过,合同流程可以继续执行签署等操作</li>
6734
+ <li><b>REJECT</b>: 审核拒绝,合同流程不会变动</li>
6735
+ <li><b>SIGN_REJECT</b>:拒签,合同流程直接结束,合同状态变为**合同拒签**</li></ul>
6736
+ */
6737
+ ReviewType: string
6738
+ /**
6739
+ * 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
6740
+
6741
+ 个人:二选一(选择其中任意信息组合即可)
6742
+ <ul><li>姓名+证件类型+证件号</li>
6743
+ <li>姓名+手机号</li></ul>
6744
+
6745
+ 企业:二选一 (选择其中任意信息组合即可)
6746
+ <ul><li>企业名+姓名+证件类型+证件号</li>
6747
+ <li>企业名+姓名+手机号</li></ul>
6748
+ */
6749
+ ApproverInfo: NeedReviewApproverInfo
6750
+ /**
6751
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6752
+ */
6753
+ Agent?: Agent
6754
+ /**
6755
+ * 审核不通过的原因,该字段的字符串长度不超过200个字符。
6756
+
6757
+ 注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
6758
+
6759
+ */
6760
+ ReviewMessage?: string
6658
6761
  }
6659
6762
 
6660
6763
  /**
@@ -62,6 +62,8 @@ import {
62
62
  DownloadFlowInfo,
63
63
  FlowApproverUrlInfo,
64
64
  ChannelCreateWebThemeConfigRequest,
65
+ NeedReviewApproverInfo,
66
+ CreateFlowGroupSignReviewResponse,
65
67
  ChannelCreateConvertTaskApiRequest,
66
68
  ChannelCreateFlowByFilesRequest,
67
69
  UploadFilesResponse,
@@ -194,6 +196,7 @@ import {
194
196
  ChannelUpdateSealStatusRequest,
195
197
  ChannelCreateFlowGroupByTemplatesRequest,
196
198
  SignUrl,
199
+ CreateFlowGroupSignReviewRequest,
197
200
  ChannelBillUsageDetail,
198
201
  DescribeBillUsageDetailRequest,
199
202
  RelieveInfo,
@@ -245,11 +248,22 @@ export class Client extends AbstractClient {
245
248
  }
246
249
 
247
250
  /**
248
- * 提交企业流程审批结果
249
- 目前存在两种审核操作,签署审核,发起审核
250
- 签署审核:通过接口(CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow)发起签署流程后,若指定了参数 NeedSignReview 为true,则可以调用此接口,指定operate=SignReview,提交企业内部签署审批结果;若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效
251
-
252
- 发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效
251
+ * 提交企业流程审批结果
252
+ **当前存在两种审核操作:**
253
+ <ul>
254
+ <li>签署审核
255
+ <ul>
256
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li><li>ChannelCreatePrepareFlow</li></ul> 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
257
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li></ul>发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
258
+ </ul>
259
+ </li>
260
+ <li>发起审核
261
+ <ul>
262
+ <li>通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
263
+ </li>
264
+ </ul>
265
+ </li>
266
+ </ul>
253
267
  */
254
268
  async ChannelCreateFlowSignReview(
255
269
  req: ChannelCreateFlowSignReviewRequest,
@@ -1217,6 +1231,21 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1217
1231
  return this.request("DescribeResourceUrlsByFlows", req, cb)
1218
1232
  }
1219
1233
 
1234
+ /**
1235
+ * 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
1236
+ - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
1237
+ - [FlowFileInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowfileinfo)
1238
+ - [FlowApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo)
1239
+
1240
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
1241
+ */
1242
+ async CreateFlowGroupSignReview(
1243
+ req: CreateFlowGroupSignReviewRequest,
1244
+ cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void
1245
+ ): Promise<CreateFlowGroupSignReviewResponse> {
1246
+ return this.request("CreateFlowGroupSignReview", req, cb)
1247
+ }
1248
+
1220
1249
  /**
1221
1250
  * 使用此接口,用来绑定企业实名员工的角色,
1222
1251
  支持以电子签userId、客户系统openId两种方式进行绑定。
@@ -564,31 +564,37 @@ export interface ChannelCreateFlowSignReviewRequest {
564
564
  */
565
565
  Agent: Agent
566
566
  /**
567
- * 签署流程编号
567
+ * 合同流程ID,为32位字符串。
568
+ <ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
569
+ <li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
568
570
  */
569
571
  FlowId: string
570
572
  /**
571
573
  * 企业内部审核结果
572
- PASS: 通过
573
- REJECT: 拒绝
574
- SIGN_REJECT:拒签(流程结束)
574
+ <ul><li>PASS: 审核通过</li>
575
+ <li>REJECT: 审核拒绝</li>
576
+ <li>SIGN_REJECT:拒签(流程结束)</li></ul>
575
577
  */
576
578
  ReviewType: string
577
579
  /**
578
- * 审核原因
579
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
580
+ * 审核结果原因
581
+ <ul><li>字符串长度不超过200</li>
582
+ <li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
583
+ <li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
580
584
  */
581
585
  ReviewMessage?: string
582
586
  /**
583
- * 签署节点审核时需要指定,给个人审核时必填。
587
+ * 审核节点的签署人标志,用于指定当前审核的签署方
588
+ <ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
584
589
  */
585
590
  RecipientId?: string
586
591
  /**
587
- * 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核
588
- 注:接口通过该字段区分操作类型
589
- 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
590
- 若想使用发起审核,请指定该字段为:CreateReview
591
- 若发起个人审核,则指定该字段为:SignReview
592
+ * 流程审核操作类型,取值如下:
593
+ <ul><li>**SignReview**:(默认)签署审核</li>
594
+ <li>**CreateReview**:发起审核</li>
595
+ <li>注意:`该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程`</li></ul>
596
+
597
+
592
598
  */
593
599
  OperateType?: string
594
600
  }
@@ -1789,6 +1795,61 @@ export interface ChannelCreateWebThemeConfigRequest {
1789
1795
  WebThemeConfig: WebThemeConfig
1790
1796
  }
1791
1797
 
1798
+ /**
1799
+ * 需要进行签署审核的签署人信息
1800
+ */
1801
+ export interface NeedReviewApproverInfo {
1802
+ /**
1803
+ * 签署方经办人的类型,支持以下类型
1804
+ <ul><li> ORGANIZATION 企业(含企业自动签)</li>
1805
+ <li>PERSON 个人(含个人自动签)</li></ul>
1806
+ */
1807
+ ApproverType: string
1808
+ /**
1809
+ * 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1810
+ */
1811
+ ApproverName: string
1812
+ /**
1813
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
1814
+ */
1815
+ ApproverMobile?: string
1816
+ /**
1817
+ * 签署方经办人的证件类型,支持以下类型
1818
+ <ul><li>ID_CARD 居民身份证 (默认值)</li>
1819
+ <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
1820
+ <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
1821
+ <li>OTHER_CARD_TYPE 其他证件</li></ul>
1822
+
1823
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
1824
+ */
1825
+ ApproverIdCardType?: string
1826
+ /**
1827
+ * 签署方经办人的证件号码,应符合以下规则
1828
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1829
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1830
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1831
+ */
1832
+ ApproverIdCardNumber?: string
1833
+ /**
1834
+ * 组织机构名称。
1835
+ 请确认该名称与企业营业执照中注册的名称一致。
1836
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1837
+ 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
1838
+
1839
+ */
1840
+ OrganizationName?: string
1841
+ }
1842
+
1843
+ /**
1844
+ * CreateFlowGroupSignReview返回参数结构体
1845
+ */
1846
+ export interface CreateFlowGroupSignReviewResponse {
1847
+ /**
1848
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1849
+ */
1850
+ RequestId?: string
1851
+ }
1852
+
1792
1853
  /**
1793
1854
  * ChannelCreateConvertTaskApi请求参数结构体
1794
1855
  */
@@ -2474,7 +2535,7 @@ export interface TemplateInfo {
2474
2535
  */
2475
2536
  IsPromoter?: boolean
2476
2537
  /**
2477
- * 模板的创建者信息,电子签系统用户ID
2538
+ * 模板的创建者名字
2478
2539
  */
2479
2540
  Creator?: string
2480
2541
  /**
@@ -3436,7 +3497,7 @@ export interface CommonFlowApprover {
3436
3497
  */
3437
3498
  NotifyType?: string
3438
3499
  /**
3439
- * 签署人配置
3500
+ * 签署人配置,用于控制签署人相关属性
3440
3501
  */
3441
3502
  ApproverOption?: CommonApproverOption
3442
3503
  /**
@@ -4848,7 +4909,14 @@ export interface FlowApproverInfo {
4848
4909
  */
4849
4910
  ApproverOption?: ApproverOption
4850
4911
  /**
4851
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
4912
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
4913
+ <ul><li>**false**:(默认)不需要审批,直接签署。</li>
4914
+ <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
4915
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
4916
+ <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
4917
+ <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
4918
+
4919
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4852
4920
  */
4853
4921
  ApproverNeedSignReview?: boolean
4854
4922
  /**
@@ -6540,6 +6608,54 @@ export interface SignUrl {
6540
6608
  HttpSignUrl?: string
6541
6609
  }
6542
6610
 
6611
+ /**
6612
+ * CreateFlowGroupSignReview请求参数结构体
6613
+ */
6614
+ export interface CreateFlowGroupSignReviewRequest {
6615
+ /**
6616
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6617
+
6618
+ 此接口下面信息必填。
6619
+ <ul>
6620
+ <li>渠道应用标识: Agent.AppId</li>
6621
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6622
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6623
+ </ul>
6624
+ 第三方平台子客企业和员工必须已经经过实名认证
6625
+ */
6626
+ Agent: Agent
6627
+ /**
6628
+ * 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时返回。
6629
+ */
6630
+ FlowGroupId: string
6631
+ /**
6632
+ * 提交的审核结果,审核结果有下面三种情况
6633
+ <ul><li><b>PASS</b>: 审核通过,合同流程可以继续执行签署等操作</li>
6634
+ <li><b>REJECT</b>: 审核拒绝,合同流程不会变动</li>
6635
+ <li><b>SIGN_REJECT</b>:拒签,合同流程直接结束,合同状态变为**合同拒签**</li></ul>
6636
+ */
6637
+ ReviewType: string
6638
+ /**
6639
+ * 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
6640
+
6641
+ 个人:二选一(选择其中任意信息组合即可)
6642
+ <ul><li>姓名+证件类型+证件号</li>
6643
+ <li>姓名+手机号</li></ul>
6644
+
6645
+ 企业:二选一 (选择其中任意信息组合即可)
6646
+ <ul><li>企业名+姓名+证件类型+证件号</li>
6647
+ <li>企业名+姓名+手机号</li></ul>
6648
+ */
6649
+ ApproverInfo: NeedReviewApproverInfo
6650
+ /**
6651
+ * 审核不通过的原因,该字段的字符串长度不超过200个字符。
6652
+
6653
+ 注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
6654
+
6655
+ */
6656
+ ReviewMessage?: string
6657
+ }
6658
+
6543
6659
  /**
6544
6660
  * 用户计费使用情况详情
6545
6661
  */
@@ -188,7 +188,7 @@ export interface IntentionQuestionResult {
188
188
  -301: "意愿核验不通过"
189
189
  -800: "前端不兼容错误"
190
190
  -801: "用户未授权摄像头和麦克风权限"
191
- -802: "获取视频流失败"
191
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
192
192
  -803: "用户主动关闭链接/异常断开链接"
193
193
  -998: "系统数据异常"
194
194
  -999: "系统未知错误,请联系人工核实"
@@ -204,34 +204,34 @@ export interface IntentionQuestionResult {
204
204
  * 视频base64(其中包含全程问题和回答音频,mp4格式)
205
205
  注意:此字段可能返回 null,表示取不到有效值。
206
206
  */
207
- Video: string
207
+ Video?: string
208
208
  /**
209
209
  * 屏幕截图base64列表
210
210
  注意:此字段可能返回 null,表示取不到有效值。
211
211
  */
212
- ScreenShot: Array<string>
212
+ ScreenShot?: Array<string>
213
213
  /**
214
214
  * 和答案匹配结果列表
215
215
  0:成功,-1:不匹配
216
216
  注意:此字段可能返回 null,表示取不到有效值。
217
217
  */
218
- ResultCode: Array<string>
218
+ ResultCode?: Array<string>
219
219
  /**
220
220
  * 回答问题语音识别结果列表
221
221
  注意:此字段可能返回 null,表示取不到有效值。
222
222
  */
223
- AsrResult: Array<string>
223
+ AsrResult?: Array<string>
224
224
  /**
225
225
  * 答案录音音频
226
226
  注意:此字段可能返回 null,表示取不到有效值。
227
227
  */
228
- Audios: Array<string>
228
+ Audios?: Array<string>
229
229
  /**
230
230
  * 意愿核身最终结果:
231
231
  0:认证通过,-1:认证未通过,-2:浏览器内核不兼容,无法进行意愿校验。建议使用“FinalResultDetailCode”参数获取详细的错误码信息。
232
232
  注意:此字段可能返回 null,表示取不到有效值。
233
233
  */
234
- FinalResultCode: string
234
+ FinalResultCode?: string
235
235
  }
236
236
 
237
237
  /**
@@ -2525,7 +2525,7 @@ export interface IntentionActionResult {
2525
2525
  -301: "意愿核验不通过"
2526
2526
  -800: "前端不兼容错误"
2527
2527
  -801: "用户未授权摄像头和麦克风权限"
2528
- -802: "获取视频流失败"
2528
+ -802: "核验流程异常中断,请勿切屏或进行其他操作"
2529
2529
  -803: "用户主动关闭链接/异常断开链接"
2530
2530
  -998: "系统数据异常"
2531
2531
  -999: "系统未知错误,请联系人工核实"