@alicloud/dytnsapi20200217 3.3.0 → 3.4.0

package/src/models/PhoneNumberStatusForRealResponseBody.ts

@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
+   * The carrier that provides service for the phone number. If the number has been ported through mobile number portability (MNP), this field returns the new carrier. Valid values:
    * 
-   * *   **CMCC**: China Mobile
-   * *   **CUCC**: China Unicom
-   * *   **CTCC**: China Telecom
+   * - **CMCC**: China Mobile.
    * 
-   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * - **CUCC**: China Unicom.
+   * 
+   * - **CTCC**: China Telecom.
+   * 
+   * > Queries for China Broadnet numbers are not supported.
    * 
    * @example
    * CMCC
@@ -19,18 +21,25 @@ export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
   carrier?: string;
   /**
    * @remarks
-   * The returned status for the queried phone number. Valid values:
+   * The status of the phone number. Valid values:
+   * 
+   * - **NORMAL**: The number is in service.
+   * 
+   * - **SHUTDOWN**: The service for the number is suspended.
+   * 
+   * - **POWER_OFF**: The phone is powered off.
+   * 
+   * - **NOT_EXIST**: The number is not in service.
    * 
-   * *   **NORMAL**: The queried phone number can be reached.
-   * *   **SHUTDOWN**: The queried phone number is suspended.
-   * *   **POWER_OFF**: The phone is powered off.
-   * *   **NOT_EXIST**: The queried phone number is a nonexistent number.
-   * *   **BUSY**: The queried phone number is busy.
-   * *   **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
-   * *   **DEFECT**: The queried phone number is invalid.
-   * *   **UNKNOWN**: The queried phone number is unknown.
+   * - **BUSY**: The line is busy.
    * 
-   * >  Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
+   * - **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
+   * 
+   * - **DEFECT**: The number is invalid.
+   * 
+   * - **UNKNOWN**: The status is unknown.
+   * 
+   * > Due to carrier system adjustments, China Telecom numbers no longer return the `BUSY`, `SUSPECTED_POWER_OFF`, and `POWER_OFF` statuses. For more information, see the [official announcement](https://help.aliyun.com/document_detail/2489709.html).
    * 
    * @example
    * NORMAL
@@ -62,11 +71,13 @@ export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
 export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The request status code. Valid values:
+   * 
+   * - **OK**: The request was successful.
+   * 
+   * - **OperatorLimit**: The query for the phone number is restricted by the carrier.
    * 
-   * *   **OK**: The request is successful.
-   * *   **OperatorLimit**: The carrier prohibits the query of the phone number.
-   * *   **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
+   * - **RequestFrequencyLimit**: Carriers prohibit high-frequency queries for the same number within a short period. If this error code is returned, try again later.
    * 
    * @example
    * OK
@@ -74,12 +85,12 @@ export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The data returned for the request.
    */
   data?: PhoneNumberStatusForRealResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK
@@ -87,7 +98,7 @@ export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * A unique identifier for the request. You can use this ID to troubleshoot issues.
    * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

package/src/models/PhoneNumberStatusForSmsRequest.ts

@@ -7,7 +7,7 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
    * @remarks
    * The authorization code.
    * 
-   * >  On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).
+   * > On the **My Applications** page in the [Phone Number Pedia console](https://dytns.console.aliyun.com/analysis/apply), obtain the authorization ID and use it as the value for this parameter.
    * 
    * This parameter is required.
    * 
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number to query.
    * 
-   * *   If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.
-   * *   If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.
-   * *   If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.
+   * - If `Mask` is set to `NORMAL`, specify an 11-digit phone number.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * - If `Mask` is set to `MD5`, specify a 32-character encrypted string.
+   * 
+   * - If `Mask` is set to `SHA256`, specify a 64-character encrypted string.
+   * 
+   * - If `Mask` is set to `SM3`, specify a 64-character encrypted string.
+   * 
+   * >Notice: 
+   * 
+   * The encrypted string is not case-sensitive.
    * 
    * This parameter is required.
    * 
@@ -33,11 +39,15 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
   inputNumber?: string;
   /**
    * @remarks
-   * The encryption method of the phone number. Valid values:
+   * The encryption method for the phone number. Valid values:
+   * 
+   * - **NORMAL**: The number is not encrypted.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
-   * *   **NORMAL**: plaintext
-   * *   **MD5**
-   * *   **SHA256**
+   * - **SM3**
    * 
    * This parameter is required.
    * 

package/src/models/PhoneNumberStatusForSmsResponseBody.ts

@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
+   * The carrier of the phone number. If the number has been ported, this parameter returns the current carrier. Valid values:
    * 
-   * *   **CMCC**: China Mobile
-   * *   **CUCC**: China Unicom
-   * *   **CTCC**: China Telecom
+   * - **CMCC**: China Mobile.
    * 
-   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * - **CUCC**: China Unicom.
+   * 
+   * - **CTCC**: China Telecom.
+   * 
+   * > Queries for China Broadnet numbers are not supported.
    * 
    * @example
    * CMCC
@@ -19,16 +21,21 @@ export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
   carrier?: string;
   /**
    * @remarks
-   * The returned status for the queried phone number. Valid values:
+   * The status of the phone number. Valid values:
+   * 
+   * - **NORMAL**: Active.
+   * 
+   * - **SHUTDOWN**: Shutdown.
+   * 
+   * - **POWER_OFF**: Powered off.
    * 
-   * *   **NORMAL**: The queried phone number can be reached.
-   * *   **SHUTDOWN**: The queried phone number is suspended.
-   * *   **POWER_OFF**: The phone is powered off.
-   * *   **NOT_EXIST**: The queried phone number is a nonexistent number.
-   * *   **DEFECT**: The queried phone number is invalid.
-   * *   **UNKNOWN**: The queried phone number is unknown.
+   * - **NOT_EXIST**: Non-existent number.
    * 
-   * >  Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
+   * - **DEFECT**: Invalid number.
+   * 
+   * - **UNKNOWN**: Unknown.
+   * 
+   * > Due to carrier system adjustments, the statuses for busy, suspected to be powered off, and powered off are not returned for China Telecom numbers. For more information, see the [official announcement](https://help.aliyun.com/document_detail/2489709.html).
    * 
    * @example
    * NORMAL
@@ -60,11 +67,13 @@ export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
 export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The request status code. Valid values:
+   * 
+   * - **OK**: The request was successful.
+   * 
+   * - **OperatorLimit**: The carrier restricts queries for this phone number.
    * 
-   * *   **OK**: The request is successful.
-   * *   **OperatorLimit**: The carrier prohibits the query of the phone number.
-   * *   **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
+   * - **RequestFrequencyLimit**: Indicates that requests for a single number are too frequent. Due to carrier restrictions, repeated queries for the same number within a short period are prohibited. If you receive this error code, try again later.
    * 
    * @example
    * OK
@@ -72,12 +81,12 @@ export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * A container for the returned data.
    */
   data?: PhoneNumberStatusForSmsResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK
@@ -85,7 +94,7 @@ export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The unique ID of the request. Use this ID to troubleshoot issues.
    * 
    * @example
    * 68A40250-50CD-034C-B728-0BD135850177

package/src/models/PhoneNumberStatusForVoiceRequest.ts

@@ -7,7 +7,7 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
    * @remarks
    * The authorization code.
    * 
-   * >  On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).
+   * > The authorization code is the authorization ID that you can find on the **My Applications** page of the [Phone Number Encyclopedia console](https://dytns.console.aliyun.com/analysis/apply).
    * 
    * This parameter is required.
    * 
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number to query.
    * 
-   * *   If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.
-   * *   If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.
-   * *   If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.
+   * - If you set `Mask` to `NORMAL`, specify an 11-digit mobile number.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * - If you set `Mask` to `MD5`, specify a 32-bit encrypted string.
+   * 
+   * - If you set `Mask` to `SHA256`, specify a 64-bit encrypted string.
+   * 
+   * - If you set `Mask` to `SM3`, specify a 64-bit encrypted string.
+   * 
+   * >Notice: 
+   * 
+   * The letters in the encrypted string are not case-sensitive.
    * 
    * This parameter is required.
    * 
@@ -35,9 +41,13 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
    * @remarks
    * The encryption method. Valid values:
    * 
-   * *   **NORMAL**: plaintext
-   * *   **MD5**
-   * *   **SHA256**
+   * - **NORMAL**: The number is in plaintext.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
+   * 
+   * - **SM3**
    * 
    * This parameter is required.
    * 

package/src/models/PhoneNumberStatusForVoiceResponseBody.ts

@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
+   * The current carrier for the number. If the number has been ported, this field returns the new carrier. Valid values:
    * 
-   * *   **CMCC**: China Mobile
-   * *   **CUCC**: China Unicom
-   * *   **CTCC**: China Telecom
+   * - **CMCC**: China Mobile
    * 
-   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * - **CUCC**: China Unicom
+   * 
+   * - **CTCC**: China Telecom
+   * 
+   * > Queries for China Broadnet numbers are not supported.
    * 
    * @example
    * CTCC
@@ -19,17 +21,23 @@ export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
   carrier?: string;
   /**
    * @remarks
-   * The returned status for the queried phone number. Valid values:
+   * The status of the phone number. Valid values:
+   * 
+   * - **NORMAL**: The number is active.
+   * 
+   * - **SHUTDOWN**: The service for the number is suspended.
+   * 
+   * - **POWER_OFF**: The phone is powered off.
    * 
-   * *   **NORMAL**: The queried phone number can be reached.
-   * *   **SHUTDOWN**: The queried phone number is suspended.
-   * *   **POWER_OFF**: The phone is powered off.
-   * *   **NOT_EXIST**: The queried phone number is a nonexistent number.
-   * *   **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
-   * *   **DEFECT**: The queried phone number is invalid.
-   * *   **UNKNOWN**: The queried phone number is unknown.
+   * - **NOT_EXIST**: The number does not exist.
    * 
-   * >  Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
+   * - **SUSPECTED_POWER_OFF**: The phone is likely powered off.
+   * 
+   * - **DEFECT**: The number is invalid.
+   * 
+   * - **UNKNOWN**: The status is unknown.
+   * 
+   * > Due to carrier system adjustments, the `SUSPECTED_POWER_OFF` and `POWER_OFF` statuses are not returned for China Telecom numbers. [For more information, see the official announcement.](https://help.aliyun.com/document_detail/2489709.html)
    * 
    * @example
    * NORMAL
@@ -61,11 +69,13 @@ export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
 export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The status code of the request. Valid values:
+   * 
+   * - **OK**: The request was successful.
+   * 
+   * - **OperatorLimit**: The carrier restricts queries for this phone number.
    * 
-   * *   **OK**: The request is successful.
-   * *   **OperatorLimit**: The carrier prohibits the query of the phone number.
-   * *   **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
+   * - **RequestFrequencyLimit**: Carrier restrictions limit how frequently you can query the same number. If you receive this error, try again later.
    * 
    * @example
    * OK
@@ -73,12 +83,12 @@ export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The returned data.
    */
   data?: PhoneNumberStatusForVoiceResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK
@@ -86,7 +96,7 @@ export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The request ID. This is a common parameter. Each request has a unique ID that you can use to troubleshoot issues.
    * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

package/src/models/QueryAvailableAuthCodeRequest.ts

@@ -8,7 +8,7 @@ export class QueryAvailableAuthCodeRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The tag ID.
+   * The tag ID. You can call the [QueryTagListPage](~~QueryTagListPage~~) operation to query tag IDs.
    * 
    * @example
    * 22

package/src/models/QueryAvailableAuthCodeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. **OK** indicates that the request is successful.
+   * The status code returned. **OK** indicates that the request was successful.
    * 
    * @example
    * OK
@@ -13,12 +13,12 @@ export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned data.
+   * The data returned.
    */
   data?: string[];
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code returned.
    * 
    * @example
    * OK
@@ -34,13 +34,14 @@ export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful. Valid values:
+   * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: successful.
+   * 
+   * - false: failed.
    * 
    * @example
-   * false
+   * true
    */
   success?: boolean;
   static names(): { [key: string]: string } {

package/src/models/QueryPackageTypeInfoRequest.ts

@@ -6,7 +6,7 @@ export class QueryPackageTypeInfoRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * 产品名称，如dysms
+   * The product name. The value must be dytns.
    * 
    * @example
    * dytns

package/src/models/QueryPackageTypeInfoResponseBody.ts

@@ -4,24 +4,51 @@ import * as $dara from '@darabonba/typescript';
 
 export class QueryPackageTypeInfoResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
+   * - OK indicates that the request is successful.
+   * 
+   * - For other error codes, see the [error code list](https://help.aliyun.com/document_detail/109196.html).
+   * 
    * @example
-   * 示例值示例值
+   * Example
    */
   code?: string;
+  /**
+   * @remarks
+   * The response data.
+   * 
+   * @example
+   * {"efactorVerification":"平台风控-二要素核验查询套餐包"}
+   */
   data?: { [key: string]: any };
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
-   * 示例值示例值示例值
+   * Example
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
-   * 示例值示例值示例值
+   * Example
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - true: The request was successful.
+   * 
+   * - false: The request failed.
+   * 
    * @example
-   * false
+   * true
    */
   success?: boolean;
   static names(): { [key: string]: string } {

package/src/models/QueryTagApplyRuleResponseBody.ts

@@ -5,23 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class QueryTagApplyRuleResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The requirements for application materials.
+   * The application material requirements. This parameter is returned when NeedApplyMaterial=1.
    * 
    * @example
-   * Requirements for application materials
+   * 申请材料的要求是XXX
    */
   applyMaterialDesc?: string;
   /**
    * @remarks
-   * Indicates whether the application is automatically approved.
+   * Indicates whether to automatically approve. Valid values:
+   * 
+   * - 0: do not automatically approve.
+   * 
+   * - 1: automatically approve.
    * 
    * @example
-   * 16
+   * 1
    */
   autoAudit?: number;
   /**
    * @remarks
-   * The URL for the billing documentation.
+   * The billing standard description link.
    * 
    * @example
    * aliyundoc.com
@@ -29,23 +33,31 @@ export class QueryTagApplyRuleResponseBodyData extends $dara.Model {
   chargingStandardLink?: string;
   /**
    * @remarks
-   * indicates whether encrypted queries are supported.
+   * Indicates whether encrypted query is supported. Valid values:
+   * 
+   * - 0: not supported.
+   * 
+   * - 1: supported.
    * 
    * @example
-   * 99
+   * 0
    */
   encryptedQuery?: number;
   /**
    * @remarks
-   * Indicates whether application materials are required.
+   * Indicates whether application materials need to be provided. Valid values:
+   * 
+   * - 0: not required.
+   * 
+   * - 1: required.
    * 
    * @example
-   * 46
+   * 1
    */
   needApplyMaterial?: number;
   /**
    * @remarks
-   * The URL for the service agreement.
+   * The service agreement link.
    * 
    * @example
    * example.aliyundoc.com
@@ -85,7 +97,7 @@ export class QueryTagApplyRuleResponseBodyData extends $dara.Model {
 export class QueryTagApplyRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. **OK** indicates that the request is successful.
+   * The request status code. **OK** indicates success.
    * 
    * @example
    * OK
@@ -98,7 +110,7 @@ export class QueryTagApplyRuleResponseBody extends $dara.Model {
   data?: QueryTagApplyRuleResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK
@@ -116,11 +128,12 @@ export class QueryTagApplyRuleResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request is successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: successful.
+   * 
+   * - false: failed.
    * 
    * @example
-   * false
+   * true
    */
   success?: boolean;
   static names(): { [key: string]: string } {