@figuredev/orders-sdk - npm Package Compare versions

Comparing version 0.13.5 to 0.13.6

lib/order.d.ts

@@ -5,2 +5,3 @@ import { AddressDTO, IsoDateTime, Maybe, RecipientDTO } from "./types";
     accountId: string;
+    accountName?: Maybe<string>;
     locationId: string;
@@ -10,4 +11,5 @@ locationName?: Maybe<string>;
     serviceName?: Maybe<string>;
-    orderNumber: string;
+    orderNumber?: string;
     state: OrderStateDTO;
+    timezone?: Maybe<string>;
     source?: Maybe<OrderSourceDTO>;
@@ -20,3 +22,3 @@ sourceName?: Maybe<OrderSourceNameDTO>;
     placedAt: IsoDateTime;
-    totals: OrderTotalsDTO;
+    totals?: Maybe<OrderTotalsDTO>;
     items?: OrderItemDTO[];
@@ -32,2 +34,3 @@ fulfillments?: OrderFulfillmentDTO[];
     metadata?: Maybe<OrderMetadataDTO>;
+    splits?: OrderSplitDTO[];
 };
@@ -61,2 +64,13 @@ export declare type OrderPreviewDTO = {
 };
+export declare type OrderSplitDTO = {
+    id: string;
+    transactionId?: string;
+    amount?: number;
+    gratuity?: number;
+    items: OrderSplitItemDTO[];
+};
+export declare type OrderSplitItemDTO = {
+    orderItemId: string;
+    quantity?: Maybe<number>;
+};
 export declare type OrderFulfillmentDTO = {
@@ -111,4 +125,3 @@ id: string;
     WestSideEats = "WestSideEats",
-    Slice = "slice",
-    Wolt = "wolt"
+    Slice = "slice"
 }
@@ -152,2 +165,3 @@ export declare enum OrderPaymentMethodDTO {
     isGift?: boolean;
+    containsAlcohol?: boolean;
 };
@@ -164,10 +178,22 @@ export declare type OrderPricingDTO = {
 export declare type OrderTotalsDTO = {
-    subtotal?: number;
-    netCollected?: number;
-    total?: number;
-    paymentState?: string;
+    subtotal?: Maybe<number>;
+    netCollected?: Maybe<number>;
+    total?: Maybe<number>;
+    netRevenue?: Maybe<number>;
+    paymentState?: Maybe<PaymentStateDTO>;
 };
+export declare enum PaymentStateDTO {
+    Unpaid = "unpaid",
+    PartiallyPaid = "partially-paid",
+    Paid = "paid",
+    Overcharged = "overcharged",
+    PartiallyRefunded = "partially-refunded",
+    Refunded = "refunded",
+    Forfeited = "forfeited",
+    Voided = "voided"
+}
 export declare type OrderItemTotalsDTO = {
-    subtotal?: number;
-    total?: number;
+    subtotal?: Maybe<number>;
+    total?: Maybe<number>;
+    pricings?: Maybe<number>;
 };
@@ -192,2 +218,4 @@ export declare type OrderPaymentDTO = {
     externalDetails?: Maybe<OrderPaymentExternalDetailsDTO>;
+    declineCode?: Maybe<string>;
+    declineMessage?: Maybe<string>;
 };
@@ -233,2 +261,3 @@ export declare type OrderPaymentPriceComponentDTO = {
     id: string;
+    timestamp: IsoDateTime;
     type: OrderPaymentTypeDTO;
@@ -238,13 +267,21 @@ state: OrderPaymentStateDTO;
     amount: number;
-    tip?: number;
+    tip?: Maybe<number>;
     priceComponents?: OrderPaymentPriceComponentDTO[];
     itemIds?: string[];
-    paymentId?: string;
-    customerId?: string;
-    signature?: string;
-    audit?: OrderPaymentAuditDTO[];
+    paymentId?: Maybe<string>;
+    customerId?: Maybe<string>;
+    signature?: Maybe<{
+        base64?: Maybe<string>;
+    }>;
+    audit?: Maybe<OrderPaymentAuditDTO[]>;
+    cashDetails?: Maybe<OrderPaymentCashDetailsDTO>;
+    cardDetails?: Maybe<OrderPaymentCardDetailsDTO>;
+    externalDetails?: Maybe<OrderPaymentExternalDetailsDTO>;
 };
 export declare type OrderPaymentAuditDTO = {
+    id: string;
+    parentId?: Maybe<string>;
     amount?: Maybe<number>;
-    type: string;
+    type: OrderPaymentTransactionTypeDTO;
+    state?: Maybe<OrderPaymentStateDTO>;
     serviceId?: Maybe<string>;
@@ -256,3 +293,2 @@ serviceName?: Maybe<string>;
     paymentRequestId?: Maybe<string>;
-    state?: Maybe<string>;
 };
@@ -280,8 +316,27 @@ export declare enum OrderFulfillmentScheduleTypeDTO {
     Cash = "cash",
-    External = "external"
+    External = "external",
+    Redemption = "redemption",
+    CardProgram = "card-program"
 }
 export declare enum OrderPaymentTransactionTypeDTO {
     Payment = "payment",
-    Refund = "refund"
+    Refund = "refund",
+    Tip = "tip",
+    Void = "void",
+    Authorize = "authorize"
 }
+export declare enum ReportPaymentTypeDTO {
+    LoyaltyRewards = "Loyalty Rewards",
+    CardProgram = "Card Program",
+    External = "External",
+    Card = "Card",
+    Cash = "Cash"
+}
+export declare enum ReportRecordFilterTypeDTO {
+    Transaction = "transaction",
+    Order = "order",
+    Pricing = "Pricing",
+    Tax = "tax",
+    Category = "category"
+}
 export declare enum OrderPaymentStateDTO {
@@ -302,2 +357,6 @@ Pending = "pending",
 }
+export declare enum OrderSpecialPricingLevelDTO {
+    Order = "order",
+    OrderItem = "order-item"
+}
 export declare enum OrderItemModifierGroupDisplayTypeDTO {
@@ -304,0 +363,0 @@ Horizontal = "horizontal",

lib/order.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderItemModifierGroupDisplayTypeDTO = exports.OrderItemModifierGroupTypeDTO = exports.OrderPaymentStateDTO = exports.OrderPaymentTransactionTypeDTO = exports.OrderPaymentTypeDTO = exports.OrderFulfillmentTypeDTO = exports.OrderPricingTypeDTO = exports.OrderFulfillmentScheduleTypeDTO = exports.CardPaymentEntryModeDTO = exports.OrderPaymentPriceComponentTypeDTO = exports.OrderFulfillmentDeliveryStateDTO = exports.OrderFulfillmentStateDTO = exports.OrderStateDTO = exports.OrderPaymentMethodDTO = exports.OrderSourceNameDTO = exports.OrderSourceDTO = void 0;
+exports.OrderItemModifierGroupDisplayTypeDTO = exports.OrderSpecialPricingLevelDTO = exports.OrderItemModifierGroupTypeDTO = exports.OrderPaymentStateDTO = exports.ReportRecordFilterTypeDTO = exports.ReportPaymentTypeDTO = exports.OrderPaymentTransactionTypeDTO = exports.OrderPaymentTypeDTO = exports.OrderFulfillmentTypeDTO = exports.OrderPricingTypeDTO = exports.OrderFulfillmentScheduleTypeDTO = exports.CardPaymentEntryModeDTO = exports.OrderPaymentPriceComponentTypeDTO = exports.PaymentStateDTO = exports.OrderFulfillmentDeliveryStateDTO = exports.OrderFulfillmentStateDTO = exports.OrderStateDTO = exports.OrderPaymentMethodDTO = exports.OrderSourceNameDTO = exports.OrderSourceDTO = void 0;
 var OrderSourceDTO;
@@ -20,3 +20,2 @@ (function (OrderSourceDTO) {
     OrderSourceNameDTO["Slice"] = "slice";
-    OrderSourceNameDTO["Wolt"] = "wolt";
 })(OrderSourceNameDTO = exports.OrderSourceNameDTO || (exports.OrderSourceNameDTO = {}));
@@ -48,3 +47,2 @@ var OrderPaymentMethodDTO;
 })(OrderFulfillmentStateDTO = exports.OrderFulfillmentStateDTO || (exports.OrderFulfillmentStateDTO = {}));
-// TODO review
 var OrderFulfillmentDeliveryStateDTO;
@@ -61,2 +59,13 @@ (function (OrderFulfillmentDeliveryStateDTO) {
 })(OrderFulfillmentDeliveryStateDTO = exports.OrderFulfillmentDeliveryStateDTO || (exports.OrderFulfillmentDeliveryStateDTO = {}));
+var PaymentStateDTO;
+(function (PaymentStateDTO) {
+    PaymentStateDTO["Unpaid"] = "unpaid";
+    PaymentStateDTO["PartiallyPaid"] = "partially-paid";
+    PaymentStateDTO["Paid"] = "paid";
+    PaymentStateDTO["Overcharged"] = "overcharged";
+    PaymentStateDTO["PartiallyRefunded"] = "partially-refunded";
+    PaymentStateDTO["Refunded"] = "refunded";
+    PaymentStateDTO["Forfeited"] = "forfeited";
+    PaymentStateDTO["Voided"] = "voided";
+})(PaymentStateDTO = exports.PaymentStateDTO || (exports.PaymentStateDTO = {}));
 var OrderPaymentPriceComponentTypeDTO;
@@ -104,2 +113,4 @@ (function (OrderPaymentPriceComponentTypeDTO) {
     OrderPaymentTypeDTO["External"] = "external";
+    OrderPaymentTypeDTO["Redemption"] = "redemption";
+    OrderPaymentTypeDTO["CardProgram"] = "card-program";
 })(OrderPaymentTypeDTO = exports.OrderPaymentTypeDTO || (exports.OrderPaymentTypeDTO = {}));
@@ -110,3 +121,22 @@ var OrderPaymentTransactionTypeDTO;
     OrderPaymentTransactionTypeDTO["Refund"] = "refund";
+    OrderPaymentTransactionTypeDTO["Tip"] = "tip";
+    OrderPaymentTransactionTypeDTO["Void"] = "void";
+    OrderPaymentTransactionTypeDTO["Authorize"] = "authorize";
 })(OrderPaymentTransactionTypeDTO = exports.OrderPaymentTransactionTypeDTO || (exports.OrderPaymentTransactionTypeDTO = {}));
+var ReportPaymentTypeDTO;
+(function (ReportPaymentTypeDTO) {
+    ReportPaymentTypeDTO["LoyaltyRewards"] = "Loyalty Rewards";
+    ReportPaymentTypeDTO["CardProgram"] = "Card Program";
+    ReportPaymentTypeDTO["External"] = "External";
+    ReportPaymentTypeDTO["Card"] = "Card";
+    ReportPaymentTypeDTO["Cash"] = "Cash";
+})(ReportPaymentTypeDTO = exports.ReportPaymentTypeDTO || (exports.ReportPaymentTypeDTO = {}));
+var ReportRecordFilterTypeDTO;
+(function (ReportRecordFilterTypeDTO) {
+    ReportRecordFilterTypeDTO["Transaction"] = "transaction";
+    ReportRecordFilterTypeDTO["Order"] = "order";
+    ReportRecordFilterTypeDTO["Pricing"] = "Pricing";
+    ReportRecordFilterTypeDTO["Tax"] = "tax";
+    ReportRecordFilterTypeDTO["Category"] = "category";
+})(ReportRecordFilterTypeDTO = exports.ReportRecordFilterTypeDTO || (exports.ReportRecordFilterTypeDTO = {}));
 var OrderPaymentStateDTO;
@@ -129,2 +159,7 @@ (function (OrderPaymentStateDTO) {
 })(OrderItemModifierGroupTypeDTO = exports.OrderItemModifierGroupTypeDTO || (exports.OrderItemModifierGroupTypeDTO = {}));
+var OrderSpecialPricingLevelDTO;
+(function (OrderSpecialPricingLevelDTO) {
+    OrderSpecialPricingLevelDTO["Order"] = "order";
+    OrderSpecialPricingLevelDTO["OrderItem"] = "order-item";
+})(OrderSpecialPricingLevelDTO = exports.OrderSpecialPricingLevelDTO || (exports.OrderSpecialPricingLevelDTO = {}));
 var OrderItemModifierGroupDisplayTypeDTO;
@@ -131,0 +166,0 @@ (function (OrderItemModifierGroupDisplayTypeDTO) {

package.json

 {
     "name": "@figuredev/orders-sdk",
-    "version": "0.13.5",
+    "version": "0.13.6",
     "license": "ISC",
@@ -5,0 +5,0 @@ "files": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

88604

increased by9.56%

Number of package files

44

increased by4.76%

Lines of code

1702

increased by10.38%

No dependency changes