tencentcloud-sdk-nodejs 4.0.668 → 4.0.669

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 (43) hide show
  1. package/CHANGELOG.md +155 -0
  2. package/SERVICE_CHANGELOG.md +192 -100
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdn/v20180606/cdn_models.ts +4 -0
  7. package/src/services/cynosdb/v20190107/cynosdb_models.ts +15 -11
  8. package/src/services/dts/v20211206/dts_client.ts +30 -6
  9. package/src/services/dts/v20211206/dts_models.ts +80 -0
  10. package/src/services/ess/v20201111/ess_models.ts +29 -5
  11. package/src/services/essbasic/v20210526/essbasic_client.ts +14 -6
  12. package/src/services/essbasic/v20210526/essbasic_models.ts +64 -14
  13. package/src/services/nlp/v20190408/nlp_client.ts +1 -1
  14. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  15. package/src/services/tcb/v20180608/tcb_models.ts +19 -14
  16. package/src/services/tdmq/v20200217/tdmq_models.ts +1 -1
  17. package/src/services/tse/v20201207/tse_client.ts +152 -33
  18. package/src/services/tse/v20201207/tse_models.ts +792 -121
  19. package/src/services/tts/v20190823/tts_client.ts +0 -1
  20. package/tencentcloud/common/sdk_version.d.ts +1 -1
  21. package/tencentcloud/common/sdk_version.js +1 -1
  22. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +4 -0
  23. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +15 -11
  24. package/tencentcloud/services/dts/v20211206/dts_client.d.ts +11 -3
  25. package/tencentcloud/services/dts/v20211206/dts_client.js +15 -3
  26. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +76 -0
  27. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +29 -5
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -5
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -5
  30. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +64 -14
  31. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -1
  32. package/tencentcloud/services/nlp/v20190408/nlp_client.js +1 -1
  33. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  34. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  35. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +19 -14
  36. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +1 -1
  37. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +45 -9
  38. package/tencentcloud/services/tse/v20201207/tse_client.js +66 -12
  39. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +770 -128
  40. package/tencentcloud/services/tts/v20190823/tts_client.d.ts +0 -1
  41. package/tencentcloud/services/tts/v20190823/tts_client.js +0 -1
  42. package/test/dts.v20211206.test.js +22 -2
  43. package/test/tse.v20201207.test.js +98 -8
@@ -81,7 +81,6 @@ export class Client extends AbstractClient {
81
81
  /**
82
82
  * 腾讯云语音合成技术(TTS)可以将任意文本转化为语音,实现让机器和应用张口说话。
83
83
  腾讯TTS技术可以应用到很多场景,比如,移动APP语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。
84
- 内测期间免费使用。
85
84
  基础合成支持 SSML,语法详见 [SSML 标记语言](https://cloud.tencent.com/document/product/1073/49575)。
86
85
  默认接口请求频率限制:20次/秒。
87
86
  */
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.668";
1
+ export declare const sdkVersion = "4.0.669";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.668";
4
+ exports.sdkVersion = "4.0.669";
@@ -1433,10 +1433,12 @@ export interface HeuristicCache {
1433
1433
  * 启发式缓存配置开关,取值有:
1434
1434
  on:开启
1435
1435
  off:关闭
1436
+ 注意:此字段可能返回 null,表示取不到有效值。
1436
1437
  */
1437
1438
  Switch: string;
1438
1439
  /**
1439
1440
  * 自定义启发式缓存时间配置
1441
+ 注意:此字段可能返回 null,表示取不到有效值。
1440
1442
  */
1441
1443
  CacheConfig?: CacheConfig;
1442
1444
  }
@@ -4491,10 +4493,12 @@ export interface CacheConfig {
4491
4493
  * 启发式自定义时间缓存配置开关,取值有:
4492
4494
  on:开启
4493
4495
  off:关闭
4496
+ 注意:此字段可能返回 null,表示取不到有效值。
4494
4497
  */
4495
4498
  HeuristicCacheTimeSwitch: string;
4496
4499
  /**
4497
4500
  * 单位 秒.
4501
+ 注意:此字段可能返回 null,表示取不到有效值。
4498
4502
  */
4499
4503
  HeuristicCacheTime: number;
4500
4504
  }
@@ -2060,7 +2060,7 @@ export interface DescribeResourcesByDealNameResponse {
2060
2060
  /**
2061
2061
  * 计费资源id信息数组
2062
2062
  */
2063
- BillingResourceInfos: Array<BillingResourceInfo>;
2063
+ BillingResourceInfos?: Array<BillingResourceInfo>;
2064
2064
  /**
2065
2065
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2066
2066
  */
@@ -5758,43 +5758,47 @@ export interface ProxyNodeInfo {
5758
5758
  /**
5759
5759
  * 数据库代理节点ID
5760
5760
  */
5761
- ProxyNodeId: string;
5761
+ ProxyNodeId?: string;
5762
5762
  /**
5763
5763
  * 节点当前连接数, DescribeProxyNodes接口此字段值不返回
5764
5764
  */
5765
- ProxyNodeConnections: number;
5765
+ ProxyNodeConnections?: number;
5766
5766
  /**
5767
5767
  * 数据库代理节点cpu
5768
5768
  */
5769
- Cpu: number;
5769
+ Cpu?: number;
5770
5770
  /**
5771
5771
  * 数据库代理节点内存
5772
5772
  */
5773
- Mem: number;
5773
+ Mem?: number;
5774
5774
  /**
5775
5775
  * 数据库代理节点状态
5776
5776
  */
5777
- Status: string;
5777
+ Status?: string;
5778
5778
  /**
5779
5779
  * 数据库代理组ID
5780
5780
  */
5781
- ProxyGroupId: string;
5781
+ ProxyGroupId?: string;
5782
5782
  /**
5783
5783
  * 集群ID
5784
5784
  */
5785
- ClusterId: string;
5785
+ ClusterId?: string;
5786
5786
  /**
5787
5787
  * 用户AppID
5788
5788
  */
5789
- AppId: number;
5789
+ AppId?: number;
5790
5790
  /**
5791
5791
  * 地域
5792
5792
  */
5793
- Region: string;
5793
+ Region?: string;
5794
5794
  /**
5795
5795
  * 可用区
5796
5796
  */
5797
- Zone: string;
5797
+ Zone?: string;
5798
+ /**
5799
+ * 数据库代理节点名字
5800
+ */
5801
+ OssProxyNodeName?: string;
5798
5802
  }
5799
5803
  /**
5800
5804
  * OfflineCluster返回参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { ModifyCompareTaskResponse, DescribeSyncJobsResponse, ModifyMigrationJobResponse, ModifyMigrateJobSpecRequest, StartMigrateJobRequest, DestroyMigrateJobRequest, SkipCheckItemResponse, IsolateMigrateJobRequest, ResizeSyncJobResponse, ResumeMigrateJobResponse, CreateModifyCheckSyncJobRequest, IsolateSyncJobRequest, PauseMigrateJobRequest, ContinueMigrateJobRequest, DescribeCheckSyncJobResultRequest, DestroySyncJobResponse, DescribeCompareReportResponse, StopMigrateJobResponse, ModifyCompareTaskNameRequest, CompleteMigrateJobResponse, DescribeMigrateDBInstancesResponse, CreateCheckSyncJobRequest, DescribeModifyCheckSyncJobResultResponse, StopSyncJobRequest, DescribeMigrationDetailRequest, DestroySyncJobRequest, ResizeSyncJobRequest, ResumeSyncJobResponse, ModifyCompareTaskNameResponse, StartSyncJobRequest, PauseSyncJobRequest, CreateMigrateCheckJobResponse, ModifySyncJobConfigRequest, ContinueMigrateJobResponse, CreateMigrationServiceRequest, DescribeCompareTasksRequest, RecoverSyncJobResponse, DeleteCompareTaskResponse, ContinueSyncJobResponse, CompleteMigrateJobRequest, DescribeCompareTasksResponse, StopCompareRequest, StartModifySyncJobRequest, DescribeCheckSyncJobResultResponse, StopSyncJobResponse, ModifyMigrateNameResponse, DescribeMigrationJobsResponse, ModifyMigrationJobRequest, StopCompareResponse, DestroyMigrateJobResponse, SkipSyncCheckItemRequest, DescribeModifyCheckSyncJobResultRequest, SkipSyncCheckItemResponse, IsolateSyncJobResponse, CreateMigrateCheckJobRequest, DescribeMigrationJobsRequest, ContinueSyncJobRequest, CreateMigrationServiceResponse, DescribeMigrationCheckJobResponse, CreateCheckSyncJobResponse, ConfigureSyncJobRequest, StartModifySyncJobResponse, DescribeMigrateDBInstancesRequest, ModifyCompareTaskRequest, RecoverSyncJobRequest, DescribeSyncJobsRequest, ResumeSyncJobRequest, ConfigureSyncJobResponse, ResumeMigrateJobRequest, PauseSyncJobResponse, StartCompareResponse, CreateCompareTaskResponse, SkipCheckItemRequest, ModifyMigrateJobSpecResponse, CreateSyncJobResponse, CreateCompareTaskRequest, StartCompareRequest, DescribeMigrationCheckJobRequest, DescribeMigrationDetailResponse, CreateModifyCheckSyncJobResponse, ModifyMigrateNameRequest, StartSyncJobResponse, RecoverMigrateJobResponse, DeleteCompareTaskRequest, StopMigrateJobRequest, IsolateMigrateJobResponse, ModifySyncJobConfigResponse, CreateSyncJobRequest, DescribeCompareReportRequest, RecoverMigrateJobRequest, PauseMigrateJobResponse, StartMigrateJobResponse } from "./dts_models";
3
+ import { ModifyCompareTaskResponse, DescribeSyncJobsResponse, ModifyMigrationJobResponse, ModifyMigrateRateLimitResponse, ModifyMigrateJobSpecRequest, StartMigrateJobRequest, ModifySyncRateLimitResponse, DestroyMigrateJobRequest, SkipCheckItemResponse, IsolateMigrateJobRequest, ResizeSyncJobResponse, ResumeMigrateJobResponse, CreateModifyCheckSyncJobRequest, IsolateSyncJobRequest, PauseMigrateJobRequest, ContinueMigrateJobRequest, ModifySyncRateLimitRequest, DescribeCheckSyncJobResultRequest, DestroySyncJobResponse, DescribeCompareReportResponse, StopMigrateJobResponse, ModifyCompareTaskNameRequest, CompleteMigrateJobResponse, DescribeMigrateDBInstancesResponse, CreateCheckSyncJobRequest, DescribeModifyCheckSyncJobResultResponse, StopSyncJobRequest, DescribeMigrationDetailRequest, DestroySyncJobRequest, ResizeSyncJobRequest, ResumeSyncJobResponse, ModifyCompareTaskNameResponse, StartSyncJobRequest, PauseSyncJobRequest, CreateMigrateCheckJobResponse, ModifySyncJobConfigRequest, ContinueMigrateJobResponse, CreateMigrationServiceRequest, DescribeCompareTasksRequest, RecoverSyncJobResponse, DeleteCompareTaskResponse, ContinueSyncJobResponse, CompleteMigrateJobRequest, DescribeCompareTasksResponse, StopCompareRequest, StartModifySyncJobRequest, DescribeCheckSyncJobResultResponse, StopSyncJobResponse, ModifyMigrateNameResponse, DescribeMigrationJobsResponse, ModifyMigrationJobRequest, StopCompareResponse, DestroyMigrateJobResponse, SkipSyncCheckItemRequest, DescribeModifyCheckSyncJobResultRequest, SkipSyncCheckItemResponse, IsolateSyncJobResponse, CreateMigrateCheckJobRequest, DescribeMigrationJobsRequest, ContinueSyncJobRequest, CreateMigrationServiceResponse, DescribeMigrationCheckJobResponse, CreateCheckSyncJobResponse, ConfigureSyncJobRequest, StartModifySyncJobResponse, DescribeMigrateDBInstancesRequest, ModifyCompareTaskRequest, RecoverSyncJobRequest, DescribeSyncJobsRequest, ResumeSyncJobRequest, ModifyMigrateRateLimitRequest, ConfigureSyncJobResponse, ResumeMigrateJobRequest, PauseSyncJobResponse, StartCompareResponse, CreateCompareTaskResponse, SkipCheckItemRequest, ModifyMigrateJobSpecResponse, CreateSyncJobResponse, CreateCompareTaskRequest, StartCompareRequest, DescribeMigrationCheckJobRequest, DescribeMigrationDetailResponse, CreateModifyCheckSyncJobResponse, ModifyMigrateNameRequest, StartSyncJobResponse, RecoverMigrateJobResponse, DeleteCompareTaskRequest, StopMigrateJobRequest, IsolateMigrateJobResponse, ModifySyncJobConfigResponse, CreateSyncJobRequest, DescribeCompareReportRequest, RecoverMigrateJobRequest, PauseMigrateJobResponse, StartMigrateJobResponse } from "./dts_models";
4
4
  /**
5
5
  * dts client
6
6
  * @class
@@ -23,6 +23,10 @@ export declare class Client extends AbstractClient {
23
23
  * 购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。
24
24
  */
25
25
  CreateMigrationService(req: CreateMigrationServiceRequest, cb?: (error: string, rep: CreateMigrationServiceResponse) => void): Promise<CreateMigrationServiceResponse>;
26
+ /**
27
+ * 用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
28
+ */
29
+ ModifyMigrateRateLimit(req: ModifyMigrateRateLimitRequest, cb?: (error: string, rep: ModifyMigrateRateLimitResponse) => void): Promise<ModifyMigrateRateLimitResponse>;
26
30
  /**
27
31
  * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
28
32
  */
@@ -71,6 +75,10 @@ export declare class Client extends AbstractClient {
71
75
  * 配置一个同步任务
72
76
  */
73
77
  ConfigureSyncJob(req: ConfigureSyncJobRequest, cb?: (error: string, rep: ConfigureSyncJobResponse) => void): Promise<ConfigureSyncJobResponse>;
78
+ /**
79
+ * 在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
80
+ */
81
+ StartModifySyncJob(req: StartModifySyncJobRequest, cb?: (error: string, rep: StartModifySyncJobResponse) => void): Promise<StartModifySyncJobResponse>;
74
82
  /**
75
83
  * 调整同步任务规格,此接口只支持按量计费任务的调整,调用此接口后不会立即生效,后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs,获取变配后的状态。
76
84
  */
@@ -94,9 +102,9 @@ export declare class Client extends AbstractClient {
94
102
  */
95
103
  PauseSyncJob(req: PauseSyncJobRequest, cb?: (error: string, rep: PauseSyncJobResponse) => void): Promise<PauseSyncJobResponse>;
96
104
  /**
97
- * 在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
105
+ * 用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
98
106
  */
99
- StartModifySyncJob(req: StartModifySyncJobRequest, cb?: (error: string, rep: StartModifySyncJobResponse) => void): Promise<StartModifySyncJobResponse>;
107
+ ModifySyncRateLimit(req: ModifySyncRateLimitRequest, cb?: (error: string, rep: ModifySyncRateLimitResponse) => void): Promise<ModifySyncRateLimitResponse>;
100
108
  /**
101
109
  * 启动一致性校验任务,启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务,启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态
102
110
  */
@@ -51,6 +51,12 @@ class Client extends abstract_client_1.AbstractClient {
51
51
  async CreateMigrationService(req, cb) {
52
52
  return this.request("CreateMigrationService", req, cb);
53
53
  }
54
+ /**
55
+ * 用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
56
+ */
57
+ async ModifyMigrateRateLimit(req, cb) {
58
+ return this.request("ModifyMigrateRateLimit", req, cb);
59
+ }
54
60
  /**
55
61
  * 隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。
56
62
  */
@@ -123,6 +129,12 @@ class Client extends abstract_client_1.AbstractClient {
123
129
  async ConfigureSyncJob(req, cb) {
124
130
  return this.request("ConfigureSyncJob", req, cb);
125
131
  }
132
+ /**
133
+ * 在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
134
+ */
135
+ async StartModifySyncJob(req, cb) {
136
+ return this.request("StartModifySyncJob", req, cb);
137
+ }
126
138
  /**
127
139
  * 调整同步任务规格,此接口只支持按量计费任务的调整,调用此接口后不会立即生效,后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs,获取变配后的状态。
128
140
  */
@@ -156,10 +168,10 @@ class Client extends abstract_client_1.AbstractClient {
156
168
  return this.request("PauseSyncJob", req, cb);
157
169
  }
158
170
  /**
159
- * 在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
171
+ * 用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
160
172
  */
161
- async StartModifySyncJob(req, cb) {
162
- return this.request("StartModifySyncJob", req, cb);
173
+ async ModifySyncRateLimit(req, cb) {
174
+ return this.request("ModifySyncRateLimit", req, cb);
163
175
  }
164
176
  /**
165
177
  * 启动一致性校验任务,启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务,启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态
@@ -35,6 +35,15 @@ export interface ModifyMigrationJobResponse {
35
35
  */
36
36
  RequestId?: string;
37
37
  }
38
+ /**
39
+ * ModifyMigrateRateLimit返回参数结构体
40
+ */
41
+ export interface ModifyMigrateRateLimitResponse {
42
+ /**
43
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
44
+ */
45
+ RequestId?: string;
46
+ }
38
47
  /**
39
48
  * ModifyMigrateJobSpec请求参数结构体
40
49
  */
@@ -87,6 +96,15 @@ export interface StepTip {
87
96
  */
88
97
  SkipInfo?: string;
89
98
  }
99
+ /**
100
+ * ModifySyncRateLimit返回参数结构体
101
+ */
102
+ export interface ModifySyncRateLimitResponse {
103
+ /**
104
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
105
+ */
106
+ RequestId?: string;
107
+ }
90
108
  /**
91
109
  * DestroyMigrateJob请求参数结构体
92
110
  */
@@ -228,6 +246,35 @@ export interface ContinueMigrateJobRequest {
228
246
  */
229
247
  JobId: string;
230
248
  }
249
+ /**
250
+ * ModifySyncRateLimit请求参数结构体
251
+ */
252
+ export interface ModifySyncRateLimitRequest {
253
+ /**
254
+ * 迁移任务ID
255
+ */
256
+ JobId: string;
257
+ /**
258
+ * 同步任务全量导出线程数、有效值为 1-16
259
+ */
260
+ DumpThread?: number;
261
+ /**
262
+ * 同步任务全量导出的 Rps 限制、需要大于 0
263
+ */
264
+ DumpRps?: number;
265
+ /**
266
+ * 同步任务全量导入线程数、有效值为 1-16
267
+ */
268
+ LoadThread?: number;
269
+ /**
270
+ * 同步任务增量导入线程数、有效值为 1-128
271
+ */
272
+ SinkerThread?: number;
273
+ /**
274
+ * 同步任务全量导入的Rps
275
+ */
276
+ LoadRps?: number;
277
+ }
231
278
  /**
232
279
  * DescribeCheckSyncJobResult请求参数结构体
233
280
  */
@@ -2220,6 +2267,35 @@ export interface ResumeSyncJobRequest {
2220
2267
  */
2221
2268
  JobId: string;
2222
2269
  }
2270
+ /**
2271
+ * ModifyMigrateRateLimit请求参数结构体
2272
+ */
2273
+ export interface ModifyMigrateRateLimitRequest {
2274
+ /**
2275
+ * 迁移任务ID
2276
+ */
2277
+ JobId: string;
2278
+ /**
2279
+ * 迁移任务全量导出线程数、有效值为 1-16
2280
+ */
2281
+ DumpThread?: number;
2282
+ /**
2283
+ * 迁移全量导出的 Rps 限制、需要大于 0
2284
+ */
2285
+ DumpRps?: number;
2286
+ /**
2287
+ * 迁移任务全量导入线程数、有效值为 1-16
2288
+ */
2289
+ LoadThread?: number;
2290
+ /**
2291
+ * 迁移任务增量导入线程数、有效值为 1-128
2292
+ */
2293
+ SinkerThread?: number;
2294
+ /**
2295
+ * 全量导入Rps限制
2296
+ */
2297
+ LoadRps?: number;
2298
+ }
2223
2299
  /**
2224
2300
  * 用于一致性校验的表配置
2225
2301
  */
@@ -1525,13 +1525,19 @@ export interface BindEmployeeUserIdWithClientOpenIdRequest {
1525
1525
  */
1526
1526
  export interface DescribeIntegrationDepartmentsRequest {
1527
1527
  /**
1528
- * 操作人信息,UserId必填且需拥有组织架构管理权限
1528
+ * 执行本接口操作的员工信息。
1529
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
1529
1530
  */
1530
1531
  Operator: UserInfo;
1531
1532
  /**
1532
1533
  * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1533
1534
  */
1534
1535
  QueryType: number;
1536
+ /**
1537
+ * 代理企业和员工的信息。
1538
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1539
+ */
1540
+ Agent?: Agent;
1535
1541
  /**
1536
1542
  * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1537
1543
  */
@@ -2672,13 +2678,19 @@ export interface DescribeFlowComponentsRequest {
2672
2678
  */
2673
2679
  export interface CreateIntegrationDepartmentRequest {
2674
2680
  /**
2675
- * 操作人信息,UserId必填且需拥有组织架构管理权限
2681
+ * 执行本接口操作的员工信息。
2682
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
2676
2683
  */
2677
2684
  Operator: UserInfo;
2678
2685
  /**
2679
2686
  * 部门名称,不超过50个字符
2680
2687
  */
2681
2688
  DeptName: string;
2689
+ /**
2690
+ * 代理企业和员工的信息。
2691
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2692
+ */
2693
+ Agent?: Agent;
2682
2694
  /**
2683
2695
  * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
2684
2696
  */
@@ -3598,7 +3610,7 @@ export interface ApproverInfo {
3598
3610
  * 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
3599
3611
  <ul><li> 个人签名/印章</li>
3600
3612
  <li> 企业印章</li>
3601
- <li> 骑缝章等签署控件</li><ul>
3613
+ <li> 骑缝章等签署控件</li></ul>
3602
3614
  */
3603
3615
  SignComponents?: Array<Component>;
3604
3616
  /**
@@ -3714,13 +3726,19 @@ export interface CreateFlowSignReviewResponse {
3714
3726
  */
3715
3727
  export interface ModifyIntegrationDepartmentRequest {
3716
3728
  /**
3717
- * 操作人信息,UserId必填且需拥有组织架构管理权限
3729
+ * 执行本接口操作的员工信息。
3730
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
3718
3731
  */
3719
3732
  Operator: UserInfo;
3720
3733
  /**
3721
3734
  * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
3722
3735
  */
3723
3736
  DeptId: string;
3737
+ /**
3738
+ * 代理企业和员工的信息。
3739
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3740
+ */
3741
+ Agent?: Agent;
3724
3742
  /**
3725
3743
  * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
3726
3744
  */
@@ -4092,13 +4110,19 @@ export interface CancelMultiFlowSignQRCodeRequest {
4092
4110
  */
4093
4111
  export interface DeleteIntegrationDepartmentRequest {
4094
4112
  /**
4095
- * 操作人信息,UserId必填且需拥有组织架构管理权限
4113
+ * 执行本接口操作的员工信息。
4114
+ 注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
4096
4115
  */
4097
4116
  Operator: UserInfo;
4098
4117
  /**
4099
4118
  * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4100
4119
  */
4101
4120
  DeptId: string;
4121
+ /**
4122
+ * 代理企业和员工的信息。
4123
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4124
+ */
4125
+ Agent?: Agent;
4102
4126
  /**
4103
4127
  * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4104
4128
  */
@@ -130,10 +130,16 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
130
130
  */
131
131
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
132
132
  /**
133
- * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
134
- 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
135
- 若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
136
- 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
133
+ * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
134
+ 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下:
135
+ 1. 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。
136
+ 2. 若子客企业已激活,员工未激活,则会进入经办人激活流程。
137
+ 3. 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
138
+
139
+ 如果是企业激活流程,需要注意如下情况:
140
+
141
+ 1. 若在激活过程中,更换用户OpenID重新生成链接,之前的认证会被清理。因此不要在认证过程中多人同时操作,导致认证过程互相影响。
142
+ 2. 若您认证中发现信息有误需要重新认证,可以通过更换OpenID重新生成链接的方式,来清理掉已有的流程。
137
143
  */
138
144
  CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
139
145
  /**
@@ -268,7 +274,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
268
274
  */
269
275
  ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
270
276
  /**
271
- * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
277
+ * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
278
+ 1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
279
+ 2. 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
272
280
  */
273
281
  SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
274
282
  /**
@@ -186,10 +186,16 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
186
186
  return this.request("CreateSignUrls", req, cb);
187
187
  }
188
188
  /**
189
- * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
190
- 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
191
- 若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
192
- 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
189
+ * 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。
190
+ 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下:
191
+ 1. 若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。
192
+ 2. 若子客企业已激活,员工未激活,则会进入经办人激活流程。
193
+ 3. 若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
194
+
195
+ 如果是企业激活流程,需要注意如下情况:
196
+
197
+ 1. 若在激活过程中,更换用户OpenID重新生成链接,之前的认证会被清理。因此不要在认证过程中多人同时操作,导致认证过程互相影响。
198
+ 2. 若您认证中发现信息有误需要重新认证,可以通过更换OpenID重新生成链接的方式,来清理掉已有的流程。
193
199
  */
194
200
  async CreateConsoleLoginUrl(req, cb) {
195
201
  return this.request("CreateConsoleLoginUrl", req, cb);
@@ -370,7 +376,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
370
376
  return this.request("ChannelCreateFlowReminds", req, cb);
371
377
  }
372
378
  /**
373
- * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
379
+ * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
380
+ 1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
381
+ 2. 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
374
382
  */
375
383
  async SyncProxyOrganization(req, cb) {
376
384
  return this.request("SyncProxyOrganization", req, cb);
@@ -850,18 +850,22 @@ export interface CreateConsoleLoginUrlResponse {
850
850
  /**
851
851
  * 子客企业Web控制台url注意事项:
852
852
  1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
853
- 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
854
- 3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
855
- 4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
853
+ 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接在5分钟之内有效,且只能访问一次
854
+ 3. 若企业认证完成且员工认证完成后,重新获取CHANNEL/APP的链接只要在有效期内(一年)都可以访问
855
+ 4. 此链接仅单次有效,每次登录需要需要重新创建新的链接,尽量不要做链接存储,多次使用。
856
856
  5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
857
857
  */
858
858
  ConsoleUrl?: string;
859
859
  /**
860
860
  * 子客企业是否已开通腾讯电子签,true-是,false-否
861
+ 注意:
862
+ 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码
861
863
  */
862
864
  IsActivated?: boolean;
863
865
  /**
864
- * 当前经办人是否已认证(false:未认证 true:已认证)
866
+ * 当前经办人是否已认证,true-是,false-否
867
+ 注意:
868
+ 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名
865
869
  */
866
870
  ProxyOperatorIsVerified?: boolean;
867
871
  /**
@@ -938,6 +942,14 @@ export interface SyncProxyOrganizationRequest {
938
942
  * @deprecated
939
943
  */
940
944
  Operator?: UserInfo;
945
+ /**
946
+ * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
947
+ */
948
+ ProxyLegalIdCardType?: string;
949
+ /**
950
+ * 第三方平台子客企业法人/负责人证件号
951
+ */
952
+ ProxyLegalIdCardNumber?: string;
941
953
  }
942
954
  /**
943
955
  * ChannelCreatePrepareFlow请求参数结构体
@@ -1807,38 +1819,76 @@ export interface CreateConsoleLoginUrlRequest {
1807
1819
  Agent: Agent;
1808
1820
  /**
1809
1821
  * 子客企业名称,最大长度64个字符
1822
+ 注意:
1823
+ 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
1824
+ 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
1810
1825
  */
1811
1826
  ProxyOrganizationName: string;
1827
+ /**
1828
+ * 子客企业统一社会信用代码,最大长度200个字符
1829
+ 注意:
1830
+ 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
1831
+ */
1832
+ UniformSocialCreditCode?: string;
1812
1833
  /**
1813
1834
  * 子客企业经办人的姓名,最大长度50个字符
1835
+ 注意:
1836
+ 1、若经办人已经实名,这里修改经办人名字传入将不会生效。
1837
+ 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
1814
1838
  */
1815
1839
  ProxyOperatorName?: string;
1816
1840
  /**
1817
- * PC控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
1841
+ * PC控制台登录后进入该参数指定的模块,如果不传递,将默认进入控制台首页。支持的模块包括:
1842
+ 1、DOCUMENT:合同管理模块,
1843
+ 2、TEMPLATE:企业模板管理模块,
1844
+ 3、SEAL:印章管理模块,
1845
+ 4、OPERATOR:组织管理模块,
1846
+ 默认将进入企业中心模块
1847
+ 注意:
1848
+ 1、如果EndPoint选择"CHANNEL"或"APP",该参数仅支持传递"SEAL",进入印章管理模块
1849
+ 2、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1818
1850
  */
1819
1851
  Module?: string;
1820
1852
  /**
1821
- * 控制台指定模块Id
1853
+ * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
1854
+ 根据Module参数的不同所代表的含义不同。当前支持:
1855
+ 1、如果Module="SEAL",ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
1856
+ 2、如果Module="TEMPLATE",ModuleId代表模版Id,登录链接将直接查看指定模版的详情。
1857
+ 3、如果Module="1、DOCUMENT",ModuleId代表合同Id,登录链接将直接查看指定合同的详情。
1858
+ 注意:
1859
+ 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1860
+ 2、ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到。
1822
1861
  */
1823
1862
  ModuleId?: string;
1824
1863
  /**
1825
- * 子客企业统一社会信用代码,最大长度200个字符
1826
- */
1827
- UniformSocialCreditCode?: string;
1828
- /**
1829
- * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1864
+ * 是否展示左侧菜单栏
1865
+ "ENABLE": 是,展示
1866
+ “DISABLE”: 否,不展示
1867
+ 默认值为ENABLE
1868
+ 注意:
1869
+ 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1830
1870
  */
1831
1871
  MenuStatus?: string;
1832
1872
  /**
1833
- * 链接跳转类型:"PC"-PC控制台,“CHANNEL”-H5跳转到电子签小程序;“APP”-第三方APP或小程序跳转电子签小程序,默认为PC控制台
1873
+ * 生成链接的类型:
1874
+ "PC":PC控制台链接
1875
+ "CHANNEL":H5跳转到电子签小程序链接
1876
+ "APP":第三方APP或小程序跳转电子签小程序链接
1877
+ 默认将生成PC控制台链接
1834
1878
  */
1835
1879
  Endpoint?: string;
1836
1880
  /**
1837
- * 触发自动跳转事件,仅对App类型有效,"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
1881
+ * 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
1882
+ "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
1838
1883
  */
1839
1884
  AutoJumpBackEvent?: string;
1840
1885
  /**
1841
- * 支持的授权方式,授权方式: "1" - 上传授权书认证 "2" - 法定代表人认证
1886
+ * 可选的企业授权方式:
1887
+ 1:上传授权书
1888
+ 2:转法定代表人授权
1889
+ 4:企业实名认证(信任第三方认证源)(此项仅支持单选)
1890
+ 未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不生效;选择信任第三方认证源时,请先通过“同步企业信息”接口同步信息。
1891
+ 该参数仅在企业激活场景生效
1842
1892
  */
1843
1893
  AuthorizationTypes?: Array<number>;
1844
1894
  /**
@@ -56,7 +56,7 @@ export declare class Client extends AbstractClient {
56
56
  */
57
57
  ParseWords(req: ParseWordsRequest, cb?: (error: string, rep: ParseWordsResponse) => void): Promise<ParseWordsResponse>;
58
58
  /**
59
- * 基于腾讯大模型能力,用户可以通过传入不同的参数控制生成内容的类型,并通过自然语言给模型以内容生成的指令,可以满足多种场景的文本生成需求,包括但不限于文章写作、营销文案、视频脚本、电商文案、纪要整理等(注意:当前接口为内测体验专用接口,非正式服务接口,内测期结束接口会下线或停服,届时请接入正式服务接口)
59
+ * 基于腾讯大模型能力,用户可以通过传入不同的参数控制生成内容的类型,并通过自然语言给模型以内容生成的指令,可以满足多种场景的文本生成需求,包括但不限于文章写作、营销文案、视频脚本、电商文案、纪要整理等(**注意:当前接口为内测体验专用接口,仅有获取白名单权限的客户可以测试调用,如需测试请联系商务非正式服务接口,内测期结束接口会下线或停服,届时请接入正式服务接口**)
60
60
  */
61
61
  TestingTextGeneration(req: TestingTextGenerationRequest, cb?: (error: string, rep: TestingTextGenerationResponse) => void): Promise<TestingTextGenerationResponse>;
62
62
  }
@@ -100,7 +100,7 @@ class Client extends abstract_client_1.AbstractClient {
100
100
  return this.request("ParseWords", req, cb);
101
101
  }
102
102
  /**
103
- * 基于腾讯大模型能力,用户可以通过传入不同的参数控制生成内容的类型,并通过自然语言给模型以内容生成的指令,可以满足多种场景的文本生成需求,包括但不限于文章写作、营销文案、视频脚本、电商文案、纪要整理等(注意:当前接口为内测体验专用接口,非正式服务接口,内测期结束接口会下线或停服,届时请接入正式服务接口)
103
+ * 基于腾讯大模型能力,用户可以通过传入不同的参数控制生成内容的类型,并通过自然语言给模型以内容生成的指令,可以满足多种场景的文本生成需求,包括但不限于文章写作、营销文案、视频脚本、电商文案、纪要整理等(**注意:当前接口为内测体验专用接口,仅有获取白名单权限的客户可以测试调用,如需测试请联系商务非正式服务接口,内测期结束接口会下线或停服,届时请接入正式服务接口**)
104
104
  */
105
105
  async TestingTextGeneration(req, cb) {
106
106
  return this.request("TestingTextGeneration", req, cb);
@@ -667,7 +667,7 @@ export declare class Client extends AbstractClient {
667
667
  */
668
668
  RecognizePhilippinesDrivingLicenseOCR(req: RecognizePhilippinesDrivingLicenseOCRRequest, cb?: (error: string, rep: RecognizePhilippinesDrivingLicenseOCRResponse) => void): Promise<RecognizePhilippinesDrivingLicenseOCRResponse>;
669
669
  /**
670
- * 本接口支持OFD格式的增值税电子普通发票和增值税电子专用发票的识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。
670
+ * 本接口支持OFD格式的 增值税电子普通发票、增值税电子专用发票、电子发票(普通发票)、电子发票(增值税专用发票)识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。
671
671
  */
672
672
  VerifyOfdVatInvoiceOCR(req: VerifyOfdVatInvoiceOCRRequest, cb?: (error: string, rep: VerifyOfdVatInvoiceOCRResponse) => void): Promise<VerifyOfdVatInvoiceOCRResponse>;
673
673
  /**
@@ -831,7 +831,7 @@ class Client extends abstract_client_1.AbstractClient {
831
831
  return this.request("RecognizePhilippinesDrivingLicenseOCR", req, cb);
832
832
  }
833
833
  /**
834
- * 本接口支持OFD格式的增值税电子普通发票和增值税电子专用发票的识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。
834
+ * 本接口支持OFD格式的 增值税电子普通发票、增值税电子专用发票、电子发票(普通发票)、电子发票(增值税专用发票)识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。
835
835
  */
836
836
  async VerifyOfdVatInvoiceOCR(req, cb) {
837
837
  return this.request("VerifyOfdVatInvoiceOCR", req, cb);