@capacitor-community/stripe-terminal 6.0.2 → 6.2.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.
Files changed (36) hide show
  1. package/CapacitorCommunityStripeTerminal.podspec +1 -1
  2. package/README.md +767 -28
  3. package/android/build.gradle +1 -1
  4. package/android/src/main/java/com/getcapacitor/community/stripe/terminal/StripeTerminal.java +372 -51
  5. package/android/src/main/java/com/getcapacitor/community/stripe/terminal/StripeTerminalPlugin.java +61 -5
  6. package/android/src/main/java/com/getcapacitor/community/stripe/terminal/TerminalEvent.kt +14 -0
  7. package/android/src/main/java/com/getcapacitor/community/stripe/terminal/helper/TerminalMappers.java +96 -0
  8. package/dist/docs.json +1389 -111
  9. package/dist/esm/definitions.d.ts +263 -11
  10. package/dist/esm/definitions.js +1 -8
  11. package/dist/esm/definitions.js.map +1 -1
  12. package/dist/esm/events.enum.d.ts +15 -1
  13. package/dist/esm/events.enum.js +14 -0
  14. package/dist/esm/events.enum.js.map +1 -1
  15. package/dist/esm/stripe-types/proto.d.ts +501 -0
  16. package/dist/esm/stripe-types/proto.js +2 -0
  17. package/dist/esm/stripe-types/proto.js.map +1 -0
  18. package/dist/esm/stripe.enum.d.ts +154 -0
  19. package/dist/esm/stripe.enum.js +170 -0
  20. package/dist/esm/stripe.enum.js.map +1 -0
  21. package/dist/esm/terminalMappers.d.ts +23 -0
  22. package/dist/esm/terminalMappers.js +119 -0
  23. package/dist/esm/terminalMappers.js.map +1 -0
  24. package/dist/esm/web.d.ts +25 -2
  25. package/dist/esm/web.js +137 -13
  26. package/dist/esm/web.js.map +1 -1
  27. package/dist/plugin.cjs.js +428 -13
  28. package/dist/plugin.cjs.js.map +1 -1
  29. package/dist/plugin.js +429 -15
  30. package/dist/plugin.js.map +1 -1
  31. package/ios/Plugin/StripeTerminal.swift +345 -61
  32. package/ios/Plugin/StripeTerminalPlugin.m +7 -0
  33. package/ios/Plugin/StripeTerminalPlugin.swift +29 -4
  34. package/ios/Plugin/TerminalEvents.swift +14 -0
  35. package/ios/Plugin/TerminalMappers.swift +269 -0
  36. package/package.json +4 -1
package/dist/docs.json CHANGED
@@ -57,17 +57,41 @@
57
57
  "slug": "setconnectiontoken"
58
58
  },
59
59
  {
60
- "name": "connectReader",
61
- "signature": "(options: { reader: ReaderInterface; }) => Promise<void>",
60
+ "name": "setSimulatorConfiguration",
61
+ "signature": "(options: { update?: SimulateReaderUpdate; simulatedCard?: SimulatedCardType; simulatedTipAmount?: number; }) => Promise<void>",
62
62
  "parameters": [
63
63
  {
64
64
  "name": "options",
65
65
  "docs": "",
66
- "type": "{ reader: ReaderInterface; }"
66
+ "type": "{ update?: SimulateReaderUpdate | undefined; simulatedCard?: SimulatedCardType | undefined; simulatedTipAmount?: number | undefined; }"
67
67
  }
68
68
  ],
69
69
  "returns": "Promise<void>",
70
70
  "tags": [],
71
+ "docs": "[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.models/-simulator-configuration/index.html)",
72
+ "complexTypes": [
73
+ "SimulateReaderUpdate",
74
+ "SimulatedCardType"
75
+ ],
76
+ "slug": "setsimulatorconfiguration"
77
+ },
78
+ {
79
+ "name": "connectReader",
80
+ "signature": "(options: { reader: ReaderInterface; autoReconnectOnUnexpectedDisconnect?: boolean; merchantDisplayName?: string; onBehalfOf?: string; }) => Promise<void>",
81
+ "parameters": [
82
+ {
83
+ "name": "options",
84
+ "docs": "",
85
+ "type": "{ reader: ReaderInterface; autoReconnectOnUnexpectedDisconnect?: boolean | undefined; merchantDisplayName?: string | undefined; onBehalfOf?: string | undefined; }"
86
+ }
87
+ ],
88
+ "returns": "Promise<void>",
89
+ "tags": [
90
+ {
91
+ "name": "param",
92
+ "text": "options.autoReconnectOnUnexpectedDisconnect If true, the SDK will automatically attempt to reconnect to the reader. default is false."
93
+ }
94
+ ],
71
95
  "docs": "",
72
96
  "complexTypes": [
73
97
  "ReaderInterface"
@@ -142,6 +166,74 @@
142
166
  "complexTypes": [],
143
167
  "slug": "confirmpaymentintent"
144
168
  },
169
+ {
170
+ "name": "installAvailableUpdate",
171
+ "signature": "() => Promise<void>",
172
+ "parameters": [],
173
+ "returns": "Promise<void>",
174
+ "tags": [],
175
+ "docs": "",
176
+ "complexTypes": [],
177
+ "slug": "installavailableupdate"
178
+ },
179
+ {
180
+ "name": "cancelInstallUpdate",
181
+ "signature": "() => Promise<void>",
182
+ "parameters": [],
183
+ "returns": "Promise<void>",
184
+ "tags": [],
185
+ "docs": "",
186
+ "complexTypes": [],
187
+ "slug": "cancelinstallupdate"
188
+ },
189
+ {
190
+ "name": "setReaderDisplay",
191
+ "signature": "(options: Cart) => Promise<void>",
192
+ "parameters": [
193
+ {
194
+ "name": "options",
195
+ "docs": "",
196
+ "type": "Cart"
197
+ }
198
+ ],
199
+ "returns": "Promise<void>",
200
+ "tags": [],
201
+ "docs": "",
202
+ "complexTypes": [
203
+ "Cart"
204
+ ],
205
+ "slug": "setreaderdisplay"
206
+ },
207
+ {
208
+ "name": "clearReaderDisplay",
209
+ "signature": "() => Promise<void>",
210
+ "parameters": [],
211
+ "returns": "Promise<void>",
212
+ "tags": [],
213
+ "docs": "",
214
+ "complexTypes": [],
215
+ "slug": "clearreaderdisplay"
216
+ },
217
+ {
218
+ "name": "rebootReader",
219
+ "signature": "() => Promise<void>",
220
+ "parameters": [],
221
+ "returns": "Promise<void>",
222
+ "tags": [],
223
+ "docs": "",
224
+ "complexTypes": [],
225
+ "slug": "rebootreader"
226
+ },
227
+ {
228
+ "name": "cancelReaderReconnection",
229
+ "signature": "() => Promise<void>",
230
+ "parameters": [],
231
+ "returns": "Promise<void>",
232
+ "tags": [],
233
+ "docs": "",
234
+ "complexTypes": [],
235
+ "slug": "cancelreaderreconnection"
236
+ },
145
237
  {
146
238
  "name": "addListener",
147
239
  "signature": "(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>",
@@ -192,7 +284,7 @@
192
284
  },
193
285
  {
194
286
  "name": "addListener",
195
- "signature": "(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: () => { reader: ReaderInterface; }) => Promise<PluginListenerHandle>",
287
+ "signature": "(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>",
196
288
  "parameters": [
197
289
  {
198
290
  "name": "eventName",
@@ -202,7 +294,7 @@
202
294
  {
203
295
  "name": "listenerFunc",
204
296
  "docs": "",
205
- "type": "() => { reader: ReaderInterface; }"
297
+ "type": "({ readers }: { readers: ReaderInterface[]; }) => void"
206
298
  }
207
299
  ],
208
300
  "returns": "Promise<PluginListenerHandle>",
@@ -239,6 +331,81 @@
239
331
  ],
240
332
  "slug": "addlistenerterminaleventsenumconnectedreader"
241
333
  },
334
+ {
335
+ "name": "addListener",
336
+ "signature": "(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>",
337
+ "parameters": [
338
+ {
339
+ "name": "eventName",
340
+ "docs": "",
341
+ "type": "TerminalEventsEnum.DisconnectedReader"
342
+ },
343
+ {
344
+ "name": "listenerFunc",
345
+ "docs": "",
346
+ "type": "({ reason }: { reason?: DisconnectReason | undefined; }) => void"
347
+ }
348
+ ],
349
+ "returns": "Promise<PluginListenerHandle>",
350
+ "tags": [],
351
+ "docs": "Emitted when the reader is disconnected, either in response to [`disconnectReader()`](#disconnectreader)\nor some connection error.\n\nFor all reader types, this is emitted in response to [`disconnectReader()`](#disconnectreader)\nwithout a `reason` property.\n\nFor 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\nwill be emitted twice: one without a `reason` in acknowledgement of your call, and again with a `reason` when the reader\nfinishes disconnecting.",
352
+ "complexTypes": [
353
+ "PluginListenerHandle",
354
+ "TerminalEventsEnum",
355
+ "DisconnectReason"
356
+ ],
357
+ "slug": "addlistenerterminaleventsenumdisconnectedreader"
358
+ },
359
+ {
360
+ "name": "addListener",
361
+ "signature": "(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>",
362
+ "parameters": [
363
+ {
364
+ "name": "eventName",
365
+ "docs": "",
366
+ "type": "TerminalEventsEnum.ConnectionStatusChange"
367
+ },
368
+ {
369
+ "name": "listenerFunc",
370
+ "docs": "",
371
+ "type": "({ status }: { status: ConnectionStatus; }) => void"
372
+ }
373
+ ],
374
+ "returns": "Promise<PluginListenerHandle>",
375
+ "tags": [],
376
+ "docs": "Emitted when the Terminal's connection status changed.\n\nNote: You should *not* use this method to detect when a reader unexpectedly disconnects from your app,\nas it cannot be used to accurately distinguish between expected and unexpected disconnect events.\n\nTo detect unexpected disconnects (e.g. to automatically notify your user), you should instead use\nthe 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)",
377
+ "complexTypes": [
378
+ "PluginListenerHandle",
379
+ "TerminalEventsEnum",
380
+ "ConnectionStatus"
381
+ ],
382
+ "slug": "addlistenerterminaleventsenumconnectionstatuschange"
383
+ },
384
+ {
385
+ "name": "addListener",
386
+ "signature": "(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
387
+ "parameters": [
388
+ {
389
+ "name": "eventName",
390
+ "docs": "",
391
+ "type": "TerminalEventsEnum.UnexpectedReaderDisconnect"
392
+ },
393
+ {
394
+ "name": "listenerFunc",
395
+ "docs": "",
396
+ "type": "({ reader }: { reader: ReaderInterface; }) => void"
397
+ }
398
+ ],
399
+ "returns": "Promise<PluginListenerHandle>",
400
+ "tags": [],
401
+ "docs": "The Terminal disconnected unexpectedly from the reader.\n\nIn your implementation of this method, you may want to notify your user that the reader disconnected.\nYou may also call [`discoverReaders()`](#discoverreaders) to begin scanning for readers, and attempt\nto automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it\npossible to cancel calls to `discoverReaders()`\n\nWhen connected to a Bluetooth or USB reader, you can get more information about the disconnect by\nimplementing 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)",
402
+ "complexTypes": [
403
+ "PluginListenerHandle",
404
+ "TerminalEventsEnum",
405
+ "ReaderInterface"
406
+ ],
407
+ "slug": "addlistenerterminaleventsenumunexpectedreaderdisconnect"
408
+ },
242
409
  {
243
410
  "name": "addListener",
244
411
  "signature": "(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>",
@@ -304,7 +471,7 @@
304
471
  ],
305
472
  "returns": "Promise<PluginListenerHandle>",
306
473
  "tags": [],
307
- "docs": "",
474
+ "docs": "Emitted when [`cancelCollectPaymentMethod()`](#cancelcollectpaymentmethod) is called and succeeds.\nThe Promise returned by `cancelCollectPaymentMethod()` will also be resolved.",
308
475
  "complexTypes": [
309
476
  "PluginListenerHandle",
310
477
  "TerminalEventsEnum"
@@ -328,130 +495,861 @@
328
495
  ],
329
496
  "returns": "Promise<PluginListenerHandle>",
330
497
  "tags": [],
331
- "docs": "",
498
+ "docs": "Emitted when either [`collectPaymentMethod()`](#collectpaymentmethod) or [`confirmPaymentIntent()`](#confirmpaymentintent)\nfails. The Promise returned by the relevant call will also be rejected.",
332
499
  "complexTypes": [
333
500
  "PluginListenerHandle",
334
501
  "TerminalEventsEnum"
335
502
  ],
336
503
  "slug": "addlistenerterminaleventsenumfailed"
337
- }
338
- ],
339
- "properties": [
504
+ },
340
505
  {
341
- "name": "collect",
342
- "tags": [
506
+ "name": "addListener",
507
+ "signature": "(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>",
508
+ "parameters": [
343
509
  {
344
- "text": "This method has been deprecated and replaced by the `collectPaymentMethod`.\nSimilarly, note that TerminalEvents.Completed is now obsolete.\nAnd, method `confirmPaymentIntent` added to be executed after `collectPaymentMethod` is executed.\n\nThis is left as type string to avoid accidental use.",
345
- "name": "deprecated"
510
+ "name": "eventName",
511
+ "docs": "",
512
+ "type": "TerminalEventsEnum.ReportAvailableUpdate"
513
+ },
514
+ {
515
+ "name": "listenerFunc",
516
+ "docs": "",
517
+ "type": "({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void"
346
518
  }
347
519
  ],
348
- "docs": "",
349
- "complexTypes": [],
350
- "type": "string"
520
+ "returns": "Promise<PluginListenerHandle>",
521
+ "tags": [],
522
+ "docs": "Emitted when a software update is available for the connected reader.",
523
+ "complexTypes": [
524
+ "PluginListenerHandle",
525
+ "TerminalEventsEnum",
526
+ "ReaderSoftwareUpdateInterface"
527
+ ],
528
+ "slug": "addlistenerterminaleventsenumreportavailableupdate"
351
529
  },
352
530
  {
353
- "name": "cancelCollect",
354
- "tags": [
531
+ "name": "addListener",
532
+ "signature": "(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>",
533
+ "parameters": [
355
534
  {
356
- "text": "This method has been deprecated and replaced by the `cancelCollectPaymentMethod`.\n\nThis is left as type string to avoid accidental use.",
357
- "name": "deprecated"
535
+ "name": "eventName",
536
+ "docs": "",
537
+ "type": "TerminalEventsEnum.StartInstallingUpdate"
538
+ },
539
+ {
540
+ "name": "listenerFunc",
541
+ "docs": "",
542
+ "type": "({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void"
358
543
  }
359
544
  ],
360
- "docs": "",
361
- "complexTypes": [],
362
- "type": "string"
363
- }
364
- ]
365
- },
366
- "interfaces": [
367
- {
368
- "name": "PluginListenerHandle",
369
- "slug": "pluginlistenerhandle",
370
- "docs": "",
371
- "tags": [],
372
- "methods": [],
373
- "properties": [
374
- {
375
- "name": "remove",
376
- "tags": [],
377
- "docs": "",
378
- "complexTypes": [],
379
- "type": "() => Promise<void>"
380
- }
381
- ]
382
- }
383
- ],
384
- "enums": [
385
- {
386
- "name": "TerminalConnectTypes",
387
- "slug": "terminalconnecttypes",
388
- "members": [
389
- {
390
- "name": "Simulated",
391
- "value": "'simulated'",
392
- "tags": [],
393
- "docs": ""
394
- },
395
- {
396
- "name": "Internet",
397
- "value": "'internet'",
398
- "tags": [],
399
- "docs": ""
400
- },
401
- {
402
- "name": "Bluetooth",
403
- "value": "'bluetooth'",
404
- "tags": [],
405
- "docs": ""
406
- },
407
- {
408
- "name": "Usb",
409
- "value": "'usb'",
410
- "tags": [],
411
- "docs": ""
412
- },
413
- {
414
- "name": "TapToPay",
415
- "value": "'tap-to-pay'",
416
- "tags": [],
417
- "docs": ""
418
- }
419
- ]
420
- },
421
- {
422
- "name": "TerminalEventsEnum",
423
- "slug": "terminaleventsenum",
424
- "members": [
425
- {
426
- "name": "Loaded",
427
- "value": "'terminalLoaded'",
428
- "tags": [],
429
- "docs": ""
430
- },
431
- {
432
- "name": "DiscoveredReaders",
433
- "value": "'terminalDiscoveredReaders'",
434
- "tags": [],
435
- "docs": ""
436
- },
437
- {
438
- "name": "CancelDiscoveredReaders",
439
- "value": "'terminalCancelDiscoveredReaders'",
440
- "tags": [],
441
- "docs": ""
442
- },
443
- {
444
- "name": "ConnectedReader",
445
- "value": "'terminalConnectedReader'",
446
- "tags": [],
447
- "docs": ""
448
- },
545
+ "returns": "Promise<PluginListenerHandle>",
546
+ "tags": [],
547
+ "docs": "**Only applicable to Bluetooth and USB readers.**\n\nEmitted when the connected reader begins installing a software update.\nIf a mandatory software update is available when a reader first connects, that update is\nautomatically installed. The update will be installed before ConnectedReader is emitted and\nbefore the Promise returned by [`connectReader()`](#connectreader) resolves.\nIn this case, you will receive this sequence of events:\n\n1. StartInstallingUpdate\n2. ReaderSoftwareUpdateProgress (repeatedly)\n3. FinishInstallingUpdates\n4. ConnectedReader\n5. `connectReader()` Promise resolves\n\nYour app should show UI to the user indiciating that a software update is being installed\nto 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)",
548
+ "complexTypes": [
549
+ "PluginListenerHandle",
550
+ "TerminalEventsEnum",
551
+ "ReaderSoftwareUpdateInterface"
552
+ ],
553
+ "slug": "addlistenerterminaleventsenumstartinstallingupdate"
554
+ },
555
+ {
556
+ "name": "addListener",
557
+ "signature": "(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>",
558
+ "parameters": [
559
+ {
560
+ "name": "eventName",
561
+ "docs": "",
562
+ "type": "TerminalEventsEnum.ReaderSoftwareUpdateProgress"
563
+ },
564
+ {
565
+ "name": "listenerFunc",
566
+ "docs": "",
567
+ "type": "({ progress }: { progress: number; }) => void"
568
+ }
569
+ ],
570
+ "returns": "Promise<PluginListenerHandle>",
571
+ "tags": [],
572
+ "docs": "**Only applicable to Bluetooth and USB readers.**\n\nEmitted 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)",
573
+ "complexTypes": [
574
+ "PluginListenerHandle",
575
+ "TerminalEventsEnum"
576
+ ],
577
+ "slug": "addlistenerterminaleventsenumreadersoftwareupdateprogress"
578
+ },
579
+ {
580
+ "name": "addListener",
581
+ "signature": "(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>",
582
+ "parameters": [
583
+ {
584
+ "name": "eventName",
585
+ "docs": "",
586
+ "type": "TerminalEventsEnum.FinishInstallingUpdate"
587
+ },
588
+ {
589
+ "name": "listenerFunc",
590
+ "docs": "",
591
+ "type": "(args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void"
592
+ }
593
+ ],
594
+ "returns": "Promise<PluginListenerHandle>",
595
+ "tags": [],
596
+ "docs": "**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)",
597
+ "complexTypes": [
598
+ "PluginListenerHandle",
599
+ "TerminalEventsEnum",
600
+ "ReaderSoftwareUpdateInterface"
601
+ ],
602
+ "slug": "addlistenerterminaleventsenumfinishinstallingupdate"
603
+ },
604
+ {
605
+ "name": "addListener",
606
+ "signature": "(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status, }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>",
607
+ "parameters": [
608
+ {
609
+ "name": "eventName",
610
+ "docs": "",
611
+ "type": "TerminalEventsEnum.BatteryLevel"
612
+ },
613
+ {
614
+ "name": "listenerFunc",
615
+ "docs": "",
616
+ "type": "({ level, charging, status, }: { level: number; charging: boolean; status: BatteryStatus; }) => void"
617
+ }
618
+ ],
619
+ "returns": "Promise<PluginListenerHandle>",
620
+ "tags": [],
621
+ "docs": "**Only applicable to Bluetooth and USB readers.**\n\nEmitted 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)",
622
+ "complexTypes": [
623
+ "PluginListenerHandle",
624
+ "TerminalEventsEnum",
625
+ "BatteryStatus"
626
+ ],
627
+ "slug": "addlistenerterminaleventsenumbatterylevel"
628
+ },
629
+ {
630
+ "name": "addListener",
631
+ "signature": "(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>",
632
+ "parameters": [
633
+ {
634
+ "name": "eventName",
635
+ "docs": "",
636
+ "type": "TerminalEventsEnum.ReaderEvent"
637
+ },
638
+ {
639
+ "name": "listenerFunc",
640
+ "docs": "",
641
+ "type": "({ event }: { event: ReaderEvent; }) => void"
642
+ }
643
+ ],
644
+ "returns": "Promise<PluginListenerHandle>",
645
+ "tags": [],
646
+ "docs": "**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)",
647
+ "complexTypes": [
648
+ "PluginListenerHandle",
649
+ "TerminalEventsEnum",
650
+ "ReaderEvent"
651
+ ],
652
+ "slug": "addlistenerterminaleventsenumreaderevent"
653
+ },
654
+ {
655
+ "name": "addListener",
656
+ "signature": "(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message, }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>",
657
+ "parameters": [
658
+ {
659
+ "name": "eventName",
660
+ "docs": "",
661
+ "type": "TerminalEventsEnum.RequestDisplayMessage"
662
+ },
663
+ {
664
+ "name": "listenerFunc",
665
+ "docs": "",
666
+ "type": "({ messageType, message, }: { messageType: ReaderDisplayMessage; message: string; }) => void"
667
+ }
668
+ ],
669
+ "returns": "Promise<PluginListenerHandle>",
670
+ "tags": [],
671
+ "docs": "**Only applicable to Bluetooth and USB readers.**\n\nEmitted 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)",
672
+ "complexTypes": [
673
+ "PluginListenerHandle",
674
+ "TerminalEventsEnum",
675
+ "ReaderDisplayMessage"
676
+ ],
677
+ "slug": "addlistenerterminaleventsenumrequestdisplaymessage"
678
+ },
679
+ {
680
+ "name": "addListener",
681
+ "signature": "(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>",
682
+ "parameters": [
683
+ {
684
+ "name": "eventName",
685
+ "docs": "",
686
+ "type": "TerminalEventsEnum.RequestReaderInput"
687
+ },
688
+ {
689
+ "name": "listenerFunc",
690
+ "docs": "",
691
+ "type": "({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void"
692
+ }
693
+ ],
694
+ "returns": "Promise<PluginListenerHandle>",
695
+ "tags": [],
696
+ "docs": "**Only applicable to Bluetooth and USB readers.**\n\nEmitted when the reader begins waiting for input. Your app should prompt the customer\nto present a source using one of the given input options. If the reader emits a message,\nthe 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)",
697
+ "complexTypes": [
698
+ "PluginListenerHandle",
699
+ "TerminalEventsEnum",
700
+ "ReaderInputOption"
701
+ ],
702
+ "slug": "addlistenerterminaleventsenumrequestreaderinput"
703
+ },
704
+ {
705
+ "name": "addListener",
706
+ "signature": "(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>",
707
+ "parameters": [
708
+ {
709
+ "name": "eventName",
710
+ "docs": "",
711
+ "type": "TerminalEventsEnum.PaymentStatusChange"
712
+ },
713
+ {
714
+ "name": "listenerFunc",
715
+ "docs": "",
716
+ "type": "({ status }: { status: PaymentStatus; }) => void"
717
+ }
718
+ ],
719
+ "returns": "Promise<PluginListenerHandle>",
720
+ "tags": [],
721
+ "docs": "[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-payment-status-change.html)",
722
+ "complexTypes": [
723
+ "PluginListenerHandle",
724
+ "TerminalEventsEnum",
725
+ "PaymentStatus"
726
+ ],
727
+ "slug": "addlistenerterminaleventsenumpaymentstatuschange"
728
+ },
729
+ {
730
+ "name": "addListener",
731
+ "signature": "(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason, }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>",
732
+ "parameters": [
733
+ {
734
+ "name": "eventName",
735
+ "docs": "",
736
+ "type": "TerminalEventsEnum.ReaderReconnectStarted"
737
+ },
738
+ {
739
+ "name": "listenerFunc",
740
+ "docs": "",
741
+ "type": "({ reader, reason, }: { reader: ReaderInterface; reason: string; }) => void"
742
+ }
743
+ ],
744
+ "returns": "Promise<PluginListenerHandle>",
745
+ "tags": [],
746
+ "docs": "",
747
+ "complexTypes": [
748
+ "PluginListenerHandle",
749
+ "TerminalEventsEnum",
750
+ "ReaderInterface"
751
+ ],
752
+ "slug": "addlistenerterminaleventsenumreaderreconnectstarted"
753
+ },
754
+ {
755
+ "name": "addListener",
756
+ "signature": "(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
757
+ "parameters": [
758
+ {
759
+ "name": "eventName",
760
+ "docs": "",
761
+ "type": "TerminalEventsEnum.ReaderReconnectSucceeded"
762
+ },
763
+ {
764
+ "name": "listenerFunc",
765
+ "docs": "",
766
+ "type": "({ reader }: { reader: ReaderInterface; }) => void"
767
+ }
768
+ ],
769
+ "returns": "Promise<PluginListenerHandle>",
770
+ "tags": [],
771
+ "docs": "",
772
+ "complexTypes": [
773
+ "PluginListenerHandle",
774
+ "TerminalEventsEnum",
775
+ "ReaderInterface"
776
+ ],
777
+ "slug": "addlistenerterminaleventsenumreaderreconnectsucceeded"
778
+ },
779
+ {
780
+ "name": "addListener",
781
+ "signature": "(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
782
+ "parameters": [
783
+ {
784
+ "name": "eventName",
785
+ "docs": "",
786
+ "type": "TerminalEventsEnum.ReaderReconnectFailed"
787
+ },
788
+ {
789
+ "name": "listenerFunc",
790
+ "docs": "",
791
+ "type": "({ reader }: { reader: ReaderInterface; }) => void"
792
+ }
793
+ ],
794
+ "returns": "Promise<PluginListenerHandle>",
795
+ "tags": [],
796
+ "docs": "",
797
+ "complexTypes": [
798
+ "PluginListenerHandle",
799
+ "TerminalEventsEnum",
800
+ "ReaderInterface"
801
+ ],
802
+ "slug": "addlistenerterminaleventsenumreaderreconnectfailed"
803
+ }
804
+ ],
805
+ "properties": [
806
+ {
807
+ "name": "collect",
808
+ "tags": [
809
+ {
810
+ "text": "This method has been deprecated and replaced by the `collectPaymentMethod`.\nSimilarly, note that TerminalEvents.Completed is now obsolete.\nAnd, method `confirmPaymentIntent` added to be executed after `collectPaymentMethod` is executed.\n\nThis is left as type string to avoid accidental use.",
811
+ "name": "deprecated"
812
+ }
813
+ ],
814
+ "docs": "",
815
+ "complexTypes": [],
816
+ "type": "string"
817
+ },
818
+ {
819
+ "name": "cancelCollect",
820
+ "tags": [
821
+ {
822
+ "text": "This method has been deprecated and replaced by the `cancelCollectPaymentMethod`.\n\nThis is left as type string to avoid accidental use.",
823
+ "name": "deprecated"
824
+ }
825
+ ],
826
+ "docs": "",
827
+ "complexTypes": [],
828
+ "type": "string"
829
+ }
830
+ ]
831
+ },
832
+ "interfaces": [
833
+ {
834
+ "name": "PluginListenerHandle",
835
+ "slug": "pluginlistenerhandle",
836
+ "docs": "",
837
+ "tags": [],
838
+ "methods": [],
839
+ "properties": [
840
+ {
841
+ "name": "remove",
842
+ "tags": [],
843
+ "docs": "",
844
+ "complexTypes": [],
845
+ "type": "() => Promise<void>"
846
+ }
847
+ ]
848
+ }
849
+ ],
850
+ "enums": [
851
+ {
852
+ "name": "BatteryStatus",
853
+ "slug": "batterystatus",
854
+ "members": [
855
+ {
856
+ "name": "Unknown",
857
+ "value": "'UNKNOWN'",
858
+ "tags": [],
859
+ "docs": ""
860
+ },
861
+ {
862
+ "name": "Critical",
863
+ "value": "'CRITICAL'",
864
+ "tags": [],
865
+ "docs": ""
866
+ },
867
+ {
868
+ "name": "Low",
869
+ "value": "'LOW'",
870
+ "tags": [],
871
+ "docs": ""
872
+ },
873
+ {
874
+ "name": "Nominal",
875
+ "value": "'NOMINAL'",
876
+ "tags": [],
877
+ "docs": ""
878
+ }
879
+ ]
880
+ },
881
+ {
882
+ "name": "UpdateTimeEstimate",
883
+ "slug": "updatetimeestimate",
884
+ "members": [
885
+ {
886
+ "name": "LessThanOneMinute",
887
+ "value": "'LESS_THAN_ONE_MINUTE'",
888
+ "tags": [],
889
+ "docs": ""
890
+ },
891
+ {
892
+ "name": "OneToTwoMinutes",
893
+ "value": "'ONE_TO_TWO_MINUTES'",
894
+ "tags": [],
895
+ "docs": ""
896
+ },
897
+ {
898
+ "name": "TwoToFiveMinutes",
899
+ "value": "'TWO_TO_FIVE_MINUTES'",
900
+ "tags": [],
901
+ "docs": ""
902
+ },
903
+ {
904
+ "name": "FiveToFifteenMinutes",
905
+ "value": "'FIVE_TO_FIFTEEN_MINUTES'",
906
+ "tags": [],
907
+ "docs": ""
908
+ }
909
+ ]
910
+ },
911
+ {
912
+ "name": "NetworkStatus",
913
+ "slug": "networkstatus",
914
+ "members": [
915
+ {
916
+ "name": "Unknown",
917
+ "value": "'UNKNOWN'",
918
+ "tags": [],
919
+ "docs": ""
920
+ },
921
+ {
922
+ "name": "Online",
923
+ "value": "'ONLINE'",
924
+ "tags": [],
925
+ "docs": ""
926
+ },
927
+ {
928
+ "name": "Offline",
929
+ "value": "'OFFLINE'",
930
+ "tags": [],
931
+ "docs": ""
932
+ }
933
+ ]
934
+ },
935
+ {
936
+ "name": "LocationStatus",
937
+ "slug": "locationstatus",
938
+ "members": [
939
+ {
940
+ "name": "NotSet",
941
+ "value": "'NOT_SET'",
942
+ "tags": [],
943
+ "docs": ""
944
+ },
945
+ {
946
+ "name": "Set",
947
+ "value": "'SET'",
948
+ "tags": [],
949
+ "docs": ""
950
+ },
951
+ {
952
+ "name": "Unknown",
953
+ "value": "'UNKNOWN'",
954
+ "tags": [],
955
+ "docs": ""
956
+ }
957
+ ]
958
+ },
959
+ {
960
+ "name": "DeviceType",
961
+ "slug": "devicetype",
962
+ "members": [
963
+ {
964
+ "name": "cotsDevice",
965
+ "value": "'cotsDevice'",
966
+ "tags": [],
967
+ "docs": ""
968
+ },
969
+ {
970
+ "name": "wisePad3s",
971
+ "value": "'wisePad3s'",
972
+ "tags": [],
973
+ "docs": ""
974
+ },
975
+ {
976
+ "name": "appleBuiltIn",
977
+ "value": "'appleBuiltIn'",
978
+ "tags": [],
979
+ "docs": ""
980
+ },
981
+ {
982
+ "name": "chipper1X",
983
+ "value": "'chipper1X'",
984
+ "tags": [],
985
+ "docs": ""
986
+ },
987
+ {
988
+ "name": "chipper2X",
989
+ "value": "'chipper2X'",
990
+ "tags": [],
991
+ "docs": ""
992
+ },
993
+ {
994
+ "name": "etna",
995
+ "value": "'etna'",
996
+ "tags": [],
997
+ "docs": ""
998
+ },
999
+ {
1000
+ "name": "stripeM2",
1001
+ "value": "'stripeM2'",
1002
+ "tags": [],
1003
+ "docs": ""
1004
+ },
1005
+ {
1006
+ "name": "stripeS700",
1007
+ "value": "'stripeS700'",
1008
+ "tags": [],
1009
+ "docs": ""
1010
+ },
1011
+ {
1012
+ "name": "stripeS700DevKit",
1013
+ "value": "'stripeS700Devkit'",
1014
+ "tags": [],
1015
+ "docs": ""
1016
+ },
1017
+ {
1018
+ "name": "verifoneP400",
1019
+ "value": "'verifoneP400'",
1020
+ "tags": [],
1021
+ "docs": ""
1022
+ },
1023
+ {
1024
+ "name": "wiseCube",
1025
+ "value": "'wiseCube'",
1026
+ "tags": [],
1027
+ "docs": ""
1028
+ },
1029
+ {
1030
+ "name": "wisePad3",
1031
+ "value": "'wisePad3'",
1032
+ "tags": [],
1033
+ "docs": ""
1034
+ },
1035
+ {
1036
+ "name": "wisePosE",
1037
+ "value": "'wisePosE'",
1038
+ "tags": [],
1039
+ "docs": ""
1040
+ },
1041
+ {
1042
+ "name": "wisePosEDevKit",
1043
+ "value": "'wisePosEDevkit'",
1044
+ "tags": [],
1045
+ "docs": ""
1046
+ },
1047
+ {
1048
+ "name": "unknown",
1049
+ "value": "'unknown'",
1050
+ "tags": [],
1051
+ "docs": ""
1052
+ }
1053
+ ]
1054
+ },
1055
+ {
1056
+ "name": "TerminalConnectTypes",
1057
+ "slug": "terminalconnecttypes",
1058
+ "members": [
1059
+ {
1060
+ "name": "Simulated",
1061
+ "value": "'simulated'",
1062
+ "tags": [],
1063
+ "docs": ""
1064
+ },
1065
+ {
1066
+ "name": "Internet",
1067
+ "value": "'internet'",
1068
+ "tags": [],
1069
+ "docs": ""
1070
+ },
1071
+ {
1072
+ "name": "Bluetooth",
1073
+ "value": "'bluetooth'",
1074
+ "tags": [],
1075
+ "docs": ""
1076
+ },
1077
+ {
1078
+ "name": "Usb",
1079
+ "value": "'usb'",
1080
+ "tags": [],
1081
+ "docs": ""
1082
+ },
1083
+ {
1084
+ "name": "TapToPay",
1085
+ "value": "'tap-to-pay'",
1086
+ "tags": [],
1087
+ "docs": ""
1088
+ }
1089
+ ]
1090
+ },
1091
+ {
1092
+ "name": "SimulateReaderUpdate",
1093
+ "slug": "simulatereaderupdate",
1094
+ "members": [
1095
+ {
1096
+ "name": "UpdateAvailable",
1097
+ "value": "'UPDATE_AVAILABLE'",
1098
+ "tags": [],
1099
+ "docs": ""
1100
+ },
1101
+ {
1102
+ "name": "None",
1103
+ "value": "'NONE'",
1104
+ "tags": [],
1105
+ "docs": ""
1106
+ },
1107
+ {
1108
+ "name": "Required",
1109
+ "value": "'REQUIRED'",
1110
+ "tags": [],
1111
+ "docs": ""
1112
+ },
1113
+ {
1114
+ "name": "Random",
1115
+ "value": "'RANDOM'",
1116
+ "tags": [],
1117
+ "docs": ""
1118
+ },
1119
+ {
1120
+ "name": "LowBattery",
1121
+ "value": "'LOW_BATTERY'",
1122
+ "tags": [],
1123
+ "docs": ""
1124
+ },
1125
+ {
1126
+ "name": "LowBatterySucceedConnect",
1127
+ "value": "'LOW_BATTERY_SUCCEED_CONNECT'",
1128
+ "tags": [],
1129
+ "docs": ""
1130
+ }
1131
+ ]
1132
+ },
1133
+ {
1134
+ "name": "SimulatedCardType",
1135
+ "slug": "simulatedcardtype",
1136
+ "members": [
1137
+ {
1138
+ "name": "Visa",
1139
+ "value": "'VISA'",
1140
+ "tags": [],
1141
+ "docs": ""
1142
+ },
1143
+ {
1144
+ "name": "VisaDebit",
1145
+ "value": "'VISA_DEBIT'",
1146
+ "tags": [],
1147
+ "docs": ""
1148
+ },
1149
+ {
1150
+ "name": "Mastercard",
1151
+ "value": "'MASTERCARD'",
1152
+ "tags": [],
1153
+ "docs": ""
1154
+ },
1155
+ {
1156
+ "name": "MastercardDebit",
1157
+ "value": "'MASTERCARD_DEBIT'",
1158
+ "tags": [],
1159
+ "docs": ""
1160
+ },
1161
+ {
1162
+ "name": "MastercardPrepaid",
1163
+ "value": "'MASTERCARD_PREPAID'",
1164
+ "tags": [],
1165
+ "docs": ""
1166
+ },
1167
+ {
1168
+ "name": "Amex",
1169
+ "value": "'AMEX'",
1170
+ "tags": [],
1171
+ "docs": ""
1172
+ },
1173
+ {
1174
+ "name": "Amex2",
1175
+ "value": "'AMEX_2'",
1176
+ "tags": [],
1177
+ "docs": ""
1178
+ },
1179
+ {
1180
+ "name": "Discover",
1181
+ "value": "'DISCOVER'",
1182
+ "tags": [],
1183
+ "docs": ""
1184
+ },
1185
+ {
1186
+ "name": "Discover2",
1187
+ "value": "'DISCOVER_2'",
1188
+ "tags": [],
1189
+ "docs": ""
1190
+ },
1191
+ {
1192
+ "name": "DinersClub",
1193
+ "value": "'DINERS'",
1194
+ "tags": [],
1195
+ "docs": ""
1196
+ },
1197
+ {
1198
+ "name": "DinersClulb14Digits",
1199
+ "value": "'DINERS_14_DIGITS'",
1200
+ "tags": [],
1201
+ "docs": ""
1202
+ },
1203
+ {
1204
+ "name": "JCB",
1205
+ "value": "'JCB'",
1206
+ "tags": [],
1207
+ "docs": ""
1208
+ },
1209
+ {
1210
+ "name": "UnionPay",
1211
+ "value": "'UNION_PAY'",
1212
+ "tags": [],
1213
+ "docs": ""
1214
+ },
1215
+ {
1216
+ "name": "Interac",
1217
+ "value": "'INTERAC'",
1218
+ "tags": [],
1219
+ "docs": ""
1220
+ },
1221
+ {
1222
+ "name": "EftposAustraliaDebit",
1223
+ "value": "'EFTPOS_AU_DEBIT'",
1224
+ "tags": [],
1225
+ "docs": ""
1226
+ },
1227
+ {
1228
+ "name": "VisaUsCommonDebit",
1229
+ "value": "'VISA_US_COMMON_DEBIT'",
1230
+ "tags": [],
1231
+ "docs": ""
1232
+ },
1233
+ {
1234
+ "name": "ChargeDeclined",
1235
+ "value": "'CHARGE_DECLINED'",
1236
+ "tags": [],
1237
+ "docs": ""
1238
+ },
1239
+ {
1240
+ "name": "ChargeDeclinedInsufficientFunds",
1241
+ "value": "'CHARGE_DECLINED_INSUFFICIENT_FUNDS'",
1242
+ "tags": [],
1243
+ "docs": ""
1244
+ },
1245
+ {
1246
+ "name": "ChargeDeclinedLostCard",
1247
+ "value": "'CHARGE_DECLINED_LOST_CARD'",
1248
+ "tags": [],
1249
+ "docs": ""
1250
+ },
1251
+ {
1252
+ "name": "ChargeDeclinedStolenCard",
1253
+ "value": "'CHARGE_DECLINED_STOLEN_CARD'",
1254
+ "tags": [],
1255
+ "docs": ""
1256
+ },
1257
+ {
1258
+ "name": "ChargeDeclinedExpiredCard",
1259
+ "value": "'CHARGE_DECLINED_EXPIRED_CARD'",
1260
+ "tags": [],
1261
+ "docs": ""
1262
+ },
1263
+ {
1264
+ "name": "ChargeDeclinedProcessingError",
1265
+ "value": "'CHARGE_DECLINED_PROCESSING_ERROR'",
1266
+ "tags": [],
1267
+ "docs": ""
1268
+ },
1269
+ {
1270
+ "name": "EftposAustraliaVisaDebit",
1271
+ "value": "'EFTPOS_AU_VISA_DEBIT'",
1272
+ "tags": [],
1273
+ "docs": ""
1274
+ },
1275
+ {
1276
+ "name": "EftposAustraliaMastercardDebit",
1277
+ "value": "'EFTPOS_AU_DEBIT_MASTERCARD'",
1278
+ "tags": [],
1279
+ "docs": ""
1280
+ },
1281
+ {
1282
+ "name": "OfflinePinCVM",
1283
+ "value": "'OFFLINE_PIN_CVM'",
1284
+ "tags": [],
1285
+ "docs": ""
1286
+ },
1287
+ {
1288
+ "name": "OfflinePinSCARetry",
1289
+ "value": "'OFFLINE_PIN_SCA_RETRY'",
1290
+ "tags": [],
1291
+ "docs": ""
1292
+ },
1293
+ {
1294
+ "name": "OnlinePinCVM",
1295
+ "value": "'ONLINE_PIN_CVM'",
1296
+ "tags": [],
1297
+ "docs": ""
1298
+ },
1299
+ {
1300
+ "name": "OnlinePinSCARetry",
1301
+ "value": "'ONLINE_PIN_SCA_RETRY'",
1302
+ "tags": [],
1303
+ "docs": ""
1304
+ }
1305
+ ]
1306
+ },
1307
+ {
1308
+ "name": "TerminalEventsEnum",
1309
+ "slug": "terminaleventsenum",
1310
+ "members": [
1311
+ {
1312
+ "name": "Loaded",
1313
+ "value": "'terminalLoaded'",
1314
+ "tags": [],
1315
+ "docs": ""
1316
+ },
1317
+ {
1318
+ "name": "DiscoveredReaders",
1319
+ "value": "'terminalDiscoveredReaders'",
1320
+ "tags": [],
1321
+ "docs": ""
1322
+ },
1323
+ {
1324
+ "name": "CancelDiscoveredReaders",
1325
+ "value": "'terminalCancelDiscoveredReaders'",
1326
+ "tags": [],
1327
+ "docs": ""
1328
+ },
1329
+ {
1330
+ "name": "ConnectedReader",
1331
+ "value": "'terminalConnectedReader'",
1332
+ "tags": [],
1333
+ "docs": ""
1334
+ },
449
1335
  {
450
1336
  "name": "DisconnectedReader",
451
1337
  "value": "'terminalDisconnectedReader'",
452
1338
  "tags": [],
453
1339
  "docs": ""
454
1340
  },
1341
+ {
1342
+ "name": "ConnectionStatusChange",
1343
+ "value": "'terminalConnectionStatusChange'",
1344
+ "tags": [],
1345
+ "docs": ""
1346
+ },
1347
+ {
1348
+ "name": "UnexpectedReaderDisconnect",
1349
+ "value": "'terminalUnexpectedReaderDisconnect'",
1350
+ "tags": [],
1351
+ "docs": ""
1352
+ },
455
1353
  {
456
1354
  "name": "ConfirmedPaymentIntent",
457
1355
  "value": "'terminalConfirmedPaymentIntent'",
@@ -481,6 +1379,318 @@
481
1379
  "value": "'terminalRequestedConnectionToken'",
482
1380
  "tags": [],
483
1381
  "docs": ""
1382
+ },
1383
+ {
1384
+ "name": "ReportAvailableUpdate",
1385
+ "value": "'terminalReportAvailableUpdate'",
1386
+ "tags": [],
1387
+ "docs": ""
1388
+ },
1389
+ {
1390
+ "name": "StartInstallingUpdate",
1391
+ "value": "'terminalStartInstallingUpdate'",
1392
+ "tags": [],
1393
+ "docs": ""
1394
+ },
1395
+ {
1396
+ "name": "ReaderSoftwareUpdateProgress",
1397
+ "value": "'terminalReaderSoftwareUpdateProgress'",
1398
+ "tags": [],
1399
+ "docs": ""
1400
+ },
1401
+ {
1402
+ "name": "FinishInstallingUpdate",
1403
+ "value": "'terminalFinishInstallingUpdate'",
1404
+ "tags": [],
1405
+ "docs": ""
1406
+ },
1407
+ {
1408
+ "name": "BatteryLevel",
1409
+ "value": "'terminalBatteryLevel'",
1410
+ "tags": [],
1411
+ "docs": ""
1412
+ },
1413
+ {
1414
+ "name": "ReaderEvent",
1415
+ "value": "'terminalReaderEvent'",
1416
+ "tags": [],
1417
+ "docs": ""
1418
+ },
1419
+ {
1420
+ "name": "RequestDisplayMessage",
1421
+ "value": "'terminalRequestDisplayMessage'",
1422
+ "tags": [],
1423
+ "docs": ""
1424
+ },
1425
+ {
1426
+ "name": "RequestReaderInput",
1427
+ "value": "'terminalRequestReaderInput'",
1428
+ "tags": [],
1429
+ "docs": ""
1430
+ },
1431
+ {
1432
+ "name": "PaymentStatusChange",
1433
+ "value": "'terminalPaymentStatusChange'",
1434
+ "tags": [],
1435
+ "docs": ""
1436
+ },
1437
+ {
1438
+ "name": "ReaderReconnectStarted",
1439
+ "value": "'terminalReaderReconnectStarted'",
1440
+ "tags": [],
1441
+ "docs": ""
1442
+ },
1443
+ {
1444
+ "name": "ReaderReconnectSucceeded",
1445
+ "value": "'terminalReaderReconnectSucceeded'",
1446
+ "tags": [],
1447
+ "docs": ""
1448
+ },
1449
+ {
1450
+ "name": "ReaderReconnectFailed",
1451
+ "value": "'terminalReaderReconnectFailed'",
1452
+ "tags": [],
1453
+ "docs": ""
1454
+ }
1455
+ ]
1456
+ },
1457
+ {
1458
+ "name": "DisconnectReason",
1459
+ "slug": "disconnectreason",
1460
+ "members": [
1461
+ {
1462
+ "name": "Unknown",
1463
+ "value": "'UNKNOWN'",
1464
+ "tags": [],
1465
+ "docs": ""
1466
+ },
1467
+ {
1468
+ "name": "DisconnectRequested",
1469
+ "value": "'DISCONNECT_REQUESTED'",
1470
+ "tags": [],
1471
+ "docs": ""
1472
+ },
1473
+ {
1474
+ "name": "RebootRequested",
1475
+ "value": "'REBOOT_REQUESTED'",
1476
+ "tags": [],
1477
+ "docs": ""
1478
+ },
1479
+ {
1480
+ "name": "SecurityReboot",
1481
+ "value": "'SECURITY_REBOOT'",
1482
+ "tags": [],
1483
+ "docs": ""
1484
+ },
1485
+ {
1486
+ "name": "CriticallyLowBattery",
1487
+ "value": "'CRITICALLY_LOW_BATTERY'",
1488
+ "tags": [],
1489
+ "docs": ""
1490
+ },
1491
+ {
1492
+ "name": "PoweredOff",
1493
+ "value": "'POWERED_OFF'",
1494
+ "tags": [],
1495
+ "docs": ""
1496
+ },
1497
+ {
1498
+ "name": "BluetoothDisabled",
1499
+ "value": "'BLUETOOTH_DISABLED'",
1500
+ "tags": [],
1501
+ "docs": ""
1502
+ }
1503
+ ]
1504
+ },
1505
+ {
1506
+ "name": "ConnectionStatus",
1507
+ "slug": "connectionstatus",
1508
+ "members": [
1509
+ {
1510
+ "name": "Unknown",
1511
+ "value": "'UNKNOWN'",
1512
+ "tags": [],
1513
+ "docs": ""
1514
+ },
1515
+ {
1516
+ "name": "NotConnected",
1517
+ "value": "'NOT_CONNECTED'",
1518
+ "tags": [],
1519
+ "docs": ""
1520
+ },
1521
+ {
1522
+ "name": "Connecting",
1523
+ "value": "'CONNECTING'",
1524
+ "tags": [],
1525
+ "docs": ""
1526
+ },
1527
+ {
1528
+ "name": "Connected",
1529
+ "value": "'CONNECTED'",
1530
+ "tags": [],
1531
+ "docs": ""
1532
+ }
1533
+ ]
1534
+ },
1535
+ {
1536
+ "name": "ReaderEvent",
1537
+ "slug": "readerevent",
1538
+ "members": [
1539
+ {
1540
+ "name": "Unknown",
1541
+ "value": "'UNKNOWN'",
1542
+ "tags": [],
1543
+ "docs": ""
1544
+ },
1545
+ {
1546
+ "name": "CardInserted",
1547
+ "value": "'CARD_INSERTED'",
1548
+ "tags": [],
1549
+ "docs": ""
1550
+ },
1551
+ {
1552
+ "name": "CardRemoved",
1553
+ "value": "'CARD_REMOVED'",
1554
+ "tags": [],
1555
+ "docs": ""
1556
+ }
1557
+ ]
1558
+ },
1559
+ {
1560
+ "name": "ReaderDisplayMessage",
1561
+ "slug": "readerdisplaymessage",
1562
+ "members": [
1563
+ {
1564
+ "name": "CheckMobileDevice",
1565
+ "value": "'CHECK_MOBILE_DEVICE'",
1566
+ "tags": [],
1567
+ "docs": ""
1568
+ },
1569
+ {
1570
+ "name": "RetryCard",
1571
+ "value": "'RETRY_CARD'",
1572
+ "tags": [],
1573
+ "docs": ""
1574
+ },
1575
+ {
1576
+ "name": "InsertCard",
1577
+ "value": "'INSERT_CARD'",
1578
+ "tags": [],
1579
+ "docs": ""
1580
+ },
1581
+ {
1582
+ "name": "InsertOrSwipeCard",
1583
+ "value": "'INSERT_OR_SWIPE_CARD'",
1584
+ "tags": [],
1585
+ "docs": ""
1586
+ },
1587
+ {
1588
+ "name": "SwipeCard",
1589
+ "value": "'SWIPE_CARD'",
1590
+ "tags": [],
1591
+ "docs": ""
1592
+ },
1593
+ {
1594
+ "name": "RemoveCard",
1595
+ "value": "'REMOVE_CARD'",
1596
+ "tags": [],
1597
+ "docs": ""
1598
+ },
1599
+ {
1600
+ "name": "MultipleContactlessCardsDetected",
1601
+ "value": "'MULTIPLE_CONTACTLESS_CARDS_DETECTED'",
1602
+ "tags": [],
1603
+ "docs": ""
1604
+ },
1605
+ {
1606
+ "name": "TryAnotherReadMethod",
1607
+ "value": "'TRY_ANOTHER_READ_METHOD'",
1608
+ "tags": [],
1609
+ "docs": ""
1610
+ },
1611
+ {
1612
+ "name": "TryAnotherCard",
1613
+ "value": "'TRY_ANOTHER_CARD'",
1614
+ "tags": [],
1615
+ "docs": ""
1616
+ },
1617
+ {
1618
+ "name": "CardRemovedTooEarly",
1619
+ "value": "'CARD_REMOVED_TOO_EARLY'",
1620
+ "tags": [],
1621
+ "docs": ""
1622
+ }
1623
+ ]
1624
+ },
1625
+ {
1626
+ "name": "ReaderInputOption",
1627
+ "slug": "readerinputoption",
1628
+ "members": [
1629
+ {
1630
+ "name": "None",
1631
+ "value": "'NONE'",
1632
+ "tags": [],
1633
+ "docs": ""
1634
+ },
1635
+ {
1636
+ "name": "Insert",
1637
+ "value": "'INSERT'",
1638
+ "tags": [],
1639
+ "docs": ""
1640
+ },
1641
+ {
1642
+ "name": "Swipe",
1643
+ "value": "'SWIPE'",
1644
+ "tags": [],
1645
+ "docs": ""
1646
+ },
1647
+ {
1648
+ "name": "Tap",
1649
+ "value": "'TAP'",
1650
+ "tags": [],
1651
+ "docs": ""
1652
+ },
1653
+ {
1654
+ "name": "ManualEntry",
1655
+ "value": "'MANUAL_ENTRY'",
1656
+ "tags": [],
1657
+ "docs": ""
1658
+ }
1659
+ ]
1660
+ },
1661
+ {
1662
+ "name": "PaymentStatus",
1663
+ "slug": "paymentstatus",
1664
+ "members": [
1665
+ {
1666
+ "name": "Unknown",
1667
+ "value": "'UNKNOWN'",
1668
+ "tags": [],
1669
+ "docs": ""
1670
+ },
1671
+ {
1672
+ "name": "NotReady",
1673
+ "value": "'NOT_READY'",
1674
+ "tags": [],
1675
+ "docs": ""
1676
+ },
1677
+ {
1678
+ "name": "Ready",
1679
+ "value": "'READY'",
1680
+ "tags": [],
1681
+ "docs": ""
1682
+ },
1683
+ {
1684
+ "name": "WaitingForInput",
1685
+ "value": "'WAITING_FOR_INPUT'",
1686
+ "tags": [],
1687
+ "docs": ""
1688
+ },
1689
+ {
1690
+ "name": "Processing",
1691
+ "value": "'PROCESSING'",
1692
+ "tags": [],
1693
+ "docs": ""
484
1694
  }
485
1695
  ]
486
1696
  }
@@ -492,7 +1702,75 @@
492
1702
  "docs": "",
493
1703
  "types": [
494
1704
  {
495
- "text": "{\n index: number;\n serialNumber: string;\n}",
1705
+ "text": "{\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}",
1706
+ "complexTypes": [
1707
+ "BatteryStatus",
1708
+ "ReaderSoftwareUpdateInterface",
1709
+ "NetworkStatus",
1710
+ "LocationInterface",
1711
+ "LocationStatus",
1712
+ "DeviceType"
1713
+ ]
1714
+ }
1715
+ ]
1716
+ },
1717
+ {
1718
+ "name": "ReaderSoftwareUpdateInterface",
1719
+ "slug": "readersoftwareupdateinterface",
1720
+ "docs": "",
1721
+ "types": [
1722
+ {
1723
+ "text": "{\n deviceSoftwareVersion: string;\n estimatedUpdateTime: UpdateTimeEstimate;\n requiredAt: number;\n}",
1724
+ "complexTypes": [
1725
+ "UpdateTimeEstimate"
1726
+ ]
1727
+ }
1728
+ ]
1729
+ },
1730
+ {
1731
+ "name": "LocationInterface",
1732
+ "slug": "locationinterface",
1733
+ "docs": "",
1734
+ "types": [
1735
+ {
1736
+ "text": "{\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}",
1737
+ "complexTypes": []
1738
+ }
1739
+ ]
1740
+ },
1741
+ {
1742
+ "name": "DeviceType",
1743
+ "slug": "devicetype",
1744
+ "docs": "",
1745
+ "types": [
1746
+ {
1747
+ "text": "Stripe.Terminal.Reader.DeviceType",
1748
+ "complexTypes": [
1749
+ "Stripe"
1750
+ ]
1751
+ }
1752
+ ]
1753
+ },
1754
+ {
1755
+ "name": "Cart",
1756
+ "slug": "cart",
1757
+ "docs": "",
1758
+ "types": [
1759
+ {
1760
+ "text": "{\n currency: string;\n tax: number;\n total: number;\n lineItems: CartLineItem[];\n}",
1761
+ "complexTypes": [
1762
+ "CartLineItem"
1763
+ ]
1764
+ }
1765
+ ]
1766
+ },
1767
+ {
1768
+ "name": "CartLineItem",
1769
+ "slug": "cartlineitem",
1770
+ "docs": "",
1771
+ "types": [
1772
+ {
1773
+ "text": "{\n displayName: string;\n quantity: number;\n amount: number;\n}",
496
1774
  "complexTypes": []
497
1775
  }
498
1776
  ]