@alicloud/cloudauth20190307 3.13.3 → 3.14.0

package/src/models/UpdateAntCloudAuthSceneRequest.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   /**
    * @remarks
-   * Update Ant Blockchain Transaction Scenario
+   * Specifies whether to bind a mini program. Valid values:
+   * - **Y**: enabled.
+   * - **N (default)**: disabled.
+   * >Notice: If you enable mini program binding, make sure that you specify all parameters related to the mini program binding.
    * 
    * @example
    * Y
@@ -13,10 +16,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   bindMiniProgram?: string;
   /**
    * @remarks
-   * Whether to enable binding with a mini program:
-   * - **Y**: Enable
-   * - **N (default)**: Disable
-   * >Notice: If you enable binding with a mini program, please ensure that all parameters for the mini program are passed.
+   * The content of the uploaded verification file.
    * 
    * @example
    * 774c4aab45981ff4a86cde9255a11xxx
@@ -24,17 +24,41 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   checkFileBody?: string;
   /**
    * @remarks
-   * Scenario name.
+   * The name of the uploaded verification file.
    * 
    * @example
-   * Whether to enable storing the authentication files generated during the authentication process to the user\\"s OSS:
-   * - **Y**: Enable
-   * - **N (default)**: Disable
+   * test.txt
    */
   checkFileName?: string;
   /**
    * @remarks
-   * Name of the uploaded verification file.
+   * The iOS app scheme for degradation.
+   * 
+   * @example
+   * cloudauth://callback
+   */
+  degradeAppScheme?: string;
+  /**
+   * @remarks
+   * The SubCode that triggers degradation.
+   * 
+   * @example
+   * 201,202
+   */
+  degradeSubCodes?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable degraded authentication.
+   * 
+   * @example
+   * ALIPAY
+   */
+  degradeType?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable enhanced device risk detection. Valid values:
+   * - **Y**: enabled.
+   * - **N**: disabled.
    * 
    * @example
    * Y
@@ -42,15 +66,18 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   deviceRiskPlus?: string;
   /**
    * @remarks
-   * System-defined parameter. Value: **UpdateAntCloudAuthScene**.
+   * The name of the mini program.
    * 
    * @example
-   * Scenario ID.
+   * TestApp
    */
   miniProgramName?: string;
   /**
    * @remarks
-   * Currently meaningless, can be omitted.
+   * The mini program platform. Valid values:
+   * - **WECHAT**: WeChat
+   * - **ALIPAY**: Alipay
+   * - **TIKTOK**: TikTok
    * 
    * @example
    * IOS
@@ -58,7 +85,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   platform?: string;
   /**
    * @remarks
-   * Mini program name.
+   * The number of returned photos (1 to 5). This parameter takes effect after StoreImage is enabled for authentication file retention.
    * 
    * @example
    * 1
@@ -66,10 +93,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   returnPicCount?: number;
   /**
    * @remarks
-   * Platform for binding the mini program:
-   * - **WECHAT**: WeChat
-   * - **ALIPAY**: Alipay
-   * - **TIKTOK**: TikTok
+   * The duration of the returned video (1 to 2 seconds). This parameter takes effect after StoreImage is enabled.
    * 
    * @example
    * 2
@@ -77,7 +101,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   returnVideoLength?: number;
   /**
    * @remarks
-   * Update Financial-Level Authentication Scenario
+   * The scenario ID.
    * 
    * This parameter is required.
    * 
@@ -87,9 +111,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * Update the information of a financial-level authentication scenario based on the scenario ID.
-   * - Service address: cloudauth.aliyuncs.com.
-   * - Request method: HTTPS POST.
+   * The scenario name.
    * 
    * @example
    * test
@@ -97,27 +119,38 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
   sceneName?: string;
   /**
    * @remarks
-   * Update Ant Blockchain Transaction Scenario
+   * This parameter has no effect. You do not need to specify this parameter.
    * 
    * @example
-   * -
+   * 0
    */
   status?: number;
   /**
    * @remarks
-   * Update the information of a financial-level authentication scenario based on the scenario ID.
-   * - Service address: cloudauth.aliyuncs.com.
-   * - Request method: HTTPS POST.
+   * Specifies whether to deliver authentication files generated during the authentication process to your OSS bucket. Valid values:
+   * - **Y**: enabled.
+   * - **N (default)**: disabled.
    * 
    * @example
    * Y
    */
   storeImage?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable degraded authentication.
+   * 
+   * @example
+   * Y
+   */
+  useDegrade?: string;
   static names(): { [key: string]: string } {
     return {
       bindMiniProgram: 'BindMiniProgram',
       checkFileBody: 'CheckFileBody',
       checkFileName: 'CheckFileName',
+      degradeAppScheme: 'DegradeAppScheme',
+      degradeSubCodes: 'DegradeSubCodes',
+      degradeType: 'DegradeType',
       deviceRiskPlus: 'DeviceRiskPlus',
       miniProgramName: 'MiniProgramName',
       platform: 'Platform',
@@ -127,6 +160,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
       sceneName: 'SceneName',
       status: 'Status',
       storeImage: 'StoreImage',
+      useDegrade: 'UseDegrade',
     };
   }
 
@@ -135,6 +169,9 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
       bindMiniProgram: 'string',
       checkFileBody: 'string',
       checkFileName: 'string',
+      degradeAppScheme: 'string',
+      degradeSubCodes: 'string',
+      degradeType: 'string',
       deviceRiskPlus: 'string',
       miniProgramName: 'string',
       platform: 'string',
@@ -144,6 +181,7 @@ export class UpdateAntCloudAuthSceneRequest extends $dara.Model {
       sceneName: 'string',
       status: 'number',
       storeImage: 'string',
+      useDegrade: 'string',
     };
   }
 

package/src/models/UpdateAntCloudAuthSceneResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAntCloudAuthSceneResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Content of the uploaded verification file.
+   * The request ID.
    * 
    * @example
    * A07D5838-2BE0-5D2E-B864-D05ADAA5EDE3

package/src/models/UpdateSceneConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * Scene configuration information, in JSON format. For the specific structure definition, please refer to more information about the configuration.
+   * The scenario configuration in JSON format. For the specific structure definition, refer to the additional information about configurations.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateSceneConfigRequest extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Willingness configuration ID.
+   * The ID of the intent configuration.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class UpdateSceneConfigRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Selected authentication scene.
+   * The selected verification scenario.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateSceneConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSceneConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

package/src/models/Vehicle5itemQueryRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class Vehicle5ItemQueryRequest extends $dara.Model {
   /**
    * @remarks
-   * Parameter type:
+   * The parameter type. Valid values:
    * 
-   * - **normal**: Unencrypted.
-   * - **md5**: MD5 encrypted.
+   * - **normal**: Not encrypted.
+   * - **md5**: MD5-encrypted.
    * 
    * @example
    * normal
@@ -16,11 +16,11 @@ export class Vehicle5ItemQueryRequest extends $dara.Model {
   paramType?: string;
   /**
    * @remarks
-   * License plate number
+   * The license plate number.
    * 
    * > 
-   * > - When paramType is set to normal, enter the plain text.
-   * > - When paramType is set to md5, enter the plain text of all but the last two characters of the license plate + MD5 encryption (32-bit lowercase MD5) of the last two characters.
+   * > - If ParamType is set to normal, enter the plaintext value.
+   * > - If ParamType is set to md5, enter the plaintext of the license plate number excluding the last two characters, concatenated with the MD5-encrypted last two characters (32-bit lowercase MD5).
    * 
    * @example
    * 陕A9****
@@ -28,11 +28,11 @@ export class Vehicle5ItemQueryRequest extends $dara.Model {
   vehicleNum?: string;
   /**
    * @remarks
-   * Vehicle type
+   * The vehicle type.
    * 
    * > 
-   * > - 02: Ordinary passenger car
-   * > - 52: New energy passenger car
+   * > - 02: standard passenger car
+   * > - 52: new energy passenger car.
    * 
    * @example
    * 02

package/src/models/Vehicle5itemQueryResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class Vehicle5ItemQueryResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Verification result code:
-   * - **1**: Found (charged)
-   * - **3**: No record found (not charged)
+   * The verification result code. Valid values:
+   * - **1**: Match found (billable).
+   * - **3**: No record found (not billable).
    * 
    * @example
    * 1
@@ -15,7 +15,7 @@ export class Vehicle5ItemQueryResponseBodyResultObject extends $dara.Model {
   bizCode?: string;
   /**
    * @remarks
-   * Vehicle information
+   * The vehicle information.
    * 
    * @example
    * {
@@ -59,7 +59,7 @@ export class Vehicle5ItemQueryResponseBodyResultObject extends $dara.Model {
 export class Vehicle5ItemQueryResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code
+   * The return code.
    * 
    * @example
    * 200
@@ -67,7 +67,7 @@ export class Vehicle5ItemQueryResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -75,7 +75,7 @@ export class Vehicle5ItemQueryResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0D******
@@ -83,7 +83,7 @@ export class Vehicle5ItemQueryResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The result information.
    */
   resultObject?: Vehicle5ItemQueryResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/VehicleInsureQueryRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class VehicleInsureQueryRequest extends $dara.Model {
   /**
    * @remarks
-   * Parameter type:
+   * The parameter type. Valid values:
    * 
-   * - **normal**: Unencrypted.
-   * - **md5**: MD5 encrypted.
+   * - **normal**: not encrypted.
+   * - **md5**: MD5-encrypted.
    * 
    * @example
    * normal
@@ -16,10 +16,10 @@ export class VehicleInsureQueryRequest extends $dara.Model {
   paramType?: string;
   /**
    * @remarks
-   * License plate number
+   * The license plate number.
    * > 
-   * > - When `paramType` is set to `normal`, enter the plain text.
-   * > - When `paramType` is set to `md5`, enter the plain text of all but the last two characters of the license plate + the MD5 encryption (32 lowercase characters) of the last two characters of the license plate.
+   * > - If ParamType is set to normal, enter the plaintext value.
+   * > - If ParamType is set to md5, enter the plaintext of the license plate number excluding the last two characters, concatenated with the MD5-encrypted value of the last two characters (32-bit lowercase MD5).
    * 
    * @example
    * 陕A9****
@@ -27,7 +27,7 @@ export class VehicleInsureQueryRequest extends $dara.Model {
   vehicleNum?: string;
   /**
    * @remarks
-   * Driver\\"s license vehicle type.
+   * The vehicle type on the driving license.
    * 
    * @example
    * 02
@@ -35,12 +35,12 @@ export class VehicleInsureQueryRequest extends $dara.Model {
   vehicleType?: string;
   /**
    * @remarks
-   * Vehicle identification code, i.e., the vehicle VIN
+   * The vehicle identification number (VIN).
    * 
    * 
    * > 
-   * > - When `paramType` is set to `normal`, enter the plain text.
-   * > - When `paramType` is set to `md5`, enter the plain text of all but the last four characters of the VIN + the MD5 encryption (32 lowercase characters) of the last four characters of the VIN.
+   * > - If ParamType is set to normal, enter the plaintext value.
+   * > - If ParamType is set to md5, enter the plaintext of the VIN excluding the last 4 characters, concatenated with the MD5-encrypted value of the last 4 characters (32-bit lowercase MD5).
    * 
    * @example
    * LB**************

package/src/models/VehicleInsureQueryResponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class VehicleInsureQueryResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Verification result code:
+   * The verification result code. Valid values:
    * 
    * > 
-   * > - 1: Found (charged)
-   * > - 3: No record found (not charged)
+   * > - 1: record found (billable).
+   * > - 3: no record found (not billable).
    * 
    * @example
    * 1
@@ -17,7 +17,7 @@ export class VehicleInsureQueryResponseBodyResultObject extends $dara.Model {
   bizCode?: string;
   /**
    * @remarks
-   * Insurance date information
+   * The insurance date information.
    * 
    * @example
    * {
@@ -54,7 +54,7 @@ export class VehicleInsureQueryResponseBodyResultObject extends $dara.Model {
 export class VehicleInsureQueryResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 indicates success, others indicate failure.
+   * The return code. A value of 200 indicates success. Other values indicate failure.
    * 
    * @example
    * 200
@@ -62,7 +62,7 @@ export class VehicleInsureQueryResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response message for the request information.
+   * The response message of the request.
    * 
    * @example
    * success
@@ -70,7 +70,7 @@ export class VehicleInsureQueryResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F52********
@@ -78,7 +78,7 @@ export class VehicleInsureQueryResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The result information.
    */
   resultObject?: VehicleInsureQueryResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/VehicleMetaVerifyRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class VehicleMetaVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * ID number.
+   * The ID card number.
    * 
-   * This is a required field when VerifyMetaType is set to VEHICLE_3_META.
+   * This parameter is required when VerifyMetaType is set to VEHICLE_3_META.
    * > 
-   * > - When paramType is set to normal, enter the plain text.
-   * > - When paramType is set to md5, enter the first 6 digits in plain text + the birth date encrypted with MD5 (32 lowercase characters) + the last 4 digits in plain text.
+   * > - When paramType is set to normal, enter the plaintext.
+   * > - When paramType is set to md5, enter the first 6 digits of the ID card number in plaintext + the MD5-encrypted date of birth (32-bit lowercase MD5) + the last 4 digits of the ID card number.
    * 
    * @example
    * 4****************1
@@ -18,10 +18,10 @@ export class VehicleMetaVerifyRequest extends $dara.Model {
   identifyNum?: string;
   /**
    * @remarks
-   * Parameter type:
+   * The parameter type. Valid values:
    * 
-   * - normal: Unencrypted.
-   * - md5: Encrypted with MD5.
+   * - normal: not encrypted.
+   * - md5: MD5-encrypted.
    * 
    * @example
    * normal
@@ -29,11 +29,11 @@ export class VehicleMetaVerifyRequest extends $dara.Model {
   paramType?: string;
   /**
    * @remarks
-   * Name
+   * The name.
    * 
-   * > This is an explanation
-   * > - When paramType is set to normal, enter the plain text.
-   * > - When paramType is set to md5, encrypt the first character of the name with MD5 (32 lowercase characters) + the rest of the name in plain text.
+   * > Note
+   * > - When paramType is set to normal, enter the plaintext.
+   * > - When paramType is set to md5, enter the MD5-encrypted first character of the name (32-bit lowercase MD5) + the remaining characters of the name in plaintext.
    * 
    * @example
    * 张**
@@ -41,11 +41,11 @@ export class VehicleMetaVerifyRequest extends $dara.Model {
   userName?: string;
   /**
    * @remarks
-   * Vehicle license plate
+   * The license plate number.
    * 
    * > 
-   * > - When paramType is set to normal, enter the plain text.
-   * > - When paramType is set to md5, enter the part of the license plate except for the last two characters in plain text + the last two characters of the license plate encrypted with MD5 (32 lowercase characters).
+   * > - When paramType is set to normal, enter the plaintext.
+   * > - When paramType is set to md5, enter the characters of the license plate number except the last two in plaintext + the MD5-encrypted last two characters (32-bit lowercase MD5).
    * 
    * @example
    * 陕A9****
@@ -53,7 +53,7 @@ export class VehicleMetaVerifyRequest extends $dara.Model {
   vehicleNum?: string;
   /**
    * @remarks
-   * Vehicle type
+   * The vehicle type.
    * 
    * @example
    * 02
@@ -61,11 +61,11 @@ export class VehicleMetaVerifyRequest extends $dara.Model {
   vehicleType?: string;
   /**
    * @remarks
-   * Verification type
+   * The verification type.
    * 
    * > 
-   * > - VEHICLE_2_META: Two-element verification, name + vehicle license plate verification;
-   * > - VEHICLE_3_META: Three-element verification, name + vehicle license plate + ID number verification;
+   * > - VEHICLE_2_META: two-element verification. Verifies the name and license plate number.
+   * > - VEHICLE_3_META: three-element verification. Verifies the name, license plate number, and ID card number.
    * 
    * @example
    * VEHICLE_2_META

package/src/models/VehicleMetaVerifyResponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class VehicleMetaVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Verification result.
+   * The verification result. Valid values:
    * 
-   * - 1: Consistent (billable)
-   * - 2: Inconsistent (billable)
-   * - 3: No record found (non-billable)
+   * - 1: Consistent (billable).
+   * - 2: Inconsistent (billable).
+   * - 3: No record found (not billable).
    * 
    * @example
    * 1
@@ -39,7 +39,7 @@ export class VehicleMetaVerifyResponseBodyResultObject extends $dara.Model {
 export class VehicleMetaVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response code, **200** indicates that the API response was successful.
+   * The return code. **200** indicates that the request was successful.
    * 
    * @example
    * 200
@@ -47,7 +47,7 @@ export class VehicleMetaVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -55,7 +55,7 @@ export class VehicleMetaVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 8FC3D6AC-9FED-4311-8DA7-C4BF4*****
@@ -63,7 +63,7 @@ export class VehicleMetaVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The result information.
    */
   resultObject?: VehicleMetaVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {