tencentcloud-sdk-nodejs 4.0.766 → 4.0.768

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 (70) hide show
  1. package/CHANGELOG.md +300 -0
  2. package/SERVICE_CHANGELOG.md +286 -143
  3. package/package.json +1 -1
  4. package/products.md +20 -20
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/billing/v20180709/billing_models.ts +15 -4
  7. package/src/services/cat/v20180409/cat_models.ts +1 -1
  8. package/src/services/cbs/v20170312/cbs_models.ts +4 -4
  9. package/src/services/cwp/v20180228/cwp_models.ts +17 -23
  10. package/src/services/dts/v20211206/dts_models.ts +97 -97
  11. package/src/services/ess/v20201111/ess_client.ts +68 -22
  12. package/src/services/ess/v20201111/ess_models.ts +144 -37
  13. package/src/services/essbasic/v20210526/essbasic_client.ts +34 -5
  14. package/src/services/essbasic/v20210526/essbasic_models.ts +155 -25
  15. package/src/services/faceid/v20180301/faceid_models.ts +8 -8
  16. package/src/services/iss/v20230517/iss_models.ts +12 -8
  17. package/src/services/ivld/v20210903/ivld_models.ts +3 -3
  18. package/src/services/mongodb/v20190725/mongodb_client.ts +3 -1
  19. package/src/services/mongodb/v20190725/mongodb_models.ts +57 -4
  20. package/src/services/monitor/v20180724/monitor_models.ts +7 -7
  21. package/src/services/omics/v20221128/omics_models.ts +21 -4
  22. package/src/services/sqlserver/v20180328/sqlserver_client.ts +6 -6
  23. package/src/services/sqlserver/v20180328/sqlserver_models.ts +2 -2
  24. package/src/services/ssm/v20190923/ssm_models.ts +2 -2
  25. package/src/services/tcb/v20180608/tcb_models.ts +3 -3
  26. package/src/services/tsf/v20180326/tsf_client.ts +1 -1
  27. package/src/services/tsf/v20180326/tsf_models.ts +1 -1
  28. package/src/services/vod/v20180717/vod_client.ts +4 -3
  29. package/src/services/vod/v20180717/vod_models.ts +131 -132
  30. package/src/services/vpc/v20170312/vpc_models.ts +8 -0
  31. package/src/services/wedata/v20210820/wedata_client.ts +55 -16
  32. package/src/services/wedata/v20210820/wedata_models.ts +552 -71
  33. package/tencentcloud/common/sdk_version.d.ts +1 -1
  34. package/tencentcloud/common/sdk_version.js +1 -1
  35. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +15 -4
  36. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1 -1
  37. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -4
  38. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +17 -23
  39. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +97 -97
  40. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +55 -18
  41. package/tencentcloud/services/ess/v20201111/ess_client.js +57 -18
  42. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +141 -37
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +25 -5
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +26 -4
  45. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +152 -25
  46. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +8 -8
  47. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +12 -8
  48. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +3 -3
  49. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +1 -1
  50. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +55 -4
  51. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +7 -7
  52. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +21 -4
  53. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +6 -6
  54. package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +6 -6
  55. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +2 -2
  56. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +2 -2
  57. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +3 -3
  58. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  59. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  60. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +1 -1
  61. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -1
  62. package/tencentcloud/services/vod/v20180717/vod_client.js +2 -1
  63. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +131 -132
  64. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +8 -0
  65. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +17 -5
  66. package/tencentcloud/services/wedata/v20210820/wedata_client.js +24 -6
  67. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +545 -73
  68. package/test/ess.v20201111.test.js +12 -2
  69. package/test/essbasic.v20210526.test.js +10 -0
  70. package/test/wedata.v20210820.test.js +34 -4
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, VerifyPdfResponse, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -99,19 +99,16 @@ export declare class Client extends AbstractClient {
99
99
  */
100
100
  CreateUserAutoSignEnableUrl(req: CreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CreateUserAutoSignEnableUrlResponse) => void): Promise<CreateUserAutoSignEnableUrlResponse>;
101
101
  /**
102
- * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
102
+ * 提交合同组签署流程审批结果的适用场景包括:
103
103
 
104
- 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
104
+ 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时,若指定了以下参数 为true,则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
105
+ - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
106
+ - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
105
107
 
106
- 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
107
-
108
- 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
109
108
 
110
- 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
111
-
112
- 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
109
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
113
110
  */
114
- CreateIntegrationRole(req: CreateIntegrationRoleRequest, cb?: (error: string, rep: CreateIntegrationRoleResponse) => void): Promise<CreateIntegrationRoleResponse>;
111
+ CreateFlowGroupSignReview(req: CreateFlowGroupSignReviewRequest, cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void): Promise<CreateFlowGroupSignReviewResponse>;
115
112
  /**
116
113
  * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
117
114
  1. 创建印章
@@ -170,9 +167,36 @@ export declare class Client extends AbstractClient {
170
167
  */
171
168
  DeleteIntegrationRoleUsers(req: DeleteIntegrationRoleUsersRequest, cb?: (error: string, rep: DeleteIntegrationRoleUsersResponse) => void): Promise<DeleteIntegrationRoleUsersResponse>;
172
169
  /**
173
- * 提交签署流程审批结果的适用场景包括:
174
- 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
175
- 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
170
+ * 提交企业流程审批结果
171
+ **当前存在两种审核操作:**
172
+ <ul>
173
+ <li>签署审核
174
+ <ul>
175
+ <li>在通过接口<ul>
176
+ <li>CreateFlowByFiles</li>
177
+ <li>CreateFlow</li>
178
+ <li>CreateFlowGroupByTemplates</li>
179
+ <li>CreateFlowGroupByFiles</li>
180
+ <li>CreatePrepareFlow</li>
181
+ </ul>
182
+ 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
183
+ <li>在通过接口
184
+ <ul>
185
+ <li>CreateFlowByFiles</li>
186
+ <li>CreateFlow</li>
187
+ <li>CreateFlowGroupByTemplates</li>
188
+ <li>CreateFlowGroupByFiles</li>
189
+ </ul>
190
+ 发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
191
+ </ul>
192
+ </li>
193
+ <li>发起审核
194
+ <ul>
195
+ <li>通过接口CreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
196
+ </li>
197
+ </ul>
198
+ </li>
199
+ </ul>
176
200
  */
177
201
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
178
202
  /**
@@ -279,11 +303,10 @@ export declare class Client extends AbstractClient {
279
303
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
280
304
 
281
305
  注:
282
- `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
283
-
284
- `2. 签署链接的有效期为90天,超过有效期链接不可用`
285
-
286
- `3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`
306
+ <ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
307
+ <li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
308
+ <li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>
309
+ <li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>
287
310
 
288
311
  其中小程序的原始Id如下,或者查看小程序信息自助获取。
289
312
 
@@ -485,6 +508,20 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
485
508
  注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
486
509
  */
487
510
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
511
+ /**
512
+ * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
513
+
514
+ 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
515
+
516
+ 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
517
+
518
+ 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
519
+
520
+ 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
521
+
522
+ 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
523
+ */
524
+ CreateIntegrationRole(req: CreateIntegrationRoleRequest, cb?: (error: string, rep: CreateIntegrationRoleResponse) => void): Promise<CreateIntegrationRoleResponse>;
488
525
  /**
489
526
  * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
490
527
  */
@@ -139,20 +139,17 @@ class Client extends abstract_client_1.AbstractClient {
139
139
  return this.request("CreateUserAutoSignEnableUrl", req, cb);
140
140
  }
141
141
  /**
142
- * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
143
-
144
- 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
145
-
146
- 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
142
+ * 提交合同组签署流程审批结果的适用场景包括:
147
143
 
148
- 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
144
+ 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时,若指定了以下参数 为true,则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
145
+ - [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
146
+ - [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
149
147
 
150
- 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
151
148
 
152
- 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
149
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
153
150
  */
154
- async CreateIntegrationRole(req, cb) {
155
- return this.request("CreateIntegrationRole", req, cb);
151
+ async CreateFlowGroupSignReview(req, cb) {
152
+ return this.request("CreateFlowGroupSignReview", req, cb);
156
153
  }
157
154
  /**
158
155
  * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
@@ -232,9 +229,36 @@ class Client extends abstract_client_1.AbstractClient {
232
229
  return this.request("DeleteIntegrationRoleUsers", req, cb);
233
230
  }
234
231
  /**
235
- * 提交签署流程审批结果的适用场景包括:
236
- 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
237
- 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
232
+ * 提交企业流程审批结果
233
+ **当前存在两种审核操作:**
234
+ <ul>
235
+ <li>签署审核
236
+ <ul>
237
+ <li>在通过接口<ul>
238
+ <li>CreateFlowByFiles</li>
239
+ <li>CreateFlow</li>
240
+ <li>CreateFlowGroupByTemplates</li>
241
+ <li>CreateFlowGroupByFiles</li>
242
+ <li>CreatePrepareFlow</li>
243
+ </ul>
244
+ 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
245
+ <li>在通过接口
246
+ <ul>
247
+ <li>CreateFlowByFiles</li>
248
+ <li>CreateFlow</li>
249
+ <li>CreateFlowGroupByTemplates</li>
250
+ <li>CreateFlowGroupByFiles</li>
251
+ </ul>
252
+ 发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
253
+ </ul>
254
+ </li>
255
+ <li>发起审核
256
+ <ul>
257
+ <li>通过接口CreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
258
+ </li>
259
+ </ul>
260
+ </li>
261
+ </ul>
238
262
  */
239
263
  async CreateFlowSignReview(req, cb) {
240
264
  return this.request("CreateFlowSignReview", req, cb);
@@ -355,11 +379,10 @@ class Client extends abstract_client_1.AbstractClient {
355
379
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
356
380
 
357
381
  注:
358
- `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
359
-
360
- `2. 签署链接的有效期为90天,超过有效期链接不可用`
361
-
362
- `3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接`
382
+ <ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
383
+ <li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
384
+ <li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>
385
+ <li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>
363
386
 
364
387
  其中小程序的原始Id如下,或者查看小程序信息自助获取。
365
388
 
@@ -599,6 +622,22 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
599
622
  async DescribeFlowBriefs(req, cb) {
600
623
  return this.request("DescribeFlowBriefs", req, cb);
601
624
  }
625
+ /**
626
+ * 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
627
+
628
+ 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
629
+
630
+ 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
631
+
632
+ 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
633
+
634
+ 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
635
+
636
+ 注意事项:SaaS角色和集团角色对应的权限树是不一样的。
637
+ */
638
+ async CreateIntegrationRole(req, cb) {
639
+ return this.request("CreateIntegrationRole", req, cb);
640
+ }
602
641
  /**
603
642
  * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
604
643
  */
@@ -356,6 +356,21 @@ export interface CreatePreparedPersonalEsignRequest {
356
356
  */
357
357
  SceneKey?: string;
358
358
  }
359
+ /**
360
+ * 删除员工结果
361
+ */
362
+ export interface DeleteStaffsResult {
363
+ /**
364
+ * 删除员工的成功数据
365
+ 注意:此字段可能返回 null,表示取不到有效值。
366
+ */
367
+ SuccessEmployeeData: Array<SuccessDeleteStaffData>;
368
+ /**
369
+ * 删除员工的失败数据
370
+ 注意:此字段可能返回 null,表示取不到有效值。
371
+ */
372
+ FailedEmployeeData: Array<FailedDeleteStaffData>;
373
+ }
359
374
  /**
360
375
  * DescribeIntegrationDepartments返回参数结构体
361
376
  */
@@ -504,35 +519,32 @@ export interface CreateMultiFlowSignQRCodeResponse {
504
519
  */
505
520
  export interface FlowApproverUrlInfo {
506
521
  /**
507
- * 签署短链接。</br>
522
+ * 签署短链接。
508
523
  注意:
509
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
510
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
511
- 注意:此字段可能返回 null,表示取不到有效值。
524
+ 1. 该链接有效期为<b>30分钟</b>,同时需要注意保密,不要外泄给无关用户。
525
+ 2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。
526
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
512
527
  */
513
528
  SignUrl?: string;
514
529
  /**
515
530
  * 签署人类型。
516
531
  - **1**: 个人
517
- 注意:此字段可能返回 null,表示取不到有效值。
518
532
  */
519
533
  ApproverType?: number;
520
534
  /**
521
535
  * 签署人姓名。
522
- 注意:此字段可能返回 null,表示取不到有效值。
523
536
  */
524
537
  ApproverName?: string;
525
538
  /**
526
539
  * 签署人手机号。
527
- 注意:此字段可能返回 null,表示取不到有效值。
528
540
  */
529
541
  ApproverMobile?: string;
530
542
  /**
531
- * 签署长链接。</br>
543
+ * 签署长链接。
532
544
  注意:
533
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
534
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
535
- 注意:此字段可能返回 null,表示取不到有效值。
545
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
546
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
547
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
536
548
  */
537
549
  LongUrl?: string;
538
550
  }
@@ -1043,6 +1055,59 @@ export interface DeleteIntegrationEmployeesResponse {
1043
1055
  */
1044
1056
  RequestId?: string;
1045
1057
  }
1058
+ /**
1059
+ * 需要进行签署审核的签署人信息
1060
+ */
1061
+ export interface NeedReviewApproverInfo {
1062
+ /**
1063
+ * 签署方经办人的类型,支持以下类型
1064
+ <ul><li> ORGANIZATION 企业(含企业自动签)</li>
1065
+ <li>PERSON 个人(含个人自动签)</li></ul>
1066
+ */
1067
+ ApproverType: string;
1068
+ /**
1069
+ * 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1070
+ */
1071
+ ApproverName: string;
1072
+ /**
1073
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
1074
+ */
1075
+ ApproverMobile?: string;
1076
+ /**
1077
+ * 签署方经办人的证件类型,支持以下类型
1078
+ <ul><li>ID_CARD 居民身份证 (默认值)</li>
1079
+ <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
1080
+ <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
1081
+ <li>OTHER_CARD_TYPE 其他证件</li></ul>
1082
+
1083
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
1084
+ */
1085
+ ApproverIdCardType?: string;
1086
+ /**
1087
+ * 签署方经办人的证件号码,应符合以下规则
1088
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1089
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1090
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1091
+ */
1092
+ ApproverIdCardNumber?: string;
1093
+ /**
1094
+ * 组织机构名称。
1095
+ 请确认该名称与企业营业执照中注册的名称一致。
1096
+ 如果名称中包含英文括号(),请使用中文括号()代替。
1097
+ 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
1098
+
1099
+ */
1100
+ OrganizationName?: string;
1101
+ }
1102
+ /**
1103
+ * CreateFlowGroupSignReview返回参数结构体
1104
+ */
1105
+ export interface CreateFlowGroupSignReviewResponse {
1106
+ /**
1107
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1108
+ */
1109
+ RequestId?: string;
1110
+ }
1046
1111
  /**
1047
1112
  * CreateBatchSignUrl返回参数结构体
1048
1113
  */
@@ -1050,7 +1115,9 @@ export interface CreateBatchSignUrlResponse {
1050
1115
  /**
1051
1116
  * 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
1052
1117
 
1053
- 注: `非小程序和APP集成使用`
1118
+ 注:
1119
+ 1. 非小程序和APP集成使用
1120
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1054
1121
  */
1055
1122
  SignUrl?: string;
1056
1123
  /**
@@ -1060,7 +1127,9 @@ export interface CreateBatchSignUrlResponse {
1060
1127
  /**
1061
1128
  * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
1062
1129
 
1063
- 注: `小程序和APP集成使用`
1130
+ 注:
1131
+ 1. 小程序和APP集成使用
1132
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1064
1133
  */
1065
1134
  MiniAppPath?: string;
1066
1135
  /**
@@ -2704,31 +2773,24 @@ export interface CreateFlowSignReviewRequest {
2704
2773
  Operator: UserInfo;
2705
2774
  /**
2706
2775
  * 合同流程ID,为32位字符串。
2707
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2708
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)
2776
+ <ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
2777
+ <li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
2709
2778
  */
2710
2779
  FlowId: string;
2711
2780
  /**
2712
- * 企业审核结果
2713
- <ul><li>PASS: 通过</li>
2714
- <li>REJECT: 拒绝</li></ul>
2781
+ * 企业内部审核结果
2782
+ <ul><li>PASS: 审核通过</li>
2783
+ <li>REJECT: 审核拒绝</li>
2784
+ <li>SIGN_REJECT:拒签(流程结束)</li></ul>
2715
2785
  */
2716
2786
  ReviewType: string;
2717
- /**
2718
- * 审核结果原因,
2719
- 字符串长度不超过200
2720
- 当ReviewType 是拒绝(REJECT) 时此字段必填。
2721
-
2722
- */
2723
- ReviewMessage?: string;
2724
2787
  /**
2725
2788
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2726
2789
  */
2727
2790
  Agent?: Agent;
2728
2791
  /**
2729
- * 审核签署节点人标识,
2730
- 用来标识审核的签署方。
2731
- 如果签署审核节点是个人, 此参数必填。
2792
+ * 审核节点的签署人标志,用于指定当前审核的签署方
2793
+ <ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
2732
2794
  */
2733
2795
  RecipientId?: string;
2734
2796
  /**
@@ -2740,6 +2802,15 @@ export interface CreateFlowSignReviewRequest {
2740
2802
  如果审核节点是个人,则操作类型只能为SignReview。
2741
2803
  */
2742
2804
  OperateType?: string;
2805
+ /**
2806
+ * 审核结果原因
2807
+ <ul><li>字符串长度不超过200</li>
2808
+ <li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
2809
+ <li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
2810
+
2811
+
2812
+ */
2813
+ ReviewMessage?: string;
2743
2814
  }
2744
2815
  /**
2745
2816
  * UnbindEmployeeUserIdWithClientOpenId请求参数结构体
@@ -2776,6 +2847,9 @@ export interface CreateSchemeUrlResponse {
2776
2847
  <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
2777
2848
  <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
2778
2849
  <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
2850
+
2851
+
2852
+ 注: <font color="red">生成的链路后面不能再增加参数</font>
2779
2853
  */
2780
2854
  SchemeUrl?: string;
2781
2855
  /**
@@ -3176,7 +3250,8 @@ FormField输入示例:
3176
3250
  }
3177
3251
  ```
3178
3252
 
3179
- 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
3253
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue支持填入附件图片或者文件的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
3254
+ 支持的文件类型包括doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf
3180
3255
 
3181
3256
  ```
3182
3257
  FormField输入示例:
@@ -6443,19 +6518,48 @@ export interface VerifyPdfResponse {
6443
6518
  RequestId?: string;
6444
6519
  }
6445
6520
  /**
6446
- * 删除员工结果
6521
+ * CreateFlowGroupSignReview请求参数结构体
6447
6522
  */
6448
- export interface DeleteStaffsResult {
6523
+ export interface CreateFlowGroupSignReviewRequest {
6449
6524
  /**
6450
- * 删除员工的成功数据
6451
- 注意:此字段可能返回 null,表示取不到有效值。
6525
+ * 执行本接口操作的员工信息。
6526
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6452
6527
  */
6453
- SuccessEmployeeData: Array<SuccessDeleteStaffData>;
6528
+ Operator: UserInfo;
6454
6529
  /**
6455
- * 删除员工的失败数据
6456
- 注意:此字段可能返回 null,表示取不到有效值。
6530
+ * 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时返回。
6457
6531
  */
6458
- FailedEmployeeData: Array<FailedDeleteStaffData>;
6532
+ FlowGroupId: string;
6533
+ /**
6534
+ * 提交的审核结果,审核结果有下面三种情况
6535
+ <ul><li><b>PASS</b>: 审核通过,合同流程可以继续执行签署等操作</li>
6536
+ <li><b>REJECT</b>: 审核拒绝,合同流程不会变动</li>
6537
+ <li><b>SIGN_REJECT</b>:拒签,合同流程直接结束,合同状态变为**合同拒签**</li></ul>
6538
+ */
6539
+ ReviewType: string;
6540
+ /**
6541
+ * 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
6542
+
6543
+ 个人:二选一(选择其中任意信息组合即可)
6544
+ <ul><li>姓名+证件类型+证件号</li>
6545
+ <li>姓名+手机号</li></ul>
6546
+
6547
+ 企业:二选一 (选择其中任意信息组合即可)
6548
+ <ul><li>企业名+姓名+证件类型+证件号</li>
6549
+ <li>企业名+姓名+手机号</li></ul>
6550
+ */
6551
+ ApproverInfo: NeedReviewApproverInfo;
6552
+ /**
6553
+ * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6554
+ */
6555
+ Agent?: Agent;
6556
+ /**
6557
+ * 审核不通过的原因,该字段的字符串长度不超过200个字符。
6558
+
6559
+ 注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
6560
+
6561
+ */
6562
+ ReviewMessage?: string;
6459
6563
  }
6460
6564
  /**
6461
6565
  * DescribeBillUsageDetail请求参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeTemplatesRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeTemplatesRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -13,10 +13,21 @@ export declare class Client extends AbstractClient {
13
13
  ChannelDeleteSealPolicies(req: ChannelDeleteSealPoliciesRequest, cb?: (error: string, rep: ChannelDeleteSealPoliciesResponse) => void): Promise<ChannelDeleteSealPoliciesResponse>;
14
14
  /**
15
15
  * 提交企业流程审批结果
16
- 目前存在两种审核操作,签署审核,发起审核
17
- 签署审核:通过接口(CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow)发起签署流程后,若指定了参数 NeedSignReview 为true,则可以调用此接口,指定operate=SignReview,提交企业内部签署审批结果;若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效
18
-
19
- 发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效
16
+ **当前存在两种审核操作:**
17
+ <ul>
18
+ <li>签署审核
19
+ <ul>
20
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li><li>ChannelCreatePrepareFlow</li></ul> 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
21
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li></ul>发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
22
+ </ul>
23
+ </li>
24
+ <li>发起审核
25
+ <ul>
26
+ <li>通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
27
+ </li>
28
+ </ul>
29
+ </li>
30
+ </ul>
20
31
  */
21
32
  ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
22
33
  /**
@@ -690,6 +701,15 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
690
701
  ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
691
702
  */
692
703
  DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
704
+ /**
705
+ * 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
706
+ - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
707
+ - [FlowFileInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowfileinfo)
708
+ - [FlowApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo)
709
+
710
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
711
+ */
712
+ CreateFlowGroupSignReview(req: CreateFlowGroupSignReviewRequest, cb?: (error: string, rep: CreateFlowGroupSignReviewResponse) => void): Promise<CreateFlowGroupSignReviewResponse>;
693
713
  /**
694
714
  * 使用此接口,用来绑定企业实名员工的角色,
695
715
  支持以电子签userId、客户系统openId两种方式进行绑定。
@@ -35,10 +35,21 @@ class Client extends abstract_client_1.AbstractClient {
35
35
  }
36
36
  /**
37
37
  * 提交企业流程审批结果
38
- 目前存在两种审核操作,签署审核,发起审核
39
- 签署审核:通过接口(CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow)发起签署流程后,若指定了参数 NeedSignReview 为true,则可以调用此接口,指定operate=SignReview,提交企业内部签署审批结果;若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效
40
-
41
- 发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效
38
+ **当前存在两种审核操作:**
39
+ <ul>
40
+ <li>签署审核
41
+ <ul>
42
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li><li>ChannelCreatePrepareFlow</li></ul> 发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果</li>
43
+ <li>在通过接口<ul><li>CreateFlowsByTemplates</li><li>ChannelCreateFlowByFiles</li><li>ChannelCreateFlowGroupByTemplates</li><li>ChannelCreateFlowGroupByFiles</li></ul>发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果</li>
44
+ </ul>
45
+ </li>
46
+ <li>发起审核
47
+ <ul>
48
+ <li>通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
49
+ </li>
50
+ </ul>
51
+ </li>
52
+ </ul>
42
53
  */
43
54
  async ChannelCreateFlowSignReview(req, cb) {
44
55
  return this.request("ChannelCreateFlowSignReview", req, cb);
@@ -810,6 +821,17 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
810
821
  async DescribeResourceUrlsByFlows(req, cb) {
811
822
  return this.request("DescribeResourceUrlsByFlows", req, cb);
812
823
  }
824
+ /**
825
+ * 1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
826
+ - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
827
+ - [FlowFileInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowfileinfo)
828
+ - [FlowApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo)
829
+
830
+ 2. 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
831
+ */
832
+ async CreateFlowGroupSignReview(req, cb) {
833
+ return this.request("CreateFlowGroupSignReview", req, cb);
834
+ }
813
835
  /**
814
836
  * 使用此接口,用来绑定企业实名员工的角色,
815
837
  支持以电子签userId、客户系统openId两种方式进行绑定。