@instockng/api-client 1.0.21 → 1.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,6 +13,156 @@
13
13
  * @returns Products for the brand with variants and availability
14
14
  */
15
15
  export declare function fetchProductsByBrand(brandId: string): Promise<{
16
+ id: string;
17
+ name: string;
18
+ slug: string;
19
+ description: string;
20
+ thumbnailUrl: string;
21
+ quantityDiscounts: string | number | boolean | {
22
+ [x: string]: string | number | boolean | /*elided*/ any | {
23
+ [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
24
+ length: number;
25
+ toString: never;
26
+ toLocaleString: never;
27
+ pop: never;
28
+ push: never;
29
+ concat: never;
30
+ join: never;
31
+ reverse: never;
32
+ shift: never;
33
+ slice: never;
34
+ sort: never;
35
+ splice: never;
36
+ unshift: never;
37
+ indexOf: never;
38
+ lastIndexOf: never;
39
+ every: never;
40
+ some: never;
41
+ forEach: never;
42
+ map: never;
43
+ filter: never;
44
+ reduce: never;
45
+ reduceRight: never;
46
+ find: never;
47
+ findIndex: never;
48
+ fill: never;
49
+ copyWithin: never;
50
+ entries: never;
51
+ keys: never;
52
+ values: never;
53
+ includes: never;
54
+ flatMap: never;
55
+ flat: never;
56
+ [Symbol.iterator]: never;
57
+ readonly [Symbol.unscopables]: {
58
+ [x: number]: boolean;
59
+ length?: boolean;
60
+ toString?: boolean;
61
+ toLocaleString?: boolean;
62
+ pop?: boolean;
63
+ push?: boolean;
64
+ concat?: boolean;
65
+ join?: boolean;
66
+ reverse?: boolean;
67
+ shift?: boolean;
68
+ slice?: boolean;
69
+ sort?: boolean;
70
+ splice?: boolean;
71
+ unshift?: boolean;
72
+ indexOf?: boolean;
73
+ lastIndexOf?: boolean;
74
+ every?: boolean;
75
+ some?: boolean;
76
+ forEach?: boolean;
77
+ map?: boolean;
78
+ filter?: boolean;
79
+ reduce?: boolean;
80
+ reduceRight?: boolean;
81
+ find?: boolean;
82
+ findIndex?: boolean;
83
+ fill?: boolean;
84
+ copyWithin?: boolean;
85
+ entries?: boolean;
86
+ keys?: boolean;
87
+ values?: boolean;
88
+ includes?: boolean;
89
+ flatMap?: boolean;
90
+ flat?: boolean;
91
+ };
92
+ };
93
+ } | {
94
+ [x: number]: string | number | boolean | {
95
+ [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
96
+ } | /*elided*/ any;
97
+ length: number;
98
+ toString: never;
99
+ toLocaleString: never;
100
+ pop: never;
101
+ push: never;
102
+ concat: never;
103
+ join: never;
104
+ reverse: never;
105
+ shift: never;
106
+ slice: never;
107
+ sort: never;
108
+ splice: never;
109
+ unshift: never;
110
+ indexOf: never;
111
+ lastIndexOf: never;
112
+ every: never;
113
+ some: never;
114
+ forEach: never;
115
+ map: never;
116
+ filter: never;
117
+ reduce: never;
118
+ reduceRight: never;
119
+ find: never;
120
+ findIndex: never;
121
+ fill: never;
122
+ copyWithin: never;
123
+ entries: never;
124
+ keys: never;
125
+ values: never;
126
+ includes: never;
127
+ flatMap: never;
128
+ flat: never;
129
+ [Symbol.iterator]: never;
130
+ readonly [Symbol.unscopables]: {
131
+ [x: number]: boolean;
132
+ length?: boolean;
133
+ toString?: boolean;
134
+ toLocaleString?: boolean;
135
+ pop?: boolean;
136
+ push?: boolean;
137
+ concat?: boolean;
138
+ join?: boolean;
139
+ reverse?: boolean;
140
+ shift?: boolean;
141
+ slice?: boolean;
142
+ sort?: boolean;
143
+ splice?: boolean;
144
+ unshift?: boolean;
145
+ indexOf?: boolean;
146
+ lastIndexOf?: boolean;
147
+ every?: boolean;
148
+ some?: boolean;
149
+ forEach?: boolean;
150
+ map?: boolean;
151
+ filter?: boolean;
152
+ reduce?: boolean;
153
+ reduceRight?: boolean;
154
+ find?: boolean;
155
+ findIndex?: boolean;
156
+ fill?: boolean;
157
+ copyWithin?: boolean;
158
+ entries?: boolean;
159
+ keys?: boolean;
160
+ values?: boolean;
161
+ includes?: boolean;
162
+ flatMap?: boolean;
163
+ flat?: boolean;
164
+ };
165
+ };
16
166
  brand: {
17
167
  createdAt: string;
18
168
  updatedAt: string;
@@ -28,30 +178,325 @@ export declare function fetchProductsByBrand(brandId: string): Promise<{
28
178
  paystackPublicKey: string | null;
29
179
  paystackSecretKey: string | null;
30
180
  };
31
- variants: {
32
- createdAt: string;
33
- updatedAt: string;
34
- price: number;
35
- deletedAt: string;
36
- id: string;
37
- name: string | null;
38
- isActive: boolean;
39
- thumbnailUrl: string | null;
40
- productId: string;
41
- sku: string;
42
- trackInventory: boolean;
43
- lowStockThreshold: number | null;
44
- }[];
181
+ variants: {
182
+ createdAt: string;
183
+ updatedAt: string;
184
+ price: number;
185
+ compareAtPrice: number;
186
+ deletedAt: string;
187
+ id: string;
188
+ name: string | null;
189
+ isActive: boolean;
190
+ thumbnailUrl: string | null;
191
+ productId: string;
192
+ sku: string;
193
+ trackInventory: boolean;
194
+ lowStockThreshold: number | null;
195
+ }[];
196
+ media: string | number | true | {
197
+ [x: string]: string | number | boolean | /*elided*/ any | {
198
+ [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
199
+ length: number;
200
+ toString: never;
201
+ toLocaleString: never;
202
+ pop: never;
203
+ push: never;
204
+ concat: never;
205
+ join: never;
206
+ reverse: never;
207
+ shift: never;
208
+ slice: never;
209
+ sort: never;
210
+ splice: never;
211
+ unshift: never;
212
+ indexOf: never;
213
+ lastIndexOf: never;
214
+ every: never;
215
+ some: never;
216
+ forEach: never;
217
+ map: never;
218
+ filter: never;
219
+ reduce: never;
220
+ reduceRight: never;
221
+ find: never;
222
+ findIndex: never;
223
+ fill: never;
224
+ copyWithin: never;
225
+ entries: never;
226
+ keys: never;
227
+ values: never;
228
+ includes: never;
229
+ flatMap: never;
230
+ flat: never;
231
+ [Symbol.iterator]: never;
232
+ readonly [Symbol.unscopables]: {
233
+ [x: number]: boolean;
234
+ length?: boolean;
235
+ toString?: boolean;
236
+ toLocaleString?: boolean;
237
+ pop?: boolean;
238
+ push?: boolean;
239
+ concat?: boolean;
240
+ join?: boolean;
241
+ reverse?: boolean;
242
+ shift?: boolean;
243
+ slice?: boolean;
244
+ sort?: boolean;
245
+ splice?: boolean;
246
+ unshift?: boolean;
247
+ indexOf?: boolean;
248
+ lastIndexOf?: boolean;
249
+ every?: boolean;
250
+ some?: boolean;
251
+ forEach?: boolean;
252
+ map?: boolean;
253
+ filter?: boolean;
254
+ reduce?: boolean;
255
+ reduceRight?: boolean;
256
+ find?: boolean;
257
+ findIndex?: boolean;
258
+ fill?: boolean;
259
+ copyWithin?: boolean;
260
+ entries?: boolean;
261
+ keys?: boolean;
262
+ values?: boolean;
263
+ includes?: boolean;
264
+ flatMap?: boolean;
265
+ flat?: boolean;
266
+ };
267
+ };
268
+ } | {
269
+ [x: number]: string | number | boolean | {
270
+ [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
271
+ } | /*elided*/ any;
272
+ length: number;
273
+ toString: never;
274
+ toLocaleString: never;
275
+ pop: never;
276
+ push: never;
277
+ concat: never;
278
+ join: never;
279
+ reverse: never;
280
+ shift: never;
281
+ slice: never;
282
+ sort: never;
283
+ splice: never;
284
+ unshift: never;
285
+ indexOf: never;
286
+ lastIndexOf: never;
287
+ every: never;
288
+ some: never;
289
+ forEach: never;
290
+ map: never;
291
+ filter: never;
292
+ reduce: never;
293
+ reduceRight: never;
294
+ find: never;
295
+ findIndex: never;
296
+ fill: never;
297
+ copyWithin: never;
298
+ entries: never;
299
+ keys: never;
300
+ values: never;
301
+ includes: never;
302
+ flatMap: never;
303
+ flat: never;
304
+ [Symbol.iterator]: never;
305
+ readonly [Symbol.unscopables]: {
306
+ [x: number]: boolean;
307
+ length?: boolean;
308
+ toString?: boolean;
309
+ toLocaleString?: boolean;
310
+ pop?: boolean;
311
+ push?: boolean;
312
+ concat?: boolean;
313
+ join?: boolean;
314
+ reverse?: boolean;
315
+ shift?: boolean;
316
+ slice?: boolean;
317
+ sort?: boolean;
318
+ splice?: boolean;
319
+ unshift?: boolean;
320
+ indexOf?: boolean;
321
+ lastIndexOf?: boolean;
322
+ every?: boolean;
323
+ some?: boolean;
324
+ forEach?: boolean;
325
+ map?: boolean;
326
+ filter?: boolean;
327
+ reduce?: boolean;
328
+ reduceRight?: boolean;
329
+ find?: boolean;
330
+ findIndex?: boolean;
331
+ fill?: boolean;
332
+ copyWithin?: boolean;
333
+ entries?: boolean;
334
+ keys?: boolean;
335
+ values?: boolean;
336
+ includes?: boolean;
337
+ flatMap?: boolean;
338
+ flat?: boolean;
339
+ };
340
+ };
341
+ features: string;
342
+ faqs: string | number | true | {
343
+ [x: string]: string | number | boolean | /*elided*/ any | {
344
+ [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
345
+ length: number;
346
+ toString: never;
347
+ toLocaleString: never;
348
+ pop: never;
349
+ push: never;
350
+ concat: never;
351
+ join: never;
352
+ reverse: never;
353
+ shift: never;
354
+ slice: never;
355
+ sort: never;
356
+ splice: never;
357
+ unshift: never;
358
+ indexOf: never;
359
+ lastIndexOf: never;
360
+ every: never;
361
+ some: never;
362
+ forEach: never;
363
+ map: never;
364
+ filter: never;
365
+ reduce: never;
366
+ reduceRight: never;
367
+ find: never;
368
+ findIndex: never;
369
+ fill: never;
370
+ copyWithin: never;
371
+ entries: never;
372
+ keys: never;
373
+ values: never;
374
+ includes: never;
375
+ flatMap: never;
376
+ flat: never;
377
+ [Symbol.iterator]: never;
378
+ readonly [Symbol.unscopables]: {
379
+ [x: number]: boolean;
380
+ length?: boolean;
381
+ toString?: boolean;
382
+ toLocaleString?: boolean;
383
+ pop?: boolean;
384
+ push?: boolean;
385
+ concat?: boolean;
386
+ join?: boolean;
387
+ reverse?: boolean;
388
+ shift?: boolean;
389
+ slice?: boolean;
390
+ sort?: boolean;
391
+ splice?: boolean;
392
+ unshift?: boolean;
393
+ indexOf?: boolean;
394
+ lastIndexOf?: boolean;
395
+ every?: boolean;
396
+ some?: boolean;
397
+ forEach?: boolean;
398
+ map?: boolean;
399
+ filter?: boolean;
400
+ reduce?: boolean;
401
+ reduceRight?: boolean;
402
+ find?: boolean;
403
+ findIndex?: boolean;
404
+ fill?: boolean;
405
+ copyWithin?: boolean;
406
+ entries?: boolean;
407
+ keys?: boolean;
408
+ values?: boolean;
409
+ includes?: boolean;
410
+ flatMap?: boolean;
411
+ flat?: boolean;
412
+ };
413
+ };
414
+ } | {
415
+ [x: number]: string | number | boolean | {
416
+ [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
417
+ } | /*elided*/ any;
418
+ length: number;
419
+ toString: never;
420
+ toLocaleString: never;
421
+ pop: never;
422
+ push: never;
423
+ concat: never;
424
+ join: never;
425
+ reverse: never;
426
+ shift: never;
427
+ slice: never;
428
+ sort: never;
429
+ splice: never;
430
+ unshift: never;
431
+ indexOf: never;
432
+ lastIndexOf: never;
433
+ every: never;
434
+ some: never;
435
+ forEach: never;
436
+ map: never;
437
+ filter: never;
438
+ reduce: never;
439
+ reduceRight: never;
440
+ find: never;
441
+ findIndex: never;
442
+ fill: never;
443
+ copyWithin: never;
444
+ entries: never;
445
+ keys: never;
446
+ values: never;
447
+ includes: never;
448
+ flatMap: never;
449
+ flat: never;
450
+ [Symbol.iterator]: never;
451
+ readonly [Symbol.unscopables]: {
452
+ [x: number]: boolean;
453
+ length?: boolean;
454
+ toString?: boolean;
455
+ toLocaleString?: boolean;
456
+ pop?: boolean;
457
+ push?: boolean;
458
+ concat?: boolean;
459
+ join?: boolean;
460
+ reverse?: boolean;
461
+ shift?: boolean;
462
+ slice?: boolean;
463
+ sort?: boolean;
464
+ splice?: boolean;
465
+ unshift?: boolean;
466
+ indexOf?: boolean;
467
+ lastIndexOf?: boolean;
468
+ every?: boolean;
469
+ some?: boolean;
470
+ forEach?: boolean;
471
+ map?: boolean;
472
+ filter?: boolean;
473
+ reduce?: boolean;
474
+ reduceRight?: boolean;
475
+ find?: boolean;
476
+ findIndex?: boolean;
477
+ fill?: boolean;
478
+ copyWithin?: boolean;
479
+ entries?: boolean;
480
+ keys?: boolean;
481
+ values?: boolean;
482
+ includes?: boolean;
483
+ flatMap?: boolean;
484
+ flat?: boolean;
485
+ };
486
+ };
487
+ }[]>;
488
+ /**
489
+ * Fetch a single product by slug
490
+ *
491
+ * @param slug - Product slug (e.g., 'cotton-t-shirt')
492
+ * @returns Product with variants and availability
493
+ */
494
+ export declare function fetchProductBySlug(slug: string): Promise<{
45
495
  id: string;
46
496
  name: string;
47
497
  slug: string;
48
- createdAt: string;
49
- updatedAt: string;
50
- deletedAt: string;
51
- brandId: string;
52
- isActive: boolean;
53
- description: string | null;
54
- thumbnailUrl: string | null;
498
+ description: string;
499
+ thumbnailUrl: string;
55
500
  quantityDiscounts: string | number | boolean | {
56
501
  [x: string]: string | number | boolean | /*elided*/ any | {
57
502
  [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
@@ -197,14 +642,6 @@ export declare function fetchProductsByBrand(brandId: string): Promise<{
197
642
  flat?: boolean;
198
643
  };
199
644
  };
200
- }[]>;
201
- /**
202
- * Fetch a single product by slug
203
- *
204
- * @param slug - Product slug (e.g., 'cotton-t-shirt')
205
- * @returns Product with variants and availability
206
- */
207
- export declare function fetchProductBySlug(slug: string): Promise<{
208
645
  brand: {
209
646
  createdAt: string;
210
647
  updatedAt: string;
@@ -224,6 +661,7 @@ export declare function fetchProductBySlug(slug: string): Promise<{
224
661
  createdAt: string;
225
662
  updatedAt: string;
226
663
  price: number;
664
+ compareAtPrice: number;
227
665
  deletedAt: string;
228
666
  id: string;
229
667
  name: string | null;
@@ -234,17 +672,153 @@ export declare function fetchProductBySlug(slug: string): Promise<{
234
672
  trackInventory: boolean;
235
673
  lowStockThreshold: number | null;
236
674
  }[];
237
- id: string;
238
- name: string;
239
- slug: string;
240
- createdAt: string;
241
- updatedAt: string;
242
- deletedAt: string;
243
- brandId: string;
244
- isActive: boolean;
245
- description: string | null;
246
- thumbnailUrl: string | null;
247
- quantityDiscounts: string | number | boolean | {
675
+ media: string | number | true | {
676
+ [x: string]: string | number | boolean | /*elided*/ any | {
677
+ [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
678
+ length: number;
679
+ toString: never;
680
+ toLocaleString: never;
681
+ pop: never;
682
+ push: never;
683
+ concat: never;
684
+ join: never;
685
+ reverse: never;
686
+ shift: never;
687
+ slice: never;
688
+ sort: never;
689
+ splice: never;
690
+ unshift: never;
691
+ indexOf: never;
692
+ lastIndexOf: never;
693
+ every: never;
694
+ some: never;
695
+ forEach: never;
696
+ map: never;
697
+ filter: never;
698
+ reduce: never;
699
+ reduceRight: never;
700
+ find: never;
701
+ findIndex: never;
702
+ fill: never;
703
+ copyWithin: never;
704
+ entries: never;
705
+ keys: never;
706
+ values: never;
707
+ includes: never;
708
+ flatMap: never;
709
+ flat: never;
710
+ [Symbol.iterator]: never;
711
+ readonly [Symbol.unscopables]: {
712
+ [x: number]: boolean;
713
+ length?: boolean;
714
+ toString?: boolean;
715
+ toLocaleString?: boolean;
716
+ pop?: boolean;
717
+ push?: boolean;
718
+ concat?: boolean;
719
+ join?: boolean;
720
+ reverse?: boolean;
721
+ shift?: boolean;
722
+ slice?: boolean;
723
+ sort?: boolean;
724
+ splice?: boolean;
725
+ unshift?: boolean;
726
+ indexOf?: boolean;
727
+ lastIndexOf?: boolean;
728
+ every?: boolean;
729
+ some?: boolean;
730
+ forEach?: boolean;
731
+ map?: boolean;
732
+ filter?: boolean;
733
+ reduce?: boolean;
734
+ reduceRight?: boolean;
735
+ find?: boolean;
736
+ findIndex?: boolean;
737
+ fill?: boolean;
738
+ copyWithin?: boolean;
739
+ entries?: boolean;
740
+ keys?: boolean;
741
+ values?: boolean;
742
+ includes?: boolean;
743
+ flatMap?: boolean;
744
+ flat?: boolean;
745
+ };
746
+ };
747
+ } | {
748
+ [x: number]: string | number | boolean | {
749
+ [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
750
+ } | /*elided*/ any;
751
+ length: number;
752
+ toString: never;
753
+ toLocaleString: never;
754
+ pop: never;
755
+ push: never;
756
+ concat: never;
757
+ join: never;
758
+ reverse: never;
759
+ shift: never;
760
+ slice: never;
761
+ sort: never;
762
+ splice: never;
763
+ unshift: never;
764
+ indexOf: never;
765
+ lastIndexOf: never;
766
+ every: never;
767
+ some: never;
768
+ forEach: never;
769
+ map: never;
770
+ filter: never;
771
+ reduce: never;
772
+ reduceRight: never;
773
+ find: never;
774
+ findIndex: never;
775
+ fill: never;
776
+ copyWithin: never;
777
+ entries: never;
778
+ keys: never;
779
+ values: never;
780
+ includes: never;
781
+ flatMap: never;
782
+ flat: never;
783
+ [Symbol.iterator]: never;
784
+ readonly [Symbol.unscopables]: {
785
+ [x: number]: boolean;
786
+ length?: boolean;
787
+ toString?: boolean;
788
+ toLocaleString?: boolean;
789
+ pop?: boolean;
790
+ push?: boolean;
791
+ concat?: boolean;
792
+ join?: boolean;
793
+ reverse?: boolean;
794
+ shift?: boolean;
795
+ slice?: boolean;
796
+ sort?: boolean;
797
+ splice?: boolean;
798
+ unshift?: boolean;
799
+ indexOf?: boolean;
800
+ lastIndexOf?: boolean;
801
+ every?: boolean;
802
+ some?: boolean;
803
+ forEach?: boolean;
804
+ map?: boolean;
805
+ filter?: boolean;
806
+ reduce?: boolean;
807
+ reduceRight?: boolean;
808
+ find?: boolean;
809
+ findIndex?: boolean;
810
+ fill?: boolean;
811
+ copyWithin?: boolean;
812
+ entries?: boolean;
813
+ keys?: boolean;
814
+ values?: boolean;
815
+ includes?: boolean;
816
+ flatMap?: boolean;
817
+ flat?: boolean;
818
+ };
819
+ };
820
+ features: string;
821
+ faqs: string | number | true | {
248
822
  [x: string]: string | number | boolean | /*elided*/ any | {
249
823
  [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
250
824
  length: number;
@@ -390,3 +964,11 @@ export declare function fetchProductBySlug(slug: string): Promise<{
390
964
  };
391
965
  };
392
966
  }>;
967
+ /**
968
+ * Fetch product add-ons
969
+ *
970
+ * @param slug - Product slug
971
+ * @param limit - Max number of add-ons to return (default 6)
972
+ * @returns List of add-on products
973
+ */
974
+ export declare function fetchProductAddons(slug: string, limit?: number): Promise<any>;