@drttix/drt-sdk 0.1.0 → 0.1.2

package/README.md

@@ -1,54 +1,54 @@
-# DRT Public API
-
-A unified NPM package for typed API clients generated from OpenAPI specs.
-This package provides typed access to `shopper` and `scanner` services via `fetch`.
-
----
-
-## 📦 Installation
-
-```bash
-npm install @drttix/public-api
-```
-
----
-
-## 📦 Usage
-
-```ts
-import { DRT } from "@drttix/public-api";
-
-const shopperGuid = "your-shopper-guid";
-const account = "your-account";
-const apiKey = "your-api-key";
-
-const root = await DRT.shopper.account.getRoot(shopperGuid, account, apiKey);
-```
-
----
-
-## 🛠️ Local Development (Developer Only)
-
-For SDK contributors testing against a local API server:
-
-```ts
-// Option 1: Use localhost:3000
-process.env.DRT_API_LOCAL = "true";
-
-// Option 2: Use a custom base URL
-process.env.DRT_API_BASE_URL = "http://localhost:8080";
-
-import { DRT } from "@drttix/public-api";
-```
-
-Or via command line:
-
-```bash
-# Use localhost:3000
-DRT_API_LOCAL=true npx tsx test.ts
-
-# Use custom base URL
-DRT_API_BASE_URL=http://localhost:8080 npx tsx test.ts
-```
-
----
+# DRT Public API
+
+A unified NPM package for typed API clients generated from OpenAPI specs.
+This package provides typed access to `shopper` and `scanner` services via `fetch`.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @drttix/drt-sdk
+```
+
+---
+
+## 📦 Usage
+
+```ts
+import { DRT } from "@drttix/drt-sdk";
+
+const shopperGuid = "your-shopper-guid";
+const account = "your-account";
+const apiKey = "your-api-key";
+
+const root = await DRT.shopper.account.getRoot(shopperGuid, account, apiKey);
+```
+
+---
+
+## 🛠️ Local Development (Developer Only)
+
+For SDK contributors testing against a local API server:
+
+```ts
+// Option 1: Use localhost:3000
+process.env.DRT_API_LOCAL = "true";
+
+// Option 2: Use a custom base URL
+process.env.DRT_API_BASE_URL = "http://localhost:8080";
+
+import { DRT } from "@drttix/drt-sdk";
+```
+
+Or via command line:
+
+```bash
+# Use localhost:3000
+DRT_API_LOCAL=true npx tsx test.ts
+
+# Use custom base URL
+DRT_API_BASE_URL=http://localhost:8080 npx tsx test.ts
+```
+
+---

package/dist/cjs/index.d.ts

@@ -1,3 +1,5 @@
+export { ShopperTypes } from "./src/definitions/shopper";
+export { ScannerTypes } from "./src/definitions/scanner";
 export declare const DRT: {
     shopper: {
         account: typeof import("./src/generated/shopper").AccountService;
@@ -5,6 +7,7 @@ export declare const DRT: {
         code: typeof import("./src/generated/shopper").CodeService;
         donation: typeof import("./src/generated/shopper").DonationService;
         event: typeof import("./src/generated/shopper").EventService;
+        giftcard: typeof import("./src/generated/shopper").GiftCardService;
         order: typeof import("./src/generated/shopper").OrderService;
         payment: typeof import("./src/generated/shopper").PaymentService;
         product: typeof import("./src/generated/shopper").ProductService;

package/dist/cjs/index.js

@@ -1,10 +1,14 @@
 "use strict";
 // AUTO-GENERATED FILE – DO NOT EDIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DRT = void 0;
+exports.DRT = exports.ScannerTypes = exports.ShopperTypes = void 0;
 const shopper_1 = require("./src/definitions/shopper");
 const scanner_1 = require("./src/definitions/scanner");
 const setBaseURL_1 = require("./src/functions/setBaseURL");
+var shopper_2 = require("./src/definitions/shopper");
+Object.defineProperty(exports, "ShopperTypes", { enumerable: true, get: function () { return shopper_2.ShopperTypes; } });
+var scanner_2 = require("./src/definitions/scanner");
+Object.defineProperty(exports, "ScannerTypes", { enumerable: true, get: function () { return scanner_2.ScannerTypes; } });
 exports.DRT = {
     shopper: shopper_1.shopper,
     scanner: scanner_1.scanner,

package/dist/cjs/src/definitions/scanner.d.ts

@@ -6,3 +6,4 @@ export declare const scanner: {
     orders: typeof OrdersService;
     scanning: typeof ScanningService;
 };
+export * as ScannerTypes from "../generated/scanner/types";

package/dist/cjs/src/definitions/scanner.js

@@ -1,7 +1,40 @@
 "use strict";
 // AUTO-GENERATED FILE – DO NOT EDIT
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scanner = void 0;
+exports.ScannerTypes = exports.scanner = void 0;
 const scanner_1 = require("../generated/scanner");
 const scanner_2 = require("../generated/scanner");
 const scanner_3 = require("../generated/scanner");
@@ -10,3 +43,5 @@ exports.scanner = {
     orders: scanner_2.OrdersService,
     scanning: scanner_3.ScanningService,
 };
+// Re-export all types as a namespace
+exports.ScannerTypes = __importStar(require("../generated/scanner/types"));

package/dist/cjs/src/definitions/shopper.d.ts

@@ -3,6 +3,7 @@ import { CartService } from "../generated/shopper";
 import { CodeService } from "../generated/shopper";
 import { DonationService } from "../generated/shopper";
 import { EventService } from "../generated/shopper";
+import { GiftCardService } from "../generated/shopper";
 import { OrderService } from "../generated/shopper";
 import { PaymentService } from "../generated/shopper";
 import { ProductService } from "../generated/shopper";
@@ -14,9 +15,11 @@ export declare const shopper: {
     code: typeof CodeService;
     donation: typeof DonationService;
     event: typeof EventService;
+    giftcard: typeof GiftCardService;
     order: typeof OrderService;
     payment: typeof PaymentService;
     product: typeof ProductService;
     seat: typeof SeatService;
     session: typeof SessionService;
 };
+export * as ShopperTypes from "../generated/shopper/types";

package/dist/cjs/src/definitions/shopper.js

@@ -1,7 +1,40 @@
 "use strict";
 // AUTO-GENERATED FILE – DO NOT EDIT
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shopper = void 0;
+exports.ShopperTypes = exports.shopper = void 0;
 const shopper_1 = require("../generated/shopper");
 const shopper_2 = require("../generated/shopper");
 const shopper_3 = require("../generated/shopper");
@@ -12,15 +45,19 @@ const shopper_7 = require("../generated/shopper");
 const shopper_8 = require("../generated/shopper");
 const shopper_9 = require("../generated/shopper");
 const shopper_10 = require("../generated/shopper");
+const shopper_11 = require("../generated/shopper");
 exports.shopper = {
     account: shopper_1.AccountService,
     cart: shopper_2.CartService,
     code: shopper_3.CodeService,
     donation: shopper_4.DonationService,
     event: shopper_5.EventService,
-    order: shopper_6.OrderService,
-    payment: shopper_7.PaymentService,
-    product: shopper_8.ProductService,
-    seat: shopper_9.SeatService,
-    session: shopper_10.SessionService,
+    giftcard: shopper_6.GiftCardService,
+    order: shopper_7.OrderService,
+    payment: shopper_8.PaymentService,
+    product: shopper_9.ProductService,
+    seat: shopper_10.SeatService,
+    session: shopper_11.SessionService,
 };
+// Re-export all types as a namespace
+exports.ShopperTypes = __importStar(require("../generated/shopper/types"));

package/dist/cjs/src/generated/scanner/types.d.ts

@@ -0,0 +1,31 @@
+export type { DatabaseUpload } from './models/DatabaseUpload';
+export type { DatabaseUploadData } from './models/DatabaseUploadData';
+export type { DisplayMessage } from './models/DisplayMessage';
+export type { EventResponse } from './models/EventResponse';
+export type { EventResponseStats } from './models/EventResponseStats';
+export type { EventSkin } from './models/EventSkin';
+export type { MobileReceiptResponse } from './models/MobileReceiptResponse';
+export type { OrderDetails } from './models/OrderDetails';
+export type { OrderProduct } from './models/OrderProduct';
+export type { OrderSeat } from './models/OrderSeat';
+export type { OrderSummary } from './models/OrderSummary';
+export type { Product } from './models/Product';
+export type { ProductQR } from './models/ProductQR';
+export type { ProductScan } from './models/ProductScan';
+export type { QueryDatabaseUnionResult } from './models/QueryDatabaseUnionResult';
+export type { ReceiptBuyerDetails } from './models/ReceiptBuyerDetails';
+export type { ReceiptEventDetails } from './models/ReceiptEventDetails';
+export type { ReceiptProductDetails } from './models/ReceiptProductDetails';
+export type { ReceiptResponse } from './models/ReceiptResponse';
+export type { ReceiptSeatDetails } from './models/ReceiptSeatDetails';
+export type { ResultMessage } from './models/ResultMessage';
+export type { RowResult } from './models/RowResult';
+export type { SeatQR } from './models/SeatQR';
+export type { SeatResponse } from './models/SeatResponse';
+export type { SeatResult } from './models/SeatResult';
+export type { SectionResult } from './models/SectionResult';
+export type { TicketDatabase } from './models/TicketDatabase';
+export type { TicketScan } from './models/TicketScan';
+export type { TicketScanStats } from './models/TicketScanStats';
+export type { TicketSeats } from './models/TicketSeats';
+export type { UploadDatabaseResponse } from './models/UploadDatabaseResponse';

package/dist/cjs/src/generated/scanner/types.js

@@ -0,0 +1,4 @@
+"use strict";
+// AUTO-GENERATED FILE – DO NOT EDIT
+// Re-export all types as a namespace
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/core/OpenAPI.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPI = void 0;
 exports.OpenAPI = {
     BASE: 'https://api.drttix.com/shopper',
-    VERSION: '20251230.1',
+    VERSION: '20260107.1',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/cjs/src/generated/shopper/index.d.ts

@@ -32,6 +32,12 @@ export type { GAHold } from './models/GAHold';
 export type { GAResponse } from './models/GAResponse';
 export type { GASeatRelease } from './models/GASeatRelease';
 export type { GetEventsResponse } from './models/GetEventsResponse';
+export type { GiftCardApplyDto } from './models/GiftCardApplyDto';
+export type { GiftCardApplyResponse } from './models/GiftCardApplyResponse';
+export type { GiftCardCheckoutInfo } from './models/GiftCardCheckoutInfo';
+export type { GiftCardEditFormResponse } from './models/GiftCardEditFormResponse';
+export type { GiftCardLookupResponse } from './models/GiftCardLookupResponse';
+export type { GiftCardRemoveResponse } from './models/GiftCardRemoveResponse';
 export type { GuidReturn } from './models/GuidReturn';
 export type { HasAccessResponse } from './models/HasAccessResponse';
 export type { LandingConfig } from './models/LandingConfig';
@@ -101,6 +107,7 @@ export { CartService } from './services/CartService';
 export { CodeService } from './services/CodeService';
 export { DonationService } from './services/DonationService';
 export { EventService } from './services/EventService';
+export { GiftCardService } from './services/GiftCardService';
 export { OrderService } from './services/OrderService';
 export { PaymentService } from './services/PaymentService';
 export { ProductService } from './services/ProductService';

package/dist/cjs/src/generated/shopper/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionService = exports.SeatService = exports.ProductService = exports.PaymentService = exports.OrderService = exports.EventService = exports.DonationService = exports.CodeService = exports.CartService = exports.AccountService = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.ApiError = void 0;
+exports.SessionService = exports.SeatService = exports.ProductService = exports.PaymentService = exports.OrderService = exports.GiftCardService = exports.EventService = exports.DonationService = exports.CodeService = exports.CartService = exports.AccountService = exports.OpenAPI = exports.CancelError = exports.CancelablePromise = exports.ApiError = void 0;
 /* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -22,6 +22,8 @@ var DonationService_1 = require("./services/DonationService");
 Object.defineProperty(exports, "DonationService", { enumerable: true, get: function () { return DonationService_1.DonationService; } });
 var EventService_1 = require("./services/EventService");
 Object.defineProperty(exports, "EventService", { enumerable: true, get: function () { return EventService_1.EventService; } });
+var GiftCardService_1 = require("./services/GiftCardService");
+Object.defineProperty(exports, "GiftCardService", { enumerable: true, get: function () { return GiftCardService_1.GiftCardService; } });
 var OrderService_1 = require("./services/OrderService");
 Object.defineProperty(exports, "OrderService", { enumerable: true, get: function () { return OrderService_1.OrderService; } });
 var PaymentService_1 = require("./services/PaymentService");

package/dist/cjs/src/generated/shopper/models/GiftCardApplyDto.d.ts

@@ -0,0 +1,18 @@
+export type GiftCardApplyDto = {
+    /**
+     * Gift card code
+     */
+    code: string;
+    /**
+     * Gift card PIN
+     */
+    pin: string;
+    /**
+     * Maximum amount to apply from gift card (0 or omitted for full balance)
+     */
+    maxAmount?: number;
+    /**
+     * Whether to fill contact info from gift card purchaser
+     */
+    fillContactInfo?: boolean;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardApplyDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/models/GiftCardApplyResponse.d.ts

@@ -0,0 +1,30 @@
+export type GiftCardApplyResponse = {
+    /**
+     * Indicates the apply operation was successful
+     */
+    success: boolean;
+    /**
+     * Total payment amount before credit card (gift cards + contributions)
+     */
+    paymentBeforeCc: number;
+    /**
+     * Current order total
+     */
+    orderTotal: number;
+    /**
+     * First name from POS (if fillContactInfo was true)
+     */
+    posFirstName?: string;
+    /**
+     * Last name from POS (if fillContactInfo was true)
+     */
+    posLastName?: string;
+    /**
+     * Email from POS (if fillContactInfo was true)
+     */
+    posEmail?: string;
+    /**
+     * Phone from POS (if fillContactInfo was true)
+     */
+    posPhone?: string;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardApplyResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/models/GiftCardCheckoutInfo.d.ts

@@ -0,0 +1,30 @@
+export type GiftCardCheckoutInfo = {
+    /**
+     * Whether a gift card is applied to the session
+     */
+    hasGiftCard: boolean;
+    /**
+     * Gift card code (masked)
+     */
+    code?: string;
+    /**
+     * Amount applied from the gift card
+     */
+    amount?: number;
+    /**
+     * Whether this is a house card (cash payment)
+     */
+    isHouseCard?: boolean;
+    /**
+     * Current order total
+     */
+    orderTotal: number;
+    /**
+     * Total payment amount before credit card (gift cards + contributions)
+     */
+    paymentBeforeCc: number;
+    /**
+     * Remaining balance to pay by credit card
+     */
+    remainingBalance: number;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardCheckoutInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/models/GiftCardEditFormResponse.d.ts

@@ -0,0 +1,10 @@
+export type GiftCardEditFormResponse = {
+    /**
+     * Gift card code
+     */
+    code: string;
+    /**
+     * Amount applied from the gift card
+     */
+    amount: number;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardEditFormResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/models/GiftCardLookupResponse.d.ts

@@ -0,0 +1,18 @@
+export type GiftCardLookupResponse = {
+    /**
+     * Indicates the lookup was successful
+     */
+    success: boolean;
+    /**
+     * Current balance on the gift card
+     */
+    balance: number;
+    /**
+     * Available balance considering pending transactions
+     */
+    available: number;
+    /**
+     * Maximum amount needed to cover the current order
+     */
+    maxNeeded: number;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardLookupResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/models/GiftCardRemoveResponse.d.ts

@@ -0,0 +1,14 @@
+export type GiftCardRemoveResponse = {
+    /**
+     * Indicates the remove operation was successful
+     */
+    success: boolean;
+    /**
+     * Total payment amount before credit card (gift cards + contributions)
+     */
+    paymentBeforeCc: number;
+    /**
+     * Current order total
+     */
+    orderTotal: number;
+};

package/dist/cjs/src/generated/shopper/models/GiftCardRemoveResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/generated/shopper/services/GiftCardService.d.ts

@@ -0,0 +1,62 @@
+import type { GiftCardApplyDto } from '../models/GiftCardApplyDto';
+import type { GiftCardApplyResponse } from '../models/GiftCardApplyResponse';
+import type { GiftCardCheckoutInfo } from '../models/GiftCardCheckoutInfo';
+import type { GiftCardEditFormResponse } from '../models/GiftCardEditFormResponse';
+import type { GiftCardLookupResponse } from '../models/GiftCardLookupResponse';
+import type { GiftCardRemoveResponse } from '../models/GiftCardRemoveResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class GiftCardService {
+    /**
+     * Look up a gift card by code and PIN
+     * Retrieves gift card balance and availability information for the specified code and PIN.
+     * @param code Gift card code
+     * @param pin Gift card PIN
+     * @param shopperguid Unique identifier for the shopper.
+     * @param accountid Unique identifier for the account.
+     * @param apikey API key for authentication.
+     * @returns GiftCardLookupResponse Returns gift card balance and availability information.
+     * @throws ApiError
+     */
+    static lookupGiftCard(code: string, pin: string, shopperguid: string, accountid: string, apikey: string): CancelablePromise<GiftCardLookupResponse>;
+    /**
+     * Apply a gift card to the current session
+     * Applies a gift card to the current shopper session. Removes any previously applied gift card.
+     * @param shopperguid Unique identifier for the shopper.
+     * @param accountid Unique identifier for the account.
+     * @param apikey API key for authentication.
+     * @param requestBody Gift card details to apply
+     * @returns GiftCardApplyResponse Gift card applied successfully.
+     * @throws ApiError
+     */
+    static applyGiftCard(shopperguid: string, accountid: string, apikey: string, requestBody: GiftCardApplyDto): CancelablePromise<GiftCardApplyResponse>;
+    /**
+     * Remove the gift card from the current session
+     * Removes all gift cards from the current shopper session and recalculates payment totals.
+     * @param shopperguid Unique identifier for the shopper.
+     * @param accountid Unique identifier for the account.
+     * @param apikey API key for authentication.
+     * @returns GiftCardRemoveResponse Gift card removed successfully.
+     * @throws ApiError
+     */
+    static removeGiftCard(shopperguid: string, accountid: string, apikey: string): CancelablePromise<GiftCardRemoveResponse>;
+    /**
+     * Get gift card checkout information
+     * Retrieves gift card information for the checkout page, including applied gift card details and remaining balance.
+     * @param shopperguid Unique identifier for the shopper.
+     * @param accountid Unique identifier for the account.
+     * @param apikey API key for authentication.
+     * @returns GiftCardCheckoutInfo Returns gift card checkout information.
+     * @throws ApiError
+     */
+    static getGiftCardCheckoutInfo(shopperguid: string, accountid: string, apikey: string): CancelablePromise<GiftCardCheckoutInfo>;
+    /**
+     * Get gift card edit form data
+     * Retrieves the currently applied gift card information for editing purposes.
+     * @param shopperguid Unique identifier for the shopper.
+     * @param accountid Unique identifier for the account.
+     * @param apikey API key for authentication.
+     * @returns GiftCardEditFormResponse Returns the applied gift card code and amount.
+     * @throws ApiError
+     */
+    static getGiftCardEditForm(shopperguid: string, accountid: string, apikey: string): CancelablePromise<GiftCardEditFormResponse>;
+}