@alicloud/dytnsapi20200217 3.2.0 → 3.4.0

package/src/models/HistoryThreeElementsVerificationResponseBody.ts

@@ -0,0 +1,130 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class HistoryThreeElementsVerificationResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The consistency of the verification result. Valid values:
+   * 
+   * - `0`: No record found.
+   * 
+   * - `1`: The phone number, ID number, and name match the carrier\\"s records.
+   * 
+   * - `2`: The phone number and ID number match the carrier\\"s records, but the name does not.
+   * 
+   * - `3`: The phone number and name match the carrier\\"s records, but the ID number does not.
+   * 
+   * - `4`: The phone number matches the carrier\\"s records, but the name and ID number do not.
+   * 
+   * @example
+   * 72
+   */
+  isConsistent?: number;
+  /**
+   * @remarks
+   * The carrier to which the request was routed.
+   * 
+   * @example
+   * CMCC
+   */
+  requestCarrier?: string;
+  static names(): { [key: string]: string } {
+    return {
+      isConsistent: 'IsConsistent',
+      requestCarrier: 'RequestCarrier',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      isConsistent: 'number',
+      requestCarrier: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class HistoryThreeElementsVerificationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Details about why access is denied.
+   * 
+   * > This parameter is returned only when RAM authentication fails.
+   * 
+   * @example
+   * -
+   */
+  accessDeniedDetail?: string;
+  /**
+   * @remarks
+   * The status code of the request.
+   * 
+   * - A value of `OK` indicates the request was successful.
+   * 
+   * - For other values, see the Error Codes section.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The query results.
+   */
+  data?: HistoryThreeElementsVerificationResponseBodyData;
+  /**
+   * @remarks
+   * The description of the status code.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accessDeniedDetail: 'AccessDeniedDetail',
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accessDeniedDetail: 'string',
+      code: 'string',
+      data: HistoryThreeElementsVerificationResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/InvalidPhoneNumberFilterRequest.ts

@@ -7,7 +7,7 @@ export class InvalidPhoneNumberFilterRequest 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). On the **My Applications** page, obtain the authorization ID, which serves as the authorization code.
    * 
    * This parameter is required.
    * 
@@ -29,7 +29,7 @@ export class InvalidPhoneNumberFilterRequest extends $dara.Model {
    * @remarks
    * The encryption method of the phone number.
    * 
-   * >  Only the NORMAL encryption method is supported.
+   * >Notice: Only the NORMAL encryption method is supported.
    * 
    * This parameter is required.
    * 

package/src/models/InvalidPhoneNumberFilterResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class InvalidPhoneNumberFilterResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The returned filter results.
+   * The filtering result.
    * 
-   * *   **YES**: the valid phone number. The mappings are returned.
-   * *   **NO**: the invalid phone number. No mappings are returned.
+   * - **YES**: A valid phone number. The mapping relationship is returned.
+   * 
+   * - **NO**: An invalid phone number. The mapping relationship is not returned.
    * 
    * @example
    * YES
@@ -24,7 +25,7 @@ export class InvalidPhoneNumberFilterResponseBodyData extends $dara.Model {
   encryptedNumber?: string;
   /**
    * @remarks
-   * The time when the phone number expires.
+   * The expiration time of the phone number.
    * 
    * @example
    * 2022-05-27 16:05:23
@@ -68,19 +69,28 @@ export class InvalidPhoneNumberFilterResponseBodyData extends $dara.Model {
 export class InvalidPhoneNumberFilterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
-   * 
-   * *   **OK**: The request is successful.
-   * *   **MobileNumberIllegal**: The phone number is invalid.
-   * *   **EncyrptTypeIllegal**: The encryption type is invalid.
-   * *   **MobileNumberTypeNotMatch**: The phone number does not match the encryption type.
-   * *   **CarrierIllegal**: The carrier type is invalid.
-   * *   **AuthCodeNotExist**: The authorization code does not exist.
-   * *   **PortabilityNumberNotSupported**: Mobile number portability is not supported.
-   * *   **Unknown**: An unknown exception occurred.
-   * *   **AuthCodeAndApiNotMatch**: A system exception occurred.
-   * *   **AuthCodeAndApiNotMatch**: The authorization code does not match the API operation.
-   * *   **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.
+   * The status code of the request. Valid values:
+   * 
+   * - **OK**: The request is successful.
+   * 
+   * - **MobileNumberIllegal**: The mobile number is invalid.
+   * 
+   * - **EncyrptTypeIllegal**: The encryption type is invalid.
+   * 
+   * - **MobileNumberTypeNotMatch**: The mobile number does not match the encryption type.
+   * 
+   * - **CarrierIllegal**: The carrier type is invalid.
+   * 
+   * - **AuthCodeNotExist**: The authorization code does not exist.
+   * 
+   * - **PortabilityNumberNotSupported**: Mobile number portability is not supported.
+   * 
+   * - **Unknown**: An unknown exception occurred.
+   * 
+   * - **AuthCodeAndApiNotMatch**: A system exception occurred.
+   * 
+   * - **AuthCodeAndApiNotMatch**: The AuthCode does not match the API operation.
+   * - **RequestFrequencyLimit**: Due to carrier restrictions, repeated high-frequency queries against the same phone number within a short period of time are prohibited. If this error code is returned, try again later.
    * 
    * @example
    * OK
@@ -88,12 +98,12 @@ export class InvalidPhoneNumberFilterResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Details about the returned entries.
+   * The array of returned data.
    */
   data?: InvalidPhoneNumberFilterResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK

package/src/models/ListContactsRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContactsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The business type. Set the value to `dytns`.
+   * 
    * @example
    * dytns
    */
   bizType?: string;
   /**
+   * @remarks
+   * The contact ID.
+   * 
    * @example
    * 1298647
    */

package/src/models/ListContactsResponseBody.ts

@@ -4,42 +4,89 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContactsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The contact email.
+   * 
    * @example
    * xxxx @alibaba-inc.com
    */
   contactEmail?: string;
   /**
+   * @remarks
+   * The contact ID.
+   * 
    * @example
    * 0
    */
   contactId?: number;
+  /**
+   * @remarks
+   * The contact name.
+   * 
+   * @example
+   * 黄勇
+   */
   contactName?: string;
   /**
+   * @remarks
+   * The contact mobile number.
+   * 
    * @example
    * 19211111111
    */
   contactPhone?: string;
   /**
+   * @remarks
+   * The email status.
+   * 
+   * - 1: Normal
+   * 
+   * - 0: Abnormal
+   * 
    * @example
    * 1
    */
   mailStatus?: number;
   /**
+   * @remarks
+   * The calling number.
+   * 
    * @example
    * 0
    */
   main?: number;
   /**
+   * @remarks
+   * Specifies whether the number status warning is enabled.
+   * 
+   * - **true**: Enabled.
+   * 
+   * - **false**: Disabled.
+   * 
    * @example
    * true
    */
   openStatusWarning?: boolean;
   /**
+   * @remarks
+   * Specifies whether the number attribution query warning is enabled.
+   * 
+   * - **true**: Enabled.
+   * 
+   * - **false**: Disabled.
+   * 
    * @example
    * true
    */
   opentAttributionWarning?: boolean;
   /**
+   * @remarks
+   * The number status.
+   * 
+   * - 1: Normal
+   * 
+   * - 0: Abnormal
+   * 
    * @example
    * 1
    */
@@ -83,17 +130,30 @@ export class ListContactsResponseBodyData extends $dara.Model {
 
 export class ListContactsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code. `OK` indicates a successful request.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * An array of contact information objects.
+   */
   data?: ListContactsResponseBodyData[];
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
    */

package/src/models/PhoneNumberEncryptRequest.ts

@@ -7,7 +7,7 @@ export class PhoneNumberEncryptRequest 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,7 +19,7 @@ export class PhoneNumberEncryptRequest extends $dara.Model {
    * @remarks
    * The phone number to be queried.
    * 
-   * >  You can query only one phone number at a time.
+   * > Currently, only single phone number queries are supported.
    * 
    * This parameter is required.
    * 
@@ -29,9 +29,10 @@ export class PhoneNumberEncryptRequest extends $dara.Model {
   inputNumber?: string;
   /**
    * @remarks
-   * The encryption method of the phone number. Set the value to **NORMAL**.
+   * The encryption method of the phone number. Valid value: **NORMAL**.
    * 
-   * >  Only the NORMAL encryption method is supported.
+   * 
+   * >Notice: Currently, only the NORMAL encryption method is supported.
    * 
    * This parameter is required.
    * 
@@ -39,6 +40,13 @@ export class PhoneNumberEncryptRequest extends $dara.Model {
    * NORMAL
    */
   mask?: string;
+  /**
+   * @remarks
+   * The user-defined outId. This parameter is optional. The format is not limited, and the length must be less than or equal to 64 characters.
+   * 
+   * @example
+   * 213e367117422635749191493eea68
+   */
   outId?: string;
   ownerId?: number;
   resourceOwnerAccount?: string;

package/src/models/PhoneNumberEncryptResponseBody.ts

@@ -13,7 +13,7 @@ export class PhoneNumberEncryptResponseBodyData extends $dara.Model {
   encryptedNumber?: string;
   /**
    * @remarks
-   * The time when the phone number expires.
+   * The expiration time of the phone number.
    * 
    * @example
    * 2022-05-27 16:05:23
@@ -27,6 +27,15 @@ export class PhoneNumberEncryptResponseBodyData extends $dara.Model {
    * 1390000****
    */
   originalNumber?: string;
+  /**
+   * @remarks
+   * The custom ID reserved for the caller when the request was initiated. This ID is eventually returned to the caller.
+   * 
+   * The value is of the string type. The maximum length is 64 characters.
+   * 
+   * @example
+   * 215044c917374256269257695e9d22
+   */
   outId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -58,10 +67,11 @@ export class PhoneNumberEncryptResponseBodyData extends $dara.Model {
 export class PhoneNumberEncryptResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code.
+   * The status code of the request.
+   * 
+   * - The value OK indicates that the request was successful.
    * 
-   * *   The value OK indicates that the request was successful.
-   * *   Other values indicate that the request failed. For more information, see [Error codes](https://help.aliyun.com/document_detail/109196.html).
+   * - For information about other error codes, see [Error codes](https://help.aliyun.com/document_detail/109196.html).
    * 
    * @example
    * OK
@@ -69,12 +79,12 @@ export class PhoneNumberEncryptResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Details about the returned entries.
+   * The array.
    */
   data?: PhoneNumberEncryptResponseBodyData[];
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK

package/src/models/PhoneNumberStatusForAccountRequest.ts

@@ -7,7 +7,7 @@ export class PhoneNumberStatusForAccountRequest 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 Intelligence console](https://dytns.console.aliyun.com/analysis/apply), obtain the authorization ID. This ID is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForAccountRequest 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`, this parameter is an 11-digit mobile phone number.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * - If `Mask` is set to `MD5`, this parameter is a 32-character hashed string.
+   * 
+   * - If `Mask` is set to `SHA256`, this parameter is a 64-character hashed string.
+   * 
+   * - If `Mask` is set to `SM3`, this parameter is a 64-character hashed string.
+   * 
+   * >Notice: 
+   * 
+   * The letters in the hashed string are case-insensitive.
    * 
    * This parameter is required.
    * 
@@ -33,11 +39,15 @@ export class PhoneNumberStatusForAccountRequest extends $dara.Model {
   inputNumber?: string;
   /**
    * @remarks
-   * The encryption method of the phone number. Valid values:
+   * The encryption method. Valid values:
+   * 
+   * - **NORMAL**: The number is not encrypted.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **SM3**
    * 
    * This parameter is required.
    * 

package/src/models/PhoneNumberStatusForAccountResponseBody.ts

@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class PhoneNumberStatusForAccountResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The basic carrier who assings the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
+   * The number\\"s current carrier. If the number has been ported to a new carrier through mobile number portability, the new carrier is returned. 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 PhoneNumberStatusForAccountResponseBodyData 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 number is suspended or temporarily out of service.
+   * 
+   * - **POWER_OFF**: The phone is powered off.
    * 
-   * *   **NORMAL**: The queried phone number is valid.
-   * *   **SHUTDOWN**: The queried phone number is suspended.
-   * *   **POWER_OFF**: The queried phone number cannot be connected.
-   * *   **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**: The number is non-existent.
    * 
-   * >  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).
+   * - **DEFECT**: The number is invalid.
+   * 
+   * - **UNKNOWN**: The status is unknown.
+   * 
+   * > Due to adjustments in the carrier\\"s system, China Telecom numbers do not return the `busy` and `powered off` statuses. For more information, [see the official announcement](https://help.aliyun.com/document_detail/2489709.html).
    * 
    * @example
    * NORMAL
@@ -62,9 +69,11 @@ export class PhoneNumberStatusForAccountResponseBody extends $dara.Model {
    * @remarks
    * The response code. Valid values:
    * 
-   * *   **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.
+   * - **OK**: The request was successful.
+   * 
+   * - **OperatorLimit**: The query is prohibited by the carrier.
+   * 
+   * - **RequestFrequencyLimit**: Carriers restrict frequent queries for the same number within a short period. If you receive this error code, try again later.
    * 
    * @example
    * OK
@@ -72,12 +81,12 @@ export class PhoneNumberStatusForAccountResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The response object.
    */
   data?: PhoneNumberStatusForAccountResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK
@@ -85,7 +94,7 @@ export class PhoneNumberStatusForAccountResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The ID of the request. This ID is unique to each request and can be used for troubleshooting.
    * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

package/src/models/PhoneNumberStatusForPublicRequest.ts

@@ -7,7 +7,7 @@ export class PhoneNumberStatusForPublicRequest 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 ID.
+   * > On the **My Applications** page of the [Phone Number Intelligence console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization ID and use it as the authorization code.
    * 
    * This parameter is required.
    * 
@@ -19,11 +19,15 @@ export class PhoneNumberStatusForPublicRequest extends $dara.Model {
    * @remarks
    * The phone number to be queried.
    * 
-   * *   If the value of Mask is NORMAL, the value of this field is an 11-digit phone number.
-   * *   If the value of Mask is MD5, the value of this field is a 32-bit encrypted string.
-   * *   If the value of Mask is SHA256, the value of this field is a 64-bit encrypted string.
+   * - If `Mask` is set to `NORMAL`, this parameter must be an 11-digit mobile phone number.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * - If `Mask` is set to `MD5`, this parameter must be a 32-character encrypted string.
+   * 
+   * - If `Mask` is set to `SHA256`, this parameter must be a 64-character encrypted string.
+   * 
+   * - If `Mask` is set to `SM3`, this parameter must be a 64-character encrypted string.
+   * 
+   * > The encrypted strings are case-insensitive.
    * 
    * @example
    * 139****1234
@@ -31,11 +35,15 @@ export class PhoneNumberStatusForPublicRequest extends $dara.Model {
   inputNumber?: string;
   /**
    * @remarks
-   * The encryption method of the phone number. Valid values:
+   * The encryption method. Valid values:
+   * 
+   * - **NORMAL**: The phone number is not encrypted.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **SM3**
    * 
    * This parameter is required.
    *