@alicloud/dytnsapi20200217 3.3.0 → 3.4.0

package/src/models/SaveContactsRequest.ts

@@ -4,42 +4,68 @@ import * as $dara from '@darabonba/typescript';
 
 export class SaveContactsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The business type. Set the value to **contact**.
+   * 
    * @example
    * dytns
    */
   bizType?: string;
   /**
+   * @remarks
+   * The contact email.
+   * 
    * @example
    * 1234@alibaba-inc.com
    */
   contactEmail?: string;
   /**
    * @remarks
+   * The contact name.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 张光宇
    */
   contactName?: string;
   /**
+   * @remarks
+   * The contact phone number.
+   * 
    * @example
    * 122354532434
    */
   contactPhone?: string;
   /**
+   * @remarks
+   * Specifies whether to enable email alerts. Valid values:
+   * 
    * @example
    * 0
    */
   mailStatus?: number;
   /**
+   * @remarks
+   * Specifies whether to enable status warnings. Valid values:
+   * 
    * @example
    * false
    */
   openStatusWarning?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable attribution warnings. Valid values:
+   * 
    * @example
    * true
    */
   opentAttributionWarning?: boolean;
   ownerId?: number;
   /**
+   * @remarks
+   * Specifies whether to enable phone alerts. Valid values:
+   * 
    * @example
    * 0
    */

package/src/models/SaveContactsResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class SaveContactsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code. A value of `OK` indicates that the request was successful. For more information about other error codes, see the [error code list](https://help.aliyun.com/document_detail/109196.html).
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * The data returned by the operation.
+   * 
    * @example
    * 1
    */
   data?: string;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 29E058D7-4B28-55EE-BE3B-61D5AE488A9E
    */

package/src/models/ThreeElementsVerificationRequest.ts

@@ -7,7 +7,7 @@ export class ThreeElementsVerificationRequest 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), the authorization ID is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -19,11 +19,11 @@ export class ThreeElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The ID card number to be verified.
    * 
-   * *   If the value of Mask is NORMAL, specify a value in plaintext for this field.
-   * *   If the value of Mask is MD5, specify a MD5-encrypted value for this field.
-   * *   If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.
+   * - If Mask is set to NORMAL, this field is in plaintext.
+   * - If Mask is set to MD5, encrypt this field by using MD5.
+   * - If Mask is set to SHA256, encrypt this field by using SHA256.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are case-insensitive.
    * 
    * This parameter is required.
    * 
@@ -35,11 +35,11 @@ export class ThreeElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The phone number to be verified.
    * 
-   * *   If the value of Mask is NORMAL, specify a value in plaintext for this field.
-   * *   If the value of Mask is MD5, specify a MD5-encrypted value for this field.
-   * *   If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.
+   * - If Mask is set to NORMAL, this field is in plaintext.
+   * - If Mask is set to MD5, encrypt this field by using MD5.
+   * - If Mask is set to SHA256, encrypt this field by using SHA256.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are case-insensitive.
    * 
    * This parameter is required.
    * 
@@ -51,9 +51,11 @@ export class ThreeElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The encryption method. Valid values:
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **NORMAL**: No encryption.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
    * This parameter is required.
    * 
@@ -65,16 +67,16 @@ export class ThreeElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The name to be verified.
    * 
-   * *   If the value of Mask is NORMAL, specify a value in plaintext for this field.
-   * *   If the value of Mask is MD5, specify a MD5-encrypted value for this field.
-   * *   If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.
+   * - If Mask is set to NORMAL, this field is in plaintext.
+   * - If Mask is set to MD5, encrypt this field by using MD5.
+   * - If Mask is set to SHA256, encrypt this field by using SHA256.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are case-insensitive.
    * 
    * This parameter is required.
    * 
    * @example
-   * Aliyun
+   * 阿里云
    */
   name?: string;
   ownerId?: number;

package/src/models/ThreeElementsVerificationResponseBody.ts

@@ -7,29 +7,31 @@ export class ThreeElementsVerificationResponseBodyData extends $dara.Model {
    * @remarks
    * The basic carrier. Valid values:
    * 
-   * *   **China Mobile**
-   * *   **China Unicom**
-   * *   **China Telecom**
+   * - **China Mobile**.
+   * 
+   * - **China Unicom**.
+   * 
+   * - **China Telecom**.
    * 
    * @example
-   * China Mobile
+   * 中国移动
    */
   basicCarrier?: string;
   /**
    * @remarks
-   * Indicates whether the specified name, phone number, and ID card number belong to the same user. Valid values:
-   * 
-   * * **1**: The specified name, phone number, and ID card number belong to the same user.
-   * * **0**: The specified name, phone number, and ID card number do not belong to the same user.
-   * * **2**: The specified name, phone number, and ID card number cannot be found.
+   * Indicates whether the verification results are consistent. Returned values:
    * 
-   * **Note** The phone number registration data of a user is usually updated one or three days after registration. The registration data can be queried only after the update. The following table shows the verification results under different phone number states.
+   * - **1**: Consistent
+   * - **0**: Inconsistent
+   * - **2**: Not found
+   * >The data update timeliness varies by carrier and city, and is typically between T+1 and T+3.
+   * The verification results for mobile phone numbers of different carriers in different states are as follows: 
    * 
-   * |Carrier/Phone number state|Out-of-service|Nonexistent|Canceled|
-   * |---|---|---|---|
-   * |China Mobile|Verifications can be carried out normally.|The specified name, phone number, and ID card number cannot be found.|The specified name, phone number, and ID card number cannot be found.|
-   * |China Unicom|Verifications can be carried out normally.|The specified name, phone number, and ID card number do not belong to the same user.|The specified name, phone number, and ID card number do not belong to the same user.|
-   * |China Telecom|Verifications can be carried out normally.|The specified name, phone number, and ID card number cannot be found.|The specified name, phone number, and ID card number cannot be found.|
+   * |Carrier/Mobile Phone Number Status|Suspended|Empty Number|Deregistered|
+   * |--|--|--|--|
+   * |China Mobile|Normal verification|Not found|Not found|
+   * |China Unicom|Normal verification|Inconsistent|Inconsistent|
+   * |China Telecom|Normal verification|Not found|Not found|
    * 
    * @example
    * 1
@@ -61,11 +63,11 @@ export class ThreeElementsVerificationResponseBodyData extends $dara.Model {
 export class ThreeElementsVerificationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code.
+   * The request status code.
    * 
-   * *   **OK**: The request is successful.
-   * *   For more information, see Error codes in this documentation.
-   * *   **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.
+   * - For other error codes, see the error code table in this chapter.
+   * - **RequestFrequencyLimit**: Due to carrier restrictions, repeated high-frequency queries on the same number within a short period are prohibited. If this error code is returned, try again later.
    * 
    * @example
    * OK
@@ -73,12 +75,12 @@ export class ThreeElementsVerificationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The data returned.
    */
   data?: ThreeElementsVerificationResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK

package/src/models/TwoElementsVerificationRequest.ts

@@ -7,7 +7,7 @@ export class TwoElementsVerificationRequest 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.
    * 
@@ -19,11 +19,11 @@ export class TwoElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The phone number to be verified.
    * 
-   * *   If the value of Mask is NORMAL, specify a value in plaintext for this field.
-   * *   If the value of Mask is MD5, specify a MD5-encrypted value for this field.
-   * *   If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.
+   * - If Mask is set to NORMAL, this field is in plaintext.
+   * - If Mask is set to MD5, encrypt this field with MD5.
+   * - If Mask is set to SHA256, encrypt this field with SHA256.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are not case-sensitive.
    * 
    * This parameter is required.
    * 
@@ -35,9 +35,11 @@ export class TwoElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The encryption method. Valid values:
    * 
-   * *   **NORMAL**: plaintext
-   * *   **MD5**
-   * *   **SHA256**
+   * - **NORMAL**: No encryption.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
    * This parameter is required.
    * 
@@ -49,16 +51,16 @@ export class TwoElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The name to be verified.
    * 
-   * *   If the value of Mask is NORMAL, specify a value in plaintext for this field.
-   * *   If the value of Mask is MD5, specify a MD5-encrypted value for this field.
-   * *   If the value of Mask is SHA256, specify a SHA256-encrypted value for this field.
+   * - If Mask is set to NORMAL, this field is in plaintext.
+   * - If Mask is set to MD5, encrypt this field with MD5.
+   * - If Mask is set to SHA256, encrypt this field with SHA256.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: Letters in the encrypted string are not case-sensitive.
    * 
    * This parameter is required.
    * 
    * @example
-   * Aliyun
+   * 阿里云
    */
   name?: string;
   ownerId?: number;

package/src/models/TwoElementsVerificationResponseBody.ts

@@ -5,35 +5,38 @@ import * as $dara from '@darabonba/typescript';
 export class TwoElementsVerificationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The basic carriers. Valid values:
+   * The basic operator. Valid values:
    * 
-   * *   **China Mobile**
-   * *   **China Unicom**
-   * *   **China Telecom**
+   * - **China Mobile**.
    * 
-   * >  You are not allowed to verify numbers assigned by China Broadnet.
+   * - **China Unicom**.
+   * 
+   * - **China Telecom**.
+   * 
+   * >Notice: China Broadcasting Network numbers are not currently supported.
    * 
    * @example
-   * China Mobile
+   * 中国移动
    */
   basicCarrier?: string;
   /**
    * @remarks
-   * Indicates whether the specified name and phone number belong to the same user. Valid values:
+   * Indicates whether the verification result is consistent. Returns:
    * 
-   * * **1**: The specified name and phone number belong to the same user.
+   * - **1**: Consistent.
    * 
-   * * **0**: The specified name and phone number do not belong to the same user.
+   * - **0**: Inconsistent.
    * 
-   * * **2**: The specified name and phone number cannot be found.
+   * - **2**: Not found.
    * 
-   * The phone number registration data of a user is usually updated one or three days after registration. The registration data can be queried only after the update. The following table shows the verification results under different phone number states.
+   * The data update timeliness for different operators and cities is typically T+1 to T+3.
+   * The verification results for different operator phone numbers in different states are as follows: 
    * 
-   * |Carrier/Phone number state|Out-of-service|Nonexistent|Canceled|
-   * |---|---|---|---|
-   * |China Mobile|Verifications can be carried out normally.|The specified name and phone number cannot be found.|The specified name and phone number cannot be found.|
-   * |China Unicom|Verifications can be carried out normally.|The specified name and phone number do not belong to the same user.|The specified name and phone number do not belong to the same user.|
-   * |China Telecom|Verifications can be carried out normally.|The specified name and phone number cannot be found.|The specified name and phone number cannot be found.|
+   * |Operator/Phone Number Status|Suspended|Empty Number|Cancelled|
+   * |--|--|--|--|
+   * |China Mobile|Normal verification|Not found|Not found|
+   * |China Unicom|Normal verification|Inconsistent|Inconsistent|
+   * |China Telecom|Normal verification|Not found|Not found|
    * 
    * @example
    * 1
@@ -65,11 +68,12 @@ export class TwoElementsVerificationResponseBodyData extends $dara.Model {
 export class TwoElementsVerificationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The request status code.
+   * 
+   * - **OK**: The request was successful.
    * 
-   * *   **OK**: The request is successful.
-   * *   For more information, see Error codes in this documentation.
-   * *   **RequestFrequencyLimit**: Repeated queries for the same phone number or name 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.
+   * - For other error codes, see the error code table in this chapter.
+   * - **RequestFrequencyLimit**: Due to operator restrictions, repeated high-frequency queries against the same number or name in a short period are prohibited. If this error code is returned, try again later.
    * 
    * @example
    * OK
@@ -77,12 +81,12 @@ export class TwoElementsVerificationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The structure.
    */
   data?: TwoElementsVerificationResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK

package/src/models/UaidverificationRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UAIDVerificationRequest extends $dara.Model {
   /**
    * @remarks
+   * The authorization code.
+   * 
+   * > In **Cell Phone Number Service** -> [**Tag Marketplace**](https://dytns.console.aliyun.com/analysis/square), select a tag and submit a usage application. After the application is approved, you will obtain this authorization code.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,11 @@ export class UAIDVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
+   * The carrier of the user. Valid values:
+   * - **CM**: China Mobile.
+   * - **CU**: China Unicom.
+   * - **CT**: China Telecom.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,25 +29,37 @@ export class UAIDVerificationRequest extends $dara.Model {
    */
   carrier?: string;
   /**
+   * @remarks
+   * The public IP address. This parameter is required when the carrier is China Unicom (CU). Both IPv4 and IPv6 addresses are supported.
+   * 
    * @example
-   * 示例值
+   * 2408:8440:308:29dc:ed00:c4ec:475c:25a4
    */
   ip?: string;
   /**
+   * @remarks
+   * The external serial number.
+   * 
    * @example
    * b8b5b3a*******0b9893484fdf412c99
    */
   outId?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The province ID. This parameter is optional when the carrier is China Unicom (CU). The value must be the same as the value of the province field in the response returned when the token is obtained.
+   * 
    * @example
-   * 示例值示例值
+   * 1
    */
   province?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
+   * The carrier authorization token.  
+   * > For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -46,6 +67,11 @@ export class UAIDVerificationRequest extends $dara.Model {
    */
   token?: string;
   /**
+   * @remarks
+   * The user authorization code, which indicates that the user has granted authorization. The value must be a unique random number that does not exceed 128 characters in length.  
+   * 
+   * <warning>When you integrate the service, we recommend that you include UAID-related content in the privacy policy of your product.</warning>
+   * 
    * @example
    * Md****a3Em
    */

package/src/models/UaidverificationResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UAIDVerificationResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The obtained UAID value.
+   * 
    * @example
    * B1E0C1********9F757AF52A035
    */
@@ -31,22 +34,40 @@ export class UAIDVerificationResponseBodyData extends $dara.Model {
 
 export class UAIDVerificationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about the access denial.
+   * 
    * @example
    * -
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The request status code. Valid values:
+   * 
+   * - **OK**: The request is successful.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   data?: UAIDVerificationResponseBodyData;
   /**
+   * @remarks
+   * The description of the status code.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 68A40250-50CD-034C-B728-0BD******177
    */

package/src/models/UpdateContactsRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateContactsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The email address of the contact.
+   * 
    * @example
    * XXXX@alibaba-inc.com
    */
   contactEmail?: string;
   /**
    * @remarks
+   * The ID of the contact to update. You can retrieve the ID by calling the ListContacts operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,32 +22,63 @@ export class UpdateContactsRequest extends $dara.Model {
    */
   contactId?: number;
   /**
+   * @remarks
+   * The name of the contact.
+   * 
    * @example
    * XXX
    */
   contactName?: string;
   /**
+   * @remarks
+   * The mobile phone number of the contact.
+   * 
    * @example
    * 192XXXXXXXX
    */
   contactPhone?: string;
   /**
+   * @remarks
+   * Enables or disables email alerts. Valid values:
+   * 
+   * - 0: disabled.
+   * 
+   * - 1: enabled.
+   * 
    * @example
    * 1
    */
   mailStatus?: number;
   /**
+   * @remarks
+   * Enables or disables alerts for number status.
+   * Valid values:
+   * 
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
+   * 
    * @example
    * false
    */
   openStatusWarning?: boolean;
   /**
+   * @remarks
+   * Enables or disables alerts for number attribution queries. Valid values: -**true**: enabled. -**false**: disabled.
+   * 
    * @example
    * true
    */
   opentAttributionWarning?: boolean;
   ownerId?: number;
   /**
+   * @remarks
+   * Enables or disables phone call alerts. Valid values:
+   * 
+   * - 0: disabled.
+   * 
+   * - 1: enabled.
+   * 
    * @example
    * 1
    */

package/src/models/UpdateContactsResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateContactsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request status code. The value `OK` indicates a successful request. For more information about other error codes, see [Error codes](https://help.aliyun.com/document_detail/109196.html).
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * Indicates whether the operation was successful. A value of **true** indicates success, and a value of **false** indicates failure.
+   * 
    * @example
    * false
    */
   data?: boolean;
   /**
+   * @remarks
+   * The description of the status code.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 68A40250-50CD-034C-B728-0BD******177
    */