@wix/autocms-collection-metadata-service 1.0.3 → 1.0.5

package/type-bundles/meta.bundle.d.ts

@@ -1,16 +1,16 @@
-/** CollectionMetadata contains CM-specific metadata for a collection */
+/** Contains the CMS metadata for the given collection. */
 interface CollectionMetadata$1 {
-    /** ID of data collection */
+    /** ID of the associated data collection. */
     dataCollectionId?: string;
-    /** active named view */
+    /** ID of the active named (custom) view. Learn more about [creating custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views) in the CMS. */
     activeNamedViewId?: string | null;
-    /** if table view should be hidden */
+    /** Whether to [hide the table layout view](https://support.wix.com/en/article/cms-setting-field-validations-in-your-collections#hiding-the-table-layout-to-prevent-empty-required-fields). Default: `false`. */
     hideTableView?: boolean | null;
-    /** named views */
+    /** List of [custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views). */
     namedViews?: Record<string, any>[] | null;
-    /** named view ID used for default site sort in datasets */
+    /** Custom view to mirror on the Wix site. Learn more about [mirroring item order to the site's connected elements](https://support.wix.com/en/article/cms-mirroring-the-order-of-items-in-your-collection-to-your-sites-connected-elements). */
     namedViewIdForSiteSort?: string | null;
-    /** Type of data permissions template used initially */
+    /** Collection permission template. Each collection has a permissions template that determines what Learn more about [collection permissions](https://support.wix.com/en/article/cms-changing-your-collection-permissions). */
     permissionsTemplate?: PermissionsTemplateType$1;
 }
 declare enum PermissionsTemplateType$1 {
@@ -20,48 +20,51 @@ declare enum PermissionsTemplateType$1 {
     CUSTOM = "CUSTOM"
 }
 interface CreateCollectionMetadataRequest$1 {
-    /** CollectionMetadata to be created */
+    /** Collection metadata details. */
     collectionMetadata: CollectionMetadata$1;
 }
 interface CreateCollectionMetadataResponse$1 {
-    /** The created CollectionMetadata */
+    /** Created collection metadata instance. */
     collectionMetadata?: CollectionMetadata$1;
 }
 interface GetCollectionMetadataRequest$1 {
-    /** Id of collection to retrieve metadata for */
+    /** ID of the collection for which to retrieve metadata. */
     dataCollectionId?: string;
 }
 interface GetCollectionMetadataResponse$1 {
-    /** The retrieved CollectionMetadata */
+    /** Retrieved collection metadata instance. */
     collectionMetadata?: CollectionMetadata$1;
 }
 interface UpdateCollectionMetadataRequest$1 {
     /**
-     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * TODO CLARIFY WHAT THIS MEANS:
+     * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
      * exists because of docs generation issue with nested fields and ** path variables
+     * TODO shouldn't this be required? // Yes
+     * ID of the collection for which to update metadata.
      */
     dataCollectionId?: string;
-    /** CollectionMetadata to be updated, may be partial */
+    /** Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged. */
     collectionMetadata: CollectionMetadata$1;
 }
 interface UpdateCollectionMetadataResponse$1 {
-    /** The updated CollectionMetadata */
+    /** Updated collection metadata instance. */
     collectionMetadata?: CollectionMetadata$1;
 }
 interface ReplaceCollectionMetadataRequest$1 {
-    /** The updated CollectionMetadatas */
+    /** Collection metadata to replace existing metadata. */
     items?: CollectionMetadata$1[];
 }
 interface ReplaceCollectionMetadataResponse$1 {
 }
 interface DeleteCollectionMetadataRequest$1 {
-    /** Id of collection to delete metadata for */
+    /** ID of the collection for which to delete metadata. */
     dataCollectionId?: string;
 }
 interface DeleteCollectionMetadataResponse$1 {
 }
 interface ListCollectionMetadataRequest$1 {
-    /** paging info */
+    /** Paging settings. */
     paging?: CursorPaging$1;
 }
 interface CursorPaging$1 {
@@ -76,9 +79,9 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface ListCollectionMetadataResponse$1 {
-    /** The retrieved CollectionMetadatas */
+    /** List of collection metadata instances. */
     items?: CollectionMetadata$1[];
-    /** paging metadata */
+    /** Paging information. */
     pagingMetadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
@@ -117,19 +120,19 @@ interface ListCollectionMetadataResponseNonNullableFields$1 {
     items: CollectionMetadataNonNullableFields$1[];
 }
 
-/** CollectionMetadata contains CM-specific metadata for a collection */
+/** Contains the CMS metadata for the given collection. */
 interface CollectionMetadata {
-    /** ID of data collection */
+    /** ID of the associated data collection. */
     dataCollectionId?: string;
-    /** active named view */
+    /** ID of the active named (custom) view. Learn more about [creating custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views) in the CMS. */
     activeNamedViewId?: string | null;
-    /** if table view should be hidden */
+    /** Whether to [hide the table layout view](https://support.wix.com/en/article/cms-setting-field-validations-in-your-collections#hiding-the-table-layout-to-prevent-empty-required-fields). Default: `false`. */
     hideTableView?: boolean | null;
-    /** named views */
+    /** List of [custom collection views](https://support.wix.com/en/article/cms-creating-custom-collection-views). */
     namedViews?: Record<string, any>[] | null;
-    /** named view ID used for default site sort in datasets */
+    /** Custom view to mirror on the Wix site. Learn more about [mirroring item order to the site's connected elements](https://support.wix.com/en/article/cms-mirroring-the-order-of-items-in-your-collection-to-your-sites-connected-elements). */
     namedViewIdForSiteSort?: string | null;
-    /** Type of data permissions template used initially */
+    /** Collection permission template. Each collection has a permissions template that determines what Learn more about [collection permissions](https://support.wix.com/en/article/cms-changing-your-collection-permissions). */
     permissionsTemplate?: PermissionsTemplateType;
 }
 declare enum PermissionsTemplateType {
@@ -139,48 +142,51 @@ declare enum PermissionsTemplateType {
     CUSTOM = "CUSTOM"
 }
 interface CreateCollectionMetadataRequest {
-    /** CollectionMetadata to be created */
+    /** Collection metadata details. */
     collectionMetadata: CollectionMetadata;
 }
 interface CreateCollectionMetadataResponse {
-    /** The created CollectionMetadata */
+    /** Created collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface GetCollectionMetadataRequest {
-    /** Id of collection to retrieve metadata for */
+    /** ID of the collection for which to retrieve metadata. */
     dataCollectionId?: string;
 }
 interface GetCollectionMetadataResponse {
-    /** The retrieved CollectionMetadata */
+    /** Retrieved collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface UpdateCollectionMetadataRequest {
     /**
-     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * TODO CLARIFY WHAT THIS MEANS:
+     * ID of metadata to update, ignored if **collection_metadata.data_collection_id** is non-empty // a technical workaround
      * exists because of docs generation issue with nested fields and ** path variables
+     * TODO shouldn't this be required? // Yes
+     * ID of the collection for which to update metadata.
      */
     dataCollectionId?: string;
-    /** CollectionMetadata to be updated, may be partial */
+    /** Collection metadata to update. Only the specified fields are affected. Fields not mentioned remain unchanged. */
     collectionMetadata: CollectionMetadata;
 }
 interface UpdateCollectionMetadataResponse {
-    /** The updated CollectionMetadata */
+    /** Updated collection metadata instance. */
     collectionMetadata?: CollectionMetadata;
 }
 interface ReplaceCollectionMetadataRequest {
-    /** The updated CollectionMetadatas */
+    /** Collection metadata to replace existing metadata. */
     items?: CollectionMetadata[];
 }
 interface ReplaceCollectionMetadataResponse {
 }
 interface DeleteCollectionMetadataRequest {
-    /** Id of collection to delete metadata for */
+    /** ID of the collection for which to delete metadata. */
     dataCollectionId?: string;
 }
 interface DeleteCollectionMetadataResponse {
 }
 interface ListCollectionMetadataRequest {
-    /** paging info */
+    /** Paging settings. */
     paging?: CursorPaging;
 }
 interface CursorPaging {
@@ -195,9 +201,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface ListCollectionMetadataResponse {
-    /** The retrieved CollectionMetadatas */
+    /** List of collection metadata instances. */
     items?: CollectionMetadata[];
-    /** paging metadata */
+    /** Paging information. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {