@bigcommerce/checkout-sdk 1.273.0 → 1.274.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -805,6 +805,23 @@ declare interface ApplePayButtonInitializeOptions {
805
805
  onPaymentAuthorize(): void;
806
806
  }
807
807
 
808
+ /**
809
+ * A set of options that are required to initialize ApplePay in cart.
810
+ *
811
+ * When ApplePay is initialized, an ApplePay button will be inserted into the
812
+ * DOM. When a customer clicks on it, it will trigger Apple sheet.
813
+ */
814
+ declare interface ApplePayButtonInitializeOptions_2 {
815
+ /**
816
+ * The class name of the ApplePay button style.
817
+ */
818
+ buttonClassName?: string;
819
+ /**
820
+ * A callback that gets called when a payment is successfully completed.
821
+ */
822
+ onPaymentAuthorize(): void;
823
+ }
824
+
808
825
  /**
809
826
  * A set of options that are required to initialize the customer step of
810
827
  * checkout in order to support ApplePay.
@@ -883,6 +900,190 @@ declare interface BaseAccountInstrument extends BaseInstrument {
883
900
  type: 'account' | 'bank';
884
901
  }
885
902
 
903
+ declare interface BaseCheckoutButtonInitializeOptions extends CheckoutButtonOptions {
904
+ /**
905
+ * The options that are required to initialize the ApplePay payment method.
906
+ * They can be omitted unless you need to support ApplePay in cart.
907
+ */
908
+ applepay?: ApplePayButtonInitializeOptions;
909
+ /**
910
+ * The options that are required to facilitate AmazonPayV2. They can be
911
+ * omitted unless you need to support AmazonPayV2.
912
+ */
913
+ amazonpay?: AmazonPayV2ButtonInitializeOptions;
914
+ /**
915
+ * The options that are required to facilitate Braintree PayPal. They can be
916
+ * omitted unless you need to support Braintree PayPal.
917
+ */
918
+ braintreepaypal?: BraintreePaypalButtonInitializeOptions;
919
+ /**
920
+ * The options that are required to facilitate Braintree Credit. They can be
921
+ * omitted unless you need to support Braintree Credit.
922
+ */
923
+ braintreepaypalcredit?: BraintreePaypalCreditButtonInitializeOptions;
924
+ /**
925
+ * The options that are required to facilitate Braintree Venmo. They can be
926
+ * omitted unless you need to support Braintree Venmo.
927
+ */
928
+ braintreevenmo?: BraintreeVenmoButtonInitializeOptions;
929
+ /**
930
+ * The ID of a container which the checkout button should be inserted.
931
+ */
932
+ containerId: string;
933
+ /**
934
+ * The options that are required to initialize the GooglePay payment method.
935
+ * They can be omitted unless you need to support adyenv2 GooglePay.
936
+ */
937
+ googlepayadyenv2?: GooglePayButtonInitializeOptions;
938
+ /**
939
+ * The options that are required to initialize the GooglePay payment method.
940
+ * They can be omitted unless you need to support adyenv2 GooglePay.
941
+ */
942
+ googlepayadyenv3?: GooglePayButtonInitializeOptions;
943
+ /**
944
+ * The options that are required to facilitate Braintree GooglePay. They can be
945
+ * omitted unless you need to support Braintree GooglePay.
946
+ */
947
+ googlepaybraintree?: GooglePayButtonInitializeOptions;
948
+ /**
949
+ * The options that are required to facilitate Checkout.com GooglePay. They can be
950
+ * omitted unless you need to support Checkout.com GooglePay.
951
+ */
952
+ googlepaycheckoutcom?: GooglePayButtonInitializeOptions;
953
+ /**
954
+ * The options that are required to facilitate CybersourceV2 GooglePay. They can be
955
+ * omitted unless you need to support CybersourceV2 GooglePay.
956
+ */
957
+ googlepaycybersourcev2?: GooglePayButtonInitializeOptions;
958
+ /**
959
+ * The options that are required to facilitate Orbital GooglePay. They can be
960
+ * omitted unless you need to support Orbital GooglePay.
961
+ */
962
+ googlepayorbital?: GooglePayButtonInitializeOptions;
963
+ /**
964
+ * The options that are required to facilitate Stripe GooglePay. They can be
965
+ * omitted unless you need to support Stripe GooglePay.
966
+ */
967
+ googlepaystripe?: GooglePayButtonInitializeOptions;
968
+ /**
969
+ * The options that are required to facilitate Stripe GooglePay. They can be
970
+ * omitted unless you need to support Stripe GooglePay.
971
+ */
972
+ googlepaystripeupe?: GooglePayButtonInitializeOptions;
973
+ /**
974
+ * The options that are required to facilitate Authorize.Net GooglePay.
975
+ * They can be omitted unless you need to support Authorize.Net GooglePay.
976
+ */
977
+ googlepayauthorizenet?: GooglePayButtonInitializeOptions;
978
+ /**
979
+ * The options that are required to facilitate PayPal. They can be omitted
980
+ * unless you need to support Paypal.
981
+ */
982
+ paypal?: PaypalButtonInitializeOptions;
983
+ /**
984
+ * The options that are required to facilitate PayPal Commerce. They can be omitted
985
+ * unless you need to support Paypal.
986
+ */
987
+ paypalCommerce?: PaypalCommerceButtonInitializeOptions;
988
+ /**
989
+ * The options that are required to facilitate PayPal Commerce. They can be omitted
990
+ * unless you need to support PayPal Commerce Alternative Payment Methods.
991
+ */
992
+ paypalcommercealternativemethods?: PaypalCommerceAlternativeMethodsButtonOptions;
993
+ /**
994
+ * The options that are required to facilitate PayPal Commerce Venmo. They can be omitted
995
+ * unless you need to support PayPal Commerce Venmo.
996
+ */
997
+ paypalcommercevenmo?: PaypalCommerceVenmoButtonInitializeOptions;
998
+ }
999
+
1000
+ /**
1001
+ * A set of options that are required to initialize the customer step of the
1002
+ * current checkout flow.
1003
+ *
1004
+ * Some payment methods have specific requirements for setting the customer
1005
+ * details for checkout. For example, Amazon Pay requires the customer to sign in
1006
+ * using their sign-in button. As a result, you may need to provide additional
1007
+ * information in order to initialize the customer step of checkout.
1008
+ */
1009
+ declare interface BaseCustomerInitializeOptions extends CustomerRequestOptions {
1010
+ /**
1011
+ * The options that are required to initialize the customer step of checkout
1012
+ * when using Amazon Pay.
1013
+ */
1014
+ amazon?: AmazonPayCustomerInitializeOptions;
1015
+ /**
1016
+ * The options that are required to initialize the customer step of checkout
1017
+ * when using AmazonPayV2.
1018
+ */
1019
+ amazonpay?: AmazonPayV2CustomerInitializeOptions;
1020
+ /**
1021
+ * The options that are required to initialize the customer step of checkout
1022
+ * when using Visa Checkout provided by Braintree.
1023
+ */
1024
+ braintreevisacheckout?: BraintreeVisaCheckoutCustomerInitializeOptions;
1025
+ /**
1026
+ * The options that are required to initialize the customer step of checkout
1027
+ * when using Bolt.
1028
+ */
1029
+ bolt?: BoltCustomerInitializeOptions;
1030
+ /**
1031
+ * The options that are required to initialize the Chasepay payment method.
1032
+ * They can be omitted unless you need to support Chasepay.
1033
+ */
1034
+ chasepay?: ChasePayCustomerInitializeOptions;
1035
+ /**
1036
+ * The options that are required to initialize the Masterpass payment method.
1037
+ * They can be omitted unless you need to support Masterpass.
1038
+ */
1039
+ masterpass?: MasterpassCustomerInitializeOptions;
1040
+ /**
1041
+ * The options that are required to initialize the GooglePay payment method.
1042
+ * They can be omitted unless you need to support GooglePay.
1043
+ */
1044
+ googlepayadyenv2?: GooglePayCustomerInitializeOptions;
1045
+ /**
1046
+ * The options that are required to initialize the GooglePay payment method.
1047
+ * They can be omitted unless you need to support GooglePay.
1048
+ */
1049
+ googlepayadyenv3?: GooglePayCustomerInitializeOptions;
1050
+ /**
1051
+ * The options that are required to initialize the GooglePay payment method.
1052
+ * They can be omitted unless you need to support GooglePay.
1053
+ */
1054
+ googlepayauthorizenet?: GooglePayCustomerInitializeOptions;
1055
+ /**
1056
+ * The options that are required to initialize the GooglePay payment method.
1057
+ * They can be omitted unless you need to support GooglePay.
1058
+ */
1059
+ googlepaybraintree?: GooglePayCustomerInitializeOptions;
1060
+ /**
1061
+ * The options that are required to initialize the GooglePay payment method.
1062
+ * They can be omitted unless you need to support GooglePay.
1063
+ */
1064
+ googlepaycheckoutcom?: GooglePayCustomerInitializeOptions;
1065
+ /**
1066
+ * The options that are required to initialize the GooglePay payment method.
1067
+ * They can be omitted unless you need to support GooglePay.
1068
+ */
1069
+ googlepaycybersourcev2?: GooglePayCustomerInitializeOptions;
1070
+ /**
1071
+ * The options that are required to initialize the GooglePay payment method.
1072
+ * They can be omitted unless you need to support GooglePay.
1073
+ */
1074
+ googlepayorbital?: GooglePayCustomerInitializeOptions;
1075
+ /**
1076
+ * The options that are required to initialize the GooglePay payment method.
1077
+ * They can be omitted unless you need to support GooglePay.
1078
+ */
1079
+ googlepaystripe?: GooglePayCustomerInitializeOptions;
1080
+ /**
1081
+ * The options that are required to initialize the GooglePay payment method.
1082
+ * They can be omitted unless you need to support GooglePay.
1083
+ */
1084
+ googlepaystripeupe?: GooglePayCustomerInitializeOptions;
1085
+ }
1086
+
886
1087
  declare interface BaseElementOptions {
887
1088
  /**
888
1089
  * Set custom class names on the container DOM element when the Digital River element is in a particular state.
@@ -903,20 +1104,190 @@ declare interface BaseElementOptions_2 {
903
1104
  /**
904
1105
  * Applies a disabled state to the Element such that user input is not accepted. Default is false.
905
1106
  */
906
- disabled?: boolean;
907
- }
908
-
909
- declare interface BaseIndividualElementOptions extends BaseElementOptions_2 {
910
- containerId: string;
911
- }
912
-
913
- declare interface BaseInstrument {
914
- bigpayToken: string;
915
- defaultInstrument: boolean;
916
- provider: string;
917
- trustedShippingAddress: boolean;
918
- method: string;
919
- type: string;
1107
+ disabled?: boolean;
1108
+ }
1109
+
1110
+ declare interface BaseIndividualElementOptions extends BaseElementOptions_2 {
1111
+ containerId: string;
1112
+ }
1113
+
1114
+ declare interface BaseInstrument {
1115
+ bigpayToken: string;
1116
+ defaultInstrument: boolean;
1117
+ provider: string;
1118
+ trustedShippingAddress: boolean;
1119
+ method: string;
1120
+ type: string;
1121
+ }
1122
+
1123
+ /**
1124
+ * A set of options that are required to initialize the payment step of the
1125
+ * current checkout flow.
1126
+ */
1127
+ declare interface BasePaymentInitializeOptions extends PaymentRequestOptions {
1128
+ /**
1129
+ * @alpha
1130
+ * Please note that this option is currently in an early stage of
1131
+ * development. Therefore the API is unstable and not ready for public
1132
+ * consumption.
1133
+ */
1134
+ creditCard?: CreditCardPaymentInitializeOptions;
1135
+ /**
1136
+ * The options that are required to initialize the AdyenV2 payment
1137
+ * method. They can be omitted unless you need to support AdyenV2.
1138
+ */
1139
+ adyenv2?: AdyenV2PaymentInitializeOptions;
1140
+ /**
1141
+ * The options that are required to initialize the AdyenV3 payment
1142
+ * method. They can be omitted unless you need to support AdyenV3.
1143
+ */
1144
+ adyenv3?: AdyenV3PaymentInitializeOptions;
1145
+ /**
1146
+ * The options that are required to initialize the Amazon Pay payment
1147
+ * method. They can be omitted unless you need to support AmazonPay.
1148
+ */
1149
+ amazon?: AmazonPayPaymentInitializeOptions;
1150
+ /**
1151
+ * The options that are required to initialize the AmazonPayV2 payment
1152
+ * method. They can be omitted unless you need to support AmazonPayV2.
1153
+ */
1154
+ amazonpay?: AmazonPayV2PaymentInitializeOptions;
1155
+ /**
1156
+ * The options that are required to initialize the BlueSnapV2 payment method.
1157
+ * They can be omitted unless you need to support BlueSnapV2.
1158
+ */
1159
+ bluesnapv2?: BlueSnapV2PaymentInitializeOptions;
1160
+ /**
1161
+ * The options that allow Bolt to load the client script and handle the checkout.
1162
+ * They can be omitted if Bolt's full checkout take over is intended.
1163
+ */
1164
+ bolt?: BoltPaymentInitializeOptions;
1165
+ /**
1166
+ * The options that are required to initialize the Braintree payment method.
1167
+ * They can be omitted unless you need to support Braintree.
1168
+ */
1169
+ braintree?: BraintreePaymentInitializeOptions;
1170
+ /**
1171
+ * The options that are required to initialize the Visa Checkout payment
1172
+ * method provided by Braintree. They can be omitted unless you need to
1173
+ * support Visa Checkout.
1174
+ */
1175
+ braintreevisacheckout?: BraintreeVisaCheckoutPaymentInitializeOptions;
1176
+ /**
1177
+ * The options that are required to initialize the Digital River payment method.
1178
+ * They can be omitted unless you need to support Digital River.
1179
+ */
1180
+ digitalriver?: DigitalRiverPaymentInitializeOptions;
1181
+ /**
1182
+ * The options that are required to initialize the Klarna payment method.
1183
+ * They can be omitted unless you need to support Klarna.
1184
+ */
1185
+ klarna?: KlarnaPaymentInitializeOptions;
1186
+ /**
1187
+ * The options that are required to initialize the KlarnaV2 payment method.
1188
+ * They can be omitted unless you need to support KlarnaV2.
1189
+ */
1190
+ klarnav2?: KlarnaV2PaymentInitializeOptions;
1191
+ /**
1192
+ * The options that are required to initialize the Masterpass payment method.
1193
+ * They can be omitted unless you need to support Masterpass.
1194
+ */
1195
+ masterpass?: MasterpassPaymentInitializeOptions;
1196
+ /**
1197
+ * The options that are required to initialize the Moneris payment method.
1198
+ * They can be omitted unless you need to support Moneris.
1199
+ */
1200
+ moneris?: MonerisPaymentInitializeOptions;
1201
+ /**
1202
+ * The options that are required to initialize the Opy payment
1203
+ * method. They can be omitted unless you need to support Opy.
1204
+ */
1205
+ opy?: OpyPaymentInitializeOptions;
1206
+ /**
1207
+ * The options that are required to initialize the PayPal Express payment method.
1208
+ * They can be omitted unless you need to support PayPal Express.
1209
+ */
1210
+ paypalexpress?: PaypalExpressPaymentInitializeOptions;
1211
+ /**
1212
+ * The options that are required to initialize the PayPal Commerce payment method.
1213
+ * They can be omitted unless you need to support PayPal Commerce.
1214
+ */
1215
+ paypalcommerce?: PaypalCommerceInitializeOptions;
1216
+ /**
1217
+ * The options that are required to initialize the Square payment method.
1218
+ * They can be omitted unless you need to support Square.
1219
+ */
1220
+ square?: SquarePaymentInitializeOptions;
1221
+ /**
1222
+ * The options that are required to initialize the Chasepay payment method.
1223
+ * They can be omitted unless you need to support Chasepay.
1224
+ */
1225
+ chasepay?: ChasePayInitializeOptions;
1226
+ /**
1227
+ * The options that are required to initialize the GooglePay Authorize.Net
1228
+ * payment method. They can be omitted unless you need to support GooglePay.
1229
+ */
1230
+ googlepayadyenv2?: GooglePayPaymentInitializeOptions;
1231
+ /**
1232
+ * The options that are required to initialize the GooglePay Authorize.Net
1233
+ * payment method. They can be omitted unless you need to support GooglePay.
1234
+ */
1235
+ googlepayadyenv3?: GooglePayPaymentInitializeOptions;
1236
+ /**
1237
+ * The options that are required to initialize the GooglePay Authorize.Net
1238
+ * payment method. They can be omitted unless you need to support GooglePay.
1239
+ */
1240
+ googlepayauthorizenet?: GooglePayPaymentInitializeOptions;
1241
+ /**
1242
+ * The options that are required to initialize the GooglePay Braintree payment method.
1243
+ * They can be omitted unless you need to support GooglePay.
1244
+ */
1245
+ googlepaybraintree?: GooglePayPaymentInitializeOptions;
1246
+ /**
1247
+ * The options that are required to initialize the GooglePay Checkout.com payment method.
1248
+ * They can be omitted unless you need to support GooglePay.
1249
+ */
1250
+ googlepaycheckoutcom?: GooglePayPaymentInitializeOptions;
1251
+ /**
1252
+ * The options that are required to initialize the GooglePay CybersourceV2 payment method.
1253
+ * They can be omitted unless you need to support GooglePay.
1254
+ */
1255
+ googlepaycybersourcev2?: GooglePayPaymentInitializeOptions;
1256
+ /**
1257
+ * The options that are required to initialize the GooglePay payment method.
1258
+ * They can be omitted unless you need to support GooglePay.
1259
+ */
1260
+ googlepayorbital?: GooglePayPaymentInitializeOptions;
1261
+ /**
1262
+ * The options that are required to initialize the GooglePay Stripe payment method.
1263
+ * They can be omitted unless you need to support GooglePay.
1264
+ */
1265
+ googlepaystripe?: GooglePayPaymentInitializeOptions;
1266
+ /**
1267
+ * The options that are required to initialize the GooglePay Stripe payment method.
1268
+ * They can be omitted unless you need to support GooglePay.
1269
+ */
1270
+ googlepaystripeupe?: GooglePayPaymentInitializeOptions;
1271
+ /**
1272
+ * The options that are required to initialize the Stripe payment method.
1273
+ * They can be omitted unless you need to support StripeV3.
1274
+ */
1275
+ stripev3?: StripeV3PaymentInitializeOptions;
1276
+ /**
1277
+ * The options that are required to initialize the StripeUPE payment method.
1278
+ * They can be omitted unless you need to support StripeUPE.
1279
+ */
1280
+ stripeupe?: StripeUPEPaymentInitializeOptions;
1281
+ /**
1282
+ * The options that are required to initialize the Mollie payment method.
1283
+ * They can be omitted unless you need to support Mollie.
1284
+ */
1285
+ mollie?: MolliePaymentInitializeOptions;
1286
+ /**
1287
+ * The options that are required to initialize the Worldpay payment method.
1288
+ * They can be omitted unless you need to support Worldpay.
1289
+ */
1290
+ worldpay?: WorldpayPaymentInitializeOptions;
920
1291
  }
921
1292
 
922
1293
  declare interface BillingAddress extends Address {
@@ -1682,102 +2053,7 @@ declare class CheckoutButtonErrorSelector {
1682
2053
  getDeinitializeButtonError(methodId?: CheckoutButtonMethodType): Error | undefined;
1683
2054
  }
1684
2055
 
1685
- declare interface CheckoutButtonInitializeOptions extends CheckoutButtonOptions {
1686
- /**
1687
- * The options that are required to initialize the ApplePay payment method.
1688
- * They can be omitted unless you need to support ApplePay in cart.
1689
- */
1690
- applepay?: ApplePayButtonInitializeOptions;
1691
- /**
1692
- * The options that are required to facilitate AmazonPayV2. They can be
1693
- * omitted unless you need to support AmazonPayV2.
1694
- */
1695
- amazonpay?: AmazonPayV2ButtonInitializeOptions;
1696
- /**
1697
- * The options that are required to facilitate Braintree PayPal. They can be
1698
- * omitted unless you need to support Braintree PayPal.
1699
- */
1700
- braintreepaypal?: BraintreePaypalButtonInitializeOptions;
1701
- /**
1702
- * The options that are required to facilitate Braintree Credit. They can be
1703
- * omitted unless you need to support Braintree Credit.
1704
- */
1705
- braintreepaypalcredit?: BraintreePaypalCreditButtonInitializeOptions;
1706
- /**
1707
- * The options that are required to facilitate Braintree Venmo. They can be
1708
- * omitted unless you need to support Braintree Venmo.
1709
- */
1710
- braintreevenmo?: BraintreeVenmoButtonInitializeOptions;
1711
- /**
1712
- * The ID of a container which the checkout button should be inserted.
1713
- */
1714
- containerId: string;
1715
- /**
1716
- * The options that are required to initialize the GooglePay payment method.
1717
- * They can be omitted unless you need to support adyenv2 GooglePay.
1718
- */
1719
- googlepayadyenv2?: GooglePayButtonInitializeOptions;
1720
- /**
1721
- * The options that are required to initialize the GooglePay payment method.
1722
- * They can be omitted unless you need to support adyenv2 GooglePay.
1723
- */
1724
- googlepayadyenv3?: GooglePayButtonInitializeOptions;
1725
- /**
1726
- * The options that are required to facilitate Braintree GooglePay. They can be
1727
- * omitted unless you need to support Braintree GooglePay.
1728
- */
1729
- googlepaybraintree?: GooglePayButtonInitializeOptions;
1730
- /**
1731
- * The options that are required to facilitate Checkout.com GooglePay. They can be
1732
- * omitted unless you need to support Checkout.com GooglePay.
1733
- */
1734
- googlepaycheckoutcom?: GooglePayButtonInitializeOptions;
1735
- /**
1736
- * The options that are required to facilitate CybersourceV2 GooglePay. They can be
1737
- * omitted unless you need to support CybersourceV2 GooglePay.
1738
- */
1739
- googlepaycybersourcev2?: GooglePayButtonInitializeOptions;
1740
- /**
1741
- * The options that are required to facilitate Orbital GooglePay. They can be
1742
- * omitted unless you need to support Orbital GooglePay.
1743
- */
1744
- googlepayorbital?: GooglePayButtonInitializeOptions;
1745
- /**
1746
- * The options that are required to facilitate Stripe GooglePay. They can be
1747
- * omitted unless you need to support Stripe GooglePay.
1748
- */
1749
- googlepaystripe?: GooglePayButtonInitializeOptions;
1750
- /**
1751
- * The options that are required to facilitate Stripe GooglePay. They can be
1752
- * omitted unless you need to support Stripe GooglePay.
1753
- */
1754
- googlepaystripeupe?: GooglePayButtonInitializeOptions;
1755
- /**
1756
- * The options that are required to facilitate Authorize.Net GooglePay.
1757
- * They can be omitted unless you need to support Authorize.Net GooglePay.
1758
- */
1759
- googlepayauthorizenet?: GooglePayButtonInitializeOptions;
1760
- /**
1761
- * The options that are required to facilitate PayPal. They can be omitted
1762
- * unless you need to support Paypal.
1763
- */
1764
- paypal?: PaypalButtonInitializeOptions;
1765
- /**
1766
- * The options that are required to facilitate PayPal Commerce. They can be omitted
1767
- * unless you need to support Paypal.
1768
- */
1769
- paypalCommerce?: PaypalCommerceButtonInitializeOptions;
1770
- /**
1771
- * The options that are required to facilitate PayPal Commerce. They can be omitted
1772
- * unless you need to support PayPal Commerce Alternative Payment Methods.
1773
- */
1774
- paypalcommercealternativemethods?: PaypalCommerceAlternativeMethodsButtonOptions;
1775
- /**
1776
- * The options that are required to facilitate PayPal Commerce Venmo. They can be omitted
1777
- * unless you need to support PayPal Commerce Venmo.
1778
- */
1779
- paypalcommercevenmo?: PaypalCommerceVenmoButtonInitializeOptions;
1780
- }
2056
+ declare type CheckoutButtonInitializeOptions = BaseCheckoutButtonInitializeOptions & WithApplePayButtonInitializeOptions;
1781
2057
 
1782
2058
  declare class CheckoutButtonInitializer {
1783
2059
  private _store;
@@ -4034,165 +4310,75 @@ declare class CurrencyService {
4034
4310
  private _storeFormatter;
4035
4311
  toCustomerCurrency(amount: number): string;
4036
4312
  toStoreCurrency(amount: number): string;
4037
- }
4038
-
4039
- declare interface CustomError extends Error {
4040
- message: string;
4041
- type: string;
4042
- subtype?: string;
4043
- }
4044
-
4045
- declare interface CustomItem {
4046
- id: string;
4047
- listPrice: number;
4048
- extendedListPrice: number;
4049
- name: string;
4050
- quantity: number;
4051
- sku: string;
4052
- }
4053
-
4054
- declare interface Customer {
4055
- id: number;
4056
- addresses: CustomerAddress[];
4057
- storeCredit: number;
4058
- /**
4059
- * The email address of the signed in customer.
4060
- */
4061
- email: string;
4062
- firstName: string;
4063
- fullName: string;
4064
- isGuest: boolean;
4065
- lastName: string;
4066
- /**
4067
- * Indicates whether the customer should be prompted to sign-in.
4068
- *
4069
- * Note: You need to enable "Prompt existing accounts to sign in" in your Checkout Settings.
4070
- */
4071
- shouldEncourageSignIn: boolean;
4072
- customerGroup?: CustomerGroup;
4073
- }
4074
-
4075
- declare interface CustomerAccountRequestBody {
4076
- firstName: string;
4077
- lastName: string;
4078
- email: string;
4079
- password: string;
4080
- acceptsMarketingEmails?: boolean;
4081
- customFields?: Array<{
4082
- fieldId: string;
4083
- fieldValue: string | number | string[];
4084
- }>;
4085
- }
4086
-
4087
- declare interface CustomerAddress extends Address {
4088
- id: number;
4089
- type: string;
4090
- }
4091
-
4092
- declare type CustomerAddressRequestBody = AddressRequestBody;
4093
-
4094
- declare interface CustomerCredentials {
4095
- email: string;
4096
- password: string;
4097
- }
4098
-
4099
- declare interface CustomerGroup {
4100
- id: number;
4101
- name: string;
4102
- }
4103
-
4104
- /**
4105
- * A set of options that are required to initialize the customer step of the
4106
- * current checkout flow.
4107
- *
4108
- * Some payment methods have specific requirements for setting the customer
4109
- * details for checkout. For example, Amazon Pay requires the customer to sign in
4110
- * using their sign-in button. As a result, you may need to provide additional
4111
- * information in order to initialize the customer step of checkout.
4112
- */
4113
- declare interface CustomerInitializeOptions extends CustomerRequestOptions {
4114
- /**
4115
- * The options that are required to initialize the customer step of checkout
4116
- * when using Amazon Pay.
4117
- */
4118
- amazon?: AmazonPayCustomerInitializeOptions;
4119
- /**
4120
- * The options that are required to initialize the customer step of checkout
4121
- * when using AmazonPayV2.
4122
- */
4123
- amazonpay?: AmazonPayV2CustomerInitializeOptions;
4124
- /**
4125
- * The options that are required to initialize the customer step of checkout
4126
- * when using ApplePay.
4127
- */
4128
- applepay?: ApplePayCustomerInitializeOptions;
4129
- /**
4130
- * The options that are required to initialize the customer step of checkout
4131
- * when using Visa Checkout provided by Braintree.
4132
- */
4133
- braintreevisacheckout?: BraintreeVisaCheckoutCustomerInitializeOptions;
4134
- /**
4135
- * The options that are required to initialize the customer step of checkout
4136
- * when using Bolt.
4137
- */
4138
- bolt?: BoltCustomerInitializeOptions;
4139
- /**
4140
- * The options that are required to initialize the Chasepay payment method.
4141
- * They can be omitted unless you need to support Chasepay.
4142
- */
4143
- chasepay?: ChasePayCustomerInitializeOptions;
4144
- /**
4145
- * The options that are required to initialize the Masterpass payment method.
4146
- * They can be omitted unless you need to support Masterpass.
4147
- */
4148
- masterpass?: MasterpassCustomerInitializeOptions;
4149
- /**
4150
- * The options that are required to initialize the GooglePay payment method.
4151
- * They can be omitted unless you need to support GooglePay.
4152
- */
4153
- googlepayadyenv2?: GooglePayCustomerInitializeOptions;
4154
- /**
4155
- * The options that are required to initialize the GooglePay payment method.
4156
- * They can be omitted unless you need to support GooglePay.
4157
- */
4158
- googlepayadyenv3?: GooglePayCustomerInitializeOptions;
4159
- /**
4160
- * The options that are required to initialize the GooglePay payment method.
4161
- * They can be omitted unless you need to support GooglePay.
4162
- */
4163
- googlepayauthorizenet?: GooglePayCustomerInitializeOptions;
4164
- /**
4165
- * The options that are required to initialize the GooglePay payment method.
4166
- * They can be omitted unless you need to support GooglePay.
4167
- */
4168
- googlepaybraintree?: GooglePayCustomerInitializeOptions;
4169
- /**
4170
- * The options that are required to initialize the GooglePay payment method.
4171
- * They can be omitted unless you need to support GooglePay.
4172
- */
4173
- googlepaycheckoutcom?: GooglePayCustomerInitializeOptions;
4174
- /**
4175
- * The options that are required to initialize the GooglePay payment method.
4176
- * They can be omitted unless you need to support GooglePay.
4177
- */
4178
- googlepaycybersourcev2?: GooglePayCustomerInitializeOptions;
4179
- /**
4180
- * The options that are required to initialize the GooglePay payment method.
4181
- * They can be omitted unless you need to support GooglePay.
4182
- */
4183
- googlepayorbital?: GooglePayCustomerInitializeOptions;
4313
+ }
4314
+
4315
+ declare interface CustomError extends Error {
4316
+ message: string;
4317
+ type: string;
4318
+ subtype?: string;
4319
+ }
4320
+
4321
+ declare interface CustomItem {
4322
+ id: string;
4323
+ listPrice: number;
4324
+ extendedListPrice: number;
4325
+ name: string;
4326
+ quantity: number;
4327
+ sku: string;
4328
+ }
4329
+
4330
+ declare interface Customer {
4331
+ id: number;
4332
+ addresses: CustomerAddress[];
4333
+ storeCredit: number;
4184
4334
  /**
4185
- * The options that are required to initialize the GooglePay payment method.
4186
- * They can be omitted unless you need to support GooglePay.
4335
+ * The email address of the signed in customer.
4187
4336
  */
4188
- googlepaystripe?: GooglePayCustomerInitializeOptions;
4337
+ email: string;
4338
+ firstName: string;
4339
+ fullName: string;
4340
+ isGuest: boolean;
4341
+ lastName: string;
4189
4342
  /**
4190
- * The options that are required to initialize the GooglePay payment method.
4191
- * They can be omitted unless you need to support GooglePay.
4343
+ * Indicates whether the customer should be prompted to sign-in.
4344
+ *
4345
+ * Note: You need to enable "Prompt existing accounts to sign in" in your Checkout Settings.
4192
4346
  */
4193
- googlepaystripeupe?: GooglePayCustomerInitializeOptions;
4347
+ shouldEncourageSignIn: boolean;
4348
+ customerGroup?: CustomerGroup;
4349
+ }
4350
+
4351
+ declare interface CustomerAccountRequestBody {
4352
+ firstName: string;
4353
+ lastName: string;
4354
+ email: string;
4355
+ password: string;
4356
+ acceptsMarketingEmails?: boolean;
4357
+ customFields?: Array<{
4358
+ fieldId: string;
4359
+ fieldValue: string | number | string[];
4360
+ }>;
4361
+ }
4362
+
4363
+ declare interface CustomerAddress extends Address {
4364
+ id: number;
4365
+ type: string;
4366
+ }
4367
+
4368
+ declare type CustomerAddressRequestBody = AddressRequestBody;
4369
+
4370
+ declare interface CustomerCredentials {
4371
+ email: string;
4372
+ password: string;
4373
+ }
4374
+
4375
+ declare interface CustomerGroup {
4376
+ id: number;
4377
+ name: string;
4194
4378
  }
4195
4379
 
4380
+ declare type CustomerInitializeOptions = BaseCustomerInitializeOptions & WithApplePayCustomerInitializeOptions;
4381
+
4196
4382
  declare interface CustomerPasswordRequirements {
4197
4383
  alpha: string;
4198
4384
  numeric: string;
@@ -5631,180 +5817,7 @@ declare interface PayPalInstrument extends BaseAccountInstrument {
5631
5817
  method: 'paypal';
5632
5818
  }
5633
5819
 
5634
- /**
5635
- * A set of options that are required to initialize the payment step of the
5636
- * current checkout flow.
5637
- */
5638
- declare interface PaymentInitializeOptions extends PaymentRequestOptions {
5639
- /**
5640
- * @alpha
5641
- * Please note that this option is currently in an early stage of
5642
- * development. Therefore the API is unstable and not ready for public
5643
- * consumption.
5644
- */
5645
- creditCard?: CreditCardPaymentInitializeOptions;
5646
- /**
5647
- * The options that are required to initialize the AdyenV2 payment
5648
- * method. They can be omitted unless you need to support AdyenV2.
5649
- */
5650
- adyenv2?: AdyenV2PaymentInitializeOptions;
5651
- /**
5652
- * The options that are required to initialize the AdyenV3 payment
5653
- * method. They can be omitted unless you need to support AdyenV3.
5654
- */
5655
- adyenv3?: AdyenV3PaymentInitializeOptions;
5656
- /**
5657
- * The options that are required to initialize the Amazon Pay payment
5658
- * method. They can be omitted unless you need to support AmazonPay.
5659
- */
5660
- amazon?: AmazonPayPaymentInitializeOptions;
5661
- /**
5662
- * The options that are required to initialize the Apple Pay payment
5663
- * method. They can be omitted unless you need to support AmazonPay.
5664
- */
5665
- applepay?: ApplePayPaymentInitializeOptions;
5666
- /**
5667
- * The options that are required to initialize the AmazonPayV2 payment
5668
- * method. They can be omitted unless you need to support AmazonPayV2.
5669
- */
5670
- amazonpay?: AmazonPayV2PaymentInitializeOptions;
5671
- /**
5672
- * The options that are required to initialize the BlueSnapV2 payment method.
5673
- * They can be omitted unless you need to support BlueSnapV2.
5674
- */
5675
- bluesnapv2?: BlueSnapV2PaymentInitializeOptions;
5676
- /**
5677
- * The options that allow Bolt to load the client script and handle the checkout.
5678
- * They can be omitted if Bolt's full checkout take over is intended.
5679
- */
5680
- bolt?: BoltPaymentInitializeOptions;
5681
- /**
5682
- * The options that are required to initialize the Braintree payment method.
5683
- * They can be omitted unless you need to support Braintree.
5684
- */
5685
- braintree?: BraintreePaymentInitializeOptions;
5686
- /**
5687
- * The options that are required to initialize the Visa Checkout payment
5688
- * method provided by Braintree. They can be omitted unless you need to
5689
- * support Visa Checkout.
5690
- */
5691
- braintreevisacheckout?: BraintreeVisaCheckoutPaymentInitializeOptions;
5692
- /**
5693
- * The options that are required to initialize the Digital River payment method.
5694
- * They can be omitted unless you need to support Digital River.
5695
- */
5696
- digitalriver?: DigitalRiverPaymentInitializeOptions;
5697
- /**
5698
- * The options that are required to initialize the Klarna payment method.
5699
- * They can be omitted unless you need to support Klarna.
5700
- */
5701
- klarna?: KlarnaPaymentInitializeOptions;
5702
- /**
5703
- * The options that are required to initialize the KlarnaV2 payment method.
5704
- * They can be omitted unless you need to support KlarnaV2.
5705
- */
5706
- klarnav2?: KlarnaV2PaymentInitializeOptions;
5707
- /**
5708
- * The options that are required to initialize the Masterpass payment method.
5709
- * They can be omitted unless you need to support Masterpass.
5710
- */
5711
- masterpass?: MasterpassPaymentInitializeOptions;
5712
- /**
5713
- * The options that are required to initialize the Moneris payment method.
5714
- * They can be omitted unless you need to support Moneris.
5715
- */
5716
- moneris?: MonerisPaymentInitializeOptions;
5717
- /**
5718
- * The options that are required to initialize the Opy payment
5719
- * method. They can be omitted unless you need to support Opy.
5720
- */
5721
- opy?: OpyPaymentInitializeOptions;
5722
- /**
5723
- * The options that are required to initialize the PayPal Express payment method.
5724
- * They can be omitted unless you need to support PayPal Express.
5725
- */
5726
- paypalexpress?: PaypalExpressPaymentInitializeOptions;
5727
- /**
5728
- * The options that are required to initialize the PayPal Commerce payment method.
5729
- * They can be omitted unless you need to support PayPal Commerce.
5730
- */
5731
- paypalcommerce?: PaypalCommerceInitializeOptions;
5732
- /**
5733
- * The options that are required to initialize the Square payment method.
5734
- * They can be omitted unless you need to support Square.
5735
- */
5736
- square?: SquarePaymentInitializeOptions;
5737
- /**
5738
- * The options that are required to initialize the Chasepay payment method.
5739
- * They can be omitted unless you need to support Chasepay.
5740
- */
5741
- chasepay?: ChasePayInitializeOptions;
5742
- /**
5743
- * The options that are required to initialize the GooglePay Authorize.Net
5744
- * payment method. They can be omitted unless you need to support GooglePay.
5745
- */
5746
- googlepayadyenv2?: GooglePayPaymentInitializeOptions;
5747
- /**
5748
- * The options that are required to initialize the GooglePay Authorize.Net
5749
- * payment method. They can be omitted unless you need to support GooglePay.
5750
- */
5751
- googlepayadyenv3?: GooglePayPaymentInitializeOptions;
5752
- /**
5753
- * The options that are required to initialize the GooglePay Authorize.Net
5754
- * payment method. They can be omitted unless you need to support GooglePay.
5755
- */
5756
- googlepayauthorizenet?: GooglePayPaymentInitializeOptions;
5757
- /**
5758
- * The options that are required to initialize the GooglePay Braintree payment method.
5759
- * They can be omitted unless you need to support GooglePay.
5760
- */
5761
- googlepaybraintree?: GooglePayPaymentInitializeOptions;
5762
- /**
5763
- * The options that are required to initialize the GooglePay Checkout.com payment method.
5764
- * They can be omitted unless you need to support GooglePay.
5765
- */
5766
- googlepaycheckoutcom?: GooglePayPaymentInitializeOptions;
5767
- /**
5768
- * The options that are required to initialize the GooglePay CybersourceV2 payment method.
5769
- * They can be omitted unless you need to support GooglePay.
5770
- */
5771
- googlepaycybersourcev2?: GooglePayPaymentInitializeOptions;
5772
- /**
5773
- * The options that are required to initialize the GooglePay payment method.
5774
- * They can be omitted unless you need to support GooglePay.
5775
- */
5776
- googlepayorbital?: GooglePayPaymentInitializeOptions;
5777
- /**
5778
- * The options that are required to initialize the GooglePay Stripe payment method.
5779
- * They can be omitted unless you need to support GooglePay.
5780
- */
5781
- googlepaystripe?: GooglePayPaymentInitializeOptions;
5782
- /**
5783
- * The options that are required to initialize the GooglePay Stripe payment method.
5784
- * They can be omitted unless you need to support GooglePay.
5785
- */
5786
- googlepaystripeupe?: GooglePayPaymentInitializeOptions;
5787
- /**
5788
- * The options that are required to initialize the Stripe payment method.
5789
- * They can be omitted unless you need to support StripeV3.
5790
- */
5791
- stripev3?: StripeV3PaymentInitializeOptions;
5792
- /**
5793
- * The options that are required to initialize the StripeUPE payment method.
5794
- * They can be omitted unless you need to support StripeUPE.
5795
- */
5796
- stripeupe?: StripeUPEPaymentInitializeOptions;
5797
- /**
5798
- * The options that are required to initialize the Mollie payment method.
5799
- * They can be omitted unless you need to support Mollie.
5800
- */
5801
- mollie?: MolliePaymentInitializeOptions;
5802
- /**
5803
- * The options that are required to initialize the Worldpay payment method.
5804
- * They can be omitted unless you need to support Worldpay.
5805
- */
5806
- worldpay?: WorldpayPaymentInitializeOptions;
5807
- }
5820
+ declare type PaymentInitializeOptions = BasePaymentInitializeOptions & WithApplePayPaymentInitializeOptions;
5808
5821
 
5809
5822
  declare type PaymentInstrument = CardInstrument | AccountInstrument;
5810
5823
 
@@ -7121,6 +7134,26 @@ declare interface WithAccountCreation {
7121
7134
  shouldCreateAccount?: boolean;
7122
7135
  }
7123
7136
 
7137
+ declare interface WithApplePayButtonInitializeOptions {
7138
+ applepay?: ApplePayButtonInitializeOptions_2;
7139
+ }
7140
+
7141
+ declare interface WithApplePayCustomerInitializeOptions {
7142
+ /**
7143
+ * The options that are required to initialize the customer step of checkout
7144
+ * when using ApplePay.
7145
+ */
7146
+ applepay?: ApplePayCustomerInitializeOptions;
7147
+ }
7148
+
7149
+ declare interface WithApplePayPaymentInitializeOptions {
7150
+ /**
7151
+ * The options that are required to initialize the Apple Pay payment
7152
+ * method. They can be omitted unless you need to support Apple Pay.
7153
+ */
7154
+ applepay?: ApplePayPaymentInitializeOptions;
7155
+ }
7156
+
7124
7157
  declare interface WithCheckoutcomFawryInstrument {
7125
7158
  customerMobile: string;
7126
7159
  customerEmail: string;