tencentcloud-sdk-nodejs-intl-en 3.0.1438 → 3.0.1439

package/tencentcloud/ocr/v20181119/models.js

@@ -653,176 +653,6 @@ ItemNames=["Name","Gender"]
     }
 }
 
-/**
- * RecognizeThaiIDCardOCR response structure.
- * @class
- */
-class RecognizeThaiIDCardOCRResponse extends  AbstractModel {
-    constructor(){
-        super();
-
-        /**
-         * ID card number
-         * @type {string || null}
-         */
-        this.ID = null;
-
-        /**
-         * Name in Thai
-         * @type {string || null}
-         */
-        this.ThaiName = null;
-
-        /**
-         * First name in English
-         * @type {string || null}
-         */
-        this.EnFirstName = null;
-
-        /**
-         * Last name in English
-         * @type {string || null}
-         */
-        this.EnLastName = null;
-
-        /**
-         * Date of issue in Thai
-         * @type {string || null}
-         */
-        this.IssueDate = null;
-
-        /**
-         * Expiration date in Thai
-         * @type {string || null}
-         */
-        this.ExpirationDate = null;
-
-        /**
-         * Date of issue in English
-         * @type {string || null}
-         */
-        this.EnIssueDate = null;
-
-        /**
-         * Expiration date in English
-         * @type {string || null}
-         */
-        this.EnExpirationDate = null;
-
-        /**
-         * Date of birth in Thai
-         * @type {string || null}
-         */
-        this.Birthday = null;
-
-        /**
-         * Date of birth in English
-         * @type {string || null}
-         */
-        this.EnBirthday = null;
-
-        /**
-         * Religion
-         * @type {string || null}
-         */
-        this.Religion = null;
-
-        /**
-         * Serial number
-         * @type {string || null}
-         */
-        this.SerialNumber = null;
-
-        /**
-         * Address
-         * @type {string || null}
-         */
-        this.Address = null;
-
-        /**
-         * Laser ID on the back of the card.
-         * @type {string || null}
-         */
-        this.LaserID = null;
-
-        /**
-         * Identity photo
-         * @type {string || null}
-         */
-        this.PortraitImage = null;
-
-        /**
-         * Card Warning Information
-
--9101 Alarm for covered certificate,
--9102 Alarm for photocopied certificate,
--9103 Alarm for photographed certificate,
--9104 Alarm for PS certificate,
--9107 Alarm for reflective certificate,
--9108 Alarm for blurry image,
--9109 This capability is not enabled.
-         * @type {Array.<number> || null}
-         */
-        this.WarnCardInfos = null;
-
-        /**
-         * This field is deprecated and will always return "1". Usage is not recommended.
-         * @type {string || null}
-         */
-        this.AdvancedInfo = null;
-
-        /**
-         * The number of cards detected in the input image provided via ImageBase64 parameter.(Currently supported only in ap-bangkok region)
-         * @type {number || null}
-         */
-        this.CardCount = null;
-
-        /**
-         * The card information field complete or not
-true: complete; false: incomplete
-         * @type {boolean || null}
-         */
-        this.IsComplete = null;
-
-        /**
-         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
-         * @type {string || null}
-         */
-        this.RequestId = null;
-
-    }
-
-    /**
-     * @private
-     */
-    deserialize(params) {
-        if (!params) {
-            return;
-        }
-        this.ID = 'ID' in params ? params.ID : null;
-        this.ThaiName = 'ThaiName' in params ? params.ThaiName : null;
-        this.EnFirstName = 'EnFirstName' in params ? params.EnFirstName : null;
-        this.EnLastName = 'EnLastName' in params ? params.EnLastName : null;
-        this.IssueDate = 'IssueDate' in params ? params.IssueDate : null;
-        this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
-        this.EnIssueDate = 'EnIssueDate' in params ? params.EnIssueDate : null;
-        this.EnExpirationDate = 'EnExpirationDate' in params ? params.EnExpirationDate : null;
-        this.Birthday = 'Birthday' in params ? params.Birthday : null;
-        this.EnBirthday = 'EnBirthday' in params ? params.EnBirthday : null;
-        this.Religion = 'Religion' in params ? params.Religion : null;
-        this.SerialNumber = 'SerialNumber' in params ? params.SerialNumber : null;
-        this.Address = 'Address' in params ? params.Address : null;
-        this.LaserID = 'LaserID' in params ? params.LaserID : null;
-        this.PortraitImage = 'PortraitImage' in params ? params.PortraitImage : null;
-        this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
-        this.AdvancedInfo = 'AdvancedInfo' in params ? params.AdvancedInfo : null;
-        this.CardCount = 'CardCount' in params ? params.CardCount : null;
-        this.IsComplete = 'IsComplete' in params ? params.IsComplete : null;
-        this.RequestId = 'RequestId' in params ? params.RequestId : null;
-
-    }
-}
-
 /**
  * RecognizeBrazilCommonOCR response structure.
  * @class
@@ -2674,6 +2504,95 @@ class GeneralAccurateOCRResponse extends  AbstractModel {
     }
 }
 
+/**
+ * HmtResidentPermitOCR request structure.
+ * @class
+ */
+class HmtResidentPermitOCRRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Base64 value of the image. Supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. Supported image size: no more than 7M after the downloaded image is Base64-encoded. The image download must complete within 3 seconds.Either ImageUrl or ImageBase64 must be provided. If both are provided, only ImageUrl is used.</p>
+         * @type {string || null}
+         */
+        this.ImageBase64 = null;
+
+        /**
+         * <p>Image URL.Supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. Supported image size: no more than 7M after Base64 encoding. Image download time no more than 3 seconds. URLs stored in Tencent Cloud guarantee higher download speed and stability. It is recommended to store images in Tencent Cloud. Speed and stability may be impacted for URLs not stored in Tencent Cloud.</p>
+         * @type {string || null}
+         */
+        this.ImageUrl = null;
+
+        /**
+         * <p>FRONT: the side with a photo (portrait side),<br>BACK: the side without a photo (national emblem side),<br>if this parameter is left empty or incorrect, the front or back side is automatically determined for you.</p>
+         * @type {string || null}
+         */
+        this.CardSide = null;
+
+        /**
+         * Whether to return the portrait image and position coordinates
+         * @type {boolean || null}
+         */
+        this.CropPortrait = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
+        this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
+        this.CardSide = 'CardSide' in params ? params.CardSide : null;
+        this.CropPortrait = 'CropPortrait' in params ? params.CropPortrait : null;
+
+    }
+}
+
+/**
+ * Avatar photo and coordinates
+ * @class
+ */
+class PortraitImageInfo extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Avatar</p>
+         * @type {string || null}
+         */
+        this.PortraitImage = null;
+
+        /**
+         * <p>Avatar coordinate</p>
+         * @type {ImageCoordinates || null}
+         */
+        this.ImageCoordinates = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.PortraitImage = 'PortraitImage' in params ? params.PortraitImage : null;
+
+        if (params.ImageCoordinates) {
+            let obj = new ImageCoordinates();
+            obj.deserialize(params.ImageCoordinates)
+            this.ImageCoordinates = obj;
+        }
+
+    }
+}
+
 /**
  * GeneralBasicOCR response structure.
  * @class
@@ -2745,32 +2664,142 @@ class GeneralBasicOCRResponse extends  AbstractModel {
     }
 }
 
-/**
- * VinOCR request structure.
- * @class
- */
-class VinOCRRequest extends  AbstractModel {
-    constructor(){
-        super();
+/**
+ * RecognizeThaiIDCardOCR response structure.
+ * @class
+ */
+class RecognizeThaiIDCardOCRResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * ID card number
+         * @type {string || null}
+         */
+        this.ID = null;
+
+        /**
+         * Name in Thai
+         * @type {string || null}
+         */
+        this.ThaiName = null;
+
+        /**
+         * First name in English
+         * @type {string || null}
+         */
+        this.EnFirstName = null;
+
+        /**
+         * Last name in English
+         * @type {string || null}
+         */
+        this.EnLastName = null;
+
+        /**
+         * Date of issue in Thai
+         * @type {string || null}
+         */
+        this.IssueDate = null;
+
+        /**
+         * Expiration date in Thai
+         * @type {string || null}
+         */
+        this.ExpirationDate = null;
+
+        /**
+         * Date of issue in English
+         * @type {string || null}
+         */
+        this.EnIssueDate = null;
+
+        /**
+         * Expiration date in English
+         * @type {string || null}
+         */
+        this.EnExpirationDate = null;
+
+        /**
+         * Date of birth in Thai
+         * @type {string || null}
+         */
+        this.Birthday = null;
+
+        /**
+         * Date of birth in English
+         * @type {string || null}
+         */
+        this.EnBirthday = null;
+
+        /**
+         * Religion
+         * @type {string || null}
+         */
+        this.Religion = null;
+
+        /**
+         * Serial number
+         * @type {string || null}
+         */
+        this.SerialNumber = null;
+
+        /**
+         * Address
+         * @type {string || null}
+         */
+        this.Address = null;
+
+        /**
+         * Laser ID on the back of the card.
+         * @type {string || null}
+         */
+        this.LaserID = null;
+
+        /**
+         * Identity photo
+         * @type {string || null}
+         */
+        this.PortraitImage = null;
+
+        /**
+         * Card Warning Information
+
+-9101 Alarm for covered certificate
+-9102 Alarm for photocopied certificate
+-9103 Alarm for photographed certificate
+-9104 Alarm for tamper certificate
+-9107 Alarm for reflective certificate
+-9108 Alarm for blurry certificate 
+-9109 This capability is not enabled. Please contact customer support to activate the alert service
+         * @type {Array.<number> || null}
+         */
+        this.WarnCardInfos = null;
 
         /**
-         * The Base64-encoded value of the image.
-Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
-Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
-Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.
+         * This field is deprecated and will always return "1". Usage is not recommended.
          * @type {string || null}
          */
-        this.ImageBase64 = null;
+        this.AdvancedInfo = null;
 
         /**
-         * The URL of the image.
-Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
-Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
-We recommend that you store the image in Tencent Cloud for higher download speed and stability.
-The download speed and stability of non-Tencent Cloud URLs may be low.
+         * The number of cards detected in the input image provided via ImageBase64 parameter.(Currently supported only in ap-bangkok region)
+         * @type {number || null}
+         */
+        this.CardCount = null;
+
+        /**
+         * The card information field complete or not
+true: complete; false: incomplete
+         * @type {boolean || null}
+         */
+        this.IsComplete = null;
+
+        /**
+         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
          * @type {string || null}
          */
-        this.ImageUrl = null;
+        this.RequestId = null;
 
     }
 
@@ -2781,8 +2810,26 @@ The download speed and stability of non-Tencent Cloud URLs may be low.
         if (!params) {
             return;
         }
-        this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
-        this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
+        this.ID = 'ID' in params ? params.ID : null;
+        this.ThaiName = 'ThaiName' in params ? params.ThaiName : null;
+        this.EnFirstName = 'EnFirstName' in params ? params.EnFirstName : null;
+        this.EnLastName = 'EnLastName' in params ? params.EnLastName : null;
+        this.IssueDate = 'IssueDate' in params ? params.IssueDate : null;
+        this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
+        this.EnIssueDate = 'EnIssueDate' in params ? params.EnIssueDate : null;
+        this.EnExpirationDate = 'EnExpirationDate' in params ? params.EnExpirationDate : null;
+        this.Birthday = 'Birthday' in params ? params.Birthday : null;
+        this.EnBirthday = 'EnBirthday' in params ? params.EnBirthday : null;
+        this.Religion = 'Religion' in params ? params.Religion : null;
+        this.SerialNumber = 'SerialNumber' in params ? params.SerialNumber : null;
+        this.Address = 'Address' in params ? params.Address : null;
+        this.LaserID = 'LaserID' in params ? params.LaserID : null;
+        this.PortraitImage = 'PortraitImage' in params ? params.PortraitImage : null;
+        this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
+        this.AdvancedInfo = 'AdvancedInfo' in params ? params.AdvancedInfo : null;
+        this.CardCount = 'CardCount' in params ? params.CardCount : null;
+        this.IsComplete = 'IsComplete' in params ? params.IsComplete : null;
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
 
     }
 }
@@ -5973,6 +6020,177 @@ Note: Only supported for the back side of the Mainland Travel Permit for Hong Ko
     }
 }
 
+/**
+ * HmtResidentPermitOCR response structure.
+ * @class
+ */
+class HmtResidentPermitOCRResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Name on the document</p>
+         * @type {string || null}
+         */
+        this.Name = null;
+
+        /**
+         * <p>Gender</p>
+         * @type {string || null}
+         */
+        this.Sex = null;
+
+        /**
+         * <p>Date of birth</p>
+         * @type {string || null}
+         */
+        this.Birth = null;
+
+        /**
+         * <p>Address</p>
+         * @type {string || null}
+         */
+        this.Address = null;
+
+        /**
+         * <p>Identity card number</p>
+         * @type {string || null}
+         */
+        this.IdCardNo = null;
+
+        /**
+         * <p>0-Front<br>1-Back</p>
+         * @type {number || null}
+         */
+        this.CardType = null;
+
+        /**
+         * <p>Document validity period</p>
+         * @type {string || null}
+         */
+        this.ValidDate = null;
+
+        /**
+         * <p>Issuing authority</p>
+         * @type {string || null}
+         */
+        this.Authority = null;
+
+        /**
+         * <p>Number of issuances</p>
+         * @type {string || null}
+         */
+        this.VisaNum = null;
+
+        /**
+         * Travel permit number
+         * @type {string || null}
+         */
+        this.PassNo = null;
+
+        /**
+         * Portrait image and coordinate information
+         * @type {PortraitImageInfo || null}
+         */
+        this.PortraitImageInfo = null;
+
+        /**
+         * Card Warning Information
+
+-9102 Alarm for photocopied certificate
+-9103 Alarm for photographed certificate
+-9104 Alarm for tamper certificate
+-9109 This capability is not enabled. Please contact customer support to activate the alert service
+         * @type {Array.<number> || null}
+         */
+        this.WarnCardInfos = null;
+
+        /**
+         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
+         * @type {string || null}
+         */
+        this.RequestId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.Name = 'Name' in params ? params.Name : null;
+        this.Sex = 'Sex' in params ? params.Sex : null;
+        this.Birth = 'Birth' in params ? params.Birth : null;
+        this.Address = 'Address' in params ? params.Address : null;
+        this.IdCardNo = 'IdCardNo' in params ? params.IdCardNo : null;
+        this.CardType = 'CardType' in params ? params.CardType : null;
+        this.ValidDate = 'ValidDate' in params ? params.ValidDate : null;
+        this.Authority = 'Authority' in params ? params.Authority : null;
+        this.VisaNum = 'VisaNum' in params ? params.VisaNum : null;
+        this.PassNo = 'PassNo' in params ? params.PassNo : null;
+
+        if (params.PortraitImageInfo) {
+            let obj = new PortraitImageInfo();
+            obj.deserialize(params.PortraitImageInfo)
+            this.PortraitImageInfo = obj;
+        }
+        this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
+/**
+ * Avatar position coordinates
+ * @class
+ */
+class ImageCoordinates extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Top-left horizontal coordinate of the avatar</p>
+         * @type {number || null}
+         */
+        this.X = null;
+
+        /**
+         * <p>Top-left vertical coordinate of the avatar</p>
+         * @type {number || null}
+         */
+        this.Y = null;
+
+        /**
+         * <p>Avatar frame width.</p><p>Unit: px.</p>
+         * @type {number || null}
+         */
+        this.Width = null;
+
+        /**
+         * <p>Avatar frame height.</p><p>Unit: px.</p>
+         * @type {number || null}
+         */
+        this.Height = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.X = 'X' in params ? params.X : null;
+        this.Y = 'Y' in params ? params.Y : null;
+        this.Width = 'Width' in params ? params.Width : null;
+        this.Height = 'Height' in params ? params.Height : null;
+
+    }
+}
+
 /**
  * RecognizeMexicoVTID request structure.
  * @class
@@ -6485,6 +6703,48 @@ class AnalyzedLog extends  AbstractModel {
     }
 }
 
+/**
+ * VinOCR request structure.
+ * @class
+ */
+class VinOCRRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The Base64-encoded value of the image.
+Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
+Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
+Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.
+         * @type {string || null}
+         */
+        this.ImageBase64 = null;
+
+        /**
+         * The URL of the image.
+Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
+Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
+We recommend that you store the image in Tencent Cloud for higher download speed and stability.
+The download speed and stability of non-Tencent Cloud URLs may be low.
+         * @type {string || null}
+         */
+        this.ImageUrl = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
+        this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
+
+    }
+}
+
 /**
  * BrazilRNEInfo
  * @class
@@ -7341,7 +7601,6 @@ module.exports = {
     MLIDPassportOCRRequest: MLIDPassportOCRRequest,
     ItemInfo: ItemInfo,
     SmartStructuralOCRV2Request: SmartStructuralOCRV2Request,
-    RecognizeThaiIDCardOCRResponse: RecognizeThaiIDCardOCRResponse,
     RecognizeBrazilCommonOCRResponse: RecognizeBrazilCommonOCRResponse,
     RecognizeMacaoIDCardOCRResponse: RecognizeMacaoIDCardOCRResponse,
     GetCardVerificationExternalResultResponse: GetCardVerificationExternalResultResponse,
@@ -7364,8 +7623,10 @@ module.exports = {
     LineInfo: LineInfo,
     BrazilDriverLicenseInfo: BrazilDriverLicenseInfo,
     GeneralAccurateOCRResponse: GeneralAccurateOCRResponse,
+    HmtResidentPermitOCRRequest: HmtResidentPermitOCRRequest,
+    PortraitImageInfo: PortraitImageInfo,
     GeneralBasicOCRResponse: GeneralBasicOCRResponse,
-    VinOCRRequest: VinOCRRequest,
+    RecognizeThaiIDCardOCRResponse: RecognizeThaiIDCardOCRResponse,
     RecognizePhilippinesUMIDOCRRequest: RecognizePhilippinesUMIDOCRRequest,
     RecognizePhilippinesSssIDOCRRequest: RecognizePhilippinesSssIDOCRRequest,
     Key: Key,
@@ -7404,6 +7665,8 @@ module.exports = {
     SmartStructuralOCRV2Response: SmartStructuralOCRV2Response,
     RecognizeMainlandIDCardOCRResponse: RecognizeMainlandIDCardOCRResponse,
     MainlandPermitOCRResponse: MainlandPermitOCRResponse,
+    HmtResidentPermitOCRResponse: HmtResidentPermitOCRResponse,
+    ImageCoordinates: ImageCoordinates,
     RecognizeMexicoVTIDRequest: RecognizeMexicoVTIDRequest,
     PODAuditAIResponse: PODAuditAIResponse,
     MainlandTravelPermitBackInfos: MainlandTravelPermitBackInfos,
@@ -7412,6 +7675,7 @@ module.exports = {
     BrazilCardInfo: BrazilCardInfo,
     RecognizeIndonesiaIDCardOCRRequest: RecognizeIndonesiaIDCardOCRRequest,
     AnalyzedLog: AnalyzedLog,
+    VinOCRRequest: VinOCRRequest,
     BrazilRNEInfo: BrazilRNEInfo,
     MLIDCardOCRResponse: MLIDCardOCRResponse,
     RecognizePhilippinesTinIDOCRRequest: RecognizePhilippinesTinIDOCRRequest,