@beamimpact/web-sdk 1.42.0 → 1.42.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chunks/_share-dialog-dependencies-g3jQ8id8.esm.js +2 -0
- package/dist/chunks/_share-dialog-dependencies-g3jQ8id8.esm.js.map +1 -0
- package/dist/chunks/_share-dialog-dependencies-illEcadu.esm.js +2 -0
- package/dist/chunks/_share-dialog-dependencies-illEcadu.esm.js.map +1 -0
- package/dist/chunks/{cart-contents-sUhfwLAz.esm.d.ts → cart-contents-WB1BF6hG.esm.d.ts} +1 -1
- package/dist/chunks/{events-QJc86_5Y.esm.d.ts → events-MfRTtTVm.esm.d.ts} +1 -1
- package/dist/chunks/index-3sQuy5hc.esm.js +2 -0
- package/dist/chunks/index-3sQuy5hc.esm.js.map +1 -0
- package/dist/chunks/{index-M-0eAFA6.esm.d.ts → index-B9w02q6y.esm.d.ts} +1 -1
- package/dist/chunks/index-DMAoV_0a.esm.js +2 -0
- package/dist/chunks/index-DMAoV_0a.esm.js.map +1 -0
- package/dist/chunks/{index-_Hgu38MH.esm.d.ts → index-OaRsZJh7.esm.d.ts} +1 -1
- package/dist/chunks/{index-euJMrXIc.esm.d.ts → index-UggwPn9Q.esm.d.ts} +1 -1
- package/dist/chunks/index-ZkBd4ymi.esm.js +2 -0
- package/dist/chunks/index-ZkBd4ymi.esm.js.map +1 -0
- package/dist/chunks/index-i2CQiQI2.esm.js +2 -0
- package/dist/chunks/index-i2CQiQI2.esm.js.map +1 -0
- package/dist/chunks/{index-ZgCs6F4e.esm.d.ts → index-ozcDdIom.esm.d.ts} +4 -4
- package/dist/chunks/{index-AQ8n9ODJ.esm.js → index-q6z7dFlx.esm.js} +2 -2
- package/dist/chunks/{index-AQ8n9ODJ.esm.js.map → index-q6z7dFlx.esm.js.map} +1 -1
- package/dist/chunks/{index-cUb-0Igl.esm.js → index-sq8adzxn.esm.js} +2 -2
- package/dist/chunks/{index-cUb-0Igl.esm.js.map → index-sq8adzxn.esm.js.map} +1 -1
- package/dist/chunks/{index-VHXu2kRx.esm.d.ts → index-uqNCQVUx.esm.d.ts} +1 -1
- package/dist/chunks/index-x8t2PPR9.esm.js +2 -0
- package/dist/chunks/index-x8t2PPR9.esm.js.map +1 -0
- package/dist/chunks/index-xd5EFnau.esm.js +2 -0
- package/dist/chunks/index-xd5EFnau.esm.js.map +1 -0
- package/dist/chunks/{index-_UuYsIe9.esm.d.ts → index-yeW2w5bb.esm.d.ts} +1 -1
- package/dist/chunks/{openapi-spec--WoGcZgR.esm.d.ts → openapi-spec-GGEBbqAJ.esm.d.ts} +892 -27
- package/dist/chunks/order-page-HVySSia7.esm.js +2 -0
- package/dist/chunks/order-page-HVySSia7.esm.js.map +1 -0
- package/dist/chunks/{order-page-Ps8Qyjfg.esm.d.ts → order-page-LvE0Otsn.esm.d.ts} +3 -3
- package/dist/chunks/order-page-V0lMZwIk.esm.js +2 -0
- package/dist/chunks/order-page-V0lMZwIk.esm.js.map +1 -0
- package/dist/chunks/{routes-r5D_LdgT.esm.js → routes-8O1TW_Zi.esm.js} +2 -2
- package/dist/chunks/{routes-r5D_LdgT.esm.js.map → routes-8O1TW_Zi.esm.js.map} +1 -1
- package/dist/chunks/{routes-rmhOokKz.esm.js → routes-SVTSfe0m.esm.js} +2 -2
- package/dist/chunks/{routes-rmhOokKz.esm.js.map → routes-SVTSfe0m.esm.js.map} +1 -1
- package/dist/chunks/{routes-qbvie7oI.esm.d.ts → routes-wCCYf_uA.esm.d.ts} +31 -0
- package/dist/chunks/{share-button-JqbM7N_4.esm.js → share-button-MIfALwo7.esm.js} +2 -2
- package/dist/chunks/{share-button-JqbM7N_4.esm.js.map → share-button-MIfALwo7.esm.js.map} +1 -1
- package/dist/chunks/{share-button-jpa1X3FA.esm.js → share-button-SBb1jPC2.esm.js} +2 -2
- package/dist/chunks/{share-button-jpa1X3FA.esm.js.map → share-button-SBb1jPC2.esm.js.map} +1 -1
- package/dist/chunks/{shoelace-components-NR11kwmz.esm.js → shoelace-components-5jajO5Gh.esm.js} +2 -2
- package/dist/chunks/{shoelace-components-NR11kwmz.esm.js.map → shoelace-components-5jajO5Gh.esm.js.map} +1 -1
- package/dist/chunks/{shoelace-components-yXqj8DyM.esm.js → shoelace-components-fjdtu7FL.esm.js} +2 -2
- package/dist/chunks/{shoelace-components-yXqj8DyM.esm.js.map → shoelace-components-fjdtu7FL.esm.js.map} +1 -1
- package/dist/chunks/{update-cart-lTgKV-Zu.esm.js → update-cart-iH40XbBA.esm.js} +2 -2
- package/dist/chunks/{update-cart-lTgKV-Zu.esm.js.map → update-cart-iH40XbBA.esm.js.map} +1 -1
- package/dist/chunks/{update-cart-SajqAoez.esm.d.ts → update-cart-tjLR7pMx.esm.d.ts} +1 -1
- package/dist/chunks/{update-cart-05ZiT0Xf.esm.js → update-cart-x_iZyHUC.esm.js} +2 -2
- package/dist/chunks/{update-cart-05ZiT0Xf.esm.js.map → update-cart-x_iZyHUC.esm.js.map} +1 -1
- package/dist/components/community-impact.esm.js +1 -1
- package/dist/components/community-impact.js +1 -1
- package/dist/components/cumulative-impact.esm.js +1 -1
- package/dist/components/cumulative-impact.js +1 -1
- package/dist/components/impact-overview.d.ts +15 -0
- package/dist/components/impact-overview.esm.js +7 -7
- package/dist/components/impact-overview.esm.js.map +1 -1
- package/dist/components/impact-overview.js +7 -7
- package/dist/components/impact-overview.js.map +1 -1
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.esm.js +1 -1
- package/dist/components/index.js +1 -1
- package/dist/components/post-purchase.d.ts +10 -2
- package/dist/components/post-purchase.esm.js +2 -1
- package/dist/components/post-purchase.esm.js.map +1 -1
- package/dist/components/post-purchase.js +2 -1
- package/dist/components/post-purchase.js.map +1 -1
- package/dist/components/product-details-page.d.ts +3 -0
- package/dist/components/product-details-page.esm.js +1 -1
- package/dist/components/product-details-page.js +1 -1
- package/dist/components/redeem-transaction.d.ts +2 -2
- package/dist/components/redeem-transaction.esm.js +1 -1
- package/dist/components/redeem-transaction.js +1 -1
- package/dist/components/select-nonprofit.d.ts +2 -2
- package/dist/components/select-nonprofit.esm.js +33 -32
- package/dist/components/select-nonprofit.esm.js.map +1 -1
- package/dist/components/select-nonprofit.js +33 -32
- package/dist/components/select-nonprofit.js.map +1 -1
- package/dist/components/select-subscription-nonprofit.esm.js +1 -1
- package/dist/components/select-subscription-nonprofit.js +1 -1
- package/dist/components/shopify.d.ts +6 -6
- package/dist/components/shopify.esm.js +1 -1
- package/dist/components/shopify.js +1 -1
- package/dist/components/social-share.d.ts +1 -0
- package/dist/components/social-share.esm.js +2 -2
- package/dist/components/social-share.esm.js.map +1 -1
- package/dist/components/social-share.js +2 -2
- package/dist/components/social-share.js.map +1 -1
- package/dist/components/subscription-impact.d.ts +14 -0
- package/dist/components/subscription-impact.esm.js +1 -1
- package/dist/components/subscription-impact.js +1 -1
- package/dist/components/subscription-management.d.ts +25 -3
- package/dist/components/subscription-management.esm.js +1 -1
- package/dist/components/subscription-management.js +1 -1
- package/dist/index.d.ts +12 -12
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/integrations/beam.esm.js +1 -1
- package/dist/integrations/beam.js +1 -1
- package/dist/integrations/cart.d.ts +3 -3
- package/dist/integrations/cart.esm.js +1 -1
- package/dist/integrations/cart.js +1 -1
- package/dist/integrations/index.d.ts +10 -10
- package/dist/integrations/index.esm.js +1 -1
- package/dist/integrations/index.js +1 -1
- package/dist/integrations/logs.d.ts +2 -2
- package/dist/integrations/logs.esm.js +1 -1
- package/dist/integrations/logs.js +1 -1
- package/dist/integrations/shopify.d.ts +5 -5
- package/dist/integrations/shopify.esm.js +1 -1
- package/dist/integrations/shopify.js +1 -1
- package/dist/integrations/statsig.esm.js +1 -1
- package/dist/integrations/statsig.js +1 -1
- package/dist/integrations/utils.d.ts +3 -3
- package/dist/react/community-impact.esm.js +1 -1
- package/dist/react/community-impact.js +1 -1
- package/dist/react/cumulative-impact.esm.js +1 -1
- package/dist/react/cumulative-impact.js +1 -1
- package/dist/react/impact-overview.esm.js +1 -1
- package/dist/react/impact-overview.js +1 -1
- package/dist/react/index.d.ts +4 -4
- package/dist/react/index.esm.js +1 -1
- package/dist/react/index.js +1 -1
- package/dist/react/post-purchase.d.ts +2 -2
- package/dist/react/post-purchase.esm.js +1 -1
- package/dist/react/post-purchase.js +1 -1
- package/dist/react/product-details-page.esm.js +1 -1
- package/dist/react/product-details-page.js +1 -1
- package/dist/react/redeem-transaction.d.ts +3 -3
- package/dist/react/redeem-transaction.esm.js +1 -1
- package/dist/react/redeem-transaction.js +1 -1
- package/dist/react/select-nonprofit.d.ts +3 -3
- package/dist/react/select-nonprofit.esm.js +1 -1
- package/dist/react/select-nonprofit.js +1 -1
- package/dist/react/select-subscription-nonprofit.d.ts +3 -3
- package/dist/react/select-subscription-nonprofit.esm.js +1 -1
- package/dist/react/select-subscription-nonprofit.js +1 -1
- package/dist/react/social-share.esm.js +1 -1
- package/dist/react/social-share.js +1 -1
- package/dist/react/subscription-impact.esm.js +1 -1
- package/dist/react/subscription-impact.js +1 -1
- package/dist/react/subscription-management.d.ts +3 -3
- package/dist/react/subscription-management.esm.js +1 -1
- package/dist/react/subscription-management.js +1 -1
- package/dist/utils/events.d.ts +3 -3
- package/dist/utils/index.d.ts +3 -3
- package/package.json +1 -1
- package/dist/chunks/_share-dialog-dependencies-0XZ9j6DF.esm.js +0 -2
- package/dist/chunks/_share-dialog-dependencies-0XZ9j6DF.esm.js.map +0 -1
- package/dist/chunks/_share-dialog-dependencies-cBi8GG00.esm.js +0 -2
- package/dist/chunks/_share-dialog-dependencies-cBi8GG00.esm.js.map +0 -1
- package/dist/chunks/index--phjcEHh.esm.js +0 -2
- package/dist/chunks/index--phjcEHh.esm.js.map +0 -1
- package/dist/chunks/index-2K1cEtb1.esm.js +0 -2
- package/dist/chunks/index-2K1cEtb1.esm.js.map +0 -1
- package/dist/chunks/index-3-VTK-nH.esm.js +0 -2
- package/dist/chunks/index-3-VTK-nH.esm.js.map +0 -1
- package/dist/chunks/index-JA-7NqMF.esm.js +0 -2
- package/dist/chunks/index-JA-7NqMF.esm.js.map +0 -1
- package/dist/chunks/index-eHSdKArB.esm.js +0 -2
- package/dist/chunks/index-eHSdKArB.esm.js.map +0 -1
- package/dist/chunks/index-sOAq6oM0.esm.js +0 -2
- package/dist/chunks/index-sOAq6oM0.esm.js.map +0 -1
- package/dist/chunks/order-page-4qPr8vqZ.esm.js +0 -2
- package/dist/chunks/order-page-4qPr8vqZ.esm.js.map +0 -1
- package/dist/chunks/order-page-akvp5h2x.esm.js +0 -2
- package/dist/chunks/order-page-akvp5h2x.esm.js.map +0 -1
|
@@ -40,6 +40,11 @@ interface paths {
|
|
|
40
40
|
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
41
41
|
*/
|
|
42
42
|
logoUrl: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* @description Image pre baked with partner logo next to Beam logo
|
|
45
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
46
|
+
*/
|
|
47
|
+
logoLockupUrl?: string | null;
|
|
43
48
|
/**
|
|
44
49
|
* @description A URL string, but can be null
|
|
45
50
|
* @example https://beamimpact.com
|
|
@@ -67,6 +72,21 @@ interface paths {
|
|
|
67
72
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
68
73
|
*/
|
|
69
74
|
promoDescription?: string;
|
|
75
|
+
/**
|
|
76
|
+
* @description confirm button
|
|
77
|
+
* @example Confirm free donation
|
|
78
|
+
*/
|
|
79
|
+
confirmButton?: string;
|
|
80
|
+
/**
|
|
81
|
+
* @description copy once confirm button is clicked
|
|
82
|
+
* @example Confirmed!
|
|
83
|
+
*/
|
|
84
|
+
confirmedButton?: string;
|
|
85
|
+
/**
|
|
86
|
+
* @description collapsed button copy
|
|
87
|
+
* @example Choose a nonprofit
|
|
88
|
+
*/
|
|
89
|
+
collapsedButton?: string;
|
|
70
90
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
71
91
|
theme?: {
|
|
72
92
|
[key: string]: unknown;
|
|
@@ -195,6 +215,12 @@ interface paths {
|
|
|
195
215
|
* @example #000000
|
|
196
216
|
*/
|
|
197
217
|
causeColor: string | null;
|
|
218
|
+
extensibility?: {
|
|
219
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
220
|
+
causeIconUrl?: string | null;
|
|
221
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
222
|
+
causeIconSelectedUrl?: string | null;
|
|
223
|
+
};
|
|
198
224
|
/**
|
|
199
225
|
* @description A URL string
|
|
200
226
|
* @example https://beamimpact.com
|
|
@@ -309,6 +335,11 @@ interface paths {
|
|
|
309
335
|
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
310
336
|
*/
|
|
311
337
|
logoUrl: string | null;
|
|
338
|
+
/**
|
|
339
|
+
* @description Image pre baked with partner logo next to Beam logo
|
|
340
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
341
|
+
*/
|
|
342
|
+
logoLockupUrl?: string | null;
|
|
312
343
|
/**
|
|
313
344
|
* @description A URL string, but can be null
|
|
314
345
|
* @example https://beamimpact.com
|
|
@@ -336,6 +367,21 @@ interface paths {
|
|
|
336
367
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
337
368
|
*/
|
|
338
369
|
promoDescription?: string;
|
|
370
|
+
/**
|
|
371
|
+
* @description confirm button
|
|
372
|
+
* @example Confirm free donation
|
|
373
|
+
*/
|
|
374
|
+
confirmButton?: string;
|
|
375
|
+
/**
|
|
376
|
+
* @description copy once confirm button is clicked
|
|
377
|
+
* @example Confirmed!
|
|
378
|
+
*/
|
|
379
|
+
confirmedButton?: string;
|
|
380
|
+
/**
|
|
381
|
+
* @description collapsed button copy
|
|
382
|
+
* @example Choose a nonprofit
|
|
383
|
+
*/
|
|
384
|
+
collapsedButton?: string;
|
|
339
385
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
340
386
|
theme?: {
|
|
341
387
|
[key: string]: unknown;
|
|
@@ -526,6 +572,11 @@ interface paths {
|
|
|
526
572
|
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
527
573
|
*/
|
|
528
574
|
logoUrl: string | null;
|
|
575
|
+
/**
|
|
576
|
+
* @description Image pre baked with partner logo next to Beam logo
|
|
577
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
578
|
+
*/
|
|
579
|
+
logoLockupUrl?: string | null;
|
|
529
580
|
/**
|
|
530
581
|
* @description A URL string, but can be null
|
|
531
582
|
* @example https://beamimpact.com
|
|
@@ -553,6 +604,21 @@ interface paths {
|
|
|
553
604
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
554
605
|
*/
|
|
555
606
|
promoDescription?: string;
|
|
607
|
+
/**
|
|
608
|
+
* @description confirm button
|
|
609
|
+
* @example Confirm free donation
|
|
610
|
+
*/
|
|
611
|
+
confirmButton?: string;
|
|
612
|
+
/**
|
|
613
|
+
* @description copy once confirm button is clicked
|
|
614
|
+
* @example Confirmed!
|
|
615
|
+
*/
|
|
616
|
+
confirmedButton?: string;
|
|
617
|
+
/**
|
|
618
|
+
* @description collapsed button copy
|
|
619
|
+
* @example Choose a nonprofit
|
|
620
|
+
*/
|
|
621
|
+
collapsedButton?: string;
|
|
556
622
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
557
623
|
theme?: {
|
|
558
624
|
[key: string]: unknown;
|
|
@@ -681,6 +747,12 @@ interface paths {
|
|
|
681
747
|
* @example #000000
|
|
682
748
|
*/
|
|
683
749
|
causeColor: string | null;
|
|
750
|
+
extensibility?: {
|
|
751
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
752
|
+
causeIconUrl?: string | null;
|
|
753
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
754
|
+
causeIconSelectedUrl?: string | null;
|
|
755
|
+
};
|
|
684
756
|
/**
|
|
685
757
|
* @description A URL string
|
|
686
758
|
* @example https://beamimpact.com
|
|
@@ -917,6 +989,8 @@ interface paths {
|
|
|
917
989
|
"options.config.omitThemes"?: boolean;
|
|
918
990
|
/** Discount codes applied to the order */
|
|
919
991
|
discountCodes?: string[];
|
|
992
|
+
/** The transactionId of the purchase */
|
|
993
|
+
transactionId?: string;
|
|
920
994
|
};
|
|
921
995
|
};
|
|
922
996
|
responses: {
|
|
@@ -931,6 +1005,11 @@ interface paths {
|
|
|
931
1005
|
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
932
1006
|
*/
|
|
933
1007
|
logoUrl: string | null;
|
|
1008
|
+
/**
|
|
1009
|
+
* @description Image pre baked with partner logo next to Beam logo
|
|
1010
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1011
|
+
*/
|
|
1012
|
+
logoLockupUrl?: string | null;
|
|
934
1013
|
/**
|
|
935
1014
|
* @description A URL string, but can be null
|
|
936
1015
|
* @example https://beamimpact.com
|
|
@@ -967,6 +1046,21 @@ interface paths {
|
|
|
967
1046
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
968
1047
|
*/
|
|
969
1048
|
promoDescription?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* @description confirm button
|
|
1051
|
+
* @example Confirm free donation
|
|
1052
|
+
*/
|
|
1053
|
+
confirmButton?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* @description copy once confirm button is clicked
|
|
1056
|
+
* @example Confirmed!
|
|
1057
|
+
*/
|
|
1058
|
+
confirmedButton?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* @description collapsed button copy
|
|
1061
|
+
* @example Choose a nonprofit
|
|
1062
|
+
*/
|
|
1063
|
+
collapsedButton?: string;
|
|
970
1064
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
971
1065
|
theme?: {
|
|
972
1066
|
[key: string]: unknown;
|
|
@@ -1085,6 +1179,12 @@ interface paths {
|
|
|
1085
1179
|
* @example #000000
|
|
1086
1180
|
*/
|
|
1087
1181
|
causeColor: string | null;
|
|
1182
|
+
extensibility?: {
|
|
1183
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
1184
|
+
causeIconUrl?: string | null;
|
|
1185
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
1186
|
+
causeIconSelectedUrl?: string | null;
|
|
1187
|
+
};
|
|
1088
1188
|
/**
|
|
1089
1189
|
* @description A URL string
|
|
1090
1190
|
* @example https://beamimpact.com
|
|
@@ -1168,6 +1268,12 @@ interface paths {
|
|
|
1168
1268
|
* @example #000000
|
|
1169
1269
|
*/
|
|
1170
1270
|
causeColor: string | null;
|
|
1271
|
+
extensibility?: {
|
|
1272
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
1273
|
+
causeIconUrl?: string | null;
|
|
1274
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
1275
|
+
causeIconSelectedUrl?: string | null;
|
|
1276
|
+
};
|
|
1171
1277
|
/**
|
|
1172
1278
|
* @description A URL string
|
|
1173
1279
|
* @example https://beamimpact.com
|
|
@@ -1223,35 +1329,561 @@ interface paths {
|
|
|
1223
1329
|
promo: {
|
|
1224
1330
|
isActive: boolean;
|
|
1225
1331
|
/**
|
|
1226
|
-
* @description When a promo is active, the total amount donated is multiplied by this value. ex:\ (subtotal * donationAmount) * multiplier -> ($100 * 1%) * 2 = $2.00 donated
|
|
1227
|
-
* @example 2
|
|
1332
|
+
* @description When a promo is active, the total amount donated is multiplied by this value. ex:\ (subtotal * donationAmount) * multiplier -> ($100 * 1%) * 2 = $2.00 donated
|
|
1333
|
+
* @example 2
|
|
1334
|
+
*/
|
|
1335
|
+
multiplier: number | null;
|
|
1336
|
+
} | null;
|
|
1337
|
+
promoAssetUrl: string | null;
|
|
1338
|
+
personalImpactAssetUrl: string | null;
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
};
|
|
1342
|
+
/** Standard error */
|
|
1343
|
+
default: {
|
|
1344
|
+
content: {
|
|
1345
|
+
"application/json": {
|
|
1346
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
1347
|
+
code: string;
|
|
1348
|
+
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
1349
|
+
title: string;
|
|
1350
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
1351
|
+
detail: string;
|
|
1352
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
1353
|
+
field?: string;
|
|
1354
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
1355
|
+
metadata?: {
|
|
1356
|
+
[key: string]: unknown;
|
|
1357
|
+
};
|
|
1358
|
+
/** @description Whether the API or user can resend the request */
|
|
1359
|
+
retryable?: boolean;
|
|
1360
|
+
} & {
|
|
1361
|
+
source: unknown;
|
|
1362
|
+
meta: unknown;
|
|
1363
|
+
};
|
|
1364
|
+
};
|
|
1365
|
+
};
|
|
1366
|
+
};
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
"/impact/calculateImpactPreview": {
|
|
1370
|
+
post: {
|
|
1371
|
+
responses: {
|
|
1372
|
+
/** The post-transaction impact for both the user and the community on that non-profit */
|
|
1373
|
+
200: {
|
|
1374
|
+
content: {
|
|
1375
|
+
"application/json": {
|
|
1376
|
+
chain: {
|
|
1377
|
+
name: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* @description URL including file extension, e.g., an image path
|
|
1380
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1381
|
+
*/
|
|
1382
|
+
logoUrl: string | null;
|
|
1383
|
+
/**
|
|
1384
|
+
* @description Image pre baked with partner logo next to Beam logo
|
|
1385
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1386
|
+
*/
|
|
1387
|
+
logoLockupUrl?: string | null;
|
|
1388
|
+
/**
|
|
1389
|
+
* @description A URL string, but can be null
|
|
1390
|
+
* @example https://beamimpact.com
|
|
1391
|
+
*/
|
|
1392
|
+
communityImpactUrl: string | null;
|
|
1393
|
+
donationTypeName: string | null;
|
|
1394
|
+
matchDonationTypeName: string | null;
|
|
1395
|
+
};
|
|
1396
|
+
store: {
|
|
1397
|
+
name: string | null;
|
|
1398
|
+
displayName: string | null;
|
|
1399
|
+
/**
|
|
1400
|
+
* @description A URL string, but can be null
|
|
1401
|
+
* @example https://beamimpact.com
|
|
1402
|
+
*/
|
|
1403
|
+
communityPageURL: string | null;
|
|
1404
|
+
};
|
|
1405
|
+
config: {
|
|
1406
|
+
web: {
|
|
1407
|
+
/**
|
|
1408
|
+
* @description Header/title for the widget
|
|
1409
|
+
* @example Choose your impact
|
|
1410
|
+
*/
|
|
1411
|
+
title: string;
|
|
1412
|
+
/** @description Subtitle/description for the widget */
|
|
1413
|
+
description: string;
|
|
1414
|
+
/**
|
|
1415
|
+
* @description The prefix promo description for the widget for web
|
|
1416
|
+
* @example At no extra cost,
|
|
1417
|
+
*/
|
|
1418
|
+
promoDescriptionPrefix?: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* @description The promo description for the widget for web
|
|
1421
|
+
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
1422
|
+
*/
|
|
1423
|
+
promoDescription?: string;
|
|
1424
|
+
/**
|
|
1425
|
+
* @description confirm button
|
|
1426
|
+
* @example Confirm free donation
|
|
1427
|
+
*/
|
|
1428
|
+
confirmButton?: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* @description copy once confirm button is clicked
|
|
1431
|
+
* @example Confirmed!
|
|
1432
|
+
*/
|
|
1433
|
+
confirmedButton?: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* @description collapsed button copy
|
|
1436
|
+
* @example Choose a nonprofit
|
|
1437
|
+
*/
|
|
1438
|
+
collapsedButton?: string;
|
|
1439
|
+
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
1440
|
+
theme?: {
|
|
1441
|
+
[key: string]: unknown;
|
|
1442
|
+
} | null;
|
|
1443
|
+
/**
|
|
1444
|
+
* @description nonprofit Selected Header for select-nonprofit-cta widget
|
|
1445
|
+
* @example Your impact
|
|
1446
|
+
*/
|
|
1447
|
+
nonprofitSelectedHeader?: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* @description nonprofit Unselected Header for select-nonprofit-cta widget
|
|
1450
|
+
* @example Make your purchase a force for good
|
|
1451
|
+
*/
|
|
1452
|
+
nonprofitUnselectedHeader?: string;
|
|
1453
|
+
/** @description An object containing dynamic strings for the widget. These strings serve as templates and include dynamic variables that vary based on the widget type. */
|
|
1454
|
+
dynamicStrings?: {
|
|
1455
|
+
[key: string]: string;
|
|
1456
|
+
} | null;
|
|
1457
|
+
/** @description An object containing additional static strings specific to each widget. These strings are unique to the widget and are not shared across different widgets. */
|
|
1458
|
+
additionalStrings?: {
|
|
1459
|
+
[key: string]: string;
|
|
1460
|
+
} | null;
|
|
1461
|
+
/** @description Disables counter animation for cumulative-impact widget */
|
|
1462
|
+
disableAnimation?: boolean;
|
|
1463
|
+
/** @description promo copy is sent in this object to be used in conditionally rendered UI components. This object serves as a repository for server-generated copy */
|
|
1464
|
+
promo?: {
|
|
1465
|
+
/** @example Donations are 2x for Black History Month */
|
|
1466
|
+
"promo-text-long": string;
|
|
1467
|
+
/** @example Donations are 2x */
|
|
1468
|
+
"promo-text-short": string;
|
|
1469
|
+
/**
|
|
1470
|
+
* @description replaces cause copy
|
|
1471
|
+
* @example 2x boosting donations
|
|
1472
|
+
*/
|
|
1473
|
+
"promo-cause-alt-text": string;
|
|
1474
|
+
};
|
|
1475
|
+
};
|
|
1476
|
+
mobileWeb?: {
|
|
1477
|
+
/**
|
|
1478
|
+
* @description Header/title for the widget
|
|
1479
|
+
* @example Choose your impact
|
|
1480
|
+
*/
|
|
1481
|
+
title: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* @description Subtitle/description for the widget
|
|
1484
|
+
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
1485
|
+
*/
|
|
1486
|
+
description: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* @description nonprofit Selected Header for select-nonprofit-cta widget
|
|
1489
|
+
* @example Your impact
|
|
1490
|
+
*/
|
|
1491
|
+
nonprofitSelectedHeader?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* @description nonprofit Unselected Header for select-nonprofit-cta widget
|
|
1494
|
+
* @example Make your purchase a force for good
|
|
1495
|
+
*/
|
|
1496
|
+
nonprofitUnselectedHeader?: string;
|
|
1497
|
+
};
|
|
1498
|
+
mobile: {
|
|
1499
|
+
/**
|
|
1500
|
+
* @description Header/title for the widget
|
|
1501
|
+
* @example Choose your impact
|
|
1502
|
+
*/
|
|
1503
|
+
title: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* @description Subtitle/description for the widget
|
|
1506
|
+
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
1507
|
+
*/
|
|
1508
|
+
description: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* @description nonprofit Selected Header for select-nonprofit-cta widget
|
|
1511
|
+
* @example Your impact
|
|
1512
|
+
*/
|
|
1513
|
+
nonprofitSelectedHeader?: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* @description nonprofit Unselected Header for select-nonprofit-cta widget
|
|
1516
|
+
* @example Make your purchase a force for good
|
|
1517
|
+
*/
|
|
1518
|
+
nonprofitUnselectedHeader?: string;
|
|
1519
|
+
};
|
|
1520
|
+
/**
|
|
1521
|
+
* @description determines if a chain can enable nonprofit deselection for the select-nonprofit widget
|
|
1522
|
+
* @default false
|
|
1523
|
+
*/
|
|
1524
|
+
enableNonprofitDeselection?: boolean;
|
|
1525
|
+
};
|
|
1526
|
+
personal: {
|
|
1527
|
+
/**
|
|
1528
|
+
* @description URL including file extension, e.g., an image path
|
|
1529
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1530
|
+
*/
|
|
1531
|
+
imageUrl: string | null;
|
|
1532
|
+
nonprofit: {
|
|
1533
|
+
/**
|
|
1534
|
+
* @description Numeric ID
|
|
1535
|
+
* @example 1001
|
|
1536
|
+
*/
|
|
1537
|
+
id: number;
|
|
1538
|
+
/** @example LA Regional Food Bank */
|
|
1539
|
+
name: string;
|
|
1540
|
+
/** @example Food Security */
|
|
1541
|
+
cause: string | null;
|
|
1542
|
+
/**
|
|
1543
|
+
* @description URL including file extension, e.g., an image path
|
|
1544
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1545
|
+
*/
|
|
1546
|
+
causeIconUrl: string | null;
|
|
1547
|
+
/**
|
|
1548
|
+
* @description URL including file extension, e.g., an image path
|
|
1549
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1550
|
+
*/
|
|
1551
|
+
causeIconSelectedUrl: string | null;
|
|
1552
|
+
/**
|
|
1553
|
+
* @description Hex code of the color for the nonprofit when it is selected
|
|
1554
|
+
* @example #000000
|
|
1555
|
+
*/
|
|
1556
|
+
causeColor: string | null;
|
|
1557
|
+
extensibility?: {
|
|
1558
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
1559
|
+
causeIconUrl?: string | null;
|
|
1560
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
1561
|
+
causeIconSelectedUrl?: string | null;
|
|
1562
|
+
};
|
|
1563
|
+
/**
|
|
1564
|
+
* @description A URL string
|
|
1565
|
+
* @example https://beamimpact.com
|
|
1566
|
+
*/
|
|
1567
|
+
website: string | null;
|
|
1568
|
+
/** @example Learn More */
|
|
1569
|
+
websiteLinkText: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* @description a label that can be used for location
|
|
1572
|
+
* @example Hawaii
|
|
1573
|
+
*/
|
|
1574
|
+
badge?: string;
|
|
1575
|
+
/** @description should include nonprofit in personal impact */
|
|
1576
|
+
includeInPersonalImpact?: boolean;
|
|
1577
|
+
};
|
|
1578
|
+
impact: {
|
|
1579
|
+
/**
|
|
1580
|
+
* @description The description of the funding
|
|
1581
|
+
* @example <b>Fund</b> 10 sewing machines...
|
|
1582
|
+
*/
|
|
1583
|
+
description: string | null;
|
|
1584
|
+
/**
|
|
1585
|
+
* @description The string representing the number of times the goal has been completed
|
|
1586
|
+
* @example <b>Funded</b> 2 times so far
|
|
1587
|
+
*/
|
|
1588
|
+
goalCompletionText: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* @description The text next to the progress bar
|
|
1591
|
+
* @example 54% funded
|
|
1592
|
+
*/
|
|
1593
|
+
goalProgressText: string;
|
|
1594
|
+
/**
|
|
1595
|
+
* @description The progress towards the next goal completion
|
|
1596
|
+
* @example 41
|
|
1597
|
+
*/
|
|
1598
|
+
goalProgressPercentage: number;
|
|
1599
|
+
};
|
|
1600
|
+
share: {
|
|
1601
|
+
/**
|
|
1602
|
+
* @description URL including file extension, e.g., an image path
|
|
1603
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1604
|
+
*/
|
|
1605
|
+
imageUrl: string | null;
|
|
1606
|
+
};
|
|
1607
|
+
/**
|
|
1608
|
+
* @example [
|
|
1609
|
+
* "Midwest",
|
|
1610
|
+
* "Southeast"
|
|
1611
|
+
* ]
|
|
1612
|
+
*/
|
|
1613
|
+
filters?: string[];
|
|
1614
|
+
}[];
|
|
1615
|
+
community: {
|
|
1616
|
+
/**
|
|
1617
|
+
* @description URL including file extension, e.g., an image path
|
|
1618
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1619
|
+
*/
|
|
1620
|
+
imageUrl: string | null;
|
|
1621
|
+
nonprofit: {
|
|
1622
|
+
/**
|
|
1623
|
+
* @description Numeric ID
|
|
1624
|
+
* @example 1001
|
|
1625
|
+
*/
|
|
1626
|
+
id: number;
|
|
1627
|
+
/** @example LA Regional Food Bank */
|
|
1628
|
+
name: string;
|
|
1629
|
+
/** @example Food Security */
|
|
1630
|
+
cause: string | null;
|
|
1631
|
+
/**
|
|
1632
|
+
* @description URL including file extension, e.g., an image path
|
|
1633
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1634
|
+
*/
|
|
1635
|
+
causeIconUrl: string | null;
|
|
1636
|
+
/**
|
|
1637
|
+
* @description URL including file extension, e.g., an image path
|
|
1638
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1639
|
+
*/
|
|
1640
|
+
causeIconSelectedUrl: string | null;
|
|
1641
|
+
/**
|
|
1642
|
+
* @description Hex code of the color for the nonprofit when it is selected
|
|
1643
|
+
* @example #000000
|
|
1644
|
+
*/
|
|
1645
|
+
causeColor: string | null;
|
|
1646
|
+
extensibility?: {
|
|
1647
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
1648
|
+
causeIconUrl?: string | null;
|
|
1649
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
1650
|
+
causeIconSelectedUrl?: string | null;
|
|
1651
|
+
};
|
|
1652
|
+
/**
|
|
1653
|
+
* @description A URL string
|
|
1654
|
+
* @example https://beamimpact.com
|
|
1655
|
+
*/
|
|
1656
|
+
website: string | null;
|
|
1657
|
+
/** @example Learn More */
|
|
1658
|
+
websiteLinkText: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* @description a label that can be used for location
|
|
1661
|
+
* @example Hawaii
|
|
1662
|
+
*/
|
|
1663
|
+
badge?: string;
|
|
1664
|
+
/** @description should include nonprofit in personal impact */
|
|
1665
|
+
includeInPersonalImpact?: boolean;
|
|
1666
|
+
};
|
|
1667
|
+
impact: {
|
|
1668
|
+
/**
|
|
1669
|
+
* @description The description of the funding
|
|
1670
|
+
* @example <b>Fund</b> 10 sewing machines...
|
|
1671
|
+
*/
|
|
1672
|
+
description: string | null;
|
|
1673
|
+
/**
|
|
1674
|
+
* @description The string representing the number of times the goal has been completed
|
|
1675
|
+
* @example <b>Funded</b> 2 times so far
|
|
1676
|
+
*/
|
|
1677
|
+
goalCompletionText: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* @description The text next to the progress bar
|
|
1680
|
+
* @example 54% funded
|
|
1681
|
+
*/
|
|
1682
|
+
goalProgressText: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* @description The progress towards the next goal completion
|
|
1685
|
+
* @example 41
|
|
1686
|
+
*/
|
|
1687
|
+
goalProgressPercentage: number;
|
|
1688
|
+
};
|
|
1689
|
+
share: {
|
|
1690
|
+
/**
|
|
1691
|
+
* @description URL including file extension, e.g., an image path
|
|
1692
|
+
* @example https://cdn.beamimpact.com/logos/beam.png
|
|
1693
|
+
*/
|
|
1694
|
+
imageUrl: string | null;
|
|
1695
|
+
};
|
|
1696
|
+
/**
|
|
1697
|
+
* @example [
|
|
1698
|
+
* "Midwest",
|
|
1699
|
+
* "Southeast"
|
|
1700
|
+
* ]
|
|
1701
|
+
*/
|
|
1702
|
+
filters?: string[];
|
|
1703
|
+
}[];
|
|
1704
|
+
promo: {
|
|
1705
|
+
isActive: boolean;
|
|
1706
|
+
/**
|
|
1707
|
+
* @description When a promo is active, the total amount donated is multiplied by this value. ex:\ (subtotal * donationAmount) * multiplier -> ($100 * 1%) * 2 = $2.00 donated
|
|
1708
|
+
* @example 2
|
|
1709
|
+
*/
|
|
1710
|
+
multiplier: number | null;
|
|
1711
|
+
} | null;
|
|
1712
|
+
promoAssetUrl: string | null;
|
|
1713
|
+
personalImpactAssetUrl: string | null;
|
|
1714
|
+
};
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
/** Standard error */
|
|
1718
|
+
default: {
|
|
1719
|
+
content: {
|
|
1720
|
+
"application/json": {
|
|
1721
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
1722
|
+
code: string;
|
|
1723
|
+
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
1724
|
+
title: string;
|
|
1725
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
1726
|
+
detail: string;
|
|
1727
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
1728
|
+
field?: string;
|
|
1729
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
1730
|
+
metadata?: {
|
|
1731
|
+
[key: string]: unknown;
|
|
1732
|
+
};
|
|
1733
|
+
/** @description Whether the API or user can resend the request */
|
|
1734
|
+
retryable?: boolean;
|
|
1735
|
+
} & {
|
|
1736
|
+
source: unknown;
|
|
1737
|
+
meta: unknown;
|
|
1738
|
+
};
|
|
1739
|
+
};
|
|
1740
|
+
};
|
|
1741
|
+
};
|
|
1742
|
+
requestBody: {
|
|
1743
|
+
content: {
|
|
1744
|
+
"application/json": {
|
|
1745
|
+
/** @description The partner's order ID */
|
|
1746
|
+
orderId: string | number;
|
|
1747
|
+
/**
|
|
1748
|
+
* @description The ID of the store
|
|
1749
|
+
* @example 1001
|
|
1750
|
+
*/
|
|
1751
|
+
storeId: number;
|
|
1752
|
+
/** @description nonprofit ID selected when a transaction is created/updated. When present and set to null, nonprofitId is deleted from DB for existing transactions. When not present, existing transactions remain unaffected. */
|
|
1753
|
+
nonprofitId?: number | null;
|
|
1754
|
+
/** @description ISO currency code */
|
|
1755
|
+
currencyCode: string;
|
|
1756
|
+
/** @description The amount in the cart */
|
|
1757
|
+
cartTotal: number;
|
|
1758
|
+
cart?: {
|
|
1759
|
+
schema: {
|
|
1760
|
+
/** @enum {string} */
|
|
1761
|
+
source: "shopify";
|
|
1762
|
+
/** @enum {string} */
|
|
1763
|
+
variant: "ajax";
|
|
1764
|
+
version?: string;
|
|
1765
|
+
};
|
|
1766
|
+
content: {
|
|
1767
|
+
localAmount?: number;
|
|
1768
|
+
/** @description Order or cart level discounts */
|
|
1769
|
+
discounts?: {
|
|
1770
|
+
/** @description The code for the discount */
|
|
1771
|
+
code: string;
|
|
1772
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
1773
|
+
applicable: boolean;
|
|
1774
|
+
}[] | null;
|
|
1775
|
+
items: {
|
|
1776
|
+
id?: number | null;
|
|
1777
|
+
gift_card?: boolean | null;
|
|
1778
|
+
/** @description Price for line item (qty * unit price), after discounts, in integer cents format (3.50 => 350) */
|
|
1779
|
+
final_line_price: number | null;
|
|
1780
|
+
/** @description Unit price for line item, in integer cents format (3.50 => 350) */
|
|
1781
|
+
final_price?: number | null;
|
|
1782
|
+
/** @description Line item discounts */
|
|
1783
|
+
line_level_discount_applications?: ({
|
|
1784
|
+
/** @description The code for the discount */
|
|
1785
|
+
title: string;
|
|
1786
|
+
} & {
|
|
1787
|
+
[key: string]: unknown;
|
|
1788
|
+
})[] | null;
|
|
1789
|
+
quantity?: number | null;
|
|
1790
|
+
sku: string | null;
|
|
1791
|
+
product_id?: number | null;
|
|
1792
|
+
product_title?: string | null;
|
|
1793
|
+
product_type?: string | null;
|
|
1794
|
+
variant_id?: number | null;
|
|
1795
|
+
}[];
|
|
1796
|
+
subscriptions?: {
|
|
1797
|
+
remoteSubscriptionId: string;
|
|
1798
|
+
isNew?: boolean;
|
|
1799
|
+
}[];
|
|
1800
|
+
};
|
|
1801
|
+
} | {
|
|
1802
|
+
schema: {
|
|
1803
|
+
/** @enum {string} */
|
|
1804
|
+
source: "shopify";
|
|
1805
|
+
/** @enum {string} */
|
|
1806
|
+
variant: "liquid";
|
|
1807
|
+
version?: string;
|
|
1808
|
+
};
|
|
1809
|
+
content: {
|
|
1810
|
+
localAmount?: number;
|
|
1811
|
+
/** @description Order or cart level discounts */
|
|
1812
|
+
discounts?: {
|
|
1813
|
+
/** @description The code for the discount */
|
|
1814
|
+
code: string;
|
|
1815
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
1816
|
+
applicable: boolean;
|
|
1817
|
+
}[] | null;
|
|
1818
|
+
items: {
|
|
1819
|
+
id?: number | null;
|
|
1820
|
+
gift_card?: boolean | null;
|
|
1821
|
+
/** @description Price for line item (qty * unit price), after discounts, in decimal format (3.50) */
|
|
1822
|
+
final_line_price: number | null;
|
|
1823
|
+
/** @description Unit price for line item in decimal format (3.50) */
|
|
1824
|
+
final_price?: number | null;
|
|
1825
|
+
/** @description Line item discounts */
|
|
1826
|
+
line_level_discount_applications?: ({
|
|
1827
|
+
/** @description The code for the discount */
|
|
1828
|
+
title: string;
|
|
1829
|
+
} & {
|
|
1830
|
+
[key: string]: unknown;
|
|
1831
|
+
})[] | null;
|
|
1832
|
+
quantity?: number | null;
|
|
1833
|
+
sku: string | null;
|
|
1834
|
+
product_id?: number | null;
|
|
1835
|
+
variant_id?: number | null;
|
|
1836
|
+
}[];
|
|
1837
|
+
subscriptions?: {
|
|
1838
|
+
remoteSubscriptionId: string;
|
|
1839
|
+
isNew?: boolean;
|
|
1840
|
+
}[];
|
|
1841
|
+
};
|
|
1842
|
+
} | {
|
|
1843
|
+
schema: {
|
|
1844
|
+
/**
|
|
1845
|
+
* @default generic
|
|
1846
|
+
* @enum {string}
|
|
1228
1847
|
*/
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
};
|
|
1234
|
-
/** Standard error */
|
|
1235
|
-
default: {
|
|
1236
|
-
content: {
|
|
1237
|
-
"application/json": {
|
|
1238
|
-
/** @description Beam code for the error, meant to be used programmatically */
|
|
1239
|
-
code: string;
|
|
1240
|
-
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
1241
|
-
title: string;
|
|
1242
|
-
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
1243
|
-
detail: string;
|
|
1244
|
-
/** @description a JSON Pointer to the associated entity in the request document */
|
|
1245
|
-
field?: string;
|
|
1246
|
-
/** @description A meta object containing non-standard meta-information about the error */
|
|
1247
|
-
metadata?: {
|
|
1248
|
-
[key: string]: unknown;
|
|
1848
|
+
source: "generic";
|
|
1849
|
+
/** @enum {string} */
|
|
1850
|
+
variant?: "default";
|
|
1851
|
+
version?: string;
|
|
1249
1852
|
};
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1853
|
+
content: {
|
|
1854
|
+
localAmount?: number;
|
|
1855
|
+
/** @description Order or cart level discounts */
|
|
1856
|
+
discounts?: {
|
|
1857
|
+
/** @description The code for the discount */
|
|
1858
|
+
code: string;
|
|
1859
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
1860
|
+
applicable: boolean;
|
|
1861
|
+
}[] | null;
|
|
1862
|
+
items: {
|
|
1863
|
+
remoteProductIdentifier?: string | null;
|
|
1864
|
+
localAmount: number;
|
|
1865
|
+
remoteSubscriptionId?: string;
|
|
1866
|
+
/** @description Line item discounts */
|
|
1867
|
+
discounts?: {
|
|
1868
|
+
/** @description The code for the discount */
|
|
1869
|
+
code: string;
|
|
1870
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
1871
|
+
applicable: boolean;
|
|
1872
|
+
}[] | null;
|
|
1873
|
+
}[];
|
|
1874
|
+
subscriptions?: {
|
|
1875
|
+
remoteSubscriptionId: string;
|
|
1876
|
+
isNew?: boolean;
|
|
1877
|
+
}[];
|
|
1878
|
+
};
|
|
1879
|
+
};
|
|
1880
|
+
options?: {
|
|
1881
|
+
communityImpactLimit?: number;
|
|
1882
|
+
personalImpactLimit?: number;
|
|
1883
|
+
lang?: string;
|
|
1884
|
+
widgetName?: string;
|
|
1885
|
+
widgetVersion?: string;
|
|
1886
|
+
omitThemes?: boolean;
|
|
1255
1887
|
};
|
|
1256
1888
|
};
|
|
1257
1889
|
};
|
|
@@ -1413,6 +2045,12 @@ interface paths {
|
|
|
1413
2045
|
* @example #000000
|
|
1414
2046
|
*/
|
|
1415
2047
|
causeColor: string | null;
|
|
2048
|
+
extensibility?: {
|
|
2049
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
2050
|
+
causeIconUrl?: string | null;
|
|
2051
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
2052
|
+
causeIconSelectedUrl?: string | null;
|
|
2053
|
+
};
|
|
1416
2054
|
/**
|
|
1417
2055
|
* @description A URL string
|
|
1418
2056
|
* @example https://beamimpact.com
|
|
@@ -1496,6 +2134,12 @@ interface paths {
|
|
|
1496
2134
|
* @example #000000
|
|
1497
2135
|
*/
|
|
1498
2136
|
causeColor: string | null;
|
|
2137
|
+
extensibility?: {
|
|
2138
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
2139
|
+
causeIconUrl?: string | null;
|
|
2140
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
2141
|
+
causeIconSelectedUrl?: string | null;
|
|
2142
|
+
};
|
|
1499
2143
|
/**
|
|
1500
2144
|
* @description A URL string
|
|
1501
2145
|
* @example https://beamimpact.com
|
|
@@ -1656,6 +2300,12 @@ interface paths {
|
|
|
1656
2300
|
* @example #000000
|
|
1657
2301
|
*/
|
|
1658
2302
|
causeColor: string | null;
|
|
2303
|
+
extensibility?: {
|
|
2304
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
2305
|
+
causeIconUrl?: string | null;
|
|
2306
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
2307
|
+
causeIconSelectedUrl?: string | null;
|
|
2308
|
+
};
|
|
1659
2309
|
/**
|
|
1660
2310
|
* @description A URL string
|
|
1661
2311
|
* @example https://beamimpact.com
|
|
@@ -1739,6 +2389,12 @@ interface paths {
|
|
|
1739
2389
|
* @example #000000
|
|
1740
2390
|
*/
|
|
1741
2391
|
causeColor: string | null;
|
|
2392
|
+
extensibility?: {
|
|
2393
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
2394
|
+
causeIconUrl?: string | null;
|
|
2395
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
2396
|
+
causeIconSelectedUrl?: string | null;
|
|
2397
|
+
};
|
|
1742
2398
|
/**
|
|
1743
2399
|
* @description A URL string
|
|
1744
2400
|
* @example https://beamimpact.com
|
|
@@ -2198,6 +2854,21 @@ interface paths {
|
|
|
2198
2854
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
2199
2855
|
*/
|
|
2200
2856
|
promoDescription?: string;
|
|
2857
|
+
/**
|
|
2858
|
+
* @description confirm button
|
|
2859
|
+
* @example Confirm free donation
|
|
2860
|
+
*/
|
|
2861
|
+
confirmButton?: string;
|
|
2862
|
+
/**
|
|
2863
|
+
* @description copy once confirm button is clicked
|
|
2864
|
+
* @example Confirmed!
|
|
2865
|
+
*/
|
|
2866
|
+
confirmedButton?: string;
|
|
2867
|
+
/**
|
|
2868
|
+
* @description collapsed button copy
|
|
2869
|
+
* @example Choose a nonprofit
|
|
2870
|
+
*/
|
|
2871
|
+
collapsedButton?: string;
|
|
2201
2872
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
2202
2873
|
theme?: {
|
|
2203
2874
|
[key: string]: unknown;
|
|
@@ -2317,6 +2988,12 @@ interface paths {
|
|
|
2317
2988
|
* @example #000000
|
|
2318
2989
|
*/
|
|
2319
2990
|
causeColor: string | null;
|
|
2991
|
+
extensibility?: {
|
|
2992
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
2993
|
+
causeIconUrl?: string | null;
|
|
2994
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
2995
|
+
causeIconSelectedUrl?: string | null;
|
|
2996
|
+
};
|
|
2320
2997
|
/**
|
|
2321
2998
|
* @description A URL string
|
|
2322
2999
|
* @example https://beamimpact.com
|
|
@@ -2400,6 +3077,12 @@ interface paths {
|
|
|
2400
3077
|
* @example #000000
|
|
2401
3078
|
*/
|
|
2402
3079
|
causeColor: string | null;
|
|
3080
|
+
extensibility?: {
|
|
3081
|
+
/** @description The cause icon for the extensibility widgets due to color scheme limitations */
|
|
3082
|
+
causeIconUrl?: string | null;
|
|
3083
|
+
/** @description The cause selected icon for the extensibility widgets due to color scheme limitations */
|
|
3084
|
+
causeIconSelectedUrl?: string | null;
|
|
3085
|
+
};
|
|
2403
3086
|
/**
|
|
2404
3087
|
* @description A URL string
|
|
2405
3088
|
* @example https://beamimpact.com
|
|
@@ -2978,6 +3661,21 @@ interface paths {
|
|
|
2978
3661
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
2979
3662
|
*/
|
|
2980
3663
|
promoDescription?: string;
|
|
3664
|
+
/**
|
|
3665
|
+
* @description confirm button
|
|
3666
|
+
* @example Confirm free donation
|
|
3667
|
+
*/
|
|
3668
|
+
confirmButton?: string;
|
|
3669
|
+
/**
|
|
3670
|
+
* @description copy once confirm button is clicked
|
|
3671
|
+
* @example Confirmed!
|
|
3672
|
+
*/
|
|
3673
|
+
confirmedButton?: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* @description collapsed button copy
|
|
3676
|
+
* @example Choose a nonprofit
|
|
3677
|
+
*/
|
|
3678
|
+
collapsedButton?: string;
|
|
2981
3679
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
2982
3680
|
theme?: {
|
|
2983
3681
|
[key: string]: unknown;
|
|
@@ -3084,6 +3782,21 @@ interface paths {
|
|
|
3084
3782
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
3085
3783
|
*/
|
|
3086
3784
|
promoDescription?: string;
|
|
3785
|
+
/**
|
|
3786
|
+
* @description confirm button
|
|
3787
|
+
* @example Confirm free donation
|
|
3788
|
+
*/
|
|
3789
|
+
confirmButton?: string;
|
|
3790
|
+
/**
|
|
3791
|
+
* @description copy once confirm button is clicked
|
|
3792
|
+
* @example Confirmed!
|
|
3793
|
+
*/
|
|
3794
|
+
confirmedButton?: string;
|
|
3795
|
+
/**
|
|
3796
|
+
* @description collapsed button copy
|
|
3797
|
+
* @example Choose a nonprofit
|
|
3798
|
+
*/
|
|
3799
|
+
collapsedButton?: string;
|
|
3087
3800
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
3088
3801
|
theme?: {
|
|
3089
3802
|
[key: string]: unknown;
|
|
@@ -3332,6 +4045,8 @@ interface paths {
|
|
|
3332
4045
|
beamCartId: string | null;
|
|
3333
4046
|
/** @description Whether the Beam Cart was created (T) or updated (F). Null if beamCartId is null. */
|
|
3334
4047
|
beamCartCreated?: boolean | null;
|
|
4048
|
+
/** @description Whether the external Cart was created (T) or updated (F). Null if external cart id is null. */
|
|
4049
|
+
externalCartCreated?: boolean | null;
|
|
3335
4050
|
};
|
|
3336
4051
|
};
|
|
3337
4052
|
};
|
|
@@ -5998,6 +6713,21 @@ interface paths {
|
|
|
5998
6713
|
* @example Select a nonprofit and 1% of your purchase will be donated, at no extra cost
|
|
5999
6714
|
*/
|
|
6000
6715
|
promoDescription?: string;
|
|
6716
|
+
/**
|
|
6717
|
+
* @description confirm button
|
|
6718
|
+
* @example Confirm free donation
|
|
6719
|
+
*/
|
|
6720
|
+
confirmButton?: string;
|
|
6721
|
+
/**
|
|
6722
|
+
* @description copy once confirm button is clicked
|
|
6723
|
+
* @example Confirmed!
|
|
6724
|
+
*/
|
|
6725
|
+
confirmedButton?: string;
|
|
6726
|
+
/**
|
|
6727
|
+
* @description collapsed button copy
|
|
6728
|
+
* @example Choose a nonprofit
|
|
6729
|
+
*/
|
|
6730
|
+
collapsedButton?: string;
|
|
6001
6731
|
/** @description Remote config theme data as requested by the given widgetName & version query params */
|
|
6002
6732
|
theme?: {
|
|
6003
6733
|
[key: string]: unknown;
|
|
@@ -6099,6 +6829,141 @@ interface paths {
|
|
|
6099
6829
|
};
|
|
6100
6830
|
};
|
|
6101
6831
|
};
|
|
6832
|
+
"/webhooks/shopify/redactCustomer": {
|
|
6833
|
+
post: {
|
|
6834
|
+
responses: {
|
|
6835
|
+
/** Webhook received and verified */
|
|
6836
|
+
200: {
|
|
6837
|
+
content: {
|
|
6838
|
+
"application/json": {
|
|
6839
|
+
[key: string]: unknown;
|
|
6840
|
+
};
|
|
6841
|
+
};
|
|
6842
|
+
};
|
|
6843
|
+
/** Standard error */
|
|
6844
|
+
default: {
|
|
6845
|
+
content: {
|
|
6846
|
+
"application/json": {
|
|
6847
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
6848
|
+
code: string;
|
|
6849
|
+
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
6850
|
+
title: string;
|
|
6851
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
6852
|
+
detail: string;
|
|
6853
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
6854
|
+
field?: string;
|
|
6855
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
6856
|
+
metadata?: {
|
|
6857
|
+
[key: string]: unknown;
|
|
6858
|
+
};
|
|
6859
|
+
/** @description Whether the API or user can resend the request */
|
|
6860
|
+
retryable?: boolean;
|
|
6861
|
+
} & {
|
|
6862
|
+
source: unknown;
|
|
6863
|
+
meta: unknown;
|
|
6864
|
+
};
|
|
6865
|
+
};
|
|
6866
|
+
};
|
|
6867
|
+
};
|
|
6868
|
+
requestBody: {
|
|
6869
|
+
content: {
|
|
6870
|
+
"application/json": {
|
|
6871
|
+
[key: string]: unknown;
|
|
6872
|
+
};
|
|
6873
|
+
};
|
|
6874
|
+
};
|
|
6875
|
+
};
|
|
6876
|
+
};
|
|
6877
|
+
"/webhooks/shopify/requestCustomerData": {
|
|
6878
|
+
post: {
|
|
6879
|
+
responses: {
|
|
6880
|
+
/** Webhook received and verified */
|
|
6881
|
+
200: {
|
|
6882
|
+
content: {
|
|
6883
|
+
"application/json": {
|
|
6884
|
+
[key: string]: unknown;
|
|
6885
|
+
};
|
|
6886
|
+
};
|
|
6887
|
+
};
|
|
6888
|
+
/** Standard error */
|
|
6889
|
+
default: {
|
|
6890
|
+
content: {
|
|
6891
|
+
"application/json": {
|
|
6892
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
6893
|
+
code: string;
|
|
6894
|
+
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
6895
|
+
title: string;
|
|
6896
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
6897
|
+
detail: string;
|
|
6898
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
6899
|
+
field?: string;
|
|
6900
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
6901
|
+
metadata?: {
|
|
6902
|
+
[key: string]: unknown;
|
|
6903
|
+
};
|
|
6904
|
+
/** @description Whether the API or user can resend the request */
|
|
6905
|
+
retryable?: boolean;
|
|
6906
|
+
} & {
|
|
6907
|
+
source: unknown;
|
|
6908
|
+
meta: unknown;
|
|
6909
|
+
};
|
|
6910
|
+
};
|
|
6911
|
+
};
|
|
6912
|
+
};
|
|
6913
|
+
requestBody: {
|
|
6914
|
+
content: {
|
|
6915
|
+
"application/json": {
|
|
6916
|
+
[key: string]: unknown;
|
|
6917
|
+
};
|
|
6918
|
+
};
|
|
6919
|
+
};
|
|
6920
|
+
};
|
|
6921
|
+
};
|
|
6922
|
+
"/webhooks/shopify/redactShop": {
|
|
6923
|
+
post: {
|
|
6924
|
+
responses: {
|
|
6925
|
+
/** Webhook received and verified */
|
|
6926
|
+
200: {
|
|
6927
|
+
content: {
|
|
6928
|
+
"application/json": {
|
|
6929
|
+
[key: string]: unknown;
|
|
6930
|
+
};
|
|
6931
|
+
};
|
|
6932
|
+
};
|
|
6933
|
+
/** Standard error */
|
|
6934
|
+
default: {
|
|
6935
|
+
content: {
|
|
6936
|
+
"application/json": {
|
|
6937
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
6938
|
+
code: string;
|
|
6939
|
+
/** @description A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization */
|
|
6940
|
+
title: string;
|
|
6941
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
6942
|
+
detail: string;
|
|
6943
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
6944
|
+
field?: string;
|
|
6945
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
6946
|
+
metadata?: {
|
|
6947
|
+
[key: string]: unknown;
|
|
6948
|
+
};
|
|
6949
|
+
/** @description Whether the API or user can resend the request */
|
|
6950
|
+
retryable?: boolean;
|
|
6951
|
+
} & {
|
|
6952
|
+
source: unknown;
|
|
6953
|
+
meta: unknown;
|
|
6954
|
+
};
|
|
6955
|
+
};
|
|
6956
|
+
};
|
|
6957
|
+
};
|
|
6958
|
+
requestBody: {
|
|
6959
|
+
content: {
|
|
6960
|
+
"application/json": {
|
|
6961
|
+
[key: string]: unknown;
|
|
6962
|
+
};
|
|
6963
|
+
};
|
|
6964
|
+
};
|
|
6965
|
+
};
|
|
6966
|
+
};
|
|
6102
6967
|
}
|
|
6103
6968
|
|
|
6104
6969
|
export type { paths as p };
|