@wix/auto_sdk_data_collections 1.0.24 → 1.0.26

package/build/cjs/index.d.ts

@@ -40,14 +40,18 @@ interface UpdateDataCollectionSignature {
      * 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 - Updated collection details. The existing collection is replaced with this version.
      * @param - Options for updating a data collection.
      * @returns Updated collection details.
@@ -59,8 +63,13 @@ interface DeleteDataCollectionSignature {
     /**
      * 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 - ID of the collection to delete.
      */
     (dataCollectionId: string): Promise<void>;
@@ -68,24 +77,27 @@ interface DeleteDataCollectionSignature {
 declare function createDataCollectionField$1(httpClient: HttpClient): CreateDataCollectionFieldSignature;
 interface CreateDataCollectionFieldSignature {
     /**
-     * Adds new field to data collection schema
-     * @param - ID of data collection to update
+     * Adds a new field to the structure of a data collection.
+     * @param - ID of the data collection to update.
      */
     (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>>;
 }
 declare function updateDataCollectionField$1(httpClient: HttpClient): UpdateDataCollectionFieldSignature;
 interface UpdateDataCollectionFieldSignature {
     /**
-     * Updates data collection field
-     * @param - ID of data collection to update
+     * Updates a field in the structure of a data collection.
+     * @param - ID of the data collection to update.
      */
     (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>>;
 }
 declare function deleteDataCollectionField$1(httpClient: HttpClient): DeleteDataCollectionFieldSignature;
 interface DeleteDataCollectionFieldSignature {
     /**
-     * Deletes data collection field
-     * @param - 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 - ID of the data collection to update.
      */
     (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>>;
 }

package/build/cjs/index.js

@@ -947,6 +947,7 @@ async function getDataCollection2(dataCollectionId, options) {
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     dataCollectionId,
     consistentRead: options?.consistentRead,
+    includeAllowedDataPermissions: options?.includeAllowedDataPermissions,
     fields: options?.fields
   });
   const reqOpts = getDataCollection(payload);
@@ -963,6 +964,7 @@ async function getDataCollection2(dataCollectionId, options) {
         explicitPathsToArguments: {
           dataCollectionId: "$[0]",
           consistentRead: "$[1].consistentRead",
+          includeAllowedDataPermissions: "$[1].includeAllowedDataPermissions",
           fields: "$[1].fields"
         },
         singleArgumentUnchanged: false
@@ -979,6 +981,7 @@ async function listDataCollections2(options) {
     sort: options?.sort,
     paging: options?.paging,
     consistentRead: options?.consistentRead,
+    includeAllowedDataPermissions: options?.includeAllowedDataPermissions,
     fields: options?.fields
   });
   const reqOpts = listDataCollections(payload);
@@ -996,6 +999,7 @@ async function listDataCollections2(options) {
           sort: "$[0].sort",
           paging: "$[0].paging",
           consistentRead: "$[0].consistentRead",
+          includeAllowedDataPermissions: "$[0].includeAllowedDataPermissions",
           fields: "$[0].fields"
         },
         singleArgumentUnchanged: false