@wix/auto_sdk_restaurants_recipients 1.0.0

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

@@ -0,0 +1,827 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface Recipient {
+    /**
+     * Recipient ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Recipient is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Recipient.
+     *
+     * Ignored when creating a Recipient.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Recipient was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Recipient was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Recipient's phone number for receiving notifications.
+     * @format PHONE
+     */
+    phone?: string;
+    /**
+     * IDs of the business locations this recipient should receive order creation notifications for.
+     *
+     * If this list is empty the recipient receives notifications for orders created at all locations.
+     * @maxSize 100
+     * @format GUID
+     */
+    businessLocationIds?: string[];
+    /**
+     * Communication channels for sending notifications to the recipient.
+     *
+     * At least 1 channel is required. Recipients can receive notifications
+     * through multiple channels simultaneously.
+     * @minSize 1
+     * @maxSize 2
+     */
+    channels?: ChannelWithLiterals[];
+    /**
+     * Additional information about the recipient.
+     *
+     * Use this field to store notes about the recipient's role, availability,
+     * or other relevant details for notification management.
+     * @maxLength 500
+     */
+    note?: string | null;
+    /**
+     * Additional custom fields for the recipient.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/api-reference/business-solutions/wix-api/extended-fields).
+     */
+    extendedFields?: ExtendedFields;
+    /**
+     * Tags for categorizing and organizing recipients.
+     *
+     * Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications.
+     */
+    tags?: Tags;
+}
+declare enum Channel {
+    UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
+    /** Send notifications via SMS text messages. */
+    SMS = "SMS",
+    /** Send notifications via phone calls. */
+    PHONE = "PHONE"
+}
+/** @enumType */
+type ChannelWithLiterals = Channel | 'UNKNOWN_CHANNEL' | 'SMS' | 'PHONE';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+interface CreateRecipientRequest {
+    /** Recipient to create. */
+    recipient: Recipient;
+}
+interface CreateRecipientResponse {
+    /** Created recipient. */
+    recipient?: Recipient;
+}
+interface GetRecipientRequest {
+    /**
+     * ID of the recipient to retrieve.
+     * @format GUID
+     */
+    recipientId: string;
+}
+interface GetRecipientResponse {
+    /** Retrieved recipient. */
+    recipient?: Recipient;
+}
+interface UpdateRecipientRequest {
+    /** Recipient to update. May be partial. */
+    recipient: Recipient;
+}
+interface UpdateRecipientResponse {
+    /** Updated recipient. */
+    recipient?: Recipient;
+}
+interface DeleteRecipientRequest {
+    /**
+     * ID of the recipient to delete.
+     * @format GUID
+     */
+    recipientId: string;
+}
+interface DeleteRecipientResponse {
+}
+interface QueryRecipientsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryRecipientsResponse {
+    /** Retrieved recipients. */
+    recipients?: Recipient[];
+    /** Paging metadata for the query results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface BulkUpdateRecipientTagsRequest {
+    /**
+     * IDs of recipients to update tags for.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    recipientIds: string[];
+    /** List of Tags to assign. */
+    assignTags?: Tags;
+    /** List of Tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateRecipientTagsResponse {
+    /**
+     * Results of the bulk update operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateRecipientTagsResult[];
+    /** Metadata regarding the bulk update operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkUpdateRecipientTagsResult {
+    /** Metadata regarding the specific single update operation. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpdateRecipientTagsByFilterRequest {
+    /** Filter. */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign. */
+    assignTags?: Tags;
+    /** List of Tags to unassign. */
+    unassignTags?: Tags;
+}
+interface BulkUpdateRecipientTagsByFilterResponse {
+    /**
+     * Job ID.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type BulkUpdateRecipientTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateRecipientTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface RecipientCreatedEnvelope {
+    entity: Recipient;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.RECIPIENT_READ
+ * @webhook
+ * @eventType wix.restaurants.recipient.v1.recipient_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onRecipientCreated(handler: (event: RecipientCreatedEnvelope) => void | Promise<void>): void;
+interface RecipientDeletedEnvelope {
+    entity: Recipient;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.RECIPIENT_READ
+ * @webhook
+ * @eventType wix.restaurants.recipient.v1.recipient_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onRecipientDeleted(handler: (event: RecipientDeletedEnvelope) => void | Promise<void>): void;
+interface RecipientUpdatedEnvelope {
+    entity: Recipient;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId RESTAURANTS.RECIPIENT_READ
+ * @webhook
+ * @eventType wix.restaurants.recipient.v1.recipient_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onRecipientUpdated(handler: (event: RecipientUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a recipient.
+ * @param recipient - Recipient to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField recipient
+ * @requiredField recipient.channels
+ * @permissionId RESTAURANTS.RECIPIENT_CREATE
+ * @applicableIdentity APP
+ * @returns Created recipient.
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.CreateRecipient
+ */
+declare function createRecipient(recipient: NonNullablePaths<Recipient, `channels`, 2>): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Retrieves a recipient by ID.
+ * @param recipientId - ID of the recipient to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField recipientId
+ * @permissionId RESTAURANTS.RECIPIENT_READ
+ * @applicableIdentity APP
+ * @returns Retrieved recipient.
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.GetRecipient
+ */
+declare function getRecipient(recipientId: string): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+/**
+ * Updates a recipient's information.
+ *
+ * Each time the recipient is updated, `revision` increments by 1.
+ * The current `revision` must be passed when updating the recipient.
+ * This ensures you're working with the latest recipient and prevents unintended overwrites.
+ * @param _id - Recipient ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField recipient
+ * @requiredField recipient.revision
+ * @permissionId RESTAURANTS.RECIPIENT_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated recipient.
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.UpdateRecipient
+ */
+declare function updateRecipient(_id: string, recipient: NonNullablePaths<UpdateRecipient, `revision`, 2>): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+interface UpdateRecipient {
+    /**
+     * Recipient ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the Recipient is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the Recipient.
+     *
+     * Ignored when creating a Recipient.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Recipient was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Recipient was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Recipient's phone number for receiving notifications.
+     * @format PHONE
+     */
+    phone?: string;
+    /**
+     * IDs of the business locations this recipient should receive order creation notifications for.
+     *
+     * If this list is empty the recipient receives notifications for orders created at all locations.
+     * @maxSize 100
+     * @format GUID
+     */
+    businessLocationIds?: string[];
+    /**
+     * Communication channels for sending notifications to the recipient.
+     *
+     * At least 1 channel is required. Recipients can receive notifications
+     * through multiple channels simultaneously.
+     * @minSize 1
+     * @maxSize 2
+     */
+    channels?: ChannelWithLiterals[];
+    /**
+     * Additional information about the recipient.
+     *
+     * Use this field to store notes about the recipient's role, availability,
+     * or other relevant details for notification management.
+     * @maxLength 500
+     */
+    note?: string | null;
+    /**
+     * Additional custom fields for the recipient.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/api-reference/business-solutions/wix-api/extended-fields).
+     */
+    extendedFields?: ExtendedFields;
+    /**
+     * Tags for categorizing and organizing recipients.
+     *
+     * Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications.
+     */
+    tags?: Tags;
+}
+/**
+ * Deletes a recipient.
+ * @param recipientId - ID of the recipient to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField recipientId
+ * @permissionId RESTAURANTS.RECIPIENT_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.DeleteRecipient
+ */
+declare function deleteRecipient(recipientId: string): Promise<void>;
+/**
+ * Retrieves a list of recipients with optional filtering, sorting, and paging.
+ *
+ * Up to 100 recipients can be returned per request.
+ *
+ * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/online-orders/notification-recipients/supported-filters-and-sorting) article.
+ * To learn how to query notification recipients, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ *
+ * Supported properties for filtering and sorting:
+ * `id`, `createdDate`, `updatedDate`, `channels`
+ * @public
+ * @documentationMaturity preview
+ * @permissionId RESTAURANTS.RECIPIENT_READ
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.QueryRecipients
+ */
+declare function queryRecipients(): RecipientsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface RecipientsQueryResult extends QueryCursorResult {
+    items: Recipient[];
+    query: RecipientsQueryBuilder;
+    next: () => Promise<RecipientsQueryResult>;
+    prev: () => Promise<RecipientsQueryResult>;
+}
+interface RecipientsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id', value: string) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => RecipientsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasAll: (propertyName: 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => RecipientsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => RecipientsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: boolean) => RecipientsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'channels' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => RecipientsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'businessLocationIds' | 'channels' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => RecipientsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => RecipientsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => RecipientsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<RecipientsQueryResult>;
+}
+/**
+ * Updates tags on multiple recipients by recipient IDs.
+ *
+ * This is a synchronous operation that updates up to 100 recipients at once.
+ * If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param recipientIds - IDs of recipients to update tags for.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField recipientIds
+ * @permissionId RESTAURANTS.RECIPIENT_UPDATE_TAGS
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.BulkUpdateRecipientTags
+ */
+declare function bulkUpdateRecipientTags(recipientIds: string[], options?: BulkUpdateRecipientTagsOptions): Promise<NonNullablePaths<BulkUpdateRecipientTagsResponse, `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`, 6> & {
+    __applicationErrorsType?: BulkUpdateRecipientTagsApplicationErrors;
+}>;
+interface BulkUpdateRecipientTagsOptions {
+    /** List of Tags to assign. */
+    assignTags?: Tags;
+    /** List of Tags to unassign. */
+    unassignTags?: Tags;
+}
+/**
+ * Updates tags on multiple recipients using filter criteria.
+ *
+ * This is an asynchronous operation that returns a job ID for tracking progress.
+ * An empty filter will update all recipients. If a tag appears in both assign and unassign lists, it will be assigned.
+ * @param filter - Filter.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId RESTAURANTS.RECIPIENT_UPDATE_TAGS
+ * @applicableIdentity APP
+ * @fqn wix.restaurants.recipient.v1.NotificationRecipientsService.BulkUpdateRecipientTagsByFilter
+ */
+declare function bulkUpdateRecipientTagsByFilter(filter: Record<string, any>, options?: BulkUpdateRecipientTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateRecipientTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateRecipientTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateRecipientTagsByFilterOptions {
+    /** List of Tags to assign. */
+    assignTags?: Tags;
+    /** List of Tags to unassign. */
+    unassignTags?: Tags;
+}
+
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdateRecipientTagsApplicationErrors, type BulkUpdateRecipientTagsByFilterApplicationErrors, type BulkUpdateRecipientTagsByFilterOptions, type BulkUpdateRecipientTagsByFilterRequest, type BulkUpdateRecipientTagsByFilterResponse, type BulkUpdateRecipientTagsOptions, type BulkUpdateRecipientTagsRequest, type BulkUpdateRecipientTagsResponse, type BulkUpdateRecipientTagsResult, Channel, type ChannelWithLiterals, type CreateRecipientRequest, type CreateRecipientResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteRecipientRequest, type DeleteRecipientResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetRecipientRequest, type GetRecipientResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type QueryRecipientsRequest, type QueryRecipientsResponse, type Recipient, type RecipientCreatedEnvelope, type RecipientDeletedEnvelope, type RecipientUpdatedEnvelope, type RecipientsQueryBuilder, type RecipientsQueryResult, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type TagList, type Tags, type UpdateRecipient, type UpdateRecipientRequest, type UpdateRecipientResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdateRecipientTags, bulkUpdateRecipientTagsByFilter, createRecipient, deleteRecipient, getRecipient, onRecipientCreated, onRecipientDeleted, onRecipientUpdated, queryRecipients, updateRecipient };