@wix/auto_sdk_restaurants_recipients 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,103 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Recipient, UpdateRecipient, RecipientsQueryBuilder, BulkUpdateRecipientTagsOptions, BulkUpdateRecipientTagsResponse, BulkUpdateRecipientTagsApplicationErrors, BulkUpdateRecipientTagsByFilterOptions, BulkUpdateRecipientTagsByFilterResponse, BulkUpdateRecipientTagsByFilterApplicationErrors, RecipientCreatedEnvelope, RecipientDeletedEnvelope, RecipientUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkUpdateRecipientTagsByFilterRequest, BulkUpdateRecipientTagsRequest, BulkUpdateRecipientTagsResult, Channel, ChannelWithLiterals, CreateRecipientRequest, CreateRecipientResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteRecipientRequest, DeleteRecipientResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetRecipientRequest, GetRecipientResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, QueryRecipientsRequest, QueryRecipientsResponse, RecipientsQueryResult, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, TagList, Tags, UpdateRecipientRequest, UpdateRecipientResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function createRecipient$1(httpClient: HttpClient): CreateRecipientSignature;
+interface CreateRecipientSignature {
+    /**
+     * Creates a recipient.
+     * @param - Recipient to create.
+     * @returns Created recipient.
+     */
+    (recipient: NonNullablePaths<Recipient, `channels`, 2>): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function getRecipient$1(httpClient: HttpClient): GetRecipientSignature;
+interface GetRecipientSignature {
+    /**
+     * Retrieves a recipient by ID.
+     * @param - ID of the recipient to retrieve.
+     * @returns Retrieved recipient.
+     */
+    (recipientId: string): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function updateRecipient$1(httpClient: HttpClient): UpdateRecipientSignature;
+interface UpdateRecipientSignature {
+    /**
+     * 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 - Recipient ID.
+     * @returns Updated recipient.
+     */
+    (_id: string, recipient: NonNullablePaths<UpdateRecipient, `revision`, 2>): Promise<NonNullablePaths<Recipient, `phone` | `businessLocationIds` | `channels` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function deleteRecipient$1(httpClient: HttpClient): DeleteRecipientSignature;
+interface DeleteRecipientSignature {
+    /**
+     * Deletes a recipient.
+     * @param - ID of the recipient to delete.
+     */
+    (recipientId: string): Promise<void>;
+}
+declare function queryRecipients$1(httpClient: HttpClient): QueryRecipientsSignature;
+interface QueryRecipientsSignature {
+    /**
+     * 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`
+     */
+    (): RecipientsQueryBuilder;
+}
+declare function bulkUpdateRecipientTags$1(httpClient: HttpClient): BulkUpdateRecipientTagsSignature;
+interface BulkUpdateRecipientTagsSignature {
+    /**
+     * 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 - IDs of recipients to update tags for.
+     */
+    (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;
+    }>;
+}
+declare function bulkUpdateRecipientTagsByFilter$1(httpClient: HttpClient): BulkUpdateRecipientTagsByFilterSignature;
+interface BulkUpdateRecipientTagsByFilterSignature {
+    /**
+     * 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: Record<string, any>, options?: BulkUpdateRecipientTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateRecipientTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateRecipientTagsByFilterApplicationErrors;
+    }>;
+}
+declare const onRecipientCreated$1: EventDefinition<RecipientCreatedEnvelope, "wix.restaurants.recipient.v1.recipient_created">;
+declare const onRecipientDeleted$1: EventDefinition<RecipientDeletedEnvelope, "wix.restaurants.recipient.v1.recipient_deleted">;
+declare const onRecipientUpdated$1: EventDefinition<RecipientUpdatedEnvelope, "wix.restaurants.recipient.v1.recipient_updated">;
+
+declare const createRecipient: MaybeContext<BuildRESTFunction<typeof createRecipient$1> & typeof createRecipient$1>;
+declare const getRecipient: MaybeContext<BuildRESTFunction<typeof getRecipient$1> & typeof getRecipient$1>;
+declare const updateRecipient: MaybeContext<BuildRESTFunction<typeof updateRecipient$1> & typeof updateRecipient$1>;
+declare const deleteRecipient: MaybeContext<BuildRESTFunction<typeof deleteRecipient$1> & typeof deleteRecipient$1>;
+declare const queryRecipients: MaybeContext<BuildRESTFunction<typeof queryRecipients$1> & typeof queryRecipients$1>;
+declare const bulkUpdateRecipientTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateRecipientTags$1> & typeof bulkUpdateRecipientTags$1>;
+declare const bulkUpdateRecipientTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateRecipientTagsByFilter$1> & typeof bulkUpdateRecipientTagsByFilter$1>;
+/** */
+declare const onRecipientCreated: BuildEventDefinition<typeof onRecipientCreated$1> & typeof onRecipientCreated$1;
+/** */
+declare const onRecipientDeleted: BuildEventDefinition<typeof onRecipientDeleted$1> & typeof onRecipientDeleted$1;
+/** */
+declare const onRecipientUpdated: BuildEventDefinition<typeof onRecipientUpdated$1> & typeof onRecipientUpdated$1;
+
+export { BulkUpdateRecipientTagsApplicationErrors, BulkUpdateRecipientTagsByFilterApplicationErrors, BulkUpdateRecipientTagsByFilterOptions, BulkUpdateRecipientTagsByFilterResponse, BulkUpdateRecipientTagsOptions, BulkUpdateRecipientTagsResponse, Recipient, RecipientCreatedEnvelope, RecipientDeletedEnvelope, RecipientUpdatedEnvelope, RecipientsQueryBuilder, UpdateRecipient, bulkUpdateRecipientTags, bulkUpdateRecipientTagsByFilter, createRecipient, deleteRecipient, getRecipient, onRecipientCreated, onRecipientDeleted, onRecipientUpdated, queryRecipients, updateRecipient };