tencentcloud-sdk-nodejs 4.0.688 → 4.0.689

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 (80) hide show
  1. package/CHANGELOG.md +264 -0
  2. package/SERVICE_CHANGELOG.md +381 -364
  3. package/package.json +1 -1
  4. package/products.md +19 -19
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cvm/v20170312/cvm_client.ts +6 -3
  7. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  8. package/src/services/cynosdb/v20190107/cynosdb_client.ts +8 -6
  9. package/src/services/cynosdb/v20190107/cynosdb_models.ts +190 -74
  10. package/src/services/dlc/v20210125/dlc_client.ts +13 -1
  11. package/src/services/dlc/v20210125/dlc_models.ts +80 -39
  12. package/src/services/es/v20180416/es_models.ts +5 -5
  13. package/src/services/ess/v20201111/ess_client.ts +43 -43
  14. package/src/services/ess/v20201111/ess_models.ts +102 -124
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +52 -3
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +203 -9
  17. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  18. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -19
  19. package/src/services/mongodb/v20190725/mongodb_models.ts +46 -46
  20. package/src/services/monitor/v20180724/monitor_models.ts +6 -2
  21. package/src/services/nlp/v20190408/nlp_client.ts +0 -17
  22. package/src/services/nlp/v20190408/nlp_models.ts +0 -117
  23. package/src/services/omics/v20221128/omics_models.ts +1 -1
  24. package/src/services/postgres/v20170312/postgres_models.ts +33 -30
  25. package/src/services/ssa/v20180608/ssa_client.ts +16 -3
  26. package/src/services/ssa/v20180608/ssa_models.ts +94 -24
  27. package/src/services/ssl/v20191205/ssl_client.ts +26 -2
  28. package/src/services/ssl/v20191205/ssl_models.ts +64 -16
  29. package/src/services/vod/v20180717/vod_client.ts +3 -9
  30. package/src/services/vod/v20180717/vod_models.ts +243 -239
  31. package/src/services/vpc/v20170312/vpc_models.ts +40 -22
  32. package/src/services/waf/v20180125/waf_client.ts +41 -26
  33. package/src/services/waf/v20180125/waf_models.ts +212 -45
  34. package/tencentcloud/common/sdk_version.d.ts +1 -1
  35. package/tencentcloud/common/sdk_version.js +1 -1
  36. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -0
  37. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -0
  38. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  39. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -5
  40. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +4 -4
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +185 -71
  42. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  43. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  44. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +78 -39
  45. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -5
  46. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +36 -27
  47. package/tencentcloud/services/ess/v20201111/ess_client.js +36 -29
  48. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +102 -121
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -3
  50. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -2
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +195 -9
  52. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  53. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -19
  54. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +46 -46
  55. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +6 -2
  56. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -7
  57. package/tencentcloud/services/nlp/v20190408/nlp_client.js +0 -8
  58. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +0 -112
  59. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +1 -1
  60. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +33 -30
  61. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  62. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  63. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +91 -24
  64. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +9 -1
  65. package/tencentcloud/services/ssl/v20191205/ssl_client.js +12 -0
  66. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +60 -16
  67. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -7
  68. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -7
  69. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +243 -239
  70. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +40 -22
  71. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -9
  72. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -12
  73. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +207 -45
  74. package/test/dlc.v20210125.test.js +10 -0
  75. package/test/ess.v20201111.test.js +2 -12
  76. package/test/essbasic.v20210526.test.js +30 -0
  77. package/test/nlp.v20190408.test.js +0 -10
  78. package/test/ssa.v20180608.test.js +10 -0
  79. package/test/ssl.v20191205.test.js +20 -0
  80. package/test/waf.v20180125.test.js +18 -8
@@ -1777,57 +1777,30 @@ export interface KVPair {
1777
1777
  Value: string;
1778
1778
  }
1779
1779
  /**
1780
- * 数据表配置信息
1780
+ * QueryResult返回参数结构体
1781
1781
  */
1782
- export interface TableBaseInfo {
1783
- /**
1784
- * 该数据表所属数据库名字
1785
- */
1786
- DatabaseName: string;
1787
- /**
1788
- * 数据表名字
1789
- */
1790
- TableName: string;
1791
- /**
1792
- * 该数据表所属数据源名字
1793
- 注意:此字段可能返回 null,表示取不到有效值。
1794
- */
1795
- DatasourceConnectionName?: string;
1796
- /**
1797
- * 该数据表备注
1798
- 注意:此字段可能返回 null,表示取不到有效值。
1799
- */
1800
- TableComment?: string;
1801
- /**
1802
- * 具体类型,表or视图
1803
- 注意:此字段可能返回 null,表示取不到有效值。
1804
- */
1805
- Type?: string;
1782
+ export interface QueryResultResponse {
1806
1783
  /**
1807
- * 数据格式类型,hive,iceberg等
1808
- 注意:此字段可能返回 null,表示取不到有效值。
1784
+ * 任务Id
1809
1785
  */
1810
- TableFormat?: string;
1786
+ TaskId: string;
1811
1787
  /**
1812
- * 建表用户昵称
1813
- 注意:此字段可能返回 null,表示取不到有效值。
1788
+ * 结果数据
1814
1789
  */
1815
- UserAlias?: string;
1790
+ ResultSet: string;
1816
1791
  /**
1817
- * 建表用户ID
1818
- 注意:此字段可能返回 null,表示取不到有效值。
1792
+ * schema
1819
1793
  */
1820
- UserSubUin?: string;
1794
+ ResultSchema: Array<Column>;
1821
1795
  /**
1822
- * 数据治理配置项
1796
+ * 分页信息
1823
1797
  注意:此字段可能返回 null,表示取不到有效值。
1824
1798
  */
1825
- GovernPolicy?: DataGovernPolicy;
1799
+ NextToken: string;
1826
1800
  /**
1827
- * 库数据治理是否关闭,关闭:true,开启:false
1828
- 注意:此字段可能返回 null,表示取不到有效值。
1801
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1829
1802
  */
1830
- DbGovernPolicyIsDisable?: string;
1803
+ RequestId?: string;
1831
1804
  }
1832
1805
  /**
1833
1806
  * UnlockMetaData请求参数结构体
@@ -2420,6 +2393,19 @@ export interface Partition {
2420
2393
  */
2421
2394
  CreateTime: number;
2422
2395
  }
2396
+ /**
2397
+ * QueryResult请求参数结构体
2398
+ */
2399
+ export interface QueryResultRequest {
2400
+ /**
2401
+ * 任务ID
2402
+ */
2403
+ TaskId: string;
2404
+ /**
2405
+ * lastReadFile为上一次读取的文件,lastReadOffset为上一次读取到的位置
2406
+ */
2407
+ NextToken?: string;
2408
+ }
2423
2409
  /**
2424
2410
  * CreateDataEngine请求参数结构体
2425
2411
  */
@@ -3022,6 +3008,59 @@ export interface CancelNotebookSessionStatementResponse {
3022
3008
  */
3023
3009
  RequestId?: string;
3024
3010
  }
3011
+ /**
3012
+ * 数据表配置信息
3013
+ */
3014
+ export interface TableBaseInfo {
3015
+ /**
3016
+ * 该数据表所属数据库名字
3017
+ */
3018
+ DatabaseName: string;
3019
+ /**
3020
+ * 数据表名字
3021
+ */
3022
+ TableName: string;
3023
+ /**
3024
+ * 该数据表所属数据源名字
3025
+ 注意:此字段可能返回 null,表示取不到有效值。
3026
+ */
3027
+ DatasourceConnectionName?: string;
3028
+ /**
3029
+ * 该数据表备注
3030
+ 注意:此字段可能返回 null,表示取不到有效值。
3031
+ */
3032
+ TableComment?: string;
3033
+ /**
3034
+ * 具体类型,表or视图
3035
+ 注意:此字段可能返回 null,表示取不到有效值。
3036
+ */
3037
+ Type?: string;
3038
+ /**
3039
+ * 数据格式类型,hive,iceberg等
3040
+ 注意:此字段可能返回 null,表示取不到有效值。
3041
+ */
3042
+ TableFormat?: string;
3043
+ /**
3044
+ * 建表用户昵称
3045
+ 注意:此字段可能返回 null,表示取不到有效值。
3046
+ */
3047
+ UserAlias?: string;
3048
+ /**
3049
+ * 建表用户ID
3050
+ 注意:此字段可能返回 null,表示取不到有效值。
3051
+ */
3052
+ UserSubUin?: string;
3053
+ /**
3054
+ * 数据治理配置项
3055
+ 注意:此字段可能返回 null,表示取不到有效值。
3056
+ */
3057
+ GovernPolicy?: DataGovernPolicy;
3058
+ /**
3059
+ * 库数据治理是否关闭,关闭:true,开启:false
3060
+ 注意:此字段可能返回 null,表示取不到有效值。
3061
+ */
3062
+ DbGovernPolicyIsDisable?: string;
3063
+ }
3025
3064
  /**
3026
3065
  * DMSTable基本信息
3027
3066
  */
@@ -845,7 +845,7 @@ export interface DescribeIndexMetaResponse {
845
845
  * 索引元数据字段
846
846
  注意:此字段可能返回 null,表示取不到有效值。
847
847
  */
848
- IndexMetaField: IndexMetaField;
848
+ IndexMetaField?: IndexMetaField;
849
849
  /**
850
850
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
851
851
  */
@@ -1038,7 +1038,7 @@ export interface CreateIndexRequest {
1038
1038
  */
1039
1039
  IndexName: string;
1040
1040
  /**
1041
- * 创建的索引元数据JSON,如mappings、settings
1041
+ * 【必填】创建的索引元数据JSON,如mappings、settings
1042
1042
  */
1043
1043
  IndexMetaJson?: string;
1044
1044
  /**
@@ -1230,12 +1230,12 @@ export interface DescribeIndexListResponse {
1230
1230
  * 索引元数据字段
1231
1231
  注意:此字段可能返回 null,表示取不到有效值。
1232
1232
  */
1233
- IndexMetaFields: Array<IndexMetaField>;
1233
+ IndexMetaFields?: Array<IndexMetaField>;
1234
1234
  /**
1235
1235
  * 查询总数
1236
1236
  注意:此字段可能返回 null,表示取不到有效值。
1237
1237
  */
1238
- TotalCount: number;
1238
+ TotalCount?: number;
1239
1239
  /**
1240
1240
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1241
1241
  */
@@ -1472,7 +1472,7 @@ export interface DescribeIndexListRequest {
1472
1472
  */
1473
1473
  IndexStatusList?: Array<string>;
1474
1474
  /**
1475
- * 排序顺序,支持asc、desc
1475
+ * 排序顺序,支持asc、desc,默认为desc 数据格式"asc","desc"
1476
1476
  */
1477
1477
  Order?: string;
1478
1478
  }
@@ -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, 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";
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, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, 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, 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
@@ -77,7 +77,14 @@ export declare class Client extends AbstractClient {
77
77
  */
78
78
  CreateIntegrationRole(req: CreateIntegrationRoleRequest, cb?: (error: string, rep: CreateIntegrationRoleResponse) => void): Promise<CreateIntegrationRoleResponse>;
79
79
  /**
80
- * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
80
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
81
+ 1. 创建印章
82
+ 2. 创建模板
83
+ 3. 修改模板
84
+ 4. 预览模板
85
+ 5. 预览合同流程
86
+
87
+ 用户可以通过这些链接快速将其集成到自己的系统中。
81
88
  */
82
89
  CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
83
90
  /**
@@ -107,12 +114,13 @@ export declare class Client extends AbstractClient {
107
114
  */
108
115
  CreatePreparedPersonalEsign(req: CreatePreparedPersonalEsignRequest, cb?: (error: string, rep: CreatePreparedPersonalEsignResponse) => void): Promise<CreatePreparedPersonalEsignResponse>;
109
116
  /**
110
- * ### 适用场景
111
- 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
112
- 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
113
- ### 限制条件
114
- - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
115
- - 他方企业仅支持通过姓名+手机号补充
117
+ * 适用场景:
118
+ 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
119
+
120
+ 限制条件:
121
+ 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
122
+ 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
123
+ 3. 他方企业仅支持通过姓名+手机号进行补充。
116
124
  */
117
125
  CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
118
126
  /**
@@ -120,17 +128,7 @@ export declare class Client extends AbstractClient {
120
128
  */
121
129
  ModifyIntegrationDepartment(req: ModifyIntegrationDepartmentRequest, cb?: (error: string, rep: ModifyIntegrationDepartmentResponse) => void): Promise<ModifyIntegrationDepartmentResponse>;
122
130
  /**
123
- * 通过此接口可以关闭个人用户自动签功能。
124
- 无需对应的用户刷脸等方式同意即可关闭。
125
-
126
- 注意:
127
-
128
- <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
129
- <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
130
- */
131
- DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
132
- /**
133
- * 解绑员工与对应角色关系
131
+ * 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
134
132
  */
135
133
  DeleteIntegrationRoleUsers(req: DeleteIntegrationRoleUsersRequest, cb?: (error: string, rep: DeleteIntegrationRoleUsersResponse) => void): Promise<DeleteIntegrationRoleUsersResponse>;
136
134
  /**
@@ -212,8 +210,9 @@ export declare class Client extends AbstractClient {
212
210
  */
213
211
  DescribeUserAutoSignStatus(req: DescribeUserAutoSignStatusRequest, cb?: (error: string, rep: DescribeUserAutoSignStatusResponse) => void): Promise<DescribeUserAutoSignStatusResponse>;
214
212
  /**
215
- * 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
216
- 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
213
+ * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
214
+
215
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
217
216
  */
218
217
  CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
219
218
  /**
@@ -259,7 +258,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
259
258
  */
260
259
  CreateSeal(req: CreateSealRequest, cb?: (error: string, rep: CreateSealResponse) => void): Promise<CreateSealResponse>;
261
260
  /**
262
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
261
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
262
+
263
+ 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
263
264
  */
264
265
  DescribeIntegrationRoles(req: DescribeIntegrationRolesRequest, cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void): Promise<DescribeIntegrationRolesResponse>;
265
266
  /**
@@ -299,7 +300,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
299
300
 
300
301
  ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
301
302
 
302
- 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
303
+ 注:
304
+ <ul>
305
+ <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
306
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
307
+ </ul>
303
308
  */
304
309
  CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
305
310
  /**
@@ -321,7 +326,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
321
326
  */
322
327
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
323
328
  /**
324
- * 绑定员工与对应角色
329
+ * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
325
330
  */
326
331
  CreateIntegrationUserRoles(req: CreateIntegrationUserRolesRequest, cb?: (error: string, rep: CreateIntegrationUserRolesResponse) => void): Promise<CreateIntegrationUserRolesResponse>;
327
332
  /**
@@ -363,11 +368,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
363
368
  */
364
369
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
365
370
  /**
366
- * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
371
+ * 通过此接口可以关闭个人用户自动签功能。
372
+ 无需对应的用户刷脸等方式同意即可关闭。
373
+
374
+ 注意:
367
375
 
368
- 通过子企业影子账号查询主企业员工账号
376
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
377
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
369
378
  */
370
- DescribeIntegrationMainOrganizationUser(req: DescribeIntegrationMainOrganizationUserRequest, cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void): Promise<DescribeIntegrationMainOrganizationUserResponse>;
379
+ DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
371
380
  /**
372
381
  * 通过AuthCode查询个人用户是否实名
373
382
 
@@ -115,7 +115,14 @@ class Client extends abstract_client_1.AbstractClient {
115
115
  return this.request("CreateIntegrationRole", req, cb);
116
116
  }
117
117
  /**
118
- * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
118
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
119
+ 1. 创建印章
120
+ 2. 创建模板
121
+ 3. 修改模板
122
+ 4. 预览模板
123
+ 5. 预览合同流程
124
+
125
+ 用户可以通过这些链接快速将其集成到自己的系统中。
119
126
  */
120
127
  async CreateEmbedWebUrl(req, cb) {
121
128
  return this.request("CreateEmbedWebUrl", req, cb);
@@ -159,12 +166,13 @@ class Client extends abstract_client_1.AbstractClient {
159
166
  return this.request("CreatePreparedPersonalEsign", req, cb);
160
167
  }
161
168
  /**
162
- * ### 适用场景
163
- 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
164
- 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
165
- ### 限制条件
166
- - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
167
- - 他方企业仅支持通过姓名+手机号补充
169
+ * 适用场景:
170
+ 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
171
+
172
+ 限制条件:
173
+ 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
174
+ 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
175
+ 3. 他方企业仅支持通过姓名+手机号进行补充。
168
176
  */
169
177
  async CreateFlowApprovers(req, cb) {
170
178
  return this.request("CreateFlowApprovers", req, cb);
@@ -176,19 +184,7 @@ class Client extends abstract_client_1.AbstractClient {
176
184
  return this.request("ModifyIntegrationDepartment", req, cb);
177
185
  }
178
186
  /**
179
- * 通过此接口可以关闭个人用户自动签功能。
180
- 无需对应的用户刷脸等方式同意即可关闭。
181
-
182
- 注意:
183
-
184
- <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
185
- <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
186
- */
187
- async DisableUserAutoSign(req, cb) {
188
- return this.request("DisableUserAutoSign", req, cb);
189
- }
190
- /**
191
- * 解绑员工与对应角色关系
187
+ * 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
192
188
  */
193
189
  async DeleteIntegrationRoleUsers(req, cb) {
194
190
  return this.request("DeleteIntegrationRoleUsers", req, cb);
@@ -288,8 +284,9 @@ class Client extends abstract_client_1.AbstractClient {
288
284
  return this.request("DescribeUserAutoSignStatus", req, cb);
289
285
  }
290
286
  /**
291
- * 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
292
- 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
287
+ * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
288
+
289
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
293
290
  */
294
291
  async CreateFlowGroupByTemplates(req, cb) {
295
292
  return this.request("CreateFlowGroupByTemplates", req, cb);
@@ -347,7 +344,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
347
344
  return this.request("CreateSeal", req, cb);
348
345
  }
349
346
  /**
350
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
347
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
348
+
349
+ 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
351
350
  */
352
351
  async DescribeIntegrationRoles(req, cb) {
353
352
  return this.request("DescribeIntegrationRoles", req, cb);
@@ -399,7 +398,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
399
398
 
400
399
  ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
401
400
 
402
- 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
401
+ 注:
402
+ <ul>
403
+ <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
404
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
405
+ </ul>
403
406
  */
404
407
  async CreatePersonAuthCertificateImage(req, cb) {
405
408
  return this.request("CreatePersonAuthCertificateImage", req, cb);
@@ -427,7 +430,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
427
430
  return this.request("DescribeFlowBriefs", req, cb);
428
431
  }
429
432
  /**
430
- * 绑定员工与对应角色
433
+ * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
431
434
  */
432
435
  async CreateIntegrationUserRoles(req, cb) {
433
436
  return this.request("CreateIntegrationUserRoles", req, cb);
@@ -481,12 +484,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
481
484
  return this.request("DescribeFlowComponents", req, cb);
482
485
  }
483
486
  /**
484
- * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
487
+ * 通过此接口可以关闭个人用户自动签功能。
488
+ 无需对应的用户刷脸等方式同意即可关闭。
489
+
490
+ 注意:
485
491
 
486
- 通过子企业影子账号查询主企业员工账号
492
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
493
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
487
494
  */
488
- async DescribeIntegrationMainOrganizationUser(req, cb) {
489
- return this.request("DescribeIntegrationMainOrganizationUser", req, cb);
495
+ async DisableUserAutoSign(req, cb) {
496
+ return this.request("DisableUserAutoSign", req, cb);
490
497
  }
491
498
  /**
492
499
  * 通过AuthCode查询个人用户是否实名