@alicloud/cloudauth20190307 3.14.0 → 3.14.2

package/src/models/DeleteFaceVerifyResultResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier for real-person authentication.
+   * The unique identifier for ID Verification.
    * 
    * @example
    * sha58aeae7ea2f5ed069530f58df4e6d
@@ -14,9 +14,8 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
   /**
    * @remarks
    * The deletion result. Valid values:
-   * 
-   * - Y: Deletion successful.
-   * - N: Deletion failed.
+   * - Y: The deletion succeeded.
+   * - N: The deletion failed.
    * 
    * @example
    * N
@@ -24,10 +23,9 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
   deleteResult?: string;
   /**
    * @remarks
-   * The reason for deletion failure.
-   * 
-   * - NOT_DELETE_REPEATEDLY: The data cannot be deleted repeatedly.
-   * - NEED_QUERY_VERIFY_RESULT: You must query the authentication result before deleting.
+   * The reason for the deletion failure. Valid values:
+   * - NOT_DELETE_REPEATEDLY: The data cannot be repeatedly deleted.
+   * - NEED_QUERY_VERIFY_RESULT: You must query the verification result before you delete the data.
    * 
    * @example
    * NOT_DELETE_REPEATEDLY
@@ -61,7 +59,7 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
 export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code. A value of 200 indicates success. Other values indicate failure.
+   * The return code. A value of 200 indicates success, and other values indicate failure.
    * 
    * @example
    * 200
@@ -69,7 +67,7 @@ export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Return message.
+   * The returned message.
    * 
    * @example
    * success
@@ -85,7 +83,7 @@ export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned result.
+   * The returned result information.
    */
   resultObject?: DeleteFaceVerifyResultResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DeleteSceneConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the ID Verification scenario configuration.
+   * The intent verification configuration ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteSceneConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteSceneConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/DescribeAuthVerifyRequest.ts

@@ -5,8 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuthVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier for ID Verification.
-   * Obtain this value by calling InitAuthVerify to initiate an OCR request.
+   * The unique identifier for ID Verification. To obtain this value, call the InitAuthVerify operation to initiate an OCR request.
    * 
    * This parameter is required.
    * 
@@ -16,7 +15,7 @@ export class DescribeAuthVerifyRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * The authentication scenario ID.
+   * The authentication scene ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeAuthVerifyResponseBody.ts

@@ -5,30 +5,30 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuthVerifyResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * - Card information read by OCR (ocrIdCardInfo)
-   * - Card information photo edited by the client (ocrIdEditInfo)
-   * - OSS storage location and link of the OCR photo (ocrPictureFront).
+   * - The card and certificate information read by OCR (ocrIdCardInfo)
+   * - The photo of the card and certificate information edited on the client (ocrIdEditInfo)
+   * - The OSS storage location and URL of the OCR photo (ocrPictureFront)
    * 
    * @example
    * "ocrIdCardInfo": {
-   *     "certName": "张先生",
-   *     "sex": "男",
-   *     "nationality": "汉",
+   *     "certName": "Mr. Zhang",
+   *     "sex": "Male",
+   *     "nationality": "Han",
    *     "birth": "20010213",
-   *     "address": "XXX省XX市XXX区XX街道X号",
+   *     "address": "No. X, XX Street, XXX District, XX City, XXX Province",
    *     "certNo": "4****************X",
-   *     "authority": "XXX公安局XXX分局",
+   *     "authority": "XXX Branch of XXX Public Security Bureau",
    *     "startDate": "20250523",
    *     "endDate": "20450523"
    *   },
    * "ocrIdEditInfo": {
-   *     "certName": "张先生",
-   *     "sex": "男",
-   *     "nationality": "汉",
+   *     "certName": "Mr. Zhang",
+   *     "sex": "Male",
+   *     "nationality": "Han",
    *     "birth": "20010213",
-   *     "address": "XXX省XX市XXX区XX街道X号",
+   *     "address": "No. X, XX Street, XXX District, XX City, XXX Province",
    *     "certNo": "4****************X",
-   *     "authority": "XXX公安局XXX分局",
+   *     "authority": "XXX Branch of XXX Public Security Bureau",
    *     "startDate": "20250523",
    *     "endDate": "20450523"
    *   },
@@ -43,20 +43,20 @@ export class DescribeAuthVerifyResponseBodyResult extends $dara.Model {
   materialInfo?: string;
   /**
    * @remarks
-   * The anti-spoofing detection result for the back side of the document, including the risk determination result and risk type:
+   * The anti-spoofing detection result for the back side of the ID card, including the risk determination result and risk type:
    * > - 
-   * Card front anti-spoofing detection is enabled only when IdSpoof = Y is set in the Initialize operation. Otherwise, spoofRiskResult returns N by default, and spoofType is empty.
+   * Anti-spoofing detection for the back side of the card is enabled only when IdSpoof is set to Y in the Initialize operation. Otherwise, spoofRiskResult defaults to N, and spoofType is empty.
    * 
    * spoofRiskResult:
-   * - Y: Risk detected.
-   *  - N: No risk detected.
+   * - Y: Risk detected
+   * - N: No risk detected
    * 
    * spoofType:
-   * - SCREEN_REMARK: Recaptured photo.
-   * - PHOTO_COPY: Photocopy.
-   * - TAMPER: Digitally tampered.
+   * - SCREEN_REMARK: Screen recapture
+   * - PHOTO_COPY: Photocopy
+   * - TAMPER: Image tampering
    * 
-   * > - This is an algorithm prediction result. This field may not be returned. Avoid setting a mandatory dependency on this field in your business logic.
+   * > - This field contains algorithm prediction results and may not be returned. Avoid building critical business dependencies on this field.
    * 
    * @example
    * spoofRiskResult：Y
@@ -65,20 +65,20 @@ export class DescribeAuthVerifyResponseBodyResult extends $dara.Model {
   spoofBackInfo?: string;
   /**
    * @remarks
-   * The anti-spoofing detection result for the front side of the document, including the risk determination result and risk type:
+   * The anti-spoofing detection result for the front side of the ID card, including the risk determination result and risk type:
    * > - 
-   * Card front anti-spoofing detection is enabled only when IdSpoof = Y is set in the Initialize operation. Otherwise, spoofRiskResult returns N by default, and spoofType is empty.
+   * Anti-spoofing detection for the front side of the card is enabled only when IdSpoof is set to Y in the Initialize operation. Otherwise, spoofRiskResult defaults to N, and spoofType is empty.
    * 
    * spoofRiskResult:
-   * - Y: Risk detected.
-   *  - N: No risk detected.
+   * - Y: Risk detected
+   * - N: No risk detected
    * 
    * spoofType:
-   * - SCREEN_REMARK: Recaptured photo.
-   * - PHOTO_COPY: Photocopy.
-   * - TAMPER: Digitally tampered.
+   * - SCREEN_REMARK: Screen recapture
+   * - PHOTO_COPY: Photocopy
+   * - TAMPER: Image tampering
    * 
-   * > - This is an algorithm prediction result. This field may not be returned. Avoid setting a mandatory dependency on this field in your business logic.
+   * > - This field contains algorithm prediction results and may not be returned. Avoid building critical business dependencies on this field.
    * 
    * @example
    * spoofRiskResult：Y

package/src/models/DescribeCardVerifyRequest.ts

@@ -5,8 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCardVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * The verification request ID.
-   * You must first call the InitCardVerify operation to submit a verification request before you can obtain the verification request ID.
+   * The authentication request ID. You must call the InitCardVerify operation to submit an authentication request before you can obtain the authentication request ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeCardVerifyResponseBody.ts

@@ -6,9 +6,9 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
    * The identity verification result. Valid values:
-   * - 1: consistent
-   * - 2: inconsistent
-   * - 3: no record found.
+   * - 1: Consistent.
+   * - 2: Inconsistent.
+   * - 3: No record found.
    * 
    * @example
    * 1
@@ -19,7 +19,7 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
    * The ID card information submitted for verification.
    * 
    * @example
-   * {"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}
+   * {"address":"No. 969 West Wenyi Road, Yuhang District, Hangzhou City, Zhejiang Province","birthDate":"19901226","certName":"Zhang San","certNo":"1234561990122*****","nationality":"Han","authority":"xxx Public Security Bureau","startDate":"20201130","endDate":"20301130"}
    */
   cardInfo?: string;
   /**
@@ -37,14 +37,14 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
    * The ID card information read by OCR.
    * 
    * @example
-   * {"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}
+   * {"address":"No. 969 West Wenyi Road, Yuhang District, Hangzhou City, Zhejiang Province","birthDate":"19901226","certName":"Zhang San","certNo":"1234561990122*****","nationality":"Han","authority":"xxx Public Security Bureau","startDate":"20201130","endDate":"20301130"}
    */
   ocrCardInfo?: string;
   /**
    * @remarks
-   * The returned photo URLs.
-   * - certUrl: front side
-   * - certNationalUrl: national emblem side.
+   * The URLs of the returned photos.
+   * - certUrl: Front side.
+   * - certNationalUrl: National emblem side.
    * 
    * @example
    * {
@@ -85,10 +85,10 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
 export class DescribeCardVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. 200 indicates success. Other values indicate failure.
-   * > **Important**
-   * > - This parameter indicates whether the operation is called correctly. For more information about return codes, refer to error codes.
-   * > - Check the business verification result by viewing the fields in ResultObject.
+   * The return code. A value of 200 indicates success, and other values indicate failure.
+   * Important
+   * - This parameter indicates whether the operation is called correctly. For more information about return codes, see Error codes.
+   * - To view the business verification result, check the fields in ResultObject.
    * 
    * @example
    * 200
@@ -96,9 +96,9 @@ export class DescribeCardVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message of the operation.
-   * > **Important**
-   * > - This parameter only indicates whether the operation is abnormal.
+   * The message returned for the operation call.
+   * Important
+   * - This parameter only indicates whether an exception occurs during the operation call.
    * 
    * @example
    * success

package/src/models/DescribeCloudauthstSceneListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudauthstSceneListRequest extends $dara.Model {
   /**
    * @remarks
-   * The commodity code.
+   * The product code.
    * 
    * @example
    * SMART_CARD

package/src/models/DescribeCloudauthstSceneListResponseBody.ts

@@ -21,7 +21,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Marketplace commodity code.
+   * The commodity code in Alibaba Cloud Marketplace.
    * 
    * @example
    * SMART_VERIFY
@@ -48,12 +48,12 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
    * The scenario name.
    * 
    * @example
-   * 测试场景
+   * Test scenario
    */
   sceneName?: string;
   /**
    * @remarks
-   * Specifies whether to deliver files generated during authentication to the customer\\"s OSS. Valid values:
+   * Specifies whether to deliver the files generated during verification to the customer\\"s OSS. Valid values:
    * - **Y**: Enabled.
    * - **N**: Disabled.
    * 

package/src/models/DescribeFaceGuardRiskRequest.ts

@@ -23,7 +23,7 @@ export class DescribeFaceGuardRiskRequest extends $dara.Model {
    * @remarks
    * The identifier used for subsequent troubleshooting. Ensure that this value is unique within your business.
    * 
-   * The value can contain letters (both uppercase and lowercase) and digits, with a maximum length of 32 characters.
+   * The value can contain uppercase and lowercase letters and digits, and can be up to 32 characters in length.
    * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c35xxxx
@@ -31,7 +31,7 @@ export class DescribeFaceGuardRiskRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
-   * The product code. Set this to FACE_GUARD.
+   * The product code. Set the value to FACE_GUARD.
    * 
    * @example
    * FACE_GUARD

package/src/models/DescribeFaceGuardRiskResponseBody.ts

@@ -13,9 +13,9 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * The device risk probability predicted by the device assistant algorithm. A higher score indicates a higher device risk.
+   * The device risk probability predicted by the Device Assistant algorithm. A higher score indicates a higher device risk.
    * 
-   * Value range: 0 to 100.
+   * Valid values: 0 to 100.
    * 
    * @example
    * 80
@@ -23,7 +23,7 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
   guardRiskScore?: number;
   /**
    * @remarks
-   * The extended information in JSON format. The returned content is customized based on tenant requirements.
+   * The extended information in JSON format. This information is customized and returned based on tenant requirements.
    * 
    * @example
    * {
@@ -40,11 +40,11 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
   riskExtends?: string;
   /**
    * @remarks
-   * The device risk labels.
+   * The device risk tags.
    * 
-   * - Multiple device risk labels are separated by commas (,), such as "ROOT,VPN,HOOK".
+   * - Multiple device risk tags are separated by commas (,), such as ROOT,VPN,HOOK.
    * 
-   * - For more information about device risk labels and their descriptions, see the Face Guard label description in the official documentation.
+   * - For more information about device risk tags and their meanings, refer to the Face Guard tag description in the official documentation.
    * 
    * @example
    * ROOT,VPN,HOOK
@@ -80,7 +80,7 @@ export class DescribeFaceGuardRiskResponseBodyResultObject extends $dara.Model {
 export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. **200** indicates that the request was successful.
+   * The return code. A value of **200** indicates that the request was successful.
    * 
    * @example
    * 200
@@ -88,7 +88,7 @@ export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message.
+   * The returned message.
    * 
    * @example
    * success
@@ -104,7 +104,7 @@ export class DescribeFaceGuardRiskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result information.
+   * The returned result.
    */
   resultObject?: DescribeFaceGuardRiskResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DescribeOssStatusV2request.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeOssStatusV2Request extends $dara.Model {
   /**
    * @remarks
-   * The ServiceCode of the ID Verification product. Valid values:
-   * - **antcloudauth**: financial-grade ID Verification.
-   * - **cloudauthst (discontinued)**: enhanced ID Verification.
+   * The ServiceCode of the ID Verification cloud service. Valid values:
+   * - **antcloudauth**: Financial-grade ID Verification.
+   * - **cloudauthst** (retired): ID Verification Enhanced Edition.
    * 
    * @example
    * antcloudauth
@@ -15,7 +15,7 @@ export class DescribeOssStatusV2Request extends $dara.Model {
   serviceCode?: string;
   /**
    * @remarks
-   * The source IP address of the visitor.
+   * The source IP address of the requester.
    * 
    * @example
    * 120.25.41.25

package/src/models/DescribeOssStatusV2responseBody.ts

@@ -71,7 +71,7 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The response message.
+   * The returned message.
    * 
    * @example
    * success
@@ -92,7 +92,7 @@ export class DescribeOssStatusV2ResponseBody extends $dara.Model {
   resultObject?: DescribeOssStatusV2ResponseBodyResultObject;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is 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
-   * The OSS bucket for file storage.
+   * The OSS bucket.
    * 
    * @example
    * cloudauth-zhangjiakou-external
@@ -29,7 +29,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   expired?: number;
   /**
    * @remarks
-   * The key required for file upload.
+   * The key required to upload files.
    * 
    * @example
    * STS.NU8rUBj****
@@ -45,7 +45,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   path?: string;
   /**
    * @remarks
-   * The secret required for file upload.
+   * The secret required to upload files.
    * 
    * @example
    * FwmnyoqT8dHj7nJLuM67T****
@@ -53,7 +53,7 @@ export class DescribeOssUploadTokenResponseBodyOssUploadToken extends $dara.Mode
   secret?: string;
   /**
    * @remarks
-   * The token required for file upload.
+   * The token required to upload files.
    * 
    * @example
    * uWia500nTS5knZaDzq4/KqpvhcLnO****

package/src/models/DescribeVerifyResultRequest.ts

@@ -5,8 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifyResultRequest extends $dara.Model {
   /**
    * @remarks
-   * The verification ID. A unique ID that identifies a verification task. The value can be up to 64 characters in length. For a single verification task, the system supports unlimited submissions until the verification is passed and the task is completed.
-   * > Use a different BizId for each verification task.
+   * The verification ID. The unique ID that identifies a verification task. The ID can be up to 64 characters in length. For a single verification task, the system supports unlimited submissions until the verification is passed and the task is completed.
+   * > You must use a different BizId when you initiate different verification tasks.
    * 
    * This parameter is required.
    *