tencentcloud-sdk-nodejs 4.0.686 → 4.0.687

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 (76) hide show
  1. package/CHANGELOG.md +197 -0
  2. package/SERVICE_CHANGELOG.md +325 -396
  3. package/package.json +1 -1
  4. package/products.md +18 -17
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +4 -3
  7. package/src/services/ams/v20201229/ams_models.ts +1 -1
  8. package/src/services/asr/v20190614/asr_models.ts +81 -28
  9. package/src/services/cdb/v20170320/cdb_models.ts +3 -3
  10. package/src/services/cvm/v20170312/cvm_models.ts +6 -1
  11. package/src/services/dlc/v20210125/dlc_client.ts +1 -1
  12. package/src/services/dlc/v20210125/dlc_models.ts +1 -1
  13. package/src/services/ecc/v20181213/ecc_client.ts +1 -0
  14. package/src/services/ecc/v20181213/ecc_models.ts +35 -0
  15. package/src/services/ess/v20201111/ess_client.ts +6 -22
  16. package/src/services/ess/v20201111/ess_models.ts +96 -114
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +45 -3
  18. package/src/services/index.ts +1 -0
  19. package/src/services/monitor/v20180724/monitor_models.ts +5 -0
  20. package/src/services/mrs/v20200910/mrs_client.ts +3 -2
  21. package/src/services/mrs/v20200910/mrs_models.ts +2 -2
  22. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  23. package/src/services/sqlserver/v20180328/sqlserver_models.ts +31 -19
  24. package/src/services/teo/v20220901/teo_models.ts +11 -10
  25. package/src/services/vod/v20180717/vod_client.ts +0 -12
  26. package/src/services/vod/v20180717/vod_models.ts +0 -24
  27. package/src/services/waf/v20180125/waf_client.ts +12 -0
  28. package/src/services/waf/v20180125/waf_models.ts +32 -0
  29. package/src/services/weilingwith/index.ts +5 -0
  30. package/src/services/weilingwith/v20230427/index.ts +6 -0
  31. package/src/services/weilingwith/v20230427/weilingwith_client.ts +93 -0
  32. package/src/services/weilingwith/v20230427/weilingwith_models.ts +197 -0
  33. package/tencentcloud/common/sdk_version.d.ts +1 -1
  34. package/tencentcloud/common/sdk_version.js +1 -1
  35. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +4 -3
  36. package/tencentcloud/services/ams/v20201229/ams_client.js +4 -3
  37. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +1 -1
  38. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +81 -28
  39. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +3 -3
  40. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +6 -1
  41. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +1 -1
  42. package/tencentcloud/services/dlc/v20210125/dlc_client.js +1 -1
  43. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +1 -1
  44. package/tencentcloud/services/ecc/v20181213/ecc_models.d.ts +34 -0
  45. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -13
  46. package/tencentcloud/services/ess/v20201111/ess_client.js +4 -14
  47. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +96 -112
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +45 -3
  49. package/tencentcloud/services/index.d.ts +1 -0
  50. package/tencentcloud/services/index.js +2 -0
  51. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +5 -0
  52. package/tencentcloud/services/mrs/v20200910/mrs_client.d.ts +2 -1
  53. package/tencentcloud/services/mrs/v20200910/mrs_client.js +2 -1
  54. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +2 -2
  55. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  56. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  57. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +31 -19
  58. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +11 -10
  59. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -5
  60. package/tencentcloud/services/vod/v20180717/vod_client.js +0 -6
  61. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +0 -22
  62. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
  63. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
  64. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +30 -0
  65. package/tencentcloud/services/weilingwith/index.d.ts +6 -0
  66. package/tencentcloud/services/weilingwith/index.js +7 -0
  67. package/tencentcloud/services/weilingwith/v20230427/index.d.ts +6 -0
  68. package/tencentcloud/services/weilingwith/v20230427/index.js +9 -0
  69. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +30 -0
  70. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +61 -0
  71. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +169 -0
  72. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.js +18 -0
  73. package/test/ess.v20201111.test.js +0 -10
  74. package/test/vod.v20180717.test.js +0 -10
  75. package/test/waf.v20180125.test.js +10 -0
  76. package/test/weilingwith.v20230427.test.js +71 -0
@@ -5816,15 +5816,15 @@ export interface DescribeTagsOfInstanceIdsResponse {
5816
5816
  /**
5817
5817
  * 分页偏移量。
5818
5818
  */
5819
- Offset: number;
5819
+ Offset?: number;
5820
5820
  /**
5821
5821
  * 分页大小。
5822
5822
  */
5823
- Limit: number;
5823
+ Limit?: number;
5824
5824
  /**
5825
5825
  * 实例标签信息。
5826
5826
  */
5827
- Rows: Array<TagsInfoOfInstance>;
5827
+ Rows?: Array<TagsInfoOfInstance>;
5828
5828
  /**
5829
5829
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5830
5830
  */
@@ -2762,7 +2762,12 @@ export interface HostItem {
2762
2762
  * 专用宿主机所属的围笼ID。该字段仅对金融专区围笼内的专用宿主机有效。
2763
2763
  注意:此字段可能返回 null,表示取不到有效值。
2764
2764
  */
2765
- CageId: string;
2765
+ CageId?: string;
2766
+ /**
2767
+ * 专用宿主机关联的标签列表。
2768
+ 注意:此字段可能返回 null,表示取不到有效值。
2769
+ */
2770
+ Tags?: Array<Tag>;
2766
2771
  }
2767
2772
  /**
2768
2773
  * 操作系统支持的类型。
@@ -52,7 +52,7 @@ export declare class Client extends AbstractClient {
52
52
  */
53
53
  CreateNotebookSessionStatementSupportBatchSQL(req: CreateNotebookSessionStatementSupportBatchSQLRequest, cb?: (error: string, rep: CreateNotebookSessionStatementSupportBatchSQLResponse) => void): Promise<CreateNotebookSessionStatementSupportBatchSQLResponse>;
54
54
  /**
55
- * 本接口(DescribeSparkSessionBatchSqlLog)用于获取SparkSQL批任务日志
55
+ * 本接口(DescribeSparkSessionBatchSqlLog)用于查询Spark SQL批任务日志
56
56
  */
57
57
  DescribeSparkSessionBatchSqlLog(req: DescribeSparkSessionBatchSqlLogRequest, cb?: (error: string, rep: DescribeSparkSessionBatchSqlLogResponse) => void): Promise<DescribeSparkSessionBatchSqlLogResponse>;
58
58
  /**
@@ -94,7 +94,7 @@ class Client extends abstract_client_1.AbstractClient {
94
94
  return this.request("CreateNotebookSessionStatementSupportBatchSQL", req, cb);
95
95
  }
96
96
  /**
97
- * 本接口(DescribeSparkSessionBatchSqlLog)用于获取SparkSQL批任务日志
97
+ * 本接口(DescribeSparkSessionBatchSqlLog)用于查询Spark SQL批任务日志
98
98
  */
99
99
  async DescribeSparkSessionBatchSqlLog(req, cb) {
100
100
  return this.request("DescribeSparkSessionBatchSqlLog", req, cb);
@@ -1299,7 +1299,7 @@ export interface DetachWorkGroupPolicyResponse {
1299
1299
  */
1300
1300
  export interface DescribeSparkSessionBatchSqlLogResponse {
1301
1301
  /**
1302
- * 状态:0:初始化、1:成功、2:失败、3:取消、4:异常;
1302
+ * 状态:0:运行中、1:成功、2:失败、3:取消、4:超时;
1303
1303
  */
1304
1304
  State?: number;
1305
1305
  /**
@@ -4,8 +4,13 @@
4
4
  export interface CorrectMultiImageResponse {
5
5
  /**
6
6
  * 接口返回数据
7
+ * @deprecated
7
8
  */
8
9
  Data?: CompostionContext;
10
+ /**
11
+ * 接口返回数据
12
+ */
13
+ ResultData?: CompositionContext;
9
14
  /**
10
15
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
11
16
  */
@@ -66,8 +71,13 @@ export interface ECCResponse {
66
71
  export interface EHOCRResponse {
67
72
  /**
68
73
  * 接口返回数据
74
+ * @deprecated
69
75
  */
70
76
  Data?: CompostionContext;
77
+ /**
78
+ * 接口返回数据
79
+ */
80
+ ResultData?: CompositionContext;
71
81
  /**
72
82
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
73
83
  */
@@ -332,6 +342,30 @@ export interface EHOCRRequest {
332
342
  */
333
343
  IsAsync?: number;
334
344
  }
345
+ /**
346
+ * 图像识别批改接口返回的作文文本信息或批改信息
347
+ */
348
+ export interface CompositionContext {
349
+ /**
350
+ * 作文内容
351
+ */
352
+ Content: string;
353
+ /**
354
+ * 批改结果
355
+ 注意:此字段可能返回 null,表示取不到有效值。
356
+ */
357
+ CorrectData: CorrectData;
358
+ /**
359
+ * 任务 id,用于查询接口
360
+ 注意:此字段可能返回 null,表示取不到有效值。
361
+ */
362
+ TaskId: string;
363
+ /**
364
+ * 图像识别唯一标识,一次识别一个 SessionId
365
+ 注意:此字段可能返回 null,表示取不到有效值。
366
+ */
367
+ SessionId: string;
368
+ }
335
369
  /**
336
370
  * CorrectMultiImage请求参数结构体
337
371
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, DescribeIntegrationMainOrganizationUserRequest, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, DescribeIntegrationMainOrganizationUserRequest, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -219,16 +219,6 @@ export declare class Client extends AbstractClient {
219
219
  5. 批量签署能力
220
220
  */
221
221
  DescribeExtendedServiceAuthInfos(req: DescribeExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfosResponse) => void): Promise<DescribeExtendedServiceAuthInfosResponse>;
222
- /**
223
- * 根据产品要求,调整接口目录
224
-
225
- 新接口:ChannelCreateOrganizationModifyQrCode
226
-
227
- 老接口目前无线上流量,测试用例已下线处理
228
-
229
- 生成子客编辑企业信息二维码
230
- */
231
- CreateChannelSubOrganizationModifyQrCode(req: CreateChannelSubOrganizationModifyQrCodeRequest, cb?: (error: string, rep: CreateChannelSubOrganizationModifyQrCodeResponse) => void): Promise<CreateChannelSubOrganizationModifyQrCodeResponse>;
232
222
  /**
233
223
  * 此接口(UploadFiles)用于文件上传。<br/>
234
224
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
@@ -338,8 +328,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
338
328
  */
339
329
  CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
340
330
  /**
341
- * 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
342
- 如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
331
+ * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。</br>
332
+ 附注:
333
+ - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。
334
+ - 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
343
335
  */
344
336
  CreateOrganizationBatchSignUrl(req: CreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: CreateOrganizationBatchSignUrlResponse) => void): Promise<CreateOrganizationBatchSignUrlResponse>;
345
337
  /**
@@ -299,18 +299,6 @@ class Client extends abstract_client_1.AbstractClient {
299
299
  async DescribeExtendedServiceAuthInfos(req, cb) {
300
300
  return this.request("DescribeExtendedServiceAuthInfos", req, cb);
301
301
  }
302
- /**
303
- * 根据产品要求,调整接口目录
304
-
305
- 新接口:ChannelCreateOrganizationModifyQrCode
306
-
307
- 老接口目前无线上流量,测试用例已下线处理
308
-
309
- 生成子客编辑企业信息二维码
310
- */
311
- async CreateChannelSubOrganizationModifyQrCode(req, cb) {
312
- return this.request("CreateChannelSubOrganizationModifyQrCode", req, cb);
313
- }
314
302
  /**
315
303
  * 此接口(UploadFiles)用于文件上传。<br/>
316
304
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
@@ -452,8 +440,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
452
440
  return this.request("CreateSealPolicy", req, cb);
453
441
  }
454
442
  /**
455
- * 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
456
- 如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
443
+ * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。</br>
444
+ 附注:
445
+ - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。
446
+ - 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
457
447
  */
458
448
  async CreateOrganizationBatchSignUrl(req, cb) {
459
449
  return this.request("CreateOrganizationBatchSignUrl", req, cb);
@@ -2621,19 +2621,6 @@ export interface FormField {
2621
2621
  */
2622
2622
  ComponentName?: string;
2623
2623
  }
2624
- /**
2625
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
2626
- */
2627
- export interface CreateChannelSubOrganizationModifyQrCodeRequest {
2628
- /**
2629
- * 操作人信息,userId必填
2630
- */
2631
- Operator: UserInfo;
2632
- /**
2633
- * 应用编号
2634
- */
2635
- ApplicationId: string;
2636
- }
2637
2624
  /**
2638
2625
  * 用户信息
2639
2626
  */
@@ -3224,65 +3211,23 @@ export interface CreateDocumentRequest {
3224
3211
  ClientToken?: string;
3225
3212
  }
3226
3213
  /**
3227
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
3214
+ * 催办接口返回的详细信息。
3228
3215
  */
3229
- export interface FlowDetailInfo {
3230
- /**
3231
- * 合同(流程)的ID
3232
- */
3233
- FlowId?: string;
3234
- /**
3235
- * 合同(流程)的名字
3236
- */
3237
- FlowName?: string;
3238
- /**
3239
- * 合同(流程)的类型
3240
- 注意:此字段可能返回 null,表示取不到有效值。
3241
- */
3242
- FlowType?: string;
3243
- /**
3244
- * 流程状态
3245
- - 0 还没有发起
3246
- - 1 待签署
3247
- - 2 部分签署
3248
- - 3 已拒签
3249
- - 4 已签署
3250
- - 5 已过期
3251
- - 6 已撤销
3252
- - 7 还没有预发起
3253
- - 8 等待填写
3254
- - 9 部分填写
3255
- - 10 拒填
3256
- - 21 已解除
3257
- */
3258
- FlowStatus?: number;
3259
- /**
3260
- * 合同(流程)的信息
3261
- 注意:此字段可能返回 null,表示取不到有效值。
3262
- */
3263
- FlowMessage?: string;
3264
- /**
3265
- * 流程的描述
3266
- 注意:此字段可能返回 null,表示取不到有效值。
3267
- */
3268
- FlowDescription?: string;
3269
- /**
3270
- * 合同(流程)的创建时间戳,单位秒
3271
- */
3272
- CreatedOn?: number;
3216
+ export interface RemindFlowRecords {
3273
3217
  /**
3274
- * 合同(流程)的签署方数组
3218
+ * 合同流程是否可以催办:
3219
+ true - 可以,false - 不可以。
3220
+ 若无法催办,将返回RemindMessage以解释原因。
3275
3221
  */
3276
- FlowApproverInfos?: Array<FlowApproverDetail>;
3222
+ CanRemind?: boolean;
3277
3223
  /**
3278
- * 合同(流程)的关注方信息列表
3224
+ * 合同流程ID,为32位字符串。
3279
3225
  */
3280
- CcInfos?: Array<FlowApproverDetail>;
3226
+ FlowId?: string;
3281
3227
  /**
3282
- * 合同发起人UserId
3283
- 注意:此字段可能返回 null,表示取不到有效值。
3228
+ * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
3284
3229
  */
3285
- Creator?: string;
3230
+ RemindMessage?: string;
3286
3231
  }
3287
3232
  /**
3288
3233
  * CreatePreparedPersonalEsign返回参数结构体
@@ -3319,7 +3264,8 @@ export interface DescribeOrganizationSealsResponse {
3319
3264
  */
3320
3265
  export interface CreateEmbedWebUrlRequest {
3321
3266
  /**
3322
- * 操作者信息
3267
+ * 执行本接口操作的员工信息。
3268
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3323
3269
  */
3324
3270
  Operator: UserInfo;
3325
3271
  /**
@@ -3344,7 +3290,8 @@ export interface CreateEmbedWebUrlRequest {
3344
3290
  */
3345
3291
  BusinessId?: string;
3346
3292
  /**
3347
- * 代理相关应用信息,如集团主企业代子企业操作
3293
+ * 代理企业和员工的信息。
3294
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3348
3295
  */
3349
3296
  Agent?: Agent;
3350
3297
  /**
@@ -3352,7 +3299,7 @@ export interface CreateEmbedWebUrlRequest {
3352
3299
  */
3353
3300
  Reviewer?: ReviewerInfo;
3354
3301
  /**
3355
- * 个性化参数
3302
+ * 个性化参数,用于控制页面展示内容
3356
3303
  */
3357
3304
  Option?: EmbedUrlOption;
3358
3305
  }
@@ -3784,21 +3731,65 @@ export interface CreateIntegrationUserRolesRequest {
3784
3731
  Agent?: Agent;
3785
3732
  }
3786
3733
  /**
3787
- * CreateChannelSubOrganizationModifyQrCode返回参数结构体
3734
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
3788
3735
  */
3789
- export interface CreateChannelSubOrganizationModifyQrCodeResponse {
3736
+ export interface FlowDetailInfo {
3790
3737
  /**
3791
- * 二维码下载链接
3738
+ * 合同(流程)的ID
3792
3739
  */
3793
- QrCodeUrl?: string;
3740
+ FlowId?: string;
3794
3741
  /**
3795
- * 二维码失效时间 UNIX 时间戳 精确到秒
3742
+ * 合同(流程)的名字
3796
3743
  */
3797
- ExpiredTime?: number;
3744
+ FlowName?: string;
3798
3745
  /**
3799
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3746
+ * 合同(流程)的类型
3747
+ 注意:此字段可能返回 null,表示取不到有效值。
3800
3748
  */
3801
- RequestId?: string;
3749
+ FlowType?: string;
3750
+ /**
3751
+ * 流程状态
3752
+ - 0 还没有发起
3753
+ - 1 待签署
3754
+ - 2 部分签署
3755
+ - 3 已拒签
3756
+ - 4 已签署
3757
+ - 5 已过期
3758
+ - 6 已撤销
3759
+ - 7 还没有预发起
3760
+ - 8 等待填写
3761
+ - 9 部分填写
3762
+ - 10 拒填
3763
+ - 21 已解除
3764
+ */
3765
+ FlowStatus?: number;
3766
+ /**
3767
+ * 合同(流程)的信息
3768
+ 注意:此字段可能返回 null,表示取不到有效值。
3769
+ */
3770
+ FlowMessage?: string;
3771
+ /**
3772
+ * 流程的描述
3773
+ 注意:此字段可能返回 null,表示取不到有效值。
3774
+ */
3775
+ FlowDescription?: string;
3776
+ /**
3777
+ * 合同(流程)的创建时间戳,单位秒
3778
+ */
3779
+ CreatedOn?: number;
3780
+ /**
3781
+ * 合同(流程)的签署方数组
3782
+ */
3783
+ FlowApproverInfos?: Array<FlowApproverDetail>;
3784
+ /**
3785
+ * 合同(流程)的关注方信息列表
3786
+ */
3787
+ CcInfos?: Array<FlowApproverDetail>;
3788
+ /**
3789
+ * 合同发起人UserId
3790
+ 注意:此字段可能返回 null,表示取不到有效值。
3791
+ */
3792
+ Creator?: string;
3802
3793
  }
3803
3794
  /**
3804
3795
  * 更新员工信息成功返回的数据信息
@@ -4282,11 +4273,11 @@ export interface CreateUserAutoSignEnableUrlRequest {
4282
4273
  */
4283
4274
  export interface CreateOrganizationBatchSignUrlResponse {
4284
4275
  /**
4285
- * 批量签署入口链接
4276
+ * 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
4286
4277
  */
4287
4278
  SignUrl?: string;
4288
4279
  /**
4289
- * 链接过期时间戳
4280
+ * 链接过期截止时间,格式为Unix标准时间戳(秒),默认为7天后截止。
4290
4281
  */
4291
4282
  ExpiredTime?: number;
4292
4283
  /**
@@ -4308,25 +4299,6 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
4308
4299
  */
4309
4300
  RequestId?: string;
4310
4301
  }
4311
- /**
4312
- * 催办接口返回的详细信息。
4313
- */
4314
- export interface RemindFlowRecords {
4315
- /**
4316
- * 合同流程是否可以催办:
4317
- true - 可以,false - 不可以。
4318
- 若无法催办,将返回RemindMessage以解释原因。
4319
- */
4320
- CanRemind?: boolean;
4321
- /**
4322
- * 合同流程ID,为32位字符串。
4323
- */
4324
- FlowId?: string;
4325
- /**
4326
- * 在合同流程无法催办的情况下,系统将返回RemindMessage以阐述原因。
4327
- */
4328
- RemindMessage?: string;
4329
- }
4330
4302
  /**
4331
4303
  * CancelUserAutoSignEnableUrl请求参数结构体
4332
4304
  */
@@ -4449,27 +4421,37 @@ export interface DeleteSealPoliciesRequest {
4449
4421
  */
4450
4422
  export interface CreateOrganizationBatchSignUrlRequest {
4451
4423
  /**
4452
- * 调用方用户信息,UserId 必填,支持填入集团子公司经办人UserId
4424
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
4425
+ 支持填入集团子公司经办人 userId 代发合同。
4426
+
4427
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4453
4428
  */
4454
4429
  Operator: UserInfo;
4455
4430
  /**
4456
- * 指定需要进行批量签署的流程id,数量1-100,填写后用户将通过链接对这些合同进行批量签署。
4431
+ * 请指定需执行批量签署的流程ID,数量范围为1-100。</br>
4432
+ 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。</br>
4433
+ 用户将利用链接对这些合同实施批量操作。
4457
4434
  */
4458
4435
  FlowIds: Array<string>;
4459
4436
  /**
4460
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
4437
+ * 代理企业和员工的信息。
4438
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4461
4439
  */
4462
4440
  Agent?: Agent;
4463
4441
  /**
4464
- * 员工的UserId,该UserId对应的员工必须已经加入企业并实名,Name和Mobile为空时该字段不能为空。(优先使用UserId对应的员工)
4442
+ * 员工在腾讯电子签平台的独特身份标识,为32位字符串。</br>
4443
+ 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。</br>
4444
+ UserId必须是传入合同(FlowId)中的签署人。
4445
+ - 1. 若UserId为空,Name和Mobile 必须提供。
4446
+ - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
4465
4447
  */
4466
4448
  UserId?: string;
4467
4449
  /**
4468
- * 员工姓名,该字段需要与Mobile组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
4450
+ * 员工姓名,必须与手机号码一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4469
4451
  */
4470
4452
  Name?: string;
4471
4453
  /**
4472
- * 员工手机号码,该字段需要与Name组合使用,UserId为空时该字段不能为空。(UserId为空时,使用Name和Mbile对应的员工)
4454
+ * 员工手机号,必须与姓名一起使用。</br> 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
4473
4455
  */
4474
4456
  Mobile?: string;
4475
4457
  }
@@ -4605,10 +4587,11 @@ export interface DeleteIntegrationDepartmentRequest {
4605
4587
  */
4606
4588
  export interface WebThemeConfig {
4607
4589
  /**
4608
- * 是否页面底部显示电子签logo
4609
- <br/>true:允许在页面底部隐藏电子签logo
4610
- <br/>false:不允许允许在页面底部隐藏电子签logo
4611
- <br/>默认false,不隐藏logo
4590
+ * 是否显示页面底部电子签logo,取值如下:
4591
+ <ul>
4592
+ <li> **true**:页面底部显示电子签logo</li>
4593
+ <li> **false**:页面底部不显示电子签logo(默认)</li>
4594
+ </ul>
4612
4595
  */
4613
4596
  DisplaySignBrandLogo?: boolean;
4614
4597
  /**
@@ -4827,7 +4810,7 @@ export interface ApproverOption {
4827
4810
  export interface CreateEmbedWebUrlResponse {
4828
4811
  /**
4829
4812
  * 嵌入的web链接,有效期:5分钟
4830
- EmbedType=PREVIEW_CC_FLOW,该url为h5链接
4813
+ <br/>EmbedType=PREVIEW_CC_FLOW,该url为h5链接
4831
4814
  */
4832
4815
  WebUrl?: string;
4833
4816
  /**
@@ -5661,17 +5644,18 @@ export interface EmbedUrlOption {
5661
5644
  */
5662
5645
  export interface CreateBatchCancelFlowUrlRequest {
5663
5646
  /**
5664
- * 调用方用户信息,userId 必填
5647
+ * 执行本接口操作的员工信息。
5648
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5665
5649
  */
5666
5650
  Operator: UserInfo;
5667
5651
  /**
5668
5652
  * 需要执行撤回的流程(合同)的编号列表,最多100个.
5669
- 列表中的流程(合同)编号不要重复.
5653
+ <br>列表中的流程(合同)编号不要重复.
5670
5654
  */
5671
5655
  FlowIds: Array<string>;
5672
5656
  /**
5673
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5674
-
5657
+ * 代理企业和员工的信息。
5658
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5675
5659
  */
5676
5660
  Agent?: Agent;
5677
5661
  }
@@ -3605,9 +3605,16 @@ export interface ChannelDescribeOrganizationSealsResponse {
3605
3605
  */
3606
3606
  export interface CreateSealByImageResponse {
3607
3607
  /**
3608
- * 印章id
3608
+ * 电子印章ID,为32位字符串。
3609
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
3610
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
3609
3611
  */
3610
3612
  SealId?: string;
3613
+ /**
3614
+ * 电子印章预览链接地址,地址默认失效时间为24小时。
3615
+ 注意:此字段可能返回 null,表示取不到有效值。
3616
+ */
3617
+ ImageUrl?: string;
3611
3618
  /**
3612
3619
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3613
3620
  */
@@ -4497,7 +4504,8 @@ export interface DescribeChannelFlowEvidenceReportResponse {
4497
4504
  */
4498
4505
  export interface CreateSealByImageRequest {
4499
4506
  /**
4500
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4507
+ * 代理企业和员工的信息。
4508
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4501
4509
  */
4502
4510
  Agent: Agent;
4503
4511
  /**
@@ -4507,12 +4515,46 @@ export interface CreateSealByImageRequest {
4507
4515
  /**
4508
4516
  * 印章图片base64,大小不超过10M(原始图片不超过7.6M)
4509
4517
  */
4510
- SealImage: string;
4518
+ SealImage?: string;
4511
4519
  /**
4512
4520
  * 操作者的信息
4513
4521
  * @deprecated
4514
4522
  */
4515
4523
  Operator?: UserInfo;
4524
+ /**
4525
+ * 本接口支持上传图片印章及系统直接生成印章; 如果要使用系统生成印章,此值传:SealGenerateSourceSystem; 如果要使用图片上传请传字段 SealImage
4526
+ */
4527
+ GenerateSource?: string;
4528
+ /**
4529
+ * 电子印章类型:
4530
+ <ul><li>OFFICIAL-公章</li>
4531
+ <li>CONTRACT-合同专用章;</li>
4532
+ <li>FINANCE-合财务专用章;</li>
4533
+ <li>PERSONNEL-人事专用章
4534
+ </li>
4535
+ <li>默认:OFFICIAL</li>
4536
+ <ul>
4537
+ */
4538
+ SealType?: string;
4539
+ /**
4540
+ * 企业印章横向文字,最多可填15个汉字(若超过印章最大宽度,优先压缩字间距,其次缩小字号
4541
+ */
4542
+ SealHorizontalText?: string;
4543
+ /**
4544
+ * 印章样式:
4545
+
4546
+ <ul><li>cycle:圆形印章</li>
4547
+ <li>ellipse:椭圆印章</li>
4548
+ <li> 注:默认圆形印章</li></ul>
4549
+ */
4550
+ SealStyle?: string;
4551
+ /**
4552
+ * 印章尺寸取值描述:<ul><li> 42_42 圆形企业公章直径42mm</li>
4553
+ <li> 40_40 圆形企业印章直径40mm</li>
4554
+ <li> 45_30 椭圆形印章45mm x 30mm</li>
4555
+ </ul>
4556
+ */
4557
+ SealSize?: string;
4516
4558
  }
4517
4559
  /**
4518
4560
  * ChannelDescribeUserAutoSignStatus返回参数结构体
@@ -230,6 +230,7 @@ export { vrs } from "./vrs";
230
230
  export { waf } from "./waf";
231
231
  export { wav } from "./wav";
232
232
  export { wedata } from "./wedata";
233
+ export { weilingwith } from "./weilingwith";
233
234
  export { wss } from "./wss";
234
235
  export { yinsuda } from "./yinsuda";
235
236
  export { youmall } from "./youmall";
@@ -464,6 +464,8 @@ var wav_1 = require("./wav");
464
464
  Object.defineProperty(exports, "wav", { enumerable: true, get: function () { return wav_1.wav; } });
465
465
  var wedata_1 = require("./wedata");
466
466
  Object.defineProperty(exports, "wedata", { enumerable: true, get: function () { return wedata_1.wedata; } });
467
+ var weilingwith_1 = require("./weilingwith");
468
+ Object.defineProperty(exports, "weilingwith", { enumerable: true, get: function () { return weilingwith_1.weilingwith; } });
467
469
  var wss_1 = require("./wss");
468
470
  Object.defineProperty(exports, "wss", { enumerable: true, get: function () { return wss_1.wss; } });
469
471
  var yinsuda_1 = require("./yinsuda");
@@ -7163,6 +7163,11 @@ export interface AlarmHistory {
7163
7163
  注意:此字段可能返回 null,表示取不到有效值。
7164
7164
  */
7165
7165
  Dimensions: string;
7166
+ /**
7167
+ * 告警等级
7168
+ 注意:此字段可能返回 null,表示取不到有效值。
7169
+ */
7170
+ AlarmLevel?: string;
7166
7171
  }
7167
7172
  /**
7168
7173
  * 与腾讯云可观测平台融合托管 Prometheus 实例,关联集群基础信息
@@ -12,7 +12,8 @@ export declare class Client extends AbstractClient {
12
12
  */
13
13
  ImageToClass(req: ImageToClassRequest, cb?: (error: string, rep: ImageToClassResponse) => void): Promise<ImageToClassResponse>;
14
14
  /**
15
- * 将PDF格式的体检报告文件结构化,解析关键信息.
15
+ * 将PDF格式的体检报告文件结构化,解析关键信息。
16
+ 注意:该接口是按照体检报告 PDF 页面数量统计次数,不是按照 PDF 文件数量统计次数。通过该接口传入的报告必须是体检报告,非体检报告可能无法正确解析。
16
17
  */
17
18
  TurnPDFToObject(req: TurnPDFToObjectRequest, cb?: (error: string, rep: TurnPDFToObjectResponse) => void): Promise<TurnPDFToObjectResponse>;
18
19
  /**
@@ -34,7 +34,8 @@ class Client extends abstract_client_1.AbstractClient {
34
34
  return this.request("ImageToClass", req, cb);
35
35
  }
36
36
  /**
37
- * 将PDF格式的体检报告文件结构化,解析关键信息.
37
+ * 将PDF格式的体检报告文件结构化,解析关键信息。
38
+ 注意:该接口是按照体检报告 PDF 页面数量统计次数,不是按照 PDF 文件数量统计次数。通过该接口传入的报告必须是体检报告,非体检报告可能无法正确解析。
38
39
  */
39
40
  async TurnPDFToObject(req, cb) {
40
41
  return this.request("TurnPDFToObject", req, cb);