@wix/auto_sdk_fast-gallery_galleries 1.0.1 → 1.0.3

package/build/internal/es/{fastgallery-gallery-v1-gallery-galleries.universal-D2SCxAXG.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /** Gallery is the main entity of GalleryService */
 interface Gallery {
     /**
@@ -561,6 +563,71 @@ interface GalleryRemovedFromTrashBinEnvelope {
     data: GalleryRemovedFromTrashBin;
     metadata: EventMetadata;
 }
+/** @permissionScope Fast Gallery Manager
+ * @permissionScopeId SCOPE.FAST-GALLERY.MANAGE
+ * @permissionId FAST_GALLERY.READ
+ * @webhook
+ * @eventType wix.fastgallery.gallery.v1.gallery_gallery_removed_from_trash_bin
+ * @serviceIdentifier wix.fastgallery.gallery.v1.GalleryService
+ * @slug gallery_removed_from_trash_bin
+ * @documentationMaturity preview
+ */
+declare function onGalleryRemovedFromTrashBin(handler: (event: GalleryRemovedFromTrashBinEnvelope) => void | Promise<void>): void;
+type GalleryNonNullablePaths = `variant`;
+/**
+ * Creates a new Gallery
+ * @param gallery - Gallery to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField gallery
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @returns The created Gallery.
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.CreateGallery
+ */
+declare function createGallery(gallery: Gallery): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
+/**
+ * Get a Gallery by id
+ * @param galleryId - ID of the Gallery to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleryId
+ * @permissionId FAST_GALLERY.READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The requested Gallery.
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.GetGallery
+ */
+declare function getGallery(galleryId: string): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
+/**
+ * Get a Gallery by draft gallery id
+ * @param draftGalleryId - Id of the draftGallery the Gallery originates from
+ * @public
+ * @documentationMaturity preview
+ * @requiredField draftGalleryId
+ * @permissionId FAST_GALLERY.READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.GetGalleryByDraftGalleryId
+ */
+declare function getGalleryByDraftGalleryId(draftGalleryId: string): Promise<NonNullablePaths<GetGalleryByDraftGalleryIdResponse, {
+    [P in GalleryNonNullablePaths]: `gallery.${P}`;
+}[GalleryNonNullablePaths]>>;
+/**
+ * Update a Gallery, supports partial update
+ * Pass the latest `revision` for a successful update
+ * @param _id - Gallery ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField gallery
+ * @requiredField gallery.revision
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @returns Updated Gallery.
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.UpdateGallery
+ */
+declare function updateGallery(_id: string, gallery: NonNullablePaths<UpdateGallery, `revision`>): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
 interface UpdateGallery {
     /**
      * Gallery ID.
@@ -604,6 +671,22 @@ interface UpdateGallery {
      */
     variant?: VariantWithLiterals;
 }
+/**
+ * Creates a query to retrieve a list of galleries.
+ *
+ * The `queryGalleries()` method builds a query to retrieve a list of galleries and returns a `GalleriesQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `GalleriesQueryBuilder` methods onto the query. `GalleriesQueryBuilder` methods enable you to filter, sort, and control the results that `queryGalleries()` returns.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId FAST_GALLERY.READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.QueryGalleries
+ */
+declare function queryGalleries(): GalleriesQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -681,18 +764,97 @@ interface GalleriesQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<GalleriesQueryResult>;
 }
+/**
+ * Updates extended fields of a Gallery without incrementing revision
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.UpdateExtendedFields
+ */
+declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+    [P in GalleryNonNullablePaths]: `gallery.${P}`;
+}[GalleryNonNullablePaths]>>;
 interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
 }
+/**
+ * Create multiple Galleries in a single request. Works synchronously.
+ * @param galleries - List of Galleries to be created
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleries
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.BulkCreateGalleries
+ */
+declare function bulkCreateGalleries(galleries: Gallery[], options?: BulkCreateGalleriesOptions): Promise<NonNullablePaths<BulkCreateGalleriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in GalleryNonNullablePaths]: `results.${number}.item.${P}`;
+}[GalleryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkCreateGalleriesOptions {
     /** set to `true` if you wish to receive back the created Galleries in the response */
     returnEntity?: boolean;
 }
+/**
+ * Update multiple Galleries in a single request. Works synchronously.
+ * @param galleries - List of Galleries to be updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleries
+ * @requiredField galleries.gallery.revision
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.BulkUpdateGalleries
+ */
+declare function bulkUpdateGalleries(galleries: NonNullablePaths<MaskedGallery, `gallery.revision`>[], options?: BulkUpdateGalleriesOptions): Promise<NonNullablePaths<BulkUpdateGalleriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in GalleryNonNullablePaths]: `results.${number}.item.${P}`;
+}[GalleryNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkUpdateGalleriesOptions {
     /** set to `true` if you wish to receive back the updated Galleries in the response */
     returnEntity?: boolean;
 }
+/**
+ * Delete multiple Galleries in a single request. Works synchronously.
+ * @param galleryIds - Gallery ids to be deleted
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleryIds
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.BulkDeleteGalleries
+ */
+declare function bulkDeleteGalleries(galleryIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+/**
+ * Get a deleted Gallery by id
+ * @param galleryId - Id of the deleted  Gallery to retrieve
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleryId
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.GetDeletedGallery
+ */
+declare function getDeletedGallery(galleryId: string): Promise<NonNullablePaths<GetDeletedGalleryResponse, {
+    [P in GalleryNonNullablePaths]: `gallery.${P}`;
+}[GalleryNonNullablePaths]>>;
+/**
+ * Get all deleted Galleries, or specific ones specified by ids
+ * @public
+ * @documentationMaturity preview
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.ListDeletedGalleries
+ */
+declare function listDeletedGalleries(options?: ListDeletedGalleriesOptions): Promise<NonNullablePaths<ListDeletedGalleriesResponse, {
+    [P in GalleryNonNullablePaths]: `galleries.${number}.${P}`;
+}[GalleryNonNullablePaths]>>;
 interface ListDeletedGalleriesOptions {
     /** WQL expression */
     cursorPaging?: CursorPaging;
@@ -703,5 +865,29 @@ interface ListDeletedGalleriesOptions {
      */
     galleryIds?: string[];
 }
+/**
+ * Restore a deleted Gallery from the trash bin by id
+ * @param galleryId - Id of the deleted  Gallery to restore
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleryId
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.RestoreGalleryFromTrashBin
+ */
+declare function restoreGalleryFromTrashBin(galleryId: string): Promise<NonNullablePaths<RestoreGalleryFromTrashBinResponse, {
+    [P in GalleryNonNullablePaths]: `gallery.${P}`;
+}[GalleryNonNullablePaths]>>;
+/**
+ * Permanently delete a Gallery from the trash bin by id
+ * @param galleryId - Id of the  Gallery to delete permanently
+ * @public
+ * @documentationMaturity preview
+ * @requiredField galleryId
+ * @permissionId FAST_GALLERY.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.fastgallery.gallery.v1.GalleryService.RemoveGalleryFromTrashBin
+ */
+declare function removeGalleryFromTrashBin(galleryId: string): Promise<void>;
 
-export { type RemoveGalleryFromTrashBinResponse as $, type UpdateExtendedFieldsRequest as A, type BulkCreateGalleriesOptions as B, type CreateGalleryRequest as C, type DeleteGalleryRequest as D, type ExtendedFields as E, type BulkCreateGalleriesRequest as F, type Gallery as G, type ApplicationError as H, type ItemMetadata as I, type BulkGalleryResult as J, type BulkActionMetadata as K, type ListDeletedGalleriesOptions as L, type MaskedGallery as M, type BulkUpdateGalleriesRequest as N, type BulkUpdateGalleriesResponseBulkGalleryResult as O, type BulkDeleteGalleriesRequest as P, type QueryGalleriesRequest as Q, type RestoreGalleryFromTrashBinResponse as R, SortOrder as S, type BulkDeleteGalleriesResponseBulkGalleryResult as T, type UpdateGallery as U, Variant as V, WebhookIdentityType as W, type GetDeletedGalleryRequest as X, type ListDeletedGalleriesRequest as Y, type RestoreGalleryFromTrashBinRequest as Z, type RemoveGalleryFromTrashBinRequest as _, type GetGalleryByDraftGalleryIdResponse as a, type DeleteOutdatedGalleryVersionsRequest as a0, type DeleteOutdatedGalleryVersionsResponse as a1, type DomainEvent as a2, type DomainEventBodyOneOf as a3, type EntityCreatedEvent as a4, type RestoreInfo as a5, type EntityUpdatedEvent as a6, type EntityDeletedEvent as a7, type ActionEvent as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type GalleriesQueryResult as ae, type GalleriesQueryBuilder as b, type UpdateExtendedFieldsOptions as c, type UpdateExtendedFieldsResponse as d, type BulkCreateGalleriesResponse as e, type BulkUpdateGalleriesOptions as f, type BulkUpdateGalleriesResponse as g, type BulkDeleteGalleriesResponse as h, type GetDeletedGalleryResponse as i, type ListDeletedGalleriesResponse as j, type GalleryRemovedFromTrashBinEnvelope as k, type GalleryRemovedFromTrashBin as l, type CreateGalleryResponse as m, type GetGalleryRequest as n, type GetGalleryResponse as o, type GetGalleryByDraftGalleryIdRequest as p, type UpdateGalleryRequest as q, type UpdateGalleryResponse as r, type DeleteGalleryResponse as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type QueryGalleriesResponse as x, type CursorPagingMetadata as y, type Cursors as z };
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateGalleriesOptions, type BulkCreateGalleriesRequest, type BulkCreateGalleriesResponse, type BulkDeleteGalleriesRequest, type BulkDeleteGalleriesResponse, type BulkDeleteGalleriesResponseBulkGalleryResult, type BulkGalleryResult, type BulkUpdateGalleriesOptions, type BulkUpdateGalleriesRequest, type BulkUpdateGalleriesResponse, type BulkUpdateGalleriesResponseBulkGalleryResult, type CreateGalleryRequest, type CreateGalleryResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteGalleryRequest, type DeleteGalleryResponse, type DeleteOutdatedGalleryVersionsRequest, type DeleteOutdatedGalleryVersionsResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GalleriesQueryBuilder, type GalleriesQueryResult, type Gallery, type GalleryRemovedFromTrashBin, type GalleryRemovedFromTrashBinEnvelope, type GetDeletedGalleryRequest, type GetDeletedGalleryResponse, type GetGalleryByDraftGalleryIdRequest, type GetGalleryByDraftGalleryIdResponse, type GetGalleryRequest, type GetGalleryResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListDeletedGalleriesOptions, type ListDeletedGalleriesRequest, type ListDeletedGalleriesResponse, type MaskedGallery, type MessageEnvelope, type QueryGalleriesRequest, type QueryGalleriesResponse, type RemoveGalleryFromTrashBinRequest, type RemoveGalleryFromTrashBinResponse, type RestoreGalleryFromTrashBinRequest, type RestoreGalleryFromTrashBinResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateGallery, type UpdateGalleryRequest, type UpdateGalleryResponse, Variant, type VariantWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateGalleries, bulkDeleteGalleries, bulkUpdateGalleries, createGallery, getDeletedGallery, getGallery, getGalleryByDraftGalleryId, listDeletedGalleries, onGalleryRemovedFromTrashBin, queryGalleries, removeGalleryFromTrashBin, restoreGalleryFromTrashBin, updateExtendedFields, updateGallery };