@alicloud/cloudauth20190307 3.9.1 → 3.9.3

package/src/models/Id2metaStandardVerifyResponseBody.ts

@@ -1,27 +1,69 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { Id2MetaStandardVerifyResponseBodyResultObject } from "./Id2metaStandardVerifyResponseBodyResultObject";
 
 
+export class Id2MetaStandardVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Verification result code:
+   * - **1**: verification matches.
+   * - **2**: verification does not match.
+   * - **3**: no record found.
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class Id2MetaStandardVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information.
+   */
   resultObject?: Id2MetaStandardVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/Id2metaVerifyRequest.ts

@@ -3,8 +3,52 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class Id2MetaVerifyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * ID number:
+   * 
+   * Note
+   * Only supports the ID numbers of second-generation resident IDs and Hong Kong, Macao, and Taiwan residence permits.
+   * 
+   * - When paramType is normal: enter the plaintext ID number.
+   * 
+   * - When paramType is md5: first 6 digits of the ID number (plaintext) + date of birth (ciphertext) + last 4 digits of the ID number (plaintext).
+   * 
+   * @example
+   * 明文：429001********8211
+   * 
+   * 密文：
+   * 
+   * 42900132fa7bcd874161bea8ec8fd98f390ec98211
+   */
   identifyNum?: string;
+  /**
+   * @remarks
+   * Encryption method:
+   * 
+   * - normal: plaintext, no encryption
+   * 
+   * - md5: MD5 encryption
+   * 
+   * @example
+   * normal
+   */
   paramType?: string;
+  /**
+   * @remarks
+   * Name:
+   * 
+   * - When paramType is normal: enter the plaintext name.
+   * 
+   * - When paramType is md5: first character of the name in ciphertext + rest of the name in plaintext.
+   * 
+   * @example
+   * 明文：张三
+   * 
+   * 密文：
+   * 
+   * 6499fc7409049355527ef6a2ba5706b8三​
+   */
   userName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/Id2metaVerifyResponseBody.ts

@@ -1,24 +1,69 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { Id2MetaVerifyResponseBodyResultObject } from "./Id2metaVerifyResponseBodyResultObject";
 
 
+export class Id2MetaVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Verification result code:
+   * - **1**: Verification consistent.
+   * - **2**: Verification inconsistent.
+   * - **3**: No record found.
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class Id2MetaVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code, **200** indicates successful API response.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information.
+   */
   resultObject?: Id2MetaVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/Id2metaVerifyWithOcradvanceRequest.ts

@@ -4,14 +4,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class Id2MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Input stream for the portrait side of the ID card image.
+   * Choose one between CertUrl and CertFile.
+   * 
+   * @example
+   * 无
+   */
   certFileObject?: Readable;
+  /**
+   * @remarks
+   * National emblem side of the ID card image address.
+   * Choose one between CertNationalUrl and CertNationalFile, or omit both.
+   * 
+   * @example
+   * 无
+   */
   certNationalFileObject?: Readable;
   /**
+   * @remarks
+   * National emblem side of the ID card image URL. National emblem side
+   * A publicly accessible HTTP or HTTPS link.
+   * Choose one between CertNationalUrl and CertNationalFile, or omit both.
+   * 
    * @example
    * https://www.aliyun.com/cert.jpeg
    */
   certNationalUrl?: string;
   /**
+   * @remarks
+   * Portrait side of the ID card image.
+   * A publicly accessible HTTP or HTTPS link.
+   * Choose one between CertUrl and CertFile.
+   * 
    * @example
    * https://www.aliyun.com/cert.jpeg
    */

package/src/models/Id2metaVerifyWithOcrrequest.ts

@@ -3,14 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class Id2MetaVerifyWithOCRRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Input stream for the portrait side of the ID card image.
+   * Choose one between CertUrl and CertFile.
+   * 
+   * @example
+   * 无
+   */
   certFile?: string;
+  /**
+   * @remarks
+   * National emblem side of the ID card image address.
+   * Choose one between CertNationalUrl and CertNationalFile, or omit both.
+   * 
+   * @example
+   * 无
+   */
   certNationalFile?: string;
   /**
+   * @remarks
+   * National emblem side of the ID card image URL. National emblem side
+   * A publicly accessible HTTP or HTTPS link.
+   * Choose one between CertNationalUrl and CertNationalFile, or omit both.
+   * 
    * @example
    * https://www.aliyun.com/cert.jpeg
    */
   certNationalUrl?: string;
   /**
+   * @remarks
+   * Portrait side of the ID card image.
+   * A publicly accessible HTTP or HTTPS link.
+   * Choose one between CertUrl and CertFile.
+   * 
    * @example
    * https://www.aliyun.com/cert.jpeg
    */

package/src/models/Id2metaVerifyWithOcrresponseBody.ts

@@ -1,24 +1,84 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { Id2MetaVerifyWithOCRResponseBodyResultObject } from "./Id2metaVerifyWithOcrresponseBodyResultObject";
 
 
+export class Id2MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Identity verification result:
+   * - 1: Consistent
+   * - 2: Inconsistent
+   * - 3: No record found
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  /**
+   * @remarks
+   * {"address":"Zhejiang Province, Hangzhou City, Yu*****","birthDate":"19901226","certName":"Zhang San","certNo":"1234561990122*****","nationality":"Han","authority":"xxx Public Security Bureau","startDate":"20201130","endDate":"20301130"}
+   * 
+   * @example
+   * OCR读取的身份证信息。
+   */
+  cardInfo?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+      cardInfo: 'CardInfo',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+      cardInfo: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class Id2MetaVerifyWithOCRResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 indicates success, any other value indicates failure.
+   * **Important**
+   * - This parameter indicates whether the API was called correctly. For detailed return code explanations, please refer to the error codes.
+   * - Check the business verification results through the fields in ResultObject.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * API call return message.
+   * **Important**
+   * This parameter only indicates if there was an exception with the API call.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF03****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Result object
+   */
   resultObject?: Id2MetaVerifyWithOCRResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/InitCardVerifyRequest.ts

@@ -4,17 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export class InitCardVerifyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Security Token, used for anti-replay and anti-tampering checks. If this parameter is passed, the CallbackToken field will be displayed in the callback address.
+   * 
    * @example
    * NMjvQanQgplBSaEI0sL86WnQplB
    */
   callbackToken?: string;
   /**
+   * @remarks
+   * - The callback notification address for the authentication result, which must start with https.
+   * - The platform will call back this address after completing the authentication and automatically add the certifyId and passed fields, example: https://www.aliyun.com?certifyId=xxxx&passed=T
+   * - Warning
+   * The callback is triggered only when the authentication is completed. If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that when you receive the callback notification, if necessary, you can obtain detailed authentication information through the query interface.
+   * 
    * @example
    * https://www.aliyun.com
    */
   callbackUrl?: string;
   /**
    * @remarks
+   * Number of card pages collected by the SDK
+   * - You can input 1 or 2; input 1 to collect the front side, input 2 to collect both the front and back sides.
+   * 
+   * - If the verification type is ID period (VerifyMeta value is ID_PERIOD), you must input 2.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -23,6 +37,9 @@ export class InitCardVerifyRequest extends $dara.Model {
   cardPageNumber?: string;
   /**
    * @remarks
+   * Type of identification
+   * - Resident Second Generation ID Card: IDENTITY_CARD
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,12 +47,21 @@ export class InitCardVerifyRequest extends $dara.Model {
    */
   cardType?: string;
   /**
+   * @remarks
+   * Enumeration of photo-taking methods (manual/auto)
+   * - Take a photo: shoot
+   * - Scan: scan 
+   * - Auto switch: auto
+   * 
    * @example
    * shoot
    */
   docScanMode?: string;
   /**
    * @remarks
+   * A unique business identifier you define, used for subsequent troubleshooting.
+   * Supports a combination of 32 alphanumeric characters, please ensure uniqueness.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -44,6 +70,8 @@ export class InitCardVerifyRequest extends $dara.Model {
   merchantBizId?: string;
   /**
    * @remarks
+   * MetaInfo environment parameter, which needs to be obtained through the client SDK.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,6 +80,9 @@ export class InitCardVerifyRequest extends $dara.Model {
   metaInfo?: string;
   /**
    * @remarks
+   * Verification method, value:
+   * - OCR_VERIFY: OCR recognition and verification mode.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -60,14 +91,22 @@ export class InitCardVerifyRequest extends $dara.Model {
   model?: string;
   /**
    * @remarks
+   * Whether to temporarily store the images collected by the app.
+   * - Y: Yes
+   * - N: No
+   * - If \\"Yes\\" is selected here, the query interface will support returning the card image information.
+   * 
    * This parameter is required.
    * 
    * @example
-   * T
+   * Y
    */
   pictureSave?: string;
   /**
    * @remarks
+   * Verification type, value:
+   * - Identity two elements (name + ID number): ID_2_META
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/InitCardVerifyResponseBody.ts

@@ -1,24 +1,72 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { InitCardVerifyResponseBodyResultObject } from "./InitCardVerifyResponseBodyResultObject";
 
 
+export class InitCardVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Verification request ID, a unique identifier for the verification service\\"s authentication request.
+   * - When querying the authentication result, the authentication request ID must be provided.
+   * 
+   * - The CertifyId field is a billing statistics field. To facilitate subsequent bill reconciliation, please retain this field information locally. The CertifyId returned by the initialization interface is valid for 30 minutes and can only be submitted once for authentication. Please apply it within the validity period to avoid reuse.
+   * 
+   * @example
+   * 91707dc296d469ad38e4c5efa6a0****
+   */
+  certifyId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      certifyId: 'CertifyId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certifyId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class InitCardVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * Important
+   * - This parameter indicates whether the interface was called correctly. For detailed return code descriptions, see the error codes.
+   * - Business results should be viewed through the fields in ResultObject.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Return result.
+   */
   resultObject?: InitCardVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/InitFaceVerifyResponseBody.ts

@@ -1,8 +1,37 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { InitFaceVerifyResponseBodyResultObject } from "./InitFaceVerifyResponseBodyResultObject";
 
 
+export class InitFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @example
+   * 91707dc296d469ad38e4c5efa6a0f24b
+   */
+  certifyId?: string;
+  certifyUrl?: string;
+  static names(): { [key: string]: string } {
+    return {
+      certifyId: 'CertifyId',
+      certifyUrl: 'CertifyUrl',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certifyId: 'string',
+      certifyUrl: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class InitFaceVerifyResponseBody extends $dara.Model {
   /**
    * @example

package/src/models/InsertWhiteListSettingRequest.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class InsertWhiteListSettingRequest extends $dara.Model {
   /**
+   * @remarks
+   * ID number.
+   * 
    * @example
    * 330103xxxxxxxxxxxx
    */
   certNo?: string;
   /**
+   * @remarks
+   * Unique identifier for real person authentication.
+   * 
    * @example
    * shsf57a4e0d9981c3bd66dc754f3d3cd
    */
   certifyId?: string;
   /**
+   * @remarks
+   * Remark, with a length less than 32 characters.
+   * 
    * @example
    * xxxxxx
    */
   remark?: string;
   /**
+   * @remarks
+   * Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For instructions on how to create an authentication scene, see Adding an Authentication Scene.
+   * 
    * @example
    * 100000xxxx
    */
   sceneId?: number;
   /**
+   * @remarks
+   * ServiceCode for the real person cloud product, value: **antcloudauth**.
+   * 
    * @example
    * antcloudauth
    */
   serviceCode?: string;
   /**
+   * @remarks
+   * Whitelist validity period in days (only supports 3, 7, 30).
+   * 
    * @example
    * 30
    */

package/src/models/InsertWhiteListSettingResponseBody.ts

@@ -4,29 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class InsertWhiteListSettingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * Request ID
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Returned result
+   * 
    * @example
    * true
    */
   resultObject?: boolean;
   /**
+   * @remarks
+   * Indicates whether the response was successful.
+   * 
    * @example
    * true
    */