@alicloud/dm20151123 1.8.2 → 1.9.0

package/src/models/SendTestByTemplateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SendTestByTemplateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 10A1AD70-E48E-476D-98D9-39BD92193837

package/src/models/SendValidateFileAdvanceRequest.ts

@@ -6,6 +6,8 @@ import * as $dara from '@darabonba/typescript';
 export class SendValidateFileAdvanceRequest extends $dara.Model {
   /**
    * @remarks
+   * The column that contains the email addresses in the file. The index starts from 1.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +16,8 @@ export class SendValidateFileAdvanceRequest extends $dara.Model {
   addressColumn?: number;
   /**
    * @remarks
+   * The name of the file that contains the list of email addresses.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +26,8 @@ export class SendValidateFileAdvanceRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
+   * The URL of the file that contains the list of email addresses.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,6 +36,8 @@ export class SendValidateFileAdvanceRequest extends $dara.Model {
   fileUrlObject?: Readable;
   /**
    * @remarks
+   * Specifies whether the first row is a table header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,6 +46,8 @@ export class SendValidateFileAdvanceRequest extends $dara.Model {
   hasHeaderRow?: boolean;
   /**
    * @remarks
+   * Specifies whether to remove duplicate email addresses in the output file.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/SendValidateFileRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class SendValidateFileRequest extends $dara.Model {
   /**
    * @remarks
+   * The column that contains the email addresses in the file. The index starts from 1.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class SendValidateFileRequest extends $dara.Model {
   addressColumn?: number;
   /**
    * @remarks
+   * The name of the file that contains the list of email addresses.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class SendValidateFileRequest extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
+   * The URL of the file that contains the list of email addresses.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class SendValidateFileRequest extends $dara.Model {
   fileUrl?: string;
   /**
    * @remarks
+   * Specifies whether the first row is a table header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +45,8 @@ export class SendValidateFileRequest extends $dara.Model {
   hasHeaderRow?: boolean;
   /**
    * @remarks
+   * Specifies whether to remove duplicate email addresses in the output file.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/SendValidateFileResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class SendValidateFileResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the file. Use this ID to query the results.
+   * 
    * @example
    * yyyy-yyyy-yyyy-yyyy
    */
   fileId?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * xxxx-xxxx-xxxx-xxxx
    */

package/src/models/SenderStatisticsByTagNameAndBatchIdrequest.ts

@@ -5,17 +5,40 @@ import * as $dara from '@darabonba/typescript';
 export class SenderStatisticsByTagNameAndBatchIDRequest extends $dara.Model {
   /**
    * @remarks
-   * Sending address. If not filled, it represents all addresses.
+   * The sender address. If you do not specify this parameter, statistics for all sender addresses are returned.
    * 
    * @example
    * xxx
    */
   accountName?: string;
+  /**
+   * @remarks
+   * If you use Dedicated IPs, use this parameter to filter statistics by a specific Dedicated IP.
+   * 
+   * If you do not specify this parameter, statistics for all dedicated IPs that match the other criteria are returned.
+   * 
+   * @example
+   * xxx.xxx.xxx.xxx
+   */
   dedicatedIp?: string;
+  /**
+   * @remarks
+   * If you use Dedicated IPs, specify the ID of the dedicated IP pool to query.
+   * 
+   * If you do not specify this parameter, statistics for all resources are returned.
+   * 
+   * @example
+   * xxx
+   */
   dedicatedIpPoolId?: string;
+  /**
+   * @example
+   * dmdomain.com
+   */
+  domain?: string;
   /**
    * @remarks
-   * End time, which cannot exceed 7 days from the start time, in the format yyyy-MM-dd.
+   * The end time for the query. The time range between `StartTime` and `EndTime` cannot exceed 7 days. The format must be `YYYY-MM-DD`.
    * 
    * This parameter is required.
    * 
@@ -23,13 +46,32 @@ export class SenderStatisticsByTagNameAndBatchIDRequest extends $dara.Model {
    * 2019-09-29
    */
   endTime?: string;
+  /**
+   * @remarks
+   * If you use Dedicated IPs, use this parameter to filter statistics by a specific Email Service Provider (ESP). Valid values are:
+   * 
+   * - `gmail.com`
+   * 
+   * - `yahoo.com`
+   * 
+   * - `outlook.com`
+   * 
+   * - `icloud.com`
+   * 
+   * - `others` (matches data for all other ESPs)
+   * 
+   * If you do not specify this parameter, statistics for all ESPs are returned.
+   * 
+   * @example
+   * gmail.com
+   */
   esp?: string;
   ownerId?: number;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
-   * Start time, in the format yyyy-MM-dd.
+   * The start time for the query. The date cannot be more than 30 days in the past. The format must be `YYYY-MM-DD`.
    * 
    * This parameter is required.
    * 
@@ -39,7 +81,7 @@ export class SenderStatisticsByTagNameAndBatchIDRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * Email tag. If not filled, it represents all tags.
+   * The email tag. If you do not specify this parameter, statistics for all tags are returned.
    * 
    * @example
    * xxx
@@ -50,6 +92,7 @@ export class SenderStatisticsByTagNameAndBatchIDRequest extends $dara.Model {
       accountName: 'AccountName',
       dedicatedIp: 'DedicatedIp',
       dedicatedIpPoolId: 'DedicatedIpPoolId',
+      domain: 'Domain',
       endTime: 'EndTime',
       esp: 'Esp',
       ownerId: 'OwnerId',
@@ -65,6 +108,7 @@ export class SenderStatisticsByTagNameAndBatchIDRequest extends $dara.Model {
       accountName: 'string',
       dedicatedIp: 'string',
       dedicatedIpPoolId: 'string',
+      domain: 'string',
       endTime: 'string',
       esp: 'string',
       ownerId: 'number',

package/src/models/SenderStatisticsByTagNameAndBatchIdresponseBody.ts

@@ -3,61 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SenderStatisticsByTagNameAndBatchIDResponseBodyDataStat extends $dara.Model {
-  /**
-   * @remarks
-   * Creation time
-   * 
-   * @example
-   * 2021-07-02
-   */
   createTime?: string;
-  /**
-   * @remarks
-   * Failure count
-   * 
-   * @example
-   * 0
-   */
   faildCount?: string;
-  /**
-   * @remarks
-   * Request count
-   * 
-   * @example
-   * 4
-   */
   requestCount?: string;
-  /**
-   * @remarks
-   * Success rate
-   * 
-   * @example
-   * 100.00%
-   */
   succeededPercent?: string;
-  /**
-   * @remarks
-   * Success count
-   * 
-   * @example
-   * 4
-   */
   successCount?: string;
-  /**
-   * @remarks
-   * Invalid count
-   * 
-   * @example
-   * 0
-   */
   unavailableCount?: string;
-  /**
-   * @remarks
-   * Unavailability rate
-   * 
-   * @example
-   * 0%
-   */
   unavailablePercent?: string;
   static names(): { [key: string]: string } {
     return {
@@ -121,7 +72,7 @@ export class SenderStatisticsByTagNameAndBatchIDResponseBodyData extends $dara.M
 export class SenderStatisticsByTagNameAndBatchIDResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID
+   * The ID of the request.
    * 
    * @example
    * 10A1AD70-E48E-476D-98D9-39BD92193837
@@ -129,7 +80,7 @@ export class SenderStatisticsByTagNameAndBatchIDResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Total count
+   * The total count of data records.
    * 
    * @example
    * 1
@@ -137,7 +88,7 @@ export class SenderStatisticsByTagNameAndBatchIDResponseBody extends $dara.Model
   totalCount?: number;
   /**
    * @remarks
-   * Data records
+   * Contains the statistical data.
    */
   data?: SenderStatisticsByTagNameAndBatchIDResponseBodyData;
   static names(): { [key: string]: string } {

package/src/models/SenderStatisticsDetailByParamRequest.ts

@@ -5,35 +5,47 @@ import * as $dara from '@darabonba/typescript';
 export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   /**
    * @remarks
-   * Sending address. If not filled, it represents all addresses.
+   * The sender address. If you leave this parameter empty, emails from all sender addresses are queried.
    * 
-   * > **AccountName**, **TagName**, and **ToAddress** can all be left unfilled. If any are filled, only one of these parameters can be passed; you cannot pass a combination of two or more.
+   * > You can leave **AccountName**, **TagName**, and **ToAddress** empty. You can specify a value for only one of these parameters at a time.
    * 
    * @example
    * s***@example.net
    */
   accountName?: string;
   /**
+   * @remarks
+   * The ID of the configuration set.
+   * 
+   * @example
+   * 95437e39-5433-4c6c-8b66-0c4eac2f4d97
+   * 
    * **if can be null:**
    * true
    */
   configSetId?: string;
   /**
    * @remarks
-   * End time. The span between start and end times cannot exceed 30 days, format: yyyy-MM-dd HH:mm.
+   * The end time. The time range between the start time and the end time cannot exceed 30 days. The format is yyyy-MM-dd HH:mm.
    * 
    * @example
    * 2021-04-29 00:00
    */
   endTime?: string;
   /**
+   * @remarks
+   * The ID of the independent IP address pool.
+   * 
+   * @example
+   * e42a4d8e-66e0-4ea3-88aa-74c66c661cef
+   * 
    * **if can be null:**
    * true
    */
   ipPoolId?: string;
   /**
    * @remarks
-   * Specifies the number of results to return in this request. Range is 1~100.
+   * The number of results to return. The value can range from 1 to 100.
    * 
    * @example
    * 5
@@ -41,7 +53,7 @@ export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   length?: number;
   /**
    * @remarks
-   * Used for pagination. Specifies the offset for this request. If there are more results, set this returned value to the NextStart in the next request.
+   * The offset for this request, used for paging. If more results are available, set the \\`NextStart\\` parameter in your next request to this return value.
    * 
    * @example
    * 90f0243616#203#a***@example.net-1658817837#a***@example.net.247475288187
@@ -52,7 +64,7 @@ export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * Start time. The span between start and end times cannot exceed 30 days, format: yyyy-MM-dd HH:mm
+   * The start time. The time range between the start time and the end time cannot exceed 30 days. The format is yyyy-MM-dd HH:mm.
    * 
    * @example
    * 2021-04-28 00:00
@@ -60,12 +72,15 @@ export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * Delivery result. If not filled, it represents all statuses. Values:
+   * The delivery status. If you leave this parameter empty, emails in all delivery statuses are queried. Valid values:
+   * 
+   * - 0: delivered successfully
+   * 
+   * - 2: invalid address
+   * 
+   * - 3: spam
    * 
-   * - 0: Success
-   * - 2: Invalid Address
-   * - 3: Spam
-   * - 4: Failure
+   * - 4: failed
    * 
    * @example
    * 0
@@ -73,7 +88,8 @@ export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * Email tag. If not filled, it represents all tags.
+   * The email tag. If you leave this parameter empty, emails with all tags are queried.
+   * When you send an email using SMTP, specify the \\`TagName\\` and its value for the \\`X-AliDM-Trace\\` field. For more information, see the examples for email tracking.
    * 
    * @example
    * EmailQuestionnaireHelioscam
@@ -81,7 +97,7 @@ export class SenderStatisticsDetailByParamRequest extends $dara.Model {
   tagName?: string;
   /**
    * @remarks
-   * Recipient address. If not filled, it represents all recipient addresses.
+   * The recipient address. If you leave this parameter empty, emails sent to all recipient addresses are queried.
    * 
    * @example
    * b***@example.net

package/src/models/SenderStatisticsDetailByParamResponseBody.ts

@@ -3,13 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SenderStatisticsDetailByParamResponseBodyDataMailDetail extends $dara.Model {
-  /**
-   * @remarks
-   * Sending address
-   * 
-   * @example
-   * s***@example.net
-   */
   accountName?: string;
   /**
    * **if can be null:**
@@ -21,14 +14,6 @@ export class SenderStatisticsDetailByParamResponseBodyDataMailDetail extends $da
    * true
    */
   configSetName?: string;
-  /**
-   * @remarks
-   * Detailed classification of error reasons: - SendOk - SmtpNxBox
-   * etc.
-   * 
-   * @example
-   * SendOk
-   */
   errorClassification?: string;
   /**
    * **if can be null:**
@@ -40,53 +25,11 @@ export class SenderStatisticsDetailByParamResponseBodyDataMailDetail extends $da
    * true
    */
   ipPoolName?: string;
-  /**
-   * @remarks
-   * Update time
-   * 
-   * @example
-   * 2021-04-28T17:11Z
-   */
   lastUpdateTime?: string;
-  /**
-   * @remarks
-   * Delivery detail information
-   * 
-   * @example
-   * 250 Send Mail OK
-   */
   message?: string;
-  /**
-   * @remarks
-   * Delivery status: 0 Success, 2 Invalid Address, 3 Spam, 4 Other Failures
-   * 
-   * @example
-   * 0
-   */
   status?: number;
-  /**
-   * @remarks
-   * Email subject
-   * 
-   * @example
-   * test subject
-   */
   subject?: string;
-  /**
-   * @remarks
-   * Recipient address
-   * 
-   * @example
-   * b***@example.net
-   */
   toAddress?: string;
-  /**
-   * @remarks
-   * UTC formatted update time
-   * 
-   * @example
-   * 1619601108
-   */
   utcLastUpdateTime?: string;
   static names(): { [key: string]: string } {
     return {
@@ -160,7 +103,7 @@ export class SenderStatisticsDetailByParamResponseBodyData extends $dara.Model {
 export class SenderStatisticsDetailByParamResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Used for pagination. If there are more results, set this returned value to the NextStart in the next request.
+   * Used for paging. If more results are available, set the \\`NextStart\\` parameter in your next request to this return value.
    * 
    * @example
    * 90f0243616#203#a***@example.net-1658817689#a***@example.net.247141122178
@@ -168,16 +111,12 @@ export class SenderStatisticsDetailByParamResponseBody extends $dara.Model {
   nextStart?: string;
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * B5AB8EBB-EE64-4BB2-B085-B92CC5DEDC41
    */
   requestId?: string;
-  /**
-   * @remarks
-   * Detailed records
-   */
   data?: SenderStatisticsDetailByParamResponseBodyData;
   static names(): { [key: string]: string } {
     return {