@alicloud/cloudauth20190307 3.9.4 → 3.10.0

package/src/models/ContrastFaceVerifyAdvanceRequest.ts

@@ -4,77 +4,170 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ContrastFaceVerifyAdvanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Real name.
+   * 
+   * @example
+   * 张三
+   */
   certName?: string;
   /**
+   * @remarks
+   * ID number
+   * 
    * @example
    * 330103xxxxxxxxxxxx
    */
   certNo?: string;
   /**
+   * @remarks
+   * Type of identification. Currently, only IDENTITY_CARD is supported and must be provided.
+   * 
    * @example
    * IDENTITY_CARD
    */
   certType?: string;
   /**
+   * @remarks
+   * The CertifyId of a previously passed real-person authentication, with the photo taken during that authentication used as the comparison photo. 
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to provide.
+   * 
    * @example
    * 0bfa7c493f850e5178b9f8613634c9xx
    */
   certifyId?: string;
+  /**
+   * @remarks
+   * Allow face image cropping:
+   * 
+   * -  **T** – Cropping is allowed.
+   * -  **F** (default) – Cropping is not allowed.
+   * 
+   * @example
+   * T
+   */
   crop?: string;
   /**
+   * @remarks
+   * Risk Identification - Device Token
+   * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
    */
   deviceToken?: string;
+  /**
+   * @remarks
+   * Encryption type. Leave it empty if no encryption is required.
+   * 
+   * If you enable encrypted transmission, you must specify the encryption algorithm; currently, only the SM2 (Chinese national standard) algorithm is supported.
+   * 
+   * When an encryption algorithm is specified, encrypt both **CertName** and **CertNo** and submit the resulting ciphertext. For more details on parameter encryption, see the [Parameter Encryption documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.49541a8554cELI#task-2229332).
+   * 
+   * @example
+   * SM2
+   */
   encryptType?: string;
+  /**
+   * @remarks
+   * Local video file.
+   * 
+   * @example
+   * -
+   */
   faceContrastFileObject?: Readable;
   /**
+   * @remarks
+   * Base64 encoded photo
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   faceContrastPicture?: string;
   /**
+   * @remarks
+   * OSS photo URL, currently only supports authorized OSS photo URLs.
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   faceContrastPictureUrl?: string;
   /**
+   * @remarks
+   * User IP.
+   * 
    * @example
    * 114.xxx.xxx.xxx
    */
   ip?: string;
   /**
+   * @remarks
+   * User\\"s phone number.
+   * 
    * @example
    * 130xxxxxxxx
    */
   mobile?: string;
+  /**
+   * @remarks
+   * Liveness detection type. Possible values:
+   * 
+   * • **NO_LIVENESS** – Liveness detection is disabled.
+   * 
+   * • **FRONT_CAMERA_LIVENESS** (default) – Liveness detection on face images captured with the mobile device’s front camera.
+   * 
+   * • **REAR_CAMERA_LIVENESS** – Liveness detection on face images captured in other scenarios (e.g., via the rear camera).
+   * 
+   * @example
+   * FRONT_CAMERA_LIVENESS
+   */
   model?: string;
   /**
+   * @remarks
+   * Authorized OSS space Bucket name. In the methods of passing images, including FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS, choose one to pass in.
+   * 
    * @example
    * cn-shanghai-aliyun-cloudauth-xxxxx
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * Filename of the authorized OSS space.
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+   * 
    * @example
    * verify/xxxxx/xxxxxx.jpeg
    */
   ossObjectName?: string;
   /**
+   * @remarks
+   * A unique identifier for the merchant\\"s request. It is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incrementing sequence.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
    */
   outerOrderNo?: string;
   /**
+   * @remarks
+   * Fixed value: ID_MIN.
+   * 
    * @example
    * ID_MIN
    */
   productCode?: string;
   /**
+   * @remarks
+   * Authentication scenario ID.
+   * 
    * @example
    * 1000000006
    */
   sceneId?: number;
   /**
+   * @remarks
+   * Custom user ID defined by the customer\\"s business.
+   * 
    * @example
    * 123456789
    */

package/src/models/ContrastFaceVerifyRequest.ts

@@ -3,77 +3,170 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ContrastFaceVerifyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Real name.
+   * 
+   * @example
+   * 张三
+   */
   certName?: string;
   /**
+   * @remarks
+   * ID number
+   * 
    * @example
    * 330103xxxxxxxxxxxx
    */
   certNo?: string;
   /**
+   * @remarks
+   * Type of identification. Currently, only IDENTITY_CARD is supported and must be provided.
+   * 
    * @example
    * IDENTITY_CARD
    */
   certType?: string;
   /**
+   * @remarks
+   * The CertifyId of a previously passed real-person authentication, with the photo taken during that authentication used as the comparison photo. 
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to provide.
+   * 
    * @example
    * 0bfa7c493f850e5178b9f8613634c9xx
    */
   certifyId?: string;
+  /**
+   * @remarks
+   * Allow face image cropping:
+   * 
+   * -  **T** – Cropping is allowed.
+   * -  **F** (default) – Cropping is not allowed.
+   * 
+   * @example
+   * T
+   */
   crop?: string;
   /**
+   * @remarks
+   * Risk Identification - Device Token
+   * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
    */
   deviceToken?: string;
+  /**
+   * @remarks
+   * Encryption type. Leave it empty if no encryption is required.
+   * 
+   * If you enable encrypted transmission, you must specify the encryption algorithm; currently, only the SM2 (Chinese national standard) algorithm is supported.
+   * 
+   * When an encryption algorithm is specified, encrypt both **CertName** and **CertNo** and submit the resulting ciphertext. For more details on parameter encryption, see the [Parameter Encryption documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.49541a8554cELI#task-2229332).
+   * 
+   * @example
+   * SM2
+   */
   encryptType?: string;
+  /**
+   * @remarks
+   * Local video file.
+   * 
+   * @example
+   * -
+   */
   faceContrastFile?: string;
   /**
+   * @remarks
+   * Base64 encoded photo
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   faceContrastPicture?: string;
   /**
+   * @remarks
+   * OSS photo URL, currently only supports authorized OSS photo URLs.
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   faceContrastPictureUrl?: string;
   /**
+   * @remarks
+   * User IP.
+   * 
    * @example
    * 114.xxx.xxx.xxx
    */
   ip?: string;
   /**
+   * @remarks
+   * User\\"s phone number.
+   * 
    * @example
    * 130xxxxxxxx
    */
   mobile?: string;
+  /**
+   * @remarks
+   * Liveness detection type. Possible values:
+   * 
+   * • **NO_LIVENESS** – Liveness detection is disabled.
+   * 
+   * • **FRONT_CAMERA_LIVENESS** (default) – Liveness detection on face images captured with the mobile device’s front camera.
+   * 
+   * • **REAR_CAMERA_LIVENESS** – Liveness detection on face images captured in other scenarios (e.g., via the rear camera).
+   * 
+   * @example
+   * FRONT_CAMERA_LIVENESS
+   */
   model?: string;
   /**
+   * @remarks
+   * Authorized OSS space Bucket name. In the methods of passing images, including FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS, choose one to pass in.
+   * 
    * @example
    * cn-shanghai-aliyun-cloudauth-xxxxx
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * Filename of the authorized OSS space.
+   * > Among the four ways to input images (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+   * 
    * @example
    * verify/xxxxx/xxxxxx.jpeg
    */
   ossObjectName?: string;
   /**
+   * @remarks
+   * A unique identifier for the merchant\\"s request. It is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incrementing sequence.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
    */
   outerOrderNo?: string;
   /**
+   * @remarks
+   * Fixed value: ID_MIN.
+   * 
    * @example
    * ID_MIN
    */
   productCode?: string;
   /**
+   * @remarks
+   * Authentication scenario ID.
+   * 
    * @example
    * 1000000006
    */
   sceneId?: number;
   /**
+   * @remarks
+   * Custom user ID defined by the customer\\"s business.
+   * 
    * @example
    * 123456789
    */

package/src/models/ContrastFaceVerifyResponseBody.ts

@@ -3,23 +3,42 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ContrastFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Unique identifier for the real-person verification request.
+   * 
+   * @example
+   * 91707dc296d469ad38e4c5efa6a0****
+   */
   certifyId?: string;
   /**
+   * @remarks
+   * Information about the authenticated entity, which is usually empty in general authentication scenarios.
+   * 
    * @example
    * null
    */
   identityInfo?: string;
   /**
+   * @remarks
+   * Attachment information of the authenticated entity, mainly image materials, in JSON format, as follows.
+   * 
    * @example
    * {"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"verifyScore": 50.28594166529785}}
    */
   materialInfo?: string;
   /**
+   * @remarks
+   * Whether it passed, T for pass, F for fail.
+   * 
    * @example
    * T
    */
   passed?: string;
   /**
+   * @remarks
+   * Description of the authentication result. For details, see the SubCode explanation below.
+   * 
    * @example
    * 200
    */
@@ -55,20 +74,33 @@ export class ContrastFaceVerifyResponseBodyResultObject extends $dara.Model {
 
 export class ContrastFaceVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Request result
+   */
   resultObject?: ContrastFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateAuthKeyRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAuthKeyRequest extends $dara.Model {
   /**
+   * @remarks
+   * When the Test flag is false or empty, AuthYears is required, in years, with a range of [1,100]. A value of 100 indicates permanent authorization.
+   * 
    * @example
    * 1
    */
   authYears?: number;
   /**
+   * @remarks
+   * Business type. No more than 64 characters. Can be used to note specific business, such as different face usage scenarios of the access party or the customer identifier to be delivered. It is recommended to pass this parameter.
+   * 
    * @example
    * FACE_TEST
    */
   bizType?: string;
   /**
+   * @remarks
+   * Test flag. If true, it indicates using test authorization with a default duration of 30 days; if false, the authorization duration will be based on AuthYears.
+   * 
    * @example
    * false
    */
   test?: boolean;
   /**
+   * @remarks
+   * User device ID. No more than 64 characters. Can be used to identify a specific device, and it is suggested to use the physical number of the device. It is recommended to pass this parameter.
+   * 
    * @example
    * 3iJ1AY$oHcu7mC69
    */

package/src/models/CreateAuthKeyResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAuthKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The key that can be used for authorization activation. The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
+   * 
    * @example
    * auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$
    */
   authKey?: string;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */

package/src/models/CreateVerifySettingRequest.ts

@@ -5,11 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class CreateVerifySettingRequest extends $dara.Model {
   /**
    * @remarks
+   * Verification scenario name, supporting Chinese, English, numbers, and hyphens (-), with a maximum of 20 characters.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 用户注册
    */
   bizName?: string;
   /**
    * @remarks
+   * Verification scenario identifier, supporting English letters, numbers, and hyphens (-), with a maximum of 20 characters.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,22 +24,33 @@ export class CreateVerifySettingRequest extends $dara.Model {
    */
   bizType?: string;
   /**
+   * @remarks
+   * Whether to use the system\\"s default guide page.
+   * 
    * @example
    * false
    */
   guideStep?: boolean;
   /**
+   * @remarks
+   * Whether to use the system\\"s default authorization page.
+   * 
    * @example
    * true
    */
   privacyStep?: boolean;
   /**
+   * @remarks
+   * Whether to use the system\\"s default result page.
+   * 
    * @example
    * false
    */
   resultStep?: boolean;
   /**
    * @remarks
+   * The name of the authentication solution to use, such as **RPBasic**, **RPBioOnly**, etc. For all supported authentication solutions, see [Authentication Solutions](https://help.aliyun.com/document_detail/127521.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateVerifySettingResponseBody.ts

@@ -3,22 +3,42 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateVerifySettingResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Verification scenario name.
+   * 
+   * @example
+   * 用户注册
+   */
   bizName?: string;
   /**
+   * @remarks
+   * Verification scenario identifier.
+   * 
    * @example
    * UserRegister
    */
   bizType?: string;
   /**
+   * @remarks
+   * ID of this request.
+   * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
    */
   requestId?: string;
   /**
+   * @remarks
+   * Authentication solution name.
+   * 
    * @example
    * RPBasic
    */
   solution?: string;
+  /**
+   * @remarks
+   * Authentication steps
+   */
   stepList?: string[];
   static names(): { [key: string]: string } {
     return {