@alicloud/cms20240330 9.2.2 → 10.0.0

package/src/models/ListAlertWebhooksResponseBody.ts

@@ -4,39 +4,69 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAlertWebhooksResponseBodyWebhooks extends $dara.Model {
   /**
+   * @remarks
+   * The content type of the data. Valid values:
+   * 
+   * - JSON
+   * 
+   * - FORM
+   * 
    * @example
    * JSON
    */
   contentType?: string;
   /**
    * @remarks
-   * headers
+   * The headers.
    * 
    * @example
    * key
    */
   headers?: { [key: string]: any };
   /**
+   * @remarks
+   * The language. Valid values:
+   * 
+   * - zh_CN
+   * 
+   * - en_US
+   * 
    * @example
    * zh_CN
    */
   lang?: string;
   /**
+   * @remarks
+   * The request method. Valid values:
+   * 
+   * - GET
+   * 
+   * - POST
+   * 
    * @example
    * GET
    */
   method?: string;
   /**
+   * @remarks
+   * The name of the webhook.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The URL of the alert callback.
+   * 
    * @example
    * http://aliyun.com/test
    */
   url?: string;
   /**
+   * @remarks
+   * The unique ID of the webhook.
+   * 
    * @example
    * test
    */
@@ -82,28 +112,40 @@ export class ListAlertWebhooksResponseBodyWebhooks extends $dara.Model {
 
 export class ListAlertWebhooksResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The page number. The default value is 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8A33DBEA-*****-*****-*****-*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 8
    */
   total?: number;
   /**
    * @remarks
-   * webhooks
+   * The webhooks.
    */
   webhooks?: ListAlertWebhooksResponseBodyWebhooks[];
   static names(): { [key: string]: string } {

package/src/models/ListAlertWebhooksShrinkRequest.ts

@@ -4,20 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAlertWebhooksShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the webhook.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The unique ID of the webhook.
+   */
   webhookIdsShrink?: string;
   workspace?: string;
   static names(): { [key: string]: string } {

package/src/models/ListBizTracesRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListBizTracesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The maximum number of results to return. The maximum value is 100.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next page of results.
+   * 
    * @example
    * aa9d0e569b88098a0e3155c29b473201a
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The name of the workspace.
+   * 
    * @example
    * default-cms-xxxxxx-cn-beijing
    */

package/src/models/ListBizTracesResponseBody.ts

@@ -4,23 +4,39 @@ import { BizTraceConfig } from "./BizTraceConfig";
 
 
 export class ListBizTracesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of business traces.
+   */
   items?: BizTraceConfig[];
   /**
+   * @remarks
+   * The maximum number of results returned. The maximum value is 100.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token to use to retrieve the next page of results.
+   * 
    * @example
    * aa9d0e569b88098a0e3155c29b473201a
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 66
    */

package/src/models/ListContactGroupsRequest.ts

@@ -3,18 +3,31 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListContactGroupsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The contact group IDs.
+   */
   contactGroupIds?: string[];
   /**
+   * @remarks
+   * The name of the contact group.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The page number. The default is 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return per page. The default is 100.
+   * 
    * @example
    * 20
    */

package/src/models/ListContactGroupsResponseBody.ts

@@ -4,12 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContactGroupsResponseBodyContactGroups extends $dara.Model {
   /**
+   * @remarks
+   * The contact group ID.
+   * 
    * @example
    * test
    */
   contactGroupId?: string;
+  /**
+   * @remarks
+   * The contact IDs in the group.
+   * 
+   * @example
+   * ["Demo meeting"]
+   */
   contactIds?: string[];
   /**
+   * @remarks
+   * The name of the contact group.
+   * 
    * @example
    * test
    */
@@ -46,26 +59,39 @@ export class ListContactGroupsResponseBodyContactGroups extends $dara.Model {
 }
 
 export class ListContactGroupsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of contact groups.
+   */
   contactGroups?: ListContactGroupsResponseBodyContactGroups[];
   /**
+   * @remarks
+   * The returned page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 15
    */

package/src/models/ListContactGroupsShrinkRequest.ts

@@ -3,18 +3,31 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListContactGroupsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The contact group IDs.
+   */
   contactGroupIdsShrink?: string;
   /**
+   * @remarks
+   * The name of the contact group.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The page number. The default is 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return per page. The default is 100.
+   * 
    * @example
    * 20
    */

package/src/models/ListContactsRequest.ts

@@ -3,38 +3,71 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListContactsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The contact IDs.
+   */
   contactIds?: string[];
   /**
+   * @remarks
+   * The email address of the contact.
+   * 
    * @example
    * test@aliyun.com
    */
   email?: string;
+  /**
+   * @remarks
+   * The ID of the contact group.
+   * 
+   * @example
+   * group-id-123
+   */
   groupId?: string;
   /**
+   * @remarks
+   * The contact name.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 100.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The mobile number of the contact.
+   * 
    * @example
    * 15012345678
    */
   phone?: string;
   /**
+   * @remarks
+   * Specifies whether to query only ungrouped contacts.
+   * 
    * @example
    * true
    */
   queryUngroupedContacts?: boolean;
+  /**
+   * @remarks
+   * The workspace ID.
+   */
   workspace?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListContactsResponseBody.ts

@@ -4,43 +4,75 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContactsResponseBodyContacts extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the contact.
+   * 
    * @example
    * test
    */
   contactId?: string;
   /**
+   * @remarks
+   * The email address of the contact.
+   * 
    * @example
    * test@aliyun.com
    */
   email?: string;
   /**
+   * @remarks
+   * Indicates whether the email address is verified.
+   * 
    * @example
    * true
    */
   emailVerify?: boolean;
+  /**
+   * @remarks
+   * A list of contact group IDs to which the contact belongs.
+   */
   groupList?: string[];
+  /**
+   * @remarks
+   * A map of user IDs for various instant messaging (IM) tools.
+   */
   imUserIds?: { [key: string]: string };
   /**
+   * @remarks
+   * The language preference for notifications. Valid values: zh-CN and en-US.
+   * 
    * @example
    * zh_CN
    */
   lang?: string;
   /**
+   * @remarks
+   * The name of the contact.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The phone number of the contact.
+   * 
    * @example
    * 130123456789
    */
   phone?: string;
   /**
+   * @remarks
+   * Indicates whether the phone number is verified.
+   * 
    * @example
    * true
    */
   phoneVerify?: boolean;
   /**
+   * @remarks
+   * The last time the contact was updated.
+   * 
    * @example
    * 2024-10-22 02:21:51
    */
@@ -94,26 +126,39 @@ export class ListContactsResponseBodyContacts extends $dara.Model {
 }
 
 export class ListContactsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of contacts.
+   */
   contacts?: ListContactsResponseBodyContacts[];
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 100.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 56
    */

package/src/models/ListContactsShrinkRequest.ts

@@ -3,38 +3,71 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListContactsShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The contact IDs.
+   */
   contactIdsShrink?: string;
   /**
+   * @remarks
+   * The email address of the contact.
+   * 
    * @example
    * test@aliyun.com
    */
   email?: string;
+  /**
+   * @remarks
+   * The ID of the contact group.
+   * 
+   * @example
+   * group-id-123
+   */
   groupId?: string;
   /**
+   * @remarks
+   * The contact name.
+   * 
    * @example
    * test
    */
   name?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 100.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The mobile number of the contact.
+   * 
    * @example
    * 15012345678
    */
   phone?: string;
   /**
+   * @remarks
+   * Specifies whether to query only ungrouped contacts.
+   * 
    * @example
    * true
    */
   queryUngroupedContacts?: boolean;
+  /**
+   * @remarks
+   * The workspace ID.
+   */
   workspace?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListContextStoreApikeysRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContextStoreAPIKeysRequest extends $dara.Model {
   /**
+   * @remarks
+   * The maximum number of entries to return in a single request. If this parameter is not specified, the service returns a default number of entries.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token used to retrieve the next page of results. Leave this parameter empty to retrieve the first page.
+   * 
    * @example
    * 615dfe7fd00f699ea94d5e63ba564aaf22450858c58f1387cc78f883b2254ab47232ce40fa95d9cb
    */

package/src/models/ListContextStoreApikeysResponseBody.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContextStoreAPIKeysResponseBodyResults extends $dara.Model {
   /**
+   * @remarks
+   * The complete API key value.
+   * 
    * @example
    * sk-3ac8d45d741e4f31b81aa6ee984ce9fd
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The name of the context store.
+   * 
    * @example
    * test-context-Store
    */
   contextStoreName?: string;
   /**
    * @remarks
+   * The time when the API key was created, represented as a Unix timestamp.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -22,11 +30,17 @@ export class ListContextStoreAPIKeysResponseBodyResults extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The display name of the API key. This name helps you identify the purpose of the key.
+   * 
    * @example
    * Production Service Key
    */
   name?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * test-workspace
    */
@@ -62,22 +76,38 @@ export class ListContextStoreAPIKeysResponseBodyResults extends $dara.Model {
 
 export class ListContextStoreAPIKeysResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The maximum number of entries returned per page.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * A pagination token. To retrieve the next page of results, include this value in the `nextToken` parameter of your next request. If this parameter is not returned, there are no more results.
+   * 
    * @example
    * xCs4wJD41qEejNkappMSJ1OL2Ky2GeKLqmBLJrC61WrgUOj9F-31jHbo5Kgqzifv
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of API keys.
+   */
   results?: ListContextStoreAPIKeysResponseBodyResults[];
   /**
+   * @remarks
+   * The total count of entries that match the query.
+   * 
    * @example
    * 454
    */