@alicloud/dytnsapi20200217 3.2.0 → 3.4.0

package/src/models/CertNoThreeElementVerificationRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CertNoThreeElementVerificationRequest extends $dara.Model {
   /**
    * @remarks
+   * The authorization code. Sources:
+   * - In the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, select the **ID Card Three Elements** tag, and submit a usage application. After the application is approved, you will obtain the authorization code.
+   * - On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page of the Cell Phone Number Service console, view the approved **ID Card Three Elements** authorization ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,14 +17,18 @@ export class CertNoThreeElementVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
+   * The name to be verified.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * 张三
    */
   certName?: string;
   /**
    * @remarks
+   * The ID card number to be verified.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +37,8 @@ export class CertNoThreeElementVerificationRequest extends $dara.Model {
   certNo?: string;
   /**
    * @remarks
+   * The BASE64 encoding of the portrait photo to be verified. **Remove the encoded URI information (such as `data:image/png;base64,`) before submission**. The photo size and the BASE64-encoded size must not exceed 50 KB.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -36,8 +46,11 @@ export class CertNoThreeElementVerificationRequest extends $dara.Model {
    */
   certPicture?: string;
   /**
+   * @remarks
+   * Specifies whether to encrypt. Currently only unencrypted is supported.
+   * 
    * @example
-   * 示例值示例值
+   * 不加密
    */
   mask?: string;
   ownerId?: number;

package/src/models/CertNoThreeElementVerificationResponseBody.ts

@@ -6,6 +6,21 @@ import * as $dara from '@darabonba/typescript';
  */
 export class CertNoThreeElementVerificationResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the verification result is consistent. Returned values:
+   * 
+   * - 0: The name matches the ID card number, but they are recognized as not the same person.
+   * 
+   * - 1: The name matches the ID card number, and they are recognized as the same person.
+   * 
+   * - 2: The name matches the ID card number, and they are suspected to be the same person.
+   * 
+   * - 3: The name matches the ID card number, but no portrait information is found in the database.
+   * 
+   * - 4: Invalid identity information (the name does not match the ID card number).
+   * 
+   * - 5: The photo quality is unqualified.
+   * 
    * @example
    * 1
    */
@@ -33,22 +48,40 @@ export class CertNoThreeElementVerificationResponseBodyData extends $dara.Model
 
 export class CertNoThreeElementVerificationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about why access was denied.
+   * 
    * @example
    * -
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The request status code. Valid values:
+   * - OK: The request is successful.
+   * - For other error codes, see the error code list below.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   data?: CertNoThreeElementVerificationResponseBodyData;
   /**
+   * @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/CertNoTwoElementVerificationRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CertNoTwoElementVerificationRequest 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 an application for use. After the application is approved, you will obtain the authorization code.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,18 +17,22 @@ export class CertNoTwoElementVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
+   * The name to be verified.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * 张三
    */
   certName?: string;
   /**
    * @remarks
+   * The ID card number to be verified.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 331021200001010000
+   * 3***************0
    */
   certNo?: string;
   ownerId?: number;

package/src/models/CertNoTwoElementVerificationResponseBody.ts

@@ -4,6 +4,15 @@ import * as $dara from '@darabonba/typescript';
 
 export class CertNoTwoElementVerificationResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the verification result is consistent. Valid values:
+   * 
+   * - **1**: Consistent
+   * 
+   * - **0**: Inconsistent
+   * 
+   * - **2**: Not found
+   * 
    * @example
    * 1
    */
@@ -31,22 +40,38 @@ export class CertNoTwoElementVerificationResponseBodyData extends $dara.Model {
 
 export class CertNoTwoElementVerificationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about the access denial.
+   * 
    * @example
    * -
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The request status code.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   data?: CertNoTwoElementVerificationResponseBodyData;
   /**
+   * @remarks
+   * The description of the status code.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
    */

package/src/models/CompanyFourElementsVerificationRequest.ts

@@ -6,8 +6,7 @@ export class CompanyFourElementsVerificationRequest extends $dara.Model {
   /**
    * @remarks
    * The authorization code.
-   * 
-   * >  On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), 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/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC) and go to the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page to obtain the authorization ID, which is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,15 +16,15 @@ export class CompanyFourElementsVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The enterprise name.
+   * The enterprise name (required).
    * 
    * @example
-   * 示例值示例值
+   * 某企业
    */
   epCertName?: string;
   /**
    * @remarks
-   * The business license number.
+   * The enterprise certificate number.
    * 
    * This parameter is required.
    * 
@@ -35,26 +34,24 @@ export class CompanyFourElementsVerificationRequest extends $dara.Model {
   epCertNo?: string;
   /**
    * @remarks
-   * The name of the legal representative.
-   * 
-   * >  If an enterprise has multiple legal representatives, separate them with commas (,).
+   * The name of the enterprise legal person.
+   * > If the enterprise has multiple legal persons, separate them with a Chinese enumeration comma ("、").
    * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * 张三
    */
   legalPersonCertName?: string;
   /**
    * @remarks
-   * The ID card number of the legal representative.
-   * 
-   * >  If an enterprise has multiple legal representatives, separate the ID card numbers with commas (,).
+   * The ID card number of the enterprise legal person.
+   * > If the enterprise has multiple ID card numbers, separate them with a Chinese enumeration comma ("、").
    * 
    * This parameter is required.
    * 
    * @example
-   * 331021********0011
+   * 610321********0011、510180********0022
    */
   legalPersonCertNo?: string;
   ownerId?: number;

package/src/models/CompanyFourElementsVerificationResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CompanyFourElementsVerificationResponseBodyDataDetailInfo extends $dara.Model {
   /**
    * @remarks
-   * The business status of the enterprise.
+   * The operating status of the enterprise.
    * 
    * @example
-   * Active
+   * 在营（开业）
    */
   enterpriseStatus?: string;
   /**
@@ -45,24 +45,28 @@ export class CompanyFourElementsVerificationResponseBodyDataDetailInfo extends $
 export class CompanyFourElementsVerificationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The information about the enterprise.
+   * The enterprise details.
+   * 
+   * @example
+   * { "enterpriseStatus": "在营（开业）", 
+   * "openTime": "2023-05-25/2053-05-24" }
    */
   detailInfo?: CompanyFourElementsVerificationResponseBodyDataDetailInfo;
   /**
    * @remarks
-   * The fields to be verified.
+   * The fields that failed verification.
    */
   inconsistentData?: string[];
   /**
    * @remarks
-   * The code of the verification result. Valid values:
+   * The verification result code. Valid values:
    * 
-   * *   0: The four elements belong to the same enterprise.
-   * *   1: The four elements belong to the same enterprise, but the business status of the enterprise is abnormal.
-   * *   2: The legal representative information cannot match the enterprise information.
-   * *   3: The four elements do not belong to the same enterprise.
-   * *   4: No information about the enterprise is found.
-   * *   5: No information about the legal representative is found.
+   * - 0: Verification passed.
+   * - 1: Verification passed, but the enterprise is not operating normally.
+   * - 2: The legal person and enterprise information are inconsistent.
+   * - 3: The enterprise four-element verification failed.
+   * - 4: The enterprise was not found.
+   * - 5: The legal person was not found in the database.
    * 
    * @example
    * 0
@@ -71,9 +75,8 @@ export class CompanyFourElementsVerificationResponseBodyData extends $dara.Model
   /**
    * @remarks
    * The verification result. Valid values:
-   * 
-   * *   true: The four elements belong to the same enterprise and the business status of the enterprise is Active.
-   * *   false: The four elements do not belong to the same enterprise.
+   * -   true: The information is consistent and the enterprise is operating normally.
+   * -   false: Verification failed.
    * 
    * @example
    * true
@@ -123,7 +126,7 @@ export class CompanyFourElementsVerificationResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The response code.
+   * The request status code.
    * 
    * @example
    * OK
@@ -131,12 +134,12 @@ export class CompanyFourElementsVerificationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The structure.
    */
   data?: CompanyFourElementsVerificationResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK
@@ -144,7 +147,7 @@ export class CompanyFourElementsVerificationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The common parameter. The ID returned for each request is unique and can be used to troubleshoot and locate issues.
    * 
    * @example
    * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

package/src/models/CompanyThreeElementsVerificationRequest.ts

@@ -7,7 +7,7 @@ export class CompanyThreeElementsVerificationRequest extends $dara.Model {
    * @remarks
    * The authorization code.
    * 
-   * >  On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), 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/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC) and go to the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page to obtain the authorization ID, which is the authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,17 +17,17 @@ export class CompanyThreeElementsVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The enterprise name.
+   * The company name.
    * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * 某企业
    */
   epCertName?: string;
   /**
    * @remarks
-   * The business license number.
+   * The company certificate number.
    * 
    * This parameter is required.
    * 
@@ -37,14 +37,13 @@ export class CompanyThreeElementsVerificationRequest extends $dara.Model {
   epCertNo?: string;
   /**
    * @remarks
-   * The name of the legal representative.
-   * 
-   * >  If an enterprise has multiple legal representatives, separate them with commas (,).
+   * The name of the company\\"s legal representative.
+   * >If the company has multiple legal representatives, separate the names with the Chinese enumeration comma ("、").
    * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值
+   * 张三
    */
   legalPersonCertName?: string;
   ownerId?: number;

package/src/models/CompanyThreeElementsVerificationResponseBody.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CompanyThreeElementsVerificationResponseBodyDataDetailInfo extends $dara.Model {
   /**
    * @remarks
-   * The business status of the enterprise.
+   * The operating status of the company.
    * 
    * @example
-   * Active
+   * 在营（开业）
    */
   enterpriseStatus?: string;
   /**
    * @remarks
-   * The business term of the enterprise.
+   * The business term of the company.
    * 
    * @example
    * 2023-05-25/2053-05-24
@@ -45,38 +45,44 @@ export class CompanyThreeElementsVerificationResponseBodyDataDetailInfo extends
 export class CompanyThreeElementsVerificationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The information about the enterprise.
+   * The company details.
+   * 
+   * @example
+   * {
+   *       "enterpriseStatus": "在营（开业）",
+   *       "openTime": "2023-05-25/2053-05-24"
+   * }
    */
   detailInfo?: CompanyThreeElementsVerificationResponseBodyDataDetailInfo;
   /**
    * @remarks
-   * The fields to be verified.
+   * The fields whose verification results are inconsistent.
    */
   inconsistentData?: string[];
   /**
    * @remarks
-   * The code of the verification result. Valid values:
+   * The verification result code. Valid values:
    * 
-   * *   0: The three elements belong to the same enterprise.
-   * *   1: The three elements belong to the same enterprise, and the business status of the enterprise is abnormal.
-   * *   2: The legal representative information cannot match the enterprise information.
-   * *   3: The three elements do not belong to the same enterprise.
-   * *   4: No information about the enterprise is found.
-   * *   5: No information about the legal representative is found.
+   * - 0: The verification is consistent.
+   * - 1: The verification is consistent, but the company is not operating normally.
+   * - 2: The person-company verification is inconsistent.
+   * - 3: The two-element company verification failed.
+   * - 4: The company is not found.
+   * - 5: The person does not exist in the database.
    * 
    * @example
-   * 0
+   * 2
    */
   reasonCode?: number;
   /**
    * @remarks
    * The verification result. Valid values:
    * 
-   * *   true: The three elements belong to the same enterprise and the business status of the enterprise is Active.
-   * *   false: The three elements do not belong to the same enterprise.
+   * - true: The information is consistent and the company is operating normally.
+   * - false: The verification failed.
    * 
    * @example
-   * true
+   * false
    */
   verifyResult?: string;
   static names(): { [key: string]: string } {
@@ -123,7 +129,7 @@ export class CompanyThreeElementsVerificationResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The response code.
+   * The request status code.
    * 
    * @example
    * OK
@@ -131,12 +137,12 @@ export class CompanyThreeElementsVerificationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The returned data.
    */
   data?: CompanyThreeElementsVerificationResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK
@@ -144,7 +150,7 @@ export class CompanyThreeElementsVerificationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The common parameter. Each request returns a unique ID, which can be used to troubleshoot and locate issues.
    * 
    * @example
    * 68A40250-50CD-034C-B728-0BD135850177

package/src/models/CompanyTwoElementsVerificationRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CompanyTwoElementsVerificationRequest extends $dara.Model {
   /**
    * @remarks
-   * The authorization code.
+   * Authorization code.
    * 
-   * >  On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), 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/overview?spm=a2c4g.608385.0.0.79847f8b3awqUC), and obtain the authorization ID (i.e., authorization code) on the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page.
    * 
    * This parameter is required.
    * 
@@ -17,17 +17,17 @@ export class CompanyTwoElementsVerificationRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The enterprise name.
+   * Enterprise name.
    * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值
+   * 某企业
    */
   epCertName?: string;
   /**
    * @remarks
-   * The business license number.
+   * Enterprise certificate number.
    * 
    * This parameter is required.
    * 

package/src/models/CompanyTwoElementsVerificationResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CompanyTwoElementsVerificationResponseBodyDataDetailInfo extends $dara.Model {
   /**
    * @remarks
-   * The business status of the enterprise.
+   * The operating status of the enterprise.
    * 
    * @example
-   * Active
+   * 在营（开业）
    */
   enterpriseStatus?: string;
   /**
@@ -45,22 +45,30 @@ export class CompanyTwoElementsVerificationResponseBodyDataDetailInfo extends $d
 export class CompanyTwoElementsVerificationResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The information about the enterprise.
+   * Enterprise details.
+   * 
+   * > This field is not returned for public institutions or civil groups.
+   * 
+   * @example
+   * {
+   *       "enterpriseStatus": "在营（开业）",
+   *       "openTime": "2023-05-25/2053-05-24"
+   * }
    */
   detailInfo?: CompanyTwoElementsVerificationResponseBodyDataDetailInfo;
   /**
    * @remarks
-   * The fields to be verified.
+   * The fields that are inconsistent in the verification.
    */
   inconsistentData?: string[];
   /**
    * @remarks
-   * The code of the verification result. Valid values:
+   * The verification result code. Valid values:
    * 
-   * *   0: The two elements belong to the same enterprise.
-   * *   1: The two elements belong to the same enterprise, but the business status of the enterprise is abnormal.
-   * *   3: The two elements do not belong to the same enterprise.
-   * *   4: No information about the enterprise is found.
+   * - 0: Verification consistent
+   * - 1: Verification consistent, the enterprise is not in normal operation
+   * - 3: The two enterprise elements failed verification
+   * - 4: No such enterprise found
    * 
    * @example
    * 0
@@ -70,8 +78,10 @@ export class CompanyTwoElementsVerificationResponseBodyData extends $dara.Model
    * @remarks
    * The verification result. Valid values:
    * 
-   * *   true: The two elements belong to the same enterprise and the business status of the enterprise is Active.
-   * *   false: The two elements do not belong to the same enterprise.
+   * - true: The information is verified to be consistent, and the enterprise is operating normally.
+   * - false: The verification failed.
+   * 
+   * > The operating status verification is not supported for public institutions or civil groups. Only the consistency between the enterprise name and the enterprise certificate number is verified.
    * 
    * @example
    * true
@@ -113,7 +123,7 @@ export class CompanyTwoElementsVerificationResponseBodyData extends $dara.Model
 export class CompanyTwoElementsVerificationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details about the access denial.
+   * Details about the access denial.
    * 
    * @example
    * -
@@ -121,7 +131,7 @@ export class CompanyTwoElementsVerificationResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The response code.
+   * The request status code.
    * 
    * @example
    * OK
@@ -129,12 +139,12 @@ export class CompanyTwoElementsVerificationResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The struct.
    */
   data?: CompanyTwoElementsVerificationResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the returned status code.
    * 
    * @example
    * OK
@@ -142,7 +152,7 @@ export class CompanyTwoElementsVerificationResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
+   * The common parameter. Each request returns a unique ID, which can be used to troubleshoot and locate issues.
    * 
    * @example
    * 68A40250-50CD-034C-B728-0BD135850177

package/src/models/DeleteContactsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteContactsRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the contact.
+   * 
    * This parameter is required.
    * 
    * @example