@wix/auto_sdk_data_collections 1.0.42 → 1.0.44

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

@@ -1094,6 +1094,32 @@ interface DeleteDataCollectionFieldResponse {
     /** Updated data collection. */
     dataCollection?: DataCollection;
 }
+interface AddDataCollectionPluginRequest {
+    /**
+     * ID of the data collection to update.
+     * @maxLength 256
+     */
+    dataCollectionId: string;
+    /** Plugin to add. */
+    plugin: Plugin;
+}
+interface AddDataCollectionPluginResponse {
+    /** Updated data collection. */
+    dataCollection?: DataCollection;
+}
+interface DeleteDataCollectionPluginRequest {
+    /**
+     * ID of the data collection to update.
+     * @maxLength 256
+     */
+    dataCollectionId: string;
+    /** Plugin type to remove. */
+    pluginType: PluginTypeWithLiterals;
+}
+interface DeleteDataCollectionPluginResponse {
+    /** Updated data collection. */
+    dataCollection?: DataCollection;
+}
 interface PatchDataCollectionFieldRequest {
     /**
      * ID of the data collection to update.
@@ -1851,6 +1877,41 @@ interface DeleteDataCollectionFieldOptions {
      */
     fieldKey: string;
 }
+/**
+ * Adds a plugin to a data collection.
+ * @param dataCollectionId - ID of the data collection to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField options
+ * @requiredField options.plugin
+ * @requiredField options.plugin.type
+ * @permissionId WIX_DATA.UPDATE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDataCollectionPlugin
+ */
+declare function addDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<AddDataCollectionPluginOptions, `plugin` | `plugin.type`, 3>): Promise<NonNullablePaths<AddDataCollectionPluginResponse, `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 AddDataCollectionPluginOptions {
+    /** Plugin to add. */
+    plugin: Plugin;
+}
+/**
+ * Deletes a plugin from a data collection.
+ * @param dataCollectionId - ID of the data collection to update.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField options
+ * @requiredField options.pluginType
+ * @permissionId WIX_DATA.UPDATE_COLLECTION
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionPlugin
+ */
+declare function deleteDataCollectionPlugin(dataCollectionId: string, options: NonNullablePaths<DeleteDataCollectionPluginOptions, `pluginType`, 2>): Promise<NonNullablePaths<DeleteDataCollectionPluginResponse, `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 DeleteDataCollectionPluginOptions {
+    /** Plugin type to remove. */
+    pluginType: PluginTypeWithLiterals;
+}
 /**
  * Patches (partial update) a field in the structure of a data collection.
  * @public
@@ -1938,4 +1999,4 @@ interface PatchDataCollectionField {
     plugins?: FieldPlugin[];
 }
 
-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 PatchDataCollectionField, type PatchDataCollectionFieldIdentifiers, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, 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, patchDataCollectionField, updateDataCollection, updateDataCollectionField };
+export { AccessLevel, type AccessLevelWithLiterals, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, 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 DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, 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 PatchDataCollectionField, type PatchDataCollectionFieldIdentifiers, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, 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, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollectionField, updateDataCollection, updateDataCollectionField };

package/build/cjs/index.typings.js

@@ -40,10 +40,12 @@ __export(index_typings_exports, {
   TenantMode: () => TenantMode,
   Type: () => Type,
   WebhookIdentityType: () => WebhookIdentityType,
+  addDataCollectionPlugin: () => addDataCollectionPlugin2,
   createDataCollection: () => createDataCollection2,
   createDataCollectionField: () => createDataCollectionField2,
   deleteDataCollection: () => deleteDataCollection2,
   deleteDataCollectionField: () => deleteDataCollectionField2,
+  deleteDataCollectionPlugin: () => deleteDataCollectionPlugin2,
   getDataCollection: () => getDataCollection2,
   listDataCollections: () => listDataCollections2,
   patchDataCollection: () => patchDataCollection2,
@@ -849,6 +851,76 @@ function deleteDataCollectionField(payload) {
   }
   return __deleteDataCollectionField;
 }
+function addDataCollectionPlugin(payload) {
+  function __addDataCollectionPlugin({ host }) {
+    const metadata = {
+      entityFqdn: "wix.data.v2.data_collection",
+      method: "POST",
+      methodFqn: "com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDataCollectionPlugin",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl(
+        { protoPath: "/v2/collections/add-plugin", data: payload, host }
+      ),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "dataCollection.createdDate" },
+            { path: "dataCollection.updatedDate" }
+          ]
+        },
+        {
+          transformFn: import_float2.transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "dataCollection.fields.numberRange.min" },
+            { path: "dataCollection.fields.numberRange.max" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __addDataCollectionPlugin;
+}
+function deleteDataCollectionPlugin(payload) {
+  function __deleteDataCollectionPlugin({ host }) {
+    const metadata = {
+      entityFqdn: "wix.data.v2.data_collection",
+      method: "POST",
+      methodFqn: "com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDataCollectionPlugin",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveComWixpressCloudDataApiCollectionserviceDataCollectionServiceUrl(
+        { protoPath: "/v2/collections/delete-plugin", data: payload, host }
+      ),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "dataCollection.createdDate" },
+            { path: "dataCollection.updatedDate" }
+          ]
+        },
+        {
+          transformFn: import_float2.transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "dataCollection.fields.numberRange.min" },
+            { path: "dataCollection.fields.numberRange.max" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __deleteDataCollectionPlugin;
+}
 function patchDataCollectionField(payload) {
   function __patchDataCollectionField({ host }) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
@@ -1372,6 +1444,64 @@ async function deleteDataCollectionField2(dataCollectionId, options) {
     throw transformedError;
   }
 }
+async function addDataCollectionPlugin2(dataCollectionId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    dataCollectionId,
+    plugin: options?.plugin
+  });
+  const reqOpts = addDataCollectionPlugin(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          dataCollectionId: "$[0]",
+          plugin: "$[1].plugin"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["dataCollectionId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function deleteDataCollectionPlugin2(dataCollectionId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    dataCollectionId,
+    pluginType: options?.pluginType
+  });
+  const reqOpts = deleteDataCollectionPlugin(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          dataCollectionId: "$[0]",
+          pluginType: "$[1].pluginType"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["dataCollectionId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function patchDataCollectionField2(identifiers, field) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -1423,10 +1553,12 @@ async function patchDataCollectionField2(identifiers, field) {
   TenantMode,
   Type,
   WebhookIdentityType,
+  addDataCollectionPlugin,
   createDataCollection,
   createDataCollectionField,
   deleteDataCollection,
   deleteDataCollectionField,
+  deleteDataCollectionPlugin,
   getDataCollection,
   listDataCollections,
   patchDataCollection,