order3000 0.12.1 → 0.13.0

package/dist/client.cjs

@@ -263,6 +263,17 @@ class MenusResource extends BaseResource {
   async getBundles(menuIdOrAccessor) {
     return this.request("GET", `/${menuIdOrAccessor}/bundles`);
   }
+  /**
+   * Get all active subscriptions for a menu
+   * @param menuIdOrAccessor - The menu UUID or accessor (slug)
+   * @returns Array of menu subscriptions with posters
+   */
+  async getSubscriptions(menuIdOrAccessor) {
+    return this.request(
+      "GET",
+      `/${menuIdOrAccessor}/subscriptions`
+    );
+  }
   buildQueryString(options) {
     if (!options?.expand?.length) return "";
     return `?expand=${options.expand.join(",")}`;
@@ -336,6 +347,70 @@ class ReservationsResource extends BaseResource {
   }
 }
 
+class SubscriptionsResource extends BaseResource {
+  constructor(tokenManager, baseUrl) {
+    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)
+   * @returns The subscription with posters
+   */
+  async getByAccessor(accessor) {
+    return this.request("GET", `/${accessor}`);
+  }
+  /**
+   * Subscribe a customer to a subscription plan via Stripe Checkout
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param request - Subscribe request with email and redirect URLs
+   * @returns Stripe Checkout URL and session ID
+   */
+  async subscribe(subscriptionIdOrAccessor, request) {
+    return this.request(
+      "POST",
+      `/${subscriptionIdOrAccessor}/subscribe`,
+      request
+    );
+  }
+  /**
+   * Cancel a customer's subscription
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param subscriberId - The subscriber record ID
+   */
+  async cancel(subscriptionIdOrAccessor, subscriberId) {
+    await this.request(
+      "POST",
+      `/${subscriptionIdOrAccessor}/cancel`,
+      { subscriberId }
+    );
+  }
+  /**
+   * Get credits for a subscriber
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param subscriberId - The subscriber record ID
+   * @param status - Optional filter by credit status
+   * @returns Array of subscription credits
+   */
+  async getCredits(subscriptionIdOrAccessor, subscriberId, status) {
+    const params = new URLSearchParams({ subscriberId });
+    if (status) {
+      params.set("status", status);
+    }
+    return this.request(
+      "GET",
+      `/${subscriptionIdOrAccessor}/credits?${params.toString()}`
+    );
+  }
+}
+
 var __defProp$2 = Object.defineProperty;
 var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -666,6 +741,7 @@ class Order3000Client {
     __publicField(this, "orders");
     __publicField(this, "paymentIntents");
     __publicField(this, "reservations");
+    __publicField(this, "subscriptions");
     __publicField(this, "realtime");
     __publicField(this, "baseUrl");
     __publicField(this, "tokenManager");
@@ -689,6 +765,10 @@ class Order3000Client {
       this.tokenManager,
       this.baseUrl
     );
+    this.subscriptions = new SubscriptionsResource(
+      this.tokenManager,
+      this.baseUrl
+    );
     this.realtime = new RealtimeManager(this.tokenManager, this.baseUrl);
   }
 }

package/dist/client.d.cts

@@ -671,6 +671,64 @@ interface ConfirmOrderResponse {
     status: string;
     publicId: string | null;
 }
+type SubscriptionPeriod = 'week' | 'month' | 'year';
+type SubscriberStatus = 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+type SubscriptionCreditStatus = 'available' | 'redeemed' | 'expired';
+interface MenuSubscriptionPoster {
+    id: string;
+    menuSubscriptionId: string;
+    storagePath: string;
+    /** Signed URL for accessing the poster image (1 hour expiry) */
+    signedUrl: string | null;
+    filename: string;
+    contentType: string;
+    sizeBytes: number;
+    sortIndex: string | null;
+    createdBy: string | null;
+    createdAt: string | null;
+}
+interface MenuSubscription {
+    id: string;
+    menuId: string;
+    accessor: string;
+    name: Record<string, string>;
+    shortName: Record<string, string> | null;
+    description: Record<string, string> | null;
+    scheduleId: string | null;
+    allowance: number;
+    billingPeriod: SubscriptionPeriod;
+    allowancePeriod: SubscriptionPeriod;
+    redeemableTagSets: string[][];
+    expiryInDays: number;
+    price: number;
+    currency: Currency;
+    isActive: boolean;
+    sortIndex: string | null;
+    posters: MenuSubscriptionPoster[];
+}
+interface SubscribeRequest {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    sessionId?: string;
+    successUrl: string;
+    cancelUrl: string;
+}
+interface SubscribeResponse {
+    checkoutUrl: string;
+    sessionId: string;
+}
+interface SubscriptionCredit {
+    id: string;
+    subscriberId: string;
+    periodStart: string;
+    periodEnd: string;
+    expiresAt: string;
+    status: SubscriptionCreditStatus;
+    redeemedAt: string | null;
+    orderId: string | null;
+    createdAt: string | null;
+}
 
 declare class BasketsResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
@@ -752,6 +810,12 @@ declare class MenusResource extends BaseResource {
      * @returns Array of menu bundles
      */
     getBundles(menuIdOrAccessor: string): Promise<MenuBundle[]>;
+    /**
+     * Get all active subscriptions for a menu
+     * @param menuIdOrAccessor - The menu UUID or accessor (slug)
+     * @returns Array of menu subscriptions with posters
+     */
+    getSubscriptions(menuIdOrAccessor: string): Promise<MenuSubscription[]>;
     private buildQueryString;
 }
 
@@ -804,6 +868,43 @@ declare class ReservationsResource extends BaseResource {
     get(reservationId: string): Promise<MakeReservationResponse>;
 }
 
+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)
+     * @returns The subscription with posters
+     */
+    getByAccessor(accessor: string): Promise<MenuSubscription>;
+    /**
+     * Subscribe a customer to a subscription plan via Stripe Checkout
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param request - Subscribe request with email and redirect URLs
+     * @returns Stripe Checkout URL and session ID
+     */
+    subscribe(subscriptionIdOrAccessor: string, request: SubscribeRequest): Promise<SubscribeResponse>;
+    /**
+     * Cancel a customer's subscription
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param subscriberId - The subscriber record ID
+     */
+    cancel(subscriptionIdOrAccessor: string, subscriberId: string): Promise<void>;
+    /**
+     * Get credits for a subscriber
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param subscriberId - The subscriber record ID
+     * @param status - Optional filter by credit status
+     * @returns Array of subscription credits
+     */
+    getCredits(subscriptionIdOrAccessor: string, subscriberId: string, status?: SubscriptionCreditStatus): Promise<SubscriptionCredit[]>;
+}
+
 type RealtimeEvent = 'INSERT' | 'UPDATE' | 'DELETE' | '*';
 type RealtimeRow = {
     [key: string]: any;
@@ -967,10 +1068,11 @@ declare class Order3000Client {
     orders: OrdersResource;
     paymentIntents: PaymentIntentsResource;
     reservations: ReservationsResource;
+    subscriptions: SubscriptionsResource;
     realtime: RealtimeManager;
     private readonly baseUrl;
     private readonly tokenManager;
     constructor(config: Order3000ClientConfig);
 }
 
-export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type ConfirmOrderRequest, type ConfirmOrderResponse, type CreatePaymentIntentRequest, type CreatePaymentIntentResponse, type CropArea, type Currency, type DayOfWeek, type Event, type EventByAccessor, type EventMenu, type EventPoster, type EventRow, type GetEventOptions, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuBundle, type MenuBundleDeposit, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type OrderFulfillmentType, type PlaceOrderRequest, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleInfo, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type ScheduleTimeSlot, type ScheduleWithTimeSlots, type SubscriptionOptions, type TimeSlot, type Unit, getScheduleInfo };
+export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type ConfirmOrderRequest, type ConfirmOrderResponse, type CreatePaymentIntentRequest, type CreatePaymentIntentResponse, type CropArea, type Currency, type DayOfWeek, type Event, type EventByAccessor, type EventMenu, type EventPoster, type EventRow, type GetEventOptions, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuBundle, type MenuBundleDeposit, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, type MenuSubscription, type MenuSubscriptionPoster, Order3000Client, type Order3000ClientConfig, type OrderFulfillmentType, type PlaceOrderRequest, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleInfo, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type ScheduleTimeSlot, type ScheduleWithTimeSlots, type SubscribeRequest, type SubscribeResponse, type SubscriberStatus, type SubscriptionCredit, type SubscriptionCreditStatus, type SubscriptionOptions, type SubscriptionPeriod, type TimeSlot, type Unit, getScheduleInfo };

package/dist/client.d.mts

@@ -671,6 +671,64 @@ interface ConfirmOrderResponse {
     status: string;
     publicId: string | null;
 }
+type SubscriptionPeriod = 'week' | 'month' | 'year';
+type SubscriberStatus = 'active' | 'paused' | 'cancelled' | 'past_due' | 'trialing';
+type SubscriptionCreditStatus = 'available' | 'redeemed' | 'expired';
+interface MenuSubscriptionPoster {
+    id: string;
+    menuSubscriptionId: string;
+    storagePath: string;
+    /** Signed URL for accessing the poster image (1 hour expiry) */
+    signedUrl: string | null;
+    filename: string;
+    contentType: string;
+    sizeBytes: number;
+    sortIndex: string | null;
+    createdBy: string | null;
+    createdAt: string | null;
+}
+interface MenuSubscription {
+    id: string;
+    menuId: string;
+    accessor: string;
+    name: Record<string, string>;
+    shortName: Record<string, string> | null;
+    description: Record<string, string> | null;
+    scheduleId: string | null;
+    allowance: number;
+    billingPeriod: SubscriptionPeriod;
+    allowancePeriod: SubscriptionPeriod;
+    redeemableTagSets: string[][];
+    expiryInDays: number;
+    price: number;
+    currency: Currency;
+    isActive: boolean;
+    sortIndex: string | null;
+    posters: MenuSubscriptionPoster[];
+}
+interface SubscribeRequest {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    sessionId?: string;
+    successUrl: string;
+    cancelUrl: string;
+}
+interface SubscribeResponse {
+    checkoutUrl: string;
+    sessionId: string;
+}
+interface SubscriptionCredit {
+    id: string;
+    subscriberId: string;
+    periodStart: string;
+    periodEnd: string;
+    expiresAt: string;
+    status: SubscriptionCreditStatus;
+    redeemedAt: string | null;
+    orderId: string | null;
+    createdAt: string | null;
+}
 
 declare class BasketsResource extends BaseResource {
     constructor(tokenManager: TokenManager, baseUrl: string);
@@ -752,6 +810,12 @@ declare class MenusResource extends BaseResource {
      * @returns Array of menu bundles
      */
     getBundles(menuIdOrAccessor: string): Promise<MenuBundle[]>;
+    /**
+     * Get all active subscriptions for a menu
+     * @param menuIdOrAccessor - The menu UUID or accessor (slug)
+     * @returns Array of menu subscriptions with posters
+     */
+    getSubscriptions(menuIdOrAccessor: string): Promise<MenuSubscription[]>;
     private buildQueryString;
 }
 
@@ -804,6 +868,43 @@ declare class ReservationsResource extends BaseResource {
     get(reservationId: string): Promise<MakeReservationResponse>;
 }
 
+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)
+     * @returns The subscription with posters
+     */
+    getByAccessor(accessor: string): Promise<MenuSubscription>;
+    /**
+     * Subscribe a customer to a subscription plan via Stripe Checkout
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param request - Subscribe request with email and redirect URLs
+     * @returns Stripe Checkout URL and session ID
+     */
+    subscribe(subscriptionIdOrAccessor: string, request: SubscribeRequest): Promise<SubscribeResponse>;
+    /**
+     * Cancel a customer's subscription
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param subscriberId - The subscriber record ID
+     */
+    cancel(subscriptionIdOrAccessor: string, subscriberId: string): Promise<void>;
+    /**
+     * Get credits for a subscriber
+     * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+     * @param subscriberId - The subscriber record ID
+     * @param status - Optional filter by credit status
+     * @returns Array of subscription credits
+     */
+    getCredits(subscriptionIdOrAccessor: string, subscriberId: string, status?: SubscriptionCreditStatus): Promise<SubscriptionCredit[]>;
+}
+
 type RealtimeEvent = 'INSERT' | 'UPDATE' | 'DELETE' | '*';
 type RealtimeRow = {
     [key: string]: any;
@@ -967,10 +1068,11 @@ declare class Order3000Client {
     orders: OrdersResource;
     paymentIntents: PaymentIntentsResource;
     reservations: ReservationsResource;
+    subscriptions: SubscriptionsResource;
     realtime: RealtimeManager;
     private readonly baseUrl;
     private readonly tokenManager;
     constructor(config: Order3000ClientConfig);
 }
 
-export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type ConfirmOrderRequest, type ConfirmOrderResponse, type CreatePaymentIntentRequest, type CreatePaymentIntentResponse, type CropArea, type Currency, type DayOfWeek, type Event, type EventByAccessor, type EventMenu, type EventPoster, type EventRow, type GetEventOptions, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuBundle, type MenuBundleDeposit, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, Order3000Client, type Order3000ClientConfig, type OrderFulfillmentType, type PlaceOrderRequest, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleInfo, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type ScheduleTimeSlot, type ScheduleWithTimeSlots, type SubscriptionOptions, type TimeSlot, type Unit, getScheduleInfo };
+export { type AddToBasketRequest, type AddToBasketResponse, type Basket, type BasketItem, type BasketItemMenuItemRef, type BasketItemMetadata, type BasketStatus, type ConfirmOrderRequest, type ConfirmOrderResponse, type CreatePaymentIntentRequest, type CreatePaymentIntentResponse, type CropArea, type Currency, type DayOfWeek, type Event, type EventByAccessor, type EventMenu, type EventPoster, type EventRow, type GetEventOptions, type GetMenuOptions, type ListEventsOptions, type ListEventsResponse, type Menu, type MenuAsset, type MenuBeverage, type MenuBundle, type MenuBundleDeposit, type MenuDish, type MenuItem, type MenuItemRow, type MenuItemType, type MenuSubscription, type MenuSubscriptionPoster, Order3000Client, type Order3000ClientConfig, type OrderFulfillmentType, type PlaceOrderRequest, type Promotion, type RealtimeConfig, type RealtimeEvent, type RealtimeSubscription, type RemoveFromBasketResponse, type Schedule, type ScheduleInfo, type ScheduleOverride, type ScheduleOverrideRow, type ScheduleRow, type ScheduleTimeSlot, type ScheduleWithTimeSlots, type SubscribeRequest, type SubscribeResponse, type SubscriberStatus, type SubscriptionCredit, type SubscriptionCreditStatus, type SubscriptionOptions, type SubscriptionPeriod, type TimeSlot, type Unit, getScheduleInfo };

package/dist/client.mjs

@@ -261,6 +261,17 @@ class MenusResource extends BaseResource {
   async getBundles(menuIdOrAccessor) {
     return this.request("GET", `/${menuIdOrAccessor}/bundles`);
   }
+  /**
+   * Get all active subscriptions for a menu
+   * @param menuIdOrAccessor - The menu UUID or accessor (slug)
+   * @returns Array of menu subscriptions with posters
+   */
+  async getSubscriptions(menuIdOrAccessor) {
+    return this.request(
+      "GET",
+      `/${menuIdOrAccessor}/subscriptions`
+    );
+  }
   buildQueryString(options) {
     if (!options?.expand?.length) return "";
     return `?expand=${options.expand.join(",")}`;
@@ -334,6 +345,70 @@ class ReservationsResource extends BaseResource {
   }
 }
 
+class SubscriptionsResource extends BaseResource {
+  constructor(tokenManager, baseUrl) {
+    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)
+   * @returns The subscription with posters
+   */
+  async getByAccessor(accessor) {
+    return this.request("GET", `/${accessor}`);
+  }
+  /**
+   * Subscribe a customer to a subscription plan via Stripe Checkout
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param request - Subscribe request with email and redirect URLs
+   * @returns Stripe Checkout URL and session ID
+   */
+  async subscribe(subscriptionIdOrAccessor, request) {
+    return this.request(
+      "POST",
+      `/${subscriptionIdOrAccessor}/subscribe`,
+      request
+    );
+  }
+  /**
+   * Cancel a customer's subscription
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param subscriberId - The subscriber record ID
+   */
+  async cancel(subscriptionIdOrAccessor, subscriberId) {
+    await this.request(
+      "POST",
+      `/${subscriptionIdOrAccessor}/cancel`,
+      { subscriberId }
+    );
+  }
+  /**
+   * Get credits for a subscriber
+   * @param subscriptionIdOrAccessor - The subscription UUID or accessor
+   * @param subscriberId - The subscriber record ID
+   * @param status - Optional filter by credit status
+   * @returns Array of subscription credits
+   */
+  async getCredits(subscriptionIdOrAccessor, subscriberId, status) {
+    const params = new URLSearchParams({ subscriberId });
+    if (status) {
+      params.set("status", status);
+    }
+    return this.request(
+      "GET",
+      `/${subscriptionIdOrAccessor}/credits?${params.toString()}`
+    );
+  }
+}
+
 var __defProp$2 = Object.defineProperty;
 var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -664,6 +739,7 @@ class Order3000Client {
     __publicField(this, "orders");
     __publicField(this, "paymentIntents");
     __publicField(this, "reservations");
+    __publicField(this, "subscriptions");
     __publicField(this, "realtime");
     __publicField(this, "baseUrl");
     __publicField(this, "tokenManager");
@@ -687,6 +763,10 @@ class Order3000Client {
       this.tokenManager,
       this.baseUrl
     );
+    this.subscriptions = new SubscriptionsResource(
+      this.tokenManager,
+      this.baseUrl
+    );
     this.realtime = new RealtimeManager(this.tokenManager, this.baseUrl);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "order3000",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "order3000 node.js sdk",
   "main": "./dist/client.cjs",
   "module": "./dist/client.mjs",
@@ -30,8 +30,8 @@
     "prettier": "^3.7.4",
     "tsx": "^4.19.2",
     "typescript": "^5.9.3",
+    "@kolaveri/eslint-config": "1.4.1",
     "@kolaveri/prettier-config": "1.0.6",
-    "@kolaveri/eslint-config": "1.4.0",
     "@kolaveri/tsconfig": "1.0.1"
   },
   "files": [