@final-commerce/common 2.5.1-online.2 → 2.5.1-online.4

package/dist/pos-types/index.d.mts

@@ -50,189 +50,6 @@ interface OrderTax {
     priority?: number;
 }
 
-interface OrderTip {
-    percentage?: number;
-    amount?: number;
-    tipTo?: string;
-}
-
-interface OrderSummaryPayments {
-    cardTotal: number;
-    cashTotal: number;
-    customTotal: number;
-    cardProcessingFeesTotal: number;
-}
-interface OrderSummary {
-    discountTotal: number;
-    shippingTotal?: number;
-    total: number;
-    totalTaxes: number;
-    isTaxInclusive: boolean;
-    subtotalAfterFees: number;
-    nonRevenueTotal?: number;
-    grossSales?: number;
-    lineDiscountTotal?: number;
-    cartDiscountTotal?: number;
-    feesTotal?: number;
-    lineFeesTotal?: number;
-    cartFeesTotal?: number;
-    taxableFeesTotal?: number;
-    nonTaxableFeesTotal?: number;
-    modifiersTotal?: number;
-    taxableModifiersTotal?: number;
-    nonTaxableModifiersTotal?: number;
-    totalTaxableSales?: number;
-    totalNonTaxableSales?: number;
-    tipTotal?: number;
-    cashRounding: number;
-    payments?: OrderSummaryPayments;
-    totalBeforeTip?: number;
-    amountPaid?: number;
-    taxes: OrderTax[];
-    tip?: OrderTip;
-}
-
-interface PriceModifierDetail {
-    percentage: number;
-    amount: number;
-    label?: string;
-    tax?: number;
-    taxTableId?: string;
-    taxRateId?: string;
-}
-
-interface OrderCartDiscount {
-    amount: number;
-    percentage: number;
-    label?: string;
-}
-
-interface OrderCartFee {
-    label: string;
-    id: string;
-    percentage: number;
-    amount: number;
-    taxName?: string;
-    taxTableId?: string;
-    tax?: number;
-    taxes?: OrderTax[];
-}
-
-interface OrderPaymentMethod {
-    paymentType: string;
-    amount: number;
-    transactionId: string;
-    timestamp?: string;
-    emv?: string | null;
-    cashRounding?: number;
-    change?: number;
-    processor?: string;
-    processorFee?: number;
-    tendered?: number;
-    tip?: OrderTip | null;
-}
-
-interface OrderPosData {
-    outlet?: string;
-    station?: string;
-    employee?: string;
-}
-
-interface OrderLineItemDiscount {
-    itemDiscounts?: PriceModifierDetail[];
-    cartDiscount?: PriceModifierDetail;
-}
-interface OrderLineItemFee {
-    cartFee?: PriceModifierDetail;
-    itemFees?: PriceModifierDetail[];
-}
-interface OrderLineItemModifier {
-    modifierId: string;
-    modifierName: string;
-    choiceId: string;
-    choiceName: string;
-    unitPrice: number;
-    quantity: number;
-    total: number;
-    totalTax?: number;
-    taxes?: OrderTax[];
-}
-interface OrderLineItem {
-    id?: string;
-    productId?: string;
-    variantId?: string;
-    name?: string;
-    quantity?: number;
-    manageStock?: boolean;
-    price?: number;
-    description?: string;
-    sku?: string;
-    totalTax?: number;
-    total?: number;
-    productExternalId?: string;
-    variantExternalId?: string;
-    lineItemExternalId?: string;
-    internalId?: string;
-    note?: string;
-    image?: string;
-    attributes?: string;
-    taxes?: OrderTax[];
-    discount?: OrderLineItemDiscount;
-    fee?: OrderLineItemFee;
-    modifiers?: OrderLineItemModifier[];
-    lineNetWithFees?: number;
-    metadata?: Metadata[];
-    stock?: number;
-    subTotal?: number;
-    unitId?: string;
-    unitAbbreviation?: string;
-    stockQuantity?: number;
-    unitRatioToBase?: number;
-    stockVariantId?: string;
-}
-
-interface OrderCustomSaleDiscount {
-    cartDiscount: OrderCartDiscount;
-}
-interface OrderCustomSaleFee {
-    cartFee: PriceModifierDetail;
-}
-interface OrderCustomSale {
-    customSaleId: string;
-    applyTaxes: boolean;
-    quantity: number;
-    name: string;
-    price: number;
-    totalTax: number;
-    total: number;
-    taxes?: OrderTax[];
-    discount?: OrderCustomSaleDiscount;
-    fee?: OrderCustomSaleFee;
-}
-
-interface OrderRefundSummary {
-    total?: number;
-}
-interface OrderRefund {
-    externalId?: string;
-    reason?: string;
-    summary?: OrderRefundSummary;
-}
-
-interface RefundCartDiscount {
-    amount?: number;
-    percentage?: number;
-}
-interface RefundItemDiscount {
-    amount?: number;
-    percentage?: number;
-    label?: string;
-}
-interface RefundDiscount {
-    cartDiscount?: RefundCartDiscount;
-    itemDiscounts?: RefundItemDiscount[];
-}
-
 declare enum CurrencyCode {
     USD = "USD",
     EUR = "EUR",
@@ -502,6 +319,213 @@ declare enum ReservationStatus {
     EXPIRED = "expired"
 }
 
+declare enum ShippingOptionType {
+    SHIP = "ship",
+    PICKUP = "pickup"
+}
+declare enum ShippingRateType {
+    FLAT = "flat"
+}
+declare enum ShippingChannel {
+    WEB = "web",
+    POS = "pos"
+}
+
+interface OrderShippingLine {
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    name?: string;
+    amount: number;
+    zoneId?: string;
+    optionId?: string;
+    minDays?: number;
+    maxDays?: number;
+    pickupOutletId?: string;
+    taxes?: OrderTax[];
+}
+
+interface OrderTip {
+    percentage?: number;
+    amount?: number;
+    tipTo?: string;
+}
+
+interface OrderSummaryPayments {
+    cardTotal: number;
+    cashTotal: number;
+    customTotal: number;
+    cardProcessingFeesTotal: number;
+}
+interface OrderSummary {
+    discountTotal: number;
+    shippingTotal?: number;
+    total: number;
+    totalTaxes: number;
+    isTaxInclusive: boolean;
+    subtotalAfterFees: number;
+    nonRevenueTotal?: number;
+    grossSales?: number;
+    lineDiscountTotal?: number;
+    cartDiscountTotal?: number;
+    feesTotal?: number;
+    lineFeesTotal?: number;
+    cartFeesTotal?: number;
+    taxableFeesTotal?: number;
+    nonTaxableFeesTotal?: number;
+    modifiersTotal?: number;
+    taxableModifiersTotal?: number;
+    nonTaxableModifiersTotal?: number;
+    totalTaxableSales?: number;
+    totalNonTaxableSales?: number;
+    tipTotal?: number;
+    cashRounding: number;
+    payments?: OrderSummaryPayments;
+    totalBeforeTip?: number;
+    amountPaid?: number;
+    taxes: OrderTax[];
+    tip?: OrderTip;
+}
+
+interface PriceModifierDetail {
+    percentage: number;
+    amount: number;
+    label?: string;
+    tax?: number;
+    taxTableId?: string;
+    taxRateId?: string;
+}
+
+interface OrderCartDiscount {
+    amount: number;
+    percentage: number;
+    label?: string;
+}
+
+interface OrderCartFee {
+    label: string;
+    id: string;
+    percentage: number;
+    amount: number;
+    taxName?: string;
+    taxTableId?: string;
+    tax?: number;
+    taxes?: OrderTax[];
+}
+
+interface OrderPaymentMethod {
+    paymentType: string;
+    amount: number;
+    transactionId: string;
+    timestamp?: string;
+    emv?: string | null;
+    cashRounding?: number;
+    change?: number;
+    processor?: string;
+    processorFee?: number;
+    tendered?: number;
+    tip?: OrderTip | null;
+}
+
+interface OrderPosData {
+    outlet?: string;
+    station?: string;
+    employee?: string;
+}
+
+interface OrderLineItemDiscount {
+    itemDiscounts?: PriceModifierDetail[];
+    cartDiscount?: PriceModifierDetail;
+}
+interface OrderLineItemFee {
+    cartFee?: PriceModifierDetail;
+    itemFees?: PriceModifierDetail[];
+}
+interface OrderLineItemModifier {
+    modifierId: string;
+    modifierName: string;
+    choiceId: string;
+    choiceName: string;
+    unitPrice: number;
+    quantity: number;
+    total: number;
+    totalTax?: number;
+    taxes?: OrderTax[];
+}
+interface OrderLineItem {
+    id?: string;
+    productId?: string;
+    variantId?: string;
+    name?: string;
+    quantity?: number;
+    manageStock?: boolean;
+    price?: number;
+    description?: string;
+    sku?: string;
+    totalTax?: number;
+    total?: number;
+    productExternalId?: string;
+    variantExternalId?: string;
+    lineItemExternalId?: string;
+    internalId?: string;
+    note?: string;
+    image?: string;
+    attributes?: string;
+    taxes?: OrderTax[];
+    discount?: OrderLineItemDiscount;
+    fee?: OrderLineItemFee;
+    modifiers?: OrderLineItemModifier[];
+    lineNetWithFees?: number;
+    metadata?: Metadata[];
+    stock?: number;
+    subTotal?: number;
+    unitId?: string;
+    unitAbbreviation?: string;
+    stockQuantity?: number;
+    unitRatioToBase?: number;
+    stockVariantId?: string;
+}
+
+interface OrderCustomSaleDiscount {
+    cartDiscount: OrderCartDiscount;
+}
+interface OrderCustomSaleFee {
+    cartFee: PriceModifierDetail;
+}
+interface OrderCustomSale {
+    customSaleId: string;
+    applyTaxes: boolean;
+    quantity: number;
+    name: string;
+    price: number;
+    totalTax: number;
+    total: number;
+    taxes?: OrderTax[];
+    discount?: OrderCustomSaleDiscount;
+    fee?: OrderCustomSaleFee;
+}
+
+interface OrderRefundSummary {
+    total?: number;
+}
+interface OrderRefund {
+    externalId?: string;
+    reason?: string;
+    summary?: OrderRefundSummary;
+}
+
+interface RefundCartDiscount {
+    amount?: number;
+    percentage?: number;
+}
+interface RefundItemDiscount {
+    amount?: number;
+    percentage?: number;
+    label?: string;
+}
+interface RefundDiscount {
+    cartDiscount?: RefundCartDiscount;
+    itemDiscounts?: RefundItemDiscount[];
+}
+
 interface RefundLineItem {
     taxes?: OrderTax[];
     discount?: RefundDiscount;
@@ -846,6 +870,7 @@ interface Order extends BaseEntity {
     notes: OrderNote$1[];
     billing?: Address$1;
     shipping?: Address$1;
+    shippingLine?: OrderShippingLine;
     lineItems: Partial<OrderLineItem>[];
     customSales?: OrderCustomSale[];
     nonRevenueItems?: NonRevenueItem$1[];
@@ -1708,6 +1733,48 @@ interface CartReservation extends OrderReservation {
     fees?: CustomFee[];
 }
 
+interface ShippingPriceTier {
+    from: number;
+    price: number;
+}
+interface ShippingOptionRule {
+    id: string;
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    rate?: ShippingRateType | `${ShippingRateType}`;
+    name?: string | null;
+    price: number;
+    priceByTotal?: ShippingPriceTier[] | null;
+    freeOver?: number | null;
+    minDays?: number | null;
+    maxDays?: number | null;
+    channels: (ShippingChannel | `${ShippingChannel}`)[];
+    outletId?: string | null;
+}
+
+interface CartAddress {
+    firstName?: string;
+    lastName?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postCode?: string;
+    country?: string;
+    fromCustomer?: boolean;
+}
+interface CartShipping {
+    zoneId: string;
+    optionId: string;
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    name: string | null;
+    amount: number;
+    taxes?: Tax[];
+    minDays: number | null;
+    maxDays: number | null;
+    outletId: string | null;
+    rule?: Pick<ShippingOptionRule, 'price' | 'priceByTotal' | 'freeOver'>;
+}
+
 interface ActiveCustomSales {
     id: string;
     name: string;
@@ -1743,6 +1810,10 @@ interface ActiveCart {
     amountToBeCharged: number;
     customer?: Partial<ActiveCustomer | null> | null;
     orderNotes?: string;
+    shippingAddress?: CartAddress | null;
+    billingAddress?: CartAddress | null;
+    shipping?: CartShipping | null;
+    shippingTotal?: number;
     cartTotal?: number;
     orderTotal?: number;
     orderId?: string;
@@ -2139,6 +2210,7 @@ interface CalculatedTaxDetails {
     };
     totalTaxes: TaxesDetails;
     cartFees: CartFeesDetails[];
+    shipping?: CartFeesDetails;
 }
 interface TipData {
     value: number;
@@ -2427,4 +2499,4 @@ interface PubsubEventMessage {
 }
 type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | PrinterSettingsMessage | RuntimeReadyMessage | HostNavigateMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage | PubsubTopicsRequestMessage | PubsubTopicsListMessage | PubsubSubscribeMessage | PubsubEventMessage;
 
-export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOrderReservation, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineModifier, type CartReservation, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostNavigateMessage, type HostNavigateTarget, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderLineItem, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type ResolvedModifier, type ResolvedModifierChoice, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type TimeClockEntry, type TimeClockEntryStatus, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type TopicDefinitionWire, type TopicEventWire, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };
+export { type ActiveCart, type ActiveCartProduct, type ActiveCompany, type ActiveCustomSales, type ActiveCustomer, type ActiveEntityChanges, ActiveEntityType, type ActiveFullProduct, type ActiveOrder, type ActiveOrderReservation, type ActiveOutlet, type ActivePark, type ActiveProduct, type ActiveRefundOrder, type ActiveSession, type ActiveSplitPayment, type ActiveStation, type ActiveTaxDetails, type ActiveTimer, type ActiveUpdatedOrder, type ActiveUser, type ActiveUserRole, type Address, type Attribute, type AttributeEmbedded, type AttributeOption, type BaseDocument, type BaseEntity, type BaseTile, type Booking, type BookingAvailability, type BookingResource, type BookingSlot, type BookingSlotResource, type BootstrapMessage, type CalculatedTaxDetails, type CartAddress, type CartDiscountItem, type CartFeeItem, type CartFeeTaxEntry, type CartFeesDetails, type CartLineModifier, type CartReservation, type CartShipping, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type CustomExtension, type CustomFee, type CustomSale, type CustomSaleDetails, type CustomTable, type CustomTableField, type CustomTableMetadata, type CustomTableRow, type CustomTableValue, type Customer, type CustomerNote, type DeviceEnvAttribute, type DeviceEnvCategory, type DeviceEnvValue, type DeviceOpName, type DeviceOpRequestMessage, type DeviceOpResponseMessage, type Discount, type DiscountDetail, type DiscountLineItem, type Enrich, EnvironmentDataKeys, EnvironmentDataSubKeys, type FeeDetail, type FeeLineItem, type Flow, type FlowSettings, type FlowSettingsKey, type FlowWebApp, type FlowWebAppVersion, type FullProduct, type HostHelloMessage, type HostNavigateMessage, type HostNavigateTarget, type HostShutdownMessage, type Inventory, type LineItem, type Metadata, type MetadataItem, type ModifierChoiceSelection, type ModifierSelection, type ModifierSelectionType, type NonRevenueItem, type Note, type Order, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderLineItem, type OrderLineItemDiscount, type OrderLineItemFee, type OrderLineItemModifier, type OrderNote, type OrderPaymentMethod, type OrderPosData, type OrderRefund, type OrderRefundSummary, type OrderReservation, type OrderShippingLine, type OrderStateActor, type OrderStateActorType, type OrderStateConfig, type OrderStateEvent, type OrderStateEventTrigger, type OrderStateHistoryEntry, type OrderStateOperation, type OrderStatePair, type OrderSummary, type OrderSummaryPayments, type OrderTax, type OrderTip, type Outlet, type PaymentMethod, type PaymentResponse, type PaymentSetting, PaymentStatus, type PosBrainReadyMessage, type PosDataItem, type PriceModifierDetail, type PrinterDetails, type PrinterSettings, type PrinterSettingsMessage, ProcessorType, type ProdDiscountBreakdown, type ProdFeeBreakdown, type ProdModifierBreakdown, type Product, type ProductTaxDetails, type ProductVariant, type PubsubEventMessage, type PubsubSubscribeMessage, type PubsubTopicsListMessage, type PubsubTopicsRequestMessage, type Reader, type ReaderAvailability, type ReaderCapabilities, type ReaderCapabilitiesMessage, type Refund, type RefundCartDiscount, type RefundDiscount, type RefundItem, type RefundItemDiscount, type RefundLineItem, type RefundPayment, type RefundProcessingStatus, type RefundSummary, type RefundTip, type RefundedCustomSale, type RefundedLineItem, type RefundedTipPayment, type ResolvedModifier, type ResolvedModifierChoice, type Role, type RolePermission, type RuntimeReadyMessage, type SelectionContext, type SelectionFlowContext, type SelectionMessage, type SelectionRoleContext, type ServiceChannelMessage, type ServiceChannelMessageType, type ServiceInitMessage, type Session, type SessionClosingAmounts, type SmartGridSetting, type SmartGridSettings, type SmartGridSettingsData, type Station, type StripeAccount, type Summary, type SummaryPayments, type SyncProgressMessage, type Tax, type TaxRate, type TaxRateValue, type TaxTable, type TaxTableActive, type TaxTableRate, type TileGrid, type TimeClockEntry, type TimeClockEntryStatus, type Tip, type TipData, type TipPayment, type TipsDetails, type TokenRefreshMessage, type TopicDefinitionWire, type TopicEventWire, type Transaction, type TransactionPaymentData, type User, type UserType, type Variant, type VariantInventory };