@wix/auto_sdk_data_collections 1.0.39 → 1.0.41

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

@@ -497,6 +497,13 @@ interface PageLink {
      */
     linkedRouterPage?: string | null;
 }
+interface Slug {
+    /**
+     * @minLength 1
+     * @maxLength 1000
+     */
+    pattern?: string;
+}
 interface NumberRange {
     /**
      * Minimum permitted value for a numerical field.
@@ -1068,6 +1075,14 @@ interface RestoreDataCollectionResponse {
     /** Restored data collection */
     dataCollection?: DataCollection;
 }
+interface PatchDataCollectionRequest {
+    /** Data collection to patch. Only fields specified in the field_mask are updated. */
+    dataCollection: DataCollection;
+}
+interface PatchDataCollectionResponse {
+    /** The updated data collection. */
+    dataCollection?: DataCollection;
+}
 interface CreateDataCollectionFieldRequest {
     /**
      * ID of the data collection to update.
@@ -1730,6 +1745,116 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.RestoreDataCollection
  */
 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>>;
+/**
+ * Patches (partial update) a data collection.
+ * @param _id - Collection ID. For example, `my-first-collection`. May include a namespace.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField dataCollection
+ * @requiredField dataCollection.revision
+ * @permissionId WIX_DATA.UPDATE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection
+ */
+declare function patchDataCollection(_id: string, dataCollection: NonNullablePaths<PatchDataCollection, `revision`, 2>): Promise<NonNullablePaths<PatchDataCollectionResponse, `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 PatchDataCollection {
+    /**
+     * Collection ID. For example, `my-first-collection`. May include a namespace.
+     * @immutable
+     * @maxLength 256
+     */
+    _id?: string;
+    /**
+     * Collection type. Indicates how the collection was created and how it is stored.
+     * @readonly
+     */
+    collectionType?: CollectionTypeWithLiterals;
+    /**
+     * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
+     * @format GUID
+     * @readonly
+     */
+    ownerAppId?: string | null;
+    /**
+     * Maximum number of items returned in a single query, based on the underlying storage.
+     * Native collections have a maximum page size of 1000 for offset-based queries or 100 for cursor-based queries.
+     * External collections' maximum page size defaults to 50, but an external provider can set any maximum value up to 1000.
+     * @readonly
+     */
+    maxPageSize?: number | null;
+    /**
+     * Collection's display name as shown in the CMS. For example, `My First Collection`.
+     * @maxLength 1000
+     */
+    displayName?: string | null;
+    /**
+     * Default item sorting order when a query doesn't specify one.
+     * @readonly
+     */
+    defaultDisplayOrder?: Sort;
+    /**
+     * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
+     * Empty for all data collections not owned by Wix apps.
+     * @readonly
+     * @maxLength 1000
+     */
+    displayNamespace?: string | null;
+    /**
+     * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
+     * @maxLength 1000
+     */
+    displayField?: string | null;
+    /**
+     * Capabilities the collection supports.
+     * @readonly
+     */
+    capabilities?: CollectionCapabilities;
+    /**
+     * Collection's field structure.
+     * @maxSize 1000
+     */
+    fields?: Field[];
+    /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
+    permissions?: Permissions;
+    /**
+     * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality.
+     * @maxSize 100
+     */
+    plugins?: Plugin[];
+    /**
+     * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * @readonly
+     * @maxSize 2
+     */
+    pagingModes?: PagingModeWithLiterals[];
+    /**
+     * Date the collection was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the collection was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Levels of permission for accessing and modifying data.
+     * @internal
+     */
+    dataPermissions?: DataPermissions;
+    /**
+     * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
+     * @internal
+     * @readonly
+     */
+    allowedDataPermissions?: AllowedDataPermissions;
+}
 /**
  * Adds a new field to the structure of a data collection.
  * @param dataCollectionId - ID of the data collection to update.
@@ -1792,4 +1917,4 @@ interface DeleteDataCollectionFieldOptions {
     fieldKey: string;
 }
 
-export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, 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, TenantMode, type TenantModeWithLiterals, 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 AppOptions, type ApplicationError, type ArraySizeRange, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, 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 PatchDataCollection, type PatchDataCollectionRequest, type PatchDataCollectionResponse, 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 Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StringLengthRange, TenantMode, type TenantModeWithLiterals, 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, patchDataCollection, restoreDataCollection, updateDataCollection, updateDataCollectionField };

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

@@ -11,6 +11,7 @@ import { transformSDKFloatToRESTFloat } from "@wix/sdk-runtime/transformations/f
 import { transformRESTFloatToSDKFloat } from "@wix/sdk-runtime/transformations/float";
 import { transformSDKTimestampToRESTTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
 import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformSDKFieldMaskToRESTFieldMask } from "@wix/sdk-runtime/transformations/field-mask";
 import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
 import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
 function resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl(opts) {
@@ -605,6 +606,65 @@ function restoreDataCollection(payload) {
   }
   return __restoreDataCollection;
 }
+function patchDataCollection(payload) {
+  function __patchDataCollection({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKFieldMaskToRESTFieldMask,
+        paths: [{ path: "fieldMask" }]
+      },
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "dataCollection.createdDate" },
+          { path: "dataCollection.updatedDate" }
+        ]
+      },
+      {
+        transformFn: transformSDKFloatToRESTFloat,
+        paths: [
+          { path: "dataCollection.fields.numberRange.min" },
+          { path: "dataCollection.fields.numberRange.max" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.data.v2.data_collection",
+      method: "PATCH",
+      methodFqn: "com.wixpress.cloud.data.api.collectionservice.DataCollectionService.PatchDataCollection",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl(
+        {
+          protoPath: "/v2/collections/{dataCollection.id}",
+          data: serializedData,
+          host
+        }
+      ),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "dataCollection.createdDate" },
+            { path: "dataCollection.updatedDate" }
+          ]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "dataCollection.fields.numberRange.min" },
+            { path: "dataCollection.fields.numberRange.max" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __patchDataCollection;
+}
 function createDataCollectionField(payload) {
   function __createDataCollectionField({ host }) {
     const serializedData = transformPaths(payload, [
@@ -1095,6 +1155,31 @@ async function restoreDataCollection2(dataCollectionId) {
     throw transformedError;
   }
 }
+async function patchDataCollection2(_id, dataCollection) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    dataCollection: { ...dataCollection, id: _id }
+  });
+  const reqOpts = patchDataCollection(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: { dataCollection: "$[1]" },
+        explicitPathsToArguments: { "dataCollection.id": "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["_id", "dataCollection"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function createDataCollectionField2(dataCollectionId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -1209,6 +1294,7 @@ export {
   deleteDataCollectionField2 as deleteDataCollectionField,
   getDataCollection2 as getDataCollection,
   listDataCollections2 as listDataCollections,
+  patchDataCollection2 as patchDataCollection,
   restoreDataCollection2 as restoreDataCollection,
   updateDataCollection2 as updateDataCollection,
   updateDataCollectionField2 as updateDataCollectionField