@capacitor-community/stripe-terminal 6.1.0 → 6.2.1

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA6BA,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nimport type { TerminalEventsEnum } from './events.enum';\nimport type {\n  TerminalConnectTypes,\n  UpdateTimeEstimate,\n  SimulateReaderUpdate,\n  SimulatedCardType,\n  BatteryStatus,\n  ReaderEvent,\n  ReaderDisplayMessage,\n  ReaderInputOption,\n  PaymentStatus,\n  DisconnectReason,\n  ConnectionStatus,\n} from './stripe.enum';\n\nexport type ReaderInterface = {\n  index: number;\n  serialNumber: string;\n};\n\nexport type ReaderSoftwareUpdateInterface = {\n  version: string;\n  settingsVersion: string;\n  requiredAt: number;\n  timeEstimate: UpdateTimeEstimate;\n};\n\nexport * from './events.enum';\nexport * from './stripe.enum';\nexport interface StripeTerminalPlugin {\n  initialize(options: {\n    tokenProviderEndpoint?: string;\n    isTest: boolean;\n  }): Promise<void>;\n  discoverReaders(options: {\n    type: TerminalConnectTypes;\n    locationId?: string;\n  }): Promise<{\n    readers: ReaderInterface[];\n  }>;\n  setConnectionToken(options: { token: string }): Promise<void>;\n  /**\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-simulator-configuration/index.html)\n   */\n  setSimulatorConfiguration(options: {\n    update?: SimulateReaderUpdate;\n    simulatedCard?: SimulatedCardType;\n    simulatedTipAmount?: number;\n  }): Promise<void>;\n  connectReader(options: { reader: ReaderInterface }): Promise<void>;\n  getConnectedReader(): Promise<{ reader: ReaderInterface | null }>;\n  disconnectReader(): Promise<void>;\n  cancelDiscoverReaders(): Promise<void>;\n  collectPaymentMethod(options: { paymentIntent: string }): Promise<void>;\n  cancelCollectPaymentMethod(): Promise<void>;\n  confirmPaymentIntent(): Promise<void>;\n\n  addListener(\n    eventName: TerminalEventsEnum.Loaded,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.RequestedConnectionToken,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.DiscoveredReaders,\n    listenerFunc: ({ readers }: { readers: ReaderInterface[] }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ConnectedReader,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when the reader is disconnected, either in response to [`disconnectReader()`](#disconnectreader)\n   * or some connection error.\n   *\n   * For all reader types, this is emitted in response to [`disconnectReader()`](#disconnectreader)\n   * without a `reason` property.\n   *\n   * For Bluetooth and USB readers, this is emitted with a `reason` property when the reader disconnects.\n   *\n   * **Note:** For Bluetooth and USB readers, when you call [`disconnectReader()`](#disconnectreader), this event\n   * will be emitted twice: one without a `reason` in acknowledgement of your call, and again with a `reason` when the reader\n   * finishes disconnecting.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.DisconnectedReader,\n    listenerFunc: ({ reason }: { reason?: DisconnectReason }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when the Terminal's connection status changed.\n   *\n   * Note: You should *not* use this method to detect when a reader unexpectedly disconnects from your app,\n   * as it cannot be used to accurately distinguish between expected and unexpected disconnect events.\n   *\n   * To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use\n   * the UnexpectedReaderDisconnect event.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-connection-status-change.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ConnectionStatusChange,\n    listenerFunc: ({ status }: { status: ConnectionStatus }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * The Terminal disconnected unexpectedly from the reader.\n   *\n   * In your implementation of this method, you may want to notify your user that the reader disconnected.\n   * You may also call [`discoverReaders()`](#discoverreaders) to begin scanning for readers, and attempt\n   * to automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it\n   * possible to cancel calls to `discoverReaders()`\n   *\n   * When connected to a Bluetooth or USB reader, you can get more information about the disconnect by\n   * implementing the DisconnectedReader event.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-unexpected-reader-disconnect.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.UnexpectedReaderDisconnect,\n    listenerFunc: ({ reader }: { reader: ReaderInterface }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ConfirmedPaymentIntent,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.CollectedPaymentIntent,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when [`cancelCollectPaymentMethod()`](#cancelcollectpaymentmethod) is called and succeeds.\n   * The Promise returned by `cancelCollectPaymentMethod()` will also be resolved.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.Canceled,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when either [`collectPaymentMethod()`](#collectpaymentmethod) or [`confirmPaymentIntent()`](#confirmpaymentintent)\n   * fails. The Promise returned by the relevant call will also be rejected.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.Failed,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when a software update is available for the connected reader.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReportAvailableUpdate,\n    listenerFunc: ({\n      update,\n    }: {\n      update: ReaderSoftwareUpdateInterface;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the connected reader begins installing a software update.\n   * If a mandatory software update is available when a reader first connects, that update is\n   * automatically installed. The update will be installed before ConnectedReader is emitted and\n   * before the Promise returned by [`connectReader()`](#connectreader) resolves.\n   * In this case, you will receive this sequence of events:\n   *\n   * 1. StartInstallingUpdate\n   * 2. ReaderSoftwareUpdateProgress (repeatedly)\n   * 3. FinishInstallingUpdates\n   * 4. ConnectedReader\n   * 5. `connectReader()` Promise resolves\n   *\n   * Your app should show UI to the user indiciating that a software update is being installed\n   * to explain why connecting is taking longer than usual.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-start-installing-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.StartInstallingUpdate,\n    listenerFunc: ({\n      update,\n    }: {\n      update: ReaderSoftwareUpdateInterface;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted periodically while reader software is updating to inform of the installation progress.\n   * `progress` is a float between 0 and 1.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-report-reader-software-update-progress.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress,\n    listenerFunc: ({ progress }: { progress: number }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-finish-installing-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.FinishInstallingUpdate,\n    listenerFunc: (\n      args:\n        | {\n            update: ReaderSoftwareUpdateInterface;\n          }\n        | {\n            error: string;\n          },\n    ) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted upon connection and every 10 minutes.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-battery-level-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.BatteryLevel,\n    listenerFunc: ({\n      level,\n      charging,\n      status,\n    }: {\n      level: number;\n      charging: boolean;\n      status: BatteryStatus;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listenable/on-report-reader-event.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReaderEvent,\n    listenerFunc: ({ event }: { event: ReaderEvent }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the Terminal requests that a message be displayed in your app.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-display-message.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.RequestDisplayMessage,\n    listenerFunc: ({\n      messageType,\n      message,\n    }: {\n      messageType: ReaderDisplayMessage;\n      message: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the reader begins waiting for input. Your app should prompt the customer\n   * to present a source using one of the given input options. If the reader emits a message,\n   * the RequestDisplayMessage event will be emitted.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-input.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.RequestReaderInput,\n    listenerFunc: ({\n      options,\n      message,\n    }: {\n      options: ReaderInputOption[];\n      message: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-payment-status-change.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.PaymentStatusChange,\n    listenerFunc: ({ status }: { status: PaymentStatus }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * @deprecated\n   * This method has been deprecated and replaced by the `collectPaymentMethod`.\n   * Similarly, note that TerminalEvents.Completed is now obsolete.\n   * And, method `confirmPaymentIntent` added to be executed after `collectPaymentMethod` is executed.\n   *\n   * This is left as type string to avoid accidental use.\n   */\n  collect: string;\n\n  /**\n   * @deprecated\n   * This method has been deprecated and replaced by the `cancelCollectPaymentMethod`.\n   *\n   * This is left as type string to avoid accidental use.\n   */\n  cancelCollect: string;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAkGA,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nimport type { TerminalEventsEnum } from './events.enum';\nimport type {\n  TerminalConnectTypes,\n  UpdateTimeEstimate,\n  SimulateReaderUpdate,\n  SimulatedCardType,\n  BatteryStatus,\n  ReaderEvent,\n  ReaderDisplayMessage,\n  ReaderInputOption,\n  PaymentStatus,\n  DisconnectReason,\n  ConnectionStatus,\n  NetworkStatus,\n  LocationStatus,\n  DeviceType,\n} from './stripe.enum';\n\nexport type ReaderInterface = {\n  /**\n   * The unique serial number is primary identifier inner plugin.\n   */\n  serialNumber: string;\n\n  label: string;\n  batteryLevel: number;\n  batteryStatus: BatteryStatus;\n  simulated: boolean;\n  id: number;\n  availableUpdate: ReaderSoftwareUpdateInterface | undefined;\n  locationId: string;\n  ipAddress: string;\n  status: NetworkStatus;\n  location: LocationInterface | undefined;\n  locationStatus: LocationStatus;\n  deviceType: DeviceType;\n  deviceSoftwareVersion: string | null;\n\n  /**\n   * iOS Only properties. These properties are not available on Android.\n   */\n  isCharging: number;\n\n  /**\n   * Android Only properties. These properties are not available on iOS.\n   */\n  baseUrl: string;\n  bootloaderVersion: string;\n  configVersion: string;\n  emvKeyProfileId: string;\n  firmwareVersion: string;\n  hardwareVersion: string;\n  macKeyProfileId: string;\n  pinKeyProfileId: string;\n  trackKeyProfileId: string;\n  settingsVersion: string;\n  pinKeysetId: string;\n\n  /**\n   * @deprecated This property has been deprecated and should use the `serialNumber` property.\n   */\n  index?: number;\n};\nexport type LocationInterface = {\n  id: string;\n  displayName: string;\n  address: {\n    city: string;\n    country: string;\n    postalCode: string;\n    line1: string;\n    line2: string;\n    state: string;\n  };\n  ipAddress: string;\n};\n\nexport type ReaderSoftwareUpdateInterface = {\n  deviceSoftwareVersion: string;\n  estimatedUpdateTime: UpdateTimeEstimate;\n  requiredAt: number;\n};\n\nexport type CartLineItem = {\n  displayName: string;\n  quantity: number;\n  amount: number;\n};\n\nexport type Cart = {\n  currency: string;\n  tax: number;\n  total: number;\n  lineItems: CartLineItem[];\n};\n\nexport * from './events.enum';\nexport * from './stripe.enum';\nexport interface StripeTerminalPlugin {\n  initialize(options: {\n    tokenProviderEndpoint?: string;\n    isTest: boolean;\n  }): Promise<void>;\n  discoverReaders(options: {\n    type: TerminalConnectTypes;\n    locationId?: string;\n  }): Promise<{\n    readers: ReaderInterface[];\n  }>;\n  setConnectionToken(options: { token: string }): Promise<void>;\n  /**\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-simulator-configuration/index.html)\n   */\n  setSimulatorConfiguration(options: {\n    update?: SimulateReaderUpdate;\n    simulatedCard?: SimulatedCardType;\n    simulatedTipAmount?: number;\n  }): Promise<void>;\n\n  /**\n   * @param options.autoReconnectOnUnexpectedDisconnect If true, the SDK will automatically attempt to reconnect to the reader. default is false.\n   */\n  connectReader(options: {\n    reader: ReaderInterface;\n    autoReconnectOnUnexpectedDisconnect?: boolean;\n\n    /**\n     * iOS and LocalMobileReader only. Android needs to be set to PaymentIntent only.\n     */\n    merchantDisplayName?: string;\n\n    /**\n     * iOS and LocalMobileReader only. Android needs to be set to PaymentIntent only.\n     * The Stripe account ID for which these funds are intended.\n     */\n    onBehalfOf?: string;\n  }): Promise<void>;\n  getConnectedReader(): Promise<{ reader: ReaderInterface | null }>;\n  disconnectReader(): Promise<void>;\n  cancelDiscoverReaders(): Promise<void>;\n  collectPaymentMethod(options: { paymentIntent: string }): Promise<void>;\n  cancelCollectPaymentMethod(): Promise<void>;\n  confirmPaymentIntent(): Promise<void>;\n  installAvailableUpdate(): Promise<void>;\n  cancelInstallUpdate(): Promise<void>;\n  setReaderDisplay(options: Cart): Promise<void>;\n  clearReaderDisplay(): Promise<void>;\n  rebootReader(): Promise<void>;\n  cancelReaderReconnection(): Promise<void>;\n\n  addListener(\n    eventName: TerminalEventsEnum.Loaded,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.RequestedConnectionToken,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.DiscoveredReaders,\n    listenerFunc: ({ readers }: { readers: ReaderInterface[] }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ConnectedReader,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when the reader is disconnected, either in response to [`disconnectReader()`](#disconnectreader)\n   * or some connection error.\n   *\n   * For all reader types, this is emitted in response to [`disconnectReader()`](#disconnectreader)\n   * without a `reason` property.\n   *\n   * For Bluetooth and USB readers, this is emitted with a `reason` property when the reader disconnects.\n   *\n   * **Note:** For Bluetooth and USB readers, when you call [`disconnectReader()`](#disconnectreader), this event\n   * will be emitted twice: one without a `reason` in acknowledgement of your call, and again with a `reason` when the reader\n   * finishes disconnecting.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.DisconnectedReader,\n    listenerFunc: ({ reason }: { reason?: DisconnectReason }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when the Terminal's connection status changed.\n   *\n   * Note: You should *not* use this method to detect when a reader unexpectedly disconnects from your app,\n   * as it cannot be used to accurately distinguish between expected and unexpected disconnect events.\n   *\n   * To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use\n   * the UnexpectedReaderDisconnect event.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-connection-status-change.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ConnectionStatusChange,\n    listenerFunc: ({ status }: { status: ConnectionStatus }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * The Terminal disconnected unexpectedly from the reader.\n   *\n   * In your implementation of this method, you may want to notify your user that the reader disconnected.\n   * You may also call [`discoverReaders()`](#discoverreaders) to begin scanning for readers, and attempt\n   * to automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it\n   * possible to cancel calls to `discoverReaders()`\n   *\n   * When connected to a Bluetooth or USB reader, you can get more information about the disconnect by\n   * implementing the DisconnectedReader event.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-unexpected-reader-disconnect.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.UnexpectedReaderDisconnect,\n    listenerFunc: ({ reader }: { reader: ReaderInterface }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ConfirmedPaymentIntent,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.CollectedPaymentIntent,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when [`cancelCollectPaymentMethod()`](#cancelcollectpaymentmethod) is called and succeeds.\n   * The Promise returned by `cancelCollectPaymentMethod()` will also be resolved.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.Canceled,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when either [`collectPaymentMethod()`](#collectpaymentmethod) or [`confirmPaymentIntent()`](#confirmpaymentintent)\n   * fails. The Promise returned by the relevant call will also be rejected.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.Failed,\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Emitted when a software update is available for the connected reader.\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReportAvailableUpdate,\n    listenerFunc: ({\n      update,\n    }: {\n      update: ReaderSoftwareUpdateInterface;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the connected reader begins installing a software update.\n   * If a mandatory software update is available when a reader first connects, that update is\n   * automatically installed. The update will be installed before ConnectedReader is emitted and\n   * before the Promise returned by [`connectReader()`](#connectreader) resolves.\n   * In this case, you will receive this sequence of events:\n   *\n   * 1. StartInstallingUpdate\n   * 2. ReaderSoftwareUpdateProgress (repeatedly)\n   * 3. FinishInstallingUpdates\n   * 4. ConnectedReader\n   * 5. `connectReader()` Promise resolves\n   *\n   * Your app should show UI to the user indiciating that a software update is being installed\n   * to explain why connecting is taking longer than usual.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-start-installing-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.StartInstallingUpdate,\n    listenerFunc: ({\n      update,\n    }: {\n      update: ReaderSoftwareUpdateInterface;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted periodically while reader software is updating to inform of the installation progress.\n   * `progress` is a float between 0 and 1.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-report-reader-software-update-progress.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress,\n    listenerFunc: ({ progress }: { progress: number }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-finish-installing-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.FinishInstallingUpdate,\n    listenerFunc: (\n      args:\n        | {\n            update: ReaderSoftwareUpdateInterface;\n          }\n        | {\n            error: string;\n          },\n    ) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted upon connection and every 10 minutes.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-battery-level-update.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.BatteryLevel,\n    listenerFunc: ({\n      level,\n      charging,\n      status,\n    }: {\n      level: number;\n      charging: boolean;\n      status: BatteryStatus;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listenable/on-report-reader-event.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.ReaderEvent,\n    listenerFunc: ({ event }: { event: ReaderEvent }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the Terminal requests that a message be displayed in your app.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-display-message.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.RequestDisplayMessage,\n    listenerFunc: ({\n      messageType,\n      message,\n    }: {\n      messageType: ReaderDisplayMessage;\n      message: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * **Only applicable to Bluetooth and USB readers.**\n   *\n   * Emitted when the reader begins waiting for input. Your app should prompt the customer\n   * to present a source using one of the given input options. If the reader emits a message,\n   * the RequestDisplayMessage event will be emitted.\n   *\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-input.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.RequestReaderInput,\n    listenerFunc: ({\n      options,\n      message,\n    }: {\n      options: ReaderInputOption[];\n      message: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * [*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-payment-status-change.html)\n   */\n  addListener(\n    eventName: TerminalEventsEnum.PaymentStatusChange,\n    listenerFunc: ({ status }: { status: PaymentStatus }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ReaderReconnectStarted,\n    listenerFunc: ({\n      reader,\n      reason,\n    }: {\n      reader: ReaderInterface;\n      reason: string;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ReaderReconnectSucceeded,\n    listenerFunc: ({ reader }: { reader: ReaderInterface }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: TerminalEventsEnum.ReaderReconnectFailed,\n    listenerFunc: ({ reader }: { reader: ReaderInterface }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * @deprecated\n   * This method has been deprecated and replaced by the `collectPaymentMethod`.\n   * Similarly, note that TerminalEvents.Completed is now obsolete.\n   * And, method `confirmPaymentIntent` added to be executed after `collectPaymentMethod` is executed.\n   *\n   * This is left as type string to avoid accidental use.\n   */\n  collect: string;\n\n  /**\n   * @deprecated\n   * This method has been deprecated and replaced by the `cancelCollectPaymentMethod`.\n   *\n   * This is left as type string to avoid accidental use.\n   */\n  cancelCollect: string;\n}\n"]}

package/dist/esm/events.enum.d.ts

@@ -19,6 +19,9 @@ export declare enum TerminalEventsEnum {
     ReaderEvent = "terminalReaderEvent",
     RequestDisplayMessage = "terminalRequestDisplayMessage",
     RequestReaderInput = "terminalRequestReaderInput",
-    PaymentStatusChange = "terminalPaymentStatusChange"
+    PaymentStatusChange = "terminalPaymentStatusChange",
+    ReaderReconnectStarted = "terminalReaderReconnectStarted",
+    ReaderReconnectSucceeded = "terminalReaderReconnectSucceeded",
+    ReaderReconnectFailed = "terminalReaderReconnectFailed"
 }
 export declare type TerminalResultInterface = TerminalEventsEnum.ConfirmedPaymentIntent | TerminalEventsEnum.CollectedPaymentIntent | TerminalEventsEnum.Canceled | TerminalEventsEnum.Failed;

package/dist/esm/events.enum.js

@@ -21,5 +21,8 @@ export var TerminalEventsEnum;
     TerminalEventsEnum["RequestDisplayMessage"] = "terminalRequestDisplayMessage";
     TerminalEventsEnum["RequestReaderInput"] = "terminalRequestReaderInput";
     TerminalEventsEnum["PaymentStatusChange"] = "terminalPaymentStatusChange";
+    TerminalEventsEnum["ReaderReconnectStarted"] = "terminalReaderReconnectStarted";
+    TerminalEventsEnum["ReaderReconnectSucceeded"] = "terminalReaderReconnectSucceeded";
+    TerminalEventsEnum["ReaderReconnectFailed"] = "terminalReaderReconnectFailed";
 })(TerminalEventsEnum || (TerminalEventsEnum = {}));
 //# sourceMappingURL=events.enum.js.map

package/dist/esm/events.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.enum.js","sourceRoot":"","sources":["../../src/events.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAsBX;AAtBD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,qEAA+C,CAAA;IAC/C,iFAA2D,CAAA;IAC3D,iEAA2C,CAAA;IAC3C,uEAAiD,CAAA;IACjD,+EAAyD,CAAA;IACzD,uFAAiE,CAAA;IACjE,+EAAyD,CAAA;IACzD,+EAAyD,CAAA;IACzD,mDAA6B,CAAA;IAC7B,+CAAyB,CAAA;IACzB,mFAA6D,CAAA;IAC7D,6EAAuD,CAAA;IACvD,6EAAuD,CAAA;IACvD,2FAAqE,CAAA;IACrE,+EAAyD,CAAA;IACzD,2DAAqC,CAAA;IACrC,yDAAmC,CAAA;IACnC,6EAAuD,CAAA;IACvD,uEAAiD,CAAA;IACjD,yEAAmD,CAAA;AACrD,CAAC,EAtBW,kBAAkB,KAAlB,kBAAkB,QAsB7B","sourcesContent":["export enum TerminalEventsEnum {\n  Loaded = 'terminalLoaded',\n  DiscoveredReaders = 'terminalDiscoveredReaders',\n  CancelDiscoveredReaders = 'terminalCancelDiscoveredReaders',\n  ConnectedReader = 'terminalConnectedReader',\n  DisconnectedReader = 'terminalDisconnectedReader',\n  ConnectionStatusChange = 'terminalConnectionStatusChange',\n  UnexpectedReaderDisconnect = 'terminalUnexpectedReaderDisconnect',\n  ConfirmedPaymentIntent = 'terminalConfirmedPaymentIntent',\n  CollectedPaymentIntent = 'terminalCollectedPaymentIntent',\n  Canceled = 'terminalCanceled',\n  Failed = 'terminalFailed',\n  RequestedConnectionToken = 'terminalRequestedConnectionToken',\n  ReportAvailableUpdate = 'terminalReportAvailableUpdate',\n  StartInstallingUpdate = 'terminalStartInstallingUpdate',\n  ReaderSoftwareUpdateProgress = 'terminalReaderSoftwareUpdateProgress',\n  FinishInstallingUpdate = 'terminalFinishInstallingUpdate',\n  BatteryLevel = 'terminalBatteryLevel',\n  ReaderEvent = 'terminalReaderEvent',\n  RequestDisplayMessage = 'terminalRequestDisplayMessage',\n  RequestReaderInput = 'terminalRequestReaderInput',\n  PaymentStatusChange = 'terminalPaymentStatusChange',\n}\n\nexport type TerminalResultInterface =\n  | TerminalEventsEnum.ConfirmedPaymentIntent\n  | TerminalEventsEnum.CollectedPaymentIntent\n  | TerminalEventsEnum.Canceled\n  | TerminalEventsEnum.Failed;\n"]}
+{"version":3,"file":"events.enum.js","sourceRoot":"","sources":["../../src/events.enum.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAyBX;AAzBD,WAAY,kBAAkB;IAC5B,+CAAyB,CAAA;IACzB,qEAA+C,CAAA;IAC/C,iFAA2D,CAAA;IAC3D,iEAA2C,CAAA;IAC3C,uEAAiD,CAAA;IACjD,+EAAyD,CAAA;IACzD,uFAAiE,CAAA;IACjE,+EAAyD,CAAA;IACzD,+EAAyD,CAAA;IACzD,mDAA6B,CAAA;IAC7B,+CAAyB,CAAA;IACzB,mFAA6D,CAAA;IAC7D,6EAAuD,CAAA;IACvD,6EAAuD,CAAA;IACvD,2FAAqE,CAAA;IACrE,+EAAyD,CAAA;IACzD,2DAAqC,CAAA;IACrC,yDAAmC,CAAA;IACnC,6EAAuD,CAAA;IACvD,uEAAiD,CAAA;IACjD,yEAAmD,CAAA;IACnD,+EAAyD,CAAA;IACzD,mFAA6D,CAAA;IAC7D,6EAAuD,CAAA;AACzD,CAAC,EAzBW,kBAAkB,KAAlB,kBAAkB,QAyB7B","sourcesContent":["export enum TerminalEventsEnum {\n  Loaded = 'terminalLoaded',\n  DiscoveredReaders = 'terminalDiscoveredReaders',\n  CancelDiscoveredReaders = 'terminalCancelDiscoveredReaders',\n  ConnectedReader = 'terminalConnectedReader',\n  DisconnectedReader = 'terminalDisconnectedReader',\n  ConnectionStatusChange = 'terminalConnectionStatusChange',\n  UnexpectedReaderDisconnect = 'terminalUnexpectedReaderDisconnect',\n  ConfirmedPaymentIntent = 'terminalConfirmedPaymentIntent',\n  CollectedPaymentIntent = 'terminalCollectedPaymentIntent',\n  Canceled = 'terminalCanceled',\n  Failed = 'terminalFailed',\n  RequestedConnectionToken = 'terminalRequestedConnectionToken',\n  ReportAvailableUpdate = 'terminalReportAvailableUpdate',\n  StartInstallingUpdate = 'terminalStartInstallingUpdate',\n  ReaderSoftwareUpdateProgress = 'terminalReaderSoftwareUpdateProgress',\n  FinishInstallingUpdate = 'terminalFinishInstallingUpdate',\n  BatteryLevel = 'terminalBatteryLevel',\n  ReaderEvent = 'terminalReaderEvent',\n  RequestDisplayMessage = 'terminalRequestDisplayMessage',\n  RequestReaderInput = 'terminalRequestReaderInput',\n  PaymentStatusChange = 'terminalPaymentStatusChange',\n  ReaderReconnectStarted = 'terminalReaderReconnectStarted',\n  ReaderReconnectSucceeded = 'terminalReaderReconnectSucceeded',\n  ReaderReconnectFailed = 'terminalReaderReconnectFailed',\n}\n\nexport type TerminalResultInterface =\n  | TerminalEventsEnum.ConfirmedPaymentIntent\n  | TerminalEventsEnum.CollectedPaymentIntent\n  | TerminalEventsEnum.Canceled\n  | TerminalEventsEnum.Failed;\n"]}

package/dist/esm/stripe-types/proto.d.ts

@@ -0,0 +1,501 @@
+/** Properties of a TipOption. */
+interface ITipOption {
+    /** REQUIRED: Amount of this tip option */
+    amount?: number | null;
+    /** Descriptor of the amount, displayed in the button */
+    label?: string | null;
+}
+/** Properties of a TipConfiguration. */
+export interface ITipConfiguration {
+    /** List of at most 3 options */
+    options?: ITipOption[] | null;
+    /** Hide the custom amount button */
+    hide_custom_amount?: boolean | null;
+}
+/** Properties of a TipSelection. */
+interface ITipSelection {
+    /** Amount associated with the selection */
+    amount?: number | null;
+}
+/** CreditCardBrand enum. */
+declare type CreditCardBrand = 'INVALID_CREDIT_CARD_BRAND' | 'UNKNOWN_CREDIT' | 'AMERICAN_EXPRESS' | 'DINERS' | 'DISCOVER' | 'JCB' | 'MASTERCARD' | 'VISA' | 'CUP';
+/** CardEntryMethod enum. */
+declare type CardEntryMethod = 'INVALID_ENTRY_METHOD' | 'CHIP_READ' | 'CONTACTLESS' | 'FSWIPE' | 'KEYED' | 'SWIPED' | 'BARCODE_READ';
+/** Properties of a CardPaymentMethod. */
+interface ICardPaymentMethod {
+    /** Masked card data */
+    masked_pan?: string | null;
+    /** The card expiration date */
+    expiration_date?: string | null;
+    /** Brand of credit card tender, determined by BIN table lookup */
+    card_brand?: CreditCardBrand | null;
+    /** Entry method of payment */
+    card_entry_method?: CardEntryMethod | null;
+}
+/** Properties of a PaymentMethod. */
+export interface IPaymentMethod {
+    /** PaymentMethod card_payment */
+    card_payment?: ICardPaymentMethod | null;
+    /** Tip selection chosen by the cardholder */
+    tip_selection?: ITipSelection | null;
+}
+/** Properties of a PaymentMethod. */
+export interface IPaymentMethodReadReusableResponse {
+    /** Unique identifier for the Payment Method object */
+    id?: string | null;
+    /** Time at which the Payment Method object was created. Measured in seconds since the Unix epoch */
+    created?: number | null;
+    /** Customer ID */
+    customer?: string | null;
+    /** Whether this charge was made in live mode or not */
+    livemode?: boolean | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** PaymentMethod type */
+    type?: string | null;
+    /** Card representation of payment method */
+    card?: ICardPaymentMethodReadReusableResponse | null;
+}
+/** Properties of a CardPaymentMethod. */
+interface ICardPaymentMethodReadReusableResponse {
+    /** Masked card data */
+    masked_pan?: string | null;
+    /** The card expiration date */
+    expiration_date?: string | null;
+    /** Brand of credit card tender, determined by BIN table lookup */
+    card_brand?: CreditCardBrand | null;
+    /** Entry method of payment */
+    card_entry_method?: CardEntryMethod | null;
+}
+/** Properties of an ErrorResponse. */
+export interface IErrorResponse {
+    /** The type of error returned. */
+    type?: string | null;
+    /** ID of failed charge */
+    charge?: string | null;
+    /** For some errors that could be handled programmatically, a short string indicating the error code reported. (https://stripe.com/docs/error-codes) */
+    code?: string | null;
+    /** For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. (https://stripe.com/docs/declines#issuer-declines) */
+    decline_code?: string | null;
+    /** A URL to more information about the error code reported. */
+    doc_url?: string | null;
+    /** A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */
+    message?: string | null;
+    /** If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */
+    param?: string | null;
+    /** Source used for the error */
+    source?: ISource | null;
+    /** Payment intent used for the error */
+    payment_intent?: IPaymentIntent | null;
+}
+/** Properties of an Owner. */
+export interface IOwner {
+    /** Owner address */
+    address?: string | null;
+    /** Owner email */
+    email?: string | null;
+    /** Owner name */
+    name?: string | null;
+    /** Owner phone */
+    phone?: string | null;
+    /** Owner verified_address */
+    verified_address?: string | null;
+    /** Owner verified_email */
+    verified_email?: string | null;
+    /** Owner verified_name */
+    verified_name?: string | null;
+    /** Owner verified_phone */
+    verified_phone?: string | null;
+}
+/** Properties of a PaymentMethodDetails. */
+export interface IPaymentMethodDetails {
+    /** Payment Method type (e.g. "card_present") */
+    type?: string | null;
+    /** PaymentMethodDetails card_present */
+    card_present?: ICardPresent | null;
+    /** PaymentMethodDetails interac_present */
+    interac_present?: ICardPresent | null;
+}
+/** Properties of a Refund. */
+interface IRefund {
+    /** Refund id */
+    id?: string | null;
+    /** Refund amount */
+    amount?: number | null;
+    /** Refund charge */
+    charge?: string | null;
+    /** Time at which the Refund object was created. Measured in seconds since the Unix epoch */
+    created?: number | null;
+    /** Three-letter ISO currency code, in lowercase. Must be a supported currency */
+    currency?: string | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** Reason for refund */
+    reason?: string | null;
+    /** Status of refund */
+    status?: string | null;
+    /** Actual details of the payment method */
+    payment_method_details?: IPaymentMethodDetails | null;
+    /** If the refund failed, the reason for refund failure if known. */
+    failure_reason?: string | null;
+}
+/** Properties of a Refunds. */
+interface IRefunds {
+    /** Refunds data */
+    data?: IRefund[] | null;
+    /** Refunds has_more */
+    has_more?: boolean | null;
+    /** Refunds total_count */
+    total_count?: number | null;
+}
+/** Properties of a Charge. */
+interface ICharge {
+    /** ID for charge */
+    id?: string | null;
+    /** Amount that is associated with the charge */
+    amount?: number | null;
+    /** Amount that is associated with a refund of the charge */
+    amount_refunded?: number | null;
+    /** Whether this charge has been captured */
+    captured?: boolean | null;
+    /** Whether this charge has been refunded */
+    refunded?: boolean | null;
+    /** Time at which the Charge object was created. Measured in seconds since the Unix epoch */
+    created?: number | null;
+    /** Three-letter ISO currency code, in lowercase. Must be a supported currency. */
+    currency?: string | null;
+    /** An arbitrary string attached to the object. Often useful for displaying to users. */
+    description?: string | null;
+    /** An arbitrary string to be displayed on your customer's credit card statement. */
+    statement_descriptor?: string | null;
+    /** Email address that the receipt for the resulting payment will be sent to. */
+    receipt_email?: string | null;
+    /** Failure code if the charge was declined */
+    failure_code?: string | null;
+    /** Message associated with the failure code */
+    failure_message?: string | null;
+    /** Whether this charge was made in live mode or not */
+    livemode?: boolean | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** Source associated with the charge */
+    source?: ISource | null;
+    /** Payment intent ID associated with the charge */
+    payment_intent?: string | null;
+    /** Status of the charge */
+    status?: string | null;
+    /** Payment method ID */
+    payment_method?: string | null;
+    /** Actual details of the payment method */
+    payment_method_details?: IPaymentMethodDetails | null;
+    /** Whether the charge was paid */
+    paid?: boolean | null;
+    /** Receipt URL */
+    receipt_url?: string | null;
+    /** Refunds associated with charge */
+    refunds?: IRefunds | null;
+}
+/** Properties of a Charges. */
+interface ICharges {
+    /** Charges data */
+    data?: ICharge[] | null;
+    /** Charges has_more */
+    has_more?: boolean | null;
+    /** Charges total_count */
+    total_count?: number | null;
+}
+/** Properties of a CardPresent. */
+interface ICardPresent {
+    /** The last four digits of the card. */
+    last4?: string | null;
+    /** Card brand */
+    brand?: string | null;
+    /** Customer's signature if signed */
+    evidence_customer_signature?: string | null;
+    /** Method used by POS to read the card */
+    read_method?: string | null;
+    /** The EMV authorization response payload */
+    emv_auth_data?: string | null;
+    /** The EMV authorization response code */
+    authorization_response_code?: string | null;
+    /** AID */
+    dedicated_file_name?: string | null;
+    /** AID name */
+    application_preferred_name?: string | null;
+    /** TVR */
+    terminal_verification_results?: string | null;
+    /** TSI */
+    transaction_status_information?: string | null;
+    /** CVM type */
+    cvm_type?: string | null;
+    /** CardPresent reader */
+    reader?: string | null;
+    /** CardPresent fingerprint */
+    fingerprint?: string | null;
+    /** CardPresent authorization_code */
+    authorization_code?: string | null;
+}
+/** Properties of a Source. */
+export interface ISource {
+    /** Unique identifier for the source card object. */
+    id?: string | null;
+    /** Source type (e.g. "card_present") */
+    type?: string | null;
+    /** Card payment method */
+    card_present?: ICardPresent | null;
+    /** Interac version of card present */
+    interac_present?: ICardPresent | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** Owner data */
+    owner?: IOwner | null;
+}
+export interface IPaymentIntent {
+    /** Unique identifier for the Payment Intent object */
+    id?: string | null;
+    /** Time at which the Payment Intent object was created. Measured in seconds since the Unix epoch */
+    created?: number | null;
+    /** Status of this PaymentIntent */
+    status?: string | null;
+    /** Amount intended to be collected by this Payment Intent */
+    amount?: number | null;
+    /** Three-letter ISO currency code, in lowercase. Must be a supported currency. */
+    currency?: string | null;
+    /** Card present payment source field map */
+    source?: ISource | null;
+    /** An arbitrary string to be displayed on your customer's credit card statement. */
+    statement_descriptor?: string | null;
+    /** An arbitrary string attached to the object. Often useful for displaying to users. */
+    description?: string | null;
+    /** Email address that the receipt for the resulting payment will be sent to. */
+    receipt_email?: string | null;
+    /** Whether this charge was made in live mode or not */
+    livemode?: boolean | null;
+    /** Last payment error on a charge (if retrieved) */
+    last_payment_error?: IErrorResponse | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** Charges associated with the payment intent */
+    charges?: ICharges | null;
+    /** ID for payment method */
+    payment_method?: string | null;
+}
+export interface ISetupIntent {
+    /** Unique identifier for the object. */
+    id?: string | null;
+    /** The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. */
+    client_secret?: string | null;
+    /** ID of the Customer this SetupIntent belongs to, if one exists. */
+    customer?: string | null;
+    /** An arbitrary string attached to the object. Often useful for displaying to users. */
+    description?: string | null;
+    /** The error encountered in the previous SetupIntent confirmation. */
+    last_setup_error?: ILastSetupError | null;
+    /** Meta data in JSON format */
+    metadata?: {
+        [k: string]: string;
+    } | null;
+    /** If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */
+    next_action?: INextAction | null;
+    /** ID of the payment method used with this SetupIntent. */
+    payment_method?: string | null;
+    /** The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */
+    payment_method_types?: string[] | null;
+    /** Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded. */
+    status?: string | null;
+    /** Indicates how the payment method is intended to be used in the future. */
+    usage?: string | null;
+    /** Time at which the object was created. Measured in seconds since the Unix epoch. */
+    created?: number | null;
+    /** The most recent SetupAttempt for this SetupIntent. */
+    latest_attempt?: ISetupAttempt | null;
+    /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+    livemode?: boolean | null;
+    /** ID of the multi use Mandate generated by the SetupIntent. */
+    mandate?: string | null;
+    /** ID of the single_use Mandate generated by the SetupIntent. */
+    single_use_mandate?: string | null;
+    /** ID of the Connect application that created the SetupIntent. */
+    application?: string | null;
+    /** The account (if any) for which the setup is intended. */
+    on_behalf_of?: string | null;
+    /** Payment-method-specific configuration for this SetupIntent. */
+    payment_method_options?: IPaymentMethodOptions | null;
+}
+/** Properties of a SetupAttempt. */
+export interface ISetupAttempt {
+    /** Unique identifier for the object. */
+    id?: string | null;
+    /** String representing the object’s type: "setup_attempt" */
+    object?: string | null;
+    /** ID of the Connect application that created the SetupIntent. */
+    application?: string | null;
+    /** Time at which the object was created. Measured in seconds since the Unix epoch. */
+    created?: number | null;
+    /** ID of the Customer this SetupIntent belongs to, if one exists. */
+    customer?: string | null;
+    /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+    livemode?: boolean | null;
+    /** The account (if any) for which the setup is intended. */
+    on_behalf_of?: string | null;
+    /** ID of the payment method used with this SetupAttempt. */
+    payment_method?: string | null;
+    /** Details about the payment method at the time of SetupIntent confirmation. */
+    payment_method_details?: IPaymentMethodDetails | null;
+    /** The error encountered during this attempt to confirm the SetupIntent, if any. */
+    setup_error?: ISetupError | null;
+    /** ID of the SetupIntent that this attempt belongs to. */
+    setup_intent?: string | null;
+    /** Status of this SetupAttempt, one of requires_confirmation, requires_action, processing, succeeded, failed, or abandoned. */
+    status?: string | null;
+    /** The value of usage on the SetupIntent at the time of this confirmation, one of off_session or on_session. */
+    usage?: string | null;
+}
+/** Properties of a SetupError. */
+export interface ISetupError {
+    /** For some errors that could be handled programmatically, a short string indicating the error code reported. */
+    code?: string | null;
+    /** For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. */
+    decline_code?: string | null;
+    /** A URL to more information about the error code reported. */
+    doc_url?: string | null;
+    /** A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */
+    message?: string | null;
+    /** If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */
+    param?: string | null;
+    /** The PaymentMethod object for errors returned on a request involving a PaymentMethod. */
+    payment_method?: IPaymentMethod | null;
+    /** If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. */
+    payment_method_type?: string | null;
+    /** The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error */
+    type?: string | null;
+}
+/** Properties of an ActivateTerminalRequest. */
+export interface IActivateTerminalRequest {
+    /** An activation token obtained from Stripe that can be used to activate the reader */
+    pos_activation_token?: string | null;
+    /** The fingerprint for the POS authenticating to rabbit */
+    pos_device_id?: string | null;
+    /** The terminal hardware information */
+    pos_hardware_info?: any | null;
+    /** The terminal software information */
+    pos_software_info?: any | null;
+    /** Provide RPC error if reader is currently in use */
+    fail_if_in_use?: boolean | null;
+    /** The logical identity of terminal (i.e. lane number) authenticating to rabbit. */
+    terminal_id?: string | null;
+    /** ActivateTerminalRequest terminal_ip */
+    terminal_ip?: string | null;
+    /** The store name associated with the POS */
+    store_name?: string | null;
+    /** The store address associated with the POS */
+    store_address?: any | null;
+}
+/** Properties of a SetReaderDisplayRequest. */
+export interface ISetReaderDisplayRequest {
+    /** SetReaderDisplayRequest type */
+    type?: string | null;
+    /** SetReaderDisplayRequest cart */
+    cart?: ICart | null;
+}
+export interface ICart {
+    /** All line items in the basket */
+    line_items?: ILineItem[] | null;
+    /** Modifiers that have been applied to the basket. */
+    modifiers?: IModifier[] | null;
+    /** Any discounts that have been added to the basket. */
+    discounts?: IDiscount[] | null;
+    /** Tenders that have been charged/refunded */
+    tenders?: ITender[] | null;
+    /** Total amount of tax */
+    tax?: number | null;
+    /** Total balance of cart due */
+    total?: number | null;
+    /** The currency of the basket (i.e. USD or AUD). */
+    currency?: string | null;
+}
+/** Properties of a LineItem. */
+interface ILineItem {
+    /** LineItem quantity */
+    quantity?: number | null;
+    /** A detailed description of the item. */
+    description?: string | null;
+    /** This is equal to extended_price - discount + modifiers */
+    amount?: number | null;
+    /** The discounts that have been applied to this line item. */
+    discounts?: IDiscount[] | null;
+    /** The modifiers that have been applied to this line item. */
+    modifiers?: IModifier[] | null;
+}
+interface IModifier {
+    /** A detailed description of discount. */
+    description?: string | null;
+    /** Amount in cents of the modification. */
+    amount?: number | null;
+}
+/** Properties of a Discount. */
+interface IDiscount {
+    /** A detailed description of discount. */
+    description?: string | null;
+    /** The amount and mechanism of the discount */
+    amount?: number | null;
+}
+/** Properties of a Tender. */
+interface ITender {
+    /** A detailed description of tender. */
+    description?: string | null;
+    /** Amount in cents of the tender. */
+    amount?: number | null;
+}
+interface ILastSetupError {
+    /** For some errors that could be handled programmatically, a short string indicating the error code reported. */
+    code?: string | null;
+    /** For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. */
+    decline_code?: string | null;
+    /** A URL to more information about the error code reported. */
+    doc_url?: string | null;
+    /** A human-readable message providing more details about the error. For card errors, these messages can be shown to users. */
+    message?: string | null;
+    /** If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */
+    param?: string | null;
+    /** The PaymentMethod object for errors returned on a request involving a PaymentMethod. */
+    payment_method?: IPaymentMethod | null;
+    /** One of: api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error */
+    type?: string | null;
+}
+interface INextAction {
+    /** Contains instructions for authenticating by redirecting your customer to another page or application. */
+    redirect_to_url?: IRedirectToUrl | null;
+    /** Type of the next action to perform, one of redirect_to_url or use_stripe_sdk. */
+    type?: string | null;
+    /** When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. */
+    use_stripe_sdk?: {
+        [k: string]: string;
+    } | null;
+}
+interface IRedirectToUrl {
+    /** If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */
+    return_url?: string | null;
+    /** The URL you must redirect your customer to in order to authenticate. */
+    url?: string | null;
+}
+interface IPaymentMethodOptions {
+    /** PaymentMethodOptions card */
+    card?: ICardOptions | null;
+}
+interface ICardOptions {
+    /** CardOptions request_three_d_secure */
+    request_three_d_secure?: Request3dSecureType | null;
+}
+declare type Request3dSecureType = 'automatic' | 'any';
+export {};

package/dist/esm/stripe-types/proto.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=proto.js.map