@tiquo/dom-package 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -328,13 +328,14 @@ interface TiquoOrderItem {
328
328
  /**
329
329
  * An order belonging to the authenticated customer.
330
330
  *
331
- * Note: abandoned `lost_cart` orders are never returned — they're internal
332
- * marketing-recovery state, not part of the customer's purchase history.
331
+ * Note: `lost_cart` (abandoned) and `pending` (unprocessed/awaiting-payment)
332
+ * orders are never returned — they're internal state, not part of the
333
+ * customer's purchase history.
333
334
  */
334
335
  interface TiquoOrder {
335
336
  id: string;
336
337
  orderNumber: string;
337
- status: 'draft' | 'pending' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
338
+ status: 'draft' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
338
339
  paymentStatus: 'pending' | 'paid' | 'partial' | 'refunded' | 'partially_refunded' | 'failed' | 'cancelled';
339
340
  total: number;
340
341
  subtotal: number;
@@ -423,16 +424,27 @@ interface TiquoReceipt {
423
424
  business: TiquoReceiptBusiness;
424
425
  customer: TiquoReceiptCustomer;
425
426
  }
427
+ /**
428
+ * A booking belonging to the authenticated customer.
429
+ *
430
+ * Note: `draft` bookings (in-progress checkout state) are never returned —
431
+ * they're internal state, not part of the customer's booking history.
432
+ */
426
433
  interface TiquoBooking {
427
434
  id: string;
428
435
  bookingNumber: string;
429
- status: 'draft' | 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
436
+ status: 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
430
437
  date: number;
431
438
  startTime: string;
432
439
  endTime: string;
433
440
  duration: number;
434
441
  timezone: string;
435
442
  attendeeCount: number;
443
+ /**
444
+ * Service title (e.g. "OJAS Listening Room"). Empty string when the
445
+ * underlying service has been deleted — render your own fallback if you
446
+ * need a non-empty display string.
447
+ */
436
448
  serviceName: string;
437
449
  serviceId: string;
438
450
  sublocationId: string;
@@ -540,9 +552,10 @@ declare class TiquoAuth {
540
552
  /**
541
553
  * Get the authenticated customer's order history.
542
554
  *
543
- * Returns orders across every status (draft, pending, processing, completed,
544
- * cancelled, refunded, open_tab) — except `lost_cart`, which is internal
545
- * marketing-recovery state and is never exposed to customers.
555
+ * Returns orders across most statuses (draft, processing, completed,
556
+ * cancelled, refunded, open_tab). `lost_cart` (abandoned) and `pending`
557
+ * (unprocessed/awaiting-payment) orders are never exposed they're
558
+ * internal state, not purchase history.
546
559
  *
547
560
  * Pass `status` to filter to a single status; pass `cursor` (an order id
548
561
  * from a previous `nextCursor`) to paginate. Sorted most recent first.
@@ -561,6 +574,11 @@ declare class TiquoAuth {
561
574
  * Convenience wrapper around `getBookings({ upcoming: true })` for the
562
575
  * common "show me my upcoming bookings" case. Results are sorted
563
576
  * soonest-first.
577
+ *
578
+ * Only actionable future bookings are returned — `cancelled`, `no_show`,
579
+ * and `rescheduled` bookings are excluded even if their date is in the
580
+ * future, since they're effectively history. Use `getBookings()` without
581
+ * `upcoming: true` if you need those.
564
582
  */
565
583
  getUpcomingBookings(options?: Omit<GetBookingsOptions, 'upcoming'>): Promise<GetBookingsResult>;
566
584
  /**
package/dist/index.d.ts CHANGED
@@ -328,13 +328,14 @@ interface TiquoOrderItem {
328
328
  /**
329
329
  * An order belonging to the authenticated customer.
330
330
  *
331
- * Note: abandoned `lost_cart` orders are never returned — they're internal
332
- * marketing-recovery state, not part of the customer's purchase history.
331
+ * Note: `lost_cart` (abandoned) and `pending` (unprocessed/awaiting-payment)
332
+ * orders are never returned — they're internal state, not part of the
333
+ * customer's purchase history.
333
334
  */
334
335
  interface TiquoOrder {
335
336
  id: string;
336
337
  orderNumber: string;
337
- status: 'draft' | 'pending' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
338
+ status: 'draft' | 'processing' | 'completed' | 'cancelled' | 'refunded' | 'open_tab';
338
339
  paymentStatus: 'pending' | 'paid' | 'partial' | 'refunded' | 'partially_refunded' | 'failed' | 'cancelled';
339
340
  total: number;
340
341
  subtotal: number;
@@ -423,16 +424,27 @@ interface TiquoReceipt {
423
424
  business: TiquoReceiptBusiness;
424
425
  customer: TiquoReceiptCustomer;
425
426
  }
427
+ /**
428
+ * A booking belonging to the authenticated customer.
429
+ *
430
+ * Note: `draft` bookings (in-progress checkout state) are never returned —
431
+ * they're internal state, not part of the customer's booking history.
432
+ */
426
433
  interface TiquoBooking {
427
434
  id: string;
428
435
  bookingNumber: string;
429
- status: 'draft' | 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
436
+ status: 'scheduled' | 'confirmed' | 'reminder_sent' | 'waiting_room' | 'waiting_list' | 'checked_in' | 'active' | 'in_progress' | 'completed' | 'cancelled' | 'no_show' | 'rescheduled';
430
437
  date: number;
431
438
  startTime: string;
432
439
  endTime: string;
433
440
  duration: number;
434
441
  timezone: string;
435
442
  attendeeCount: number;
443
+ /**
444
+ * Service title (e.g. "OJAS Listening Room"). Empty string when the
445
+ * underlying service has been deleted — render your own fallback if you
446
+ * need a non-empty display string.
447
+ */
436
448
  serviceName: string;
437
449
  serviceId: string;
438
450
  sublocationId: string;
@@ -540,9 +552,10 @@ declare class TiquoAuth {
540
552
  /**
541
553
  * Get the authenticated customer's order history.
542
554
  *
543
- * Returns orders across every status (draft, pending, processing, completed,
544
- * cancelled, refunded, open_tab) — except `lost_cart`, which is internal
545
- * marketing-recovery state and is never exposed to customers.
555
+ * Returns orders across most statuses (draft, processing, completed,
556
+ * cancelled, refunded, open_tab). `lost_cart` (abandoned) and `pending`
557
+ * (unprocessed/awaiting-payment) orders are never exposed they're
558
+ * internal state, not purchase history.
546
559
  *
547
560
  * Pass `status` to filter to a single status; pass `cursor` (an order id
548
561
  * from a previous `nextCursor`) to paginate. Sorted most recent first.
@@ -561,6 +574,11 @@ declare class TiquoAuth {
561
574
  * Convenience wrapper around `getBookings({ upcoming: true })` for the
562
575
  * common "show me my upcoming bookings" case. Results are sorted
563
576
  * soonest-first.
577
+ *
578
+ * Only actionable future bookings are returned — `cancelled`, `no_show`,
579
+ * and `rescheduled` bookings are excluded even if their date is in the
580
+ * future, since they're effectively history. Use `getBookings()` without
581
+ * `upcoming: true` if you need those.
564
582
  */
565
583
  getUpcomingBookings(options?: Omit<GetBookingsOptions, 'upcoming'>): Promise<GetBookingsResult>;
566
584
  /**
package/dist/index.js CHANGED
@@ -921,9 +921,10 @@ var TiquoAuth = class {
921
921
  /**
922
922
  * Get the authenticated customer's order history.
923
923
  *
924
- * Returns orders across every status (draft, pending, processing, completed,
925
- * cancelled, refunded, open_tab) — except `lost_cart`, which is internal
926
- * marketing-recovery state and is never exposed to customers.
924
+ * Returns orders across most statuses (draft, processing, completed,
925
+ * cancelled, refunded, open_tab). `lost_cart` (abandoned) and `pending`
926
+ * (unprocessed/awaiting-payment) orders are never exposed they're
927
+ * internal state, not purchase history.
927
928
  *
928
929
  * Pass `status` to filter to a single status; pass `cursor` (an order id
929
930
  * from a previous `nextCursor`) to paginate. Sorted most recent first.
@@ -997,6 +998,11 @@ var TiquoAuth = class {
997
998
  * Convenience wrapper around `getBookings({ upcoming: true })` for the
998
999
  * common "show me my upcoming bookings" case. Results are sorted
999
1000
  * soonest-first.
1001
+ *
1002
+ * Only actionable future bookings are returned — `cancelled`, `no_show`,
1003
+ * and `rescheduled` bookings are excluded even if their date is in the
1004
+ * future, since they're effectively history. Use `getBookings()` without
1005
+ * `upcoming: true` if you need those.
1000
1006
  */
1001
1007
  async getUpcomingBookings(options) {
1002
1008
  return this.getBookings({ ...options, upcoming: true });
package/dist/index.mjs CHANGED
@@ -885,9 +885,10 @@ var TiquoAuth = class {
885
885
  /**
886
886
  * Get the authenticated customer's order history.
887
887
  *
888
- * Returns orders across every status (draft, pending, processing, completed,
889
- * cancelled, refunded, open_tab) — except `lost_cart`, which is internal
890
- * marketing-recovery state and is never exposed to customers.
888
+ * Returns orders across most statuses (draft, processing, completed,
889
+ * cancelled, refunded, open_tab). `lost_cart` (abandoned) and `pending`
890
+ * (unprocessed/awaiting-payment) orders are never exposed they're
891
+ * internal state, not purchase history.
891
892
  *
892
893
  * Pass `status` to filter to a single status; pass `cursor` (an order id
893
894
  * from a previous `nextCursor`) to paginate. Sorted most recent first.
@@ -961,6 +962,11 @@ var TiquoAuth = class {
961
962
  * Convenience wrapper around `getBookings({ upcoming: true })` for the
962
963
  * common "show me my upcoming bookings" case. Results are sorted
963
964
  * soonest-first.
965
+ *
966
+ * Only actionable future bookings are returned — `cancelled`, `no_show`,
967
+ * and `rescheduled` bookings are excluded even if their date is in the
968
+ * future, since they're effectively history. Use `getBookings()` without
969
+ * `upcoming: true` if you need those.
964
970
  */
965
971
  async getUpcomingBookings(options) {
966
972
  return this.getBookings({ ...options, upcoming: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tiquo/dom-package",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "Tiquo SDK for third-party websites - authentication, customer profiles, orders, bookings, and enquiries",
5
5
  "sideEffects": true,
6
6
  "publishConfig": {