@wix/table-reservations 1.0.78 → 1.0.80

package/build/es/src/table-reservations-v1-reservation.universal.d.ts

@@ -1,1416 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/** The reservation domain object. */
-export interface Reservation {
-    /**
-     * Reservation ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Status of the reservation.
-     *
-     * Supported values:
-     *
-     * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. 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.
-     * * `REQUESTED`: 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.
-     * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
-     * * `RESERVED`: The reservation is confirmed.
-     * * `SEATED`: The customer is currently occupying the table.
-     * * `CANCELED`: The reservation is canceled.
-     * * `NO_SHOW`: The customer didn't show up for their reservation.
-     * * `FINISHED`: The reservation completed successfully.
-     *
-     *
-     * See the article for this API titled "The Reservation Lifecycle" in the menu on the left for more details on each of the statuses, and an explanation of the reservation lifecycle.
-     */
-    status?: Status;
-    /**
-     * Reservation source.
-     *
-     * This indicates how the reservation was made.
-     * * `ONLINE` indicates that the customer made the reservation through a website or app.
-     * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
-     * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.
-     */
-    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;
-    /**
-     * Date and time the reservation was changed.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * Revision number, which increments by 1 each time the reservation is updated.
-     * To prevent conflicting changes, the current revision must be passed 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;
-}
-export declare enum Status {
-    UNKNOWN = "UNKNOWN",
-    /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
-    HELD = "HELD",
-    /** The reservation has been reserved. */
-    RESERVED = "RESERVED",
-    /** The reservation has been canceled. */
-    CANCELED = "CANCELED",
-    /** The reservation has finished successfully. */
-    FINISHED = "FINISHED",
-    /** The reservee didn't arrive. */
-    NO_SHOW = "NO_SHOW",
-    /** The reservee occupied the table. */
-    SEATED = "SEATED",
-    /** The reservee requested a reservation and is waiting for manual approval. */
-    REQUESTED = "REQUESTED",
-    /** The owner declined a reservee's request. */
-    DECLINED = "DECLINED",
-    /** The reservation is held for 10 minutes from the created time, during which time the reservee should pay. After payment is completed status will be changed automatically to RESERVED. */
-    PAYMENT_PENDING = "PAYMENT_PENDING"
-}
-export declare enum Source {
-    UNKNOWN = "UNKNOWN",
-    /** The reservation is created by a User. */
-    OFFLINE = "OFFLINE",
-    /** The reservation is created by UoU. */
-    ONLINE = "ONLINE",
-    /** The reservation is created by a User. It can be created without reservee data. */
-    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. */
-    tableIds?: string[] | null;
-    /** Start date and time of the reservation. */
-    startDate?: Date;
-    /** End date and time of the reservation. */
-    endDate?: Date;
-    /** 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 {
-    UNKNOWN = "UNKNOWN",
-    /** A reservation is free of charge. */
-    FREE = "FREE",
-    /** A payment is not received yet. */
-    NOT_PAID = "NOT_PAID",
-    /** A corresponding to reservation order was fully payed. */
-    PAID = "PAID",
-    /** A corresponding to reservation order was refunded, but refund amount is less than order total price. */
-    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    /** A corresponding to reservation order was fully refunded. The refund amount equals total price. */
-    FULLY_REFUNDED = "FULLY_REFUNDED",
-    /** A corresponding to reservation order was partially payed. */
-    PARTIALLY_PAID = "PARTIALLY_PAID"
-}
-export interface CreateReservationRequest {
-    /** Reservation details. */
-    reservation: Reservation;
-    /**
-     * Ignore table combination conflicts of the types included 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 included 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 {
-    UNKNOWN = "UNKNOWN",
-    RESERVED = "RESERVED",
-    TOO_BIG = "TOO_BIG",
-    TOO_SMALL = "TOO_SMALL",
-    OFFLINE_ONLY = "OFFLINE_ONLY"
-}
-export declare enum Type {
-    UNKNOWN = "UNKNOWN",
-    PARTY_PACING = "PARTY_PACING",
-    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.
-     *
-     * Supported values: `PUBLIC`, `FULL`.
-     *
-     * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
-     */
-    fieldsets?: Set[];
-}
-export declare enum Set {
-    PUBLIC = "PUBLIC",
-    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.
-     *
-     * 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 included in the array. This ensures that the reservation is updated 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 interface UpdateReservationResponse {
-    /** Reservation. */
-    reservation?: Reservation;
-}
-export interface ReservationDataUpdated {
-    /** Reserved reservation. */
-    reservation?: Reservation;
-    /** Old reservation. */
-    oldReservation?: 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;
-    /** Party size. */
-    partySize?: number | null;
-}
-export interface CreateHeldReservationResponse {
-    /** Reservation. */
-    reservation?: Reservation;
-}
-export interface ReserveReservationRequest {
-    /** Reservation ID. */
-    reservationId: string;
-    /** Reservee details. */
-    reservee: Reservee;
-    /**
-     * Revision number.
-     *
-     * Include the existing `revision` to prevent conflicting updates to reservations.
-     */
-    revision: string | null;
-}
-export interface ReserveReservationResponse {
-    /** Reservation. */
-    reservation?: Reservation;
-}
-export interface ReservationReserved {
-    /** Reserved reservation. */
-    reservation?: Reservation;
-}
-export interface CancelReservationRequest {
-    /** Reservation ID. */
-    reservationId: string;
-    /**
-     * Revision number.
-     *
-     * Include 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;
-    revision?: 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;
-    /** Only reservations starting before this date are returned. */
-    startDateTo?: Date;
-    /**
-     * Only reservations with this status are returned.
-     *
-     * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. 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.
-     * * `REQUESTED`: 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.
-     * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
-     * * `RESERVED`: The reservation is confirmed.
-     * * `SEATED`: The customer is currently occupying the table.
-     * * `CANCELED`: The reservation is canceled.
-     * * `NO_SHOW`: The customer didn't show up for their reservation.
-     * * `FINISHED`: The reservation completed successfully.
-     */
-    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.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
-     */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    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-and-filtering) 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 page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
-    cursorPaging?: CursorPaging;
-    /** A filter object. See the filter section [here](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/wix-api-basics/1011-wql-wix-query-language) */
-    filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
-    sort?: Sorting[];
-    /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
-    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 page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
-    cursorPaging?: CursorPaging;
-}
-export interface Aggregation extends AggregationKindOneOf {
-    value?: ValueAggregation;
-    range?: RangeAggregation;
-    scalar?: ScalarAggregation;
-    dateHistogram?: DateHistogramAggregation;
-    nested?: NestedAggregation;
-    name?: string | null;
-    type?: AggregationType;
-    fieldPath?: string;
-    groupBy?: GroupByAggregation;
-}
-/** @oneof */
-export interface AggregationKindOneOf {
-    value?: ValueAggregation;
-    range?: RangeAggregation;
-    scalar?: ScalarAggregation;
-    dateHistogram?: DateHistogramAggregation;
-    nested?: NestedAggregation;
-}
-export interface RangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given. */
-    from?: number | null;
-    /** Exclusive upper bound of the range. Required if from is not given. */
-    to?: number | null;
-}
-export declare enum SortType {
-    COUNT = "COUNT",
-    VALUE = "VALUE"
-}
-export declare enum SortDirection {
-    DESC = "DESC",
-    ASC = "ASC"
-}
-export declare enum MissingValues {
-    EXCLUDE = "EXCLUDE",
-    INCLUDE = "INCLUDE"
-}
-export interface IncludeMissingValuesOptions {
-    /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
-    addToBucket?: string;
-}
-export declare enum ScalarType {
-    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    COUNT_DISTINCT = "COUNT_DISTINCT",
-    MIN = "MIN",
-    MAX = "MAX",
-    SUM = "SUM",
-    AVG = "AVG"
-}
-export interface ValueAggregation extends ValueAggregationOptionsOneOf {
-    /** options for including missing values */
-    includeOptions?: IncludeMissingValuesOptions;
-    sortType?: SortType;
-    sortDirection?: SortDirection;
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
-    limit?: number | null;
-    /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
-    missingValues?: MissingValues;
-}
-/** @oneof */
-export interface ValueAggregationOptionsOneOf {
-    /** options for including missing values */
-    includeOptions?: IncludeMissingValuesOptions;
-}
-export declare enum NestedAggregationType {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    VALUE = "VALUE",
-    RANGE = "RANGE",
-    SCALAR = "SCALAR",
-    DATE_HISTOGRAM = "DATE_HISTOGRAM"
-}
-export interface RangeAggregation {
-    buckets?: RangeBucket[];
-}
-export interface ScalarAggregation {
-    type?: ScalarType;
-}
-export interface DateHistogramAggregation {
-    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 {
-    value?: ValueAggregation;
-    range?: RangeAggregation;
-    scalar?: ScalarAggregation;
-    dateHistogram?: DateHistogramAggregation;
-    name?: string | null;
-    type?: NestedAggregationType;
-    fieldPath?: string;
-}
-/** @oneof */
-export interface NestedAggregationItemKindOneOf {
-    value?: ValueAggregation;
-    range?: RangeAggregation;
-    scalar?: ScalarAggregation;
-    dateHistogram?: DateHistogramAggregation;
-}
-export declare enum AggregationType {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    VALUE = "VALUE",
-    RANGE = "RANGE",
-    SCALAR = "SCALAR",
-    DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    NESTED = "NESTED"
-}
-export interface NestedAggregation {
-    nestedAggregations?: NestedAggregationItem[];
-}
-export interface GroupByAggregation extends GroupByAggregationKindOneOf {
-    value?: ValueAggregation;
-    name?: string | null;
-    fieldPath?: string;
-}
-/** @oneof */
-export interface GroupByAggregationKindOneOf {
-    value?: ValueAggregation;
-}
-export interface SearchDetails {
-    /** boolean search mode */
-    mode?: Mode;
-    /** search term or expression */
-    expression?: string | null;
-    /** fields to search in. if empty - server will search in own default fields */
-    fields?: string[];
-    /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
-    fuzzy?: boolean;
-}
-export declare enum Mode {
-    /** any */
-    OR = "OR",
-    /** all */
-    AND = "AND"
-}
-export interface SearchReservationsResponse {
-    /** List of Reservations. */
-    reservations?: Reservation[];
-    /** Cursor paging metadata. */
-    pagingMetadata?: CursorPagingMetadata;
-    /** Aggregation data. */
-    aggregationData?: AggregationData;
-}
-export interface AggregationData {
-    /** key = aggregation name (as derived from search request) */
-    results?: AggregationResults[];
-}
-export interface ValueAggregationResult {
-    value?: string;
-    count?: number;
-}
-export interface RangeAggregationResult {
-    from?: number | null;
-    to?: number | null;
-    count?: number;
-}
-export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
-    values?: ValueResults;
-    ranges?: RangeResults;
-    scalar?: ScalarResult;
-    name?: string;
-    type?: AggregationType;
-    fieldPath?: string;
-}
-/** @oneof */
-export interface NestedAggregationResultsResultOneOf {
-    values?: ValueResults;
-    ranges?: RangeResults;
-    scalar?: ScalarResult;
-}
-export interface ValueResults {
-    results?: ValueAggregationResult[];
-}
-export interface RangeResults {
-    results?: RangeAggregationResult[];
-}
-export interface ScalarResult {
-    type?: ScalarType;
-    value?: number;
-}
-export interface NestedValueAggregationResult {
-    value?: string;
-    nestedResults?: NestedAggregationResults;
-}
-export interface ValueResult {
-    value?: string;
-    count?: number | null;
-}
-export interface RangeResult {
-    from?: number | null;
-    to?: number | null;
-    count?: number | null;
-}
-export interface NestedResultsScalarResult {
-    value?: number;
-}
-export interface NestedResultValue extends NestedResultValueResultOneOf {
-    value?: ValueResult;
-    range?: RangeResult;
-    scalar?: NestedResultsScalarResult;
-    dateHistogram?: ValueResult;
-}
-/** @oneof */
-export interface NestedResultValueResultOneOf {
-    value?: ValueResult;
-    range?: RangeResult;
-    scalar?: NestedResultsScalarResult;
-    dateHistogram?: ValueResult;
-}
-export interface Results {
-    results?: Record<string, NestedResultValue>;
-}
-export interface DateHistogramResult {
-    value?: string;
-    count?: number;
-}
-export interface GroupByValueResults {
-    results?: NestedValueAggregationResult[];
-}
-export interface DateHistogramResults {
-    results?: DateHistogramResult[];
-}
-export interface NestedResults {
-    results?: Results[];
-}
-export interface AggregationResults extends AggregationResultsResultOneOf {
-    values?: ValueResults;
-    ranges?: RangeResults;
-    scalar?: ScalarResult;
-    groupedByValue?: GroupByValueResults;
-    dateHistogram?: DateHistogramResults;
-    nested?: NestedResults;
-    name?: string;
-    type?: AggregationType;
-    fieldPath?: string;
-}
-/** @oneof */
-export interface AggregationResultsResultOneOf {
-    values?: ValueResults;
-    ranges?: RangeResults;
-    scalar?: ScalarResult;
-    groupedByValue?: GroupByValueResults;
-    dateHistogram?: DateHistogramResults;
-    nested?: NestedResults;
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    /** Information about the reservation that was created and event metadata. */
-    createdEvent?: EntityCreatedEvent<T>;
-    /** Information about the reservation that was updated and event metadata. */
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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. */
-    eventTime?: Date;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface Empty {
-}
-export interface RemoveReservationMigrationNotesRequest {
-    /** Reservation ID. */
-    reservationId?: string;
-    /** Revision. */
-    revision?: string;
-}
-export interface RemoveReservationMigrationNotesResponse {
-    reservation?: Reservation;
-}
-export interface CreateReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface GetReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface UpdateReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface CreateHeldReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface ReserveReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface CancelReservationResponseNonNullableFields {
-    reservation?: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    };
-}
-export interface ListReservationsResponseNonNullableFields {
-    reservations: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    }[];
-}
-export interface QueryReservationsResponseNonNullableFields {
-    reservations: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    }[];
-}
-export interface SearchReservationsResponseNonNullableFields {
-    reservations: {
-        status: Status;
-        source: Source;
-        paymentStatus: PaymentStatus;
-    }[];
-    aggregationData?: {
-        results: {
-            values?: {
-                results: {
-                    value: string;
-                    count: number;
-                }[];
-            };
-            ranges?: {
-                results: {
-                    count: number;
-                }[];
-            };
-            scalar?: {
-                type: ScalarType;
-                value: number;
-            };
-            groupedByValue?: {
-                results: {
-                    value: string;
-                    nestedResults?: {
-                        values?: {
-                            results: {
-                                value: string;
-                                count: number;
-                            }[];
-                        };
-                        ranges?: {
-                            results: {
-                                count: number;
-                            }[];
-                        };
-                        scalar?: {
-                            type: ScalarType;
-                            value: number;
-                        };
-                        name: string;
-                        type: AggregationType;
-                        fieldPath: string;
-                    };
-                }[];
-            };
-            dateHistogram?: {
-                results: {
-                    value: string;
-                    count: number;
-                }[];
-            };
-            nested?: {
-                results: {
-                    results?: {
-                        value?: {
-                            value: string;
-                        };
-                        scalar?: {
-                            value: number;
-                        };
-                        dateHistogram?: {
-                            value: string;
-                        };
-                    };
-                }[];
-            };
-            name: string;
-            type: AggregationType;
-            fieldPath: string;
-        }[];
-    };
-}
-export declare const onReservationCreated: EventDefinition<DomainCreatedEvent<Reservation>, "wix.table_reservations.v1.reservation_created">;
-export declare const onReservationUpdated: EventDefinition<DomainUpdatedEvent<Reservation>, "wix.table_reservations.v1.reservation_updated">;
-/**
- * Creates a new reservation.
- *
- * `createReservation()` accepts and requires different fields depending on the `status` provided and your permissions.
- *
- * **Status and source**
- *
- * If a `status` is not provided, it will be set to:
- * * `RESERVED` if manual approval is not required for confirmation
- * * `REQUESTED` if manual approval is required for confirmation.
- *
- * 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 will result in an error.
- *
- * **Permissions**
- *
- * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
- *
- * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
- *
- *
- *  > **Note:** `createReservation()` requires all details of the reservation upfront. The process of creating a reservation can be broken up using `createHeldReservation`.  `createHeldReservation` creates a temporary reservation that expires automatically unless it is completed with the addition of more details using `reserveReservation()`.
- * @param reservation - Reservation details.
- * @public
- * @documentationMaturity preview
- * @requiredField reservation
- * @requiredField reservation.details
- * @requiredField reservation.details.partySize
- * @requiredField reservation.details.reservationLocationId
- * @requiredField reservation.details.startDate
- * @param options - Options for creating the reservation.
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Basic)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Reservation.
- */
-export declare function createReservation(reservation: Reservation, options?: CreateReservationOptions): Promise<Reservation & NonNullable<CreateReservationResponseNonNullableFields>['reservation']>;
-export interface CreateReservationOptions {
-    /**
-     * Ignore table combination conflicts of the types included 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 included 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[];
-}
-/**
- * Retrieves a reservation.
- *
- * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
- * @param reservationId - Reservation ID.
- * @public
- * @documentationMaturity preview
- * @requiredField reservationId
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Basic)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Reservation.
- */
-export declare function getReservation(reservationId: string, options?: GetReservationOptions): Promise<Reservation & NonNullable<GetReservationResponseNonNullableFields>['reservation']>;
-export interface GetReservationOptions {
-    /**
-     * Array of named, predefined sets of projected fields to be returned.
-     *
-     * Supported values: `PUBLIC`, `FULL`.
-     *
-     * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
-     */
-    fieldsets?: Set[];
-}
-/**
- * Updates a reservation.
- *
- * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, and `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
- *
- * Each time the reservation is updated, revision increments by 1. The existing revision must be included when updating the reservation. This ensures you're working with the latest reservation information, and it prevents unintended overwrites.
- * @param _id - Reservation ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField reservation
- * @requiredField reservation.revision
- * @param options - Options for updating the reservation.
- * @param reservation - Reservation information to update.
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- * @returns Reservation.
- */
-export declare function updateReservation(_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions): Promise<Reservation & NonNullable<UpdateReservationResponseNonNullableFields>['reservation']>;
-export interface UpdateReservation {
-    /**
-     * Reservation ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Status of the reservation.
-     *
-     * See the article for this API titled "The Reservation Lifecycle" in the menu on the left for more details on each of the statuses, and an explanation of the reservation lifecycle.
-     */
-    status?: Status;
-    /**
-     * Reservation source.
-     *
-     * This indicates how the reservation was made.
-     * * `ONLINE` indicates that the customer made the reservation through a website or app.
-     * * `OFFLINE` indicates that the reservation was made by a restaurant employee, for example when a customer calls to make a reservation.
-     * * `WALK-IN` indicates that the customer did not make a reservation beforehand, and the reservation was entered into the system by a restaurant employee when the customer arrived at the restaurant.
-     */
-    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;
-    /**
-     * Date and time the reservation was changed.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * Revision number, which increments by 1 each time the reservation is updated.
-     * To prevent conflicting changes, the current revision must be passed 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;
-}
-export interface UpdateReservationOptions {
-    /**
-     * 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.
-     *
-     * 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 included in the array. This ensures that the reservation is updated 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[];
-}
-/**
- * Creates a new temporary reservation and holds it for the customer for 10 minutes.
- *
- * Creates a new reservation with the `HELD` status. `HELD` reservations are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to change a `HELD` reservation’s status after 10 minutes returns an error.
- *
- * You cannot call `updateReservation()` to change a reservation’s status from `HELD`. Trying to do so returns an error. Instead, you should use `reserveReservation()`.
- *
- * If you do not wish to have `HELD` reservations in your flow, you can create a reservation with all required details using `createReservation()`.
- *
- * @param reservationDetails - Held reservation information to update.
- * @public
- * @documentationMaturity preview
- * @requiredField reservationDetails
- * @requiredField reservationDetails.partySize
- * @requiredField reservationDetails.reservationLocationId
- * @requiredField reservationDetails.startDate
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Basic)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function createHeldReservation(reservationDetails: HeldReservationDetails): Promise<CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields>;
-/**
- * Reserves or requests a held reservation.
- *
- * Held reservations are temporary reservations with the `HELD` status created by `createHeldReservation()`.
- *
- * They are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the `HELD` status are only valid for 10 minutes. Trying to call `Reserve Reservation` with a held reservation older than 10 minutes returns an error.
- *
- * `Reserve Reservation` changes a reservation's `HELD` status to:
- * * `RESERVED` if the reservation's reservation location does not require manual approval.
- * * `REQUESTED` if the reservation's reservation location requires manual approval.
- * @param reservationId - Reservation ID.
- * @param reservee - Reservee details.
- * @param revision - Revision number.
- *
- * Include the existing `revision` to prevent conflicting updates to reservations.
- * @public
- * @documentationMaturity preview
- * @requiredField reservationId
- * @requiredField reservee
- * @requiredField reservee.firstName
- * @requiredField reservee.phone
- * @requiredField revision
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Basic)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function reserveReservation(reservationId: string, reservee: Reservee, revision: string | null): Promise<ReserveReservationResponse & ReserveReservationResponseNonNullableFields>;
-/**
- * Cancels a reservation.
- *
- * Sets the reservation status to `CANCELED`.
- * @param reservationId - Reservation ID.
- * @param revision - Revision number.
- *
- * Include the existing `revision` to prevent conflicting updates to reservations.
- * @public
- * @documentationMaturity preview
- * @requiredField reservationId
- * @requiredField revision
- * @param options - Options for canceling the reservation.
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @permissionScope Manage Reservations (Basic)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-BASIC
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function cancelReservation(reservationId: string, revision: string | null, options?: CancelReservationOptions): Promise<CancelReservationResponse & CancelReservationResponseNonNullableFields>;
-export interface CancelReservationOptions {
-    /**
-     * 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;
-}
-/**
- * Retrieves a list of up to 100 reservations.
- * @public
- * @documentationMaturity preview
- * @param options - Options for listing the reservations.
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- */
-export declare function listReservations(options?: ListReservationsOptions): Promise<ListReservationsResponse & ListReservationsResponseNonNullableFields>;
-export interface ListReservationsOptions {
-    /** 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;
-    /** Only reservations starting before this date are returned. */
-    startDateTo?: Date;
-    /**
-     * Only reservations with this status are returned.
-     *
-     * * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. 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.
-     * * `REQUESTED`: 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.
-     * * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
-     * * `RESERVED`: The reservation is confirmed.
-     * * `SEATED`: The customer is currently occupying the table.
-     * * `CANCELED`: The reservation is canceled.
-     * * `NO_SHOW`: The customer didn't show up for their reservation.
-     * * `FINISHED`: The reservation completed successfully.
-     */
-    status?: Status;
-}
-/**
- * Creates a query to retrieve a list of reservations.
- *
- * The `queryReservations()` function builds a query to retrieve a list of reservations and returns a [`ReservationsQueryBuilder`](#ReservationsQueryBuilder) object.
- *
- * The returned object contains the query definition, which is used to run the query using the [find()](#ReservationsQueryBuilder/find) function.
- *
- * You can refine the query by chaining `ReservationsQueryBuilder` functions onto the query. `ReservationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryReservations()` returns.
- *
- * `queryReservations()` runs with the following `ReservationsQueryBuilder` defaults, which you can override:
- *
- * * [`skip(0)`](#ReservationsQueryBuilder/skip)
- * * [`limit(50)`](#ReservationsQueryBuilder/limit)
- * * [`descending('_createdDate')`](#ReservationsQueryBuilder/descending)
- *
- * The following `ReservationsQueryBuilder` functions are supported for `queryReservations()`. For a full description of the reservation object, see the object returned for the [`items`](#ReservationsQueryResult/items) property in [`ReservationsQueryResult`](#ReservationsQueryResult).
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- */
-export declare function queryReservations(): ReservationsQueryBuilder;
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface ReservationsQueryResult extends QueryCursorResult {
-    items: Reservation[];
-    query: ReservationsQueryBuilder;
-    next: () => Promise<ReservationsQueryResult>;
-    prev: () => Promise<ReservationsQueryResult>;
-}
-export interface ReservationsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    eq: (propertyName: '_id' | 'status' | 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ne: (propertyName: '_id' | 'status' | 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ge: (propertyName: 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    le: (propertyName: 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: '_id' | 'status' | 'details.startDate', value: any) => ReservationsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    ascending: (...propertyNames: Array<'details.startDate'>) => ReservationsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    descending: (...propertyNames: Array<'details.startDate'>) => ReservationsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
-    limit: (limit: number) => ReservationsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
-    skipTo: (cursor: string) => ReservationsQueryBuilder;
-    /** @documentationMaturity preview */
-    find: () => Promise<ReservationsQueryResult>;
-}
-/** @param search - Search query.
- * @public
- * @documentationMaturity preview
- * @requiredField search
- * @permissionScope Manage Reservations (Medium)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-MEDIUM
- * @permissionScope Manage Reservations (Full)
- * @permissionScopeId SCOPE.DC-RESERVATIONS.MANAGE-RESERVATIONS-FULL
- * @applicableIdentity APP
- */
-export declare function searchReservations(search: CursorSearch): Promise<SearchReservationsResponse & SearchReservationsResponseNonNullableFields>;
-export {};