@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/dist/docs.json CHANGED
@@ -56,6 +56,25 @@
56
56
  "complexTypes": [],
57
57
  "slug": "setconnectiontoken"
58
58
  },
59
+ {
60
+ "name": "setSimulatorConfiguration",
61
+ "signature": "(options: { update?: SimulateReaderUpdate; simulatedCard?: SimulatedCardType; simulatedTipAmount?: number; }) => Promise<void>",
62
+ "parameters": [
63
+ {
64
+ "name": "options",
65
+ "docs": "",
66
+ "type": "{ update?: SimulateReaderUpdate | undefined; simulatedCard?: SimulatedCardType | undefined; simulatedTipAmount?: number | undefined; }"
67
+ }
68
+ ],
69
+ "returns": "Promise<void>",
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
+ },
59
78
  {
60
79
  "name": "connectReader",
61
80
  "signature": "(options: { reader: ReaderInterface; }) => Promise<void>",
@@ -192,7 +211,7 @@
192
211
  },
193
212
  {
194
213
  "name": "addListener",
195
- "signature": "(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: () => { reader: ReaderInterface; }) => Promise<PluginListenerHandle>",
214
+ "signature": "(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>",
196
215
  "parameters": [
197
216
  {
198
217
  "name": "eventName",
@@ -202,7 +221,7 @@
202
221
  {
203
222
  "name": "listenerFunc",
204
223
  "docs": "",
205
- "type": "() => { reader: ReaderInterface; }"
224
+ "type": "({ readers }: { readers: ReaderInterface[]; }) => void"
206
225
  }
207
226
  ],
208
227
  "returns": "Promise<PluginListenerHandle>",
@@ -239,6 +258,81 @@
239
258
  ],
240
259
  "slug": "addlistenerterminaleventsenumconnectedreader"
241
260
  },
261
+ {
262
+ "name": "addListener",
263
+ "signature": "(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>",
264
+ "parameters": [
265
+ {
266
+ "name": "eventName",
267
+ "docs": "",
268
+ "type": "TerminalEventsEnum.DisconnectedReader"
269
+ },
270
+ {
271
+ "name": "listenerFunc",
272
+ "docs": "",
273
+ "type": "({ reason }: { reason?: DisconnectReason | undefined; }) => void"
274
+ }
275
+ ],
276
+ "returns": "Promise<PluginListenerHandle>",
277
+ "tags": [],
278
+ "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.",
279
+ "complexTypes": [
280
+ "PluginListenerHandle",
281
+ "TerminalEventsEnum",
282
+ "DisconnectReason"
283
+ ],
284
+ "slug": "addlistenerterminaleventsenumdisconnectedreader"
285
+ },
286
+ {
287
+ "name": "addListener",
288
+ "signature": "(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>",
289
+ "parameters": [
290
+ {
291
+ "name": "eventName",
292
+ "docs": "",
293
+ "type": "TerminalEventsEnum.ConnectionStatusChange"
294
+ },
295
+ {
296
+ "name": "listenerFunc",
297
+ "docs": "",
298
+ "type": "({ status }: { status: ConnectionStatus; }) => void"
299
+ }
300
+ ],
301
+ "returns": "Promise<PluginListenerHandle>",
302
+ "tags": [],
303
+ "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)",
304
+ "complexTypes": [
305
+ "PluginListenerHandle",
306
+ "TerminalEventsEnum",
307
+ "ConnectionStatus"
308
+ ],
309
+ "slug": "addlistenerterminaleventsenumconnectionstatuschange"
310
+ },
311
+ {
312
+ "name": "addListener",
313
+ "signature": "(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>",
314
+ "parameters": [
315
+ {
316
+ "name": "eventName",
317
+ "docs": "",
318
+ "type": "TerminalEventsEnum.UnexpectedReaderDisconnect"
319
+ },
320
+ {
321
+ "name": "listenerFunc",
322
+ "docs": "",
323
+ "type": "({ reader }: { reader: ReaderInterface; }) => void"
324
+ }
325
+ ],
326
+ "returns": "Promise<PluginListenerHandle>",
327
+ "tags": [],
328
+ "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)",
329
+ "complexTypes": [
330
+ "PluginListenerHandle",
331
+ "TerminalEventsEnum",
332
+ "ReaderInterface"
333
+ ],
334
+ "slug": "addlistenerterminaleventsenumunexpectedreaderdisconnect"
335
+ },
242
336
  {
243
337
  "name": "addListener",
244
338
  "signature": "(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>",
@@ -304,7 +398,7 @@
304
398
  ],
305
399
  "returns": "Promise<PluginListenerHandle>",
306
400
  "tags": [],
307
- "docs": "",
401
+ "docs": "Emitted when [`cancelCollectPaymentMethod()`](#cancelcollectpaymentmethod) is called and succeeds.\nThe Promise returned by `cancelCollectPaymentMethod()` will also be resolved.",
308
402
  "complexTypes": [
309
403
  "PluginListenerHandle",
310
404
  "TerminalEventsEnum"
@@ -328,12 +422,236 @@
328
422
  ],
329
423
  "returns": "Promise<PluginListenerHandle>",
330
424
  "tags": [],
331
- "docs": "",
425
+ "docs": "Emitted when either [`collectPaymentMethod()`](#collectpaymentmethod) or [`confirmPaymentIntent()`](#confirmpaymentintent)\nfails. The Promise returned by the relevant call will also be rejected.",
332
426
  "complexTypes": [
333
427
  "PluginListenerHandle",
334
428
  "TerminalEventsEnum"
335
429
  ],
336
430
  "slug": "addlistenerterminaleventsenumfailed"
431
+ },
432
+ {
433
+ "name": "addListener",
434
+ "signature": "(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>",
435
+ "parameters": [
436
+ {
437
+ "name": "eventName",
438
+ "docs": "",
439
+ "type": "TerminalEventsEnum.ReportAvailableUpdate"
440
+ },
441
+ {
442
+ "name": "listenerFunc",
443
+ "docs": "",
444
+ "type": "({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void"
445
+ }
446
+ ],
447
+ "returns": "Promise<PluginListenerHandle>",
448
+ "tags": [],
449
+ "docs": "Emitted when a software update is available for the connected reader.",
450
+ "complexTypes": [
451
+ "PluginListenerHandle",
452
+ "TerminalEventsEnum",
453
+ "ReaderSoftwareUpdateInterface"
454
+ ],
455
+ "slug": "addlistenerterminaleventsenumreportavailableupdate"
456
+ },
457
+ {
458
+ "name": "addListener",
459
+ "signature": "(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>",
460
+ "parameters": [
461
+ {
462
+ "name": "eventName",
463
+ "docs": "",
464
+ "type": "TerminalEventsEnum.StartInstallingUpdate"
465
+ },
466
+ {
467
+ "name": "listenerFunc",
468
+ "docs": "",
469
+ "type": "({ update, }: { update: ReaderSoftwareUpdateInterface; }) => void"
470
+ }
471
+ ],
472
+ "returns": "Promise<PluginListenerHandle>",
473
+ "tags": [],
474
+ "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)",
475
+ "complexTypes": [
476
+ "PluginListenerHandle",
477
+ "TerminalEventsEnum",
478
+ "ReaderSoftwareUpdateInterface"
479
+ ],
480
+ "slug": "addlistenerterminaleventsenumstartinstallingupdate"
481
+ },
482
+ {
483
+ "name": "addListener",
484
+ "signature": "(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>",
485
+ "parameters": [
486
+ {
487
+ "name": "eventName",
488
+ "docs": "",
489
+ "type": "TerminalEventsEnum.ReaderSoftwareUpdateProgress"
490
+ },
491
+ {
492
+ "name": "listenerFunc",
493
+ "docs": "",
494
+ "type": "({ progress }: { progress: number; }) => void"
495
+ }
496
+ ],
497
+ "returns": "Promise<PluginListenerHandle>",
498
+ "tags": [],
499
+ "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)",
500
+ "complexTypes": [
501
+ "PluginListenerHandle",
502
+ "TerminalEventsEnum"
503
+ ],
504
+ "slug": "addlistenerterminaleventsenumreadersoftwareupdateprogress"
505
+ },
506
+ {
507
+ "name": "addListener",
508
+ "signature": "(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>",
509
+ "parameters": [
510
+ {
511
+ "name": "eventName",
512
+ "docs": "",
513
+ "type": "TerminalEventsEnum.FinishInstallingUpdate"
514
+ },
515
+ {
516
+ "name": "listenerFunc",
517
+ "docs": "",
518
+ "type": "(args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void"
519
+ }
520
+ ],
521
+ "returns": "Promise<PluginListenerHandle>",
522
+ "tags": [],
523
+ "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)",
524
+ "complexTypes": [
525
+ "PluginListenerHandle",
526
+ "TerminalEventsEnum",
527
+ "ReaderSoftwareUpdateInterface"
528
+ ],
529
+ "slug": "addlistenerterminaleventsenumfinishinstallingupdate"
530
+ },
531
+ {
532
+ "name": "addListener",
533
+ "signature": "(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status, }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>",
534
+ "parameters": [
535
+ {
536
+ "name": "eventName",
537
+ "docs": "",
538
+ "type": "TerminalEventsEnum.BatteryLevel"
539
+ },
540
+ {
541
+ "name": "listenerFunc",
542
+ "docs": "",
543
+ "type": "({ level, charging, status, }: { level: number; charging: boolean; status: BatteryStatus; }) => void"
544
+ }
545
+ ],
546
+ "returns": "Promise<PluginListenerHandle>",
547
+ "tags": [],
548
+ "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)",
549
+ "complexTypes": [
550
+ "PluginListenerHandle",
551
+ "TerminalEventsEnum",
552
+ "BatteryStatus"
553
+ ],
554
+ "slug": "addlistenerterminaleventsenumbatterylevel"
555
+ },
556
+ {
557
+ "name": "addListener",
558
+ "signature": "(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>",
559
+ "parameters": [
560
+ {
561
+ "name": "eventName",
562
+ "docs": "",
563
+ "type": "TerminalEventsEnum.ReaderEvent"
564
+ },
565
+ {
566
+ "name": "listenerFunc",
567
+ "docs": "",
568
+ "type": "({ event }: { event: ReaderEvent; }) => void"
569
+ }
570
+ ],
571
+ "returns": "Promise<PluginListenerHandle>",
572
+ "tags": [],
573
+ "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)",
574
+ "complexTypes": [
575
+ "PluginListenerHandle",
576
+ "TerminalEventsEnum",
577
+ "ReaderEvent"
578
+ ],
579
+ "slug": "addlistenerterminaleventsenumreaderevent"
580
+ },
581
+ {
582
+ "name": "addListener",
583
+ "signature": "(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message, }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>",
584
+ "parameters": [
585
+ {
586
+ "name": "eventName",
587
+ "docs": "",
588
+ "type": "TerminalEventsEnum.RequestDisplayMessage"
589
+ },
590
+ {
591
+ "name": "listenerFunc",
592
+ "docs": "",
593
+ "type": "({ messageType, message, }: { messageType: ReaderDisplayMessage; message: string; }) => void"
594
+ }
595
+ ],
596
+ "returns": "Promise<PluginListenerHandle>",
597
+ "tags": [],
598
+ "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)",
599
+ "complexTypes": [
600
+ "PluginListenerHandle",
601
+ "TerminalEventsEnum",
602
+ "ReaderDisplayMessage"
603
+ ],
604
+ "slug": "addlistenerterminaleventsenumrequestdisplaymessage"
605
+ },
606
+ {
607
+ "name": "addListener",
608
+ "signature": "(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>",
609
+ "parameters": [
610
+ {
611
+ "name": "eventName",
612
+ "docs": "",
613
+ "type": "TerminalEventsEnum.RequestReaderInput"
614
+ },
615
+ {
616
+ "name": "listenerFunc",
617
+ "docs": "",
618
+ "type": "({ options, message, }: { options: ReaderInputOption[]; message: string; }) => void"
619
+ }
620
+ ],
621
+ "returns": "Promise<PluginListenerHandle>",
622
+ "tags": [],
623
+ "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)",
624
+ "complexTypes": [
625
+ "PluginListenerHandle",
626
+ "TerminalEventsEnum",
627
+ "ReaderInputOption"
628
+ ],
629
+ "slug": "addlistenerterminaleventsenumrequestreaderinput"
630
+ },
631
+ {
632
+ "name": "addListener",
633
+ "signature": "(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>",
634
+ "parameters": [
635
+ {
636
+ "name": "eventName",
637
+ "docs": "",
638
+ "type": "TerminalEventsEnum.PaymentStatusChange"
639
+ },
640
+ {
641
+ "name": "listenerFunc",
642
+ "docs": "",
643
+ "type": "({ status }: { status: PaymentStatus; }) => void"
644
+ }
645
+ ],
646
+ "returns": "Promise<PluginListenerHandle>",
647
+ "tags": [],
648
+ "docs": "[*Stripe docs reference*](https://stripe.dev/stripe-terminal-android/external/com.stripe.stripeterminal.external.callable/-terminal-listener/on-payment-status-change.html)",
649
+ "complexTypes": [
650
+ "PluginListenerHandle",
651
+ "TerminalEventsEnum",
652
+ "PaymentStatus"
653
+ ],
654
+ "slug": "addlistenerterminaleventsenumpaymentstatuschange"
337
655
  }
338
656
  ],
339
657
  "properties": [
@@ -419,41 +737,269 @@
419
737
  ]
420
738
  },
421
739
  {
422
- "name": "TerminalEventsEnum",
423
- "slug": "terminaleventsenum",
740
+ "name": "SimulateReaderUpdate",
741
+ "slug": "simulatereaderupdate",
424
742
  "members": [
425
743
  {
426
- "name": "Loaded",
427
- "value": "'terminalLoaded'",
744
+ "name": "UpdateAvailable",
745
+ "value": "'UPDATE_AVAILABLE'",
428
746
  "tags": [],
429
747
  "docs": ""
430
748
  },
431
749
  {
432
- "name": "DiscoveredReaders",
433
- "value": "'terminalDiscoveredReaders'",
750
+ "name": "None",
751
+ "value": "'NONE'",
434
752
  "tags": [],
435
753
  "docs": ""
436
754
  },
437
755
  {
438
- "name": "CancelDiscoveredReaders",
439
- "value": "'terminalCancelDiscoveredReaders'",
756
+ "name": "Required",
757
+ "value": "'REQUIRED'",
440
758
  "tags": [],
441
759
  "docs": ""
442
760
  },
443
761
  {
444
- "name": "ConnectedReader",
445
- "value": "'terminalConnectedReader'",
762
+ "name": "Random",
763
+ "value": "'RANDOM'",
446
764
  "tags": [],
447
765
  "docs": ""
448
766
  },
449
767
  {
450
- "name": "DisconnectedReader",
451
- "value": "'terminalDisconnectedReader'",
768
+ "name": "LowBattery",
769
+ "value": "'LOW_BATTERY'",
452
770
  "tags": [],
453
771
  "docs": ""
454
772
  },
455
773
  {
456
- "name": "ConfirmedPaymentIntent",
774
+ "name": "LowBatterySucceedConnect",
775
+ "value": "'LOW_BATTERY_SUCCEED_CONNECT'",
776
+ "tags": [],
777
+ "docs": ""
778
+ }
779
+ ]
780
+ },
781
+ {
782
+ "name": "SimulatedCardType",
783
+ "slug": "simulatedcardtype",
784
+ "members": [
785
+ {
786
+ "name": "Visa",
787
+ "value": "'VISA'",
788
+ "tags": [],
789
+ "docs": ""
790
+ },
791
+ {
792
+ "name": "VisaDebit",
793
+ "value": "'VISA_DEBIT'",
794
+ "tags": [],
795
+ "docs": ""
796
+ },
797
+ {
798
+ "name": "Mastercard",
799
+ "value": "'MASTERCARD'",
800
+ "tags": [],
801
+ "docs": ""
802
+ },
803
+ {
804
+ "name": "MastercardDebit",
805
+ "value": "'MASTERCARD_DEBIT'",
806
+ "tags": [],
807
+ "docs": ""
808
+ },
809
+ {
810
+ "name": "MastercardPrepaid",
811
+ "value": "'MASTERCARD_PREPAID'",
812
+ "tags": [],
813
+ "docs": ""
814
+ },
815
+ {
816
+ "name": "Amex",
817
+ "value": "'AMEX'",
818
+ "tags": [],
819
+ "docs": ""
820
+ },
821
+ {
822
+ "name": "Amex2",
823
+ "value": "'AMEX_2'",
824
+ "tags": [],
825
+ "docs": ""
826
+ },
827
+ {
828
+ "name": "Discover",
829
+ "value": "'DISCOVER'",
830
+ "tags": [],
831
+ "docs": ""
832
+ },
833
+ {
834
+ "name": "Discover2",
835
+ "value": "'DISCOVER_2'",
836
+ "tags": [],
837
+ "docs": ""
838
+ },
839
+ {
840
+ "name": "DinersClub",
841
+ "value": "'DINERS'",
842
+ "tags": [],
843
+ "docs": ""
844
+ },
845
+ {
846
+ "name": "DinersClulb14Digits",
847
+ "value": "'DINERS_14_DIGITS'",
848
+ "tags": [],
849
+ "docs": ""
850
+ },
851
+ {
852
+ "name": "JCB",
853
+ "value": "'JCB'",
854
+ "tags": [],
855
+ "docs": ""
856
+ },
857
+ {
858
+ "name": "UnionPay",
859
+ "value": "'UNION_PAY'",
860
+ "tags": [],
861
+ "docs": ""
862
+ },
863
+ {
864
+ "name": "Interac",
865
+ "value": "'INTERAC'",
866
+ "tags": [],
867
+ "docs": ""
868
+ },
869
+ {
870
+ "name": "EftposAustraliaDebit",
871
+ "value": "'EFTPOS_AU_DEBIT'",
872
+ "tags": [],
873
+ "docs": ""
874
+ },
875
+ {
876
+ "name": "VisaUsCommonDebit",
877
+ "value": "'VISA_US_COMMON_DEBIT'",
878
+ "tags": [],
879
+ "docs": ""
880
+ },
881
+ {
882
+ "name": "ChargeDeclined",
883
+ "value": "'CHARGE_DECLINED'",
884
+ "tags": [],
885
+ "docs": ""
886
+ },
887
+ {
888
+ "name": "ChargeDeclinedInsufficientFunds",
889
+ "value": "'CHARGE_DECLINED_INSUFFICIENT_FUNDS'",
890
+ "tags": [],
891
+ "docs": ""
892
+ },
893
+ {
894
+ "name": "ChargeDeclinedLostCard",
895
+ "value": "'CHARGE_DECLINED_LOST_CARD'",
896
+ "tags": [],
897
+ "docs": ""
898
+ },
899
+ {
900
+ "name": "ChargeDeclinedStolenCard",
901
+ "value": "'CHARGE_DECLINED_STOLEN_CARD'",
902
+ "tags": [],
903
+ "docs": ""
904
+ },
905
+ {
906
+ "name": "ChargeDeclinedExpiredCard",
907
+ "value": "'CHARGE_DECLINED_EXPIRED_CARD'",
908
+ "tags": [],
909
+ "docs": ""
910
+ },
911
+ {
912
+ "name": "ChargeDeclinedProcessingError",
913
+ "value": "'CHARGE_DECLINED_PROCESSING_ERROR'",
914
+ "tags": [],
915
+ "docs": ""
916
+ },
917
+ {
918
+ "name": "EftposAustraliaVisaDebit",
919
+ "value": "'EFTPOS_AU_VISA_DEBIT'",
920
+ "tags": [],
921
+ "docs": ""
922
+ },
923
+ {
924
+ "name": "EftposAustraliaMastercardDebit",
925
+ "value": "'EFTPOS_AU_DEBIT_MASTERCARD'",
926
+ "tags": [],
927
+ "docs": ""
928
+ },
929
+ {
930
+ "name": "OfflinePinCVM",
931
+ "value": "'OFFLINE_PIN_CVM'",
932
+ "tags": [],
933
+ "docs": ""
934
+ },
935
+ {
936
+ "name": "OfflinePinSCARetry",
937
+ "value": "'OFFLINE_PIN_SCA_RETRY'",
938
+ "tags": [],
939
+ "docs": ""
940
+ },
941
+ {
942
+ "name": "OnlinePinCVM",
943
+ "value": "'ONLINE_PIN_CVM'",
944
+ "tags": [],
945
+ "docs": ""
946
+ },
947
+ {
948
+ "name": "OnlinePinSCARetry",
949
+ "value": "'ONLINE_PIN_SCA_RETRY'",
950
+ "tags": [],
951
+ "docs": ""
952
+ }
953
+ ]
954
+ },
955
+ {
956
+ "name": "TerminalEventsEnum",
957
+ "slug": "terminaleventsenum",
958
+ "members": [
959
+ {
960
+ "name": "Loaded",
961
+ "value": "'terminalLoaded'",
962
+ "tags": [],
963
+ "docs": ""
964
+ },
965
+ {
966
+ "name": "DiscoveredReaders",
967
+ "value": "'terminalDiscoveredReaders'",
968
+ "tags": [],
969
+ "docs": ""
970
+ },
971
+ {
972
+ "name": "CancelDiscoveredReaders",
973
+ "value": "'terminalCancelDiscoveredReaders'",
974
+ "tags": [],
975
+ "docs": ""
976
+ },
977
+ {
978
+ "name": "ConnectedReader",
979
+ "value": "'terminalConnectedReader'",
980
+ "tags": [],
981
+ "docs": ""
982
+ },
983
+ {
984
+ "name": "DisconnectedReader",
985
+ "value": "'terminalDisconnectedReader'",
986
+ "tags": [],
987
+ "docs": ""
988
+ },
989
+ {
990
+ "name": "ConnectionStatusChange",
991
+ "value": "'terminalConnectionStatusChange'",
992
+ "tags": [],
993
+ "docs": ""
994
+ },
995
+ {
996
+ "name": "UnexpectedReaderDisconnect",
997
+ "value": "'terminalUnexpectedReaderDisconnect'",
998
+ "tags": [],
999
+ "docs": ""
1000
+ },
1001
+ {
1002
+ "name": "ConfirmedPaymentIntent",
457
1003
  "value": "'terminalConfirmedPaymentIntent'",
458
1004
  "tags": [],
459
1005
  "docs": ""
@@ -481,6 +1027,360 @@
481
1027
  "value": "'terminalRequestedConnectionToken'",
482
1028
  "tags": [],
483
1029
  "docs": ""
1030
+ },
1031
+ {
1032
+ "name": "ReportAvailableUpdate",
1033
+ "value": "'terminalReportAvailableUpdate'",
1034
+ "tags": [],
1035
+ "docs": ""
1036
+ },
1037
+ {
1038
+ "name": "StartInstallingUpdate",
1039
+ "value": "'terminalStartInstallingUpdate'",
1040
+ "tags": [],
1041
+ "docs": ""
1042
+ },
1043
+ {
1044
+ "name": "ReaderSoftwareUpdateProgress",
1045
+ "value": "'terminalReaderSoftwareUpdateProgress'",
1046
+ "tags": [],
1047
+ "docs": ""
1048
+ },
1049
+ {
1050
+ "name": "FinishInstallingUpdate",
1051
+ "value": "'terminalFinishInstallingUpdate'",
1052
+ "tags": [],
1053
+ "docs": ""
1054
+ },
1055
+ {
1056
+ "name": "BatteryLevel",
1057
+ "value": "'terminalBatteryLevel'",
1058
+ "tags": [],
1059
+ "docs": ""
1060
+ },
1061
+ {
1062
+ "name": "ReaderEvent",
1063
+ "value": "'terminalReaderEvent'",
1064
+ "tags": [],
1065
+ "docs": ""
1066
+ },
1067
+ {
1068
+ "name": "RequestDisplayMessage",
1069
+ "value": "'terminalRequestDisplayMessage'",
1070
+ "tags": [],
1071
+ "docs": ""
1072
+ },
1073
+ {
1074
+ "name": "RequestReaderInput",
1075
+ "value": "'terminalRequestReaderInput'",
1076
+ "tags": [],
1077
+ "docs": ""
1078
+ },
1079
+ {
1080
+ "name": "PaymentStatusChange",
1081
+ "value": "'terminalPaymentStatusChange'",
1082
+ "tags": [],
1083
+ "docs": ""
1084
+ }
1085
+ ]
1086
+ },
1087
+ {
1088
+ "name": "DisconnectReason",
1089
+ "slug": "disconnectreason",
1090
+ "members": [
1091
+ {
1092
+ "name": "Unknown",
1093
+ "value": "'UNKNOWN'",
1094
+ "tags": [],
1095
+ "docs": ""
1096
+ },
1097
+ {
1098
+ "name": "DisconnectRequested",
1099
+ "value": "'DISCONNECT_REQUESTED'",
1100
+ "tags": [],
1101
+ "docs": ""
1102
+ },
1103
+ {
1104
+ "name": "RebootRequested",
1105
+ "value": "'REBOOT_REQUESTED'",
1106
+ "tags": [],
1107
+ "docs": ""
1108
+ },
1109
+ {
1110
+ "name": "SecurityReboot",
1111
+ "value": "'SECURITY_REBOOT'",
1112
+ "tags": [],
1113
+ "docs": ""
1114
+ },
1115
+ {
1116
+ "name": "CriticallyLowBattery",
1117
+ "value": "'CRITICALLY_LOW_BATTERY'",
1118
+ "tags": [],
1119
+ "docs": ""
1120
+ },
1121
+ {
1122
+ "name": "PoweredOff",
1123
+ "value": "'POWERED_OFF'",
1124
+ "tags": [],
1125
+ "docs": ""
1126
+ },
1127
+ {
1128
+ "name": "BluetoothDisabled",
1129
+ "value": "'BLUETOOTH_DISABLED'",
1130
+ "tags": [],
1131
+ "docs": ""
1132
+ }
1133
+ ]
1134
+ },
1135
+ {
1136
+ "name": "ConnectionStatus",
1137
+ "slug": "connectionstatus",
1138
+ "members": [
1139
+ {
1140
+ "name": "Unknown",
1141
+ "value": "'UNKNOWN'",
1142
+ "tags": [],
1143
+ "docs": ""
1144
+ },
1145
+ {
1146
+ "name": "NotConnected",
1147
+ "value": "'NOT_CONNECTED'",
1148
+ "tags": [],
1149
+ "docs": ""
1150
+ },
1151
+ {
1152
+ "name": "Connecting",
1153
+ "value": "'CONNECTING'",
1154
+ "tags": [],
1155
+ "docs": ""
1156
+ },
1157
+ {
1158
+ "name": "Connected",
1159
+ "value": "'CONNECTED'",
1160
+ "tags": [],
1161
+ "docs": ""
1162
+ }
1163
+ ]
1164
+ },
1165
+ {
1166
+ "name": "UpdateTimeEstimate",
1167
+ "slug": "updatetimeestimate",
1168
+ "members": [
1169
+ {
1170
+ "name": "LessThanOneMinute",
1171
+ "value": "'LESS_THAN_ONE_MINUTE'",
1172
+ "tags": [],
1173
+ "docs": ""
1174
+ },
1175
+ {
1176
+ "name": "OneToTwoMinutes",
1177
+ "value": "'ONE_TO_TWO_MINUTES'",
1178
+ "tags": [],
1179
+ "docs": ""
1180
+ },
1181
+ {
1182
+ "name": "TwoToFiveMinutes",
1183
+ "value": "'TWO_TO_FIVE_MINUTES'",
1184
+ "tags": [],
1185
+ "docs": ""
1186
+ },
1187
+ {
1188
+ "name": "FiveToFifteenMinutes",
1189
+ "value": "'FIVE_TO_FIFTEEN_MINUTES'",
1190
+ "tags": [],
1191
+ "docs": ""
1192
+ }
1193
+ ]
1194
+ },
1195
+ {
1196
+ "name": "BatteryStatus",
1197
+ "slug": "batterystatus",
1198
+ "members": [
1199
+ {
1200
+ "name": "Unknown",
1201
+ "value": "'UNKNOWN'",
1202
+ "tags": [],
1203
+ "docs": ""
1204
+ },
1205
+ {
1206
+ "name": "Critical",
1207
+ "value": "'CRITICAL'",
1208
+ "tags": [],
1209
+ "docs": ""
1210
+ },
1211
+ {
1212
+ "name": "Low",
1213
+ "value": "'LOW'",
1214
+ "tags": [],
1215
+ "docs": ""
1216
+ },
1217
+ {
1218
+ "name": "Nominal",
1219
+ "value": "'NOMINAL'",
1220
+ "tags": [],
1221
+ "docs": ""
1222
+ }
1223
+ ]
1224
+ },
1225
+ {
1226
+ "name": "ReaderEvent",
1227
+ "slug": "readerevent",
1228
+ "members": [
1229
+ {
1230
+ "name": "Unknown",
1231
+ "value": "'UNKNOWN'",
1232
+ "tags": [],
1233
+ "docs": ""
1234
+ },
1235
+ {
1236
+ "name": "CardInserted",
1237
+ "value": "'CARD_INSERTED'",
1238
+ "tags": [],
1239
+ "docs": ""
1240
+ },
1241
+ {
1242
+ "name": "CardRemoved",
1243
+ "value": "'CARD_REMOVED'",
1244
+ "tags": [],
1245
+ "docs": ""
1246
+ }
1247
+ ]
1248
+ },
1249
+ {
1250
+ "name": "ReaderDisplayMessage",
1251
+ "slug": "readerdisplaymessage",
1252
+ "members": [
1253
+ {
1254
+ "name": "CheckMobileDevice",
1255
+ "value": "'CHECK_MOBILE_DEVICE'",
1256
+ "tags": [],
1257
+ "docs": ""
1258
+ },
1259
+ {
1260
+ "name": "RetryCard",
1261
+ "value": "'RETRY_CARD'",
1262
+ "tags": [],
1263
+ "docs": ""
1264
+ },
1265
+ {
1266
+ "name": "InsertCard",
1267
+ "value": "'INSERT_CARD'",
1268
+ "tags": [],
1269
+ "docs": ""
1270
+ },
1271
+ {
1272
+ "name": "InsertOrSwipeCard",
1273
+ "value": "'INSERT_OR_SWIPE_CARD'",
1274
+ "tags": [],
1275
+ "docs": ""
1276
+ },
1277
+ {
1278
+ "name": "SwipeCard",
1279
+ "value": "'SWIPE_CARD'",
1280
+ "tags": [],
1281
+ "docs": ""
1282
+ },
1283
+ {
1284
+ "name": "RemoveCard",
1285
+ "value": "'REMOVE_CARD'",
1286
+ "tags": [],
1287
+ "docs": ""
1288
+ },
1289
+ {
1290
+ "name": "MultipleContactlessCardsDetected",
1291
+ "value": "'MULTIPLE_CONTACTLESS_CARDS_DETECTED'",
1292
+ "tags": [],
1293
+ "docs": ""
1294
+ },
1295
+ {
1296
+ "name": "TryAnotherReadMethod",
1297
+ "value": "'TRY_ANOTHER_READ_METHOD'",
1298
+ "tags": [],
1299
+ "docs": ""
1300
+ },
1301
+ {
1302
+ "name": "TryAnotherCard",
1303
+ "value": "'TRY_ANOTHER_CARD'",
1304
+ "tags": [],
1305
+ "docs": ""
1306
+ },
1307
+ {
1308
+ "name": "CardRemovedTooEarly",
1309
+ "value": "'CARD_REMOVED_TOO_EARLY'",
1310
+ "tags": [],
1311
+ "docs": ""
1312
+ }
1313
+ ]
1314
+ },
1315
+ {
1316
+ "name": "ReaderInputOption",
1317
+ "slug": "readerinputoption",
1318
+ "members": [
1319
+ {
1320
+ "name": "None",
1321
+ "value": "'NONE'",
1322
+ "tags": [],
1323
+ "docs": ""
1324
+ },
1325
+ {
1326
+ "name": "Insert",
1327
+ "value": "'INSERT'",
1328
+ "tags": [],
1329
+ "docs": ""
1330
+ },
1331
+ {
1332
+ "name": "Swipe",
1333
+ "value": "'SWIPE'",
1334
+ "tags": [],
1335
+ "docs": ""
1336
+ },
1337
+ {
1338
+ "name": "Tap",
1339
+ "value": "'TAP'",
1340
+ "tags": [],
1341
+ "docs": ""
1342
+ },
1343
+ {
1344
+ "name": "ManualEntry",
1345
+ "value": "'MANUAL_ENTRY'",
1346
+ "tags": [],
1347
+ "docs": ""
1348
+ }
1349
+ ]
1350
+ },
1351
+ {
1352
+ "name": "PaymentStatus",
1353
+ "slug": "paymentstatus",
1354
+ "members": [
1355
+ {
1356
+ "name": "Unknown",
1357
+ "value": "'UNKNOWN'",
1358
+ "tags": [],
1359
+ "docs": ""
1360
+ },
1361
+ {
1362
+ "name": "NotReady",
1363
+ "value": "'NOT_READY'",
1364
+ "tags": [],
1365
+ "docs": ""
1366
+ },
1367
+ {
1368
+ "name": "Ready",
1369
+ "value": "'READY'",
1370
+ "tags": [],
1371
+ "docs": ""
1372
+ },
1373
+ {
1374
+ "name": "WaitingForInput",
1375
+ "value": "'WAITING_FOR_INPUT'",
1376
+ "tags": [],
1377
+ "docs": ""
1378
+ },
1379
+ {
1380
+ "name": "Processing",
1381
+ "value": "'PROCESSING'",
1382
+ "tags": [],
1383
+ "docs": ""
484
1384
  }
485
1385
  ]
486
1386
  }
@@ -496,6 +1396,19 @@
496
1396
  "complexTypes": []
497
1397
  }
498
1398
  ]
1399
+ },
1400
+ {
1401
+ "name": "ReaderSoftwareUpdateInterface",
1402
+ "slug": "readersoftwareupdateinterface",
1403
+ "docs": "",
1404
+ "types": [
1405
+ {
1406
+ "text": "{\n version: string;\n settingsVersion: string;\n requiredAt: number;\n timeEstimate: UpdateTimeEstimate;\n}",
1407
+ "complexTypes": [
1408
+ "UpdateTimeEstimate"
1409
+ ]
1410
+ }
1411
+ ]
499
1412
  }
500
1413
  ],
501
1414
  "pluginConfigs": []