@wix/auto_sdk_data_collections 1.0.15 → 1.0.17

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

@@ -1,7 +1,8 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { DataCollection, GetDataCollectionOptions, ListDataCollectionsOptions, ListDataCollectionsResponse, RestoreDataCollectionResponse, CreateDataCollectionFieldOptions, CreateDataCollectionFieldResponse, UpdateDataCollectionFieldOptions, UpdateDataCollectionFieldResponse, DeleteDataCollectionFieldOptions, DeleteDataCollectionFieldResponse } from './index.typings.mjs';
 export { AccessLevel, ActionEvent, AllowedDataPermissions, ArraySizeRange, BulkGetDataCollectionsPageBySnapshotsRequest, BulkGetDataCollectionsPageBySnapshotsResponse, BulkGetDataCollectionsRequest, BulkGetDataCollectionsResponse, Calculator, CalculatorPatternOneOf, CmsOptions, CollectionCapabilities, CollectionOperation, CollectionType, CreateDataCollectionFieldRequest, CreateDataCollectionRequest, CreateDataCollectionResponse, CreateDataCollectionsSnapshotRequest, CreateDataCollectionsSnapshotResponse, CreateMigratedCollectionsSnapshotRequest, CreateMigratedCollectionsSnapshotResponse, DataCollectionChangedEvent, DataCollectionClonedEvent, DataCollectionEvictedEvent, DataOperation, DataPermissions, DeleteDataCollectionFieldRequest, DeleteDataCollectionRequest, DeleteDataCollectionResponse, DeleteDataCollectionsSnapshotRequest, DeleteDataCollectionsSnapshotResponse, Destination, Direction, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Failure, Field, FieldCapabilities, FieldPlugin, FieldPluginOptionsOneOf, FieldPluginType, FieldRangeValidationsOneOf, FieldUpdate, FieldsPattern, Format, GetDataCollectionRequest, GetDataCollectionResponse, IdentificationData, IdentificationDataIdOneOf, Index, IndexField, IndexLimits, IndexQuotaLimits, IndexSource, IndexStatus, ListDataCollectionsRequest, MessageEnvelope, MultiReference, MultilingualOptions, NumberRange, ObjectField, Order, PageLink, PageLinkPluginOptions, Paging, PagingMetadataV2, PagingMode, Permissions, Plugin, PluginCmsOptions, PluginOptionsOneOf, PluginType, PluginUpdate, PublishPluginOptions, QueryOperator, Reference, RestorationCollection, RestoreDataCollectionRequest, RestoreDataCollectionsFromSnapshotRequest, RestoreDataCollectionsFromSnapshotResponse, RestoreInfo, Role, Segment, SingleItemPluginOptions, SiteSort, SnapshotCollection, Sort, SortOrder, Sorting, Status, StringLengthRange, Type, TypeMetadata, TypeMetadataMetadataOneOf, UpdateDataCollectionFieldRequest, UpdateDataCollectionRequest, UpdateDataCollectionResponse, UpdateDataPermissionsRequest, UpdateDataPermissionsResponse, UrlizedOnlyPattern, UrlizedPluginOptions, WebhookIdentityType, _Array, _Object } from './index.typings.mjs';
 
+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`;
 declare function createDataCollection$1(httpClient: HttpClient): CreateDataCollectionSignature;
 interface CreateDataCollectionSignature {
     /**
@@ -12,7 +13,7 @@ interface CreateDataCollectionSignature {
      * @param - Options for creating a data collection.
      * @returns Details of collection created.
      */
-    (collection: DataCollection): Promise<DataCollection>;
+    (collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`>): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
 }
 declare function getDataCollection$1(httpClient: HttpClient): GetDataCollectionSignature;
 interface GetDataCollectionSignature {
@@ -22,7 +23,7 @@ interface GetDataCollectionSignature {
      * @param - Options for retrieving a data collection.
      * @returns Details of the collection requested.
      */
-    (dataCollectionId: string, options?: GetDataCollectionOptions | undefined): Promise<DataCollection>;
+    (dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
 }
 declare function listDataCollections$1(httpClient: HttpClient): ListDataCollectionsSignature;
 interface ListDataCollectionsSignature {
@@ -32,7 +33,9 @@ interface ListDataCollectionsSignature {
      * By default, the list is ordered by ID in ascending order.
      * @param - Options for retrieving a list of data collections.
      */
-    (options?: ListDataCollectionsOptions | undefined): Promise<ListDataCollectionsResponse>;
+    (options?: ListDataCollectionsOptions): Promise<NonNullablePaths<ListDataCollectionsResponse, {
+        [P in DataCollectionNonNullablePaths]: `collections.${number}.${P}`;
+    }[DataCollectionNonNullablePaths]>>;
 }
 declare function updateDataCollection$1(httpClient: HttpClient): UpdateDataCollectionSignature;
 interface UpdateDataCollectionSignature {
@@ -52,7 +55,7 @@ interface UpdateDataCollectionSignature {
      * @param - Options for updating a data collection.
      * @returns Updated collection details.
      */
-    (collection: DataCollection): Promise<DataCollection>;
+    (collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update` | `revision`>): Promise<NonNullablePaths<DataCollection, DataCollectionNonNullablePaths>>;
 }
 declare function deleteDataCollection$1(httpClient: HttpClient): DeleteDataCollectionSignature;
 interface DeleteDataCollectionSignature {
@@ -74,7 +77,9 @@ interface RestoreDataCollectionSignature {
      * Fails with `WDE0025` if collection was deleted too long ago or has never existed.
      * @param - Data Collection ID to restore
      */
-    (dataCollectionId: string): Promise<RestoreDataCollectionResponse>;
+    (dataCollectionId: string): Promise<NonNullablePaths<RestoreDataCollectionResponse, {
+        [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+    }[DataCollectionNonNullablePaths]>>;
 }
 /** @internal */
 declare function createDataCollectionField$1(httpClient: HttpClient): CreateDataCollectionFieldSignature;
@@ -83,7 +88,9 @@ interface CreateDataCollectionFieldSignature {
      * Adds new field to data collection schema
      * @param - ID of data collection to update
      */
-    (dataCollectionId: string, options: CreateDataCollectionFieldOptions): Promise<CreateDataCollectionFieldResponse>;
+    (dataCollectionId: string, options: NonNullablePaths<CreateDataCollectionFieldOptions, `field`>): Promise<NonNullablePaths<CreateDataCollectionFieldResponse, {
+        [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+    }[DataCollectionNonNullablePaths]>>;
 }
 /** @internal */
 declare function updateDataCollectionField$1(httpClient: HttpClient): UpdateDataCollectionFieldSignature;
@@ -92,7 +99,9 @@ interface UpdateDataCollectionFieldSignature {
      * Updates data collection field
      * @param - ID of data collection to update
      */
-    (dataCollectionId: string, options: UpdateDataCollectionFieldOptions): Promise<UpdateDataCollectionFieldResponse>;
+    (dataCollectionId: string, options: NonNullablePaths<UpdateDataCollectionFieldOptions, `field`>): Promise<NonNullablePaths<UpdateDataCollectionFieldResponse, {
+        [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+    }[DataCollectionNonNullablePaths]>>;
 }
 /** @internal */
 declare function deleteDataCollectionField$1(httpClient: HttpClient): DeleteDataCollectionFieldSignature;
@@ -101,7 +110,9 @@ interface DeleteDataCollectionFieldSignature {
      * Deletes data collection field
      * @param - ID of data collection to update
      */
-    (dataCollectionId: string, options: DeleteDataCollectionFieldOptions): Promise<DeleteDataCollectionFieldResponse>;
+    (dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionFieldOptions, `fieldKey`>): Promise<NonNullablePaths<DeleteDataCollectionFieldResponse, {
+        [P in DataCollectionNonNullablePaths]: `dataCollection.${P}`;
+    }[DataCollectionNonNullablePaths]>>;
 }
 
 declare const createDataCollection: MaybeContext<BuildRESTFunction<typeof createDataCollection$1> & typeof createDataCollection$1>;