@ikas/code-components-mcp 1.4.0-beta.4 → 1.4.0-beta.40
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/framework.json +22 -5
- package/data/migration.json +189 -24
- package/data/storefront-api.json +114 -1381
- package/data/storefront-types.json +32 -124
- package/dist/index.js +511 -92
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/data/storefront-api.json
CHANGED
|
@@ -1,907 +1,32 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-
|
|
2
|
+
"generatedAt": "2026-06-10T09:36:05.906Z",
|
|
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[]>>",
|
|
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; }>>",
|
|
882
7
|
"description": "",
|
|
883
8
|
"params": [],
|
|
884
|
-
"returnType": "Promise<APIResponse<
|
|
9
|
+
"returnType": "Promise<APIResponse<{ data: IkasBrand[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
885
10
|
"categories": [],
|
|
886
11
|
"related": [],
|
|
887
12
|
"isAsync": true,
|
|
888
13
|
"isClass": false,
|
|
889
14
|
"parameterTypes": [
|
|
890
|
-
"
|
|
15
|
+
"IkasBrand"
|
|
891
16
|
]
|
|
892
17
|
},
|
|
893
18
|
{
|
|
894
|
-
"name": "
|
|
895
|
-
"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; }>>",
|
|
896
21
|
"description": "",
|
|
897
22
|
"params": [],
|
|
898
|
-
"returnType": "Promise<APIResponse<
|
|
23
|
+
"returnType": "Promise<APIResponse<{ data: IkasCategory[] | undefined; count?: number | undefined; hasNext?: boolean | undefined; limit?: number | undefined; page?: number | undefined; }>>",
|
|
899
24
|
"categories": [],
|
|
900
25
|
"related": [],
|
|
901
26
|
"isAsync": true,
|
|
902
27
|
"isClass": false,
|
|
903
28
|
"parameterTypes": [
|
|
904
|
-
"
|
|
29
|
+
"IkasCategory"
|
|
905
30
|
]
|
|
906
31
|
},
|
|
907
32
|
{
|
|
@@ -971,310 +96,71 @@
|
|
|
971
96
|
"isAsync": true,
|
|
972
97
|
"isClass": false,
|
|
973
98
|
"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[]>>",
|
|
1159
|
-
"description": "",
|
|
1160
|
-
"params": [],
|
|
1161
|
-
"returnType": "Promise<APIResponse<IkasProductCampaign[]>>",
|
|
1162
|
-
"categories": [],
|
|
1163
|
-
"related": [],
|
|
1164
|
-
"isAsync": true,
|
|
1165
|
-
"isClass": false,
|
|
1166
|
-
"parameterTypes": [
|
|
1167
|
-
"IkasProductCampaign"
|
|
1168
|
-
]
|
|
1169
|
-
},
|
|
1170
|
-
{
|
|
1171
|
-
"name": "apiGetVariantStockLocations",
|
|
1172
|
-
"signature": "async function apiGetVariantStockLocations(data: GetVariantStockLocationsQueryParams): Promise<APIResponse<IkasProductStockLocations[]>>",
|
|
1173
|
-
"description": "",
|
|
1174
|
-
"params": [],
|
|
1175
|
-
"returnType": "Promise<APIResponse<IkasProductStockLocations[]>>",
|
|
1176
|
-
"categories": [],
|
|
1177
|
-
"related": [],
|
|
1178
|
-
"isAsync": true,
|
|
1179
|
-
"isClass": false,
|
|
1180
|
-
"parameterTypes": [
|
|
1181
|
-
"IkasProductStockLocations"
|
|
1182
|
-
]
|
|
1183
|
-
},
|
|
1184
|
-
{
|
|
1185
|
-
"name": "apiGetOrderLineFile",
|
|
1186
|
-
"signature": "async function apiGetOrderLineFile(params: GetOrderLineFileQueryParams): Promise<APIResponse<undefined> | APIResponse<string>>",
|
|
1187
|
-
"description": "",
|
|
1188
|
-
"params": [],
|
|
1189
|
-
"returnType": "Promise<APIResponse<undefined> | APIResponse<string>>",
|
|
1190
|
-
"categories": [],
|
|
1191
|
-
"related": [],
|
|
1192
|
-
"isAsync": true,
|
|
1193
|
-
"isClass": false
|
|
1194
|
-
},
|
|
1195
|
-
{
|
|
1196
|
-
"name": "apiListProductOptionSet",
|
|
1197
|
-
"signature": "async function apiListProductOptionSet(params: ListProductOptionSetQueryParams, product: IkasProduct): Promise<APIResponse<IkasProductOptionSet[]>>",
|
|
1198
|
-
"description": "",
|
|
1199
|
-
"params": [],
|
|
1200
|
-
"returnType": "Promise<APIResponse<IkasProductOptionSet[]>>",
|
|
1201
|
-
"categories": [],
|
|
1202
|
-
"related": [],
|
|
1203
|
-
"isAsync": true,
|
|
1204
|
-
"isClass": false,
|
|
1205
|
-
"parameterTypes": [
|
|
1206
|
-
"IkasProduct",
|
|
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",
|
|
@@ -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,31 +7306,6 @@
|
|
|
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",
|
|
@@ -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",
|
|
@@ -16242,10 +15129,10 @@
|
|
|
16242
15129
|
},
|
|
16243
15130
|
{
|
|
16244
15131
|
"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<
|
|
15132
|
+
"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",
|
|
16246
15133
|
"description": "",
|
|
16247
15134
|
"params": [],
|
|
16248
|
-
"returnType": "VNode<ClassAttributes<
|
|
15135
|
+
"returnType": "VNode<ClassAttributes<HTMLDivElement> & { id: string; ref: MutableRef<HTMLDivElement | null>; dangerouslySetInnerHTML: { ...; }; style: { ...; }; className: string | undefined; }> | null",
|
|
16249
15136
|
"categories": [],
|
|
16250
15137
|
"related": [],
|
|
16251
15138
|
"isAsync": false,
|
|
@@ -16288,127 +15175,6 @@
|
|
|
16288
15175
|
"isAsync": true,
|
|
16289
15176
|
"isClass": false
|
|
16290
15177
|
},
|
|
16291
|
-
{
|
|
16292
|
-
"name": "findAllIndexes",
|
|
16293
|
-
"signature": "function findAllIndexes(str: string, pattern: string): number[]",
|
|
16294
|
-
"description": "",
|
|
16295
|
-
"params": [],
|
|
16296
|
-
"returnType": "number[]",
|
|
16297
|
-
"categories": [],
|
|
16298
|
-
"related": [],
|
|
16299
|
-
"isAsync": false,
|
|
16300
|
-
"isClass": false
|
|
16301
|
-
},
|
|
16302
|
-
{
|
|
16303
|
-
"name": "stringSorter",
|
|
16304
|
-
"signature": "function stringSorter(atitle: string, btitle: string): number",
|
|
16305
|
-
"description": "",
|
|
16306
|
-
"params": [],
|
|
16307
|
-
"returnType": "number",
|
|
16308
|
-
"categories": [],
|
|
16309
|
-
"related": [],
|
|
16310
|
-
"isAsync": false,
|
|
16311
|
-
"isClass": false
|
|
16312
|
-
},
|
|
16313
|
-
{
|
|
16314
|
-
"name": "capitalize",
|
|
16315
|
-
"signature": "function capitalize(value: string): string",
|
|
16316
|
-
"description": "",
|
|
16317
|
-
"params": [],
|
|
16318
|
-
"returnType": "string",
|
|
16319
|
-
"categories": [],
|
|
16320
|
-
"related": [],
|
|
16321
|
-
"isAsync": false,
|
|
16322
|
-
"isClass": false
|
|
16323
|
-
},
|
|
16324
|
-
{
|
|
16325
|
-
"name": "tryForEach",
|
|
16326
|
-
"signature": "function tryForEach(items: any[], callback: (item: any, index: number) => void, printErrors: any = false): void",
|
|
16327
|
-
"description": "",
|
|
16328
|
-
"params": [],
|
|
16329
|
-
"returnType": "void",
|
|
16330
|
-
"categories": [],
|
|
16331
|
-
"related": [],
|
|
16332
|
-
"isAsync": false,
|
|
16333
|
-
"isClass": false
|
|
16334
|
-
},
|
|
16335
|
-
{
|
|
16336
|
-
"name": "formatDate",
|
|
16337
|
-
"signature": "function formatDate(date: Date): string",
|
|
16338
|
-
"description": "",
|
|
16339
|
-
"params": [],
|
|
16340
|
-
"returnType": "string",
|
|
16341
|
-
"categories": [],
|
|
16342
|
-
"related": [],
|
|
16343
|
-
"isAsync": false,
|
|
16344
|
-
"isClass": false
|
|
16345
|
-
},
|
|
16346
|
-
{
|
|
16347
|
-
"name": "getCookieValue",
|
|
16348
|
-
"signature": "function getCookieValue(cookieName: string): string | null",
|
|
16349
|
-
"description": "",
|
|
16350
|
-
"params": [],
|
|
16351
|
-
"returnType": "string | null",
|
|
16352
|
-
"categories": [],
|
|
16353
|
-
"related": [],
|
|
16354
|
-
"isAsync": false,
|
|
16355
|
-
"isClass": false
|
|
16356
|
-
},
|
|
16357
|
-
{
|
|
16358
|
-
"name": "isClient",
|
|
16359
|
-
"signature": "function isClient(): boolean",
|
|
16360
|
-
"description": "",
|
|
16361
|
-
"params": [],
|
|
16362
|
-
"returnType": "boolean",
|
|
16363
|
-
"categories": [],
|
|
16364
|
-
"related": [],
|
|
16365
|
-
"isAsync": false,
|
|
16366
|
-
"isClass": false
|
|
16367
|
-
},
|
|
16368
|
-
{
|
|
16369
|
-
"name": "isServer",
|
|
16370
|
-
"signature": "function isServer(): boolean",
|
|
16371
|
-
"description": "",
|
|
16372
|
-
"params": [],
|
|
16373
|
-
"returnType": "boolean",
|
|
16374
|
-
"categories": [],
|
|
16375
|
-
"related": [],
|
|
16376
|
-
"isAsync": false,
|
|
16377
|
-
"isClass": false
|
|
16378
|
-
},
|
|
16379
|
-
{
|
|
16380
|
-
"name": "getQueryParams",
|
|
16381
|
-
"signature": "function getQueryParams(): URLSearchParams | undefined",
|
|
16382
|
-
"description": "",
|
|
16383
|
-
"params": [],
|
|
16384
|
-
"returnType": "URLSearchParams | undefined",
|
|
16385
|
-
"categories": [],
|
|
16386
|
-
"related": [],
|
|
16387
|
-
"isAsync": false,
|
|
16388
|
-
"isClass": false
|
|
16389
|
-
},
|
|
16390
|
-
{
|
|
16391
|
-
"name": "isBackNavigation",
|
|
16392
|
-
"signature": "function isBackNavigation(): boolean",
|
|
16393
|
-
"description": "",
|
|
16394
|
-
"params": [],
|
|
16395
|
-
"returnType": "boolean",
|
|
16396
|
-
"categories": [],
|
|
16397
|
-
"related": [],
|
|
16398
|
-
"isAsync": false,
|
|
16399
|
-
"isClass": false
|
|
16400
|
-
},
|
|
16401
|
-
{
|
|
16402
|
-
"name": "stringifyQueryParams",
|
|
16403
|
-
"signature": "function stringifyQueryParams(params: Record<string, any>, options: any = { arrayFormat: \"comma\" }): string",
|
|
16404
|
-
"description": "",
|
|
16405
|
-
"params": [],
|
|
16406
|
-
"returnType": "string",
|
|
16407
|
-
"categories": [],
|
|
16408
|
-
"related": [],
|
|
16409
|
-
"isAsync": false,
|
|
16410
|
-
"isClass": false
|
|
16411
|
-
},
|
|
16412
15178
|
{
|
|
16413
15179
|
"name": "cloneDeep",
|
|
16414
15180
|
"signature": "function cloneDeep(obj: T): T",
|
|
@@ -16420,39 +15186,6 @@
|
|
|
16420
15186
|
"isAsync": false,
|
|
16421
15187
|
"isClass": false
|
|
16422
15188
|
},
|
|
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
15189
|
{
|
|
16457
15190
|
"name": "reaction",
|
|
16458
15191
|
"signature": "function reaction(condition: () => any, effect: () => void): IReactionDisposer",
|