@alicloud/cloudauth20190307 3.13.3 → 3.13.4

package/src/models/MobileRecycledMetaVerifyResponseBody.ts

@@ -4,16 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class MobileRecycledMetaVerifyResponseBodyResultObject extends $dara.Model {
   /**
+   * @remarks
+   * The query result. Valid values:
+   * 
+   * - 1: A query result is found.
+   * - 3: No query result is found.
+   * 
    * @example
    * 1
    */
   bizCode?: string;
   /**
+   * @remarks
+   * The carrier name. China Mobile: CMCC. China Unicom: CUCC. China Telecom: CTCC.
+   * 
    * @example
    * CMCC
    */
   ispName?: string;
   /**
+   * @remarks
+   * The detailed verification result. Valid values:
+   * 
+   * - 101: The registration date is equal to or later than the phone number activation date.
+   * - 102: The registration date is earlier than the phone number activation date.
+   * - 103: The new subscriber has not been synchronized yet.
+   * - 301: Data exception or the subscriber has been deactivated.
+   * 
    * @example
    * 101
    */
@@ -45,11 +62,20 @@ export class MobileRecycledMetaVerifyResponseBodyResultObject extends $dara.Mode
 
 export class MobileRecycledMetaVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code. A value of 200 indicates success. Any other value indicates failure.
+   * > **Important**
+   * - This parameter indicates whether the API operation is called correctly. For more information about return codes, see error codes.
+   * - Check the business verification result in the fields of ResultObject.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
@@ -62,6 +88,10 @@ export class MobileRecycledMetaVerifyResponseBody extends $dara.Model {
    * 8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   resultObject?: MobileRecycledMetaVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyBlackListStrategyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model {
   /**
    * @remarks
-   * Blacklist string, with each blacklist entry separated by commas.
+   * The blacklist string. Separate multiple entries with commas (,).
    * 
    * @example
    * 127.0.0.1,127.0.0.2
@@ -13,11 +13,11 @@ export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model
   bizContent?: string;
   /**
    * @remarks
-   * List Type:
-   * - **mobile**: Mobile number blacklist
-   * - **ip**: IP blacklist
-   * - **identifyNum**: ID number blacklist
-   * - **bankCard**: Bank card blacklist
+   * The blacklist type. Valid values:
+   * - **mobile**: mobile number blacklist.
+   * - **ip**: IP blacklist.
+   * - **identifyNum**: ID card blacklist.
+   * - **bankCard**: bank card blacklist.
    * 
    * @example
    * ip
@@ -25,9 +25,9 @@ export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model
   bizKey?: string;
   /**
    * @remarks
-   * Rule ID:
-   * - **Empty**: Add a new rule
-   * - **Non-empty**: Modify an existing rule
+   * The rule ID. Valid values:
+   * - **Empty**: creates a rule.
+   * - **Not empty**: modifies a rule.
    * 
    * @example
    * 38
@@ -35,10 +35,10 @@ export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model
   id?: number;
   /**
    * @remarks
-   * Product Name:
-   * - **id2meta**: ID card two-factor verification
-   * - **mobile3Meta**: Mobile number factor verification
-   * - **bankcardMeta**: Bank card factor verification
+   * The product name. Valid values:
+   * - **id2meta**: ID card two-element verification.
+   * - **mobile3Meta**: mobile number element verification.
+   * - **bankcardMeta**: bank card element verification.
    * 
    * @example
    * id2meta
@@ -46,9 +46,9 @@ export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model
   productName?: string;
   /**
    * @remarks
-   * Verification Status:
-   * - **1**: Verification passed
-   * - **2**: Verification failed
+   * The authentication status. Valid values:
+   * - **1**: Authentication passed.
+   * - **2**: Authentication failed.
    * 
    * @example
    * 3
@@ -86,12 +86,12 @@ export class ModifyBlackListStrategyRequestBlackListStrategy extends $dara.Model
 export class ModifyBlackListStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * Blacklist rule.
+   * The blacklist rule.
    */
   blackListStrategy?: ModifyBlackListStrategyRequestBlackListStrategy;
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-shanghai

package/src/models/ModifyBlackListStrategyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyBlackListStrategyResponseBody 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
@@ -13,7 +13,7 @@ export class ModifyBlackListStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Returned data.
+   * The returned data.
    * 
    * @example
    * {\\"StatusCode\\": -1}
@@ -21,7 +21,7 @@ export class ModifyBlackListStrategyResponseBody extends $dara.Model {
   data?: number;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * OK
@@ -29,7 +29,7 @@ export class ModifyBlackListStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
@@ -37,7 +37,7 @@ export class ModifyBlackListStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/ModifyBlackListStrategyShrinkRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyBlackListStrategyShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Blacklist rule.
+   * The blacklist rule.
    */
   blackListStrategyShrink?: string;
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-shanghai

package/src/models/ModifyControlStrategyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyControlStrategyRequestControlStrategyList extends $dara.Model {
   /**
    * @remarks
-   * API name, same as **ProductCode**.
+   * The API name, which is the same as **ProductCode**.
    * 
    * @example
    * ID_PRO
@@ -13,14 +13,14 @@ export class ModifyControlStrategyRequestControlStrategyList 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 +28,7 @@ export class ModifyControlStrategyRequestControlStrategyList extends $dara.Model
   bizType?: string;
   /**
    * @remarks
-   * Rule ID.
+   * The rule ID.
    * 
    * @example
    * 38
@@ -36,9 +36,9 @@ export class ModifyControlStrategyRequestControlStrategyList extends $dara.Model
   id?: number;
   /**
    * @remarks
-   * Status:
-   * - **disabled**: Disabled
-   * - **normal**: Enabled
+   * The status. Valid values:
+   * - **disabled**: Disabled.
+   * - **normal**: Enabled.
    * 
    * @example
    * 2
@@ -46,7 +46,7 @@ export class ModifyControlStrategyRequestControlStrategyList extends $dara.Model
   status?: string;
   /**
    * @remarks
-   * Alarm threshold for the rule.
+   * The alert threshold of the rule.
    * 
    * @example
    * 0.9
@@ -84,12 +84,12 @@ export class ModifyControlStrategyRequestControlStrategyList extends $dara.Model
 export class ModifyControlStrategyRequest extends $dara.Model {
   /**
    * @remarks
-   * List of security alarm rules.
+   * The list of security alert rules.
    */
   controlStrategyList?: ModifyControlStrategyRequestControlStrategyList[];
   /**
    * @remarks
-   * Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others are 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
@@ -97,7 +97,7 @@ export class ModifyControlStrategyRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * Region ID of the intelligent access gateway instance.
+   * The region ID of the Smart Access Gateway instance.
    * 
    * @example
    * cn-shanghai

package/src/models/ModifyControlStrategyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyControlStrategyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code
+   * The return code.
    * 
    * @example
    * 200
@@ -13,7 +13,7 @@ export class ModifyControlStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Information returned by the API call.
+   * The response message returned by the operation.
    * 
    * @example
    * success
@@ -21,7 +21,7 @@ export class ModifyControlStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
@@ -29,7 +29,7 @@ export class ModifyControlStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true

package/src/models/ModifyControlStrategyShrinkRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyControlStrategyShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * List of security alarm rules.
+   * The list of security alert rules.
    */
   controlStrategyListShrink?: string;
   /**
    * @remarks
-   * Product type, currently only supports **ANT_CLOUD_AUTH** (Financial-grade Real Person), all others are 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
@@ -18,7 +18,7 @@ export class ModifyControlStrategyShrinkRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * Region ID of the intelligent access gateway instance.
+   * The region ID of the Smart Access Gateway instance.
    * 
    * @example
    * cn-shanghai

package/src/models/ModifyCustomizeFlowStrategyListRequest.ts

@@ -13,7 +13,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   accumulateKey?: string;
   /**
    * @remarks
-   * Flow control statistical window size, in minutes.
+   * The size of the rate limiting statistical window, in minutes.
    * 
    * @example
    * 60
@@ -21,7 +21,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   accumulateWindow?: number;
   /**
    * @remarks
-   * API name, same as **ProductCode**.
+   * The API name, which is the same as **ProductCode**.
    * 
    * This parameter is required.
    * 
@@ -31,11 +31,11 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   apiName?: string;
   /**
    * @remarks
-   * Flow type:
-   * - **ACCUMULATE**: Repeated appearance of ID card
-   * - **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.
+   * - **PASSED_RATE**: pass rate is less than.
+   * - **SUB_CODE_205**: authentication failed and the proportion of liveness attack 205 is greater than.
+   * - **SUB_CODE_206**: authentication failed and the proportion of liveness attack 206 is greater than.
    * 
    * @example
    * ACCUMULATE
@@ -43,7 +43,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   flowType?: string;
   /**
    * @remarks
-   * Rule ID.
+   * The rule ID.
    * 
    * @example
    * 38
@@ -51,7 +51,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   id?: number;
   /**
    * @remarks
-   * Operation.
+   * The operation.
    * 
    * @example
    * -
@@ -59,9 +59,9 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   operation?: string;
   /**
    * @remarks
-   * Status:
-   * - **disabled**: Disabled
-   * - **normal**: Enabled
+   * The status. Valid values:
+   * - **disabled**: disabled.
+   * - **normal**: enabled.
    * 
    * This parameter is required.
    * 
@@ -71,7 +71,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   status?: string;
   /**
    * @remarks
-   * Flow control threshold.
+   * The rate limiting threshold.
    * 
    * This parameter is required.
    * 
@@ -81,7 +81,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
   threshold?: number;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 126005125163xxxx
@@ -127,7 +127,7 @@ export class ModifyCustomizeFlowStrategyListRequestStrategyObject extends $dara.
 export class ModifyCustomizeFlowStrategyListRequest 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
@@ -135,7 +135,7 @@ export class ModifyCustomizeFlowStrategyListRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * Strategy list.
+   * The policy list.
    */
   strategyObject?: ModifyCustomizeFlowStrategyListRequestStrategyObject[];
   static names(): { [key: string]: string } {

package/src/models/ModifyCustomizeFlowStrategyListResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code, **200** indicates the interface responded successfully.
+   * The return code. **200** indicates that the request is successful.
    * 
    * @example
    * 200
@@ -13,7 +13,7 @@ export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Result data.
+   * The result data.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   data?: number;
   /**
    * @remarks
-   * HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -29,7 +29,7 @@ export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -37,7 +37,7 @@ export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260
@@ -45,7 +45,7 @@ export class ModifyCustomizeFlowStrategyListResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true

package/src/models/ModifyCustomizeFlowStrategyListShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyCustomizeFlowStrategyListShrinkRequest 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 ModifyCustomizeFlowStrategyListShrinkRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * Strategy list.
+   * The policy list.
    */
   strategyObjectShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyDeviceInfoRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDeviceInfoRequest extends $dara.Model {
   /**
    * @remarks
-   * The updated business type. It should not exceed 64 characters and is defined by the connected party. It can be used to annotate specific businesses, for example, different face usage scenarios or the customer identifiers to be delivered.
+   * The updated business type. The value can be up to 64 characters in length. This parameter is defined by the requester and can be used to add remarks for specific business scenarios, such as different facial recognition usage scenarios or customer identifiers for pending deliveries.
    * 
    * @example
    * FACE_TEST
@@ -13,7 +13,7 @@ export class ModifyDeviceInfoRequest extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * A unique ID generated by the real-person authentication server for the connected device, which is only generated after the device is successfully activated. This ID can be obtained through the getLicenseExtraInfo function in the offline facial recognition SDK.
+   * The unique ID generated by the ID Verification server for the device of the requester. This ID is generated only after the device is successfully activated. You can obtain this ID by calling the getLicenseExtraInfo function in the offline facial recognition SDK.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class ModifyDeviceInfoRequest extends $dara.Model {
   deviceId?: string;
   /**
    * @remarks
-   * The extended duration of the device expiration. Unit: years, with a range of [1,100]. A value of 100 indicates permanent use. One year is calculated as 365 days.
+   * The period by which to extend the device expiration time. Unit: years. Valid values: 1 to 100. A value of 100 indicates permanent use. One year is calculated as 365 days.
    * 
    * @example
    * 1
@@ -31,8 +31,8 @@ export class ModifyDeviceInfoRequest extends $dara.Model {
   duration?: string;
   /**
    * @remarks
-   * The current expiration time of the device. If the expiration date is incorrect (differing from the real-person authentication server\\"s recorded expiration time by more than one week), an error will be reported.
-   * > The expiration time can be queried through the DescribeDeviceInfo interface. An incorrect expiration date will result in an error. This check ensures that the business party does not accidentally re-activate a device due to some misoperation, thus consuming the authorization unnecessarily.
+   * The expiration time of the current device. An error is returned if the expiration date is incorrect (differs from the expiration time recorded on the ID Verification server by more than one week).
+   * > You can query the expiration time by calling the DescribeDeviceInfo operation. An error is returned if the expiration date is incorrect. This validation ensures that the requester does not accidentally reactivate a device due to misoperations, which would unnecessarily consume authorization quotas.
    * 
    * @example
    * 20190401
@@ -40,7 +40,7 @@ export class ModifyDeviceInfoRequest extends $dara.Model {
   expiredDay?: string;
   /**
    * @remarks
-   * The updated user device ID. It should not exceed 64 characters and is defined by the connected party. It can be used to identify specific devices, and it is recommended to use the physical number of the device.
+   * The updated user device ID. The value can be up to 64 characters in length. This parameter is defined by the requester and can be used to identify a specific device. We recommend that you use the physical device number.
    * 
    * @example
    * 3iJ1AY$oHcu7mC69

package/src/models/ModifyDeviceInfoResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDeviceInfoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * If the Duration in the request parameters is not empty, this field represents the start time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.
+   * If the Duration request parameter is not empty, this field indicates the authorization start time after the device validity period is extended. One year in Duration is calculated as 365 days. Example: 20180101.
    * 
    * @example
    * 20190401
@@ -13,7 +13,7 @@ export class ModifyDeviceInfoResponseBody extends $dara.Model {
   beginDay?: string;
   /**
    * @remarks
-   * Corresponds to the BizType in the request parameters.
+   * The value corresponds to the BizType in the request parameters.
    * 
    * @example
    * FACE_TEST
@@ -21,7 +21,7 @@ export class ModifyDeviceInfoResponseBody extends $dara.Model {
   bizType?: string;
   /**
    * @remarks
-   * Corresponds to the DeviceId in the request parameters.
+   * The value corresponds to the DeviceId in the request parameters.
    * 
    * @example
    * wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
@@ -29,7 +29,7 @@ export class ModifyDeviceInfoResponseBody extends $dara.Model {
   deviceId?: string;
   /**
    * @remarks
-   * If the Duration in the request parameters is not empty, this field represents the expiration time of the authorization after the device validity period has been extended. One year of Duration is calculated as 365 days. Example: 20180101.
+   * If the Duration request parameter is not empty, this field indicates the authorization expiration time after the device validity period is extended. One year in Duration is calculated as 365 days. Example: 20180101.
    * 
    * @example
    * 20200330
@@ -45,7 +45,7 @@ export class ModifyDeviceInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Corresponds to the UserDeviceId in the request parameters.
+   * The value corresponds to the UserDeviceId in the request parameters.
    * 
    * @example
    * 3iJ1AY$oHcu7mC69