@alicloud/dm20151123 1.8.2 → 1.9.0

package/src/models/AddIpfilterRequest.ts

@@ -5,14 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AddIpfilterRequest extends $dara.Model {
   /**
    * @remarks
-   * IP Address/IP Range/IP Segment
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * xxx.xxx.xxx.xxx
-   * xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx
-   * xxx.xxx.xxx.xxx/xxx
    */
   ipAddress?: string;
   ownerId?: number;

package/src/models/AddIpfilterResponseBody.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AddIpfilterResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * ID corresponding to the IP
-   * 
-   * @example
-   * 10795
-   */
   ipFilterId?: string;
-  /**
-   * @remarks
-   * Request ID
-   * 
-   * @example
-   * 0E9282E8-DC08-5445-8FB0-B9F0CA28B249
-   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/BatchSendMailRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BatchSendMailRequest extends $dara.Model {
   /**
    * @remarks
-   * The sending address configured in the management console.
+   * The sender address configured in the console.
    * 
    * This parameter is required.
    * 
@@ -16,7 +16,8 @@ export class BatchSendMailRequest extends $dara.Model {
   /**
    * @remarks
    * - 0: Random account
-   * - 1: Sending address
+   * 
+   * - 1: Sender address
    * 
    * This parameter is required.
    * 
@@ -26,38 +27,93 @@ export class BatchSendMailRequest extends $dara.Model {
   addressType?: number;
   /**
    * @remarks
-   * - 1: Enable data tracking function
-   * - 0 (default): Disable data tracking function
+   * - 1: Enables the data tracking feature.
+   * 
+   * - 0 (default): Disables the data tracking feature.
    * 
    * @example
    * 0
    */
   clickTrace?: string;
+  /**
+   * @remarks
+   * Enables domain-level authentication.
+   * 
+   * - true
+   * 
+   * - false
+   * 
+   * Use this parameter only for domain-level authentication. Ignore it for sender address-level authentication.
+   * 
+   * 1\\. The console creates the address \\`domain-auth-created-by-system\\@example.com\\`. Do not change the prefix before the at sign (@). Replace the domain suffix with your own domain.
+   * 
+   * 2\\.
+   * 
+   * **API scenario**
+   * 
+   * Set \\`AccountName\\` to your domain. Recipients see \\`domain-auth-created-by-system\\@example.com\\` as the sender.
+   * 
+   * **SMTP scenario**
+   * 
+   * a. Use the \\`ModifyPWByDomain\\` API to set a password for your domain.
+   * 
+   * b. Authenticate using your domain and the password. Set the actual sender address (\\`mailfrom\\`) to a custom address, such as \\`user\\@example.com\\`. Recipients see \\`user\\@example.com\\` as the sender.
+   * 
+   * @example
+   * true
+   */
   domainAuth?: boolean;
   /**
    * @remarks
-   * Currently, the standard fields that can be added to the email header are Message-ID, List-Unsubscribe, and List-Unsubscribe-Post. Standard fields will overwrite the existing values in the email header, while non-standard fields must start with X-User- and will be appended to the email header. Currently, up to 10 headers can be passed in JSON format, and both standard and non-standard fields must comply with the syntax requirements for headers.
+   * Message header settings.
+   * 
+   * All fields, standard or non-standard, must follow standard header syntax. For API calls, the \\`headers\\` field supports up to 10 headers. Any headers beyond this limit are ignored. SMTP does not have a header limit.
+   * 
+   * 1\\. Standard fields
+   * 
+   * \\`Message-ID\\`, \\`List-Unsubscribe\\`, \\`List-Unsubscribe-Post\\`
+   * 
+   * Standard fields overwrite existing values in the message header.
+   * 
+   * 2\\. Non-standard fields
+   * 
+   * Case-insensitive
+   * 
+   * a. Start with \\`X-User-\\`. These fields are not pushed to EventBridge or Message Service. They are required only for API calls. SMTP supports any custom header.
+   * 
+   * b. Start with \\`X-User-Notify-\\`. These fields are pushed to EventBridge and Message Service. They are supported by both API and SMTP.
+   * 
+   * When pushed to EventBridge or Message Service, these fields appear under the \\`headers\\` object.
    * 
    * @example
    * {
-   *   "Message-ID": "<msg0001@example.com>",
-   *   "X-User-UID1": "UID-1-000001",
-   *   "X-User-UID2": "UID-2-000001"
+   *       "Message-ID": "<d52ce63e-a0d5-4f95-b6a9-e1256a44f5fb@example.net>",
+   *       "X-User-UID1": "UID-1-000001",
+   *       "X-User-UID2": "UID-2-000001",
+   *       "X-User-Notify-UID1": "UID-3-000001",
+   *       "X-User-Notify-UID2": "UID-4-000001"
+   * 	  
    * }
    */
   headers?: string;
   /**
    * @remarks
-   * dedicated IP pool ID. Users who have purchased an dedicated IP can use this parameter to specify the outgoing IP for this send operation.
+   * The ID of the dedicated IP address pool. If you purchased dedicated IP addresses, use this parameter to specify the egress IP address for sending the email.
    * 
    * @example
-   * xxx
+   * e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
    */
   ipPoolId?: string;
   ownerId?: number;
   /**
    * @remarks
-   * The name of the recipient list that has been created and uploaded with recipients. Note: The recipient list should not be deleted until at least 10 minutes after the task is triggered, otherwise it may cause sending failure.
+   * The name of a pre-created recipient list to which recipients have been uploaded.
+   * 
+   * Note:
+   * 
+   * The number of recipients in the list must not exceed your remaining daily quota. Otherwise, email sending fails.
+   * 
+   * Do not delete the recipient list for at least 10 minutes after triggering the task. Otherwise, email sending may fail.
    * 
    * This parameter is required.
    * 
@@ -67,7 +123,7 @@ export class BatchSendMailRequest extends $dara.Model {
   receiversName?: string;
   /**
    * @remarks
-   * Reply address
+   * The reply-to address.
    * 
    * @example
    * test2***@example.net
@@ -75,17 +131,17 @@ export class BatchSendMailRequest extends $dara.Model {
   replyAddress?: string;
   /**
    * @remarks
-   * Alias for the reply address
+   * The alias for the reply-to address.
    * 
    * @example
-   * Lucy
+   * 小红
    */
   replyAddressAlias?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
-   * Email tag name.
+   * The name of the email tag.
    * 
    * @example
    * test3
@@ -93,7 +149,7 @@ export class BatchSendMailRequest extends $dara.Model {
   tagName?: string;
   /**
    * @remarks
-   * The name of the template that has been created and approved in advance.
+   * The name of a pre-created and approved template.
    * 
    * This parameter is required.
    * 
@@ -103,12 +159,17 @@ export class BatchSendMailRequest extends $dara.Model {
   templateName?: string;
   /**
    * @remarks
-   * Filtering level. Refer to the [Unsubscribe Function Link Generation and Filtering Mechanism](https://help.aliyun.com/document_detail/2689048.html) document.
-   * - disabled: No filtering
-   * - default: Use the default strategy, bulk addresses use sender address-level filtering
-   * - mailfrom: Sender address-level filtering
-   * - mailfrom_domain: Sender domain-level filtering
-   * - edm_id: Account-level filtering
+   * The filtering level. For more information, see [Unsubscribe link generation and filtering mechanism](https://help.aliyun.com/document_detail/2689048.html).
+   * 
+   * - disabled: No filtering.
+   * 
+   * - default: Uses the default policy. Batch emails are filtered at the sender address level.
+   * 
+   * - mailfrom: Filters at the sender address level.
+   * 
+   * - mailfrom_domain: Filters at the email domain level.
+   * 
+   * - edm_id: Filters at the account level.
    * 
    * @example
    * mailfrom_domain
@@ -116,13 +177,13 @@ export class BatchSendMailRequest extends $dara.Model {
   unSubscribeFilterLevel?: string;
   /**
    * @remarks
-   * The type of generated unsubscribe link. Refer to the [Unsubscribe Function Link Generation and Filtering Mechanism](https://help.aliyun.com/document_detail/2689048.html) document.
-   * - disabled: Do not generate
-   * - default: Use the default strategy: Generate an unsubscribe link when a bulk-type sending address sends to specific domains, such as those containing keywords like "gmail", "yahoo",
-   * "google", "aol.com", "hotmail",
-   * "outlook", "ymail.com", etc.
-   * - zh-cn: Generate, for future content preparation
-   * - en-us: Generate, for future content preparation
+   * The type of unsubscribe link to generate. For more information, see [Unsubscribe link generation and filtering mechanism](https://help.aliyun.com/document_detail/2689048.html).
+   * 
+   * - disabled: Does not generate a link.
+   * 
+   * - default: Uses the default policy. An unsubscribe link is generated when batch emails are sent from a sender address to specific domains, such as those containing the keywords "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", or "ymail.com".
+   * 
+   * The language of the unsubscribe link matches the recipient\\"s browser language setting.
    * 
    * @example
    * default

package/src/models/BatchSendMailResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BatchSendMailResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Event ID
+   * The event ID.
    * 
    * @example
    * xxx
@@ -13,7 +13,7 @@ export class BatchSendMailResponseBody extends $dara.Model {
   envId?: string;
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 12D086F6-8F31-4658-84C1-006DED011A85

package/src/models/CheckDomainResponseBody.ts

@@ -8,6 +8,7 @@ export class CheckDomainResponseBody extends $dara.Model {
    * Domain status. Indicates whether the verification was successful, with values as follows:
    * 
    * - **0**: Available, verified successfully
+   * 
    * - **1**: Unavailable, verification failed
    * 
    * @example

package/src/models/CheckReplyToMailAddressRequest.ts

@@ -10,7 +10,7 @@ export class CheckReplyToMailAddressRequest extends $dara.Model {
    * en is English, and any other value or an empty value defaults to Chinese.
    * 
    * @example
-   * en
+   * 无
    */
   lang?: string;
   /**

package/src/models/ConfigSetCancelRelationFromAddressRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetCancelRelationFromAddressRequest extends $dara.Model {
   /**
+   * @remarks
+   * The sender address. This parameter is required.
+   * 
    * @example
    * xxx@xxx.com
    */
   fromAddress?: string;
   /**
+   * @remarks
+   * The ID of the configuration set. This parameter is required.
+   * 
    * @example
    * xxx
    */

package/src/models/ConfigSetCancelRelationFromAddressResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetCancelRelationFromAddressResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * xxx
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the request.
+   * 
    * @example
    * true
    */

package/src/models/ConfigSetCreateRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetCreateRequest extends $dara.Model {
   /**
+   * @remarks
+   * The description of the configuration set. The description can be up to 50 characters long.
+   * 
    * @example
    * XXX
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the associated IP pool. This parameter is optional.
+   * 
    * @example
    * XXX
    */
   ipPoolId?: string;
   /**
+   * @remarks
+   * The name of the configuration set. This parameter is required. The name must be unique and can be up to 50 characters long.
+   * 
    * @example
    * XXX
    */

package/src/models/ConfigSetCreateResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetCreateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration set ID.
+   * 
    * @example
    * XXX
    */
   id?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * XXX
    */

package/src/models/ConfigSetDeleteRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetDeleteRequest extends $dara.Model {
   /**
+   * @remarks
+   * The IDs of the configuration sets. Separate multiple IDs with commas. This parameter is required.
+   * 
    * @example
    * xxx
    */
   ids?: string;
   /**
+   * @remarks
+   * Specifies whether to force delete the associations with sender addresses.
+   * 
    * @example
    * true
    */

package/src/models/ConfigSetDeleteResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetDeleteResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxx
    */

package/src/models/ConfigSetDetailRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetDetailRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the configuration set. This parameter is required.
+   * 
    * @example
    * xxx
    */

package/src/models/ConfigSetDetailResponseBody.ts

@@ -6,11 +6,17 @@ import * as $dara from '@darabonba/typescript';
  */
 export class ConfigSetDetailResponseBodyDetailIpPool extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the associated IP pool.
+   * 
    * @example
    * xxx
    */
   ipPoolId?: string;
   /**
+   * @remarks
+   * The name of the associated IP pool.
+   * 
    * @example
    * xxx
    */
@@ -40,17 +46,30 @@ export class ConfigSetDetailResponseBodyDetailIpPool extends $dara.Model {
 
 export class ConfigSetDetailResponseBodyDetail extends $dara.Model {
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * xxx
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the configuration set.
+   * 
    * @example
    * xxx
    */
   id?: string;
+  /**
+   * @remarks
+   * The associated IP pool.
+   */
   ipPool?: ConfigSetDetailResponseBodyDetailIpPool;
   /**
+   * @remarks
+   * The name of the configuration set.
+   * 
    * @example
    * xxx
    */
@@ -86,8 +105,15 @@ export class ConfigSetDetailResponseBodyDetail extends $dara.Model {
 }
 
 export class ConfigSetDetailResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the configuration set.
+   */
   detail?: ConfigSetDetailResponseBodyDetail;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxx
    */

package/src/models/ConfigSetListRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetListRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to query all configuration sets. This parameter is optional.
+   * 
    * @example
    * false
    */
   all?: boolean;
   /**
+   * @remarks
+   * The keyword to search by name.
+   * 
    * @example
    * xxx
    */
   keyword?: string;
   /**
+   * @remarks
+   * The page index. The value starts from 1. This parameter is required.
+   * 
    * @example
    * 1
    */
   pageIndex?: string;
   /**
+   * @remarks
+   * The number of entries per page. This parameter is required.
+   * 
    * @example
    * 10
    */

package/src/models/ConfigSetListResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetListResponseBodyConfigSetsIpPool extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the associated IP pool.
+   * 
    * @example
    * xxx
    */
   ipPoolId?: string;
   /**
+   * @remarks
+   * The name of the associated IP pool.
+   * 
    * @example
    * xxx
    */
@@ -38,18 +44,35 @@ export class ConfigSetListResponseBodyConfigSetsIpPool extends $dara.Model {
 
 export class ConfigSetListResponseBodyConfigSets extends $dara.Model {
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * xxx
    */
   description?: string;
+  /**
+   * @remarks
+   * The list of associated sender addresses.
+   */
   fromAddresses?: string[];
   /**
+   * @remarks
+   * The ID of the configuration set.
+   * 
    * @example
    * xxx
    */
   id?: string;
+  /**
+   * @remarks
+   * The IP pool information.
+   */
   ipPool?: ConfigSetListResponseBodyConfigSetsIpPool;
   /**
+   * @remarks
+   * The name of the configuration set.
+   * 
    * @example
    * xxx
    */
@@ -90,28 +113,47 @@ export class ConfigSetListResponseBodyConfigSets extends $dara.Model {
 }
 
 export class ConfigSetListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of configuration sets.
+   */
   configSets?: ConfigSetListResponseBodyConfigSets[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * Indicates whether a next page of results exists.
+   * 
    * @example
    * false
    */
   hasMore?: boolean;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxx
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries that match the request.
+   * 
    * @example
    * 5
    */

package/src/models/ConfigSetRelationFromAddressRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetRelationFromAddressRequest extends $dara.Model {
   /**
+   * @remarks
+   * The sender address. This parameter is required.
+   * 
    * @example
    * xxx@xxx.com
    */
   fromAddress?: string;
   /**
+   * @remarks
+   * The ID of the configuration set. This parameter is required.
+   * 
    * @example
    * xxx
    */

package/src/models/ConfigSetRelationFromAddressResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetRelationFromAddressResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * xxx
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the operation.
+   * 
    * @example
    * true
    */

package/src/models/ConfigSetUpdateRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigSetUpdateRequest extends $dara.Model {
   /**
+   * @remarks
+   * The description. The description can be up to 50 characters long.
+   * 
    * @example
    * XXX
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the configuration set. This parameter is required.
+   * 
    * @example
    * XXX
    */
   id?: string;
   /**
+   * @remarks
+   * The ID of the associated IP pool. This parameter is optional.
+   * 
    * @example
    * XXX
    */
   ipPoolId?: string;
   /**
+   * @remarks
+   * The name of the configuration. This parameter is required. The name must be unique and can be up to 50 characters long.
+   * 
    * @example
    * XXX
    */