order3000 0.18.4 → 0.19.0

package/dist/client.d.mts

@@ -55,6 +55,280 @@ declare abstract class BaseResource {
 
 interface components {
     schemas: {
+        /**
+         * Area
+         * @description A bookable + public area for a venue. Assets are only included when the request expands them.
+         */
+        Area: {
+            id: string;
+            venueId: string;
+            accessor: string;
+            name: {
+                [key: string]: string;
+            };
+            description: {
+                [key: string]: string;
+            } | null;
+            longDescription: {
+                [key: string]: string;
+            } | null;
+            minCapacity: number | null;
+            maxCapacity: number;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            basePrice: number | null;
+            perPersonPrice: number | null;
+            features: {
+                icon: string;
+                label: {
+                    [key: string]: string;
+                };
+                description?: {
+                    [key: string]: string;
+                };
+            }[] | null;
+            /** @enum {string} */
+            bookingMode: "slot" | "day";
+            assets?: {
+                id: string;
+                /** @enum {string} */
+                type: "image" | "video" | "document";
+                tags: string[] | null;
+                filename: string;
+                contentType: string;
+                metadata: {
+                    width?: number;
+                    height?: number;
+                    duration?: number;
+                } | null;
+                cropArea: {
+                    x: number;
+                    y: number;
+                    width: number;
+                    height: number;
+                } | null;
+                /** Format: uri */
+                publicUrl: string;
+            }[];
+        };
+        /** ListAreasResponse */
+        ListAreasResponse: components["schemas"]["Area"][];
+        /**
+         * GetAreaResponse
+         * @description A bookable + public area for a venue. Assets are only included when the request expands them.
+         */
+        GetAreaResponse: {
+            id: string;
+            venueId: string;
+            accessor: string;
+            name: {
+                [key: string]: string;
+            };
+            description: {
+                [key: string]: string;
+            } | null;
+            longDescription: {
+                [key: string]: string;
+            } | null;
+            minCapacity: number | null;
+            maxCapacity: number;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            basePrice: number | null;
+            perPersonPrice: number | null;
+            features: {
+                icon: string;
+                label: {
+                    [key: string]: string;
+                };
+                description?: {
+                    [key: string]: string;
+                };
+            }[] | null;
+            /** @enum {string} */
+            bookingMode: "slot" | "day";
+            assets?: {
+                id: string;
+                /** @enum {string} */
+                type: "image" | "video" | "document";
+                tags: string[] | null;
+                filename: string;
+                contentType: string;
+                metadata: {
+                    width?: number;
+                    height?: number;
+                    duration?: number;
+                } | null;
+                cropArea: {
+                    x: number;
+                    y: number;
+                    width: number;
+                    height: number;
+                } | null;
+                /** Format: uri */
+                publicUrl: string;
+            }[];
+        };
+        /** GetAreaAvailabilityResponse */
+        GetAreaAvailabilityResponse: {
+            from: string;
+            to: string;
+            /** @enum {string} */
+            bookingMode: "slot" | "day";
+            occupied: {
+                date: string;
+                startTime: string | null;
+                endTime: string | null;
+            }[];
+        };
+        /** SubmitAreaBookingRequest */
+        SubmitAreaBookingRequest: {
+            requestedDate: string;
+            requestedStartTime?: string;
+            requestedEndTime?: string;
+            partySize: number;
+            customerFirstName: string;
+            customerLastName: string;
+            /** Format: email */
+            customerEmail: string;
+            customerPhone?: string;
+            message?: string;
+            /** @enum {string} */
+            source?: "website" | "phone" | "walk_in";
+        };
+        /** SubmitAreaBookingResponse */
+        SubmitAreaBookingResponse: {
+            id: string;
+            venueId: string;
+            areaId: string;
+            requestedDate: string;
+            requestedStartTime: string | null;
+            requestedEndTime: string | null;
+            partySize: number;
+            customerFirstName: string;
+            customerLastName: string;
+            customerEmail: string;
+            customerPhone: string | null;
+            message: string | null;
+            /** @enum {string} */
+            source: "website" | "phone" | "walk_in";
+            /** @enum {string} */
+            status: "pending" | "approved" | "rejected" | "cancelled";
+            areaBookingId: string | null;
+            createdAt: string | null;
+            updatedAt: string | null;
+        };
+        /**
+         * AddToBasketRequest
+         * @description Add an item to the shopping basket
+         */
+        AddToBasketRequest: {
+            /** Format: uuid */
+            venueId: string;
+            sessionId: string;
+            menuItems: {
+                menuItemId: string;
+                role?: string;
+                quantity?: number;
+                /** @enum {string} */
+                unit?: "grams" | "kilograms" | "liters" | "milliliters" | "pieces";
+            }[];
+            metadata?: {
+                [key: string]: unknown;
+            };
+        };
+        /** AddToBasketResponse */
+        AddToBasketResponse: {
+            /** Format: uuid */
+            basketItemId: string;
+            itemCount: number;
+            deposit: {
+                depositwareTemplateId: string;
+                name: {
+                    [key: string]: string;
+                };
+                amount: number;
+                /** @enum {string} */
+                currency: "EUR" | "CHF";
+            } | null;
+            totals: {
+                /** @enum {string} */
+                currency: "EUR" | "CHF";
+                itemsTotal: number;
+                taxAmount: number;
+                depositCharge: number;
+                grossTotal: number;
+                depositCredit: number;
+                effectiveTotal: number;
+                cashRefund: number;
+                returnable: {
+                    depositwareTemplateId: string;
+                    count: number;
+                }[];
+            };
+        };
+        /** RemoveFromBasketResponse */
+        RemoveFromBasketResponse: {
+            success: boolean;
+            /** Format: uuid */
+            basketItemId: string;
+            itemCount: number;
+            totals: {
+                /** @enum {string} */
+                currency: "EUR" | "CHF";
+                itemsTotal: number;
+                taxAmount: number;
+                depositCharge: number;
+                grossTotal: number;
+                depositCredit: number;
+                effectiveTotal: number;
+                cashRefund: number;
+                returnable: {
+                    depositwareTemplateId: string;
+                    count: number;
+                }[];
+            } | null;
+        };
+        /** GetBasketTotalsRequest */
+        GetBasketTotalsRequest: {
+            declaredReturns?: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** GetBasketTotalsResponse */
+        GetBasketTotalsResponse: {
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            itemsTotal: number;
+            taxAmount: number;
+            depositCharge: number;
+            grossTotal: number;
+            depositCredit: number;
+            effectiveTotal: number;
+            cashRefund: number;
+            returnable: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** SetBasketDeclaredReturnsRequest */
+        SetBasketDeclaredReturnsRequest: {
+            basketId: string;
+            sessionId: string;
+            declaredReturns: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** SetBasketDeclaredReturnsResponse */
+        SetBasketDeclaredReturnsResponse: {
+            basketId: string;
+            declaredReturns: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
         /**
          * CreateEventRequest
          * @description Request payload for creating a new event
@@ -95,6 +369,7 @@ interface components {
                 intervalMinutes?: number | null;
                 durationMinutes?: number | null;
             } | null;
+            ritualAccessor?: string | null;
             venueAccessor: string;
         };
         /**
@@ -112,6 +387,7 @@ interface components {
                 [key: string]: unknown;
             } | unknown[]) | null;
             scheduleId: string | null;
+            ritualId: string | null;
             maxBookings: number | null;
             maxGuests: number | null;
             minPartySize: number | null;
@@ -129,6 +405,34 @@ interface components {
             createdAt: unknown;
             updatedAt: unknown;
         };
+        /**
+         * GetMenuResponse
+         * @description Menu details. Nested arrays (items, assets, bundles, schedule, etc.) pass through; their shape follows the SDK Menu interface.
+         */
+        GetMenuResponse: {
+            id: string;
+            venueId: string;
+            accessor: string;
+            name: {
+                [key: string]: string;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+        /** ListMenuBundlesResponse */
+        ListMenuBundlesResponse: ({
+            id: string;
+            menuId: string;
+        } & {
+            [key: string]: unknown;
+        })[];
+        /** ListMenuSubscriptionsResponse */
+        ListMenuSubscriptionsResponse: ({
+            id: string;
+            menuId: string;
+        } & {
+            [key: string]: unknown;
+        })[];
         /**
          * PlaceOrderRequest
          * @description Place a new order for a specific venue
@@ -190,6 +494,67 @@ interface components {
             participantDisplayName: string | null;
             leadSettledAt: unknown;
         };
+        /** CreatePaymentIntentRequest */
+        CreatePaymentIntentRequest: {
+            basketId: string;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            sessionId: string;
+            /** @enum {string} */
+            fulfillmentType: "pickup" | "delivery";
+            /** Format: date-time */
+            fulfillmentAt?: string | null;
+            customerFirstName?: string;
+            customerLastName?: string;
+            teamOrderPublicId?: string;
+            declaredReturns?: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** CreatePaymentIntentResponse */
+        CreatePaymentIntentResponse: {
+            clientSecret: string | null;
+            paymentIntentId: string;
+            orderId: string;
+        };
+        /** CreateDeltaPaymentIntentRequest */
+        CreateDeltaPaymentIntentRequest: {
+            basketId: string;
+            sessionId: string;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            declaredReturns?: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** CreateDeltaPaymentIntentResponse */
+        CreateDeltaPaymentIntentResponse: {
+            clientSecret: string | null;
+            paymentIntentId: string;
+            orderId: string;
+            amount: number;
+            /** @enum {string} */
+            status: "requires_payment_method" | "requires_confirmation" | "requires_action" | "processing" | "requires_capture" | "canceled" | "succeeded";
+        };
+        /** ReduceDeltaPaymentIntentRequest */
+        ReduceDeltaPaymentIntentRequest: {
+            basketId: string;
+            sessionId: string;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            declaredReturns?: {
+                depositwareTemplateId: string;
+                count: number;
+            }[];
+        };
+        /** ReduceDeltaPaymentIntentResponse */
+        ReduceDeltaPaymentIntentResponse: {
+            orderId: string;
+            paidTotal: number;
+            released: number;
+        };
         /**
          * MakeReservationRequest
          * @description Request payload for making a new reservation
@@ -330,6 +695,377 @@ interface components {
             /** @description Last update timestamp */
             updatedAt: unknown;
         };
+        /** GetSubscriptionResponse */
+        GetSubscriptionResponse: {
+            id: string;
+            menuId: string;
+            accessor: string;
+            name: {
+                [key: string]: string;
+            };
+            shortName: {
+                [key: string]: string;
+            } | null;
+            description: {
+                [key: string]: string;
+            } | null;
+            scheduleId: string | null;
+            allowance: number;
+            /** @enum {string} */
+            billingPeriod: "week" | "month" | "year";
+            /** @enum {string} */
+            allowancePeriod: "week" | "month" | "year";
+            redeemableTagSets: string[] | null;
+            expiryInDays: number | null;
+            price: number;
+            /** @enum {string} */
+            currency: "EUR" | "CHF";
+            isActive: boolean;
+            sortIndex: number | null;
+            posters: {
+                id: string;
+                menuSubscriptionId: string;
+                storagePath: string;
+                /** Format: uri */
+                publicUrl: string;
+                filename: string;
+                contentType: string;
+                sizeBytes: number | null;
+                sortIndex: number | null;
+                createdBy: string | null;
+                createdAt: string | null;
+            }[];
+        };
+        /** SubscribeRequest */
+        SubscribeRequest: {
+            /** Format: email */
+            email: string;
+            firstName?: string;
+            lastName?: string;
+            sessionId?: string;
+            /** Format: uri */
+            successUrl: string;
+            /** Format: uri */
+            cancelUrl: string;
+        };
+        /** SubscribeResponse */
+        SubscribeResponse: {
+            /** Format: uri */
+            checkoutUrl: string | null;
+            sessionId: string;
+        };
+        /** CancelSubscriptionRequest */
+        CancelSubscriptionRequest: {
+            subscriberId: string;
+        };
+        /** CancelSubscriptionResponse */
+        CancelSubscriptionResponse: {
+            /** @enum {boolean} */
+            success: true;
+        };
+        /** GetSubscriptionCreditsResponse */
+        GetSubscriptionCreditsResponse: {
+            id: string;
+            subscriberId: string;
+            periodStart: string;
+            periodEnd: string;
+            expiresAt: string | null;
+            /** @enum {string} */
+            status: "available" | "redeemed" | "expired";
+            redeemedAt: string | null;
+            orderId: string | null;
+            createdAt: string | null;
+        }[];
+        /**
+         * CreateTeamOrderRequest
+         * @description Create a team order: promotes the lead's active basket into a shared team basket and returns the share token.
+         */
+        CreateTeamOrderRequest: {
+            /** Format: uuid */
+            venueId: string;
+            sessionId: string;
+            /** Format: uuid */
+            menuId: string;
+            leadDisplayName: string;
+            teamName?: string;
+            /** Format: uri */
+            logoUrl?: string;
+            /** Format: date-time */
+            deadlineAt?: string | null;
+            /** @enum {string} */
+            fulfillmentType: "pickup" | "delivery";
+            /** Format: date-time */
+            fulfillmentAt?: string | null;
+            deliveryAddress?: {
+                street: string;
+                city: string;
+                state: string;
+                postalCode: string;
+                country: string;
+            };
+            allowedPaymentMethods: ("card" | "cash" | "voucher")[];
+            /** Format: uuid */
+            eventId?: string;
+        };
+        /** CreateTeamOrderResponse */
+        CreateTeamOrderResponse: {
+            publicId: string;
+            /** Format: uuid */
+            teamOrderId: string;
+        };
+        /** FetchTeamOrderResponse */
+        FetchTeamOrderResponse: {
+            teamOrder: {
+                id: string;
+                publicId: string;
+                venueId: string;
+                menuId: string;
+                eventId: string | null;
+                teamName: string | null;
+                logoUrl: string | null;
+                leadDisplayName: string;
+                /** @enum {string} */
+                status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+                allowedPaymentMethods: ("card" | "cash" | "voucher")[];
+                /** @enum {string} */
+                fulfillmentType: "pickup" | "delivery";
+                /** Format: date-time */
+                fulfillmentAt: string | null;
+                /** Format: date-time */
+                deadlineAt: string | null;
+                /** Format: date-time */
+                lockedAt: string | null;
+                /** Format: date-time */
+                placedAt: string | null;
+                /** Format: date-time */
+                cancelledAt: string | null;
+                cancelReason: string | null;
+                deliveryAddressId: string | null;
+                diningLocation: string | null;
+                diningTime: string | null;
+                isDeliveryEnabled: boolean;
+                quickReferenceNumber: number | null;
+            };
+            deliveryThreshold: {
+                amount: number | null;
+                quantity: number | null;
+            };
+            participants: {
+                customerId: string;
+                basketId: string | null;
+                orderId: string | null;
+                participantNumber: number | null;
+                displayName: string | null;
+                /** @enum {string} */
+                status: "browsing" | "authorized" | "cash_pending" | "placed" | "completed" | "cancelled";
+                bundleCount: number;
+                amount: number;
+                /** @enum {string|null} */
+                paymentMethod: "card" | "cash" | "voucher" | null;
+                isLead: boolean;
+                isMe: boolean;
+                /** Format: date-time */
+                joinedAt: string;
+                items: {
+                    id: string;
+                    metadata: unknown;
+                    menuItems: {
+                        menuItemId: string;
+                        role: string | null;
+                        quantity: number;
+                        /** @enum {string} */
+                        unit: "grams" | "kilograms" | "liters" | "milliliters" | "pieces";
+                    }[];
+                    isPaid: boolean;
+                }[];
+                payments: {
+                    amount: number;
+                    /** @enum {string} */
+                    method: "card" | "cash" | "voucher";
+                    /** @enum {string} */
+                    status: "authorized" | "captured" | "cash_pending" | "cash_received";
+                    /** Format: date-time */
+                    createdAt: string;
+                    cardLast4: string | null;
+                }[];
+                paidTotal: number;
+                amountDue: number;
+                declaredReturns: {
+                    depositwareTemplateId: string;
+                    count: number;
+                }[];
+                leadSettledAt: string | null;
+            }[];
+            aggregatedTotals: {
+                confirmedBundleCount: number;
+                confirmedAmount: number;
+                totalBundleCount: number;
+            };
+            thresholdCheck: {
+                meets: boolean;
+                failedConstraints: ("quantity" | "amount")[];
+                requiredQuantity: number | null;
+                currentQuantity: number;
+                requiredAmount: number | null;
+                currentAmount: number;
+            };
+            isLead: boolean;
+        };
+        /** JoinTeamOrderRequest */
+        JoinTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            displayName?: string;
+        };
+        /** JoinTeamOrderResponse */
+        JoinTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            basketId: string;
+            customerId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            isLead: boolean;
+            alreadyJoined: boolean;
+        };
+        /** SubmitTeamOrderRequest */
+        SubmitTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+        };
+        /** SubmitTeamOrderResponse */
+        SubmitTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            capturedOrderIds: string[];
+            cashPendingOrderIds: string[];
+            droppedBasketIds: string[];
+            /** Format: date-time */
+            placedAt: string;
+        };
+        /** CancelTeamOrderRequest */
+        CancelTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            reason?: string;
+        };
+        /** CancelTeamOrderResponse */
+        CancelTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            voidedPaymentIntentIds: string[];
+            /** Format: date-time */
+            cancelledAt: string;
+        };
+        /** ExtendDeadlineTeamOrderRequest */
+        ExtendDeadlineTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            /** Format: date-time */
+            newDeadlineAt: string;
+        };
+        /** ExtendDeadlineTeamOrderResponse */
+        ExtendDeadlineTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            /** Format: date-time */
+            deadlineAt: string | null;
+        };
+        /** SetFulfillmentAtTeamOrderRequest */
+        SetFulfillmentAtTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            /** Format: date-time */
+            fulfillmentAt: string;
+        };
+        /** SetFulfillmentAtTeamOrderResponse */
+        SetFulfillmentAtTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            /** Format: date-time */
+            fulfillmentAt: string;
+            /** Format: date-time */
+            deadlineAt: string | null;
+        };
+        /** SetDiningLocationTeamOrderRequest */
+        SetDiningLocationTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            diningLocation: string;
+        };
+        /** SetDiningLocationTeamOrderResponse */
+        SetDiningLocationTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            diningLocation: string | null;
+        };
+        /** SetDiningTimeTeamOrderRequest */
+        SetDiningTimeTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            diningTime: string;
+        };
+        /** SetDiningTimeTeamOrderResponse */
+        SetDiningTimeTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            diningTime: string;
+            diningOffsetMinutes: number;
+        };
+        /** SwitchFulfillmentTeamOrderRequest */
+        SwitchFulfillmentTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            /** @enum {string} */
+            fulfillmentType: "pickup" | "delivery";
+            deliveryAddress?: {
+                street: string;
+                city: string;
+                state: string;
+                postalCode: string;
+                country: string;
+            };
+        };
+        /** SwitchFulfillmentTeamOrderResponse */
+        SwitchFulfillmentTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            /** @enum {string} */
+            status: "draft" | "collecting" | "locked" | "placed" | "ready" | "completed" | "cancelled";
+            /** @enum {string} */
+            fulfillmentType: "pickup" | "delivery";
+            deliveryAddressId: string | null;
+        };
+        /** UpdateDeliveryAddressTeamOrderRequest */
+        UpdateDeliveryAddressTeamOrderRequest: {
+            publicId: string;
+            sessionId: string;
+            deliveryAddress: {
+                street: string;
+                city: string;
+                state: string;
+                postalCode: string;
+                country: string;
+            };
+        };
+        /** UpdateDeliveryAddressTeamOrderResponse */
+        UpdateDeliveryAddressTeamOrderResponse: {
+            /** Format: uuid */
+            teamOrderId: string;
+            deliveryAddressId: string;
+        };
     };
     responses: never;
     parameters: never;