@alicloud/websitebuild20250429 2.25.0 → 2.26.1

package/src/models/GetAppInstanceTempShortUrlRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppInstanceTempShortUrlRequest extends $dara.Model {
   /**
+   * @remarks
+   * Application business ID
+   * 
    * @example
    * WD20250703155602000001
    */

package/src/models/GetAppInstanceTempShortUrlResponseBody.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAppInstanceTempShortUrlResponseBodyModule extends $dara.Model {
   /**
    * @remarks
+   * time-to-live (TTL)
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ss.SSSZ
    * 
    * @example
@@ -12,11 +14,17 @@ export class GetAppInstanceTempShortUrlResponseBodyModule extends $dara.Model {
    */
   expireAtTime?: string;
   /**
+   * @remarks
+   * temporary short URL
+   * 
    * @example
    * http://www.aliyun.com
    */
   tempShortUrl?: string;
   /**
+   * @remarks
+   * full URL
+   * 
    * @example
    * https://bj.download.cycore.cn/zhkt-student-cystore-https/2025/9/31/10/12/9b48342f-e595-4c60-8032-dccd355e7552.jpg
    */
@@ -48,31 +56,54 @@ export class GetAppInstanceTempShortUrlResponseBodyModule extends $dara.Model {
 
 export class GetAppInstanceTempShortUrlResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * access denied details
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * is retry allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App Name.
+   * 
    * @example
    * dewuApp
    */
   appName?: string;
   /**
+   * @remarks
+   * dynamic code, currently unused. Please ignore.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * dynamic message.
+   * 
    * @example
    * SYSTEM_ERROR
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * returned error parameters
+   */
   errorArgs?: any[];
+  /**
+   * @remarks
+   * response data
+   */
   module?: GetAppInstanceTempShortUrlResponseBodyModule;
   /**
    * @remarks
@@ -83,12 +114,25 @@ export class GetAppInstanceTempShortUrlResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.ERROR
    */
   rootErrorCode?: string;
+  /**
+   * @remarks
+   * abnormal message
+   * 
+   * @example
+   * 系统异常
+   */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Reserved parameter.
+   * 
    * @example
    * True
    */

package/src/models/GetAppPluginConfigRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAppPluginConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * Customer business ID
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class GetAppPluginConfigRequest extends $dara.Model {
   bizId?: string;
   /**
    * @remarks
+   * Gateway plugin ID
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetAppPluginConfigResponseBody.ts

@@ -4,46 +4,73 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppPluginConfigResponseBodyModule extends $dara.Model {
   /**
+   * @remarks
+   * Business ID
+   * 
    * @example
    * WD20250703155602000001
    */
   bizId?: string;
   /**
+   * @remarks
+   * Creation Time
+   * 
    * @example
    * 1740479834
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * Updated At
+   * 
    * @example
    * 2025-08-28T02:25:41Z
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * Primary key
+   * 
    * @example
    * 16257
    */
   id?: number;
   /**
+   * @remarks
+   * Specific widget configuration, formatted as a JSON string. Refer to the utility class: com.alibaba.dataphin.pipeline.common.facade.openapi.model.plugin.OABasePluginConfig and the toJsonString method of its child classes. Developers should inherit this widget configuration class and implement the corresponding widget configuration. The structure of each widget configuration is identical to the MPS queue configuration structure created on the Dataphin Page.
+   * 
    * @example
    * {}
    */
   pluginConfig?: string;
   /**
+   * @remarks
+   * View Description
+   * 
    * @example
    * a simple test plugin
    */
   pluginDesc?: string;
   /**
+   * @remarks
+   * ID of the attached API Gateway plugin
+   * 
    * @example
    * 1bae9ceaceea432d91c7069fab0dfc02
    */
   pluginId?: string;
   /**
+   * @remarks
+   * Plugin Name. It can contain uppercase and lowercase English letters, Chinese characters, digits, and underscores (_). The length must be between 4 and 50 characters, and it cannot start with an underscore.
+   * 
    * @example
    * tf_testaccapigatewayplugin29311
    */
   pluginName?: string;
   /**
+   * @remarks
+   * User ID
+   * 
    * @example
    * 123
    */
@@ -87,15 +114,25 @@ export class GetAppPluginConfigResponseBodyModule extends $dara.Model {
 
 export class GetAppPluginConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * API status or POP error code
+   * 
    * @example
    * OK
    */
   code?: string;
   /**
+   * @remarks
+   * Additional information
+   * 
    * @example
    * Instance `wget h33E1En5.popscan.xaliyun.com` does not exist.
    */
   message?: string;
+  /**
+   * @remarks
+   * Response data
+   */
   module?: GetAppPluginConfigResponseBodyModule;
   /**
    * @remarks
@@ -106,6 +143,9 @@ export class GetAppPluginConfigResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded.
+   * 
    * @example
    * true
    */

package/src/models/GetAppPublishStatusRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppPublishStatusRequest extends $dara.Model {
   /**
+   * @remarks
+   * Business ID
+   * 
    * @example
    * WS20250731233102000001
    */
   bizId?: string;
   /**
+   * @remarks
+   * Deployment ticket ID
+   * 
    * @example
    * 4998717
    */
   deployOrderId?: number;
   /**
+   * @remarks
+   * Website domain name
+   * 
    * @example
    * www.aliyun.com
    */

package/src/models/GetAppPublishStatusResponseBody.ts

@@ -4,63 +4,106 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppPublishStatusResponseBodyModule extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether quick rollback is supported.
+   * 
    * @example
    * true
    */
   canQuickRevert?: string;
   /**
+   * @remarks
+   * Current operation step of the job.
+   * 
    * @example
    * PRE_CHECK
    */
   currentStep?: string;
   /**
+   * @remarks
+   * Deployment channel
+   * 
    * @example
    * PC,WEAPP
    */
   deployChannel?: string;
   /**
+   * @remarks
+   * Application description
+   * 
    * @example
    * /bak->serverless.handler(2020091300200279)
    */
   description?: string;
   /**
+   * @remarks
+   * Publishing procedure
+   * 
    * @example
    * abc
    */
   errorStep?: string;
+  /**
+   * @remarks
+   * Indicates whether the job is finished.
+   */
   isFinish?: boolean;
   /**
+   * @remarks
+   * Indicates whether the invocation succeeded. Valid values:
+   * 
+   * - `true`: The invocation succeeded.
+   * 
+   * - `false`: Failed to invoke.
+   * 
    * @example
    * True
    */
   isSuccess?: boolean;
   /**
+   * @remarks
+   * Additional description information.
+   * 
    * @example
    * common notify successfully.
    */
   msg?: string;
   /**
+   * @remarks
+   * Sorting type: ASC or DESC.
+   * 
    * @example
    * DESC
    */
   orderType?: string;
   /**
+   * @remarks
+   * Job completion percentage.
+   * 
    * @example
    * 20
    */
   percent?: number;
   /**
+   * @remarks
+   * Publish number
+   * 
    * @example
    * 123
    */
   publishNumber?: string;
   /**
+   * @remarks
+   * Publish order ID
+   * 
    * @example
    * 123
    */
   publishOrderId?: number;
   /**
    * @remarks
+   * Scheduled publish time
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ss.SSSZ
    * 
    * @example
@@ -68,11 +111,19 @@ export class GetAppPublishStatusResponseBodyModule extends $dara.Model {
    */
   publishTime?: string;
   /**
+   * @remarks
+   * The site ID, which can be obtained by invoking the [ListSites](~~ListSites~~) API.
+   * 
    * @example
    * 865181640657408
    */
   siteId?: string;
+  /**
+   * @remarks
+   * Error Level, including FATAL, ERROR, WARNING, and CRITICAL.
+   */
   steps?: string[];
+  subchannel?: string;
   static names(): { [key: string]: string } {
     return {
       canQuickRevert: 'CanQuickRevert',
@@ -90,6 +141,7 @@ export class GetAppPublishStatusResponseBodyModule extends $dara.Model {
       publishTime: 'PublishTime',
       siteId: 'SiteId',
       steps: 'Steps',
+      subchannel: 'Subchannel',
     };
   }
 
@@ -110,6 +162,7 @@ export class GetAppPublishStatusResponseBodyModule extends $dara.Model {
       publishTime: 'string',
       siteId: 'string',
       steps: { 'type': 'array', 'itemType': 'string' },
+      subchannel: 'string',
     };
   }
 
@@ -127,31 +180,54 @@ export class GetAppPublishStatusResponseBodyModule extends $dara.Model {
 
 export class GetAppPublishStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Detailed reason for access denial.
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * Is retry allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App name.
+   * 
    * @example
    * or
    */
   appName?: string;
   /**
+   * @remarks
+   * Dynamic error code.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * Dynamic message.
+   * 
    * @example
    * SYSTEM_ERROR
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * Returned error parameters
+   */
   errorArgs?: any[];
+  /**
+   * @remarks
+   * Response data
+   */
   module?: GetAppPublishStatusResponseBodyModule;
   /**
    * @remarks
@@ -162,12 +238,25 @@ export class GetAppPublishStatusResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.ERROR
    */
   rootErrorCode?: string;
+  /**
+   * @remarks
+   * Abnormal message
+   * 
+   * @example
+   * 系统异常
+   */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Reserved parameter.
+   * 
    * @example
    * True
    */

package/src/models/GetAppRecommendedCommoditiesRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppRecommendedCommoditiesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Application instance business ID (required in scenario 1, used to filter instance versions during query)
+   * 
    * @example
    * WD20250703155602000001
    */
@@ -11,6 +14,9 @@ export class GetAppRecommendedCommoditiesRequest extends $dara.Model {
   extend?: string;
   resourceConditions?: string;
   /**
+   * @remarks
+   * Scenarios: ai_chat | inspiration
+   * 
    * @example
    * DataworksManualTask
    */

package/src/models/GetAppRecommendedCommoditiesResponseBody.ts

@@ -4,32 +4,54 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppRecommendedCommoditiesResponseBodyModuleCommodities extends $dara.Model {
   /**
+   * @remarks
+   * Commodity code (used for both resource plans and Marketing Products)
+   * 
    * @example
    * rds
    */
   commodityCode?: string;
+  /**
+   * @remarks
+   * Extension fields (such as unsupportedReason)
+   */
   extend?: { [key: string]: string };
   /**
+   * @remarks
+   * Order Type: BUY - Purchase, UPGRADE - upgrade
+   * 
    * @example
    * DESC
    */
   orderType?: string;
   /**
+   * @remarks
+   * Sorting Priority (the smaller the number, the higher the priority)
+   * 
    * @example
    * 1
    */
   priority?: number;
   /**
+   * @remarks
+   * Marketing Product ID (returned only for new purchases)
+   * 
    * @example
    * 12345
    */
   promotionCommodityId?: string;
   /**
+   * @remarks
+   * Hyperlink URL (returned when a redirect is required, such as during an upgrade)
+   * 
    * @example
    * https://ecs-workbench-disposable.aliyun.com/account/disposable/login/sst/1291612921555690/edvo2gevfh
    */
   redirectUrl?: string;
   /**
+   * @remarks
+   * Product Status
+   * 
    * @example
    * Normal
    */
@@ -71,6 +93,10 @@ export class GetAppRecommendedCommoditiesResponseBodyModuleCommodities extends $
 }
 
 export class GetAppRecommendedCommoditiesResponseBodyModule extends $dara.Model {
+  /**
+   * @remarks
+   * Marketing product list
+   */
   commodities?: GetAppRecommendedCommoditiesResponseBodyModuleCommodities[];
   static names(): { [key: string]: string } {
     return {
@@ -98,31 +124,61 @@ export class GetAppRecommendedCommoditiesResponseBodyModule extends $dara.Model
 
 export class GetAppRecommendedCommoditiesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Detailed reason for access denial.
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * Indicates whether retry is allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App Name.
+   * 
    * @example
    * spring-cloud-b
    */
   appName?: string;
   /**
+   * @remarks
+   * Dynamic error code.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * Dynamic error message used to replace the `%s` placeholder in the **ErrMessage** error message.  
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, it means the provided request parameter **DtsJobId** is invalid.
+   * 
    * @example
    * SYSTEM_ERROR
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * Returned error parameters
+   */
   errorArgs?: any[];
+  /**
+   * @remarks
+   * Data table module.  
+   * 
+   * - ABTest: Experiment Data Table  
+   * 
+   * - ExperimentTool: Experiment Tool Table  
+   * 
+   * - DataDiagnosis: Data Diagnosis
+   */
   module?: GetAppRecommendedCommoditiesResponseBodyModule;
   /**
    * @remarks
@@ -133,12 +189,25 @@ export class GetAppRecommendedCommoditiesResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.ERROR
    */
   rootErrorCode?: string;
+  /**
+   * @remarks
+   * Abnormal message
+   * 
+   * @example
+   * 系统异常
+   */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Indicates whether processing is synchronous
+   * 
    * @example
    * True
    */

package/src/models/GetAppRequirementRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAppRequirementRequest extends $dara.Model {
   /**
+   * @remarks
+   * Session ID
+   * 
    * @example
    * 81bc5a34-1d8d-4ef7-a208-7401c51b054b
    */