@wix/auto_sdk_data_collections 1.0.14 → 1.0.16

package/build/internal/cjs/{data-v2-data-collection-collections.universal-DZ3_N2Cv.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /** A data collection determines the structure of data to be stored in a database. */
 interface DataCollection {
     /**
@@ -853,6 +855,8 @@ declare enum Segment {
     PUBLIC = "PUBLIC",
     DEV = "DEV"
 }
+/** @enumType */
+type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
 interface GetDataCollectionResponse {
     /** Details of the collection requested. */
     collection?: DataCollection;
@@ -1429,6 +1433,41 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type DataCollectionNonNullablePaths = `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.typeMetadata.pageLink.calculator.fieldsPattern.pattern` | `fields.${number}.typeMetadata.pageLink.calculator.fieldsPattern.lowercase` | `fields.${number}.typeMetadata.pageLink.calculator.urlizedOnlyPattern.pattern` | `fields.${number}.systemField` | `fields.${number}.encrypted` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes`;
+/**
+ * Creates a new data collection.
+ *
+ * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
+ * @param collection - Collection details.
+ * @public
+ * @requiredField collection
+ * @requiredField collection._id
+ * @requiredField collection.fields.key
+ * @requiredField collection.fields.type
+ * @requiredField collection.permissions.insert
+ * @requiredField collection.permissions.read
+ * @requiredField collection.permissions.remove
+ * @requiredField collection.permissions.update
+ * @param options - Options for creating a data collection.
+ * @permissionId WIX_DATA.CREATE_COLLECTION
+ * @applicableIdentity APP
+ * @returns Details of collection created.
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
+ */
+declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`>): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
+/**
+ * Retrieves a data collection by ID.
+ * @param dataCollectionId - ID of the collection to retrieve.
+ * @public
+ * @requiredField dataCollectionId
+ * @param options - Options for retrieving a data collection.
+ * @permissionId WIX_DATA.GET_COLLECTION
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Details of the collection requested.
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
+ */
+declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
 interface GetDataCollectionOptions {
     /**
      * Whether to retrieve data from the primary database instance.
@@ -1446,6 +1485,19 @@ interface GetDataCollectionOptions {
      */
     fields?: string[];
 }
+/**
+ * Retrieves a list of all data collections associated with the site or project.
+ *
+ * By default, the list is ordered by ID in ascending order.
+ * @public
+ * @param options - Options for retrieving a list of data collections.
+ * @permissionId WIX_DATA.LIST_COLLECTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.ListDataCollections
+ */
+declare function listDataCollections(options?: ListDataCollectionsOptions): Promise<NonNullablePaths<ListDataCollectionsResponse, {
+    [P in DataCollectionNonNullablePaths]: `collections.${number}.${P}`;
+}[DataCollectionNonNullablePaths]>>;
 interface ListDataCollectionsOptions {
     /**
      * Defines how collections in the response are sorted.
@@ -1471,14 +1523,117 @@ interface ListDataCollectionsOptions {
      */
     fields?: string[];
 }
+/**
+ * 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.
+ * 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.
+ * @param collection - Updated collection details. The existing collection is replaced with this version.
+ * @public
+ * @requiredField collection
+ * @requiredField collection._id
+ * @requiredField collection.fields.key
+ * @requiredField collection.fields.type
+ * @requiredField collection.permissions.insert
+ * @requiredField collection.permissions.read
+ * @requiredField collection.permissions.remove
+ * @requiredField collection.permissions.update
+ * @requiredField collection.revision
+ * @param options - Options for updating a data collection.
+ * @permissionId WIX_DATA.UPDATE_COLLECTION
+ * @applicableIdentity APP
+ * @returns Updated collection details.
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollection
+ */
+declare function updateDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update` | `revision`>): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
+/**
+ * Deletes a data collection.
+ *
+ * > **Note:**
+ * > Once a collection is deleted, it can only be restored for limited amount of time.
+ * @param dataCollectionId - ID of the collection to delete.
+ * @public
+ * @requiredField dataCollectionId
+ * @permissionId WIX_DATA.DELETE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollection
+ */
+declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
+/**
+ * Restores recently deleted collection.
+ *
+ * Fails with `WDE0025` if collection was deleted too long ago or has never existed.
+ * @param dataCollectionId - Data Collection ID to restore
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @permissionId WIX_DATA.CREATE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection
+ */
+declare function restoreDataCollection(dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, {
+    [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+}[DataCollectionNonNullablePaths]>>;
+/**
+ * Adds new field to data collection schema
+ * @param dataCollectionId - ID of data collection to update
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField options
+ * @requiredField options.field
+ * @permissionId WIX_DATA.CREATE_COLLECTION_FIELD
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollectionField
+ */
+declare function createDataCollectionField(dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field`>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, {
+    [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+}[DataCollectionNonNullablePaths]>>;
 interface CreateDataCollectionFieldOptions {
     /** field to create */
     field: Field;
 }
+/**
+ * Updates data collection field
+ * @param dataCollectionId - ID of data collection to update
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField options
+ * @requiredField options.field
+ * @permissionId WIX_DATA.UPDATE_COLLECTION_FIELD
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDataCollectionField
+ */
+declare function updateDataCollectionField(dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field`>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, {
+    [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+}[DataCollectionNonNullablePaths]>>;
 interface UpdateDataCollectionFieldOptions {
     /** Field to update */
     field: Field;
 }
+/**
+ * Deletes data collection field
+ * @param dataCollectionId - ID of data collection to update
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField options
+ * @requiredField options.fieldKey
+ * @permissionId WIX_DATA.DELETE_COLLECTION_FIELD
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionField
+ */
+declare function deleteDataCollectionField(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, {
+    [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+}[DataCollectionNonNullablePaths]>>;
 interface DeleteDataCollectionFieldOptions {
     /**
      * Field ID to delete
@@ -1487,4 +1642,4 @@ interface DeleteDataCollectionFieldOptions {
     fieldKey: string;
 }
 
-export { type FieldPluginOptionsOneOf as $, AccessLevel as A, type UrlizedOnlyPattern as B, type CreateDataCollectionFieldOptions as C, type DataCollection as D, type Calculator as E, FieldPluginType as F, type GetDataCollectionOptions as G, type CalculatorPatternOneOf as H, IndexStatus as I, type Reference as J, type _Array as K, type ListDataCollectionsOptions as L, type MultiReference as M, type PageLink as N, Order as O, PluginType as P, QueryOperator as Q, type RestoreDataCollectionResponse as R, Status as S, Type as T, type UpdateDataCollectionFieldOptions as U, type NumberRange as V, WebhookIdentityType as W, type StringLengthRange as X, type ArraySizeRange as Y, type FieldPlugin as Z, type _Object as _, type ListDataCollectionsResponse as a, type IdentificationDataIdOneOf as a$, type CmsOptions as a0, type Permissions as a1, type Plugin as a2, type PluginOptionsOneOf as a3, type SiteSort as a4, type PublishPluginOptions as a5, type SingleItemPluginOptions as a6, type UrlizedPluginOptions as a7, type MultilingualOptions as a8, type PageLinkPluginOptions as a9, type UpdateDataPermissionsRequest as aA, type UpdateDataPermissionsResponse as aB, type BulkGetDataCollectionsPageBySnapshotsRequest as aC, type BulkGetDataCollectionsPageBySnapshotsResponse as aD, type SnapshotCollection as aE, type Index as aF, type IndexField as aG, type Failure as aH, type CreateDataCollectionsSnapshotRequest as aI, type CreateDataCollectionsSnapshotResponse as aJ, type RestoreDataCollectionsFromSnapshotRequest as aK, type Destination as aL, type RestorationCollection as aM, type RestoreDataCollectionsFromSnapshotResponse as aN, type DeleteDataCollectionsSnapshotRequest as aO, type DeleteDataCollectionsSnapshotResponse as aP, type CreateMigratedCollectionsSnapshotRequest as aQ, type CreateMigratedCollectionsSnapshotResponse as aR, type DomainEvent as aS, type DomainEventBodyOneOf as aT, type EntityCreatedEvent as aU, type RestoreInfo as aV, type EntityUpdatedEvent as aW, type EntityDeletedEvent as aX, type ActionEvent as aY, type MessageEnvelope as aZ, type IdentificationData as a_, type PluginCmsOptions as aa, type DataPermissions as ab, type AllowedDataPermissions as ac, type DataCollectionClonedEvent as ad, type DataCollectionChangedEvent as ae, type FieldUpdate as af, type PluginUpdate as ag, type DataCollectionEvictedEvent as ah, type CreateDataCollectionRequest as ai, type CreateDataCollectionResponse as aj, type GetDataCollectionRequest as ak, type GetDataCollectionResponse as al, type ListDataCollectionsRequest as am, type Sorting as an, type Paging as ao, type PagingMetadataV2 as ap, type BulkGetDataCollectionsRequest as aq, type BulkGetDataCollectionsResponse as ar, type UpdateDataCollectionRequest as as, type UpdateDataCollectionResponse as at, type DeleteDataCollectionRequest as au, type DeleteDataCollectionResponse as av, type RestoreDataCollectionRequest as aw, type CreateDataCollectionFieldRequest as ax, type UpdateDataCollectionFieldRequest as ay, type DeleteDataCollectionFieldRequest as az, type CreateDataCollectionFieldResponse as b, type UpdateDataCollectionFieldResponse as c, type DeleteDataCollectionFieldOptions as d, type DeleteDataCollectionFieldResponse as e, CollectionType as f, Direction as g, DataOperation as h, CollectionOperation as i, Role as j, Format as k, PagingMode as l, Segment as m, SortOrder as n, IndexSource as o, type Sort as p, type CollectionCapabilities as q, type IndexLimits as r, type IndexQuotaLimits as s, type Field as t, type FieldRangeValidationsOneOf as u, type TypeMetadata as v, type TypeMetadataMetadataOneOf as w, type FieldCapabilities as x, type ObjectField as y, type FieldsPattern as z };
+export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AllowedDataPermissions, 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 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 };