@instockng/api-client 1.0.35 → 1.0.37

package/dist/hooks/admin/orders.d.ts

@@ -32,25 +32,33 @@ export declare function useListOrders(filters?: {
         deliveryCharge: number;
         totalPrice: number;
         discountAmount: number;
+        amountPaid: number;
+        flutterwaveAccountBank: string;
+        flutterwaveAccountNumber: string;
+        flutterwaveAccountExpiry: string;
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
         prospectSince: string;
         lastRecoveryAttemptAt: string;
+        shippedAt: string;
+        deliveryConfirmationSentAt: string;
+        deliveryConfirmedAt: string;
+        deliveryConfirmationAttempts: number;
         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;
@@ -68,6 +76,7 @@ export declare function useListOrders(filters?: {
             };
             id: string;
             name: string;
+            isActive: boolean;
             brandId: string | null;
             stateId: string;
             allowCOD: boolean;
@@ -76,7 +85,6 @@ export declare function useListOrders(filters?: {
             estimatedDays: number | null;
             noteTitle: string | null;
             noteContent: string | null;
-            isActive: boolean;
         };
         items: {
             priceAtPurchase: number;
@@ -92,8 +100,8 @@ export declare function useListOrders(filters?: {
                     id: string;
                     name: string;
                     slug: string;
-                    brandId: string;
                     isActive: boolean;
+                    brandId: string;
                     description: string | null;
                     thumbnailUrl: string | null;
                     quantityDiscounts: string | number | boolean | {
@@ -536,8 +544,8 @@ export declare function useListOrders(filters?: {
                 id: string;
                 name: string | null;
                 isActive: boolean;
-                thumbnailUrl: string | null;
                 productId: string;
+                thumbnailUrl: string | null;
                 sku: string;
                 compareAtPrice: string;
                 trackInventory: boolean;
@@ -549,16 +557,16 @@ export declare function useListOrders(filters?: {
                 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;
@@ -579,8 +587,19 @@ export declare function useListOrders(filters?: {
         paystackReference: string | null;
         status: import("@prisma/client").$Enums.OrderStatus;
         cancellationReason: string | null;
+        shippingMethod: string | null;
+        dispatchRiderId: string | null;
+        fezTrackingNumber: string | null;
+        flutterwaveOrderRef: string | null;
+        flutterwaveCustomerId: string | null;
         prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
         userActionToken: string;
+        labelPrintedAt: string;
+        dispatchRider?: {
+            id: string;
+            name: string;
+            phone: string;
+        };
     }[];
     pagination: {
         page: number;
@@ -605,25 +624,33 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
     deliveryCharge: number;
     totalPrice: number;
     discountAmount: number;
+    amountPaid: number;
+    flutterwaveAccountBank: string;
+    flutterwaveAccountNumber: string;
+    flutterwaveAccountExpiry: string;
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
     prospectSince: string;
     lastRecoveryAttemptAt: string;
+    shippedAt: string;
+    deliveryConfirmationSentAt: string;
+    deliveryConfirmedAt: string;
+    deliveryConfirmationAttempts: number;
     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;
@@ -641,6 +668,7 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
         };
         id: string;
         name: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         allowCOD: boolean;
@@ -649,7 +677,6 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
     };
     items: {
         priceAtPurchase: number;
@@ -665,8 +692,8 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
                 id: string;
                 name: string;
                 slug: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -1109,8 +1136,8 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
             id: string;
             name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             compareAtPrice: string;
             trackInventory: boolean;
@@ -1122,16 +1149,16 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
             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;
@@ -1152,8 +1179,19 @@ export declare function useGetOrder(orderId: string, options?: Omit<UseQueryOpti
     paystackReference: string | null;
     status: import("@prisma/client").$Enums.OrderStatus;
     cancellationReason: string | null;
+    shippingMethod: string | null;
+    dispatchRiderId: string | null;
+    fezTrackingNumber: string | null;
+    flutterwaveOrderRef: string | null;
+    flutterwaveCustomerId: string | null;
     prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
     userActionToken: string;
+    labelPrintedAt: string;
+    dispatchRider?: {
+        id: string;
+        name: string;
+        phone: string;
+    };
 }, Error>;
 /**
  * Hook to create a new order using admin RPC
@@ -1175,25 +1213,33 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
     deliveryCharge: number;
     totalPrice: number;
     discountAmount: number;
+    amountPaid: number;
+    flutterwaveAccountBank: string;
+    flutterwaveAccountNumber: string;
+    flutterwaveAccountExpiry: string;
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
     prospectSince: string;
     lastRecoveryAttemptAt: string;
+    shippedAt: string;
+    deliveryConfirmationSentAt: string;
+    deliveryConfirmedAt: string;
+    deliveryConfirmationAttempts: number;
     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;
@@ -1211,6 +1257,7 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
         };
         id: string;
         name: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         allowCOD: boolean;
@@ -1219,7 +1266,6 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
     };
     items: {
         priceAtPurchase: number;
@@ -1235,8 +1281,8 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
                 id: string;
                 name: string;
                 slug: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -1679,8 +1725,8 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
             id: string;
             name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             compareAtPrice: string;
             trackInventory: boolean;
@@ -1692,16 +1738,16 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
             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;
@@ -1722,8 +1768,19 @@ export declare function useCreateOrder(options?: UseMutationOptions<Awaited<Retu
     paystackReference: string | null;
     status: import("@prisma/client").$Enums.OrderStatus;
     cancellationReason: string | null;
+    shippingMethod: string | null;
+    dispatchRiderId: string | null;
+    fezTrackingNumber: string | null;
+    flutterwaveOrderRef: string | null;
+    flutterwaveCustomerId: string | null;
     prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
     userActionToken: string;
+    labelPrintedAt: string;
+    dispatchRider?: {
+        id: string;
+        name: string;
+        phone: string;
+    };
 } | {
     error: {
         code: string;
@@ -1746,25 +1803,33 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
     deliveryCharge: number;
     totalPrice: number;
     discountAmount: number;
+    amountPaid: number;
+    flutterwaveAccountBank: string;
+    flutterwaveAccountNumber: string;
+    flutterwaveAccountExpiry: string;
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
     prospectSince: string;
     lastRecoveryAttemptAt: string;
+    shippedAt: string;
+    deliveryConfirmationSentAt: string;
+    deliveryConfirmedAt: string;
+    deliveryConfirmationAttempts: number;
     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;
@@ -1782,6 +1847,7 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
         };
         id: string;
         name: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         allowCOD: boolean;
@@ -1790,7 +1856,6 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
     };
     items: {
         priceAtPurchase: number;
@@ -1806,8 +1871,8 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
                 id: string;
                 name: string;
                 slug: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -2250,8 +2315,8 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
             id: string;
             name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             compareAtPrice: string;
             trackInventory: boolean;
@@ -2263,16 +2328,16 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
             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;
@@ -2293,8 +2358,19 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
     paystackReference: string | null;
     status: import("@prisma/client").$Enums.OrderStatus;
     cancellationReason: string | null;
+    shippingMethod: string | null;
+    dispatchRiderId: string | null;
+    fezTrackingNumber: string | null;
+    flutterwaveOrderRef: string | null;
+    flutterwaveCustomerId: string | null;
     prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
     userActionToken: string;
+    labelPrintedAt: string;
+    dispatchRider?: {
+        id: string;
+        name: string;
+        phone: string;
+    };
 } | {
     error: {
         code: string;
@@ -2312,6 +2388,7 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
         tiktokPixelId: string | null;
         paystackPublicKey: string | null;
         paystackSecretKey: string | null;
+        freeShippingThreshold: string;
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
@@ -2327,20 +2404,28 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
         };
         id: string;
         name: string;
+        freeShippingThreshold: string;
         createdAt: string;
         updatedAt: string;
         deletedAt: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         deliveryCost: string;
-        freeShippingThreshold: string;
         allowCOD: boolean;
         allowOnline: boolean;
         waybillOnly: boolean;
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
+    };
+    dispatchRider: {
+        id: string;
+        name: string;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+        phone: string;
     };
     items: {
         warehouse: {
@@ -2349,10 +2434,10 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
             createdAt: string;
             updatedAt: string;
             deletedAt: string;
+            state: string | null;
             isActive: boolean;
             address: string | null;
             city: string | null;
-            state: string | null;
         };
         variant: {
             product: {
@@ -2362,8 +2447,8 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
                 createdAt: string;
                 updatedAt: string;
                 deletedAt: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -2809,8 +2894,8 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
             updatedAt: string;
             deletedAt: string;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             price: string;
             compareAtPrice: string;
@@ -2818,10 +2903,10 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
             lowStockThreshold: number | null;
         };
         id: string;
-        orderId: string;
         variantId: string;
-        warehouseId: string | null;
         quantity: number;
+        orderId: string;
+        warehouseId: string | null;
         priceAtPurchase: string;
     }[];
     notes: {
@@ -2998,6 +3083,7 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
     recoveryDiscountCodeId: string | null;
     wasRecovered: boolean;
     estimatedDays: number | null;
+    discountAmount: string;
     orderNumber: number;
     firstName: string;
     lastName: string;
@@ -3007,14 +3093,27 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
     deliveryCharge: string;
     totalPrice: string;
     discountCodeId: string | null;
-    discountAmount: string;
     paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
     paystackReference: string | null;
     status: import("@prisma/client").$Enums.OrderStatus;
     cancellationReason: string | null;
+    shippingMethod: string | null;
+    dispatchRiderId: string | null;
+    fezTrackingNumber: string | null;
+    amountPaid: string;
+    flutterwaveAccountBank: string | null;
+    flutterwaveAccountNumber: string | null;
+    flutterwaveOrderRef: string | null;
+    flutterwaveCustomerId: string | null;
+    flutterwaveAccountExpiry: string;
     prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
     prospectSince: string;
     userActionToken: string;
+    shippedAt: string;
+    labelPrintedAt: string;
+    deliveryConfirmationSentAt: string;
+    deliveryConfirmedAt: string;
+    deliveryConfirmationAttempts: number;
 } | {
     error: {
         code: string;
@@ -3032,25 +3131,33 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
     deliveryCharge: number;
     totalPrice: number;
     discountAmount: number;
+    amountPaid: number;
+    flutterwaveAccountBank: string;
+    flutterwaveAccountNumber: string;
+    flutterwaveAccountExpiry: string;
     createdAt: string;
     updatedAt: string;
     deletedAt: string;
     prospectSince: string;
     lastRecoveryAttemptAt: string;
+    shippedAt: string;
+    deliveryConfirmationSentAt: string;
+    deliveryConfirmedAt: string;
+    deliveryConfirmationAttempts: number;
     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;
@@ -3068,6 +3175,7 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
         };
         id: string;
         name: string;
+        isActive: boolean;
         brandId: string | null;
         stateId: string;
         allowCOD: boolean;
@@ -3076,7 +3184,6 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
         estimatedDays: number | null;
         noteTitle: string | null;
         noteContent: string | null;
-        isActive: boolean;
     };
     items: {
         priceAtPurchase: number;
@@ -3092,8 +3199,8 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
                 id: string;
                 name: string;
                 slug: string;
-                brandId: string;
                 isActive: boolean;
+                brandId: string;
                 description: string | null;
                 thumbnailUrl: string | null;
                 quantityDiscounts: string | number | boolean | {
@@ -3536,8 +3643,8 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
             id: string;
             name: string | null;
             isActive: boolean;
-            thumbnailUrl: string | null;
             productId: string;
+            thumbnailUrl: string | null;
             sku: string;
             compareAtPrice: string;
             trackInventory: boolean;
@@ -3549,16 +3656,16 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
             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;
@@ -3579,8 +3686,19 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
     paystackReference: string | null;
     status: import("@prisma/client").$Enums.OrderStatus;
     cancellationReason: string | null;
+    shippingMethod: string | null;
+    dispatchRiderId: string | null;
+    fezTrackingNumber: string | null;
+    flutterwaveOrderRef: string | null;
+    flutterwaveCustomerId: string | null;
     prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
     userActionToken: string;
+    labelPrintedAt: string;
+    dispatchRider?: {
+        id: string;
+        name: string;
+        phone: string;
+    };
 } | {
     error: {
         code: string;
@@ -3604,6 +3722,25 @@ export declare function useUpdateOrderStatus(orderId: string, options?: UseMutat
  * @param options - React Query mutation options
  */
 export declare function useDeleteOrder(orderId: string, options?: UseMutationOptions<Awaited<ReturnType<Awaited<ReturnType<ReturnType<typeof createAdminRpcClients>['orders'][':id']['$delete']>>['json']>>, Error, void>): import("@tanstack/react-query").UseMutationResult<unknown, Error, void, unknown>;
+/**
+ * Hook to regenerate Flutterwave virtual account for a COD order
+ *
+ * @param orderId - Order UUID
+ * @param options - React Query mutation options
+ */
+export declare function useRegenerateAccount(orderId: string, options?: UseMutationOptions<any, Error, void>): import("@tanstack/react-query").UseMutationResult<any, Error, void, unknown>;
+/**
+ * Hook to send delivery confirmation for a single order
+ */
+export declare function useSendDeliveryConfirmation(orderId: string, options?: UseMutationOptions<any, Error, void>): import("@tanstack/react-query").UseMutationResult<any, Error, void, unknown>;
+/**
+ * Hook to send batch delivery confirmation
+ */
+export declare function useBatchDeliveryConfirmation(options?: UseMutationOptions<any, Error, {
+    orderIds: string[];
+}>): import("@tanstack/react-query").UseMutationResult<any, Error, {
+    orderIds: string[];
+}, unknown>;
 /**
  * Hook to add a note to an order using admin RPC
  *