@alicloud/dytnsapi20200217 3.2.0 → 3.4.0

package/src/models/DeleteContactsResponseBody.ts

@@ -4,17 +4,34 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteContactsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code. `OK` indicates a successful request.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * Indicates whether the operation succeeded. Valid values:
+   * 
+   * - true
+   * 
+   * - false
+   */
   data?: boolean;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
    */

package/src/models/DescribeEmptyNumberRequest.ts

@@ -7,7 +7,7 @@ export class DescribeEmptyNumberRequest 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 of the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), obtain the authorization ID, which is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,9 +17,10 @@ export class DescribeEmptyNumberRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number to query.
    * 
-   * >  You can query only one phone number a time.
+   * 
+   * > Only single-number queries are supported.
    * 
    * This parameter is required.
    * 
@@ -29,11 +30,13 @@ export class DescribeEmptyNumberRequest 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**: no encryption.
+   * 
+   * - **MD5**
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **SHA256**.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeEmptyNumberResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeEmptyNumberResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The specified phone number.
+   * 传入的手机号。
    * 
    * @example
    * 189****1234
@@ -13,12 +13,15 @@ export class DescribeEmptyNumberResponseBodyData extends $dara.Model {
   number?: string;
   /**
    * @remarks
-   * The returned status for the queried phone number. Valid values:
+   * 检测手机号返回状态。取值：
    * 
-   * *   **EMPTY**: The queried phone number is a nonexistent number.
-   * *   **NORMAL**: The queried phone number is valid.
-   * *   **SUSPECT_EMPTY**: The queried phone number is suspected to be a nonexistent number.
-   * *   **UNKNOWN**: The queried phone number is unknown.
+   * - **EMPTY**：空号。
+   * 
+   * - **NORMAL**：正常。
+   * 
+   * - **SUSPECT_EMPTY**：疑似空号。
+   * 
+   * - **UNKNOWN**：未知。
    * 
    * @example
    * EMPTY
@@ -50,10 +53,11 @@ export class DescribeEmptyNumberResponseBodyData extends $dara.Model {
 export class DescribeEmptyNumberResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code. Valid values:
+   * 返回状态码。取值：
+   * 
+   * - **OK**：成功。
    * 
-   * *   **OK**: The request is successful.
-   * *   **InvalidPhoneNumber.Check**: The phone number is invalid.
+   * - **InvalidPhoneNumber.Check**：手机号非法。
    * 
    * @example
    * OK
@@ -61,12 +65,12 @@ export class DescribeEmptyNumberResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * 返回结果。
    */
   data?: DescribeEmptyNumberResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * 状态码的描述。
    * 
    * @example
    * OK
@@ -74,7 +78,7 @@ export class DescribeEmptyNumberResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * 公共参数，每个请求返回的ID都是唯一的，可用于排查和定位问题。
    * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

package/src/models/DescribePhoneNumberAnalysisAirequest.ts

@@ -7,7 +7,7 @@ export class DescribePhoneNumberAnalysisAIRequest extends $dara.Model {
    * @remarks
    * The authorization code.
    * 
-   * >  On the ****[**Labels**](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click Activate Now, enter the required information, and then submit your application. After your application is approved, you can obtain an authorization code.
+   * > In **Cell Phone Number Service** -> [**Tag Square**](https://dytns.console.aliyun.com/analysis/square), select a tag and submit a usage application. After the application is approved, you will receive the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class DescribePhoneNumberAnalysisAIRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number to query.
    * 
    * This parameter is required.
    * 
@@ -27,7 +27,7 @@ export class DescribePhoneNumberAnalysisAIRequest extends $dara.Model {
   inputNumber?: string;
   /**
    * @remarks
-   * The model parameter configuration. This field is required by some labels.
+   * The model parameter configuration (required by some tag capabilities).
    * 
    * @example
    * {"trainingJobId": "17**********48"}
@@ -36,9 +36,9 @@ export class DescribePhoneNumberAnalysisAIRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The score threshold for the phone number. Valid values: **0 to 100**.
+   * The phone number score threshold. Valid values: **0 to 100**.
    * 
-   * >  The system provided by Alibaba Cloud determines whether to accept the specified score threshold. When the system does not accept the specified score threshold, the value of this field is invalid.
+   * > Whether to accept the specified score threshold is determined by the server. When the specified score threshold is not accepted, the data entered in this field is invalid.
    * 
    * @example
    * 96

package/src/models/DescribePhoneNumberAnalysisAiresponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePhoneNumberAnalysisAIResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The returned code.
+   * The returned result code.
    * 
-   * *   YES: The specified phone number is valid.
-   * *   NO: The specified phone number is invalid.
-   * *   UNKNOWN: The specified phone number is unknown
+   * - YES: valid
+   * - NO: invalid
+   * - UNKNOWN: unknown
    * 
    * @example
    * YES
@@ -17,7 +17,7 @@ export class DescribePhoneNumberAnalysisAIResponseBodyData extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The specified phone number.
+   * The phone number that was passed in.
    * 
    * @example
    * 187****5620
@@ -47,12 +47,18 @@ export class DescribePhoneNumberAnalysisAIResponseBodyData extends $dara.Model {
 }
 
 export class DescribePhoneNumberAnalysisAIResponseBody extends $dara.Model {
-  accessDeniedDetail?: string;
   /**
    * @remarks
-   * The response code. Valid values:
+   * The details about the access denial.
    * 
-   * *   OK: The request is successful.
+   * @example
+   * -
+   */
+  accessDeniedDetail?: string;
+  /**
+   * @remarks
+   * The request status code. Valid values:
+   * - OK: success
    * 
    * @example
    * OK
@@ -60,12 +66,12 @@ export class DescribePhoneNumberAnalysisAIResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The returned result.
    */
   data?: DescribePhoneNumberAnalysisAIResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK

package/src/models/DescribePhoneNumberAnalysisRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePhoneNumberAnalysisRequest extends $dara.Model {
   /**
    * @remarks
+   * The authorization code.
+   * 
+   * > Log on to the [Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), go to the **My Applications** page, and obtain the authorization ID, which is the authorization code.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,24 +17,47 @@ export class DescribePhoneNumberAnalysisRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
+   * The phone number to be queried.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 1310000****
+   * 187****5620
    */
   inputNumber?: string;
   /**
+   * @remarks
+   * The encryption method of the phone number. Valid values:
+   * 
+   * - **NORMAL**: no encryption
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
+   * 
    * @example
-   * MD5
+   * NORMAL
    */
   mask?: string;
   /**
+   * @remarks
+   * The type of the phone number. Valid values:
+   * 
+   * - **0**: mobile phone number
+   * 
+   * - **1**: mobile IMEI number
+   * 
    * @example
    * 0
    */
   numberType?: number;
   ownerId?: number;
   /**
+   * @remarks
+   * The score threshold of the phone number. Valid values: **0 to 100**.
+   * 
+   * >Notice: Whether the specified score threshold is accepted is determined by the server. When the specified score threshold is not accepted, the data entered in this field is invalid.
+   * 
    * @example
    * 10
    */

package/src/models/DescribePhoneNumberAnalysisResponseBody.ts

@@ -4,13 +4,22 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribePhoneNumberAnalysisResponseBodyDataList extends $dara.Model {
   /**
+   * @remarks
+   * The result code returned.
+   * - YES: valid
+   * - NO: invalid
+   * - UNKNOWN: unknown
+   * 
    * @example
    * NO
    */
   code?: string;
   /**
+   * @remarks
+   * The mobile phone number that is passed in.
+   * 
    * @example
-   * 18752785620
+   * 187****5620
    */
   number?: string;
   static names(): { [key: string]: string } {
@@ -37,6 +46,10 @@ export class DescribePhoneNumberAnalysisResponseBodyDataList extends $dara.Model
 }
 
 export class DescribePhoneNumberAnalysisResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The data list.
+   */
   list?: DescribePhoneNumberAnalysisResponseBodyDataList[];
   static names(): { [key: string]: string } {
     return {
@@ -63,19 +76,41 @@ export class DescribePhoneNumberAnalysisResponseBodyData extends $dara.Model {
 }
 
 export class DescribePhoneNumberAnalysisResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details about the access denial. This parameter is returned only if RAM verification fails.
+   * 
+   * @example
+   * -
+   */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The request status code. Valid values:
+   * 
+   *  **OK**: The request was successful.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The information about the phone number analysis result.
+   */
   data?: DescribePhoneNumberAnalysisResponseBodyData;
   /**
+   * @remarks
+   * The description of the phone number status.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
    */

package/src/models/DescribePhoneNumberAnalysisTransparentResponseBody.ts

@@ -58,26 +58,10 @@ export class DescribePhoneNumberAnalysisTransparentResponseBodyData extends $dar
 }
 
 export class DescribePhoneNumberAnalysisTransparentResponseBody extends $dara.Model {
-  /**
-   * @example
-   * -
-   */
   accessDeniedDetail?: string;
-  /**
-   * @example
-   * OK
-   */
   code?: string;
   data?: DescribePhoneNumberAnalysisTransparentResponseBodyData;
-  /**
-   * @example
-   * OK
-   */
   message?: string;
-  /**
-   * @example
-   * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
-   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribePhoneNumberAttributeRequest.ts

@@ -6,12 +6,7 @@ export class DescribePhoneNumberAttributeRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The phone number that you want to query.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * 1390000****
    */
   phoneNumber?: string;
   resourceOwnerAccount?: string;

package/src/models/DescribePhoneNumberAttributeResponseBody.ts

@@ -3,48 +3,11 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribePhoneNumberAttributeResponseBodyPhoneNumberAttribute extends $dara.Model {
-  /**
-   * @remarks
-   * The basic carrier. Valid values:
-   * 
-   * *   **China Mobile**
-   * *   **China Unicom**
-   * *   **China Telecom**
-   */
   basicCarrier?: string;
-  /**
-   * @remarks
-   * The actual carrier, including the virtual network operator (VNO). If the phone number involves mobile number portability, the value of this parameter is the carrier after mobile number portability.
-   */
   carrier?: string;
-  /**
-   * @remarks
-   * The city where the phone number is registered.
-   */
   city?: string;
-  /**
-   * @remarks
-   * Indicates whether the phone number involves mobile number portability. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
-   * 
-   * @example
-   * false
-   */
   isNumberPortability?: boolean;
-  /**
-   * @remarks
-   * The number segment to which the phone number belongs.
-   * 
-   * @example
-   * 139
-   */
   numberSegment?: number;
-  /**
-   * @remarks
-   * The province where the phone number is registered.
-   */
   province?: string;
   static names(): { [key: string]: string } {
     return {
@@ -78,39 +41,9 @@ export class DescribePhoneNumberAttributeResponseBodyPhoneNumberAttribute extend
 }
 
 export class DescribePhoneNumberAttributeResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The response code. Valid values:
-   * 
-   * *   **OK**: The request is successful.
-   * *   **InvalidParameter**: The specified phone number is invalid or the parameter format is invalid.
-   * *   **PhoneNumberNotfound**: No attribute information can be found for the specified phone number.
-   * *   **isp.UNKNOWN**: An unknown exception occurred.
-   * 
-   * @example
-   * OK
-   */
   code?: string;
-  /**
-   * @remarks
-   * The returned message.
-   * 
-   * @example
-   * OK
-   */
   message?: string;
-  /**
-   * @remarks
-   * The attribute information about the phone number.
-   */
   phoneNumberAttribute?: DescribePhoneNumberAttributeResponseBodyPhoneNumberAttribute;
-  /**
-   * @remarks
-   * The request ID.
-   * 
-   * @example
-   * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
-   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribePhoneNumberOnlineTimeRequest.ts

@@ -6,8 +6,7 @@ export class DescribePhoneNumberOnlineTimeRequest 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).
+   * > Log on to the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), go to the **My Applications** page, and obtain the authorization ID, which is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,13 +16,13 @@ export class DescribePhoneNumberOnlineTimeRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The carrier. Valid values:
+   * The external carrier. Valid values:
    * 
-   * *   **MOBILE**: China Mobile
-   * *   **UNICOM**: China Unicom
-   * *   **TELECOM**: China Telecom
+   * - **MOBILE**: China Mobile.
+   * - **UNICOM**: China Unicom.
+   * - **TELECOM**: China Telecom.
    * 
-   * >  Alibaba Cloud automatically determines the carrier based on the carrier who assigns the phone number. Therefore, the value of this field does not affect the query result.
+   * >Notice: This parameter is optional. Alibaba Cloud automatically determines the carrier type based on the phone number. The value of this field has no impact on the query result.
    * 
    * @example
    * UNICOM
@@ -33,11 +32,11 @@ export class DescribePhoneNumberOnlineTimeRequest extends $dara.Model {
    * @remarks
    * The phone number to be queried.
    * 
-   * *   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, this field is an 11-digit phone number.
+   * - If Mask is set to MD5, this field is a 32-character encrypted string.
+   * - If Mask is set to SHA256, this field is a 64-character encrypted string.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are case-insensitive.
    * 
    * This parameter is required.
    * 
@@ -49,9 +48,9 @@ export class DescribePhoneNumberOnlineTimeRequest extends $dara.Model {
    * @remarks
    * The encryption method of the phone number. Valid values:
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **NORMAL**: no encryption
+   * - **MD5**
+   * - **SHA256**
    * 
    * This parameter is required.
    * 

package/src/models/DescribePhoneNumberOnlineTimeResponseBody.ts

@@ -5,12 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePhoneNumberOnlineTimeResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The carrier code. Valid values:
-   * 
-   * *   **CMCC**: China Mobile
-   * *   **CUCC**: China Unicom
-   * *   **CTCC**: China Telecom
-   * *   **CBN**: China Broadnet
+   * The carrier SMS status code. Valid values:
+   * - **CMCC**: China Mobile
+   * - **CUCC**: China Unicom
+   * - **CTCC**: China Telecom
+   * - **CBN**: China Broadnet
    * 
    * @example
    * CMCC
@@ -18,15 +17,15 @@ export class DescribePhoneNumberOnlineTimeResponseBodyData extends $dara.Model {
   carrierCode?: string;
   /**
    * @remarks
-   * The enumerated value of the usage period of a phone number. Valid values:
+   * The enumeration value of the network registration duration. Valid values:
    * 
-   * *   **-1**: No usage period information is available for the phone number.
-   * *   **0**: The phone number status is abnormal. For example, the phone number is a nonexistent number.
-   * *   **1** :[0-3) months.
-   * *   **2** :[3-6] months.
-   * *   **3** :(6-12] months.
-   * *   **4** :(12-24] months.
-   * *   **5** :(24,+) months.
+   * - **-1**: No duration was found.
+   * - **0**: Abnormal phone status, for example, a non-existent number.
+   * - **1**: [0-3) months.
+   * - **2**: [3-6) months.
+   * - **3**: [6-12) months.
+   * - **4**: [12-24) months.
+   * - **5**: [24,+∞) months.
    * 
    * @example
    * 1
@@ -58,13 +57,14 @@ export class DescribePhoneNumberOnlineTimeResponseBodyData extends $dara.Model {
 export class DescribePhoneNumberOnlineTimeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The request status code. Valid values:
    * 
-   * *   **OK**: The request is successful.
-   * *   **PortabilityNumberNotSupported**: The phone number that is involved in mobile number portability is not supported.
-   * *   **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.
+   * - **OK**: The request was successful.
+   * - **PortabilityNumberNotSupported**: The mobile number portability number is not supported.
+   * - **RequestFrequencyLimit**: Due to carrier restrictions, frequent repeated queries on the same number within a short period are prohibited. If this error code is returned, try again later.
    * 
-   * >  You are charged if the value of Code is OK and the value of VerifyResult is not -1. For more information, see [Pricing](https://help.aliyun.com/document_detail/154751.html).
+   * > Charges are incurred when Code is OK and VerifyResult is not -1. For billing details, see [Cell Phone Number Service Pricing](https://help.aliyun.com/document_detail/154751.html).
+   * >
    * 
    * @example
    * OK
@@ -72,12 +72,12 @@ export class DescribePhoneNumberOnlineTimeResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The returned data.
    */
   data?: DescribePhoneNumberOnlineTimeResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the number status code.
    * 
    * @example
    * OK