@alicloud/dytnsapi20200217 3.3.0 → 3.4.0

package/src/models/DescribePhoneNumberOperatorAttributeRequest.ts

@@ -7,7 +7,7 @@ export class DescribePhoneNumberOperatorAttributeRequest 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.
    * 
@@ -16,19 +16,23 @@ export class DescribePhoneNumberOperatorAttributeRequest extends $dara.Model {
    */
   authCode?: string;
   /**
+   * @remarks
+   * A system parameter. You do not need to specify this parameter.
+   * 
    * @example
-   * 示例值
+   * -
    */
   flowName?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number that you want 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 field is an 11-digit phone number.
+   * - If Mask is set to MD5, this field is a 32-character encrypted string.
+   * - If Mask is set to SHA256, this field is a 64-character encrypted string.
+   * - If Mask is set to SM3, this field is a 64-character encrypted string.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * >Notice: The letters in the encrypted string are not case-sensitive.</notice>
    * 
    * This parameter is required.
    * 
@@ -40,11 +44,12 @@ export class DescribePhoneNumberOperatorAttributeRequest extends $dara.Model {
    * @remarks
    * The encryption method of the phone number. Valid values:
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**: The phone number is MD5-encrypted.
-   * *   **SHA256**: The phone number is SHA256-encrypted.
+   * - **NORMAL**: no encryption
+   * - **MD5**: MD5 encryption
+   * - **SHA256**: SHA256 encryption
+   * - **SM3**: SM3 encryption
    * 
-   * > Letters in the string must be uppercase.
+   * >Notice: All letters in the string must be uppercase.</notice>
    * 
    * This parameter is required.
    * 
@@ -56,8 +61,11 @@ export class DescribePhoneNumberOperatorAttributeRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * A system parameter. You do not need to specify this parameter.
+   * 
    * @example
-   * 示例值示例值示例值
+   * -
    */
   resultCount?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribePhoneNumberOperatorAttributeResponseBody.ts

@@ -7,37 +7,38 @@ export class DescribePhoneNumberOperatorAttributeResponseBodyData extends $dara.
    * @remarks
    * The basic carrier. Valid values:
    * 
-   * *   **China Mobile**
-   * *   **China Unicom**
-   * *   **China Telecom**
-   * *   **China Broadnet**
+   * - **China Mobile**.
+   * - **China Unicom**.
+   * - **China Telecom**.
+   * - **China Broadnet**.
    * 
    * @example
-   * China Mobile
+   * 中国移动
    */
   basicCarrier?: string;
   /**
    * @remarks
-   * The actual carrier, including the virtual network operator (VNO). If the phone number involves mobile number portability, the value of this parameter is the carrier after mobile number portability.
+   * The actual carrier (including the mobile virtual network operator). If number portability is enabled, the value indicates the carrier after number portability.
    * 
    * @example
-   * China Mobile
+   * 中国移动
    */
   carrier?: string;
   /**
    * @remarks
-   * The city where the phone number is registered.
+   * The city to which the phone number belongs.
    * 
    * @example
-   * hangzhou
+   * 杭州
    */
   city?: string;
   /**
    * @remarks
-   * Indicates whether the phone number involves mobile number portability. Valid values:
+   * Indicates whether the number has been ported. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: yes
+   * 
+   * - **false**: no
    * 
    * @example
    * false
@@ -53,10 +54,10 @@ export class DescribePhoneNumberOperatorAttributeResponseBodyData extends $dara.
   numberSegment?: number;
   /**
    * @remarks
-   * The province where the phone number is registered.
+   * The province to which the phone number belongs.
    * 
    * @example
-   * zhejiang
+   * 浙江
    */
   province?: string;
   static names(): { [key: string]: string } {
@@ -91,16 +92,23 @@ export class DescribePhoneNumberOperatorAttributeResponseBodyData extends $dara.
 }
 
 export class DescribePhoneNumberOperatorAttributeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details about the access denial. This parameter is returned only if the request is denied because the RAM user or RAM role does not have the required permissions.
+   * 
+   * @example
+   * -
+   */
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * The response code. Valid values:
+   * The status code of the request. Valid values:
    * 
-   * *   **OK**: The request is successful.
-   * *   **InvalidParameter**: The specified phone number is invalid or the parameter format is invalid.
-   * *   **PhoneNumberNotfound**: No attribute information can be found for the specified phone number.
-   * *   **isp.UNKNOWN**: An unknown exception occurred.
-   * *   **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 is successful.
+   * - **InvalidParameter**: The phone number is invalid or the format of the parameter is invalid.
+   * - **PhoneNumberNotfound**: The carrier information of the phone number is not found.
+   * - **isp.UNKNOWN**: An unknown error occurred.
+   * - **RequestFrequencyLimit**: Due to carrier restrictions, you cannot frequently query the same number in a short period of time. If this error code is returned, try again later.
    * 
    * @example
    * OK
@@ -108,12 +116,12 @@ export class DescribePhoneNumberOperatorAttributeResponseBody extends $dara.Mode
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The returned data.
    */
   data?: DescribePhoneNumberOperatorAttributeResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The description of the status code.
    * 
    * @example
    * OK

package/src/models/DescribePhoneTwiceTelVerifyRequest.ts

@@ -7,7 +7,7 @@ export class DescribePhoneTwiceTelVerifyRequest 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 Verification Service console](https://dytns.console.aliyun.com/analysis/apply), get the Authorization ID. This ID is your authorization code.
    * 
    * This parameter is required.
    * 
@@ -17,13 +17,17 @@ export class DescribePhoneTwiceTelVerifyRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
-   * The phone number to be queried.
+   * The phone number to be queried. The number can be a mobile phone number or an encrypted string.
    * 
-   * *   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 the value of **Mask** is **NORMAL**, **InputNumber** is an 11-digit mobile phone number.
    * 
-   * >  Letters in the encrypted strings are not case-sensitive.
+   * - If the value of **Mask** is **MD5**, **InputNumber** is a 32-bit encrypted string.
+   * 
+   * - If the value of **Mask** is **SHA256**, **InputNumber** is a 64-bit encrypted string.
+   * 
+   * >Notice: 
+   * 
+   * The encrypted string is not case-sensitive.
    * 
    * This parameter is required.
    * 
@@ -35,9 +39,11 @@ export class DescribePhoneTwiceTelVerifyRequest extends $dara.Model {
    * @remarks
    * The encryption method of the phone number. Valid values:
    * 
-   * *   **NORMAL**: The phone number is not encrypted.
-   * *   **MD5**
-   * *   **SHA256**
+   * - **NORMAL**: The phone number is not encrypted.
+   * 
+   * - **MD5**
+   * 
+   * - **SHA256**
    * 
    * This parameter is required.
    * 
@@ -50,13 +56,11 @@ export class DescribePhoneTwiceTelVerifyRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The registration time. Specify the time in the yyyy-MM-dd HH:mm:ss format. This time is the service registration time of the mobile phone user. If the service registration time is later than the time when the phone number is assigned by a carrier, it indicates that the phone number is not a reassigned number. Otherwise, the phone number is a reassigned number.
-   * 
-   * > 
-   * 
-   * *   If a carrier allocates a single number multiple times, the system will determine whether the phone number is a reassigned number based on the time when the carrier last allocated the phone number.
+   * The registration time of a phone number. The time must be in the `yyyy-MM-dd HH:mm:ss` format. The value of this parameter is the registration time of a mobile phone user in your business. If the registration time is later than the time when a carrier assigns a number, the number is not a recycled number. Otherwise, the number is a recycled number.
    * 
-   * *   The service registration time must be later than 00:00:00 on January 1, 1970.
+   * > - If a phone number is assigned for multiple times, the system uses the last assignment time as the criterion.
+   * >
+   * > - The registration time must be later than `1970-01-01 00:00:00`.
    * 
    * This parameter is required.
    * 

package/src/models/DescribePhoneTwiceTelVerifyResponseBody.ts

@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePhoneTwiceTelVerifyResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The carrier. Valid values:
+   * The carrier that provides service for the number. Valid values:
    * 
-   * *   **CMCC**: China Mobile
-   * *   **CUCC**: China Unicom
-   * *   **CTCC**: China Telecom
+   * - **CMCC**: China Mobile.
    * 
-   * >  The returned result indicates the carrier who assigns the phone number. If the phone number involves mobile number portability, the carrier after mobile number portability is returned.
+   * - **CUCC**: China Unicom.
+   * 
+   * - **CTCC**: China Telecom.
+   * 
+   * > The carrier that currently provides service for the number. For a ported number, this is the destination carrier.
    * 
    * @example
    * CMCC
@@ -19,12 +21,17 @@ export class DescribePhoneTwiceTelVerifyResponseBodyData extends $dara.Model {
   carrier?: string;
   /**
    * @remarks
-   * The result of the request. Valid values:
+   * The verification result. Valid values:
+   * 
+   * - **0**: Cannot be determined.
+   * 
+   * - **1**: The number is a recycled number.
+   * 
+   * - **2**: The number is not a recycled number.
    * 
-   * *   **0**: It is unable to judge whether the phone number is a reassigned number.
-   * *   **1**: The phone number is a reassigned number.
-   * *   **2**: The phone number is not a reassigned number.
-   * *   **3**: The phone number has been canceled.
+   * - **3**: The number has been deactivated.
+   * 
+   * - **4**: Unknown: The number was transferred to a new owner.
    * 
    * @example
    * 1
@@ -56,14 +63,17 @@ export class DescribePhoneTwiceTelVerifyResponseBodyData extends $dara.Model {
 export class DescribePhoneTwiceTelVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. Valid values:
+   * The request status code. Valid values:
+   * 
+   * - **OK**: The request was successful.
+   * 
+   * - **PortabilityNumberNotSupported**: Queries for this ported number are not supported.
+   * 
+   * - **RequestNumberNotSupported**: Queries are not supported for numbers from China Broadnet (starting with 192), mobile virtual network operators, and other unsupported carriers.
    * 
-   * *   **OK**: The request is successful.
-   * *   **PortabilityNumberNotSupported**: The phone number that is involved in mobile number portability is not supported.
-   * *   **RequestNumberNotSupported**: You are not allowed to query phone numbers assigned by China Broadnet (that is, phone numbers start with 192) and phone numbers assigned by virtual network operators (VNOs).
-   * *   **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.
+   * - **RequestFrequencyLimit**: Carriers limit frequent queries for the same number. If you receive this error code, try again later.
    * 
-   * >  You are charged for phone number verifications if the value of Code is OK and the value of VerifyResult is not 0. For more information, see [Pricing](https://help.aliyun.com/document_detail/154751.html).
+   * > A charge applies when the value of `Code` is `OK` and the value of `VerifyResult` is not `0`. For more information, see [Phone Number Service pricing](https://help.aliyun.com/document_detail/154751.html).
    * 
    * @example
    * OK
@@ -71,12 +81,12 @@ export class DescribePhoneTwiceTelVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * A data structure that contains the verification results.
    */
   data?: DescribePhoneTwiceTelVerifyResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * A description of the returned status code.
    * 
    * @example
    * OK
@@ -84,7 +94,7 @@ export class DescribePhoneTwiceTelVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique request ID. It is a common parameter and can be used to troubleshoot and locate issues.
+   * The unique ID of the request. This common parameter is returned with each request. Use this ID to troubleshoot issues.
    * 
    * @example
    * 68A40250-50CD-034C-B728-0BD135850177

package/src/models/GetUaidapplyTokenSignRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   /**
    * @remarks
+   * The authorization code.
+   * 
+   * > To obtain this authorization code, navigate to **Tag Plaza** in the [**Phone Number Verification Service**](https://dytns.console.aliyun.com/analysis/square) console, select a tag, and submit an application. You receive the code after your application is approved.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,14 @@ export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   authCode?: string;
   /**
    * @remarks
+   * The mobile carrier. Valid values:
+   * 
+   * - **CM**: China Mobile
+   * 
+   * - **CU**: China Unicom
+   * 
+   * - **CT**: China Telecom
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +33,16 @@ export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   carrier?: string;
   /**
    * @remarks
+   * The client type. Valid values:
+   * 
+   * - `30100`: Android
+   * 
+   * - `30300`: iOS
+   * 
+   * - `20200`: H5
+   * 
+   * - `10010`: Web
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,6 +56,10 @@ export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   format?: string;
   /**
    * @remarks
+   * The external ID.
+   * 
+   * > For China Mobile (CM), this parameter corresponds to `traceId` and `msgId`. The values of `OutId`, `traceId`, and `msgId` must be the same.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -42,11 +68,17 @@ export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   outId?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * This parameter is required if the carrier is China Telecom (CT). For details, see the China Telecom documentation.
+   * 
    * @example
    * 955EC1A869852EA8BC66F********D7C6E92017BBD5B001C736EFEAFB775C232
    */
   paramKey?: string;
   /**
+   * @remarks
+   * This parameter is required if the carrier is China Telecom (CT). For details, see the China Telecom documentation.
+   * 
    * @example
    * B2F0D4CD7A216D16CE2AF4BBC********29A454FDDD991F919106C12CB89ABA8
    */
@@ -55,6 +87,9 @@ export class GetUAIDApplyTokenSignRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
+   * The event timestamp, accurate to the millisecond.<br>
+   * Format: `yyyyMMddHHmmssSSS`.<br>
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetUaidapplyTokenSignResponseBody.ts

@@ -4,16 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetUAIDApplyTokenSignResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The mobile carrier. Valid values:
+   * 
+   * - **CM**: China Mobile
+   * 
+   * - **CU**: China Unicom
+   * 
+   * - **CT**: China Telecom
+   * 
    * @example
    * CM
    */
   carrier?: string;
   /**
+   * @remarks
+   * The external ID.
+   * 
    * @example
    * b8b5b3a*******0b9893484fdf412c99
    */
   outId?: string;
   /**
+   * @remarks
+   * The signature value.
+   * 
    * @example
    * D2E204D74EEB373E468632********23F592C4C9
    */
@@ -45,22 +60,40 @@ export class GetUAIDApplyTokenSignResponseBodyData extends $dara.Model {
 
 export class GetUAIDApplyTokenSignResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Details about the access denial.
+   * 
    * @example
    * -
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The response status code. Valid values:
+   * 
+   * - **OK**: The request was successful.
+   * 
    * @example
    * OK
    */
   code?: string;
+  /**
+   * @remarks
+   * The response data.
+   */
   data?: GetUAIDApplyTokenSignResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 68A40250-50CD-034C-B728-0BD******177
    */

package/src/models/HistoryThreeElementsVerificationRequest.ts

@@ -5,55 +5,92 @@ import * as $dara from '@darabonba/typescript';
 export class HistoryThreeElementsVerificationRequest extends $dara.Model {
   /**
    * @remarks
+   * The authorization code. You can obtain it from the following sources:
+   * 
+   * - On the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page in the Phone Number Intelligence console, select the **three-element ID verification** tag and submit an application. You will receive an authorization code after the application is approved.
+   * 
+   * - On the [My Applications](https://dytns.console.aliyun.com/analysis/apply) page in the Phone Number Intelligence console, find the authorization ID for your approved **three-element ID verification** service.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值示例值
+   * example
    */
   authCode?: string;
   /**
+   * @remarks
+   * The carrier to query. By default, the system queries the number\\"s carrier of record. Specify this parameter to route the query to a specific carrier.
+   * 
+   * Valid values:
+   * 
+   * - `CMCC`: China Mobile
+   * 
+   * - `CUCC`: China Unicom
+   * 
+   * - `CTCC`: China Telecom
+   * 
+   * > Due to number portability, a ported number\\"s historical carrier may be unknown. Use this parameter to explicitly query a specific carrier. If omitted, the query defaults to the number\\"s current carrier of record.
+   * >
+   * > **Important** Specifying China Broadcasting Network is not supported and results in an HTTP 400 error.
+   * 
    * @example
    * CMCC
    */
   carrier?: string;
   /**
    * @remarks
+   * The ID number to verify.
+   * 
+   * - If `Mask` is set to `NORMAL`, the value of this parameter is in plaintext.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值示例值
+   * example
    */
   certCode?: string;
   /**
    * @remarks
+   * The phone number to query.
+   * 
+   * - If `Mask` is set to `NORMAL`, this parameter must be an 11-digit mobile phone number.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值示例值
+   * example
    */
   inputNumber?: string;
   /**
    * @remarks
+   * The encryption method. Valid value:
+   * 
+   * - **NORMAL**: The phone number is not encrypted.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * example
    */
   mask?: string;
   /**
    * @remarks
+   * The name to verify.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值
+   * example
    */
   name?: string;
   /**
    * @remarks
+   * The historical point in time to verify, in `yyyyMMddHHmmss` format. If the specific time of day is unknown, set the `HHmmss` portion to `000000`. For example, `20230615000000` verifies ownership as of June 15, 2023.
+   * 
    * This parameter is required.
    * 
    * @example
-   * 示例值示例值示例值
+   * example
    */
   verificationTime?: string;
   static names(): { [key: string]: string } {

package/src/models/HistoryThreeElementsVerificationResponseBody.ts

@@ -4,11 +4,27 @@ 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
    */
@@ -38,22 +54,44 @@ export class HistoryThreeElementsVerificationResponseBodyData extends $dara.Mode
 
 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
    */

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.
    *