@final-commerce/common 2.10.0 → 2.11.1-online.1

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.
@@ -38,247 +38,6 @@ interface VariantInventory {
38
38
  outletId: string;
39
39
  }
40
40
 
41
- interface OrderTax {
42
- name: string;
43
- taxTableId?: string;
44
- taxTableName?: string;
45
- id?: string;
46
- percentage: number;
47
- amount: number;
48
- taxableAmount?: number;
49
- compounding?: boolean;
50
- priority?: number;
51
- }
52
-
53
- interface OrderTip {
54
- percentage?: number;
55
- amount?: number;
56
- tipTo?: string;
57
- }
58
-
59
- interface OrderSummaryPayments {
60
- cardTotal: number;
61
- cashTotal: number;
62
- customTotal: number;
63
- cardProcessingFeesTotal: number;
64
- }
65
- interface OrderSummary {
66
- discountTotal: number;
67
- shippingTotal?: number;
68
- total: number;
69
- totalTaxes: number;
70
- isTaxInclusive: boolean;
71
- subtotalAfterFees: number;
72
- nonRevenueTotal?: number;
73
- grossSales?: number;
74
- lineDiscountTotal?: number;
75
- cartDiscountTotal?: number;
76
- feesTotal?: number;
77
- lineFeesTotal?: number;
78
- cartFeesTotal?: number;
79
- taxableFeesTotal?: number;
80
- nonTaxableFeesTotal?: number;
81
- modifiersTotal?: number;
82
- taxableModifiersTotal?: number;
83
- nonTaxableModifiersTotal?: number;
84
- totalTaxableSales?: number;
85
- totalNonTaxableSales?: number;
86
- tipTotal?: number;
87
- cashRounding: number;
88
- payments?: OrderSummaryPayments;
89
- totalBeforeTip?: number;
90
- amountPaid?: number;
91
- taxes: OrderTax[];
92
- tip?: OrderTip;
93
- }
94
-
95
- interface PriceModifierDetail {
96
- percentage: number;
97
- amount: number;
98
- label?: string;
99
- tax?: number;
100
- taxTableId?: string;
101
- taxRateId?: string;
102
- }
103
-
104
- interface OrderCartDiscount {
105
- amount: number;
106
- percentage: number;
107
- label?: string;
108
- }
109
-
110
- interface OrderCartFee {
111
- label: string;
112
- id: string;
113
- percentage: number;
114
- amount: number;
115
- taxName?: string;
116
- taxTableId?: string;
117
- tax?: number;
118
- taxes?: OrderTax[];
119
- }
120
-
121
- interface OrderPaymentMethod {
122
- paymentType: string;
123
- amount: number;
124
- transactionId: string;
125
- timestamp?: string;
126
- emv?: string | null;
127
- cashRounding?: number;
128
- change?: number;
129
- processor?: string;
130
- processorFee?: number;
131
- tendered?: number;
132
- tip?: OrderTip | null;
133
- }
134
-
135
- interface OrderPosData {
136
- outlet?: string;
137
- station?: string;
138
- employee?: string;
139
- }
140
-
141
- interface OrderAssignedUser {
142
- userId: string;
143
- assignedAt: string;
144
- label?: string | null;
145
- unassignedAt?: string | null;
146
- }
147
-
148
- interface OrderInCart {
149
- active: boolean;
150
- stationId: string | null;
151
- since: string;
152
- }
153
-
154
- interface OrderCustomStatus {
155
- id: string;
156
- key?: string;
157
- label: string;
158
- setAt: string;
159
- setBy: string | null;
160
- }
161
-
162
- interface OrderLineItemDiscount {
163
- itemDiscounts?: PriceModifierDetail[];
164
- cartDiscount?: PriceModifierDetail;
165
- }
166
- interface OrderLineItemFee {
167
- cartFee?: PriceModifierDetail;
168
- itemFees?: PriceModifierDetail[];
169
- }
170
- interface OrderLineItemModifier {
171
- modifierId: string;
172
- modifierName: string;
173
- choiceId: string;
174
- choiceName: string;
175
- unitPrice: number;
176
- quantity: number;
177
- total: number;
178
- totalTax?: number;
179
- taxes?: OrderTax[];
180
- componentIndex?: number;
181
- }
182
- interface OrderLineItemComponent {
183
- productId: string;
184
- variantId: string;
185
- name: string;
186
- attributes?: string;
187
- sku?: string;
188
- productExternalId?: string;
189
- variantExternalId?: string;
190
- partName?: string;
191
- quantity: number;
192
- price: number;
193
- unitId?: string;
194
- unitAbbreviation?: string;
195
- unitRatioToBase?: number;
196
- stockQuantity?: number;
197
- stockVariantId?: string;
198
- manageStock?: boolean;
199
- supplierId?: string | null;
200
- taxTableId?: string;
201
- totalTax?: number;
202
- taxes?: OrderTax[];
203
- }
204
- interface OrderLineItem {
205
- id?: string;
206
- productId?: string;
207
- variantId?: string;
208
- name?: string;
209
- quantity?: number;
210
- manageStock?: boolean;
211
- supplierId?: string | null;
212
- price?: number;
213
- description?: string;
214
- sku?: string;
215
- totalTax?: number;
216
- total?: number;
217
- productExternalId?: string;
218
- variantExternalId?: string;
219
- lineItemExternalId?: string;
220
- internalId?: string;
221
- note?: string;
222
- image?: string;
223
- attributes?: string;
224
- taxes?: OrderTax[];
225
- discount?: OrderLineItemDiscount;
226
- fee?: OrderLineItemFee;
227
- modifiers?: OrderLineItemModifier[];
228
- components?: OrderLineItemComponent[];
229
- lineNetWithFees?: number;
230
- metadata?: Metadata[];
231
- stock?: number;
232
- subTotal?: number;
233
- unitId?: string;
234
- unitAbbreviation?: string;
235
- stockQuantity?: number;
236
- unitRatioToBase?: number;
237
- stockVariantId?: string;
238
- }
239
-
240
- interface OrderCustomSaleDiscount {
241
- cartDiscount: OrderCartDiscount;
242
- }
243
- interface OrderCustomSaleFee {
244
- cartFee: PriceModifierDetail;
245
- }
246
- interface OrderCustomSale {
247
- customSaleId: string;
248
- applyTaxes: boolean;
249
- quantity: number;
250
- name: string;
251
- price: number;
252
- totalTax: number;
253
- total: number;
254
- taxes?: OrderTax[];
255
- discount?: OrderCustomSaleDiscount;
256
- fee?: OrderCustomSaleFee;
257
- }
258
-
259
- interface OrderRefundSummary {
260
- total?: number;
261
- }
262
- interface OrderRefund {
263
- externalId?: string;
264
- reason?: string;
265
- summary?: OrderRefundSummary;
266
- }
267
-
268
- interface RefundCartDiscount {
269
- amount?: number;
270
- percentage?: number;
271
- }
272
- interface RefundItemDiscount {
273
- amount?: number;
274
- percentage?: number;
275
- label?: string;
276
- }
277
- interface RefundDiscount {
278
- cartDiscount?: RefundCartDiscount;
279
- itemDiscounts?: RefundItemDiscount[];
280
- }
281
-
282
41
  declare enum CurrencyCode {
283
42
  USD = "USD",
284
43
  EUR = "EUR",
@@ -435,118 +194,394 @@ declare enum CurrencyCode {
435
194
  IQD = "IQD"
436
195
  }
437
196
 
438
- declare enum CustomTableAvailability {
439
- PUBLIC = "public",
440
- ORGANIZATION = "organization"
197
+ declare enum CustomTableAvailability {
198
+ PUBLIC = "public",
199
+ ORGANIZATION = "organization"
200
+ }
201
+ declare enum AttributeType {
202
+ STRING = "string",
203
+ NUMBER = "number",
204
+ BOOLEAN = "boolean",
205
+ DATE = "date",
206
+ JSON_STRING = "json-string"
207
+ }
208
+ declare enum Platform {
209
+ WOO_COMMERCE = "woo-commerce",
210
+ SHOPIFY = "shopify",
211
+ OLIVER = "oliver",
212
+ STANDALONE = "standalone"
213
+ }
214
+ declare enum CustomerPlatform {
215
+ POS = "in-store",
216
+ WOO_COMMERCE = "woo-commerce"
217
+ }
218
+ declare enum StationStatus {
219
+ IN_USE = "IN_USE",
220
+ AVAILABLE = "AVAILABLE"
221
+ }
222
+ declare enum InventorySpecificActionType {
223
+ STOCK_RECEIVED = "STOCK_RECEIVED",
224
+ INVENTORY_RECOUNT = "INVENTORY_RECOUNT",
225
+ DAMAGE = "DAMAGE",
226
+ THEFT = "THEFT",
227
+ LOSS = "LOSS",
228
+ RESTOCK_RETURN = "RESTOCK_RETURN",
229
+ REFUND_RESTOCK_RETURN = "REFUND_RESTOCK_RETURN",
230
+ REFUND_DAMAGE = "REFUND_DAMAGE",
231
+ SALE = "SALE",
232
+ COMPOSED_FOR_SALE = "COMPOSED_FOR_SALE",
233
+ UNIT_FAMILY_CHANGED = "UNIT_FAMILY_CHANGED",
234
+ TRANSFER = "TRANSFER",
235
+ BULK_RECOUNT = "BULK_RECOUNT",
236
+ APPLIED_FROM_WOO = "APPLIED_FROM_WOO",
237
+ PO_RECEIVED = "PO_RECEIVED",
238
+ EXTERNAL_SALE = "EXTERNAL_SALE",
239
+ EXTERNAL_RESTOCK = "EXTERNAL_RESTOCK",
240
+ CUSTOM = "CUSTOM"
241
+ }
242
+ declare enum UserTypes {
243
+ COMPANY_OWNER = "owner",
244
+ ORG_USER = "organization_user",
245
+ ORG_OWNER = "organization_owner",
246
+ FINAL_USER = "final_user",
247
+ FINAL_OWNER = "final_owner",
248
+ EMPLOYEE = "employee",
249
+ SUPER_ADMIN = "super_admin",
250
+ MANAGER = "manager",
251
+ ADMIN = "admin",
252
+ ASSISTANT_MANAGER = "assistant",
253
+ CASHIER = "cashier",
254
+ RESELLER = "reseller"
255
+ }
256
+ declare enum OwnerType {
257
+ API_KEY = "api-key",
258
+ ORGANIZATION = "organization",
259
+ COMPANY = "company"
260
+ }
261
+ declare enum NonRevenueItemType {
262
+ GIFT_CARD = "gift-card"
263
+ }
264
+
265
+ declare enum ProductType {
266
+ SIMPLE = "simple",
267
+ VARIABLE = "variable",
268
+ BOOKING = "booking",
269
+ COMPOSITE = "composite"
270
+ }
271
+ declare enum ProductStatus {
272
+ ACTIVE = "active",
273
+ INACTIVE = "inactive",
274
+ DRAFT = "draft"
275
+ }
276
+
277
+ declare enum PaymentProcessor {
278
+ STRIPE = "stripe",
279
+ ADYEN = "adyen",
280
+ EXTERNAL = "external"
281
+ }
282
+
283
+ declare enum BookingType {
284
+ RENTAL = "rental",
285
+ APPOINTMENT = "appointment",
286
+ OVERNIGHT = "overnight",
287
+ GROUP = "group"
288
+ }
289
+ declare enum BookingRatePeriod {
290
+ SLOT = "slot",
291
+ DAY = "day",
292
+ NIGHT = "night",
293
+ WEEK = "week",
294
+ MONTH = "month"
295
+ }
296
+ declare enum BookingResourceKind {
297
+ ASSET = "asset",
298
+ ROOM = "room",
299
+ PROPERTY = "property",
300
+ SPACE = "space",
301
+ STAFF = "staff",
302
+ TABLE = "table"
303
+ }
304
+ declare enum ReservationStatus {
305
+ HELD = "held",
306
+ CONFIRMED = "confirmed",
307
+ CANCELLED = "cancelled",
308
+ EXPIRED = "expired"
309
+ }
310
+
311
+ declare enum ShippingOptionType {
312
+ SHIP = "ship",
313
+ PICKUP = "pickup"
314
+ }
315
+ declare enum ShippingRateType {
316
+ FLAT = "flat"
317
+ }
318
+ declare enum ShippingChannel {
319
+ WEB = "web",
320
+ POS = "pos"
321
+ }
322
+
323
+ declare enum TaxSource {
324
+ MERCHANT = "merchant",
325
+ AUTOMATIC = "automatic"
326
+ }
327
+
328
+ interface OrderTax {
329
+ name: string;
330
+ taxTableId?: string;
331
+ taxTableName?: string;
332
+ id?: string;
333
+ percentage: number;
334
+ amount: number;
335
+ taxableAmount?: number;
336
+ compounding?: boolean;
337
+ priority?: number;
338
+ source?: TaxSource | `${TaxSource}`;
339
+ code?: string;
340
+ place?: string;
341
+ }
342
+
343
+ interface OrderShippingLine {
344
+ type: ShippingOptionType | `${ShippingOptionType}`;
345
+ name?: string;
346
+ amount: number;
347
+ zoneId?: string;
348
+ optionId?: string;
349
+ minDays?: number;
350
+ maxDays?: number;
351
+ pickupOutletId?: string;
352
+ taxes?: OrderTax[];
353
+ }
354
+
355
+ interface OrderTip {
356
+ percentage?: number;
357
+ amount?: number;
358
+ tipTo?: string;
359
+ }
360
+
361
+ interface OrderSummaryPayments {
362
+ cardTotal: number;
363
+ cashTotal: number;
364
+ customTotal: number;
365
+ cardProcessingFeesTotal: number;
366
+ }
367
+ interface OrderSummary {
368
+ discountTotal: number;
369
+ shippingTotal?: number;
370
+ total: number;
371
+ totalTaxes: number;
372
+ isTaxInclusive: boolean;
373
+ subtotalAfterFees: number;
374
+ nonRevenueTotal?: number;
375
+ grossSales?: number;
376
+ lineDiscountTotal?: number;
377
+ cartDiscountTotal?: number;
378
+ feesTotal?: number;
379
+ lineFeesTotal?: number;
380
+ cartFeesTotal?: number;
381
+ taxableFeesTotal?: number;
382
+ nonTaxableFeesTotal?: number;
383
+ modifiersTotal?: number;
384
+ taxableModifiersTotal?: number;
385
+ nonTaxableModifiersTotal?: number;
386
+ totalTaxableSales?: number;
387
+ totalNonTaxableSales?: number;
388
+ tipTotal?: number;
389
+ cashRounding: number;
390
+ payments?: OrderSummaryPayments;
391
+ totalBeforeTip?: number;
392
+ amountPaid?: number;
393
+ taxes: OrderTax[];
394
+ tip?: OrderTip;
395
+ }
396
+
397
+ interface PriceModifierDetail {
398
+ percentage: number;
399
+ amount: number;
400
+ label?: string;
401
+ tax?: number;
402
+ taxTableId?: string;
403
+ taxRateId?: string;
404
+ }
405
+
406
+ interface OrderCartDiscount {
407
+ amount: number;
408
+ percentage: number;
409
+ label?: string;
410
+ }
411
+
412
+ interface OrderCartFee {
413
+ label: string;
414
+ id: string;
415
+ percentage: number;
416
+ amount: number;
417
+ taxName?: string;
418
+ taxTableId?: string;
419
+ tax?: number;
420
+ taxes?: OrderTax[];
421
+ }
422
+
423
+ interface OrderPaymentMethod {
424
+ paymentType: string;
425
+ amount: number;
426
+ transactionId: string;
427
+ timestamp?: string;
428
+ emv?: string | null;
429
+ cashRounding?: number;
430
+ change?: number;
431
+ processor?: string;
432
+ processorFee?: number;
433
+ tendered?: number;
434
+ tip?: OrderTip | null;
435
+ }
436
+
437
+ interface OrderPosData {
438
+ outlet?: string;
439
+ station?: string;
440
+ employee?: string;
441
441
  }
442
- declare enum AttributeType {
443
- STRING = "string",
444
- NUMBER = "number",
445
- BOOLEAN = "boolean",
446
- DATE = "date",
447
- JSON_STRING = "json-string"
442
+
443
+ interface OrderAssignedUser {
444
+ userId: string;
445
+ assignedAt: string;
446
+ label?: string | null;
447
+ unassignedAt?: string | null;
448
448
  }
449
- declare enum Platform {
450
- WOO_COMMERCE = "woo-commerce",
451
- SHOPIFY = "shopify",
452
- OLIVER = "oliver",
453
- STANDALONE = "standalone"
449
+
450
+ interface OrderInCart {
451
+ active: boolean;
452
+ stationId: string | null;
453
+ since: string;
454
454
  }
455
- declare enum CustomerPlatform {
456
- POS = "in-store",
457
- WOO_COMMERCE = "woo-commerce"
455
+
456
+ interface OrderCustomStatus {
457
+ id: string;
458
+ key?: string;
459
+ label: string;
460
+ setAt: string;
461
+ setBy: string | null;
458
462
  }
459
- declare enum StationStatus {
460
- IN_USE = "IN_USE",
461
- AVAILABLE = "AVAILABLE"
463
+
464
+ interface OrderLineItemDiscount {
465
+ itemDiscounts?: PriceModifierDetail[];
466
+ cartDiscount?: PriceModifierDetail;
462
467
  }
463
- declare enum InventorySpecificActionType {
464
- STOCK_RECEIVED = "STOCK_RECEIVED",
465
- INVENTORY_RECOUNT = "INVENTORY_RECOUNT",
466
- DAMAGE = "DAMAGE",
467
- THEFT = "THEFT",
468
- LOSS = "LOSS",
469
- RESTOCK_RETURN = "RESTOCK_RETURN",
470
- REFUND_RESTOCK_RETURN = "REFUND_RESTOCK_RETURN",
471
- REFUND_DAMAGE = "REFUND_DAMAGE",
472
- SALE = "SALE",
473
- COMPOSED_FOR_SALE = "COMPOSED_FOR_SALE",
474
- UNIT_FAMILY_CHANGED = "UNIT_FAMILY_CHANGED",
475
- TRANSFER = "TRANSFER",
476
- BULK_RECOUNT = "BULK_RECOUNT",
477
- APPLIED_FROM_WOO = "APPLIED_FROM_WOO",
478
- PO_RECEIVED = "PO_RECEIVED",
479
- EXTERNAL_SALE = "EXTERNAL_SALE",
480
- EXTERNAL_RESTOCK = "EXTERNAL_RESTOCK",
481
- CUSTOM = "CUSTOM"
468
+ interface OrderLineItemFee {
469
+ cartFee?: PriceModifierDetail;
470
+ itemFees?: PriceModifierDetail[];
482
471
  }
483
- declare enum UserTypes {
484
- COMPANY_OWNER = "owner",
485
- ORG_USER = "organization_user",
486
- ORG_OWNER = "organization_owner",
487
- FINAL_USER = "final_user",
488
- FINAL_OWNER = "final_owner",
489
- EMPLOYEE = "employee",
490
- SUPER_ADMIN = "super_admin",
491
- MANAGER = "manager",
492
- ADMIN = "admin",
493
- ASSISTANT_MANAGER = "assistant",
494
- CASHIER = "cashier",
495
- RESELLER = "reseller"
472
+ interface OrderLineItemModifier {
473
+ modifierId: string;
474
+ modifierName: string;
475
+ choiceId: string;
476
+ choiceName: string;
477
+ unitPrice: number;
478
+ quantity: number;
479
+ total: number;
480
+ totalTax?: number;
481
+ taxes?: OrderTax[];
482
+ componentIndex?: number;
496
483
  }
497
- declare enum OwnerType {
498
- API_KEY = "api-key",
499
- ORGANIZATION = "organization",
500
- COMPANY = "company"
484
+ interface OrderLineItemComponent {
485
+ productId: string;
486
+ variantId: string;
487
+ name: string;
488
+ attributes?: string;
489
+ sku?: string;
490
+ productExternalId?: string;
491
+ variantExternalId?: string;
492
+ partName?: string;
493
+ quantity: number;
494
+ price: number;
495
+ unitId?: string;
496
+ unitAbbreviation?: string;
497
+ unitRatioToBase?: number;
498
+ stockQuantity?: number;
499
+ stockVariantId?: string;
500
+ manageStock?: boolean;
501
+ supplierId?: string | null;
502
+ taxTableId?: string;
503
+ totalTax?: number;
504
+ taxes?: OrderTax[];
501
505
  }
502
- declare enum NonRevenueItemType {
503
- GIFT_CARD = "gift-card"
506
+ interface OrderLineItem {
507
+ id?: string;
508
+ productId?: string;
509
+ variantId?: string;
510
+ name?: string;
511
+ quantity?: number;
512
+ manageStock?: boolean;
513
+ supplierId?: string | null;
514
+ price?: number;
515
+ description?: string;
516
+ sku?: string;
517
+ totalTax?: number;
518
+ total?: number;
519
+ productExternalId?: string;
520
+ variantExternalId?: string;
521
+ lineItemExternalId?: string;
522
+ internalId?: string;
523
+ note?: string;
524
+ image?: string;
525
+ attributes?: string;
526
+ taxes?: OrderTax[];
527
+ discount?: OrderLineItemDiscount;
528
+ fee?: OrderLineItemFee;
529
+ modifiers?: OrderLineItemModifier[];
530
+ components?: OrderLineItemComponent[];
531
+ lineNetWithFees?: number;
532
+ metadata?: Metadata[];
533
+ stock?: number;
534
+ subTotal?: number;
535
+ unitId?: string;
536
+ unitAbbreviation?: string;
537
+ stockQuantity?: number;
538
+ unitRatioToBase?: number;
539
+ stockVariantId?: string;
540
+ taxType?: string | null;
541
+ taxCategoryIds?: string[];
542
+ taxTableId?: string;
504
543
  }
505
544
 
506
- declare enum ProductType {
507
- SIMPLE = "simple",
508
- VARIABLE = "variable",
509
- BOOKING = "booking",
510
- COMPOSITE = "composite"
545
+ interface OrderCustomSaleDiscount {
546
+ cartDiscount: OrderCartDiscount;
511
547
  }
512
- declare enum ProductStatus {
513
- ACTIVE = "active",
514
- INACTIVE = "inactive",
515
- DRAFT = "draft"
548
+ interface OrderCustomSaleFee {
549
+ cartFee: PriceModifierDetail;
516
550
  }
517
-
518
- declare enum PaymentProcessor {
519
- STRIPE = "stripe",
520
- ADYEN = "adyen",
521
- EXTERNAL = "external"
551
+ interface OrderCustomSale {
552
+ customSaleId: string;
553
+ applyTaxes: boolean;
554
+ quantity: number;
555
+ name: string;
556
+ price: number;
557
+ totalTax: number;
558
+ total: number;
559
+ taxes?: OrderTax[];
560
+ discount?: OrderCustomSaleDiscount;
561
+ fee?: OrderCustomSaleFee;
522
562
  }
523
563
 
524
- declare enum BookingType {
525
- RENTAL = "rental",
526
- APPOINTMENT = "appointment",
527
- OVERNIGHT = "overnight",
528
- GROUP = "group"
564
+ interface OrderRefundSummary {
565
+ total?: number;
529
566
  }
530
- declare enum BookingRatePeriod {
531
- SLOT = "slot",
532
- DAY = "day",
533
- NIGHT = "night",
534
- WEEK = "week",
535
- MONTH = "month"
567
+ interface OrderRefund {
568
+ externalId?: string;
569
+ reason?: string;
570
+ summary?: OrderRefundSummary;
536
571
  }
537
- declare enum BookingResourceKind {
538
- ASSET = "asset",
539
- ROOM = "room",
540
- PROPERTY = "property",
541
- SPACE = "space",
542
- STAFF = "staff",
543
- TABLE = "table"
572
+
573
+ interface RefundCartDiscount {
574
+ amount?: number;
575
+ percentage?: number;
544
576
  }
545
- declare enum ReservationStatus {
546
- HELD = "held",
547
- CONFIRMED = "confirmed",
548
- CANCELLED = "cancelled",
549
- EXPIRED = "expired"
577
+ interface RefundItemDiscount {
578
+ amount?: number;
579
+ percentage?: number;
580
+ label?: string;
581
+ }
582
+ interface RefundDiscount {
583
+ cartDiscount?: RefundCartDiscount;
584
+ itemDiscounts?: RefundItemDiscount[];
550
585
  }
551
586
 
552
587
  interface RefundLineItem {
@@ -700,6 +735,7 @@ interface Category extends BaseEntity {
700
735
  parentId?: string;
701
736
  menuOrder?: number;
702
737
  source?: string;
738
+ taxType?: string | null;
703
739
  }
704
740
 
705
741
  interface CompanyExtension extends BaseEntity {
@@ -982,6 +1018,9 @@ interface Order extends BaseEntity {
982
1018
  notes: OrderNote$1[];
983
1019
  billing?: Address$1;
984
1020
  shipping?: Address$1;
1021
+ shippingLine?: OrderShippingLine;
1022
+ taxPlace?: string;
1023
+ taxTableVersion?: string;
985
1024
  lineItems: Partial<OrderLineItem>[];
986
1025
  customSales?: OrderCustomSale[];
987
1026
  nonRevenueItems?: NonRevenueItem$1[];
@@ -1036,6 +1075,7 @@ interface Product extends BaseEntity {
1036
1075
  maxPrice?: number;
1037
1076
  supplier?: string;
1038
1077
  taxTable?: string | null;
1078
+ taxType?: string | null;
1039
1079
  defaultVariantId?: string;
1040
1080
  categories?: string[];
1041
1081
  outlets?: string[];
@@ -1269,6 +1309,9 @@ interface Tax {
1269
1309
  taxTableId: string;
1270
1310
  compounding?: boolean;
1271
1311
  priority?: number;
1312
+ source?: TaxSource | `${TaxSource}`;
1313
+ code?: string;
1314
+ place?: string;
1272
1315
  }
1273
1316
  interface Tip {
1274
1317
  amount: number;
@@ -1522,6 +1565,9 @@ interface LineItem {
1522
1565
  stockQuantity?: number;
1523
1566
  unitRatioToBase?: number;
1524
1567
  stockVariantId?: string;
1568
+ taxType?: string | null;
1569
+ taxCategoryIds?: string[];
1570
+ taxTableId?: string;
1525
1571
  }
1526
1572
 
1527
1573
  interface TipPayment {
@@ -1770,6 +1816,7 @@ interface FullProduct {
1770
1816
  companyId?: string;
1771
1817
  externalId: string;
1772
1818
  taxTable: string;
1819
+ taxType?: string | null;
1773
1820
  name: string;
1774
1821
  description?: string;
1775
1822
  shortDescription?: string;
@@ -1886,6 +1933,8 @@ interface ActiveProduct {
1886
1933
  price: number;
1887
1934
  images: string[];
1888
1935
  taxTableId: string;
1936
+ taxType?: string | null;
1937
+ taxCategoryIds?: string[];
1889
1938
  quantity: number;
1890
1939
  note?: string;
1891
1940
  discounts?: Discount[];
@@ -1899,6 +1948,12 @@ interface ActiveProduct {
1899
1948
  modifierSelections?: ModifierSelection[];
1900
1949
  modifiers?: CartLineModifier[];
1901
1950
  components?: CartLineComponent[];
1951
+ compositePicks?: (CompositePick & {
1952
+ resourceId?: string;
1953
+ })[];
1954
+ compositeSlot?: {
1955
+ startAt: string;
1956
+ };
1902
1957
  currency?: CurrencyCode;
1903
1958
  minorUnits?: number;
1904
1959
  isUnlimited?: boolean;
@@ -1918,6 +1973,48 @@ interface CartReservation extends OrderReservation {
1918
1973
  fees?: CustomFee[];
1919
1974
  }
1920
1975
 
1976
+ interface ShippingPriceTier {
1977
+ from: number;
1978
+ price: number;
1979
+ }
1980
+ interface ShippingOptionRule {
1981
+ id: string;
1982
+ type: ShippingOptionType | `${ShippingOptionType}`;
1983
+ rate?: ShippingRateType | `${ShippingRateType}`;
1984
+ name?: string | null;
1985
+ price: number;
1986
+ priceByTotal?: ShippingPriceTier[] | null;
1987
+ freeOver?: number | null;
1988
+ minDays?: number | null;
1989
+ maxDays?: number | null;
1990
+ channels: (ShippingChannel | `${ShippingChannel}`)[];
1991
+ outletId?: string | null;
1992
+ }
1993
+
1994
+ interface CartAddress {
1995
+ firstName?: string;
1996
+ lastName?: string;
1997
+ address1?: string;
1998
+ address2?: string;
1999
+ city?: string;
2000
+ state?: string;
2001
+ postCode?: string;
2002
+ country?: string;
2003
+ fromCustomer?: boolean;
2004
+ }
2005
+ interface CartShipping {
2006
+ zoneId: string;
2007
+ optionId: string;
2008
+ type: ShippingOptionType | `${ShippingOptionType}`;
2009
+ name: string | null;
2010
+ amount: number;
2011
+ taxes?: Tax[];
2012
+ minDays: number | null;
2013
+ maxDays: number | null;
2014
+ outletId: string | null;
2015
+ rule?: Pick<ShippingOptionRule, 'price' | 'priceByTotal' | 'freeOver'>;
2016
+ }
2017
+
1921
2018
  interface ActiveCustomSales {
1922
2019
  id: string;
1923
2020
  name: string;
@@ -1953,6 +2050,10 @@ interface ActiveCart {
1953
2050
  amountToBeCharged: number;
1954
2051
  customer?: Partial<ActiveCustomer | null> | null;
1955
2052
  orderNotes?: string;
2053
+ shippingAddress?: CartAddress | null;
2054
+ billingAddress?: CartAddress | null;
2055
+ shipping?: CartShipping | null;
2056
+ shippingTotal?: number;
1956
2057
  cartTotal?: number;
1957
2058
  orderTotal?: number;
1958
2059
  orderId?: string;
@@ -2066,6 +2167,7 @@ declare enum ProcessorType {
2066
2167
  REDEEM = "Redeem",
2067
2168
  INTEGRATION = "Integration",
2068
2169
  PAYMENT_LINK = "PaymentLink",
2170
+ ONLINE_PAYMENT = "OnlinePayment",
2069
2171
  EXTERNAL = "External"
2070
2172
  }
2071
2173
 
@@ -2276,6 +2378,7 @@ interface CalculatedTaxDetails {
2276
2378
  };
2277
2379
  totalTaxes: TaxesDetails;
2278
2380
  cartFees: CartFeesDetails[];
2381
+ shipping?: CartFeesDetails;
2279
2382
  }
2280
2383
  interface TipData {
2281
2384
  value: number;
@@ -2573,4 +2676,4 @@ interface PubsubEventMessage {
2573
2676
  }
2574
2677
  type ServiceChannelMessage = PosBrainReadyMessage | HostHelloMessage | ServiceInitMessage | BootstrapMessage | TokenRefreshMessage | RequestTokenRefreshMessage | SelectionMessage | HostShutdownMessage | ReaderCapabilitiesMessage | PrinterSettingsMessage | RuntimeReadyMessage | HostNavigateMessage | SyncProgressMessage | DeviceOpRequestMessage | DeviceOpResponseMessage | PubsubTopicsRequestMessage | PubsubTopicsListMessage | PubsubSubscribeMessage | PubsubEventMessage;
2575
2678
 
2576
- 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 AdyenCardEntryConfig, 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 CartLineComponent, type CartLineModifier, type CartReservation, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, 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 OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, 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 RequestTokenRefreshMessage, 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 };
2679
+ 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 AdyenCardEntryConfig, 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 CartLineComponent, type CartLineModifier, type CartReservation, type CartShipping, type CashDrawerPolicy, type CashPaymentSettings, type CashRoundingIncrement, type Category, type CompanyExtension, type CompanySettingsEavValue, type CompanySettingsEavValueType, type Composite, type CompositeChoice, type CompositeItem, type CompositeItemUnavailable, type CompositePart, type CompositePick, 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 OrderAssignedUser, type OrderCartDiscount, type OrderCartFee, type OrderCustomSale, type OrderCustomSaleDiscount, type OrderCustomSaleFee, type OrderCustomStatus, type OrderInCart, type OrderLineItem, type OrderLineItemComponent, 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 RequestTokenRefreshMessage, 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 };