import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types'; import { BackInStockNotificationRequest, BackInStockItemDetails, CreateBackInStockNotificationRequestApplicationErrors, MarkAsNotificationSentResponse, MarkAsNotificationSentApplicationErrors, CatalogReference, GetBackInStockNotificationRequestsCountByCatalogReferencesResponse, ReportItemsBackInStockOptions, ReportItemsBackInStockApplicationErrors, BackInStockNotificationRequestCreatedEnvelope, BackInStockNotificationRequestDeletedEnvelope, BackInStockNotificationRequestUpdatedEnvelope, RequestsQueryBuilder, BackInStockNotificationRequestQuery, typedQueryBackInStockNotificationRequests } from './index.typings.js'; export { AccountInfo, AccountInfoMetadata, ActionEvent, App, BackInStockNotificationRequestQuerySpec, BackInStockNotificationRequestsCount, BaseEventMetadata, CommonQueryWithEntityContext, CreateBackInStockNotificationRequestRequest, CreateBackInStockNotificationRequestResponse, CursorPaging, Cursors, CustomTag, DeleteBackInStockNotificationRequestRequest, DeleteBackInStockNotificationRequestResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, FocalPoint, GetBackInStockNotificationRequestRequest, GetBackInStockNotificationRequestResponse, GetBackInStockNotificationRequestsCountByCatalogReferencesRequest, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, MarkAsNotificationSentRequest, MessageEnvelope, Page, Pages, PlatformPaging, PlatformPagingMetadata, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryBackInStockNotificationRequestsRequest, QueryBackInStockNotificationRequestsResponse, ReportItemsBackInStockRequest, ReportItemsBackInStockResponse, RequestsQueryResult, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, URI, URIs, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js'; declare function createBackInStockNotificationRequest$1(httpClient: HttpClient): CreateBackInStockNotificationRequestSignature; interface CreateBackInStockNotificationRequestSignature { /** * Creates a back in stock notification request. * * If a notification request already exists for the same `catalogReference` and `email`, * then a new one isn't created and the existing request is returned. * * Back in stock notifications only work for [Wix Stores](https://support.wix.com/en/article/wix-stores-about-wix-stores). * The `appId` for Wix Stores is `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`. * @param - Notification request information. * * Includes details for the out of stock item and the email address * requesting to be notified when it's back in stock. * @param - Item details to include in the notification when the item is back in stock. * @returns Created back in stock notification request. */ (request: NonNullablePaths, itemDetails: NonNullablePaths): Promise & { __applicationErrorsType?: CreateBackInStockNotificationRequestApplicationErrors; }>; } declare function getBackInStockNotificationRequest$1(httpClient: HttpClient): GetBackInStockNotificationRequestSignature; interface GetBackInStockNotificationRequestSignature { /** * Retrieves a back in stock notification request. * @param - ID of the notification request to retrieve. * @returns Retrieved back in stock notification request. */ (_id: string): Promise>; } declare function deleteBackInStockNotificationRequest$1(httpClient: HttpClient): DeleteBackInStockNotificationRequestSignature; interface DeleteBackInStockNotificationRequestSignature { /** * Deletes a back in stock notification request. * @param - ID of the notification request to delete. */ (_id: string): Promise; } declare function markAsNotificationSent$1(httpClient: HttpClient): MarkAsNotificationSentSignature; interface MarkAsNotificationSentSignature { /** * Sets `status` of a back in stock request to `NOTIFICATION_SENT`. * * Use this endpoint if the notification is sent manually offline. If the notification is sent * automatically or with the Report Items Back In Stock method, then `status` updates on its own. * @param - ID of the notification request to mark. */ (_id: string): Promise & { __applicationErrorsType?: MarkAsNotificationSentApplicationErrors; }>; } declare function getBackInStockNotificationRequestsCountByCatalogReferences$1(httpClient: HttpClient): GetBackInStockNotificationRequestsCountByCatalogReferencesSignature; interface GetBackInStockNotificationRequestsCountByCatalogReferencesSignature { /** * Retrieves the amount of back in stock requests for a given `catalogReference` item. * @param - `catalogReference` items to retrieve the notification request for. */ (catalogReferences: CatalogReference[]): Promise>; } declare function reportItemsBackInStock$1(httpClient: HttpClient): ReportItemsBackInStockSignature; interface ReportItemsBackInStockSignature { /** * Sends notifications for back in stock requests. * * > **Important:** * > Automations must be turned on in a [Wix user's dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock) for notifications to send. * * This endpoint triggers notifications for requests in 1 of 2 ways: * 1. For a specific item, with the `catalogReference` information. * 2. For specific requests, with `requestIds`. * * `itemDetails` are required and may populate dynamic values in the notification template, as follows: * + `itemDetails.name` passes to the template as `item.name` * + `itemDetails.price` passes to the template as `item.price` * + `itemDetails.image.url` passes to the template as `item.image.url` * * If the notification template doesn't include `item.price`, `item.name`, or `item.image.url`, values should * be passed in `extraAutomationTemplateParameters`. * * After this endpoint is called, the `status` for the request will update to `NOTIFICATION_SENT` if it sends * successfully, or to `FAILED` if it fails to send. * @param - Item details to use in notifications. * * `itemDetails` may populate dynamic values in the notification template, as follows: * + `itemDetails.name` passes to the template as `item.name` * + `itemDetails.price` passes to the template as `item.price` * + `itemDetails.image.url` passes to the template as `item.image.url` * * Use `extraAutomationTemplateParameters` to pass additional dynamic values. * @param - Report options. */ (itemDetails: NonNullablePaths, options?: ReportItemsBackInStockOptions): Promise; } declare const onBackInStockNotificationRequestCreated$1: EventDefinition; declare const onBackInStockNotificationRequestDeleted$1: EventDefinition; declare const onBackInStockNotificationRequestUpdated$1: EventDefinition; declare function customQueryBackInStockNotificationRequests(httpClient: HttpClient): { (): RequestsQueryBuilder; (query: BackInStockNotificationRequestQuery): ReturnType; }; declare const createBackInStockNotificationRequest: MaybeContext & typeof createBackInStockNotificationRequest$1>; declare const getBackInStockNotificationRequest: MaybeContext & typeof getBackInStockNotificationRequest$1>; declare const deleteBackInStockNotificationRequest: MaybeContext & typeof deleteBackInStockNotificationRequest$1>; declare const markAsNotificationSent: MaybeContext & typeof markAsNotificationSent$1>; declare const getBackInStockNotificationRequestsCountByCatalogReferences: MaybeContext & typeof getBackInStockNotificationRequestsCountByCatalogReferences$1>; declare const reportItemsBackInStock: MaybeContext & typeof reportItemsBackInStock$1>; declare const queryBackInStockNotificationRequests: MaybeContext & typeof customQueryBackInStockNotificationRequests>; /** */ declare const onBackInStockNotificationRequestCreated: BuildEventDefinition & typeof onBackInStockNotificationRequestCreated$1; /** */ declare const onBackInStockNotificationRequestDeleted: BuildEventDefinition & typeof onBackInStockNotificationRequestDeleted$1; /** */ declare const onBackInStockNotificationRequestUpdated: BuildEventDefinition & typeof onBackInStockNotificationRequestUpdated$1; export { BackInStockItemDetails, BackInStockNotificationRequest, BackInStockNotificationRequestCreatedEnvelope, BackInStockNotificationRequestDeletedEnvelope, BackInStockNotificationRequestQuery, BackInStockNotificationRequestUpdatedEnvelope, CatalogReference, CreateBackInStockNotificationRequestApplicationErrors, GetBackInStockNotificationRequestsCountByCatalogReferencesResponse, MarkAsNotificationSentApplicationErrors, MarkAsNotificationSentResponse, ReportItemsBackInStockApplicationErrors, ReportItemsBackInStockOptions, RequestsQueryBuilder, createBackInStockNotificationRequest, deleteBackInStockNotificationRequest, getBackInStockNotificationRequest, getBackInStockNotificationRequestsCountByCatalogReferences, markAsNotificationSent, onBackInStockNotificationRequestCreated, onBackInStockNotificationRequestDeleted, onBackInStockNotificationRequestUpdated, queryBackInStockNotificationRequests, reportItemsBackInStock };