@beamimpact/web-sdk 1.52.7 → 1.54.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-BXp5YnfR.esm.js +2 -0
- package/dist/chunks/{_share-dialog-dependencies-CYeOdZWi.esm.js.map → _share-dialog-dependencies-BXp5YnfR.esm.js.map} +1 -1
- package/dist/chunks/_share-dialog-dependencies-CwQxKtg2.esm.js +2 -0
- package/dist/chunks/{_share-dialog-dependencies-FmC7lLQ6.esm.js.map → _share-dialog-dependencies-CwQxKtg2.esm.js.map} +1 -1
- package/dist/chunks/cart-contents-DkoytiZh.esm.js.map +1 -1
- package/dist/chunks/{cart-contents-CUgc4y1N.esm.d.ts → cart-contents-oArgpFbi.esm.d.ts} +1 -1
- package/dist/chunks/{events-BKkf9u9l.esm.d.ts → events-D7Q2jJgz.esm.d.ts} +19 -4
- package/dist/chunks/events-DahlkyxO.esm.js +2 -0
- package/dist/chunks/{events-BohmT6Lp.esm.js.map → events-DahlkyxO.esm.js.map} +1 -1
- package/dist/chunks/index--NDbk-eE.esm.js +389 -0
- package/dist/chunks/index--NDbk-eE.esm.js.map +1 -0
- package/dist/chunks/{index-TAxKoTC1.esm.d.ts → index-1Mhh255_.esm.d.ts} +1 -1
- package/dist/chunks/{index-ChmhNz41.esm.js → index-B7ij5jz8.esm.js} +2 -2
- package/dist/chunks/index-B7ij5jz8.esm.js.map +1 -0
- package/dist/chunks/index-Bydn4zMN.esm.js +2 -0
- package/dist/chunks/index-Bydn4zMN.esm.js.map +1 -0
- package/dist/chunks/{index-Dnm34FcO.esm.d.ts → index-C-TP8NdG.esm.d.ts} +1 -1
- package/dist/chunks/{index-DkGjP-Zg.esm.js → index-C2KsnRGC.esm.js} +2 -2
- package/dist/chunks/index-C2KsnRGC.esm.js.map +1 -0
- package/dist/chunks/{index-DvbUE31b.esm.d.ts → index-CCRz-5hA.esm.d.ts} +1 -1
- package/dist/chunks/index-CIey5rKC.esm.js +2 -0
- package/dist/chunks/index-CIey5rKC.esm.js.map +1 -0
- package/dist/chunks/index-CInpKPId.esm.js +2 -0
- package/dist/chunks/index-CInpKPId.esm.js.map +1 -0
- package/dist/chunks/{index-CbKkAM6h.esm.d.ts → index-CPVMm4wx.esm.d.ts} +1 -1
- package/dist/chunks/index-CeYpLstb.esm.js +2 -0
- package/dist/chunks/index-CeYpLstb.esm.js.map +1 -0
- package/dist/chunks/{index-BqBEii8E.esm.d.ts → index-CkuCObi0.esm.d.ts} +1 -1
- package/dist/chunks/index-Co6Pvowh.esm.js +2 -0
- package/dist/chunks/index-Co6Pvowh.esm.js.map +1 -0
- package/dist/chunks/{index-ki8pLX6n.esm.d.ts → index-CuzElPMZ.esm.d.ts} +4 -4
- package/dist/chunks/index-DDNrz43j.esm.js +389 -0
- package/dist/chunks/index-DDNrz43j.esm.js.map +1 -0
- package/dist/chunks/index-DqwTVzld.esm.js +2 -0
- package/dist/chunks/index-DqwTVzld.esm.js.map +1 -0
- package/dist/chunks/index-E5gX8_N2.esm.js +2 -0
- package/dist/chunks/index-E5gX8_N2.esm.js.map +1 -0
- package/dist/chunks/index-Ls4pNA_r.esm.js +2 -0
- package/dist/chunks/index-Ls4pNA_r.esm.js.map +1 -0
- package/dist/chunks/index-MKr3f8W9.esm.js +2 -0
- package/dist/chunks/index-MKr3f8W9.esm.js.map +1 -0
- package/dist/chunks/index-XTzV546k.esm.js +2 -0
- package/dist/chunks/index-XTzV546k.esm.js.map +1 -0
- package/dist/chunks/index-ewiV_0-t.esm.js +2 -0
- package/dist/chunks/index-ewiV_0-t.esm.js.map +1 -0
- package/dist/chunks/index-rO_5zds6.esm.js +2 -0
- package/dist/chunks/index-rO_5zds6.esm.js.map +1 -0
- package/dist/chunks/{openapi-spec-VAt3phhg.esm.d.ts → openapi-spec-x9NbL7bU.esm.d.ts} +860 -199
- package/dist/chunks/order-page-CJR7GRgk.esm.js +2 -0
- package/dist/chunks/order-page-CJR7GRgk.esm.js.map +1 -0
- package/dist/chunks/order-page-CtQ9OX_A.esm.js +2 -0
- package/dist/chunks/order-page-CtQ9OX_A.esm.js.map +1 -0
- package/dist/chunks/{order-page-Cerye00Q.esm.d.ts → order-page-D_p01zgd.esm.d.ts} +3 -3
- package/dist/chunks/{promo-types-C1unMpo2.esm.d.ts → promo-types-Cz_Zkjy1.esm.d.ts} +1 -1
- package/dist/chunks/promo-types-DKAOFHJr.esm.js +2 -0
- package/dist/chunks/promo-types-DKAOFHJr.esm.js.map +1 -0
- package/dist/chunks/routes-Bw7hn3RL.esm.js +2 -0
- package/dist/chunks/routes-Bw7hn3RL.esm.js.map +1 -0
- package/dist/chunks/{routes-DDRd747e.esm.d.ts → routes-BwRUVGsk.esm.d.ts} +21 -4
- package/dist/chunks/routes-Ck-AZVsH.esm.js +2 -0
- package/dist/chunks/routes-Ck-AZVsH.esm.js.map +1 -0
- package/dist/chunks/{share-button-C2_VjXAY.esm.js → share-button-BopORXeO.esm.js} +2 -2
- package/dist/chunks/{share-button-C2_VjXAY.esm.js.map → share-button-BopORXeO.esm.js.map} +1 -1
- package/dist/chunks/{share-button-BXEwUmT4.esm.js → share-button-BupVxILq.esm.js} +2 -2
- package/dist/chunks/{share-button-CLpGIG3j.esm.js.map → share-button-BupVxILq.esm.js.map} +1 -1
- package/dist/chunks/{share-button-DVQotZGR.esm.js → share-button-G4zNdeOS.esm.js} +2 -2
- package/dist/chunks/{share-button-DVQotZGR.esm.js.map → share-button-G4zNdeOS.esm.js.map} +1 -1
- package/dist/chunks/{share-button-CLpGIG3j.esm.js → share-button-gAbnieb4.esm.js} +2 -2
- package/dist/chunks/{share-button-BXEwUmT4.esm.js.map → share-button-gAbnieb4.esm.js.map} +1 -1
- package/dist/chunks/update-cart-CmyZ_Qmv.esm.js +2 -0
- package/dist/chunks/{update-cart-BpiNvvDT.esm.js.map → update-cart-CmyZ_Qmv.esm.js.map} +1 -1
- package/dist/chunks/update-cart-DhgjSmWJ.esm.js +2 -0
- package/dist/chunks/{update-cart-DIJcb6w0.esm.js.map → update-cart-DhgjSmWJ.esm.js.map} +1 -1
- package/dist/chunks/{update-cart-NiToHHJH.esm.d.ts → update-cart-Dp0v0m4d.esm.d.ts} +1 -1
- package/dist/components/community-impact.esm.js +1 -1
- package/dist/components/community-impact.esm.js.map +1 -1
- package/dist/components/community-impact.js +1 -1
- package/dist/components/community-impact.js.map +1 -1
- package/dist/components/cumulative-impact.esm.js +1 -1
- package/dist/components/cumulative-impact.esm.js.map +1 -1
- package/dist/components/cumulative-impact.js +1 -1
- package/dist/components/cumulative-impact.js.map +1 -1
- package/dist/components/impact-overview.d.ts +3 -0
- package/dist/components/impact-overview.esm.js +35 -35
- package/dist/components/impact-overview.esm.js.map +1 -1
- package/dist/components/impact-overview.js +35 -35
- 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 +11 -89
- package/dist/components/post-purchase.esm.js +3 -2
- package/dist/components/post-purchase.esm.js.map +1 -1
- package/dist/components/post-purchase.js +3 -2
- package/dist/components/post-purchase.js.map +1 -1
- package/dist/components/product-details-page.d.ts +2 -2
- package/dist/components/product-details-page.esm.js +7 -7
- package/dist/components/product-details-page.esm.js.map +1 -1
- package/dist/components/product-details-page.js +7 -7
- package/dist/components/product-details-page.js.map +1 -1
- package/dist/components/redeem-transaction.d.ts +3 -3
- package/dist/components/redeem-transaction.esm.js +1 -388
- package/dist/components/redeem-transaction.esm.js.map +1 -1
- package/dist/components/redeem-transaction.js +1 -388
- package/dist/components/redeem-transaction.js.map +1 -1
- package/dist/components/select-nonprofit.d.ts +4 -3
- package/dist/components/select-nonprofit.esm.js +22 -22
- package/dist/components/select-nonprofit.esm.js.map +1 -1
- package/dist/components/select-nonprofit.js +22 -22
- package/dist/components/select-nonprofit.js.map +1 -1
- package/dist/components/select-subscription-nonprofit.d.ts +1 -1
- package/dist/components/select-subscription-nonprofit.esm.js +16 -16
- package/dist/components/select-subscription-nonprofit.esm.js.map +1 -1
- package/dist/components/select-subscription-nonprofit.js +16 -16
- package/dist/components/select-subscription-nonprofit.js.map +1 -1
- package/dist/components/shopify.d.ts +7 -7
- package/dist/components/shopify.esm.js +1 -1
- package/dist/components/shopify.esm.js.map +1 -1
- package/dist/components/shopify.js +1 -1
- package/dist/components/shopify.js.map +1 -1
- package/dist/components/social-share.esm.js +1 -1
- package/dist/components/social-share.esm.js.map +1 -1
- package/dist/components/social-share.js +1 -1
- package/dist/components/social-share.js.map +1 -1
- package/dist/components/subscription-impact.d.ts +4 -1
- package/dist/components/subscription-impact.esm.js +14 -14
- package/dist/components/subscription-impact.esm.js.map +1 -1
- package/dist/components/subscription-impact.js +14 -14
- package/dist/components/subscription-impact.js.map +1 -1
- package/dist/components/subscription-management.d.ts +17 -4
- package/dist/components/subscription-management.esm.js +18 -18
- package/dist/components/subscription-management.esm.js.map +1 -1
- package/dist/components/subscription-management.js +18 -18
- package/dist/components/subscription-management.js.map +1 -1
- package/dist/index.d.ts +13 -13
- 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.esm.js.map +1 -1
- package/dist/integrations/beam.js +1 -1
- package/dist/integrations/beam.js.map +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 +11 -11
- 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/promoManager.esm.js +1 -1
- package/dist/integrations/promoManager.esm.js.map +1 -1
- package/dist/integrations/promoManager.js +1 -1
- package/dist/integrations/promoManager.js.map +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.esm.js.map +1 -1
- package/dist/integrations/statsig.js +1 -1
- package/dist/integrations/statsig.js.map +1 -1
- package/dist/integrations/utils.d.ts +4 -4
- package/dist/integrations/utils.esm.js +1 -1
- package/dist/integrations/utils.js +1 -1
- package/dist/react/community-impact.esm.js +1 -1
- package/dist/react/community-impact.esm.js.map +1 -1
- package/dist/react/community-impact.js +1 -1
- package/dist/react/community-impact.js.map +1 -1
- package/dist/react/cumulative-impact.esm.js +1 -1
- package/dist/react/cumulative-impact.esm.js.map +1 -1
- package/dist/react/cumulative-impact.js +1 -1
- package/dist/react/cumulative-impact.js.map +1 -1
- package/dist/react/impact-overview.esm.js +1 -1
- package/dist/react/impact-overview.esm.js.map +1 -1
- package/dist/react/impact-overview.js +1 -1
- package/dist/react/impact-overview.js.map +1 -1
- package/dist/react/index.d.ts +5 -5
- 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.esm.js.map +1 -1
- package/dist/react/post-purchase.js +1 -1
- package/dist/react/post-purchase.js.map +1 -1
- package/dist/react/product-details-page.d.ts +1 -1
- package/dist/react/product-details-page.esm.js +1 -1
- package/dist/react/product-details-page.esm.js.map +1 -1
- package/dist/react/product-details-page.js +1 -1
- package/dist/react/product-details-page.js.map +1 -1
- package/dist/react/redeem-transaction.d.ts +4 -4
- package/dist/react/redeem-transaction.esm.js +1 -1
- package/dist/react/redeem-transaction.esm.js.map +1 -1
- package/dist/react/redeem-transaction.js +1 -1
- package/dist/react/redeem-transaction.js.map +1 -1
- package/dist/react/select-nonprofit.d.ts +4 -4
- package/dist/react/select-nonprofit.esm.js +1 -1
- package/dist/react/select-nonprofit.esm.js.map +1 -1
- package/dist/react/select-nonprofit.js +1 -1
- package/dist/react/select-nonprofit.js.map +1 -1
- package/dist/react/select-subscription-nonprofit.d.ts +4 -4
- package/dist/react/select-subscription-nonprofit.esm.js +1 -1
- package/dist/react/select-subscription-nonprofit.esm.js.map +1 -1
- package/dist/react/select-subscription-nonprofit.js +1 -1
- package/dist/react/select-subscription-nonprofit.js.map +1 -1
- package/dist/react/social-share.esm.js +1 -1
- package/dist/react/social-share.esm.js.map +1 -1
- package/dist/react/social-share.js +1 -1
- package/dist/react/social-share.js.map +1 -1
- package/dist/react/subscription-impact.esm.js +1 -1
- package/dist/react/subscription-impact.esm.js.map +1 -1
- package/dist/react/subscription-impact.js +1 -1
- package/dist/react/subscription-impact.js.map +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.esm.js.map +1 -1
- package/dist/react/subscription-management.js +1 -1
- package/dist/react/subscription-management.js.map +1 -1
- package/dist/utils/events.d.ts +4 -4
- package/dist/utils/events.esm.js +1 -1
- package/dist/utils/events.js +1 -1
- package/dist/utils/index.d.ts +4 -4
- package/dist/utils/index.esm.js +1 -1
- package/dist/utils/index.js +1 -1
- package/dist/utils/network-listeners.esm.js +1 -1
- package/dist/utils/network-listeners.js +1 -1
- package/dist/utils/promoManager.d.ts +3 -3
- package/dist/utils/promoManager.esm.js +1 -1
- package/dist/utils/promoManager.esm.js.map +1 -1
- package/dist/utils/promoManager.js +1 -1
- package/dist/utils/promoManager.js.map +1 -1
- package/package.json +2 -2
- package/dist/chunks/_share-dialog-dependencies-CYeOdZWi.esm.js +0 -2
- package/dist/chunks/_share-dialog-dependencies-FmC7lLQ6.esm.js +0 -2
- package/dist/chunks/events-BohmT6Lp.esm.js +0 -2
- package/dist/chunks/index-9s_WWt_5.esm.js +0 -2
- package/dist/chunks/index-9s_WWt_5.esm.js.map +0 -1
- package/dist/chunks/index-AEnQH-so.esm.js +0 -2
- package/dist/chunks/index-AEnQH-so.esm.js.map +0 -1
- package/dist/chunks/index-B-4isAGW.esm.js +0 -2
- package/dist/chunks/index-B-4isAGW.esm.js.map +0 -1
- package/dist/chunks/index-Bp28pZSn.esm.js +0 -2
- package/dist/chunks/index-Bp28pZSn.esm.js.map +0 -1
- package/dist/chunks/index-CFtmDAHb.esm.js +0 -2
- package/dist/chunks/index-CFtmDAHb.esm.js.map +0 -1
- package/dist/chunks/index-CL7fWjz1.esm.js +0 -2
- package/dist/chunks/index-CL7fWjz1.esm.js.map +0 -1
- package/dist/chunks/index-CfgpHhN1.esm.js +0 -2
- package/dist/chunks/index-CfgpHhN1.esm.js.map +0 -1
- package/dist/chunks/index-ChmhNz41.esm.js.map +0 -1
- package/dist/chunks/index-CtYbieoH.esm.js +0 -2
- package/dist/chunks/index-CtYbieoH.esm.js.map +0 -1
- package/dist/chunks/index-DhhPQ773.esm.js +0 -2
- package/dist/chunks/index-DhhPQ773.esm.js.map +0 -1
- package/dist/chunks/index-DkGjP-Zg.esm.js.map +0 -1
- package/dist/chunks/index-DrOeOk1M.esm.js +0 -2
- package/dist/chunks/index-DrOeOk1M.esm.js.map +0 -1
- package/dist/chunks/index-DtfQd6C4.esm.js +0 -2
- package/dist/chunks/index-DtfQd6C4.esm.js.map +0 -1
- package/dist/chunks/index-oGObXjk6.esm.js +0 -2
- package/dist/chunks/index-oGObXjk6.esm.js.map +0 -1
- package/dist/chunks/order-page-BPm0hcsC.esm.js +0 -2
- package/dist/chunks/order-page-BPm0hcsC.esm.js.map +0 -1
- package/dist/chunks/order-page-DFtCsDYa.esm.js +0 -2
- package/dist/chunks/order-page-DFtCsDYa.esm.js.map +0 -1
- package/dist/chunks/promoManager-B9cTR1R3.esm.js +0 -2
- package/dist/chunks/promoManager-B9cTR1R3.esm.js.map +0 -1
- package/dist/chunks/promoManager-fl54hq13.esm.js +0 -2
- package/dist/chunks/promoManager-fl54hq13.esm.js.map +0 -1
- package/dist/chunks/routes-Dl-QWRUP.esm.js +0 -2
- package/dist/chunks/routes-Dl-QWRUP.esm.js.map +0 -1
- package/dist/chunks/routes-VlLXqb7P.esm.js +0 -2
- package/dist/chunks/routes-VlLXqb7P.esm.js.map +0 -1
- package/dist/chunks/update-cart-BpiNvvDT.esm.js +0 -2
- package/dist/chunks/update-cart-DIJcb6w0.esm.js +0 -2
|
@@ -293,6 +293,17 @@ interface paths {
|
|
|
293
293
|
apply: boolean;
|
|
294
294
|
}[];
|
|
295
295
|
};
|
|
296
|
+
/** @description Extensibility-related settings */
|
|
297
|
+
extensibility?: {
|
|
298
|
+
/**
|
|
299
|
+
* @description Whether to exclude B2B orders from reporting and from seeing Beam widgets
|
|
300
|
+
* @example true
|
|
301
|
+
*/
|
|
302
|
+
excludeB2BOrders?: boolean;
|
|
303
|
+
};
|
|
304
|
+
settings?: {
|
|
305
|
+
excludeDonationsForRecurringTransactions: boolean;
|
|
306
|
+
};
|
|
296
307
|
};
|
|
297
308
|
};
|
|
298
309
|
};
|
|
@@ -845,6 +856,17 @@ interface paths {
|
|
|
845
856
|
apply: boolean;
|
|
846
857
|
}[];
|
|
847
858
|
};
|
|
859
|
+
/** @description Extensibility-related settings */
|
|
860
|
+
extensibility?: {
|
|
861
|
+
/**
|
|
862
|
+
* @description Whether to exclude B2B orders from reporting and from seeing Beam widgets
|
|
863
|
+
* @example true
|
|
864
|
+
*/
|
|
865
|
+
excludeB2BOrders?: boolean;
|
|
866
|
+
};
|
|
867
|
+
settings?: {
|
|
868
|
+
excludeDonationsForRecurringTransactions: boolean;
|
|
869
|
+
};
|
|
848
870
|
};
|
|
849
871
|
};
|
|
850
872
|
};
|
|
@@ -1077,6 +1099,8 @@ interface paths {
|
|
|
1077
1099
|
discountCodes?: string[];
|
|
1078
1100
|
/** The transactionId of the purchase */
|
|
1079
1101
|
transactionId?: string;
|
|
1102
|
+
/** The id of the user in the partner's system */
|
|
1103
|
+
partnerUserId?: string;
|
|
1080
1104
|
};
|
|
1081
1105
|
};
|
|
1082
1106
|
responses: {
|
|
@@ -1427,6 +1451,9 @@ interface paths {
|
|
|
1427
1451
|
} | null;
|
|
1428
1452
|
promoAssetUrl: string | null;
|
|
1429
1453
|
personalImpactAssetUrl: string | null;
|
|
1454
|
+
settings?: {
|
|
1455
|
+
excludeDonationsForRecurringTransactions: boolean;
|
|
1456
|
+
};
|
|
1430
1457
|
};
|
|
1431
1458
|
};
|
|
1432
1459
|
};
|
|
@@ -1807,6 +1834,9 @@ interface paths {
|
|
|
1807
1834
|
} | null;
|
|
1808
1835
|
promoAssetUrl: string | null;
|
|
1809
1836
|
personalImpactAssetUrl: string | null;
|
|
1837
|
+
settings?: {
|
|
1838
|
+
excludeDonationsForRecurringTransactions: boolean;
|
|
1839
|
+
};
|
|
1810
1840
|
};
|
|
1811
1841
|
};
|
|
1812
1842
|
};
|
|
@@ -2114,6 +2144,8 @@ interface paths {
|
|
|
2114
2144
|
*/
|
|
2115
2145
|
chainId: number;
|
|
2116
2146
|
nonprofitId: number | (number | null);
|
|
2147
|
+
/** @default */
|
|
2148
|
+
creationMethod?: string;
|
|
2117
2149
|
impact?: {
|
|
2118
2150
|
personal?: {
|
|
2119
2151
|
/**
|
|
@@ -2348,6 +2380,22 @@ interface paths {
|
|
|
2348
2380
|
} | null;
|
|
2349
2381
|
};
|
|
2350
2382
|
};
|
|
2383
|
+
/** @description Extensibility-related settings */
|
|
2384
|
+
extensibility?: {
|
|
2385
|
+
/**
|
|
2386
|
+
* @description Whether to exclude B2B orders from reporting and from seeing Beam widgets
|
|
2387
|
+
* @example true
|
|
2388
|
+
*/
|
|
2389
|
+
excludeB2BOrders?: boolean;
|
|
2390
|
+
};
|
|
2391
|
+
/** @description Report Settings */
|
|
2392
|
+
reportSettings?: {
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Whether to exclude donations on recurring transactions
|
|
2395
|
+
* @example true
|
|
2396
|
+
*/
|
|
2397
|
+
excludeRecurringDonations?: boolean;
|
|
2398
|
+
};
|
|
2351
2399
|
};
|
|
2352
2400
|
};
|
|
2353
2401
|
};
|
|
@@ -2378,6 +2426,8 @@ interface paths {
|
|
|
2378
2426
|
*/
|
|
2379
2427
|
chainId: number;
|
|
2380
2428
|
nonprofitId: number | (number | null);
|
|
2429
|
+
/** @default */
|
|
2430
|
+
creationMethod?: string;
|
|
2381
2431
|
impact?: {
|
|
2382
2432
|
personal?: {
|
|
2383
2433
|
/**
|
|
@@ -2612,6 +2662,22 @@ interface paths {
|
|
|
2612
2662
|
} | null;
|
|
2613
2663
|
};
|
|
2614
2664
|
};
|
|
2665
|
+
/** @description Extensibility-related settings */
|
|
2666
|
+
extensibility?: {
|
|
2667
|
+
/**
|
|
2668
|
+
* @description Whether to exclude B2B orders from reporting and from seeing Beam widgets
|
|
2669
|
+
* @example true
|
|
2670
|
+
*/
|
|
2671
|
+
excludeB2BOrders?: boolean;
|
|
2672
|
+
};
|
|
2673
|
+
/** @description Report Settings */
|
|
2674
|
+
reportSettings?: {
|
|
2675
|
+
/**
|
|
2676
|
+
* @description Whether to exclude donations on recurring transactions
|
|
2677
|
+
* @example true
|
|
2678
|
+
*/
|
|
2679
|
+
excludeRecurringDonations?: boolean;
|
|
2680
|
+
};
|
|
2615
2681
|
};
|
|
2616
2682
|
};
|
|
2617
2683
|
};
|
|
@@ -2808,17 +2874,17 @@ interface paths {
|
|
|
2808
2874
|
};
|
|
2809
2875
|
remoteSessionId?: string;
|
|
2810
2876
|
options?: {
|
|
2877
|
+
config?: {
|
|
2878
|
+
/** @description Removes the themes object from the remote config object in the response. */
|
|
2879
|
+
omitThemes?: boolean;
|
|
2880
|
+
draftConfig?: boolean;
|
|
2881
|
+
};
|
|
2811
2882
|
response?: {
|
|
2812
2883
|
/** @description Returns the user's overall impact toward the given nonprofit. */
|
|
2813
2884
|
personalImpact?: boolean;
|
|
2814
2885
|
/** @description Returns the community's overall impact toward the given nonprofit. */
|
|
2815
2886
|
communityImpact?: boolean;
|
|
2816
2887
|
};
|
|
2817
|
-
config?: {
|
|
2818
|
-
/** @description Removes the themes object from the remote config object in the response. */
|
|
2819
|
-
omitThemes?: boolean;
|
|
2820
|
-
draftConfig?: boolean;
|
|
2821
|
-
};
|
|
2822
2888
|
};
|
|
2823
2889
|
/** @enum {string} */
|
|
2824
2890
|
widgetName?: "select-nonprofit" | "redeem-transaction" | "select-nonprofit-cta";
|
|
@@ -3510,128 +3576,36 @@ interface paths {
|
|
|
3510
3576
|
};
|
|
3511
3577
|
};
|
|
3512
3578
|
};
|
|
3513
|
-
"/
|
|
3514
|
-
post: {
|
|
3515
|
-
responses: {
|
|
3516
|
-
/** Subscription updated */
|
|
3517
|
-
200: unknown;
|
|
3518
|
-
};
|
|
3519
|
-
requestBody: {
|
|
3520
|
-
content: {
|
|
3521
|
-
"application/json": {
|
|
3522
|
-
/** @description Id derived from partner services. Not the Beam subscription ID. */
|
|
3523
|
-
remoteSubscriptionId: string;
|
|
3524
|
-
nonprofitId: number | null;
|
|
3525
|
-
/** @enum {string|null} */
|
|
3526
|
-
selectionMethod?: ("dashboard" | "remote_order" | "checkout" | "subscription_management_widget") | null;
|
|
3527
|
-
};
|
|
3528
|
-
};
|
|
3529
|
-
};
|
|
3530
|
-
};
|
|
3531
|
-
};
|
|
3532
|
-
"/subscriptions/cancelSubscription": {
|
|
3533
|
-
post: {
|
|
3534
|
-
responses: {
|
|
3535
|
-
/** Subscription updated */
|
|
3536
|
-
200: unknown;
|
|
3537
|
-
};
|
|
3538
|
-
requestBody: {
|
|
3539
|
-
content: {
|
|
3540
|
-
"application/json": {
|
|
3541
|
-
/** @description Id derived from partner services. Not the Beam subscription ID. */
|
|
3542
|
-
remoteSubscriptionId: string;
|
|
3543
|
-
};
|
|
3544
|
-
};
|
|
3545
|
-
};
|
|
3546
|
-
};
|
|
3547
|
-
};
|
|
3548
|
-
"/subscriptions/findOrCreateSubscription": {
|
|
3579
|
+
"/v4/transaction": {
|
|
3549
3580
|
post: {
|
|
3550
3581
|
responses: {
|
|
3551
|
-
/**
|
|
3552
|
-
|
|
3582
|
+
/** Transaction that was either created or existing */
|
|
3583
|
+
201: {
|
|
3553
3584
|
content: {
|
|
3554
3585
|
"application/json": {
|
|
3586
|
+
transactionId: string;
|
|
3587
|
+
transactionCreated: boolean;
|
|
3555
3588
|
beamUserId: string;
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3589
|
+
nonprofitId: number | null;
|
|
3590
|
+
/** @description Report Settings */
|
|
3591
|
+
reportSettings?: {
|
|
3559
3592
|
/**
|
|
3560
|
-
* @description
|
|
3561
|
-
* @
|
|
3593
|
+
* @description Whether to exclude donations on recurring transactions
|
|
3594
|
+
* @default false
|
|
3595
|
+
* @example true
|
|
3562
3596
|
*/
|
|
3563
|
-
|
|
3564
|
-
} | null;
|
|
3565
|
-
};
|
|
3566
|
-
};
|
|
3567
|
-
};
|
|
3568
|
-
/** Standard error */
|
|
3569
|
-
default: {
|
|
3570
|
-
content: {
|
|
3571
|
-
"application/json": {
|
|
3572
|
-
/** @description Beam code for the error, meant to be used programmatically */
|
|
3573
|
-
code: string;
|
|
3574
|
-
/** @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 */
|
|
3575
|
-
title: string;
|
|
3576
|
-
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
3577
|
-
detail: string;
|
|
3578
|
-
/** @description a JSON Pointer to the associated entity in the request document */
|
|
3579
|
-
field?: string;
|
|
3580
|
-
/** @description A meta object containing non-standard meta-information about the error */
|
|
3581
|
-
metadata?: {
|
|
3582
|
-
[key: string]: unknown;
|
|
3597
|
+
excludeRecurringDonations?: boolean;
|
|
3583
3598
|
};
|
|
3584
|
-
/** @description
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
content: {
|
|
3595
|
-
"application/json": ({
|
|
3596
|
-
remoteSubscriptionId: string;
|
|
3597
|
-
options?: {
|
|
3598
|
-
disableDefaultToUniversalSubscriptionIfNotFound?: boolean;
|
|
3599
|
-
};
|
|
3600
|
-
} & {
|
|
3601
|
-
[key: string]: unknown;
|
|
3602
|
-
}) & (Partial<{
|
|
3603
|
-
partnerUserId: string;
|
|
3604
|
-
}> & Partial<{
|
|
3605
|
-
email: string;
|
|
3606
|
-
}>);
|
|
3607
|
-
};
|
|
3608
|
-
};
|
|
3609
|
-
};
|
|
3610
|
-
};
|
|
3611
|
-
"/selectNonprofit": {
|
|
3612
|
-
post: {
|
|
3613
|
-
responses: {
|
|
3614
|
-
/** Existing selection updated OK */
|
|
3615
|
-
200: {
|
|
3616
|
-
content: {
|
|
3617
|
-
"application/json": {
|
|
3618
|
-
/**
|
|
3619
|
-
* @description UUID
|
|
3620
|
-
* @example bqkdk-0393b-jbkdd-02difj
|
|
3621
|
-
*/
|
|
3622
|
-
selectionId: string;
|
|
3623
|
-
};
|
|
3624
|
-
};
|
|
3625
|
-
};
|
|
3626
|
-
/** New selection created OK */
|
|
3627
|
-
201: {
|
|
3628
|
-
content: {
|
|
3629
|
-
"application/json": {
|
|
3630
|
-
/**
|
|
3631
|
-
* @description UUID
|
|
3632
|
-
* @example bqkdk-0393b-jbkdd-02difj
|
|
3633
|
-
*/
|
|
3634
|
-
selectionId: string;
|
|
3599
|
+
/** @description Extensibility-related settings */
|
|
3600
|
+
extensibility?: {
|
|
3601
|
+
/**
|
|
3602
|
+
* @description Whether to exclude B2B orders from reporting and from seeing Beam widgets
|
|
3603
|
+
* @example true
|
|
3604
|
+
*/
|
|
3605
|
+
excludeB2BOrders?: boolean;
|
|
3606
|
+
};
|
|
3607
|
+
/** @default */
|
|
3608
|
+
creationMethod?: string;
|
|
3635
3609
|
};
|
|
3636
3610
|
};
|
|
3637
3611
|
};
|
|
@@ -3663,97 +3637,782 @@ interface paths {
|
|
|
3663
3637
|
requestBody: {
|
|
3664
3638
|
content: {
|
|
3665
3639
|
"application/json": {
|
|
3666
|
-
|
|
3640
|
+
/** @description The partner's order ID */
|
|
3641
|
+
orderId: string | number;
|
|
3667
3642
|
/**
|
|
3668
|
-
*
|
|
3669
|
-
* @
|
|
3643
|
+
* @description The ID of the store
|
|
3644
|
+
* @example 1001
|
|
3670
3645
|
*/
|
|
3671
|
-
|
|
3672
|
-
/** @description Cart ID from partner site */
|
|
3673
|
-
cartId?: string;
|
|
3646
|
+
storeId?: number;
|
|
3674
3647
|
/**
|
|
3675
|
-
* @description
|
|
3648
|
+
* @description The ID of the selection
|
|
3649
|
+
* @example bqkdk-0393b-jbkdd-02difj
|
|
3650
|
+
*/
|
|
3651
|
+
selectionId?: string;
|
|
3652
|
+
/**
|
|
3653
|
+
* @description Beam generated cart id if exists
|
|
3676
3654
|
* @example bqkdk-0393b-jbkdd-02difj
|
|
3677
3655
|
*/
|
|
3678
3656
|
beamCartId?: string;
|
|
3679
|
-
/** @description
|
|
3680
|
-
|
|
3681
|
-
/** @description
|
|
3682
|
-
|
|
3657
|
+
/** @description (externalCartId) Unique identifier for the cart provided by partner. */
|
|
3658
|
+
cartId?: string;
|
|
3659
|
+
/** @description Email of the user. Required if partner user ID are not provided */
|
|
3660
|
+
email?: string;
|
|
3661
|
+
/** @description The user ID of the partner. Required if email are not provided */
|
|
3662
|
+
partnerUserId?: string;
|
|
3663
|
+
/** @description ISO currency code */
|
|
3664
|
+
currencyCode: string;
|
|
3683
3665
|
/** @example 10292 */
|
|
3684
3666
|
postalCode?: string;
|
|
3685
3667
|
/** @example US */
|
|
3686
3668
|
countryCode?: string;
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
"/getLastSelectedNonprofit": {
|
|
3695
|
-
get: {
|
|
3696
|
-
parameters: {
|
|
3697
|
-
query: {
|
|
3698
|
-
beamUserId: string;
|
|
3699
|
-
};
|
|
3700
|
-
};
|
|
3701
|
-
responses: {
|
|
3702
|
-
/** Retrieved user's last selected nonprofit. */
|
|
3703
|
-
200: {
|
|
3704
|
-
content: {
|
|
3705
|
-
"application/json": {
|
|
3706
|
-
/** @description ID of last selected nonprofit */
|
|
3707
|
-
nonprofitId: number;
|
|
3708
|
-
};
|
|
3709
|
-
};
|
|
3710
|
-
};
|
|
3711
|
-
/** Standard error */
|
|
3712
|
-
default: {
|
|
3713
|
-
content: {
|
|
3714
|
-
"application/json": {
|
|
3715
|
-
/** @description Beam code for the error, meant to be used programmatically */
|
|
3716
|
-
code: string;
|
|
3717
|
-
/** @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 */
|
|
3718
|
-
title: string;
|
|
3719
|
-
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
3720
|
-
detail: string;
|
|
3721
|
-
/** @description a JSON Pointer to the associated entity in the request document */
|
|
3722
|
-
field?: string;
|
|
3723
|
-
/** @description A meta object containing non-standard meta-information about the error */
|
|
3724
|
-
metadata?: {
|
|
3725
|
-
[key: string]: unknown;
|
|
3669
|
+
cart?: {
|
|
3670
|
+
schema: {
|
|
3671
|
+
/** @enum {string} */
|
|
3672
|
+
source: "shopify";
|
|
3673
|
+
/** @enum {string} */
|
|
3674
|
+
variant: "ajax";
|
|
3675
|
+
version?: string;
|
|
3726
3676
|
};
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
|
|
3747
|
-
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
|
|
3751
|
-
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
3756
|
-
|
|
3677
|
+
content: {
|
|
3678
|
+
localAmount?: number;
|
|
3679
|
+
/** @description Order or cart level discounts */
|
|
3680
|
+
discounts?: {
|
|
3681
|
+
/** @description The code for the discount */
|
|
3682
|
+
code: string;
|
|
3683
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
3684
|
+
applicable: boolean;
|
|
3685
|
+
}[] | null;
|
|
3686
|
+
items: {
|
|
3687
|
+
id?: number | null;
|
|
3688
|
+
gift_card?: boolean | null;
|
|
3689
|
+
/** @description Price for line item (qty * unit price), after discounts, in integer cents format (3.50 => 350) */
|
|
3690
|
+
final_line_price: number | null;
|
|
3691
|
+
/** @description Unit price for line item, in integer cents format (3.50 => 350) */
|
|
3692
|
+
final_price?: number | null;
|
|
3693
|
+
/** @description Line item discounts */
|
|
3694
|
+
line_level_discount_applications?: ({
|
|
3695
|
+
/** @description The code for the discount */
|
|
3696
|
+
title: string;
|
|
3697
|
+
} & {
|
|
3698
|
+
[key: string]: unknown;
|
|
3699
|
+
})[] | null;
|
|
3700
|
+
quantity?: number | null;
|
|
3701
|
+
sku: string | null;
|
|
3702
|
+
product_id?: number | null;
|
|
3703
|
+
product_title?: string | null;
|
|
3704
|
+
product_type?: string | null;
|
|
3705
|
+
variant_id?: number | null;
|
|
3706
|
+
}[];
|
|
3707
|
+
subscriptions?: {
|
|
3708
|
+
remoteSubscriptionId: string;
|
|
3709
|
+
isNew?: boolean;
|
|
3710
|
+
}[];
|
|
3711
|
+
};
|
|
3712
|
+
} | {
|
|
3713
|
+
schema: {
|
|
3714
|
+
/** @enum {string} */
|
|
3715
|
+
source: "shopify";
|
|
3716
|
+
/** @enum {string} */
|
|
3717
|
+
variant: "liquid";
|
|
3718
|
+
version?: string;
|
|
3719
|
+
};
|
|
3720
|
+
content: {
|
|
3721
|
+
localAmount?: number;
|
|
3722
|
+
/** @description Order or cart level discounts */
|
|
3723
|
+
discounts?: {
|
|
3724
|
+
/** @description The code for the discount */
|
|
3725
|
+
code: string;
|
|
3726
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
3727
|
+
applicable: boolean;
|
|
3728
|
+
}[] | null;
|
|
3729
|
+
items: {
|
|
3730
|
+
id?: number | null;
|
|
3731
|
+
gift_card?: boolean | null;
|
|
3732
|
+
/** @description Price for line item (qty * unit price), after discounts, in decimal format (3.50) */
|
|
3733
|
+
final_line_price: number | null;
|
|
3734
|
+
/** @description Unit price for line item in decimal format (3.50) */
|
|
3735
|
+
final_price?: number | null;
|
|
3736
|
+
/** @description Line item discounts */
|
|
3737
|
+
line_level_discount_applications?: ({
|
|
3738
|
+
/** @description The code for the discount */
|
|
3739
|
+
title: string;
|
|
3740
|
+
} & {
|
|
3741
|
+
[key: string]: unknown;
|
|
3742
|
+
})[] | null;
|
|
3743
|
+
quantity?: number | null;
|
|
3744
|
+
sku: string | null;
|
|
3745
|
+
product_id?: number | null;
|
|
3746
|
+
variant_id?: number | null;
|
|
3747
|
+
}[];
|
|
3748
|
+
subscriptions?: {
|
|
3749
|
+
remoteSubscriptionId: string;
|
|
3750
|
+
isNew?: boolean;
|
|
3751
|
+
}[];
|
|
3752
|
+
};
|
|
3753
|
+
} | {
|
|
3754
|
+
schema: {
|
|
3755
|
+
/**
|
|
3756
|
+
* @default generic
|
|
3757
|
+
* @enum {string}
|
|
3758
|
+
*/
|
|
3759
|
+
source: "generic";
|
|
3760
|
+
/** @enum {string} */
|
|
3761
|
+
variant?: "default";
|
|
3762
|
+
version?: string;
|
|
3763
|
+
};
|
|
3764
|
+
content: {
|
|
3765
|
+
localAmount?: number;
|
|
3766
|
+
/** @description Order or cart level discounts */
|
|
3767
|
+
discounts?: {
|
|
3768
|
+
/** @description The code for the discount */
|
|
3769
|
+
code: string;
|
|
3770
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
3771
|
+
applicable: boolean;
|
|
3772
|
+
}[] | null;
|
|
3773
|
+
items: {
|
|
3774
|
+
remoteProductIdentifier?: string | null;
|
|
3775
|
+
localAmount: number;
|
|
3776
|
+
remoteSubscriptionId?: string;
|
|
3777
|
+
/** @description Line item discounts */
|
|
3778
|
+
discounts?: {
|
|
3779
|
+
/** @description The code for the discount */
|
|
3780
|
+
code: string;
|
|
3781
|
+
/** @description Whether the discount code is applicable to the current order, cart, or item */
|
|
3782
|
+
applicable: boolean;
|
|
3783
|
+
}[] | null;
|
|
3784
|
+
}[];
|
|
3785
|
+
subscriptions?: {
|
|
3786
|
+
remoteSubscriptionId: string;
|
|
3787
|
+
isNew?: boolean;
|
|
3788
|
+
}[];
|
|
3789
|
+
};
|
|
3790
|
+
};
|
|
3791
|
+
remoteSessionId?: string;
|
|
3792
|
+
donation?: {
|
|
3793
|
+
currencyCode: string;
|
|
3794
|
+
/** @example 1.25 */
|
|
3795
|
+
amount: number;
|
|
3796
|
+
};
|
|
3797
|
+
/** @description The amount in the cart */
|
|
3798
|
+
cartTotal?: number;
|
|
3799
|
+
discountCodes?: string[];
|
|
3800
|
+
promos?: {
|
|
3801
|
+
unvalidatedPromoCodes: (Partial<{
|
|
3802
|
+
/** @enum {string} */
|
|
3803
|
+
type?: "manual" | "url";
|
|
3804
|
+
} & {
|
|
3805
|
+
attributes?: {
|
|
3806
|
+
value?: string;
|
|
3807
|
+
};
|
|
3808
|
+
}> & Partial<{
|
|
3809
|
+
/** @enum {string} */
|
|
3810
|
+
type?: "manual" | "url";
|
|
3811
|
+
} & {
|
|
3812
|
+
attributes?: {
|
|
3813
|
+
url?: string;
|
|
3814
|
+
};
|
|
3815
|
+
}>)[];
|
|
3816
|
+
validatedPromoCodes: {
|
|
3817
|
+
/** @description promoCodeId */
|
|
3818
|
+
promoCodeId: string | null;
|
|
3819
|
+
promoCodeGroupId?: string | null;
|
|
3820
|
+
promoId?: number;
|
|
3821
|
+
/**
|
|
3822
|
+
* Format: date-time
|
|
3823
|
+
* @description ISO formatted date
|
|
3824
|
+
* @example 2023-04-19T03:23:59.301Z
|
|
3825
|
+
*/
|
|
3826
|
+
validatedAt: string;
|
|
3827
|
+
apply: boolean;
|
|
3828
|
+
}[];
|
|
3829
|
+
};
|
|
3830
|
+
};
|
|
3831
|
+
};
|
|
3832
|
+
};
|
|
3833
|
+
};
|
|
3834
|
+
};
|
|
3835
|
+
"/v4/transaction/redeem/{transactionId}": {
|
|
3836
|
+
put: {
|
|
3837
|
+
parameters: {
|
|
3838
|
+
path: {
|
|
3839
|
+
transactionId: string;
|
|
3840
|
+
};
|
|
3841
|
+
};
|
|
3842
|
+
responses: {
|
|
3843
|
+
/** The redeemed transaction */
|
|
3844
|
+
200: {
|
|
3845
|
+
content: {
|
|
3846
|
+
"application/json": {
|
|
3847
|
+
transactionId: string;
|
|
3848
|
+
beamUserId: string;
|
|
3849
|
+
nonprofitId: number | null;
|
|
3850
|
+
};
|
|
3851
|
+
};
|
|
3852
|
+
};
|
|
3853
|
+
/** Standard error */
|
|
3854
|
+
default: {
|
|
3855
|
+
content: {
|
|
3856
|
+
"application/json": {
|
|
3857
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
3858
|
+
code: string;
|
|
3859
|
+
/** @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 */
|
|
3860
|
+
title: string;
|
|
3861
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
3862
|
+
detail: string;
|
|
3863
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
3864
|
+
field?: string;
|
|
3865
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
3866
|
+
metadata?: {
|
|
3867
|
+
[key: string]: unknown;
|
|
3868
|
+
};
|
|
3869
|
+
/** @description Whether the API or user can resend the request */
|
|
3870
|
+
retryable?: boolean;
|
|
3871
|
+
} & {
|
|
3872
|
+
source: unknown;
|
|
3873
|
+
meta: unknown;
|
|
3874
|
+
};
|
|
3875
|
+
};
|
|
3876
|
+
};
|
|
3877
|
+
};
|
|
3878
|
+
requestBody: {
|
|
3879
|
+
content: {
|
|
3880
|
+
"application/json": {
|
|
3881
|
+
nonprofitId: number;
|
|
3882
|
+
};
|
|
3883
|
+
};
|
|
3884
|
+
};
|
|
3885
|
+
};
|
|
3886
|
+
};
|
|
3887
|
+
"/v4/transaction/impact/{transactionId}": {
|
|
3888
|
+
get: {
|
|
3889
|
+
parameters: {
|
|
3890
|
+
path: {
|
|
3891
|
+
transactionId: string;
|
|
3892
|
+
};
|
|
3893
|
+
query: {
|
|
3894
|
+
includeExtensibility?: boolean;
|
|
3895
|
+
widgetName: string;
|
|
3896
|
+
version: string;
|
|
3897
|
+
/** Language code. */
|
|
3898
|
+
lang?: "en" | "fr" | "de" | "es" | "it" | "pl";
|
|
3899
|
+
/** When set to true, draft themes are returned */
|
|
3900
|
+
draftConfig?: boolean;
|
|
3901
|
+
};
|
|
3902
|
+
};
|
|
3903
|
+
responses: {
|
|
3904
|
+
/** The impact from the transaction */
|
|
3905
|
+
200: {
|
|
3906
|
+
content: {
|
|
3907
|
+
"application/json": {
|
|
3908
|
+
transactionId: string;
|
|
3909
|
+
beamUserId: string;
|
|
3910
|
+
impact: {
|
|
3911
|
+
personalImpact: {
|
|
3912
|
+
nonprofit: {
|
|
3913
|
+
name: string;
|
|
3914
|
+
causeIconUrl: string | null;
|
|
3915
|
+
causeIconSelectedUrl: string | null;
|
|
3916
|
+
causeIconAndBackground: string | null;
|
|
3917
|
+
website: string;
|
|
3918
|
+
};
|
|
3919
|
+
description: string;
|
|
3920
|
+
/**
|
|
3921
|
+
* @description The progress towards the goal for the nonprofit and brand
|
|
3922
|
+
* @example 70% Funded
|
|
3923
|
+
*/
|
|
3924
|
+
goalProgressText: string;
|
|
3925
|
+
/**
|
|
3926
|
+
* @description The progress towards the next goal completion
|
|
3927
|
+
* @example 70
|
|
3928
|
+
*/
|
|
3929
|
+
goalProgressPercentage: number;
|
|
3930
|
+
/**
|
|
3931
|
+
* @description The number of times the goal has been reached
|
|
3932
|
+
* @example Funded 3 times
|
|
3933
|
+
*/
|
|
3934
|
+
goalCompletionText: string | null;
|
|
3935
|
+
imageUrl: string | null;
|
|
3936
|
+
shareImageUrl: string | null;
|
|
3937
|
+
cause: string | null;
|
|
3938
|
+
};
|
|
3939
|
+
communityImpact: {
|
|
3940
|
+
nonprofit: {
|
|
3941
|
+
name: string;
|
|
3942
|
+
causeIconUrl: string | null;
|
|
3943
|
+
causeIconSelectedUrl: string | null;
|
|
3944
|
+
causeIconAndBackground: string | null;
|
|
3945
|
+
website: string;
|
|
3946
|
+
};
|
|
3947
|
+
description: string;
|
|
3948
|
+
/**
|
|
3949
|
+
* @description The progress towards the goal for the nonprofit and brand
|
|
3950
|
+
* @example 70% Funded
|
|
3951
|
+
*/
|
|
3952
|
+
goalProgressText: string;
|
|
3953
|
+
/**
|
|
3954
|
+
* @description The progress towards the next goal completion
|
|
3955
|
+
* @example 70
|
|
3956
|
+
*/
|
|
3957
|
+
goalProgressPercentage: number;
|
|
3958
|
+
/**
|
|
3959
|
+
* @description The number of times the goal has been reached
|
|
3960
|
+
* @example Funded 3 times
|
|
3961
|
+
*/
|
|
3962
|
+
goalCompletionText: string | null;
|
|
3963
|
+
imageUrl: string | null;
|
|
3964
|
+
shareImageUrl: string | null;
|
|
3965
|
+
cause: string | null;
|
|
3966
|
+
};
|
|
3967
|
+
};
|
|
3968
|
+
config: {
|
|
3969
|
+
web: {
|
|
3970
|
+
/**
|
|
3971
|
+
* @description The header for the widget for mobile
|
|
3972
|
+
* @example What we've funded
|
|
3973
|
+
*/
|
|
3974
|
+
title: string;
|
|
3975
|
+
/**
|
|
3976
|
+
* @description The description for the widget for mobile
|
|
3977
|
+
* @example Here's the impact that our community has made so far in our partnership with Beam
|
|
3978
|
+
*/
|
|
3979
|
+
description: string;
|
|
3980
|
+
/** @description The remote config theme data */
|
|
3981
|
+
theme: {
|
|
3982
|
+
[key: string]: unknown;
|
|
3983
|
+
} | null;
|
|
3984
|
+
/**
|
|
3985
|
+
* @description The prefix promo description for the widget for web
|
|
3986
|
+
* @example At no extra cost,
|
|
3987
|
+
*/
|
|
3988
|
+
promoDescriptionPrefix: string | null;
|
|
3989
|
+
/**
|
|
3990
|
+
* @description The promo description for the widget for web
|
|
3991
|
+
* @example At no extra cost, select a nonprofit and 1% of your purchase will be donated
|
|
3992
|
+
*/
|
|
3993
|
+
promoDescription: string | null;
|
|
3994
|
+
/**
|
|
3995
|
+
* @description confirm button
|
|
3996
|
+
* @example Confirm free donation
|
|
3997
|
+
*/
|
|
3998
|
+
confirmButton: string | null;
|
|
3999
|
+
/**
|
|
4000
|
+
* @description copy once confirm button is clicked
|
|
4001
|
+
* @example Confirmed!
|
|
4002
|
+
*/
|
|
4003
|
+
confirmedButton: string | null;
|
|
4004
|
+
/**
|
|
4005
|
+
* @description collapsed button copy
|
|
4006
|
+
* @example Choose a nonprofit
|
|
4007
|
+
*/
|
|
4008
|
+
collapsedButton: string | null;
|
|
4009
|
+
/** @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 */
|
|
4010
|
+
promo: {
|
|
4011
|
+
/** @example Donations are 2x for Black History Month */
|
|
4012
|
+
"promo-text-long": string;
|
|
4013
|
+
/** @example Donations are 2x */
|
|
4014
|
+
"promo-text-short": string;
|
|
4015
|
+
/**
|
|
4016
|
+
* @description replaces cause copy
|
|
4017
|
+
* @example 2x boosting donations
|
|
4018
|
+
*/
|
|
4019
|
+
"promo-cause-alt-text": string;
|
|
4020
|
+
} | null;
|
|
4021
|
+
};
|
|
4022
|
+
};
|
|
4023
|
+
chain: {
|
|
4024
|
+
displayName: string;
|
|
4025
|
+
logoUrl: string;
|
|
4026
|
+
communityPageUrl: string;
|
|
4027
|
+
logoLockupUrl: string | null;
|
|
4028
|
+
};
|
|
4029
|
+
store: {
|
|
4030
|
+
communityPageUrl: string;
|
|
4031
|
+
displayName: string;
|
|
4032
|
+
};
|
|
4033
|
+
};
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
/** Standard error */
|
|
4037
|
+
default: {
|
|
4038
|
+
content: {
|
|
4039
|
+
"application/json": {
|
|
4040
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4041
|
+
code: string;
|
|
4042
|
+
/** @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 */
|
|
4043
|
+
title: string;
|
|
4044
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4045
|
+
detail: string;
|
|
4046
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4047
|
+
field?: string;
|
|
4048
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4049
|
+
metadata?: {
|
|
4050
|
+
[key: string]: unknown;
|
|
4051
|
+
};
|
|
4052
|
+
/** @description Whether the API or user can resend the request */
|
|
4053
|
+
retryable?: boolean;
|
|
4054
|
+
} & {
|
|
4055
|
+
source: unknown;
|
|
4056
|
+
meta: unknown;
|
|
4057
|
+
};
|
|
4058
|
+
};
|
|
4059
|
+
};
|
|
4060
|
+
};
|
|
4061
|
+
};
|
|
4062
|
+
};
|
|
4063
|
+
"/v4/events/socialShare": {
|
|
4064
|
+
post: {
|
|
4065
|
+
responses: {
|
|
4066
|
+
/** Social Share event created */
|
|
4067
|
+
200: unknown;
|
|
4068
|
+
/** Standard error */
|
|
4069
|
+
default: {
|
|
4070
|
+
content: {
|
|
4071
|
+
"application/json": {
|
|
4072
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4073
|
+
code: string;
|
|
4074
|
+
/** @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 */
|
|
4075
|
+
title: string;
|
|
4076
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4077
|
+
detail: string;
|
|
4078
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4079
|
+
field?: string;
|
|
4080
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4081
|
+
metadata?: {
|
|
4082
|
+
[key: string]: unknown;
|
|
4083
|
+
};
|
|
4084
|
+
/** @description Whether the API or user can resend the request */
|
|
4085
|
+
retryable?: boolean;
|
|
4086
|
+
} & {
|
|
4087
|
+
source: unknown;
|
|
4088
|
+
meta: unknown;
|
|
4089
|
+
};
|
|
4090
|
+
};
|
|
4091
|
+
};
|
|
4092
|
+
};
|
|
4093
|
+
requestBody: {
|
|
4094
|
+
content: {
|
|
4095
|
+
"application/json": {
|
|
4096
|
+
eventName: string;
|
|
4097
|
+
nonprofitId: number;
|
|
4098
|
+
storeId: number;
|
|
4099
|
+
transactionId: number;
|
|
4100
|
+
timestamp: number;
|
|
4101
|
+
};
|
|
4102
|
+
};
|
|
4103
|
+
};
|
|
4104
|
+
};
|
|
4105
|
+
};
|
|
4106
|
+
"/subscriptions/updateSubscriptionNonprofit": {
|
|
4107
|
+
post: {
|
|
4108
|
+
responses: {
|
|
4109
|
+
/** Subscription updated */
|
|
4110
|
+
200: unknown;
|
|
4111
|
+
};
|
|
4112
|
+
requestBody: {
|
|
4113
|
+
content: {
|
|
4114
|
+
"application/json": {
|
|
4115
|
+
/** @description Id derived from partner services. Not the Beam subscription ID. */
|
|
4116
|
+
remoteSubscriptionId: string;
|
|
4117
|
+
nonprofitId: number | null;
|
|
4118
|
+
/** @enum {string|null} */
|
|
4119
|
+
selectionMethod?: ("dashboard" | "remote_order" | "checkout" | "subscription_management_widget") | null;
|
|
4120
|
+
};
|
|
4121
|
+
};
|
|
4122
|
+
};
|
|
4123
|
+
};
|
|
4124
|
+
};
|
|
4125
|
+
"/subscriptions/cancelSubscription": {
|
|
4126
|
+
post: {
|
|
4127
|
+
responses: {
|
|
4128
|
+
/** Subscription updated */
|
|
4129
|
+
200: unknown;
|
|
4130
|
+
};
|
|
4131
|
+
requestBody: {
|
|
4132
|
+
content: {
|
|
4133
|
+
"application/json": {
|
|
4134
|
+
/** @description Id derived from partner services. Not the Beam subscription ID. */
|
|
4135
|
+
remoteSubscriptionId: string;
|
|
4136
|
+
};
|
|
4137
|
+
};
|
|
4138
|
+
};
|
|
4139
|
+
};
|
|
4140
|
+
};
|
|
4141
|
+
"/subscriptions/findOrCreateSubscription": {
|
|
4142
|
+
post: {
|
|
4143
|
+
responses: {
|
|
4144
|
+
/** Sends subscription info along with corresponding nonprofit and cause data */
|
|
4145
|
+
200: {
|
|
4146
|
+
content: {
|
|
4147
|
+
"application/json": {
|
|
4148
|
+
beamUserId: string;
|
|
4149
|
+
remoteSubscriptionId: string;
|
|
4150
|
+
internalSubscriptionId: string;
|
|
4151
|
+
settings?: {
|
|
4152
|
+
excludeDonationsForRecurringTransactions: boolean;
|
|
4153
|
+
};
|
|
4154
|
+
nonprofit: {
|
|
4155
|
+
/**
|
|
4156
|
+
* @description Numeric ID
|
|
4157
|
+
* @example 1001
|
|
4158
|
+
*/
|
|
4159
|
+
id: number;
|
|
4160
|
+
name?: string;
|
|
4161
|
+
} | null;
|
|
4162
|
+
};
|
|
4163
|
+
};
|
|
4164
|
+
};
|
|
4165
|
+
/** Standard error */
|
|
4166
|
+
default: {
|
|
4167
|
+
content: {
|
|
4168
|
+
"application/json": {
|
|
4169
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4170
|
+
code: string;
|
|
4171
|
+
/** @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 */
|
|
4172
|
+
title: string;
|
|
4173
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4174
|
+
detail: string;
|
|
4175
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4176
|
+
field?: string;
|
|
4177
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4178
|
+
metadata?: {
|
|
4179
|
+
[key: string]: unknown;
|
|
4180
|
+
};
|
|
4181
|
+
/** @description Whether the API or user can resend the request */
|
|
4182
|
+
retryable?: boolean;
|
|
4183
|
+
} & {
|
|
4184
|
+
source: unknown;
|
|
4185
|
+
meta: unknown;
|
|
4186
|
+
};
|
|
4187
|
+
};
|
|
4188
|
+
};
|
|
4189
|
+
};
|
|
4190
|
+
requestBody: {
|
|
4191
|
+
content: {
|
|
4192
|
+
"application/json": ({
|
|
4193
|
+
remoteSubscriptionId: string;
|
|
4194
|
+
options?: {
|
|
4195
|
+
disableDefaultToUniversalSubscriptionIfNotFound?: boolean;
|
|
4196
|
+
};
|
|
4197
|
+
} & {
|
|
4198
|
+
[key: string]: unknown;
|
|
4199
|
+
}) & (Partial<{
|
|
4200
|
+
partnerUserId: string;
|
|
4201
|
+
}> & Partial<{
|
|
4202
|
+
email: string;
|
|
4203
|
+
}>);
|
|
4204
|
+
};
|
|
4205
|
+
};
|
|
4206
|
+
};
|
|
4207
|
+
};
|
|
4208
|
+
"/subscriptions/findNonprofitForSubscription": {
|
|
4209
|
+
post: {
|
|
4210
|
+
responses: {
|
|
4211
|
+
/** Nonprofit information associated to the subscription */
|
|
4212
|
+
200: {
|
|
4213
|
+
content: {
|
|
4214
|
+
"application/json": {
|
|
4215
|
+
/**
|
|
4216
|
+
* @description Numeric ID
|
|
4217
|
+
* @example 1001
|
|
4218
|
+
*/
|
|
4219
|
+
id?: number;
|
|
4220
|
+
name?: string;
|
|
4221
|
+
cause?: string | null;
|
|
4222
|
+
} | null;
|
|
4223
|
+
};
|
|
4224
|
+
};
|
|
4225
|
+
/** Standard error */
|
|
4226
|
+
default: {
|
|
4227
|
+
content: {
|
|
4228
|
+
"application/json": {
|
|
4229
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4230
|
+
code: string;
|
|
4231
|
+
/** @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 */
|
|
4232
|
+
title: string;
|
|
4233
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4234
|
+
detail: string;
|
|
4235
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4236
|
+
field?: string;
|
|
4237
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4238
|
+
metadata?: {
|
|
4239
|
+
[key: string]: unknown;
|
|
4240
|
+
};
|
|
4241
|
+
/** @description Whether the API or user can resend the request */
|
|
4242
|
+
retryable?: boolean;
|
|
4243
|
+
} & {
|
|
4244
|
+
source: unknown;
|
|
4245
|
+
meta: unknown;
|
|
4246
|
+
};
|
|
4247
|
+
};
|
|
4248
|
+
};
|
|
4249
|
+
};
|
|
4250
|
+
requestBody: {
|
|
4251
|
+
content: {
|
|
4252
|
+
"application/json": ({
|
|
4253
|
+
remoteSubscriptionId: string;
|
|
4254
|
+
} & {
|
|
4255
|
+
[key: string]: unknown;
|
|
4256
|
+
}) & (Partial<{
|
|
4257
|
+
partnerUserId: string;
|
|
4258
|
+
}> & Partial<{
|
|
4259
|
+
email: string;
|
|
4260
|
+
}>);
|
|
4261
|
+
};
|
|
4262
|
+
};
|
|
4263
|
+
};
|
|
4264
|
+
};
|
|
4265
|
+
"/selectNonprofit": {
|
|
4266
|
+
post: {
|
|
4267
|
+
responses: {
|
|
4268
|
+
/** Existing selection updated OK */
|
|
4269
|
+
200: {
|
|
4270
|
+
content: {
|
|
4271
|
+
"application/json": {
|
|
4272
|
+
/**
|
|
4273
|
+
* @description UUID
|
|
4274
|
+
* @example bqkdk-0393b-jbkdd-02difj
|
|
4275
|
+
*/
|
|
4276
|
+
selectionId: string;
|
|
4277
|
+
};
|
|
4278
|
+
};
|
|
4279
|
+
};
|
|
4280
|
+
/** New selection created OK */
|
|
4281
|
+
201: {
|
|
4282
|
+
content: {
|
|
4283
|
+
"application/json": {
|
|
4284
|
+
/**
|
|
4285
|
+
* @description UUID
|
|
4286
|
+
* @example bqkdk-0393b-jbkdd-02difj
|
|
4287
|
+
*/
|
|
4288
|
+
selectionId: string;
|
|
4289
|
+
};
|
|
4290
|
+
};
|
|
4291
|
+
};
|
|
4292
|
+
/** Standard error */
|
|
4293
|
+
default: {
|
|
4294
|
+
content: {
|
|
4295
|
+
"application/json": {
|
|
4296
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4297
|
+
code: string;
|
|
4298
|
+
/** @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 */
|
|
4299
|
+
title: string;
|
|
4300
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4301
|
+
detail: string;
|
|
4302
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4303
|
+
field?: string;
|
|
4304
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4305
|
+
metadata?: {
|
|
4306
|
+
[key: string]: unknown;
|
|
4307
|
+
};
|
|
4308
|
+
/** @description Whether the API or user can resend the request */
|
|
4309
|
+
retryable?: boolean;
|
|
4310
|
+
} & {
|
|
4311
|
+
source: unknown;
|
|
4312
|
+
meta: unknown;
|
|
4313
|
+
};
|
|
4314
|
+
};
|
|
4315
|
+
};
|
|
4316
|
+
};
|
|
4317
|
+
requestBody: {
|
|
4318
|
+
content: {
|
|
4319
|
+
"application/json": {
|
|
4320
|
+
nonprofitId: number | null;
|
|
4321
|
+
/**
|
|
4322
|
+
* Format: uuid
|
|
4323
|
+
* @description UUID of an existing selection
|
|
4324
|
+
*/
|
|
4325
|
+
selectionId?: string | null;
|
|
4326
|
+
/** @description Cart ID from partner site */
|
|
4327
|
+
cartId?: string;
|
|
4328
|
+
/**
|
|
4329
|
+
* @description internal cart ID
|
|
4330
|
+
* @example bqkdk-0393b-jbkdd-02difj
|
|
4331
|
+
*/
|
|
4332
|
+
beamCartId?: string;
|
|
4333
|
+
/** @description Beam store ID */
|
|
4334
|
+
storeId?: number;
|
|
4335
|
+
/** @description UUID of existing beam user. Used to update user's `lastNonprofitId` */
|
|
4336
|
+
beamUserId?: string | null;
|
|
4337
|
+
/** @example 10292 */
|
|
4338
|
+
postalCode?: string;
|
|
4339
|
+
/** @example US */
|
|
4340
|
+
countryCode?: string;
|
|
4341
|
+
/** @description is this a test selection? */
|
|
4342
|
+
isTest?: boolean;
|
|
4343
|
+
/**
|
|
4344
|
+
* @description The source from where the selection was made
|
|
4345
|
+
* @enum {string}
|
|
4346
|
+
*/
|
|
4347
|
+
creationMethod?: "cart" | "checkout";
|
|
4348
|
+
};
|
|
4349
|
+
};
|
|
4350
|
+
};
|
|
4351
|
+
};
|
|
4352
|
+
};
|
|
4353
|
+
"/getLastSelectedNonprofit": {
|
|
4354
|
+
get: {
|
|
4355
|
+
parameters: {
|
|
4356
|
+
query: {
|
|
4357
|
+
beamUserId: string;
|
|
4358
|
+
};
|
|
4359
|
+
};
|
|
4360
|
+
responses: {
|
|
4361
|
+
/** Retrieved user's last selected nonprofit. */
|
|
4362
|
+
200: {
|
|
4363
|
+
content: {
|
|
4364
|
+
"application/json": {
|
|
4365
|
+
/** @description ID of last selected nonprofit */
|
|
4366
|
+
nonprofitId: number;
|
|
4367
|
+
};
|
|
4368
|
+
};
|
|
4369
|
+
};
|
|
4370
|
+
/** Standard error */
|
|
4371
|
+
default: {
|
|
4372
|
+
content: {
|
|
4373
|
+
"application/json": {
|
|
4374
|
+
/** @description Beam code for the error, meant to be used programmatically */
|
|
4375
|
+
code: string;
|
|
4376
|
+
/** @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 */
|
|
4377
|
+
title: string;
|
|
4378
|
+
/** @description A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized */
|
|
4379
|
+
detail: string;
|
|
4380
|
+
/** @description a JSON Pointer to the associated entity in the request document */
|
|
4381
|
+
field?: string;
|
|
4382
|
+
/** @description A meta object containing non-standard meta-information about the error */
|
|
4383
|
+
metadata?: {
|
|
4384
|
+
[key: string]: unknown;
|
|
4385
|
+
};
|
|
4386
|
+
/** @description Whether the API or user can resend the request */
|
|
4387
|
+
retryable?: boolean;
|
|
4388
|
+
} & {
|
|
4389
|
+
source: unknown;
|
|
4390
|
+
meta: unknown;
|
|
4391
|
+
};
|
|
4392
|
+
};
|
|
4393
|
+
};
|
|
4394
|
+
};
|
|
4395
|
+
};
|
|
4396
|
+
};
|
|
4397
|
+
"/remoteConfig": {
|
|
4398
|
+
get: {
|
|
4399
|
+
parameters: {
|
|
4400
|
+
query: {
|
|
4401
|
+
chainId: number;
|
|
4402
|
+
widgetName: "community-impact" | "impact-overview" | "select-nonprofit" | "redeem-transaction" | "cumulative-impact" | "mobile-full-screen-nonprofit-selection" | "mobile-impact-list" | "mobile-minimal-nonprofit-selection" | "mobile-personal-impact" | "mobile-selected-nonprofit" | "mobile-progress-bar" | "select-nonprofit-cta" | "mobile-share-button" | "subscription-management" | "product-details-page" | "select-subscription-nonprofit" | "subscription-impact";
|
|
4403
|
+
version: string;
|
|
4404
|
+
};
|
|
4405
|
+
};
|
|
4406
|
+
responses: {
|
|
4407
|
+
/** Fetch remote config for the provided chain and widget OK */
|
|
4408
|
+
200: {
|
|
4409
|
+
content: {
|
|
4410
|
+
"application/json": {
|
|
4411
|
+
[key: string]: unknown;
|
|
4412
|
+
};
|
|
4413
|
+
};
|
|
4414
|
+
};
|
|
4415
|
+
};
|
|
3757
4416
|
};
|
|
3758
4417
|
post: {
|
|
3759
4418
|
responses: {
|
|
@@ -4245,6 +4904,8 @@ interface paths {
|
|
|
4245
4904
|
/** @default USD */
|
|
4246
4905
|
currencyCode?: string;
|
|
4247
4906
|
remoteSessionId?: string;
|
|
4907
|
+
/** @enum {string} */
|
|
4908
|
+
creationMethod?: "cart" | "checkout";
|
|
4248
4909
|
};
|
|
4249
4910
|
};
|
|
4250
4911
|
};
|