order3000 1.2.0 → 1.4.0

package/dist/client.cjs

@@ -116,13 +116,9 @@ class BaseResource {
         "Content-Type": "application/json"
       },
       body: data ? JSON.stringify(data) : void 0,
-      signal: AbortSignal.timeout(36e4)
+      signal: AbortSignal.timeout(36e4),
+      cache: cacheOptions?.cache ?? "no-store"
     };
-    if (cacheOptions?.next !== void 0) {
-      init.next = cacheOptions.next;
-    } else {
-      init.cache = cacheOptions?.cache ?? "no-store";
-    }
     const response = await fetch(url, init);
     if (!response.ok) {
       let body = "";
@@ -247,11 +243,12 @@ class AreasResource extends BaseResource {
     return this.request("GET", queryString);
   }
   /**
-   * Fetch a single area by id or accessor.
+   * Fetch a single area by id or accessor. The server resolves either
+   * form transparently.
    */
-  async getByAccessor(accessor, options) {
+  async get(idOrAccessor, options) {
     const queryString = this.buildExpandQuery(options?.expand);
-    return this.request("GET", `/${accessor}${queryString}`);
+    return this.request("GET", `/${idOrAccessor}${queryString}`);
   }
   /**
    * List occupied date/time windows for an area between `from` and `to`.
@@ -312,9 +309,10 @@ class ArticlesResource extends BaseResource {
   }
   /**
    * Fetch a single article by id or accessor within the active venue.
-   * Returns the full row including the TipTap `content` document.
+   * The server resolves either form transparently. Returns the full row
+   * including the TipTap `content` document.
    */
-  async getByAccessor(idOrAccessor) {
+  async get(idOrAccessor) {
     return this.request("GET", `/${encodeURIComponent(idOrAccessor)}`);
   }
   /**
@@ -543,27 +541,15 @@ class EventsResource extends BaseResource {
     return this.request("POST", "", event);
   }
   /**
-   * Get a single event by ID
-   * @param eventId - The event ID
-   * @returns The event details
-   */
-  async get(eventId) {
-    return this.request("GET", `/${eventId}`);
-  }
-  /**
-   * Get an event by accessor (slug)
-   * @param accessor - The event accessor (e.g., 'lunch-menu')
+   * Get a single event by id or accessor (slug), with optional `expand`
+   * parts. The server resolves either form transparently.
+   * @param idOrAccessor - The event UUID or accessor (e.g., 'lunch-menu')
    * @param options - Optional expand options
    * @returns The event with optional schedule, timeSlots, menus, and posters
    */
-  async getByAccessor(accessor, options) {
+  async get(idOrAccessor, options) {
     const queryString = this.buildQueryString(options);
-    return this.request(
-      "GET",
-      `/${accessor}${queryString}`,
-      void 0,
-      { next: { revalidate: 2700 } }
-    );
+    return this.request("GET", `/${idOrAccessor}${queryString}`);
   }
   buildQueryString(options) {
     if (!options?.expand?.length) return "";
@@ -596,11 +582,11 @@ class EventsResource extends BaseResource {
   }
   /**
    * List the posters attached to an event. Convenience over
-   * `getByAccessor(idOrAccessor, { expand: ['posters'] })` — returns the
+   * `get(idOrAccessor, { expand: ['posters'] })` — returns the
    * `posters[]` array (empty when the event has none).
    */
   async listPosters(idOrAccessor) {
-    const event = await this.getByAccessor(idOrAccessor, {
+    const event = await this.get(idOrAccessor, {
       expand: ["posters"]
     });
     return event.posters ?? [];
@@ -641,24 +627,15 @@ class MenusResource extends BaseResource {
     super(tokenManager, baseUrl, "/menus");
   }
   /**
-   * Get a menu by ID
-   * @param id - The menu UUID
+   * Get a menu by id or accessor (slug), with optional `expand` parts.
+   * The server resolves either form transparently.
+   * @param idOrAccessor - The menu UUID or accessor (slug)
    * @param options - Optional expand options
    * @returns The menu with optional items and assets
    */
-  async get(id, options) {
+  async get(idOrAccessor, options) {
     const queryString = this.buildQueryString(options);
-    return this.request("GET", `/${id}${queryString}`);
-  }
-  /**
-   * Get a menu by accessor
-   * @param accessor - The menu accessor (slug)
-   * @param options - Optional expand options
-   * @returns The menu with optional items and assets
-   */
-  async getByAccessor(accessor, options) {
-    const queryString = this.buildQueryString(options);
-    return this.request("GET", `/${accessor}${queryString}`);
+    return this.request("GET", `/${idOrAccessor}${queryString}`);
   }
   /**
    * Get all bundles for a menu
@@ -787,20 +764,13 @@ class SubscriptionsResource extends BaseResource {
     super(tokenManager, baseUrl, "/subscriptions");
   }
   /**
-   * Get a subscription by ID
-   * @param id - The subscription UUID
-   * @returns The subscription with posters
-   */
-  async get(id) {
-    return this.request("GET", `/${id}`);
-  }
-  /**
-   * Get a subscription by accessor
-   * @param accessor - The subscription accessor (slug)
+   * Get a subscription by id or accessor (slug). The server resolves
+   * either form transparently.
+   * @param idOrAccessor - The subscription UUID or accessor (slug)
    * @returns The subscription with posters
    */
-  async getByAccessor(accessor) {
-    return this.request("GET", `/${accessor}`);
+  async get(idOrAccessor) {
+    return this.request("GET", `/${idOrAccessor}`);
   }
   /**
    * Subscribe a customer to a subscription plan via Stripe Checkout
@@ -1053,7 +1023,7 @@ class VenuesResource {
    * — the CLI hits this to prove the accessor exists and to cache the
    * resolved UUID + display fields locally.
    */
-  async getByAccessor(idOrAccessor) {
+  async get(idOrAccessor) {
     const token = await this.tokenManager.getToken();
     const url = `${this.baseUrl}/venues/${encodeURIComponent(idOrAccessor)}`;
     const response = await fetch(url, {

package/dist/client.d.cts

@@ -30,21 +30,20 @@ declare class TokenManager {
 }
 
 /**
- * Per-call cache override. Default behaviour is `cache: 'no-store'`
+ * Per-call cache override. SDK reads are uniformly `cache: 'no-store'`
  * — correct for live-read endpoints (basket, team-order, payment
  * intents) where any caching causes stale responses against realtime
- * mutations. Resources that surface near-static data consumed during
- * static generation (e.g. `events.getByAccessor` for the Tiffinbox
- * event schedule) can override with `next: { revalidate: N }` so
- * Next.js can pre-render the calling page during the build instead
- * of bailing out to dynamic rendering with `DYNAMIC_SERVER_USAGE`.
+ * mutations. No SDK method bakes in ISR: apps that consume near-static
+ * data during static generation own caching at the call site by
+ * wrapping the SDK call in Next.js `unstable_cache(fn, key, { revalidate })`
+ * (e.g. thamarai's `getTiffinBoxEvent` / `getALaCarteMenu`), which is
+ * what lets Next.js pre-render the page during the build instead of
+ * bailing out to dynamic rendering with `DYNAMIC_SERVER_USAGE`. The
+ * `cache` field below remains only as a per-call escape hatch for the
+ * rare reader that needs a non-default `RequestCache` value.
  */
 interface RequestCacheOptions {
     cache?: RequestCache;
-    next?: {
-        revalidate?: number | false;
-        tags?: string[];
-    };
 }
 declare abstract class BaseResource {
     protected readonly tokenManager: TokenManager;
@@ -71,9 +70,18 @@ interface components {
             ownerEntityId: string;
             channel: components["schemas"]["AdChannel"];
             status: components["schemas"]["AdStatus"];
+            campaignId: string | null;
             content: (string | number | boolean | (null)) | {
                 [key: string]: unknown;
             } | unknown[];
+            keywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            negativeKeywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            publishedContentHash: string | null;
+            publishedAt: unknown;
             createdBy: string | null;
             updatedBy: string | null;
             createdAt: unknown;
@@ -87,9 +95,18 @@ interface components {
             ownerEntityId: string;
             channel: components["schemas"]["AdChannel"];
             status: components["schemas"]["AdStatus"];
+            campaignId: string | null;
             content: (string | number | boolean | (null)) | {
                 [key: string]: unknown;
             } | unknown[];
+            keywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            negativeKeywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            publishedContentHash: string | null;
+            publishedAt: unknown;
             createdBy: string | null;
             updatedBy: string | null;
             createdAt: unknown;
@@ -116,9 +133,18 @@ interface components {
             ownerEntityId: string;
             channel: components["schemas"]["AdChannel"];
             status: components["schemas"]["AdStatus"];
+            campaignId: string | null;
             content: (string | number | boolean | (null)) | {
                 [key: string]: unknown;
             } | unknown[];
+            keywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            negativeKeywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            publishedContentHash: string | null;
+            publishedAt: unknown;
             createdBy: string | null;
             updatedBy: string | null;
             createdAt: unknown;
@@ -160,9 +186,18 @@ interface components {
             ownerEntityId: string;
             channel: components["schemas"]["AdChannel"];
             status: components["schemas"]["AdStatus"];
+            campaignId: string | null;
             content: (string | number | boolean | (null)) | {
                 [key: string]: unknown;
             } | unknown[];
+            keywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            negativeKeywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            publishedContentHash: string | null;
+            publishedAt: unknown;
             createdBy: string | null;
             updatedBy: string | null;
             createdAt: unknown;
@@ -176,9 +211,18 @@ interface components {
             ownerEntityId: string;
             channel: components["schemas"]["AdChannel"];
             status: components["schemas"]["AdStatus"];
+            campaignId: string | null;
             content: (string | number | boolean | (null)) | {
                 [key: string]: unknown;
             } | unknown[];
+            keywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            negativeKeywords: (string | number | boolean | (null)) | {
+                [key: string]: unknown;
+            } | unknown[];
+            publishedContentHash: string | null;
+            publishedAt: unknown;
             createdBy: string | null;
             updatedBy: string | null;
             createdAt: unknown;
@@ -318,8 +362,8 @@ interface components {
             endTime: string | null;
             partySize: number;
             status: components["schemas"]["AreaBookingStatus"];
-            customerFirstName?: string;
-            customerLastName?: string;
+            guestFirstName?: string;
+            guestLastName?: string;
             totalPrice?: number;
             currency?: components["schemas"]["Currency"];
             confirmationCode?: string | null;
@@ -330,11 +374,11 @@ interface components {
             requestedStartTime?: string;
             requestedEndTime?: string;
             partySize: number;
-            customerFirstName: string;
-            customerLastName: string;
+            guestFirstName: string;
+            guestLastName: string;
             /** Format: email */
-            customerEmail: string;
-            customerPhone?: string;
+            guestEmail: string;
+            guestPhone?: string;
             message?: string;
             source?: components["schemas"]["AreaBookingRequestSource"];
         };
@@ -347,10 +391,10 @@ interface components {
             requestedStartTime: string | null;
             requestedEndTime: string | null;
             partySize: number;
-            customerFirstName: string;
-            customerLastName: string;
-            customerEmail: string;
-            customerPhone: string | null;
+            guestFirstName: string;
+            guestLastName: string;
+            guestEmail: string;
+            guestPhone: string | null;
             message: string | null;
             source: components["schemas"]["AreaBookingRequestSource"];
             status: components["schemas"]["AreaBookingRequestStatus"];
@@ -1537,9 +1581,9 @@ interface components {
             fulfillmentType: components["schemas"]["FulfillmentType"];
             /** Format: date-time */
             fulfillmentAt?: string | null;
-            customerFirstName?: string;
-            customerLastName?: string;
-            customerEmail?: string;
+            guestFirstName?: string;
+            guestLastName?: string;
+            guestEmail?: string;
             declaredReturns?: {
                 depositwareTemplateId: string;
                 count: number;
@@ -1566,7 +1610,7 @@ interface components {
             status: string;
             publicId: string | null;
             quickReferenceNumber: number | null;
-            customerId?: string;
+            guestId?: string;
         };
         /** FetchLatestOrderResponse */
         FetchLatestOrderResponse: {
@@ -1618,8 +1662,8 @@ interface components {
             fulfillmentType: components["schemas"]["FulfillmentType"];
             /** Format: date-time */
             fulfillmentAt?: string | null;
-            customerFirstName?: string;
-            customerLastName?: string;
+            guestFirstName?: string;
+            guestLastName?: string;
             teamOrderPublicId?: string;
             declaredReturns?: {
                 depositwareTemplateId: string;
@@ -1693,18 +1737,18 @@ interface components {
              * Format: uuid
              * @description UUID of existing customer profile if available
              */
-            customerId?: string | null;
+            guestId?: string | null;
             /** @description First name of the customer making the reservation */
-            customerFirstName: string;
+            guestFirstName: string;
             /** @description Last name of the customer making the reservation */
-            customerLastName: string;
+            guestLastName: string;
             /**
              * Format: email
              * @description Email address for reservation confirmations and updates
              */
-            customerEmail?: string | null;
+            guestEmail?: string | null;
             /** @description Phone number for reservation confirmations and updates. Include country code for international numbers. */
-            customerPhone?: string | null;
+            guestPhone?: string | null;
             contactPreference?: components["schemas"]["ContactPreference"];
             source?: components["schemas"]["AreaBookingRequestSource"];
             /** @description Any dietary restrictions, allergies, or special occasions (max 500 characters) */
@@ -1751,15 +1795,15 @@ interface components {
              * Format: uuid
              * @description Link to customer profile if exists
              */
-            customerId: string | null;
+            guestId: string | null;
             /** @description First name of the customer */
-            customerFirstName: string;
+            guestFirstName: string;
             /** @description Last name of the customer */
-            customerLastName: string;
+            guestLastName: string;
             /** @description Customer email address */
-            customerEmail: string | null;
+            guestEmail: string | null;
             /** @description Customer phone number */
-            customerPhone: string | null;
+            guestPhone: string | null;
             contactPreference: components["schemas"]["ContactPreference"];
             status: components["schemas"]["ReservationStatus"];
             /** @description 6-character confirmation code for the reservation */
@@ -1944,7 +1988,7 @@ interface components {
                 quantity: number | null;
             };
             participants: {
-                customerId: string;
+                guestId: string;
                 basketId: string | null;
                 orderId: string | null;
                 participantNumber: number | null;
@@ -2013,7 +2057,7 @@ interface components {
             /** Format: uuid */
             teamOrderId: string;
             basketId: string;
-            customerId: string;
+            guestId: string;
             status: components["schemas"]["TeamOrderStatus"];
             isLead: boolean;
             alreadyJoined: boolean;
@@ -2299,6 +2343,10 @@ interface components {
         /** @enum {string} */
         ReservationStatus: "pending" | "confirmed" | "arrived" | "seated" | "completed" | "cancelled" | "no_show";
         /** @enum {string} */
+        ReservationMessageStatus: "draft" | "sent";
+        /** @enum {string} */
+        VenueEmailSenderStatus: "pending" | "verified" | "failed" | "temporary_failure";
+        /** @enum {string} */
         VenueAssetType: "logomark" | "wordmark" | "combinationmark_horizontal" | "combinationmark_vertical";
         /** @enum {string} */
         VenueUserStatus: "pending" | "confirmed" | "revoked";
@@ -2556,18 +2604,18 @@ interface GetMenuOptions {
 type MenuBundle = schemas['FetchMenuBundlesResponse'][number];
 type MenuBundleDeposit = NonNullable<MenuBundle['deposit']>;
 /**
- * A single event as returned by the `getByAccessor` endpoint, with
+ * A single event as returned by the `events.get` endpoint, with
  * optional schedule / menus / posters expansions. Generated-bound to the
  * `FetchEventResponse` component (the order3000 `fetchEvent` output
  * schema is now precise) — request-shape drift is impossible.
  */
 type EventByAccessor = schemas['FetchEventResponse'];
 /**
- * The `getByAccessor` event's schedule sub-object, including the optional
+ * The fetched event's schedule sub-object, including the optional
  * `scheduleTimeSlots[]` expansion. Generated-bound to the non-null
  * `schedule` on `FetchEventResponse`. Kept as a distinct public SDK type
  * name (re-exported as `O3KScheduleWithTimeSlots`) for downstream
- * stability; structurally it is the by-accessor schedule shape.
+ * stability; structurally it is the single-event-fetch schedule shape.
  */
 type ScheduleWithTimeSlots = NonNullable<EventByAccessor['schedule']>;
 /**
@@ -2767,9 +2815,10 @@ declare class AreasResource extends BaseResource {
      */
     list(options?: GetAreaOptions): Promise<Area[]>;
     /**
-     * Fetch a single area by id or accessor.
+     * Fetch a single area by id or accessor. The server resolves either
+     * form transparently.
      */
-    getByAccessor(accessor: string, options?: GetAreaOptions): Promise<Area>;
+    get(idOrAccessor: string, options?: GetAreaOptions): Promise<Area>;
     /**
      * List occupied date/time windows for an area between `from` and `to`.
      */
@@ -2796,9 +2845,10 @@ declare class ArticlesResource extends BaseResource {
     list(options?: ListArticlesOptions): Promise<ListArticlesResponse>;
     /**
      * Fetch a single article by id or accessor within the active venue.
-     * Returns the full row including the TipTap `content` document.
+     * The server resolves either form transparently. Returns the full row
+     * including the TipTap `content` document.
      */
-    getByAccessor(idOrAccessor: string): Promise<Article>;
+    get(idOrAccessor: string): Promise<Article>;
     /**
      * Partial-update an article. Locale-keyed fields (slug, title, excerpt)
      * merge at the locale level — `{ slug: { en: 'foo' } }` updates `en`
@@ -2936,18 +2986,13 @@ declare class EventsResource extends BaseResource {
      */
     place(event: CreateEventRequest): Promise<CreateEventResponse>;
     /**
-     * Get a single event by ID
-     * @param eventId - The event ID
-     * @returns The event details
-     */
-    get(eventId: string): Promise<Event>;
-    /**
-     * Get an event by accessor (slug)
-     * @param accessor - The event accessor (e.g., 'lunch-menu')
+     * Get a single event by id or accessor (slug), with optional `expand`
+     * parts. The server resolves either form transparently.
+     * @param idOrAccessor - The event UUID or accessor (e.g., 'lunch-menu')
      * @param options - Optional expand options
      * @returns The event with optional schedule, timeSlots, menus, and posters
      */
-    getByAccessor(accessor: string, options?: GetEventOptions): Promise<EventByAccessor>;
+    get(idOrAccessor: string, options?: GetEventOptions): Promise<EventByAccessor>;
     private buildQueryString;
     /**
      * Partial-update an event by id or accessor. Every body field is
@@ -2965,7 +3010,7 @@ declare class EventsResource extends BaseResource {
     delete(idOrAccessor: string): Promise<DeleteEventResponse>;
     /**
      * List the posters attached to an event. Convenience over
-     * `getByAccessor(idOrAccessor, { expand: ['posters'] })` — returns the
+     * `get(idOrAccessor, { expand: ['posters'] })` — returns the
      * `posters[]` array (empty when the event has none).
      */
     listPosters(idOrAccessor: string): Promise<EventPosterEntry[]>;
@@ -2988,19 +3033,13 @@ declare class EventsResource extends BaseResource {
 declare class MenusResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
     /**
-     * Get a menu by ID
-     * @param id - The menu UUID
-     * @param options - Optional expand options
-     * @returns The menu with optional items and assets
-     */
-    get(id: string, options?: GetMenuOptions): Promise<Menu>;
-    /**
-     * Get a menu by accessor
-     * @param accessor - The menu accessor (slug)
+     * Get a menu by id or accessor (slug), with optional `expand` parts.
+     * The server resolves either form transparently.
+     * @param idOrAccessor - The menu UUID or accessor (slug)
      * @param options - Optional expand options
      * @returns The menu with optional items and assets
      */
-    getByAccessor(accessor: string, options?: GetMenuOptions): Promise<Menu>;
+    get(idOrAccessor: string, options?: GetMenuOptions): Promise<Menu>;
     /**
      * Get all bundles for a menu
      * @param menuIdOrAccessor - The menu UUID or accessor (slug)
@@ -3089,17 +3128,12 @@ declare class ReservationsResource extends BaseResource {
 declare class SubscriptionsResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
     /**
-     * Get a subscription by ID
-     * @param id - The subscription UUID
-     * @returns The subscription with posters
-     */
-    get(id: string): Promise<MenuSubscription>;
-    /**
-     * Get a subscription by accessor
-     * @param accessor - The subscription accessor (slug)
+     * Get a subscription by id or accessor (slug). The server resolves
+     * either form transparently.
+     * @param idOrAccessor - The subscription UUID or accessor (slug)
      * @returns The subscription with posters
      */
-    getByAccessor(accessor: string): Promise<MenuSubscription>;
+    get(idOrAccessor: string): Promise<MenuSubscription>;
     /**
      * Subscribe a customer to a subscription plan via Stripe Checkout
      * @param subscriptionIdOrAccessor - The subscription UUID or accessor
@@ -3277,7 +3311,7 @@ interface TeamOrderParticipantPayment {
     cardLast4: string | null;
 }
 interface TeamOrderParticipant {
-    customerId: string;
+    guestId: string;
     basketId: string | null;
     orderId: string | null;
     /**
@@ -3426,7 +3460,7 @@ interface JoinTeamOrderRequest {
 interface JoinTeamOrderResponse {
     teamOrderId: string;
     basketId: string;
-    customerId: string;
+    guestId: string;
     status: TeamOrderStatus;
     isLead: boolean;
     alreadyJoined: boolean;
@@ -3631,7 +3665,7 @@ declare class VenuesResource {
      * — the CLI hits this to prove the accessor exists and to cache the
      * resolved UUID + display fields locally.
      */
-    getByAccessor(idOrAccessor: string): Promise<Venue>;
+    get(idOrAccessor: string): Promise<Venue>;
 }
 
 type RealtimeEvent = 'INSERT' | 'UPDATE' | 'DELETE' | '*';