increase 1.351.0 → 1.352.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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_statement.rb +12 -4
  4. data/lib/increase/models/balance_lookup.rb +1 -59
  5. data/lib/increase/models/entity_create_params.rb +33 -20
  6. data/lib/increase/models/entity_update_params.rb +33 -20
  7. data/lib/increase/models/event.rb +12 -0
  8. data/lib/increase/models/event_list_params.rb +12 -0
  9. data/lib/increase/models/event_subscription.rb +12 -0
  10. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  11. data/lib/increase/models/inbound_ach_transfer.rb +9 -1
  12. data/lib/increase/models/pending_transaction.rb +121 -1
  13. data/lib/increase/models/pending_transaction_list_params.rb +6 -0
  14. data/lib/increase/models/simulations/physical_card_create_params.rb +9 -6
  15. data/lib/increase/models/transaction.rb +103 -1
  16. data/lib/increase/models/transaction_list_params.rb +6 -0
  17. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  18. data/lib/increase/resources/simulations/account_statements.rb +2 -1
  19. data/lib/increase/resources/simulations/physical_cards.rb +5 -3
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/account_statement.rbi +12 -4
  22. data/rbi/increase/models/balance_lookup.rbi +3 -87
  23. data/rbi/increase/models/entity_create_params.rbi +39 -21
  24. data/rbi/increase/models/entity_update_params.rbi +39 -21
  25. data/rbi/increase/models/event.rbi +28 -0
  26. data/rbi/increase/models/event_list_params.rbi +28 -0
  27. data/rbi/increase/models/event_subscription.rbi +28 -0
  28. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  29. data/rbi/increase/models/inbound_ach_transfer.rbi +8 -0
  30. data/rbi/increase/models/pending_transaction.rbi +254 -0
  31. data/rbi/increase/models/pending_transaction_list_params.rbi +14 -0
  32. data/rbi/increase/models/simulations/physical_card_create_params.rbi +8 -6
  33. data/rbi/increase/models/transaction.rbi +178 -0
  34. data/rbi/increase/models/transaction_list_params.rbi +14 -0
  35. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  36. data/rbi/increase/resources/simulations/account_statements.rbi +2 -1
  37. data/rbi/increase/resources/simulations/physical_cards.rbi +4 -3
  38. data/sig/increase/models/balance_lookup.rbs +3 -42
  39. data/sig/increase/models/entity_create_params.rbs +20 -11
  40. data/sig/increase/models/entity_update_params.rbs +20 -11
  41. data/sig/increase/models/event.rbs +16 -0
  42. data/sig/increase/models/event_list_params.rbs +16 -0
  43. data/sig/increase/models/event_subscription.rbs +16 -0
  44. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  45. data/sig/increase/models/inbound_ach_transfer.rbs +5 -0
  46. data/sig/increase/models/pending_transaction.rbs +84 -0
  47. data/sig/increase/models/pending_transaction_list_params.rbs +8 -0
  48. data/sig/increase/models/transaction.rbs +50 -0
  49. data/sig/increase/models/transaction_list_params.rbs +8 -0
  50. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  51. metadata +2 -2
@@ -842,6 +842,20 @@ module Increase
842
842
  Increase::Event::Category::TaggedSymbol
843
843
  )
844
844
 
845
+ # Occurs whenever a SEPA Instant Transfer is created.
846
+ SEPA_INSTANT_TRANSFER_CREATED =
847
+ T.let(
848
+ :"sepa_instant_transfer.created",
849
+ Increase::Event::Category::TaggedSymbol
850
+ )
851
+
852
+ # Occurs whenever a SEPA Instant Transfer is updated.
853
+ SEPA_INSTANT_TRANSFER_UPDATED =
854
+ T.let(
855
+ :"sepa_instant_transfer.updated",
856
+ Increase::Event::Category::TaggedSymbol
857
+ )
858
+
845
859
  # Occurs whenever a Swift Transfer is created.
846
860
  SWIFT_TRANSFER_CREATED =
847
861
  T.let(
@@ -860,6 +874,20 @@ module Increase
860
874
  TRANSACTION_CREATED =
861
875
  T.let(:"transaction.created", Increase::Event::Category::TaggedSymbol)
862
876
 
877
+ # Occurs whenever a UK Faster Payment System Transfer is created.
878
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
879
+ T.let(
880
+ :"uk_faster_payment_system_transfer.created",
881
+ Increase::Event::Category::TaggedSymbol
882
+ )
883
+
884
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
885
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
886
+ T.let(
887
+ :"uk_faster_payment_system_transfer.updated",
888
+ Increase::Event::Category::TaggedSymbol
889
+ )
890
+
863
891
  # Occurs whenever a Wire Drawdown Request is created.
864
892
  WIRE_DRAWDOWN_REQUEST_CREATED =
865
893
  T.let(
@@ -969,6 +969,20 @@ module Increase
969
969
  Increase::EventListParams::Category::In::TaggedSymbol
970
970
  )
971
971
 
972
+ # Occurs whenever a SEPA Instant Transfer is created.
973
+ SEPA_INSTANT_TRANSFER_CREATED =
974
+ T.let(
975
+ :"sepa_instant_transfer.created",
976
+ Increase::EventListParams::Category::In::TaggedSymbol
977
+ )
978
+
979
+ # Occurs whenever a SEPA Instant Transfer is updated.
980
+ SEPA_INSTANT_TRANSFER_UPDATED =
981
+ T.let(
982
+ :"sepa_instant_transfer.updated",
983
+ Increase::EventListParams::Category::In::TaggedSymbol
984
+ )
985
+
972
986
  # Occurs whenever a Swift Transfer is created.
973
987
  SWIFT_TRANSFER_CREATED =
974
988
  T.let(
@@ -990,6 +1004,20 @@ module Increase
990
1004
  Increase::EventListParams::Category::In::TaggedSymbol
991
1005
  )
992
1006
 
1007
+ # Occurs whenever a UK Faster Payment System Transfer is created.
1008
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
1009
+ T.let(
1010
+ :"uk_faster_payment_system_transfer.created",
1011
+ Increase::EventListParams::Category::In::TaggedSymbol
1012
+ )
1013
+
1014
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
1015
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
1016
+ T.let(
1017
+ :"uk_faster_payment_system_transfer.updated",
1018
+ Increase::EventListParams::Category::In::TaggedSymbol
1019
+ )
1020
+
993
1021
  # Occurs whenever a Wire Drawdown Request is created.
994
1022
  WIRE_DRAWDOWN_REQUEST_CREATED =
995
1023
  T.let(
@@ -990,6 +990,20 @@ module Increase
990
990
  Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
991
991
  )
992
992
 
993
+ # Occurs whenever a SEPA Instant Transfer is created.
994
+ SEPA_INSTANT_TRANSFER_CREATED =
995
+ T.let(
996
+ :"sepa_instant_transfer.created",
997
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
998
+ )
999
+
1000
+ # Occurs whenever a SEPA Instant Transfer is updated.
1001
+ SEPA_INSTANT_TRANSFER_UPDATED =
1002
+ T.let(
1003
+ :"sepa_instant_transfer.updated",
1004
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
1005
+ )
1006
+
993
1007
  # Occurs whenever a Swift Transfer is created.
994
1008
  SWIFT_TRANSFER_CREATED =
995
1009
  T.let(
@@ -1011,6 +1025,20 @@ module Increase
1011
1025
  Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
1012
1026
  )
1013
1027
 
1028
+ # Occurs whenever a UK Faster Payment System Transfer is created.
1029
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
1030
+ T.let(
1031
+ :"uk_faster_payment_system_transfer.created",
1032
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
1033
+ )
1034
+
1035
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
1036
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
1037
+ T.let(
1038
+ :"uk_faster_payment_system_transfer.updated",
1039
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
1040
+ )
1041
+
1014
1042
  # Occurs whenever a Wire Drawdown Request is created.
1015
1043
  WIRE_DRAWDOWN_REQUEST_CREATED =
1016
1044
  T.let(
@@ -988,6 +988,20 @@ module Increase
988
988
  Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
989
989
  )
990
990
 
991
+ # Occurs whenever a SEPA Instant Transfer is created.
992
+ SEPA_INSTANT_TRANSFER_CREATED =
993
+ T.let(
994
+ :"sepa_instant_transfer.created",
995
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
996
+ )
997
+
998
+ # Occurs whenever a SEPA Instant Transfer is updated.
999
+ SEPA_INSTANT_TRANSFER_UPDATED =
1000
+ T.let(
1001
+ :"sepa_instant_transfer.updated",
1002
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
1003
+ )
1004
+
991
1005
  # Occurs whenever a Swift Transfer is created.
992
1006
  SWIFT_TRANSFER_CREATED =
993
1007
  T.let(
@@ -1009,6 +1023,20 @@ module Increase
1009
1023
  Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
1010
1024
  )
1011
1025
 
1026
+ # Occurs whenever a UK Faster Payment System Transfer is created.
1027
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED =
1028
+ T.let(
1029
+ :"uk_faster_payment_system_transfer.created",
1030
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
1031
+ )
1032
+
1033
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
1034
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED =
1035
+ T.let(
1036
+ :"uk_faster_payment_system_transfer.updated",
1037
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
1038
+ )
1039
+
1012
1040
  # Occurs whenever a Wire Drawdown Request is created.
1013
1041
  WIRE_DRAWDOWN_REQUEST_CREATED =
1014
1042
  T.let(
@@ -1783,6 +1783,10 @@ module Increase
1783
1783
  )
1784
1784
  end
1785
1785
 
1786
+ # The three character ACH return code, in the range R01 to R85.
1787
+ sig { returns(String) }
1788
+ attr_accessor :raw_reason_code
1789
+
1786
1790
  # The reason for the transfer return.
1787
1791
  sig do
1788
1792
  returns(
@@ -1802,6 +1806,7 @@ module Increase
1802
1806
  # If your transfer is returned, this will contain details of the return.
1803
1807
  sig do
1804
1808
  params(
1809
+ raw_reason_code: String,
1805
1810
  reason:
1806
1811
  Increase::InboundACHTransfer::TransferReturn::Reason::OrSymbol,
1807
1812
  returned_at: Time,
@@ -1809,6 +1814,8 @@ module Increase
1809
1814
  ).returns(T.attached_class)
1810
1815
  end
1811
1816
  def self.new(
1817
+ # The three character ACH return code, in the range R01 to R85.
1818
+ raw_reason_code:,
1812
1819
  # The reason for the transfer return.
1813
1820
  reason:,
1814
1821
  # The time at which the transfer was returned.
@@ -1821,6 +1828,7 @@ module Increase
1821
1828
  sig do
1822
1829
  override.returns(
1823
1830
  {
1831
+ raw_reason_code: String,
1824
1832
  reason:
1825
1833
  Increase::InboundACHTransfer::TransferReturn::Reason::TaggedSymbol,
1826
1834
  returned_at: Time,
@@ -519,6 +519,28 @@ module Increase
519
519
  end
520
520
  attr_writer :real_time_payments_transfer_instruction
521
521
 
522
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
523
+ # JSON response if and only if `category` is equal to
524
+ # `sepa_instant_transfer_instruction`.
525
+ sig do
526
+ returns(
527
+ T.nilable(
528
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction
529
+ )
530
+ )
531
+ end
532
+ attr_reader :sepa_instant_transfer_instruction
533
+
534
+ sig do
535
+ params(
536
+ sepa_instant_transfer_instruction:
537
+ T.nilable(
538
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::OrHash
539
+ )
540
+ ).void
541
+ end
542
+ attr_writer :sepa_instant_transfer_instruction
543
+
522
544
  # A Swift Transfer Instruction object. This field will be present in the JSON
523
545
  # response if and only if `category` is equal to `swift_transfer_instruction`.
524
546
  sig do
@@ -540,6 +562,28 @@ module Increase
540
562
  end
541
563
  attr_writer :swift_transfer_instruction
542
564
 
565
+ # An UK Faster Payment System Transfer Instruction object. This field will be
566
+ # present in the JSON response if and only if `category` is equal to
567
+ # `uk_faster_payment_system_transfer_instruction`.
568
+ sig do
569
+ returns(
570
+ T.nilable(
571
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction
572
+ )
573
+ )
574
+ end
575
+ attr_reader :uk_faster_payment_system_transfer_instruction
576
+
577
+ sig do
578
+ params(
579
+ uk_faster_payment_system_transfer_instruction:
580
+ T.nilable(
581
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::OrHash
582
+ )
583
+ ).void
584
+ end
585
+ attr_writer :uk_faster_payment_system_transfer_instruction
586
+
543
587
  # An User Initiated Hold object. This field will be present in the JSON response
544
588
  # if and only if `category` is equal to `user_initiated_hold`. Created when a user
545
589
  # initiates a hold on funds in their account.
@@ -623,10 +667,18 @@ module Increase
623
667
  T.nilable(
624
668
  Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction::OrHash
625
669
  ),
670
+ sepa_instant_transfer_instruction:
671
+ T.nilable(
672
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::OrHash
673
+ ),
626
674
  swift_transfer_instruction:
627
675
  T.nilable(
628
676
  Increase::PendingTransaction::Source::SwiftTransferInstruction::OrHash
629
677
  ),
678
+ uk_faster_payment_system_transfer_instruction:
679
+ T.nilable(
680
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::OrHash
681
+ ),
630
682
  user_initiated_hold: T.nilable(T::Hash[Symbol, T.anything]),
631
683
  wire_transfer_instruction:
632
684
  T.nilable(
@@ -687,9 +739,17 @@ module Increase
687
739
  # the JSON response if and only if `category` is equal to
688
740
  # `real_time_payments_transfer_instruction`.
689
741
  real_time_payments_transfer_instruction: nil,
742
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
743
+ # JSON response if and only if `category` is equal to
744
+ # `sepa_instant_transfer_instruction`.
745
+ sepa_instant_transfer_instruction: nil,
690
746
  # A Swift Transfer Instruction object. This field will be present in the JSON
691
747
  # response if and only if `category` is equal to `swift_transfer_instruction`.
692
748
  swift_transfer_instruction: nil,
749
+ # An UK Faster Payment System Transfer Instruction object. This field will be
750
+ # present in the JSON response if and only if `category` is equal to
751
+ # `uk_faster_payment_system_transfer_instruction`.
752
+ uk_faster_payment_system_transfer_instruction: nil,
693
753
  # An User Initiated Hold object. This field will be present in the JSON response
694
754
  # if and only if `category` is equal to `user_initiated_hold`. Created when a user
695
755
  # initiates a hold on funds in their account.
@@ -754,10 +814,18 @@ module Increase
754
814
  T.nilable(
755
815
  Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction
756
816
  ),
817
+ sepa_instant_transfer_instruction:
818
+ T.nilable(
819
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction
820
+ ),
757
821
  swift_transfer_instruction:
758
822
  T.nilable(
759
823
  Increase::PendingTransaction::Source::SwiftTransferInstruction
760
824
  ),
825
+ uk_faster_payment_system_transfer_instruction:
826
+ T.nilable(
827
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction
828
+ ),
761
829
  user_initiated_hold: T.nilable(T::Hash[Symbol, T.anything]),
762
830
  wire_transfer_instruction:
763
831
  T.nilable(
@@ -885,6 +953,20 @@ module Increase
885
953
  Increase::PendingTransaction::Source::Category::TaggedSymbol
886
954
  )
887
955
 
956
+ # UK Faster Payment System Transfer Instruction: details will be under the `uk_faster_payment_system_transfer_instruction` object.
957
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_INSTRUCTION =
958
+ T.let(
959
+ :uk_faster_payment_system_transfer_instruction,
960
+ Increase::PendingTransaction::Source::Category::TaggedSymbol
961
+ )
962
+
963
+ # SEPA Instant Transfer Instruction: details will be under the `sepa_instant_transfer_instruction` object.
964
+ SEPA_INSTANT_TRANSFER_INSTRUCTION =
965
+ T.let(
966
+ :sepa_instant_transfer_instruction,
967
+ Increase::PendingTransaction::Source::Category::TaggedSymbol
968
+ )
969
+
888
970
  # The Pending Transaction was made for an undocumented or deprecated reason.
889
971
  OTHER =
890
972
  T.let(
@@ -4892,6 +4974,92 @@ module Increase
4892
4974
  end
4893
4975
  end
4894
4976
 
4977
+ class SepaInstantTransferInstruction < Increase::Internal::Type::BaseModel
4978
+ OrHash =
4979
+ T.type_alias do
4980
+ T.any(
4981
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction,
4982
+ Increase::Internal::AnyHash
4983
+ )
4984
+ end
4985
+
4986
+ # The transfer amount in EUR cents.
4987
+ sig { returns(Integer) }
4988
+ attr_accessor :amount
4989
+
4990
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
4991
+ # transfer's currency. This is always `EUR`.
4992
+ sig do
4993
+ returns(
4994
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency::TaggedSymbol
4995
+ )
4996
+ end
4997
+ attr_accessor :currency
4998
+
4999
+ # A SEPA Instant Transfer Instruction object. This field will be present in the
5000
+ # JSON response if and only if `category` is equal to
5001
+ # `sepa_instant_transfer_instruction`.
5002
+ sig do
5003
+ params(
5004
+ amount: Integer,
5005
+ currency:
5006
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency::OrSymbol
5007
+ ).returns(T.attached_class)
5008
+ end
5009
+ def self.new(
5010
+ # The transfer amount in EUR cents.
5011
+ amount:,
5012
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
5013
+ # transfer's currency. This is always `EUR`.
5014
+ currency:
5015
+ )
5016
+ end
5017
+
5018
+ sig do
5019
+ override.returns(
5020
+ {
5021
+ amount: Integer,
5022
+ currency:
5023
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency::TaggedSymbol
5024
+ }
5025
+ )
5026
+ end
5027
+ def to_hash
5028
+ end
5029
+
5030
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
5031
+ # transfer's currency. This is always `EUR`.
5032
+ module Currency
5033
+ extend Increase::Internal::Type::Enum
5034
+
5035
+ TaggedSymbol =
5036
+ T.type_alias do
5037
+ T.all(
5038
+ Symbol,
5039
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency
5040
+ )
5041
+ end
5042
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5043
+
5044
+ # EUR
5045
+ EUR =
5046
+ T.let(
5047
+ :EUR,
5048
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency::TaggedSymbol
5049
+ )
5050
+
5051
+ sig do
5052
+ override.returns(
5053
+ T::Array[
5054
+ Increase::PendingTransaction::Source::SepaInstantTransferInstruction::Currency::TaggedSymbol
5055
+ ]
5056
+ )
5057
+ end
5058
+ def self.values
5059
+ end
5060
+ end
5061
+ end
5062
+
4895
5063
  class SwiftTransferInstruction < Increase::Internal::Type::BaseModel
4896
5064
  OrHash =
4897
5065
  T.type_alias do
@@ -4919,6 +5087,92 @@ module Increase
4919
5087
  end
4920
5088
  end
4921
5089
 
5090
+ class UkFasterPaymentSystemTransferInstruction < Increase::Internal::Type::BaseModel
5091
+ OrHash =
5092
+ T.type_alias do
5093
+ T.any(
5094
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction,
5095
+ Increase::Internal::AnyHash
5096
+ )
5097
+ end
5098
+
5099
+ # The transfer amount in GBP pence.
5100
+ sig { returns(Integer) }
5101
+ attr_accessor :amount
5102
+
5103
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
5104
+ # transfer's currency. This is always `GBP`.
5105
+ sig do
5106
+ returns(
5107
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency::TaggedSymbol
5108
+ )
5109
+ end
5110
+ attr_accessor :currency
5111
+
5112
+ # An UK Faster Payment System Transfer Instruction object. This field will be
5113
+ # present in the JSON response if and only if `category` is equal to
5114
+ # `uk_faster_payment_system_transfer_instruction`.
5115
+ sig do
5116
+ params(
5117
+ amount: Integer,
5118
+ currency:
5119
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency::OrSymbol
5120
+ ).returns(T.attached_class)
5121
+ end
5122
+ def self.new(
5123
+ # The transfer amount in GBP pence.
5124
+ amount:,
5125
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
5126
+ # transfer's currency. This is always `GBP`.
5127
+ currency:
5128
+ )
5129
+ end
5130
+
5131
+ sig do
5132
+ override.returns(
5133
+ {
5134
+ amount: Integer,
5135
+ currency:
5136
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency::TaggedSymbol
5137
+ }
5138
+ )
5139
+ end
5140
+ def to_hash
5141
+ end
5142
+
5143
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
5144
+ # transfer's currency. This is always `GBP`.
5145
+ module Currency
5146
+ extend Increase::Internal::Type::Enum
5147
+
5148
+ TaggedSymbol =
5149
+ T.type_alias do
5150
+ T.all(
5151
+ Symbol,
5152
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency
5153
+ )
5154
+ end
5155
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5156
+
5157
+ # GBP
5158
+ GBP =
5159
+ T.let(
5160
+ :GBP,
5161
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency::TaggedSymbol
5162
+ )
5163
+
5164
+ sig do
5165
+ override.returns(
5166
+ T::Array[
5167
+ Increase::PendingTransaction::Source::UkFasterPaymentSystemTransferInstruction::Currency::TaggedSymbol
5168
+ ]
5169
+ )
5170
+ end
5171
+ def self.values
5172
+ end
5173
+ end
5174
+ end
5175
+
4922
5176
  class WireTransferInstruction < Increase::Internal::Type::BaseModel
4923
5177
  OrHash =
4924
5178
  T.type_alias do
@@ -304,6 +304,20 @@ module Increase
304
304
  Increase::PendingTransactionListParams::Category::In::TaggedSymbol
305
305
  )
306
306
 
307
+ # UK Faster Payment System Transfer Instruction: details will be under the `uk_faster_payment_system_transfer_instruction` object.
308
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_INSTRUCTION =
309
+ T.let(
310
+ :uk_faster_payment_system_transfer_instruction,
311
+ Increase::PendingTransactionListParams::Category::In::TaggedSymbol
312
+ )
313
+
314
+ # SEPA Instant Transfer Instruction: details will be under the `sepa_instant_transfer_instruction` object.
315
+ SEPA_INSTANT_TRANSFER_INSTRUCTION =
316
+ T.let(
317
+ :sepa_instant_transfer_instruction,
318
+ Increase::PendingTransactionListParams::Category::In::TaggedSymbol
319
+ )
320
+
307
321
  # The Pending Transaction was made for an undocumented or deprecated reason.
308
322
  OTHER =
309
323
  T.let(
@@ -35,21 +35,22 @@ module Increase
35
35
  sig { params(carrier_estimated_delivery_at: Time).void }
36
36
  attr_writer :carrier_estimated_delivery_at
37
37
 
38
- # The city where the event took place.
38
+ # The city where the event took place. Required if postal_code is not provided.
39
39
  sig { returns(T.nilable(String)) }
40
40
  attr_reader :city
41
41
 
42
42
  sig { params(city: String).void }
43
43
  attr_writer :city
44
44
 
45
- # The postal code where the event took place.
45
+ # The postal code where the event took place. Required unless both city and state
46
+ # are provided.
46
47
  sig { returns(T.nilable(String)) }
47
48
  attr_reader :postal_code
48
49
 
49
50
  sig { params(postal_code: String).void }
50
51
  attr_writer :postal_code
51
52
 
52
- # The state where the event took place.
53
+ # The state where the event took place. Required if postal_code is not provided.
53
54
  sig { returns(T.nilable(String)) }
54
55
  attr_reader :state
55
56
 
@@ -76,11 +77,12 @@ module Increase
76
77
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
77
78
  # carrier expects the card to be delivered.
78
79
  carrier_estimated_delivery_at: nil,
79
- # The city where the event took place.
80
+ # The city where the event took place. Required if postal_code is not provided.
80
81
  city: nil,
81
- # The postal code where the event took place.
82
+ # The postal code where the event took place. Required unless both city and state
83
+ # are provided.
82
84
  postal_code: nil,
83
- # The state where the event took place.
85
+ # The state where the event took place. Required if postal_code is not provided.
84
86
  state: nil,
85
87
  request_options: {}
86
88
  )