@wix/auto_sdk_data_collections 1.0.23 → 1.0.25

package/build/internal/es/index.typings.d.mts

@@ -702,6 +702,38 @@ interface PluginCmsOptions {
     /** CMS sort, applied when a collection is displayed on a site. */
     siteSort?: SiteSort;
 }
+interface CatalogOptions {
+    /**
+     * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
+     * @maxLength 1000
+     */
+    name?: string;
+    /**
+     * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
+     * @maxLength 1000
+     */
+    price?: string;
+    /**
+     * the field key that contains the catalog item URL - field must be of type URL.
+     * @maxLength 1000
+     */
+    url?: string | null;
+    /**
+     * the field key that contains the catalog item description - field must be of type TEXT.
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * the field key that contains the catalog item image - field must be of type IMAGE.
+     * @maxLength 1000
+     */
+    image?: string | null;
+    /**
+     * the field key that contains the catalog item quantity - field must be of type NUMBER.
+     * @maxLength 1000
+     */
+    quantity?: string | null;
+}
 declare enum PagingMode {
     /** Offset-based paging. */
     OFFSET = "OFFSET",
@@ -1034,44 +1066,44 @@ interface RestoreDataCollectionResponse {
 }
 interface CreateDataCollectionFieldRequest {
     /**
-     * ID of data collection to update
+     * ID of the data collection to update.
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** field to create */
+    /** New field to add. */
     field: Field;
 }
 interface CreateDataCollectionFieldResponse {
-    /** updated data collection */
+    /** Updated data collection. */
     dataCollection?: DataCollection;
 }
 interface UpdateDataCollectionFieldRequest {
     /**
-     * ID of data collection to update
+     * ID of the data collection to update.
      * @maxLength 256
      */
     dataCollectionId: string;
-    /** Field to update */
+    /** Field to update. */
     field: Field;
 }
 interface UpdateDataCollectionFieldResponse {
-    /** updated data collection */
+    /** Updated data collection. */
     dataCollection?: DataCollection;
 }
 interface DeleteDataCollectionFieldRequest {
     /**
-     * ID of data collection to update
+     * ID of the data collection to update.
      * @maxLength 256
      */
     dataCollectionId: string;
     /**
-     * Field ID to delete
+     * ID of the field to delete.
      * @maxLength 1000
      */
     fieldKey: string;
 }
 interface DeleteDataCollectionFieldResponse {
-    /** updated data collection */
+    /** Updated data collection. */
     dataCollection?: DataCollection;
 }
 interface UpdateDataPermissionsRequest {
@@ -1494,6 +1526,11 @@ interface GetDataCollectionOptions {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -1530,6 +1567,11 @@ interface ListDataCollectionsOptions {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -1542,14 +1584,18 @@ interface ListDataCollectionsOptions {
  * Updates a data collection.
  *
  * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
- * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
+ * If a collection with that ID exists, and if its current `revision` number matches the one provided, it's updated.
  * Otherwise, the request fails.
  *
  * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
  *
- * > **Note:**
- * > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
- * > aren't included in the updated collection details, their values are lost.
+ * <blockquote class="important">
+ * <strong>Important:</strong>
+ * After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection
+ * has properties with values and those properties aren't included in the updated collection details, their values are lost.<br/><br/>
+ *
+ * To update a single field, use the Update Data Collection Field method.
+ * </blockquote>
  * @param collection - Updated collection details. The existing collection is replaced with this version.
  * @public
  * @requiredField collection
@@ -1571,8 +1617,13 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
 /**
  * Deletes a data collection.
  *
+ * Before deleting a collection:
+ * - Make sure the collection isn't connected to any site pages or elements.
+ * - You can create a manual backup of a collections with the Backups API, in case you need to restore them later.
+ * - You can also export a collection to a CSV file with the Data Movement Jobs API, if you want to save the data outside of Wix.
+ *
  * > **Note:**
- * > Once a collection is deleted, it can only be restored for limited amount of time.
+ * > Once a collection is deleted, it can only be restored for a limited amount of time.
  * @param dataCollectionId - ID of the collection to delete.
  * @public
  * @requiredField dataCollectionId
@@ -1595,8 +1646,8 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
  */
 declare function restoreDataCollection(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 /**
- * Adds new field to data collection schema
- * @param dataCollectionId - ID of data collection to update
+ * Adds a new field to the structure of a data collection.
+ * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -1610,12 +1661,12 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
  */
 declare function createDataCollectionField(dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 3>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 interface CreateDataCollectionFieldOptions {
-    /** field to create */
+    /** New field to add. */
     field: Field;
 }
 /**
- * Updates data collection field
- * @param dataCollectionId - ID of data collection to update
+ * Updates a field in the structure of a data collection.
+ * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -1629,12 +1680,15 @@ interface CreateDataCollectionFieldOptions {
  */
 declare function updateDataCollectionField(dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field` | `field.key` | `field.type`, 3>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 interface UpdateDataCollectionFieldOptions {
-    /** Field to update */
+    /** Field to update. */
     field: Field;
 }
 /**
- * Deletes data collection field
- * @param dataCollectionId - ID of data collection to update
+ * Deletes a field from the structure of a data collection.
+ *
+ * When a field is deleted, all values associated with that field are also deleted
+ * from all items in the collection.
+ * @param dataCollectionId - ID of the data collection to update.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -1647,10 +1701,10 @@ interface UpdateDataCollectionFieldOptions {
 declare function deleteDataCollectionField(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`, 2>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
 interface DeleteDataCollectionFieldOptions {
     /**
-     * Field ID to delete
+     * ID of the field to delete.
      * @maxLength 1000
      */
     fieldKey: string;
 }
 
-export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AllowedDataPermissions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CmsOptions, type CollectionCapabilities, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UrlizedOnlyPattern, type UrlizedPluginOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Object, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, getDataCollection, listDataCollections, restoreDataCollection, updateDataCollection, updateDataCollectionField };
+export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AllowedDataPermissions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type Permissions, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UrlizedOnlyPattern, type UrlizedPluginOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Object, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, getDataCollection, listDataCollections, restoreDataCollection, updateDataCollection, updateDataCollectionField };

package/build/internal/es/index.typings.mjs

@@ -897,6 +897,7 @@ async function getDataCollection2(dataCollectionId, options) {
   const payload = renameKeysFromSDKRequestToRESTRequest({
     dataCollectionId,
     consistentRead: options?.consistentRead,
+    includeAllowedDataPermissions: options?.includeAllowedDataPermissions,
     fields: options?.fields
   });
   const reqOpts = getDataCollection(payload);
@@ -913,6 +914,7 @@ async function getDataCollection2(dataCollectionId, options) {
         explicitPathsToArguments: {
           dataCollectionId: "$[0]",
           consistentRead: "$[1].consistentRead",
+          includeAllowedDataPermissions: "$[1].includeAllowedDataPermissions",
           fields: "$[1].fields"
         },
         singleArgumentUnchanged: false
@@ -929,6 +931,7 @@ async function listDataCollections2(options) {
     sort: options?.sort,
     paging: options?.paging,
     consistentRead: options?.consistentRead,
+    includeAllowedDataPermissions: options?.includeAllowedDataPermissions,
     fields: options?.fields
   });
   const reqOpts = listDataCollections(payload);
@@ -946,6 +949,7 @@ async function listDataCollections2(options) {
           sort: "$[0].sort",
           paging: "$[0].paging",
           consistentRead: "$[0].consistentRead",
+          includeAllowedDataPermissions: "$[0].includeAllowedDataPermissions",
           fields: "$[0].fields"
         },
         singleArgumentUnchanged: false