increase 1.233.0 → 1.234.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.
@@ -220,14 +220,72 @@ module Increase
220
220
  )
221
221
  end
222
222
 
223
+ # A unique identifier assigned by the Access Control Server (us) for this
224
+ # transaction.
225
+ sig { returns(String) }
226
+ attr_accessor :access_control_server_transaction_id
227
+
223
228
  # The identifier of the Account the card belongs to.
224
229
  sig { returns(String) }
225
230
  attr_accessor :account_id
226
231
 
227
- # The identifier of the Card that is being tokenized.
232
+ # The city of the cardholder billing address associated with the card used for
233
+ # this purchase.
234
+ sig { returns(T.nilable(String)) }
235
+ attr_accessor :billing_address_city
236
+
237
+ # The country of the cardholder billing address associated with the card used for
238
+ # this purchase.
239
+ sig { returns(T.nilable(String)) }
240
+ attr_accessor :billing_address_country
241
+
242
+ # The first line of the cardholder billing address associated with the card used
243
+ # for this purchase.
244
+ sig { returns(T.nilable(String)) }
245
+ attr_accessor :billing_address_line1
246
+
247
+ # The second line of the cardholder billing address associated with the card used
248
+ # for this purchase.
249
+ sig { returns(T.nilable(String)) }
250
+ attr_accessor :billing_address_line2
251
+
252
+ # The third line of the cardholder billing address associated with the card used
253
+ # for this purchase.
254
+ sig { returns(T.nilable(String)) }
255
+ attr_accessor :billing_address_line3
256
+
257
+ # The postal code of the cardholder billing address associated with the card used
258
+ # for this purchase.
259
+ sig { returns(T.nilable(String)) }
260
+ attr_accessor :billing_address_postal_code
261
+
262
+ # The US state of the cardholder billing address associated with the card used for
263
+ # this purchase.
264
+ sig { returns(T.nilable(String)) }
265
+ attr_accessor :billing_address_state
266
+
267
+ # The identifier of the Card.
228
268
  sig { returns(String) }
229
269
  attr_accessor :card_id
230
270
 
271
+ # The email address of the cardholder.
272
+ sig { returns(T.nilable(String)) }
273
+ attr_accessor :cardholder_email
274
+
275
+ # The name of the cardholder.
276
+ sig { returns(T.nilable(String)) }
277
+ attr_accessor :cardholder_name
278
+
279
+ # The category of the card authentication attempt.
280
+ sig do
281
+ returns(
282
+ T.nilable(
283
+ Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
284
+ )
285
+ )
286
+ end
287
+ attr_accessor :category
288
+
231
289
  # Whether or not the authentication attempt was approved.
232
290
  sig do
233
291
  returns(
@@ -238,6 +296,129 @@ module Increase
238
296
  end
239
297
  attr_accessor :decision
240
298
 
299
+ # The device channel of the card authentication attempt.
300
+ sig do
301
+ returns(Increase::RealTimeDecision::CardAuthentication::DeviceChannel)
302
+ end
303
+ attr_reader :device_channel
304
+
305
+ sig do
306
+ params(
307
+ device_channel:
308
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::OrHash
309
+ ).void
310
+ end
311
+ attr_writer :device_channel
312
+
313
+ # A unique identifier assigned by the Directory Server (the card network) for this
314
+ # transaction.
315
+ sig { returns(String) }
316
+ attr_accessor :directory_server_transaction_id
317
+
318
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
319
+ # is transacting with.
320
+ sig { returns(String) }
321
+ attr_accessor :merchant_acceptor_id
322
+
323
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
324
+ # card is transacting with.
325
+ sig { returns(String) }
326
+ attr_accessor :merchant_category_code
327
+
328
+ # The country the merchant resides in.
329
+ sig { returns(String) }
330
+ attr_accessor :merchant_country
331
+
332
+ # The name of the merchant.
333
+ sig { returns(String) }
334
+ attr_accessor :merchant_name
335
+
336
+ # The ID of a prior Card Authentication that the requestor used to authenticate
337
+ # this cardholder for a previous transaction.
338
+ sig { returns(T.nilable(String)) }
339
+ attr_accessor :prior_card_authentication_id
340
+
341
+ # The purchase amount in minor units.
342
+ sig { returns(T.nilable(Integer)) }
343
+ attr_accessor :purchase_amount
344
+
345
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
346
+ # authentication attempt's purchase currency.
347
+ sig { returns(T.nilable(String)) }
348
+ attr_accessor :purchase_currency
349
+
350
+ # The 3DS requestor authentication indicator describes why the authentication
351
+ # attempt is performed, such as for a recurring transaction.
352
+ sig do
353
+ returns(
354
+ T.nilable(
355
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
356
+ )
357
+ )
358
+ end
359
+ attr_accessor :requestor_authentication_indicator
360
+
361
+ # Indicates whether a challenge is requested for this transaction.
362
+ sig do
363
+ returns(
364
+ T.nilable(
365
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
366
+ )
367
+ )
368
+ end
369
+ attr_accessor :requestor_challenge_indicator
370
+
371
+ # The name of the 3DS requestor.
372
+ sig { returns(String) }
373
+ attr_accessor :requestor_name
374
+
375
+ # The URL of the 3DS requestor.
376
+ sig { returns(String) }
377
+ attr_accessor :requestor_url
378
+
379
+ # The city of the shipping address associated with this purchase.
380
+ sig { returns(T.nilable(String)) }
381
+ attr_accessor :shipping_address_city
382
+
383
+ # The country of the shipping address associated with this purchase.
384
+ sig { returns(T.nilable(String)) }
385
+ attr_accessor :shipping_address_country
386
+
387
+ # The first line of the shipping address associated with this purchase.
388
+ sig { returns(T.nilable(String)) }
389
+ attr_accessor :shipping_address_line1
390
+
391
+ # The second line of the shipping address associated with this purchase.
392
+ sig { returns(T.nilable(String)) }
393
+ attr_accessor :shipping_address_line2
394
+
395
+ # The third line of the shipping address associated with this purchase.
396
+ sig { returns(T.nilable(String)) }
397
+ attr_accessor :shipping_address_line3
398
+
399
+ # The postal code of the shipping address associated with this purchase.
400
+ sig { returns(T.nilable(String)) }
401
+ attr_accessor :shipping_address_postal_code
402
+
403
+ # The US state of the shipping address associated with this purchase.
404
+ sig { returns(T.nilable(String)) }
405
+ attr_accessor :shipping_address_state
406
+
407
+ # A unique identifier assigned by the 3DS Server initiating the authentication
408
+ # attempt for this transaction.
409
+ sig { returns(String) }
410
+ attr_accessor :three_d_secure_server_transaction_id
411
+
412
+ # The type of transaction being authenticated.
413
+ sig do
414
+ returns(
415
+ T.nilable(
416
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
417
+ )
418
+ )
419
+ end
420
+ attr_accessor :transaction_type
421
+
241
422
  # The identifier of the Card Payment this authentication attempt will belong to.
242
423
  # Available in the API once the card authentication has completed.
243
424
  sig { returns(String) }
@@ -246,22 +427,149 @@ module Increase
246
427
  # Fields related to a 3DS authentication attempt.
247
428
  sig do
248
429
  params(
430
+ access_control_server_transaction_id: String,
249
431
  account_id: String,
432
+ billing_address_city: T.nilable(String),
433
+ billing_address_country: T.nilable(String),
434
+ billing_address_line1: T.nilable(String),
435
+ billing_address_line2: T.nilable(String),
436
+ billing_address_line3: T.nilable(String),
437
+ billing_address_postal_code: T.nilable(String),
438
+ billing_address_state: T.nilable(String),
250
439
  card_id: String,
440
+ cardholder_email: T.nilable(String),
441
+ cardholder_name: T.nilable(String),
442
+ category:
443
+ T.nilable(
444
+ Increase::RealTimeDecision::CardAuthentication::Category::OrSymbol
445
+ ),
251
446
  decision:
252
447
  T.nilable(
253
448
  Increase::RealTimeDecision::CardAuthentication::Decision::OrSymbol
254
449
  ),
450
+ device_channel:
451
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::OrHash,
452
+ directory_server_transaction_id: String,
453
+ merchant_acceptor_id: String,
454
+ merchant_category_code: String,
455
+ merchant_country: String,
456
+ merchant_name: String,
457
+ prior_card_authentication_id: T.nilable(String),
458
+ purchase_amount: T.nilable(Integer),
459
+ purchase_currency: T.nilable(String),
460
+ requestor_authentication_indicator:
461
+ T.nilable(
462
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::OrSymbol
463
+ ),
464
+ requestor_challenge_indicator:
465
+ T.nilable(
466
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::OrSymbol
467
+ ),
468
+ requestor_name: String,
469
+ requestor_url: String,
470
+ shipping_address_city: T.nilable(String),
471
+ shipping_address_country: T.nilable(String),
472
+ shipping_address_line1: T.nilable(String),
473
+ shipping_address_line2: T.nilable(String),
474
+ shipping_address_line3: T.nilable(String),
475
+ shipping_address_postal_code: T.nilable(String),
476
+ shipping_address_state: T.nilable(String),
477
+ three_d_secure_server_transaction_id: String,
478
+ transaction_type:
479
+ T.nilable(
480
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::OrSymbol
481
+ ),
255
482
  upcoming_card_payment_id: String
256
483
  ).returns(T.attached_class)
257
484
  end
258
485
  def self.new(
486
+ # A unique identifier assigned by the Access Control Server (us) for this
487
+ # transaction.
488
+ access_control_server_transaction_id:,
259
489
  # The identifier of the Account the card belongs to.
260
490
  account_id:,
261
- # The identifier of the Card that is being tokenized.
491
+ # The city of the cardholder billing address associated with the card used for
492
+ # this purchase.
493
+ billing_address_city:,
494
+ # The country of the cardholder billing address associated with the card used for
495
+ # this purchase.
496
+ billing_address_country:,
497
+ # The first line of the cardholder billing address associated with the card used
498
+ # for this purchase.
499
+ billing_address_line1:,
500
+ # The second line of the cardholder billing address associated with the card used
501
+ # for this purchase.
502
+ billing_address_line2:,
503
+ # The third line of the cardholder billing address associated with the card used
504
+ # for this purchase.
505
+ billing_address_line3:,
506
+ # The postal code of the cardholder billing address associated with the card used
507
+ # for this purchase.
508
+ billing_address_postal_code:,
509
+ # The US state of the cardholder billing address associated with the card used for
510
+ # this purchase.
511
+ billing_address_state:,
512
+ # The identifier of the Card.
262
513
  card_id:,
514
+ # The email address of the cardholder.
515
+ cardholder_email:,
516
+ # The name of the cardholder.
517
+ cardholder_name:,
518
+ # The category of the card authentication attempt.
519
+ category:,
263
520
  # Whether or not the authentication attempt was approved.
264
521
  decision:,
522
+ # The device channel of the card authentication attempt.
523
+ device_channel:,
524
+ # A unique identifier assigned by the Directory Server (the card network) for this
525
+ # transaction.
526
+ directory_server_transaction_id:,
527
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
528
+ # is transacting with.
529
+ merchant_acceptor_id:,
530
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
531
+ # card is transacting with.
532
+ merchant_category_code:,
533
+ # The country the merchant resides in.
534
+ merchant_country:,
535
+ # The name of the merchant.
536
+ merchant_name:,
537
+ # The ID of a prior Card Authentication that the requestor used to authenticate
538
+ # this cardholder for a previous transaction.
539
+ prior_card_authentication_id:,
540
+ # The purchase amount in minor units.
541
+ purchase_amount:,
542
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
543
+ # authentication attempt's purchase currency.
544
+ purchase_currency:,
545
+ # The 3DS requestor authentication indicator describes why the authentication
546
+ # attempt is performed, such as for a recurring transaction.
547
+ requestor_authentication_indicator:,
548
+ # Indicates whether a challenge is requested for this transaction.
549
+ requestor_challenge_indicator:,
550
+ # The name of the 3DS requestor.
551
+ requestor_name:,
552
+ # The URL of the 3DS requestor.
553
+ requestor_url:,
554
+ # The city of the shipping address associated with this purchase.
555
+ shipping_address_city:,
556
+ # The country of the shipping address associated with this purchase.
557
+ shipping_address_country:,
558
+ # The first line of the shipping address associated with this purchase.
559
+ shipping_address_line1:,
560
+ # The second line of the shipping address associated with this purchase.
561
+ shipping_address_line2:,
562
+ # The third line of the shipping address associated with this purchase.
563
+ shipping_address_line3:,
564
+ # The postal code of the shipping address associated with this purchase.
565
+ shipping_address_postal_code:,
566
+ # The US state of the shipping address associated with this purchase.
567
+ shipping_address_state:,
568
+ # A unique identifier assigned by the 3DS Server initiating the authentication
569
+ # attempt for this transaction.
570
+ three_d_secure_server_transaction_id:,
571
+ # The type of transaction being authenticated.
572
+ transaction_type:,
265
573
  # The identifier of the Card Payment this authentication attempt will belong to.
266
574
  # Available in the API once the card authentication has completed.
267
575
  upcoming_card_payment_id:
@@ -271,12 +579,58 @@ module Increase
271
579
  sig do
272
580
  override.returns(
273
581
  {
582
+ access_control_server_transaction_id: String,
274
583
  account_id: String,
584
+ billing_address_city: T.nilable(String),
585
+ billing_address_country: T.nilable(String),
586
+ billing_address_line1: T.nilable(String),
587
+ billing_address_line2: T.nilable(String),
588
+ billing_address_line3: T.nilable(String),
589
+ billing_address_postal_code: T.nilable(String),
590
+ billing_address_state: T.nilable(String),
275
591
  card_id: String,
592
+ cardholder_email: T.nilable(String),
593
+ cardholder_name: T.nilable(String),
594
+ category:
595
+ T.nilable(
596
+ Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
597
+ ),
276
598
  decision:
277
599
  T.nilable(
278
600
  Increase::RealTimeDecision::CardAuthentication::Decision::TaggedSymbol
279
601
  ),
602
+ device_channel:
603
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel,
604
+ directory_server_transaction_id: String,
605
+ merchant_acceptor_id: String,
606
+ merchant_category_code: String,
607
+ merchant_country: String,
608
+ merchant_name: String,
609
+ prior_card_authentication_id: T.nilable(String),
610
+ purchase_amount: T.nilable(Integer),
611
+ purchase_currency: T.nilable(String),
612
+ requestor_authentication_indicator:
613
+ T.nilable(
614
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
615
+ ),
616
+ requestor_challenge_indicator:
617
+ T.nilable(
618
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
619
+ ),
620
+ requestor_name: String,
621
+ requestor_url: String,
622
+ shipping_address_city: T.nilable(String),
623
+ shipping_address_country: T.nilable(String),
624
+ shipping_address_line1: T.nilable(String),
625
+ shipping_address_line2: T.nilable(String),
626
+ shipping_address_line3: T.nilable(String),
627
+ shipping_address_postal_code: T.nilable(String),
628
+ shipping_address_state: T.nilable(String),
629
+ three_d_secure_server_transaction_id: String,
630
+ transaction_type:
631
+ T.nilable(
632
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
633
+ ),
280
634
  upcoming_card_payment_id: String
281
635
  }
282
636
  )
@@ -284,6 +638,44 @@ module Increase
284
638
  def to_hash
285
639
  end
286
640
 
641
+ # The category of the card authentication attempt.
642
+ module Category
643
+ extend Increase::Internal::Type::Enum
644
+
645
+ TaggedSymbol =
646
+ T.type_alias do
647
+ T.all(
648
+ Symbol,
649
+ Increase::RealTimeDecision::CardAuthentication::Category
650
+ )
651
+ end
652
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
653
+
654
+ # The authentication attempt is for a payment.
655
+ PAYMENT_AUTHENTICATION =
656
+ T.let(
657
+ :payment_authentication,
658
+ Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
659
+ )
660
+
661
+ # The authentication attempt is not for a payment.
662
+ NON_PAYMENT_AUTHENTICATION =
663
+ T.let(
664
+ :non_payment_authentication,
665
+ Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
666
+ )
667
+
668
+ sig do
669
+ override.returns(
670
+ T::Array[
671
+ Increase::RealTimeDecision::CardAuthentication::Category::TaggedSymbol
672
+ ]
673
+ )
674
+ end
675
+ def self.values
676
+ end
677
+ end
678
+
287
679
  # Whether or not the authentication attempt was approved.
288
680
  module Decision
289
681
  extend Increase::Internal::Type::Enum
@@ -328,6 +720,690 @@ module Increase
328
720
  def self.values
329
721
  end
330
722
  end
723
+
724
+ class DeviceChannel < Increase::Internal::Type::BaseModel
725
+ OrHash =
726
+ T.type_alias do
727
+ T.any(
728
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel,
729
+ Increase::Internal::AnyHash
730
+ )
731
+ end
732
+
733
+ # Fields specific to the browser device channel.
734
+ sig do
735
+ returns(
736
+ T.nilable(
737
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser
738
+ )
739
+ )
740
+ end
741
+ attr_reader :browser
742
+
743
+ sig do
744
+ params(
745
+ browser:
746
+ T.nilable(
747
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::OrHash
748
+ )
749
+ ).void
750
+ end
751
+ attr_writer :browser
752
+
753
+ # The category of the device channel.
754
+ sig do
755
+ returns(
756
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol
757
+ )
758
+ end
759
+ attr_accessor :category
760
+
761
+ # Fields specific to merchant initiated transactions.
762
+ sig do
763
+ returns(
764
+ T.nilable(
765
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated
766
+ )
767
+ )
768
+ end
769
+ attr_reader :merchant_initiated
770
+
771
+ sig do
772
+ params(
773
+ merchant_initiated:
774
+ T.nilable(
775
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::OrHash
776
+ )
777
+ ).void
778
+ end
779
+ attr_writer :merchant_initiated
780
+
781
+ # The device channel of the card authentication attempt.
782
+ sig do
783
+ params(
784
+ browser:
785
+ T.nilable(
786
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::OrHash
787
+ ),
788
+ category:
789
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::OrSymbol,
790
+ merchant_initiated:
791
+ T.nilable(
792
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::OrHash
793
+ )
794
+ ).returns(T.attached_class)
795
+ end
796
+ def self.new(
797
+ # Fields specific to the browser device channel.
798
+ browser:,
799
+ # The category of the device channel.
800
+ category:,
801
+ # Fields specific to merchant initiated transactions.
802
+ merchant_initiated:
803
+ )
804
+ end
805
+
806
+ sig do
807
+ override.returns(
808
+ {
809
+ browser:
810
+ T.nilable(
811
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser
812
+ ),
813
+ category:
814
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol,
815
+ merchant_initiated:
816
+ T.nilable(
817
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated
818
+ )
819
+ }
820
+ )
821
+ end
822
+ def to_hash
823
+ end
824
+
825
+ class Browser < Increase::Internal::Type::BaseModel
826
+ OrHash =
827
+ T.type_alias do
828
+ T.any(
829
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser,
830
+ Increase::Internal::AnyHash
831
+ )
832
+ end
833
+
834
+ # The accept header from the cardholder's browser.
835
+ sig { returns(T.nilable(String)) }
836
+ attr_accessor :accept_header
837
+
838
+ # The IP address of the cardholder's browser.
839
+ sig { returns(T.nilable(String)) }
840
+ attr_accessor :ip_address
841
+
842
+ # Whether JavaScript is enabled in the cardholder's browser.
843
+ sig do
844
+ returns(
845
+ T.nilable(
846
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::TaggedSymbol
847
+ )
848
+ )
849
+ end
850
+ attr_accessor :javascript_enabled
851
+
852
+ # The language of the cardholder's browser.
853
+ sig { returns(T.nilable(String)) }
854
+ attr_accessor :language
855
+
856
+ # The user agent of the cardholder's browser.
857
+ sig { returns(T.nilable(String)) }
858
+ attr_accessor :user_agent
859
+
860
+ # Fields specific to the browser device channel.
861
+ sig do
862
+ params(
863
+ accept_header: T.nilable(String),
864
+ ip_address: T.nilable(String),
865
+ javascript_enabled:
866
+ T.nilable(
867
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::OrSymbol
868
+ ),
869
+ language: T.nilable(String),
870
+ user_agent: T.nilable(String)
871
+ ).returns(T.attached_class)
872
+ end
873
+ def self.new(
874
+ # The accept header from the cardholder's browser.
875
+ accept_header:,
876
+ # The IP address of the cardholder's browser.
877
+ ip_address:,
878
+ # Whether JavaScript is enabled in the cardholder's browser.
879
+ javascript_enabled:,
880
+ # The language of the cardholder's browser.
881
+ language:,
882
+ # The user agent of the cardholder's browser.
883
+ user_agent:
884
+ )
885
+ end
886
+
887
+ sig do
888
+ override.returns(
889
+ {
890
+ accept_header: T.nilable(String),
891
+ ip_address: T.nilable(String),
892
+ javascript_enabled:
893
+ T.nilable(
894
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::TaggedSymbol
895
+ ),
896
+ language: T.nilable(String),
897
+ user_agent: T.nilable(String)
898
+ }
899
+ )
900
+ end
901
+ def to_hash
902
+ end
903
+
904
+ # Whether JavaScript is enabled in the cardholder's browser.
905
+ module JavascriptEnabled
906
+ extend Increase::Internal::Type::Enum
907
+
908
+ TaggedSymbol =
909
+ T.type_alias do
910
+ T.all(
911
+ Symbol,
912
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled
913
+ )
914
+ end
915
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
916
+
917
+ # JavaScript is enabled in the cardholder's browser.
918
+ ENABLED =
919
+ T.let(
920
+ :enabled,
921
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::TaggedSymbol
922
+ )
923
+
924
+ # JavaScript is not enabled in the cardholder's browser.
925
+ DISABLED =
926
+ T.let(
927
+ :disabled,
928
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::TaggedSymbol
929
+ )
930
+
931
+ sig do
932
+ override.returns(
933
+ T::Array[
934
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled::TaggedSymbol
935
+ ]
936
+ )
937
+ end
938
+ def self.values
939
+ end
940
+ end
941
+ end
942
+
943
+ # The category of the device channel.
944
+ module Category
945
+ extend Increase::Internal::Type::Enum
946
+
947
+ TaggedSymbol =
948
+ T.type_alias do
949
+ T.all(
950
+ Symbol,
951
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category
952
+ )
953
+ end
954
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
955
+
956
+ # The authentication attempt was made from an app.
957
+ APP =
958
+ T.let(
959
+ :app,
960
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol
961
+ )
962
+
963
+ # The authentication attempt was made from a browser.
964
+ BROWSER =
965
+ T.let(
966
+ :browser,
967
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol
968
+ )
969
+
970
+ # The authentication attempt was initiated by the 3DS Requestor.
971
+ THREE_DS_REQUESTOR_INITIATED =
972
+ T.let(
973
+ :three_ds_requestor_initiated,
974
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol
975
+ )
976
+
977
+ sig do
978
+ override.returns(
979
+ T::Array[
980
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category::TaggedSymbol
981
+ ]
982
+ )
983
+ end
984
+ def self.values
985
+ end
986
+ end
987
+
988
+ class MerchantInitiated < Increase::Internal::Type::BaseModel
989
+ OrHash =
990
+ T.type_alias do
991
+ T.any(
992
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated,
993
+ Increase::Internal::AnyHash
994
+ )
995
+ end
996
+
997
+ # The merchant initiated indicator for the transaction.
998
+ sig do
999
+ returns(
1000
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1001
+ )
1002
+ end
1003
+ attr_accessor :indicator
1004
+
1005
+ # Fields specific to merchant initiated transactions.
1006
+ sig do
1007
+ params(
1008
+ indicator:
1009
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::OrSymbol
1010
+ ).returns(T.attached_class)
1011
+ end
1012
+ def self.new(
1013
+ # The merchant initiated indicator for the transaction.
1014
+ indicator:
1015
+ )
1016
+ end
1017
+
1018
+ sig do
1019
+ override.returns(
1020
+ {
1021
+ indicator:
1022
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1023
+ }
1024
+ )
1025
+ end
1026
+ def to_hash
1027
+ end
1028
+
1029
+ # The merchant initiated indicator for the transaction.
1030
+ module Indicator
1031
+ extend Increase::Internal::Type::Enum
1032
+
1033
+ TaggedSymbol =
1034
+ T.type_alias do
1035
+ T.all(
1036
+ Symbol,
1037
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator
1038
+ )
1039
+ end
1040
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1041
+
1042
+ # Recurring transaction.
1043
+ RECURRING_TRANSACTION =
1044
+ T.let(
1045
+ :recurring_transaction,
1046
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1047
+ )
1048
+
1049
+ # Installment transaction.
1050
+ INSTALLMENT_TRANSACTION =
1051
+ T.let(
1052
+ :installment_transaction,
1053
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1054
+ )
1055
+
1056
+ # Add card.
1057
+ ADD_CARD =
1058
+ T.let(
1059
+ :add_card,
1060
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1061
+ )
1062
+
1063
+ # Maintain card information.
1064
+ MAINTAIN_CARD_INFORMATION =
1065
+ T.let(
1066
+ :maintain_card_information,
1067
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1068
+ )
1069
+
1070
+ # Account verification.
1071
+ ACCOUNT_VERIFICATION =
1072
+ T.let(
1073
+ :account_verification,
1074
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1075
+ )
1076
+
1077
+ # Split or delayed shipment.
1078
+ SPLIT_DELAYED_SHIPMENT =
1079
+ T.let(
1080
+ :split_delayed_shipment,
1081
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1082
+ )
1083
+
1084
+ # Top up.
1085
+ TOP_UP =
1086
+ T.let(
1087
+ :top_up,
1088
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1089
+ )
1090
+
1091
+ # Mail order.
1092
+ MAIL_ORDER =
1093
+ T.let(
1094
+ :mail_order,
1095
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1096
+ )
1097
+
1098
+ # Telephone order.
1099
+ TELEPHONE_ORDER =
1100
+ T.let(
1101
+ :telephone_order,
1102
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1103
+ )
1104
+
1105
+ # Whitelist status check.
1106
+ WHITELIST_STATUS_CHECK =
1107
+ T.let(
1108
+ :whitelist_status_check,
1109
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1110
+ )
1111
+
1112
+ # Other payment.
1113
+ OTHER_PAYMENT =
1114
+ T.let(
1115
+ :other_payment,
1116
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1117
+ )
1118
+
1119
+ # Billing agreement.
1120
+ BILLING_AGREEMENT =
1121
+ T.let(
1122
+ :billing_agreement,
1123
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1124
+ )
1125
+
1126
+ # Device binding status check.
1127
+ DEVICE_BINDING_STATUS_CHECK =
1128
+ T.let(
1129
+ :device_binding_status_check,
1130
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1131
+ )
1132
+
1133
+ # Card security code status check.
1134
+ CARD_SECURITY_CODE_STATUS_CHECK =
1135
+ T.let(
1136
+ :card_security_code_status_check,
1137
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1138
+ )
1139
+
1140
+ # Delayed shipment.
1141
+ DELAYED_SHIPMENT =
1142
+ T.let(
1143
+ :delayed_shipment,
1144
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1145
+ )
1146
+
1147
+ # Split payment.
1148
+ SPLIT_PAYMENT =
1149
+ T.let(
1150
+ :split_payment,
1151
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1152
+ )
1153
+
1154
+ # FIDO credential deletion.
1155
+ FIDO_CREDENTIAL_DELETION =
1156
+ T.let(
1157
+ :fido_credential_deletion,
1158
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1159
+ )
1160
+
1161
+ # FIDO credential registration.
1162
+ FIDO_CREDENTIAL_REGISTRATION =
1163
+ T.let(
1164
+ :fido_credential_registration,
1165
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1166
+ )
1167
+
1168
+ # Decoupled authentication fallback.
1169
+ DECOUPLED_AUTHENTICATION_FALLBACK =
1170
+ T.let(
1171
+ :decoupled_authentication_fallback,
1172
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1173
+ )
1174
+
1175
+ sig do
1176
+ override.returns(
1177
+ T::Array[
1178
+ Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator::TaggedSymbol
1179
+ ]
1180
+ )
1181
+ end
1182
+ def self.values
1183
+ end
1184
+ end
1185
+ end
1186
+ end
1187
+
1188
+ # The 3DS requestor authentication indicator describes why the authentication
1189
+ # attempt is performed, such as for a recurring transaction.
1190
+ module RequestorAuthenticationIndicator
1191
+ extend Increase::Internal::Type::Enum
1192
+
1193
+ TaggedSymbol =
1194
+ T.type_alias do
1195
+ T.all(
1196
+ Symbol,
1197
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator
1198
+ )
1199
+ end
1200
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1201
+
1202
+ # The authentication is for a payment transaction.
1203
+ PAYMENT_TRANSACTION =
1204
+ T.let(
1205
+ :payment_transaction,
1206
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1207
+ )
1208
+
1209
+ # The authentication is for a recurring transaction.
1210
+ RECURRING_TRANSACTION =
1211
+ T.let(
1212
+ :recurring_transaction,
1213
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1214
+ )
1215
+
1216
+ # The authentication is for an installment transaction.
1217
+ INSTALLMENT_TRANSACTION =
1218
+ T.let(
1219
+ :installment_transaction,
1220
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1221
+ )
1222
+
1223
+ # The authentication is for adding a card.
1224
+ ADD_CARD =
1225
+ T.let(
1226
+ :add_card,
1227
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1228
+ )
1229
+
1230
+ # The authentication is for maintaining a card.
1231
+ MAINTAIN_CARD =
1232
+ T.let(
1233
+ :maintain_card,
1234
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1235
+ )
1236
+
1237
+ # The authentication is for EMV token cardholder verification.
1238
+ EMV_TOKEN_CARDHOLDER_VERIFICATION =
1239
+ T.let(
1240
+ :emv_token_cardholder_verification,
1241
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1242
+ )
1243
+
1244
+ # The authentication is for a billing agreement.
1245
+ BILLING_AGREEMENT =
1246
+ T.let(
1247
+ :billing_agreement,
1248
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1249
+ )
1250
+
1251
+ sig do
1252
+ override.returns(
1253
+ T::Array[
1254
+ Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1255
+ ]
1256
+ )
1257
+ end
1258
+ def self.values
1259
+ end
1260
+ end
1261
+
1262
+ # Indicates whether a challenge is requested for this transaction.
1263
+ module RequestorChallengeIndicator
1264
+ extend Increase::Internal::Type::Enum
1265
+
1266
+ TaggedSymbol =
1267
+ T.type_alias do
1268
+ T.all(
1269
+ Symbol,
1270
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator
1271
+ )
1272
+ end
1273
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1274
+
1275
+ # No preference.
1276
+ NO_PREFERENCE =
1277
+ T.let(
1278
+ :no_preference,
1279
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1280
+ )
1281
+
1282
+ # No challenge requested.
1283
+ NO_CHALLENGE_REQUESTED =
1284
+ T.let(
1285
+ :no_challenge_requested,
1286
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1287
+ )
1288
+
1289
+ # Challenge requested, 3DS Requestor preference.
1290
+ CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE =
1291
+ T.let(
1292
+ :challenge_requested_3ds_requestor_preference,
1293
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1294
+ )
1295
+
1296
+ # Challenge requested, mandate.
1297
+ CHALLENGE_REQUESTED_MANDATE =
1298
+ T.let(
1299
+ :challenge_requested_mandate,
1300
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1301
+ )
1302
+
1303
+ # No challenge requested, transactional risk analysis already performed.
1304
+ NO_CHALLENGE_REQUESTED_TRANSACTIONAL_RISK_ANALYSIS_ALREADY_PERFORMED =
1305
+ T.let(
1306
+ :no_challenge_requested_transactional_risk_analysis_already_performed,
1307
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1308
+ )
1309
+
1310
+ # No challenge requested, data share only.
1311
+ NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY =
1312
+ T.let(
1313
+ :no_challenge_requested_data_share_only,
1314
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1315
+ )
1316
+
1317
+ # No challenge requested, strong consumer authentication already performed.
1318
+ NO_CHALLENGE_REQUESTED_STRONG_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED =
1319
+ T.let(
1320
+ :no_challenge_requested_strong_consumer_authentication_already_performed,
1321
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1322
+ )
1323
+
1324
+ # No challenge requested, utilize whitelist exemption if no challenge required.
1325
+ NO_CHALLENGE_REQUESTED_UTILIZE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED =
1326
+ T.let(
1327
+ :no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required,
1328
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1329
+ )
1330
+
1331
+ # Challenge requested, whitelist prompt requested if challenge required.
1332
+ CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED =
1333
+ T.let(
1334
+ :challenge_requested_whitelist_prompt_requested_if_challenge_required,
1335
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1336
+ )
1337
+
1338
+ sig do
1339
+ override.returns(
1340
+ T::Array[
1341
+ Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1342
+ ]
1343
+ )
1344
+ end
1345
+ def self.values
1346
+ end
1347
+ end
1348
+
1349
+ # The type of transaction being authenticated.
1350
+ module TransactionType
1351
+ extend Increase::Internal::Type::Enum
1352
+
1353
+ TaggedSymbol =
1354
+ T.type_alias do
1355
+ T.all(
1356
+ Symbol,
1357
+ Increase::RealTimeDecision::CardAuthentication::TransactionType
1358
+ )
1359
+ end
1360
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1361
+
1362
+ # Purchase of goods or services.
1363
+ GOODS_SERVICE_PURCHASE =
1364
+ T.let(
1365
+ :goods_service_purchase,
1366
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1367
+ )
1368
+
1369
+ # Check acceptance.
1370
+ CHECK_ACCEPTANCE =
1371
+ T.let(
1372
+ :check_acceptance,
1373
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1374
+ )
1375
+
1376
+ # Account funding.
1377
+ ACCOUNT_FUNDING =
1378
+ T.let(
1379
+ :account_funding,
1380
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1381
+ )
1382
+
1383
+ # Quasi-cash transaction.
1384
+ QUASI_CASH_TRANSACTION =
1385
+ T.let(
1386
+ :quasi_cash_transaction,
1387
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1388
+ )
1389
+
1390
+ # Prepaid activation and load.
1391
+ PREPAID_ACTIVATION_AND_LOAD =
1392
+ T.let(
1393
+ :prepaid_activation_and_load,
1394
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1395
+ )
1396
+
1397
+ sig do
1398
+ override.returns(
1399
+ T::Array[
1400
+ Increase::RealTimeDecision::CardAuthentication::TransactionType::TaggedSymbol
1401
+ ]
1402
+ )
1403
+ end
1404
+ def self.values
1405
+ end
1406
+ end
331
1407
  end
332
1408
 
333
1409
  class CardAuthenticationChallenge < Increase::Internal::Type::BaseModel