@wix/table-reservations 1.0.0

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

@@ -0,0 +1,477 @@
+/** The reservation domain object. */
+export interface Reservation {
+    /**
+     * Reservation ID. Read-Only.
+     * @readonly
+     */
+    id?: string | null;
+    /** Status of the reservation. See the [Reservation Lifecycle article]() for more details on each of the statuses, and an explanations 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. */
+    reservee?: Reservee;
+    /**
+     * Information about the person making the reservation.
+     * @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 when the when the reservation was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time when the when 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;
+}
+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 been successfully finished. */
+    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"
+}
+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;
+    /** Table 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;
+}
+/** A person the reservation is being made for. */
+export interface Reservee {
+    /** First name. */
+    firstName?: string | null;
+    /** Last name. */
+    lastName?: string | null;
+    /** Email address. */
+    email?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Whether the reserve 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.
+     *
+     * 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;
+}
+export interface CreateReservationRequest {
+    /** Reservation details. */
+    reservation: Reservation;
+    /** Ignore table combination conflicts. This will ensure that the reservation is created even if the required tables are already reserved. */
+    ignoreTableCombinationConflicts?: TableCombinationConflictType[];
+    /** Ignore reservation location conflicts. This will ensure that the reservation is created even if the required seats or tables are unavailable according to the reservation location's business schedule or its 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`.
+     */
+    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;
+    /** Ignored table combination conflicts. This will ensure that the reservation is updated even if the required tables are already reserved. */
+    ignoreTableCombinationConflicts?: TableCombinationConflictType[];
+    /** Ignored reservation location conflicts. This will ensure that the reservation is updated even if the required seats or tables are unavailable according to the reservation location's business schedule or its 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;
+    /** Phone number that was used when the reservation was created. */
+    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;
+    /** The way how reservations in response should be sorted. */
+    sort?: Sorting;
+    /** Start date from. */
+    startDateFrom?: Date;
+    /** Start date to. */
+    startDateTo?: Date;
+    /** Only reservations with this status should be 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.
+     *
+     * 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"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    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 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. */
+    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;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+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 {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface Empty {
+}
+export interface CreateReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface GetReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface UpdateReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface CreateHeldReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface ReserveReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface CancelReservationResponseNonNullableFields {
+    reservation?: {
+        status: Status;
+        source: Source;
+    };
+}
+export interface ListReservationsResponseNonNullableFields {
+    reservations: {
+        status: Status;
+        source: Source;
+    }[];
+}
+export interface QueryReservationsResponseNonNullableFields {
+    reservations: {
+        status: Status;
+        source: Source;
+    }[];
+}

package/build/es/src/table-reservations-v1-reservation.types.js

@@ -0,0 +1,55 @@
+export var Status;
+(function (Status) {
+    Status["UNKNOWN"] = "UNKNOWN";
+    /** The reservation is held for 10 minutes, during which time the reservee should fill in their details. */
+    Status["HELD"] = "HELD";
+    /** The reservation has been reserved. */
+    Status["RESERVED"] = "RESERVED";
+    /** The reservation has been canceled. */
+    Status["CANCELED"] = "CANCELED";
+    /** The reservation has been successfully finished. */
+    Status["FINISHED"] = "FINISHED";
+    /** The reservee didn't arrive. */
+    Status["NO_SHOW"] = "NO_SHOW";
+    /** The reservee occupied the table. */
+    Status["SEATED"] = "SEATED";
+    /** The reservee requested a reservation and is waiting for manual approval. */
+    Status["REQUESTED"] = "REQUESTED";
+    /** The owner declined a reservee's request. */
+    Status["DECLINED"] = "DECLINED";
+})(Status || (Status = {}));
+export var Source;
+(function (Source) {
+    Source["UNKNOWN"] = "UNKNOWN";
+    /** The reservation is created by a User. */
+    Source["OFFLINE"] = "OFFLINE";
+    /** The reservation is created by UoU. */
+    Source["ONLINE"] = "ONLINE";
+    /** The reservation is created by a User. It can be created without reservee data. */
+    Source["WALK_IN"] = "WALK_IN";
+})(Source || (Source = {}));
+export var TableCombinationConflictType;
+(function (TableCombinationConflictType) {
+    TableCombinationConflictType["UNKNOWN"] = "UNKNOWN";
+    TableCombinationConflictType["RESERVED"] = "RESERVED";
+    TableCombinationConflictType["TOO_BIG"] = "TOO_BIG";
+    TableCombinationConflictType["TOO_SMALL"] = "TOO_SMALL";
+    TableCombinationConflictType["OFFLINE_ONLY"] = "OFFLINE_ONLY";
+})(TableCombinationConflictType || (TableCombinationConflictType = {}));
+export var Type;
+(function (Type) {
+    Type["UNKNOWN"] = "UNKNOWN";
+    Type["PARTY_PACING"] = "PARTY_PACING";
+    Type["SEAT_PACING"] = "SEAT_PACING";
+})(Type || (Type = {}));
+export var Set;
+(function (Set) {
+    Set["PUBLIC"] = "PUBLIC";
+    Set["FULL"] = "FULL";
+})(Set || (Set = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+//# sourceMappingURL=table-reservations-v1-reservation.types.js.map

package/build/es/src/table-reservations-v1-reservation.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table-reservations-v1-reservation.types.js","sourceRoot":"","sources":["../../../src/table-reservations-v1-reservation.types.ts"],"names":[],"mappings":"AAuDA,MAAM,CAAN,IAAY,MAkBX;AAlBD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,2GAA2G;IAC3G,uBAAa,CAAA;IACb,yCAAyC;IACzC,+BAAqB,CAAA;IACrB,yCAAyC;IACzC,+BAAqB,CAAA;IACrB,sDAAsD;IACtD,+BAAqB,CAAA;IACrB,kCAAkC;IAClC,6BAAmB,CAAA;IACnB,uCAAuC;IACvC,2BAAiB,CAAA;IACjB,+EAA+E;IAC/E,iCAAuB,CAAA;IACvB,+CAA+C;IAC/C,+BAAqB,CAAA;AACvB,CAAC,EAlBW,MAAM,KAAN,MAAM,QAkBjB;AAED,MAAM,CAAN,IAAY,MAQX;AARD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,4CAA4C;IAC5C,6BAAmB,CAAA;IACnB,yCAAyC;IACzC,2BAAiB,CAAA;IACjB,qFAAqF;IACrF,6BAAmB,CAAA;AACrB,CAAC,EARW,MAAM,KAAN,MAAM,QAQjB;AA6DD,MAAM,CAAN,IAAY,4BAMX;AAND,WAAY,4BAA4B;IACtC,mDAAmB,CAAA;IACnB,qDAAqB,CAAA;IACrB,mDAAmB,CAAA;IACnB,uDAAuB,CAAA;IACvB,6DAA6B,CAAA;AAC/B,CAAC,EANW,4BAA4B,KAA5B,4BAA4B,QAMvC;AAED,MAAM,CAAN,IAAY,IAIX;AAJD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,qCAA6B,CAAA;IAC7B,mCAA2B,CAAA;AAC7B,CAAC,EAJW,IAAI,KAAJ,IAAI,QAIf;AAmCD,MAAM,CAAN,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,wBAAiB,CAAA;IACjB,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,KAAH,GAAG,QAGd;AA2ID,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}