@fire-spark/types 0.8.3 → 0.9.0

package/dist/index.d.ts

@@ -912,6 +912,15 @@ type OrderFulfillment = {
     status?: string | undefined;
     message: string;
   } | null;
+  device_reversal: {
+    pending: {
+      tender_id: string;
+      payment_id: string;
+      attempt_reference: string;
+      amount: number;
+      currency: string;
+    }[];
+  } | null;
   customer_id: string;
   payment_status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
   fulfillment_status: string;
@@ -1617,6 +1626,21 @@ interface OrderChangedError {
   status?: string;
   message: string;
 }
+/** A tender the charging device must void (CliSiTef pinpad and the like). */
+interface OrderChangedDeviceReversalTender {
+  tender_id: string;
+  payment_id: string;
+  attempt_reference: string;
+  amount: number;
+  currency: string;
+}
+/**
+ * Tenders the device must still void after a failed checkout; `pending`
+ * empties once the server recorded every void.
+ */
+interface OrderChangedDeviceReversal {
+  pending: OrderChangedDeviceReversalTender[];
+}
 /** Broadcast payload for `order.changed` (and snapshot mapped to this shape). */
 interface OrderChangedPayload {
   order_id: string;
@@ -1630,6 +1654,8 @@ interface OrderChangedPayload {
   entered_node_ids: string[];
   callbacks: OrderChangedCallback[];
   error: OrderChangedError | null;
+  /** `null` unless checkout failed; absent from servers that predate it. */
+  device_reversal?: OrderChangedDeviceReversal | null;
   emitted_at: string;
 }
 //#endregion
@@ -2198,7 +2224,7 @@ type Order = {
   metadata: Record<string, unknown>;
   payment_status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
   fulfillment_status: string;
-  status: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSED" | "VOIDED";
+  status: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSAL_PENDING" | "REVERSED" | "VOIDED";
   issued_at?: string | null | undefined;
   resolved_at?: string | null | undefined;
   device_id?: string | null | undefined;
@@ -3160,14 +3186,14 @@ type OrderListInput = {
   channel_id?: string | undefined;
   fulfillment_id?: string | undefined;
   brand_id?: string | undefined;
-  status?: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSED" | "VOIDED" | undefined;
+  status?: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSAL_PENDING" | "REVERSED" | "VOIDED" | undefined;
   cursor?: string | undefined;
 };
 /** `POST .../devices/me/orders` body (kiosk or POS). */
 type OrderDeviceListInput = {
   device_uid: string;
   device_secret: string;
-  status?: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSED" | "VOIDED" | undefined;
+  status?: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSAL_PENDING" | "REVERSED" | "VOIDED" | undefined;
   payment_status?: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED" | undefined;
   from?: string | undefined;
   to?: string | undefined;
@@ -3451,7 +3477,7 @@ type OrderDeviceListResult = {
     metadata: Record<string, unknown>;
     payment_status: "CANCELLED" | "FAILED" | "IDLE" | "PAID" | "PENDING" | "REFUNDED";
     fulfillment_status: string;
-    status: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSED" | "VOIDED";
+    status: "CANCELLED" | "CLOSED" | "COMPLETED" | "OPEN" | "REFUNDED" | "REVERSAL_PENDING" | "REVERSED" | "VOIDED";
     issued_at?: string | null | undefined;
     resolved_at?: string | null | undefined;
     device_id?: string | null | undefined;
@@ -4448,4 +4474,4 @@ interface CheckoutResolved {
   billingFields: Record<string, CheckoutMode>;
 }
 //#endregion
-export type { AddressInfo, AndConditions, BillingInfo, BillingProfile, BundledItem, Category, CategoryAvailability, CategoryItem, ChannelManifest, ChannelManifestNative, ChannelManifestWeb, ChannelPlatform, ChannelTemplate, CheckoutMode, CheckoutResolved, CmsBlock, CmsBlockItem, Condition, Customer, CustomerGender, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, DayOfWeek, DeliveryAddress, Fulfillment, FulfillmentListInput, GroupDisplayType, KioskAdminGesture, KioskAppState, KioskCommandPayload, KioskCommandType, KioskConfigChangedPayload, KioskDeviceConfig, KioskDeviceConfigDevice, KioskDeviceConfigPayment, KioskDeviceConfigScope, KioskDeviceConfigSettings, KioskDeviceOverrides, KioskDevicePaymentSettings, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, MixedPaymentsEffect, MixedPaymentsLimits, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderDeviceCredential, OrderDeviceKind, OrderDeviceListInput, OrderDeviceListResult, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentCollectAt, PaymentErrorCode, PaymentIntent, PaymentIntentInput, PaymentIntentPutInput, PaymentIntentStatus, PaymentMethod, PaymentProvider, PaymentScope, PaymentStatus, PaymentTender, PaymentTenderInput, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosFloor, PosFloorChangedPayload, PosFloorElement, PosFloorInput, PosFloorLayout, PosFloorOccupancy, PosFloorPlan, PosFloorRealtimeToken, PosFloorTable, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosReservationHold, PosReservationHoldStatus, PosStaff, PosTableAttachOrderInput, PosTableCloseInput, PosTableJoinInput, PosTableSeatInput, PosTableSeatReservationInput, PosTableSession, PosTableSessionOrder, PosTableSessionStatus, PosTableSplitInput, PricingModifier, PricingVariant, Product, ProductAvailability, ProductPricing, ProductRecommendationLink, Recommendation, RecurringDateCronExpression, RecurringDateCronRepeat, RecurringDateCronResult, RecurringDateCronValues, RuleInterpretation, RulesEngineMonitoring, RulesEngineOrder, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, Schedule, ScheduleDay, SchedulePeriod, SdkLogContext, SdkLogEntry, SdkLogErrorInfo, SdkLogIngestResult, SdkLogLevel, SdkLogOptions, Store, StoreAvailabilityFilters, StoreGetInput, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityInput, StorefrontAvailabilityRule, StorefrontCmsChangedPayload, StorefrontMenu, StorefrontMenuChangedPayload, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput, StorefrontPreferences, StorefrontPreferencesInput, StorefrontRealtimeToken, StorefrontRealtimeTokenInput, StorefrontWorkspaceChangedPayload, StringMatchCaseOptions, TenderAllocation, TenderAllocationInput, TenderAmount, TenderDetails, TenderRefundInput, TenderReplaceInput, TenderVoidInput, Variant, VariantGroup };
+export type { AddressInfo, AndConditions, BillingInfo, BillingProfile, BundledItem, Category, CategoryAvailability, CategoryItem, ChannelManifest, ChannelManifestNative, ChannelManifestWeb, ChannelPlatform, ChannelTemplate, CheckoutMode, CheckoutResolved, CmsBlock, CmsBlockItem, Condition, Customer, CustomerGender, CustomerIdentifyInput, CustomerRegisterInput, CustomerUpdateInput, DayOfWeek, DeliveryAddress, Fulfillment, FulfillmentListInput, GroupDisplayType, KioskAdminGesture, KioskAppState, KioskCommandPayload, KioskCommandType, KioskConfigChangedPayload, KioskDeviceConfig, KioskDeviceConfigDevice, KioskDeviceConfigPayment, KioskDeviceConfigScope, KioskDeviceConfigSettings, KioskDeviceOverrides, KioskDevicePaymentSettings, KioskHealthBatchInput, KioskHealthBatchResult, KioskHealthSample, KioskHeartbeatHealth, KioskHeartbeatInput, KioskHeartbeatResult, KioskOrderPager, KioskPagerSide, KioskPagersOverrides, KioskPagersSettings, KioskRealtimeToken, MatchResult, MatchableRule, Menu, MenuLookup, MerchantPayment, Metadata, MixedPaymentsEffect, MixedPaymentsLimits, ModifierControlType, ModifierGroup, MultiLanguageText, OrConditions, Order, OrderChangedCallback, OrderChangedCallbackError, OrderChangedCheckoutState, OrderChangedDeviceReversal, OrderChangedDeviceReversalTender, OrderChangedError, OrderChangedPayload, OrderChangedRunStatus, OrderDeviceCredential, OrderDeviceKind, OrderDeviceListInput, OrderDeviceListResult, OrderFulfillment, OrderInsertInput, OrderLine, OrderListInput, OrderRecordPaymentInput, OrderRedeem, OrderRedeemInput, OrderRedemptionState, OrderRedemptionStep, OrderReorderInput, OrderTotals, OrderUpdateInput, OrderValidateInput, OrderValidateOutput, Payment, PaymentCollectAt, PaymentErrorCode, PaymentIntent, PaymentIntentInput, PaymentIntentPutInput, PaymentIntentStatus, PaymentMethod, PaymentProvider, PaymentScope, PaymentStatus, PaymentTender, PaymentTenderInput, PlaceOrderResult, PosActorKind, PosCashBreakdownItem, PosCatalog, PosDenominationKind, PosDeviceConfigDevice, PosDeviceConfigScope, PosDeviceOverrides, PosErrorCode, PosFloor, PosFloorChangedPayload, PosFloorElement, PosFloorInput, PosFloorLayout, PosFloorOccupancy, PosFloorPlan, PosFloorRealtimeToken, PosFloorTable, PosHealthBatchInput, PosHealthBatchResult, PosHealthSample, PosHeartbeatHealth, PosHeartbeatInput, PosHeartbeatResult, PosKioskOrder, PosKioskSettleInput, PosKioskSettleResult, PosOrderInput, PosOrderResult, PosReservationHold, PosReservationHoldStatus, PosStaff, PosTableAttachOrderInput, PosTableCloseInput, PosTableJoinInput, PosTableSeatInput, PosTableSeatReservationInput, PosTableSession, PosTableSessionOrder, PosTableSessionStatus, PosTableSplitInput, PricingModifier, PricingVariant, Product, ProductAvailability, ProductPricing, ProductRecommendationLink, Recommendation, RecurringDateCronExpression, RecurringDateCronRepeat, RecurringDateCronResult, RecurringDateCronValues, RuleInterpretation, RulesEngineMonitoring, RulesEngineOrder, RulesEngineOrderLine, RulesEngineParams, RulesEngineRuntime, Schedule, ScheduleDay, SchedulePeriod, SdkLogContext, SdkLogEntry, SdkLogErrorInfo, SdkLogIngestResult, SdkLogLevel, SdkLogOptions, Store, StoreAvailabilityFilters, StoreGetInput, StoreListInput, StoreNearbyInput, StorefrontAvailability, StorefrontAvailabilityChangedPayload, StorefrontAvailabilityInput, StorefrontAvailabilityRule, StorefrontCmsChangedPayload, StorefrontMenu, StorefrontMenuChangedPayload, StorefrontMenuScope, StorefrontMenuStreamOptions, StorefrontPaymentsListInput, StorefrontPreferences, StorefrontPreferencesInput, StorefrontRealtimeToken, StorefrontRealtimeTokenInput, StorefrontWorkspaceChangedPayload, StringMatchCaseOptions, TenderAllocation, TenderAllocationInput, TenderAmount, TenderDetails, TenderRefundInput, TenderReplaceInput, TenderVoidInput, Variant, VariantGroup };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/types",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "Fire Spark public TypeScript types",
   "type": "module",
   "sideEffects": false,