@ikas/code-components-mcp 1.4.0-beta.9 → 1.4.0-beta.90

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.
@@ -1,59 +1,6 @@
1
1
  {
2
- "generatedAt": "2026-05-12T12:18:10.080Z",
2
+ "generatedAt": "2026-06-29T12:42:29.671Z",
3
3
  "functions": [
4
- {
5
- "name": "fbp_initAdvancedMatching",
6
- "signature": "function fbp_initAdvancedMatching(userData: {\n em?: string | null;\n fn?: string | null;\n ln?: string | null;\n ph?: string | null;\n external_id?: string | null;\n ct?: string | null;\n st?: string | null;\n zp?: string | null;\n country?: string | null;\n}): void",
7
- "description": "",
8
- "params": [],
9
- "returnType": "void",
10
- "categories": [],
11
- "related": [],
12
- "isAsync": false,
13
- "isClass": false
14
- },
15
- {
16
- "name": "apiListBlog",
17
- "signature": "async function apiListBlog(params: ListBlogQueryParams): Promise<APIResponse<{ data: IkasBlog[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
18
- "description": "",
19
- "params": [],
20
- "returnType": "Promise<APIResponse<{ data: IkasBlog[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
21
- "categories": [],
22
- "related": [],
23
- "isAsync": true,
24
- "isClass": false,
25
- "parameterTypes": [
26
- "IkasBlog"
27
- ]
28
- },
29
- {
30
- "name": "apiListBlogMetaData",
31
- "signature": "async function apiListBlogMetaData(params: ListBlogMetadataQueryParams): Promise<APIResponse<{ data: IkasBlogMetaData[] | null; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
32
- "description": "",
33
- "params": [],
34
- "returnType": "Promise<APIResponse<{ data: IkasBlogMetaData[] | null; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
35
- "categories": [],
36
- "related": [],
37
- "isAsync": true,
38
- "isClass": false,
39
- "parameterTypes": [
40
- "IkasBlogMetaData"
41
- ]
42
- },
43
- {
44
- "name": "apiListBlogCategory",
45
- "signature": "async function apiListBlogCategory(params: ListBlogCategoryQueryParams): Promise<APIResponse<{ data: IkasBlogCategory[] | null; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
46
- "description": "",
47
- "params": [],
48
- "returnType": "Promise<APIResponse<{ data: IkasBlogCategory[] | null; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
49
- "categories": [],
50
- "related": [],
51
- "isAsync": true,
52
- "isClass": false,
53
- "parameterTypes": [
54
- "IkasBlogCategory"
55
- ]
56
- },
57
4
  {
58
5
  "name": "apiListProductBrand",
59
6
  "signature": "async function apiListProductBrand(params: ListProductBrandQueryParams): Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
@@ -68,92 +15,6 @@
68
15
  "IkasBrand"
69
16
  ]
70
17
  },
71
- {
72
- "name": "apiGetCartById",
73
- "signature": "async function apiGetCartById(params: GetCartByIdQueryParams): Promise<APIResponse<IkasCart | null>>",
74
- "description": "",
75
- "params": [],
76
- "returnType": "Promise<APIResponse<IkasCart | null>>",
77
- "categories": [],
78
- "related": [],
79
- "isAsync": true,
80
- "isClass": false,
81
- "parameterTypes": [
82
- "IkasCart"
83
- ]
84
- },
85
- {
86
- "name": "apiSaveCart",
87
- "signature": "async function apiSaveCart(params: SaveCartQueryParams): Promise<APIResponse<IkasCart | null>>",
88
- "description": "",
89
- "params": [],
90
- "returnType": "Promise<APIResponse<IkasCart | null>>",
91
- "categories": [],
92
- "related": [],
93
- "isAsync": true,
94
- "isClass": false,
95
- "parameterTypes": [
96
- "IkasCart"
97
- ]
98
- },
99
- {
100
- "name": "apiCreatePayWithIkasSessionUrl",
101
- "signature": "async function apiCreatePayWithIkasSessionUrl(params: CreatePayWithIkasSessionUrlQueryParams): Promise<APIResponse<CreatePayWithIkasSessionUrlResponse>>",
102
- "description": "",
103
- "params": [],
104
- "returnType": "Promise<APIResponse<CreatePayWithIkasSessionUrlResponse>>",
105
- "categories": [],
106
- "related": [],
107
- "isAsync": true,
108
- "isClass": false,
109
- "parameterTypes": [
110
- "IkasSessionUrl",
111
- "IkasSessionUrlQueryParams",
112
- "IkasSessionUrlResponse"
113
- ]
114
- },
115
- {
116
- "name": "apiSaveCartCouponCode",
117
- "signature": "async function apiSaveCartCouponCode(params: SaveCartCouponCodeQueryParams): Promise<APIResponse<IkasCart | null>>",
118
- "description": "",
119
- "params": [],
120
- "returnType": "Promise<APIResponse<IkasCart | null>>",
121
- "categories": [],
122
- "related": [],
123
- "isAsync": true,
124
- "isClass": false,
125
- "parameterTypes": [
126
- "IkasCart"
127
- ]
128
- },
129
- {
130
- "name": "apiAddItemToCart",
131
- "signature": "async function apiAddItemToCart(params: AddItemToCartQueryParams): Promise<APIResponse<IkasCart | null>>",
132
- "description": "",
133
- "params": [],
134
- "returnType": "Promise<APIResponse<IkasCart | null>>",
135
- "categories": [],
136
- "related": [],
137
- "isAsync": true,
138
- "isClass": false,
139
- "parameterTypes": [
140
- "IkasCart"
141
- ]
142
- },
143
- {
144
- "name": "apiUpdateCartCampaignOffer",
145
- "signature": "async function apiUpdateCartCampaignOffer(params: UpdateCartCampaignOfferQueryParams): Promise<APIResponse<IkasCart | null>>",
146
- "description": "",
147
- "params": [],
148
- "returnType": "Promise<APIResponse<IkasCart | null>>",
149
- "categories": [],
150
- "related": [],
151
- "isAsync": true,
152
- "isClass": false,
153
- "parameterTypes": [
154
- "IkasCart"
155
- ]
156
- },
157
18
  {
158
19
  "name": "apiListCategory",
159
20
  "signature": "async function apiListCategory(params: ListCategoryQueryParams, excludedFieldsCategory?: string[] | null): Promise<APIResponse<{ data: IkasCategory[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
@@ -169,1112 +30,137 @@
169
30
  ]
170
31
  },
171
32
  {
172
- "name": "apiCreateSaleTransactionWithCart",
173
- "signature": "async function apiCreateSaleTransactionWithCart(params: CreateSaleTransactionWithCartQueryParams): Promise<APIResponse<undefined> | APIResponse<TransactionResponse>>",
174
- "description": "",
175
- "params": [],
176
- "returnType": "Promise<APIResponse<undefined> | APIResponse<TransactionResponse>>",
177
- "categories": [],
178
- "related": [],
179
- "isAsync": true,
180
- "isClass": false
181
- },
182
- {
183
- "name": "apiListPaymentGateway",
184
- "signature": "async function apiListPaymentGateway(params: ListPaymentGatewayQueryParams): Promise<APIResponse<IkasPaymentGateway[]>>",
185
- "description": "",
186
- "params": [],
187
- "returnType": "Promise<APIResponse<IkasPaymentGateway[]>>",
188
- "categories": [],
189
- "related": [],
190
- "isAsync": true,
191
- "isClass": false,
192
- "parameterTypes": [
193
- "IkasPaymentGateway"
194
- ]
195
- },
196
- {
197
- "name": "apiListProductFile",
198
- "signature": "async function apiListProductFile(params: ListProductFileQueryParams): Promise<APIResponse<undefined> | APIResponse<ProductFile[]>>",
199
- "description": "",
200
- "params": [],
201
- "returnType": "Promise<APIResponse<undefined> | APIResponse<ProductFile[]>>",
202
- "categories": [],
203
- "related": [],
204
- "isAsync": true,
205
- "isClass": false
206
- },
207
- {
208
- "name": "apiRetrieveInstallmentInfo",
209
- "signature": "async function apiRetrieveInstallmentInfo(params: RetrieveInstallmentInfoQueryParams): Promise<APIResponse<undefined> | APIResponse<RetrieveInstallmentInfoResponse>>",
210
- "description": "",
211
- "params": [],
212
- "returnType": "Promise<APIResponse<undefined> | APIResponse<RetrieveInstallmentInfoResponse>>",
213
- "categories": [],
214
- "related": [],
215
- "isAsync": true,
216
- "isClass": false
217
- },
218
- {
219
- "name": "apiCheckStocks",
220
- "signature": "async function apiCheckStocks(params: CheckStocksQueryParams): Promise<APIResponse<undefined> | APIResponse<CheckStocksResponse>>",
221
- "description": "",
222
- "params": [],
223
- "returnType": "Promise<APIResponse<undefined> | APIResponse<CheckStocksResponse>>",
224
- "categories": [],
225
- "related": [],
226
- "isAsync": true,
227
- "isClass": false
228
- },
229
- {
230
- "name": "apiCheckCartStocks",
231
- "signature": "async function apiCheckCartStocks(params: CheckCartStocksQueryParams): Promise<APIResponse<undefined> | APIResponse<CheckStocksResponse>>",
232
- "description": "",
233
- "params": [],
234
- "returnType": "Promise<APIResponse<undefined> | APIResponse<CheckStocksResponse>>",
235
- "categories": [],
236
- "related": [],
237
- "isAsync": true,
238
- "isClass": false
239
- },
240
- {
241
- "name": "apiListCheckoutSettings",
242
- "signature": "async function apiListCheckoutSettings(params: ListCheckoutSettingsQueryParams): Promise<APIResponse<IkasCheckoutSettings[]>>",
243
- "description": "",
244
- "params": [],
245
- "returnType": "Promise<APIResponse<IkasCheckoutSettings[]>>",
246
- "categories": [],
247
- "related": [],
248
- "isAsync": true,
249
- "isClass": false,
250
- "parameterTypes": [
251
- "IkasCheckoutSettings"
252
- ]
253
- },
254
- {
255
- "name": "apiGetAvailableShippingCountries",
256
- "signature": "async function apiGetAvailableShippingCountries(params: GetAvailableShippingCountriesQueryParams): Promise<APIResponse<undefined> | APIResponse<string[]>>",
257
- "description": "",
258
- "params": [],
259
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string[]>>",
260
- "categories": [],
261
- "related": [],
262
- "isAsync": true,
263
- "isClass": false
264
- },
265
- {
266
- "name": "apiListStockLocations",
267
- "signature": "async function apiListStockLocations(params: ListStockLocationQueryParams): Promise<APIResponse<IkasStockLocation[]>>",
268
- "description": "",
269
- "params": [],
270
- "returnType": "Promise<APIResponse<IkasStockLocation[]>>",
271
- "categories": [],
272
- "related": [],
273
- "isAsync": true,
274
- "isClass": false,
275
- "parameterTypes": [
276
- "IkasStockLocation"
277
- ]
278
- },
279
- {
280
- "name": "apiGetAvailableStockLocations",
281
- "signature": "async function apiGetAvailableStockLocations(params: GetAvailableStockLocationsQueryParams): Promise<APIResponse<IkasAvailableStockLocation[]>>",
282
- "description": "",
283
- "params": [],
284
- "returnType": "Promise<APIResponse<IkasAvailableStockLocation[]>>",
285
- "categories": [],
286
- "related": [],
287
- "isAsync": true,
288
- "isClass": false,
289
- "parameterTypes": [
290
- "IkasAvailableStockLocation"
291
- ]
292
- },
293
- {
294
- "name": "apiCreateStripePaymentIntent",
295
- "signature": "async function apiCreateStripePaymentIntent(params: CreateStripePaymentIntentQueryParams): Promise<APIResponse<CreateStripePaymentIntentResponse>>",
296
- "description": "",
297
- "params": [],
298
- "returnType": "Promise<APIResponse<CreateStripePaymentIntentResponse>>",
299
- "categories": [],
300
- "related": [],
301
- "isAsync": true,
302
- "isClass": false
303
- },
304
- {
305
- "name": "apiCreateKlarnaClientToken",
306
- "signature": "async function apiCreateKlarnaClientToken(params: CreateKlarnaClientTokenQueryParams): Promise<APIResponse<CreateKlarnaTokenResponse>>",
307
- "description": "",
308
- "params": [],
309
- "returnType": "Promise<APIResponse<CreateKlarnaTokenResponse>>",
310
- "categories": [],
311
- "related": [],
312
- "isAsync": true,
313
- "isClass": false
314
- },
315
- {
316
- "name": "apiCreateAdyenBalancePlatformPaymentSession",
317
- "signature": "async function apiCreateAdyenBalancePlatformPaymentSession(params: CreateAdyenBalancePlatformPaymentSessionQueryParams): Promise<APIResponse<CreateAdyenPlatformSessionResponse>>",
318
- "description": "",
319
- "params": [],
320
- "returnType": "Promise<APIResponse<CreateAdyenPlatformSessionResponse>>",
321
- "categories": [],
322
- "related": [],
323
- "isAsync": true,
324
- "isClass": false
325
- },
326
- {
327
- "name": "apiGetPayPalClientId",
328
- "signature": "async function apiGetPayPalClientId(params: GetPaypalClientIdQueryParams): Promise<APIResponse<GetPaypalClientIdResponse>>",
329
- "description": "",
330
- "params": [],
331
- "returnType": "Promise<APIResponse<GetPaypalClientIdResponse>>",
332
- "categories": [],
333
- "related": [],
334
- "isAsync": true,
335
- "isClass": false
336
- },
337
- {
338
- "name": "apiCreatePayPalOrder",
339
- "signature": "async function apiCreatePayPalOrder(params: CreatePaypalOrderQueryParams): Promise<APIResponse<CreatePaypalOrderResponse>>",
340
- "description": "",
341
- "params": [],
342
- "returnType": "Promise<APIResponse<CreatePaypalOrderResponse>>",
343
- "categories": [],
344
- "related": [],
345
- "isAsync": true,
346
- "isClass": false
347
- },
348
- {
349
- "name": "apiLogin",
350
- "signature": "async function apiLogin(params: CustomerLoginQueryParams): Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
351
- "description": "",
352
- "params": [],
353
- "returnType": "Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
354
- "categories": [],
355
- "related": [],
356
- "isAsync": true,
357
- "isClass": false,
358
- "parameterTypes": [
359
- "IkasCustomer"
360
- ]
361
- },
362
- {
363
- "name": "apiSocialLogin",
364
- "signature": "async function apiSocialLogin(params: CustomerSocialLoginQueryParams): Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
33
+ "name": "apiGetStorefrontWidgetSettings",
34
+ "signature": "async function apiGetStorefrontWidgetSettings(): Promise<APIResponse<IkasStorefrontWidgetSettings>>",
365
35
  "description": "",
366
36
  "params": [],
367
- "returnType": "Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
37
+ "returnType": "Promise<APIResponse<IkasStorefrontWidgetSettings>>",
368
38
  "categories": [],
369
39
  "related": [],
370
40
  "isAsync": true,
371
41
  "isClass": false,
372
42
  "parameterTypes": [
373
- "IkasCustomer"
374
- ]
375
- },
376
- {
377
- "name": "apiRegister",
378
- "signature": "async function apiRegister(params: RegisterCustomerQueryParams): Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
379
- "description": "",
380
- "params": [],
381
- "returnType": "Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
382
- "categories": [],
383
- "related": [],
384
- "isAsync": true,
385
- "isClass": false,
386
- "parameterTypes": [
387
- "IkasCustomer"
388
- ]
389
- },
390
- {
391
- "name": "apiRefreshToken",
392
- "signature": "async function apiRefreshToken(params: CustomerRefreshTokenQueryParams): Promise<APIResponse<undefined> | APIResponse<CustomerRefreshTokenResponse>>",
393
- "description": "",
394
- "params": [],
395
- "returnType": "Promise<APIResponse<undefined> | APIResponse<CustomerRefreshTokenResponse>>",
396
- "categories": [],
397
- "related": [],
398
- "isAsync": true,
399
- "isClass": false
400
- },
401
- {
402
- "name": "apiForgotPassword",
403
- "signature": "async function apiForgotPassword(params: CustomerForgotPasswordQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
404
- "description": "",
405
- "params": [],
406
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
407
- "categories": [],
408
- "related": [],
409
- "isAsync": true,
410
- "isClass": false
411
- },
412
- {
413
- "name": "apiRecoverPassword",
414
- "signature": "async function apiRecoverPassword(params: CustomerRecoverPasswordQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
415
- "description": "",
416
- "params": [],
417
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
418
- "categories": [],
419
- "related": [],
420
- "isAsync": true,
421
- "isClass": false
422
- },
423
- {
424
- "name": "apiCheckEmail",
425
- "signature": "async function apiCheckEmail(params: CheckCustomerEmailQueryParams): Promise<APIResponse<undefined> | APIResponse<CustomerCheckResponse>>",
426
- "description": "",
427
- "params": [],
428
- "returnType": "Promise<APIResponse<undefined> | APIResponse<CustomerCheckResponse>>",
429
- "categories": [],
430
- "related": [],
431
- "isAsync": true,
432
- "isClass": false
433
- },
434
- {
435
- "name": "apiGetCustomer",
436
- "signature": "async function apiGetCustomer(): Promise<APIResponse<IkasCustomer | null>>",
437
- "description": "",
438
- "params": [],
439
- "returnType": "Promise<APIResponse<IkasCustomer | null>>",
440
- "categories": [],
441
- "related": [],
442
- "isAsync": true,
443
- "isClass": false,
444
- "parameterTypes": [
445
- "IkasCustomer"
446
- ]
447
- },
448
- {
449
- "name": "apiSaveCustomer",
450
- "signature": "async function apiSaveCustomer(params: SaveMyCustomerQueryParams): Promise<APIResponse<IkasCustomer | null>>",
451
- "description": "",
452
- "params": [],
453
- "returnType": "Promise<APIResponse<IkasCustomer | null>>",
454
- "categories": [],
455
- "related": [],
456
- "isAsync": true,
457
- "isClass": false,
458
- "parameterTypes": [
459
- "IkasCustomer"
460
- ]
461
- },
462
- {
463
- "name": "apiSaveCustomerFormData",
464
- "signature": "async function apiSaveCustomerFormData(params: SaveCustomerFormDataQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
465
- "description": "",
466
- "params": [],
467
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
468
- "categories": [],
469
- "related": [],
470
- "isAsync": true,
471
- "isClass": false
472
- },
473
- {
474
- "name": "apiGetOrders",
475
- "signature": "async function apiGetOrders(params: GetCustomerOrdersQueryParams): Promise<APIResponse<IkasOrder[]>>",
476
- "description": "",
477
- "params": [],
478
- "returnType": "Promise<APIResponse<IkasOrder[]>>",
479
- "categories": [],
480
- "related": [],
481
- "isAsync": true,
482
- "isClass": false,
483
- "parameterTypes": [
484
- "IkasOrder"
485
- ]
486
- },
487
- {
488
- "name": "apiGetOrderByEmail",
489
- "signature": "async function apiGetOrderByEmail(params: GetOrderByEmailQueryParams): Promise<APIResponse<IkasOrder>>",
490
- "description": "",
491
- "params": [],
492
- "returnType": "Promise<APIResponse<IkasOrder>>",
493
- "categories": [],
494
- "related": [],
495
- "isAsync": true,
496
- "isClass": false,
497
- "parameterTypes": [
498
- "IkasOrder"
499
- ]
500
- },
501
- {
502
- "name": "apiListOrderTransactions",
503
- "signature": "async function apiListOrderTransactions(params: ListOrderTransactionsQueryParams): Promise<APIResponse<IkasOrderTransaction[]>>",
504
- "description": "",
505
- "params": [],
506
- "returnType": "Promise<APIResponse<IkasOrderTransaction[]>>",
507
- "categories": [],
508
- "related": [],
509
- "isAsync": true,
510
- "isClass": false,
511
- "parameterTypes": [
512
- "IkasOrderTransaction"
513
- ]
514
- },
515
- {
516
- "name": "apiCreateOrderRefundRequest",
517
- "signature": "async function apiCreateOrderRefundRequest(params: CreateOrderRefundRequestQueryParams): Promise<APIResponse<IkasOrder>>",
518
- "description": "",
519
- "params": [],
520
- "returnType": "Promise<APIResponse<IkasOrder>>",
521
- "categories": [],
522
- "related": [],
523
- "isAsync": true,
524
- "isClass": false,
525
- "parameterTypes": [
526
- "IkasOrder"
527
- ]
528
- },
529
- {
530
- "name": "apiSubscribeToMarketingNotifications",
531
- "signature": "async function apiSubscribeToMarketingNotifications(params: SubscribeToMarketingNotificationsQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
532
- "description": "",
533
- "params": [],
534
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
535
- "categories": [],
536
- "related": [],
537
- "isAsync": true,
538
- "isClass": false
539
- },
540
- {
541
- "name": "apiGetLastViewedProducts",
542
- "signature": "async function apiGetLastViewedProducts(params: GetLastViewedProductsQueryParams): Promise<APIResponse<IkasLastViewedProduct[]>>",
543
- "description": "",
544
- "params": [],
545
- "returnType": "Promise<APIResponse<IkasLastViewedProduct[]>>",
546
- "categories": [],
547
- "related": [],
548
- "isAsync": true,
549
- "isClass": false,
550
- "parameterTypes": [
551
- "IkasLastViewedProduct"
552
- ]
553
- },
554
- {
555
- "name": "apiSaveLastViewedProducts",
556
- "signature": "async function apiSaveLastViewedProducts(params: SaveLastViewedProductsQueryParams): Promise<APIResponse<undefined> | APIResponse<ProductLastViewed>>",
557
- "description": "",
558
- "params": [],
559
- "returnType": "Promise<APIResponse<undefined> | APIResponse<ProductLastViewed>>",
560
- "categories": [],
561
- "related": [],
562
- "isAsync": true,
563
- "isClass": false
564
- },
565
- {
566
- "name": "apiListOrderRefundSettings",
567
- "signature": "async function apiListOrderRefundSettings(params: ListOrderRefundSettingsQueryParams): Promise<APIResponse<IkasOrderRefundSettings[] | null>>",
568
- "description": "",
569
- "params": [],
570
- "returnType": "Promise<APIResponse<IkasOrderRefundSettings[] | null>>",
571
- "categories": [],
572
- "related": [],
573
- "isAsync": true,
574
- "isClass": false,
575
- "parameterTypes": [
576
- "IkasOrderRefundSettings"
577
- ]
578
- },
579
- {
580
- "name": "apiSendContactFormToMerchant",
581
- "signature": "async function apiSendContactFormToMerchant(params: SendContactFormToMerchantQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
582
- "description": "",
583
- "params": [],
584
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
585
- "categories": [],
586
- "related": [],
587
- "isAsync": true,
588
- "isClass": false
589
- },
590
- {
591
- "name": "apiListFavoriteProducts",
592
- "signature": "async function apiListFavoriteProducts(): Promise<APIResponse<IkasFavoriteProduct[] | null>>",
593
- "description": "",
594
- "params": [],
595
- "returnType": "Promise<APIResponse<IkasFavoriteProduct[] | null>>",
596
- "categories": [],
597
- "related": [],
598
- "isAsync": true,
599
- "isClass": false,
600
- "parameterTypes": [
601
- "IkasFavoriteProduct"
602
- ]
603
- },
604
- {
605
- "name": "apiSaveFavoriteProduct",
606
- "signature": "async function apiSaveFavoriteProduct(params: SaveFavoriteProductQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
607
- "description": "",
608
- "params": [],
609
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
610
- "categories": [],
611
- "related": [],
612
- "isAsync": true,
613
- "isClass": false
614
- },
615
- {
616
- "name": "apiIsFavoriteProduct",
617
- "signature": "async function apiIsFavoriteProduct(params: IsFavoriteProductQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
618
- "description": "",
619
- "params": [],
620
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
621
- "categories": [],
622
- "related": [],
623
- "isAsync": true,
624
- "isClass": false
625
- },
626
- {
627
- "name": "apiCreateCustomerReview",
628
- "signature": "async function apiCreateCustomerReview(params: CreateCustomerReviewQueryParams): Promise<APIResponse<IkasCustomerReview>>",
629
- "description": "",
630
- "params": [],
631
- "returnType": "Promise<APIResponse<IkasCustomerReview>>",
632
- "categories": [],
633
- "related": [],
634
- "isAsync": true,
635
- "isClass": false,
636
- "parameterTypes": [
637
- "IkasCustomerReview"
638
- ]
639
- },
640
- {
641
- "name": "apiListCustomerReviews",
642
- "signature": "async function apiListCustomerReviews(params: ListCustomerReviewsQueryParams): Promise<APIResponse<{ data: IkasCustomerReview[]; count: number; hasNext: boolean; limit: number; page: number; } | null>>",
643
- "description": "",
644
- "params": [],
645
- "returnType": "Promise<APIResponse<{ data: IkasCustomerReview[]; count: number; hasNext: boolean; limit: number; page: number; } | null>>",
646
- "categories": [],
647
- "related": [],
648
- "isAsync": true,
649
- "isClass": false,
650
- "parameterTypes": [
651
- "IkasCustomerReview"
652
- ]
653
- },
654
- {
655
- "name": "apiListCustomerReviewSummary",
656
- "signature": "async function apiListCustomerReviewSummary(params: ListCustomerReviewSummaryQueryParams): Promise<APIResponse<{ data: IkasCustomerReviewSummary[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
657
- "description": "",
658
- "params": [],
659
- "returnType": "Promise<APIResponse<{ data: IkasCustomerReviewSummary[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
660
- "categories": [],
661
- "related": [],
662
- "isAsync": true,
663
- "isClass": false,
664
- "parameterTypes": [
665
- "IkasCustomerReviewSummary"
666
- ]
667
- },
668
- {
669
- "name": "apiListCustomerAttribute",
670
- "signature": "async function apiListCustomerAttribute(): Promise<APIResponse<IkasCustomerAttribute[]>>",
671
- "description": "",
672
- "params": [],
673
- "returnType": "Promise<APIResponse<IkasCustomerAttribute[]>>",
674
- "categories": [],
675
- "related": [],
676
- "isAsync": true,
677
- "isClass": false,
678
- "parameterTypes": [
679
- "IkasCustomerAttribute"
680
- ]
681
- },
682
- {
683
- "name": "apiListCustomerSettings",
684
- "signature": "async function apiListCustomerSettings(params: ListCustomerSettingsQueryParams): Promise<APIResponse<{ data: IkasCustomerSettings[]; length?: number | undefined; toString?: (() => string) | undefined; toLocaleString?: { (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; } | undefined; ... 31 more ...; at?: ((index: number) => Cu...",
685
- "description": "",
686
- "params": [],
687
- "returnType": "Promise<APIResponse<{ data: IkasCustomerSettings[]; length?: number | undefined; toString?: (() => string) | undefined; toLocaleString?: { (): string; (locales: string | string[], options?: (NumberFormatOptions & DateTimeFormatOptions) | undefined): string; } | undefined; ... 31 more ...; at?: ((index: number) => Cu...",
688
- "categories": [],
689
- "related": [],
690
- "isAsync": true,
691
- "isClass": false,
692
- "parameterTypes": [
693
- "IkasCustomerSettings"
694
- ]
695
- },
696
- {
697
- "name": "apiActivateCustomer",
698
- "signature": "async function apiActivateCustomer(params: ActivateCustomerQueryParams): Promise<APIResponse<undefined> | APIResponse<string>>",
699
- "description": "",
700
- "params": [],
701
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
702
- "categories": [],
703
- "related": [],
704
- "isAsync": true,
705
- "isClass": false
706
- },
707
- {
708
- "name": "apiResendCustomerActivationMail",
709
- "signature": "async function apiResendCustomerActivationMail(params: ResendCustomerActivationMailQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
710
- "description": "",
711
- "params": [],
712
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
713
- "categories": [],
714
- "related": [],
715
- "isAsync": true,
716
- "isClass": false
717
- },
718
- {
719
- "name": "apiResendCustomerPhoneVerificationCode",
720
- "signature": "async function apiResendCustomerPhoneVerificationCode(): Promise<APIResponse<undefined> | APIResponse<boolean>>",
721
- "description": "",
722
- "params": [],
723
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
724
- "categories": [],
725
- "related": [],
726
- "isAsync": true,
727
- "isClass": false
728
- },
729
- {
730
- "name": "apiValidateCustomerPhoneVerificationCode",
731
- "signature": "async function apiValidateCustomerPhoneVerificationCode(params: ValidateCustomerPhoneVerificationCodeQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
732
- "description": "",
733
- "params": [],
734
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
735
- "categories": [],
736
- "related": [],
737
- "isAsync": true,
738
- "isClass": false
739
- },
740
- {
741
- "name": "apiValidateOTPCode",
742
- "signature": "async function apiValidateOTPCode(params: ValidateOTPCodeQueryParams): Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
743
- "description": "",
744
- "params": [],
745
- "returnType": "Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
746
- "categories": [],
747
- "related": [],
748
- "isAsync": true,
749
- "isClass": false,
750
- "parameterTypes": [
751
- "IkasCustomer"
752
- ]
753
- },
754
- {
755
- "name": "apiDeactivateCustomer",
756
- "signature": "async function apiDeactivateCustomer(params: CustomerDeactivateQueryParams): Promise<APIResponse<undefined> | APIResponse<boolean>>",
757
- "description": "",
758
- "params": [],
759
- "returnType": "Promise<APIResponse<undefined> | APIResponse<boolean>>",
760
- "categories": [],
761
- "related": [],
762
- "isAsync": true,
763
- "isClass": false
764
- },
765
- {
766
- "name": "apiExportCustomerPersonalData",
767
- "signature": "async function apiExportCustomerPersonalData(): Promise<APIResponse<undefined> | APIResponse<string>>",
768
- "description": "",
769
- "params": [],
770
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
771
- "categories": [],
772
- "related": [],
773
- "isAsync": true,
774
- "isClass": false
775
- },
776
- {
777
- "name": "apiGetDigitalProductFileDownloadUrl",
778
- "signature": "async function apiGetDigitalProductFileDownloadUrl(orderId: string, orderLineItemId: string): Promise<APIResponse<undefined> | APIResponse<string>>",
779
- "description": "",
780
- "params": [],
781
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
782
- "categories": [],
783
- "related": [],
784
- "isAsync": true,
785
- "isClass": false
786
- },
787
- {
788
- "name": "apiGetProductOptionFileUrl",
789
- "signature": "async function apiGetProductOptionFileUrl(params: GetProductOptionFileUrlQueryParams, file: File): Promise<APIResponse<{ file: File; fields: any; optionUrl: string; url: string; } | null>>",
790
- "description": "",
791
- "params": [],
792
- "returnType": "Promise<APIResponse<{ file: File; fields: any; optionUrl: string; url: string; } | null>>",
793
- "categories": [],
794
- "related": [],
795
- "isAsync": true,
796
- "isClass": false
797
- },
798
- {
799
- "name": "apiUploadFile",
800
- "signature": "async function apiUploadFile(params: IkasProductOptionFileUrl, file: File): Promise<boolean>",
801
- "description": "",
802
- "params": [],
803
- "returnType": "Promise<boolean>",
804
- "categories": [],
805
- "related": [],
806
- "isAsync": true,
807
- "isClass": false,
808
- "parameterTypes": [
809
- "IkasProductOptionFileUrl"
810
- ]
811
- },
812
- {
813
- "name": "apiListHTMLMetaData",
814
- "signature": "async function apiListHTMLMetaData(params: ListHTMLMetaDataQueryParams): Promise<APIResponse<IkasHTMLMetaData[]>>",
815
- "description": "",
816
- "params": [],
817
- "returnType": "Promise<APIResponse<IkasHTMLMetaData[]>>",
818
- "categories": [],
819
- "related": [],
820
- "isAsync": true,
821
- "isClass": false,
822
- "parameterTypes": [
823
- "IkasHTMLMetaData"
824
- ]
825
- },
826
- {
827
- "name": "apiGetMyCountry",
828
- "signature": "async function apiGetMyCountry(): Promise<APIResponse<undefined> | APIResponse<string>>",
829
- "description": "",
830
- "params": [],
831
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
832
- "categories": [],
833
- "related": [],
834
- "isAsync": true,
835
- "isClass": false
836
- },
837
- {
838
- "name": "apiListCountry",
839
- "signature": "async function apiListCountry(params: ListCountryQueryParams): Promise<APIResponse<IkasCountry[]>>",
840
- "description": "",
841
- "params": [],
842
- "returnType": "Promise<APIResponse<IkasCountry[]>>",
843
- "categories": [],
844
- "related": [],
845
- "isAsync": true,
846
- "isClass": false,
847
- "parameterTypes": [
848
- "IkasCountry"
849
- ]
850
- },
851
- {
852
- "name": "apiListCity",
853
- "signature": "async function apiListCity(params: ListCityQueryParams): Promise<APIResponse<IkasCity[]>>",
854
- "description": "",
855
- "params": [],
856
- "returnType": "Promise<APIResponse<IkasCity[]>>",
857
- "categories": [],
858
- "related": [],
859
- "isAsync": true,
860
- "isClass": false,
861
- "parameterTypes": [
862
- "IkasCity"
863
- ]
864
- },
865
- {
866
- "name": "apiListDistrict",
867
- "signature": "async function apiListDistrict(params: ListDistrictQueryParams): Promise<APIResponse<IkasDistrict[]>>",
868
- "description": "",
869
- "params": [],
870
- "returnType": "Promise<APIResponse<IkasDistrict[]>>",
871
- "categories": [],
872
- "related": [],
873
- "isAsync": true,
874
- "isClass": false,
875
- "parameterTypes": [
876
- "IkasDistrict"
877
- ]
878
- },
879
- {
880
- "name": "apiListState",
881
- "signature": "async function apiListState(params: ListStateQueryParams): Promise<APIResponse<IkasState[]>>",
882
- "description": "",
883
- "params": [],
884
- "returnType": "Promise<APIResponse<IkasState[]>>",
885
- "categories": [],
886
- "related": [],
887
- "isAsync": true,
888
- "isClass": false,
889
- "parameterTypes": [
890
- "IkasState"
891
- ]
892
- },
893
- {
894
- "name": "apiGetAvailableShippingZones",
895
- "signature": "async function apiGetAvailableShippingZones(params: GetAvailableShippingZonesQueryParams): Promise<APIResponse<IkasShippingZone[]>>",
896
- "description": "",
897
- "params": [],
898
- "returnType": "Promise<APIResponse<IkasShippingZone[]>>",
899
- "categories": [],
900
- "related": [],
901
- "isAsync": true,
902
- "isClass": false,
903
- "parameterTypes": [
904
- "IkasShippingZone"
905
- ]
906
- },
907
- {
908
- "name": "apiGetStorefrontWidgetSettings",
909
- "signature": "async function apiGetStorefrontWidgetSettings(): Promise<APIResponse<IkasStorefrontWidgetSettings>>",
910
- "description": "",
911
- "params": [],
912
- "returnType": "Promise<APIResponse<IkasStorefrontWidgetSettings>>",
913
- "categories": [],
914
- "related": [],
915
- "isAsync": true,
916
- "isClass": false,
917
- "parameterTypes": [
918
- "IkasStorefrontWidgetSettings"
43
+ "IkasStorefrontWidgetSettings"
919
44
  ]
920
45
  },
921
46
  {
922
47
  "name": "apiListEarningMethods",
923
- "signature": "async function apiListEarningMethods(): Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
924
- "description": "",
925
- "params": [],
926
- "returnType": "Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
927
- "categories": [],
928
- "related": [],
929
- "isAsync": true,
930
- "isClass": false,
931
- "parameterTypes": [
932
- "IkasLoyaltyProgramEarningMethod"
933
- ]
934
- },
935
- {
936
- "name": "apiListLoyaltyProgramTiers",
937
- "signature": "async function apiListLoyaltyProgramTiers(): Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
938
- "description": "",
939
- "params": [],
940
- "returnType": "Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
941
- "categories": [],
942
- "related": [],
943
- "isAsync": true,
944
- "isClass": false,
945
- "parameterTypes": [
946
- "IkasLoyaltyProgramTier"
947
- ]
948
- },
949
- {
950
- "name": "apiListSpendingMethodsByCartId",
951
- "signature": "async function apiListSpendingMethodsByCartId(params: ListSpendingMethodsByCartIdQueryParams): Promise<APIResponse<IkasLoyaltyProgramSpendingMethod[]>>",
952
- "description": "",
953
- "params": [],
954
- "returnType": "Promise<APIResponse<IkasLoyaltyProgramSpendingMethod[]>>",
955
- "categories": [],
956
- "related": [],
957
- "isAsync": true,
958
- "isClass": false,
959
- "parameterTypes": [
960
- "IkasLoyaltyProgramSpendingMethod"
961
- ]
962
- },
963
- {
964
- "name": "apiGetLoyaltyCustomerInfo",
965
- "signature": "async function apiGetLoyaltyCustomerInfo(params: GetLoyaltyCustomerInfoQueryParams): Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
966
- "description": "",
967
- "params": [],
968
- "returnType": "Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
969
- "categories": [],
970
- "related": [],
971
- "isAsync": true,
972
- "isClass": false,
973
- "parameterTypes": [
974
- "IkasLoyaltyCustomerInfo"
975
- ]
976
- },
977
- {
978
- "name": "apiListLoyaltyProgramPointHistory",
979
- "signature": "async function apiListLoyaltyProgramPointHistory(params: ListLoyaltyProgramPointHistoryQueryParams): Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
980
- "description": "",
981
- "params": [],
982
- "returnType": "Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
983
- "categories": [],
984
- "related": [],
985
- "isAsync": true,
986
- "isClass": false,
987
- "parameterTypes": [
988
- "IkasLoyaltyProgramPointHistory"
989
- ]
990
- },
991
- {
992
- "name": "apiUseLoyaltyPoints",
993
- "signature": "async function apiUseLoyaltyPoints(params: UseLoyaltyPointsQueryParams): Promise<APIResponse<CartV2>>",
994
- "description": "",
995
- "params": [],
996
- "returnType": "Promise<APIResponse<CartV2>>",
997
- "categories": [],
998
- "related": [],
999
- "isAsync": true,
1000
- "isClass": false
1001
- },
1002
- {
1003
- "name": "apiRemoveLoyaltyPointsFromCart",
1004
- "signature": "async function apiRemoveLoyaltyPointsFromCart(params: RemoveLoyaltyPointsFromCartQueryParams): Promise<APIResponse<CartV2>>",
1005
- "description": "",
1006
- "params": [],
1007
- "returnType": "Promise<APIResponse<CartV2>>",
1008
- "categories": [],
1009
- "related": [],
1010
- "isAsync": true,
1011
- "isClass": false
1012
- },
1013
- {
1014
- "name": "apiGetMasterPassRequestToken",
1015
- "signature": "async function apiGetMasterPassRequestToken(data: GetMasterPassRequestTokenQueryParams): Promise<APIResponse<undefined> | APIResponse<MasterPassTokenResponse>>",
1016
- "description": "",
1017
- "params": [],
1018
- "returnType": "Promise<APIResponse<undefined> | APIResponse<MasterPassTokenResponse>>",
1019
- "categories": [],
1020
- "related": [],
1021
- "isAsync": true,
1022
- "isClass": false
1023
- },
1024
- {
1025
- "name": "apiListMerchantSettings",
1026
- "signature": "async function apiListMerchantSettings(params: ListMerchantSettingsQueryParams): Promise<APIResponse<IkasMerchantSettings | null>>",
1027
- "description": "",
1028
- "params": [],
1029
- "returnType": "Promise<APIResponse<IkasMerchantSettings | null>>",
1030
- "categories": [],
1031
- "related": [],
1032
- "isAsync": true,
1033
- "isClass": false,
1034
- "parameterTypes": [
1035
- "IkasMerchantSettings"
1036
- ]
1037
- },
1038
- {
1039
- "name": "apiListStorefrontPopup",
1040
- "signature": "async function apiListStorefrontPopup(params: ListStorefrontPopupQueryParams): Promise<APIResponse<IkasStorefrontPopup[]>>",
1041
- "description": "",
1042
- "params": [],
1043
- "returnType": "Promise<APIResponse<IkasStorefrontPopup[]>>",
1044
- "categories": [],
1045
- "related": [],
1046
- "isAsync": true,
1047
- "isClass": false,
1048
- "parameterTypes": [
1049
- "IkasStorefrontPopup"
1050
- ]
1051
- },
1052
- {
1053
- "name": "apiListProductBackInStockRemind",
1054
- "signature": "async function apiListProductBackInStockRemind(params: ListProductBackInStockRemindQueryParams): Promise<APIResponse<undefined> | APIResponse<ProductBackInStockRemind[]>>",
1055
- "description": "",
1056
- "params": [],
1057
- "returnType": "Promise<APIResponse<undefined> | APIResponse<ProductBackInStockRemind[]>>",
1058
- "categories": [],
1059
- "related": [],
1060
- "isAsync": true,
1061
- "isClass": false
1062
- },
1063
- {
1064
- "name": "apiSaveProductBackInStockRemind",
1065
- "signature": "async function apiSaveProductBackInStockRemind(params: SaveProductBackInStockRemindQueryParams): Promise<APIResponse<undefined> | APIResponse<ProductBackInStockRemind>>",
1066
- "description": "",
1067
- "params": [],
1068
- "returnType": "Promise<APIResponse<undefined> | APIResponse<ProductBackInStockRemind>>",
1069
- "categories": [],
1070
- "related": [],
1071
- "isAsync": true,
1072
- "isClass": false
1073
- },
1074
- {
1075
- "name": "apiListCampaignOffer",
1076
- "signature": "async function apiListCampaignOffer(params: ListCampaignOfferQueryParams): Promise<APIResponse<CampaignOffer[] | null>>",
1077
- "description": "",
1078
- "params": [],
1079
- "returnType": "Promise<APIResponse<CampaignOffer[] | null>>",
1080
- "categories": [],
1081
- "related": [],
1082
- "isAsync": true,
1083
- "isClass": false
1084
- },
1085
- {
1086
- "name": "apiSearchProducts",
1087
- "signature": "async function apiSearchProducts(params: SearchProductsQueryParams, excludedFields?: string[]): Promise<APIResponse<{ data: IkasProduct[] | undefined; catalogResults: SearchCatalog[] | null; count: number; facets: ProductFacetCount[] | null; ... 4 more ...; totalCount: number; } | null>>",
1088
- "description": "",
1089
- "params": [],
1090
- "returnType": "Promise<APIResponse<{ data: IkasProduct[] | undefined; catalogResults: SearchCatalog[] | null; count: number; facets: ProductFacetCount[] | null; ... 4 more ...; totalCount: number; } | null>>",
1091
- "categories": [],
1092
- "related": [],
1093
- "isAsync": true,
1094
- "isClass": false,
1095
- "parameterTypes": [
1096
- "IkasProduct"
1097
- ]
1098
- },
1099
- {
1100
- "name": "apiGetProductFilterData",
1101
- "signature": "async function apiGetProductFilterData(params: GetProductFilterDataQueryParams): Promise<APIResponse<{ filters: IkasProductFilter[]; categories: IkasFilterCategory[] | null; disabledSortTypes: SortByTypeEnum[] | null; } | null>>",
1102
- "description": "",
1103
- "params": [],
1104
- "returnType": "Promise<APIResponse<{ filters: IkasProductFilter[]; categories: IkasFilterCategory[] | null; disabledSortTypes: SortByTypeEnum[] | null; } | null>>",
1105
- "categories": [],
1106
- "related": [],
1107
- "isAsync": true,
1108
- "isClass": false,
1109
- "parameterTypes": [
1110
- "IkasProductFilter",
1111
- "IkasFilterCategory"
1112
- ]
1113
- },
1114
- {
1115
- "name": "apiGetRelatedProducts",
1116
- "signature": "async function apiGetRelatedProducts(params: GetRelatedProductsQueryParams): Promise<APIResponse<{ data: IkasProduct[]; count: any; facets: null; limit: number; page: number; totalCount: any; } | null>>",
1117
- "description": "",
1118
- "params": [],
1119
- "returnType": "Promise<APIResponse<{ data: IkasProduct[]; count: any; facets: null; limit: number; page: number; totalCount: any; } | null>>",
1120
- "categories": [],
1121
- "related": [],
1122
- "isAsync": true,
1123
- "isClass": false,
1124
- "parameterTypes": [
1125
- "IkasProduct"
1126
- ]
1127
- },
1128
- {
1129
- "name": "apiGetSuggestedProducts",
1130
- "signature": "async function apiGetSuggestedProducts(params: GetSuggestedProductsQueryParams): Promise<APIResponse<{ data: IkasProduct[]; count: number; facets: null; limit: number; page: number; totalCount: number; } | null>>",
1131
- "description": "",
1132
- "params": [],
1133
- "returnType": "Promise<APIResponse<{ data: IkasProduct[]; count: number; facets: null; limit: number; page: number; totalCount: number; } | null>>",
1134
- "categories": [],
1135
- "related": [],
1136
- "isAsync": true,
1137
- "isClass": false,
1138
- "parameterTypes": [
1139
- "IkasProduct"
1140
- ]
1141
- },
1142
- {
1143
- "name": "apiListProductAttribute",
1144
- "signature": "async function apiListProductAttribute(params: ListProductAttributeQueryParams): Promise<APIResponse<IkasProductAttribute[]>>",
1145
- "description": "",
1146
- "params": [],
1147
- "returnType": "Promise<APIResponse<IkasProductAttribute[]>>",
1148
- "categories": [],
1149
- "related": [],
1150
- "isAsync": true,
1151
- "isClass": false,
1152
- "parameterTypes": [
1153
- "IkasProductAttribute"
1154
- ]
1155
- },
1156
- {
1157
- "name": "apiGetProductCampaigns",
1158
- "signature": "async function apiGetProductCampaigns(params: GetProductCampaignsQueryParams): Promise<APIResponse<IkasProductCampaign[]>>",
48
+ "signature": "async function apiListEarningMethods(): Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
1159
49
  "description": "",
1160
50
  "params": [],
1161
- "returnType": "Promise<APIResponse<IkasProductCampaign[]>>",
51
+ "returnType": "Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
1162
52
  "categories": [],
1163
53
  "related": [],
1164
54
  "isAsync": true,
1165
55
  "isClass": false,
1166
56
  "parameterTypes": [
1167
- "IkasProductCampaign"
57
+ "IkasLoyaltyProgramEarningMethod"
1168
58
  ]
1169
59
  },
1170
60
  {
1171
- "name": "apiGetVariantStockLocations",
1172
- "signature": "async function apiGetVariantStockLocations(data: GetVariantStockLocationsQueryParams): Promise<APIResponse<IkasProductStockLocations[]>>",
61
+ "name": "apiListLoyaltyProgramTiers",
62
+ "signature": "async function apiListLoyaltyProgramTiers(): Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
1173
63
  "description": "",
1174
64
  "params": [],
1175
- "returnType": "Promise<APIResponse<IkasProductStockLocations[]>>",
65
+ "returnType": "Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
1176
66
  "categories": [],
1177
67
  "related": [],
1178
68
  "isAsync": true,
1179
69
  "isClass": false,
1180
70
  "parameterTypes": [
1181
- "IkasProductStockLocations"
71
+ "IkasLoyaltyProgramTier"
1182
72
  ]
1183
73
  },
1184
74
  {
1185
- "name": "apiGetOrderLineFile",
1186
- "signature": "async function apiGetOrderLineFile(params: GetOrderLineFileQueryParams): Promise<APIResponse<undefined> | APIResponse<string>>",
75
+ "name": "apiListSpendingMethodsByCartId",
76
+ "signature": "async function apiListSpendingMethodsByCartId(params: ListSpendingMethodsByCartIdQueryParams): Promise<APIResponse<IkasLoyaltyProgramSpendingMethod[]>>",
1187
77
  "description": "",
1188
78
  "params": [],
1189
- "returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
79
+ "returnType": "Promise<APIResponse<IkasLoyaltyProgramSpendingMethod[]>>",
1190
80
  "categories": [],
1191
81
  "related": [],
1192
82
  "isAsync": true,
1193
- "isClass": false
83
+ "isClass": false,
84
+ "parameterTypes": [
85
+ "IkasLoyaltyProgramSpendingMethod"
86
+ ]
1194
87
  },
1195
88
  {
1196
- "name": "apiListProductOptionSet",
1197
- "signature": "async function apiListProductOptionSet(params: ListProductOptionSetQueryParams, product: IkasProduct): Promise<APIResponse<IkasProductOptionSet[]>>",
89
+ "name": "apiGetLoyaltyCustomerInfo",
90
+ "signature": "async function apiGetLoyaltyCustomerInfo(params: GetLoyaltyCustomerInfoQueryParams): Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
1198
91
  "description": "",
1199
92
  "params": [],
1200
- "returnType": "Promise<APIResponse<IkasProductOptionSet[]>>",
93
+ "returnType": "Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
1201
94
  "categories": [],
1202
95
  "related": [],
1203
96
  "isAsync": true,
1204
97
  "isClass": false,
1205
98
  "parameterTypes": [
1206
- "IkasProduct",
1207
- "IkasProductOptionSet"
99
+ "IkasLoyaltyCustomerInfo"
1208
100
  ]
1209
101
  },
1210
102
  {
1211
- "name": "apiListStorefrontRaffle",
1212
- "signature": "async function apiListStorefrontRaffle(params: ListStorefrontRaffleQueryParams): Promise<APIResponse<{ data: IkasRaffle[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
103
+ "name": "apiListLoyaltyProgramPointHistory",
104
+ "signature": "async function apiListLoyaltyProgramPointHistory(params: ListLoyaltyProgramPointHistoryQueryParams): Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
1213
105
  "description": "",
1214
106
  "params": [],
1215
- "returnType": "Promise<APIResponse<{ data: IkasRaffle[]; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
107
+ "returnType": "Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
1216
108
  "categories": [],
1217
109
  "related": [],
1218
110
  "isAsync": true,
1219
111
  "isClass": false,
1220
112
  "parameterTypes": [
1221
- "IkasRaffle"
113
+ "IkasLoyaltyProgramPointHistory"
1222
114
  ]
1223
115
  },
1224
116
  {
1225
- "name": "apiSaveRaffleParticipant",
1226
- "signature": "async function apiSaveRaffleParticipant(params: SaveRaffleParticipantQueryParams): Promise<APIResponse<IkasRaffleParticipant | null>>",
117
+ "name": "apiUseLoyaltyPoints",
118
+ "signature": "async function apiUseLoyaltyPoints(params: UseLoyaltyPointsQueryParams): Promise<APIResponse<CartV2>>",
1227
119
  "description": "",
1228
120
  "params": [],
1229
- "returnType": "Promise<APIResponse<IkasRaffleParticipant | null>>",
121
+ "returnType": "Promise<APIResponse<CartV2>>",
1230
122
  "categories": [],
1231
123
  "related": [],
1232
124
  "isAsync": true,
1233
- "isClass": false,
1234
- "parameterTypes": [
1235
- "IkasRaffleParticipant"
1236
- ]
125
+ "isClass": false
1237
126
  },
1238
127
  {
1239
- "name": "apiListRaffleMetaData",
1240
- "signature": "async function apiListRaffleMetaData(params: ListRaffleMetadataQueryParams): Promise<APIResponse<IkasRaffleMetaData[]>>",
128
+ "name": "apiRemoveLoyaltyPointsFromCart",
129
+ "signature": "async function apiRemoveLoyaltyPointsFromCart(params: RemoveLoyaltyPointsFromCartQueryParams): Promise<APIResponse<CartV2>>",
1241
130
  "description": "",
1242
131
  "params": [],
1243
- "returnType": "Promise<APIResponse<IkasRaffleMetaData[]>>",
132
+ "returnType": "Promise<APIResponse<CartV2>>",
1244
133
  "categories": [],
1245
134
  "related": [],
1246
135
  "isAsync": true,
1247
- "isClass": false,
1248
- "parameterTypes": [
1249
- "IkasRaffleMetaData"
1250
- ]
136
+ "isClass": false
1251
137
  },
1252
138
  {
1253
- "name": "apiListRaffleParticipants",
1254
- "signature": "async function apiListRaffleParticipants(): Promise<APIResponse<IkasRaffleParticipant[]>>",
139
+ "name": "apiListStorefrontPopup",
140
+ "signature": "async function apiListStorefrontPopup(params: ListStorefrontPopupQueryParams): Promise<APIResponse<IkasStorefrontPopup[]>>",
1255
141
  "description": "",
1256
142
  "params": [],
1257
- "returnType": "Promise<APIResponse<IkasRaffleParticipant[]>>",
143
+ "returnType": "Promise<APIResponse<IkasStorefrontPopup[]>>",
1258
144
  "categories": [],
1259
145
  "related": [],
1260
146
  "isAsync": true,
1261
147
  "isClass": false,
1262
148
  "parameterTypes": [
1263
- "IkasRaffleParticipant"
149
+ "IkasStorefrontPopup"
1264
150
  ]
1265
151
  },
1266
152
  {
1267
- "name": "apiGetStorefrontSettings",
1268
- "signature": "async function apiGetStorefrontSettings(): Promise<APIResponse<IkasStorefrontSettings>>",
153
+ "name": "apiSearchProducts",
154
+ "signature": "async function apiSearchProducts(params: SearchProductsQueryParams, excludedFields?: string[]): Promise<APIResponse<{ data: IkasProduct[] | undefined; catalogResults: SearchCatalog[] | null; count: number; facets: ProductFacetCount[] | null; ... 4 more ...; totalCount: number; } | null>>",
1269
155
  "description": "",
1270
156
  "params": [],
1271
- "returnType": "Promise<APIResponse<IkasStorefrontSettings>>",
157
+ "returnType": "Promise<APIResponse<{ data: IkasProduct[] | undefined; catalogResults: SearchCatalog[] | null; count: number; facets: ProductFacetCount[] | null; ... 4 more ...; totalCount: number; } | null>>",
1272
158
  "categories": [],
1273
159
  "related": [],
1274
160
  "isAsync": true,
1275
161
  "isClass": false,
1276
162
  "parameterTypes": [
1277
- "IkasStorefrontSettings"
163
+ "IkasProduct"
1278
164
  ]
1279
165
  },
1280
166
  {
@@ -3875,16 +2761,16 @@
3875
2761
  {
3876
2762
  "name": "getDefaultSrc",
3877
2763
  "signature": "function getDefaultSrc(image: IkasImage): string",
3878
- "description": "Returns the default source URL for an image at 1080px resolution.",
2764
+ "description": "Returns the default source URL for an image OR video at 1080px resolution.\n\nProduct media items (IkasProductImage) can be videos. ALWAYS check `item.isVideo`\nand render a `<video src={getDefaultSrc(item)}>` instead of an `<img>` when it is true.\nNever assume every media item is an image.",
3879
2765
  "params": [
3880
2766
  {
3881
2767
  "name": "image",
3882
2768
  "description": "- The image object to generate the default source URL for."
3883
2769
  }
3884
2770
  ],
3885
- "returns": "The CDN URL string for the image at 1080px size.",
2771
+ "returns": "The CDN URL string for the image or video at 1080px size.",
3886
2772
  "returnType": "string",
3887
- "example": "```typescript\nimport { getDefaultSrc } from \"@ikas/bp-storefront\";\n\nconst src = getDefaultSrc(image);\nconsole.log(src); // \"https://cdn.example.com/images/.../1080/image.webp\"\n```",
2773
+ "example": "```typescript\nimport { getDefaultSrc, createMediaSrcset } from \"@ikas/bp-storefront\";\n\n// Product images can be videos — ALWAYS branch on isVideo when mapping media:\n{product.images.map((item, i) =>\n item.isVideo ? (\n <video key={i} src={getDefaultSrc(item)} muted playsInline preload=\"metadata\">\n <track kind=\"captions\" />\n </video>\n ) : (\n <img key={i} src={getDefaultSrc(item)} srcSet={createMediaSrcset(item)} alt={`Product ${i + 1}`} />\n )\n)}\n```",
3888
2774
  "categories": [
3889
2775
  "Image"
3890
2776
  ],
@@ -3902,16 +2788,16 @@
3902
2788
  {
3903
2789
  "name": "getThumbnailSrc",
3904
2790
  "signature": "function getThumbnailSrc(image: IkasImage): string",
3905
- "description": "Returns the thumbnail source URL for an image at 180px resolution.",
2791
+ "description": "Returns the thumbnail source URL for an image OR video at 180px resolution.\n\nWhen mapping over product media (IkasProductImage[]), some items are videos:\ncheck `item.isVideo` and render a `<video>` thumbnail (typically with a play\noverlay) instead of an `<img>` when it is true.",
3906
2792
  "params": [
3907
2793
  {
3908
2794
  "name": "image",
3909
2795
  "description": "- The image object to generate the thumbnail source URL for."
3910
2796
  }
3911
2797
  ],
3912
- "returns": "The CDN URL string for the image at 180px size.",
2798
+ "returns": "The CDN URL string for the image or video at 180px size.",
3913
2799
  "returnType": "string",
3914
- "example": "```typescript\nimport { getThumbnailSrc } from \"@ikas/bp-storefront\";\n\nconst thumbnailSrc = getThumbnailSrc(image);\nconsole.log(thumbnailSrc); // \"https://cdn.example.com/images/.../180/image.webp\"\n```",
2800
+ "example": "```typescript\nimport { getThumbnailSrc, getDefaultSrc } from \"@ikas/bp-storefront\";\n\n// Thumbnail rail — branch on isVideo per item:\n{product.images.map((item, i) =>\n item.isVideo ? (\n <video key={i} src={getDefaultSrc(item)} muted preload=\"metadata\">\n <track kind=\"captions\" />\n </video>\n ) : (\n <img key={i} src={getThumbnailSrc(item)} sizes=\"112px\" alt={`Thumb ${i + 1}`} />\n )\n)}\n```",
3915
2801
  "categories": [
3916
2802
  "Image"
3917
2803
  ],
@@ -3929,7 +2815,7 @@
3929
2815
  {
3930
2816
  "name": "getSrc",
3931
2817
  "signature": "function getSrc(image: IkasImage, size: number): string",
3932
- "description": "Generates the full CDN source URL for an image or video at the specified size, handling both legacy path-based and merchant-scoped ID formats.",
2818
+ "description": "Generates the full CDN source URL for an image or video at the specified size, handling both legacy path-based and merchant-scoped ID formats.\n\nNOTE: For videos (`image.isVideo === true`) the `size` argument is IGNORED — the original .mp4 is always returned.\nSo `getSrc(item, 240)` and `getDefaultSrc(item)` produce the identical URL for a video. PREFER `getDefaultSrc(item)`\nfor video `src` (no size param) — do NOT pass an arbitrary size like `getSrc(item, 240)`, it is misleading.",
3933
2819
  "params": [
3934
2820
  {
3935
2821
  "name": "image",
@@ -3937,12 +2823,12 @@
3937
2823
  },
3938
2824
  {
3939
2825
  "name": "size",
3940
- "description": "- The desired image width in pixels for the generated URL."
2826
+ "description": "- The desired image width in pixels. Ignored for videos."
3941
2827
  }
3942
2828
  ],
3943
2829
  "returns": "The full CDN URL string for the image or video.",
3944
2830
  "returnType": "string",
3945
- "example": "```typescript\nimport { getSrc } from \"@ikas/bp-storefront\";\n\nconst src = getSrc(image, 640);\nconsole.log(src); // \"https://cdn.example.com/images/.../640/image.webp\"\n```",
2831
+ "example": "```typescript\nimport { getSrc, getDefaultSrc } from \"@ikas/bp-storefront\";\n\nconst src = getSrc(image, 640);\nconsole.log(src); // \"https://cdn.example.com/images/.../640/image.webp\"\n\n// For a video, use getDefaultSrc (size is ignored anyway):\n<video src={getDefaultSrc(item)} muted playsInline preload=\"metadata\" />\n```",
3946
2832
  "categories": [
3947
2833
  "Image"
3948
2834
  ],
@@ -3960,7 +2846,7 @@
3960
2846
  {
3961
2847
  "name": "createMediaSrcset",
3962
2848
  "signature": "function createMediaSrcset(image?: IkasImage | null): string",
3963
- "description": "Generates a complete responsive `srcset` string for an image across all standard sizes (180–3840px).",
2849
+ "description": "Generates a complete responsive `srcset` string for an image across all standard sizes (180–3840px).\n\nsrcset applies to `<img>` only — video media (`item.isVideo === true`) has no srcset\nand must be rendered with `<video src={getDefaultSrc(item)}>`. When mapping product\nimages, branch on `item.isVideo` first, then only use createMediaSrcset on the image branch.",
3964
2850
  "params": [
3965
2851
  {
3966
2852
  "name": "image",
@@ -3969,7 +2855,7 @@
3969
2855
  ],
3970
2856
  "returns": "A srcset string like `\"url 180w, url 360w, ...\"`, or an empty string if no image is provided.",
3971
2857
  "returnType": "string",
3972
- "example": "```typescript\nimport { createMediaSrcset, getDefaultSrc } from \"@ikas/bp-storefront\";\n\n<img\n src={getDefaultSrc(image)}\n srcSet={createMediaSrcset(image)}\n sizes=\"(max-width: 768px) 100vw, 50vw\"\n alt=\"Product\"\n/>\n```",
2858
+ "example": "```typescript\nimport { createMediaSrcset, getDefaultSrc } from \"@ikas/bp-storefront\";\n\n// Product images can be videos — ALWAYS branch on isVideo when mapping media:\n{product.images.map((item, i) =>\n item.isVideo ? (\n <video key={i} src={getDefaultSrc(item)} muted playsInline preload=\"metadata\">\n <track kind=\"captions\" />\n </video>\n ) : (\n <img\n key={i}\n src={getDefaultSrc(item)}\n srcSet={createMediaSrcset(item)}\n sizes=\"(max-width: 768px) 100vw, 50vw\"\n alt={`Product ${i + 1}`}\n />\n )\n)}\n```",
3973
2859
  "categories": [
3974
2860
  "Image"
3975
2861
  ],
@@ -5619,37 +4505,6 @@
5619
4505
  "IkasOrderLineVariantVariantValue"
5620
4506
  ]
5621
4507
  },
5622
- {
5623
- "name": "getOrderPackageOrderLineItems",
5624
- "displayName": "getOrderLineItems",
5625
- "signature": "function getOrderPackageOrderLineItems(order: IkasOrder, orderPackage: IkasOrderPackage): IkasOrderLineItem[]",
5626
- "description": "Filters and returns the order line items that belong to a specific order package.",
5627
- "params": [
5628
- {
5629
- "name": "order",
5630
- "description": "- The full order containing all line items."
5631
- },
5632
- {
5633
- "name": "orderPackage",
5634
- "description": "- The order package whose associated line items to retrieve."
5635
- }
5636
- ],
5637
- "returns": "An array of order line items whose IDs are included in the package's orderLineItemIds.",
5638
- "returnType": "IkasOrderLineItem[]",
5639
- "example": "```typescript\nimport { getOrderPackageOrderLineItems } from \"@ikas/bp-storefront\";\n\nconst lineItems = getOrderPackageOrderLineItems(order, order.orderPackages[0]);\nlineItems.forEach(item => console.log(item.name));\n```",
5640
- "categories": [
5641
- "OrderPackage",
5642
- "Order"
5643
- ],
5644
- "related": [],
5645
- "isAsync": false,
5646
- "isClass": false,
5647
- "parameterTypes": [
5648
- "IkasOrder",
5649
- "IkasOrderPackage",
5650
- "IkasOrderLineItem"
5651
- ]
5652
- },
5653
4508
  {
5654
4509
  "name": "getOrderTransactionFormattedAmount",
5655
4510
  "displayName": "getFormattedAmount",
@@ -5828,31 +4683,6 @@
5828
4683
  "IkasProduct"
5829
4684
  ]
5830
4685
  },
5831
- {
5832
- "name": "isProductOfferAccepted",
5833
- "displayName": "isAccepted",
5834
- "signature": "function isProductOfferAccepted(offer: IkasProductOffer): boolean",
5835
- "description": "Checks whether a product campaign offer has been accepted in the current cart by matching offer and product IDs with a PRODUCT target page type and ACCEPTED status.",
5836
- "params": [
5837
- {
5838
- "name": "offer",
5839
- "description": "- The product offer to check acceptance status for."
5840
- }
5841
- ],
5842
- "returns": "True if the offer is found in the cart with an ACCEPTED status targeting product pages, false otherwise.",
5843
- "returnType": "boolean",
5844
- "example": "```typescript\nimport { isProductOfferAccepted } from \"@ikas/bp-storefront\";\nif (isProductOfferAccepted(product.offers[0])) {\n console.log(\"Campaign offer has been accepted\");\n}\n```",
5845
- "categories": [
5846
- "CampaignOffer",
5847
- "Product"
5848
- ],
5849
- "related": [],
5850
- "isAsync": false,
5851
- "isClass": false,
5852
- "parameterTypes": [
5853
- "IkasProductOffer"
5854
- ]
5855
- },
5856
4686
  {
5857
4687
  "name": "isCustomValueFilter",
5858
4688
  "signature": "function isCustomValueFilter(filter: IkasProductFilter): boolean",
@@ -7622,6 +6452,32 @@
7622
6452
  "IkasProductOption"
7623
6453
  ]
7624
6454
  },
6455
+ {
6456
+ "name": "hasDisplayedOptions",
6457
+ "signature": "function hasDisplayedOptions(optionSet: IkasProductOptionSet): boolean",
6458
+ "description": "Checks whether the option set has any displayed (top-level) options.",
6459
+ "params": [
6460
+ {
6461
+ "name": "optionSet",
6462
+ "description": "- The product option set to check."
6463
+ }
6464
+ ],
6465
+ "returns": "True if there is at least one displayed option, false otherwise.",
6466
+ "returnType": "boolean",
6467
+ "example": "```typescript\nimport { hasDisplayedOptions } from \"@ikas/bp-storefront\";\nif (hasDisplayedOptions(product.optionSet)) {\n // render option selector\n}\n```",
6468
+ "categories": [
6469
+ "ProductOptionSet"
6470
+ ],
6471
+ "related": [
6472
+ "getDisplayedOptions",
6473
+ "hasValidProductOptionSetValues"
6474
+ ],
6475
+ "isAsync": false,
6476
+ "isClass": false,
6477
+ "parameterTypes": [
6478
+ "IkasProductOptionSet"
6479
+ ]
6480
+ },
7625
6481
  {
7626
6482
  "name": "initProductOptionSetValues",
7627
6483
  "displayName": "initValues",
@@ -8450,45 +7306,20 @@
8450
7306
  "IkasProductOption"
8451
7307
  ]
8452
7308
  },
8453
- {
8454
- "name": "getStockLocationFullAddressText",
8455
- "displayName": "getFullAddressText",
8456
- "signature": "function getStockLocationFullAddressText(stockLocations: IkasProductStockLocations): string",
8457
- "description": "Builds a comma-separated full address string from a stock location's address components including street address, postal code, district, city, state, and country.",
8458
- "params": [
8459
- {
8460
- "name": "stockLocations",
8461
- "description": "- The product stock location object containing the address to format."
8462
- }
8463
- ],
8464
- "returns": "A comma-separated address string, or an empty string if no address exists.",
8465
- "returnType": "string",
8466
- "example": "```typescript\nimport { getStockLocationFullAddressText } from \"@ikas/bp-storefront\";\nconst address = getStockLocationFullAddressText(variant.stockLocations[0]);\nconsole.log(address); // \"123 Main St, 34000, Kadikoy, Istanbul, Turkey\"\n```",
8467
- "categories": [
8468
- "StockLocation",
8469
- "Product"
8470
- ],
8471
- "related": [],
8472
- "isAsync": false,
8473
- "isClass": false,
8474
- "parameterTypes": [
8475
- "IkasProductStockLocations"
8476
- ]
8477
- },
8478
7309
  {
8479
7310
  "name": "getProductVariantMainImage",
8480
7311
  "displayName": "getMainImage",
8481
7312
  "signature": "function getProductVariantMainImage(variant: IkasProductVariant): IkasProductImage | undefined",
8482
- "description": "Get the main/primary image for a product variant.",
7313
+ "description": "Get the main/primary media item for a product variant.\n\nThe returned IkasProductImage may be a video (`isVideo === true`) — branch on it\nand render `<video>` instead of `<img>`.",
8483
7314
  "params": [
8484
7315
  {
8485
7316
  "name": "variant",
8486
7317
  "description": "- The product variant"
8487
7318
  }
8488
7319
  ],
8489
- "returns": "The first IkasProductImage of the variant, or undefined if no images. Access `.image` to get the IkasImage for CDN helpers.",
7320
+ "returns": "The first IkasProductImage of the variant, or undefined if no images. Check `.isVideo` to decide between `<video>` and `<img>`, and access `.image` to get the IkasImage for CDN helpers.",
8490
7321
  "returnType": "IkasProductImage | undefined",
8491
- "example": "```typescript\nimport { getProductVariantMainImage, getSelectedProductVariant, getDefaultSrc } from \"@ikas/bp-storefront\";\nimport { IkasProduct } from \"@ikas/bp-storefront\";\n\nfunction ProductImage({ product }: { product: IkasProduct }) {\n const variant = getSelectedProductVariant(product);\n const productImage = getProductVariantMainImage(variant);\n const image = productImage?.image;\n\n if (!image) {\n return <div className=\"no-image\">No image available</div>;\n }\n\n return <img src={getDefaultSrc(image)} alt={product.name} />;\n}\n```",
7322
+ "example": "```typescript\nimport { getProductVariantMainImage, getSelectedProductVariant, getDefaultSrc, createMediaSrcset } from \"@ikas/bp-storefront\";\nimport { IkasProduct } from \"@ikas/bp-storefront\";\n\nfunction ProductImage({ product }: { product: IkasProduct }) {\n const variant = getSelectedProductVariant(product);\n const productImage = getProductVariantMainImage(variant);\n const image = productImage?.image;\n\n if (!image) {\n return <div className=\"no-image\">No image available</div>;\n }\n\n // Media can be a video — branch on isVideo:\n return productImage.isVideo ? (\n <video src={getDefaultSrc(image)} muted playsInline loop>\n <track kind=\"captions\" />\n </video>\n ) : (\n <img src={getDefaultSrc(image)} srcSet={createMediaSrcset(image)} alt={product.name} />\n );\n}\n```",
8492
7323
  "categories": [
8493
7324
  "ProductDetail",
8494
7325
  "ProductList"
@@ -13668,6 +12499,62 @@
13668
12499
  "isAsync": false,
13669
12500
  "isClass": false
13670
12501
  },
12502
+ {
12503
+ "name": "setLocalization",
12504
+ "signature": "function setLocalization(baseStore: BaseStore, localeOption: IkasLocaleOption): void",
12505
+ "description": "Switches the storefront to the routing associated with `localeOption` and redirects the browser\nto the equivalent URL under that routing.\n\nReads the routing directly from `localeOption.routing`, then performs a full-page redirect via\n`window.location.replace`. For CATEGORY/BRAND/PRODUCT pages, the localized slug from the page's\nmetadata translations is used when available; otherwise the visitor stays on the current path\n(with the current routing prefix swapped for the new one). Query string and hash are preserved.",
12506
+ "params": [
12507
+ {
12508
+ "name": "baseStore",
12509
+ "description": "- The base store instance (used to read the current page type for slug\nresolution on detail pages)."
12510
+ },
12511
+ {
12512
+ "name": "localeOption",
12513
+ "description": "- The locale option the visitor selected. Render `baseStore.localeOptions`\nas a list (e.g. a country/region picker) and pass the chosen entry directly to this function."
12514
+ }
12515
+ ],
12516
+ "returns": "void.",
12517
+ "returnType": "void",
12518
+ "example": "```tsx\nimport { setLocalization, baseStore } from \"@ikas/bp-storefront\";\n\nfunction LocalizationSwitcher() {\n return (\n <ul>\n {baseStore.localeOptions.map(option => (\n <li key={option.id}>\n <button onClick={() => setLocalization(baseStore, option)}>\n {option.countryName}\n </button>\n </li>\n ))}\n </ul>\n );\n}\n```",
12519
+ "categories": [
12520
+ "BaseStore",
12521
+ "Store"
12522
+ ],
12523
+ "related": [],
12524
+ "isAsync": false,
12525
+ "isClass": false,
12526
+ "parameterTypes": [
12527
+ "IkasLocaleOption"
12528
+ ]
12529
+ },
12530
+ {
12531
+ "name": "setLanguage",
12532
+ "signature": "function setLanguage(baseStore: BaseStore, language: IkasLanguageOption): void",
12533
+ "description": "Switches the storefront to the routing identified by `language` and redirects the browser to\nthe equivalent URL under that routing.\n\nLooks up the routing by `language.id`, then performs a full-page redirect via\n`window.location.replace`. For CATEGORY/BRAND/PRODUCT pages, the localized slug from the\npage's metadata translations is used when available; otherwise the visitor stays on the\ncurrent path (with the current routing prefix swapped for the new one). Query string and\nhash are preserved.",
12534
+ "params": [
12535
+ {
12536
+ "name": "baseStore",
12537
+ "description": "- The base store instance (used to read the current page type for slug\nresolution on detail pages)."
12538
+ },
12539
+ {
12540
+ "name": "language",
12541
+ "description": "- The language option the visitor selected. Render `baseStore.languageOptions`\nas a list (e.g. a dropdown) and pass the chosen entry directly to this function."
12542
+ }
12543
+ ],
12544
+ "returns": "void. No-op if no routing matches `language.id`.",
12545
+ "returnType": "void",
12546
+ "example": "```tsx\nimport { setLanguage, baseStore } from \"@ikas/bp-storefront\";\n\nfunction LanguageSwitcher() {\n return (\n <ul>\n {baseStore.languageOptions.map(option => (\n <li key={option.id}>\n <button onClick={() => setLanguage(baseStore, option)}>\n {option.language}\n </button>\n </li>\n ))}\n </ul>\n );\n}\n```",
12547
+ "categories": [
12548
+ "BaseStore",
12549
+ "Store"
12550
+ ],
12551
+ "related": [],
12552
+ "isAsync": false,
12553
+ "isClass": false,
12554
+ "parameterTypes": [
12555
+ "IkasLanguageOption"
12556
+ ]
12557
+ },
13671
12558
  {
13672
12559
  "name": "bs_searchProductById",
13673
12560
  "displayName": "searchProductById",
@@ -16230,9 +15117,9 @@
16230
15117
  "className": "Router"
16231
15118
  },
16232
15119
  {
16233
- "name": "isBrowser",
16234
- "signature": "function isBrowser(yes?: () => void, no?: () => void): void",
16235
- "description": "",
15120
+ "name": "registerThemeSettingValues",
15121
+ "signature": "function registerThemeSettingValues(values: Record<string, any> | null): void",
15122
+ "description": "Register the live global-variable object (`_g_`) so `getThemeSetting`/`getThemeSettings`\nreturn actual runtime values (constants, computed getters, and in-editor edits) instead\nof the serialized design-time defaults. Called by generated code, not by component authors.",
16236
15123
  "params": [],
16237
15124
  "returnType": "void",
16238
15125
  "categories": [],
@@ -16241,172 +15128,150 @@
16241
15128
  "isClass": false
16242
15129
  },
16243
15130
  {
16244
- "name": "IkasComponentRenderer",
16245
- "signature": "function IkasComponentRenderer({\n id: baseId,\n components,\n style,\n className,\n parentProps = EMPTY_OBJ,\n map = EMPTY_OBJ,\n}: IkasComponentRendererProps): VNode<ClassAttributes<HTMLElement> & { id: string; dangerouslySetInnerHTML: { __html: string; }; style: { cssText?: string | null | undefined; length?: string | number | null | undefined; ... 496 more ...; zoom?: string | ... 2 more ... | undefined; }; className: string | undefined; }> | null",
16246
- "description": "",
15131
+ "name": "getThemeSettings",
15132
+ "signature": "function getThemeSettings(): ThemeSetting[]",
15133
+ "description": "All global variables (Theme Settings) defined for the theme.",
16247
15134
  "params": [],
16248
- "returnType": "VNode<ClassAttributes<HTMLElement> & { id: string; dangerouslySetInnerHTML: { __html: string; }; style: { cssText?: string | null | undefined; length?: string | number | null | undefined; ... 496 more ...; zoom?: string | ... 2 more ... | undefined; }; className: string | undefined; }> | null",
15135
+ "returnType": "ThemeSetting[]",
16249
15136
  "categories": [],
16250
15137
  "related": [],
16251
15138
  "isAsync": false,
16252
- "isClass": false,
16253
- "parameterTypes": [
16254
- "IkasComponentRenderer",
16255
- "IkasComponentRendererProps"
16256
- ]
16257
- },
16258
- {
16259
- "name": "httpRequest",
16260
- "signature": "async function httpRequest(url: string, method: HttpMethod, body?: Record<string, any>, headers?: Record<string, string>): Promise<FetchResponse>",
16261
- "description": "",
16262
- "params": [],
16263
- "returnType": "Promise<FetchResponse>",
16264
- "categories": [],
16265
- "related": [],
16266
- "isAsync": true,
16267
- "isClass": false
16268
- },
16269
- {
16270
- "name": "post",
16271
- "signature": "async function post(url: string, body?: Record<string, any>, headers?: Record<string, string>): Promise<FetchResponse>",
16272
- "description": "",
16273
- "params": [],
16274
- "returnType": "Promise<FetchResponse>",
16275
- "categories": [],
16276
- "related": [],
16277
- "isAsync": true,
16278
15139
  "isClass": false
16279
15140
  },
16280
15141
  {
16281
- "name": "get",
16282
- "signature": "async function get(url: string, headers?: Record<string, string>): Promise<FetchResponse>",
16283
- "description": "",
15142
+ "name": "getThemeSetting",
15143
+ "signature": "function getThemeSetting(name: string): ThemeSetting | undefined",
15144
+ "description": "A single global variable by its stable key (`variableName`, e.g. `_6Q0KV7VGGM`).\nDiscover keys via (each item carries a human `displayName`).\nThe returned `value` is the live blueprint value when available, else the default.\nIts shape is discriminated by `type` (see ); note an\nIMAGE setting's value is an image REFERENCE (no `.url`) — resolve with\n`getDefaultSrc`/`getSrc`.",
16284
15145
  "params": [],
16285
- "returnType": "Promise<FetchResponse>",
15146
+ "returnType": "ThemeSetting | undefined",
16286
15147
  "categories": [],
16287
15148
  "related": [],
16288
- "isAsync": true,
15149
+ "isAsync": false,
16289
15150
  "isClass": false
16290
15151
  },
16291
15152
  {
16292
- "name": "findAllIndexes",
16293
- "signature": "function findAllIndexes(str: string, pattern: string): number[]",
16294
- "description": "",
15153
+ "name": "getThemeSettingValue",
15154
+ "signature": "function getThemeSettingValue(name: string): any",
15155
+ "description": "Convenience: the resolved value of a global variable, or `undefined` if not found.",
16295
15156
  "params": [],
16296
- "returnType": "number[]",
15157
+ "returnType": "any",
16297
15158
  "categories": [],
16298
15159
  "related": [],
16299
15160
  "isAsync": false,
16300
15161
  "isClass": false
16301
15162
  },
16302
15163
  {
16303
- "name": "stringSorter",
16304
- "signature": "function stringSorter(atitle: string, btitle: string): number",
16305
- "description": "",
15164
+ "name": "getThemeColors",
15165
+ "signature": "function getThemeColors(): RuntimeDesignToken[]",
15166
+ "description": "Theme color tokens. Each carries a resolved value and a `var(--id)` CSS reference.",
16306
15167
  "params": [],
16307
- "returnType": "number",
15168
+ "returnType": "RuntimeDesignToken[]",
16308
15169
  "categories": [],
16309
15170
  "related": [],
16310
15171
  "isAsync": false,
16311
15172
  "isClass": false
16312
15173
  },
16313
15174
  {
16314
- "name": "capitalize",
16315
- "signature": "function capitalize(value: string): string",
16316
- "description": "",
15175
+ "name": "getThemeTypography",
15176
+ "signature": "function getThemeTypography(): RuntimeTypographyToken[]",
15177
+ "description": "Theme typography tokens (text styles). Apply `className` or read `resolved` CSS values.",
16317
15178
  "params": [],
16318
- "returnType": "string",
15179
+ "returnType": "RuntimeTypographyToken[]",
16319
15180
  "categories": [],
16320
15181
  "related": [],
16321
15182
  "isAsync": false,
16322
15183
  "isClass": false
16323
15184
  },
16324
15185
  {
16325
- "name": "tryForEach",
16326
- "signature": "function tryForEach(items: any[], callback: (item: any, index: number) => void, printErrors: any = false): void",
16327
- "description": "",
15186
+ "name": "getThemeBreakpoints",
15187
+ "signature": "function getThemeBreakpoints(): RuntimeBreakpointToken[]",
15188
+ "description": "Theme responsive breakpoints (`{ id, width }`).",
16328
15189
  "params": [],
16329
- "returnType": "void",
15190
+ "returnType": "RuntimeBreakpointToken[]",
16330
15191
  "categories": [],
16331
15192
  "related": [],
16332
15193
  "isAsync": false,
16333
15194
  "isClass": false
16334
15195
  },
16335
15196
  {
16336
- "name": "formatDate",
16337
- "signature": "function formatDate(date: Date): string",
16338
- "description": "",
15197
+ "name": "getThemeKeyframes",
15198
+ "signature": "function getThemeKeyframes(): RuntimeKeyframeToken[]",
15199
+ "description": "Theme keyframe/transition animations. Use `ref` as the CSS animation name.",
16339
15200
  "params": [],
16340
- "returnType": "string",
15201
+ "returnType": "RuntimeKeyframeToken[]",
16341
15202
  "categories": [],
16342
15203
  "related": [],
16343
15204
  "isAsync": false,
16344
15205
  "isClass": false
16345
15206
  },
16346
15207
  {
16347
- "name": "getCookieValue",
16348
- "signature": "function getCookieValue(cookieName: string): string | null",
16349
- "description": "",
15208
+ "name": "getThemeColorSchemes",
15209
+ "signature": "function getThemeColorSchemes(): RuntimeThemeColorSchemes",
15210
+ "description": "Theme color schemes (palettes). Returns two PARALLEL lists with different jobs:\n- `schemes`: the color SLOTS as `{ id }` only — no colors and no display label live here at\n runtime. A slot's human name is authoring-only (read it via the CLI/MCP `list-theme-globals`\n or the editor); at runtime identify a slot solely by its `id`.\n- `values`: the actual palettes. A palette's colors live in its `colorsByScheme`\n map, keyed by slot id → `{ resolved, cssVar }`.\n\nTo render swatches, iterate `values[].colorsByScheme` (the source of truth for\ncolors), NOT the top-level `schemes` array — `schemes` carries slot ids only, so\niterating it renders empty:\n\n const { values } = getThemeColorSchemes();\n values.forEach(palette =>\n Object.entries(palette.colorsByScheme).forEach(([slotId, { resolved, cssVar }]) => {\n // slotId → stable slot key, cssVar → live var() ref (prefer this), resolved → hex snapshot\n })\n );",
16350
15211
  "params": [],
16351
- "returnType": "string | null",
15212
+ "returnType": "RuntimeThemeColorSchemes",
16352
15213
  "categories": [],
16353
15214
  "related": [],
16354
15215
  "isAsync": false,
16355
15216
  "isClass": false
16356
15217
  },
16357
15218
  {
16358
- "name": "isClient",
16359
- "signature": "function isClient(): boolean",
15219
+ "name": "isBrowser",
15220
+ "signature": "function isBrowser(yes?: () => void, no?: () => void): void",
16360
15221
  "description": "",
16361
15222
  "params": [],
16362
- "returnType": "boolean",
15223
+ "returnType": "void",
16363
15224
  "categories": [],
16364
15225
  "related": [],
16365
15226
  "isAsync": false,
16366
15227
  "isClass": false
16367
15228
  },
16368
15229
  {
16369
- "name": "isServer",
16370
- "signature": "function isServer(): boolean",
15230
+ "name": "IkasComponentRenderer",
15231
+ "signature": "function IkasComponentRenderer({\n id: baseId,\n components,\n style,\n className,\n parentProps = EMPTY_OBJ,\n map = EMPTY_OBJ,\n}: IkasComponentRendererProps): VNode<ClassAttributes<HTMLDivElement> & { id: string; ref: MutableRef<HTMLDivElement | null>; dangerouslySetInnerHTML: { ...; }; style: { ...; }; className: string | undefined; }> | null",
16371
15232
  "description": "",
16372
15233
  "params": [],
16373
- "returnType": "boolean",
15234
+ "returnType": "VNode<ClassAttributes<HTMLDivElement> & { id: string; ref: MutableRef<HTMLDivElement | null>; dangerouslySetInnerHTML: { ...; }; style: { ...; }; className: string | undefined; }> | null",
16374
15235
  "categories": [],
16375
15236
  "related": [],
16376
15237
  "isAsync": false,
16377
- "isClass": false
15238
+ "isClass": false,
15239
+ "parameterTypes": [
15240
+ "IkasComponentRenderer",
15241
+ "IkasComponentRendererProps"
15242
+ ]
16378
15243
  },
16379
15244
  {
16380
- "name": "getQueryParams",
16381
- "signature": "function getQueryParams(): URLSearchParams | undefined",
15245
+ "name": "httpRequest",
15246
+ "signature": "async function httpRequest(url: string, method: HttpMethod, body?: Record<string, any>, headers?: Record<string, string>): Promise<FetchResponse>",
16382
15247
  "description": "",
16383
15248
  "params": [],
16384
- "returnType": "URLSearchParams | undefined",
15249
+ "returnType": "Promise<FetchResponse>",
16385
15250
  "categories": [],
16386
15251
  "related": [],
16387
- "isAsync": false,
15252
+ "isAsync": true,
16388
15253
  "isClass": false
16389
15254
  },
16390
15255
  {
16391
- "name": "isBackNavigation",
16392
- "signature": "function isBackNavigation(): boolean",
15256
+ "name": "post",
15257
+ "signature": "async function post(url: string, body?: Record<string, any>, headers?: Record<string, string>): Promise<FetchResponse>",
16393
15258
  "description": "",
16394
15259
  "params": [],
16395
- "returnType": "boolean",
15260
+ "returnType": "Promise<FetchResponse>",
16396
15261
  "categories": [],
16397
15262
  "related": [],
16398
- "isAsync": false,
15263
+ "isAsync": true,
16399
15264
  "isClass": false
16400
15265
  },
16401
15266
  {
16402
- "name": "stringifyQueryParams",
16403
- "signature": "function stringifyQueryParams(params: Record<string, any>, options: any = { arrayFormat: \"comma\" }): string",
15267
+ "name": "get",
15268
+ "signature": "async function get(url: string, headers?: Record<string, string>): Promise<FetchResponse>",
16404
15269
  "description": "",
16405
15270
  "params": [],
16406
- "returnType": "string",
15271
+ "returnType": "Promise<FetchResponse>",
16407
15272
  "categories": [],
16408
15273
  "related": [],
16409
- "isAsync": false,
15274
+ "isAsync": true,
16410
15275
  "isClass": false
16411
15276
  },
16412
15277
  {
@@ -16420,39 +15285,6 @@
16420
15285
  "isAsync": false,
16421
15286
  "isClass": false
16422
15287
  },
16423
- {
16424
- "name": "groupBy",
16425
- "signature": "function groupBy(array: T[], iteratee: string | ((item: T) => string | number)): Record<string, T[]>",
16426
- "description": "",
16427
- "params": [],
16428
- "returnType": "Record<string, T[]>",
16429
- "categories": [],
16430
- "related": [],
16431
- "isAsync": false,
16432
- "isClass": false
16433
- },
16434
- {
16435
- "name": "sortBy",
16436
- "signature": "function sortBy(array: T[], iteratees: Array<string | ((item: T) => any)>): T[]",
16437
- "description": "",
16438
- "params": [],
16439
- "returnType": "T[]",
16440
- "categories": [],
16441
- "related": [],
16442
- "isAsync": false,
16443
- "isClass": false
16444
- },
16445
- {
16446
- "name": "debounce",
16447
- "signature": "function debounce(func: (...args: any[]) => void, wait: number): (...args: any[]) => void",
16448
- "description": "",
16449
- "params": [],
16450
- "returnType": "(...args: any[]) => void",
16451
- "categories": [],
16452
- "related": [],
16453
- "isAsync": false,
16454
- "isClass": false
16455
- },
16456
15288
  {
16457
15289
  "name": "reaction",
16458
15290
  "signature": "function reaction(condition: () => any, effect: () => void): IReactionDisposer",