tencentcloud-sdk-nodejs-intl-en 3.0.1443 → 3.0.1445

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-intl-en",
3
- "version": "3.0.1443",
3
+ "version": "3.0.1445",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.1443";
1
+ const sdkVersion = "3.0.1445";
2
2
  module.exports = sdkVersion
@@ -180,7 +180,7 @@ class FaceidClient extends AbstractClient {
180
180
  }
181
181
 
182
182
  /**
183
- * AML name list screening
183
+ * AML list screening
184
184
  * @param {RunAMLNameScreeningRequest} req
185
185
  * @param {function(string, RunAMLNameScreeningResponse):void} cb
186
186
  * @public
@@ -412,7 +412,7 @@ The data generated with the SDK must be stored in COS, and the region of the COS
412
412
  }
413
413
 
414
414
  /**
415
- * This API updates the Webhook configuration.
415
+ * This API is used to update Webhook configurations.
416
416
  * @param {UpdateEKYCWebhookRequest} req
417
417
  * @param {function(string, UpdateEKYCWebhookResponse):void} cb
418
418
  * @public
@@ -435,7 +435,7 @@ The image and the data generated with the SDK must be stored in COS, and the reg
435
435
  }
436
436
 
437
437
  /**
438
- * AML name list screening
438
+ * AML list screening
439
439
  * @param {UpdateAMLCustomerProfileRequest} req
440
440
  * @param {function(string, UpdateAMLCustomerProfileResponse):void} cb
441
441
  * @public
@@ -446,7 +446,7 @@ The image and the data generated with the SDK must be stored in COS, and the reg
446
446
  }
447
447
 
448
448
  /**
449
- * Queries the AML name list screening result.
449
+ * Status change of continuous name list screening
450
450
  * @param {GetAMLScreeningResultRequest} req
451
451
  * @param {function(string, GetAMLScreeningResultResponse):void} cb
452
452
  * @public
@@ -463,13 +463,13 @@ class GetAMLScreeningResultResponse extends AbstractModel {
463
463
  super();
464
464
 
465
465
  /**
466
- * Screening results: NO-HITS (not hit) / HAS-HITS (hit)
466
+ * <p>Filtering results: NO-HITS (not hit) / HAS-HITS (hit)</p>
467
467
  * @type {string || null}
468
468
  */
469
469
  this.ScreeningResult = null;
470
470
 
471
471
  /**
472
- * Whether continuous monitoring screening is enabled. Default value: false.
472
+ * <p>Whether continuous monitoring screening is enabled. false by default</p><p>Default value: false</p>
473
473
  * @type {boolean || null}
474
474
  */
475
475
  this.EnableOngoingScreening = null;
@@ -487,25 +487,25 @@ class GetAMLScreeningResultResponse extends AbstractModel {
487
487
  this.Result = null;
488
488
 
489
489
  /**
490
- * <p>The unique identifier of a case generated by a hit screening</p>
490
+ * <p>The unique identifier of the case generated by a hit screening</p>
491
491
  * @type {string || null}
492
492
  */
493
493
  this.ScreeningId = null;
494
494
 
495
495
  /**
496
- * Screening result time
496
+ * <p>Filtering result time</p>
497
497
  * @type {string || null}
498
498
  */
499
499
  this.ResultTime = null;
500
500
 
501
501
  /**
502
- * Returned when there is a hit. A deduplicated list of the hit AML types.
502
+ * <p>Return on hit, the hit AML type list (deduplicated)</p>
503
503
  * @type {Array.<string> || null}
504
504
  */
505
505
  this.AMLTypes = null;
506
506
 
507
507
  /**
508
- * Returned when there is a hit. A list of hit risk details.
508
+ * <p>Return on hit, hit risk detail list</p>
509
509
  * @type {string || null}
510
510
  */
511
511
  this.HitDetail = null;
@@ -559,7 +559,7 @@ class Company extends AbstractModel {
559
559
  this.CompanyCertNumber = null;
560
560
 
561
561
  /**
562
- * <p>Enterprise registration country, ISO 3166-1 alpha-2 country code (optional)</p>
562
+ * <p>Enterprise registration country, ISO 3166-1 alpha-2 country code (Option)</p>
563
563
  * @type {string || null}
564
564
  */
565
565
  this.CompanyCountry = null;
@@ -1310,13 +1310,13 @@ class CreateEKYCWebhookResponse extends AbstractModel {
1310
1310
  this.WebhookId = null;
1311
1311
 
1312
1312
  /**
1313
- * Whether to add a secret key. Default value: false.
1313
+ * <p>Whether to add a callback signature key</p><p>Default value: false</p>
1314
1314
  * @type {boolean || null}
1315
1315
  */
1316
1316
  this.HasSignatureKey = null;
1317
1317
 
1318
1318
  /**
1319
- * <p>Callback secret key</p>
1319
+ * <p>Callback signature key</p>
1320
1320
  * @type {string || null}
1321
1321
  */
1322
1322
  this.SignatureKey = null;
@@ -3102,7 +3102,7 @@ class WebhookList extends AbstractModel {
3102
3102
  this.WebhookId = null;
3103
3103
 
3104
3104
  /**
3105
- * <p>Callback URL name</p>
3105
+ * <p>Callback address name</p>
3106
3106
  * @type {string || null}
3107
3107
  */
3108
3108
  this.WebhookName = null;
@@ -3132,13 +3132,13 @@ class WebhookList extends AbstractModel {
3132
3132
  this.ModTime = null;
3133
3133
 
3134
3134
  /**
3135
- * <p>Callback request key</p>
3135
+ * <p>Callback signature key, up to 128 characters.</p>
3136
3136
  * @type {string || null}
3137
3137
  */
3138
3138
  this.SignatureKey = null;
3139
3139
 
3140
3140
  /**
3141
- * <p>Existence of callback API key</p>
3141
+ * <p>Existence of callback signature key</p>
3142
3142
  * @type {boolean || null}
3143
3143
  */
3144
3144
  this.HasSignatureKey = null;
@@ -5101,13 +5101,13 @@ class UpdateEKYCWebhookResponse extends AbstractModel {
5101
5101
  super();
5102
5102
 
5103
5103
  /**
5104
- * <p>ID of the updated Webhook configuration</p>
5104
+ * <p>ID of the Webhook configuration to be updated</p>
5105
5105
  * @type {number || null}
5106
5106
  */
5107
5107
  this.WebhookId = null;
5108
5108
 
5109
5109
  /**
5110
- * <p>Modification time after update, format YYYY-MM-DD HH:mm:ss</p>
5110
+ * <p>Modification time after the update, in the format YYYY-MM-DD HH:mm:ss</p>
5111
5111
  * @type {string || null}
5112
5112
  */
5113
5113
  this.ModTime = null;
@@ -5464,7 +5464,7 @@ class GetAMLScreeningResultRequest extends AbstractModel {
5464
5464
  super();
5465
5465
 
5466
5466
  /**
5467
- * <p>Unique identifier of the end user in the customer system, up to 256 characters.</p>
5467
+ * <p>User's unique identifier in the customer system, up to 256 characters.</p>
5468
5468
  * @type {string || null}
5469
5469
  */
5470
5470
  this.UniqueCustomerID = null;
@@ -5886,25 +5886,25 @@ class Person extends AbstractModel {
5886
5886
  super();
5887
5887
 
5888
5888
  /**
5889
- * <p>Full name (either this or LastName is required). If FullName is filled, FirstName/MiddleName/LastName cannot be filled.</p>
5889
+ * <p>Full name (either this or LastName is required). If FullName is filled, FirstName/MiddleName/LastName cannot be filled</p>
5890
5890
  * @type {string || null}
5891
5891
  */
5892
5892
  this.FullName = null;
5893
5893
 
5894
5894
  /**
5895
- * <p>name (Either this field or FullName is required)</p>
5895
+ * <p>name (either this or FullName is required)</p>
5896
5896
  * @type {string || null}
5897
5897
  */
5898
5898
  this.LastName = null;
5899
5899
 
5900
5900
  /**
5901
- * <p>First name (Option)</p>
5901
+ * <p>First name (optional)</p>
5902
5902
  * @type {string || null}
5903
5903
  */
5904
5904
  this.FirstName = null;
5905
5905
 
5906
5906
  /**
5907
- * <p>Middle name (Option)</p>
5907
+ * <p>Middle name (optional)</p>
5908
5908
  * @type {string || null}
5909
5909
  */
5910
5910
  this.MiddleName = null;
@@ -5977,26 +5977,25 @@ class UpdateAMLCustomerProfileRequest extends AbstractModel {
5977
5977
  super();
5978
5978
 
5979
5979
  /**
5980
- * End user's unique identifier in the customer system, up to 256 characters.
5980
+ * <p>User's unique identifier in the customer system, up to 256 characters.</p>
5981
5981
  * @type {string || null}
5982
5982
  */
5983
5983
  this.UniqueCustomerID = null;
5984
5984
 
5985
5985
  /**
5986
- * Entity type. Enumeration values: PERSON (individual) / COMPANY (company).
5986
+ * <p>Entity type. Enumeration values: PERSON / COMPANY</p><p>Enumeration values:</p><ul><li>PERSON: individual</li><li>COMPANY: company</li></ul>
5987
5987
  * @type {string || null}
5988
5988
  */
5989
5989
  this.EntityType = null;
5990
5990
 
5991
5991
  /**
5992
- * Personal information, required when EntityType=PERSON.
5993
- Input restriction: EntityType=PERSON.
5992
+ * <p>Personal information, required when EntityType=PERSON</p><p>Input limit: EntityType=PERSON</p>
5994
5993
  * @type {Person || null}
5995
5994
  */
5996
5995
  this.Person = null;
5997
5996
 
5998
5997
  /**
5999
- * Enterprise information, required when EntityType=COMPANY. Input restriction: EntityType=COMPANY.
5998
+ * <p>Enterprise info. Required when EntityType=COMPANY</p><p>Input limitation: EntityType=COMPANY</p>
6000
5999
  * @type {Company || null}
6001
6000
  */
6002
6001
  this.Company = null;
@@ -6903,19 +6902,19 @@ class RunAMLNameScreeningResponse extends AbstractModel {
6903
6902
  super();
6904
6903
 
6905
6904
  /**
6906
- * Screening results: NO-HITS (not hit) / HAS-HITS (hit)
6905
+ * <p>Filtering results: NO-HITS (not hit) / HAS-HITS (hit)</p>
6907
6906
  * @type {string || null}
6908
6907
  */
6909
6908
  this.ScreeningResult = null;
6910
6909
 
6911
6910
  /**
6912
- * Returned when there is a hit. A deduplicated list of the hit AML types.
6911
+ * <p>Return on hit, the hit AML type list (deduplicated)</p>
6913
6912
  * @type {Array.<string> || null}
6914
6913
  */
6915
6914
  this.AMLTypes = null;
6916
6915
 
6917
6916
  /**
6918
- * Returned when there is a hit. A list of hit risk details.
6917
+ * <p>Return on cache hit, hit risk detail list</p>
6919
6918
  * @type {string || null}
6920
6919
  */
6921
6920
  this.HitDetail = null;
@@ -6933,14 +6932,13 @@ class RunAMLNameScreeningResponse extends AbstractModel {
6933
6932
  this.Description = null;
6934
6933
 
6935
6934
  /**
6936
- * <p>The unique identifier of the case generated by a hit screening</p>
6935
+ * <p>The unique identifier of a case generated by one hit screening</p>
6937
6936
  * @type {string || null}
6938
6937
  */
6939
6938
  this.ScreeningId = null;
6940
6939
 
6941
6940
  /**
6942
- * Whether continuous monitoring screening is enabled.
6943
- Default value: false.
6941
+ * <p>Whether continuous monitoring and screening is enabled. Default value: false</p><p>Default value: false</p>
6944
6942
  * @type {boolean || null}
6945
6943
  */
6946
6944
  this.EnableOngoingScreening = null;
@@ -7346,6 +7344,18 @@ class CreateEKYCWebhookRequest extends AbstractModel {
7346
7344
  */
7347
7345
  this.WebhookURL = null;
7348
7346
 
7347
+ /**
7348
+ * <p>Business scenario. Default if not passed: AML_SCREENING_RESULT_CHANGE. For parameter values, see the enumeration below.</p><p>Enumeration values:</p><ul><li>AML_SCREENING_RESULT_CHANGE: AML anti-money laundering screening result change notification (default value) </li><li>NONDOC_VERIFICATION_RESULT: Non-document (NonDoc) verification result notification</li></ul>
7349
+ * @type {string || null}
7350
+ */
7351
+ this.Scene = null;
7352
+
7353
+ /**
7354
+ * <p>Callback signature key, up to 128 characters. Used for HMAC-SHA256 signature verification of subsequent callback messages. If not passed, signature is not enabled. We recommend using OpenSSL random bytes to generate the key. Recommended command: openssl rand -base64 32</p><blockquote><p>Our side uses your configured <code>SignatureKey</code> to calculate an HMAC-SHA256 signature over "timestamp (<code>X-Webhook-Timestamp</code>) + <code>.</code> + request body", and puts the hexadecimal result in the request header <code>X-Webhook-Signature</code>. The message itself is unencrypted and transmitted over HTTPS. Use the same key to recalculate and compare the signature by the same rule to confirm that the notification source is trustworthy and the content has not been tampered with.</p></blockquote>
7355
+ * @type {string || null}
7356
+ */
7357
+ this.SignatureKey = null;
7358
+
7349
7359
  }
7350
7360
 
7351
7361
  /**
@@ -7357,6 +7367,8 @@ class CreateEKYCWebhookRequest extends AbstractModel {
7357
7367
  }
7358
7368
  this.WebhookName = 'WebhookName' in params ? params.WebhookName : null;
7359
7369
  this.WebhookURL = 'WebhookURL' in params ? params.WebhookURL : null;
7370
+ this.Scene = 'Scene' in params ? params.Scene : null;
7371
+ this.SignatureKey = 'SignatureKey' in params ? params.SignatureKey : null;
7360
7372
 
7361
7373
  }
7362
7374
  }
@@ -7848,13 +7860,13 @@ class UpdateAMLCustomerProfileResponse extends AbstractModel {
7848
7860
  this.Result = null;
7849
7861
 
7850
7862
  /**
7851
- * <p>Description of results returned</p>
7863
+ * <p>Return result description</p>
7852
7864
  * @type {string || null}
7853
7865
  */
7854
7866
  this.Description = null;
7855
7867
 
7856
7868
  /**
7857
- * Whether continuous monitoring screening is enabled
7869
+ * <p>Whether continuous monitoring and screening is enabled</p>
7858
7870
  * @type {boolean || null}
7859
7871
  */
7860
7872
  this.EnableOngoingScreening = null;
@@ -8307,11 +8319,17 @@ class UpdateEKYCWebhookRequest extends AbstractModel {
8307
8319
  this.WebhookName = null;
8308
8320
 
8309
8321
  /**
8310
- * New callback URL, which must use the HTTPS protocol.
8322
+ * <p>New callback URL, must be HTTPS protocol</p>
8311
8323
  * @type {string || null}
8312
8324
  */
8313
8325
  this.WebhookURL = null;
8314
8326
 
8327
+ /**
8328
+ * <p>Callback signature key, up to 128 characters. Used for HMAC-SHA256 signature verification of subsequent callback messages. If not provided, signature is not enabled. We recommend using OpenSSL random bytes to generate the key. Recommended command: openssl rand -base64 32 </p><blockquote><p>Our side uses your configured <code>SignatureKey</code> to calculate the HMAC-SHA256 signature over "timestamp (<code>X-Webhook-Timestamp</code>) + <code>.</code> + request body", and puts the hexadecimal result in the request header <code>X-Webhook-Signature</code>. The message itself is unencrypted and transmitted over HTTPS. Use the same key to recalculate and compare the signature following the same rule to confirm that the notification source is trustworthy and the content has not been tampered with.</p></blockquote>
8329
+ * @type {string || null}
8330
+ */
8331
+ this.SignatureKey = null;
8332
+
8315
8333
  }
8316
8334
 
8317
8335
  /**
@@ -8324,6 +8342,7 @@ class UpdateEKYCWebhookRequest extends AbstractModel {
8324
8342
  this.WebhookId = 'WebhookId' in params ? params.WebhookId : null;
8325
8343
  this.WebhookName = 'WebhookName' in params ? params.WebhookName : null;
8326
8344
  this.WebhookURL = 'WebhookURL' in params ? params.WebhookURL : null;
8345
+ this.SignatureKey = 'SignatureKey' in params ? params.SignatureKey : null;
8327
8346
 
8328
8347
  }
8329
8348
  }
@@ -8604,27 +8623,25 @@ class RunAMLNameScreeningRequest extends AbstractModel {
8604
8623
  this.UniqueCustomerID = null;
8605
8624
 
8606
8625
  /**
8607
- * Entity type. Enumeration values: PERSON (individual) / COMPANY (company).
8626
+ * <p>Entity type. Enumeration values: PERSON / COMPANY</p><p>Enumeration values:</p><ul><li>PERSON: individual</li><li>COMPANY: company</li></ul>
8608
8627
  * @type {string || null}
8609
8628
  */
8610
8629
  this.EntityType = null;
8611
8630
 
8612
8631
  /**
8613
- * Personal information, required when EntityType=PERSON.
8614
- Input restriction: EntityType=PERSON.
8632
+ * <p>Personal info, required when EntityType=PERSON</p><p>Input limitation: EntityType=PERSON</p>
8615
8633
  * @type {Person || null}
8616
8634
  */
8617
8635
  this.Person = null;
8618
8636
 
8619
8637
  /**
8620
- * Enterprise information, required when EntityType=COMPANY.
8621
- Input restriction: EntityType=COMPANY.
8638
+ * <p>Enterprise info. Required when EntityType=COMPANY</p><p>Input limitation: EntityType=COMPANY</p>
8622
8639
  * @type {Company || null}
8623
8640
  */
8624
8641
  this.Company = null;
8625
8642
 
8626
8643
  /**
8627
- * Whether continuous monitoring screening is enabled. Default value: false.
8644
+ * <p>Whether continuous monitoring and screening is enabled. Default value: false</p><p>Default value: false</p>
8628
8645
  * @type {boolean || null}
8629
8646
  */
8630
8647
  this.EnableOngoingScreening = null;