@final-commerce/common 2.9.2-preprod.1 → 2.10.0

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
@@ -190,8 +190,7 @@ declare enum Platform {
190
190
  declare enum OrderPlatform {
191
191
  POS = "in-store",
192
192
  WOO_COMMERCE = "woo-commerce",
193
- PUBLIC_API = "public-api",
194
- ONLINE_STORE = "online-store"
193
+ PUBLIC_API = "public-api"
195
194
  }
196
195
  declare enum CustomerPlatform {
197
196
  POS = "in-store",
@@ -453,43 +452,6 @@ declare enum ResourceAvailabilityState {
453
452
  NO_HOURS_IN_RANGE = "noHoursInRange"
454
453
  }
455
454
 
456
- declare enum ShippingZoneKind {
457
- COUNTRY = "country",
458
- PROVINCE = "province",
459
- CITY = "city",
460
- EVERYWHERE = "everywhere"
461
- }
462
- declare enum ShippingOptionType {
463
- SHIP = "ship",
464
- PICKUP = "pickup"
465
- }
466
- declare enum ShippingRateType {
467
- FLAT = "flat"
468
- }
469
- declare enum ShippingChannel {
470
- WEB = "web",
471
- POS = "pos"
472
- }
473
- declare enum ShippingNoOptionReason {
474
- INCOMPLETE = "INCOMPLETE",
475
- ADDRESS_MISMATCH = "ADDRESS_MISMATCH",
476
- NO_COVERAGE = "NO_COVERAGE",
477
- BLOCKED = "BLOCKED",
478
- NO_OPTION = "NO_OPTION"
479
- }
480
- declare enum ShippingZoneError {
481
- NO_PLACES = "NO_PLACES",
482
- INVALID_PLACE = "INVALID_PLACE",
483
- DUPLICATE_PLACE = "DUPLICATE_PLACE",
484
- NO_WEBSITE_OPTION = "NO_WEBSITE_OPTION",
485
- INVALID_PRICE = "INVALID_PRICE",
486
- INVALID_DAYS = "INVALID_DAYS",
487
- INVALID_TIERS = "INVALID_TIERS",
488
- NO_CHANNEL = "NO_CHANNEL",
489
- PICKUP_WITHOUT_STORE = "PICKUP_WITHOUT_STORE",
490
- MISSING_NAME = "MISSING_NAME"
491
- }
492
-
493
455
  declare enum SalesLineAction {
494
456
  SALE = "sale",
495
457
  REFUND = "refund"
@@ -1041,46 +1003,6 @@ declare function compositeModifierMismatches(lineItems: readonly {
1041
1003
  }[]): string[];
1042
1004
  declare function compositeReservationMismatches(order: CompositeReservationOrder): string[];
1043
1005
 
1044
- type IdLike = string | {
1045
- toString(): string;
1046
- };
1047
- interface StockLineComponent {
1048
- productId: IdLike;
1049
- variantId: IdLike;
1050
- quantity: number;
1051
- stockQuantity?: number | null;
1052
- unitId?: IdLike | null;
1053
- stockVariantId?: IdLike | null;
1054
- }
1055
- interface StockLine {
1056
- internalId?: string | null;
1057
- productId?: IdLike | null;
1058
- variantId?: IdLike | null;
1059
- name?: string | null;
1060
- stockQuantity?: number | null;
1061
- unitId?: IdLike | null;
1062
- stockVariantId?: IdLike | null;
1063
- components?: readonly StockLineComponent[] | null;
1064
- }
1065
- interface StockReservationLink {
1066
- lineItemInternalId?: string | null;
1067
- componentIndex?: number | null;
1068
- }
1069
- interface LineStockMove {
1070
- productId: string;
1071
- variantId: string;
1072
- fields: {
1073
- quantity: number;
1074
- stockQuantity?: number;
1075
- unitId?: string;
1076
- stockVariantId?: string;
1077
- compositeProductId?: string;
1078
- compositeName?: string;
1079
- };
1080
- componentIndex?: number;
1081
- }
1082
- declare function lineStockMoves(item: StockLine, quantity: number, reservations?: readonly StockReservationLink[]): LineStockMove[];
1083
-
1084
1006
  declare const SYSTEM_FAMILY_IDS: {
1085
1007
  readonly COUNT: "count";
1086
1008
  readonly WEIGHT: "weight-metric";
@@ -1783,112 +1705,6 @@ declare function planWindow({ rule, timeZone, presence, startAt, endAt, now, bus
1783
1705
  };
1784
1706
  declare const holdExpiresAt: (rule: BookingRulesInput, now: Date) => Date;
1785
1707
 
1786
- interface ShippingPlace {
1787
- country: string;
1788
- province?: string | null;
1789
- city?: string | null;
1790
- }
1791
- interface ShippingPriceTier {
1792
- from: number;
1793
- price: number;
1794
- }
1795
- interface ShippingOptionRule {
1796
- id: string;
1797
- type: ShippingOptionType | `${ShippingOptionType}`;
1798
- rate?: ShippingRateType | `${ShippingRateType}`;
1799
- name?: string | null;
1800
- price: number;
1801
- priceByTotal?: ShippingPriceTier[] | null;
1802
- freeOver?: number | null;
1803
- minDays?: number | null;
1804
- maxDays?: number | null;
1805
- channels: (ShippingChannel | `${ShippingChannel}`)[];
1806
- outletId?: string | null;
1807
- }
1808
- interface ShippingZoneRule {
1809
- id: string;
1810
- kind: ShippingZoneKind | `${ShippingZoneKind}`;
1811
- places: ShippingPlace[];
1812
- ships: boolean;
1813
- message?: string | null;
1814
- options: ShippingOptionRule[];
1815
- }
1816
- interface AddressLike {
1817
- country?: string | null;
1818
- state?: string | null;
1819
- province?: string | null;
1820
- city?: string | null;
1821
- postCode?: string | null;
1822
- postalCode?: string | null;
1823
- zip?: string | null;
1824
- }
1825
- interface NormalizedAddress {
1826
- country?: string;
1827
- province?: string;
1828
- cityKey?: string;
1829
- postCode?: string;
1830
- }
1831
- interface ShippingQuoteOption {
1832
- optionId: string;
1833
- zoneId: string;
1834
- type: ShippingOptionType | `${ShippingOptionType}`;
1835
- name: string | null;
1836
- amount: number;
1837
- amountToFree: number | null;
1838
- minDays: number | null;
1839
- maxDays: number | null;
1840
- outletId: string | null;
1841
- }
1842
- interface ShippingResolution {
1843
- zoneId: string | null;
1844
- options: ShippingQuoteOption[];
1845
- reason: ShippingNoOptionReason | null;
1846
- message: string | null;
1847
- shipsToCountries: string[];
1848
- }
1849
- interface ResolveShippingInput {
1850
- zones: ShippingZoneRule[];
1851
- address: AddressLike | null | undefined;
1852
- itemsTotal: number;
1853
- channel: ShippingChannel | `${ShippingChannel}`;
1854
- }
1855
-
1856
- declare function normalizeCountry(value: string | null | undefined): string | undefined;
1857
- interface CountryOption {
1858
- code: string;
1859
- name: string;
1860
- }
1861
- declare function listCountries(locale?: string): CountryOption[];
1862
-
1863
- interface Province {
1864
- code: string;
1865
- name: string;
1866
- nameFr: string;
1867
- postalLetters: string[];
1868
- aliases?: string[];
1869
- }
1870
- declare const CANADA_PROVINCES: readonly Province[];
1871
- declare function normalizeProvince(country: string | undefined, value: string | null | undefined): string | undefined;
1872
- declare function listProvinces(country: string): readonly Province[];
1873
- declare function provincesForPostCode(country: string | undefined, postCode: string | undefined): string[];
1874
-
1875
- declare const EVERYWHERE_KEY = "*";
1876
- declare function normalizeCityKey(value: string | null | undefined): string | undefined;
1877
- declare function normalizePostCode(value: string | null | undefined): string | undefined;
1878
- declare function normalizeAddress(address: AddressLike | null | undefined): NormalizedAddress;
1879
- declare function postCodeMatchesProvince(address: NormalizedAddress): boolean;
1880
- declare function placeKey(place: ShippingPlace): string | undefined;
1881
- declare function addressPlaceKeys(address: NormalizedAddress): string[];
1882
-
1883
- declare function resolveShipping({ zones, address, itemsTotal, channel }: ResolveShippingInput): ShippingResolution;
1884
- declare function priceForTotal(option: ShippingOptionRule, itemsTotal: number): number;
1885
-
1886
- interface ShippingZoneProblem {
1887
- code: ShippingZoneError;
1888
- optionId?: string;
1889
- }
1890
- declare function validateShippingZone(zone: ShippingZoneRule): ShippingZoneProblem[];
1891
-
1892
1708
  interface CurrencyRate {
1893
1709
  rate: number;
1894
1710
  country: string;
@@ -1900,25 +1716,6 @@ declare const EUFixedRates: Record<string, CurrencyRate>;
1900
1716
  declare const OtherFixedRates: Record<string, CurrencyRate>;
1901
1717
  declare const COUNTRY_CURRENCIES: Record<string, string>;
1902
1718
 
1903
- declare enum ProcessorType {
1904
- FINAL_PAY = "Terminal",
1905
- TAP_TO_PAY = "TapToPay",
1906
- MOTO = "Moto",
1907
- CLOUD = "Cloud",
1908
- BLUETOOTH = "Bluetooth",
1909
- CASH = "Cash",
1910
- CUSTOM_PAY = "CustomPay",
1911
- VENDARA = "Vendara",
1912
- REDEEM = "Redeem",
1913
- INTEGRATION = "Integration",
1914
- PAYMENT_LINK = "PaymentLink",
1915
- ONLINE_PAYMENT = "OnlinePayment",
1916
- EXTERNAL = "External"
1917
- }
1918
-
1919
- declare const PAYMENT_CHANNELS: readonly ["inPerson", "online"];
1920
- type PaymentChannel = (typeof PAYMENT_CHANNELS)[number];
1921
-
1922
1719
  declare const EXPENSE_PAYMENT_METHOD_PRESETS: readonly ["Cash", "Cheque", "Credit card", "Direct debit", "E-Transfer", "Wire transfer"];
1923
1720
  declare const EXPENSE_NAME_MAX_LENGTH = 40;
1924
1721
  declare const EXPENSE_DEFAULT_CATEGORIES: readonly [{
@@ -1957,4 +1754,22 @@ declare const EXPENSE_DEFAULT_CATEGORIES: readonly [{
1957
1754
  }];
1958
1755
  type ExpenseDefaultCategoryKey = (typeof EXPENSE_DEFAULT_CATEGORIES)[number]['key'];
1959
1756
 
1960
- export { ADYEN_JOB_TITLE_ASSOCIATION_TYPES, ADYEN_LEGAL_ENTITY_STATE_PROVINCE_COUNTRIES, ADYEN_NO_TAX_NUMBER_ABSENT_COUNTRIES, ADYEN_ROLLOUT_COUNTRY_CODES, ADYEN_STORE_STATE_PROVINCE_COUNTRIES, ADYEN_TAX_NUMBER_FORMATS, ADYEN_TAX_NUMBER_MIN_LENGTH, AFFIRM_COUNTRY_CODES, AFFIRM_PRICE_PLANS, type AddressLike, type AdyenBnplSettings, type AdyenBnplSkippedStore, type AdyenBnplUpdateResult, type AffirmPricePlan, type Amount, type AssignUserChange, AttributeType, type AvailabilityInput, type AvailabilitySlot, type AvailableTransition, BNPL_METHOD_STATUS, BNPL_SKIP_REASON, type BnplMethodStatus, type BnplSkipReason, type BookingOccupancy, BookingRatePeriod, type BookingResourceInput, BookingResourceKind, BookingResourceStatus, BookingRulesError, type BookingRulesInput, BookingType, type BusyWindow, CANADA_PROVINCES, CONDITION_OPERATORS, COUNTRY_CURRENCIES, CURRENCY_CONFIG, type CartDiscountBucket, type CartFeeBucket, type CashDrawer, type CashRoundingTuple, type CategoryModifierRow, type CategoryRow, CompanyType, type CompositeAvailabilityRows, type CompositeMakeable, type CompositeMakeableRow, type CompositePriceItem, type CompositePricePart, type CompositeReservationOrder, type CompositeShelf, type CompositeStockPart, type Condition, type ConditionGroup, type ConditionOperator, type ConfigUpdatedPayload, type ConfigValidationError, type ConfigValidationResult, type ConfigValidationWarning, type CountryOption, type CrossAxisRequires, type CrossAxisRule, type CrossAxisTrigger, CurrencyCode, type CurrencyConfig, type CurrencyRate, CustomTableAvailability, CustomerPlatform, DEFAULT_CONFIG, DEFAULT_CROSS_AXIS_RULES, DEFAULT_DISPLAY_STATE_MAP, DEFAULT_HOLD_MINUTES, DEFAULT_RESOLVED_CONFIG, DEFAULT_UNIT_ID, type DeleteStateConfigFragmentParams, type DeleteStateConfigFragmentResponse, type DiscountsBreakdown, type DiscountsTuple, type DisplayStateResult, type DisplayStateRule, DualWriteStrategy, EUFixedRates, EUROPE, EVERYWHERE_KEY, EXPENSE_DEFAULT_CATEGORIES, EXPENSE_NAME_MAX_LENGTH, EXPENSE_PAYMENT_METHOD_PRESETS, type EndOfSessionReport, type ExpenseDefaultCategoryKey, ExtensionCategory, FINANCIAL_INVARIANTS, FULFILLMENT_STATES, type FailedCondition, type FeesBreakdown, FeesCustomBillingStatus, type FeesTuple, type FinancialInvariant, type FragmentParam, type FragmentValidationResult, type FulfillmentState, type FulfillmentStateDefinition, type FulfillmentTransitionPath, type GetAvailableTransitionsParams, type GetAvailableTransitionsResponse, type GetOrderDisplayStateParams, type GetOrderDisplayStateResponse, type GetOrderStateConfigParams, type GetOrderStateConfigResponse, type GetStateConfigFragmentParams, type GetStateConfigFragmentResponse, type GridSlot, HttpMethod, InventoryBaseActionEnum, type InventoryBaseActionType, InventorySpecificActionType, InvoiceStatus, LegacyWriteStrategy, LibraryItemType, type LineStockMove, MAX_PRECISION, type Measurable, type MeasurementBase, type MeasurementUnit, type MeasurementUnitFamily, MenuProject, type ModifierChoiceRow, type ModifierRow, type ModifiersBreakdown, type ModifiersTuple, NAFixedRates, NORTH_AMERICA, NonRevenueItemType, type NormalizedAddress, ORDER_STATE_ACTIONS, ORDER_STATE_EVENTS, ORDER_STATE_TOPIC, type OrderContext, type OrderLikeForAssignedUsers, type OrderLikeForContext, type OrderLikeForInCart, type OrderLikeForLegacyInference, type OrderLineItem, type OrderMutationData, type OrderPaymentMethod, OrderPlatform, type OrderRefund, type OrderReservationForContext, type OrderStateEventPayload, type OrderStateWritable, type OrderStatusDefinition, type OrderStatusValidationError, type OrderWriteStrategy, OtherFixedRates, OwnerType, PATH_MODES, PAYMENT_CHANNELS, PAYMENT_STATES, POS_VALID_INITIAL_STATES, type PathMode, type PaymentChannel, PaymentMethod, PaymentProcessor, type PaymentState, type PaymentStateDefinition, type PaymentTransitionPath, type PlanWindowInput, Platform, type PoolDrawing, PreviewImageMode, PricingLevel, PricingPlanEnum, PricingRegionEnum, ProcessorType, type ProductDiscountBucket, type ProductFeeBucket, ProductSalesChartStep, ProductSalesReportCompare, ProductStatus, ProductType, type Province, PublicationAvailability, type PublicationConfig, PublicationStatus, REGION_MAPPING, REPORT_NEGATE_PATHS, ReceiptSendChannel, ReceiptType, type RefundsBreakdown, ReservationStatus, ResidualPaymentMethod, ResidualStatus, type ResolveInputs, type ResolveShippingInput, type ResolveTemplateResult, type ResourceAvailability, ResourceAvailabilityState, type ResourceInWindow, type ResourcePresenceRow, STATE_SCHEMA, STRIPE_SUPPORTED_COUNTRIES, SYSTEM_FAMILIES, SYSTEM_FAMILY_IDS, SYSTEM_UNITS, SYSTEM_UNIT_IDS, SalesLineAction, SalesLineSourceArray, type SalesSummary, type SaveStateConfigFragmentParams, type SaveStateConfigFragmentResponse, type SettlementBreakdown, type SettlementBuckets, type SettlementCardSection, type SettlementCashSection, type SettlementCustomEntry, ShippingChannel, ShippingNoOptionReason, type ShippingOptionRule, ShippingOptionType, type ShippingPlace, type ShippingPriceTier, type ShippingQuoteOption, ShippingRateType, type ShippingResolution, ShippingZoneError, ShippingZoneKind, type ShippingZoneProblem, type ShippingZoneRule, type SplitPayment, type SplitPaymentPayment, type StaffSales, type StaffSalesEntry, type StateConfig, type StateConfigFragment, type StateDefinition, type StatePair, type StateSchema, type StateTransitionBlockedPayload, type StateTransitionCompletedPayload, StationStatus, type StockLine, type StockLineComponent, type StockReservationLink, type StoredStateConfig, StripeCurrencyCode, StripeStatus, type TaxBreakdown, type TaxBreakdownRateEntry, type TaxBreakdownSection, type TaxBreakdownSubtotal, type TaxesTuple, TimePeriod, type TipEntry, type TipsBreakdown, type TipsTuple, TopMetericsSort, type TransitionBlockedBy, type TransitionConditionSet, type TransitionOrderStateParams, type TransitionOrderStateResponse, type TransitionPath, type TransitionRequest, type TransitionResult, UserTypes, type WeeklyHours, addAmounts, addressPlaceKeys, adyenLegalEntityRequiresStateOrProvince, adyenRequiresJobTitle, adyenStoreRequiresStateOrProvince, adyenSupportsTaxNumberAbsent, adyenTaxNumberFormat, amountToString, ancestorChain, applyAssignment, assertUnitSane, availableIn, baseFor, baseFulfillmentDefinitions, baseOf, basePaymentDefinitions, buildAvailability, buildGrid, buildOrderContext, buildPosPresetConfig, buildResolvedConfig, calculatePercentage, canTransition, cheapestCompositeItem, cheapestCompositePrice, compositeItemCost, compositeItemUnavailable, compositeMakeable, compositeModifierMismatches, compositeReservationMismatches, compositeVariantInStock, conditionSummary, convertFixedFeeToLocalCurrency, createAmount, crossAxisRuleApplies, currentAssignees, deriveDisplayState, deriveFamilyCode, deriveUnitId, displayRuleMatchesPair, divideAmount, evaluateCondition, evaluateConditionSet, extendPrice, extendPriceFor, formatCurrency, formatInUnit, formatMinorUnitsToString, formatQuantity, fromBase, fromMinorUnits, generateMongoID, getAvailableTransitions, getCashAmountDue, getCountriesByRegion, getCurrencyConfig, getCurrentISODate, getFinancialInvariantViolations, getGoodsPortion, getLineSubtotal, getMinorUnitMultiplier, getMinorUnits, getPaymentLegTotal, getPricingRegionFromCountry, getSettlementTotal, getTotalCollected, hasInCartFlag, hasSellableChoice, holdExpiresAt, inferStatesFromLegacyStatus, isAdyenRolloutCountry, isAffirmCountry, isAffirmPricePlan, isChoiceAvailableAtOutlet, isConditionOperator, isFulfillmentState, isInCart, isPaymentState, isSupportedCurrency, isSystemFamilyCode, isValidQuantity, isWhole, lineStockMoves, listCountries, listProvinces, mapToLegacyStatus, maxPrecisionFor, mergeFragment, modifiersSellable, multiplyAmount, normalizeAddress, normalizeCityKey, normalizeCountry, normalizeMongoIdString, normalizePostCode, normalizeProvince, occupancyIn, orderAssignments, parseAmountToMinorUnits, parseCurrencyCode, parseStripeCurrencyCode, placeKey, planWindow, poolDemand, poolOf, poolShortfall, poolStockAt, postCodeMatchesProvince, presentAt, priceForTotal, provincesForPostCode, removeFragment, resolveFamily, resolveModifiersForProduct, resolveShipping, resolveTemplate, resolveUnit, roundToPrecision, sameFamily, setOrderState, shopDayKey, shopDayRange, signReportForDisplay, slotsForWindow, stringifyMinorUnits, subtractAmounts, toBase, toMinorUnits, validateConfig, validateFragmentCompatibility, validateOrderStatuses, validateShippingZone, violatesFinancialInvariant, windowEndsAt, withinPresence };
1757
+ declare enum ProcessorType {
1758
+ FINAL_PAY = "Terminal",
1759
+ TAP_TO_PAY = "TapToPay",
1760
+ MOTO = "Moto",
1761
+ CLOUD = "Cloud",
1762
+ BLUETOOTH = "Bluetooth",
1763
+ CASH = "Cash",
1764
+ CUSTOM_PAY = "CustomPay",
1765
+ VENDARA = "Vendara",
1766
+ REDEEM = "Redeem",
1767
+ INTEGRATION = "Integration",
1768
+ PAYMENT_LINK = "PaymentLink",
1769
+ EXTERNAL = "External"
1770
+ }
1771
+
1772
+ declare const PAYMENT_CHANNELS: readonly ["inPerson", "online"];
1773
+ type PaymentChannel = (typeof PAYMENT_CHANNELS)[number];
1774
+
1775
+ export { ADYEN_JOB_TITLE_ASSOCIATION_TYPES, ADYEN_LEGAL_ENTITY_STATE_PROVINCE_COUNTRIES, ADYEN_NO_TAX_NUMBER_ABSENT_COUNTRIES, ADYEN_ROLLOUT_COUNTRY_CODES, ADYEN_STORE_STATE_PROVINCE_COUNTRIES, ADYEN_TAX_NUMBER_FORMATS, ADYEN_TAX_NUMBER_MIN_LENGTH, AFFIRM_COUNTRY_CODES, AFFIRM_PRICE_PLANS, type AdyenBnplSettings, type AdyenBnplSkippedStore, type AdyenBnplUpdateResult, type AffirmPricePlan, type Amount, type AssignUserChange, AttributeType, type AvailabilityInput, type AvailabilitySlot, type AvailableTransition, BNPL_METHOD_STATUS, BNPL_SKIP_REASON, type BnplMethodStatus, type BnplSkipReason, type BookingOccupancy, BookingRatePeriod, type BookingResourceInput, BookingResourceKind, BookingResourceStatus, BookingRulesError, type BookingRulesInput, BookingType, type BusyWindow, CONDITION_OPERATORS, COUNTRY_CURRENCIES, CURRENCY_CONFIG, type CartDiscountBucket, type CartFeeBucket, type CashDrawer, type CashRoundingTuple, type CategoryModifierRow, type CategoryRow, CompanyType, type CompositeAvailabilityRows, type CompositeMakeable, type CompositeMakeableRow, type CompositePriceItem, type CompositePricePart, type CompositeReservationOrder, type CompositeShelf, type CompositeStockPart, type Condition, type ConditionGroup, type ConditionOperator, type ConfigUpdatedPayload, type ConfigValidationError, type ConfigValidationResult, type ConfigValidationWarning, type CrossAxisRequires, type CrossAxisRule, type CrossAxisTrigger, CurrencyCode, type CurrencyConfig, type CurrencyRate, CustomTableAvailability, CustomerPlatform, DEFAULT_CONFIG, DEFAULT_CROSS_AXIS_RULES, DEFAULT_DISPLAY_STATE_MAP, DEFAULT_HOLD_MINUTES, DEFAULT_RESOLVED_CONFIG, DEFAULT_UNIT_ID, type DeleteStateConfigFragmentParams, type DeleteStateConfigFragmentResponse, type DiscountsBreakdown, type DiscountsTuple, type DisplayStateResult, type DisplayStateRule, DualWriteStrategy, EUFixedRates, EUROPE, EXPENSE_DEFAULT_CATEGORIES, EXPENSE_NAME_MAX_LENGTH, EXPENSE_PAYMENT_METHOD_PRESETS, type EndOfSessionReport, type ExpenseDefaultCategoryKey, ExtensionCategory, FINANCIAL_INVARIANTS, FULFILLMENT_STATES, type FailedCondition, type FeesBreakdown, FeesCustomBillingStatus, type FeesTuple, type FinancialInvariant, type FragmentParam, type FragmentValidationResult, type FulfillmentState, type FulfillmentStateDefinition, type FulfillmentTransitionPath, type GetAvailableTransitionsParams, type GetAvailableTransitionsResponse, type GetOrderDisplayStateParams, type GetOrderDisplayStateResponse, type GetOrderStateConfigParams, type GetOrderStateConfigResponse, type GetStateConfigFragmentParams, type GetStateConfigFragmentResponse, type GridSlot, HttpMethod, InventoryBaseActionEnum, type InventoryBaseActionType, InventorySpecificActionType, InvoiceStatus, LegacyWriteStrategy, LibraryItemType, MAX_PRECISION, type Measurable, type MeasurementBase, type MeasurementUnit, type MeasurementUnitFamily, MenuProject, type ModifierChoiceRow, type ModifierRow, type ModifiersBreakdown, type ModifiersTuple, NAFixedRates, NORTH_AMERICA, NonRevenueItemType, ORDER_STATE_ACTIONS, ORDER_STATE_EVENTS, ORDER_STATE_TOPIC, type OrderContext, type OrderLikeForAssignedUsers, type OrderLikeForContext, type OrderLikeForInCart, type OrderLikeForLegacyInference, type OrderLineItem, type OrderMutationData, type OrderPaymentMethod, OrderPlatform, type OrderRefund, type OrderReservationForContext, type OrderStateEventPayload, type OrderStateWritable, type OrderStatusDefinition, type OrderStatusValidationError, type OrderWriteStrategy, OtherFixedRates, OwnerType, PATH_MODES, PAYMENT_CHANNELS, PAYMENT_STATES, POS_VALID_INITIAL_STATES, type PathMode, type PaymentChannel, PaymentMethod, PaymentProcessor, type PaymentState, type PaymentStateDefinition, type PaymentTransitionPath, type PlanWindowInput, Platform, type PoolDrawing, PreviewImageMode, PricingLevel, PricingPlanEnum, PricingRegionEnum, ProcessorType, type ProductDiscountBucket, type ProductFeeBucket, ProductSalesChartStep, ProductSalesReportCompare, ProductStatus, ProductType, PublicationAvailability, type PublicationConfig, PublicationStatus, REGION_MAPPING, REPORT_NEGATE_PATHS, ReceiptSendChannel, ReceiptType, type RefundsBreakdown, ReservationStatus, ResidualPaymentMethod, ResidualStatus, type ResolveInputs, type ResolveTemplateResult, type ResourceAvailability, ResourceAvailabilityState, type ResourceInWindow, type ResourcePresenceRow, STATE_SCHEMA, STRIPE_SUPPORTED_COUNTRIES, SYSTEM_FAMILIES, SYSTEM_FAMILY_IDS, SYSTEM_UNITS, SYSTEM_UNIT_IDS, SalesLineAction, SalesLineSourceArray, type SalesSummary, type SaveStateConfigFragmentParams, type SaveStateConfigFragmentResponse, type SettlementBreakdown, type SettlementBuckets, type SettlementCardSection, type SettlementCashSection, type SettlementCustomEntry, type SplitPayment, type SplitPaymentPayment, type StaffSales, type StaffSalesEntry, type StateConfig, type StateConfigFragment, type StateDefinition, type StatePair, type StateSchema, type StateTransitionBlockedPayload, type StateTransitionCompletedPayload, StationStatus, type StoredStateConfig, StripeCurrencyCode, StripeStatus, type TaxBreakdown, type TaxBreakdownRateEntry, type TaxBreakdownSection, type TaxBreakdownSubtotal, type TaxesTuple, TimePeriod, type TipEntry, type TipsBreakdown, type TipsTuple, TopMetericsSort, type TransitionBlockedBy, type TransitionConditionSet, type TransitionOrderStateParams, type TransitionOrderStateResponse, type TransitionPath, type TransitionRequest, type TransitionResult, UserTypes, type WeeklyHours, addAmounts, adyenLegalEntityRequiresStateOrProvince, adyenRequiresJobTitle, adyenStoreRequiresStateOrProvince, adyenSupportsTaxNumberAbsent, adyenTaxNumberFormat, amountToString, ancestorChain, applyAssignment, assertUnitSane, availableIn, baseFor, baseFulfillmentDefinitions, baseOf, basePaymentDefinitions, buildAvailability, buildGrid, buildOrderContext, buildPosPresetConfig, buildResolvedConfig, calculatePercentage, canTransition, cheapestCompositeItem, cheapestCompositePrice, compositeItemCost, compositeItemUnavailable, compositeMakeable, compositeModifierMismatches, compositeReservationMismatches, compositeVariantInStock, conditionSummary, convertFixedFeeToLocalCurrency, createAmount, crossAxisRuleApplies, currentAssignees, deriveDisplayState, deriveFamilyCode, deriveUnitId, displayRuleMatchesPair, divideAmount, evaluateCondition, evaluateConditionSet, extendPrice, extendPriceFor, formatCurrency, formatInUnit, formatMinorUnitsToString, formatQuantity, fromBase, fromMinorUnits, generateMongoID, getAvailableTransitions, getCashAmountDue, getCountriesByRegion, getCurrencyConfig, getCurrentISODate, getFinancialInvariantViolations, getGoodsPortion, getLineSubtotal, getMinorUnitMultiplier, getMinorUnits, getPaymentLegTotal, getPricingRegionFromCountry, getSettlementTotal, getTotalCollected, hasInCartFlag, hasSellableChoice, holdExpiresAt, inferStatesFromLegacyStatus, isAdyenRolloutCountry, isAffirmCountry, isAffirmPricePlan, isChoiceAvailableAtOutlet, isConditionOperator, isFulfillmentState, isInCart, isPaymentState, isSupportedCurrency, isSystemFamilyCode, isValidQuantity, isWhole, mapToLegacyStatus, maxPrecisionFor, mergeFragment, modifiersSellable, multiplyAmount, normalizeMongoIdString, occupancyIn, orderAssignments, parseAmountToMinorUnits, parseCurrencyCode, parseStripeCurrencyCode, planWindow, poolDemand, poolOf, poolShortfall, poolStockAt, presentAt, removeFragment, resolveFamily, resolveModifiersForProduct, resolveTemplate, resolveUnit, roundToPrecision, sameFamily, setOrderState, shopDayKey, shopDayRange, signReportForDisplay, slotsForWindow, stringifyMinorUnits, subtractAmounts, toBase, toMinorUnits, validateConfig, validateFragmentCompatibility, validateOrderStatuses, violatesFinancialInvariant, windowEndsAt, withinPresence };
package/dist/index.d.ts CHANGED
@@ -190,8 +190,7 @@ declare enum Platform {
190
190
  declare enum OrderPlatform {
191
191
  POS = "in-store",
192
192
  WOO_COMMERCE = "woo-commerce",
193
- PUBLIC_API = "public-api",
194
- ONLINE_STORE = "online-store"
193
+ PUBLIC_API = "public-api"
195
194
  }
196
195
  declare enum CustomerPlatform {
197
196
  POS = "in-store",
@@ -453,43 +452,6 @@ declare enum ResourceAvailabilityState {
453
452
  NO_HOURS_IN_RANGE = "noHoursInRange"
454
453
  }
455
454
 
456
- declare enum ShippingZoneKind {
457
- COUNTRY = "country",
458
- PROVINCE = "province",
459
- CITY = "city",
460
- EVERYWHERE = "everywhere"
461
- }
462
- declare enum ShippingOptionType {
463
- SHIP = "ship",
464
- PICKUP = "pickup"
465
- }
466
- declare enum ShippingRateType {
467
- FLAT = "flat"
468
- }
469
- declare enum ShippingChannel {
470
- WEB = "web",
471
- POS = "pos"
472
- }
473
- declare enum ShippingNoOptionReason {
474
- INCOMPLETE = "INCOMPLETE",
475
- ADDRESS_MISMATCH = "ADDRESS_MISMATCH",
476
- NO_COVERAGE = "NO_COVERAGE",
477
- BLOCKED = "BLOCKED",
478
- NO_OPTION = "NO_OPTION"
479
- }
480
- declare enum ShippingZoneError {
481
- NO_PLACES = "NO_PLACES",
482
- INVALID_PLACE = "INVALID_PLACE",
483
- DUPLICATE_PLACE = "DUPLICATE_PLACE",
484
- NO_WEBSITE_OPTION = "NO_WEBSITE_OPTION",
485
- INVALID_PRICE = "INVALID_PRICE",
486
- INVALID_DAYS = "INVALID_DAYS",
487
- INVALID_TIERS = "INVALID_TIERS",
488
- NO_CHANNEL = "NO_CHANNEL",
489
- PICKUP_WITHOUT_STORE = "PICKUP_WITHOUT_STORE",
490
- MISSING_NAME = "MISSING_NAME"
491
- }
492
-
493
455
  declare enum SalesLineAction {
494
456
  SALE = "sale",
495
457
  REFUND = "refund"
@@ -1041,46 +1003,6 @@ declare function compositeModifierMismatches(lineItems: readonly {
1041
1003
  }[]): string[];
1042
1004
  declare function compositeReservationMismatches(order: CompositeReservationOrder): string[];
1043
1005
 
1044
- type IdLike = string | {
1045
- toString(): string;
1046
- };
1047
- interface StockLineComponent {
1048
- productId: IdLike;
1049
- variantId: IdLike;
1050
- quantity: number;
1051
- stockQuantity?: number | null;
1052
- unitId?: IdLike | null;
1053
- stockVariantId?: IdLike | null;
1054
- }
1055
- interface StockLine {
1056
- internalId?: string | null;
1057
- productId?: IdLike | null;
1058
- variantId?: IdLike | null;
1059
- name?: string | null;
1060
- stockQuantity?: number | null;
1061
- unitId?: IdLike | null;
1062
- stockVariantId?: IdLike | null;
1063
- components?: readonly StockLineComponent[] | null;
1064
- }
1065
- interface StockReservationLink {
1066
- lineItemInternalId?: string | null;
1067
- componentIndex?: number | null;
1068
- }
1069
- interface LineStockMove {
1070
- productId: string;
1071
- variantId: string;
1072
- fields: {
1073
- quantity: number;
1074
- stockQuantity?: number;
1075
- unitId?: string;
1076
- stockVariantId?: string;
1077
- compositeProductId?: string;
1078
- compositeName?: string;
1079
- };
1080
- componentIndex?: number;
1081
- }
1082
- declare function lineStockMoves(item: StockLine, quantity: number, reservations?: readonly StockReservationLink[]): LineStockMove[];
1083
-
1084
1006
  declare const SYSTEM_FAMILY_IDS: {
1085
1007
  readonly COUNT: "count";
1086
1008
  readonly WEIGHT: "weight-metric";
@@ -1783,112 +1705,6 @@ declare function planWindow({ rule, timeZone, presence, startAt, endAt, now, bus
1783
1705
  };
1784
1706
  declare const holdExpiresAt: (rule: BookingRulesInput, now: Date) => Date;
1785
1707
 
1786
- interface ShippingPlace {
1787
- country: string;
1788
- province?: string | null;
1789
- city?: string | null;
1790
- }
1791
- interface ShippingPriceTier {
1792
- from: number;
1793
- price: number;
1794
- }
1795
- interface ShippingOptionRule {
1796
- id: string;
1797
- type: ShippingOptionType | `${ShippingOptionType}`;
1798
- rate?: ShippingRateType | `${ShippingRateType}`;
1799
- name?: string | null;
1800
- price: number;
1801
- priceByTotal?: ShippingPriceTier[] | null;
1802
- freeOver?: number | null;
1803
- minDays?: number | null;
1804
- maxDays?: number | null;
1805
- channels: (ShippingChannel | `${ShippingChannel}`)[];
1806
- outletId?: string | null;
1807
- }
1808
- interface ShippingZoneRule {
1809
- id: string;
1810
- kind: ShippingZoneKind | `${ShippingZoneKind}`;
1811
- places: ShippingPlace[];
1812
- ships: boolean;
1813
- message?: string | null;
1814
- options: ShippingOptionRule[];
1815
- }
1816
- interface AddressLike {
1817
- country?: string | null;
1818
- state?: string | null;
1819
- province?: string | null;
1820
- city?: string | null;
1821
- postCode?: string | null;
1822
- postalCode?: string | null;
1823
- zip?: string | null;
1824
- }
1825
- interface NormalizedAddress {
1826
- country?: string;
1827
- province?: string;
1828
- cityKey?: string;
1829
- postCode?: string;
1830
- }
1831
- interface ShippingQuoteOption {
1832
- optionId: string;
1833
- zoneId: string;
1834
- type: ShippingOptionType | `${ShippingOptionType}`;
1835
- name: string | null;
1836
- amount: number;
1837
- amountToFree: number | null;
1838
- minDays: number | null;
1839
- maxDays: number | null;
1840
- outletId: string | null;
1841
- }
1842
- interface ShippingResolution {
1843
- zoneId: string | null;
1844
- options: ShippingQuoteOption[];
1845
- reason: ShippingNoOptionReason | null;
1846
- message: string | null;
1847
- shipsToCountries: string[];
1848
- }
1849
- interface ResolveShippingInput {
1850
- zones: ShippingZoneRule[];
1851
- address: AddressLike | null | undefined;
1852
- itemsTotal: number;
1853
- channel: ShippingChannel | `${ShippingChannel}`;
1854
- }
1855
-
1856
- declare function normalizeCountry(value: string | null | undefined): string | undefined;
1857
- interface CountryOption {
1858
- code: string;
1859
- name: string;
1860
- }
1861
- declare function listCountries(locale?: string): CountryOption[];
1862
-
1863
- interface Province {
1864
- code: string;
1865
- name: string;
1866
- nameFr: string;
1867
- postalLetters: string[];
1868
- aliases?: string[];
1869
- }
1870
- declare const CANADA_PROVINCES: readonly Province[];
1871
- declare function normalizeProvince(country: string | undefined, value: string | null | undefined): string | undefined;
1872
- declare function listProvinces(country: string): readonly Province[];
1873
- declare function provincesForPostCode(country: string | undefined, postCode: string | undefined): string[];
1874
-
1875
- declare const EVERYWHERE_KEY = "*";
1876
- declare function normalizeCityKey(value: string | null | undefined): string | undefined;
1877
- declare function normalizePostCode(value: string | null | undefined): string | undefined;
1878
- declare function normalizeAddress(address: AddressLike | null | undefined): NormalizedAddress;
1879
- declare function postCodeMatchesProvince(address: NormalizedAddress): boolean;
1880
- declare function placeKey(place: ShippingPlace): string | undefined;
1881
- declare function addressPlaceKeys(address: NormalizedAddress): string[];
1882
-
1883
- declare function resolveShipping({ zones, address, itemsTotal, channel }: ResolveShippingInput): ShippingResolution;
1884
- declare function priceForTotal(option: ShippingOptionRule, itemsTotal: number): number;
1885
-
1886
- interface ShippingZoneProblem {
1887
- code: ShippingZoneError;
1888
- optionId?: string;
1889
- }
1890
- declare function validateShippingZone(zone: ShippingZoneRule): ShippingZoneProblem[];
1891
-
1892
1708
  interface CurrencyRate {
1893
1709
  rate: number;
1894
1710
  country: string;
@@ -1900,25 +1716,6 @@ declare const EUFixedRates: Record<string, CurrencyRate>;
1900
1716
  declare const OtherFixedRates: Record<string, CurrencyRate>;
1901
1717
  declare const COUNTRY_CURRENCIES: Record<string, string>;
1902
1718
 
1903
- declare enum ProcessorType {
1904
- FINAL_PAY = "Terminal",
1905
- TAP_TO_PAY = "TapToPay",
1906
- MOTO = "Moto",
1907
- CLOUD = "Cloud",
1908
- BLUETOOTH = "Bluetooth",
1909
- CASH = "Cash",
1910
- CUSTOM_PAY = "CustomPay",
1911
- VENDARA = "Vendara",
1912
- REDEEM = "Redeem",
1913
- INTEGRATION = "Integration",
1914
- PAYMENT_LINK = "PaymentLink",
1915
- ONLINE_PAYMENT = "OnlinePayment",
1916
- EXTERNAL = "External"
1917
- }
1918
-
1919
- declare const PAYMENT_CHANNELS: readonly ["inPerson", "online"];
1920
- type PaymentChannel = (typeof PAYMENT_CHANNELS)[number];
1921
-
1922
1719
  declare const EXPENSE_PAYMENT_METHOD_PRESETS: readonly ["Cash", "Cheque", "Credit card", "Direct debit", "E-Transfer", "Wire transfer"];
1923
1720
  declare const EXPENSE_NAME_MAX_LENGTH = 40;
1924
1721
  declare const EXPENSE_DEFAULT_CATEGORIES: readonly [{
@@ -1957,4 +1754,22 @@ declare const EXPENSE_DEFAULT_CATEGORIES: readonly [{
1957
1754
  }];
1958
1755
  type ExpenseDefaultCategoryKey = (typeof EXPENSE_DEFAULT_CATEGORIES)[number]['key'];
1959
1756
 
1960
- export { ADYEN_JOB_TITLE_ASSOCIATION_TYPES, ADYEN_LEGAL_ENTITY_STATE_PROVINCE_COUNTRIES, ADYEN_NO_TAX_NUMBER_ABSENT_COUNTRIES, ADYEN_ROLLOUT_COUNTRY_CODES, ADYEN_STORE_STATE_PROVINCE_COUNTRIES, ADYEN_TAX_NUMBER_FORMATS, ADYEN_TAX_NUMBER_MIN_LENGTH, AFFIRM_COUNTRY_CODES, AFFIRM_PRICE_PLANS, type AddressLike, type AdyenBnplSettings, type AdyenBnplSkippedStore, type AdyenBnplUpdateResult, type AffirmPricePlan, type Amount, type AssignUserChange, AttributeType, type AvailabilityInput, type AvailabilitySlot, type AvailableTransition, BNPL_METHOD_STATUS, BNPL_SKIP_REASON, type BnplMethodStatus, type BnplSkipReason, type BookingOccupancy, BookingRatePeriod, type BookingResourceInput, BookingResourceKind, BookingResourceStatus, BookingRulesError, type BookingRulesInput, BookingType, type BusyWindow, CANADA_PROVINCES, CONDITION_OPERATORS, COUNTRY_CURRENCIES, CURRENCY_CONFIG, type CartDiscountBucket, type CartFeeBucket, type CashDrawer, type CashRoundingTuple, type CategoryModifierRow, type CategoryRow, CompanyType, type CompositeAvailabilityRows, type CompositeMakeable, type CompositeMakeableRow, type CompositePriceItem, type CompositePricePart, type CompositeReservationOrder, type CompositeShelf, type CompositeStockPart, type Condition, type ConditionGroup, type ConditionOperator, type ConfigUpdatedPayload, type ConfigValidationError, type ConfigValidationResult, type ConfigValidationWarning, type CountryOption, type CrossAxisRequires, type CrossAxisRule, type CrossAxisTrigger, CurrencyCode, type CurrencyConfig, type CurrencyRate, CustomTableAvailability, CustomerPlatform, DEFAULT_CONFIG, DEFAULT_CROSS_AXIS_RULES, DEFAULT_DISPLAY_STATE_MAP, DEFAULT_HOLD_MINUTES, DEFAULT_RESOLVED_CONFIG, DEFAULT_UNIT_ID, type DeleteStateConfigFragmentParams, type DeleteStateConfigFragmentResponse, type DiscountsBreakdown, type DiscountsTuple, type DisplayStateResult, type DisplayStateRule, DualWriteStrategy, EUFixedRates, EUROPE, EVERYWHERE_KEY, EXPENSE_DEFAULT_CATEGORIES, EXPENSE_NAME_MAX_LENGTH, EXPENSE_PAYMENT_METHOD_PRESETS, type EndOfSessionReport, type ExpenseDefaultCategoryKey, ExtensionCategory, FINANCIAL_INVARIANTS, FULFILLMENT_STATES, type FailedCondition, type FeesBreakdown, FeesCustomBillingStatus, type FeesTuple, type FinancialInvariant, type FragmentParam, type FragmentValidationResult, type FulfillmentState, type FulfillmentStateDefinition, type FulfillmentTransitionPath, type GetAvailableTransitionsParams, type GetAvailableTransitionsResponse, type GetOrderDisplayStateParams, type GetOrderDisplayStateResponse, type GetOrderStateConfigParams, type GetOrderStateConfigResponse, type GetStateConfigFragmentParams, type GetStateConfigFragmentResponse, type GridSlot, HttpMethod, InventoryBaseActionEnum, type InventoryBaseActionType, InventorySpecificActionType, InvoiceStatus, LegacyWriteStrategy, LibraryItemType, type LineStockMove, MAX_PRECISION, type Measurable, type MeasurementBase, type MeasurementUnit, type MeasurementUnitFamily, MenuProject, type ModifierChoiceRow, type ModifierRow, type ModifiersBreakdown, type ModifiersTuple, NAFixedRates, NORTH_AMERICA, NonRevenueItemType, type NormalizedAddress, ORDER_STATE_ACTIONS, ORDER_STATE_EVENTS, ORDER_STATE_TOPIC, type OrderContext, type OrderLikeForAssignedUsers, type OrderLikeForContext, type OrderLikeForInCart, type OrderLikeForLegacyInference, type OrderLineItem, type OrderMutationData, type OrderPaymentMethod, OrderPlatform, type OrderRefund, type OrderReservationForContext, type OrderStateEventPayload, type OrderStateWritable, type OrderStatusDefinition, type OrderStatusValidationError, type OrderWriteStrategy, OtherFixedRates, OwnerType, PATH_MODES, PAYMENT_CHANNELS, PAYMENT_STATES, POS_VALID_INITIAL_STATES, type PathMode, type PaymentChannel, PaymentMethod, PaymentProcessor, type PaymentState, type PaymentStateDefinition, type PaymentTransitionPath, type PlanWindowInput, Platform, type PoolDrawing, PreviewImageMode, PricingLevel, PricingPlanEnum, PricingRegionEnum, ProcessorType, type ProductDiscountBucket, type ProductFeeBucket, ProductSalesChartStep, ProductSalesReportCompare, ProductStatus, ProductType, type Province, PublicationAvailability, type PublicationConfig, PublicationStatus, REGION_MAPPING, REPORT_NEGATE_PATHS, ReceiptSendChannel, ReceiptType, type RefundsBreakdown, ReservationStatus, ResidualPaymentMethod, ResidualStatus, type ResolveInputs, type ResolveShippingInput, type ResolveTemplateResult, type ResourceAvailability, ResourceAvailabilityState, type ResourceInWindow, type ResourcePresenceRow, STATE_SCHEMA, STRIPE_SUPPORTED_COUNTRIES, SYSTEM_FAMILIES, SYSTEM_FAMILY_IDS, SYSTEM_UNITS, SYSTEM_UNIT_IDS, SalesLineAction, SalesLineSourceArray, type SalesSummary, type SaveStateConfigFragmentParams, type SaveStateConfigFragmentResponse, type SettlementBreakdown, type SettlementBuckets, type SettlementCardSection, type SettlementCashSection, type SettlementCustomEntry, ShippingChannel, ShippingNoOptionReason, type ShippingOptionRule, ShippingOptionType, type ShippingPlace, type ShippingPriceTier, type ShippingQuoteOption, ShippingRateType, type ShippingResolution, ShippingZoneError, ShippingZoneKind, type ShippingZoneProblem, type ShippingZoneRule, type SplitPayment, type SplitPaymentPayment, type StaffSales, type StaffSalesEntry, type StateConfig, type StateConfigFragment, type StateDefinition, type StatePair, type StateSchema, type StateTransitionBlockedPayload, type StateTransitionCompletedPayload, StationStatus, type StockLine, type StockLineComponent, type StockReservationLink, type StoredStateConfig, StripeCurrencyCode, StripeStatus, type TaxBreakdown, type TaxBreakdownRateEntry, type TaxBreakdownSection, type TaxBreakdownSubtotal, type TaxesTuple, TimePeriod, type TipEntry, type TipsBreakdown, type TipsTuple, TopMetericsSort, type TransitionBlockedBy, type TransitionConditionSet, type TransitionOrderStateParams, type TransitionOrderStateResponse, type TransitionPath, type TransitionRequest, type TransitionResult, UserTypes, type WeeklyHours, addAmounts, addressPlaceKeys, adyenLegalEntityRequiresStateOrProvince, adyenRequiresJobTitle, adyenStoreRequiresStateOrProvince, adyenSupportsTaxNumberAbsent, adyenTaxNumberFormat, amountToString, ancestorChain, applyAssignment, assertUnitSane, availableIn, baseFor, baseFulfillmentDefinitions, baseOf, basePaymentDefinitions, buildAvailability, buildGrid, buildOrderContext, buildPosPresetConfig, buildResolvedConfig, calculatePercentage, canTransition, cheapestCompositeItem, cheapestCompositePrice, compositeItemCost, compositeItemUnavailable, compositeMakeable, compositeModifierMismatches, compositeReservationMismatches, compositeVariantInStock, conditionSummary, convertFixedFeeToLocalCurrency, createAmount, crossAxisRuleApplies, currentAssignees, deriveDisplayState, deriveFamilyCode, deriveUnitId, displayRuleMatchesPair, divideAmount, evaluateCondition, evaluateConditionSet, extendPrice, extendPriceFor, formatCurrency, formatInUnit, formatMinorUnitsToString, formatQuantity, fromBase, fromMinorUnits, generateMongoID, getAvailableTransitions, getCashAmountDue, getCountriesByRegion, getCurrencyConfig, getCurrentISODate, getFinancialInvariantViolations, getGoodsPortion, getLineSubtotal, getMinorUnitMultiplier, getMinorUnits, getPaymentLegTotal, getPricingRegionFromCountry, getSettlementTotal, getTotalCollected, hasInCartFlag, hasSellableChoice, holdExpiresAt, inferStatesFromLegacyStatus, isAdyenRolloutCountry, isAffirmCountry, isAffirmPricePlan, isChoiceAvailableAtOutlet, isConditionOperator, isFulfillmentState, isInCart, isPaymentState, isSupportedCurrency, isSystemFamilyCode, isValidQuantity, isWhole, lineStockMoves, listCountries, listProvinces, mapToLegacyStatus, maxPrecisionFor, mergeFragment, modifiersSellable, multiplyAmount, normalizeAddress, normalizeCityKey, normalizeCountry, normalizeMongoIdString, normalizePostCode, normalizeProvince, occupancyIn, orderAssignments, parseAmountToMinorUnits, parseCurrencyCode, parseStripeCurrencyCode, placeKey, planWindow, poolDemand, poolOf, poolShortfall, poolStockAt, postCodeMatchesProvince, presentAt, priceForTotal, provincesForPostCode, removeFragment, resolveFamily, resolveModifiersForProduct, resolveShipping, resolveTemplate, resolveUnit, roundToPrecision, sameFamily, setOrderState, shopDayKey, shopDayRange, signReportForDisplay, slotsForWindow, stringifyMinorUnits, subtractAmounts, toBase, toMinorUnits, validateConfig, validateFragmentCompatibility, validateOrderStatuses, validateShippingZone, violatesFinancialInvariant, windowEndsAt, withinPresence };
1757
+ declare enum ProcessorType {
1758
+ FINAL_PAY = "Terminal",
1759
+ TAP_TO_PAY = "TapToPay",
1760
+ MOTO = "Moto",
1761
+ CLOUD = "Cloud",
1762
+ BLUETOOTH = "Bluetooth",
1763
+ CASH = "Cash",
1764
+ CUSTOM_PAY = "CustomPay",
1765
+ VENDARA = "Vendara",
1766
+ REDEEM = "Redeem",
1767
+ INTEGRATION = "Integration",
1768
+ PAYMENT_LINK = "PaymentLink",
1769
+ EXTERNAL = "External"
1770
+ }
1771
+
1772
+ declare const PAYMENT_CHANNELS: readonly ["inPerson", "online"];
1773
+ type PaymentChannel = (typeof PAYMENT_CHANNELS)[number];
1774
+
1775
+ export { ADYEN_JOB_TITLE_ASSOCIATION_TYPES, ADYEN_LEGAL_ENTITY_STATE_PROVINCE_COUNTRIES, ADYEN_NO_TAX_NUMBER_ABSENT_COUNTRIES, ADYEN_ROLLOUT_COUNTRY_CODES, ADYEN_STORE_STATE_PROVINCE_COUNTRIES, ADYEN_TAX_NUMBER_FORMATS, ADYEN_TAX_NUMBER_MIN_LENGTH, AFFIRM_COUNTRY_CODES, AFFIRM_PRICE_PLANS, type AdyenBnplSettings, type AdyenBnplSkippedStore, type AdyenBnplUpdateResult, type AffirmPricePlan, type Amount, type AssignUserChange, AttributeType, type AvailabilityInput, type AvailabilitySlot, type AvailableTransition, BNPL_METHOD_STATUS, BNPL_SKIP_REASON, type BnplMethodStatus, type BnplSkipReason, type BookingOccupancy, BookingRatePeriod, type BookingResourceInput, BookingResourceKind, BookingResourceStatus, BookingRulesError, type BookingRulesInput, BookingType, type BusyWindow, CONDITION_OPERATORS, COUNTRY_CURRENCIES, CURRENCY_CONFIG, type CartDiscountBucket, type CartFeeBucket, type CashDrawer, type CashRoundingTuple, type CategoryModifierRow, type CategoryRow, CompanyType, type CompositeAvailabilityRows, type CompositeMakeable, type CompositeMakeableRow, type CompositePriceItem, type CompositePricePart, type CompositeReservationOrder, type CompositeShelf, type CompositeStockPart, type Condition, type ConditionGroup, type ConditionOperator, type ConfigUpdatedPayload, type ConfigValidationError, type ConfigValidationResult, type ConfigValidationWarning, type CrossAxisRequires, type CrossAxisRule, type CrossAxisTrigger, CurrencyCode, type CurrencyConfig, type CurrencyRate, CustomTableAvailability, CustomerPlatform, DEFAULT_CONFIG, DEFAULT_CROSS_AXIS_RULES, DEFAULT_DISPLAY_STATE_MAP, DEFAULT_HOLD_MINUTES, DEFAULT_RESOLVED_CONFIG, DEFAULT_UNIT_ID, type DeleteStateConfigFragmentParams, type DeleteStateConfigFragmentResponse, type DiscountsBreakdown, type DiscountsTuple, type DisplayStateResult, type DisplayStateRule, DualWriteStrategy, EUFixedRates, EUROPE, EXPENSE_DEFAULT_CATEGORIES, EXPENSE_NAME_MAX_LENGTH, EXPENSE_PAYMENT_METHOD_PRESETS, type EndOfSessionReport, type ExpenseDefaultCategoryKey, ExtensionCategory, FINANCIAL_INVARIANTS, FULFILLMENT_STATES, type FailedCondition, type FeesBreakdown, FeesCustomBillingStatus, type FeesTuple, type FinancialInvariant, type FragmentParam, type FragmentValidationResult, type FulfillmentState, type FulfillmentStateDefinition, type FulfillmentTransitionPath, type GetAvailableTransitionsParams, type GetAvailableTransitionsResponse, type GetOrderDisplayStateParams, type GetOrderDisplayStateResponse, type GetOrderStateConfigParams, type GetOrderStateConfigResponse, type GetStateConfigFragmentParams, type GetStateConfigFragmentResponse, type GridSlot, HttpMethod, InventoryBaseActionEnum, type InventoryBaseActionType, InventorySpecificActionType, InvoiceStatus, LegacyWriteStrategy, LibraryItemType, MAX_PRECISION, type Measurable, type MeasurementBase, type MeasurementUnit, type MeasurementUnitFamily, MenuProject, type ModifierChoiceRow, type ModifierRow, type ModifiersBreakdown, type ModifiersTuple, NAFixedRates, NORTH_AMERICA, NonRevenueItemType, ORDER_STATE_ACTIONS, ORDER_STATE_EVENTS, ORDER_STATE_TOPIC, type OrderContext, type OrderLikeForAssignedUsers, type OrderLikeForContext, type OrderLikeForInCart, type OrderLikeForLegacyInference, type OrderLineItem, type OrderMutationData, type OrderPaymentMethod, OrderPlatform, type OrderRefund, type OrderReservationForContext, type OrderStateEventPayload, type OrderStateWritable, type OrderStatusDefinition, type OrderStatusValidationError, type OrderWriteStrategy, OtherFixedRates, OwnerType, PATH_MODES, PAYMENT_CHANNELS, PAYMENT_STATES, POS_VALID_INITIAL_STATES, type PathMode, type PaymentChannel, PaymentMethod, PaymentProcessor, type PaymentState, type PaymentStateDefinition, type PaymentTransitionPath, type PlanWindowInput, Platform, type PoolDrawing, PreviewImageMode, PricingLevel, PricingPlanEnum, PricingRegionEnum, ProcessorType, type ProductDiscountBucket, type ProductFeeBucket, ProductSalesChartStep, ProductSalesReportCompare, ProductStatus, ProductType, PublicationAvailability, type PublicationConfig, PublicationStatus, REGION_MAPPING, REPORT_NEGATE_PATHS, ReceiptSendChannel, ReceiptType, type RefundsBreakdown, ReservationStatus, ResidualPaymentMethod, ResidualStatus, type ResolveInputs, type ResolveTemplateResult, type ResourceAvailability, ResourceAvailabilityState, type ResourceInWindow, type ResourcePresenceRow, STATE_SCHEMA, STRIPE_SUPPORTED_COUNTRIES, SYSTEM_FAMILIES, SYSTEM_FAMILY_IDS, SYSTEM_UNITS, SYSTEM_UNIT_IDS, SalesLineAction, SalesLineSourceArray, type SalesSummary, type SaveStateConfigFragmentParams, type SaveStateConfigFragmentResponse, type SettlementBreakdown, type SettlementBuckets, type SettlementCardSection, type SettlementCashSection, type SettlementCustomEntry, type SplitPayment, type SplitPaymentPayment, type StaffSales, type StaffSalesEntry, type StateConfig, type StateConfigFragment, type StateDefinition, type StatePair, type StateSchema, type StateTransitionBlockedPayload, type StateTransitionCompletedPayload, StationStatus, type StoredStateConfig, StripeCurrencyCode, StripeStatus, type TaxBreakdown, type TaxBreakdownRateEntry, type TaxBreakdownSection, type TaxBreakdownSubtotal, type TaxesTuple, TimePeriod, type TipEntry, type TipsBreakdown, type TipsTuple, TopMetericsSort, type TransitionBlockedBy, type TransitionConditionSet, type TransitionOrderStateParams, type TransitionOrderStateResponse, type TransitionPath, type TransitionRequest, type TransitionResult, UserTypes, type WeeklyHours, addAmounts, adyenLegalEntityRequiresStateOrProvince, adyenRequiresJobTitle, adyenStoreRequiresStateOrProvince, adyenSupportsTaxNumberAbsent, adyenTaxNumberFormat, amountToString, ancestorChain, applyAssignment, assertUnitSane, availableIn, baseFor, baseFulfillmentDefinitions, baseOf, basePaymentDefinitions, buildAvailability, buildGrid, buildOrderContext, buildPosPresetConfig, buildResolvedConfig, calculatePercentage, canTransition, cheapestCompositeItem, cheapestCompositePrice, compositeItemCost, compositeItemUnavailable, compositeMakeable, compositeModifierMismatches, compositeReservationMismatches, compositeVariantInStock, conditionSummary, convertFixedFeeToLocalCurrency, createAmount, crossAxisRuleApplies, currentAssignees, deriveDisplayState, deriveFamilyCode, deriveUnitId, displayRuleMatchesPair, divideAmount, evaluateCondition, evaluateConditionSet, extendPrice, extendPriceFor, formatCurrency, formatInUnit, formatMinorUnitsToString, formatQuantity, fromBase, fromMinorUnits, generateMongoID, getAvailableTransitions, getCashAmountDue, getCountriesByRegion, getCurrencyConfig, getCurrentISODate, getFinancialInvariantViolations, getGoodsPortion, getLineSubtotal, getMinorUnitMultiplier, getMinorUnits, getPaymentLegTotal, getPricingRegionFromCountry, getSettlementTotal, getTotalCollected, hasInCartFlag, hasSellableChoice, holdExpiresAt, inferStatesFromLegacyStatus, isAdyenRolloutCountry, isAffirmCountry, isAffirmPricePlan, isChoiceAvailableAtOutlet, isConditionOperator, isFulfillmentState, isInCart, isPaymentState, isSupportedCurrency, isSystemFamilyCode, isValidQuantity, isWhole, mapToLegacyStatus, maxPrecisionFor, mergeFragment, modifiersSellable, multiplyAmount, normalizeMongoIdString, occupancyIn, orderAssignments, parseAmountToMinorUnits, parseCurrencyCode, parseStripeCurrencyCode, planWindow, poolDemand, poolOf, poolShortfall, poolStockAt, presentAt, removeFragment, resolveFamily, resolveModifiersForProduct, resolveTemplate, resolveUnit, roundToPrecision, sameFamily, setOrderState, shopDayKey, shopDayRange, signReportForDisplay, slotsForWindow, stringifyMinorUnits, subtractAmounts, toBase, toMinorUnits, validateConfig, validateFragmentCompatibility, validateOrderStatuses, violatesFinancialInvariant, windowEndsAt, withinPresence };