tencentcloud-sdk-nodejs 4.0.743 → 4.0.745

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 (97) hide show
  1. package/CHANGELOG.md +341 -0
  2. package/SERVICE_CHANGELOG.md +340 -214
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +9 -0
  7. package/src/services/asr/v20190614/asr_client.ts +1 -1
  8. package/src/services/asr/v20190614/asr_models.ts +3 -0
  9. package/src/services/billing/v20180709/billing_models.ts +1 -1
  10. package/src/services/cfw/v20190904/cfw_client.ts +2 -3
  11. package/src/services/cfw/v20190904/cfw_models.ts +12 -8
  12. package/src/services/cls/v20201016/cls_client.ts +29 -17
  13. package/src/services/cls/v20201016/cls_models.ts +55 -31
  14. package/src/services/config/v20220802/config_client.ts +15 -2
  15. package/src/services/config/v20220802/config_models.ts +88 -33
  16. package/src/services/cwp/v20180228/cwp_models.ts +1 -1
  17. package/src/services/dts/v20211206/dts_models.ts +1 -1
  18. package/src/services/essbasic/v20210526/essbasic_client.ts +23 -9
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +153 -61
  20. package/src/services/hunyuan/v20230901/hunyuan_models.ts +2 -2
  21. package/src/services/mna/v20210119/mna_client.ts +70 -6
  22. package/src/services/mna/v20210119/mna_models.ts +326 -2
  23. package/src/services/oceanus/v20190422/oceanus_client.ts +0 -2
  24. package/src/services/oceanus/v20190422/oceanus_models.ts +42 -24
  25. package/src/services/sms/v20190711/sms_models.ts +6 -6
  26. package/src/services/sms/v20210111/sms_models.ts +1 -1
  27. package/src/services/tat/v20201028/tat_models.ts +2 -2
  28. package/src/services/tcr/v20190924/tcr_client.ts +21 -63
  29. package/src/services/tcr/v20190924/tcr_models.ts +115 -243
  30. package/src/services/tdmq/v20200217/tdmq_client.ts +15 -3
  31. package/src/services/tdmq/v20200217/tdmq_models.ts +99 -75
  32. package/src/services/teo/v20220901/teo_models.ts +5 -5
  33. package/src/services/thpc/v20230321/thpc_models.ts +6 -6
  34. package/src/services/tione/v20211111/tione_client.ts +12 -0
  35. package/src/services/tione/v20211111/tione_models.ts +60 -0
  36. package/src/services/tms/v20201229/tms_client.ts +4 -3
  37. package/src/services/tms/v20201229/tms_models.ts +62 -11
  38. package/src/services/tts/v20190823/tts_models.ts +10 -10
  39. package/src/services/vod/v20180717/vod_models.ts +4 -2
  40. package/src/services/vpc/v20170312/vpc_models.ts +35 -25
  41. package/src/services/weilingwith/v20230427/weilingwith_client.ts +2 -2
  42. package/tencentcloud/common/sdk_version.d.ts +1 -1
  43. package/tencentcloud/common/sdk_version.js +1 -1
  44. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +9 -0
  45. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +1 -1
  46. package/tencentcloud/services/asr/v20190614/asr_client.js +1 -1
  47. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +3 -0
  48. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +1 -1
  49. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +0 -1
  50. package/tencentcloud/services/cfw/v20190904/cfw_client.js +0 -1
  51. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +12 -8
  52. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +11 -7
  53. package/tencentcloud/services/cls/v20201016/cls_client.js +14 -8
  54. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +53 -31
  55. package/tencentcloud/services/config/v20220802/config_client.d.ts +5 -1
  56. package/tencentcloud/services/config/v20220802/config_client.js +6 -0
  57. package/tencentcloud/services/config/v20220802/config_models.d.ts +85 -33
  58. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +1 -1
  59. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +22 -8
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +22 -8
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +153 -61
  63. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +2 -2
  64. package/tencentcloud/services/mna/v20210119/mna_client.d.ts +23 -3
  65. package/tencentcloud/services/mna/v20210119/mna_client.js +33 -3
  66. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +312 -2
  67. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +0 -2
  68. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +0 -2
  69. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +42 -24
  70. package/tencentcloud/services/sms/v20190711/sms_models.d.ts +6 -6
  71. package/tencentcloud/services/sms/v20210111/sms_models.d.ts +1 -1
  72. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +2 -2
  73. package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +5 -23
  74. package/tencentcloud/services/tcr/v20190924/tcr_client.js +6 -30
  75. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +113 -235
  76. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +5 -1
  77. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +6 -0
  78. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +97 -75
  79. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +5 -5
  80. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +6 -6
  81. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  82. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  83. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +58 -0
  84. package/tencentcloud/services/tms/v20201229/tms_client.d.ts +2 -3
  85. package/tencentcloud/services/tms/v20201229/tms_client.js +2 -3
  86. package/tencentcloud/services/tms/v20201229/tms_models.d.ts +60 -11
  87. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +10 -10
  88. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -2
  89. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +35 -25
  90. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +2 -2
  91. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +2 -2
  92. package/test/cls.v20201016.test.js +14 -4
  93. package/test/config.v20220802.test.js +10 -0
  94. package/test/mna.v20210119.test.js +52 -2
  95. package/test/tcr.v20190924.test.js +4 -34
  96. package/test/tdmq.v20200217.test.js +10 -0
  97. package/test/tione.v20211111.test.js +10 -0
@@ -1190,19 +1190,19 @@ export interface ScheduledSqlResouceInfo {
1190
1190
  MetricName?: string;
1191
1191
  /**
1192
1192
  * 指标名称
1193
- BizType为1时,优先使用MetricNames字段信息。多指标只能填充到MetricNames字段,单指标建议填充到MetricNames字段
1193
+ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricNames字段,单指标建议填充到MetricName字段
1194
1194
  */
1195
1195
  MetricNames?: Array<string>;
1196
1196
  /**
1197
- * 指标项
1197
+ * 指标标签,从SQL结果字段中选择,一般是分组(group by) 的字段。
1198
1198
  */
1199
1199
  MetricLabels?: Array<string>;
1200
1200
  /**
1201
- * 自定义时间
1201
+ * 指标时间戳,默认值为SQL查询时间范围的左侧时间点,您也可以指定其他字段(类型为uinx时间,精度毫秒)为指标时间戳。
1202
1202
  */
1203
1203
  CustomTime?: string;
1204
1204
  /**
1205
- * 自定义标签
1205
+ * 除了MetricLabels,您还可以使用该参数,为指标补充静态的标签。
1206
1206
  */
1207
1207
  CustomMetricLabels?: Array<MetricLabel>;
1208
1208
  }
@@ -1921,7 +1921,7 @@ export interface ModifyAlarmRequest {
1921
1921
  */
1922
1922
  Status?: boolean;
1923
1923
  /**
1924
- * 是否开启告警策略。默认值为true
1924
+ * 该参数已废弃,请使用Status参数控制是否开启告警策略。
1925
1925
  */
1926
1926
  Enable?: boolean;
1927
1927
  /**
@@ -2068,11 +2068,7 @@ export interface CreateAlarmRequest {
2068
2068
  */
2069
2069
  TriggerCount: number;
2070
2070
  /**
2071
- * 告警重复的周期。
2072
-
2073
- 单位是分钟。
2074
-
2075
- 取值范围是0~1440。
2071
+ * 告警重复的周期,单位是分钟。取值范围是0~1440。
2076
2072
  */
2077
2073
  AlarmPeriod: number;
2078
2074
  /**
@@ -2080,27 +2076,22 @@ export interface CreateAlarmRequest {
2080
2076
  */
2081
2077
  AlarmNoticeIds: Array<string>;
2082
2078
  /**
2083
- * 触发条件。
2084
-
2079
+ * 触发条件
2085
2080
  注意:
2086
-
2087
2081
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
2088
2082
 
2089
2083
  */
2090
2084
  Condition?: string;
2091
2085
  /**
2092
- * 告警级别。
2093
-
2086
+ * 告警级别
2094
2087
  0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。
2095
-
2096
2088
  注意:
2097
2089
  - 不填则默认为0。
2098
2090
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
2099
2091
  */
2100
2092
  AlarmLevel?: number;
2101
2093
  /**
2102
- * 多触发条件。
2103
-
2094
+ * 多触发条件
2104
2095
  注意:
2105
2096
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
2106
2097
 
@@ -2110,12 +2101,11 @@ export interface CreateAlarmRequest {
2110
2101
  MultiConditions?: Array<MultiCondition>;
2111
2102
  /**
2112
2103
  * 是否开启告警策略。
2113
-
2114
2104
  默认值为true
2115
2105
  */
2116
2106
  Status?: boolean;
2117
2107
  /**
2118
- * 是否开启告警策略。默认值为true
2108
+ * 该参数已废弃,请使用Status参数控制是否开启告警策略。
2119
2109
  */
2120
2110
  Enable?: boolean;
2121
2111
  /**
@@ -2132,7 +2122,6 @@ export interface CreateAlarmRequest {
2132
2122
  Analysis?: Array<AnalysisDimensional>;
2133
2123
  /**
2134
2124
  * 分组触发状态。
2135
-
2136
2125
  默认值false
2137
2126
  */
2138
2127
  GroupTriggerStatus?: boolean;
@@ -2148,20 +2137,15 @@ export interface CreateAlarmRequest {
2148
2137
  Tags?: Array<Tag>;
2149
2138
  /**
2150
2139
  * 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。
2151
-
2152
2140
  不填则默认为0。
2153
-
2154
2141
  当值为1时,AlarmTargets元素个数不能超过10个,AlarmTargets中的Number必须是从1开始的连续正整数,不能重复。
2155
2142
 
2156
2143
  */
2157
2144
  MonitorObjectType?: number;
2158
2145
  /**
2159
2146
  * 告警附加分类信息列表。
2160
-
2161
2147
  Classifications元素个数不能超过20个。
2162
-
2163
- Classifications元素的Key不能为空,不能重复,长度不能超过50个字符,字符规则 ^[a-z]([a-z0-9_]{0,49})$。
2164
-
2148
+ Classifications元素的Key不能为空,不能重复,长度不能超过50个字符,符合正则 `^[a-z]([a-z0-9_]{0,49})$`。
2165
2149
  Classifications元素的Value长度不能超过200个字符。
2166
2150
  */
2167
2151
  Classifications?: Array<AlarmClassification>;
@@ -2960,13 +2944,33 @@ export interface DeleteConfigResponse {
2960
2944
  RequestId?: string;
2961
2945
  }
2962
2946
  /**
2963
- * ModifyIndex返回参数结构体
2947
+ * CreateDeliverCloudFunction请求参数结构体
2964
2948
  */
2965
- export interface ModifyIndexResponse {
2949
+ export interface CreateDeliverCloudFunctionRequest {
2966
2950
  /**
2967
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2951
+ * 投递规则属于的 topic id
2968
2952
  */
2969
- RequestId?: string;
2953
+ TopicId: string;
2954
+ /**
2955
+ * 投递的云函数名字
2956
+ */
2957
+ FunctionName: string;
2958
+ /**
2959
+ * 命名空间
2960
+ */
2961
+ Namespace: string;
2962
+ /**
2963
+ * 函数版本
2964
+ */
2965
+ Qualifier: string;
2966
+ /**
2967
+ * 投递最长等待时间,单位:秒
2968
+ */
2969
+ Timeout?: number;
2970
+ /**
2971
+ * 投递最大消息数
2972
+ */
2973
+ MaxMsgNum?: number;
2970
2974
  }
2971
2975
  /**
2972
2976
  * DeleteConsumer请求参数结构体
@@ -3480,6 +3484,15 @@ export interface DeleteConfigExtraRequest {
3480
3484
  */
3481
3485
  ConfigExtraId: string;
3482
3486
  }
3487
+ /**
3488
+ * CreateDeliverCloudFunction返回参数结构体
3489
+ */
3490
+ export interface CreateDeliverCloudFunctionResponse {
3491
+ /**
3492
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3493
+ */
3494
+ RequestId?: string;
3495
+ }
3483
3496
  /**
3484
3497
  * ModifyConfig请求参数结构体
3485
3498
  */
@@ -4121,6 +4134,15 @@ export interface ExportInfo {
4121
4134
  */
4122
4135
  SyntaxRule?: number;
4123
4136
  }
4137
+ /**
4138
+ * ModifyIndex返回参数结构体
4139
+ */
4140
+ export interface ModifyIndexResponse {
4141
+ /**
4142
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4143
+ */
4144
+ RequestId?: string;
4145
+ }
4124
4146
  /**
4125
4147
  * 分组触发条件
4126
4148
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { ListConfigRulesResponse, ListAggregateConfigRulesRequest, ListAggregateConfigRulesResponse, ListConfigRulesRequest } from "./config_models";
3
+ import { ListConfigRulesResponse, ListConfigRulesRequest, PutEvaluationsRequest, ListAggregateConfigRulesRequest, ListAggregateConfigRulesResponse, PutEvaluationsResponse } from "./config_models";
4
4
  /**
5
5
  * config client
6
6
  * @class
@@ -15,4 +15,8 @@ export declare class Client extends AbstractClient {
15
15
  * 账号组获取规则列表
16
16
  */
17
17
  ListAggregateConfigRules(req: ListAggregateConfigRulesRequest, cb?: (error: string, rep: ListAggregateConfigRulesResponse) => void): Promise<ListAggregateConfigRulesResponse>;
18
+ /**
19
+ * 上报自定义规则评估结果
20
+ */
21
+ PutEvaluations(req: PutEvaluationsRequest, cb?: (error: string, rep: PutEvaluationsResponse) => void): Promise<PutEvaluationsResponse>;
18
22
  }
@@ -39,5 +39,11 @@ class Client extends abstract_client_1.AbstractClient {
39
39
  async ListAggregateConfigRules(req, cb) {
40
40
  return this.request("ListAggregateConfigRules", req, cb);
41
41
  }
42
+ /**
43
+ * 上报自定义规则评估结果
44
+ */
45
+ async PutEvaluations(req, cb) {
46
+ return this.request("PutEvaluations", req, cb);
47
+ }
42
48
  }
43
49
  exports.Client = Client;
@@ -151,6 +151,21 @@ export interface ConfigRule {
151
151
  */
152
152
  ManageTriggerType?: Array<string>;
153
153
  }
154
+ /**
155
+ * 标签
156
+ */
157
+ export interface Tag {
158
+ /**
159
+ * 标签key
160
+ 注意:此字段可能返回 null,表示取不到有效值。
161
+ */
162
+ TagKey?: string;
163
+ /**
164
+ * 标签value
165
+ 注意:此字段可能返回 null,表示取不到有效值。
166
+ */
167
+ TagValue?: string;
168
+ }
154
169
  /**
155
170
  * ListConfigRules返回参数结构体
156
171
  */
@@ -198,6 +213,42 @@ export interface InputParameterForManage {
198
213
  */
199
214
  Description?: string;
200
215
  }
216
+ /**
217
+ * ListConfigRules请求参数结构体
218
+ */
219
+ export interface ListConfigRulesRequest {
220
+ /**
221
+ * 每页限制
222
+ */
223
+ Limit: number;
224
+ /**
225
+ * 偏移量
226
+ */
227
+ Offset: number;
228
+ /**
229
+ * 排序类型, 倒序:desc,顺序:asc
230
+ */
231
+ OrderType?: string;
232
+ /**
233
+ * 风险等级
234
+ 1:高风险。
235
+ 2:中风险。
236
+ 3:低风险。
237
+ */
238
+ RiskLevel?: Array<number | bigint>;
239
+ /**
240
+ * 规则状态
241
+ */
242
+ State?: string;
243
+ /**
244
+ * 评估结果
245
+ */
246
+ ComplianceResult?: Array<string>;
247
+ /**
248
+ * 规则名
249
+ */
250
+ RuleName?: string;
251
+ }
201
252
  /**
202
253
  * 管理端规则条件
203
254
  */
@@ -242,6 +293,19 @@ export interface TriggerType {
242
293
  */
243
294
  MaximumExecutionFrequency?: string;
244
295
  }
296
+ /**
297
+ * PutEvaluations请求参数结构体
298
+ */
299
+ export interface PutEvaluationsRequest {
300
+ /**
301
+ * 回调令牌。从自定义规则所选的scf云函数Context中取参数ResultToken值
302
+ */
303
+ ResultToken: string;
304
+ /**
305
+ * 自定义规则评估结果信息。
306
+ */
307
+ Evaluations: Array<Evaluation>;
308
+ }
245
309
  /**
246
310
  * ListAggregateConfigRules请求参数结构体
247
311
  */
@@ -304,19 +368,13 @@ export interface ListAggregateConfigRulesResponse {
304
368
  RequestId?: string;
305
369
  }
306
370
  /**
307
- * 标签
371
+ * PutEvaluations返回参数结构体
308
372
  */
309
- export interface Tag {
310
- /**
311
- * 标签key
312
- 注意:此字段可能返回 null,表示取不到有效值。
313
- */
314
- TagKey?: string;
373
+ export interface PutEvaluationsResponse {
315
374
  /**
316
- * 标签value
317
- 注意:此字段可能返回 null,表示取不到有效值。
375
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
318
376
  */
319
- TagValue?: string;
377
+ RequestId?: string;
320
378
  }
321
379
  /**
322
380
  * 参数值
@@ -337,40 +395,34 @@ export interface InputParameter {
337
395
  Value?: string;
338
396
  }
339
397
  /**
340
- * ListConfigRules请求参数结构体
398
+ * 自定义规则评估结果
341
399
  */
342
- export interface ListConfigRulesRequest {
400
+ export interface Evaluation {
343
401
  /**
344
- * 每页限制
402
+ * 已评估资源ID。长度为0~256个字符
345
403
  */
346
- Limit: number;
404
+ ComplianceResourceId: string;
347
405
  /**
348
- * 偏移量
406
+ * 已评估资源类型。
407
+ 支持:
408
+ QCS::CVM::Instance、 QCS::CBS::Disk、QCS::VPC::Vpc、QCS::VPC::Subnet、QCS::VPC::SecurityGroup、 QCS::CAM::User、QCS::CAM::Group、QCS::CAM::Policy、QCS::CAM::Role、QCS::COS::Bucket
349
409
  */
350
- Offset: number;
410
+ ComplianceResourceType: string;
351
411
  /**
352
- * 排序类型, 倒序:desc,顺序:asc
412
+ * 已评估资源地域。
413
+ 长度为0~32个字符
353
414
  */
354
- OrderType?: string;
415
+ ComplianceRegion: string;
355
416
  /**
356
- * 风险等级
357
- 1:高风险。
358
- 2:中风险。
359
- 3:低风险。
417
+ * 合规类型。取值:
418
+ COMPLIANT:合规、
419
+ NON_COMPLIANT:不合规
360
420
  */
361
- RiskLevel?: Array<number | bigint>;
362
- /**
363
- * 规则状态
364
- */
365
- State?: string;
421
+ ComplianceType: string;
366
422
  /**
367
- * 评估结果
423
+ * 不合规资源的补充信息。
368
424
  */
369
- ComplianceResult?: Array<string>;
370
- /**
371
- * 规则名
372
- */
373
- RuleName?: string;
425
+ Annotation?: Annotation;
374
426
  }
375
427
  /**
376
428
  * 合规详情
@@ -21560,7 +21560,7 @@ export interface ModifyLogKafkaDeliverTypeRequest {
21560
21560
  */
21561
21561
  SecurityType: number;
21562
21562
  /**
21563
- * 安全模块下的日志类型,http://tapd.woa.com/Teneyes/markdown_wikis/show/#1210131751002328905
21563
+ * 安全模块下的日志类型,
21564
21564
  */
21565
21565
  LogType: Array<number | bigint>;
21566
21566
  /**
@@ -948,7 +948,7 @@ export interface DBEndpointInfo {
948
948
  */
949
949
  DatabaseType: string;
950
950
  /**
951
- * 节点类型,为空或者"simple"表示普通节点、"cluster"表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)
951
+ * 节点类型,为空或者simple表示普通节点、cluster表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群);对于redis实例,为空或simple(单节点)、cluster(集群)、cluster-cache(cache集群)、cluster-proxy(代理集群)
952
952
  注意:此字段可能返回 null,表示取不到有效值。
953
953
  */
954
954
  NodeType: string;
@@ -408,11 +408,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
408
408
  */
409
409
  ChannelCreateOrganizationModifyQrCode(req: ChannelCreateOrganizationModifyQrCodeRequest, cb?: (error: string, rep: ChannelCreateOrganizationModifyQrCodeResponse) => void): Promise<ChannelCreateOrganizationModifyQrCodeResponse>;
410
410
  /**
411
- * 创建预发起合同
412
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
413
- 可指定合同信息不可更改,签署人信息不可更改
414
- 合同发起后,填写及签署流程与现有操作流程一致
415
- 注意:目前仅支持模板发起
411
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
412
+
413
+ 注意:
414
+ 1. **仅支持模板**发起
415
+ 2. 只支持PC浏览器操作使用
416
+
417
+ 嵌入的页面样式如下:
418
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
416
419
  */
417
420
  ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
418
421
  /**
@@ -611,7 +614,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
611
614
  */
612
615
  DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
613
616
  /**
614
- * 通过此接口,绑定员工角色,支持以电子签userId、客户系统userId两种方式调用。
617
+ * 使用此接口,用来绑定企业实名员工的角色,
618
+ 支持以电子签userId、客户系统openId两种方式进行绑定。
615
619
  */
616
620
  ChannelCreateUserRoles(req: ChannelCreateUserRolesRequest, cb?: (error: string, rep: ChannelCreateUserRolesResponse) => void): Promise<ChannelCreateUserRolesResponse>;
617
621
  /**
@@ -761,6 +765,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
761
765
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
762
766
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
763
767
  </ul>
768
+
769
+
770
+ 注意:
771
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
772
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
764
773
  */
765
774
  CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
766
775
  /**
@@ -887,8 +896,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
887
896
  ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
888
897
  /**
889
898
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
890
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
891
- 进入web连接后与当前控制台操作保持一致
899
+
900
+ 本接口下面功能的签署页面链接的生成
901
+ - 创建印章
902
+ - 创建模板
903
+ - 修改模板
904
+ - 预览模板
905
+ - 预览合同流程
892
906
  */
893
907
  ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
894
908
  /**
@@ -476,11 +476,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
476
476
  return this.request("ChannelCreateOrganizationModifyQrCode", req, cb);
477
477
  }
478
478
  /**
479
- * 创建预发起合同
480
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
481
- 可指定合同信息不可更改,签署人信息不可更改
482
- 合同发起后,填写及签署流程与现有操作流程一致
483
- 注意:目前仅支持模板发起
479
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
480
+
481
+ 注意:
482
+ 1. **仅支持模板**发起
483
+ 2. 只支持PC浏览器操作使用
484
+
485
+ 嵌入的页面样式如下:
486
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
484
487
  */
485
488
  async ChannelCreatePrepareFlow(req, cb) {
486
489
  return this.request("ChannelCreatePrepareFlow", req, cb);
@@ -721,7 +724,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
721
724
  return this.request("DescribeResourceUrlsByFlows", req, cb);
722
725
  }
723
726
  /**
724
- * 通过此接口,绑定员工角色,支持以电子签userId、客户系统userId两种方式调用。
727
+ * 使用此接口,用来绑定企业实名员工的角色,
728
+ 支持以电子签userId、客户系统openId两种方式进行绑定。
725
729
  */
726
730
  async ChannelCreateUserRoles(req, cb) {
727
731
  return this.request("ChannelCreateUserRoles", req, cb);
@@ -883,6 +887,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
883
887
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
884
888
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
885
889
  </ul>
890
+
891
+
892
+ 注意:
893
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
894
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
886
895
  */
887
896
  async CreateChannelOrganizationInfoChangeUrl(req, cb) {
888
897
  return this.request("CreateChannelOrganizationInfoChangeUrl", req, cb);
@@ -1023,8 +1032,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1023
1032
  }
1024
1033
  /**
1025
1034
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
1026
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
1027
- 进入web连接后与当前控制台操作保持一致
1035
+
1036
+ 本接口下面功能的签署页面链接的生成
1037
+ - 创建印章
1038
+ - 创建模板
1039
+ - 修改模板
1040
+ - 预览模板
1041
+ - 预览合同流程
1028
1042
  */
1029
1043
  async ChannelCreateEmbedWebUrl(req, cb) {
1030
1044
  return this.request("ChannelCreateEmbedWebUrl", req, cb);