@shopperlabs/shopper-types 2.4.3 → 2.5.0

package/dist/discount.d.ts

@@ -6,11 +6,16 @@ export declare enum DiscountType {
 }
 export declare enum DiscountApplyTo {
     ORDER = "order",
-    SPECIFIC = "specific"
+    PRODUCTS = "products"
 }
 export declare enum DiscountEligibility {
     EVERYONE = "everyone",
-    CUSTOMERS = "specific_customers"
+    CUSTOMERS = "customers"
+}
+export declare enum DiscountRequirement {
+    NONE = "none",
+    PRICE = "price",
+    QUANTITY = "quantity"
 }
 export declare enum DiscountCondition {
     APPLY_TO = "apply_to",

package/dist/discount.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiscountCondition = exports.DiscountEligibility = exports.DiscountApplyTo = exports.DiscountType = void 0;
+exports.DiscountCondition = exports.DiscountRequirement = exports.DiscountEligibility = exports.DiscountApplyTo = exports.DiscountType = void 0;
 var DiscountType;
 (function (DiscountType) {
     DiscountType["PERCENTAGE"] = "percentage";
@@ -9,13 +9,19 @@ var DiscountType;
 var DiscountApplyTo;
 (function (DiscountApplyTo) {
     DiscountApplyTo["ORDER"] = "order";
-    DiscountApplyTo["SPECIFIC"] = "specific";
+    DiscountApplyTo["PRODUCTS"] = "products";
 })(DiscountApplyTo || (exports.DiscountApplyTo = DiscountApplyTo = {}));
 var DiscountEligibility;
 (function (DiscountEligibility) {
     DiscountEligibility["EVERYONE"] = "everyone";
-    DiscountEligibility["CUSTOMERS"] = "specific_customers";
+    DiscountEligibility["CUSTOMERS"] = "customers";
 })(DiscountEligibility || (exports.DiscountEligibility = DiscountEligibility = {}));
+var DiscountRequirement;
+(function (DiscountRequirement) {
+    DiscountRequirement["NONE"] = "none";
+    DiscountRequirement["PRICE"] = "price";
+    DiscountRequirement["QUANTITY"] = "quantity";
+})(DiscountRequirement || (exports.DiscountRequirement = DiscountRequirement = {}));
 var DiscountCondition;
 (function (DiscountCondition) {
     DiscountCondition["APPLY_TO"] = "apply_to";

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export * from './inventory';
 export * from './media';
 export * from './order';
 export * from './payment_method';
+export * from './payment_transaction';
 export * from './product_variant';
 export * from './product_tag';
 export * from './product';

package/dist/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./inventory"), exports);
 __exportStar(require("./media"), exports);
 __exportStar(require("./order"), exports);
 __exportStar(require("./payment_method"), exports);
+__exportStar(require("./payment_transaction"), exports);
 __exportStar(require("./product_variant"), exports);
 __exportStar(require("./product_tag"), exports);
 __exportStar(require("./product"), exports);

package/dist/order.d.ts

@@ -5,29 +5,55 @@ import type { Customer } from './customer';
 import type { PaymentMethod } from './payment_method';
 import type { Zone } from './zone';
 export declare enum OrderStatus {
-    ARCHIVED = "archived",
     NEW = "new",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled",
+    ARCHIVED = "archived"
+}
+export declare enum PaymentStatus {
+    PENDING = "pending",
+    AUTHORIZED = "authorized",
+    PAID = "paid",
+    PARTIALLY_REFUNDED = "partially_refunded",
+    REFUNDED = "refunded",
+    VOIDED = "voided"
+}
+export declare enum ShippingStatus {
+    UNFULFILLED = "unfulfilled",
+    PARTIALLY_SHIPPED = "partially_shipped",
     SHIPPED = "shipped",
+    PARTIALLY_DELIVERED = "partially_delivered",
     DELIVERED = "delivered",
+    PARTIALLY_RETURNED = "partially_returned",
+    RETURNED = "returned"
+}
+export declare enum ShipmentStatus {
     PENDING = "pending",
-    PAID = "paid",
-    REGISTER = "registered",
-    COMPLETED = "completed",
-    CANCELLED = "cancelled"
+    PICKED_UP = "picked_up",
+    IN_TRANSIT = "in_transit",
+    AT_SORTING_CENTER = "at_sorting_center",
+    OUT_FOR_DELIVERY = "out_for_delivery",
+    DELIVERED = "delivered",
+    DELIVERY_FAILED = "delivery_failed",
+    RETURNED = "returned"
 }
 export declare enum FulfillmentStatus {
-    UNFULFILLED = "unfulfilled",
-    PARTIALLY_FULFILLED = "partially_fulfilled",
-    FULFILLED = "fulfilled",
+    PENDING = "pending",
+    FORWARDED_TO_SUPPLIER = "forwarded_to_supplier",
+    PROCESSING = "processing",
+    SHIPPED = "shipped",
+    DELIVERED = "delivered",
     CANCELLED = "cancelled"
 }
 export declare enum OrderRefundStatus {
+    AWAITING = "awaiting",
     PENDING = "pending",
     TREATMENT = "treatment",
-    PARTIAL_REFUND = "partial-refund",
+    PARTIAL_REFUND = "partial_refund",
     REFUNDED = "refunded",
-    CANCELLED = "cancelled",
-    REJECTED = "rejected"
+    REJECTED = "rejected",
+    CANCELLED = "cancelled"
 }
 /**
  * Order model.
@@ -45,6 +71,10 @@ export interface Order extends Entity {
     total_amount?: number;
     /** The order status. */
     status: OrderStatus;
+    /** The payment status. */
+    payment_status: PaymentStatus;
+    /** The shipping status. */
+    shipping_status: ShippingStatus;
     /** The date the order was cancelled. */
     cancelled_at: DateEntity | null;
     /** The date the order was archived. */
@@ -156,6 +186,8 @@ export interface OrderAddress extends Entity {
  * OrderShipping model.
  */
 export interface OrderShipping extends Entity {
+    /** The shipment status. */
+    status: ShipmentStatus | null;
     /** The date the order was shipped. */
     shipped_at: DateEntity;
     /** The date the order was received. */
@@ -178,6 +210,34 @@ export interface OrderShipping extends Entity {
     carrier?: import('./carrier').Carrier;
     /** The items in this shipment. */
     items?: OrderItem[];
+    /** The shipment tracking events. */
+    events?: OrderShippingEvent[];
+}
+/**
+ * OrderShippingEvent model.
+ */
+export interface OrderShippingEvent {
+    id: number;
+    /** The event status. */
+    status: ShipmentStatus;
+    /** The description of the event. */
+    description: string | null;
+    /** The location of the event. */
+    location: string | null;
+    /** The latitude of the event. */
+    latitude: number | null;
+    /** The longitude of the event. */
+    longitude: number | null;
+    /** The metadata of the event. */
+    metadata: Metadata;
+    /** The date the event occurred. */
+    occurred_at: DateEntity;
+    /** The creation date. */
+    created_at?: DateEntity;
+    /** The order shipping ID. */
+    order_shipping_id: number;
+    /** The shipment this event belongs to. */
+    shipment?: OrderShipping;
 }
 /**
  * OrderRefund model.

package/dist/order.js

@@ -1,31 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderRefundStatus = exports.FulfillmentStatus = exports.OrderStatus = void 0;
+exports.OrderRefundStatus = exports.FulfillmentStatus = exports.ShipmentStatus = exports.ShippingStatus = exports.PaymentStatus = exports.OrderStatus = void 0;
 var OrderStatus;
 (function (OrderStatus) {
-    OrderStatus["ARCHIVED"] = "archived";
     OrderStatus["NEW"] = "new";
-    OrderStatus["SHIPPED"] = "shipped";
-    OrderStatus["DELIVERED"] = "delivered";
-    OrderStatus["PENDING"] = "pending";
-    OrderStatus["PAID"] = "paid";
-    OrderStatus["REGISTER"] = "registered";
+    OrderStatus["PROCESSING"] = "processing";
     OrderStatus["COMPLETED"] = "completed";
     OrderStatus["CANCELLED"] = "cancelled";
+    OrderStatus["ARCHIVED"] = "archived";
 })(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
+var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus["PENDING"] = "pending";
+    PaymentStatus["AUTHORIZED"] = "authorized";
+    PaymentStatus["PAID"] = "paid";
+    PaymentStatus["PARTIALLY_REFUNDED"] = "partially_refunded";
+    PaymentStatus["REFUNDED"] = "refunded";
+    PaymentStatus["VOIDED"] = "voided";
+})(PaymentStatus || (exports.PaymentStatus = PaymentStatus = {}));
+var ShippingStatus;
+(function (ShippingStatus) {
+    ShippingStatus["UNFULFILLED"] = "unfulfilled";
+    ShippingStatus["PARTIALLY_SHIPPED"] = "partially_shipped";
+    ShippingStatus["SHIPPED"] = "shipped";
+    ShippingStatus["PARTIALLY_DELIVERED"] = "partially_delivered";
+    ShippingStatus["DELIVERED"] = "delivered";
+    ShippingStatus["PARTIALLY_RETURNED"] = "partially_returned";
+    ShippingStatus["RETURNED"] = "returned";
+})(ShippingStatus || (exports.ShippingStatus = ShippingStatus = {}));
+var ShipmentStatus;
+(function (ShipmentStatus) {
+    ShipmentStatus["PENDING"] = "pending";
+    ShipmentStatus["PICKED_UP"] = "picked_up";
+    ShipmentStatus["IN_TRANSIT"] = "in_transit";
+    ShipmentStatus["AT_SORTING_CENTER"] = "at_sorting_center";
+    ShipmentStatus["OUT_FOR_DELIVERY"] = "out_for_delivery";
+    ShipmentStatus["DELIVERED"] = "delivered";
+    ShipmentStatus["DELIVERY_FAILED"] = "delivery_failed";
+    ShipmentStatus["RETURNED"] = "returned";
+})(ShipmentStatus || (exports.ShipmentStatus = ShipmentStatus = {}));
 var FulfillmentStatus;
 (function (FulfillmentStatus) {
-    FulfillmentStatus["UNFULFILLED"] = "unfulfilled";
-    FulfillmentStatus["PARTIALLY_FULFILLED"] = "partially_fulfilled";
-    FulfillmentStatus["FULFILLED"] = "fulfilled";
+    FulfillmentStatus["PENDING"] = "pending";
+    FulfillmentStatus["FORWARDED_TO_SUPPLIER"] = "forwarded_to_supplier";
+    FulfillmentStatus["PROCESSING"] = "processing";
+    FulfillmentStatus["SHIPPED"] = "shipped";
+    FulfillmentStatus["DELIVERED"] = "delivered";
     FulfillmentStatus["CANCELLED"] = "cancelled";
 })(FulfillmentStatus || (exports.FulfillmentStatus = FulfillmentStatus = {}));
 var OrderRefundStatus;
 (function (OrderRefundStatus) {
+    OrderRefundStatus["AWAITING"] = "awaiting";
     OrderRefundStatus["PENDING"] = "pending";
     OrderRefundStatus["TREATMENT"] = "treatment";
-    OrderRefundStatus["PARTIAL_REFUND"] = "partial-refund";
+    OrderRefundStatus["PARTIAL_REFUND"] = "partial_refund";
     OrderRefundStatus["REFUNDED"] = "refunded";
-    OrderRefundStatus["CANCELLED"] = "cancelled";
     OrderRefundStatus["REJECTED"] = "rejected";
+    OrderRefundStatus["CANCELLED"] = "cancelled";
 })(OrderRefundStatus || (exports.OrderRefundStatus = OrderRefundStatus = {}));

package/dist/payment_method.d.ts

@@ -1,4 +1,5 @@
 import type { Entity, Metadata } from './common';
+import type { Media } from './media';
 import type { Zone } from './zone';
 /**
  * PaymentMethod model.
@@ -8,10 +9,6 @@ export interface PaymentMethod extends Entity {
     title: string;
     /** The slug of the payment method. */
     slug: string;
-    /** The logo path of the payment method. */
-    logo: string | null;
-    /** The computed logo URL. */
-    logo_url: string | null;
     /** The link URL of the payment method. */
     link_url: string | null;
     /** The description of the payment method. */
@@ -20,8 +17,12 @@ export interface PaymentMethod extends Entity {
     instructions: string | null;
     /** Whether the payment method is enabled. */
     is_enabled: boolean;
+    /** The payment driver identifier. */
+    driver: string | null;
     /** The metadata of the payment method. */
     metadata: Metadata;
+    /** The logo of the payment method. */
+    logo?: Media | null;
     /** The zones this payment method belongs to. */
     zones?: Zone[];
 }

package/dist/payment_transaction.d.ts

@@ -0,0 +1,46 @@
+import type { Entity, Metadata } from './common';
+import type { Order } from './order';
+import type { PaymentMethod } from './payment_method';
+export declare enum TransactionStatus {
+    PENDING = "pending",
+    SUCCESS = "success",
+    FAILED = "failed"
+}
+export declare enum TransactionType {
+    INITIATE = "initiate",
+    AUTHORIZE = "authorize",
+    CAPTURE = "capture",
+    REFUND = "refund",
+    CANCEL = "cancel"
+}
+/**
+ * PaymentTransaction model.
+ */
+export interface PaymentTransaction extends Entity {
+    /** The payment driver used. */
+    driver: string;
+    /** The transaction type. */
+    type: TransactionType;
+    /** The transaction status. */
+    status: TransactionStatus;
+    /** The transaction amount (in cents). */
+    amount: number;
+    /** The currency code. */
+    currency_code: string;
+    /** The external reference ID. */
+    reference: string | null;
+    /** The transaction data from the provider. */
+    data: Record<string, unknown> | null;
+    /** Additional notes. */
+    notes: string | null;
+    /** The metadata of the transaction. */
+    metadata: Metadata;
+    /** The order ID. */
+    order_id: number | null;
+    /** The payment method ID. */
+    payment_method_id: number | null;
+    /** The order. */
+    order?: Order;
+    /** The payment method. */
+    paymentMethod?: PaymentMethod;
+}

package/dist/payment_transaction.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionType = exports.TransactionStatus = void 0;
+var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus["PENDING"] = "pending";
+    TransactionStatus["SUCCESS"] = "success";
+    TransactionStatus["FAILED"] = "failed";
+})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
+var TransactionType;
+(function (TransactionType) {
+    TransactionType["INITIATE"] = "initiate";
+    TransactionType["AUTHORIZE"] = "authorize";
+    TransactionType["CAPTURE"] = "capture";
+    TransactionType["REFUND"] = "refund";
+    TransactionType["CANCEL"] = "cancel";
+})(TransactionType || (exports.TransactionType = TransactionType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopperlabs/shopper-types",
-  "version": "2.4.3",
+  "version": "2.5.0",
   "description": "TypeScript types for Laravel Shopper",
   "author": "Arthur Monney <monneylobe@gmail.com> (https://arthurmonney.me)",
   "main": "dist/index.js",