@alicloud/dytnsapi20200217 2.12.0 → 3.0.0

package/src/models/ThreeElementsVerificationRequest.ts

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

package/src/models/ThreeElementsVerificationResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ThreeElementsVerificationResponseBody } from "./ThreeElementsVerificationResponseBody";
+
+
+export class ThreeElementsVerificationResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ThreeElementsVerificationResponseBody;
+  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: ThreeElementsVerificationResponseBody,
+    };
+  }
+
+  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/ThreeElementsVerificationResponseBody.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ThreeElementsVerificationResponseBodyData } from "./ThreeElementsVerificationResponseBodyData";
+
+
+export class ThreeElementsVerificationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response 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.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
+  data?: ThreeElementsVerificationResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @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: ThreeElementsVerificationResponseBodyData,
+      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/ThreeElementsVerificationResponseBodyData.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ThreeElementsVerificationResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The basic carrier. Valid values:
+   * 
+   * *   **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.
+   * 
+   * **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.
+   * 
+   * |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.|
+   * 
+   * @example
+   * 1
+   */
+  isConsistent?: number;
+  static names(): { [key: string]: string } {
+    return {
+      basicCarrier: 'BasicCarrier',
+      isConsistent: 'IsConsistent',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      basicCarrier: 'string',
+      isConsistent: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/TwoElementsVerificationRequest.ts

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

package/src/models/TwoElementsVerificationResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { TwoElementsVerificationResponseBody } from "./TwoElementsVerificationResponseBody";
+
+
+export class TwoElementsVerificationResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: TwoElementsVerificationResponseBody;
+  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: TwoElementsVerificationResponseBody,
+    };
+  }
+
+  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/TwoElementsVerificationResponseBody.ts

@@ -0,0 +1,69 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { TwoElementsVerificationResponseBodyData } from "./TwoElementsVerificationResponseBodyData";
+
+
+export class TwoElementsVerificationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response code. Valid values:
+   * 
+   * *   **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.
+   * 
+   * @example
+   * OK
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The response parameters.
+   */
+  data?: TwoElementsVerificationResponseBodyData;
+  /**
+   * @remarks
+   * The returned message.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * CC3BB6D2-2FDF-4321-9DCE-B38165CE****
+   */
+  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: TwoElementsVerificationResponseBodyData,
+      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/TwoElementsVerificationResponseBodyData.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class TwoElementsVerificationResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The basic carriers. Valid values:
+   * 
+   * *   **China Mobile**
+   * *   **China Unicom**
+   * *   **China Telecom**
+   * 
+   * >  You are not allowed to verify numbers assigned by China Broadnet.
+   * 
+   * @example
+   * China Mobile
+   */
+  basicCarrier?: string;
+  /**
+   * @remarks
+   * Indicates whether the specified name and phone number belong to the same user. Valid values:
+   * 
+   * * **1**: The specified name and phone number belong to the same user.
+   * 
+   * * **0**: The specified name and phone number do not belong to the same user.
+   * 
+   * * **2**: The specified name and phone number cannot be 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.
+   * 
+   * |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.|
+   * 
+   * @example
+   * 1
+   */
+  isConsistent?: number;
+  static names(): { [key: string]: string } {
+    return {
+      basicCarrier: 'BasicCarrier',
+      isConsistent: 'IsConsistent',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      basicCarrier: 'string',
+      isConsistent: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/UaidcollectionRequest.ts

@@ -0,0 +1,91 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class UAIDCollectionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 示例值
+   */
+  authCode?: string;
+  /**
+   * @example
+   * 示例值
+   */
+  carrier?: string;
+  /**
+   * @example
+   * 示例值示例值示例值
+   */
+  ip?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 示例值示例值
+   */
+  outId?: string;
+  ownerId?: number;
+  /**
+   * @example
+   * 示例值示例值
+   */
+  province?: string;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 示例值示例值
+   */
+  token?: string;
+  /**
+   * @example
+   * 示例值示例值
+   */
+  userGrantId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authCode: 'AuthCode',
+      carrier: 'Carrier',
+      ip: 'Ip',
+      outId: 'OutId',
+      ownerId: 'OwnerId',
+      province: 'Province',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      token: 'Token',
+      userGrantId: 'UserGrantId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authCode: 'string',
+      carrier: 'string',
+      ip: 'string',
+      outId: 'string',
+      ownerId: 'number',
+      province: 'string',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      token: 'string',
+      userGrantId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/UaidcollectionResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { UAIDCollectionResponseBody } from "./UaidcollectionResponseBody";
+
+
+export class UAIDCollectionResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: UAIDCollectionResponseBody;
+  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: UAIDCollectionResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+