increase 1.354.0 → 1.356.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 (125) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +18 -0
  4. data/lib/increase/models/account_number.rb +1 -1
  5. data/lib/increase/models/account_number_create_params.rb +1 -1
  6. data/lib/increase/models/account_number_list_params.rb +1 -1
  7. data/lib/increase/models/account_number_update_params.rb +1 -1
  8. data/lib/increase/models/card_create_details_token_params.rb +22 -0
  9. data/lib/increase/models/card_details_token.rb +57 -0
  10. data/lib/increase/models/card_payment.rb +26 -1
  11. data/lib/increase/models/check_deposit.rb +3 -0
  12. data/lib/increase/models/digital_wallet_token.rb +3 -0
  13. data/lib/increase/models/digital_wallet_token_request.rb +307 -0
  14. data/lib/increase/models/digital_wallet_token_request_list_params.rb +99 -0
  15. data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb +22 -0
  16. data/lib/increase/models/digital_wallet_token_transition_params.rb +48 -0
  17. data/lib/increase/models/inbound_real_time_payments_request_for_payment.rb +318 -0
  18. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rb +113 -0
  19. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rb +25 -0
  20. data/lib/increase/models/physical_check_batch.rb +266 -0
  21. data/lib/increase/models/physical_check_batch_cancel_params.rb +22 -0
  22. data/lib/increase/models/physical_check_batch_complete_params.rb +22 -0
  23. data/lib/increase/models/physical_check_batch_create_params.rb +189 -0
  24. data/lib/increase/models/real_time_decision.rb +6 -0
  25. data/lib/increase/models/real_time_payments_request_for_payment.rb +658 -0
  26. data/lib/increase/models/real_time_payments_requests_for_payment_cancel_params.rb +64 -0
  27. data/lib/increase/models/real_time_payments_requests_for_payment_create_params.rb +194 -0
  28. data/lib/increase/models/real_time_payments_requests_for_payment_list_params.rb +117 -0
  29. data/lib/increase/models/real_time_payments_requests_for_payment_retrieve_params.rb +23 -0
  30. data/lib/increase/models/simulations/fednow_transfer_complete_params.rb +103 -0
  31. data/lib/increase/models/simulations/inbound_check_deposit_accept_params.rb +24 -0
  32. data/lib/increase/models/transaction.rb +26 -1
  33. data/lib/increase/models.rb +42 -0
  34. data/lib/increase/resources/cards.rb +23 -0
  35. data/lib/increase/resources/digital_wallet_token_requests.rb +68 -0
  36. data/lib/increase/resources/digital_wallet_tokens.rb +28 -0
  37. data/lib/increase/resources/inbound_real_time_payments_requests_for_payment.rb +79 -0
  38. data/lib/increase/resources/physical_check_batches.rb +86 -0
  39. data/lib/increase/resources/real_time_payments_requests_for_payment.rb +159 -0
  40. data/lib/increase/resources/simulations/fednow_transfers.rb +43 -0
  41. data/lib/increase/resources/simulations/inbound_check_deposits.rb +22 -0
  42. data/lib/increase/resources/simulations.rb +4 -0
  43. data/lib/increase/version.rb +1 -1
  44. data/lib/increase.rb +25 -0
  45. data/rbi/increase/client.rbi +14 -0
  46. data/rbi/increase/models/account_number.rbi +1 -1
  47. data/rbi/increase/models/account_number_create_params.rbi +1 -1
  48. data/rbi/increase/models/account_number_list_params.rbi +1 -1
  49. data/rbi/increase/models/account_number_update_params.rbi +1 -1
  50. data/rbi/increase/models/card_create_details_token_params.rbi +43 -0
  51. data/rbi/increase/models/card_details_token.rbi +85 -0
  52. data/rbi/increase/models/card_payment.rbi +52 -0
  53. data/rbi/increase/models/check_deposit.rbi +7 -0
  54. data/rbi/increase/models/digital_wallet_token.rbi +7 -0
  55. data/rbi/increase/models/digital_wallet_token_request.rbi +586 -0
  56. data/rbi/increase/models/digital_wallet_token_request_list_params.rbi +171 -0
  57. data/rbi/increase/models/digital_wallet_token_request_retrieve_params.rbi +46 -0
  58. data/rbi/increase/models/digital_wallet_token_transition_params.rbi +100 -0
  59. data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi +442 -0
  60. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi +188 -0
  61. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi +48 -0
  62. data/rbi/increase/models/physical_check_batch.rbi +382 -0
  63. data/rbi/increase/models/physical_check_batch_cancel_params.rbi +46 -0
  64. data/rbi/increase/models/physical_check_batch_complete_params.rbi +46 -0
  65. data/rbi/increase/models/physical_check_batch_create_params.rbi +326 -0
  66. data/rbi/increase/models/real_time_decision.rbi +14 -0
  67. data/rbi/increase/models/real_time_payments_request_for_payment.rbi +1166 -0
  68. data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi +136 -0
  69. data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi +303 -0
  70. data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi +192 -0
  71. data/rbi/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbi +46 -0
  72. data/rbi/increase/models/simulations/fednow_transfer_complete_params.rbi +243 -0
  73. data/rbi/increase/models/simulations/inbound_check_deposit_accept_params.rbi +48 -0
  74. data/rbi/increase/models/transaction.rbi +52 -0
  75. data/rbi/increase/models.rbi +50 -0
  76. data/rbi/increase/resources/cards.rbi +17 -0
  77. data/rbi/increase/resources/digital_wallet_token_requests.rbi +52 -0
  78. data/rbi/increase/resources/digital_wallet_tokens.rbi +21 -0
  79. data/rbi/increase/resources/inbound_real_time_payments_requests_for_payment.rbi +62 -0
  80. data/rbi/increase/resources/physical_check_batches.rbi +66 -0
  81. data/rbi/increase/resources/real_time_payments_requests_for_payment.rbi +127 -0
  82. data/rbi/increase/resources/simulations/fednow_transfers.rbi +34 -0
  83. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +16 -0
  84. data/rbi/increase/resources/simulations.rbi +3 -0
  85. data/sig/increase/client.rbs +8 -0
  86. data/sig/increase/models/account_number.rbs +1 -1
  87. data/sig/increase/models/account_number_create_params.rbs +1 -1
  88. data/sig/increase/models/account_number_list_params.rbs +1 -1
  89. data/sig/increase/models/account_number_update_params.rbs +1 -1
  90. data/sig/increase/models/card_create_details_token_params.rbs +23 -0
  91. data/sig/increase/models/card_details_token.rbs +40 -0
  92. data/sig/increase/models/card_payment.rbs +19 -0
  93. data/sig/increase/models/check_deposit.rbs +5 -1
  94. data/sig/increase/models/digital_wallet_token.rbs +5 -1
  95. data/sig/increase/models/digital_wallet_token_request.rbs +260 -0
  96. data/sig/increase/models/digital_wallet_token_request_list_params.rbs +86 -0
  97. data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs +24 -0
  98. data/sig/increase/models/digital_wallet_token_transition_params.rbs +48 -0
  99. data/sig/increase/models/inbound_real_time_payments_request_for_payment.rbs +200 -0
  100. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbs +93 -0
  101. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  102. data/sig/increase/models/physical_check_batch.rbs +193 -0
  103. data/sig/increase/models/physical_check_batch_cancel_params.rbs +24 -0
  104. data/sig/increase/models/physical_check_batch_complete_params.rbs +24 -0
  105. data/sig/increase/models/physical_check_batch_create_params.rbs +156 -0
  106. data/sig/increase/models/real_time_decision.rbs +10 -2
  107. data/sig/increase/models/real_time_payments_request_for_payment.rbs +513 -0
  108. data/sig/increase/models/real_time_payments_requests_for_payment_cancel_params.rbs +66 -0
  109. data/sig/increase/models/real_time_payments_requests_for_payment_create_params.rbs +149 -0
  110. data/sig/increase/models/real_time_payments_requests_for_payment_list_params.rbs +93 -0
  111. data/sig/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  112. data/sig/increase/models/simulations/fednow_transfer_complete_params.rbs +122 -0
  113. data/sig/increase/models/simulations/inbound_check_deposit_accept_params.rbs +26 -0
  114. data/sig/increase/models/transaction.rbs +19 -0
  115. data/sig/increase/models.rbs +36 -0
  116. data/sig/increase/resources/cards.rbs +5 -0
  117. data/sig/increase/resources/digital_wallet_token_requests.rbs +20 -0
  118. data/sig/increase/resources/digital_wallet_tokens.rbs +6 -0
  119. data/sig/increase/resources/inbound_real_time_payments_requests_for_payment.rbs +21 -0
  120. data/sig/increase/resources/physical_check_batches.rbs +24 -0
  121. data/sig/increase/resources/real_time_payments_requests_for_payment.rbs +41 -0
  122. data/sig/increase/resources/simulations/fednow_transfers.rbs +15 -0
  123. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +5 -0
  124. data/sig/increase/resources/simulations.rbs +2 -0
  125. metadata +77 -2
@@ -58,6 +58,9 @@ module Increase
58
58
  sig { returns(Increase::Resources::DigitalWalletTokens) }
59
59
  attr_reader :digital_wallet_tokens
60
60
 
61
+ sig { returns(Increase::Resources::DigitalWalletTokenRequests) }
62
+ attr_reader :digital_wallet_token_requests
63
+
61
64
  sig { returns(Increase::Resources::Transactions) }
62
65
  attr_reader :transactions
63
66
 
@@ -100,6 +103,14 @@ module Increase
100
103
  sig { returns(Increase::Resources::InboundRealTimePaymentsTransfers) }
101
104
  attr_reader :inbound_real_time_payments_transfers
102
105
 
106
+ sig { returns(Increase::Resources::RealTimePaymentsRequestsForPayment) }
107
+ attr_reader :real_time_payments_requests_for_payment
108
+
109
+ sig do
110
+ returns(Increase::Resources::InboundRealTimePaymentsRequestsForPayment)
111
+ end
112
+ attr_reader :inbound_real_time_payments_requests_for_payment
113
+
103
114
  sig { returns(Increase::Resources::FednowTransfers) }
104
115
  attr_reader :fednow_transfers
105
116
 
@@ -193,6 +204,9 @@ module Increase
193
204
  sig { returns(Increase::Resources::CardValidations) }
194
205
  attr_reader :card_validations
195
206
 
207
+ sig { returns(Increase::Resources::PhysicalCheckBatches) }
208
+ attr_reader :physical_check_batches
209
+
196
210
  sig { returns(Increase::Resources::Simulations) }
197
211
  attr_reader :simulations
198
212
 
@@ -201,7 +201,7 @@ module Increase
201
201
  Increase::AccountNumber::InboundACH::DebitStatus::TaggedSymbol
202
202
  )
203
203
 
204
- # ACH Debits are blocked.
204
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
205
205
  BLOCKED =
206
206
  T.let(
207
207
  :blocked,
@@ -155,7 +155,7 @@ module Increase
155
155
  Increase::AccountNumberCreateParams::InboundACH::DebitStatus::TaggedSymbol
156
156
  )
157
157
 
158
- # ACH Debits are blocked.
158
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
159
159
  BLOCKED =
160
160
  T.let(
161
161
  :blocked,
@@ -207,7 +207,7 @@ module Increase
207
207
  Increase::AccountNumberListParams::ACHDebitStatus::In::TaggedSymbol
208
208
  )
209
209
 
210
- # ACH Debits are blocked.
210
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
211
211
  BLOCKED =
212
212
  T.let(
213
213
  :blocked,
@@ -184,7 +184,7 @@ module Increase
184
184
  Increase::AccountNumberUpdateParams::InboundACH::DebitStatus::TaggedSymbol
185
185
  )
186
186
 
187
- # ACH Debits are blocked.
187
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
188
188
  BLOCKED =
189
189
  T.let(
190
190
  :blocked,
@@ -0,0 +1,43 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class CardCreateDetailsTokenParams < Increase::Internal::Type::BaseModel
6
+ extend Increase::Internal::Type::RequestParameters::Converter
7
+ include Increase::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Increase::CardCreateDetailsTokenParams,
13
+ Increase::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # The identifier of the Card to mint a details token for.
18
+ sig { returns(String) }
19
+ attr_accessor :card_id
20
+
21
+ sig do
22
+ params(
23
+ card_id: String,
24
+ request_options: Increase::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # The identifier of the Card to mint a details token for.
29
+ card_id:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ { card_id: String, request_options: Increase::RequestOptions }
37
+ )
38
+ end
39
+ def to_hash
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,85 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class CardDetailsToken < Increase::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Increase::CardDetailsToken, Increase::Internal::AnyHash)
9
+ end
10
+
11
+ # The token. Pass this to the `@increasebank/card-elements` library in your
12
+ # frontend. Treat it as a credential: it authorizes anyone holding it to read the
13
+ # Card's details until it expires.
14
+ sig { returns(String) }
15
+ attr_accessor :token
16
+
17
+ # The time the token will expire. Tokens are valid for one hour.
18
+ sig { returns(Time) }
19
+ attr_accessor :expires_at
20
+
21
+ # A constant representing the object's type. For this resource it will always be
22
+ # `card_details_token`.
23
+ sig { returns(Increase::CardDetailsToken::Type::TaggedSymbol) }
24
+ attr_accessor :type
25
+
26
+ # A short-lived token that authorizes Increase Card Elements to render the details
27
+ # of a single Card.
28
+ sig do
29
+ params(
30
+ token: String,
31
+ expires_at: Time,
32
+ type: Increase::CardDetailsToken::Type::OrSymbol
33
+ ).returns(T.attached_class)
34
+ end
35
+ def self.new(
36
+ # The token. Pass this to the `@increasebank/card-elements` library in your
37
+ # frontend. Treat it as a credential: it authorizes anyone holding it to read the
38
+ # Card's details until it expires.
39
+ token:,
40
+ # The time the token will expire. Tokens are valid for one hour.
41
+ expires_at:,
42
+ # A constant representing the object's type. For this resource it will always be
43
+ # `card_details_token`.
44
+ type:
45
+ )
46
+ end
47
+
48
+ sig do
49
+ override.returns(
50
+ {
51
+ token: String,
52
+ expires_at: Time,
53
+ type: Increase::CardDetailsToken::Type::TaggedSymbol
54
+ }
55
+ )
56
+ end
57
+ def to_hash
58
+ end
59
+
60
+ # A constant representing the object's type. For this resource it will always be
61
+ # `card_details_token`.
62
+ module Type
63
+ extend Increase::Internal::Type::Enum
64
+
65
+ TaggedSymbol =
66
+ T.type_alias { T.all(Symbol, Increase::CardDetailsToken::Type) }
67
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
68
+
69
+ CARD_DETAILS_TOKEN =
70
+ T.let(
71
+ :card_details_token,
72
+ Increase::CardDetailsToken::Type::TaggedSymbol
73
+ )
74
+
75
+ sig do
76
+ override.returns(
77
+ T::Array[Increase::CardDetailsToken::Type::TaggedSymbol]
78
+ )
79
+ end
80
+ def self.values
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
@@ -16391,6 +16391,14 @@ module Increase
16391
16391
  sig { returns(T.nilable(String)) }
16392
16392
  attr_accessor :merchant_state
16393
16393
 
16394
+ # The card network on which this transaction was processed.
16395
+ sig do
16396
+ returns(
16397
+ Increase::CardPayment::Element::CardRefund::Network::TaggedSymbol
16398
+ )
16399
+ end
16400
+ attr_accessor :network
16401
+
16394
16402
  # Network-specific identifiers for this refund.
16395
16403
  sig do
16396
16404
  returns(
@@ -16485,6 +16493,8 @@ module Increase
16485
16493
  merchant_name: String,
16486
16494
  merchant_postal_code: T.nilable(String),
16487
16495
  merchant_state: T.nilable(String),
16496
+ network:
16497
+ Increase::CardPayment::Element::CardRefund::Network::OrSymbol,
16488
16498
  network_identifiers:
16489
16499
  Increase::CardPayment::Element::CardRefund::NetworkIdentifiers::OrHash,
16490
16500
  presentment_amount: Integer,
@@ -16532,6 +16542,8 @@ module Increase
16532
16542
  merchant_postal_code:,
16533
16543
  # The state the merchant resides in.
16534
16544
  merchant_state:,
16545
+ # The card network on which this transaction was processed.
16546
+ network:,
16535
16547
  # Network-specific identifiers for this refund.
16536
16548
  network_identifiers:,
16537
16549
  # The amount in the minor unit of the transaction's presentment currency.
@@ -16575,6 +16587,8 @@ module Increase
16575
16587
  merchant_name: String,
16576
16588
  merchant_postal_code: T.nilable(String),
16577
16589
  merchant_state: T.nilable(String),
16590
+ network:
16591
+ Increase::CardPayment::Element::CardRefund::Network::TaggedSymbol,
16578
16592
  network_identifiers:
16579
16593
  Increase::CardPayment::Element::CardRefund::NetworkIdentifiers,
16580
16594
  presentment_amount: Integer,
@@ -16812,6 +16826,44 @@ module Increase
16812
16826
  end
16813
16827
  end
16814
16828
 
16829
+ # The card network on which this transaction was processed.
16830
+ module Network
16831
+ extend Increase::Internal::Type::Enum
16832
+
16833
+ TaggedSymbol =
16834
+ T.type_alias do
16835
+ T.all(
16836
+ Symbol,
16837
+ Increase::CardPayment::Element::CardRefund::Network
16838
+ )
16839
+ end
16840
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
16841
+
16842
+ # Visa
16843
+ VISA =
16844
+ T.let(
16845
+ :visa,
16846
+ Increase::CardPayment::Element::CardRefund::Network::TaggedSymbol
16847
+ )
16848
+
16849
+ # Pulse
16850
+ PULSE =
16851
+ T.let(
16852
+ :pulse,
16853
+ Increase::CardPayment::Element::CardRefund::Network::TaggedSymbol
16854
+ )
16855
+
16856
+ sig do
16857
+ override.returns(
16858
+ T::Array[
16859
+ Increase::CardPayment::Element::CardRefund::Network::TaggedSymbol
16860
+ ]
16861
+ )
16862
+ end
16863
+ def self.values
16864
+ end
16865
+ end
16866
+
16815
16867
  class NetworkIdentifiers < Increase::Internal::Type::BaseModel
16816
16868
  OrHash =
16817
16869
  T.type_alias do
@@ -460,6 +460,13 @@ module Increase
460
460
  end
461
461
  OrSymbol = T.type_alias { T.any(Symbol, String) }
462
462
 
463
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
464
+ WRONG_PAYEE_CREDIT =
465
+ T.let(
466
+ :wrong_payee_credit,
467
+ Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
468
+ )
469
+
463
470
  # The check was deposited with a different amount than what was written on the check.
464
471
  ADJUSTED_AMOUNT =
465
472
  T.let(
@@ -603,6 +603,13 @@ module Increase
603
603
  Increase::DigitalWalletToken::TokenRequestor::TaggedSymbol
604
604
  )
605
605
 
606
+ # Garmin Pay
607
+ GARMIN_PAY =
608
+ T.let(
609
+ :garmin_pay,
610
+ Increase::DigitalWalletToken::TokenRequestor::TaggedSymbol
611
+ )
612
+
606
613
  # Unknown
607
614
  UNKNOWN =
608
615
  T.let(