@ikas/code-components-mcp 2.2.0 → 2.2.2
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.
- package/data/storefront-api.json +80 -1401
- package/data/storefront-types.json +27 -123
- package/package.json +1 -1
package/data/storefront-api.json
CHANGED
|
@@ -1,1280 +1,166 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-05-
|
|
2
|
+
"generatedAt": "2026-05-20T07:21:27.700Z",
|
|
3
3
|
"functions": [
|
|
4
4
|
{
|
|
5
|
-
"name": "
|
|
6
|
-
"signature": "function
|
|
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
|
-
{
|
|
58
|
-
"name": "apiListProductBrand",
|
|
59
|
-
"signature": "async function apiListProductBrand(params: ListProductBrandQueryParams): Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
60
|
-
"description": "",
|
|
61
|
-
"params": [],
|
|
62
|
-
"returnType": "Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
63
|
-
"categories": [],
|
|
64
|
-
"related": [],
|
|
65
|
-
"isAsync": true,
|
|
66
|
-
"isClass": false,
|
|
67
|
-
"parameterTypes": [
|
|
68
|
-
"IkasBrand"
|
|
69
|
-
]
|
|
70
|
-
},
|
|
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
|
-
{
|
|
158
|
-
"name": "apiListCategory",
|
|
159
|
-
"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; }>>",
|
|
160
|
-
"description": "",
|
|
161
|
-
"params": [],
|
|
162
|
-
"returnType": "Promise<APIResponse<{ data: IkasCategory[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
163
|
-
"categories": [],
|
|
164
|
-
"related": [],
|
|
165
|
-
"isAsync": true,
|
|
166
|
-
"isClass": false,
|
|
167
|
-
"parameterTypes": [
|
|
168
|
-
"IkasCategory"
|
|
169
|
-
]
|
|
170
|
-
},
|
|
171
|
-
{
|
|
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>>",
|
|
365
|
-
"description": "",
|
|
366
|
-
"params": [],
|
|
367
|
-
"returnType": "Promise<APIResponse<{ customer: IkasCustomer | null; flowId: string | null; otpSend: boolean | null; token: string; tokenExpiry: number; } | null>>",
|
|
368
|
-
"categories": [],
|
|
369
|
-
"related": [],
|
|
370
|
-
"isAsync": true,
|
|
371
|
-
"isClass": false,
|
|
372
|
-
"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"
|
|
919
|
-
]
|
|
920
|
-
},
|
|
921
|
-
{
|
|
922
|
-
"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>>",
|
|
5
|
+
"name": "apiListProductBrand",
|
|
6
|
+
"signature": "async function apiListProductBrand(params: ListProductBrandQueryParams): Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
1117
7
|
"description": "",
|
|
1118
8
|
"params": [],
|
|
1119
|
-
"returnType": "Promise<APIResponse<{ data:
|
|
9
|
+
"returnType": "Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
1120
10
|
"categories": [],
|
|
1121
11
|
"related": [],
|
|
1122
12
|
"isAsync": true,
|
|
1123
13
|
"isClass": false,
|
|
1124
14
|
"parameterTypes": [
|
|
1125
|
-
"
|
|
15
|
+
"IkasBrand"
|
|
1126
16
|
]
|
|
1127
17
|
},
|
|
1128
18
|
{
|
|
1129
|
-
"name": "
|
|
1130
|
-
"signature": "async function
|
|
19
|
+
"name": "apiListCategory",
|
|
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; }>>",
|
|
1131
21
|
"description": "",
|
|
1132
22
|
"params": [],
|
|
1133
|
-
"returnType": "Promise<APIResponse<{ data:
|
|
23
|
+
"returnType": "Promise<APIResponse<{ data: IkasCategory[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
1134
24
|
"categories": [],
|
|
1135
25
|
"related": [],
|
|
1136
26
|
"isAsync": true,
|
|
1137
27
|
"isClass": false,
|
|
1138
28
|
"parameterTypes": [
|
|
1139
|
-
"
|
|
29
|
+
"IkasCategory"
|
|
1140
30
|
]
|
|
1141
31
|
},
|
|
1142
32
|
{
|
|
1143
|
-
"name": "
|
|
1144
|
-
"signature": "async function
|
|
33
|
+
"name": "apiGetStorefrontWidgetSettings",
|
|
34
|
+
"signature": "async function apiGetStorefrontWidgetSettings(): Promise<APIResponse<IkasStorefrontWidgetSettings>>",
|
|
1145
35
|
"description": "",
|
|
1146
36
|
"params": [],
|
|
1147
|
-
"returnType": "Promise<APIResponse<
|
|
37
|
+
"returnType": "Promise<APIResponse<IkasStorefrontWidgetSettings>>",
|
|
1148
38
|
"categories": [],
|
|
1149
39
|
"related": [],
|
|
1150
40
|
"isAsync": true,
|
|
1151
41
|
"isClass": false,
|
|
1152
42
|
"parameterTypes": [
|
|
1153
|
-
"
|
|
43
|
+
"IkasStorefrontWidgetSettings"
|
|
1154
44
|
]
|
|
1155
45
|
},
|
|
1156
46
|
{
|
|
1157
|
-
"name": "
|
|
1158
|
-
"signature": "async function
|
|
47
|
+
"name": "apiListEarningMethods",
|
|
48
|
+
"signature": "async function apiListEarningMethods(): Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
|
|
1159
49
|
"description": "",
|
|
1160
50
|
"params": [],
|
|
1161
|
-
"returnType": "Promise<APIResponse<
|
|
51
|
+
"returnType": "Promise<APIResponse<IkasLoyaltyProgramEarningMethod[]>>",
|
|
1162
52
|
"categories": [],
|
|
1163
53
|
"related": [],
|
|
1164
54
|
"isAsync": true,
|
|
1165
55
|
"isClass": false,
|
|
1166
56
|
"parameterTypes": [
|
|
1167
|
-
"
|
|
57
|
+
"IkasLoyaltyProgramEarningMethod"
|
|
1168
58
|
]
|
|
1169
59
|
},
|
|
1170
60
|
{
|
|
1171
|
-
"name": "
|
|
1172
|
-
"signature": "async function
|
|
61
|
+
"name": "apiListLoyaltyProgramTiers",
|
|
62
|
+
"signature": "async function apiListLoyaltyProgramTiers(): Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
|
|
1173
63
|
"description": "",
|
|
1174
64
|
"params": [],
|
|
1175
|
-
"returnType": "Promise<APIResponse<
|
|
65
|
+
"returnType": "Promise<APIResponse<IkasLoyaltyProgramTier[]>>",
|
|
1176
66
|
"categories": [],
|
|
1177
67
|
"related": [],
|
|
1178
68
|
"isAsync": true,
|
|
1179
69
|
"isClass": false,
|
|
1180
70
|
"parameterTypes": [
|
|
1181
|
-
"
|
|
71
|
+
"IkasLoyaltyProgramTier"
|
|
1182
72
|
]
|
|
1183
73
|
},
|
|
1184
74
|
{
|
|
1185
|
-
"name": "
|
|
1186
|
-
"signature": "async function
|
|
75
|
+
"name": "apiListSpendingMethodsByCartId",
|
|
76
|
+
"signature": "async function apiListSpendingMethodsByCartId(params: ListSpendingMethodsByCartIdQueryParams): Promise<APIResponse<IkasLoyaltyProgramSpendingMethod[]>>",
|
|
1187
77
|
"description": "",
|
|
1188
78
|
"params": [],
|
|
1189
|
-
"returnType": "Promise<APIResponse<
|
|
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": "
|
|
1197
|
-
"signature": "async function
|
|
89
|
+
"name": "apiGetLoyaltyCustomerInfo",
|
|
90
|
+
"signature": "async function apiGetLoyaltyCustomerInfo(params: GetLoyaltyCustomerInfoQueryParams): Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
|
|
1198
91
|
"description": "",
|
|
1199
92
|
"params": [],
|
|
1200
|
-
"returnType": "Promise<APIResponse<
|
|
93
|
+
"returnType": "Promise<APIResponse<IkasLoyaltyCustomerInfo>>",
|
|
1201
94
|
"categories": [],
|
|
1202
95
|
"related": [],
|
|
1203
96
|
"isAsync": true,
|
|
1204
97
|
"isClass": false,
|
|
1205
98
|
"parameterTypes": [
|
|
1206
|
-
"
|
|
1207
|
-
"IkasProductOptionSet"
|
|
99
|
+
"IkasLoyaltyCustomerInfo"
|
|
1208
100
|
]
|
|
1209
101
|
},
|
|
1210
102
|
{
|
|
1211
|
-
"name": "
|
|
1212
|
-
"signature": "async function
|
|
103
|
+
"name": "apiListLoyaltyProgramPointHistory",
|
|
104
|
+
"signature": "async function apiListLoyaltyProgramPointHistory(params: ListLoyaltyProgramPointHistoryQueryParams): Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
|
|
1213
105
|
"description": "",
|
|
1214
106
|
"params": [],
|
|
1215
|
-
"returnType": "Promise<APIResponse<
|
|
107
|
+
"returnType": "Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
|
|
1216
108
|
"categories": [],
|
|
1217
109
|
"related": [],
|
|
1218
110
|
"isAsync": true,
|
|
1219
111
|
"isClass": false,
|
|
1220
112
|
"parameterTypes": [
|
|
1221
|
-
"
|
|
113
|
+
"IkasLoyaltyProgramPointHistory"
|
|
1222
114
|
]
|
|
1223
115
|
},
|
|
1224
116
|
{
|
|
1225
|
-
"name": "
|
|
1226
|
-
"signature": "async function
|
|
117
|
+
"name": "apiUseLoyaltyPoints",
|
|
118
|
+
"signature": "async function apiUseLoyaltyPoints(params: UseLoyaltyPointsQueryParams): Promise<APIResponse<CartV2>>",
|
|
1227
119
|
"description": "",
|
|
1228
120
|
"params": [],
|
|
1229
|
-
"returnType": "Promise<APIResponse<
|
|
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": "
|
|
1240
|
-
"signature": "async function
|
|
128
|
+
"name": "apiRemoveLoyaltyPointsFromCart",
|
|
129
|
+
"signature": "async function apiRemoveLoyaltyPointsFromCart(params: RemoveLoyaltyPointsFromCartQueryParams): Promise<APIResponse<CartV2>>",
|
|
1241
130
|
"description": "",
|
|
1242
131
|
"params": [],
|
|
1243
|
-
"returnType": "Promise<APIResponse<
|
|
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": "
|
|
1254
|
-
"signature": "async function
|
|
139
|
+
"name": "apiListStorefrontPopup",
|
|
140
|
+
"signature": "async function apiListStorefrontPopup(params: ListStorefrontPopupQueryParams): Promise<APIResponse<IkasStorefrontPopup[]>>",
|
|
1255
141
|
"description": "",
|
|
1256
142
|
"params": [],
|
|
1257
|
-
"returnType": "Promise<APIResponse<
|
|
143
|
+
"returnType": "Promise<APIResponse<IkasStorefrontPopup[]>>",
|
|
1258
144
|
"categories": [],
|
|
1259
145
|
"related": [],
|
|
1260
146
|
"isAsync": true,
|
|
1261
147
|
"isClass": false,
|
|
1262
148
|
"parameterTypes": [
|
|
1263
|
-
"
|
|
149
|
+
"IkasStorefrontPopup"
|
|
1264
150
|
]
|
|
1265
151
|
},
|
|
1266
152
|
{
|
|
1267
|
-
"name": "
|
|
1268
|
-
"signature": "async function
|
|
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<
|
|
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
|
-
"
|
|
163
|
+
"IkasProduct"
|
|
1278
164
|
]
|
|
1279
165
|
},
|
|
1280
166
|
{
|
|
@@ -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",
|
|
@@ -8476,31 +7306,6 @@
|
|
|
8476
7306
|
"IkasProductOption"
|
|
8477
7307
|
]
|
|
8478
7308
|
},
|
|
8479
|
-
{
|
|
8480
|
-
"name": "getStockLocationFullAddressText",
|
|
8481
|
-
"displayName": "getFullAddressText",
|
|
8482
|
-
"signature": "function getStockLocationFullAddressText(stockLocations: IkasProductStockLocations): string",
|
|
8483
|
-
"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.",
|
|
8484
|
-
"params": [
|
|
8485
|
-
{
|
|
8486
|
-
"name": "stockLocations",
|
|
8487
|
-
"description": "- The product stock location object containing the address to format."
|
|
8488
|
-
}
|
|
8489
|
-
],
|
|
8490
|
-
"returns": "A comma-separated address string, or an empty string if no address exists.",
|
|
8491
|
-
"returnType": "string",
|
|
8492
|
-
"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```",
|
|
8493
|
-
"categories": [
|
|
8494
|
-
"StockLocation",
|
|
8495
|
-
"Product"
|
|
8496
|
-
],
|
|
8497
|
-
"related": [],
|
|
8498
|
-
"isAsync": false,
|
|
8499
|
-
"isClass": false,
|
|
8500
|
-
"parameterTypes": [
|
|
8501
|
-
"IkasProductStockLocations"
|
|
8502
|
-
]
|
|
8503
|
-
},
|
|
8504
7309
|
{
|
|
8505
7310
|
"name": "getProductVariantMainImage",
|
|
8506
7311
|
"displayName": "getMainImage",
|
|
@@ -13694,6 +12499,34 @@
|
|
|
13694
12499
|
"isAsync": false,
|
|
13695
12500
|
"isClass": false
|
|
13696
12501
|
},
|
|
12502
|
+
{
|
|
12503
|
+
"name": "setLanguage",
|
|
12504
|
+
"signature": "function setLanguage(baseStore: BaseStore, language: IkasLanguageOption): void",
|
|
12505
|
+
"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.",
|
|
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": "language",
|
|
12513
|
+
"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."
|
|
12514
|
+
}
|
|
12515
|
+
],
|
|
12516
|
+
"returns": "void. No-op if no routing matches `language.id`.",
|
|
12517
|
+
"returnType": "void",
|
|
12518
|
+
"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```",
|
|
12519
|
+
"categories": [
|
|
12520
|
+
"BaseStore",
|
|
12521
|
+
"Store"
|
|
12522
|
+
],
|
|
12523
|
+
"related": [],
|
|
12524
|
+
"isAsync": false,
|
|
12525
|
+
"isClass": false,
|
|
12526
|
+
"parameterTypes": [
|
|
12527
|
+
"IkasLanguageOption"
|
|
12528
|
+
]
|
|
12529
|
+
},
|
|
13697
12530
|
{
|
|
13698
12531
|
"name": "bs_searchProductById",
|
|
13699
12532
|
"displayName": "searchProductById",
|
|
@@ -16314,127 +15147,6 @@
|
|
|
16314
15147
|
"isAsync": true,
|
|
16315
15148
|
"isClass": false
|
|
16316
15149
|
},
|
|
16317
|
-
{
|
|
16318
|
-
"name": "findAllIndexes",
|
|
16319
|
-
"signature": "function findAllIndexes(str: string, pattern: string): number[]",
|
|
16320
|
-
"description": "",
|
|
16321
|
-
"params": [],
|
|
16322
|
-
"returnType": "number[]",
|
|
16323
|
-
"categories": [],
|
|
16324
|
-
"related": [],
|
|
16325
|
-
"isAsync": false,
|
|
16326
|
-
"isClass": false
|
|
16327
|
-
},
|
|
16328
|
-
{
|
|
16329
|
-
"name": "stringSorter",
|
|
16330
|
-
"signature": "function stringSorter(atitle: string, btitle: string): number",
|
|
16331
|
-
"description": "",
|
|
16332
|
-
"params": [],
|
|
16333
|
-
"returnType": "number",
|
|
16334
|
-
"categories": [],
|
|
16335
|
-
"related": [],
|
|
16336
|
-
"isAsync": false,
|
|
16337
|
-
"isClass": false
|
|
16338
|
-
},
|
|
16339
|
-
{
|
|
16340
|
-
"name": "capitalize",
|
|
16341
|
-
"signature": "function capitalize(value: string): string",
|
|
16342
|
-
"description": "",
|
|
16343
|
-
"params": [],
|
|
16344
|
-
"returnType": "string",
|
|
16345
|
-
"categories": [],
|
|
16346
|
-
"related": [],
|
|
16347
|
-
"isAsync": false,
|
|
16348
|
-
"isClass": false
|
|
16349
|
-
},
|
|
16350
|
-
{
|
|
16351
|
-
"name": "tryForEach",
|
|
16352
|
-
"signature": "function tryForEach(items: any[], callback: (item: any, index: number) => void, printErrors: any = false): void",
|
|
16353
|
-
"description": "",
|
|
16354
|
-
"params": [],
|
|
16355
|
-
"returnType": "void",
|
|
16356
|
-
"categories": [],
|
|
16357
|
-
"related": [],
|
|
16358
|
-
"isAsync": false,
|
|
16359
|
-
"isClass": false
|
|
16360
|
-
},
|
|
16361
|
-
{
|
|
16362
|
-
"name": "formatDate",
|
|
16363
|
-
"signature": "function formatDate(date: Date): string",
|
|
16364
|
-
"description": "",
|
|
16365
|
-
"params": [],
|
|
16366
|
-
"returnType": "string",
|
|
16367
|
-
"categories": [],
|
|
16368
|
-
"related": [],
|
|
16369
|
-
"isAsync": false,
|
|
16370
|
-
"isClass": false
|
|
16371
|
-
},
|
|
16372
|
-
{
|
|
16373
|
-
"name": "getCookieValue",
|
|
16374
|
-
"signature": "function getCookieValue(cookieName: string): string | null",
|
|
16375
|
-
"description": "",
|
|
16376
|
-
"params": [],
|
|
16377
|
-
"returnType": "string | null",
|
|
16378
|
-
"categories": [],
|
|
16379
|
-
"related": [],
|
|
16380
|
-
"isAsync": false,
|
|
16381
|
-
"isClass": false
|
|
16382
|
-
},
|
|
16383
|
-
{
|
|
16384
|
-
"name": "isClient",
|
|
16385
|
-
"signature": "function isClient(): boolean",
|
|
16386
|
-
"description": "",
|
|
16387
|
-
"params": [],
|
|
16388
|
-
"returnType": "boolean",
|
|
16389
|
-
"categories": [],
|
|
16390
|
-
"related": [],
|
|
16391
|
-
"isAsync": false,
|
|
16392
|
-
"isClass": false
|
|
16393
|
-
},
|
|
16394
|
-
{
|
|
16395
|
-
"name": "isServer",
|
|
16396
|
-
"signature": "function isServer(): boolean",
|
|
16397
|
-
"description": "",
|
|
16398
|
-
"params": [],
|
|
16399
|
-
"returnType": "boolean",
|
|
16400
|
-
"categories": [],
|
|
16401
|
-
"related": [],
|
|
16402
|
-
"isAsync": false,
|
|
16403
|
-
"isClass": false
|
|
16404
|
-
},
|
|
16405
|
-
{
|
|
16406
|
-
"name": "getQueryParams",
|
|
16407
|
-
"signature": "function getQueryParams(): URLSearchParams | undefined",
|
|
16408
|
-
"description": "",
|
|
16409
|
-
"params": [],
|
|
16410
|
-
"returnType": "URLSearchParams | undefined",
|
|
16411
|
-
"categories": [],
|
|
16412
|
-
"related": [],
|
|
16413
|
-
"isAsync": false,
|
|
16414
|
-
"isClass": false
|
|
16415
|
-
},
|
|
16416
|
-
{
|
|
16417
|
-
"name": "isBackNavigation",
|
|
16418
|
-
"signature": "function isBackNavigation(): boolean",
|
|
16419
|
-
"description": "",
|
|
16420
|
-
"params": [],
|
|
16421
|
-
"returnType": "boolean",
|
|
16422
|
-
"categories": [],
|
|
16423
|
-
"related": [],
|
|
16424
|
-
"isAsync": false,
|
|
16425
|
-
"isClass": false
|
|
16426
|
-
},
|
|
16427
|
-
{
|
|
16428
|
-
"name": "stringifyQueryParams",
|
|
16429
|
-
"signature": "function stringifyQueryParams(params: Record<string, any>, options: any = { arrayFormat: \"comma\" }): string",
|
|
16430
|
-
"description": "",
|
|
16431
|
-
"params": [],
|
|
16432
|
-
"returnType": "string",
|
|
16433
|
-
"categories": [],
|
|
16434
|
-
"related": [],
|
|
16435
|
-
"isAsync": false,
|
|
16436
|
-
"isClass": false
|
|
16437
|
-
},
|
|
16438
15150
|
{
|
|
16439
15151
|
"name": "cloneDeep",
|
|
16440
15152
|
"signature": "function cloneDeep(obj: T): T",
|
|
@@ -16446,39 +15158,6 @@
|
|
|
16446
15158
|
"isAsync": false,
|
|
16447
15159
|
"isClass": false
|
|
16448
15160
|
},
|
|
16449
|
-
{
|
|
16450
|
-
"name": "groupBy",
|
|
16451
|
-
"signature": "function groupBy(array: T[], iteratee: string | ((item: T) => string | number)): Record<string, T[]>",
|
|
16452
|
-
"description": "",
|
|
16453
|
-
"params": [],
|
|
16454
|
-
"returnType": "Record<string, T[]>",
|
|
16455
|
-
"categories": [],
|
|
16456
|
-
"related": [],
|
|
16457
|
-
"isAsync": false,
|
|
16458
|
-
"isClass": false
|
|
16459
|
-
},
|
|
16460
|
-
{
|
|
16461
|
-
"name": "sortBy",
|
|
16462
|
-
"signature": "function sortBy(array: T[], iteratees: Array<string | ((item: T) => any)>): T[]",
|
|
16463
|
-
"description": "",
|
|
16464
|
-
"params": [],
|
|
16465
|
-
"returnType": "T[]",
|
|
16466
|
-
"categories": [],
|
|
16467
|
-
"related": [],
|
|
16468
|
-
"isAsync": false,
|
|
16469
|
-
"isClass": false
|
|
16470
|
-
},
|
|
16471
|
-
{
|
|
16472
|
-
"name": "debounce",
|
|
16473
|
-
"signature": "function debounce(func: (...args: any[]) => void, wait: number): (...args: any[]) => void",
|
|
16474
|
-
"description": "",
|
|
16475
|
-
"params": [],
|
|
16476
|
-
"returnType": "(...args: any[]) => void",
|
|
16477
|
-
"categories": [],
|
|
16478
|
-
"related": [],
|
|
16479
|
-
"isAsync": false,
|
|
16480
|
-
"isClass": false
|
|
16481
|
-
},
|
|
16482
15161
|
{
|
|
16483
15162
|
"name": "reaction",
|
|
16484
15163
|
"signature": "function reaction(condition: () => any, effect: () => void): IReactionDisposer",
|