@alicloud/cloudauth20190307 3.13.3 → 3.14.0

package/src/models/CreateAntCloudAuthSceneRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAntCloudAuthSceneRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable binding of the mini program:
-   * - **Y**: Enable
-   * - **N (default)**: Not enabled
+   * Specifies whether to enable mini program binding. Valid values:
+   * - **Y**: Enabled.
+   * - **N (default)**: Disabled.
    * 
    * @example
    * Y
@@ -15,7 +15,7 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
   bindMiniProgram?: string;
   /**
    * @remarks
-   * Content of the uploaded verification file.
+   * The content of the uploaded verification file.
    * 
    * @example
    * 774c4aab45981ff4a86cde9255a11xxx
@@ -23,59 +23,117 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
   checkFileBody?: string;
   /**
    * @remarks
-   * Name of the uploaded verification file.
+   * The name of the uploaded verification file.
    * 
    * @example
-   * 测试.txt
+   * test.txt
    */
   checkFileName?: string;
+  /**
+   * @remarks
+   * The iOS app scheme for degradation redirect.
+   * 
+   * @example
+   * cloudauth://callback
+   */
+  degradeAppScheme?: string;
+  /**
+   * @remarks
+   * The SubCode that triggers degradation.
+   * 
+   * @example
+   * 201,202
+   */
+  degradeSubCodes?: string;
+  /**
+   * @remarks
+   * The degradation verification type.
+   * 
+   * @example
+   * ALIPAY
+   */
+  degradeType?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable enhanced device risk detection. Valid values:
+   * - **Y**: Enabled.
+   * - **N**: Disabled.
+   * 
+   * @example
+   * N
+   */
   deviceRiskPlus?: string;
   /**
    * @remarks
-   * Mini program name.
+   * The mini program name.
    * 
    * @example
-   * 测试APP
+   * TestApp
    */
   miniProgramName?: string;
   /**
    * @remarks
-   * Binding platform for the mini program:
-   * - **WECHAT**: WeChat
-   * - **ALIPAY**: Alipay
-   * - **TIKTOK**: TikTok
+   * The mini program platform to bind. Valid values:
+   * - **WECHAT**: WeChat.
+   * - **ALIPAY**: Alipay.
+   * - **TIKTOK**: TikTok.
    * 
    * @example
    * WECHAT
    */
   platform?: string;
+  /**
+   * @remarks
+   * The number of face photos for evidence storage (1-5).
+   * 
+   * @example
+   * 1
+   */
   returnPicCount?: number;
+  /**
+   * @remarks
+   * The duration of the evidence storage video, in seconds.
+   * 
+   * @example
+   * 1
+   */
   returnVideoLength?: number;
   /**
    * @remarks
-   * Scene name.
+   * The scenario name.
    * 
    * This parameter is required.
    * 
    * @example
-   * 测试场景
+   * TestScenario
    */
   sceneName?: string;
   /**
    * @remarks
-   * Whether to deliver the files generated from the authentication to the customer\\"s OSS:
-   * - **Y**: Yes
-   * - **N**: No
+   * Specifies whether to deliver files generated during verification to the customer\\"s OSS. Valid values:
+   * - **Y**: Yes.
+   * - **N**: No.
    * 
    * @example
    * Y
    */
   storeImage?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable degradation.
+   * 
+   * @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',
@@ -83,6 +141,7 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       returnVideoLength: 'ReturnVideoLength',
       sceneName: 'SceneName',
       storeImage: 'StoreImage',
+      useDegrade: 'UseDegrade',
     };
   }
 
@@ -91,6 +150,9 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       bindMiniProgram: 'string',
       checkFileBody: 'string',
       checkFileName: 'string',
+      degradeAppScheme: 'string',
+      degradeSubCodes: 'string',
+      degradeType: 'string',
       deviceRiskPlus: 'string',
       miniProgramName: 'string',
       platform: 'string',
@@ -98,6 +160,7 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       returnVideoLength: 'number',
       sceneName: 'string',
       storeImage: 'string',
+      useDegrade: 'string',
     };
   }
 

package/src/models/CreateAntCloudAuthSceneResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAntCloudAuthSceneResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 01D3BDC6-64C0-58E2-8760-3F1B56AAE299
@@ -13,7 +13,7 @@ export class CreateAntCloudAuthSceneResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * 1000015112

package/src/models/CreateAuthKeyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAuthKeyRequest extends $dara.Model {
   /**
    * @remarks
-   * When the Test flag is false or empty, AuthYears is required, in years, with a range of [1,100]. A value of 100 indicates permanent authorization.
+   * The authorization duration. This parameter is required when the Test parameter is set to false or is left empty. Unit: years. Valid values: 1 to 100. A value of 100 indicates permanent authorization.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class CreateAuthKeyRequest extends $dara.Model {
   authYears?: number;
   /**
    * @remarks
-   * Business type. No more than 64 characters. Can be used to note specific business, such as different face usage scenarios of the access party or the customer identifier to be delivered. It is recommended to pass this parameter.
+   * The business type. The value can be up to 64 characters in length. You can use this parameter to add remarks for a specific business, such as different facial recognition scenarios of the requester or the customer identifier to be delivered. We recommend that you specify this parameter.
    * 
    * @example
    * FACE_TEST
@@ -21,7 +21,9 @@ export class CreateAuthKeyRequest extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * Test flag. If true, it indicates using test authorization with a default duration of 30 days; if false, the authorization duration will be based on AuthYears.
+   * The test identifier. Valid values:
+   * - true: Uses test authorization. The authorization duration is 30 days by default.
+   * - false: The authorization duration is determined by the AuthYears parameter.
    * 
    * @example
    * false
@@ -29,7 +31,7 @@ export class CreateAuthKeyRequest extends $dara.Model {
   test?: boolean;
   /**
    * @remarks
-   * User device ID. No more than 64 characters. Can be used to identify a specific device, and it is suggested to use the physical number of the device. It is recommended to pass this parameter.
+   * The user device ID. The value can be up to 64 characters in length. You can use this parameter to identify a specific device. We recommend that you use the physical device number. We recommend that you specify this parameter.
    * 
    * @example
    * 3iJ1AY$oHcu7mC69

package/src/models/CreateAuthKeyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAuthKeyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The key that can be used for authorization activation. The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
+   * The key that can be used for authorization activation. The authorization key is valid for 30 minutes and cannot be reused. Obtain a new key before each activation.
    * 
    * @example
    * auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$
@@ -13,7 +13,7 @@ export class CreateAuthKeyResponseBody extends $dara.Model {
   authKey?: string;
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

package/src/models/CreateCloudauthstSceneRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCloudauthstSceneRequest extends $dara.Model {
   /**
    * @remarks
-   * Product code.
+   * The product code.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateCloudauthstSceneRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * Scene name.
+   * The scenario name.
    * 
    * This parameter is required.
    * 
@@ -25,9 +25,9 @@ export class CreateCloudauthstSceneRequest extends $dara.Model {
   sceneName?: string;
   /**
    * @remarks
-   * Whether to deliver the files generated from the authentication to the customer\\"s OSS:
-   * - **Y**: Enable
-   * - **N**: Disable
+   * Specifies whether to deliver files generated during authentication to the customer\\"s OSS. Valid values:
+   * - **Y**: Enabled.
+   * - **N**: Disabled.
    * 
    * @example
    * Y

package/src/models/CreateCloudauthstSceneResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCloudauthstSceneResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of this request
+   * The request ID.
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F528BDF60D2
@@ -13,7 +13,7 @@ export class CreateCloudauthstSceneResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The result, indicating whether the operation was successful.
+   * The returned result that indicates whether the operation is successful.
    * 
    * @example
    * true

package/src/models/CreateSceneConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * Intention authentication configuration, as a JSON string.
+   * The willingness authentication configuration, in JSON string format.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateSceneConfigRequest extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Scene ID.
+   * The scenario ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreateSceneConfigRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * Configuration type.
+   * The configuration type.
    * 
    * This parameter is required.
    * 

package/src/models/CreateSceneConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSceneConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of this request.
+   * The request ID.
    * 
    * @example
    * B506328A-D84B-4750-82C7-6A207C585CF1

package/src/models/CreateVerifySettingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateVerifySettingRequest extends $dara.Model {
   /**
    * @remarks
-   * Verification scenario name, supporting Chinese, English, numbers, and hyphens (-), with a maximum of 20 characters.
+   * The name of the verification scenario.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateVerifySettingRequest extends $dara.Model {
   bizName?: string;
   /**
    * @remarks
-   * Verification scenario identifier, supporting English letters, numbers, and hyphens (-), with a maximum of 20 characters.
+   * The identifier of the verification scenario.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreateVerifySettingRequest extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * Whether to use the system\\"s default guide page.
+   * Specifies whether to use the default system guide page.
    * 
    * @example
    * false
@@ -33,7 +33,7 @@ export class CreateVerifySettingRequest extends $dara.Model {
   guideStep?: boolean;
   /**
    * @remarks
-   * Whether to use the system\\"s default authorization page.
+   * Specifies whether to use the default system authorization page.
    * 
    * @example
    * true
@@ -41,7 +41,7 @@ export class CreateVerifySettingRequest extends $dara.Model {
   privacyStep?: boolean;
   /**
    * @remarks
-   * Whether to use the system\\"s default result page.
+   * Specifies whether to use the default system result page.
    * 
    * @example
    * false
@@ -49,7 +49,7 @@ export class CreateVerifySettingRequest extends $dara.Model {
   resultStep?: boolean;
   /**
    * @remarks
-   * The name of the authentication solution to use, such as **RPBasic**, **RPBioOnly**, etc. For all supported authentication solutions, see [Authentication Solutions](https://help.aliyun.com/document_detail/127521.html).
+   * The name of the verification solution.
    * 
    * This parameter is required.
    * 

package/src/models/CreateVerifySettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateVerifySettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Verification scenario name.
+   * The name of the verification scenario.
    * 
    * @example
    * 用户注册
@@ -13,7 +13,7 @@ export class CreateVerifySettingResponseBody extends $dara.Model {
   bizName?: string;
   /**
    * @remarks
-   * Verification scenario identifier.
+   * The identifier of the verification scenario.
    * 
    * @example
    * UserRegister
@@ -21,7 +21,7 @@ export class CreateVerifySettingResponseBody extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * ID of this request.
+   * The ID of the request.
    * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
@@ -29,7 +29,7 @@ export class CreateVerifySettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Authentication solution name.
+   * The name of the verification solution.
    * 
    * @example
    * RPBasic
@@ -37,7 +37,7 @@ export class CreateVerifySettingResponseBody extends $dara.Model {
   solution?: string;
   /**
    * @remarks
-   * Authentication steps
+   * The verification steps. guide indicates the guide step, and privacy indicates the authorization step.
    */
   stepList?: string[];
   static names(): { [key: string]: string } {

package/src/models/CreateWhitelistSettingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWhitelistSettingRequest extends $dara.Model {
   /**
    * @remarks
-   * ID number to be whitelisted.
+   * The ID card number to add to the whitelist.
    * 
    * @example
    * 44018219950810XXXX
@@ -13,7 +13,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   certNo?: string;
   /**
    * @remarks
-   * Certificate ID, used for whitelisting this specific authenticated user.
+   * The certificate ID. The user associated with this authentication is added to the whitelist.
    * 
    * @example
    * sha6d0405f42926084e396e76a037d00
@@ -21,7 +21,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * User language.
+   * The user language.
    * 
    * @example
    * zh
@@ -29,15 +29,15 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * Whitelist remarks.
+   * The remarks for the whitelist.
    * 
    * @example
-   * 测试白名单。
+   * Test whitelist
    */
   remark?: string;
   /**
    * @remarks
-   * Scene ID.
+   * The scene ID.
    * 
    * @example
    * 1000014526
@@ -45,9 +45,9 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * Service type:
-   * - **antcloudauth**: Financial-grade real-person authentication.
-   * - **cloudauthst** (discontinued): Enhanced real-person authentication.
+   * The service type. Valid values:
+   * - **antcloudauth**: Financial-grade ID Verification.
+   * - **cloudauthst** (discontinued): ID Verification Enhanced Edition.
    * 
    * This parameter is required.
    * 
@@ -57,7 +57,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   serviceCode?: string;
   /**
    * @remarks
-   * Visitor\\"s source IP address. No need to fill in, the system will automatically obtain it.
+   * The source IP address of the visitor. You do not need to specify this parameter. The system automatically obtains the value.
    * 
    * @example
    * 27.115.63.58
@@ -65,7 +65,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
   sourceIp?: string;
   /**
    * @remarks
-   * Number of valid days after creating the whitelist.
+   * The number of valid days after the whitelist is created.
    * 
    * This parameter is required.
    * 
@@ -73,6 +73,14 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
    * 7
    */
   validDay?: number;
+  /**
+   * @remarks
+   * The whitelist type.
+   * 
+   * @example
+   * SUPER
+   */
+  whitelistType?: string;
   static names(): { [key: string]: string } {
     return {
       certNo: 'CertNo',
@@ -83,6 +91,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
       serviceCode: 'ServiceCode',
       sourceIp: 'SourceIp',
       validDay: 'ValidDay',
+      whitelistType: 'WhitelistType',
     };
   }
 
@@ -96,6 +105,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
       serviceCode: 'string',
       sourceIp: 'string',
       validDay: 'number',
+      whitelistType: 'string',
     };
   }
 

package/src/models/CreateWhitelistSettingResponseBody.ts

@@ -13,9 +13,9 @@ export class CreateWhitelistSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return result, whether the creation was successful:
-   * - true: Success
-   * - false: Failure
+   * The returned result that indicates whether the whitelist is created. Valid values:
+   * - true: Succeeded.
+   * - false: Failed.
    * 
    * @example
    * true

package/src/models/CredentialProductVerifyV2advanceRequest.ts

@@ -6,7 +6,7 @@ import * as $dara from '@darabonba/typescript';
 export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   /**
    * @remarks
-   * Credential name: Only supports value 0501 (product image).
+   * The credential name. Only the following value is supported: 0501 (product image).
    * 
    * This parameter is required.
    * 
@@ -16,7 +16,7 @@ export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   credName?: string;
   /**
    * @remarks
-   * Credential type: Only supports value 05 (product image).
+   * The credential type. Only the following value is supported: 05 (product image).
    * 
    * This parameter is required.
    * 
@@ -26,7 +26,7 @@ export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   credType?: string;
   /**
    * @remarks
-   * InputStream object of the image.
+   * The InputStream object of the image.
    * 
    * @example
    * https://aliyundoc.com/picture*****.jpeg
@@ -34,7 +34,7 @@ export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   imageFileObject?: Readable;
   /**
    * @remarks
-   * URL of the image.
+   * The URL of the image.
    * 
    * @example
    * https://aliyundoc.com/picture*****.jpeg
@@ -42,7 +42,7 @@ export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   imageUrl?: string;
   /**
    * @remarks
-   * Merchant ID.
+   * The merchant ID.
    * 
    * @example
    * 无。
@@ -50,8 +50,7 @@ export class CredentialProductVerifyV2AdvanceRequest extends $dara.Model {
   merchantId?: string;
   /**
    * @remarks
-   * Invocation mode:
-   * Only supports value ANTI_FAKE_CHECK.
+   * The call mode. Only the following value is supported: ANTI_FAKE_CHECK.
    * 
    * This parameter is required.
    * 

package/src/models/CredentialProductVerifyV2request.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CredentialProductVerifyV2Request extends $dara.Model {
   /**
    * @remarks
-   * Credential name: Only supports value 0501 (product image).
+   * The credential name. Only the following value is supported: 0501 (product image).
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CredentialProductVerifyV2Request extends $dara.Model {
   credName?: string;
   /**
    * @remarks
-   * Credential type: Only supports value 05 (product image).
+   * The credential type. Only the following value is supported: 05 (product image).
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CredentialProductVerifyV2Request extends $dara.Model {
   credType?: string;
   /**
    * @remarks
-   * InputStream object of the image.
+   * The InputStream object of the image.
    * 
    * @example
    * https://aliyundoc.com/picture*****.jpeg
@@ -33,7 +33,7 @@ export class CredentialProductVerifyV2Request extends $dara.Model {
   imageFile?: string;
   /**
    * @remarks
-   * URL of the image.
+   * The URL of the image.
    * 
    * @example
    * https://aliyundoc.com/picture*****.jpeg
@@ -41,7 +41,7 @@ export class CredentialProductVerifyV2Request extends $dara.Model {
   imageUrl?: string;
   /**
    * @remarks
-   * Merchant ID.
+   * The merchant ID.
    * 
    * @example
    * 无。
@@ -49,8 +49,7 @@ export class CredentialProductVerifyV2Request extends $dara.Model {
   merchantId?: string;
   /**
    * @remarks
-   * Invocation mode:
-   * Only supports value ANTI_FAKE_CHECK.
+   * The call mode. Only the following value is supported: ANTI_FAKE_CHECK.
    * 
    * This parameter is required.
    *