@instockng/api-client 1.0.34 → 1.0.36

package/dist/fetchers/carts.d.ts

@@ -12,19 +12,19 @@
 export declare function fetchCart(cartId: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -44,9 +44,10 @@ export declare function fetchCart(cartId: string): Promise<{
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -55,14 +56,12 @@ export declare function fetchCart(cartId: string): Promise<{
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -70,8 +69,8 @@ export declare function fetchCart(cartId: string): Promise<{
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -511,16 +510,18 @@ export declare function fetchCart(cartId: string): Promise<{
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -563,19 +564,19 @@ export declare function fetchCart(cartId: string): Promise<{
 export declare function createCart(brandSlug: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -595,9 +596,10 @@ export declare function createCart(brandSlug: string): Promise<{
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -606,14 +608,12 @@ export declare function createCart(brandSlug: string): Promise<{
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -621,8 +621,8 @@ export declare function createCart(brandSlug: string): Promise<{
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -1062,16 +1062,18 @@ export declare function createCart(brandSlug: string): Promise<{
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -1117,19 +1119,19 @@ export declare function updateCart(cartId: string, data: {
 }): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -1149,9 +1151,10 @@ export declare function updateCart(cartId: string, data: {
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -1160,14 +1163,12 @@ export declare function updateCart(cartId: string, data: {
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -1175,8 +1176,8 @@ export declare function updateCart(cartId: string, data: {
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -1616,16 +1617,18 @@ export declare function updateCart(cartId: string, data: {
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -1674,19 +1677,19 @@ export declare function updateCart(cartId: string, data: {
 export declare function addCartItem(cartId: string, sku: string, quantity: number, fbc?: string, fbp?: string, ttp?: string, ttclid?: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -1706,9 +1709,10 @@ export declare function addCartItem(cartId: string, sku: string, quantity: numbe
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -1717,14 +1721,12 @@ export declare function addCartItem(cartId: string, sku: string, quantity: numbe
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -1732,8 +1734,8 @@ export declare function addCartItem(cartId: string, sku: string, quantity: numbe
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -2173,16 +2175,18 @@ export declare function addCartItem(cartId: string, sku: string, quantity: numbe
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -2227,19 +2231,19 @@ export declare function addCartItem(cartId: string, sku: string, quantity: numbe
 export declare function updateCartItem(cartId: string, itemId: string, quantity: number): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -2259,9 +2263,10 @@ export declare function updateCartItem(cartId: string, itemId: string, quantity:
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -2270,14 +2275,12 @@ export declare function updateCartItem(cartId: string, itemId: string, quantity:
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -2285,8 +2288,8 @@ export declare function updateCartItem(cartId: string, itemId: string, quantity:
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -2726,16 +2729,18 @@ export declare function updateCartItem(cartId: string, itemId: string, quantity:
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -2774,19 +2779,19 @@ export declare function updateCartItem(cartId: string, itemId: string, quantity:
 export declare function removeCartItem(cartId: string, itemId: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -2806,9 +2811,10 @@ export declare function removeCartItem(cartId: string, itemId: string): Promise<
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -2817,14 +2823,12 @@ export declare function removeCartItem(cartId: string, itemId: string): Promise<
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -2832,8 +2836,8 @@ export declare function removeCartItem(cartId: string, itemId: string): Promise<
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -3273,16 +3277,18 @@ export declare function removeCartItem(cartId: string, itemId: string): Promise<
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -3321,19 +3327,19 @@ export declare function removeCartItem(cartId: string, itemId: string): Promise<
 export declare function applyDiscount(cartId: string, code: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -3353,9 +3359,10 @@ export declare function applyDiscount(cartId: string, code: string): Promise<{
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -3364,14 +3371,12 @@ export declare function applyDiscount(cartId: string, code: string): Promise<{
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -3379,8 +3384,8 @@ export declare function applyDiscount(cartId: string, code: string): Promise<{
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -3820,16 +3825,18 @@ export declare function applyDiscount(cartId: string, code: string): Promise<{
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -3872,19 +3879,19 @@ export declare function applyDiscount(cartId: string, code: string): Promise<{
 export declare function removeDiscount(cartId: string): Promise<{
     id: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     customerPhone: string;
     customerEmail: string;
@@ -3904,9 +3911,10 @@ export declare function removeDiscount(cartId: string): Promise<{
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
-        brandId: string | null;
-        isActive: boolean;
         code: string;
+        isActive: boolean;
+        brandId: string | null;
+        description: string | null;
         minPurchase: string;
         maxDiscount: string;
         usageLimit: number | null;
@@ -3915,14 +3923,12 @@ export declare function removeDiscount(cartId: string): Promise<{
         validFrom: string;
         validUntil: string;
         isAutoApply: boolean;
-        description: string | null;
         category: string;
         createdBy: string | null;
     };
     items: {
         id: string;
         variant: {
-            price: number;
             product: {
                 id: string;
                 name: string;
@@ -3930,8 +3936,8 @@ export declare function removeDiscount(cartId: string): Promise<{
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -4371,16 +4377,18 @@ export declare function removeDiscount(cartId: string): Promise<{
                     };
                 };
             };
-            id: string;
-            name: string | null;
             createdAt: string;
             updatedAt: string;
+            price: number;
+            compareAtPrice: number;
             deletedAt: string;
+            thumbnailUrl: string;
+            originalPrice: number;
+            id: string;
+            name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
             sku: string;
-            compareAtPrice: string;
             trackInventory: boolean;
             lowStockThreshold: number | null;
         };
@@ -4447,19 +4455,19 @@ export declare function checkoutCart(cartId: string, checkoutData: {
     prospectSince: string;
     lastRecoveryAttemptAt: string;
     brand: {
-        createdAt: string;
-        updatedAt: string;
-        deletedAt: string;
         id: string;
         name: string;
         slug: string;
-        logoUrl: string | null;
+        logoUrl: string;
         siteUrl: string;
         domain: string;
-        metaPixelId: string | null;
-        tiktokPixelId: string | null;
-        paystackPublicKey: string | null;
-        paystackSecretKey: string | null;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
     };
     deliveryZone: {
         deliveryCost: number;
@@ -4477,6 +4485,7 @@ export declare function checkoutCart(cartId: string, checkoutData: {
         };
         id: string;
         name: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         allowCOD: boolean;
@@ -4485,7 +4494,6 @@ export declare function checkoutCart(cartId: string, checkoutData: {
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
     };
     items: {
         priceAtPurchase: number;
@@ -4501,8 +4509,8 @@ export declare function checkoutCart(cartId: string, checkoutData: {
                 id: string;
                 name: string;
                 slug: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -4945,8 +4953,8 @@ export declare function checkoutCart(cartId: string, checkoutData: {
             id: string;
             name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             compareAtPrice: string;
             trackInventory: boolean;
@@ -4958,16 +4966,16 @@ export declare function checkoutCart(cartId: string, checkoutData: {
             deletedAt: string;
             id: string;
             name: string;
+            state: string | null;
             isActive: boolean;
             address: string | null;
             city: string | null;
-            state: string | null;
         };
         id: string;
-        orderId: string;
         variantId: string;
-        warehouseId: string | null;
         quantity: number;
+        orderId: string;
+        warehouseId: string | null;
     }[];
     email: string | null;
     id: string;
@@ -5016,6 +5024,10 @@ export declare function initiateCheckout(cartId: string, data: {
  * @returns Array of recommended products from the same brand
  */
 export declare function fetchCartRecommendations(cartId: string, limit: number): Promise<{
+    isOnSale: boolean;
+    saleId: string;
+    saleName: string;
+    saleEndsAt: string;
     id: string;
     name: string;
     slug: string;
@@ -5176,6 +5188,7 @@ export declare function fetchCartRecommendations(cartId: string, limit: number):
         metaPixelId: string;
         tiktokPixelId: string;
         paystackPublicKey: string;
+        freeShippingThreshold: number;
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
@@ -5186,10 +5199,11 @@ export declare function fetchCartRecommendations(cartId: string, limit: number):
         price: number;
         compareAtPrice: number;
         deletedAt: string;
+        thumbnailUrl: string;
+        originalPrice: number;
         id: string;
         name: string | null;
         isActive: boolean;
-        thumbnailUrl: string | null;
         productId: string;
         sku: string;
         trackInventory: boolean;
@@ -5486,11 +5500,30 @@ export declare function fetchCartRecommendations(cartId: string, limit: number):
             flat?: boolean;
         };
     };
+    sales: {
+        sale: {
+            id: string;
+            name: string;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            isActive: boolean;
+            brandId: string;
+            discountType: import("@prisma/client").$Enums.DiscountType;
+            discountValue: string;
+            startDate: string;
+            endDate: string;
+        };
+        id: string;
+        createdAt: string;
+        productId: string;
+        saleId: string;
+    }[];
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
-    brandId: string;
     isActive: boolean;
+    brandId: string;
 }[] | {
     error: {
         code: string;