@wix/auto_sdk_data_collections 1.0.24 → 1.0.25

package/build/internal/cjs/index.typings.d.ts

@@ -1066,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 {
@@ -1526,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
@@ -1562,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
@@ -1574,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
@@ -1603,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
@@ -1627,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
@@ -1642,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
@@ -1661,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
@@ -1679,7 +1701,7 @@ 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;

package/build/internal/cjs/index.typings.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