@wix/auto_sdk_restaurants_recipients 1.0.0

package/build/es/meta.d.mts

@@ -0,0 +1,357 @@
+import { CreateRecipientRequest as CreateRecipientRequest$1, CreateRecipientResponse as CreateRecipientResponse$1, GetRecipientRequest as GetRecipientRequest$1, GetRecipientResponse as GetRecipientResponse$1, UpdateRecipientRequest as UpdateRecipientRequest$1, UpdateRecipientResponse as UpdateRecipientResponse$1, DeleteRecipientRequest as DeleteRecipientRequest$1, DeleteRecipientResponse as DeleteRecipientResponse$1, QueryRecipientsRequest as QueryRecipientsRequest$1, QueryRecipientsResponse as QueryRecipientsResponse$1, BulkUpdateRecipientTagsRequest as BulkUpdateRecipientTagsRequest$1, BulkUpdateRecipientTagsResponse as BulkUpdateRecipientTagsResponse$1, BulkUpdateRecipientTagsByFilterRequest as BulkUpdateRecipientTagsByFilterRequest$1, BulkUpdateRecipientTagsByFilterResponse as BulkUpdateRecipientTagsByFilterResponse$1 } from './index.typings.mjs';
+import '@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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createRecipient(): __PublicMethodMetaInfo<'POST', {}, CreateRecipientRequest$1, CreateRecipientRequest, CreateRecipientResponse$1, CreateRecipientResponse>;
+declare function getRecipient(): __PublicMethodMetaInfo<'GET', {
+    recipientId: string;
+}, GetRecipientRequest$1, GetRecipientRequest, GetRecipientResponse$1, GetRecipientResponse>;
+declare function updateRecipient(): __PublicMethodMetaInfo<'PATCH', {
+    recipientId: string;
+}, UpdateRecipientRequest$1, UpdateRecipientRequest, UpdateRecipientResponse$1, UpdateRecipientResponse>;
+declare function deleteRecipient(): __PublicMethodMetaInfo<'DELETE', {
+    recipientId: string;
+}, DeleteRecipientRequest$1, DeleteRecipientRequest, DeleteRecipientResponse$1, DeleteRecipientResponse>;
+declare function queryRecipients(): __PublicMethodMetaInfo<'GET', {}, QueryRecipientsRequest$1, QueryRecipientsRequest, QueryRecipientsResponse$1, QueryRecipientsResponse>;
+declare function bulkUpdateRecipientTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateRecipientTagsRequest$1, BulkUpdateRecipientTagsRequest, BulkUpdateRecipientTagsResponse$1, BulkUpdateRecipientTagsResponse>;
+declare function bulkUpdateRecipientTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateRecipientTagsByFilterRequest$1, BulkUpdateRecipientTagsByFilterRequest, BulkUpdateRecipientTagsByFilterResponse$1, BulkUpdateRecipientTagsByFilterResponse>;
+
+export { type __PublicMethodMetaInfo, bulkUpdateRecipientTags, bulkUpdateRecipientTagsByFilter, createRecipient, deleteRecipient, getRecipient, queryRecipients, updateRecipient };