tencentcloud-sdk-nodejs 4.0.362 → 4.0.363

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 (54) hide show
  1. package/CHANGELOG.md +194 -0
  2. package/SERVICE_CHANGELOG.md +305 -237
  3. package/package.json +1 -1
  4. package/products.md +9 -8
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_models.ts +7 -1
  7. package/src/services/cat/v20180409/cat_models.ts +1 -1
  8. package/src/services/ciam/v20220331/ciam_client.ts +48 -5
  9. package/src/services/ciam/v20220331/ciam_models.ts +434 -46
  10. package/src/services/dlc/v20210125/dlc_models.ts +1 -1
  11. package/src/services/index.ts +1 -0
  12. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  13. package/src/services/ocr/v20181119/ocr_models.ts +5 -0
  14. package/src/services/tcbr/index.ts +5 -0
  15. package/src/services/tcbr/v20220217/index.ts +6 -0
  16. package/src/services/tcbr/v20220217/tcbr_client.ts +130 -0
  17. package/src/services/tcbr/v20220217/tcbr_models.ts +876 -0
  18. package/src/services/teo/v20220106/teo_client.ts +25 -1
  19. package/src/services/teo/v20220106/teo_models.ts +141 -14
  20. package/src/services/vm/v20201229/vm_models.ts +7 -1
  21. package/src/services/vod/v20180717/vod_client.ts +27 -0
  22. package/src/services/vod/v20180717/vod_models.ts +232 -158
  23. package/tencentcloud/common/sdk_version.d.ts +1 -1
  24. package/tencentcloud/common/sdk_version.js +1 -1
  25. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +6 -1
  26. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +1 -1
  27. package/tencentcloud/services/ciam/v20220331/ciam_client.d.ts +13 -1
  28. package/tencentcloud/services/ciam/v20220331/ciam_client.js +18 -0
  29. package/tencentcloud/services/ciam/v20220331/ciam_models.d.ts +370 -39
  30. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +1 -1
  31. package/tencentcloud/services/index.d.ts +1 -0
  32. package/tencentcloud/services/index.js +2 -0
  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/ocr/v20181119/ocr_models.d.ts +4 -0
  36. package/tencentcloud/services/tcbr/index.d.ts +6 -0
  37. package/tencentcloud/services/tcbr/index.js +7 -0
  38. package/tencentcloud/services/tcbr/v20220217/index.d.ts +6 -0
  39. package/tencentcloud/services/tcbr/v20220217/index.js +9 -0
  40. package/tencentcloud/services/tcbr/v20220217/tcbr_client.d.ts +38 -0
  41. package/tencentcloud/services/tcbr/v20220217/tcbr_client.js +73 -0
  42. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +723 -0
  43. package/tencentcloud/services/tcbr/v20220217/tcbr_models.js +18 -0
  44. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +9 -1
  45. package/tencentcloud/services/teo/v20220106/teo_client.js +12 -0
  46. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +118 -12
  47. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +6 -1
  48. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +12 -1
  49. package/tencentcloud/services/vod/v20180717/vod_client.js +15 -0
  50. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +200 -136
  51. package/test/ciam.v20220331.test.js +30 -0
  52. package/test/tcbr.v20220217.test.js +91 -0
  53. package/test/teo.v20220106.test.js +20 -0
  54. package/test/vod.v20180717.test.js +20 -0
@@ -108,6 +108,37 @@ export interface ListUserRequest {
108
108
  Filters?: Array<Filter>
109
109
  }
110
110
 
111
+ /**
112
+ * ResetPassword请求参数结构体
113
+ */
114
+ export interface ResetPasswordRequest {
115
+ /**
116
+ * 用户ID
117
+ */
118
+ UserId: string
119
+
120
+ /**
121
+ * 用户目录ID
122
+ */
123
+ UserStoreId: string
124
+ }
125
+
126
+ /**
127
+ * 失败详情
128
+ */
129
+ export interface ErrorDetails {
130
+ /**
131
+ * 用户信息
132
+ 注意:此字段可能返回 null,表示取不到有效值。
133
+ */
134
+ UserId: string
135
+
136
+ /**
137
+ * 失败原因
138
+ */
139
+ Error: string
140
+ }
141
+
111
142
  /**
112
143
  * DeleteUsers请求参数结构体
113
144
  */
@@ -123,6 +154,147 @@ export interface DeleteUsersRequest {
123
154
  UserIds: Array<string>
124
155
  }
125
156
 
157
+ /**
158
+ * 导入用户信息
159
+ 1、UserName,PhoneNumber ,Email ,WechatOpenId ,WechatUnionId ,AlipayUserId ,QqOpenId ,QqUnionId 八个属性中,导入时必须包含其中一个属性并遵守初始化自定义属性的正则表达式规则。UserName,PhoneNumber,Email的正则表达式在控制台的自定义属性中可以查询到。
160
+ 2、对于密码的导入,导入的密码支持明文导入,MD5密文导入,SHA1密文导入,BCRYPT密文导入 ,这个需要在PasswordEncryptTypeEnum 字段中指定。
161
+ 3、IdentityVerified,IdentityVerificationMethod 支持导入,
162
+ IdentityVerified 为true,IdentityVerificationMethod必传;
163
+ IdentityVerificationMethod 为nameAndIdCard,Name,ResidentIdentityCard必传
164
+ IdentityVerificationMethod 为nameIdCardAndPhone,Name,PhoneNumber,ResidentIdentityCard必传;
165
+ */
166
+ export interface ImportUser {
167
+ /**
168
+ * 用户名
169
+ */
170
+ UserName?: string
171
+
172
+ /**
173
+ * 手机号
174
+ */
175
+ PhoneNumber?: string
176
+
177
+ /**
178
+ * 邮箱
179
+ */
180
+ Email?: string
181
+
182
+ /**
183
+ * 身份证号
184
+ */
185
+ ResidentIdentityCard?: string
186
+
187
+ /**
188
+ * 昵称
189
+ */
190
+ Nickname?: string
191
+
192
+ /**
193
+ * 地址
194
+ */
195
+ Address?: string
196
+
197
+ /**
198
+ * 用户组ID
199
+ */
200
+ UserGroup?: Array<string>
201
+
202
+ /**
203
+ * QQ qqOpenId
204
+ */
205
+ QqOpenId?: string
206
+
207
+ /**
208
+ * QQ qqUnionId
209
+ */
210
+ QqUnionId?: string
211
+
212
+ /**
213
+ * 微信wechatOpenId
214
+ */
215
+ WechatOpenId?: string
216
+
217
+ /**
218
+ * 微信wechatUnionId
219
+ */
220
+ WechatUnionId?: string
221
+
222
+ /**
223
+ * 支付宝alipayUserId
224
+ */
225
+ AlipayUserId?: string
226
+
227
+ /**
228
+ * 描述
229
+ */
230
+ Description?: string
231
+
232
+ /**
233
+ * 生日
234
+ */
235
+ Birthdate?: string
236
+
237
+ /**
238
+ * 姓名
239
+ */
240
+ Name?: string
241
+
242
+ /**
243
+ * 坐标
244
+ */
245
+ Locale?: string
246
+
247
+ /**
248
+ * 性别(MALE;FEMALE;UNKNOWN)
249
+ */
250
+ Gender?: string
251
+
252
+ /**
253
+ * 实名核验方式
254
+ */
255
+ IdentityVerificationMethod?: string
256
+
257
+ /**
258
+ * 是否已实名核验
259
+ */
260
+ IdentityVerified?: boolean
261
+
262
+ /**
263
+ * 工作
264
+ */
265
+ Job?: string
266
+
267
+ /**
268
+ * 国家
269
+ */
270
+ Nationality?: string
271
+
272
+ /**
273
+ * 时区
274
+ */
275
+ Zone?: string
276
+
277
+ /**
278
+ * 密码密文
279
+ */
280
+ Password?: string
281
+
282
+ /**
283
+ * 自定义属性
284
+ */
285
+ CustomizationAttributes?: Array<MemberMap>
286
+
287
+ /**
288
+ * 密码盐
289
+ */
290
+ Salt?: Salt
291
+
292
+ /**
293
+ * 密码加密方式(SHA1;BCRYPT)
294
+ */
295
+ PasswordEncryptTypeEnum?: string
296
+ }
297
+
126
298
  /**
127
299
  * UpdateUserStatus返回参数结构体
128
300
  */
@@ -134,18 +306,43 @@ export interface UpdateUserStatusResponse {
134
306
  }
135
307
 
136
308
  /**
137
- * ResetPassword请求参数结构体
309
+ * 失败的用户
138
310
  */
139
- export interface ResetPasswordRequest {
311
+ export interface FailedUsers {
140
312
  /**
141
- * 用户ID
142
- */
143
- UserId: string
313
+ * 失败用户标识
314
+ 注意:此字段可能返回 null,表示取不到有效值。
315
+ */
316
+ FailedUserIdentification: string
144
317
 
318
+ /**
319
+ * 导入的用户失败原因
320
+ 注意:此字段可能返回 null,表示取不到有效值。
321
+ */
322
+ FailedReason: string
323
+ }
324
+
325
+ /**
326
+ * ListUserByProperty请求参数结构体
327
+ */
328
+ export interface ListUserByPropertyRequest {
145
329
  /**
146
330
  * 用户目录ID
147
331
  */
148
332
  UserStoreId: string
333
+
334
+ /**
335
+ * 查询的属性
336
+
337
+ <li> **phoneNumber** </li> 手机号码
338
+ <li> **email** </li> 邮箱
339
+ */
340
+ PropertyCode: string
341
+
342
+ /**
343
+ * 属性值
344
+ */
345
+ PropertyValue: string
149
346
  }
150
347
 
151
348
  /**
@@ -164,6 +361,26 @@ export interface CreateUserResponse {
164
361
  RequestId?: string
165
362
  }
166
363
 
364
+ /**
365
+ * 查询条件
366
+ */
367
+ export interface Filter {
368
+ /**
369
+ * key值
370
+ */
371
+ Key?: string
372
+
373
+ /**
374
+ * value值
375
+ */
376
+ Values?: Array<string>
377
+
378
+ /**
379
+ * 逻辑值
380
+ */
381
+ Logic?: boolean
382
+ }
383
+
167
384
  /**
168
385
  * SetPassword返回参数结构体
169
386
  */
@@ -190,6 +407,21 @@ export interface ListUserByPropertyResponse {
190
407
  RequestId?: string
191
408
  }
192
409
 
410
+ /**
411
+ * ListJobs请求参数结构体
412
+ */
413
+ export interface ListJobsRequest {
414
+ /**
415
+ * 用户目录ID
416
+ */
417
+ UserStoreId: string
418
+
419
+ /**
420
+ * 任务ID列表,为空时返回全部任务
421
+ */
422
+ JobIds?: Array<string>
423
+ }
424
+
193
425
  /**
194
426
  * DescribeUserById返回参数结构体
195
427
  */
@@ -207,13 +439,96 @@ export interface DescribeUserByIdResponse {
207
439
  }
208
440
 
209
441
  /**
210
- * DeleteUsers返回参数结构体
442
+ * 任务详情
211
443
  */
212
- export interface DeleteUsersResponse {
444
+ export interface Job {
213
445
  /**
214
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
446
+ * 任务ID
215
447
  */
216
- RequestId?: string
448
+ Id: string
449
+
450
+ /**
451
+ * 任务状态
452
+
453
+ <li> **PENDING** </li> 待执行
454
+ <li> **PROCESSING** </li> 执行中
455
+ <li> **COMPLETED** </li> 完成
456
+ <li> **FAILED** </li> 失败
457
+ */
458
+ Status: string
459
+
460
+ /**
461
+ * 任务类型
462
+
463
+ <li> **IMPORT_USER** </li> 用户导入
464
+ <li> **EXPORT_USER** </li> 用户导出
465
+ */
466
+ Type: string
467
+
468
+ /**
469
+ * 任务创建时间
470
+ */
471
+ CreatedDate: number
472
+
473
+ /**
474
+ * 任务的数据类型
475
+
476
+ <li> **JSON** </li> JSON
477
+ <li> **NDJSON** </li> New-line Delimited JSON
478
+ <li> **CSV** </li> Comma-Separated Values
479
+ 注意:此字段可能返回 null,表示取不到有效值。
480
+ */
481
+ Format: string
482
+
483
+ /**
484
+ * 任务结果下载地址
485
+ 注意:此字段可能返回 null,表示取不到有效值。
486
+ */
487
+ Location: string
488
+
489
+ /**
490
+ * 失败详情
491
+ 注意:此字段可能返回 null,表示取不到有效值。
492
+ */
493
+ ErrorDetails: Array<ErrorDetails>
494
+
495
+ /**
496
+ * 失败的用户
497
+ 注意:此字段可能返回 null,表示取不到有效值。
498
+ */
499
+ FailedUsers: Array<FailedUsers>
500
+ }
501
+
502
+ /**
503
+ * CreateFileExportUserJob请求参数结构体
504
+ */
505
+ export interface CreateFileExportUserJobRequest {
506
+ /**
507
+ * 用户目录ID
508
+ */
509
+ UserStoreId: string
510
+
511
+ /**
512
+ * 导出的数据类型
513
+
514
+ <li> **JSON** </li> JSON
515
+ <li> **NDJSON** </li> New-line Delimited JSON
516
+ <li> **CSV** </li> Comma-Separated Values
517
+ */
518
+ Format?: string
519
+
520
+ /**
521
+ * Key可选值为condition、userGroupId
522
+
523
+ <li> **condition** </li> Values = 查询条件,用户ID,用户名称,手机或邮箱
524
+ <li> **userGroupId** </li> Values = 用户组ID
525
+ */
526
+ Filters?: Array<Filter>
527
+
528
+ /**
529
+ * 导出用户包含的属性和映射名称,为空时包含所有的属性
530
+ */
531
+ ExportPropertyMaps?: Array<ExportPropertyMap>
217
532
  }
218
533
 
219
534
  /**
@@ -483,6 +798,11 @@ export interface SetPasswordRequest {
483
798
  Password: string
484
799
  }
485
800
 
801
+ /**
802
+ * 盐位
803
+ */
804
+ export type SaltLocation = null
805
+
486
806
  /**
487
807
  * UpdateUserStatus请求参数结构体
488
808
  */
@@ -498,49 +818,44 @@ export interface UpdateUserStatusRequest {
498
818
  UserId: string
499
819
 
500
820
  /**
501
- * NORMAL(正常),LOCK(锁定),FREEZE(冻结),请传英文大写字母
502
- */
821
+ * 用户状态
822
+
823
+ <li> **NORMAL** </li> 正常
824
+ <li> **LOCK** </li> 锁定
825
+ <li> **FREEZE** </li> 冻结
826
+ */
503
827
  Status: string
504
828
  }
505
829
 
506
830
  /**
507
- * 查询条件
831
+ * ListJobs返回参数结构体
508
832
  */
509
- export interface Filter {
833
+ export interface ListJobsResponse {
510
834
  /**
511
- * key值
512
- */
513
- Key?: string
514
-
515
- /**
516
- * value值
517
- */
518
- Values?: Array<string>
835
+ * 任务列表
836
+ 注意:此字段可能返回 null,表示取不到有效值。
837
+ */
838
+ JobSet: Array<Job>
519
839
 
520
840
  /**
521
- * 逻辑值
841
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
522
842
  */
523
- Logic?: boolean
843
+ RequestId?: string
524
844
  }
525
845
 
526
846
  /**
527
- * ListUserByProperty请求参数结构体
847
+ * 导出属性映射
528
848
  */
529
- export interface ListUserByPropertyRequest {
849
+ export interface ExportPropertyMap {
530
850
  /**
531
- * 用户目录ID
851
+ * 用户属性code
532
852
  */
533
- UserStoreId: string
853
+ UserPropertyCode: string
534
854
 
535
855
  /**
536
- * 查询的属性(支持phoneNumber,email)
856
+ * 用户属性映射名称
537
857
  */
538
- PropertyCode: string
539
-
540
- /**
541
- * 属性值
542
- */
543
- PropertyValue: string
858
+ ColumnName: string
544
859
  }
545
860
 
546
861
  /**
@@ -609,24 +924,73 @@ export interface CreateUserRequest {
609
924
  }
610
925
 
611
926
  /**
612
- * Map数据类型
927
+ * 密码盐
613
928
  */
614
- export interface MemberMap {
929
+ export interface Salt {
615
930
  /**
616
- *
931
+ * 盐值
617
932
  */
618
- Name: string
933
+ SaltValue?: string
619
934
 
620
935
  /**
621
- *
936
+ * 盐值位置
622
937
  */
623
- Value: string
938
+ SaltLocation?: SaltLocation
939
+ }
624
940
 
941
+ /**
942
+ * DeleteUsers返回参数结构体
943
+ */
944
+ export interface DeleteUsersResponse {
625
945
  /**
626
- * 类型
627
- 注意:此字段可能返回 null,表示取不到有效值。
628
- */
629
- Type?: string
946
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
947
+ */
948
+ RequestId?: string
949
+ }
950
+
951
+ /**
952
+ * CreateApiImportUserJob请求参数结构体
953
+ */
954
+ export interface CreateApiImportUserJobRequest {
955
+ /**
956
+ * 用户目录ID
957
+ */
958
+ UserStoreId: string
959
+
960
+ /**
961
+ * 导入的用户数据
962
+ */
963
+ DataFlowUserCreateList: Array<ImportUser>
964
+ }
965
+
966
+ /**
967
+ * CreateFileExportUserJob返回参数结构体
968
+ */
969
+ export interface CreateFileExportUserJobResponse {
970
+ /**
971
+ * 数据流任务
972
+ */
973
+ Job: Job
974
+
975
+ /**
976
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
977
+ */
978
+ RequestId?: string
979
+ }
980
+
981
+ /**
982
+ * CreateApiImportUserJob返回参数结构体
983
+ */
984
+ export interface CreateApiImportUserJobResponse {
985
+ /**
986
+ * 数据流任务
987
+ */
988
+ Job: Job
989
+
990
+ /**
991
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
992
+ */
993
+ RequestId?: string
630
994
  }
631
995
 
632
996
  /**
@@ -649,11 +1013,35 @@ export interface LinkAccountRequest {
649
1013
  SecondaryUserId: string
650
1014
 
651
1015
  /**
652
- * 融合属性(PHONENUMBER,EMAIL)
653
- */
1016
+ * 融合属性
1017
+
1018
+ <li> **PHONENUMBER** </li> 手机号码
1019
+ <li> **EMAIL** </li> 邮箱
1020
+ */
654
1021
  UserLinkedOnAttribute: string
655
1022
  }
656
1023
 
1024
+ /**
1025
+ * Map数据类型
1026
+ */
1027
+ export interface MemberMap {
1028
+ /**
1029
+ * 健
1030
+ */
1031
+ Name: string
1032
+
1033
+ /**
1034
+ * 值
1035
+ */
1036
+ Value: string
1037
+
1038
+ /**
1039
+ * 类型
1040
+ 注意:此字段可能返回 null,表示取不到有效值。
1041
+ */
1042
+ Type?: string
1043
+ }
1044
+
657
1045
  /**
658
1046
  * ListUser返回参数结构体
659
1047
  */
@@ -1174,7 +1174,7 @@ export interface DescribeScriptsRequest {
1174
1174
  SortBy?: string
1175
1175
 
1176
1176
  /**
1177
- * 排序方式,desc表示正序,asc表示反序
1177
+ * 排序方式,desc表示正序,asc表示反序,默认asc
1178
1178
  */
1179
1179
  Sorting?: string
1180
1180
 
@@ -164,6 +164,7 @@ export { tbm } from "./tbm"
164
164
  export { tbp } from "./tbp"
165
165
  export { tcaplusdb } from "./tcaplusdb"
166
166
  export { tcb } from "./tcb"
167
+ export { tcbr } from "./tcbr"
167
168
  export { tcex } from "./tcex"
168
169
  export { tci } from "./tci"
169
170
  export { tcm } from "./tcm"
@@ -1204,7 +1204,7 @@ export class Client extends AbstractClient {
1204
1204
  }
1205
1205
 
1206
1206
  /**
1207
- * 本接口支持北京、上海、广东、江苏、吉林、黑龙江省市健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,七个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
1207
+ * 本接口支持北京、上海、广东、江苏、吉林、黑龙江、天津、辽宁、浙江、河南、四川、贵州、山东、安徽、福建、江西、湖南等省份健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,疫苗接种信息,八个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。
1208
1208
  */
1209
1209
  async RecognizeHealthCodeOCR(
1210
1210
  req: RecognizeHealthCodeOCRRequest,
@@ -5113,6 +5113,11 @@ export interface RecognizeHealthCodeOCRResponse {
5113
5113
  */
5114
5114
  TestingTime: string
5115
5115
 
5116
+ /**
5117
+ * 疫苗接种信息,返回接种针数或接种情况(允许返回空值)
5118
+ */
5119
+ Vaccination: string
5120
+
5116
5121
  /**
5117
5122
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5118
5123
  */
@@ -0,0 +1,5 @@
1
+ import { v20220217 } from "./v20220217"
2
+
3
+ export const tcbr = {
4
+ v20220217: v20220217,
5
+ }
@@ -0,0 +1,6 @@
1
+ import * as Models from "./tcbr_models"
2
+ import { Client } from "./tcbr_client"
3
+ export const v20220217 = {
4
+ Client: Client,
5
+ Models: Models,
6
+ }