@capacitor-community/stripe-terminal 6.0.2 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CapacitorCommunityStripeTerminal.podspec +1 -1
- package/README.md +484 -14
- package/android/build.gradle +1 -1
- package/android/src/main/java/com/getcapacitor/community/stripe/terminal/StripeTerminal.java +111 -8
- package/android/src/main/java/com/getcapacitor/community/stripe/terminal/StripeTerminalPlugin.java +31 -5
- package/android/src/main/java/com/getcapacitor/community/stripe/terminal/TerminalEvent.kt +11 -0
- package/dist/docs.json +930 -17
- package/dist/esm/definitions.d.ts +173 -10
- package/dist/esm/definitions.js +1 -8
- package/dist/esm/definitions.js.map +1 -1
- package/dist/esm/events.enum.d.ts +12 -1
- package/dist/esm/events.enum.js +11 -0
- package/dist/esm/events.enum.js.map +1 -1
- package/dist/esm/stripe.enum.d.ts +103 -0
- package/dist/esm/stripe.enum.js +115 -0
- package/dist/esm/stripe.enum.js.map +1 -0
- package/dist/esm/web.d.ts +6 -1
- package/dist/esm/web.js +3 -0
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +120 -0
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +120 -0
- package/dist/plugin.js.map +1 -1
- package/ios/Plugin/StripeTerminal.swift +113 -14
- package/ios/Plugin/StripeTerminalPlugin.m +1 -0
- package/ios/Plugin/StripeTerminalPlugin.swift +4 -0
- package/ios/Plugin/TerminalEvents.swift +11 -0
- package/ios/Plugin/TerminalMappers.swift +142 -0
- package/package.json +1 -1
|
@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
|
|
|
13
13
|
s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
|
|
14
14
|
s.ios.deployment_target = '13.0'
|
|
15
15
|
s.dependency 'Capacitor'
|
|
16
|
-
s.dependency 'StripeTerminal', '~> 3.
|
|
16
|
+
s.dependency 'StripeTerminal', '~> 3.8.0'
|
|
17
17
|
s.swift_version = '5.1'
|
|
18
18
|
end
|
package/README.md
CHANGED
|
@@ -116,6 +116,7 @@ And update minSdkVersion to 26 And compileSdkVersion to 34 in your `android/app/
|
|
|
116
116
|
* [`initialize(...)`](#initialize)
|
|
117
117
|
* [`discoverReaders(...)`](#discoverreaders)
|
|
118
118
|
* [`setConnectionToken(...)`](#setconnectiontoken)
|
|
119
|
+
* [`setSimulatorConfiguration(...)`](#setsimulatorconfiguration)
|
|
119
120
|
* [`connectReader(...)`](#connectreader)
|
|
120
121
|
* [`getConnectedReader()`](#getconnectedreader)
|
|
121
122
|
* [`disconnectReader()`](#disconnectreader)
|
|
@@ -127,10 +128,22 @@ And update minSdkVersion to 26 And compileSdkVersion to 34 in your `android/app/
|
|
|
127
128
|
* [`addListener(TerminalEventsEnum.RequestedConnectionToken, ...)`](#addlistenerterminaleventsenumrequestedconnectiontoken)
|
|
128
129
|
* [`addListener(TerminalEventsEnum.DiscoveredReaders, ...)`](#addlistenerterminaleventsenumdiscoveredreaders)
|
|
129
130
|
* [`addListener(TerminalEventsEnum.ConnectedReader, ...)`](#addlistenerterminaleventsenumconnectedreader)
|
|
131
|
+
* [`addListener(TerminalEventsEnum.DisconnectedReader, ...)`](#addlistenerterminaleventsenumdisconnectedreader)
|
|
132
|
+
* [`addListener(TerminalEventsEnum.ConnectionStatusChange, ...)`](#addlistenerterminaleventsenumconnectionstatuschange)
|
|
133
|
+
* [`addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)`](#addlistenerterminaleventsenumunexpectedreaderdisconnect)
|
|
130
134
|
* [`addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)`](#addlistenerterminaleventsenumconfirmedpaymentintent)
|
|
131
135
|
* [`addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)`](#addlistenerterminaleventsenumcollectedpaymentintent)
|
|
132
136
|
* [`addListener(TerminalEventsEnum.Canceled, ...)`](#addlistenerterminaleventsenumcanceled)
|
|
133
137
|
* [`addListener(TerminalEventsEnum.Failed, ...)`](#addlistenerterminaleventsenumfailed)
|
|
138
|
+
* [`addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)`](#addlistenerterminaleventsenumreportavailableupdate)
|
|
139
|
+
* [`addListener(TerminalEventsEnum.StartInstallingUpdate, ...)`](#addlistenerterminaleventsenumstartinstallingupdate)
|
|
140
|
+
* [`addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)`](#addlistenerterminaleventsenumreadersoftwareupdateprogress)
|
|
141
|
+
* [`addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)`](#addlistenerterminaleventsenumfinishinstallingupdate)
|
|
142
|
+
* [`addListener(TerminalEventsEnum.BatteryLevel, ...)`](#addlistenerterminaleventsenumbatterylevel)
|
|
143
|
+
* [`addListener(TerminalEventsEnum.ReaderEvent, ...)`](#addlistenerterminaleventsenumreaderevent)
|
|
144
|
+
* [`addListener(TerminalEventsEnum.RequestDisplayMessage, ...)`](#addlistenerterminaleventsenumrequestdisplaymessage)
|
|
145
|
+
* [`addListener(TerminalEventsEnum.RequestReaderInput, ...)`](#addlistenerterminaleventsenumrequestreaderinput)
|
|
146
|
+
* [`addListener(TerminalEventsEnum.PaymentStatusChange, ...)`](#addlistenerterminaleventsenumpaymentstatuschange)
|
|
134
147
|
* [Interfaces](#interfaces)
|
|
135
148
|
* [Type Aliases](#type-aliases)
|
|
136
149
|
* [Enums](#enums)
|
|
@@ -181,6 +194,21 @@ setConnectionToken(options: { token: string; }) => Promise<void>
|
|
|
181
194
|
--------------------
|
|
182
195
|
|
|
183
196
|
|
|
197
|
+
### setSimulatorConfiguration(...)
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
setSimulatorConfiguration(options: { update?: SimulateReaderUpdate; simulatedCard?: SimulatedCardType; simulatedTipAmount?: number; }) => Promise<void>
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-simulator-configuration/index.html)
|
|
204
|
+
|
|
205
|
+
| Param | Type |
|
|
206
|
+
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
207
|
+
| **`options`** | <code>{ update?: <a href="#simulatereaderupdate">SimulateReaderUpdate</a>; simulatedCard?: <a href="#simulatedcardtype">SimulatedCardType</a>; simulatedTipAmount?: number; }</code> |
|
|
208
|
+
|
|
209
|
+
--------------------
|
|
210
|
+
|
|
211
|
+
|
|
184
212
|
### connectReader(...)
|
|
185
213
|
|
|
186
214
|
```typescript
|
|
@@ -289,13 +317,13 @@ addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc
|
|
|
289
317
|
### addListener(TerminalEventsEnum.DiscoveredReaders, ...)
|
|
290
318
|
|
|
291
319
|
```typescript
|
|
292
|
-
addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: (
|
|
320
|
+
addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>
|
|
293
321
|
```
|
|
294
322
|
|
|
295
323
|
| Param | Type |
|
|
296
324
|
| ------------------ | ----------------------------------------------------------------------------------- |
|
|
297
325
|
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.DiscoveredReaders</a></code> |
|
|
298
|
-
| **`listenerFunc`** | <code>(
|
|
326
|
+
| **`listenerFunc`** | <code>({ readers }: { readers: ReaderInterface[]; }) => void</code> |
|
|
299
327
|
|
|
300
328
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
301
329
|
|
|
@@ -318,6 +346,88 @@ addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => v
|
|
|
318
346
|
--------------------
|
|
319
347
|
|
|
320
348
|
|
|
349
|
+
### addListener(TerminalEventsEnum.DisconnectedReader, ...)
|
|
350
|
+
|
|
351
|
+
```typescript
|
|
352
|
+
addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
Emitted when the reader is disconnected, either in response to [`disconnectReader()`](#disconnectreader)
|
|
356
|
+
or some connection error.
|
|
357
|
+
|
|
358
|
+
For all reader types, this is emitted in response to [`disconnectReader()`](#disconnectreader)
|
|
359
|
+
without a `reason` property.
|
|
360
|
+
|
|
361
|
+
For Bluetooth and USB readers, this is emitted with a `reason` property when the reader disconnects.
|
|
362
|
+
|
|
363
|
+
**Note:** For Bluetooth and USB readers, when you call [`disconnectReader()`](#disconnectreader), this event
|
|
364
|
+
will be emitted twice: one without a `reason` in acknowledgement of your call, and again with a `reason` when the reader
|
|
365
|
+
finishes disconnecting.
|
|
366
|
+
|
|
367
|
+
| Param | Type |
|
|
368
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
369
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.DisconnectedReader</a></code> |
|
|
370
|
+
| **`listenerFunc`** | <code>({ reason }: { reason?: <a href="#disconnectreason">DisconnectReason</a>; }) => void</code> |
|
|
371
|
+
|
|
372
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
373
|
+
|
|
374
|
+
--------------------
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
### addListener(TerminalEventsEnum.ConnectionStatusChange, ...)
|
|
378
|
+
|
|
379
|
+
```typescript
|
|
380
|
+
addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
Emitted when the Terminal's connection status changed.
|
|
384
|
+
|
|
385
|
+
Note: You should *not* use this method to detect when a reader unexpectedly disconnects from your app,
|
|
386
|
+
as it cannot be used to accurately distinguish between expected and unexpected disconnect events.
|
|
387
|
+
|
|
388
|
+
To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
|
|
389
|
+
the UnexpectedReaderDisconnect event.
|
|
390
|
+
|
|
391
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-connection-status-change.html)
|
|
392
|
+
|
|
393
|
+
| Param | Type |
|
|
394
|
+
| ------------------ | --------------------------------------------------------------------------------------------------- |
|
|
395
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.ConnectionStatusChange</a></code> |
|
|
396
|
+
| **`listenerFunc`** | <code>({ status }: { status: <a href="#connectionstatus">ConnectionStatus</a>; }) => void</code> |
|
|
397
|
+
|
|
398
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
399
|
+
|
|
400
|
+
--------------------
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
### addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)
|
|
404
|
+
|
|
405
|
+
```typescript
|
|
406
|
+
addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
The Terminal disconnected unexpectedly from the reader.
|
|
410
|
+
|
|
411
|
+
In your implementation of this method, you may want to notify your user that the reader disconnected.
|
|
412
|
+
You may also call [`discoverReaders()`](#discoverreaders) to begin scanning for readers, and attempt
|
|
413
|
+
to automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
|
|
414
|
+
possible to cancel calls to `discoverReaders()`
|
|
415
|
+
|
|
416
|
+
When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
|
|
417
|
+
implementing the DisconnectedReader event.
|
|
418
|
+
|
|
419
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-unexpected-reader-disconnect.html)
|
|
420
|
+
|
|
421
|
+
| Param | Type |
|
|
422
|
+
| ------------------ | ------------------------------------------------------------------------------------------------- |
|
|
423
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.UnexpectedReaderDisconnect</a></code> |
|
|
424
|
+
| **`listenerFunc`** | <code>({ reader }: { reader: <a href="#readerinterface">ReaderInterface</a>; }) => void</code> |
|
|
425
|
+
|
|
426
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
427
|
+
|
|
428
|
+
--------------------
|
|
429
|
+
|
|
430
|
+
|
|
321
431
|
### addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)
|
|
322
432
|
|
|
323
433
|
```typescript
|
|
@@ -356,6 +466,9 @@ addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc:
|
|
|
356
466
|
addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
357
467
|
```
|
|
358
468
|
|
|
469
|
+
Emitted when [`cancelCollectPaymentMethod()`](#cancelcollectpaymentmethod) is called and succeeds.
|
|
470
|
+
The Promise returned by `cancelCollectPaymentMethod()` will also be resolved.
|
|
471
|
+
|
|
359
472
|
| Param | Type |
|
|
360
473
|
| ------------------ | -------------------------------------------------------------------------- |
|
|
361
474
|
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.Canceled</a></code> |
|
|
@@ -372,6 +485,9 @@ addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) =>
|
|
|
372
485
|
addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>
|
|
373
486
|
```
|
|
374
487
|
|
|
488
|
+
Emitted when either [`collectPaymentMethod()`](#collectpaymentmethod) or [`confirmPaymentIntent()`](#confirmpaymentintent)
|
|
489
|
+
fails. The Promise returned by the relevant call will also be rejected.
|
|
490
|
+
|
|
375
491
|
| Param | Type |
|
|
376
492
|
| ------------------ | ------------------------------------------------------------------------ |
|
|
377
493
|
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.Failed</a></code> |
|
|
@@ -382,6 +498,208 @@ addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: () => void) => P
|
|
|
382
498
|
--------------------
|
|
383
499
|
|
|
384
500
|
|
|
501
|
+
### addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)
|
|
502
|
+
|
|
503
|
+
```typescript
|
|
504
|
+
addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
Emitted when a software update is available for the connected reader.
|
|
508
|
+
|
|
509
|
+
| Param | Type |
|
|
510
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
511
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.ReportAvailableUpdate</a></code> |
|
|
512
|
+
| **`listenerFunc`** | <code>({ update, }: { update: <a href="#readersoftwareupdateinterface">ReaderSoftwareUpdateInterface</a>; }) => void</code> |
|
|
513
|
+
|
|
514
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
515
|
+
|
|
516
|
+
--------------------
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
### addListener(TerminalEventsEnum.StartInstallingUpdate, ...)
|
|
520
|
+
|
|
521
|
+
```typescript
|
|
522
|
+
addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
526
|
+
|
|
527
|
+
Emitted when the connected reader begins installing a software update.
|
|
528
|
+
If a mandatory software update is available when a reader first connects, that update is
|
|
529
|
+
automatically installed. The update will be installed before ConnectedReader is emitted and
|
|
530
|
+
before the Promise returned by [`connectReader()`](#connectreader) resolves.
|
|
531
|
+
In this case, you will receive this sequence of events:
|
|
532
|
+
|
|
533
|
+
1. StartInstallingUpdate
|
|
534
|
+
2. ReaderSoftwareUpdateProgress (repeatedly)
|
|
535
|
+
3. FinishInstallingUpdates
|
|
536
|
+
4. ConnectedReader
|
|
537
|
+
5. `connectReader()` Promise resolves
|
|
538
|
+
|
|
539
|
+
Your app should show UI to the user indiciating that a software update is being installed
|
|
540
|
+
to explain why connecting is taking longer than usual.
|
|
541
|
+
|
|
542
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-start-installing-update.html)
|
|
543
|
+
|
|
544
|
+
| Param | Type |
|
|
545
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
546
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.StartInstallingUpdate</a></code> |
|
|
547
|
+
| **`listenerFunc`** | <code>({ update, }: { update: <a href="#readersoftwareupdateinterface">ReaderSoftwareUpdateInterface</a>; }) => void</code> |
|
|
548
|
+
|
|
549
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
550
|
+
|
|
551
|
+
--------------------
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
### addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)
|
|
555
|
+
|
|
556
|
+
```typescript
|
|
557
|
+
addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
561
|
+
|
|
562
|
+
Emitted periodically while reader software is updating to inform of the installation progress.
|
|
563
|
+
`progress` is a float between 0 and 1.
|
|
564
|
+
|
|
565
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-report-reader-software-update-progress.html)
|
|
566
|
+
|
|
567
|
+
| Param | Type |
|
|
568
|
+
| ------------------ | ---------------------------------------------------------------------------------------------- |
|
|
569
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.ReaderSoftwareUpdateProgress</a></code> |
|
|
570
|
+
| **`listenerFunc`** | <code>({ progress }: { progress: number; }) => void</code> |
|
|
571
|
+
|
|
572
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
573
|
+
|
|
574
|
+
--------------------
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
### addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)
|
|
578
|
+
|
|
579
|
+
```typescript
|
|
580
|
+
addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
584
|
+
|
|
585
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-finish-installing-update.html)
|
|
586
|
+
|
|
587
|
+
| Param | Type |
|
|
588
|
+
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
589
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.FinishInstallingUpdate</a></code> |
|
|
590
|
+
| **`listenerFunc`** | <code>(args: { update: <a href="#readersoftwareupdateinterface">ReaderSoftwareUpdateInterface</a>; } \| { error: string; }) => void</code> |
|
|
591
|
+
|
|
592
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
593
|
+
|
|
594
|
+
--------------------
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
### addListener(TerminalEventsEnum.BatteryLevel, ...)
|
|
598
|
+
|
|
599
|
+
```typescript
|
|
600
|
+
addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status, }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
604
|
+
|
|
605
|
+
Emitted upon connection and every 10 minutes.
|
|
606
|
+
|
|
607
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-battery-level-update.html)
|
|
608
|
+
|
|
609
|
+
| Param | Type |
|
|
610
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
611
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.BatteryLevel</a></code> |
|
|
612
|
+
| **`listenerFunc`** | <code>({ level, charging, status, }: { level: number; charging: boolean; status: <a href="#batterystatus">BatteryStatus</a>; }) => void</code> |
|
|
613
|
+
|
|
614
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
615
|
+
|
|
616
|
+
--------------------
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
### addListener(TerminalEventsEnum.ReaderEvent, ...)
|
|
620
|
+
|
|
621
|
+
```typescript
|
|
622
|
+
addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
626
|
+
|
|
627
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listenable/on-report-reader-event.html)
|
|
628
|
+
|
|
629
|
+
| Param | Type |
|
|
630
|
+
| ------------------ | --------------------------------------------------------------------------------------- |
|
|
631
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.ReaderEvent</a></code> |
|
|
632
|
+
| **`listenerFunc`** | <code>({ event }: { event: <a href="#readerevent">ReaderEvent</a>; }) => void</code> |
|
|
633
|
+
|
|
634
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
635
|
+
|
|
636
|
+
--------------------
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
### addListener(TerminalEventsEnum.RequestDisplayMessage, ...)
|
|
640
|
+
|
|
641
|
+
```typescript
|
|
642
|
+
addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message, }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
646
|
+
|
|
647
|
+
Emitted when the Terminal requests that a message be displayed in your app.
|
|
648
|
+
|
|
649
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-display-message.html)
|
|
650
|
+
|
|
651
|
+
| Param | Type |
|
|
652
|
+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
653
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.RequestDisplayMessage</a></code> |
|
|
654
|
+
| **`listenerFunc`** | <code>({ messageType, message, }: { messageType: <a href="#readerdisplaymessage">ReaderDisplayMessage</a>; message: string; }) => void</code> |
|
|
655
|
+
|
|
656
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
657
|
+
|
|
658
|
+
--------------------
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
### addListener(TerminalEventsEnum.RequestReaderInput, ...)
|
|
662
|
+
|
|
663
|
+
```typescript
|
|
664
|
+
addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
**Only applicable to Bluetooth and USB readers.**
|
|
668
|
+
|
|
669
|
+
Emitted when the reader begins waiting for input. Your app should prompt the customer
|
|
670
|
+
to present a source using one of the given input options. If the reader emits a message,
|
|
671
|
+
the RequestDisplayMessage event will be emitted.
|
|
672
|
+
|
|
673
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-reader-listener/on-request-reader-input.html)
|
|
674
|
+
|
|
675
|
+
| Param | Type |
|
|
676
|
+
| ------------------ | --------------------------------------------------------------------------------------------------- |
|
|
677
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.RequestReaderInput</a></code> |
|
|
678
|
+
| **`listenerFunc`** | <code>({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void</code> |
|
|
679
|
+
|
|
680
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
681
|
+
|
|
682
|
+
--------------------
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
### addListener(TerminalEventsEnum.PaymentStatusChange, ...)
|
|
686
|
+
|
|
687
|
+
```typescript
|
|
688
|
+
addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-payment-status-change.html)
|
|
692
|
+
|
|
693
|
+
| Param | Type |
|
|
694
|
+
| ------------------ | --------------------------------------------------------------------------------------------- |
|
|
695
|
+
| **`eventName`** | <code><a href="#terminaleventsenum">TerminalEventsEnum.PaymentStatusChange</a></code> |
|
|
696
|
+
| **`listenerFunc`** | <code>({ status }: { status: <a href="#paymentstatus">PaymentStatus</a>; }) => void</code> |
|
|
697
|
+
|
|
698
|
+
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
699
|
+
|
|
700
|
+
--------------------
|
|
701
|
+
|
|
702
|
+
|
|
385
703
|
### Interfaces
|
|
386
704
|
|
|
387
705
|
|
|
@@ -400,6 +718,11 @@ addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: () => void) => P
|
|
|
400
718
|
<code>{ index: number; serialNumber: string; }</code>
|
|
401
719
|
|
|
402
720
|
|
|
721
|
+
#### ReaderSoftwareUpdateInterface
|
|
722
|
+
|
|
723
|
+
<code>{ version: string; settingsVersion: string; requiredAt: number; timeEstimate: <a href="#updatetimeestimate">UpdateTimeEstimate</a>; }</code>
|
|
724
|
+
|
|
725
|
+
|
|
403
726
|
### Enums
|
|
404
727
|
|
|
405
728
|
|
|
@@ -414,19 +737,166 @@ addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: () => void) => P
|
|
|
414
737
|
| **`TapToPay`** | <code>'tap-to-pay'</code> |
|
|
415
738
|
|
|
416
739
|
|
|
740
|
+
#### SimulateReaderUpdate
|
|
741
|
+
|
|
742
|
+
| Members | Value |
|
|
743
|
+
| ------------------------------ | ------------------------------------------ |
|
|
744
|
+
| **`UpdateAvailable`** | <code>'UPDATE_AVAILABLE'</code> |
|
|
745
|
+
| **`None`** | <code>'NONE'</code> |
|
|
746
|
+
| **`Required`** | <code>'REQUIRED'</code> |
|
|
747
|
+
| **`Random`** | <code>'RANDOM'</code> |
|
|
748
|
+
| **`LowBattery`** | <code>'LOW_BATTERY'</code> |
|
|
749
|
+
| **`LowBatterySucceedConnect`** | <code>'LOW_BATTERY_SUCCEED_CONNECT'</code> |
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
#### SimulatedCardType
|
|
753
|
+
|
|
754
|
+
| Members | Value |
|
|
755
|
+
| ------------------------------------- | ------------------------------------------------- |
|
|
756
|
+
| **`Visa`** | <code>'VISA'</code> |
|
|
757
|
+
| **`VisaDebit`** | <code>'VISA_DEBIT'</code> |
|
|
758
|
+
| **`Mastercard`** | <code>'MASTERCARD'</code> |
|
|
759
|
+
| **`MastercardDebit`** | <code>'MASTERCARD_DEBIT'</code> |
|
|
760
|
+
| **`MastercardPrepaid`** | <code>'MASTERCARD_PREPAID'</code> |
|
|
761
|
+
| **`Amex`** | <code>'AMEX'</code> |
|
|
762
|
+
| **`Amex2`** | <code>'AMEX_2'</code> |
|
|
763
|
+
| **`Discover`** | <code>'DISCOVER'</code> |
|
|
764
|
+
| **`Discover2`** | <code>'DISCOVER_2'</code> |
|
|
765
|
+
| **`DinersClub`** | <code>'DINERS'</code> |
|
|
766
|
+
| **`DinersClulb14Digits`** | <code>'DINERS_14_DIGITS'</code> |
|
|
767
|
+
| **`JCB`** | <code>'JCB'</code> |
|
|
768
|
+
| **`UnionPay`** | <code>'UNION_PAY'</code> |
|
|
769
|
+
| **`Interac`** | <code>'INTERAC'</code> |
|
|
770
|
+
| **`EftposAustraliaDebit`** | <code>'EFTPOS_AU_DEBIT'</code> |
|
|
771
|
+
| **`VisaUsCommonDebit`** | <code>'VISA_US_COMMON_DEBIT'</code> |
|
|
772
|
+
| **`ChargeDeclined`** | <code>'CHARGE_DECLINED'</code> |
|
|
773
|
+
| **`ChargeDeclinedInsufficientFunds`** | <code>'CHARGE_DECLINED_INSUFFICIENT_FUNDS'</code> |
|
|
774
|
+
| **`ChargeDeclinedLostCard`** | <code>'CHARGE_DECLINED_LOST_CARD'</code> |
|
|
775
|
+
| **`ChargeDeclinedStolenCard`** | <code>'CHARGE_DECLINED_STOLEN_CARD'</code> |
|
|
776
|
+
| **`ChargeDeclinedExpiredCard`** | <code>'CHARGE_DECLINED_EXPIRED_CARD'</code> |
|
|
777
|
+
| **`ChargeDeclinedProcessingError`** | <code>'CHARGE_DECLINED_PROCESSING_ERROR'</code> |
|
|
778
|
+
| **`EftposAustraliaVisaDebit`** | <code>'EFTPOS_AU_VISA_DEBIT'</code> |
|
|
779
|
+
| **`EftposAustraliaMastercardDebit`** | <code>'EFTPOS_AU_DEBIT_MASTERCARD'</code> |
|
|
780
|
+
| **`OfflinePinCVM`** | <code>'OFFLINE_PIN_CVM'</code> |
|
|
781
|
+
| **`OfflinePinSCARetry`** | <code>'OFFLINE_PIN_SCA_RETRY'</code> |
|
|
782
|
+
| **`OnlinePinCVM`** | <code>'ONLINE_PIN_CVM'</code> |
|
|
783
|
+
| **`OnlinePinSCARetry`** | <code>'ONLINE_PIN_SCA_RETRY'</code> |
|
|
784
|
+
|
|
785
|
+
|
|
417
786
|
#### TerminalEventsEnum
|
|
418
787
|
|
|
419
|
-
| Members
|
|
420
|
-
|
|
|
421
|
-
| **`Loaded`**
|
|
422
|
-
| **`DiscoveredReaders`**
|
|
423
|
-
| **`CancelDiscoveredReaders`**
|
|
424
|
-
| **`ConnectedReader`**
|
|
425
|
-
| **`DisconnectedReader`**
|
|
426
|
-
| **`
|
|
427
|
-
| **`
|
|
428
|
-
| **`
|
|
429
|
-
| **`
|
|
430
|
-
| **`
|
|
788
|
+
| Members | Value |
|
|
789
|
+
| ---------------------------------- | --------------------------------------------------- |
|
|
790
|
+
| **`Loaded`** | <code>'terminalLoaded'</code> |
|
|
791
|
+
| **`DiscoveredReaders`** | <code>'terminalDiscoveredReaders'</code> |
|
|
792
|
+
| **`CancelDiscoveredReaders`** | <code>'terminalCancelDiscoveredReaders'</code> |
|
|
793
|
+
| **`ConnectedReader`** | <code>'terminalConnectedReader'</code> |
|
|
794
|
+
| **`DisconnectedReader`** | <code>'terminalDisconnectedReader'</code> |
|
|
795
|
+
| **`ConnectionStatusChange`** | <code>'terminalConnectionStatusChange'</code> |
|
|
796
|
+
| **`UnexpectedReaderDisconnect`** | <code>'terminalUnexpectedReaderDisconnect'</code> |
|
|
797
|
+
| **`ConfirmedPaymentIntent`** | <code>'terminalConfirmedPaymentIntent'</code> |
|
|
798
|
+
| **`CollectedPaymentIntent`** | <code>'terminalCollectedPaymentIntent'</code> |
|
|
799
|
+
| **`Canceled`** | <code>'terminalCanceled'</code> |
|
|
800
|
+
| **`Failed`** | <code>'terminalFailed'</code> |
|
|
801
|
+
| **`RequestedConnectionToken`** | <code>'terminalRequestedConnectionToken'</code> |
|
|
802
|
+
| **`ReportAvailableUpdate`** | <code>'terminalReportAvailableUpdate'</code> |
|
|
803
|
+
| **`StartInstallingUpdate`** | <code>'terminalStartInstallingUpdate'</code> |
|
|
804
|
+
| **`ReaderSoftwareUpdateProgress`** | <code>'terminalReaderSoftwareUpdateProgress'</code> |
|
|
805
|
+
| **`FinishInstallingUpdate`** | <code>'terminalFinishInstallingUpdate'</code> |
|
|
806
|
+
| **`BatteryLevel`** | <code>'terminalBatteryLevel'</code> |
|
|
807
|
+
| **`ReaderEvent`** | <code>'terminalReaderEvent'</code> |
|
|
808
|
+
| **`RequestDisplayMessage`** | <code>'terminalRequestDisplayMessage'</code> |
|
|
809
|
+
| **`RequestReaderInput`** | <code>'terminalRequestReaderInput'</code> |
|
|
810
|
+
| **`PaymentStatusChange`** | <code>'terminalPaymentStatusChange'</code> |
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
#### DisconnectReason
|
|
814
|
+
|
|
815
|
+
| Members | Value |
|
|
816
|
+
| -------------------------- | ------------------------------------- |
|
|
817
|
+
| **`Unknown`** | <code>'UNKNOWN'</code> |
|
|
818
|
+
| **`DisconnectRequested`** | <code>'DISCONNECT_REQUESTED'</code> |
|
|
819
|
+
| **`RebootRequested`** | <code>'REBOOT_REQUESTED'</code> |
|
|
820
|
+
| **`SecurityReboot`** | <code>'SECURITY_REBOOT'</code> |
|
|
821
|
+
| **`CriticallyLowBattery`** | <code>'CRITICALLY_LOW_BATTERY'</code> |
|
|
822
|
+
| **`PoweredOff`** | <code>'POWERED_OFF'</code> |
|
|
823
|
+
| **`BluetoothDisabled`** | <code>'BLUETOOTH_DISABLED'</code> |
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
#### ConnectionStatus
|
|
827
|
+
|
|
828
|
+
| Members | Value |
|
|
829
|
+
| ------------------ | ---------------------------- |
|
|
830
|
+
| **`Unknown`** | <code>'UNKNOWN'</code> |
|
|
831
|
+
| **`NotConnected`** | <code>'NOT_CONNECTED'</code> |
|
|
832
|
+
| **`Connecting`** | <code>'CONNECTING'</code> |
|
|
833
|
+
| **`Connected`** | <code>'CONNECTED'</code> |
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
#### UpdateTimeEstimate
|
|
837
|
+
|
|
838
|
+
| Members | Value |
|
|
839
|
+
| -------------------------- | -------------------------------------- |
|
|
840
|
+
| **`LessThanOneMinute`** | <code>'LESS_THAN_ONE_MINUTE'</code> |
|
|
841
|
+
| **`OneToTwoMinutes`** | <code>'ONE_TO_TWO_MINUTES'</code> |
|
|
842
|
+
| **`TwoToFiveMinutes`** | <code>'TWO_TO_FIVE_MINUTES'</code> |
|
|
843
|
+
| **`FiveToFifteenMinutes`** | <code>'FIVE_TO_FIFTEEN_MINUTES'</code> |
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
#### BatteryStatus
|
|
847
|
+
|
|
848
|
+
| Members | Value |
|
|
849
|
+
| -------------- | ----------------------- |
|
|
850
|
+
| **`Unknown`** | <code>'UNKNOWN'</code> |
|
|
851
|
+
| **`Critical`** | <code>'CRITICAL'</code> |
|
|
852
|
+
| **`Low`** | <code>'LOW'</code> |
|
|
853
|
+
| **`Nominal`** | <code>'NOMINAL'</code> |
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
#### ReaderEvent
|
|
857
|
+
|
|
858
|
+
| Members | Value |
|
|
859
|
+
| ------------------ | ---------------------------- |
|
|
860
|
+
| **`Unknown`** | <code>'UNKNOWN'</code> |
|
|
861
|
+
| **`CardInserted`** | <code>'CARD_INSERTED'</code> |
|
|
862
|
+
| **`CardRemoved`** | <code>'CARD_REMOVED'</code> |
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
#### ReaderDisplayMessage
|
|
866
|
+
|
|
867
|
+
| Members | Value |
|
|
868
|
+
| -------------------------------------- | -------------------------------------------------- |
|
|
869
|
+
| **`CheckMobileDevice`** | <code>'CHECK_MOBILE_DEVICE'</code> |
|
|
870
|
+
| **`RetryCard`** | <code>'RETRY_CARD'</code> |
|
|
871
|
+
| **`InsertCard`** | <code>'INSERT_CARD'</code> |
|
|
872
|
+
| **`InsertOrSwipeCard`** | <code>'INSERT_OR_SWIPE_CARD'</code> |
|
|
873
|
+
| **`SwipeCard`** | <code>'SWIPE_CARD'</code> |
|
|
874
|
+
| **`RemoveCard`** | <code>'REMOVE_CARD'</code> |
|
|
875
|
+
| **`MultipleContactlessCardsDetected`** | <code>'MULTIPLE_CONTACTLESS_CARDS_DETECTED'</code> |
|
|
876
|
+
| **`TryAnotherReadMethod`** | <code>'TRY_ANOTHER_READ_METHOD'</code> |
|
|
877
|
+
| **`TryAnotherCard`** | <code>'TRY_ANOTHER_CARD'</code> |
|
|
878
|
+
| **`CardRemovedTooEarly`** | <code>'CARD_REMOVED_TOO_EARLY'</code> |
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
#### ReaderInputOption
|
|
882
|
+
|
|
883
|
+
| Members | Value |
|
|
884
|
+
| ----------------- | --------------------------- |
|
|
885
|
+
| **`None`** | <code>'NONE'</code> |
|
|
886
|
+
| **`Insert`** | <code>'INSERT'</code> |
|
|
887
|
+
| **`Swipe`** | <code>'SWIPE'</code> |
|
|
888
|
+
| **`Tap`** | <code>'TAP'</code> |
|
|
889
|
+
| **`ManualEntry`** | <code>'MANUAL_ENTRY'</code> |
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
#### PaymentStatus
|
|
893
|
+
|
|
894
|
+
| Members | Value |
|
|
895
|
+
| --------------------- | -------------------------------- |
|
|
896
|
+
| **`Unknown`** | <code>'UNKNOWN'</code> |
|
|
897
|
+
| **`NotReady`** | <code>'NOT_READY'</code> |
|
|
898
|
+
| **`Ready`** | <code>'READY'</code> |
|
|
899
|
+
| **`WaitingForInput`** | <code>'WAITING_FOR_INPUT'</code> |
|
|
900
|
+
| **`Processing`** | <code>'PROCESSING'</code> |
|
|
431
901
|
|
|
432
902
|
</docgen-api>
|
package/android/build.gradle
CHANGED
|
@@ -7,7 +7,7 @@ ext {
|
|
|
7
7
|
playServicesWalletVersion = project.hasProperty('playServicesWalletVersion') ? rootProject.ext.playServicesWalletVersion : '19.2.+'
|
|
8
8
|
volleyVersion = project.hasProperty('volleyVersion') ? rootProject.ext.volleyVersion : '1.2.1'
|
|
9
9
|
stripeterminalLocalmobileVersion = project.hasProperty('stripeterminalLocalmobileVersion') ? rootProject.ext.stripeterminalLocalmobileVersion : '3.5.+'
|
|
10
|
-
stripeterminalCoreVersion = project.hasProperty('stripeterminalCoreVersion') ? rootProject.ext.stripeterminalCoreVersion : '3.
|
|
10
|
+
stripeterminalCoreVersion = project.hasProperty('stripeterminalCoreVersion') ? rootProject.ext.stripeterminalCoreVersion : '3.8.+'
|
|
11
11
|
}
|
|
12
12
|
|
|
13
13
|
buildscript {
|