@alicloud/cloudauth20190307 3.13.3 → 3.14.0

package/src/models/DescribeMetaStatisticsPageListRequest.ts

@@ -5,6 +5,22 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMetaStatisticsPageListRequest extends $dara.Model {
   /**
    * @remarks
+   * The product API. 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
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +29,8 @@ export class DescribeMetaStatisticsPageListRequest extends $dara.Model {
   api?: string;
   /**
    * @remarks
+   * The current page number.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +39,8 @@ export class DescribeMetaStatisticsPageListRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
+   * The end time of the query. The value is a UNIX timestamp.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +49,8 @@ export class DescribeMetaStatisticsPageListRequest extends $dara.Model {
   endDate?: number;
   /**
    * @remarks
+   * The number of entries per page.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +59,8 @@ export class DescribeMetaStatisticsPageListRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
+   * The start time of the query. The timestamp is in milliseconds.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeMetaStatisticsPageListResponseBody.ts

@@ -11,63 +11,123 @@ export class DescribeMetaStatisticsPageListResponseBodyItems extends $dara.Model
    * ID_PERIOD
    */
   api?: string;
+  /**
+   * @remarks
+   * The name corresponding to the API. 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
+   * 车辆要素核验增强版
+   */
   apiName?: string;
   /**
+   * @remarks
+   * The number of successful queries (billable).
+   * 
    * @example
    * 10
    */
   billCount?: number;
   /**
+   * @remarks
+   * The query hit rate (%).
+   * 
    * @example
    * 80
    */
   billRate?: string;
   /**
+   * @remarks
+   * The number of successful phone number queries (exclusive to phone number detection).
+   * 
    * @example
    * 1
    */
   chargeCount?: number;
   /**
+   * @remarks
+   * The date. Format: M/d (month/day). For example, 11/8 indicates November 8.
+   * 
    * @example
    * 11/8
    */
   date?: string;
   /**
+   * @remarks
+   * The carrier name. Valid values:
+   * - **CMCC**: China Mobile
+   * - **CUCC**: China Unicom
+   * - **CTCC**: China Telecom
+   * 
    * @example
    * CMCC
    */
   ispName?: string;
   /**
+   * @remarks
+   * The number of calls with no education information found.
+   * 
    * @example
    * 12
    */
   noRecordCount?: number;
   /**
+   * @remarks
+   * The number of authentication-passed transactions.
+   * 
    * @example
    * 21
    */
   passedCount?: number;
   /**
+   * @remarks
+   * The authentication pass rate (%).
+   * 
    * @example
    * 80
    */
   passedRate?: string;
   /**
+   * @remarks
+   * The number of successful requests.
+   * 
    * @example
    * 1
    */
   successCount?: number;
   /**
+   * @remarks
+   * The call success rate (%).
+   * 
    * @example
    * 100
    */
   successRate?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 4
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The number of authentication-failed calls.
+   * 
    * @example
    * 2
    */
@@ -121,27 +181,46 @@ export class DescribeMetaStatisticsPageListResponseBodyItems extends $dara.Model
 
 export class DescribeMetaStatisticsPageListResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 3
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * The paginated list data.
+   */
   items?: DescribeMetaStatisticsPageListResponseBodyItems[];
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * C379C9E4-4DA0-5D0B-821B-25E2B8693D48
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 7
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 1
    */

package/src/models/DescribeOssStatusRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * Service code:
-   * - antcloudauth: Financial-grade real-person authentication
-   * - cloudauthst (discontinued): Enhanced real-person authentication
+   * The service code. Valid values:
+   * - antcloudauth: Chinese financial-grade ID Verification.
+   * - cloudauthst (discontinued): ID Verification Enhanced Edition.
    * 
    * @example
    * antcloudauth

package/src/models/DescribeOssStatusResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssStatusResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The name of the OSS bucket for delivering authentication information.
+   * The name of the OSS bucket to which verification information is delivered.
    * 
    * @example
    * cn-hangzhou-aliyun-cloudauth-20250516xxxxxx
@@ -13,7 +13,7 @@ export class DescribeOssStatusResponseBodyData extends $dara.Model {
   bucketName?: string;
   /**
    * @remarks
-   * User activation status, SUCCESS indicates activated.
+   * The activation status of the user. A value of SUCCESS indicates that the service is activated.
    * 
    * @example
    * SUCCESS
@@ -45,12 +45,12 @@ export class DescribeOssStatusResponseBodyData extends $dara.Model {
 export class DescribeOssStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Returned data.
+   * The returned data.
    */
   data?: DescribeOssStatusResponseBodyData;
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * F2DB870B-EEB7-51BD-9F0A-B5D8D3C79308

package/src/models/DescribeOssStatusV2request.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssStatusV2Request extends $dara.Model {
   /**
    * @remarks
-   * ServiceCode for Real Person Cloud products:
-   * - **antcloudauth**: Financial-grade real person authentication
-   * - **cloudauthst (discontinued)**: Enhanced real person authentication
+   * The ServiceCode of the ID Verification product. Valid values:
+   * - **antcloudauth**: financial-grade ID Verification.
+   * - **cloudauthst (discontinued)**: enhanced ID Verification.
    * 
    * @example
    * antcloudauth
@@ -15,7 +15,7 @@ export class DescribeOssStatusV2Request extends $dara.Model {
   serviceCode?: string;
   /**
    * @remarks
-   * Visitor\\"s source IP address.
+   * The source IP address of the visitor.
    * 
    * @example
    * 120.25.41.25

package/src/models/DescribeOssStatusV2responseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssStatusV2ResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Bucket name.
+   * The bucket name.
    * 
    * @example
    * cn-hangzhou-aliyun-cloudauth-20250516xxxxxx
@@ -13,7 +13,7 @@ export class DescribeOssStatusV2ResponseBodyResultObject extends $dara.Model {
   bucketName?: string;
   /**
    * @remarks
-   * Region.
+   * The region.
    * 
    * @example
    * cn-hangzhou
@@ -21,7 +21,7 @@ export class DescribeOssStatusV2ResponseBodyResultObject extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * User activation status, **SUCCESS** indicates activated.
+   * The activation status of the user. A value of **SUCCESS** indicates that the service is activated.
    * 
    * @example
    * SUCCESS
@@ -55,7 +55,7 @@ export class DescribeOssStatusV2ResponseBodyResultObject extends $dara.Model {
 export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code
+   * The return code.
    * 
    * @example
    * 200
@@ -63,7 +63,7 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -71,7 +71,7 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -79,7 +79,7 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * B506328A-D84B-4750-82C7-6A207C585CF1
@@ -87,12 +87,12 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The result information.
    */
   resultObject?: DescribeOssStatusV2ResponseBodyResultObject;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/DescribeOssUploadTokenResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Model {
   /**
    * @remarks
-   * OSS bucket for file storage.
+   * The OSS bucket for file storage.
    * 
    * @example
    * cloudauth-zhangjiakou-external
@@ -13,7 +13,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   bucket?: string;
   /**
    * @remarks
-   * Access endpoint.
+   * The endpoint.
    * 
    * @example
    * https://oss-cn-zhangjiakou.aliyuncs.com
@@ -21,7 +21,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   endPoint?: string;
   /**
    * @remarks
-   * Expiration time.
+   * The expiration time.
    * 
    * @example
    * 1582636610000
@@ -29,7 +29,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   expired?: number;
   /**
    * @remarks
-   * The Key required for file upload.
+   * The key required for file upload.
    * 
    * @example
    * STS.NU8rUBj****
@@ -37,7 +37,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   key?: string;
   /**
    * @remarks
-   * File storage path.
+   * The file storage path.
    * 
    * @example
    * prod/RdNLC@Ox2n-1s7NMt
@@ -45,7 +45,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   path?: string;
   /**
    * @remarks
-   * The Secret required for file upload.
+   * The secret required for file upload.
    * 
    * @example
    * FwmnyoqT8dHj7nJLuM67T****
@@ -53,7 +53,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   secret?: string;
   /**
    * @remarks
-   * The Token required for file upload.
+   * The token required for file upload.
    * 
    * @example
    * uWia500nTS5knZaDzq4/KqpvhcLnO****
@@ -95,12 +95,12 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
 export class DescribeOssUploadTokenResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Information about the OSS upload Token.
+   * The OSS upload token information.
    */
   ossUploadToken?: DescribeOssUploadTokenResponseBodyOssUploadToken;
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 2FA2C773-47DB-4156-B1EE-5B047321A939

package/src/models/DescribePageFaceVerifyDataRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   /**
    * @remarks
-   * Current page number, default is 1.
+   * The current page number. Default value: 1.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * Required, end time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.
+   * Required. The end time in the format of yyyy-MM-dd. The default time is yyyy-MM-dd 00:00:00. The maximum query interval is 90 days.
    * 
    * @example
    * 2023-04-30
@@ -21,7 +21,7 @@ export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   endDate?: string;
   /**
    * @remarks
-   * Number of items per page, default is 10.
+   * The number of entries per page. Default value: 10.
    * 
    * @example
    * 10
@@ -29,7 +29,7 @@ export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Product code.
+   * The product code.
    * 
    * @example
    * ID_PLUS
@@ -37,7 +37,7 @@ export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * Scene ID.
+   * The scene ID.
    * 
    * @example
    * 36**01
@@ -45,7 +45,7 @@ export class DescribePageFaceVerifyDataRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * Required, start time, format is yyyy-MM-dd, default is yyyy-MM-dd 00:00:00, the query interval cannot exceed 90 days.
+   * Required. The start time in the format of yyyy-MM-dd. The default time is yyyy-MM-dd 00:00:00. The maximum query interval is 90 days.
    * 
    * @example
    * 2023-04-10

package/src/models/DescribePageFaceVerifyDataResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * Date.
+   * The date. The value is in ISO 8601/RFC 3339 format, UTC time zone (Z indicates +00:00), with millisecond precision, such as 2024-03-24T00:00:00.000Z.
    * 
    * @example
    * 2024-03-24T00:00:00.000Z
@@ -13,7 +13,7 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   date?: string;
   /**
    * @remarks
-   * Product scheme code, please refer to the financial-grade real-person help documentation.
+   * The product solution code. For more information, refer to the financial-grade ID Verification documentation.
    * 
    * @example
    * ID_PLUS
@@ -21,7 +21,7 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * Scene ID.
+   * The scene ID.
    * 
    * @example
    * 20**40
@@ -29,15 +29,15 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   sceneId?: string;
   /**
    * @remarks
-   * Scene name.
+   * The scene name.
    * 
    * @example
-   * ****实名认证
+   * ****Real-name verification
    */
   sceneName?: string;
   /**
    * @remarks
-   * Number of successful calls.
+   * The number of successful calls.
    * 
    * @example
    * 1
@@ -45,7 +45,7 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
   successCount?: string;
   /**
    * @remarks
-   * Total count.
+   * The total number of entries.
    * 
    * @example
    * 19
@@ -85,7 +85,7 @@ export class DescribePageFaceVerifyDataResponseBodyItems extends $dara.Model {
 export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code
+   * The return code.
    * 
    * @example
    * 200
@@ -93,7 +93,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -101,12 +101,12 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   currentPage?: string;
   /**
    * @remarks
-   * List of returned data.
+   * The list of returned data.
    */
   items?: DescribePageFaceVerifyDataResponseBodyItems[];
   /**
    * @remarks
-   * Return message.
+   * The return message.
    * 
    * @example
    * OK
@@ -114,7 +114,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Number of items per page.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -122,7 +122,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * ID of this request.
+   * The ID of this request.
    * 
    * @example
    * 473469C7-A***B-A3DC0DE3C83E
@@ -130,7 +130,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true
@@ -138,7 +138,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * Total count.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -146,7 +146,7 @@ export class DescribePageFaceVerifyDataResponseBody extends $dara.Model {
   totalCount?: string;
   /**
    * @remarks
-   * Total number of pages.
+   * The total number of pages.
    * 
    * @example
    * 5

package/src/models/DescribePageSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePageSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Failure reasons.
+   * The failure reasons.
    * 
    * @example
    * {
@@ -26,7 +26,7 @@ export class DescribePageSettingResponseBody extends $dara.Model {
   failReasons?: { [key: string]: any };
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * C58A8581-6A5B-55F1-B2EF-1CEAC97DA181