@alicloud/cloudauth20190307 3.13.2 → 3.13.4

package/src/models/DescribeDeviceInfoRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDeviceInfoRequest extends $dara.Model {
   /**
    * @remarks
-   * Business type. No more than 64 characters.
+   * The business type. Maximum of 64 characters.
    * 
    * @example
    * FACE_TEST
@@ -13,7 +13,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * The current page number being queried.
+   * The current page number.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * A unique ID generated by the real-person authentication server for the access party\\"s device. This ID is only generated after the device has been successfully activated and can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.
+   * The unique ID generated by the China Real Identity Authentication server for the device of the integrating party. This ID is generated only after the device is successfully activated and can be obtained by calling the getLicenseExtraInfo function in the offline facial recognition SDK.
    * 
    * @example
    * wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
@@ -29,7 +29,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   deviceId?: string;
   /**
    * @remarks
-   * The end time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.
+   * The end time of the query, which queries the authorizations that expire between ExpiredStartDay and ExpiredEndDay.
    * 
    * @example
    * 20200330
@@ -37,7 +37,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   expiredEndDay?: string;
   /**
    * @remarks
-   * The start time of the query, i.e., querying authorizations that will expire between ExpiredStartDay and ExpiredEndDay.
+   * The start time of the query, which queries the authorizations that expire between ExpiredStartDay and ExpiredEndDay.
    * 
    * @example
    * 20190401
@@ -45,7 +45,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   expiredStartDay?: string;
   /**
    * @remarks
-   * Number of items per page in the query.
+   * The number of entries per page.
    * 
    * @example
    * 20
@@ -53,7 +53,7 @@ export class DescribeDeviceInfoRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * No more than 64 characters, defined by the access party, which can be used to identify a specific device.
+   * Maximum of 64 characters. Custom-defined by the integrating party to identify a specific device.
    * 
    * @example
    * 3iJ1AY$oHcu7mC69

package/src/models/DescribeDeviceInfoResponseBody.ts

@@ -66,7 +66,7 @@ export class DescribeDeviceInfoResponseBodyDeviceInfoList extends $dara.Model {
 export class DescribeDeviceInfoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The current page number being queried.
+   * The current page number.
    * 
    * @example
    * 1
@@ -75,7 +75,7 @@ export class DescribeDeviceInfoResponseBody extends $dara.Model {
   deviceInfoList?: DescribeDeviceInfoResponseBodyDeviceInfoList;
   /**
    * @remarks
-   * Number of items per page.
+   * The number of entries per page.
    * 
    * @example
    * 20
@@ -83,7 +83,7 @@ export class DescribeDeviceInfoResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of this request.
+   * The request ID.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
@@ -91,7 +91,7 @@ export class DescribeDeviceInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total count.
+   * The total number of entries.
    * 
    * @example
    * 1

package/src/models/DescribeFaceGuardRiskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeFaceGuardRiskRequest extends $dara.Model {
   /**
    * @remarks
-   * Authentication ID
+   * The authentication ID.
    * 
    * @example
    * aba9830f471a4335af4612c8adaa91b0
@@ -13,7 +13,7 @@ export class DescribeFaceGuardRiskRequest extends $dara.Model {
   bizId?: string;
   /**
    * @remarks
-   * Risk identification - device token.
+   * The device token for risk identification.
    * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
@@ -21,9 +21,9 @@ export class DescribeFaceGuardRiskRequest extends $dara.Model {
   deviceToken?: string;
   /**
    * @remarks
-   * This identifier is used for subsequent troubleshooting, and you need to ensure that this value is unique in your business.
+   * The identifier used for subsequent troubleshooting. Ensure that this value is unique within your business.
    * 
-   * Supports the use of English letters (including uppercase and lowercase) and numbers, with a maximum length of 32 characters.
+   * The value can contain letters (both uppercase and lowercase) and digits, with a maximum length of 32 characters.
    * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c35xxxx
@@ -31,7 +31,7 @@ export class DescribeFaceGuardRiskRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
-   * Product code, fixed value: FACE_GUARD
+   * The product code. Set this to FACE_GUARD.
    * 
    * @example
    * FACE_GUARD

package/src/models/DescribeFaceGuardRiskResponseBody.ts

@@ -5,16 +5,25 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Unique real-person authentication identifier.
+   * The unique identifier for ID Verification.
    * 
    * @example
    * sha43d9cabd52d370d9f4cca9468f71e
    */
   certifyId?: string;
+  /**
+   * @remarks
+   * The device risk probability predicted by the device assistant algorithm. A higher score indicates a higher device risk.
+   * 
+   * Value range: 0 to 100.
+   * 
+   * @example
+   * 80
+   */
   guardRiskScore?: number;
   /**
    * @remarks
-   * Extended information, in JSON format. (Customized return based on tenant requirements)
+   * The extended information in JSON format. The returned content is customized based on tenant requirements.
    * 
    * @example
    * {
@@ -31,11 +40,11 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
   riskExtends?: string;
   /**
    * @remarks
-   * Device risk tags.
+   * The device risk labels.
    * 
-   * - Multiple device risk tags are separated by commas (,). For example, “ROOT,VPN,HOOK”,
+   * - Multiple device risk labels are separated by commas (,), such as "ROOT,VPN,HOOK".
    * 
-   * - For more information about device risk tags and their meanings, please refer to the official documentation on Face Guard Tag Descriptions.
+   * - For more information about device risk labels and their descriptions, see the Face Guard label description in the official documentation.
    * 
    * @example
    * ROOT,VPN,HOOK
@@ -71,7 +80,7 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
 export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code, **200** indicates successful response from the interface.
+   * The response code. **200** indicates that the request was successful.
    * 
    * @example
    * 200
@@ -79,7 +88,7 @@ export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -87,7 +96,7 @@ export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
@@ -95,7 +104,7 @@ export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The result information.
    */
   resultObject?: DescribeFaceGuardRiskResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DescribeFaceVerifyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeFaceVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * Unique identifier for real-person authentication.
+   * The unique identifier of the ID Verification request.
    * 
    * @example
    * 91707dc296d469ad38e4c5efa6a0f24b
@@ -13,7 +13,7 @@ export class DescribeFaceVerifyRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * Image return type.
+   * The image return type.
    * 
    * @example
    * JPG
@@ -21,7 +21,7 @@ export class DescribeFaceVerifyRequest extends $dara.Model {
   pictureReturnType?: string;
   /**
    * @remarks
-   * Authentication scene ID.
+   * The ID of the verification scenario.
    * 
    * @example
    * 1000000006

package/src/models/DescribeFaceVerifyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Device risk label.
+   * The device risk label.
    * 
    * @example
    * ROOT,VPN,HOOK
@@ -13,7 +13,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   deviceRisk?: string;
   /**
    * @remarks
-   * Device token.
+   * The device token.
    * 
    * @example
    * McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx
@@ -21,7 +21,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   deviceToken?: string;
   /**
    * @remarks
-   * Information about the authenticated subject, usually empty in general authentication scenarios.
+   * The identity information of the verification subject. This field is empty in common verification scenarios.
    * 
    * @example
    * null
@@ -29,7 +29,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   identityInfo?: string;
   /**
    * @remarks
-   * Attachment information of the authenticated subject, mainly image materials. JSON format, see example below.
+   * The supplementary material information of the verification subject, primarily image-based materials. The value is in JSON format. See the example below.
    * 
    * @example
    * {"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg","ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779","ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg"}}
@@ -37,7 +37,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   materialInfo?: string;
   /**
    * @remarks
-   * Whether it passed, T for pass, F for fail.
+   * Indicates whether the verification is passed. A value of T indicates passed. A value of F indicates not passed.
    * 
    * @example
    * T
@@ -45,7 +45,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   passed?: string;
   /**
    * @remarks
-   * Description of the authentication result. For details, see the SubCode explanation below.
+   * The verification result description. For more information, see the SubCode description below.
    * 
    * @example
    * 200
@@ -53,7 +53,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   subCode?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * True
@@ -61,13 +61,13 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * Records the identity information and corresponding encoding entered by the user under the rare character mode. The returned data is a JSON formatted string, which will be an empty string if there are no rare characters in the name.
+   * The identity information and corresponding encoding entered by the user in rare character mode. The value is a JSON-formatted string. An empty string is returned if the name does not contain rare characters.
    * 
-   * - name: Refers to the name entered by the user.
+   * - name: the name entered by the user.
    * 
-   * - verifyName: Refers to the final name encoding after verification. For example, if a rare character is verified through transcoding: “Mr. Wang”, the actual verified name is “Wang Xiansheng”.
+   * - verifyName: the final name encoding that passed verification. For example, if a rare character is verified through transcoding: "王先生", the actual verified name is "王先升".
    * 
-   * - number: Refers to the identification number entered by the user.
+   * - number: the ID number entered by the user.
    * 
    * @example
    * {
@@ -115,7 +115,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
 export class DescribeFaceVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 indicates success, other values indicate failure.
+   * The return code. A value of 200 indicates success. Other values indicate failure.
    * 
    * @example
    * 200
@@ -123,7 +123,7 @@ export class DescribeFaceVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Error message
+   * The error message.
    * 
    * @example
    * success
@@ -131,7 +131,7 @@ export class DescribeFaceVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
@@ -139,7 +139,7 @@ export class DescribeFaceVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information
+   * The returned result information.
    */
   resultObject?: DescribeFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DescribeInfoCheckExportRecordRequest.ts

@@ -4,26 +4,55 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeInfoCheckExportRecordRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * The end time of the query.
+   * 
    * @example
    * 2025-10-11 21:24:48
    */
   endDate?: string;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The product type. Valid values:
+   * - **ID_CARD_2_META**: ID card two-element verification.
+   * - **ID_PERIOD**: ID card validity period verification.
+   * - **MOBILE_ONLINE_LENGTH**: mobile number online duration.
+   * - **MOBILE_ONLINE_STATUS**: mobile number online status.
+   * - **MOBILE_3_META_SIMPLE**: mobile number three-element verification (simple edition).
+   * - **MOBILE_3_META**: mobile number three-element verification (detailed edition).
+   * - **MOBILE_2_META**: mobile number two-element verification.
+   * - **BANK_CARD_N_META**: bank card verification (detailed edition).
+   * - **MOBILE_DETECT**: phone number detection.
+   * - **VEHICLE_N_META**: vehicle element verification (enhanced edition).
+   * - **VEHICLE_PENTA_INFO**: vehicle five-element information recognition.
+   * - **VEHICLE_LICENSE_INFO**: vehicle information recognition.
+   * - **VEHICLE_INSURE_DATE**: vehicle insurance date query.
+   * - **VEHICLE_CHECK**: vehicle element verification.
+   * 
    * @example
    * ID_CARD_2_META
    */
   productType?: string;
   /**
+   * @remarks
+   * The start time of the query.
+   * 
    * @example
    * 2025-10-11 21:24:48
    */

package/src/models/DescribeInfoCheckExportRecordResponseBody.ts

@@ -4,33 +4,82 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeInfoCheckExportRecordResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * The download date.
+   * 
    * @example
    * 1758250979000
    */
   downloadDate?: string;
   /**
+   * @remarks
+   * The ID of the download task.
+   * 
    * @example
    * 202510189017278
    */
   downloadTaskId?: string;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * -
    */
   errorCode?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * 手机号二要素统计202509013975081.csv
+   */
   fileName?: string;
   /**
+   * @remarks
+   * The file type.
+   * 
    * @example
    * CSV
    */
   fileType?: string;
+  /**
+   * @remarks
+   * The product type name. Valid values:
+   * - **ID_CARD_2_META**: ID card two-element verification.
+   * - **ID_PERIOD**: ID card validity period verification.
+   * - **MOBILE_ONLINE_LENGTH**: mobile number online duration.
+   * - **MOBILE_ONLINE_STATUS**: mobile number online status.
+   * - **MOBILE_3_META_SIMPLE**: mobile number three-element verification (simple edition).
+   * - **MOBILE_3_META**: mobile number three-element verification (detailed edition).
+   * - **MOBILE_2_META**: mobile number two-element verification.
+   * - **BANK_CARD_N_META**: bank card verification (detailed edition).
+   * - **MOBILE_DETECT**: phone number detection.
+   * - **VEHICLE_N_META**: vehicle element verification (enhanced edition).
+   * - **VEHICLE_PENTA_INFO**: vehicle five-element information recognition.
+   * - **VEHICLE_LICENSE_INFO**: vehicle information recognition.
+   * - **VEHICLE_INSURE_DATE**: vehicle insurance date query.
+   * - **VEHICLE_CHECK**: vehicle element verification.
+   * 
+   * @example
+   * 身份证二要素
+   */
   productType?: string;
   /**
+   * @remarks
+   * The task status. Valid values:
+   * - **1**: The file is being generated.
+   * - **2**: The file has been generated.
+   * - **3**: The file failed to be generated.
+   * 
    * @example
    * 1
    */
   status?: number;
   /**
+   * @remarks
+   * The task URL.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxxxx.xlsx
    */
@@ -72,22 +121,38 @@ export class DescribeInfoCheckExportRecordResponseBodyItems extends $dara.Model
 
 export class DescribeInfoCheckExportRecordResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The return code. A value of 200 indicates success. Other values indicate failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * The list of results.
+   */
   items?: DescribeInfoCheckExportRecordResponseBodyItems[];
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
@@ -101,16 +166,25 @@ export class DescribeInfoCheckExportRecordResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 1
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 3
    */

package/src/models/DescribeListAntCloudAuthScenesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeListAntCloudAuthScenesRequest extends $dara.Model {
   /**
    * @remarks
-   * Scenario ID.
+   * The scene ID.
    * 
    * @example
    * 100000xxxx