@wix/auto_sdk_table-reservations_reservations 1.0.0

package/build/internal/cjs/src/table-reservations-v1-reservation-reservations.types.d.ts

@@ -0,0 +1,1149 @@
+/** The reservation domain object. */
+export interface Reservation {
+    /**
+     * Reservation ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Status of the reservation.
+     *
+     * See the Reservation Lifecycle article([REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/table-reservations/reservations/the-reservation-lifecycle)) for an explanation of the role of statuses in the reservation lifecycle.
+     */
+    status?: Status;
+    /**
+     * Reservation source.
+     *
+     * This indicates how the reservation was made.
+     */
+    source?: Source;
+    /** Reservation details. */
+    details?: Details;
+    /**
+     * Information about the person the reservation is being made for.
+     *
+     * A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
+     * Attempting to create a reservation without these fields results in an error.
+     */
+    reservee?: Reservee;
+    /**
+     * Information about the person making the reservation.
+     *
+     * This field is required if the reservation's `status` is anything other than `WALK_IN`.
+     * @readonly
+     */
+    reservedBy?: ReservedBy;
+    /**
+     * Team message.
+     *
+     * A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.
+     */
+    teamMessage?: string | null;
+    /**
+     * Date and time the reservation was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the reservation was changed.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the reservation is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the reservation.
+     *
+     * Ignored when creating a reservation.
+     * @readonly
+     */
+    revision?: string | null;
+    /** The reason the reservation was declined. */
+    declineReason?: string | null;
+    /**
+     * Payment status.
+     * @readonly
+     */
+    paymentStatus?: PaymentStatus;
+    /**
+     * Custom field data for the reservation object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
+export interface Tables {
+    /** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
+    ids?: string[];
+}
+export declare enum Status {
+    /** Undefined reservation status. */
+    UNKNOWN = "UNKNOWN",
+    /** A customer has begun the reservation flow, a temporary reservation is created and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request. */
+    HELD = "HELD",
+    /** The reservation is confirmed. */
+    RESERVED = "RESERVED",
+    /** The reservation is canceled. */
+    CANCELED = "CANCELED",
+    /** The reservation completed successfully. */
+    FINISHED = "FINISHED",
+    /** The customer didn't show up for their reservation. */
+    NO_SHOW = "NO_SHOW",
+    /** The customer is currently occupying the table. */
+    SEATED = "SEATED",
+    /** A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request. */
+    REQUESTED = "REQUESTED",
+    /** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
+    DECLINED = "DECLINED",
+    /** A customer has begun the checkout flow, the temporary reservation is moved to this status and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reserve reservation endpoint is called for a reservation in `HELD` status and payment is needed. After payment is completed status will be changed automatically to `RESERVED`. */
+    PAYMENT_PENDING = "PAYMENT_PENDING"
+}
+export declare enum Source {
+    /** Undefined reservation source. */
+    UNKNOWN = "UNKNOWN",
+    /** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
+    OFFLINE = "OFFLINE",
+    /** The reservation was made through a website or app. */
+    ONLINE = "ONLINE",
+    /** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
+    WALK_IN = "WALK_IN"
+}
+/** Reservation details. */
+export interface Details {
+    /** ID of the reservation location at which this reservation will be made. */
+    reservationLocationId?: string | null;
+    /**
+     * IDs of tables used for this reservation.
+     * @deprecated
+     * @replacedBy tables
+     * @targetRemovalDate 2024-12-31
+     */
+    tableIds?: string[] | null;
+    /** Tables used for this reservation. */
+    tables?: Tables;
+    /** Start date and time of the reservation. */
+    startDate?: Date | null;
+    /** End date and time of the reservation. */
+    endDate?: Date | null;
+    /** Party size. */
+    partySize?: number | null;
+}
+/** The person the reservation is being made for. */
+export interface Reservee {
+    /**
+     * First name.
+     *
+     * This field is required if the reservation's `status` is anything other than `WALK_IN`.
+     */
+    firstName?: string | null;
+    /** Last name. */
+    lastName?: string | null;
+    /** Email address. */
+    email?: string | null;
+    /**
+     * Phone number.
+     *
+     * This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `"+972555555555"`.
+     *
+     * This field is required if the reservation's `status` is anything other than `WALK_IN`.
+     */
+    phone?: string | null;
+    /** Whether the reservee has given marketing consent. */
+    marketingConsent?: boolean | null;
+    /**
+     * Custom fields for the reservee in key-value pairs.
+     *
+     * The key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : "Nuts, Seafood"`.
+     *
+     * Empty fields are not returned.
+     */
+    customFields?: Record<string, any> | null;
+    /**
+     * Contact ID. If a contact with this ID does not exist on the site, one will be created.
+     * @readonly
+     */
+    contactId?: string | null;
+}
+/** A person making reservation. */
+export interface ReservedBy {
+    /**
+     * Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.
+     * @readonly
+     */
+    contactId?: string | null;
+}
+/** Migration note. */
+export interface MigrationNote {
+}
+/** Table with reservation conflicts. */
+export interface TableWithReservationConflicts {
+    /** Table id. */
+    tableId?: string;
+    /** List of reservation ids. */
+    reservationIds?: string[];
+}
+export declare enum PaymentStatus {
+    /** Undefined payment status. */
+    UNKNOWN = "UNKNOWN",
+    /** A reservation is free of charge. */
+    FREE = "FREE",
+    /** Payment is not received yet. */
+    NOT_PAID = "NOT_PAID",
+    /** The corresponding reservation order was fully paid. */
+    PAID = "PAID",
+    /** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    /** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
+    FULLY_REFUNDED = "FULLY_REFUNDED",
+    /** The corresponding reservation order was partially paid. */
+    PARTIALLY_PAID = "PARTIALLY_PAID"
+}
+export 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>>;
+}
+export interface ReservationDelayedDomainEvent extends ReservationDelayedDomainEventBodyTypeOneOf {
+    /** Body of a created reservation event. */
+    reservationCreated?: ReservationCreated;
+    /** Body of a updated reservation event. */
+    reservationUpdated?: ReservationUpdated;
+    /** Body of a canceled reservation event. */
+    reservationCanceled?: ReservationDelayedDomainEventReservationCanceled;
+}
+/** @oneof */
+export interface ReservationDelayedDomainEventBodyTypeOneOf {
+    /** Body of a created reservation event. */
+    reservationCreated?: ReservationCreated;
+    /** Body of a updated reservation event. */
+    reservationUpdated?: ReservationUpdated;
+    /** Body of a canceled reservation event. */
+    reservationCanceled?: ReservationDelayedDomainEventReservationCanceled;
+}
+export interface ReservationCreated {
+    /** Created reservation. */
+    createdReservation?: Reservation;
+}
+export interface ReservationUpdated {
+    /** Updated reservation. */
+    updatedReservation?: Reservation;
+    /** Modified fields of previous entity */
+    modifiedFields?: Record<string, any>;
+}
+export interface ReservationDelayedDomainEventReservationCanceled {
+    /** Canceled reservation. */
+    canceledReservation?: Reservation;
+}
+export interface CreateReservationRequest {
+    /** Reservation details. */
+    reservation: Reservation;
+    /**
+     * Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     *
+     * Possible values:
+     * * `"RESERVED"`: One or more of the chosen tables are already reserved.
+     * * `"TOO_BIG"`: The party is too big for the selected table.
+     * * `"TOO_SMALL"`: The party is too small for the selected table.
+     * * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
+     */
+    ignoreTableCombinationConflicts?: TableCombinationConflictType[];
+    /**
+     * Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
+     *
+     * Possible values:
+     * * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
+     * * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
+     */
+    ignoreReservationLocationConflicts?: Type[];
+}
+export declare enum TableCombinationConflictType {
+    /** Undefined conflict type. */
+    UNKNOWN = "UNKNOWN",
+    /** One or more of the chosen tables are already reserved. */
+    RESERVED = "RESERVED",
+    /** The party is too big for the selected table. */
+    TOO_BIG = "TOO_BIG",
+    /** The party is too small for the selected table. */
+    TOO_SMALL = "TOO_SMALL",
+    /** The restaurant does not allow online reservations. */
+    OFFLINE_ONLY = "OFFLINE_ONLY"
+}
+export declare enum Type {
+    /** Undefined reservation location conflict type. */
+    UNKNOWN = "UNKNOWN",
+    /** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
+    PARTY_PACING = "PARTY_PACING",
+    /** The required number of seats are unavailable according to seat pacing settings. */
+    SEAT_PACING = "SEAT_PACING"
+}
+export interface CreateReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface ReservationDetailsConflicts {
+    /** Table combinations conflicts. */
+    tableCombinationConflicts?: TableCombinationConflict[];
+    /** Reservation location conflicts. */
+    reservationLocationConflicts?: ReservationLocationConflict[];
+}
+export interface TableCombinationConflict {
+    /** Conflict type. */
+    type?: TableCombinationConflictType;
+}
+export interface ReservationLocationConflict {
+    /** Reservation location conflict type. */
+    type?: Type;
+}
+export interface GetReservationRequest {
+    /** Reservation ID. */
+    reservationId: string;
+    /**
+     * Array of named, predefined sets of projected fields to be returned.
+     * Default: If `fields` is omitted from the request, `PUBLIC`.
+     */
+    fieldsets?: Set[];
+}
+export declare enum Set {
+    /**
+     * Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
+     * `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
+     */
+    PUBLIC = "PUBLIC",
+    /** Returns all fields. */
+    FULL = "FULL"
+}
+export interface GetReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface UpdateReservationRequest {
+    /** Reservation information to update. */
+    reservation: Reservation;
+    /** Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it. */
+    ignoreTableCombinationConflicts?: TableCombinationConflictType[];
+    ignoreReservationLocationConflicts?: Type[];
+}
+export interface UpdateReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface CreateHeldReservationRequest {
+    /** Held reservation information to update. */
+    reservationDetails: HeldReservationDetails;
+}
+/** Reservation details when create reservation in status HELD. */
+export interface HeldReservationDetails {
+    /** ID of the reservation location where the reservation is made. */
+    reservationLocationId?: string | null;
+    /** Start date and time of the reservation. */
+    startDate?: Date | null;
+    /** Party size. */
+    partySize?: number | null;
+}
+export interface CreateHeldReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface ReserveReservationRequest {
+    /** Reservation ID. */
+    reservationId: string;
+    /** Reservee details. */
+    reservee: Reservee;
+    /**
+     * Revision number.
+     *
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
+     */
+    revision: string | null;
+}
+export interface ReserveReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface CancelReservationRequest {
+    /** Reservation ID. */
+    reservationId: string;
+    /**
+     * Revision number.
+     *
+     * Specify the existing `revision` to prevent conflicting updates to reservations.
+     */
+    revision: string | null;
+    /**
+     * The phone number that was provided when the reservation was created.
+     *
+     * This is required for reservations with any `source` other than `WALK_IN`.
+     *
+     * This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.
+     */
+    phone?: string | null;
+}
+export interface CancelReservationResponse {
+    /** Reservation. */
+    reservation?: Reservation;
+}
+export interface ReservationCanceled {
+    /** Reserved reservation. */
+    reservation?: Reservation;
+}
+export interface DeleteReservationRequest {
+    /** Reservation ID. */
+    reservationId: string;
+}
+export interface DeleteReservationResponse {
+}
+export interface ListReservationsRequest {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    paging?: CursorPaging;
+    /** Defines how reservations in the response are sorted. */
+    sort?: Sorting;
+    /** Only reservations starting after this date are returned. */
+    startDateFrom?: Date | null;
+    /** Only reservations starting before this date are returned. */
+    startDateTo?: Date | null;
+    /** Only reservations with this status are returned. */
+    status?: Status;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /**
+     * Sort order.
+     * Default: `ASC`.
+     */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    /** Sort by ascending order. */
+    ASC = "ASC",
+    /** Sort by descending order. */
+    DESC = "DESC"
+}
+export interface ListReservationsResponse {
+    /** List of reservations. */
+    reservations?: Reservation[];
+    /** Metadata for the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface QueryReservationsRequest {
+    /** Query to select reservations. */
+    query: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     *
+     * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
+     * To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface QueryReservationsResponse {
+    /** List of reservations. */
+    reservations?: Reservation[];
+    /** Metadata for the paginated results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface SearchReservationsRequest {
+    /** Search query. */
+    search: CursorSearch;
+}
+export interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /**
+     * A search method for grouping data into various categories (facets) and providing summaries for each category.
+     * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific reservation statuses, party sizes, etc.
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+    /** Time zone to adjust date-time-based filters and aggregations. ISO 8601 or IANA time zone database format. */
+    timeZone?: string | null;
+}
+/** @oneof */
+export interface CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
+    cursorPaging?: CursorPaging;
+}
+export interface Aggregation extends AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
+     */
+    nested?: NestedAggregation;
+    name?: string | null;
+    type?: AggregationType;
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
+     */
+    nested?: NestedAggregation;
+}
+export interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
+    to?: number | null;
+}
+export declare enum SortType {
+    /** Sort by number of matches. */
+    COUNT = "COUNT",
+    /** Sort by value of the field alphabetically. */
+    VALUE = "VALUE"
+}
+export declare enum SortDirection {
+    /** Sort in descending order. */
+    DESC = "DESC",
+    /** Sort in ascending order. */
+    ASC = "ASC"
+}
+export declare enum MissingValues {
+    /** Exclude missing values from the aggregation results */
+    EXCLUDE = "EXCLUDE",
+    /** Include missing values in the aggregation results */
+    INCLUDE = "INCLUDE"
+}
+export interface IncludeMissingValuesOptions {
+    /** Specify a custom name for the bucket containing the missing values. Defaults are "N/A" for strings, "0" for integers, and "false" for booleans. */
+    addToBucket?: string;
+}
+export declare enum ScalarType {
+    /** Undefined scalar type. */
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    /** Count of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX"
+}
+export declare enum NestedAggregationType {
+    /** Undefined aggregation type. */
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation where you can define a set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation - such as min, max, sum, and avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+export interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Whether to sort by the number of matches or the value of the field. */
+    sortType?: SortType;
+    /** Whether to sort in ascending or descending order. */
+    sortDirection?: SortDirection;
+    /**
+     * Number of aggregation results to return.
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
+    limit?: number | null;
+    /**
+     * Whether missing values should be included or excluded from the aggregation results.
+     * Default: `EXCLUDE`.
+     */
+    missingValues?: MissingValues;
+}
+/** @oneof */
+export interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+export interface RangeAggregation {
+    /** List of range buckets. During aggregation each entity will be placed in the first bucket its value falls into based on the provided range bounds. */
+    buckets?: RangeBucket[];
+}
+export interface ScalarAggregation {
+    /** Operation type for the scalar aggregation. */
+    type?: ScalarType;
+}
+export interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation. */
+    interval?: Interval;
+}
+export declare enum Interval {
+    UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
+    YEAR = "YEAR",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    DAY = "DAY",
+    HOUR = "HOUR",
+    MINUTE = "MINUTE",
+    SECOND = "SECOND"
+}
+export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /** Aggregation name displayed in the return. */
+    name?: string | null;
+    /** Type of aggregation to perform. */
+    type?: NestedAggregationType;
+    /** Field to aggregate by. */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+}
+export declare enum AggregationType {
+    /** Undefined aggregation type. */
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    VALUE = "VALUE",
+    /** An aggregation where you can define a set of ranges - each representing a bucket. */
+    RANGE = "RANGE",
+    /** A single-value metric aggregation - such as min, max, sum, or avg. */
+    SCALAR = "SCALAR",
+    /** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
+    NESTED = "NESTED"
+}
+export interface NestedAggregation {
+    /** Flattened list of aggregations, where each aggregation is nested within the previous one. */
+    nestedAggregations?: NestedAggregationItem[];
+}
+export interface SearchDetails {
+    /** Boolean search mode. Defines how separate search terms in the `expression` are combined. */
+    mode?: Mode;
+    /** Search term or expression. */
+    expression?: string | null;
+    /**
+     * Fields to search in.
+     *
+     * Searchable fields are `reservee.firstName`, `reservee.lastName`, `reservee.phone`, and `reservee.email`.
+     *
+     * If the array is empty, all fields are searched.
+     */
+    fields?: string[];
+    /**
+     * Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
+     * The search function uses an algorithm to find results that are close to what the site visitor typed.
+     */
+    fuzzy?: boolean;
+}
+export declare enum Mode {
+    /** Returns instances where any terms in the expression occur. */
+    OR = "OR",
+    /** Returns instances where all the terms in the expression occur. */
+    AND = "AND"
+}
+export interface SearchReservationsResponse {
+    /** List of Reservations. */
+    reservations?: Reservation[];
+    /** Cursor paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data. */
+    aggregationData?: AggregationData;
+}
+export interface AggregationData {
+    /** List of the aggregated data results. */
+    results?: AggregationResults[];
+}
+export interface ValueAggregationResult {
+    /** Value of the field */
+    value?: string;
+    /** Count of entities with this value */
+    count?: number;
+}
+export interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in the range. */
+    count?: number;
+}
+export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** List of the value aggregation results. */
+    values?: ValueResults;
+    /** List of the range aggregation results. */
+    ranges?: RangeResults;
+    /** List of the scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Aggregation name defined in the request. */
+    name?: string;
+    /** Type of aggregation performed. */
+    type?: AggregationType;
+    /** Field the data was aggregated by. */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationResultsResultOneOf {
+    /** List of the value aggregation results. */
+    values?: ValueResults;
+    /** List of the range aggregation results. */
+    ranges?: RangeResults;
+    /** List of the scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+}
+export interface ValueResults {
+    /** List of value aggregations. */
+    results?: ValueAggregationResult[];
+}
+export interface RangeResults {
+    /** List of ranges returned in same order as requested. */
+    results?: RangeAggregationResult[];
+}
+export interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarType;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+export interface NestedValueAggregationResult {
+    value?: string;
+    nestedResults?: NestedAggregationResults;
+}
+export interface ValueResult {
+    /** Value of the field. */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number | null;
+}
+export interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in the range. */
+    count?: number | null;
+}
+export interface ScalarResult {
+    /** Scalar aggregation results. */
+    value?: number;
+}
+export interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation results. */
+    value?: ValueResult;
+    /** Range aggregation results. */
+    range?: RangeResult;
+    /** Scalar aggregation results. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation results. */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+export interface NestedResultValueResultOneOf {
+    /** Value aggregation results. */
+    value?: ValueResult;
+    /** Range aggregation results. */
+    range?: RangeResult;
+    /** Scalar aggregation results. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation results. */
+    dateHistogram?: ValueResult;
+}
+export interface Results {
+    /** List of nested aggregation results. */
+    results?: Record<string, NestedResultValue>;
+}
+export interface DateHistogramResult {
+    /** Date in ISO 8601 format. */
+    value?: string;
+    /** Count of entities in the interval. */
+    count?: number;
+}
+/** deprecated */
+export interface GroupByValueResults {
+    results?: NestedValueAggregationResult[];
+}
+export interface DateHistogramResults {
+    /** List of date histogram aggregations. */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in the resulting array are keyed by the requested aggregation `name`.
+ */
+export interface NestedResults {
+    /** List of nested aggregation results. */
+    results?: Results[];
+}
+export interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** deprecated */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /** Aggregation name defined in the request. */
+    name?: string;
+    /** Type of aggregation that was performed. */
+    type?: AggregationType;
+    /** Field the data was aggregated by. */
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** deprecated */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface Empty {
+}
+export interface RemoveReservationMigrationNotesRequest {
+    /** Reservation ID. */
+    reservationId?: string;
+    /** Revision. */
+    revision?: string;
+}
+export interface RemoveReservationMigrationNotesResponse {
+    reservation?: Reservation;
+}
+export interface RawHttpRequest {
+    body?: Uint8Array;
+    pathParams?: PathParametersEntry[];
+    queryParams?: QueryParametersEntry[];
+    headers?: HeadersEntry[];
+    method?: string;
+    rawPath?: string;
+    rawQuery?: string;
+}
+export interface PathParametersEntry {
+    key?: string;
+    value?: string;
+}
+export interface QueryParametersEntry {
+    key?: string;
+    value?: string;
+}
+export interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+export interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface TablesNonNullableFields {
+    ids: string[];
+}
+interface DetailsNonNullableFields {
+    tables?: TablesNonNullableFields;
+}
+interface TableWithReservationConflictsNonNullableFields {
+    tableId: string;
+    reservationIds: string[];
+}
+interface ReservationNonNullableFields {
+    status: Status;
+    source: Source;
+    details?: DetailsNonNullableFields;
+    tablesWithReservationConflicts: TableWithReservationConflictsNonNullableFields[];
+    paymentStatus: PaymentStatus;
+}
+export interface CreateReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface GetReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface UpdateReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface CreateHeldReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface ReserveReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface CancelReservationResponseNonNullableFields {
+    reservation?: ReservationNonNullableFields;
+}
+export interface ListReservationsResponseNonNullableFields {
+    reservations: ReservationNonNullableFields[];
+}
+export interface QueryReservationsResponseNonNullableFields {
+    reservations: ReservationNonNullableFields[];
+}
+interface ValueAggregationResultNonNullableFields {
+    value: string;
+    count: number;
+}
+interface ValueResultsNonNullableFields {
+    results: ValueAggregationResultNonNullableFields[];
+}
+interface RangeAggregationResultNonNullableFields {
+    count: number;
+}
+interface RangeResultsNonNullableFields {
+    results: RangeAggregationResultNonNullableFields[];
+}
+interface AggregationResultsScalarResultNonNullableFields {
+    type: ScalarType;
+    value: number;
+}
+interface NestedAggregationResultsNonNullableFields {
+    values?: ValueResultsNonNullableFields;
+    ranges?: RangeResultsNonNullableFields;
+    scalar?: AggregationResultsScalarResultNonNullableFields;
+    name: string;
+    type: AggregationType;
+    fieldPath: string;
+}
+interface NestedValueAggregationResultNonNullableFields {
+    value: string;
+    nestedResults?: NestedAggregationResultsNonNullableFields;
+}
+interface GroupByValueResultsNonNullableFields {
+    results: NestedValueAggregationResultNonNullableFields[];
+}
+interface DateHistogramResultNonNullableFields {
+    value: string;
+    count: number;
+}
+interface DateHistogramResultsNonNullableFields {
+    results: DateHistogramResultNonNullableFields[];
+}
+interface AggregationResultsNonNullableFields {
+    values?: ValueResultsNonNullableFields;
+    ranges?: RangeResultsNonNullableFields;
+    scalar?: AggregationResultsScalarResultNonNullableFields;
+    groupedByValue?: GroupByValueResultsNonNullableFields;
+    dateHistogram?: DateHistogramResultsNonNullableFields;
+    name: string;
+    type: AggregationType;
+    fieldPath: string;
+}
+interface AggregationDataNonNullableFields {
+    results: AggregationResultsNonNullableFields[];
+}
+export interface SearchReservationsResponseNonNullableFields {
+    reservations: ReservationNonNullableFields[];
+    aggregationData?: AggregationDataNonNullableFields;
+}
+export {};