@shopperlabs/shopper-types 1.0.0

package/dist/discount.d.ts

@@ -0,0 +1,70 @@
+import type { DateEntity, Entity, Metadata } from './common';
+import type { Zone } from './zone';
+export declare enum DiscountType {
+    PERCENTAGE = "percentage",
+    FIXED_AMOUNT = "fixed_amount"
+}
+export declare enum DiscountApplyTo {
+    ORDER = "order",
+    SPECIFIC = "specific"
+}
+export declare enum DiscountEligibility {
+    EVERYONE = "everyone",
+    CUSTOMERS = "specific_customers"
+}
+export declare enum DiscountCondition {
+    APPLY_TO = "apply_to",
+    ELIGIBILITY = "eligibility"
+}
+/**
+ * Discount model.
+ */
+export interface Discount extends Entity {
+    /** The discount code. */
+    code: string;
+    /** The type of discount. */
+    type: DiscountType;
+    /** The value of the discount. */
+    value: number;
+    /** What the discount applies to. */
+    apply_to: DiscountApplyTo;
+    /** Who is eligible for this discount. */
+    eligibility: DiscountEligibility;
+    /** The usage limit for the discount. */
+    usage_limit: number | null;
+    /** The total number of times the discount has been used. */
+    total_use: number;
+    /** Whether the discount has a per-user usage limit. */
+    usage_limit_per_user: boolean;
+    /** Whether the discount is active. */
+    is_active: boolean;
+    /** The zone ID this discount belongs to. */
+    zone_id: number | null;
+    /** The metadata of the discount. */
+    metadata: Metadata;
+    /** The start date of the discount. */
+    start_at: DateEntity;
+    /** The end date of the discount. */
+    end_at: DateEntity | null;
+    /** The zone of the discount. */
+    zone?: Zone;
+    /** The discount items/details. */
+    items?: DiscountDetail[];
+}
+/**
+ * DiscountDetail model (discountables).
+ */
+export interface DiscountDetail extends Entity {
+    /** The condition type for this detail. */
+    condition: DiscountCondition;
+    /** The type of the discountable entity. */
+    discountable_type: string;
+    /** The ID of the discountable entity. */
+    discountable_id: number;
+    /** The discount ID this detail belongs to. */
+    discount_id: number;
+    /** The total usage of this detail. */
+    total_use: number;
+    /** The discount this detail belongs to. */
+    discount?: Discount;
+}

package/dist/discount.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiscountCondition = exports.DiscountEligibility = exports.DiscountApplyTo = exports.DiscountType = void 0;
+var DiscountType;
+(function (DiscountType) {
+    DiscountType["PERCENTAGE"] = "percentage";
+    DiscountType["FIXED_AMOUNT"] = "fixed_amount";
+})(DiscountType || (exports.DiscountType = DiscountType = {}));
+var DiscountApplyTo;
+(function (DiscountApplyTo) {
+    DiscountApplyTo["ORDER"] = "order";
+    DiscountApplyTo["SPECIFIC"] = "specific";
+})(DiscountApplyTo || (exports.DiscountApplyTo = DiscountApplyTo = {}));
+var DiscountEligibility;
+(function (DiscountEligibility) {
+    DiscountEligibility["EVERYONE"] = "everyone";
+    DiscountEligibility["CUSTOMERS"] = "specific_customers";
+})(DiscountEligibility || (exports.DiscountEligibility = DiscountEligibility = {}));
+var DiscountCondition;
+(function (DiscountCondition) {
+    DiscountCondition["APPLY_TO"] = "apply_to";
+    DiscountCondition["ELIGIBILITY"] = "eligibility";
+})(DiscountCondition || (exports.DiscountCondition = DiscountCondition = {}));

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+export * from './address';
+export * from './attribute';
+export * from './brand';
+export * from './carrier';
+export * from './category';
+export * from './channel';
+export * from './collection';
+export * from './common';
+export * from './country';
+export * from './currency';
+export * from './customer';
+export * from './discount';
+export * from './inventory';
+export * from './media';
+export * from './order';
+export * from './payment_method';
+export * from './product_variant';
+export * from './product';
+export * from './review';
+export * from './supplier';
+export * from './zone';

package/dist/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./address"), exports);
+__exportStar(require("./attribute"), exports);
+__exportStar(require("./brand"), exports);
+__exportStar(require("./carrier"), exports);
+__exportStar(require("./category"), exports);
+__exportStar(require("./channel"), exports);
+__exportStar(require("./collection"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./country"), exports);
+__exportStar(require("./currency"), exports);
+__exportStar(require("./customer"), exports);
+__exportStar(require("./discount"), exports);
+__exportStar(require("./inventory"), exports);
+__exportStar(require("./media"), exports);
+__exportStar(require("./order"), exports);
+__exportStar(require("./payment_method"), exports);
+__exportStar(require("./product_variant"), exports);
+__exportStar(require("./product"), exports);
+__exportStar(require("./review"), exports);
+__exportStar(require("./supplier"), exports);
+__exportStar(require("./zone"), exports);

package/dist/inventory.d.ts

@@ -0,0 +1,64 @@
+import type { Entity } from './common';
+import type { Country } from './country';
+/**
+ * Inventory (warehouse/location) model.
+ */
+export interface Inventory extends Entity {
+    /** The name of the inventory location. */
+    name: string;
+    /** The code of the inventory location. */
+    code: string;
+    /** The email of the inventory location. */
+    email: string;
+    /** The city of the inventory location. */
+    city: string;
+    /** The state/province of the inventory location. */
+    state: string | null;
+    /** The description of the inventory location. */
+    description: string | null;
+    /** The street address of the inventory location. */
+    street_address: string | null;
+    /** The additional street address. */
+    street_address_plus: string | null;
+    /** The postal code of the inventory location. */
+    postal_code: string;
+    /** The phone number of the inventory location. */
+    phone_number: string | null;
+    /** Whether this is the default inventory location. */
+    is_default: boolean;
+    /** The country ID of the inventory location. */
+    country_id: number;
+    /** The country of the inventory location. */
+    country?: Country;
+    /** The inventory histories. */
+    histories?: InventoryHistory[];
+}
+/**
+ * InventoryHistory model.
+ */
+export interface InventoryHistory extends Entity {
+    /** The new quantity after the adjustment. */
+    quantity: number;
+    /** The old quantity before the adjustment. */
+    old_quantity: number | null;
+    /** The event that triggered this history entry. */
+    event: string | null;
+    /** The description of the history entry. */
+    description: string | null;
+    /** The user ID who made the adjustment. */
+    user_id: number;
+    /** The inventory ID. */
+    inventory_id: number;
+    /** The ID of the stockable entity. */
+    stockable_id: number;
+    /** The type of the stockable entity. */
+    stockable_type: string;
+    /** The ID of the reference entity. */
+    reference_id?: number | null;
+    /** The type of the reference entity. */
+    reference_type?: string | null;
+    /** The computed adjustment display. */
+    adjustment?: string | number;
+    /** The inventory location. */
+    inventory?: Inventory;
+}

package/dist/inventory.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/media.d.ts

@@ -0,0 +1,6 @@
+export interface Media {
+    id: string | number;
+    url: string;
+    created_at: string;
+    updated_at: string;
+}

package/dist/media.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/order.d.ts

@@ -0,0 +1,198 @@
+import type { CarrierOption } from './carrier';
+import type { Channel } from './channel';
+import type { DateEntity, Entity } from './common';
+import type { Customer } from './customer';
+import type { PaymentMethod } from './payment_method';
+import type { Zone } from './zone';
+export declare enum OrderStatus {
+    PENDING = "pending",
+    NEW = "new",
+    REGISTER = "register",
+    PAID = "paid",
+    COMPLETED = "completed",
+    SHIPPED = "shipped",
+    CANCELLED = "cancelled"
+}
+export declare enum FulfillmentStatus {
+    UNFULFILLED = "unfulfilled",
+    PARTIALLY_FULFILLED = "partially_fulfilled",
+    FULFILLED = "fulfilled",
+    CANCELLED = "cancelled"
+}
+export declare enum OrderRefundStatus {
+    PENDING = "pending",
+    TREATMENT = "treatment",
+    PARTIAL_REFUND = "partial-refund",
+    REFUNDED = "refunded",
+    CANCELLED = "cancelled",
+    REJECTED = "rejected"
+}
+/**
+ * Order model.
+ */
+export interface Order extends Entity {
+    /** The order number. */
+    number: string;
+    /** The total price amount (in cents). */
+    price_amount: number;
+    /** The notes for the order. */
+    notes: string | null;
+    /** The currency code for the order. */
+    currency_code: string;
+    /** The computed total amount. */
+    total_amount?: number;
+    /** The order status. */
+    status: OrderStatus;
+    /** The date the order was cancelled. */
+    canceled_at: DateEntity | null;
+    /** The date the order was archived. */
+    archived_at: DateEntity | null;
+    /** The zone ID. */
+    zone_id: number | null;
+    /** The shipping address ID. */
+    shipping_address_id: number | null;
+    /** The billing address ID. */
+    billing_address_id: number | null;
+    /** The payment method ID. */
+    payment_method_id: number | null;
+    /** The customer ID. */
+    customer_id: number | null;
+    /** The channel ID. */
+    channel_id: number | null;
+    /** The parent order ID (for split orders). */
+    parent_order_id: number | null;
+    /** The shipping option ID. */
+    shipping_option_id?: number | null;
+    /** The shipping option. */
+    shippingOption?: CarrierOption;
+    /** The shipping address. */
+    shippingAddress?: OrderAddress | null;
+    /** The billing address. */
+    billingAddress?: OrderAddress | null;
+    /** The payment method. */
+    paymentMethod?: PaymentMethod | null;
+    /** The zone. */
+    zone?: Zone | null;
+    /** The channel. */
+    channel?: Channel | null;
+    /** The parent order. */
+    parent?: Order | null;
+    /** The customer. */
+    customer?: Customer;
+    /** The order items. */
+    items?: OrderItem[];
+    /** The order shippings. */
+    shippings?: OrderShipping[];
+    /** The child orders (for split orders). */
+    children?: Order[];
+    /** The refund for the order. */
+    refund?: OrderRefund;
+}
+/**
+ * OrderItem model.
+ */
+export interface OrderItem extends Entity {
+    /** The name of the order item. */
+    name: string;
+    /** The quantity of the order item. */
+    quantity: number;
+    /** The unit price amount. */
+    unit_price_amount: number | null;
+    /** The computed total (unit_price_amount * quantity). */
+    total: number;
+    /** The SKU of the order item. */
+    sku: string | null;
+    /** The product ID. */
+    product_id: number;
+    /** The product type (morph type). */
+    product_type: string;
+    /** The order ID. */
+    order_id: number;
+    /** The order shipping ID. */
+    order_shipping_id: number | null;
+    /** The fulfillment status. */
+    fulfillment_status: FulfillmentStatus | null;
+    /** The order. */
+    order?: Order;
+    /** The shipment. */
+    shipment?: OrderShipping;
+}
+/**
+ * OrderAddress model.
+ */
+export interface OrderAddress extends Entity {
+    /** The first name. */
+    first_name: string;
+    /** The last name. */
+    last_name: string;
+    /** The computed full name. */
+    full_name: string;
+    /** The street address. */
+    street_address: string;
+    /** The additional street address. */
+    street_address_plus: string | null;
+    /** The postal code. */
+    postal_code: string;
+    /** The city. */
+    city: string;
+    /** The state/province. */
+    state: string | null;
+    /** The company name. */
+    company: string | null;
+    /** The phone number. */
+    phone: string | null;
+    /** The country name. */
+    country_name: string | null;
+    /** The customer ID. */
+    customer_id?: number | null;
+    /** The customer. */
+    customer?: Customer;
+}
+/**
+ * OrderShipping model.
+ */
+export interface OrderShipping extends Entity {
+    /** The date the order was shipped. */
+    shipped_at: DateEntity;
+    /** The date the order was received. */
+    received_at: DateEntity | null;
+    /** The date the order was returned. */
+    returned_at: DateEntity | null;
+    /** The tracking number. */
+    tracking_number: string | null;
+    /** The tracking URL. */
+    tracking_url: string | null;
+    /** The shipping voucher data. */
+    voucher: Record<string, unknown> | null;
+    /** The order ID. */
+    order_id: number;
+    /** The carrier ID. */
+    carrier_id: number | null;
+    /** The order. */
+    order?: Order;
+    /** The carrier. */
+    carrier?: import('./carrier').Carrier;
+    /** The items in this shipment. */
+    items?: OrderItem[];
+}
+/**
+ * OrderRefund model.
+ */
+export interface OrderRefund extends Entity {
+    /** The reason for the refund. */
+    refund_reason: string | null;
+    /** The refund amount (in cents). */
+    refund_amount: number | null;
+    /** The refund status. */
+    status: OrderRefundStatus;
+    /** Additional notes. */
+    notes: string | null;
+    /** The currency code. */
+    currency: string;
+    /** The order ID. */
+    order_id: number;
+    /** The user ID who processed the refund. */
+    user_id: number | null;
+    /** The order. */
+    order?: Order;
+}

package/dist/order.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderRefundStatus = exports.FulfillmentStatus = exports.OrderStatus = void 0;
+var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["PENDING"] = "pending";
+    OrderStatus["NEW"] = "new";
+    OrderStatus["REGISTER"] = "register";
+    OrderStatus["PAID"] = "paid";
+    OrderStatus["COMPLETED"] = "completed";
+    OrderStatus["SHIPPED"] = "shipped";
+    OrderStatus["CANCELLED"] = "cancelled";
+})(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
+var FulfillmentStatus;
+(function (FulfillmentStatus) {
+    FulfillmentStatus["UNFULFILLED"] = "unfulfilled";
+    FulfillmentStatus["PARTIALLY_FULFILLED"] = "partially_fulfilled";
+    FulfillmentStatus["FULFILLED"] = "fulfilled";
+    FulfillmentStatus["CANCELLED"] = "cancelled";
+})(FulfillmentStatus || (exports.FulfillmentStatus = FulfillmentStatus = {}));
+var OrderRefundStatus;
+(function (OrderRefundStatus) {
+    OrderRefundStatus["PENDING"] = "pending";
+    OrderRefundStatus["TREATMENT"] = "treatment";
+    OrderRefundStatus["PARTIAL_REFUND"] = "partial-refund";
+    OrderRefundStatus["REFUNDED"] = "refunded";
+    OrderRefundStatus["CANCELLED"] = "cancelled";
+    OrderRefundStatus["REJECTED"] = "rejected";
+})(OrderRefundStatus || (exports.OrderRefundStatus = OrderRefundStatus = {}));

package/dist/payment_method.d.ts

@@ -0,0 +1,25 @@
+import type { Entity } from './common';
+import type { Zone } from './zone';
+/**
+ * PaymentMethod model.
+ */
+export interface PaymentMethod extends Entity {
+    /** The title of the payment method. */
+    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. */
+    description: string | null;
+    /** The instructions for the payment method. */
+    instructions: string | null;
+    /** Whether the payment method is enabled. */
+    is_enabled: boolean;
+    /** The zones this payment method belongs to. */
+    zones?: Zone[];
+}

package/dist/payment_method.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/product.d.ts

@@ -0,0 +1,75 @@
+import type { Attribute } from './attribute';
+import type { Brand } from './brand';
+import type { Category } from './category';
+import type { Channel } from './channel';
+import type { Collection } from './collection';
+import type { DateEntity, Entity, Metadata, Price, SEOFields, ShippingFields } from './common';
+import type { Media } from './media';
+import type { ProductVariant } from './product_variant';
+import type { Review } from './review';
+import type { Supplier } from './supplier';
+export declare enum ProductType {
+    EXTERNAL = "external",
+    VIRTUAL = "virtual",
+    STANDARD = "standard",
+    VARIANT = "variant"
+}
+/**
+ * Product model.
+ */
+export interface Product extends Entity, SEOFields, ShippingFields {
+    /** The name of the product. */
+    name: string;
+    /** The slug of the product. */
+    slug: string;
+    /** The Stock Keeping Unit (SKU) code of the product. */
+    sku?: string | null;
+    /** The barcode of the product. */
+    barcode: string | null;
+    /** The description of the product. */
+    description: string | null;
+    /** The security stock of the product. */
+    security_stock: number | null;
+    /** Whether the product is featured. */
+    featured: boolean;
+    /** Whether the product is visible. */
+    is_visible: boolean;
+    /** The type of the product. */
+    type: ProductType | null;
+    /** The published at date of the product. */
+    published_at: DateEntity | null;
+    /** The external ID of the product. */
+    external_id: string | null;
+    /** The stock quantity of the product. */
+    stock: number;
+    /** The combined stock of all variants. */
+    variants_stock?: number;
+    /** The supplier ID of the product. */
+    supplier_id?: number | null;
+    /** The brand ID of the product. */
+    brand_id: number | null;
+    /** The metadata of the product. */
+    metadata: Metadata;
+    /** The supplier of the product. */
+    supplier?: Supplier;
+    /** The brand of the product. */
+    brand?: Brand;
+    /** The channels of the product. */
+    channels?: Channel[];
+    /** The categories of the product. */
+    categories?: Category[];
+    /** The options/attributes of the product. */
+    options?: Attribute[];
+    /** The collections of the product. */
+    collections?: Collection[];
+    /** The variants of the product. */
+    variants?: ProductVariant[];
+    /** The related products. */
+    relatedProducts?: Product[];
+    /** The images of the product. */
+    images?: Media[] | null;
+    /** The reviews of the product. */
+    reviews?: Review[];
+    /** The prices of the product. */
+    prices?: Price[];
+}

package/dist/product.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductType = void 0;
+var ProductType;
+(function (ProductType) {
+    ProductType["EXTERNAL"] = "external";
+    ProductType["VIRTUAL"] = "virtual";
+    ProductType["STANDARD"] = "standard";
+    ProductType["VARIANT"] = "variant";
+})(ProductType || (exports.ProductType = ProductType = {}));

package/dist/product_variant.d.ts

@@ -0,0 +1,37 @@
+import type { AttributeValue } from './attribute';
+import type { Entity, Metadata, Price, ShippingFields } from './common';
+import type { Media } from './media';
+import type { Product } from './product';
+/**
+ * ProductVariant model.
+ */
+export interface ProductVariant extends Entity, ShippingFields {
+    /** The name of the product variant. */
+    name: string;
+    /** The Stock Keeping Unit (SKU) code of the product variant. */
+    sku?: string | null;
+    /** The barcode of the product variant. */
+    barcode: string | null;
+    /** The EAN code of the product variant. */
+    ean: string | null;
+    /** The UPC code of the product variant. */
+    upc: string | null;
+    /** The position of the product variant. */
+    position: number;
+    /** Whether backorders are allowed. */
+    allow_backorder: boolean;
+    /** The product ID this variant belongs to. */
+    product_id: number;
+    /** The stock quantity of the variant. */
+    stock: number;
+    /** The metadata of the product variant. */
+    metadata: Metadata;
+    /** The product this variant belongs to. */
+    product?: Product;
+    /** The attribute values of this variant. */
+    values?: AttributeValue[];
+    /** The images of the product variant. */
+    images?: Media[] | null;
+    /** The prices of the product variant. */
+    prices?: Price[];
+}

package/dist/product_variant.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/review.d.ts

@@ -0,0 +1,35 @@
+import type { Entity } from './common';
+import type { AvatarType } from './customer';
+/**
+ * Review model.
+ */
+export interface Review extends Entity {
+    /** Whether the review is recommended. */
+    is_recommended: boolean;
+    /** The rating (usually 1-5). */
+    rating: number;
+    /** The title of the review. */
+    title: string | null;
+    /** The content of the review. */
+    content: string | null;
+    /** Whether the review is approved. */
+    approved: boolean;
+    /** The ID of the reviewable entity. */
+    reviewrateable_id: number;
+    /** The type of the reviewable entity. */
+    reviewrateable_type: string;
+    /** The ID of the author. */
+    author_id: number;
+    /** The type of the author. */
+    author_type: string;
+    /** The author of the review. */
+    author?: ReviewAuthor;
+}
+/**
+ * ReviewAuthor type for author information.
+ */
+export type ReviewAuthor = {
+    last_name: string;
+    first_name: string;
+    avatar: AvatarType;
+};

package/dist/review.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });