@shopperlabs/shopper-types 2.2.6 → 2.3.0

package/dist/address.d.ts

@@ -1,4 +1,4 @@
-import type { Entity } from './common';
+import type { Entity, Metadata } from './common';
 import type { Country } from './country';
 export declare enum AddressType {
     BILLING = "billing",
@@ -30,6 +30,8 @@ export interface Address extends Entity {
     phone_number?: string | null;
     /** The type of the customer address. */
     type: AddressType;
+    /** The metadata of the address. */
+    metadata: Metadata;
     /** Whether this is the default shipping address. */
     shipping_default: boolean;
     /** Whether this is the default billing address. */

package/dist/carrier.d.ts

@@ -34,6 +34,8 @@ export interface Carrier extends Entity {
 export interface CarrierOption extends Entity {
     /** The name of the carrier option. */
     name: string;
+    /** The description of the carrier option. */
+    description: string | null;
     /** The price of the carrier option (in cents). */
     price: number;
     /** Whether the carrier option is enabled. */

package/dist/category.d.ts

@@ -1,9 +1,10 @@
-import type { Entity, Metadata } from './common';
+import type { Entity, Metadata, SEOFields } from './common';
 import type { Media } from './media';
+import type { Product } from './product';
 /**
  * Category model.
  */
-export interface Category extends Entity {
+export interface Category extends Entity, SEOFields {
     /** The name of the category. */
     name: string;
     /** The slug of the category. */
@@ -12,6 +13,8 @@ export interface Category extends Entity {
     description: string | null;
     /** Whether the category is enabled. */
     is_enabled: boolean;
+    /** The position of the category. */
+    position: number;
     /** The id of the parent category. */
     parent_id: number | null;
     /** The metadata of the category. */
@@ -22,6 +25,8 @@ export interface Category extends Entity {
     parent?: Category;
     /** The children categories. */
     children?: Category[];
+    /** The products of the category. */
+    products?: Product[];
     /** The slug path of the category. */
     slug_path?: string;
 }

package/dist/channel.d.ts

@@ -1,4 +1,5 @@
 import type { Entity, Metadata } from './common';
+import type { Product } from './product';
 /**
  * Channel model.
  */
@@ -19,4 +20,6 @@ export interface Channel extends Entity {
     is_enabled: boolean;
     /** The metadata of the channel. */
     metadata: Metadata;
+    /** The products of the channel. */
+    products?: Product[];
 }

package/dist/collection.d.ts

@@ -1,5 +1,6 @@
 import type { DateEntity, Entity, Metadata, SEOFields } from './common';
 import type { Media } from './media';
+import type { Product } from './product';
 import type { Zone } from './zone';
 export declare enum CollectionType {
     MANUAL = "manual",
@@ -11,15 +12,19 @@ export declare enum CollectionCondition {
 }
 export declare enum CollectionRuleType {
     PRODUCT_TITLE = "product_title",
+    PRODUCT_BRAND = "product_brand",
+    PRODUCT_CATEGORY = "product_category",
     PRODUCT_PRICE = "product_price",
     COMPARE_AT_PRICE = "compare_at_price",
     INVENTORY_STOCK = "inventory_stock",
-    PRODUCT_CATEGORY = "product_category",
-    PRODUCT_BRAND = "product_brand"
+    PRODUCT_CREATED_AT = "product_created_at",
+    PRODUCT_FEATURED = "product_featured",
+    PRODUCT_RATING = "product_rating",
+    PRODUCT_SALES_COUNT = "product_sales_count"
 }
 export declare enum CollectionOperator {
-    EQUALS = "equals",
-    NOT_EQUALS = "not_equals",
+    EQUALS_TO = "equals_to",
+    NOT_EQUAL_TO = "not_equal_to",
     LESS_THAN = "less_than",
     GREATER_THAN = "greater_than",
     STARTS_WITH = "starts_with",
@@ -53,6 +58,8 @@ export interface Collection extends Entity, SEOFields {
     rules?: CollectionRule[];
     /** The zones this collection belongs to. */
     zones?: Zone[];
+    /** The products of the collection. */
+    products?: Product[];
 }
 /**
  * CollectionRule model.

package/dist/collection.js

@@ -14,16 +14,20 @@ var CollectionCondition;
 var CollectionRuleType;
 (function (CollectionRuleType) {
     CollectionRuleType["PRODUCT_TITLE"] = "product_title";
+    CollectionRuleType["PRODUCT_BRAND"] = "product_brand";
+    CollectionRuleType["PRODUCT_CATEGORY"] = "product_category";
     CollectionRuleType["PRODUCT_PRICE"] = "product_price";
     CollectionRuleType["COMPARE_AT_PRICE"] = "compare_at_price";
     CollectionRuleType["INVENTORY_STOCK"] = "inventory_stock";
-    CollectionRuleType["PRODUCT_CATEGORY"] = "product_category";
-    CollectionRuleType["PRODUCT_BRAND"] = "product_brand";
+    CollectionRuleType["PRODUCT_CREATED_AT"] = "product_created_at";
+    CollectionRuleType["PRODUCT_FEATURED"] = "product_featured";
+    CollectionRuleType["PRODUCT_RATING"] = "product_rating";
+    CollectionRuleType["PRODUCT_SALES_COUNT"] = "product_sales_count";
 })(CollectionRuleType || (exports.CollectionRuleType = CollectionRuleType = {}));
 var CollectionOperator;
 (function (CollectionOperator) {
-    CollectionOperator["EQUALS"] = "equals";
-    CollectionOperator["NOT_EQUALS"] = "not_equals";
+    CollectionOperator["EQUALS_TO"] = "equals_to";
+    CollectionOperator["NOT_EQUAL_TO"] = "not_equal_to";
     CollectionOperator["LESS_THAN"] = "less_than";
     CollectionOperator["GREATER_THAN"] = "greater_than";
     CollectionOperator["STARTS_WITH"] = "starts_with";

package/dist/common.d.ts

@@ -35,8 +35,8 @@ export interface Entity {
  */
 export interface DateEntity {
     /** The date format of the entity. */
-    date: Date;
-    /** The human readable date. Eg: 2 hours ago. */
+    date: string;
+    /** The human-readable date. Eg: 2 hours ago. */
     human: string;
 }
 /**
@@ -54,7 +54,7 @@ export interface Price {
     /** The currency_code for the entity. */
     currency_code: string;
     /** The currency for the entity. */
-    currency?: Currency;
+    currency: Currency;
 }
 /**
  * ShippingFields interface for shipping entity.

package/dist/currency.d.ts

@@ -1,3 +1,4 @@
+import type { Zone } from './zone';
 /**
  * Currency model.
  */
@@ -15,4 +16,6 @@ export interface Currency {
     exchange_rate: number;
     /** Whether the currency is enabled. */
     is_enabled: boolean;
+    /** The zone using this currency. */
+    zone?: Zone;
 }

package/dist/customer.d.ts

@@ -29,7 +29,7 @@ export interface Customer extends Entity {
     gender: GenderType | null;
     /** The phone number of the customer. */
     phone_number: string | null;
-    /** The birth date of the customer. */
+    /** The birthdate of the customer. */
     birth_date: Date | null;
     /** The date the email was verified. */
     email_verified_at: Date | null;

package/dist/discount.d.ts

@@ -28,6 +28,10 @@ export interface Discount extends Entity {
     value: number;
     /** What the discount applies to. */
     apply_to: DiscountApplyTo;
+    /** The minimum required type. */
+    min_required: string;
+    /** The minimum required value. */
+    min_required_value: string | null;
     /** Who is eligible for this discount. */
     eligibility: DiscountEligibility;
     /** The usage limit for the discount. */

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export * from './media';
 export * from './order';
 export * from './payment_method';
 export * from './product_variant';
+export * from './product_tag';
 export * from './product';
 export * from './review';
 export * from './supplier';

package/dist/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./media"), exports);
 __exportStar(require("./order"), exports);
 __exportStar(require("./payment_method"), exports);
 __exportStar(require("./product_variant"), exports);
+__exportStar(require("./product_tag"), exports);
 __exportStar(require("./product"), exports);
 __exportStar(require("./review"), exports);
 __exportStar(require("./supplier"), exports);

package/dist/inventory.d.ts

@@ -26,6 +26,12 @@ export interface Inventory extends Entity {
     phone_number: string | null;
     /** Whether this is the default inventory location. */
     is_default: boolean;
+    /** The priority of the inventory location. */
+    priority: number;
+    /** The latitude of the inventory location. */
+    latitude: number;
+    /** The longitude of the inventory location. */
+    longitude: number;
     /** The country ID of the inventory location. */
     country_id: number;
     /** The country of the inventory location. */

package/dist/media.d.ts

@@ -1,6 +1,8 @@
 export interface Media {
     id: string | number;
     url: string;
-    created_at: string;
-    updated_at: string;
+    name?: string | null;
+    extension?: string | null;
+    created_at?: string;
+    updated_at?: string;
 }

package/dist/order.d.ts

@@ -1,16 +1,18 @@
 import type { CarrierOption } from './carrier';
 import type { Channel } from './channel';
-import type { DateEntity, Entity } from './common';
+import type { DateEntity, Entity, Metadata } from './common';
 import type { Customer } from './customer';
 import type { PaymentMethod } from './payment_method';
 import type { Zone } from './zone';
 export declare enum OrderStatus {
-    PENDING = "pending",
+    ARCHIVED = "archived",
     NEW = "new",
-    REGISTER = "register",
+    SHIPPED = "shipped",
+    DELIVERED = "delivered",
+    PENDING = "pending",
     PAID = "paid",
+    REGISTER = "registered",
     COMPLETED = "completed",
-    SHIPPED = "shipped",
     CANCELLED = "cancelled"
 }
 export declare enum FulfillmentStatus {
@@ -44,7 +46,7 @@ export interface Order extends Entity {
     /** The order status. */
     status: OrderStatus;
     /** The date the order was cancelled. */
-    canceled_at: DateEntity | null;
+    cancelled_at: DateEntity | null;
     /** The date the order was archived. */
     archived_at: DateEntity | null;
     /** The zone ID. */
@@ -61,6 +63,8 @@ export interface Order extends Entity {
     channel_id: number | null;
     /** The parent order ID (for split orders). */
     parent_order_id: number | null;
+    /** The metadata of the order. */
+    metadata: Metadata;
     /** The shipping option ID. */
     shipping_option_id?: number | null;
     /** The shipping option. */
@@ -193,6 +197,8 @@ export interface OrderRefund extends Entity {
     order_id: number;
     /** The user ID who processed the refund. */
     user_id: number | null;
+    /** The metadata of the refund. */
+    metadata: Metadata;
     /** The order. */
     order?: Order;
 }

package/dist/order.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderRefundStatus = exports.FulfillmentStatus = exports.OrderStatus = void 0;
 var OrderStatus;
 (function (OrderStatus) {
-    OrderStatus["PENDING"] = "pending";
+    OrderStatus["ARCHIVED"] = "archived";
     OrderStatus["NEW"] = "new";
-    OrderStatus["REGISTER"] = "register";
+    OrderStatus["SHIPPED"] = "shipped";
+    OrderStatus["DELIVERED"] = "delivered";
+    OrderStatus["PENDING"] = "pending";
     OrderStatus["PAID"] = "paid";
+    OrderStatus["REGISTER"] = "registered";
     OrderStatus["COMPLETED"] = "completed";
-    OrderStatus["SHIPPED"] = "shipped";
     OrderStatus["CANCELLED"] = "cancelled";
 })(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
 var FulfillmentStatus;

package/dist/payment_method.d.ts

@@ -1,4 +1,4 @@
-import type { Entity } from './common';
+import type { Entity, Metadata } from './common';
 import type { Zone } from './zone';
 /**
  * PaymentMethod model.
@@ -20,6 +20,8 @@ export interface PaymentMethod extends Entity {
     instructions: string | null;
     /** Whether the payment method is enabled. */
     is_enabled: boolean;
+    /** The metadata of the payment method. */
+    metadata: Metadata;
     /** The zones this payment method belongs to. */
     zones?: Zone[];
 }

package/dist/product.d.ts

@@ -5,6 +5,7 @@ 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 { ProductTag } from './product_tag';
 import type { ProductVariant } from './product_variant';
 import type { Review } from './review';
 import type { Supplier } from './supplier';
@@ -26,6 +27,8 @@ export interface Product extends Entity, SEOFields, ShippingFields {
     sku?: string | null;
     /** The barcode of the product. */
     barcode: string | null;
+    /** The summary of the product. */
+    summary: string | null;
     /** The description of the product. */
     description: string | null;
     /** The security stock of the product. */
@@ -62,6 +65,8 @@ export interface Product extends Entity, SEOFields, ShippingFields {
     options?: Attribute[];
     /** The collections of the product. */
     collections?: Collection[];
+    /** The tags of the product. */
+    tags?: ProductTag[];
     /** The variants of the product. */
     variants?: ProductVariant[];
     /** The related products. */

package/dist/product_tag.d.ts

@@ -0,0 +1,13 @@
+import type { Entity } from './common';
+import type { Product } from './product';
+/**
+ * ProductTag model.
+ */
+export interface ProductTag extends Entity {
+    /** The name of the tag. */
+    name: string;
+    /** The slug of the tag. */
+    slug: string | null;
+    /** The products associated with this tag. */
+    products?: Product[];
+}

package/dist/product_tag.js

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

package/package.json

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