From 8d84261c4480eff27940b3aedf620ab5db0ca729 Mon Sep 17 00:00:00 2001 From: Nazli Yurdakul <69359432+nazli-stripe@users.noreply.github.com> Date: Mon, 24 Jun 2024 15:48:18 -0400 Subject: [PATCH] regen docs (#741) --- docs/api-reference/enums/CommonError.html | 2 +- docs/api-reference/enums/SelectionButtonStyle.html | 2 +- docs/api-reference/enums/ToggleResult.html | 2 +- docs/api-reference/enums/ToggleValue.html | 2 +- docs/api-reference/index.html | 8 ++++---- docs/api-reference/interfaces/Address.html | 2 +- docs/api-reference/interfaces/Charge.html | 2 +- docs/api-reference/interfaces/Location.html | 2 +- docs/api-reference/interfaces/PaymentIntent.Type.html | 2 +- docs/api-reference/interfaces/Refund.Android.Props.html | 2 +- docs/api-reference/interfaces/Refund.IOS.Props.html | 2 +- .../SetupIntent.SetupAttemptCardPresentDetails.html | 2 +- .../SetupIntent.SetupAttemptPaymentMethodDetails.html | 2 +- .../interfaces/StripeTerminalProviderProps.html | 2 +- docs/api-reference/interfaces/StripeTerminalSdkType.html | 2 +- docs/api-reference/modules/PaymentIntent.html | 2 +- docs/api-reference/modules/PaymentMethod.html | 2 +- docs/api-reference/modules/Reader.Android.html | 2 +- docs/api-reference/modules/Reader.IOS.html | 2 +- docs/api-reference/modules/Reader.html | 2 +- docs/api-reference/modules/Refund.html | 2 +- docs/api-reference/modules/SetupIntent.Android.html | 2 +- docs/api-reference/modules/SetupIntent.IOS.html | 2 +- docs/api-reference/modules/SetupIntent.html | 2 +- 24 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/api-reference/enums/CommonError.html b/docs/api-reference/enums/CommonError.html index 7d2e2055..13d8429e 100644 --- a/docs/api-reference/enums/CommonError.html +++ b/docs/api-reference/enums/CommonError.html @@ -1 +1 @@ -CommonError | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration CommonError

Index

Enumeration members

Enumeration members

Canceled

Canceled = "Canceled"

Failed

Failed = "Failed"

Unknown

Unknown = "Unknown"

Generated using TypeDoc

\ No newline at end of file +CommonError | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration CommonError

Index

Enumeration members

Enumeration members

Canceled

Canceled = "Canceled"

Failed

Failed = "Failed"

Unknown

Unknown = "Unknown"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/enums/SelectionButtonStyle.html b/docs/api-reference/enums/SelectionButtonStyle.html index 57e3f317..ede3074d 100644 --- a/docs/api-reference/enums/SelectionButtonStyle.html +++ b/docs/api-reference/enums/SelectionButtonStyle.html @@ -1 +1 @@ -SelectionButtonStyle | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SelectionButtonStyle

Index

Enumeration members

Enumeration members

PRIMARY

PRIMARY = "primary"

SECONDARY

SECONDARY = "secondary"

Generated using TypeDoc

\ No newline at end of file +SelectionButtonStyle | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SelectionButtonStyle

Index

Enumeration members

Enumeration members

PRIMARY

PRIMARY = "primary"

SECONDARY

SECONDARY = "secondary"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/enums/ToggleResult.html b/docs/api-reference/enums/ToggleResult.html index 9f5a01ae..c9145bf1 100644 --- a/docs/api-reference/enums/ToggleResult.html +++ b/docs/api-reference/enums/ToggleResult.html @@ -1 +1 @@ -ToggleResult | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ToggleResult

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

ENABLED

ENABLED = "enabled"

SKIPPED

SKIPPED = "skipped"

Generated using TypeDoc

\ No newline at end of file +ToggleResult | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ToggleResult

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

ENABLED

ENABLED = "enabled"

SKIPPED

SKIPPED = "skipped"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/enums/ToggleValue.html b/docs/api-reference/enums/ToggleValue.html index 4c59e35c..8ef71dcd 100644 --- a/docs/api-reference/enums/ToggleValue.html +++ b/docs/api-reference/enums/ToggleValue.html @@ -1 +1 @@ -ToggleValue | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ToggleValue

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

ENABLED

ENABLED = "enabled"

Generated using TypeDoc

\ No newline at end of file +ToggleValue | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ToggleValue

Index

Enumeration members

Enumeration members

DISABLED

DISABLED = "disabled"

ENABLED

ENABLED = "enabled"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/index.html b/docs/api-reference/index.html index 29a2b070..f3cdc0fe 100644 --- a/docs/api-reference/index.html +++ b/docs/api-reference/index.html @@ -1,19 +1,19 @@ -@stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

@stripe/stripe-terminal-react-native

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions Other

Functions ReactComponents

Type aliases

Amount

Amount: { amount: number }

Type declaration

  • amount: number

AmountDetails

AmountDetails: { tip: Amount }

Type declaration

CancelDiscoveringResultType

CancelDiscoveringResultType: Promise<{ error?: StripeError }>

CardPresentDetails

CardPresentDetails: { brand: string; cardholderName?: string; country?: string; description: string; emvAuthData?: string; expMonth: string; expYear: string; funding: string; generatedCard?: string; iin: string; issuer: string; last4: string; network: string; preferredLocales: string[]; receipt?: string; wallet: Wallet }

Type declaration

  • brand: string
  • Optional cardholderName?: string
  • Optional country?: string
  • description: string
  • Optional emvAuthData?: string
  • expMonth: string
  • expYear: string
  • funding: string
  • Optional generatedCard?: string
  • iin: string
  • issuer: string
  • last4: string
  • network: string
  • preferredLocales: string[]
  • Optional receipt?: string
  • wallet: Wallet

Cart

Cart: { currency: string; lineItems: LineItem[]; tax: number; total: number }

Type declaration

  • currency: string
  • lineItems: LineItem[]
  • tax: number
  • total: number

ClearReaderDisplayResultType

ClearReaderDisplayResultType: { error: StripeError }

Type declaration

CollectPaymentMethodParams

CollectPaymentMethodParams: { enableCustomerCancellation?: boolean; paymentIntent: PaymentIntent.Type; requestDynamicCurrencyConversion?: boolean; skipTipping?: boolean; tipEligibleAmount?: number; updatePaymentIntent?: boolean }

Type declaration

  • Optional enableCustomerCancellation?: boolean
  • paymentIntent: PaymentIntent.Type
  • Optional requestDynamicCurrencyConversion?: boolean
  • Optional skipTipping?: boolean
  • Optional tipEligibleAmount?: number
  • Optional updatePaymentIntent?: boolean

CollectRefundPaymentMethodType

CollectRefundPaymentMethodType: { error?: StripeError }

Type declaration

CollectSetupIntentPaymentMethodParams

CollectSetupIntentPaymentMethodParams: { customerConsentCollected?: boolean; enableCustomerCancellation?: boolean; setupIntent: SetupIntent.Type }

Type declaration

  • Optional customerConsentCollected?: boolean
  • Optional enableCustomerCancellation?: boolean
  • setupIntent: SetupIntent.Type

ConfirmRefundResultType

ConfirmRefundResultType: { error?: StripeError; refund?: Refund.Props }

Type declaration

ConnectBluetoothReaderParams

ConnectBluetoothReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type

ConnectHandoffParams

ConnectHandoffParams: { locationId?: string; reader: Reader.Type }

Type declaration

ConnectInternetReaderParams

ConnectInternetReaderParams: { failIfInUse?: boolean; reader: Reader.Type }

Type declaration

ConnectLocalMobileParams

ConnectLocalMobileParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; merchantDisplayName?: string; onBehalfOf?: string; reader: Reader.Type; tosAcceptancePermitted?: boolean }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • Optional merchantDisplayName?: string
  • Optional onBehalfOf?: string
  • reader: Reader.Type
  • Optional tosAcceptancePermitted?: boolean

ConnectReaderResultType

ConnectReaderResultType: { error?: undefined; reader: Reader.Type } | { error: StripeError; reader?: undefined }

ConnectUsbReaderParams

ConnectUsbReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type

ConnectionStatus

ConnectionStatus: "notConnected" | "connecting" | "connected"

CreatePaymentIntentIOSParams

CreatePaymentIntentIOSParams: { paymentMethodTypes?: string[] }

Type declaration

  • Optional paymentMethodTypes?: string[]

CreatePaymentIntentParams

CreatePaymentIntentParams: CreatePaymentIntentIOSParams & { amount: number; applicationFeeAmount?: number; captureMethod?: "automatic" | "manual"; currency: string; customer?: string; metadata?: Record<string, string>; offlineBehavior?: "prefer_online" | "require_online" | "force_offline"; onBehalfOf?: string; paymentMethodOptions?: PaymentMethodOptions; receiptEmail?: string; setupFutureUsage?: "off_session" | "on_session"; statementDescriptor?: string; statementDescriptorSuffix?: string; stripeDescription?: string; transferDataDestination?: string; transferGroup?: string }

CreateSetupIntentParams

CreateSetupIntentParams: { customerId?: string }

Type declaration

  • Optional customerId?: string

DisconnectReaderResultType

DisconnectReaderResultType: { error: StripeError }

Type declaration

DiscoverReadersParams

DiscoverReadersParams: { discoveryMethod: Reader.DiscoveryMethod; simulated?: boolean; timeout?: number }

Type declaration

DiscoverReadersResultType

DiscoverReadersResultType: Promise<{ error?: StripeError }>

GetLocationsParams

GetLocationsParams: { endingBefore?: string; limit?: number; startingAfter?: string }

Type declaration

  • Optional endingBefore?: string
  • Optional limit?: number
  • Optional startingAfter?: string

GetLocationsResultType

GetLocationsResultType: { error?: undefined; hasMore: boolean; locations: Location[] } | { error: StripeError; hasMore?: undefined; locations?: undefined }

InitParams

InitParams: { logLevel?: LogLevel }

Type declaration

InitializeResultType

InitializeResultType: { error?: undefined; reader?: Reader.Type } | { error: StripeError; reader?: undefined }

LineItem

LineItem: { amount: number; displayName: string; quantity: number }

Type declaration

  • amount: number
  • displayName: string
  • quantity: number

LocationStatus

LocationStatus: "notSet" | "set" | "unknown"

LogLevel

LogLevel: LogLevelIOS | LogLevelAndroid

LogLevelAndroid

LogLevelAndroid: "none" | "verbose" | "error" | "warning"

LogLevelIOS

LogLevelIOS: "none" | "verbose"

OfflineCardPresentDetails

OfflineCardPresentDetails: { brand: string; cardholderName: string; expMonth: number; expYear: number; last4: string; readMethod: string; receiptDetails: ReceiptDetails }

Type declaration

  • brand: string
  • cardholderName: string
  • expMonth: number
  • expYear: number
  • last4: string
  • readMethod: string
  • receiptDetails: ReceiptDetails

OfflineDetails

OfflineDetails: { amountDetails: AmountDetails; cardPresentDetails: OfflineCardPresentDetails; requiresUpload: boolean; storedAt: string }

Type declaration

OfflineStatus

OfflineStatus: { reader?: OfflineStatusDetails; sdk: OfflineStatusDetails }

Type declaration

OfflineStatusDetails

OfflineStatusDetails: { networkStatus: "online" | "offline" | "unknown"; offlinePaymentAmountsByCurrency: {}; offlinePaymentsCount: number }

Type declaration

  • networkStatus: "online" | "offline" | "unknown"
  • offlinePaymentAmountsByCurrency: {}
    • [key: string]: number
  • offlinePaymentsCount: number

PaymentIntentResultType

PaymentIntentResultType: { error?: undefined; paymentIntent: PaymentIntent.Type } | { error: StripeError; paymentIntent?: undefined } | { error: StripeError; paymentIntent: PaymentIntent.Type }

PaymentMethodDetails

PaymentMethodDetails: { cardPresentDetails?: CardPresentDetails; interacPresentDetails?: CardPresentDetails; type: string }

Type declaration

PaymentMethodOptions

PaymentMethodOptions: { requestExtendedAuthorization?: boolean; requestIncrementalAuthorizationSupport?: boolean; requestedPriority: string }

Type declaration

  • Optional requestExtendedAuthorization?: boolean
  • Optional requestIncrementalAuthorizationSupport?: boolean
  • requestedPriority: string

PaymentMethodResultType

PaymentMethodResultType: { error: undefined; paymentMethod?: PaymentMethod.Type } | { error: StripeError; paymentMethod: undefined }

PaymentMethodType

PaymentMethodType: "cardPresent" | "interacPresent" | "card"

PaymentStatus

PaymentStatus: "notReady" | "ready" | "processing" | "waitingForInput"

ReaderEvent

ReaderEvent: "cardInserted" | "cardRemoved"

RebootReaderResultType

RebootReaderResultType: { error: StripeError }

Type declaration

ReceiptDetails

ReceiptDetails: { accountType: string; applicationCryptogram: string; applicationPreferredName: string; authorizationCode: string; authorizationResponseCode: string; cvm: string; dedicatedFileName: string; terminalVerificationResult: string; transactionStatusInformation: string }

Type declaration

  • accountType: string
  • applicationCryptogram: string
  • applicationPreferredName: string
  • authorizationCode: string
  • authorizationResponseCode: string
  • cvm: string
  • dedicatedFileName: string
  • terminalVerificationResult: string
  • transactionStatusInformation: string

RefundParams

RefundParams: { amount: number; chargeId: string; currency: string; enableCustomerCancellation?: boolean; paymentIntentId: string; refundApplicationFee?: boolean; reverseTransfer?: boolean }

Type declaration

  • amount: number
  • chargeId: string
  • currency: string
  • Optional enableCustomerCancellation?: boolean
  • paymentIntentId: string
  • Optional refundApplicationFee?: boolean
  • Optional reverseTransfer?: boolean

SetConnectionTokenParams

SetConnectionTokenParams: { error?: string; token?: string }

Type declaration

  • Optional error?: string
  • Optional token?: string

SetupIntentResultType

SetupIntentResultType: { error?: undefined; setupIntent: SetupIntent.Type } | { error: StripeError; setupIntent?: undefined }

StripeError

StripeError<T>: { code: T; message: string }

Type parameters

Type declaration

  • code: T
  • message: string

UpdateSoftwareResultType

UpdateSoftwareResultType: { error?: StripeError; update?: SoftwareUpdate }

Type declaration

UseStripeTerminalProps

UseStripeTerminalProps: UserCallbacks
+@stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

@stripe/stripe-terminal-react-native

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions Other

Functions ReactComponents

Type aliases

Amount

Amount: { amount: number }

Type declaration

  • amount: number

AmountDetails

AmountDetails: { tip: Amount }

Type declaration

CancelDiscoveringResultType

CancelDiscoveringResultType: Promise<{ error?: StripeError }>

CardPresentDetails

CardPresentDetails: { brand: string; cardholderName?: string; country?: string; description: string; emvAuthData?: string; expMonth: string; expYear: string; funding: string; generatedCard?: string; iin: string; issuer: string; last4: string; network: string; preferredLocales: string[]; receipt?: string; wallet: Wallet }

Type declaration

  • brand: string
  • Optional cardholderName?: string
  • Optional country?: string
  • description: string
  • Optional emvAuthData?: string
  • expMonth: string
  • expYear: string
  • funding: string
  • Optional generatedCard?: string
  • iin: string
  • issuer: string
  • last4: string
  • network: string
  • preferredLocales: string[]
  • Optional receipt?: string
  • wallet: Wallet

Cart

Cart: { currency: string; lineItems: LineItem[]; tax: number; total: number }

Type declaration

  • currency: string
  • lineItems: LineItem[]
  • tax: number
  • total: number

ClearReaderDisplayResultType

ClearReaderDisplayResultType: { error: StripeError }

Type declaration

CollectPaymentMethodParams

CollectPaymentMethodParams: { enableCustomerCancellation?: boolean; paymentIntent: PaymentIntent.Type; requestDynamicCurrencyConversion?: boolean; skipTipping?: boolean; tipEligibleAmount?: number; updatePaymentIntent?: boolean }

Type declaration

  • Optional enableCustomerCancellation?: boolean
  • paymentIntent: PaymentIntent.Type
  • Optional requestDynamicCurrencyConversion?: boolean
  • Optional skipTipping?: boolean
  • Optional tipEligibleAmount?: number
  • Optional updatePaymentIntent?: boolean

CollectRefundPaymentMethodType

CollectRefundPaymentMethodType: { error?: StripeError }

Type declaration

CollectSetupIntentPaymentMethodParams

CollectSetupIntentPaymentMethodParams: { customerConsentCollected?: boolean; enableCustomerCancellation?: boolean; setupIntent: SetupIntent.Type }

Type declaration

  • Optional customerConsentCollected?: boolean
  • Optional enableCustomerCancellation?: boolean
  • setupIntent: SetupIntent.Type

ConfirmRefundResultType

ConfirmRefundResultType: { error?: StripeError; refund?: Refund.Props }

Type declaration

ConnectBluetoothReaderParams

ConnectBluetoothReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type

ConnectHandoffParams

ConnectHandoffParams: { locationId?: string; reader: Reader.Type }

Type declaration

ConnectInternetReaderParams

ConnectInternetReaderParams: { failIfInUse?: boolean; reader: Reader.Type }

Type declaration

ConnectLocalMobileParams

ConnectLocalMobileParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; merchantDisplayName?: string; onBehalfOf?: string; reader: Reader.Type; tosAcceptancePermitted?: boolean }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • Optional merchantDisplayName?: string
  • Optional onBehalfOf?: string
  • reader: Reader.Type
  • Optional tosAcceptancePermitted?: boolean

ConnectReaderResultType

ConnectReaderResultType: { error?: undefined; reader: Reader.Type } | { error: StripeError; reader?: undefined }

ConnectUsbReaderParams

ConnectUsbReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type

ConnectionStatus

ConnectionStatus: "notConnected" | "connecting" | "connected"

CreatePaymentIntentIOSParams

CreatePaymentIntentIOSParams: { paymentMethodTypes?: string[] }

Type declaration

  • Optional paymentMethodTypes?: string[]

CreatePaymentIntentParams

CreatePaymentIntentParams: CreatePaymentIntentIOSParams & { amount: number; applicationFeeAmount?: number; captureMethod?: "automatic" | "manual"; currency: string; customer?: string; metadata?: Record<string, string>; offlineBehavior?: "prefer_online" | "require_online" | "force_offline"; onBehalfOf?: string; paymentMethodOptions?: PaymentMethodOptions; receiptEmail?: string; setupFutureUsage?: "off_session" | "on_session"; statementDescriptor?: string; statementDescriptorSuffix?: string; stripeDescription?: string; transferDataDestination?: string; transferGroup?: string }

CreateSetupIntentParams

CreateSetupIntentParams: { customerId?: string }

Type declaration

  • Optional customerId?: string

DisconnectReaderResultType

DisconnectReaderResultType: { error: StripeError }

Type declaration

DiscoverReadersParams

DiscoverReadersParams: { discoveryMethod: Reader.DiscoveryMethod; simulated?: boolean; timeout?: number }

Type declaration

DiscoverReadersResultType

DiscoverReadersResultType: Promise<{ error?: StripeError }>

GetLocationsParams

GetLocationsParams: { endingBefore?: string; limit?: number; startingAfter?: string }

Type declaration

  • Optional endingBefore?: string
  • Optional limit?: number
  • Optional startingAfter?: string

GetLocationsResultType

GetLocationsResultType: { error?: undefined; hasMore: boolean; locations: Location[] } | { error: StripeError; hasMore?: undefined; locations?: undefined }

InitParams

InitParams: { logLevel?: LogLevel }

Type declaration

InitializeResultType

InitializeResultType: { error?: undefined; reader?: Reader.Type } | { error: StripeError; reader?: undefined }

LineItem

LineItem: { amount: number; displayName: string; quantity: number }

Type declaration

  • amount: number
  • displayName: string
  • quantity: number

LocationStatus

LocationStatus: "notSet" | "set" | "unknown"

LogLevel

LogLevel: LogLevelIOS | LogLevelAndroid

LogLevelAndroid

LogLevelAndroid: "none" | "verbose" | "error" | "warning"

LogLevelIOS

LogLevelIOS: "none" | "verbose"

OfflineCardPresentDetails

OfflineCardPresentDetails: { brand: string; cardholderName: string; expMonth: number; expYear: number; last4: string; readMethod: string; receiptDetails: ReceiptDetails }

Type declaration

  • brand: string
  • cardholderName: string
  • expMonth: number
  • expYear: number
  • last4: string
  • readMethod: string
  • receiptDetails: ReceiptDetails

OfflineDetails

OfflineDetails: { amountDetails: AmountDetails; cardPresentDetails: OfflineCardPresentDetails; requiresUpload: boolean; storedAt: string }

Type declaration

OfflineStatus

OfflineStatus: { reader?: OfflineStatusDetails; sdk: OfflineStatusDetails }

Type declaration

OfflineStatusDetails

OfflineStatusDetails: { networkStatus: "online" | "offline" | "unknown"; offlinePaymentAmountsByCurrency: {}; offlinePaymentsCount: number }

Type declaration

  • networkStatus: "online" | "offline" | "unknown"
  • offlinePaymentAmountsByCurrency: {}
    • [key: string]: number
  • offlinePaymentsCount: number

PaymentIntentResultType

PaymentIntentResultType: { error?: undefined; paymentIntent: PaymentIntent.Type } | { error: StripeError; paymentIntent?: undefined } | { error: StripeError; paymentIntent: PaymentIntent.Type }

PaymentMethodDetails

PaymentMethodDetails: { cardPresentDetails?: CardPresentDetails; interacPresentDetails?: CardPresentDetails; type: string }

Type declaration

PaymentMethodOptions

PaymentMethodOptions: { requestExtendedAuthorization?: boolean; requestIncrementalAuthorizationSupport?: boolean; requestedPriority: string }

Type declaration

  • Optional requestExtendedAuthorization?: boolean
  • Optional requestIncrementalAuthorizationSupport?: boolean
  • requestedPriority: string

PaymentMethodResultType

PaymentMethodResultType: { error: undefined; paymentMethod?: PaymentMethod.Type } | { error: StripeError; paymentMethod: undefined }

PaymentMethodType

PaymentMethodType: "cardPresent" | "interacPresent" | "card"

PaymentStatus

PaymentStatus: "notReady" | "ready" | "processing" | "waitingForInput"

ReaderEvent

ReaderEvent: "cardInserted" | "cardRemoved"

RebootReaderResultType

RebootReaderResultType: { error: StripeError }

Type declaration

ReceiptDetails

ReceiptDetails: { accountType: string; applicationCryptogram: string; applicationPreferredName: string; authorizationCode: string; authorizationResponseCode: string; cvm: string; dedicatedFileName: string; terminalVerificationResult: string; transactionStatusInformation: string }

Type declaration

  • accountType: string
  • applicationCryptogram: string
  • applicationPreferredName: string
  • authorizationCode: string
  • authorizationResponseCode: string
  • cvm: string
  • dedicatedFileName: string
  • terminalVerificationResult: string
  • transactionStatusInformation: string

RefundParams

RefundParams: { amount: number; chargeId: string; currency: string; enableCustomerCancellation?: boolean; paymentIntentId: string; refundApplicationFee?: boolean; reverseTransfer?: boolean }

Type declaration

  • amount: number
  • chargeId: string
  • currency: string
  • Optional enableCustomerCancellation?: boolean
  • paymentIntentId: string
  • Optional refundApplicationFee?: boolean
  • Optional reverseTransfer?: boolean

SetConnectionTokenParams

SetConnectionTokenParams: { error?: string; token?: string }

Type declaration

  • Optional error?: string
  • Optional token?: string

SetupIntentResultType

SetupIntentResultType: { error?: undefined; setupIntent: SetupIntent.Type } | { error: StripeError; setupIntent?: undefined }

StripeError

StripeError<T>: { code: T; message: string }

Type parameters

Type declaration

  • code: T
  • message: string

UpdateSoftwareResultType

UpdateSoftwareResultType: { error?: StripeError; update?: SoftwareUpdate }

Type declaration

UseStripeTerminalProps

UseStripeTerminalProps: UserCallbacks

useStripeTerminal hook Props

-

UserCallbacks

UserCallbacks: { onDidChangeConnectionStatus?: any; onDidChangeOfflineStatus?: any; onDidChangePaymentStatus?: any; onDidDisconnect?: any; onDidFailReaderReconnect?: any; onDidFinishInstallingUpdate?: any; onDidForwardPaymentIntent?: any; onDidForwardingFailure?: any; onDidReportAvailableUpdate?: any; onDidReportLowBatteryWarning?: any; onDidReportReaderEvent?: any; onDidReportReaderSoftwareUpdateProgress?: any; onDidReportUnexpectedReaderDisconnect?: any; onDidRequestReaderDisplayMessage?: any; onDidRequestReaderInput?: any; onDidStartInstallingUpdate?: any; onDidStartReaderReconnect?: any; onDidSucceedReaderReconnect?: any; onDidUpdateBatteryLevel?: any; onFinishDiscoveringReaders?: any; onUpdateDiscoveredReaders?: any }

Type declaration

Wallet

Wallet: { type: string }

Type declaration

  • type: string

WithStripeTerminalProps

WithStripeTerminalProps: ReturnType<typeof useStripeTerminal>

Variables

CHANGE_CONNECTION_STATUS

CHANGE_CONNECTION_STATUS: any

CHANGE_OFFLINE_STATUS

CHANGE_OFFLINE_STATUS: any

CHANGE_PAYMENT_STATUS

CHANGE_PAYMENT_STATUS: any

FETCH_TOKEN_PROVIDER

FETCH_TOKEN_PROVIDER: any

FINISH_DISCOVERING_READERS

FINISH_DISCOVERING_READERS: any

FINISH_INSTALLING_UPDATE

FINISH_INSTALLING_UPDATE: any

FORWARD_PAYMENT_INTENT

FORWARD_PAYMENT_INTENT: any

READER_RECONNECT_FAIL

READER_RECONNECT_FAIL: any

READER_RECONNECT_SUCCEED

READER_RECONNECT_SUCCEED: any

REPORT_AVAILABLE_UPDATE

REPORT_AVAILABLE_UPDATE: any

REPORT_FORWARDING_ERROR

REPORT_FORWARDING_ERROR: any

REPORT_UNEXPECTED_READER_DISCONNECT

REPORT_UNEXPECTED_READER_DISCONNECT: any

REPORT_UPDATE_PROGRESS

REPORT_UPDATE_PROGRESS: any

REQUEST_READER_DISPLAY_MESSAGE

REQUEST_READER_DISPLAY_MESSAGE: any

REQUEST_READER_INPUT

REQUEST_READER_INPUT: any

START_INSTALLING_UPDATE

START_INSTALLING_UPDATE: any

START_READER_RECONNECT

START_READER_RECONNECT: any

UPDATE_DISCOVERED_READERS

UPDATE_DISCOVERED_READERS: any

Other Functions

requestNeededAndroidPermissions

  • requestNeededAndroidPermissions(__namedParameters?: undefined | PermissionsProps): Promise<Error>

useStripeTerminal

UserCallbacks

UserCallbacks: { onDidChangeConnectionStatus?: any; onDidChangeOfflineStatus?: any; onDidChangePaymentStatus?: any; onDidDisconnect?: any; onDidFailReaderReconnect?: any; onDidFinishInstallingUpdate?: any; onDidForwardPaymentIntent?: any; onDidForwardingFailure?: any; onDidReportAvailableUpdate?: any; onDidReportLowBatteryWarning?: any; onDidReportReaderEvent?: any; onDidReportReaderSoftwareUpdateProgress?: any; onDidReportUnexpectedReaderDisconnect?: any; onDidRequestReaderDisplayMessage?: any; onDidRequestReaderInput?: any; onDidStartInstallingUpdate?: any; onDidStartReaderReconnect?: any; onDidSucceedReaderReconnect?: any; onDidUpdateBatteryLevel?: any; onFinishDiscoveringReaders?: any; onUpdateDiscoveredReaders?: any }

Type declaration

Wallet

Wallet: { type: string }

Type declaration

  • type: string

WithStripeTerminalProps

WithStripeTerminalProps: ReturnType<typeof useStripeTerminal>

Variables

CHANGE_CONNECTION_STATUS

CHANGE_CONNECTION_STATUS: any

CHANGE_OFFLINE_STATUS

CHANGE_OFFLINE_STATUS: any

CHANGE_PAYMENT_STATUS

CHANGE_PAYMENT_STATUS: any

FETCH_TOKEN_PROVIDER

FETCH_TOKEN_PROVIDER: any

FINISH_DISCOVERING_READERS

FINISH_DISCOVERING_READERS: any

FINISH_INSTALLING_UPDATE

FINISH_INSTALLING_UPDATE: any

FORWARD_PAYMENT_INTENT

FORWARD_PAYMENT_INTENT: any

READER_RECONNECT_FAIL

READER_RECONNECT_FAIL: any

READER_RECONNECT_SUCCEED

READER_RECONNECT_SUCCEED: any

REPORT_AVAILABLE_UPDATE

REPORT_AVAILABLE_UPDATE: any

REPORT_FORWARDING_ERROR

REPORT_FORWARDING_ERROR: any

REPORT_UNEXPECTED_READER_DISCONNECT

REPORT_UNEXPECTED_READER_DISCONNECT: any

REPORT_UPDATE_PROGRESS

REPORT_UPDATE_PROGRESS: any

REQUEST_READER_DISPLAY_MESSAGE

REQUEST_READER_DISPLAY_MESSAGE: any

REQUEST_READER_INPUT

REQUEST_READER_INPUT: any

START_INSTALLING_UPDATE

START_INSTALLING_UPDATE: any

START_READER_RECONNECT

START_READER_RECONNECT: any

UPDATE_DISCOVERED_READERS

UPDATE_DISCOVERED_READERS: any

Other Functions

requestNeededAndroidPermissions

  • requestNeededAndroidPermissions(__namedParameters?: undefined | PermissionsProps): Promise<Error>

useStripeTerminal

ReactComponents Functions

StripeTerminalProvider

ReactComponents Functions

StripeTerminalProvider

withStripeTerminal

  • withStripeTerminal<Props>(WrappedComponent: ComponentType<Props>): { displayName: string }

withStripeTerminal

  • withStripeTerminal<Props>(WrappedComponent: ComponentType<Props>): { displayName: string }

Hierarchy

  • StripeTerminalProviderProps

Index

Properties

Methods

Properties

children

children: ReactElement<any, string | JSXElementConstructor<any>> | ReactElement<any, string | JSXElementConstructor<any>>[]

Optional logLevel

logLevel?: LogLevel

Methods

tokenProvider

  • tokenProvider(): Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/interfaces/StripeTerminalSdkType.html b/docs/api-reference/interfaces/StripeTerminalSdkType.html index ec82f217..9e7f3746 100644 --- a/docs/api-reference/interfaces/StripeTerminalSdkType.html +++ b/docs/api-reference/interfaces/StripeTerminalSdkType.html @@ -1 +1 @@ -StripeTerminalSdkType | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StripeTerminalSdkType

Hierarchy

  • StripeTerminalSdkType

Index

Methods

Methods

cancelCollectInputs

cancelCollectPaymentMethod

cancelCollectRefundPaymentMethod

cancelCollectSetupIntent

cancelDiscovering

cancelInstallingUpdate

  • cancelInstallingUpdate(): Promise<void>

cancelPaymentIntent

cancelReaderReconnection

cancelSetupIntent

clearCachedCredentials

clearReaderDisplay

collectInputs

collectPaymentMethod

collectRefundPaymentMethod

collectSetupIntentPaymentMethod

confirmPaymentIntent

confirmRefund

confirmSetupIntent

connectBluetoothReader

connectHandoffReader

connectInternetReader

connectLocalMobileReader

connectUsbReader

createPaymentIntent

createSetupIntent

disconnectReader

discoverReaders

getConnectedReader

getConnectionStatus

getLocations

getOfflineStatus

getPaymentStatus

getReaderSettings

initialize

  • initialize(params: InternalInitParams): InitializeResultNativeType

installAvailableUpdate

  • installAvailableUpdate(): Promise<void>

rebootReader

retrievePaymentIntent

retrieveSetupIntent

setConnectionToken

setReaderDisplay

setReaderSettings

setSimulatedCard

simulateReaderUpdate

supportsReadersOfType

Generated using TypeDoc

\ No newline at end of file +StripeTerminalSdkType | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StripeTerminalSdkType

Hierarchy

  • StripeTerminalSdkType

Index

Methods

Methods

cancelCollectInputs

cancelCollectPaymentMethod

cancelCollectRefundPaymentMethod

cancelCollectSetupIntent

cancelDiscovering

cancelInstallingUpdate

  • cancelInstallingUpdate(): Promise<void>

cancelPaymentIntent

cancelReaderReconnection

cancelSetupIntent

clearCachedCredentials

clearReaderDisplay

collectInputs

collectPaymentMethod

collectRefundPaymentMethod

collectSetupIntentPaymentMethod

confirmPaymentIntent

confirmRefund

confirmSetupIntent

connectBluetoothReader

connectHandoffReader

connectInternetReader

connectLocalMobileReader

connectUsbReader

createPaymentIntent

createSetupIntent

disconnectReader

discoverReaders

getConnectedReader

getConnectionStatus

getLocations

getOfflineStatus

getPaymentStatus

getReaderSettings

initialize

  • initialize(params: InternalInitParams): InitializeResultNativeType

installAvailableUpdate

  • installAvailableUpdate(): Promise<void>

rebootReader

retrievePaymentIntent

retrieveSetupIntent

setConnectionToken

setReaderDisplay

setReaderSettings

setSimulatedCard

simulateReaderUpdate

supportsReadersOfType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/PaymentIntent.html b/docs/api-reference/modules/PaymentIntent.html index f3bdb416..5c23e10f 100644 --- a/docs/api-reference/modules/PaymentIntent.html +++ b/docs/api-reference/modules/PaymentIntent.html @@ -1 +1 @@ -PaymentIntent | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PaymentIntent

Index

Interfaces

Type aliases

Type aliases

Status

Status: "canceled" | "processing" | "requiresCapture" | "requiresConfirmation" | "requiresPaymentMethod" | "succeeded" | "unknown"

Generated using TypeDoc

\ No newline at end of file +PaymentIntent | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PaymentIntent

Index

Interfaces

Type aliases

Type aliases

Status

Status: "canceled" | "processing" | "requiresCapture" | "requiresConfirmation" | "requiresPaymentMethod" | "succeeded" | "unknown"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/PaymentMethod.html b/docs/api-reference/modules/PaymentMethod.html index bd963648..7ac9dd0d 100644 --- a/docs/api-reference/modules/PaymentMethod.html +++ b/docs/api-reference/modules/PaymentMethod.html @@ -1 +1 @@ -PaymentMethod | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PaymentMethod

Index

Type aliases

Type aliases

Type

Type: { cardPresentDetails: CardPresentDetails; customer: string; id: string; interacPresentDetails: CardPresentDetails; metadata?: Record<string, string> }

Type declaration

Generated using TypeDoc

\ No newline at end of file +PaymentMethod | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PaymentMethod

Index

Type aliases

Type aliases

Type

Type: { cardPresentDetails: CardPresentDetails; customer: string; id: string; interacPresentDetails: CardPresentDetails; metadata?: Record<string, string> }

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/Reader.Android.html b/docs/api-reference/modules/Reader.Android.html index f1a98af4..e891b81e 100644 --- a/docs/api-reference/modules/Reader.Android.html +++ b/docs/api-reference/modules/Reader.Android.html @@ -1 +1 @@ -Android | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Android

Index

Type aliases

Type aliases

DiscoveryMethod

DiscoveryMethod: "bluetoothScan" | "internet" | "localMobile" | "handoff" | "usb"

Type

Type: { baseUrl?: string; bootloaderVersion?: string; configVersion?: string; emvKeyProfileId?: string; firmwareVersion?: string; hardwareVersion?: string; macKeyProfileId?: string; pinKeyProfileId?: string; pinKeysetId?: string; settingsVersion?: string; trackKeyProfileId?: string }

Type declaration

  • Optional baseUrl?: string
  • Optional bootloaderVersion?: string
  • Optional configVersion?: string
  • Optional emvKeyProfileId?: string
  • Optional firmwareVersion?: string
  • Optional hardwareVersion?: string
  • Optional macKeyProfileId?: string
  • Optional pinKeyProfileId?: string
  • Optional pinKeysetId?: string
  • Optional settingsVersion?: string
  • Optional trackKeyProfileId?: string

Generated using TypeDoc

\ No newline at end of file +Android | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Android

Index

Type aliases

Type aliases

DiscoveryMethod

DiscoveryMethod: "bluetoothScan" | "internet" | "localMobile" | "handoff" | "usb"

Type

Type: { baseUrl?: string; bootloaderVersion?: string; configVersion?: string; emvKeyProfileId?: string; firmwareVersion?: string; hardwareVersion?: string; macKeyProfileId?: string; pinKeyProfileId?: string; pinKeysetId?: string; settingsVersion?: string; trackKeyProfileId?: string }

Type declaration

  • Optional baseUrl?: string
  • Optional bootloaderVersion?: string
  • Optional configVersion?: string
  • Optional emvKeyProfileId?: string
  • Optional firmwareVersion?: string
  • Optional hardwareVersion?: string
  • Optional macKeyProfileId?: string
  • Optional pinKeyProfileId?: string
  • Optional pinKeysetId?: string
  • Optional settingsVersion?: string
  • Optional trackKeyProfileId?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/Reader.IOS.html b/docs/api-reference/modules/Reader.IOS.html index 4b35840e..b83755f0 100644 --- a/docs/api-reference/modules/Reader.IOS.html +++ b/docs/api-reference/modules/Reader.IOS.html @@ -1 +1 @@ -IOS | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IOS

Index

Type aliases

Type aliases

DiscoveryMethod

DiscoveryMethod: "bluetoothProximity" | "bluetoothScan" | "internet" | "localMobile"

Type

Type: { batteryStatus: BatteryStatus; isCharging?: number }

Type declaration

Generated using TypeDoc

\ No newline at end of file +IOS | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IOS

Index

Type aliases

Type aliases

DiscoveryMethod

DiscoveryMethod: "bluetoothProximity" | "bluetoothScan" | "internet" | "localMobile"

Type

Type: { batteryStatus: BatteryStatus; isCharging?: number }

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/Reader.html b/docs/api-reference/modules/Reader.html index 485480fe..ba102944 100644 --- a/docs/api-reference/modules/Reader.html +++ b/docs/api-reference/modules/Reader.html @@ -1 +1 @@ -Reader | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Reader

Index

Namespaces

Type aliases

Type aliases

Accessibility

Accessibility: { error?: StripeError; textToSpeechStatus: ReaderTextToSpeechStatus }

Type declaration

BatteryLevel

BatteryLevel: { batteryLevel: number; batteryStatus: BatteryStatus; isCharging: boolean }

Type declaration

  • batteryLevel: number
  • batteryStatus: BatteryStatus
  • isCharging: boolean

BatteryStatus

BatteryStatus: "critical" | "low" | "nominal" | "unknown"

ConnectionStatus

ConnectionStatus: "connected" | "connecting" | "notConnected"

DeviceType

DeviceType: "chipper1X" | "chipper2X" | "stripeM2" | "verifoneP400" | "wiseCube" | "wisePad3" | "wisePosE" | "wisePad3s" | "wisePadEDevkit" | "stripeS700Devkit" | "stripeS700" | "cotsDevice" | "appleBuiltIn" | "etna"

DisconnectReason

DisconnectReason: "disconnectRequested" | "rebootRequested" | "securityReboot" | "criticallyLowBattery" | "poweredOff" | "bluetoothDisabled" | "unknown"

DiscoveryMethod

DiscoveryMethod: Reader.IOS.DiscoveryMethod | Reader.Android.DiscoveryMethod

DisplayMessage

DisplayMessage: "insertCard" | "insertOrSwipeCard" | "multipleContactlessCardsDetected" | "removeCard" | "retryCard" | "swipeCard" | "tryAnotherCard" | "tryAnotherReadMethod" | "checkMobileDevice" | "cardRemovedTooEarly"

EstimatedUpdateTime

EstimatedUpdateTime: "estimate1To2Minutes" | "estimate2To5Minutes" | "estimate5To15Minutes" | "estimateLessThan1Minute"

InputOptions

InputOptions: "insertCard" | "swipeCard" | "tapCard"

NetworkStatus

NetworkStatus: "offline" | "online"

ReaderSettings

ReaderSettings: { accessibility?: Accessibility; error?: undefined } | { accessibility?: undefined; error?: StripeError }

ReaderSettingsParameters

ReaderSettingsParameters: { textToSpeechViaSpeakers: boolean }

Type declaration

  • textToSpeechViaSpeakers: boolean

ReaderSupportParams

ReaderSupportParams: { deviceType: DeviceType; discoveryMethod: Reader.DiscoveryMethod; simulated?: boolean }

Type declaration

ReaderSupportResult

ReaderSupportResult: { error?: StripeError; readerSupportResult: boolean }

Type declaration

  • Optional error?: StripeError
  • readerSupportResult: boolean

ReaderTextToSpeechStatus

ReaderTextToSpeechStatus: "off" | "headphones" | "speakers"

SimulateUpdateType

SimulateUpdateType: "random" | "available" | "none" | "required" | "lowBattery"

SoftwareUpdate

SoftwareUpdate: { deviceSoftwareVersion: string; estimatedUpdateTime: EstimatedUpdateTime; requiredAt?: string }

Type declaration

  • deviceSoftwareVersion: string
  • estimatedUpdateTime: EstimatedUpdateTime
  • Optional requiredAt?: string

Type

Type: Reader.IOS.Type & Reader.Android.Type & { availableUpdate?: SoftwareUpdate; batteryLevel?: number; deviceSoftwareVersion?: string; deviceType: DeviceType; id: string; ipAddress?: string; label?: string; location?: Location; locationId?: string; locationStatus: LocationStatus; serialNumber: string; simulated?: boolean; status: NetworkStatus }

Generated using TypeDoc

\ No newline at end of file +Reader | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Reader

Index

Namespaces

Type aliases

Type aliases

Accessibility

Accessibility: { error?: StripeError; textToSpeechStatus: ReaderTextToSpeechStatus }

Type declaration

BatteryLevel

BatteryLevel: { batteryLevel: number; batteryStatus: BatteryStatus; isCharging: boolean }

Type declaration

  • batteryLevel: number
  • batteryStatus: BatteryStatus
  • isCharging: boolean

BatteryStatus

BatteryStatus: "critical" | "low" | "nominal" | "unknown"

ConnectionStatus

ConnectionStatus: "connected" | "connecting" | "notConnected"

DeviceType

DeviceType: "chipper1X" | "chipper2X" | "stripeM2" | "verifoneP400" | "wiseCube" | "wisePad3" | "wisePosE" | "wisePad3s" | "wisePadEDevkit" | "stripeS700Devkit" | "stripeS700" | "cotsDevice" | "appleBuiltIn" | "etna"

DisconnectReason

DisconnectReason: "disconnectRequested" | "rebootRequested" | "securityReboot" | "criticallyLowBattery" | "poweredOff" | "bluetoothDisabled" | "unknown"

DiscoveryMethod

DiscoveryMethod: Reader.IOS.DiscoveryMethod | Reader.Android.DiscoveryMethod

DisplayMessage

DisplayMessage: "insertCard" | "insertOrSwipeCard" | "multipleContactlessCardsDetected" | "removeCard" | "retryCard" | "swipeCard" | "tryAnotherCard" | "tryAnotherReadMethod" | "checkMobileDevice" | "cardRemovedTooEarly"

EstimatedUpdateTime

EstimatedUpdateTime: "estimate1To2Minutes" | "estimate2To5Minutes" | "estimate5To15Minutes" | "estimateLessThan1Minute"

InputOptions

InputOptions: "insertCard" | "swipeCard" | "tapCard"

NetworkStatus

NetworkStatus: "offline" | "online"

ReaderSettings

ReaderSettings: { accessibility?: Accessibility; error?: undefined } | { accessibility?: undefined; error?: StripeError }

ReaderSettingsParameters

ReaderSettingsParameters: { textToSpeechViaSpeakers: boolean }

Type declaration

  • textToSpeechViaSpeakers: boolean

ReaderSupportParams

ReaderSupportParams: { deviceType: DeviceType; discoveryMethod: Reader.DiscoveryMethod; simulated?: boolean }

Type declaration

ReaderSupportResult

ReaderSupportResult: { error?: StripeError; readerSupportResult: boolean }

Type declaration

  • Optional error?: StripeError
  • readerSupportResult: boolean

ReaderTextToSpeechStatus

ReaderTextToSpeechStatus: "off" | "headphones" | "speakers"

SimulateUpdateType

SimulateUpdateType: "random" | "available" | "none" | "required" | "lowBattery"

SoftwareUpdate

SoftwareUpdate: { deviceSoftwareVersion: string; estimatedUpdateTime: EstimatedUpdateTime; requiredAt?: string }

Type declaration

  • deviceSoftwareVersion: string
  • estimatedUpdateTime: EstimatedUpdateTime
  • Optional requiredAt?: string

Type

Type: Reader.IOS.Type & Reader.Android.Type & { availableUpdate?: SoftwareUpdate; batteryLevel?: number; deviceSoftwareVersion?: string; deviceType: DeviceType; id: string; ipAddress?: string; label?: string; location?: Location; locationId?: string; locationStatus: LocationStatus; serialNumber: string; simulated?: boolean; status: NetworkStatus }

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/Refund.html b/docs/api-reference/modules/Refund.html index 6ff7bbc6..1a2b110d 100644 --- a/docs/api-reference/modules/Refund.html +++ b/docs/api-reference/modules/Refund.html @@ -1 +1 @@ -Refund | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Refund

Index

Namespaces

Type aliases

Type aliases

Props

Props: Refund.IOS.Props & Refund.Android.Props & { amount?: number; chargeId: string; currency?: string; description?: string; failureReason?: string; id: string; metadata?: Record<string, string>; reason?: string; status?: Refund.Status }

Status

Status: "succeeded" | "failed" | "pending" | "unknown"

Generated using TypeDoc

\ No newline at end of file +Refund | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Refund

Index

Namespaces

Type aliases

Type aliases

Props

Props: Refund.IOS.Props & Refund.Android.Props & { amount?: number; chargeId: string; currency?: string; description?: string; failureReason?: string; id: string; metadata?: Record<string, string>; reason?: string; status?: Refund.Status }

Status

Status: "succeeded" | "failed" | "pending" | "unknown"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/SetupIntent.Android.html b/docs/api-reference/modules/SetupIntent.Android.html index ace61d1b..c6ffba73 100644 --- a/docs/api-reference/modules/SetupIntent.Android.html +++ b/docs/api-reference/modules/SetupIntent.Android.html @@ -1 +1 @@ -Android | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Android

Index

Type aliases

Type aliases

SetupAttempt

SetupAttempt: { isLiveMode: boolean; usage?: Usage }

Type declaration

  • isLiveMode: boolean
  • Optional usage?: Usage

Type

Type: { applicationId?: string; clientSecret?: string; description?: string; mandateId?: string; onBehalfOfId?: string; paymentMethodId?: string; singleUseMandateId?: string }

Type declaration

  • Optional applicationId?: string
  • Optional clientSecret?: string
  • Optional description?: string
  • Optional mandateId?: string
  • Optional onBehalfOfId?: string
  • Optional paymentMethodId?: string
  • Optional singleUseMandateId?: string

Generated using TypeDoc

\ No newline at end of file +Android | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Android

Index

Type aliases

Type aliases

SetupAttempt

SetupAttempt: { isLiveMode: boolean; usage?: Usage }

Type declaration

  • isLiveMode: boolean
  • Optional usage?: Usage

Type

Type: { applicationId?: string; clientSecret?: string; description?: string; mandateId?: string; onBehalfOfId?: string; paymentMethodId?: string; singleUseMandateId?: string }

Type declaration

  • Optional applicationId?: string
  • Optional clientSecret?: string
  • Optional description?: string
  • Optional mandateId?: string
  • Optional onBehalfOfId?: string
  • Optional paymentMethodId?: string
  • Optional singleUseMandateId?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/api-reference/modules/SetupIntent.IOS.html b/docs/api-reference/modules/SetupIntent.IOS.html index f8d6c022..fb3e9a5e 100644 --- a/docs/api-reference/modules/SetupIntent.IOS.html +++ b/docs/api-reference/modules/SetupIntent.IOS.html @@ -1 +1 @@ -IOS | @stripe/stripe-terminal-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IOS

Index

Type aliases

Type aliases

SetupAttempt

SetupAttempt: {}

Type declaration

    Type

    Type: {}

    Type declaration

      Generated using TypeDoc

      \ No newline at end of file +IOS | @stripe/stripe-terminal-react-native
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace IOS

      Index

      Type aliases

      Type aliases

      SetupAttempt

      SetupAttempt: {}

      Type declaration

        Type

        Type: {}

        Type declaration

          Generated using TypeDoc

          \ No newline at end of file diff --git a/docs/api-reference/modules/SetupIntent.html b/docs/api-reference/modules/SetupIntent.html index 6a66f3b6..9aef12da 100644 --- a/docs/api-reference/modules/SetupIntent.html +++ b/docs/api-reference/modules/SetupIntent.html @@ -1 +1 @@ -SetupIntent | @stripe/stripe-terminal-react-native
          Options
          All
          • Public
          • Public/Protected
          • All
          Menu

          Namespace SetupIntent

          Index

          Namespaces

          Interfaces

          Type aliases

          Type aliases

          SetupAttempt

          SetupAttempt: SetupIntent.IOS.SetupAttempt & SetupIntent.Android.SetupAttempt & { applicationId?: string; created?: number; customer?: string; id: string; onBehalfOfId?: string; paymentMethodDetails: SetupAttemptPaymentMethodDetails; paymentMethodId?: string; setupIntentId?: string; status: string }

          Status

          Status: "canceled" | "processing" | "requiresAction" | "requiresConfirmation" | "requiresPaymentMethod" | "succeeded" | "unknown"

          Type

          Type: SetupIntent.Android.Type & SetupIntent.IOS.Type & { created: string; customer?: string; id: string; latestAttempt: SetupIntent.SetupAttempt; metadata?: Record<string, string>; paymentMethodTypes?: string[]; sdkUuid: string; status: SetupIntent.Status; usage: Usage }

          Usage

          Usage: "offSession" | "onSession"

          Generated using TypeDoc

          \ No newline at end of file +SetupIntent | @stripe/stripe-terminal-react-native
          Options
          All
          • Public
          • Public/Protected
          • All
          Menu

          Namespace SetupIntent

          Index

          Namespaces

          Interfaces

          Type aliases

          Type aliases

          SetupAttempt

          SetupAttempt: SetupIntent.IOS.SetupAttempt & SetupIntent.Android.SetupAttempt & { applicationId?: string; created?: number; customer?: string; id: string; onBehalfOfId?: string; paymentMethodDetails: SetupAttemptPaymentMethodDetails; paymentMethodId?: string; setupIntentId?: string; status: string }

          Status

          Status: "canceled" | "processing" | "requiresAction" | "requiresConfirmation" | "requiresPaymentMethod" | "succeeded" | "unknown"

          Type

          Type: SetupIntent.Android.Type & SetupIntent.IOS.Type & { created: string; customer?: string; id: string; latestAttempt: SetupIntent.SetupAttempt; metadata?: Record<string, string>; paymentMethodTypes?: string[]; sdkUuid: string; status: SetupIntent.Status; usage: Usage }

          Usage

          Usage: "offSession" | "onSession"

          Generated using TypeDoc

          \ No newline at end of file