@alicloud/websitebuild20250429 2.38.4 → 2.38.6

package/src/models/BrandKnowledgeDocument.ts

@@ -0,0 +1,218 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class BrandKnowledgeDocument extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether the content is sufficient to be considered for plan summary candidates.
+   */
+  contentSufficient?: boolean;
+  /**
+   * @remarks
+   * The MIME type of the file.
+   * 
+   * @example
+   * application/pdf
+   */
+  contentType?: string;
+  /**
+   * @remarks
+   * The creation time in Unix milliseconds.
+   * 
+   * @example
+   * 1735660800000
+   */
+  createdAt?: number;
+  /**
+   * @remarks
+   * Specifies whether deletion is currently allowed.
+   */
+  deletable?: boolean;
+  /**
+   * @remarks
+   * The display title.
+   * 
+   * @example
+   * Wanxiaozhi product introduction
+   */
+  displayTitle?: string;
+  /**
+   * @remarks
+   * The document category.
+   * 
+   * @example
+   * PRODUCT
+   */
+  docCategory?: string;
+  /**
+   * @remarks
+   * The ID of the brand knowledge document.
+   * 
+   * @example
+   * bkd_3f7a1c2e9b7d4a5f8c0e1d2b3a4c5d6e
+   */
+  documentId?: string;
+  /**
+   * @remarks
+   * The stable error code for main processing failures.
+   * 
+   * @example
+   * BRAND_KNOWLEDGE_PARSE_FAILED
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The desensitized error message for main processing failures.
+   * 
+   * @example
+   * Document parsing failed. Please re-upload
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The file size in bytes.
+   * 
+   * @example
+   * 1048576
+   */
+  fileSize?: number;
+  /**
+   * @remarks
+   * The summary keywords.
+   */
+  keyTopics?: string[];
+  /**
+   * @remarks
+   * The one-line summary, which is used only to construct search queries and cannot be used as factual evidence.
+   * 
+   * @example
+   * Introduces the product positioning and core capabilities of the Wanxiaozhi AI website building platform. It can be used as a reference for content topic selection
+   */
+  oneLineSummary?: string;
+  /**
+   * @remarks
+   * The original file name.
+   * 
+   * @example
+   * Wanxiaozhi product introduction.pdf
+   */
+  originalName?: string;
+  /**
+   * @remarks
+   * The ID of the business workspace. For GEO business workspaces of the brand marketing type, this is the appWorkspaceId.
+   * 
+   * @example
+   * d4e5f60718293a4b5c6d7e8f90a1b2c3
+   */
+  projectId?: string;
+  /**
+   * @remarks
+   * The time when the document is ready for reference, in Unix milliseconds.
+   * 
+   * @example
+   * 1735660900000
+   */
+  readyAt?: number;
+  /**
+   * @remarks
+   * The document processing status.
+   * 
+   * @example
+   * READY
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The message displayed on the status page.
+   * 
+   * @example
+   * Parsing completed and available for content plans
+   */
+  statusMessage?: string;
+  /**
+   * @remarks
+   * The stable error code for summary failures.
+   * 
+   * @example
+   * BRAND_KNOWLEDGE_SUMMARY_TIMEOUT
+   */
+  summaryErrorCode?: string;
+  /**
+   * @remarks
+   * The summary status.
+   * 
+   * @example
+   * SUCCEEDED
+   */
+  summaryStatus?: string;
+  /**
+   * @remarks
+   * The last update time in Unix milliseconds.
+   * 
+   * @example
+   * 1735660900000
+   */
+  updatedAt?: number;
+  static names(): { [key: string]: string } {
+    return {
+      contentSufficient: 'ContentSufficient',
+      contentType: 'ContentType',
+      createdAt: 'CreatedAt',
+      deletable: 'Deletable',
+      displayTitle: 'DisplayTitle',
+      docCategory: 'DocCategory',
+      documentId: 'DocumentId',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      fileSize: 'FileSize',
+      keyTopics: 'KeyTopics',
+      oneLineSummary: 'OneLineSummary',
+      originalName: 'OriginalName',
+      projectId: 'ProjectId',
+      readyAt: 'ReadyAt',
+      status: 'Status',
+      statusMessage: 'StatusMessage',
+      summaryErrorCode: 'SummaryErrorCode',
+      summaryStatus: 'SummaryStatus',
+      updatedAt: 'UpdatedAt',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      contentSufficient: 'boolean',
+      contentType: 'string',
+      createdAt: 'number',
+      deletable: 'boolean',
+      displayTitle: 'string',
+      docCategory: 'string',
+      documentId: 'string',
+      errorCode: 'string',
+      errorMessage: 'string',
+      fileSize: 'number',
+      keyTopics: { 'type': 'array', 'itemType': 'string' },
+      oneLineSummary: 'string',
+      originalName: 'string',
+      projectId: 'string',
+      readyAt: 'number',
+      status: 'string',
+      statusMessage: 'string',
+      summaryErrorCode: 'string',
+      summaryStatus: 'string',
+      updatedAt: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.keyTopics)) {
+      $dara.Model.validateArray(this.keyTopics);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CheckResourceMeasureRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckResourceMeasureRequest extends $dara.Model {
   /**
    * @remarks
-   * The owner ID, which can be a website ID or an Alibaba Cloud account ID.
+   * The ID of the owner, such as the website ID or Alibaba Cloud user ID.
    * 
    * @example
    * 123456
@@ -13,9 +13,7 @@ export class CheckResourceMeasureRequest extends $dara.Model {
   belongId?: string;
   /**
    * @remarks
-   * The type of the owner ID. Valid values:
-   * - siteId
-   * - uid.
+   * The type of the owner ID. Valid values: siteId and uid.
    * 
    * @example
    * USER
@@ -29,6 +27,14 @@ export class CheckResourceMeasureRequest extends $dara.Model {
    * 1
    */
   bizType?: string;
+  /**
+   * @remarks
+   * The desired total for APP_WORKSPACE. Valid values: 0 to 100000. If this parameter is specified, it takes precedence over ResourceValue and is not added to the existing usage. For new calls, you only need to specify ResourceValue. This parameter is not used for APP or USER.
+   * 
+   * @example
+   * 21
+   */
+  desiredTotal?: number;
   /**
    * @remarks
    * The ESP business ID.
@@ -39,7 +45,7 @@ export class CheckResourceMeasureRequest extends $dara.Model {
   espBizId?: string;
   /**
    * @remarks
-   * The order module information. If this parameter is empty, espBizId and bizType cannot be empty.
+   * The order component parameters. If this parameter is empty, EspBizId and BizType cannot be empty.
    * 
    * @example
    * {"siteversion":"test"}
@@ -55,9 +61,7 @@ export class CheckResourceMeasureRequest extends $dara.Model {
   resourceCode?: string;
   /**
    * @remarks
-   * The resource value. This parameter is empty by default and is required only for feature-type resources. Valid values:
-   * - 0: not supported
-   * - 1: supported.
+   * The resource value. This parameter is empty by default and is required only for feature resources. Valid values: 0: Not supported. 1: Supported.
    * 
    * @example
    * 1
@@ -68,6 +72,7 @@ export class CheckResourceMeasureRequest extends $dara.Model {
       belongId: 'BelongId',
       belongIdType: 'BelongIdType',
       bizType: 'BizType',
+      desiredTotal: 'DesiredTotal',
       espBizId: 'EspBizId',
       orderComponentParams: 'OrderComponentParams',
       resourceCode: 'ResourceCode',
@@ -80,6 +85,7 @@ export class CheckResourceMeasureRequest extends $dara.Model {
       belongId: 'string',
       belongIdType: 'string',
       bizType: 'string',
+      desiredTotal: 'number',
       espBizId: 'string',
       orderComponentParams: 'string',
       resourceCode: 'string',

package/src/models/CheckResourceMeasureResponseBody.ts

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CheckResourceMeasureResponseBodyModule extends $dara.Model {
   /**
    * @remarks
-   * The error code when the check fails. This value is null when the check passes.
+   * The desired total returned only for APP_WORKSPACE. This is the target total for the current check, which is the sum of the existing usage in the saved configuration and ResourceValue. If the compatible DesiredTotal is provided, this total is used directly. The existing usage of issues is the sum of common and word-of-mouth issues in the saved configuration, and the existing usage of competitors is the number of competitors. This parameter is empty for APP and USER checks.
+   * 
+   * @example
+   * 21
+   */
+  desiredTotal?: number;
+  /**
+   * @remarks
+   * The error code returned when the check fails. This parameter is null when the check passes.
    * 
    * @example
    * Success
@@ -13,12 +21,20 @@ export class CheckResourceMeasureResponseBodyModule extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message when the check fails. This value is null when the check passes.
+   * The error message returned when the check fails. This parameter is null when the check passes.
    * 
    * @example
    * stream push failed
    */
   errorMessage?: string;
+  /**
+   * @remarks
+   * The limit returned only for APP_WORKSPACE quantity pre-checks. This is the maximum number of issues or competitors allowed by the current commodity edition, not the remaining quota. This parameter is empty for APP and USER checks or when the edition benefits cannot be determined.
+   * 
+   * @example
+   * 20
+   */
+  limit?: number;
   /**
    * @remarks
    * Indicates whether the check is passed.
@@ -35,21 +51,35 @@ export class CheckResourceMeasureResponseBodyModule extends $dara.Model {
    * TransitRouterVpcAttachment
    */
   resourceCode?: string;
+  /**
+   * @remarks
+   * Indicates whether a purchasable higher edition that can accommodate the DesiredTotal exists. This parameter is true only when the capacity of the current edition is insufficient and a higher edition meets the requirements. Otherwise, this parameter is false. This parameter may be empty for APP and USER checks. This field does not indicate that an upgrade has been performed or an upgrade order has been created.
+   * 
+   * @example
+   * true
+   */
+  upgradeAvailable?: boolean;
   static names(): { [key: string]: string } {
     return {
+      desiredTotal: 'DesiredTotal',
       errorCode: 'ErrorCode',
       errorMessage: 'ErrorMessage',
+      limit: 'Limit',
       passed: 'Passed',
       resourceCode: 'ResourceCode',
+      upgradeAvailable: 'UpgradeAvailable',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      desiredTotal: 'number',
       errorCode: 'string',
       errorMessage: 'string',
+      limit: 'number',
       passed: 'boolean',
       resourceCode: 'string',
+      upgradeAvailable: 'boolean',
     };
   }
 
@@ -65,7 +95,7 @@ export class CheckResourceMeasureResponseBodyModule extends $dara.Model {
 export class CheckResourceMeasureResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The detailed reason why access was denied.
+   * The detailed reason for access denial.
    * 
    * @example
    * {}
@@ -73,7 +103,7 @@ export class CheckResourceMeasureResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * Indicates whether retry is allowed.
+   * Specifies whether retries are allowed.
    * 
    * @example
    * False
@@ -97,8 +127,8 @@ export class CheckResourceMeasureResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic error message, which is used to replace the `%s` placeholder in the **ErrMessage** response element.
-   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
+   * The dynamic error message, which is used to replace `%s` in the **ErrMessage** response parameter.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the **DtsJobId** request parameter is invalid.
    * 
    * @example
    * SYSTEM_ERROR
@@ -106,7 +136,7 @@ export class CheckResourceMeasureResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error parameters.
+   * The error parameters returned.
    */
   errorArgs?: any[];
   /**
@@ -124,7 +154,7 @@ export class CheckResourceMeasureResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The error code.
+   * The root error code.
    * 
    * @example
    * SYSTEM.ERROR
@@ -135,12 +165,12 @@ export class CheckResourceMeasureResponseBody extends $dara.Model {
    * The exception message.
    * 
    * @example
-   * 系统异常
+   * System exception
    */
   rootErrorMsg?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The backup parameter.
    * 
    * @example
    * True

package/src/models/CheckUserResourceMeasureRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckUserResourceMeasureRequest extends $dara.Model {
   /**
    * @remarks
-   * The owner ID, which can be a website ID or an Alibaba Cloud account ID.
+   * The belong ID, such as the website ID or Alibaba Cloud user ID.
    * 
    * @example
    * 123456
@@ -13,9 +13,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
   belongId?: string;
   /**
    * @remarks
-   * The type of the owner ID. Valid values:
-   * - siteId
-   * - uid.
+   * The belong ID type, such as siteId or uid.
    * 
    * @example
    * USER
@@ -29,6 +27,14 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
    * 1
    */
   bizType?: string;
+  /**
+   * @remarks
+   * The optional compatible total for APP_WORKSPACE. Valid values: 0 to 100000. If provided, it takes precedence over ResourceValue and does not repeatedly add the used quota. For new calls, only ResourceValue is required. This field is not used for APP/USER.
+   * 
+   * @example
+   * 21
+   */
+  desiredTotal?: number;
   /**
    * @remarks
    * The ESP business ID.
@@ -39,7 +45,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
   espBizId?: string;
   /**
    * @remarks
-   * The order module information. If this parameter is empty, espBizId and bizType cannot be empty.
+   * The order component information. If this field is empty, EspBizId and BizType cannot be empty.
    * 
    * @example
    * {"siteversion":"test"}
@@ -47,7 +53,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
   orderComponentParams?: string;
   /**
    * @remarks
-   * The resource identifier.
+   * The resource code.
    * 
    * @example
    * InspirationTokens
@@ -55,9 +61,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
   resourceCode?: string;
   /**
    * @remarks
-   * The resource value. This parameter is empty by default and is required only for feature-type resources. Valid values:
-   * - 0: Not supported.
-   * - 1: Supported.
+   * The resource value. Default is empty. Required only for feature resources. A value of 0 indicates not supported, and 1 indicates supported.
    * 
    * @example
    * 1
@@ -68,6 +72,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
       belongId: 'BelongId',
       belongIdType: 'BelongIdType',
       bizType: 'BizType',
+      desiredTotal: 'DesiredTotal',
       espBizId: 'EspBizId',
       orderComponentParams: 'OrderComponentParams',
       resourceCode: 'ResourceCode',
@@ -80,6 +85,7 @@ export class CheckUserResourceMeasureRequest extends $dara.Model {
       belongId: 'string',
       belongIdType: 'string',
       bizType: 'string',
+      desiredTotal: 'number',
       espBizId: 'string',
       orderComponentParams: 'string',
       resourceCode: 'string',

package/src/models/CheckUserResourceMeasureResponseBody.ts

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CheckUserResourceMeasureResponseBodyModule extends $dara.Model {
   /**
    * @remarks
-   * The error code when the check fails. This value is null when the check passes.
+   * Returned only for APP_WORKSPACE: the target total for this check, which is the used quota in the saved configuration plus ResourceValue. If the compatible DesiredTotal is provided, this total is used directly. The used quota for questions is the sum of common and word-of-mouth questions in the saved configuration. The used quota for competitors is the number of competitors. This field is empty for APP and USER checks.
+   * 
+   * @example
+   * 21
+   */
+  desiredTotal?: number;
+  /**
+   * @remarks
+   * The error code when the check fails. This field is null when the check passes.
    * 
    * @example
    * Success
@@ -13,12 +21,20 @@ export class CheckUserResourceMeasureResponseBodyModule extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message when the check fails. This value is null when the check passes.
+   * The error message when the check fails. This field is null when the check passes.
    * 
    * @example
    * stream push failed
    */
   errorMessage?: string;
+  /**
+   * @remarks
+   * Returned only for APP_WORKSPACE quantity dry runs: the maximum number of questions or competitors allowed by the current commodity edition, not the remaining quota. This field is empty for APP and USER checks or when the edition benefits cannot be determined.
+   * 
+   * @example
+   * 20
+   */
+  limit?: number;
   /**
    * @remarks
    * Indicates whether the check is passed.
@@ -29,27 +45,41 @@ export class CheckUserResourceMeasureResponseBodyModule extends $dara.Model {
   passed?: boolean;
   /**
    * @remarks
-   * The resource identifier.
+   * The resource code.
    * 
    * @example
    * TransitRouterVpcAttachment
    */
   resourceCode?: string;
+  /**
+   * @remarks
+   * Indicates whether a purchasable higher edition exists that can accommodate the DesiredTotal. This field is true only when the current edition capacity is insufficient and a higher edition meets the requirements. Otherwise, it is false. This field may be empty for APP and USER checks. This field does not indicate that an upgrade has been performed or an upgrade order has been created.
+   * 
+   * @example
+   * true
+   */
+  upgradeAvailable?: boolean;
   static names(): { [key: string]: string } {
     return {
+      desiredTotal: 'DesiredTotal',
       errorCode: 'ErrorCode',
       errorMessage: 'ErrorMessage',
+      limit: 'Limit',
       passed: 'Passed',
       resourceCode: 'ResourceCode',
+      upgradeAvailable: 'UpgradeAvailable',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      desiredTotal: 'number',
       errorCode: 'string',
       errorMessage: 'string',
+      limit: 'number',
       passed: 'boolean',
       resourceCode: 'string',
+      upgradeAvailable: 'boolean',
     };
   }
 
@@ -65,7 +95,7 @@ export class CheckUserResourceMeasureResponseBodyModule extends $dara.Model {
 export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The detailed reason why access is denied.
+   * The detailed reason for access denial.
    * 
    * @example
    * {}
@@ -73,9 +103,9 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   accessDeniedDetail?: string;
   /**
    * @remarks
-   * Indicates whether a retry is allowed. Valid values:
-   * - false: A retry is not allowed.
-   * - true: A retry is allowed.
+   * Specifies whether retries are allowed. Valid values:
+   * - false: Retries are not allowed.
+   * - true: Retries are allowed.
    * 
    * @example
    * False
@@ -83,7 +113,7 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   allowRetry?: boolean;
   /**
    * @remarks
-   * The application name. The application with this name is queried.
+   * The name of the application.
    * 
    * @example
    * spring-cloud-b
@@ -99,8 +129,8 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic error message, which is used to replace the `%s` placeholder in the **ErrMessage** response element.
-   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
+   * The dynamic error message, which is used to replace `%s` in the **ErrMessage** response parameter.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, it indicates that the **DtsJobId** request parameter is invalid.
    * 
    * @example
    * SYSTEM_ERROR
@@ -108,12 +138,12 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error parameters.
+   * The returned error arguments.
    */
   errorArgs?: any[];
   /**
    * @remarks
-   * The response object.
+   * The returned object.
    */
   module?: CheckUserResourceMeasureResponseBodyModule;
   /**
@@ -126,7 +156,7 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The error code.
+   * The root error code.
    * 
    * @example
    * SYSTEM.ERROR
@@ -134,15 +164,15 @@ export class CheckUserResourceMeasureResponseBody extends $dara.Model {
   rootErrorCode?: string;
   /**
    * @remarks
-   * The exception message.
+   * The root error message.
    * 
    * @example
-   * 系统异常
+   * System exception
    */
   rootErrorMsg?: string;
   /**
    * @remarks
-   * A reserved parameter.
+   * The backup parameter.
    * 
    * @example
    * True