@stripe/stripe-react-native 0.20.0 → 0.22.0

package/src/components/AddressSheet.tsx

@@ -0,0 +1,82 @@
+import React from 'react';
+import {
+  AccessibilityProps,
+  requireNativeComponent,
+  NativeSyntheticEvent,
+} from 'react-native';
+import type {
+  PaymentSheet,
+  AddressDetails,
+  StripeError,
+  AddressSheetError,
+} from '../types';
+
+const AddressSheetNative = requireNativeComponent<any>('AddressSheetView');
+
+/**
+ *  Props
+ */
+export interface Props extends AccessibilityProps {
+  /** Whether the sheet is visible. Defaults to false. */
+  visible: boolean;
+  /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. */
+  presentationStyle?: 'fullscreen' | 'popover';
+  /** Controls how the modal animates. iOS only. */
+  animationStyle?: 'flip' | 'curl' | 'slide' | 'dissolve';
+  /** Configuration for the look and feel of the UI. */
+  appearance?: PaymentSheet.AppearanceParams;
+  /** The values to prepopulate the sheet's fields with. */
+  defaultValues?: AddressDetails;
+  /** Configuration for additional fields besides the physical address */
+  additionalFields?: {
+    /** Determines whether the phone number is hidden, required, or optional. Defaults to hidden. */
+    phoneNumber?: 'hidden' | 'optional' | 'required';
+    /** The label of a checkbox displayed below other fields. If null or undefined, the checkbox is not displayed. */
+    checkboxLabel?: string;
+  };
+  /** A list of two-letter country codes representing countries the customers can select. If the list is empty (the default), we display all countries. */
+  allowedCountries?: Array<string>;
+  /** A list of two-letter country codes representing countries that support address autocomplete. Defaults to a list of countries that Stripe has audited to ensure a good autocomplete experience. */
+  autocompleteCountries?: Array<string>;
+  /** The title of the primary button displayed at the bottom of the screen. Defaults to "Save Address". */
+  primaryButtonTitle?: string;
+  /** Title displayed at the top of the sheet. Defaults to "Address". */
+  sheetTitle?: string;
+  /** Android only. Google Places api key used to provide autocomplete suggestions. When null, autocomplete is disabled on Android. */
+  googlePlacesApiKey?: string;
+  /** Called when the user submits their information */
+  onSubmit: (result: CollectAddressResult) => void;
+  /** Called when the user taps the button to close the sheet before submitting their information, or when an error occurs. */
+  onError: (error: StripeError<AddressSheetError>) => void;
+}
+
+export type CollectAddressResult = Required<AddressDetails>;
+
+/**
+ *
+ *
+ * @example
+ * ```ts
+ *  <AddressSheet
+ *
+ *  />
+ * ```
+ * @param __namedParameters Props
+ * @returns JSX.Element
+ * @category ReactComponents
+ */
+export function AddressSheet({ onSubmit, onError, ...props }: Props) {
+  return (
+    <AddressSheetNative
+      {...props}
+      onSubmitAction={(value: NativeSyntheticEvent<CollectAddressResult>) =>
+        onSubmit(value.nativeEvent)
+      }
+      onErrorAction={(
+        value: NativeSyntheticEvent<{
+          error: StripeError<AddressSheetError>;
+        }>
+      ) => onError(value.nativeEvent.error)}
+    />
+  );
+}

package/src/components/PlatformPayButton.tsx

@@ -0,0 +1,157 @@
+import React from 'react';
+import {
+  AccessibilityProps,
+  StyleProp,
+  ViewStyle,
+  requireNativeComponent,
+  TouchableOpacity,
+  StyleSheet,
+  Platform,
+  NativeSyntheticEvent,
+} from 'react-native';
+import {
+  ButtonType,
+  ButtonStyle,
+  ShippingMethod,
+  ShippingContact,
+} from '../types/PlatformPay';
+
+const GooglePayButtonNative = requireNativeComponent<any>('GooglePayButton');
+const ApplePayButtonNative = requireNativeComponent<any>('ApplePayButton');
+
+/**
+ *  PlatformPayButton Component Props
+ */
+export interface Props extends AccessibilityProps {
+  /** Sets the text displayed by the button. */
+  type?: ButtonType;
+  /** iOS only. Sets the coloring of the button. */
+  appearance?: ButtonStyle;
+  /** iOS only. Sets the border radius of the button. */
+  borderRadius?: number;
+  /** Function called whenever the button is pressed. */
+  onPress(): void;
+  /** Set to `true` to disable the button from being pressed & apply a slight opacity to indicate that it is unpressable. Defaults to false. */
+  disabled?: boolean;
+  /**
+   * This callback is triggered whenever the user selects a shipping method in the Apple Pay sheet.
+   * It receives one parameter: an `event` object with a `shippingMethod` field. You MUST
+   * update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+   * Apple Pay sheet will hang and the payment flow will automatically cancel.
+   */
+  onShippingMethodSelected?: (event: {
+    shippingMethod: ShippingMethod;
+  }) => void;
+  /**
+   * This callback is triggered whenever the user selects a shipping contact in the Apple Pay sheet.
+   * It receives one parameter: an `event` object with a `shippingContact` field. You MUST
+   * update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+   * Apple Pay sheet will hang and the payment flow will automatically cancel.
+   */
+  onShippingContactSelected?: (event: {
+    shippingContact: ShippingContact;
+  }) => void;
+  /**
+   * This callback is triggered whenever the user inputs a coupon code in the Apple Pay sheet.
+   * It receives one parameter: an `event` object with a `couponCode` field. You MUST
+   * update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+   * Apple Pay sheet will hang and the payment flow will automatically cancel.
+   */
+  onCouponCodeEntered?: (event: { couponCode: string }) => void;
+  testID?: string;
+  style?: StyleProp<ViewStyle>;
+}
+
+/**
+ *  PlatformPayButton Component. Display the platform-specific native wallet pay button: Apple Pay on iOS, and Google Pay on Android.
+ *
+ * @example
+ * ```ts
+ *  <PlatformPayButton
+ *    onPress={pay}
+ *    type={PlatformPay.ButtonType.Subscribe}
+ *    appearance={PlatformPay.ButtonStyle.WhiteOutline}
+ *    borderRadius={4}
+ *    disabled={!isApplePaySupported}
+ *    style={styles.payButton}
+ *  />
+ * ```
+ * @param __namedParameters Props
+ * @returns JSX.Element
+ * @category ReactComponents
+ */
+export function PlatformPayButton({
+  type = ButtonType.Default,
+  appearance = ButtonStyle.Automatic,
+  onPress,
+  disabled,
+  borderRadius,
+  onShippingMethodSelected,
+  onShippingContactSelected,
+  onCouponCodeEntered,
+  ...props
+}: Props) {
+  const shippingMethodCallback = onShippingMethodSelected
+    ? (
+        value: NativeSyntheticEvent<{
+          shippingMethod: ShippingMethod;
+        }>
+      ) => {
+        onShippingMethodSelected && onShippingMethodSelected(value.nativeEvent);
+      }
+    : undefined;
+
+  const shippingContactCallback = onShippingContactSelected
+    ? (
+        value: NativeSyntheticEvent<{
+          shippingContact: ShippingContact;
+        }>
+      ) => {
+        onShippingContactSelected(value.nativeEvent);
+      }
+    : undefined;
+
+  const couponCodeCallback = onCouponCodeEntered
+    ? (
+        value: NativeSyntheticEvent<{
+          couponCode: string;
+        }>
+      ) => {
+        onCouponCodeEntered && onCouponCodeEntered(value.nativeEvent);
+      }
+    : undefined;
+
+  return (
+    <TouchableOpacity
+      disabled={disabled}
+      activeOpacity={disabled ? 0.3 : 1}
+      onPress={onPress}
+      style={disabled ? styles.disabled : styles.notDisabled}
+    >
+      {Platform.OS === 'ios' ? (
+        <ApplePayButtonNative
+          type={type}
+          buttonStyle={appearance}
+          borderRadius={borderRadius}
+          disabled={disabled}
+          onShippingMethodSelectedAction={shippingMethodCallback}
+          onShippingContactSelectedAction={shippingContactCallback}
+          onCouponCodeEnteredAction={couponCodeCallback}
+          {...props}
+        />
+      ) : (
+        <GooglePayButtonNative type={type} {...props} />
+      )}
+    </TouchableOpacity>
+  );
+}
+
+const styles = StyleSheet.create({
+  disabled: {
+    flex: 0,
+    opacity: 0.3,
+  },
+  notDisabled: {
+    flex: 0,
+  },
+});

package/src/functions.ts

@@ -5,6 +5,7 @@ import {
   ApplePay,
   ApplePayError,
   ApplePayResult,
+  PlatformPayError,
   ConfirmPaymentResult,
   ConfirmPaymentSheetPaymentResult,
   SetupIntent,
@@ -36,6 +37,7 @@ import {
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
   FinancialConnections,
+  PlatformPay,
 } from './types';
 import { Platform } from 'react-native';
 
@@ -174,10 +176,12 @@ export const confirmPayment = async (
   }
 };
 
+/** @deprecated Use `isPlatformPaySupported` instead. */
 export const isApplePaySupported = async (): Promise<boolean> => {
   return isiOS && (await NativeStripeSdk.isApplePaySupported());
 };
 
+/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
 export const presentApplePay = async (
   params: ApplePay.PresentParams
 ): Promise<ApplePayResult> => {
@@ -207,6 +211,7 @@ export const presentApplePay = async (
   }
 };
 
+/** @deprecated Use `updatePlatformPaySheet` instead. */
 export const updateApplePaySummaryItems = async (
   summaryItems: ApplePay.CartSummaryItem[],
   errorAddressFields: Array<{
@@ -237,6 +242,7 @@ export const updateApplePaySummaryItems = async (
   }
 };
 
+/** @deprecated Use `confirmPlatformPaySetupIntent` or `confirmPlatformPayPayment` instead. */
 export const confirmApplePayPayment = async (
   clientSecret: string
 ): Promise<{ error?: StripeError<ApplePayError> }> => {
@@ -464,6 +470,7 @@ export const resetPaymentSheetCustomer = async (): Promise<null> => {
   return await NativeStripeSdk.resetPaymentSheetCustomer();
 };
 
+/** @deprecated Use `isPlatformPaySupported` instead. */
 export const isGooglePaySupported = async (
   params?: GooglePay.IsSupportedParams
 ): Promise<boolean> => {
@@ -472,6 +479,7 @@ export const isGooglePaySupported = async (
   );
 };
 
+/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
 export const initGooglePay = async (
   params: GooglePay.InitParams
 ): Promise<GooglePayInitResult> => {
@@ -490,6 +498,7 @@ export const initGooglePay = async (
   }
 };
 
+/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
 export const presentGooglePay = async (
   params: GooglePay.PresentParams
 ): Promise<PayWithGooglePayResult> => {
@@ -508,6 +517,7 @@ export const presentGooglePay = async (
   }
 };
 
+/** @deprecated Use `createPlatformPayPaymentMethod` instead. */
 export const createGooglePayPaymentMethod = async (
   params: GooglePay.CreatePaymentMethodParams
 ): Promise<CreateGooglePayPaymentMethodResult> => {
@@ -529,6 +539,7 @@ export const createGooglePayPaymentMethod = async (
   }
 };
 
+/** @deprecated Use `openNativePaySetup` instead. */
 export const openApplePaySetup = async (): Promise<OpenApplePaySetupResult> => {
   try {
     const { error } = await NativeStripeSdk.openApplePaySetup();
@@ -654,6 +665,12 @@ export const collectFinancialConnectionsAccounts = async (
   }
 };
 
+/**
+ * Check if the app & device support adding this card to the native wallet.
+ * @param params An object containing fields for `primaryAccountIdentifier`, `cardLastFour`, and `testEnv`.
+ *
+ * @returns A promise resolving to an object of type CanAddCardToWalletResult. Check the `canAddCard` field, if it's true, you should show the `<AddToWalletButton />`
+ */
 export const canAddCardToWallet = async (
   params: CanAddCardToWalletParams
 ): Promise<CanAddCardToWalletResult> => {
@@ -677,6 +694,7 @@ export const canAddCardToWallet = async (
   }
 };
 
+/** @deprecated Please use `canAddCardToWallet` instead. */
 export const isCardInWallet = async (params: {
   cardLastFour: string;
 }): Promise<IsCardInWalletResult> => {
@@ -702,3 +720,166 @@ export const isCardInWallet = async (params: {
 };
 
 export const Constants = NativeStripeSdk.getConstants();
+
+/**
+ * Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.
+ * @returns A boolean indicating whether or not the native wallet is supported.
+ */
+export const isPlatformPaySupported = async (params?: {
+  googlePay?: PlatformPay.IsGooglePaySupportedParams;
+}): Promise<boolean> => {
+  return await NativeStripeSdk.isPlatformPaySupported(params ?? {});
+};
+
+/**
+ * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe [SetupIntent](https://stripe.com/docs/api/setup_intents).
+ * @param clientSecret The client secret of the SetupIntent.
+ * @param params an object describing the Apple Pay and Google Pay configurations.
+ * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `setupIntent` and `paymentMethod` fields.
+ */
+export const confirmPlatformPaySetupIntent = async (
+  clientSecret: string,
+  params: PlatformPay.ConfirmParams
+): Promise<PlatformPay.ConfirmSetupIntentResult> => {
+  try {
+    const { error, setupIntent } = (await NativeStripeSdk.confirmPlatformPay(
+      clientSecret,
+      params,
+      false
+    )) as PlatformPay.ConfirmSetupIntentResult;
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      setupIntent: setupIntent!,
+    };
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe [PaymentIntent](https://stripe.com/docs/api/payment_intents).
+ * @param clientSecret The client secret of the PaymentIntent.
+ * @param params an object describing the Apple Pay and Google Pay configurations.
+ * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentIntent` and `paymentMethod` fields.
+ */
+export const confirmPlatformPayPayment = async (
+  clientSecret: string,
+  params: PlatformPay.ConfirmParams
+): Promise<PlatformPay.ConfirmPaymentResult> => {
+  try {
+    const { error, paymentIntent } = (await NativeStripeSdk.confirmPlatformPay(
+      clientSecret,
+      params,
+      true
+    )) as PlatformPay.ConfirmPaymentResult;
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      paymentIntent: paymentIntent!,
+    };
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * iOS only, this will always return false on Android. Dismisses the Apple Pay sheet if it is open.
+ * @returns A boolean indicating whether or not the sheet was successfully closed. Will return false if the Apple Pay sheet was not open.
+ */
+export const dismissPlatformPay = async (): Promise<boolean> => {
+  if (Platform.OS !== 'ios') {
+    return false;
+  }
+  try {
+    const didDismiss = await NativeStripeSdk.dismissPlatformPay();
+    return didDismiss;
+  } catch (error: any) {
+    return false;
+  }
+};
+
+/**
+ * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [PaymentMethod](https://stripe.com/docs/api/payment_methods) and [token](https://stripe.com/docs/api/tokens).
+ * @param params an object describing the Apple Pay and Google Pay configurations.
+ * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentMethod` and `token` fields.
+ */
+export const createPlatformPayPaymentMethod = async (
+  params: PlatformPay.PaymentMethodParams
+): Promise<PlatformPay.PaymentMethodResult> => {
+  try {
+    const { error, paymentMethod, token } =
+      await NativeStripeSdk.createPlatformPayPaymentMethod(params);
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      paymentMethod: paymentMethod!,
+      token: token!,
+    };
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * iOS only. Update different items on the Apple Pay sheet, including the summary items, the shipping methods, and any errors shown. iOS only, this is a no-op on Android.
+ * @param params an object describing the Apple Pay configuration, with the following fields:
+ * - cartItems An array of payment summary items to display in the Apple Pay sheet.
+ * - shippingMethods An array of shipping methods to display in the Apple Pay sheet.
+ * - errors An array of errors associated with the user's input that must be corrected to proceed with payment. These errors will be shown in the Apple Pay sheet.
+ *
+ * @returns An object with an optional 'error' field, which is only populated if something went wrong.
+ */
+export const updatePlatformPaySheet = async (params: {
+  applePay: {
+    cartItems: Array<PlatformPay.CartSummaryItem>;
+    shippingMethods: Array<PlatformPay.ShippingMethod>;
+    errors: Array<PlatformPay.ApplePaySheetError>;
+  };
+}): Promise<{
+  error?: StripeError<PlatformPayError>;
+}> => {
+  if (Platform.OS !== 'ios') {
+    return {};
+  }
+
+  try {
+    await NativeStripeSdk.updatePlatformPaySheet(
+      params.applePay.cartItems,
+      params.applePay.shippingMethods,
+      params.applePay.errors
+    );
+
+    return {};
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * iOS only, this is a no-op on Android. Use this method to move users to the interface for adding credit cards.
+ * This method transfers control to the Wallet app on iPhone or to the Settings
+ * app on iPad. For devices that don’t support Apple Pay, this method does nothing.
+ */
+export const openPlatformPaySetup = async (): Promise<void> => {
+  if (Platform.OS === 'ios') {
+    await NativeStripeSdk.openApplePaySetup();
+  }
+};

package/src/hooks/usePlatformPay.tsx

@@ -0,0 +1,174 @@
+import { useCallback, useState } from 'react';
+import type {
+  PlatformPay,
+  CanAddCardToWalletParams,
+  CanAddCardToWalletResult,
+} from '../types';
+import { useStripe } from './useStripe';
+
+/**
+ * usePlatformPay hook. Access all Apple and Google Pay functionality with this hook.
+ */
+export function usePlatformPay() {
+  const {
+    isPlatformPaySupported,
+    confirmPlatformPaySetupIntent,
+    confirmPlatformPayPayment,
+    createPlatformPayPaymentMethod,
+    dismissPlatformPay,
+    updatePlatformPaySheet,
+    canAddCardToWallet,
+    openPlatformPaySetup,
+  } = useStripe();
+  const [loading, setLoading] = useState(false);
+
+  const _isPlatformPaySupported = useCallback(
+    async (params?: { googlePay?: PlatformPay.IsGooglePaySupportedParams }) => {
+      setLoading(true);
+
+      const result = await isPlatformPaySupported(params);
+      setLoading(false);
+
+      return result;
+    },
+    [isPlatformPaySupported]
+  );
+
+  const _confirmPlatformPaySetupIntent = useCallback(
+    async (clientSecret: string, params: PlatformPay.ConfirmParams) => {
+      setLoading(true);
+
+      const result = await confirmPlatformPaySetupIntent(clientSecret, params);
+      setLoading(false);
+
+      return result;
+    },
+    [confirmPlatformPaySetupIntent]
+  );
+
+  const _confirmPlatformPayPayment = useCallback(
+    async (clientSecret: string, params: PlatformPay.ConfirmParams) => {
+      setLoading(true);
+
+      const result = await confirmPlatformPayPayment(clientSecret, params);
+      setLoading(false);
+
+      return result;
+    },
+    [confirmPlatformPayPayment]
+  );
+
+  const _createPlatformPayPaymentMethod = useCallback(
+    async (params: PlatformPay.PaymentMethodParams) => {
+      setLoading(true);
+
+      const result = await createPlatformPayPaymentMethod(params);
+      setLoading(false);
+
+      return result;
+    },
+    [createPlatformPayPaymentMethod]
+  );
+
+  const _dismissPlatformPay = useCallback(async () => {
+    setLoading(true);
+
+    const result = await dismissPlatformPay();
+    setLoading(false);
+
+    return result;
+  }, [dismissPlatformPay]);
+
+  const _updatePlatformPaySheet = useCallback(
+    async (params: {
+      applePay: {
+        cartItems: Array<PlatformPay.CartSummaryItem>;
+        shippingMethods: Array<PlatformPay.ShippingMethod>;
+        errors: Array<PlatformPay.ApplePaySheetError>;
+      };
+    }) => {
+      setLoading(true);
+
+      const result = await updatePlatformPaySheet(params);
+      setLoading(false);
+
+      return result;
+    },
+    [updatePlatformPaySheet]
+  );
+
+  const _canAddCardToWallet = useCallback(
+    async (
+      params: CanAddCardToWalletParams
+    ): Promise<CanAddCardToWalletResult> => {
+      setLoading(true);
+
+      const result = await canAddCardToWallet(params);
+      setLoading(false);
+
+      return result;
+    },
+    [canAddCardToWallet]
+  );
+
+  const _openPlatformPaySetup = useCallback(async (): Promise<void> => {
+    return openPlatformPaySetup();
+  }, [openPlatformPaySetup]);
+
+  return {
+    /** Use this boolean to present a spinner or other similar loading screen. `true` if the SDK is currently processing, `false` if it is not. */
+    loading,
+    /**
+     * Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.
+     * @returns A boolean indicating whether or not the native wallet is supported.
+     */
+    isPlatformPaySupported: _isPlatformPaySupported,
+    /**
+     * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe [SetupIntent](https://stripe.com/docs/api/setup_intents).
+     * @param clientSecret The client secret of the SetupIntent.
+     * @param params an object describing the Apple Pay and Google Pay configurations.
+     * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `setupIntent` and `paymentMethod` fields.
+     */
+    confirmPlatformPaySetupIntent: _confirmPlatformPaySetupIntent,
+    /**
+     * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe [PaymentIntent](https://stripe.com/docs/api/payment_intents).
+     * @param clientSecret The client secret of the PaymentIntent.
+     * @param params an object describing the Apple Pay and Google Pay configurations.
+     * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentIntent` and `paymentMethod` fields.
+     */
+    confirmPlatformPayPayment: _confirmPlatformPayPayment,
+    /**
+     * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [PaymentMethod](https://stripe.com/docs/api/payment_methods) and [token](https://stripe.com/docs/api/tokens).
+     * @param params an object describing the Apple Pay and Google Pay configurations.
+     * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentMethod` and `token` fields.
+     */
+    createPlatformPayPaymentMethod: _createPlatformPayPaymentMethod,
+    /**
+     * Dismiss the Apple Pay sheet if it is open. iOS only, this is a no-op on Android.
+     * @returns A boolean indicating whether or not the sheet was successfully closed. Will return false if the Apple Pay sheet was not open.
+     */
+    dismissPlatformPay: _dismissPlatformPay,
+    /**
+     * Update different items on the Apple Pay sheet, including the summary items, the shipping methods, and any errors shown. iOS only, this is a no-op on Android.
+     * @param cartItems An array of payment summary items to display in the Apple Pay sheet.
+     * @param shippingMethods An array of shipping methods to display in the Apple Pay sheet.
+     * @param errors An array of errors associated with the user's input that must be corrected to proceed with payment. These errors will be shown in the Apple Pay sheet.
+     *
+     * @returns An object with an optional 'error' field, which is only populated if something went wrong.
+     */
+    updatePlatformPaySheet: _updatePlatformPaySheet,
+    /**
+     * Check if the app & device support adding this card to the native wallet.
+     * @param params An object containing fields for `primaryAccountIdentifier`, `cardLastFour`, and `testEnv`.
+     *
+     * @returns A promise resolving to an object of type CanAddCardToWalletResult. Check the `canAddCard` field, if it's true, you should show the `<AddToWalletButton />`
+     */
+    canAddCardToWallet: _canAddCardToWallet,
+    /**
+     * iOS only, this is a no-op on Android. Use this method to move users to the interface for adding credit cards.
+     * This method transfers control to the Wallet app on iPhone or to the Settings
+     * app on iPad. For devices that don’t support Apple Pay, this method does nothing.
+     */
+    openPlatformPaySetup: _openPlatformPaySetup,
+  };
+}