@dropins/mcp 0.1.0

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.
Files changed (103) hide show
  1. package/LICENSE.md +127 -0
  2. package/README.md +314 -0
  3. package/dist/common/project-reader.d.ts +55 -0
  4. package/dist/common/project-reader.js +173 -0
  5. package/dist/common/registry-loader.d.ts +101 -0
  6. package/dist/common/registry-loader.js +386 -0
  7. package/dist/common/response-handling.d.ts +12 -0
  8. package/dist/common/response-handling.js +21 -0
  9. package/dist/common/sanitize.d.ts +8 -0
  10. package/dist/common/sanitize.js +45 -0
  11. package/dist/common/synonyms.d.ts +9 -0
  12. package/dist/common/synonyms.js +127 -0
  13. package/dist/common/telemetry.d.ts +14 -0
  14. package/dist/common/telemetry.js +54 -0
  15. package/dist/common/types.d.ts +308 -0
  16. package/dist/common/types.js +1 -0
  17. package/dist/common/version.d.ts +2 -0
  18. package/dist/common/version.js +14 -0
  19. package/dist/index.d.ts +2 -0
  20. package/dist/index.js +136 -0
  21. package/dist/operations/analyze-project.d.ts +13 -0
  22. package/dist/operations/analyze-project.js +125 -0
  23. package/dist/operations/check-block-health.d.ts +19 -0
  24. package/dist/operations/check-block-health.js +1149 -0
  25. package/dist/operations/check-config.d.ts +13 -0
  26. package/dist/operations/check-config.js +228 -0
  27. package/dist/operations/explain-event-flow.d.ts +16 -0
  28. package/dist/operations/explain-event-flow.js +218 -0
  29. package/dist/operations/get-upgrade-diff.d.ts +13 -0
  30. package/dist/operations/get-upgrade-diff.js +144 -0
  31. package/dist/operations/list-api-functions.d.ts +13 -0
  32. package/dist/operations/list-api-functions.js +53 -0
  33. package/dist/operations/list-containers.d.ts +13 -0
  34. package/dist/operations/list-containers.js +44 -0
  35. package/dist/operations/list-design-tokens.d.ts +13 -0
  36. package/dist/operations/list-design-tokens.js +47 -0
  37. package/dist/operations/list-events.d.ts +16 -0
  38. package/dist/operations/list-events.js +39 -0
  39. package/dist/operations/list-graphql-queries.d.ts +19 -0
  40. package/dist/operations/list-graphql-queries.js +84 -0
  41. package/dist/operations/list-i18n-keys.d.ts +19 -0
  42. package/dist/operations/list-i18n-keys.js +105 -0
  43. package/dist/operations/list-models.d.ts +16 -0
  44. package/dist/operations/list-models.js +80 -0
  45. package/dist/operations/list-slots.d.ts +16 -0
  46. package/dist/operations/list-slots.js +81 -0
  47. package/dist/operations/scaffold-block.d.ts +31 -0
  48. package/dist/operations/scaffold-block.js +331 -0
  49. package/dist/operations/scaffold-extension.d.ts +28 -0
  50. package/dist/operations/scaffold-extension.js +346 -0
  51. package/dist/operations/scaffold-slot.d.ts +22 -0
  52. package/dist/operations/scaffold-slot.js +189 -0
  53. package/dist/operations/search-commerce-docs.d.ts +16 -0
  54. package/dist/operations/search-commerce-docs.js +101 -0
  55. package/dist/operations/search-docs.d.ts +23 -0
  56. package/dist/operations/search-docs.js +298 -0
  57. package/dist/operations/suggest-event-handler.d.ts +16 -0
  58. package/dist/operations/suggest-event-handler.js +175 -0
  59. package/dist/operations/suggest-slot-implementation.d.ts +19 -0
  60. package/dist/operations/suggest-slot-implementation.js +183 -0
  61. package/dist/registry/api-functions.json +3045 -0
  62. package/dist/registry/block-patterns.json +78 -0
  63. package/dist/registry/containers.json +2003 -0
  64. package/dist/registry/design-tokens.json +577 -0
  65. package/dist/registry/docs/boilerplate.json +55 -0
  66. package/dist/registry/docs/dropins-all.json +97 -0
  67. package/dist/registry/docs/dropins-b2b.json +607 -0
  68. package/dist/registry/docs/dropins-cart.json +163 -0
  69. package/dist/registry/docs/dropins-checkout.json +193 -0
  70. package/dist/registry/docs/dropins-order.json +139 -0
  71. package/dist/registry/docs/dropins-payment-services.json +73 -0
  72. package/dist/registry/docs/dropins-personalization.json +67 -0
  73. package/dist/registry/docs/dropins-product-details.json +139 -0
  74. package/dist/registry/docs/dropins-product-discovery.json +85 -0
  75. package/dist/registry/docs/dropins-recommendations.json +67 -0
  76. package/dist/registry/docs/dropins-user-account.json +121 -0
  77. package/dist/registry/docs/dropins-user-auth.json +103 -0
  78. package/dist/registry/docs/dropins-wishlist.json +85 -0
  79. package/dist/registry/docs/get-started.json +85 -0
  80. package/dist/registry/docs/how-tos.json +19 -0
  81. package/dist/registry/docs/index.json +139 -0
  82. package/dist/registry/docs/licensing.json +19 -0
  83. package/dist/registry/docs/merchants.json +523 -0
  84. package/dist/registry/docs/resources.json +13 -0
  85. package/dist/registry/docs/sdk.json +139 -0
  86. package/dist/registry/docs/setup.json +145 -0
  87. package/dist/registry/docs/troubleshooting.json +19 -0
  88. package/dist/registry/events.json +2200 -0
  89. package/dist/registry/examples/index.json +19 -0
  90. package/dist/registry/examples/storefront-checkout.json +377 -0
  91. package/dist/registry/examples/storefront-quote-management.json +49 -0
  92. package/dist/registry/extensions.json +272 -0
  93. package/dist/registry/graphql.json +3469 -0
  94. package/dist/registry/i18n.json +1873 -0
  95. package/dist/registry/models.json +1001 -0
  96. package/dist/registry/sdk.json +2357 -0
  97. package/dist/registry/slots.json +2270 -0
  98. package/dist/registry/tools-components.json +595 -0
  99. package/dist/resources/guides.d.ts +7 -0
  100. package/dist/resources/guides.js +625 -0
  101. package/dist/resources/handlers.d.ts +31 -0
  102. package/dist/resources/handlers.js +322 -0
  103. package/package.json +47 -0
@@ -0,0 +1,3045 @@
1
+ {
2
+ "version": "1.0.0",
3
+ "description": "Auto-generated API function registry",
4
+ "sharedFunctions": {
5
+ "fetchGraphQl": "Shared GraphQL fetch helper available in all dropins via @dropins/<dropin>/api.js"
6
+ },
7
+ "dropins": {
8
+ "storefront-cart": {
9
+ "version": "3.2.0",
10
+ "importPath": "@dropins/storefront-cart/api.js",
11
+ "functions": [
12
+ {
13
+ "name": "addProductsToCart",
14
+ "signature": "addProductsToCart(items: {\n sku: string;\n parentSku?: string;\n quantity: number;\n optionsUIDs?: string[];\n enteredOptions?: { uid: string; value: string }[];\n customFields?: Record<string, any>;\n }[]): Promise<CartModel | null>",
15
+ "parameters": [
16
+ {
17
+ "name": "items",
18
+ "type": "{\n sku: string;\n parentSku?: string;\n quantity: number;\n optionsUIDs?: string[];\n enteredOptions?: { uid: string; value: string }[];\n customFields?: Record<string, any>;\n }[]",
19
+ "optional": false
20
+ }
21
+ ],
22
+ "returnType": "Promise<CartModel | null>",
23
+ "description": ""
24
+ },
25
+ {
26
+ "name": "getCartData",
27
+ "signature": "getCartData(): Promise<CartModel | null>",
28
+ "parameters": [],
29
+ "returnType": "Promise<CartModel | null>",
30
+ "description": ""
31
+ },
32
+ {
33
+ "name": "initializeCart",
34
+ "signature": "initializeCart(): Promise<CartModel | null>",
35
+ "parameters": [],
36
+ "returnType": "Promise<CartModel | null>",
37
+ "description": ""
38
+ },
39
+ {
40
+ "name": "getCustomerCartPayload",
41
+ "signature": "getCustomerCartPayload(): unknown",
42
+ "parameters": [],
43
+ "returnType": "unknown",
44
+ "description": ""
45
+ },
46
+ {
47
+ "name": "getGuestCartPayload",
48
+ "signature": "getGuestCartPayload(): unknown",
49
+ "parameters": [],
50
+ "returnType": "unknown",
51
+ "description": ""
52
+ },
53
+ {
54
+ "name": "updateProductsFromCart",
55
+ "signature": "updateProductsFromCart(items: UpdateProductsFromCart): Promise<CartModel | null>",
56
+ "parameters": [
57
+ {
58
+ "name": "items",
59
+ "type": "UpdateProductsFromCart",
60
+ "optional": false
61
+ }
62
+ ],
63
+ "returnType": "Promise<CartModel | null>",
64
+ "description": ""
65
+ },
66
+ {
67
+ "name": "resetCart",
68
+ "signature": "resetCart(): Promise<CartModel | null>",
69
+ "parameters": [],
70
+ "returnType": "Promise<CartModel | null>",
71
+ "description": ""
72
+ },
73
+ {
74
+ "name": "createGuestCart",
75
+ "signature": "createGuestCart(): unknown",
76
+ "parameters": [],
77
+ "returnType": "unknown",
78
+ "description": ""
79
+ },
80
+ {
81
+ "name": "getStoreConfig",
82
+ "signature": "getStoreConfig(): Promise<StoreConfigModel | null>",
83
+ "parameters": [],
84
+ "returnType": "Promise<StoreConfigModel | null>",
85
+ "description": ""
86
+ },
87
+ {
88
+ "name": "getEstimateShipping",
89
+ "signature": "getEstimateShipping(address: EstimateAddressInput): Promise<any | null>",
90
+ "parameters": [
91
+ {
92
+ "name": "address",
93
+ "type": "EstimateAddressInput",
94
+ "optional": false
95
+ }
96
+ ],
97
+ "returnType": "Promise<any | null>",
98
+ "description": ""
99
+ },
100
+ {
101
+ "name": "getCountries",
102
+ "signature": "getCountries(): Promise<[CountryData]>",
103
+ "parameters": [],
104
+ "returnType": "Promise<[CountryData]>",
105
+ "description": ""
106
+ },
107
+ {
108
+ "name": "getRegions",
109
+ "signature": "getRegions(countryId: string): Promise<Array<{ code: string; name: string }>>",
110
+ "parameters": [
111
+ {
112
+ "name": "countryId",
113
+ "type": "string",
114
+ "optional": false
115
+ }
116
+ ],
117
+ "returnType": "Promise<Array<{ code: string; name: string }>>",
118
+ "description": ""
119
+ },
120
+ {
121
+ "name": "getEstimatedTotals",
122
+ "signature": "getEstimatedTotals(address: EstimateAddressShippingInput): Promise<CartModel | null>",
123
+ "parameters": [
124
+ {
125
+ "name": "address",
126
+ "type": "EstimateAddressShippingInput",
127
+ "optional": false
128
+ }
129
+ ],
130
+ "returnType": "Promise<CartModel | null>",
131
+ "description": ""
132
+ },
133
+ {
134
+ "name": "refreshCart",
135
+ "signature": "refreshCart(): Promise<CartModel | null>",
136
+ "parameters": [],
137
+ "returnType": "Promise<CartModel | null>",
138
+ "description": ""
139
+ },
140
+ {
141
+ "name": "getCartDataFromCache",
142
+ "signature": "getCartDataFromCache(): CartModel | null",
143
+ "parameters": [],
144
+ "returnType": "CartModel | null",
145
+ "description": ""
146
+ },
147
+ {
148
+ "name": "applyCouponsToCart",
149
+ "signature": "applyCouponsToCart(couponCodes: string[], type: ApplyCouponsStrategy): Promise<CartModel | null>",
150
+ "parameters": [
151
+ {
152
+ "name": "couponCodes",
153
+ "type": "string[]",
154
+ "optional": false
155
+ },
156
+ {
157
+ "name": "type",
158
+ "type": "ApplyCouponsStrategy",
159
+ "optional": false
160
+ }
161
+ ],
162
+ "returnType": "Promise<CartModel | null>",
163
+ "description": ""
164
+ },
165
+ {
166
+ "name": "publishShoppingCartViewEvent",
167
+ "signature": "publishShoppingCartViewEvent(): unknown",
168
+ "parameters": [],
169
+ "returnType": "unknown",
170
+ "description": ""
171
+ },
172
+ {
173
+ "name": "applyGiftCardToCart",
174
+ "signature": "applyGiftCardToCart(giftCardCode: string): Promise<CartModel | null>",
175
+ "parameters": [
176
+ {
177
+ "name": "giftCardCode",
178
+ "type": "string",
179
+ "optional": false
180
+ }
181
+ ],
182
+ "returnType": "Promise<CartModel | null>",
183
+ "description": ""
184
+ },
185
+ {
186
+ "name": "removeGiftCardFromCart",
187
+ "signature": "removeGiftCardFromCart(giftCardCode: string): Promise<CartModel | null>",
188
+ "parameters": [
189
+ {
190
+ "name": "giftCardCode",
191
+ "type": "string",
192
+ "optional": false
193
+ }
194
+ ],
195
+ "returnType": "Promise<CartModel | null>",
196
+ "description": ""
197
+ },
198
+ {
199
+ "name": "setGiftOptionsOnCart",
200
+ "signature": "setGiftOptionsOnCart(giftForm: GiftFormDataType): Promise<CartModel | null>",
201
+ "parameters": [
202
+ {
203
+ "name": "giftForm",
204
+ "type": "GiftFormDataType",
205
+ "optional": false
206
+ }
207
+ ],
208
+ "returnType": "Promise<CartModel | null>",
209
+ "description": ""
210
+ }
211
+ ]
212
+ },
213
+ "storefront-checkout": {
214
+ "version": "3.2.1",
215
+ "importPath": "@dropins/storefront-checkout/api.js",
216
+ "functions": [
217
+ {
218
+ "name": "authenticateCustomer",
219
+ "signature": "authenticateCustomer(authenticated?: unknown): unknown",
220
+ "parameters": [
221
+ {
222
+ "name": "authenticated",
223
+ "type": "unknown",
224
+ "optional": true
225
+ }
226
+ ],
227
+ "returnType": "unknown",
228
+ "description": ""
229
+ },
230
+ {
231
+ "name": "estimateShippingMethods",
232
+ "signature": "estimateShippingMethods(input?: EstimateShippingInput): Promise<ShippingMethod[] | undefined>",
233
+ "parameters": [
234
+ {
235
+ "name": "input",
236
+ "type": "EstimateShippingInput",
237
+ "optional": true
238
+ }
239
+ ],
240
+ "returnType": "Promise<ShippingMethod[] | undefined>",
241
+ "description": ""
242
+ },
243
+ {
244
+ "name": "getCart",
245
+ "signature": "getCart(): unknown",
246
+ "parameters": [],
247
+ "returnType": "unknown",
248
+ "description": ""
249
+ },
250
+ {
251
+ "name": "getCheckoutAgreements",
252
+ "signature": "getCheckoutAgreements(): Promise<CheckoutAgreement[]>",
253
+ "parameters": [],
254
+ "returnType": "Promise<CheckoutAgreement[]>",
255
+ "description": ""
256
+ },
257
+ {
258
+ "name": "getCompanyCredit",
259
+ "signature": "getCompanyCredit(): Promise<CompanyCredit | null>",
260
+ "parameters": [],
261
+ "returnType": "Promise<CompanyCredit | null>",
262
+ "description": ""
263
+ },
264
+ {
265
+ "name": "getCustomer",
266
+ "signature": "getCustomer(): Promise<Customer | null>",
267
+ "parameters": [],
268
+ "returnType": "Promise<Customer | null>",
269
+ "description": ""
270
+ },
271
+ {
272
+ "name": "getNegotiableQuote",
273
+ "signature": "getNegotiableQuote(input?: GetNegotiableQuoteInput): unknown",
274
+ "parameters": [
275
+ {
276
+ "name": "input",
277
+ "type": "GetNegotiableQuoteInput",
278
+ "optional": true
279
+ }
280
+ ],
281
+ "returnType": "unknown",
282
+ "description": ""
283
+ },
284
+ {
285
+ "name": "getStoreConfig",
286
+ "signature": "getStoreConfig(): unknown",
287
+ "parameters": [],
288
+ "returnType": "unknown",
289
+ "description": ""
290
+ },
291
+ {
292
+ "name": "getStoreConfigCache",
293
+ "signature": "getStoreConfigCache(): unknown",
294
+ "parameters": [],
295
+ "returnType": "unknown",
296
+ "description": ""
297
+ },
298
+ {
299
+ "name": "initializeCheckout",
300
+ "signature": "initializeCheckout(input: InitializeInput): unknown",
301
+ "parameters": [
302
+ {
303
+ "name": "input",
304
+ "type": "InitializeInput",
305
+ "optional": false
306
+ }
307
+ ],
308
+ "returnType": "unknown",
309
+ "description": ""
310
+ },
311
+ {
312
+ "name": "isEmailAvailable",
313
+ "signature": "isEmailAvailable(email: string): Promise<EmailAvailability>",
314
+ "parameters": [
315
+ {
316
+ "name": "email",
317
+ "type": "string",
318
+ "optional": false
319
+ }
320
+ ],
321
+ "returnType": "Promise<EmailAvailability>",
322
+ "description": ""
323
+ },
324
+ {
325
+ "name": "resetCheckout",
326
+ "signature": "resetCheckout(): unknown",
327
+ "parameters": [],
328
+ "returnType": "unknown",
329
+ "description": ""
330
+ },
331
+ {
332
+ "name": "setBillingAddress",
333
+ "signature": "setBillingAddress(input: BillingAddressInputModel): unknown",
334
+ "parameters": [
335
+ {
336
+ "name": "input",
337
+ "type": "BillingAddressInputModel",
338
+ "optional": false
339
+ }
340
+ ],
341
+ "returnType": "unknown",
342
+ "description": ""
343
+ },
344
+ {
345
+ "name": "setGuestEmailOnCart",
346
+ "signature": "setGuestEmailOnCart(email: string): unknown",
347
+ "parameters": [
348
+ {
349
+ "name": "email",
350
+ "type": "string",
351
+ "optional": false
352
+ }
353
+ ],
354
+ "returnType": "unknown",
355
+ "description": ""
356
+ },
357
+ {
358
+ "name": "setPaymentMethod",
359
+ "signature": "setPaymentMethod(input: PaymentMethodInputModel): unknown",
360
+ "parameters": [
361
+ {
362
+ "name": "input",
363
+ "type": "PaymentMethodInputModel",
364
+ "optional": false
365
+ }
366
+ ],
367
+ "returnType": "unknown",
368
+ "description": ""
369
+ },
370
+ {
371
+ "name": "setShippingAddress",
372
+ "signature": "setShippingAddress(input: ShippingAddressInputModel): unknown",
373
+ "parameters": [
374
+ {
375
+ "name": "input",
376
+ "type": "ShippingAddressInputModel",
377
+ "optional": false
378
+ }
379
+ ],
380
+ "returnType": "unknown",
381
+ "description": ""
382
+ },
383
+ {
384
+ "name": "setShippingMethods",
385
+ "signature": "setShippingMethods(input: Array<ShippingMethodInputModel>): unknown",
386
+ "parameters": [
387
+ {
388
+ "name": "input",
389
+ "type": "Array<ShippingMethodInputModel>",
390
+ "optional": false
391
+ }
392
+ ],
393
+ "returnType": "unknown",
394
+ "description": ""
395
+ },
396
+ {
397
+ "name": "setShippingMethodsOnCart",
398
+ "signature": "setShippingMethodsOnCart(input: Array<ShippingMethodInputModel>): unknown",
399
+ "parameters": [
400
+ {
401
+ "name": "input",
402
+ "type": "Array<ShippingMethodInputModel>",
403
+ "optional": false
404
+ }
405
+ ],
406
+ "returnType": "unknown",
407
+ "description": ""
408
+ },
409
+ {
410
+ "name": "synchronizeCheckout",
411
+ "signature": "synchronizeCheckout(data: SynchronizeInput): unknown",
412
+ "parameters": [
413
+ {
414
+ "name": "data",
415
+ "type": "SynchronizeInput",
416
+ "optional": false
417
+ }
418
+ ],
419
+ "returnType": "unknown",
420
+ "description": ""
421
+ }
422
+ ],
423
+ "utils": {
424
+ "importPath": "@dropins/storefront-checkout/lib/utils",
425
+ "description": "Utility functions for storefront-checkout block development",
426
+ "modules": {
427
+ "api": {
428
+ "description": "",
429
+ "functions": [
430
+ {
431
+ "name": "setAddressOnCart",
432
+ "signature": "export function setAddressOnCart(",
433
+ "description": ""
434
+ },
435
+ {
436
+ "name": "estimateShippingCost",
437
+ "signature": "export function estimateShippingCost(",
438
+ "description": ""
439
+ }
440
+ ]
441
+ },
442
+ "dom": {
443
+ "description": "",
444
+ "functions": [
445
+ {
446
+ "name": "getParentContainer",
447
+ "signature": "export function getParentContainer(element: HTMLElement): HTMLElement | null",
448
+ "description": ""
449
+ },
450
+ {
451
+ "name": "scrollToElement",
452
+ "signature": "export function scrollToElement(element: HTMLElement)",
453
+ "description": ""
454
+ },
455
+ {
456
+ "name": "scrollToParentContainer",
457
+ "signature": "export function scrollToParentContainer(element: HTMLElement)",
458
+ "description": ""
459
+ }
460
+ ]
461
+ },
462
+ "events": {
463
+ "description": "",
464
+ "functions": [
465
+ {
466
+ "name": "isVirtualCart",
467
+ "signature": "export function isVirtualCart(data?: CartData)",
468
+ "description": ""
469
+ },
470
+ {
471
+ "name": "isEmptyCart",
472
+ "signature": "export function isEmptyCart(data: CartData)",
473
+ "description": ""
474
+ },
475
+ {
476
+ "name": "getCartShippingMethod",
477
+ "signature": "export function getCartShippingMethod(data: CartData)",
478
+ "description": ""
479
+ },
480
+ {
481
+ "name": "getCartAddress",
482
+ "signature": "export function getCartAddress(\n data: CartData,\n type: 'shipping' | 'billing' = 'shipping'\n): Record<string, any> | null",
483
+ "description": ""
484
+ },
485
+ {
486
+ "name": "getCartPaymentMethod",
487
+ "signature": "export function getCartPaymentMethod(data: CartData)",
488
+ "description": ""
489
+ }
490
+ ]
491
+ },
492
+ "forms": {
493
+ "description": "",
494
+ "functions": [
495
+ {
496
+ "name": "validateForm",
497
+ "signature": "export function validateForm(\n form: HTMLForm,\n autoScrollOnError: boolean = false\n): boolean",
498
+ "description": ""
499
+ },
500
+ {
501
+ "name": "validateForms",
502
+ "signature": "export function validateForms(forms: HTMLForm[]): boolean",
503
+ "description": ""
504
+ }
505
+ ]
506
+ },
507
+ "fragments": {
508
+ "description": "",
509
+ "functions": [
510
+ {
511
+ "name": "createFragment",
512
+ "signature": "export function createFragment(html: string): DocumentFragment",
513
+ "description": ""
514
+ },
515
+ {
516
+ "name": "createScopedSelector",
517
+ "signature": "export function createScopedSelector(\n fragment: DocumentFragment\n): (selector: string) => HTMLElement | null",
518
+ "description": ""
519
+ }
520
+ ]
521
+ },
522
+ "meta": {
523
+ "description": "",
524
+ "functions": [
525
+ {
526
+ "name": "createMetaTag",
527
+ "signature": "export function createMetaTag(property: string, content: string, type: string)",
528
+ "description": ""
529
+ },
530
+ {
531
+ "name": "setMetaTags",
532
+ "signature": "export function setMetaTags(dropin: string)",
533
+ "description": ""
534
+ }
535
+ ]
536
+ },
537
+ "transformers": {
538
+ "description": "",
539
+ "functions": [
540
+ {
541
+ "name": "transformAddressFormValuesToAddressInput",
542
+ "signature": "transformAddressFormValuesToAddressInput = (\n data: Record<string, any>\n): ShippingAddressInput | BillingAddressInput => ...",
543
+ "description": ""
544
+ },
545
+ {
546
+ "name": "transformCartAddressToFormValues",
547
+ "signature": "transformCartAddressToFormValues = (\n address: CartAddress\n): Record<string, any> => ...",
548
+ "description": ""
549
+ }
550
+ ]
551
+ }
552
+ }
553
+ }
554
+ },
555
+ "storefront-order": {
556
+ "version": "3.3.0",
557
+ "importPath": "@dropins/storefront-order/api.js",
558
+ "functions": [
559
+ {
560
+ "name": "cancelOrder",
561
+ "signature": "cancelOrder(orderId: string, reason: string, onSuccess: Function, onError: Function): Promise<void | null | undefined>",
562
+ "parameters": [
563
+ {
564
+ "name": "orderId",
565
+ "type": "string",
566
+ "optional": false
567
+ },
568
+ {
569
+ "name": "reason",
570
+ "type": "string",
571
+ "optional": false
572
+ },
573
+ {
574
+ "name": "onSuccess",
575
+ "type": "Function",
576
+ "optional": false
577
+ },
578
+ {
579
+ "name": "onError",
580
+ "type": "Function",
581
+ "optional": false
582
+ }
583
+ ],
584
+ "returnType": "Promise<void | null | undefined>",
585
+ "description": ""
586
+ },
587
+ {
588
+ "name": "getAttributesForm",
589
+ "signature": "getAttributesForm(formCode: string): Promise<AttributesFormModel[]>",
590
+ "parameters": [
591
+ {
592
+ "name": "formCode",
593
+ "type": "string",
594
+ "optional": false
595
+ }
596
+ ],
597
+ "returnType": "Promise<AttributesFormModel[]>",
598
+ "description": ""
599
+ },
600
+ {
601
+ "name": "getAttributesList",
602
+ "signature": "getAttributesList(entityType: string): Promise<AttributesFormModel[] | []>",
603
+ "parameters": [
604
+ {
605
+ "name": "entityType",
606
+ "type": "string",
607
+ "optional": false
608
+ }
609
+ ],
610
+ "returnType": "Promise<AttributesFormModel[] | []>",
611
+ "description": ""
612
+ },
613
+ {
614
+ "name": "getCustomer",
615
+ "signature": "getCustomer(): Promise<CustomerDataModelShort>",
616
+ "parameters": [],
617
+ "returnType": "Promise<CustomerDataModelShort>",
618
+ "description": ""
619
+ },
620
+ {
621
+ "name": "getCustomerOrdersReturn",
622
+ "signature": "getCustomerOrdersReturn(pageSize?: unknown, currentPage?: unknown): Promise<CustomerOrdersReturnModel | null>",
623
+ "parameters": [
624
+ {
625
+ "name": "pageSize",
626
+ "type": "unknown",
627
+ "optional": true
628
+ },
629
+ {
630
+ "name": "currentPage",
631
+ "type": "unknown",
632
+ "optional": true
633
+ }
634
+ ],
635
+ "returnType": "Promise<CustomerOrdersReturnModel | null>",
636
+ "description": ""
637
+ },
638
+ {
639
+ "name": "getGuestOrder",
640
+ "signature": "getGuestOrder(form: {\n number: string;\n email: string;\n lastname: string;\n}): Promise<OrderDataModel | null>",
641
+ "parameters": [
642
+ {
643
+ "name": "form",
644
+ "type": "{\n number: string;\n email: string;\n lastname: string;\n}",
645
+ "optional": false
646
+ }
647
+ ],
648
+ "returnType": "Promise<OrderDataModel | null>",
649
+ "description": ""
650
+ },
651
+ {
652
+ "name": "getOrderDetailsById",
653
+ "signature": "getOrderDetailsById({\n orderId,\n returnRef,\n queryType,\n returnsPageSize = 50,\n}: GetOrderDetailsByIdProps): Promise<TransformedData<T>>",
654
+ "parameters": [
655
+ {
656
+ "name": "{\n orderId,\n returnRef,\n queryType,\n returnsPageSize = 50,\n}",
657
+ "type": "GetOrderDetailsByIdProps",
658
+ "optional": false
659
+ }
660
+ ],
661
+ "returnType": "Promise<TransformedData<T>>",
662
+ "description": ""
663
+ },
664
+ {
665
+ "name": "getStoreConfig",
666
+ "signature": "getStoreConfig(): Promise<StoreConfigModel | null>",
667
+ "parameters": [],
668
+ "returnType": "Promise<StoreConfigModel | null>",
669
+ "description": ""
670
+ },
671
+ {
672
+ "name": "guestOrderByToken",
673
+ "signature": "guestOrderByToken(token?: string, returnRef?: string): Promise<OrderDataModel | null>",
674
+ "parameters": [
675
+ {
676
+ "name": "token",
677
+ "type": "string",
678
+ "optional": true
679
+ },
680
+ {
681
+ "name": "returnRef",
682
+ "type": "string",
683
+ "optional": true
684
+ }
685
+ ],
686
+ "returnType": "Promise<OrderDataModel | null>",
687
+ "description": ""
688
+ },
689
+ {
690
+ "name": "placeOrder",
691
+ "signature": "placeOrder(cartId: string): Promise<OrderDataModel | null | undefined>",
692
+ "parameters": [
693
+ {
694
+ "name": "cartId",
695
+ "type": "string",
696
+ "optional": false
697
+ }
698
+ ],
699
+ "returnType": "Promise<OrderDataModel | null | undefined>",
700
+ "description": ""
701
+ },
702
+ {
703
+ "name": "reorderItems",
704
+ "signature": "reorderItems(orderNumber: string): Promise<ReorderItemsProps>",
705
+ "parameters": [
706
+ {
707
+ "name": "orderNumber",
708
+ "type": "string",
709
+ "optional": false
710
+ }
711
+ ],
712
+ "returnType": "Promise<ReorderItemsProps>",
713
+ "description": ""
714
+ },
715
+ {
716
+ "name": "requestGuestOrderCancel",
717
+ "signature": "requestGuestOrderCancel(token: string, reason: string, onSuccess: Function, onError: Function): Promise<void>",
718
+ "parameters": [
719
+ {
720
+ "name": "token",
721
+ "type": "string",
722
+ "optional": false
723
+ },
724
+ {
725
+ "name": "reason",
726
+ "type": "string",
727
+ "optional": false
728
+ },
729
+ {
730
+ "name": "onSuccess",
731
+ "type": "Function",
732
+ "optional": false
733
+ },
734
+ {
735
+ "name": "onError",
736
+ "type": "Function",
737
+ "optional": false
738
+ }
739
+ ],
740
+ "returnType": "Promise<void>",
741
+ "description": ""
742
+ },
743
+ {
744
+ "name": "requestReturn",
745
+ "signature": "requestReturn(form: RequestReturnProps): Promise<RequestReturnModel | {}>",
746
+ "parameters": [
747
+ {
748
+ "name": "form",
749
+ "type": "RequestReturnProps",
750
+ "optional": false
751
+ }
752
+ ],
753
+ "returnType": "Promise<RequestReturnModel | {}>",
754
+ "description": ""
755
+ },
756
+ {
757
+ "name": "requestGuestReturn",
758
+ "signature": "requestGuestReturn(form: RequestGuestReturnProps): Promise<{\n uid: string;\n number: string;\n status: string;\n createdAt: string;\n}>",
759
+ "parameters": [
760
+ {
761
+ "name": "form",
762
+ "type": "RequestGuestReturnProps",
763
+ "optional": false
764
+ }
765
+ ],
766
+ "returnType": "Promise<{\n uid: string;\n number: string;\n status: string;\n createdAt: string;\n}>",
767
+ "description": ""
768
+ },
769
+ {
770
+ "name": "confirmGuestReturn",
771
+ "signature": "confirmGuestReturn(orderId: string, confirmationKey: string): Promise<OrderDataModel | null>",
772
+ "parameters": [
773
+ {
774
+ "name": "orderId",
775
+ "type": "string",
776
+ "optional": false
777
+ },
778
+ {
779
+ "name": "confirmationKey",
780
+ "type": "string",
781
+ "optional": false
782
+ }
783
+ ],
784
+ "returnType": "Promise<OrderDataModel | null>",
785
+ "description": ""
786
+ },
787
+ {
788
+ "name": "confirmCancelOrder",
789
+ "signature": "confirmCancelOrder(orderId: string, confirmationKey: string): unknown",
790
+ "parameters": [
791
+ {
792
+ "name": "orderId",
793
+ "type": "string",
794
+ "optional": false
795
+ },
796
+ {
797
+ "name": "confirmationKey",
798
+ "type": "string",
799
+ "optional": false
800
+ }
801
+ ],
802
+ "returnType": "unknown",
803
+ "description": ""
804
+ },
805
+ {
806
+ "name": "setPaymentMethodAndPlaceOrder",
807
+ "signature": "setPaymentMethodAndPlaceOrder(cartId: string, paymentMethod: any): Promise<OrderDataModel | null | undefined>",
808
+ "parameters": [
809
+ {
810
+ "name": "cartId",
811
+ "type": "string",
812
+ "optional": false
813
+ },
814
+ {
815
+ "name": "paymentMethod",
816
+ "type": "any",
817
+ "optional": false
818
+ }
819
+ ],
820
+ "returnType": "Promise<OrderDataModel | null | undefined>",
821
+ "description": ""
822
+ },
823
+ {
824
+ "name": "placeNegotiableQuoteOrder",
825
+ "signature": "placeNegotiableQuoteOrder(quoteUid: string): Promise<OrderDataModel | null | undefined>",
826
+ "parameters": [
827
+ {
828
+ "name": "quoteUid",
829
+ "type": "string",
830
+ "optional": false
831
+ }
832
+ ],
833
+ "returnType": "Promise<OrderDataModel | null | undefined>",
834
+ "description": ""
835
+ }
836
+ ]
837
+ },
838
+ "storefront-auth": {
839
+ "version": "3.2.0",
840
+ "importPath": "@dropins/storefront-auth/api.js",
841
+ "functions": [
842
+ {
843
+ "name": "createCustomer",
844
+ "signature": "createCustomer(forms: Customer, apiVersion2: boolean): Promise<CustomerModel>",
845
+ "parameters": [
846
+ {
847
+ "name": "forms",
848
+ "type": "Customer",
849
+ "optional": false
850
+ },
851
+ {
852
+ "name": "apiVersion2",
853
+ "type": "boolean",
854
+ "optional": false
855
+ }
856
+ ],
857
+ "returnType": "Promise<CustomerModel>",
858
+ "description": ""
859
+ },
860
+ {
861
+ "name": "getAttributesForm",
862
+ "signature": "getAttributesForm(formCode: string): Promise<AttributesFormModel[]>",
863
+ "parameters": [
864
+ {
865
+ "name": "formCode",
866
+ "type": "string",
867
+ "optional": false
868
+ }
869
+ ],
870
+ "returnType": "Promise<AttributesFormModel[]>",
871
+ "description": ""
872
+ },
873
+ {
874
+ "name": "getCustomerData",
875
+ "signature": "getCustomerData(user_token: string): Promise<CustomerModel>",
876
+ "parameters": [
877
+ {
878
+ "name": "user_token",
879
+ "type": "string",
880
+ "optional": false
881
+ }
882
+ ],
883
+ "returnType": "Promise<CustomerModel>",
884
+ "description": ""
885
+ },
886
+ {
887
+ "name": "getCustomerToken",
888
+ "signature": "getCustomerToken({\n email,\n password,\n translations,\n onErrorCallback,\n handleSetInLineAlertProps,\n apiErrorMessageOverride,\n}: getCustomerTokenProps): Promise<{\n errorMessage: string;\n displayErrorMessage: string;\n userName: string;\n userEmail: string;\n}>",
889
+ "parameters": [
890
+ {
891
+ "name": "{\n email,\n password,\n translations,\n onErrorCallback,\n handleSetInLineAlertProps,\n apiErrorMessageOverride,\n}",
892
+ "type": "getCustomerTokenProps",
893
+ "optional": false
894
+ }
895
+ ],
896
+ "returnType": "Promise<{\n errorMessage: string;\n displayErrorMessage: string;\n userName: string;\n userEmail: string;\n}>",
897
+ "description": ""
898
+ },
899
+ {
900
+ "name": "getStoreConfig",
901
+ "signature": "getStoreConfig(): Promise<StoreConfigModel>",
902
+ "parameters": [],
903
+ "returnType": "Promise<StoreConfigModel>",
904
+ "description": ""
905
+ },
906
+ {
907
+ "name": "requestPasswordResetEmail",
908
+ "signature": "requestPasswordResetEmail(email: string): Promise<PasswordResetEmailModel>",
909
+ "parameters": [
910
+ {
911
+ "name": "email",
912
+ "type": "string",
913
+ "optional": false
914
+ }
915
+ ],
916
+ "returnType": "Promise<PasswordResetEmailModel>",
917
+ "description": ""
918
+ },
919
+ {
920
+ "name": "resetPassword",
921
+ "signature": "resetPassword(email: string, resetPasswordToken: string, newPassword: string): Promise<ResetPasswordModel>",
922
+ "parameters": [
923
+ {
924
+ "name": "email",
925
+ "type": "string",
926
+ "optional": false
927
+ },
928
+ {
929
+ "name": "resetPasswordToken",
930
+ "type": "string",
931
+ "optional": false
932
+ },
933
+ {
934
+ "name": "newPassword",
935
+ "type": "string",
936
+ "optional": false
937
+ }
938
+ ],
939
+ "returnType": "Promise<ResetPasswordModel>",
940
+ "description": ""
941
+ },
942
+ {
943
+ "name": "revokeCustomerToken",
944
+ "signature": "revokeCustomerToken(): Promise<RevokeCustomerTokenModel>",
945
+ "parameters": [],
946
+ "returnType": "Promise<RevokeCustomerTokenModel>",
947
+ "description": ""
948
+ },
949
+ {
950
+ "name": "confirmEmail",
951
+ "signature": "confirmEmail({\n customerEmail,\n customerConfirmationKey,\n}: confirmEmailProps): Promise<confirmEmailResponse | undefined>",
952
+ "parameters": [
953
+ {
954
+ "name": "{\n customerEmail,\n customerConfirmationKey,\n}",
955
+ "type": "confirmEmailProps",
956
+ "optional": false
957
+ }
958
+ ],
959
+ "returnType": "Promise<confirmEmailResponse | undefined>",
960
+ "description": ""
961
+ },
962
+ {
963
+ "name": "resendConfirmationEmail",
964
+ "signature": "resendConfirmationEmail(customerEmail: string): Promise<resendConfirmationEmailResponse>",
965
+ "parameters": [
966
+ {
967
+ "name": "customerEmail",
968
+ "type": "string",
969
+ "optional": false
970
+ }
971
+ ],
972
+ "returnType": "Promise<resendConfirmationEmailResponse>",
973
+ "description": ""
974
+ },
975
+ {
976
+ "name": "createCustomerAddress",
977
+ "signature": "createCustomerAddress(address: AddressFormProps): Promise<string>",
978
+ "parameters": [
979
+ {
980
+ "name": "address",
981
+ "type": "AddressFormProps",
982
+ "optional": false
983
+ }
984
+ ],
985
+ "returnType": "Promise<string>",
986
+ "description": ""
987
+ },
988
+ {
989
+ "name": "verifyToken",
990
+ "signature": "verifyToken(authType?: unknown, type?: unknown): unknown",
991
+ "parameters": [
992
+ {
993
+ "name": "authType",
994
+ "type": "unknown",
995
+ "optional": true
996
+ },
997
+ {
998
+ "name": "type",
999
+ "type": "unknown",
1000
+ "optional": true
1001
+ }
1002
+ ],
1003
+ "returnType": "unknown",
1004
+ "description": ""
1005
+ },
1006
+ {
1007
+ "name": "getCustomerRolePermissions",
1008
+ "signature": "getCustomerRolePermissions(): Promise<PermissionsModel>",
1009
+ "parameters": [],
1010
+ "returnType": "Promise<PermissionsModel>",
1011
+ "description": "Gets user role permissions with caching"
1012
+ },
1013
+ {
1014
+ "name": "_resetCache",
1015
+ "signature": "_resetCache(): void",
1016
+ "parameters": [],
1017
+ "returnType": "void",
1018
+ "description": "Resets the permissions cache"
1019
+ },
1020
+ {
1021
+ "name": "getAdobeCommerceOptimizerData",
1022
+ "signature": "getAdobeCommerceOptimizerData(): Promise<AdobeCommerceOptimizerModel>",
1023
+ "parameters": [],
1024
+ "returnType": "Promise<AdobeCommerceOptimizerModel>",
1025
+ "description": "Fetches Adobe Commerce Optimizer data from GraphQL API\nThis function works for both authenticated and non-authenticated users"
1026
+ }
1027
+ ]
1028
+ },
1029
+ "storefront-account": {
1030
+ "version": "3.3.0",
1031
+ "importPath": "@dropins/storefront-account/api.js",
1032
+ "functions": [
1033
+ {
1034
+ "name": "getAttributesForm",
1035
+ "signature": "getAttributesForm(formCode: string): Promise<AttributesFormModel[]>",
1036
+ "parameters": [
1037
+ {
1038
+ "name": "formCode",
1039
+ "type": "string",
1040
+ "optional": false
1041
+ }
1042
+ ],
1043
+ "returnType": "Promise<AttributesFormModel[]>",
1044
+ "description": ""
1045
+ },
1046
+ {
1047
+ "name": "createCustomerAddress",
1048
+ "signature": "createCustomerAddress(address: CustomerAddressesModel): Promise<CreateCustomerAddressResult>",
1049
+ "parameters": [
1050
+ {
1051
+ "name": "address",
1052
+ "type": "CustomerAddressesModel",
1053
+ "optional": false
1054
+ }
1055
+ ],
1056
+ "returnType": "Promise<CreateCustomerAddressResult>",
1057
+ "description": ""
1058
+ },
1059
+ {
1060
+ "name": "getCustomerAddress",
1061
+ "signature": "getCustomerAddress(): Promise<\n CustomerAddressesModel[]\n>",
1062
+ "parameters": [],
1063
+ "returnType": "Promise<\n CustomerAddressesModel[]\n>",
1064
+ "description": ""
1065
+ },
1066
+ {
1067
+ "name": "getCountries",
1068
+ "signature": "getCountries(): Promise<{\n availableCountries: Country[] | [];\n countriesWithRequiredRegion: string[];\n optionalZipCountries: string[];\n}>",
1069
+ "parameters": [],
1070
+ "returnType": "Promise<{\n availableCountries: Country[] | [];\n countriesWithRequiredRegion: string[];\n optionalZipCountries: string[];\n}>",
1071
+ "description": ""
1072
+ },
1073
+ {
1074
+ "name": "getRegions",
1075
+ "signature": "getRegions(countryCode: string): Promise<RegionTransform[] | []>",
1076
+ "parameters": [
1077
+ {
1078
+ "name": "countryCode",
1079
+ "type": "string",
1080
+ "optional": false
1081
+ }
1082
+ ],
1083
+ "returnType": "Promise<RegionTransform[] | []>",
1084
+ "description": ""
1085
+ },
1086
+ {
1087
+ "name": "updateCustomerAddress",
1088
+ "signature": "updateCustomerAddress(forms: ExtendedAddressFormProps): Promise<string>",
1089
+ "parameters": [
1090
+ {
1091
+ "name": "forms",
1092
+ "type": "ExtendedAddressFormProps",
1093
+ "optional": false
1094
+ }
1095
+ ],
1096
+ "returnType": "Promise<string>",
1097
+ "description": ""
1098
+ },
1099
+ {
1100
+ "name": "getCustomer",
1101
+ "signature": "getCustomer(): Promise<CustomerDataModelShort>",
1102
+ "parameters": [],
1103
+ "returnType": "Promise<CustomerDataModelShort>",
1104
+ "description": ""
1105
+ },
1106
+ {
1107
+ "name": "removeCustomerAddress",
1108
+ "signature": "removeCustomerAddress(addressId: number): Promise<boolean>",
1109
+ "parameters": [
1110
+ {
1111
+ "name": "addressId",
1112
+ "type": "number",
1113
+ "optional": false
1114
+ }
1115
+ ],
1116
+ "returnType": "Promise<boolean>",
1117
+ "description": ""
1118
+ },
1119
+ {
1120
+ "name": "getCustomerPaymentTokens",
1121
+ "signature": "getCustomerPaymentTokens(filterPaymentMethodCodes?: string[]): Promise<StoredPaymentMethodDisplay[]>",
1122
+ "parameters": [
1123
+ {
1124
+ "name": "filterPaymentMethodCodes",
1125
+ "type": "string[]",
1126
+ "optional": true
1127
+ }
1128
+ ],
1129
+ "returnType": "Promise<StoredPaymentMethodDisplay[]>",
1130
+ "description": ""
1131
+ },
1132
+ {
1133
+ "name": "deletePaymentToken",
1134
+ "signature": "deletePaymentToken(publicHash: string): Promise<boolean>",
1135
+ "parameters": [
1136
+ {
1137
+ "name": "publicHash",
1138
+ "type": "string",
1139
+ "optional": false
1140
+ }
1141
+ ],
1142
+ "returnType": "Promise<boolean>",
1143
+ "description": ""
1144
+ },
1145
+ {
1146
+ "name": "getOrderHistoryList",
1147
+ "signature": "getOrderHistoryList(pageSize: number, selectOrdersDate: string, currentPage: number): Promise<OrderHistoryModel | null>",
1148
+ "parameters": [
1149
+ {
1150
+ "name": "pageSize",
1151
+ "type": "number",
1152
+ "optional": false
1153
+ },
1154
+ {
1155
+ "name": "selectOrdersDate",
1156
+ "type": "string",
1157
+ "optional": false
1158
+ },
1159
+ {
1160
+ "name": "currentPage",
1161
+ "type": "number",
1162
+ "optional": false
1163
+ }
1164
+ ],
1165
+ "returnType": "Promise<OrderHistoryModel | null>",
1166
+ "description": ""
1167
+ },
1168
+ {
1169
+ "name": "updateCustomerPassword",
1170
+ "signature": "updateCustomerPassword({\n currentPassword,\n newPassword,\n}: ChangeCustomerPasswordProps): Promise<string>",
1171
+ "parameters": [
1172
+ {
1173
+ "name": "{\n currentPassword,\n newPassword,\n}",
1174
+ "type": "ChangeCustomerPasswordProps",
1175
+ "optional": false
1176
+ }
1177
+ ],
1178
+ "returnType": "Promise<string>",
1179
+ "description": ""
1180
+ },
1181
+ {
1182
+ "name": "getStoreConfig",
1183
+ "signature": "getStoreConfig(): Promise<StoreConfigModel>",
1184
+ "parameters": [],
1185
+ "returnType": "Promise<StoreConfigModel>",
1186
+ "description": ""
1187
+ },
1188
+ {
1189
+ "name": "updateCustomerEmail",
1190
+ "signature": "updateCustomerEmail({\n email,\n password,\n}: {\n email: string;\n password: string;\n}): Promise<string>",
1191
+ "parameters": [
1192
+ {
1193
+ "name": "{\n email,\n password,\n}",
1194
+ "type": "{\n email: string;\n password: string;\n}",
1195
+ "optional": false
1196
+ }
1197
+ ],
1198
+ "returnType": "Promise<string>",
1199
+ "description": ""
1200
+ },
1201
+ {
1202
+ "name": "updateCustomer",
1203
+ "signature": "updateCustomer(form: Record<string, string>): Promise<string>",
1204
+ "parameters": [
1205
+ {
1206
+ "name": "form",
1207
+ "type": "Record<string, string>",
1208
+ "optional": false
1209
+ }
1210
+ ],
1211
+ "returnType": "Promise<string>",
1212
+ "description": ""
1213
+ }
1214
+ ]
1215
+ },
1216
+ "storefront-pdp": {
1217
+ "version": "3.1.0",
1218
+ "importPath": "@dropins/storefront-pdp/api.js",
1219
+ "functions": [
1220
+ {
1221
+ "name": "getProductData",
1222
+ "signature": "getProductData(sku: string, options?: {\n preselectFirstOption?: boolean;\n optionsUIDs?: string[];\n }, raw?: boolean): Promise<ProductModel | null>",
1223
+ "parameters": [
1224
+ {
1225
+ "name": "sku",
1226
+ "type": "string",
1227
+ "optional": false
1228
+ },
1229
+ {
1230
+ "name": "options",
1231
+ "type": "{\n preselectFirstOption?: boolean;\n optionsUIDs?: string[];\n }",
1232
+ "optional": true
1233
+ },
1234
+ {
1235
+ "name": "raw",
1236
+ "type": "boolean",
1237
+ "optional": true
1238
+ }
1239
+ ],
1240
+ "returnType": "Promise<ProductModel | null>",
1241
+ "description": ""
1242
+ },
1243
+ {
1244
+ "name": "getProductsData",
1245
+ "signature": "getProductsData(items: ProductDataItem[], raw?: boolean): Promise<ProductModel[] | null>",
1246
+ "parameters": [
1247
+ {
1248
+ "name": "items",
1249
+ "type": "ProductDataItem[]",
1250
+ "optional": false
1251
+ },
1252
+ {
1253
+ "name": "raw",
1254
+ "type": "boolean",
1255
+ "optional": true
1256
+ }
1257
+ ],
1258
+ "returnType": "Promise<ProductModel[] | null>",
1259
+ "description": "Fetches multiple products by SKUs with optional per-product configuration."
1260
+ },
1261
+ {
1262
+ "name": "getRefinedProduct",
1263
+ "signature": "getRefinedProduct(sku: string, optionUIDs: string[], anchorOptions?: string[], raw?: boolean): Promise<ProductModel | null>",
1264
+ "parameters": [
1265
+ {
1266
+ "name": "sku",
1267
+ "type": "string",
1268
+ "optional": false
1269
+ },
1270
+ {
1271
+ "name": "optionUIDs",
1272
+ "type": "string[]",
1273
+ "optional": false
1274
+ },
1275
+ {
1276
+ "name": "anchorOptions",
1277
+ "type": "string[]",
1278
+ "optional": true
1279
+ },
1280
+ {
1281
+ "name": "raw",
1282
+ "type": "boolean",
1283
+ "optional": true
1284
+ }
1285
+ ],
1286
+ "returnType": "Promise<ProductModel | null>",
1287
+ "description": ""
1288
+ },
1289
+ {
1290
+ "name": "fetchProductData",
1291
+ "signature": "fetchProductData(sku: string, options?: Options): unknown",
1292
+ "parameters": [
1293
+ {
1294
+ "name": "sku",
1295
+ "type": "string",
1296
+ "optional": false
1297
+ },
1298
+ {
1299
+ "name": "options",
1300
+ "type": "Options",
1301
+ "optional": true
1302
+ }
1303
+ ],
1304
+ "returnType": "unknown",
1305
+ "description": ""
1306
+ },
1307
+ {
1308
+ "name": "setProductConfigurationValues",
1309
+ "signature": "setProductConfigurationValues(callback: (prev: ValuesModel) => ValuesModel, options?: { scope?: string }): unknown",
1310
+ "parameters": [
1311
+ {
1312
+ "name": "callback",
1313
+ "type": "(prev: ValuesModel) => ValuesModel",
1314
+ "optional": false
1315
+ },
1316
+ {
1317
+ "name": "options",
1318
+ "type": "{ scope?: string }",
1319
+ "optional": true
1320
+ }
1321
+ ],
1322
+ "returnType": "unknown",
1323
+ "description": ""
1324
+ },
1325
+ {
1326
+ "name": "getProductConfigurationValues",
1327
+ "signature": "getProductConfigurationValues({\n scope,\n}?: { scope?: string }): ValuesModel | null",
1328
+ "parameters": [
1329
+ {
1330
+ "name": "{\n scope,\n}",
1331
+ "type": "{ scope?: string }",
1332
+ "optional": true
1333
+ }
1334
+ ],
1335
+ "returnType": "ValuesModel | null",
1336
+ "description": ""
1337
+ },
1338
+ {
1339
+ "name": "setProductConfigurationValid",
1340
+ "signature": "setProductConfigurationValid(callback: (prev: boolean) => boolean, options?: { scope?: string }): unknown",
1341
+ "parameters": [
1342
+ {
1343
+ "name": "callback",
1344
+ "type": "(prev: boolean) => boolean",
1345
+ "optional": false
1346
+ },
1347
+ {
1348
+ "name": "options",
1349
+ "type": "{ scope?: string }",
1350
+ "optional": true
1351
+ }
1352
+ ],
1353
+ "returnType": "unknown",
1354
+ "description": ""
1355
+ },
1356
+ {
1357
+ "name": "getFetchedProductData",
1358
+ "signature": "getFetchedProductData({\n scope,\n}?: { scope?: string }): Promise<ProductModel | null>",
1359
+ "parameters": [
1360
+ {
1361
+ "name": "{\n scope,\n}",
1362
+ "type": "{ scope?: string }",
1363
+ "optional": true
1364
+ }
1365
+ ],
1366
+ "returnType": "Promise<ProductModel | null>",
1367
+ "description": ""
1368
+ },
1369
+ {
1370
+ "name": "isProductConfigurationValid",
1371
+ "signature": "isProductConfigurationValid({\n scope,\n}?: { scope?: string }): boolean | null",
1372
+ "parameters": [
1373
+ {
1374
+ "name": "{\n scope,\n}",
1375
+ "type": "{ scope?: string }",
1376
+ "optional": true
1377
+ }
1378
+ ],
1379
+ "returnType": "boolean | null",
1380
+ "description": ""
1381
+ }
1382
+ ]
1383
+ },
1384
+ "storefront-quote-management": {
1385
+ "version": "1.1.2",
1386
+ "importPath": "@dropins/storefront-quote-management/api.js",
1387
+ "functions": [
1388
+ {
1389
+ "name": "requestNegotiableQuote",
1390
+ "signature": "requestNegotiableQuote(input: RequestNegotiableQuoteInput): Promise<NegotiableQuoteModel | null>",
1391
+ "parameters": [
1392
+ {
1393
+ "name": "input",
1394
+ "type": "RequestNegotiableQuoteInput",
1395
+ "optional": false
1396
+ }
1397
+ ],
1398
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1399
+ "description": ""
1400
+ },
1401
+ {
1402
+ "name": "getQuoteData",
1403
+ "signature": "getQuoteData(quoteId: string): unknown",
1404
+ "parameters": [
1405
+ {
1406
+ "name": "quoteId",
1407
+ "type": "string",
1408
+ "optional": false
1409
+ }
1410
+ ],
1411
+ "returnType": "unknown",
1412
+ "description": ""
1413
+ },
1414
+ {
1415
+ "name": "negotiableQuotes",
1416
+ "signature": "negotiableQuotes(params?: NegotiableQuotesParams): Promise<NegotiableQuotesListModel>",
1417
+ "parameters": [
1418
+ {
1419
+ "name": "params",
1420
+ "type": "NegotiableQuotesParams",
1421
+ "optional": true
1422
+ }
1423
+ ],
1424
+ "returnType": "Promise<NegotiableQuotesListModel>",
1425
+ "description": ""
1426
+ },
1427
+ {
1428
+ "name": "getStoreConfig",
1429
+ "signature": "getStoreConfig(): Promise<StoreConfigModel>",
1430
+ "parameters": [],
1431
+ "returnType": "Promise<StoreConfigModel>",
1432
+ "description": ""
1433
+ },
1434
+ {
1435
+ "name": "deleteQuote",
1436
+ "signature": "deleteQuote(quoteUids: string[] | string): Promise<DeleteQuoteOutput>",
1437
+ "parameters": [
1438
+ {
1439
+ "name": "quoteUids",
1440
+ "type": "string[] | string",
1441
+ "optional": false
1442
+ }
1443
+ ],
1444
+ "returnType": "Promise<DeleteQuoteOutput>",
1445
+ "description": ""
1446
+ },
1447
+ {
1448
+ "name": "setShippingAddress",
1449
+ "signature": "setShippingAddress(input: SetShippingAddressInput): Promise<NegotiableQuoteModel | null>",
1450
+ "parameters": [
1451
+ {
1452
+ "name": "input",
1453
+ "type": "SetShippingAddressInput",
1454
+ "optional": false
1455
+ }
1456
+ ],
1457
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1458
+ "description": "Sets or updates the shipping address for a negotiable quote."
1459
+ },
1460
+ {
1461
+ "name": "sendForReview",
1462
+ "signature": "sendForReview(input: SendForReviewInput): Promise<NegotiableQuoteModel | null>",
1463
+ "parameters": [
1464
+ {
1465
+ "name": "input",
1466
+ "type": "SendForReviewInput",
1467
+ "optional": false
1468
+ }
1469
+ ],
1470
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1471
+ "description": ""
1472
+ },
1473
+ {
1474
+ "name": "uploadFile",
1475
+ "signature": "uploadFile(file: File): Promise<{ key: string }>",
1476
+ "parameters": [
1477
+ {
1478
+ "name": "file",
1479
+ "type": "File",
1480
+ "optional": false
1481
+ }
1482
+ ],
1483
+ "returnType": "Promise<{ key: string }>",
1484
+ "description": ""
1485
+ },
1486
+ {
1487
+ "name": "closeNegotiableQuote",
1488
+ "signature": "closeNegotiableQuote(input: CloseNegotiableQuoteInput): Promise<CloseNegotiableQuoteResult>",
1489
+ "parameters": [
1490
+ {
1491
+ "name": "input",
1492
+ "type": "CloseNegotiableQuoteInput",
1493
+ "optional": false
1494
+ }
1495
+ ],
1496
+ "returnType": "Promise<CloseNegotiableQuoteResult>",
1497
+ "description": ""
1498
+ },
1499
+ {
1500
+ "name": "getQuoteTemplateData",
1501
+ "signature": "getQuoteTemplateData(templateId: string): Promise<NegotiableQuoteTemplateModel | null>",
1502
+ "parameters": [
1503
+ {
1504
+ "name": "templateId",
1505
+ "type": "string",
1506
+ "optional": false
1507
+ }
1508
+ ],
1509
+ "returnType": "Promise<NegotiableQuoteTemplateModel | null>",
1510
+ "description": ""
1511
+ },
1512
+ {
1513
+ "name": "createQuoteTemplate",
1514
+ "signature": "createQuoteTemplate(quoteId: string): Promise<NegotiableQuoteTemplateModel | null>",
1515
+ "parameters": [
1516
+ {
1517
+ "name": "quoteId",
1518
+ "type": "string",
1519
+ "optional": false
1520
+ }
1521
+ ],
1522
+ "returnType": "Promise<NegotiableQuoteTemplateModel | null>",
1523
+ "description": ""
1524
+ },
1525
+ {
1526
+ "name": "getQuoteTemplates",
1527
+ "signature": "getQuoteTemplates(params?: GetQuoteTemplatesParams): Promise<NegotiableQuoteTemplatesListModel>",
1528
+ "parameters": [
1529
+ {
1530
+ "name": "params",
1531
+ "type": "GetQuoteTemplatesParams",
1532
+ "optional": true
1533
+ }
1534
+ ],
1535
+ "returnType": "Promise<NegotiableQuoteTemplatesListModel>",
1536
+ "description": ""
1537
+ },
1538
+ {
1539
+ "name": "sendQuoteTemplateForReview",
1540
+ "signature": "sendQuoteTemplateForReview(params: SendQuoteTemplateForReviewParams): unknown",
1541
+ "parameters": [
1542
+ {
1543
+ "name": "params",
1544
+ "type": "SendQuoteTemplateForReviewParams",
1545
+ "optional": false
1546
+ }
1547
+ ],
1548
+ "returnType": "unknown",
1549
+ "description": ""
1550
+ },
1551
+ {
1552
+ "name": "setQuoteTemplateExpirationDate",
1553
+ "signature": "setQuoteTemplateExpirationDate(params: SetQuoteTemplateExpirationDateParams): Promise<NegotiableQuoteTemplateModel | null>",
1554
+ "parameters": [
1555
+ {
1556
+ "name": "params",
1557
+ "type": "SetQuoteTemplateExpirationDateParams",
1558
+ "optional": false
1559
+ }
1560
+ ],
1561
+ "returnType": "Promise<NegotiableQuoteTemplateModel | null>",
1562
+ "description": ""
1563
+ },
1564
+ {
1565
+ "name": "acceptQuoteTemplate",
1566
+ "signature": "acceptQuoteTemplate(params: AcceptQuoteTemplateParams): unknown",
1567
+ "parameters": [
1568
+ {
1569
+ "name": "params",
1570
+ "type": "AcceptQuoteTemplateParams",
1571
+ "optional": false
1572
+ }
1573
+ ],
1574
+ "returnType": "unknown",
1575
+ "description": ""
1576
+ },
1577
+ {
1578
+ "name": "cancelQuoteTemplate",
1579
+ "signature": "cancelQuoteTemplate(params: CancelQuoteTemplateParams): unknown",
1580
+ "parameters": [
1581
+ {
1582
+ "name": "params",
1583
+ "type": "CancelQuoteTemplateParams",
1584
+ "optional": false
1585
+ }
1586
+ ],
1587
+ "returnType": "unknown",
1588
+ "description": ""
1589
+ },
1590
+ {
1591
+ "name": "deleteQuoteTemplate",
1592
+ "signature": "deleteQuoteTemplate(params: DeleteQuoteTemplateParams): unknown",
1593
+ "parameters": [
1594
+ {
1595
+ "name": "params",
1596
+ "type": "DeleteQuoteTemplateParams",
1597
+ "optional": false
1598
+ }
1599
+ ],
1600
+ "returnType": "unknown",
1601
+ "description": ""
1602
+ },
1603
+ {
1604
+ "name": "openQuoteTemplate",
1605
+ "signature": "openQuoteTemplate(params: OpenQuoteTemplateParams): unknown",
1606
+ "parameters": [
1607
+ {
1608
+ "name": "params",
1609
+ "type": "OpenQuoteTemplateParams",
1610
+ "optional": false
1611
+ }
1612
+ ],
1613
+ "returnType": "unknown",
1614
+ "description": ""
1615
+ },
1616
+ {
1617
+ "name": "addQuoteTemplateShippingAddress",
1618
+ "signature": "addQuoteTemplateShippingAddress(params: AddQuoteTemplateShippingAddressParams): unknown",
1619
+ "parameters": [
1620
+ {
1621
+ "name": "params",
1622
+ "type": "AddQuoteTemplateShippingAddressParams",
1623
+ "optional": false
1624
+ }
1625
+ ],
1626
+ "returnType": "unknown",
1627
+ "description": ""
1628
+ },
1629
+ {
1630
+ "name": "updateQuoteTemplateItemQuantities",
1631
+ "signature": "updateQuoteTemplateItemQuantities(params: UpdateQuoteTemplateItemQuantitiesParams): unknown",
1632
+ "parameters": [
1633
+ {
1634
+ "name": "params",
1635
+ "type": "UpdateQuoteTemplateItemQuantitiesParams",
1636
+ "optional": false
1637
+ }
1638
+ ],
1639
+ "returnType": "unknown",
1640
+ "description": ""
1641
+ },
1642
+ {
1643
+ "name": "removeQuoteTemplateItems",
1644
+ "signature": "removeQuoteTemplateItems(params: RemoveQuoteTemplateItemsParams): unknown",
1645
+ "parameters": [
1646
+ {
1647
+ "name": "params",
1648
+ "type": "RemoveQuoteTemplateItemsParams",
1649
+ "optional": false
1650
+ }
1651
+ ],
1652
+ "returnType": "unknown",
1653
+ "description": ""
1654
+ },
1655
+ {
1656
+ "name": "addQuoteTemplateLineItemNote",
1657
+ "signature": "addQuoteTemplateLineItemNote(params: AddQuoteTemplateLineItemNoteParams): unknown",
1658
+ "parameters": [
1659
+ {
1660
+ "name": "params",
1661
+ "type": "AddQuoteTemplateLineItemNoteParams",
1662
+ "optional": false
1663
+ }
1664
+ ],
1665
+ "returnType": "unknown",
1666
+ "description": ""
1667
+ },
1668
+ {
1669
+ "name": "generateQuoteFromTemplate",
1670
+ "signature": "generateQuoteFromTemplate(params: GenerateQuoteFromTemplateParams): unknown",
1671
+ "parameters": [
1672
+ {
1673
+ "name": "params",
1674
+ "type": "GenerateQuoteFromTemplateParams",
1675
+ "optional": false
1676
+ }
1677
+ ],
1678
+ "returnType": "unknown",
1679
+ "description": ""
1680
+ },
1681
+ {
1682
+ "name": "renameNegotiableQuote",
1683
+ "signature": "renameNegotiableQuote(input: RenameNegotiableQuoteInput): Promise<NegotiableQuoteModel | null>",
1684
+ "parameters": [
1685
+ {
1686
+ "name": "input",
1687
+ "type": "RenameNegotiableQuoteInput",
1688
+ "optional": false
1689
+ }
1690
+ ],
1691
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1692
+ "description": ""
1693
+ },
1694
+ {
1695
+ "name": "duplicateQuote",
1696
+ "signature": "duplicateQuote(input: DuplicateQuoteInput): Promise<NegotiableQuoteModel | null>",
1697
+ "parameters": [
1698
+ {
1699
+ "name": "input",
1700
+ "type": "DuplicateQuoteInput",
1701
+ "optional": false
1702
+ }
1703
+ ],
1704
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1705
+ "description": ""
1706
+ },
1707
+ {
1708
+ "name": "updateQuantities",
1709
+ "signature": "updateQuantities(input: UpdateQuantitiesInput): Promise<NegotiableQuoteModel | null>",
1710
+ "parameters": [
1711
+ {
1712
+ "name": "input",
1713
+ "type": "UpdateQuantitiesInput",
1714
+ "optional": false
1715
+ }
1716
+ ],
1717
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1718
+ "description": "Updates the quantities of items in a negotiable quote."
1719
+ },
1720
+ {
1721
+ "name": "removeNegotiableQuoteItems",
1722
+ "signature": "removeNegotiableQuoteItems(input: RemoveNegotiableQuoteItemsInput): Promise<NegotiableQuoteModel | null>",
1723
+ "parameters": [
1724
+ {
1725
+ "name": "input",
1726
+ "type": "RemoveNegotiableQuoteItemsInput",
1727
+ "optional": false
1728
+ }
1729
+ ],
1730
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1731
+ "description": ""
1732
+ },
1733
+ {
1734
+ "name": "setLineItemNote",
1735
+ "signature": "setLineItemNote(input: SetLineItemNoteInput): Promise<NegotiableQuoteModel | null>",
1736
+ "parameters": [
1737
+ {
1738
+ "name": "input",
1739
+ "type": "SetLineItemNoteInput",
1740
+ "optional": false
1741
+ }
1742
+ ],
1743
+ "returnType": "Promise<NegotiableQuoteModel | null>",
1744
+ "description": ""
1745
+ }
1746
+ ]
1747
+ },
1748
+ "storefront-requisition-list": {
1749
+ "version": "1.3.0",
1750
+ "importPath": "@dropins/storefront-requisition-list/api.js",
1751
+ "functions": [
1752
+ {
1753
+ "name": "getStoreConfig",
1754
+ "signature": "getStoreConfig(): Promise<any>",
1755
+ "parameters": [],
1756
+ "returnType": "Promise<any>",
1757
+ "description": ""
1758
+ },
1759
+ {
1760
+ "name": "getRequisitionLists",
1761
+ "signature": "getRequisitionLists(currentPage?: number, pageSize?: number, listItemsPageSize?: number): Promise<RequisitionList[] | null>",
1762
+ "parameters": [
1763
+ {
1764
+ "name": "currentPage",
1765
+ "type": "number",
1766
+ "optional": true
1767
+ },
1768
+ {
1769
+ "name": "pageSize",
1770
+ "type": "number",
1771
+ "optional": true
1772
+ },
1773
+ {
1774
+ "name": "listItemsPageSize",
1775
+ "type": "number",
1776
+ "optional": true
1777
+ }
1778
+ ],
1779
+ "returnType": "Promise<RequisitionList[] | null>",
1780
+ "description": ""
1781
+ },
1782
+ {
1783
+ "name": "getRequisitionList",
1784
+ "signature": "getRequisitionList(requisitionListID: string, currentPage?: number, pageSize?: number, enrichConfigurableProducts?: (items: Item[]) => Promise<Item[]>): Promise<RequisitionList | null>",
1785
+ "parameters": [
1786
+ {
1787
+ "name": "requisitionListID",
1788
+ "type": "string",
1789
+ "optional": false
1790
+ },
1791
+ {
1792
+ "name": "currentPage",
1793
+ "type": "number",
1794
+ "optional": true
1795
+ },
1796
+ {
1797
+ "name": "pageSize",
1798
+ "type": "number",
1799
+ "optional": true
1800
+ },
1801
+ {
1802
+ "name": "enrichConfigurableProducts",
1803
+ "type": "(items: Item[]) => Promise<Item[]>",
1804
+ "optional": true
1805
+ }
1806
+ ],
1807
+ "returnType": "Promise<RequisitionList | null>",
1808
+ "description": ""
1809
+ },
1810
+ {
1811
+ "name": "createRequisitionList",
1812
+ "signature": "createRequisitionList(name: string, description?: string): Promise<RequisitionList | null>",
1813
+ "parameters": [
1814
+ {
1815
+ "name": "name",
1816
+ "type": "string",
1817
+ "optional": false
1818
+ },
1819
+ {
1820
+ "name": "description",
1821
+ "type": "string",
1822
+ "optional": true
1823
+ }
1824
+ ],
1825
+ "returnType": "Promise<RequisitionList | null>",
1826
+ "description": ""
1827
+ },
1828
+ {
1829
+ "name": "updateRequisitionList",
1830
+ "signature": "updateRequisitionList(requisitionListUid: string, name: string, description?: string, pageSize?: number, currentPage?: number, enrichConfigurableProducts?: (items: Item[]) => Promise<Item[]>): Promise<RequisitionList | null>",
1831
+ "parameters": [
1832
+ {
1833
+ "name": "requisitionListUid",
1834
+ "type": "string",
1835
+ "optional": false
1836
+ },
1837
+ {
1838
+ "name": "name",
1839
+ "type": "string",
1840
+ "optional": false
1841
+ },
1842
+ {
1843
+ "name": "description",
1844
+ "type": "string",
1845
+ "optional": true
1846
+ },
1847
+ {
1848
+ "name": "pageSize",
1849
+ "type": "number",
1850
+ "optional": true
1851
+ },
1852
+ {
1853
+ "name": "currentPage",
1854
+ "type": "number",
1855
+ "optional": true
1856
+ },
1857
+ {
1858
+ "name": "enrichConfigurableProducts",
1859
+ "type": "(items: Item[]) => Promise<Item[]>",
1860
+ "optional": true
1861
+ }
1862
+ ],
1863
+ "returnType": "Promise<RequisitionList | null>",
1864
+ "description": ""
1865
+ },
1866
+ {
1867
+ "name": "deleteRequisitionList",
1868
+ "signature": "deleteRequisitionList(requisitionListUid: string): Promise<{\n items: RequisitionList[];\n page_info: any;\n status: any;\n} | null>",
1869
+ "parameters": [
1870
+ {
1871
+ "name": "requisitionListUid",
1872
+ "type": "string",
1873
+ "optional": false
1874
+ }
1875
+ ],
1876
+ "returnType": "Promise<{\n items: RequisitionList[];\n page_info: any;\n status: any;\n} | null>",
1877
+ "description": ""
1878
+ },
1879
+ {
1880
+ "name": "updateRequisitionListItems",
1881
+ "signature": "updateRequisitionListItems(requisitionListUid: string, requisitionListItems: Array<UpdateRequisitionListItemsInput>, pageSize: number, currentPage: number, enrichConfigurableProducts?: (items: Item[]) => Promise<Item[]>): Promise<RequisitionList | null>",
1882
+ "parameters": [
1883
+ {
1884
+ "name": "requisitionListUid",
1885
+ "type": "string",
1886
+ "optional": false
1887
+ },
1888
+ {
1889
+ "name": "requisitionListItems",
1890
+ "type": "Array<UpdateRequisitionListItemsInput>",
1891
+ "optional": false
1892
+ },
1893
+ {
1894
+ "name": "pageSize",
1895
+ "type": "number",
1896
+ "optional": false
1897
+ },
1898
+ {
1899
+ "name": "currentPage",
1900
+ "type": "number",
1901
+ "optional": false
1902
+ },
1903
+ {
1904
+ "name": "enrichConfigurableProducts",
1905
+ "type": "(items: Item[]) => Promise<Item[]>",
1906
+ "optional": true
1907
+ }
1908
+ ],
1909
+ "returnType": "Promise<RequisitionList | null>",
1910
+ "description": ""
1911
+ },
1912
+ {
1913
+ "name": "deleteRequisitionListItems",
1914
+ "signature": "deleteRequisitionListItems(requisitionListUid: string, items: Array<string>, pageSize: number, currentPage: number, enrichConfigurableProducts?: (items: Item[]) => Promise<Item[]>): Promise<RequisitionList | null>",
1915
+ "parameters": [
1916
+ {
1917
+ "name": "requisitionListUid",
1918
+ "type": "string",
1919
+ "optional": false
1920
+ },
1921
+ {
1922
+ "name": "items",
1923
+ "type": "Array<string>",
1924
+ "optional": false
1925
+ },
1926
+ {
1927
+ "name": "pageSize",
1928
+ "type": "number",
1929
+ "optional": false
1930
+ },
1931
+ {
1932
+ "name": "currentPage",
1933
+ "type": "number",
1934
+ "optional": false
1935
+ },
1936
+ {
1937
+ "name": "enrichConfigurableProducts",
1938
+ "type": "(items: Item[]) => Promise<Item[]>",
1939
+ "optional": true
1940
+ }
1941
+ ],
1942
+ "returnType": "Promise<RequisitionList | null>",
1943
+ "description": ""
1944
+ },
1945
+ {
1946
+ "name": "addProductsToRequisitionList",
1947
+ "signature": "addProductsToRequisitionList(requisitionListUid: string, requisitionListItems: Array<RequisitionListItemsInput>): Promise<RequisitionList | null>",
1948
+ "parameters": [
1949
+ {
1950
+ "name": "requisitionListUid",
1951
+ "type": "string",
1952
+ "optional": false
1953
+ },
1954
+ {
1955
+ "name": "requisitionListItems",
1956
+ "type": "Array<RequisitionListItemsInput>",
1957
+ "optional": false
1958
+ }
1959
+ ],
1960
+ "returnType": "Promise<RequisitionList | null>",
1961
+ "description": ""
1962
+ },
1963
+ {
1964
+ "name": "addRequisitionListItemsToCart",
1965
+ "signature": "addRequisitionListItemsToCart(requisitionListUid: string, requisitionListItemUids: Array<string>): Promise<Array<AddToCartError> | null>",
1966
+ "parameters": [
1967
+ {
1968
+ "name": "requisitionListUid",
1969
+ "type": "string",
1970
+ "optional": false
1971
+ },
1972
+ {
1973
+ "name": "requisitionListItemUids",
1974
+ "type": "Array<string>",
1975
+ "optional": false
1976
+ }
1977
+ ],
1978
+ "returnType": "Promise<Array<AddToCartError> | null>",
1979
+ "description": ""
1980
+ },
1981
+ {
1982
+ "name": "moveItemsBetweenRequisitionLists",
1983
+ "signature": "moveItemsBetweenRequisitionLists(sourceRequisitionListUid: string, destinationRequisitionListUid: string, requisitionListItemUids: string[], pageSize: number, currentPage: number): Promise<MoveItemsResult | null>",
1984
+ "parameters": [
1985
+ {
1986
+ "name": "sourceRequisitionListUid",
1987
+ "type": "string",
1988
+ "optional": false
1989
+ },
1990
+ {
1991
+ "name": "destinationRequisitionListUid",
1992
+ "type": "string",
1993
+ "optional": false
1994
+ },
1995
+ {
1996
+ "name": "requisitionListItemUids",
1997
+ "type": "string[]",
1998
+ "optional": false
1999
+ },
2000
+ {
2001
+ "name": "pageSize",
2002
+ "type": "number",
2003
+ "optional": false
2004
+ },
2005
+ {
2006
+ "name": "currentPage",
2007
+ "type": "number",
2008
+ "optional": false
2009
+ }
2010
+ ],
2011
+ "returnType": "Promise<MoveItemsResult | null>",
2012
+ "description": ""
2013
+ },
2014
+ {
2015
+ "name": "copyItemsBetweenRequisitionLists",
2016
+ "signature": "copyItemsBetweenRequisitionLists(sourceRequisitionListUid: string, destinationRequisitionListUid: string, requisitionListItemUids: string[]): Promise<CopyItemsResult | null>",
2017
+ "parameters": [
2018
+ {
2019
+ "name": "sourceRequisitionListUid",
2020
+ "type": "string",
2021
+ "optional": false
2022
+ },
2023
+ {
2024
+ "name": "destinationRequisitionListUid",
2025
+ "type": "string",
2026
+ "optional": false
2027
+ },
2028
+ {
2029
+ "name": "requisitionListItemUids",
2030
+ "type": "string[]",
2031
+ "optional": false
2032
+ }
2033
+ ],
2034
+ "returnType": "Promise<CopyItemsResult | null>",
2035
+ "description": ""
2036
+ }
2037
+ ]
2038
+ },
2039
+ "storefront-wishlist": {
2040
+ "version": "3.2.0",
2041
+ "importPath": "@dropins/storefront-wishlist/api.js",
2042
+ "functions": [
2043
+ {
2044
+ "name": "getStoreConfig",
2045
+ "signature": "getStoreConfig(): Promise<StoreConfigModel | null>",
2046
+ "parameters": [],
2047
+ "returnType": "Promise<StoreConfigModel | null>",
2048
+ "description": ""
2049
+ },
2050
+ {
2051
+ "name": "setPersistedWishlistData",
2052
+ "signature": "setPersistedWishlistData(data: Wishlist | null): unknown",
2053
+ "parameters": [
2054
+ {
2055
+ "name": "data",
2056
+ "type": "Wishlist | null",
2057
+ "optional": false
2058
+ }
2059
+ ],
2060
+ "returnType": "unknown",
2061
+ "description": ""
2062
+ },
2063
+ {
2064
+ "name": "getPersistedWishlistData",
2065
+ "signature": "getPersistedWishlistData(guest?: boolean): Wishlist | {}",
2066
+ "parameters": [
2067
+ {
2068
+ "name": "guest",
2069
+ "type": "boolean",
2070
+ "optional": true
2071
+ }
2072
+ ],
2073
+ "returnType": "Wishlist | {}",
2074
+ "description": ""
2075
+ },
2076
+ {
2077
+ "name": "clearPersistedLocalStorage",
2078
+ "signature": "clearPersistedLocalStorage(): unknown",
2079
+ "parameters": [],
2080
+ "returnType": "unknown",
2081
+ "description": ""
2082
+ },
2083
+ {
2084
+ "name": "getWishlistItemFromStorage",
2085
+ "signature": "getWishlistItemFromStorage(productSku: string, optionUIDs?: string[]): unknown",
2086
+ "parameters": [
2087
+ {
2088
+ "name": "productSku",
2089
+ "type": "string",
2090
+ "optional": false
2091
+ },
2092
+ {
2093
+ "name": "optionUIDs",
2094
+ "type": "string[]",
2095
+ "optional": true
2096
+ }
2097
+ ],
2098
+ "returnType": "unknown",
2099
+ "description": ""
2100
+ },
2101
+ {
2102
+ "name": "getWishlistById",
2103
+ "signature": "getWishlistById(wishlistId: string): Promise<void | Wishlist | null>",
2104
+ "parameters": [
2105
+ {
2106
+ "name": "wishlistId",
2107
+ "type": "string",
2108
+ "optional": false
2109
+ }
2110
+ ],
2111
+ "returnType": "Promise<void | Wishlist | null>",
2112
+ "description": ""
2113
+ },
2114
+ {
2115
+ "name": "getWishlists",
2116
+ "signature": "getWishlists(): Promise<void | Wishlist[] | null>",
2117
+ "parameters": [],
2118
+ "returnType": "Promise<void | Wishlist[] | null>",
2119
+ "description": ""
2120
+ },
2121
+ {
2122
+ "name": "addProductsToWishlist",
2123
+ "signature": "addProductsToWishlist(items: [\n {\n sku: string;\n quantity: number;\n optionsUIDs?: string[]; // should be the options available for the product\n enteredOptions?: { uid: string; value: string }[]; // refer to both selected and entered options\n }\n ]): Promise<Wishlist | null>",
2124
+ "parameters": [
2125
+ {
2126
+ "name": "items",
2127
+ "type": "[\n {\n sku: string;\n quantity: number;\n optionsUIDs?: string[]; // should be the options available for the product\n enteredOptions?: { uid: string; value: string }[]; // refer to both selected and entered options\n }\n ]",
2128
+ "optional": false
2129
+ }
2130
+ ],
2131
+ "returnType": "Promise<Wishlist | null>",
2132
+ "description": ""
2133
+ },
2134
+ {
2135
+ "name": "removeProductsFromWishlist",
2136
+ "signature": "removeProductsFromWishlist(items: Array<Item>): Promise<Wishlist | null>",
2137
+ "parameters": [
2138
+ {
2139
+ "name": "items",
2140
+ "type": "Array<Item>",
2141
+ "optional": false
2142
+ }
2143
+ ],
2144
+ "returnType": "Promise<Wishlist | null>",
2145
+ "description": ""
2146
+ },
2147
+ {
2148
+ "name": "updateProductsInWishlist",
2149
+ "signature": "updateProductsInWishlist(items: {\n wishlistItemId: string;\n quantity: number;\n description: string;\n selectedOptions?: string[];\n enteredOptions?: { uid: string; value: string }[];\n }[]): Promise<Wishlist | null>",
2150
+ "parameters": [
2151
+ {
2152
+ "name": "items",
2153
+ "type": "{\n wishlistItemId: string;\n quantity: number;\n description: string;\n selectedOptions?: string[];\n enteredOptions?: { uid: string; value: string }[];\n }[]",
2154
+ "optional": false
2155
+ }
2156
+ ],
2157
+ "returnType": "Promise<Wishlist | null>",
2158
+ "description": ""
2159
+ },
2160
+ {
2161
+ "name": "resetWishlist",
2162
+ "signature": "resetWishlist(): Promise<Wishlist | null>",
2163
+ "parameters": [],
2164
+ "returnType": "Promise<Wishlist | null>",
2165
+ "description": ""
2166
+ },
2167
+ {
2168
+ "name": "initializeWishlist",
2169
+ "signature": "initializeWishlist(): Promise<Wishlist | null>",
2170
+ "parameters": [],
2171
+ "returnType": "Promise<Wishlist | null>",
2172
+ "description": ""
2173
+ },
2174
+ {
2175
+ "name": "getDefaultWishlist",
2176
+ "signature": "getDefaultWishlist(): unknown",
2177
+ "parameters": [],
2178
+ "returnType": "unknown",
2179
+ "description": ""
2180
+ },
2181
+ {
2182
+ "name": "getGuestWishlist",
2183
+ "signature": "getGuestWishlist(): unknown",
2184
+ "parameters": [],
2185
+ "returnType": "unknown",
2186
+ "description": ""
2187
+ },
2188
+ {
2189
+ "name": "mergeWishlists",
2190
+ "signature": "mergeWishlists(wishlist: Wishlist): Promise<Wishlist | null>",
2191
+ "parameters": [
2192
+ {
2193
+ "name": "wishlist",
2194
+ "type": "Wishlist",
2195
+ "optional": false
2196
+ }
2197
+ ],
2198
+ "returnType": "Promise<Wishlist | null>",
2199
+ "description": ""
2200
+ }
2201
+ ]
2202
+ },
2203
+ "storefront-recommendations": {
2204
+ "version": "4.0.0",
2205
+ "importPath": "@dropins/storefront-recommendations/api.js",
2206
+ "functions": [
2207
+ {
2208
+ "name": "publishRecsItemAddToCartClick",
2209
+ "signature": "publishRecsItemAddToCartClick(params: PublishParams): unknown",
2210
+ "parameters": [
2211
+ {
2212
+ "name": "params",
2213
+ "type": "PublishParams",
2214
+ "optional": false
2215
+ }
2216
+ ],
2217
+ "returnType": "unknown",
2218
+ "description": "Publish a recs-item-add-to-cart-click event to the Adobe Client Data Layer (ACDL)\n\nSee: https://experienceleague.adobe.com/en/docs/commerce/product-recommendations/developer/events#events"
2219
+ },
2220
+ {
2221
+ "name": "getRecommendationsByUnitIds",
2222
+ "signature": "getRecommendationsByUnitIds(params: GetRecommendationsByUnitIdsProps): Promise<RecommendationUnitModel[] | null>",
2223
+ "parameters": [
2224
+ {
2225
+ "name": "params",
2226
+ "type": "GetRecommendationsByUnitIdsProps",
2227
+ "optional": false
2228
+ }
2229
+ ],
2230
+ "returnType": "Promise<RecommendationUnitModel[] | null>",
2231
+ "description": ""
2232
+ }
2233
+ ]
2234
+ },
2235
+ "storefront-payment-services": {
2236
+ "version": "3.0.1",
2237
+ "importPath": "@dropins/storefront-payment-services/api.js",
2238
+ "functions": [
2239
+ {
2240
+ "name": "PaymentMethodCode",
2241
+ "signature": "PaymentMethodCode(...args): unknown",
2242
+ "parameters": [],
2243
+ "returnType": "unknown",
2244
+ "description": ""
2245
+ },
2246
+ {
2247
+ "name": "PaymentLocation",
2248
+ "signature": "PaymentLocation(...args): unknown",
2249
+ "parameters": [],
2250
+ "returnType": "unknown",
2251
+ "description": ""
2252
+ }
2253
+ ]
2254
+ },
2255
+ "storefront-company-management": {
2256
+ "version": "1.2.0",
2257
+ "importPath": "@dropins/storefront-company-management/api.js",
2258
+ "functions": [
2259
+ {
2260
+ "name": "fetchUserPermissions",
2261
+ "signature": "fetchUserPermissions(): Promise<FetchUserPermissionsResult>",
2262
+ "parameters": [],
2263
+ "returnType": "Promise<FetchUserPermissionsResult>",
2264
+ "description": "Fetches user permissions and returns both the allowed permission IDs and the role response\nThis is a general-purpose API function that can be used across the application"
2265
+ },
2266
+ {
2267
+ "name": "acceptCompanyInvitation",
2268
+ "signature": "acceptCompanyInvitation(input: AcceptCompanyInvitationInput): Promise<AcceptCompanyInvitationResult | null>",
2269
+ "parameters": [
2270
+ {
2271
+ "name": "input",
2272
+ "type": "AcceptCompanyInvitationInput",
2273
+ "optional": false
2274
+ }
2275
+ ],
2276
+ "returnType": "Promise<AcceptCompanyInvitationResult | null>",
2277
+ "description": "Accepts a company invitation using the invitation code and user information"
2278
+ },
2279
+ {
2280
+ "name": "allowCompanyRegistration",
2281
+ "signature": "allowCompanyRegistration(): Promise<boolean>",
2282
+ "parameters": [],
2283
+ "returnType": "Promise<boolean>",
2284
+ "description": ""
2285
+ },
2286
+ {
2287
+ "name": "checkCompanyCreditEnabled",
2288
+ "signature": "checkCompanyCreditEnabled(): Promise<CheckCompanyCreditEnabledResponse>",
2289
+ "parameters": [],
2290
+ "returnType": "Promise<CheckCompanyCreditEnabledResponse>",
2291
+ "description": ""
2292
+ },
2293
+ {
2294
+ "name": "companyEnabled",
2295
+ "signature": "companyEnabled(): Promise<boolean>",
2296
+ "parameters": [],
2297
+ "returnType": "Promise<boolean>",
2298
+ "description": ""
2299
+ },
2300
+ {
2301
+ "name": "createCompany",
2302
+ "signature": "createCompany(formData: any): Promise<{ success: boolean; company?: CompanyRegistrationModel; errors?: string[] }>",
2303
+ "parameters": [
2304
+ {
2305
+ "name": "formData",
2306
+ "type": "any",
2307
+ "optional": false
2308
+ }
2309
+ ],
2310
+ "returnType": "Promise<{ success: boolean; company?: CompanyRegistrationModel; errors?: string[] }>",
2311
+ "description": "Registers a new B2B company with complete business information.\n\nThis function handles the entire company registration workflow including:\n- Company details validation (name, email, legal name, tax IDs)\n- Legal address validation with country/region support\n- Company administrator account creation\n- Email uniqueness validation"
2312
+ },
2313
+ {
2314
+ "name": "createCompanyTeam",
2315
+ "signature": "createCompanyTeam(input: CreateCompanyTeamInput): Promise<CreateCompanyTeamResult | null>",
2316
+ "parameters": [
2317
+ {
2318
+ "name": "input",
2319
+ "type": "CreateCompanyTeamInput",
2320
+ "optional": false
2321
+ }
2322
+ ],
2323
+ "returnType": "Promise<CreateCompanyTeamResult | null>",
2324
+ "description": "Creates a new company team with the provided information"
2325
+ },
2326
+ {
2327
+ "name": "createCompanyUser",
2328
+ "signature": "createCompanyUser(input: CreateCompanyUserInput): Promise<CreateCompanyUserResult | null>",
2329
+ "parameters": [
2330
+ {
2331
+ "name": "input",
2332
+ "type": "CreateCompanyUserInput",
2333
+ "optional": false
2334
+ }
2335
+ ],
2336
+ "returnType": "Promise<CreateCompanyUserResult | null>",
2337
+ "description": "Creates a new company user with the provided information"
2338
+ },
2339
+ {
2340
+ "name": "deleteCompanyTeam",
2341
+ "signature": "deleteCompanyTeam(id: string): Promise<boolean>",
2342
+ "parameters": [
2343
+ {
2344
+ "name": "id",
2345
+ "type": "string",
2346
+ "optional": false
2347
+ }
2348
+ ],
2349
+ "returnType": "Promise<boolean>",
2350
+ "description": "Deletes a company team by their ID"
2351
+ },
2352
+ {
2353
+ "name": "deleteCompanyUser",
2354
+ "signature": "deleteCompanyUser(params: DeleteCompanyUserParams): Promise<DeleteCompanyUserResponse>",
2355
+ "parameters": [
2356
+ {
2357
+ "name": "params",
2358
+ "type": "DeleteCompanyUserParams",
2359
+ "optional": false
2360
+ }
2361
+ ],
2362
+ "returnType": "Promise<DeleteCompanyUserResponse>",
2363
+ "description": "Deletes a company user by their ID"
2364
+ },
2365
+ {
2366
+ "name": "getCompany",
2367
+ "signature": "getCompany(): Promise<CompanyModel | null>",
2368
+ "parameters": [],
2369
+ "returnType": "Promise<CompanyModel | null>",
2370
+ "description": "Retrieves company information with permissions-aware field selection\nOnly returns fields that the current user has permission to view"
2371
+ },
2372
+ {
2373
+ "name": "getCompanyCredit",
2374
+ "signature": "getCompanyCredit(): Promise<CompanyCreditInfo | null>",
2375
+ "parameters": [],
2376
+ "returnType": "Promise<CompanyCreditInfo | null>",
2377
+ "description": ""
2378
+ },
2379
+ {
2380
+ "name": "getCompanyCreditHistory",
2381
+ "signature": "getCompanyCreditHistory(params?: GetCompanyCreditHistoryParams): Promise<CompanyCreditHistory | null>",
2382
+ "parameters": [
2383
+ {
2384
+ "name": "params",
2385
+ "type": "GetCompanyCreditHistoryParams",
2386
+ "optional": true
2387
+ }
2388
+ ],
2389
+ "returnType": "Promise<CompanyCreditHistory | null>",
2390
+ "description": "Retrieves paginated company credit transaction history.\n\nReturns credit operations including allocations, purchases, refunds, and manual\nadjustments with transaction details, amounts, and running balance."
2391
+ },
2392
+ {
2393
+ "name": "getCompanyStructure",
2394
+ "signature": "getCompanyStructure(): Promise<CompanyStructureNode[]>",
2395
+ "parameters": [],
2396
+ "returnType": "Promise<CompanyStructureNode[]>",
2397
+ "description": "Retrieves the company organizational structure as a tree of nodes"
2398
+ },
2399
+ {
2400
+ "name": "getCompanyTeam",
2401
+ "signature": "getCompanyTeam(id: string): Promise<CompanyTeamModel | null>",
2402
+ "parameters": [
2403
+ {
2404
+ "name": "id",
2405
+ "type": "string",
2406
+ "optional": false
2407
+ }
2408
+ ],
2409
+ "returnType": "Promise<CompanyTeamModel | null>",
2410
+ "description": "Retrieves a specific company team by their ID"
2411
+ },
2412
+ {
2413
+ "name": "getCompanyUser",
2414
+ "signature": "getCompanyUser(id: string): Promise<CompanyUserModel | null>",
2415
+ "parameters": [
2416
+ {
2417
+ "name": "id",
2418
+ "type": "string",
2419
+ "optional": false
2420
+ }
2421
+ ],
2422
+ "returnType": "Promise<CompanyUserModel | null>",
2423
+ "description": "Retrieves a specific company user by their ID"
2424
+ },
2425
+ {
2426
+ "name": "getCompanyUsers",
2427
+ "signature": "getCompanyUsers(params?: CompanyUsersParams): Promise<CompanyUsersResponse>",
2428
+ "parameters": [
2429
+ {
2430
+ "name": "params",
2431
+ "type": "CompanyUsersParams",
2432
+ "optional": true
2433
+ }
2434
+ ],
2435
+ "returnType": "Promise<CompanyUsersResponse>",
2436
+ "description": "Fetches the list of company users with pagination and optional filtering"
2437
+ },
2438
+ {
2439
+ "name": "getCountries",
2440
+ "signature": "getCountries(): Promise<{\n availableCountries: Country[] | [];\n countriesWithRequiredRegion: string[];\n optionalZipCountries: string[];\n}>",
2441
+ "parameters": [],
2442
+ "returnType": "Promise<{\n availableCountries: Country[] | [];\n countriesWithRequiredRegion: string[];\n optionalZipCountries: string[];\n}>",
2443
+ "description": ""
2444
+ },
2445
+ {
2446
+ "name": "getCustomerCompany",
2447
+ "signature": "getCustomerCompany(): Promise<CustomerCompanyInfo | null>",
2448
+ "parameters": [],
2449
+ "returnType": "Promise<CustomerCompanyInfo | null>",
2450
+ "description": "Gets customer company information for display on account information page\nThis is a simplified API that only returns the essential company info needed\nfor the customer account page, without requiring full company permissions"
2451
+ },
2452
+ {
2453
+ "name": "getStoreConfig",
2454
+ "signature": "getStoreConfig(): Promise<StoreConfigModel>",
2455
+ "parameters": [],
2456
+ "returnType": "Promise<StoreConfigModel>",
2457
+ "description": "Retrieves store configuration settings for company forms.\n\nReturns store-specific defaults used to pre-populate country/region\nselectors in company registration and profile forms."
2458
+ },
2459
+ {
2460
+ "name": "isCompanyAdmin",
2461
+ "signature": "isCompanyAdmin(): Promise<boolean>",
2462
+ "parameters": [],
2463
+ "returnType": "Promise<boolean>",
2464
+ "description": "Check if the current authenticated customer is a company administrator in any company"
2465
+ },
2466
+ {
2467
+ "name": "isCompanyUser",
2468
+ "signature": "isCompanyUser(): Promise<boolean>",
2469
+ "parameters": [],
2470
+ "returnType": "Promise<boolean>",
2471
+ "description": "Check if the current authenticated customer belongs to any company"
2472
+ },
2473
+ {
2474
+ "name": "isCompanyUserEmailAvailable",
2475
+ "signature": "isCompanyUserEmailAvailable(email: string): Promise<boolean | null>",
2476
+ "parameters": [
2477
+ {
2478
+ "name": "email",
2479
+ "type": "string",
2480
+ "optional": false
2481
+ }
2482
+ ],
2483
+ "returnType": "Promise<boolean | null>",
2484
+ "description": "Checks if an email address is available for use by a new company user"
2485
+ },
2486
+ {
2487
+ "name": "updateCompany",
2488
+ "signature": "updateCompany(input: UpdateCompanyDto): Promise<CompanyModel>",
2489
+ "parameters": [
2490
+ {
2491
+ "name": "input",
2492
+ "type": "UpdateCompanyDto",
2493
+ "optional": false
2494
+ }
2495
+ ],
2496
+ "returnType": "Promise<CompanyModel>",
2497
+ "description": "Updates company profile information with permission-aware field filtering.\n\nThis function dynamically builds the GraphQL mutation based on user permissions:\n- Only requests fields the user can view in the response\n- Only sends fields the user can edit in the mutation\n\n**Permissions Required:**\n- `Magento_Company::edit_account` - To update name, email, legal name, VAT/Tax ID, Reseller ID\n- `Magento_Company::edit_address` - To update legal address fields\n\n**Important:** The dropin UI gates which fields are editable. If neither permission\nis granted, the submit button is disabled and this function should not be called."
2498
+ },
2499
+ {
2500
+ "name": "updateCompanyStructure",
2501
+ "signature": "updateCompanyStructure(input: UpdateCompanyStructureInput): Promise<boolean>",
2502
+ "parameters": [
2503
+ {
2504
+ "name": "input",
2505
+ "type": "UpdateCompanyStructureInput",
2506
+ "optional": false
2507
+ }
2508
+ ],
2509
+ "returnType": "Promise<boolean>",
2510
+ "description": "Updates the company structure by moving a node to a new parent"
2511
+ },
2512
+ {
2513
+ "name": "updateCompanyTeam",
2514
+ "signature": "updateCompanyTeam(input: UpdateCompanyTeamInput): Promise<boolean>",
2515
+ "parameters": [
2516
+ {
2517
+ "name": "input",
2518
+ "type": "UpdateCompanyTeamInput",
2519
+ "optional": false
2520
+ }
2521
+ ],
2522
+ "returnType": "Promise<boolean>",
2523
+ "description": "Updates an existing company team with the provided information"
2524
+ },
2525
+ {
2526
+ "name": "updateCompanyUser",
2527
+ "signature": "updateCompanyUser(input: UpdateCompanyUserInput): Promise<boolean>",
2528
+ "parameters": [
2529
+ {
2530
+ "name": "input",
2531
+ "type": "UpdateCompanyUserInput",
2532
+ "optional": false
2533
+ }
2534
+ ],
2535
+ "returnType": "Promise<boolean>",
2536
+ "description": "Updates an existing company user with the provided information"
2537
+ },
2538
+ {
2539
+ "name": "updateCompanyUserStatus",
2540
+ "signature": "updateCompanyUserStatus(params: UpdateCompanyUserStatusParams): Promise<UpdateCompanyUserStatusResponse>",
2541
+ "parameters": [
2542
+ {
2543
+ "name": "params",
2544
+ "type": "UpdateCompanyUserStatusParams",
2545
+ "optional": false
2546
+ }
2547
+ ],
2548
+ "returnType": "Promise<UpdateCompanyUserStatusResponse>",
2549
+ "description": "Updates a company user's status (Active/Inactive)"
2550
+ },
2551
+ {
2552
+ "name": "validateCompanyEmail",
2553
+ "signature": "validateCompanyEmail(email: string): Promise<ValidateCompanyEmailResponse>",
2554
+ "parameters": [
2555
+ {
2556
+ "name": "email",
2557
+ "type": "string",
2558
+ "optional": false
2559
+ }
2560
+ ],
2561
+ "returnType": "Promise<ValidateCompanyEmailResponse>",
2562
+ "description": ""
2563
+ },
2564
+ {
2565
+ "name": "getCompanyRoles",
2566
+ "signature": "getCompanyRoles(variables?: GetCompanyRolesVariables): Promise<CompanyRolesResponseModel>",
2567
+ "parameters": [
2568
+ {
2569
+ "name": "variables",
2570
+ "type": "GetCompanyRolesVariables",
2571
+ "optional": true
2572
+ }
2573
+ ],
2574
+ "returnType": "Promise<CompanyRolesResponseModel>",
2575
+ "description": "Retrieves a paginated list of all company roles with basic information.\n\nReturns roles with their names, assigned user counts, and IDs. Supports\nserver-side pagination and filtering by role name.\n\n**Permissions Required:**\n- `Magento_Company::roles_view` - User must have permission to view company roles"
2576
+ },
2577
+ {
2578
+ "name": "getCompanyRole",
2579
+ "signature": "getCompanyRole(variables: GetCompanyRoleVariables): Promise<CompanyRoleModel>",
2580
+ "parameters": [
2581
+ {
2582
+ "name": "variables",
2583
+ "type": "GetCompanyRoleVariables",
2584
+ "optional": false
2585
+ }
2586
+ ],
2587
+ "returnType": "Promise<CompanyRoleModel>",
2588
+ "description": "Retrieves complete details for a specific company role by ID.\n\nReturns role name, assigned user count, and the complete permission tree\nstructure with this role's granted permissions. Used when editing an\nexisting role or viewing role details.\n\n**Permissions Required:**\n- `Magento_Company::roles_view` (minimum) - To view role details\n- `Magento_Company::roles_edit` - To modify the role (additional permission)"
2589
+ },
2590
+ {
2591
+ "name": "getCompanyAclResources",
2592
+ "signature": "getCompanyAclResources(): Promise<CompanyAclResourceModel[]>",
2593
+ "parameters": [],
2594
+ "returnType": "Promise<CompanyAclResourceModel[]>",
2595
+ "description": "Retrieves the complete hierarchical tree of ACL (Access Control List) resources.\n\nReturns all permission categories and individual permissions available for\ncompany role assignment. The structure is hierarchical, with parent permissions\ncontaining child permissions.\n\nUsed by the Roles & Permissions UI to display the permission tree with\ncheckboxes for role creation and editing."
2596
+ },
2597
+ {
2598
+ "name": "createCompanyRole",
2599
+ "signature": "createCompanyRole(input: CompanyRoleCreateInputModel): Promise<CompanyRoleModel>",
2600
+ "parameters": [
2601
+ {
2602
+ "name": "input",
2603
+ "type": "CompanyRoleCreateInputModel",
2604
+ "optional": false
2605
+ }
2606
+ ],
2607
+ "returnType": "Promise<CompanyRoleModel>",
2608
+ "description": "Creates a new company role with specified name and permissions.\n\nThe role name must be unique within the company. Use `isCompanyRoleNameAvailable`\nto validate name uniqueness before calling this function.\n\n**Permissions Required:**\n- `Magento_Company::roles_edit` - User must have role management permission"
2609
+ },
2610
+ {
2611
+ "name": "updateCompanyRole",
2612
+ "signature": "updateCompanyRole(input: CompanyRoleUpdateInputModel): Promise<CompanyRoleModel>",
2613
+ "parameters": [
2614
+ {
2615
+ "name": "input",
2616
+ "type": "CompanyRoleUpdateInputModel",
2617
+ "optional": false
2618
+ }
2619
+ ],
2620
+ "returnType": "Promise<CompanyRoleModel>",
2621
+ "description": "Updates an existing company role's name and/or permissions.\n\nThe role name must be unique within the company (excluding the current role).\nUse `isCompanyRoleNameAvailable` to validate name uniqueness if changing the name.\n\n**Permissions Required:**\n- `Magento_Company::roles_edit` - User must have role management permission"
2622
+ },
2623
+ {
2624
+ "name": "deleteCompanyRole",
2625
+ "signature": "deleteCompanyRole(variables: DeleteCompanyRoleVariables): Promise<boolean>",
2626
+ "parameters": [
2627
+ {
2628
+ "name": "variables",
2629
+ "type": "DeleteCompanyRoleVariables",
2630
+ "optional": false
2631
+ }
2632
+ ],
2633
+ "returnType": "Promise<boolean>",
2634
+ "description": "Permanently deletes a company role.\n\n⚠️ **IMPORTANT RESTRICTIONS:**\n- Cannot delete roles with assigned users - reassign users first\n- Cannot delete default system roles (e.g., \"Default User\")\n- This operation cannot be undone\n- Role configuration and permission settings are permanently lost\n\n**Permissions Required:**\n- `Magento_Company::roles_edit` - User must have role management permission"
2635
+ },
2636
+ {
2637
+ "name": "isCompanyRoleNameAvailable",
2638
+ "signature": "isCompanyRoleNameAvailable(variables: IsCompanyRoleNameAvailableVariables): Promise<boolean>",
2639
+ "parameters": [
2640
+ {
2641
+ "name": "variables",
2642
+ "type": "IsCompanyRoleNameAvailableVariables",
2643
+ "optional": false
2644
+ }
2645
+ ],
2646
+ "returnType": "Promise<boolean>",
2647
+ "description": "Validates whether a role name is available for use (not already taken).\n\nUsed for real-time validation during role creation and editing to prevent\nduplicate role names within a company. Role names are case-sensitive.\n\n**Note:** Role names must be unique within a company. Different companies\ncan have roles with the same name."
2648
+ },
2649
+ {
2650
+ "name": "flattenPermissionIds",
2651
+ "signature": "flattenPermissionIds(resources: CompanyAclResourceModel[]): string[]",
2652
+ "parameters": [
2653
+ {
2654
+ "name": "resources",
2655
+ "type": "CompanyAclResourceModel[]",
2656
+ "optional": false
2657
+ }
2658
+ ],
2659
+ "returnType": "string[]",
2660
+ "description": "Helper function to flatten ACL resources into a list of permission IDs"
2661
+ },
2662
+ {
2663
+ "name": "buildPermissionTree",
2664
+ "signature": "buildPermissionTree(allResources: CompanyAclResourceModel[], selectedIds: string[]): CompanyAclResourceModel[]",
2665
+ "parameters": [
2666
+ {
2667
+ "name": "allResources",
2668
+ "type": "CompanyAclResourceModel[]",
2669
+ "optional": false
2670
+ },
2671
+ {
2672
+ "name": "selectedIds",
2673
+ "type": "string[]",
2674
+ "optional": false
2675
+ }
2676
+ ],
2677
+ "returnType": "CompanyAclResourceModel[]",
2678
+ "description": "Helper function to build a permission tree from flat permission IDs"
2679
+ }
2680
+ ]
2681
+ },
2682
+ "storefront-company-switcher": {
2683
+ "version": "1.1.1",
2684
+ "importPath": "@dropins/storefront-company-switcher/api.js",
2685
+ "functions": [
2686
+ {
2687
+ "name": "getCustomerCompanyInfo",
2688
+ "signature": "getCustomerCompanyInfo(): Promise<CustomerCompanyInfo>",
2689
+ "parameters": [],
2690
+ "returnType": "Promise<CustomerCompanyInfo>",
2691
+ "description": ""
2692
+ },
2693
+ {
2694
+ "name": "updateCustomerGroup",
2695
+ "signature": "updateCustomerGroup(): Promise<string | null>",
2696
+ "parameters": [],
2697
+ "returnType": "Promise<string | null>",
2698
+ "description": ""
2699
+ },
2700
+ {
2701
+ "name": "getCompanyHeaderManager",
2702
+ "signature": "getCompanyHeaderManager(): unknown",
2703
+ "parameters": [],
2704
+ "returnType": "unknown",
2705
+ "description": "Gets the singleton instance of CompanyHeaderManager"
2706
+ },
2707
+ {
2708
+ "name": "getGroupHeaderManager",
2709
+ "signature": "getGroupHeaderManager(): unknown",
2710
+ "parameters": [],
2711
+ "returnType": "unknown",
2712
+ "description": "Gets the singleton instance of GroupHeaderManager"
2713
+ }
2714
+ ]
2715
+ },
2716
+ "storefront-purchase-order": {
2717
+ "version": "1.1.1",
2718
+ "importPath": "@dropins/storefront-purchase-order/api.js",
2719
+ "functions": [
2720
+ {
2721
+ "name": "approvePurchaseOrders",
2722
+ "signature": "approvePurchaseOrders(uids: string | string[]): Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2723
+ "parameters": [
2724
+ {
2725
+ "name": "uids",
2726
+ "type": "string | string[]",
2727
+ "optional": false
2728
+ }
2729
+ ],
2730
+ "returnType": "Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2731
+ "description": ""
2732
+ },
2733
+ {
2734
+ "name": "cancelPurchaseOrders",
2735
+ "signature": "cancelPurchaseOrders(uids: string | string[]): Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2736
+ "parameters": [
2737
+ {
2738
+ "name": "uids",
2739
+ "type": "string | string[]",
2740
+ "optional": false
2741
+ }
2742
+ ],
2743
+ "returnType": "Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2744
+ "description": ""
2745
+ },
2746
+ {
2747
+ "name": "rejectPurchaseOrders",
2748
+ "signature": "rejectPurchaseOrders(uids: string | string[]): Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2749
+ "parameters": [
2750
+ {
2751
+ "name": "uids",
2752
+ "type": "string | string[]",
2753
+ "optional": false
2754
+ }
2755
+ ],
2756
+ "returnType": "Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2757
+ "description": ""
2758
+ },
2759
+ {
2760
+ "name": "validatePurchaseOrders",
2761
+ "signature": "validatePurchaseOrders(uids: string | string[]): Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2762
+ "parameters": [
2763
+ {
2764
+ "name": "uids",
2765
+ "type": "string | string[]",
2766
+ "optional": false
2767
+ }
2768
+ ],
2769
+ "returnType": "Promise<{\n errors: { message: string; type: string }[];\n purchaseOrders: PurchaseOrderModel[];\n}>",
2770
+ "description": ""
2771
+ },
2772
+ {
2773
+ "name": "addPurchaseOrderComment",
2774
+ "signature": "addPurchaseOrderComment(uid: string, comment: string): Promise<PurchaseOrderCommentModel>",
2775
+ "parameters": [
2776
+ {
2777
+ "name": "uid",
2778
+ "type": "string",
2779
+ "optional": false
2780
+ },
2781
+ {
2782
+ "name": "comment",
2783
+ "type": "string",
2784
+ "optional": false
2785
+ }
2786
+ ],
2787
+ "returnType": "Promise<PurchaseOrderCommentModel>",
2788
+ "description": ""
2789
+ },
2790
+ {
2791
+ "name": "addPurchaseOrderItemsToCart",
2792
+ "signature": "addPurchaseOrderItemsToCart(purchaseOrderUid: string, cartId: string, replaceExistingCartItems?: boolean): Promise<CartModel>",
2793
+ "parameters": [
2794
+ {
2795
+ "name": "purchaseOrderUid",
2796
+ "type": "string",
2797
+ "optional": false
2798
+ },
2799
+ {
2800
+ "name": "cartId",
2801
+ "type": "string",
2802
+ "optional": false
2803
+ },
2804
+ {
2805
+ "name": "replaceExistingCartItems",
2806
+ "type": "boolean",
2807
+ "optional": true
2808
+ }
2809
+ ],
2810
+ "returnType": "Promise<CartModel>",
2811
+ "description": ""
2812
+ },
2813
+ {
2814
+ "name": "createPurchaseOrderApprovalRule",
2815
+ "signature": "createPurchaseOrderApprovalRule(input: any): Promise<PurchaseOrderApprovalRuleModel>",
2816
+ "parameters": [
2817
+ {
2818
+ "name": "input",
2819
+ "type": "any",
2820
+ "optional": false
2821
+ }
2822
+ ],
2823
+ "returnType": "Promise<PurchaseOrderApprovalRuleModel>",
2824
+ "description": ""
2825
+ },
2826
+ {
2827
+ "name": "deletePurchaseOrderApprovalRule",
2828
+ "signature": "deletePurchaseOrderApprovalRule(uids: string | string[]): Promise<{\n deletePurchaseOrderApprovalRule: {\n errors: { message?: string; type?: string }[];\n };\n}>",
2829
+ "parameters": [
2830
+ {
2831
+ "name": "uids",
2832
+ "type": "string | string[]",
2833
+ "optional": false
2834
+ }
2835
+ ],
2836
+ "returnType": "Promise<{\n deletePurchaseOrderApprovalRule: {\n errors: { message?: string; type?: string }[];\n };\n}>",
2837
+ "description": ""
2838
+ },
2839
+ {
2840
+ "name": "updatePurchaseOrderApprovalRule",
2841
+ "signature": "updatePurchaseOrderApprovalRule(input: any): Promise<PurchaseOrderApprovalRuleModel>",
2842
+ "parameters": [
2843
+ {
2844
+ "name": "input",
2845
+ "type": "any",
2846
+ "optional": false
2847
+ }
2848
+ ],
2849
+ "returnType": "Promise<PurchaseOrderApprovalRuleModel>",
2850
+ "description": ""
2851
+ },
2852
+ {
2853
+ "name": "getPurchaseOrder",
2854
+ "signature": "getPurchaseOrder(uid: string): Promise<{\n purchaseOrder: PurchaseOrderModel;\n}>",
2855
+ "parameters": [
2856
+ {
2857
+ "name": "uid",
2858
+ "type": "string",
2859
+ "optional": false
2860
+ }
2861
+ ],
2862
+ "returnType": "Promise<{\n purchaseOrder: PurchaseOrderModel;\n}>",
2863
+ "description": ""
2864
+ },
2865
+ {
2866
+ "name": "getPurchaseOrders",
2867
+ "signature": "getPurchaseOrders(filter?: any, pageSize?: number, currentPage?: number): Promise<{\n totalCount: number;\n pageInfo: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n };\n purchaseOrderItems: PurchaseOrderModel[];\n}>",
2868
+ "parameters": [
2869
+ {
2870
+ "name": "filter",
2871
+ "type": "any",
2872
+ "optional": true
2873
+ },
2874
+ {
2875
+ "name": "pageSize",
2876
+ "type": "number",
2877
+ "optional": true
2878
+ },
2879
+ {
2880
+ "name": "currentPage",
2881
+ "type": "number",
2882
+ "optional": true
2883
+ }
2884
+ ],
2885
+ "returnType": "Promise<{\n totalCount: number;\n pageInfo: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n };\n purchaseOrderItems: PurchaseOrderModel[];\n}>",
2886
+ "description": ""
2887
+ },
2888
+ {
2889
+ "name": "placeOrderForPurchaseOrder",
2890
+ "signature": "placeOrderForPurchaseOrder(purchaseOrderUid: string): Promise<CustomerOrderModel>",
2891
+ "parameters": [
2892
+ {
2893
+ "name": "purchaseOrderUid",
2894
+ "type": "string",
2895
+ "optional": false
2896
+ }
2897
+ ],
2898
+ "returnType": "Promise<CustomerOrderModel>",
2899
+ "description": ""
2900
+ },
2901
+ {
2902
+ "name": "placePurchaseOrder",
2903
+ "signature": "placePurchaseOrder(cartId: string): Promise<{ purchaseOrder: PurchaseOrderModel }>",
2904
+ "parameters": [
2905
+ {
2906
+ "name": "cartId",
2907
+ "type": "string",
2908
+ "optional": false
2909
+ }
2910
+ ],
2911
+ "returnType": "Promise<{ purchaseOrder: PurchaseOrderModel }>",
2912
+ "description": ""
2913
+ },
2914
+ {
2915
+ "name": "getPurchaseOrderApprovalRuleMetadata",
2916
+ "signature": "getPurchaseOrderApprovalRuleMetadata(): Promise<PurchaseOrderApprovalRuleMetadataModel>",
2917
+ "parameters": [],
2918
+ "returnType": "Promise<PurchaseOrderApprovalRuleMetadataModel>",
2919
+ "description": ""
2920
+ },
2921
+ {
2922
+ "name": "currencyInfo",
2923
+ "signature": "currencyInfo(): Promise<{\n baseCurrencyCode: string;\n availableCurrencyCodes: { text: string; value: string }[];\n}>",
2924
+ "parameters": [],
2925
+ "returnType": "Promise<{\n baseCurrencyCode: string;\n availableCurrencyCodes: { text: string; value: string }[];\n}>",
2926
+ "description": ""
2927
+ },
2928
+ {
2929
+ "name": "getPurchaseOrderApprovalRule",
2930
+ "signature": "getPurchaseOrderApprovalRule(id: string): Promise<PurchaseOrderApprovalRuleModel>",
2931
+ "parameters": [
2932
+ {
2933
+ "name": "id",
2934
+ "type": "string",
2935
+ "optional": false
2936
+ }
2937
+ ],
2938
+ "returnType": "Promise<PurchaseOrderApprovalRuleModel>",
2939
+ "description": ""
2940
+ },
2941
+ {
2942
+ "name": "getPurchaseOrderApprovalRules",
2943
+ "signature": "getPurchaseOrderApprovalRules(currentPage?: number, pageSize?: number): Promise<{\n totalCount: number;\n pageInfo: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n };\n items: PurchaseOrderApprovalRuleModel[];\n}>",
2944
+ "parameters": [
2945
+ {
2946
+ "name": "currentPage",
2947
+ "type": "number",
2948
+ "optional": true
2949
+ },
2950
+ {
2951
+ "name": "pageSize",
2952
+ "type": "number",
2953
+ "optional": true
2954
+ }
2955
+ ],
2956
+ "returnType": "Promise<{\n totalCount: number;\n pageInfo: {\n currentPage: number;\n pageSize: number;\n totalPages: number;\n };\n items: PurchaseOrderApprovalRuleModel[];\n}>",
2957
+ "description": ""
2958
+ }
2959
+ ]
2960
+ },
2961
+ "storefront-quick-order": {
2962
+ "version": "1.0.0-beta.3",
2963
+ "importPath": "@dropins/storefront-quick-order/api.js",
2964
+ "functions": [
2965
+ {
2966
+ "name": "getStoreConfig",
2967
+ "signature": "getStoreConfig(): Promise<{\n storeConfig: {\n quickOrderActive: boolean;\n };\n}>",
2968
+ "parameters": [],
2969
+ "returnType": "Promise<{\n storeConfig: {\n quickOrderActive: boolean;\n };\n}>",
2970
+ "description": ""
2971
+ }
2972
+ ]
2973
+ },
2974
+ "storefront-product-discovery": {
2975
+ "version": "3.1.0",
2976
+ "importPath": "@dropins/storefront-product-discovery/api.js",
2977
+ "functions": [
2978
+ {
2979
+ "name": "search",
2980
+ "signature": "search(request: SearchVariables | null, options?: SearchOptions): Promise<ProductSearchResult>",
2981
+ "parameters": [
2982
+ {
2983
+ "name": "request",
2984
+ "type": "SearchVariables | null",
2985
+ "optional": false
2986
+ },
2987
+ {
2988
+ "name": "options",
2989
+ "type": "SearchOptions",
2990
+ "optional": true
2991
+ }
2992
+ ],
2993
+ "returnType": "Promise<ProductSearchResult>",
2994
+ "description": ""
2995
+ }
2996
+ ]
2997
+ },
2998
+ "storefront-personalization": {
2999
+ "version": "3.1.1",
3000
+ "importPath": "@dropins/storefront-personalization/api.js",
3001
+ "functions": [
3002
+ {
3003
+ "name": "getStoreConfig",
3004
+ "signature": "getStoreConfig(): Promise<StoreConfigModel | null>",
3005
+ "parameters": [],
3006
+ "returnType": "Promise<StoreConfigModel | null>",
3007
+ "description": ""
3008
+ },
3009
+ {
3010
+ "name": "fetchPersonalizationData",
3011
+ "signature": "fetchPersonalizationData(cartId: string): Promise<PersonalizationData | null>",
3012
+ "parameters": [
3013
+ {
3014
+ "name": "cartId",
3015
+ "type": "string",
3016
+ "optional": false
3017
+ }
3018
+ ],
3019
+ "returnType": "Promise<PersonalizationData | null>",
3020
+ "description": ""
3021
+ },
3022
+ {
3023
+ "name": "getPersonalizationData",
3024
+ "signature": "getPersonalizationData(): PersonalizationData",
3025
+ "parameters": [],
3026
+ "returnType": "PersonalizationData",
3027
+ "description": ""
3028
+ },
3029
+ {
3030
+ "name": "savePersonalizationData",
3031
+ "signature": "savePersonalizationData(data: PersonalizationData): Promise<void>",
3032
+ "parameters": [
3033
+ {
3034
+ "name": "data",
3035
+ "type": "PersonalizationData",
3036
+ "optional": false
3037
+ }
3038
+ ],
3039
+ "returnType": "Promise<void>",
3040
+ "description": ""
3041
+ }
3042
+ ]
3043
+ }
3044
+ }
3045
+ }