Add transaction complete event types

Shopify · Jan 22, 2025 · 083d4bf · 083d4bf
1 parent 4de072e
commit 083d4bf
Show file tree

Hide file tree

Showing 4 changed files with 104 additions and 9 deletions.
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/api.ts b/packages/ui-extensions/src/surfaces/point-of-sale/api.ts
@@ -91,6 +91,9 @@ export type {
   LineItemDiscount,
   CustomSale,
   Address,
+  PaymentMethod,
+  ShippingLine,
+  TaxLine,
 } from './types/cart';
 
 export type {MultipleResourceResult} from './types/multiple-resource-result';

diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts b/packages/ui-extensions/src/surfaces/point-of-sale/event/input/PurchaseCompleteInput.ts
@@ -1,11 +1,21 @@
+import {
+  Discount,
+  LineItem,
+  PaymentMethod,
+  ShippingLine,
+  TaxLine,
+} from '../../api';
 import {BaseInput} from './BaseInput';
 
 export interface PurchaseCompleteInput extends BaseInput {
-  lineItems: any[];
-  discounts: any[];
-  attributedStaff: any;
-  orderId: any;
-  draftCheckoutId: any;
-  taxLines: any[];
-  shippingLines: any[];
+  purchaseComplete: {
+    attributedStaff: any;
+    discounts: Discount[];
+    draftCheckoutId: string;
+    lineItems: LineItem[];
+    orderId: string;
+    paymentMethods: PaymentMethod[];
+    shippingLines: ShippingLine;
+    taxLines: TaxLine[];
+  };
 }
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts b/packages/ui-extensions/src/surfaces/point-of-sale/types/cart.ts
@@ -34,6 +34,7 @@ export interface LineItem {
   vendor?: string;
   properties: {[key: string]: string};
   isGiftCard: boolean;
+  attributedUserId?: number;
 }
 
 export interface Discount {
@@ -107,3 +108,84 @@ export interface Address {
   provinceCode?: string;
   countryCode?: CountryCode;
 }
+
+export type ShippingLine =
+  | {
+      handle: string;
+      price: string;
+      title: string;
+      methodType: ShippingMethodType;
+      type: 'Calculated';
+    }
+  | {
+      handle: string;
+      price: string;
+      title: string;
+      type: 'Custom';
+    };
+
+export enum ShippingMethodType {
+  Shipping = 'SHIPPING',
+  Retail = 'RETAIL',
+}
+
+export interface TaxLine {
+  uuid: string;
+  price: string;
+  rate: number;
+  // For bundles we need to show the range of the tax rate.
+  // This is the minimum and maximum tax rate of the tax lines of the components.
+  rateRange?: [number, number];
+  title: string;
+  enabled: boolean;
+}
+
+export type PaymentMethod =
+  | CashPayment
+  | CreditPayment
+  | GiftCardPayment
+  | ShopPayPayment
+  | CustomPayment
+  | UnknownPayment;
+
+export type CardSource = 'manual' | 'swiped' | 'emv';
+
+interface BasePayment {
+  amount: string;
+}
+
+interface CreditPayment extends BasePayment {
+  type: 'CreditCard';
+  lastDigits: string;
+  brand: string;
+  tipAmount: string;
+  cardSource?: CardSource;
+  hasPendingOfflineTransactions: boolean;
+}
+
+interface CashPayment extends BasePayment {
+  type: 'Cash';
+  changeAmount: string;
+  roundedAmount?: string;
+}
+
+interface GiftCardPayment extends BasePayment {
+  type: 'GiftCard';
+  lastCharacters: string;
+  balance?: string;
+}
+
+interface ShopPayPayment extends BasePayment {
+  type: 'ShopPay';
+  isInstallmentsPayment: boolean;
+  orderTransactionId?: string;
+}
+
+interface CustomPayment extends BasePayment {
+  type: 'Custom';
+  name: string;
+}
+
+interface UnknownPayment extends BasePayment {
+  type: 'Unknown';
+}
diff --git a/packages/ui-extensions/src/surfaces/point-of-sale/types/device.ts b/packages/ui-extensions/src/surfaces/point-of-sale/types/device.ts
@@ -4,9 +4,9 @@ export interface Device {
    */
   name: string;
   /**
-   * The string ID of the device
+   * The ID of the device
    */
-  deviceId: string;
+  deviceId: number;
   /**
    * Whether the device is a tablet
    */