@alicloud/cloudauth20190307 3.13.2 → 3.13.4

package/src/models/PageQueryWhiteListSettingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PageQueryWhiteListSettingRequest extends $dara.Model {
   /**
    * @remarks
-   * ID number.
+   * The certificate number.
    * 
    * @example
    * 330103xxxxxxxxxxxx
@@ -13,7 +13,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   certNo?: string;
   /**
    * @remarks
-   * Unique identifier for real person authentication.
+   * The unique identifier of the ID Verification request.
    * 
    * @example
    * sha75b4e19a1ddda059b920757b0e12b
@@ -21,7 +21,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * Current page number, default is 1.
+   * The current page number. Default value: 1.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * Number of items per page, default is 10
+   * The number of entries per page. Default value: 10.
    * 
    * @example
    * 10
@@ -37,7 +37,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For how to create an authentication scene, see Adding an Authentication Scene.
+   * The verification scenario ID. This ID is automatically generated after you create a verification scenario in the console. For more information about how to create a verification scenario, refer to Add a verification scenario.
    * 
    * @example
    * 1000000xxx
@@ -45,7 +45,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * ServiceCode of the real person cloud product, value: **antcloudauth**.
+   * The ServiceCode of the ID Verification cloud service. Value: **antcloudauth**.
    * 
    * @example
    * antcloudauth
@@ -53,11 +53,11 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   serviceCode?: string;
   /**
    * @remarks
-   * Status:
+   * The status. Valid values:
    * 
-   * - DELETE: Deleted
-   * - VALID: Not deleted and within the validity period, valid
-   * - INVALID: Not deleted but outside the validity period, invalid
+   * - DELETE: Deleted.
+   * - VALID: Not deleted and within the validity period (valid).
+   * - INVALID: Not deleted but outside the validity period (invalid).
    * 
    * @example
    * VALID
@@ -65,7 +65,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * End date of validity (timestamp in milliseconds)
+   * The end date of the validity period (timestamp in milliseconds).
    * 
    * @example
    * 1725379200000
@@ -73,7 +73,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
   validEndDate?: string;
   /**
    * @remarks
-   * Start date of validity (timestamp in milliseconds)
+   * The start date of the validity period (timestamp in milliseconds).
    * 
    * @example
    * 1725120000000

package/src/models/PageQueryWhiteListSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * ID number.
+   * The certificate number.
    * 
    * @example
    * 330103xxxxxxxxxxxx
@@ -13,7 +13,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   certNo?: string;
   /**
    * @remarks
-   * Unique identifier for real person authentication.
+   * The unique identifier of the ID Verification request.
    * 
    * @example
    * sha43d9cabd52d370d9f4cca9468f71e
@@ -21,7 +21,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   certifyId?: string;
   /**
    * @remarks
-   * Creation time.
+   * The creation time.
    * 
    * @example
    * 2024-08-30 14:00:00
@@ -29,7 +29,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   gmtCreate?: string;
   /**
    * @remarks
-   * Modification time.
+   * The modification time.
    * 
    * @example
    * 2024-08-30 14:00:00
@@ -37,7 +37,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   gmtModified?: string;
   /**
    * @remarks
-   * Whitelist ID.
+   * The whitelist ID.
    * 
    * @example
    * 234822
@@ -45,7 +45,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   id?: number;
   /**
    * @remarks
-   * Remark information.
+   * The remarks.
    * 
    * @example
    * test
@@ -53,7 +53,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   remark?: string;
   /**
    * @remarks
-   * Authentication scene ID.
+   * The verification scenario ID.
    * 
    * @example
    * 1000000332
@@ -61,7 +61,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   sceneId?: number;
   /**
    * @remarks
-   * ServiceCode of the real person cloud product
+   * The ServiceCode of the ID Verification cloud service.
    * 
    * @example
    * antcloudauth
@@ -69,11 +69,11 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   serviceCode?: string;
   /**
    * @remarks
-   * Status:
+   * The status. Valid values:
    * 
-   * - DELETE: Deleted
-   * - VALID: Not deleted and within the validity period, valid
-   * - INVALID: Not deleted but outside the validity period, invalid
+   * - DELETE: Deleted.
+   * - VALID: Not deleted and within the validity period (valid).
+   * - INVALID: Not deleted but outside the validity period (invalid).
    * 
    * @example
    * VALID
@@ -81,7 +81,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   status?: string;
   /**
    * @remarks
-   * End date of validity
+   * The end date of the validity period.
    * 
    * @example
    * 2024-09-02 13:57:51
@@ -89,7 +89,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
   validEndDate?: string;
   /**
    * @remarks
-   * Start date of validity
+   * The start date of the validity period.
    * 
    * @example
    * 2024-08-30 13:57:51
@@ -139,7 +139,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
 export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code, **200** indicates a successful API response.
+   * The response code. **200** indicates that the request was successful.
    * 
    * @example
    * 200
@@ -147,7 +147,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -155,7 +155,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -163,7 +163,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Number of items per page.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -171,7 +171,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F528BDF60D2
@@ -179,12 +179,12 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Request result
+   * The request result.
    */
   resultObject?: PageQueryWhiteListSettingResponseBodyResultObject[];
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true
@@ -192,7 +192,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * Total number of items.
+   * The total number of entries.
    * 
    * @example
    * 28
@@ -200,7 +200,7 @@ export class PageQueryWhiteListSettingResponseBody extends $dara.Model {
   totalItem?: number;
   /**
    * @remarks
-   * Total number of pages.
+   * The total number of pages.
    * 
    * @example
    * 3

package/src/models/QueryBlackListStrategyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryBlackListStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-shanghai

package/src/models/QueryBlackListStrategyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Blacklist string, separated by **commas**.
+   * The blacklist string. Multiple blacklist entries are separated by **commas**.
    * 
    * @example
    * 127.0.0.1,127.0.0.2
@@ -13,11 +13,11 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   bizContent?: string;
   /**
    * @remarks
-   * List type:
-   * - mobile: Phone number blacklist
+   * The blacklist type. Valid values:
+   * - mobile: phone number blacklist
    * - ip: IP blacklist
-   * - identifyNum: ID number blacklist
-   * - bankCard: Bank card blacklist
+   * - identifyNum: ID card blacklist
+   * - bankCard: bank card blacklist.
    * 
    * @example
    * identifyNum
@@ -25,7 +25,7 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   bizKey?: string;
   /**
    * @remarks
-   * Modification time.
+   * The modification time.
    * 
    * @example
    * 1711533786000
@@ -33,7 +33,7 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   gmtModified?: number;
   /**
    * @remarks
-   * Rule ID.
+   * The rule ID.
    * 
    * @example
    * 234822
@@ -41,10 +41,10 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   id?: number;
   /**
    * @remarks
-   * Product name:
-   * - id2meta: ID number two-factor verification
-   * - mobile3Meta: Phone number factor verification
-   * - bankcardMeta: Bank card factor verification
+   * The product name. Valid values:
+   * - id2meta: ID card two-factor verification.
+   * - mobile3Meta: Phone number factor verification.
+   * - bankcardMeta: Bank card factor verification.
    * 
    * @example
    * id2meta
@@ -52,9 +52,9 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   productName?: string;
   /**
    * @remarks
-   * Status:
-   * - **disabled**: Disabled
-   * - **normal**: Enabled
+   * The status. Valid values:
+   * - **disabled**: Disabled.
+   * - **normal**: Enabled.
    * 
    * @example
    * disabled
@@ -62,7 +62,7 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
   status?: string;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 12600512xxxxxxxx
@@ -104,7 +104,7 @@ export class QueryBlackListStrategyResponseBodyResultObject extends $dara.Model
 export class QueryBlackListStrategyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code, **200** indicates successful API response.
+   * The return code. **200** indicates that the request was successful.
    * 
    * @example
    * 200
@@ -112,7 +112,7 @@ export class QueryBlackListStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Error message.
+   * The error message.
    * 
    * @example
    * success
@@ -120,7 +120,7 @@ export class QueryBlackListStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260
@@ -128,7 +128,7 @@ export class QueryBlackListStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The returned result.
    */
   resultObject?: QueryBlackListStrategyResponseBodyResultObject[];
   static names(): { [key: string]: string } {

package/src/models/QueryControlStrategyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryControlStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * Product type, currently only supports ANT_CLOUD_AUTH (financial-grade real person), all others have been phased out.
+   * The product type. Currently, only ANT_CLOUD_AUTH (financial-grade ID Verification) is supported. All other product types have been discontinued.
    * 
    * @example
    * ANT_CLOUD_AUTH
@@ -13,7 +13,7 @@ export class QueryControlStrategyRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-shanghai

package/src/models/QueryControlStrategyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * API name, same as the **ProductCode** of the authentication interface.
+   * The API name, which is the same as the ProductCode of the verification operation.
    * 
    * @example
    * ID_PRO
@@ -13,14 +13,15 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   apiName?: string;
   /**
    * @remarks
-   * Rule configuration type:
+   * The rule configuration type. Valid values:
+   * 
    * - **QPS**: QPS greater than
-   * - **SUCCESS_RATE_5_MIN**: Success rate in the last 5 minutes less than
-   * - **RESP_TIME_5_MIN**: Average response time in the last 5 minutes greater than
-   * - **AMOUNT_RISE**: Call volume growth ratio greater than
-   * - **AMOUNT_FALL**: Call volume decline ratio less than
-   * - **PASSED_RATE_1_HOUR**: Verification consistency rate in the last hour less than
-   * - **PARAM_ERROR_RATE_1_HOUR**: Parameter error rate in the last hour greater than
+   * - **SUCCESS_RATE_5_MIN**: success rate in the last 5 minutes less than
+   * - **RESP_TIME_5_MIN**: average response time in the last 5 minutes greater than
+   * - **AMOUNT_RISE**: call volume increase compared to the previous period greater than
+   * - **AMOUNT_FALL**: call volume decrease compared to the previous period less than
+   * - **PASSED_RATE_1_HOUR**: verification consistency rate in the last hour less than
+   * - **PARAM_ERROR_RATE_1_HOUR**: parameter error rate in the last hour greater than.
    * 
    * @example
    * SUCCESS_RATE_5_MIN
@@ -28,7 +29,7 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * Rule ID.
+   * The rule ID.
    * 
    * @example
    * 234822
@@ -36,9 +37,10 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Status:
-   * - **disabled**: Disabled
-   * - **normal**: Enabled
+   * The status. Valid values:
+   * 
+   * - **disabled**: Disabled.
+   * - **normal**: Enabled.
    * 
    * @example
    * normal
@@ -46,7 +48,7 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Alarm threshold for rule configuration.
+   * The alert threshold for configure alerting of the rule.
    * 
    * @example
    * 0.9
@@ -54,7 +56,7 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
   threshold?: number;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 126005125163xxxx
@@ -94,7 +96,7 @@ export class QueryControlStrategyResponseBodyResultObject extends $dara.Model {
 export class QueryControlStrategyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 for success, others for failure.
+   * The response code. A value of 200 indicates success. Other values indicate failure.
    * 
    * @example
    * Success
@@ -102,7 +104,7 @@ export class QueryControlStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -110,7 +112,7 @@ export class QueryControlStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * B506328A-D84B-4750-82C7-6A207C585CF1
@@ -118,7 +120,7 @@ export class QueryControlStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Processing result.
+   * The processing result.
    */
   resultObject?: QueryControlStrategyResponseBodyResultObject[];
   static names(): { [key: string]: string } {

package/src/models/QueryCustomizeFlowStrategyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryCustomizeFlowStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others have been phased out.
+   * The product type. Currently, only **ANT_CLOUD_AUTH** (financial-grade ID Verification) is supported. All other types have been discontinued.
    * 
    * @example
    * ANT_CLOUD_AUTH
@@ -13,7 +13,7 @@ export class QueryCustomizeFlowStrategyRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * regionId
+   * The region ID.
    * 
    * @example
    * cn-shanghai
@@ -21,7 +21,7 @@ export class QueryCustomizeFlowStrategyRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * User ID
+   * The user ID.
    * 
    * This parameter is required.
    * 

package/src/models/QueryCustomizeFlowStrategyResponseBody.ts

@@ -13,7 +13,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   accumulateKey?: string;
   /**
    * @remarks
-   * Flow control statistical window, unit: **minutes**.
+   * The rate limiting statistical window. Unit: **minutes**.
    * 
    * @example
    * 60
@@ -21,7 +21,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   accumulateWindow?: string;
   /**
    * @remarks
-   * API name, same as **ProductCode**.
+   * The API name, which is the same as **ProductCode**.
    * 
    * @example
    * ID_PRO
@@ -29,11 +29,11 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   apiName?: string;
   /**
    * @remarks
-   * Flow type:
-   * - **ACCUMULATE**: ID card reappears
-   * - **PASSED_RATE**: Pass rate less than
-   * - **SUB_CODE_205**: Authentication failed and liveness attack 205 ratio greater than
-   * - **SUB_CODE_206**: Authentication failed and liveness attack 206 ratio greater than
+   * The flow type. Valid values:
+   * - **ACCUMULATE**: repeated occurrence of an ID card number.
+   * - **PASSED_RATE**: pass rate less than the threshold.
+   * - **SUB_CODE_205**: authentication failed and the proportion of liveness attack 205 is greater than the threshold.
+   * - **SUB_CODE_206**: authentication failed and the proportion of liveness attack 206 is greater than the threshold.
    * 
    * @example
    * ACCUMULATE
@@ -41,7 +41,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   flowType?: string;
   /**
    * @remarks
-   * Rule ID.
+   * The rule ID.
    * 
    * @example
    * 234822
@@ -49,7 +49,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   id?: string;
   /**
    * @remarks
-   * Operation.
+   * The operation.
    * 
    * @example
    * match
@@ -57,9 +57,9 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   operation?: string;
   /**
    * @remarks
-   * Status:
-   * - **disabled**: Disabled
-   * - **normal**: Enabled
+   * The status. Valid values:
+   * - **disabled**: Disabled.
+   * - **normal**: Enabled.
    * 
    * @example
    * disabled
@@ -67,7 +67,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   status?: string;
   /**
    * @remarks
-   * Threshold.
+   * The threshold.
    * 
    * @example
    * 10
@@ -75,7 +75,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
   threshold?: string;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 126005125163xxxx
@@ -121,7 +121,7 @@ export class QueryCustomizeFlowStrategyResponseBodyResultObject extends $dara.Mo
 export class QueryCustomizeFlowStrategyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 for success, others for failure.
+   * The return code. A value of 200 indicates success. Other values indicate failure.
    * 
    * @example
    * 200
@@ -129,7 +129,7 @@ export class QueryCustomizeFlowStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -137,7 +137,7 @@ export class QueryCustomizeFlowStrategyResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * Error message.
+   * The error message.
    * 
    * @example
    * success
@@ -145,7 +145,7 @@ export class QueryCustomizeFlowStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of this request.
+   * The request ID.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
@@ -153,12 +153,12 @@ export class QueryCustomizeFlowStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Processing result.
+   * The processing result.
    */
   resultObject?: QueryCustomizeFlowStrategyResponseBodyResultObject[];
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true

package/src/models/QuerySceneConfigsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QuerySceneConfigsRequest extends $dara.Model {
   /**
    * @remarks
-   * Scene type.
+   * The scenario type.
    * 
    * This parameter is required.
    *