@alicloud/dytnsapi20200217 2.12.0 → 3.0.0

package/src/models/PhoneNumberStatusForRealResponseBody.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PhoneNumberStatusForRealResponseBodyData } from "./PhoneNumberStatusForRealResponseBodyData";
+
+
+export class PhoneNumberStatusForRealResponseBody 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.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
+  data?: PhoneNumberStatusForRealResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * 
+   * @example
+   * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: PhoneNumberStatusForRealResponseBodyData,
+      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/PhoneNumberStatusForRealResponseBodyData.ts

@@ -0,0 +1,61 @@
+// This file is auto-generated, don't edit it
+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:
+   * 
+   * *   **CMCC**: China Mobile
+   * *   **CUCC**: China Unicom
+   * *   **CTCC**: China Telecom
+   * 
+   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * 
+   * @example
+   * CMCC
+   */
+  carrier?: string;
+  /**
+   * @remarks
+   * The returned status for the queried phone number. Valid values:
+   * 
+   * *   **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.
+   * 
+   * >  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).
+   * 
+   * @example
+   * NORMAL
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      carrier: 'Carrier',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      carrier: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForSmsRequest.ts

@@ -0,0 +1,81 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+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).
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * zf08***pi6
+   */
+  authCode?: string;
+  /**
+   * @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.
+   * 
+   * >  Letters in the encrypted strings are not case-sensitive.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 181****1234
+   */
+  inputNumber?: string;
+  /**
+   * @remarks
+   * The encryption method of the phone number. Valid values:
+   * 
+   * *   **NORMAL**: plaintext
+   * *   **MD5**
+   * *   **SHA256**
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * NORMAL
+   */
+  mask?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      authCode: 'AuthCode',
+      inputNumber: 'InputNumber',
+      mask: 'Mask',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authCode: 'string',
+      inputNumber: 'string',
+      mask: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForSmsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PhoneNumberStatusForSmsResponseBody } from "./PhoneNumberStatusForSmsResponseBody";
+
+
+export class PhoneNumberStatusForSmsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: PhoneNumberStatusForSmsResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: PhoneNumberStatusForSmsResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForSmsResponseBody.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PhoneNumberStatusForSmsResponseBodyData } from "./PhoneNumberStatusForSmsResponseBodyData";
+
+
+export class PhoneNumberStatusForSmsResponseBody 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.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
+  data?: PhoneNumberStatusForSmsResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * 
+   * @example
+   * 68A40250-50CD-034C-B728-0BD135850177
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: PhoneNumberStatusForSmsResponseBodyData,
+      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/PhoneNumberStatusForSmsResponseBodyData.ts

@@ -0,0 +1,59 @@
+// This file is auto-generated, don't edit it
+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:
+   * 
+   * *   **CMCC**: China Mobile
+   * *   **CUCC**: China Unicom
+   * *   **CTCC**: China Telecom
+   * 
+   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * 
+   * @example
+   * CMCC
+   */
+  carrier?: string;
+  /**
+   * @remarks
+   * The returned status for the queried phone number. Valid values:
+   * 
+   * *   **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.
+   * 
+   * >  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).
+   * 
+   * @example
+   * NORMAL
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      carrier: 'Carrier',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      carrier: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForVoiceRequest.ts

@@ -0,0 +1,81 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+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).
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Dd1r***4id
+   */
+  authCode?: string;
+  /**
+   * @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.
+   * 
+   * >  Letters in the encrypted strings are not case-sensitive.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 139****1234
+   */
+  inputNumber?: string;
+  /**
+   * @remarks
+   * The encryption method. Valid values:
+   * 
+   * *   **NORMAL**: plaintext
+   * *   **MD5**
+   * *   **SHA256**
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * NORMAL
+   */
+  mask?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      authCode: 'AuthCode',
+      inputNumber: 'InputNumber',
+      mask: 'Mask',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authCode: 'string',
+      inputNumber: 'string',
+      mask: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForVoiceResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PhoneNumberStatusForVoiceResponseBody } from "./PhoneNumberStatusForVoiceResponseBody";
+
+
+export class PhoneNumberStatusForVoiceResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: PhoneNumberStatusForVoiceResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: PhoneNumberStatusForVoiceResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PhoneNumberStatusForVoiceResponseBody.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { PhoneNumberStatusForVoiceResponseBodyData } from "./PhoneNumberStatusForVoiceResponseBodyData";
+
+
+export class PhoneNumberStatusForVoiceResponseBody 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.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
+  data?: PhoneNumberStatusForVoiceResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * 
+   * @example
+   * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: PhoneNumberStatusForVoiceResponseBodyData,
+      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/PhoneNumberStatusForVoiceResponseBodyData.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+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:
+   * 
+   * *   **CMCC**: China Mobile
+   * *   **CUCC**: China Unicom
+   * *   **CTCC**: China Telecom
+   * 
+   * >  You are not allowed to query the phone numbers assigned by China Broadnet.
+   * 
+   * @example
+   * CTCC
+   */
+  carrier?: string;
+  /**
+   * @remarks
+   * The returned status for the queried phone number. Valid values:
+   * 
+   * *   **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.
+   * 
+   * >  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).
+   * 
+   * @example
+   * NORMAL
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      carrier: 'Carrier',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      carrier: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/QueryAvailableAuthCodeRequest.ts

@@ -0,0 +1,43 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryAvailableAuthCodeRequest extends $dara.Model {
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The tag ID.
+   * 
+   * @example
+   * 22
+   */
+  tagId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      tagId: 'TagId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      tagId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+