increase 1.333.1 → 1.335.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 (123) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +26 -5
  4. data/lib/increase/models/ach_prenotification.rb +5 -2
  5. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  6. data/lib/increase/models/ach_transfer.rb +9 -3
  7. data/lib/increase/models/ach_transfer_create_params.rb +3 -0
  8. data/lib/increase/models/card.rb +9 -1
  9. data/lib/increase/models/card_dispute.rb +40 -1
  10. data/lib/increase/models/card_dispute_list_params.rb +3 -0
  11. data/lib/increase/models/card_payment.rb +74 -6
  12. data/lib/increase/models/card_push_transfer.rb +53 -1
  13. data/lib/increase/models/check_transfer.rb +4 -8
  14. data/lib/increase/models/declined_transaction.rb +4 -1
  15. data/lib/increase/models/digital_wallet_token.rb +59 -1
  16. data/lib/increase/models/entity.rb +1 -1
  17. data/lib/increase/models/event.rb +12 -0
  18. data/lib/increase/models/event_list_params.rb +12 -0
  19. data/lib/increase/models/event_subscription.rb +12 -0
  20. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  21. data/lib/increase/models/export.rb +17 -1
  22. data/lib/increase/models/export_create_params.rb +78 -1
  23. data/lib/increase/models/fednow_transfer.rb +47 -1
  24. data/lib/increase/models/inbound_wire_transfer.rb +9 -1
  25. data/lib/increase/models/pending_transaction.rb +57 -1
  26. data/lib/increase/models/physical_card.rb +1 -1
  27. data/lib/increase/models/physical_card_profile.rb +38 -1
  28. data/lib/increase/models/real_time_decision.rb +55 -1
  29. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +3 -0
  30. data/lib/increase/models/simulations/card_authorization_create_params.rb +4 -1
  31. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +1 -1
  32. data/lib/increase/models/simulations/check_deposit_submit_params.rb +21 -2
  33. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +6 -0
  34. data/lib/increase/models/simulations/entity_update_validation_params.rb +1 -1
  35. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +10 -1
  36. data/lib/increase/models/simulations/physical_card_create_params.rb +1 -1
  37. data/lib/increase/models/transaction.rb +23 -8
  38. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  39. data/lib/increase/models/wire_drawdown_request.rb +20 -1
  40. data/lib/increase/resources/events.rb +4 -1
  41. data/lib/increase/resources/exports.rb +3 -1
  42. data/lib/increase/resources/simulations/check_deposits.rb +3 -0
  43. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +3 -1
  44. data/lib/increase/version.rb +1 -1
  45. data/rbi/increase/models/ach_prenotification.rbi +9 -2
  46. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  47. data/rbi/increase/models/ach_transfer.rbi +14 -4
  48. data/rbi/increase/models/ach_transfer_create_params.rbi +4 -0
  49. data/rbi/increase/models/card.rbi +8 -0
  50. data/rbi/increase/models/card_dispute.rbi +56 -0
  51. data/rbi/increase/models/card_dispute_list_params.rbi +7 -0
  52. data/rbi/increase/models/card_payment.rbi +156 -7
  53. data/rbi/increase/models/card_push_transfer.rbi +56 -0
  54. data/rbi/increase/models/check_transfer.rbi +4 -10
  55. data/rbi/increase/models/declined_transaction.rbi +8 -1
  56. data/rbi/increase/models/digital_wallet_token.rbi +131 -0
  57. data/rbi/increase/models/entity.rbi +1 -1
  58. data/rbi/increase/models/event.rbi +22 -0
  59. data/rbi/increase/models/event_list_params.rbi +28 -0
  60. data/rbi/increase/models/event_subscription.rbi +28 -0
  61. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  62. data/rbi/increase/models/export.rbi +25 -5
  63. data/rbi/increase/models/export_create_params.rbi +151 -0
  64. data/rbi/increase/models/fednow_transfer.rbi +77 -0
  65. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  66. data/rbi/increase/models/pending_transaction.rbi +129 -0
  67. data/rbi/increase/models/physical_card.rbi +1 -1
  68. data/rbi/increase/models/physical_card_profile.rbi +60 -0
  69. data/rbi/increase/models/real_time_decision.rbi +127 -0
  70. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +7 -0
  71. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +8 -1
  72. data/rbi/increase/models/simulations/card_balance_inquiry_create_params.rbi +1 -1
  73. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +21 -3
  74. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +14 -0
  75. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +1 -1
  76. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +13 -0
  77. data/rbi/increase/models/simulations/physical_card_create_params.rbi +1 -1
  78. data/rbi/increase/models/transaction.rbi +31 -10
  79. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  80. data/rbi/increase/models/wire_drawdown_request.rbi +22 -0
  81. data/rbi/increase/resources/events.rbi +4 -1
  82. data/rbi/increase/resources/exports.rbi +3 -0
  83. data/rbi/increase/resources/simulations/check_deposits.rbi +1 -0
  84. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +4 -0
  85. data/sig/increase/models/ach_prenotification.rbs +7 -3
  86. data/sig/increase/models/ach_prenotification_create_params.rbs +2 -2
  87. data/sig/increase/models/ach_transfer.rbs +9 -2
  88. data/sig/increase/models/ach_transfer_create_params.rbs +4 -1
  89. data/sig/increase/models/card.rbs +5 -0
  90. data/sig/increase/models/card_dispute.rbs +21 -0
  91. data/sig/increase/models/card_dispute_list_params.rbs +4 -0
  92. data/sig/increase/models/card_payment.rbs +49 -1
  93. data/sig/increase/models/card_push_transfer.rbs +30 -0
  94. data/sig/increase/models/check_transfer.rbs +5 -5
  95. data/sig/increase/models/declined_transaction.rbs +5 -1
  96. data/sig/increase/models/digital_wallet_token.rbs +61 -2
  97. data/sig/increase/models/entity.rbs +1 -1
  98. data/sig/increase/models/event.rbs +16 -0
  99. data/sig/increase/models/event_list_params.rbs +16 -0
  100. data/sig/increase/models/event_subscription.rbs +16 -0
  101. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  102. data/sig/increase/models/export.rbs +23 -3
  103. data/sig/increase/models/export_create_params.rbs +76 -0
  104. data/sig/increase/models/fednow_transfer.rbs +37 -0
  105. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  106. data/sig/increase/models/pending_transaction.rbs +40 -0
  107. data/sig/increase/models/physical_card.rbs +1 -1
  108. data/sig/increase/models/physical_card_profile.rbs +17 -0
  109. data/sig/increase/models/real_time_decision.rbs +40 -0
  110. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +5 -1
  111. data/sig/increase/models/simulations/card_authorization_create_params.rbs +5 -1
  112. data/sig/increase/models/simulations/card_balance_inquiry_create_params.rbs +1 -1
  113. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +10 -3
  114. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +8 -0
  115. data/sig/increase/models/simulations/entity_update_validation_params.rbs +1 -1
  116. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +7 -0
  117. data/sig/increase/models/simulations/physical_card_create_params.rbs +1 -1
  118. data/sig/increase/models/transaction.rbs +9 -0
  119. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  120. data/sig/increase/models/wire_drawdown_request.rbs +10 -0
  121. data/sig/increase/resources/exports.rbs +1 -0
  122. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +1 -0
  123. metadata +4 -4
@@ -32,6 +32,18 @@ module Increase
32
32
  sig { returns(Time) }
33
33
  attr_accessor :created_at
34
34
 
35
+ # If the Digital Wallet Token was declined during provisioning, details about the
36
+ # decline.
37
+ sig { returns(T.nilable(Increase::DigitalWalletToken::Decline)) }
38
+ attr_reader :decline
39
+
40
+ sig do
41
+ params(
42
+ decline: T.nilable(Increase::DigitalWalletToken::Decline::OrHash)
43
+ ).void
44
+ end
45
+ attr_writer :decline
46
+
35
47
  # The device that was used to create the Digital Wallet Token.
36
48
  sig { returns(Increase::DigitalWalletToken::Device) }
37
49
  attr_reader :device
@@ -85,6 +97,7 @@ module Increase
85
97
  card_id: String,
86
98
  cardholder: Increase::DigitalWalletToken::Cardholder::OrHash,
87
99
  created_at: Time,
100
+ decline: T.nilable(Increase::DigitalWalletToken::Decline::OrHash),
88
101
  device: Increase::DigitalWalletToken::Device::OrHash,
89
102
  dynamic_primary_account_number:
90
103
  T.nilable(
@@ -107,6 +120,9 @@ module Increase
107
120
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
108
121
  # the Digital Wallet Token was created.
109
122
  created_at:,
123
+ # If the Digital Wallet Token was declined during provisioning, details about the
124
+ # decline.
125
+ decline:,
110
126
  # The device that was used to create the Digital Wallet Token.
111
127
  device:,
112
128
  # The redacted Dynamic Primary Account Number.
@@ -130,6 +146,7 @@ module Increase
130
146
  card_id: String,
131
147
  cardholder: Increase::DigitalWalletToken::Cardholder,
132
148
  created_at: Time,
149
+ decline: T.nilable(Increase::DigitalWalletToken::Decline),
133
150
  device: Increase::DigitalWalletToken::Device,
134
151
  dynamic_primary_account_number:
135
152
  T.nilable(
@@ -172,6 +189,109 @@ module Increase
172
189
  end
173
190
  end
174
191
 
192
+ class Decline < Increase::Internal::Type::BaseModel
193
+ OrHash =
194
+ T.type_alias do
195
+ T.any(
196
+ Increase::DigitalWalletToken::Decline,
197
+ Increase::Internal::AnyHash
198
+ )
199
+ end
200
+
201
+ # The reason the token provisioning was declined.
202
+ sig do
203
+ returns(Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol)
204
+ end
205
+ attr_accessor :reason
206
+
207
+ # If the Digital Wallet Token was declined during provisioning, details about the
208
+ # decline.
209
+ sig do
210
+ params(
211
+ reason: Increase::DigitalWalletToken::Decline::Reason::OrSymbol
212
+ ).returns(T.attached_class)
213
+ end
214
+ def self.new(
215
+ # The reason the token provisioning was declined.
216
+ reason:
217
+ )
218
+ end
219
+
220
+ sig do
221
+ override.returns(
222
+ {
223
+ reason:
224
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
225
+ }
226
+ )
227
+ end
228
+ def to_hash
229
+ end
230
+
231
+ # The reason the token provisioning was declined.
232
+ module Reason
233
+ extend Increase::Internal::Type::Enum
234
+
235
+ TaggedSymbol =
236
+ T.type_alias do
237
+ T.all(Symbol, Increase::DigitalWalletToken::Decline::Reason)
238
+ end
239
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
240
+
241
+ # The card is not active.
242
+ CARD_NOT_ACTIVE =
243
+ T.let(
244
+ :card_not_active,
245
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
246
+ )
247
+
248
+ # The card does not have a two-factor authentication method.
249
+ NO_VERIFICATION_METHOD =
250
+ T.let(
251
+ :no_verification_method,
252
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
253
+ )
254
+
255
+ # Your webhook timed out when evaluating the token provisioning attempt.
256
+ WEBHOOK_TIMED_OUT =
257
+ T.let(
258
+ :webhook_timed_out,
259
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
260
+ )
261
+
262
+ # Your webhook declined the token provisioning attempt.
263
+ WEBHOOK_DECLINED =
264
+ T.let(
265
+ :webhook_declined,
266
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
267
+ )
268
+
269
+ # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
270
+ INCORRECT_CARD_VERIFICATION_CODE =
271
+ T.let(
272
+ :incorrect_card_verification_code,
273
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
274
+ )
275
+
276
+ # The tokenization attempt was declined by the token requestor.
277
+ DECLINED_BY_TOKEN_REQUESTOR =
278
+ T.let(
279
+ :declined_by_token_requestor,
280
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
281
+ )
282
+
283
+ sig do
284
+ override.returns(
285
+ T::Array[
286
+ Increase::DigitalWalletToken::Decline::Reason::TaggedSymbol
287
+ ]
288
+ )
289
+ end
290
+ def self.values
291
+ end
292
+ end
293
+ end
294
+
175
295
  class Device < Increase::Internal::Type::BaseModel
176
296
  OrHash =
177
297
  T.type_alias do
@@ -387,6 +507,10 @@ module Increase
387
507
  Increase::DigitalWalletToken::Status::TaggedSymbol
388
508
  )
389
509
 
510
+ # The digital wallet token was declined during provisioning.
511
+ DECLINED =
512
+ T.let(:declined, Increase::DigitalWalletToken::Status::TaggedSymbol)
513
+
390
514
  sig do
391
515
  override.returns(
392
516
  T::Array[Increase::DigitalWalletToken::Status::TaggedSymbol]
@@ -552,6 +676,13 @@ module Increase
552
676
  Increase::DigitalWalletToken::Update::Status::TaggedSymbol
553
677
  )
554
678
 
679
+ # The digital wallet token was declined during provisioning.
680
+ DECLINED =
681
+ T.let(
682
+ :declined,
683
+ Increase::DigitalWalletToken::Update::Status::TaggedSymbol
684
+ )
685
+
555
686
  sig do
556
687
  override.returns(
557
688
  T::Array[
@@ -3333,7 +3333,7 @@ module Increase
3333
3333
  end
3334
3334
  OrSymbol = T.type_alias { T.any(Symbol, String) }
3335
3335
 
3336
- # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
3336
+ # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
3337
3337
  ENTITY_TAX_IDENTIFIER =
3338
3338
  T.let(
3339
3339
  :entity_tax_identifier,
@@ -544,6 +544,28 @@ module Increase
544
544
  Increase::Event::Category::TaggedSymbol
545
545
  )
546
546
 
547
+ # Occurs whenever a Loan Application is created.
548
+ LOAN_APPLICATION_CREATED =
549
+ T.let(
550
+ :"loan_application.created",
551
+ Increase::Event::Category::TaggedSymbol
552
+ )
553
+
554
+ # Occurs whenever a Loan Application is updated.
555
+ LOAN_APPLICATION_UPDATED =
556
+ T.let(
557
+ :"loan_application.updated",
558
+ Increase::Event::Category::TaggedSymbol
559
+ )
560
+
561
+ # Occurs whenever a Loan Offer is created.
562
+ LOAN_OFFER_CREATED =
563
+ T.let(:"loan_offer.created", Increase::Event::Category::TaggedSymbol)
564
+
565
+ # Occurs whenever a Loan Offer is updated.
566
+ LOAN_OFFER_UPDATED =
567
+ T.let(:"loan_offer.updated", Increase::Event::Category::TaggedSymbol)
568
+
547
569
  # Occurs whenever a Lockbox is created.
548
570
  LOCKBOX_CREATED =
549
571
  T.let(:"lockbox.created", Increase::Event::Category::TaggedSymbol)
@@ -643,6 +643,34 @@ module Increase
643
643
  Increase::EventListParams::Category::In::TaggedSymbol
644
644
  )
645
645
 
646
+ # Occurs whenever a Loan Application is created.
647
+ LOAN_APPLICATION_CREATED =
648
+ T.let(
649
+ :"loan_application.created",
650
+ Increase::EventListParams::Category::In::TaggedSymbol
651
+ )
652
+
653
+ # Occurs whenever a Loan Application is updated.
654
+ LOAN_APPLICATION_UPDATED =
655
+ T.let(
656
+ :"loan_application.updated",
657
+ Increase::EventListParams::Category::In::TaggedSymbol
658
+ )
659
+
660
+ # Occurs whenever a Loan Offer is created.
661
+ LOAN_OFFER_CREATED =
662
+ T.let(
663
+ :"loan_offer.created",
664
+ Increase::EventListParams::Category::In::TaggedSymbol
665
+ )
666
+
667
+ # Occurs whenever a Loan Offer is updated.
668
+ LOAN_OFFER_UPDATED =
669
+ T.let(
670
+ :"loan_offer.updated",
671
+ Increase::EventListParams::Category::In::TaggedSymbol
672
+ )
673
+
646
674
  # Occurs whenever a Lockbox is created.
647
675
  LOCKBOX_CREATED =
648
676
  T.let(
@@ -668,6 +668,34 @@ module Increase
668
668
  Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
669
669
  )
670
670
 
671
+ # Occurs whenever a Loan Application is created.
672
+ LOAN_APPLICATION_CREATED =
673
+ T.let(
674
+ :"loan_application.created",
675
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
676
+ )
677
+
678
+ # Occurs whenever a Loan Application is updated.
679
+ LOAN_APPLICATION_UPDATED =
680
+ T.let(
681
+ :"loan_application.updated",
682
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
683
+ )
684
+
685
+ # Occurs whenever a Loan Offer is created.
686
+ LOAN_OFFER_CREATED =
687
+ T.let(
688
+ :"loan_offer.created",
689
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
690
+ )
691
+
692
+ # Occurs whenever a Loan Offer is updated.
693
+ LOAN_OFFER_UPDATED =
694
+ T.let(
695
+ :"loan_offer.updated",
696
+ Increase::EventSubscription::SelectedEventCategory::EventCategory::TaggedSymbol
697
+ )
698
+
671
699
  # Occurs whenever a Lockbox is created.
672
700
  LOCKBOX_CREATED =
673
701
  T.let(
@@ -666,6 +666,34 @@ module Increase
666
666
  Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
667
667
  )
668
668
 
669
+ # Occurs whenever a Loan Application is created.
670
+ LOAN_APPLICATION_CREATED =
671
+ T.let(
672
+ :"loan_application.created",
673
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
674
+ )
675
+
676
+ # Occurs whenever a Loan Application is updated.
677
+ LOAN_APPLICATION_UPDATED =
678
+ T.let(
679
+ :"loan_application.updated",
680
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
681
+ )
682
+
683
+ # Occurs whenever a Loan Offer is created.
684
+ LOAN_OFFER_CREATED =
685
+ T.let(
686
+ :"loan_offer.created",
687
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
688
+ )
689
+
690
+ # Occurs whenever a Loan Offer is updated.
691
+ LOAN_OFFER_UPDATED =
692
+ T.let(
693
+ :"loan_offer.updated",
694
+ Increase::EventSubscriptionCreateParams::SelectedEventCategory::EventCategory::TaggedSymbol
695
+ )
696
+
669
697
  # Occurs whenever a Lockbox is created.
670
698
  LOCKBOX_CREATED =
671
699
  T.let(
@@ -942,24 +942,44 @@ module Increase
942
942
  sig { returns(T.nilable(Time)) }
943
943
  attr_accessor :before
944
944
 
945
+ # Filter fees created on or after this time.
946
+ sig { returns(T.nilable(Time)) }
947
+ attr_accessor :on_or_after
948
+
949
+ # Filter fees created on or before this time.
950
+ sig { returns(T.nilable(Time)) }
951
+ attr_accessor :on_or_before
952
+
945
953
  # Filter fees by their created date. The time range must not include any fees that
946
954
  # are part of an open fee statement.
947
955
  sig do
948
- params(after: T.nilable(Time), before: T.nilable(Time)).returns(
949
- T.attached_class
950
- )
956
+ params(
957
+ after: T.nilable(Time),
958
+ before: T.nilable(Time),
959
+ on_or_after: T.nilable(Time),
960
+ on_or_before: T.nilable(Time)
961
+ ).returns(T.attached_class)
951
962
  end
952
963
  def self.new(
953
964
  # Filter fees created after this time.
954
965
  after:,
955
966
  # Filter fees created before this time.
956
- before:
967
+ before:,
968
+ # Filter fees created on or after this time.
969
+ on_or_after:,
970
+ # Filter fees created on or before this time.
971
+ on_or_before:
957
972
  )
958
973
  end
959
974
 
960
975
  sig do
961
976
  override.returns(
962
- { after: T.nilable(Time), before: T.nilable(Time) }
977
+ {
978
+ after: T.nilable(Time),
979
+ before: T.nilable(Time),
980
+ on_or_after: T.nilable(Time),
981
+ on_or_before: T.nilable(Time)
982
+ }
963
983
  )
964
984
  end
965
985
  def to_hash
@@ -103,6 +103,13 @@ module Increase
103
103
  end
104
104
  attr_writer :entity_csv
105
105
 
106
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
107
+ sig { returns(T.nilable(Increase::ExportCreateParams::FeeCsv)) }
108
+ attr_reader :fee_csv
109
+
110
+ sig { params(fee_csv: Increase::ExportCreateParams::FeeCsv::OrHash).void }
111
+ attr_writer :fee_csv
112
+
106
113
  # Options for the created export. Required if `category` is equal to
107
114
  # `funding_instructions`.
108
115
  sig do
@@ -165,6 +172,7 @@ module Increase
165
172
  daily_account_balance_csv:
166
173
  Increase::ExportCreateParams::DailyAccountBalanceCsv::OrHash,
167
174
  entity_csv: Increase::ExportCreateParams::EntityCsv::OrHash,
175
+ fee_csv: Increase::ExportCreateParams::FeeCsv::OrHash,
168
176
  funding_instructions:
169
177
  Increase::ExportCreateParams::FundingInstructions::OrHash,
170
178
  transaction_csv: Increase::ExportCreateParams::TransactionCsv::OrHash,
@@ -193,6 +201,8 @@ module Increase
193
201
  daily_account_balance_csv: nil,
194
202
  # Options for the created export. Required if `category` is equal to `entity_csv`.
195
203
  entity_csv: nil,
204
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
205
+ fee_csv: nil,
196
206
  # Options for the created export. Required if `category` is equal to
197
207
  # `funding_instructions`.
198
208
  funding_instructions: nil,
@@ -223,6 +233,7 @@ module Increase
223
233
  daily_account_balance_csv:
224
234
  Increase::ExportCreateParams::DailyAccountBalanceCsv,
225
235
  entity_csv: Increase::ExportCreateParams::EntityCsv,
236
+ fee_csv: Increase::ExportCreateParams::FeeCsv,
226
237
  funding_instructions:
227
238
  Increase::ExportCreateParams::FundingInstructions,
228
239
  transaction_csv: Increase::ExportCreateParams::TransactionCsv,
@@ -306,6 +317,10 @@ module Increase
306
317
  Increase::ExportCreateParams::Category::TaggedSymbol
307
318
  )
308
319
 
320
+ # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
321
+ FEE_CSV =
322
+ T.let(:fee_csv, Increase::ExportCreateParams::Category::TaggedSymbol)
323
+
309
324
  # A PDF of a voided check.
310
325
  VOIDED_CHECK =
311
326
  T.let(
@@ -685,6 +700,142 @@ module Increase
685
700
  end
686
701
  end
687
702
 
703
+ class FeeCsv < Increase::Internal::Type::BaseModel
704
+ OrHash =
705
+ T.type_alias do
706
+ T.any(
707
+ Increase::ExportCreateParams::FeeCsv,
708
+ Increase::Internal::AnyHash
709
+ )
710
+ end
711
+
712
+ # Filter results by time range on the `created_at` attribute.
713
+ sig do
714
+ returns(T.nilable(Increase::ExportCreateParams::FeeCsv::CreatedAt))
715
+ end
716
+ attr_reader :created_at
717
+
718
+ sig do
719
+ params(
720
+ created_at: Increase::ExportCreateParams::FeeCsv::CreatedAt::OrHash
721
+ ).void
722
+ end
723
+ attr_writer :created_at
724
+
725
+ # Filter exported Fees to the specified Program.
726
+ sig { returns(T.nilable(String)) }
727
+ attr_reader :program_id
728
+
729
+ sig { params(program_id: String).void }
730
+ attr_writer :program_id
731
+
732
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
733
+ sig do
734
+ params(
735
+ created_at: Increase::ExportCreateParams::FeeCsv::CreatedAt::OrHash,
736
+ program_id: String
737
+ ).returns(T.attached_class)
738
+ end
739
+ def self.new(
740
+ # Filter results by time range on the `created_at` attribute.
741
+ created_at: nil,
742
+ # Filter exported Fees to the specified Program.
743
+ program_id: nil
744
+ )
745
+ end
746
+
747
+ sig do
748
+ override.returns(
749
+ {
750
+ created_at: Increase::ExportCreateParams::FeeCsv::CreatedAt,
751
+ program_id: String
752
+ }
753
+ )
754
+ end
755
+ def to_hash
756
+ end
757
+
758
+ class CreatedAt < Increase::Internal::Type::BaseModel
759
+ OrHash =
760
+ T.type_alias do
761
+ T.any(
762
+ Increase::ExportCreateParams::FeeCsv::CreatedAt,
763
+ Increase::Internal::AnyHash
764
+ )
765
+ end
766
+
767
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
768
+ # timestamp.
769
+ sig { returns(T.nilable(Time)) }
770
+ attr_reader :after
771
+
772
+ sig { params(after: Time).void }
773
+ attr_writer :after
774
+
775
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
776
+ # timestamp.
777
+ sig { returns(T.nilable(Time)) }
778
+ attr_reader :before
779
+
780
+ sig { params(before: Time).void }
781
+ attr_writer :before
782
+
783
+ # Return results on or after this
784
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
785
+ sig { returns(T.nilable(Time)) }
786
+ attr_reader :on_or_after
787
+
788
+ sig { params(on_or_after: Time).void }
789
+ attr_writer :on_or_after
790
+
791
+ # Return results on or before this
792
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
793
+ sig { returns(T.nilable(Time)) }
794
+ attr_reader :on_or_before
795
+
796
+ sig { params(on_or_before: Time).void }
797
+ attr_writer :on_or_before
798
+
799
+ # Filter results by time range on the `created_at` attribute.
800
+ sig do
801
+ params(
802
+ after: Time,
803
+ before: Time,
804
+ on_or_after: Time,
805
+ on_or_before: Time
806
+ ).returns(T.attached_class)
807
+ end
808
+ def self.new(
809
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
810
+ # timestamp.
811
+ after: nil,
812
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
813
+ # timestamp.
814
+ before: nil,
815
+ # Return results on or after this
816
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
817
+ on_or_after: nil,
818
+ # Return results on or before this
819
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
820
+ on_or_before: nil
821
+ )
822
+ end
823
+
824
+ sig do
825
+ override.returns(
826
+ {
827
+ after: Time,
828
+ before: Time,
829
+ on_or_after: Time,
830
+ on_or_before: Time
831
+ }
832
+ )
833
+ end
834
+ def to_hash
835
+ end
836
+ end
837
+ end
838
+
688
839
  class FundingInstructions < Increase::Internal::Type::BaseModel
689
840
  OrHash =
690
841
  T.type_alias do
@@ -75,6 +75,18 @@ module Increase
75
75
  sig { returns(Increase::FednowTransfer::Currency::TaggedSymbol) }
76
76
  attr_accessor :currency
77
77
 
78
+ # The debtor's address.
79
+ sig { returns(T.nilable(Increase::FednowTransfer::DebtorAddress)) }
80
+ attr_reader :debtor_address
81
+
82
+ sig do
83
+ params(
84
+ debtor_address:
85
+ T.nilable(Increase::FednowTransfer::DebtorAddress::OrHash)
86
+ ).void
87
+ end
88
+ attr_writer :debtor_address
89
+
78
90
  # The name of the transfer's sender. If not provided, defaults to the name of the
79
91
  # account's entity.
80
92
  sig { returns(String) }
@@ -166,6 +178,8 @@ module Increase
166
178
  T.nilable(Increase::FednowTransfer::CreditorAddress::OrHash),
167
179
  creditor_name: String,
168
180
  currency: Increase::FednowTransfer::Currency::OrSymbol,
181
+ debtor_address:
182
+ T.nilable(Increase::FednowTransfer::DebtorAddress::OrHash),
169
183
  debtor_name: String,
170
184
  external_account_id: T.nilable(String),
171
185
  idempotency_key: T.nilable(String),
@@ -206,6 +220,8 @@ module Increase
206
220
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
207
221
  # currency. For FedNow transfers this is always equal to `USD`.
208
222
  currency:,
223
+ # The debtor's address.
224
+ debtor_address:,
209
225
  # The name of the transfer's sender. If not provided, defaults to the name of the
210
226
  # account's entity.
211
227
  debtor_name:,
@@ -259,6 +275,7 @@ module Increase
259
275
  T.nilable(Increase::FednowTransfer::CreditorAddress),
260
276
  creditor_name: String,
261
277
  currency: Increase::FednowTransfer::Currency::TaggedSymbol,
278
+ debtor_address: T.nilable(Increase::FednowTransfer::DebtorAddress),
262
279
  debtor_name: String,
263
280
  external_account_id: T.nilable(String),
264
281
  idempotency_key: T.nilable(String),
@@ -607,6 +624,66 @@ module Increase
607
624
  end
608
625
  end
609
626
 
627
+ class DebtorAddress < Increase::Internal::Type::BaseModel
628
+ OrHash =
629
+ T.type_alias do
630
+ T.any(
631
+ Increase::FednowTransfer::DebtorAddress,
632
+ Increase::Internal::AnyHash
633
+ )
634
+ end
635
+
636
+ # The city, district, town, or village of the address.
637
+ sig { returns(T.nilable(String)) }
638
+ attr_accessor :city
639
+
640
+ # The first line of the address.
641
+ sig { returns(T.nilable(String)) }
642
+ attr_accessor :line1
643
+
644
+ # The ZIP code of the address.
645
+ sig { returns(T.nilable(String)) }
646
+ attr_accessor :postal_code
647
+
648
+ # The address state.
649
+ sig { returns(T.nilable(String)) }
650
+ attr_accessor :state
651
+
652
+ # The debtor's address.
653
+ sig do
654
+ params(
655
+ city: T.nilable(String),
656
+ line1: T.nilable(String),
657
+ postal_code: T.nilable(String),
658
+ state: T.nilable(String)
659
+ ).returns(T.attached_class)
660
+ end
661
+ def self.new(
662
+ # The city, district, town, or village of the address.
663
+ city:,
664
+ # The first line of the address.
665
+ line1:,
666
+ # The ZIP code of the address.
667
+ postal_code:,
668
+ # The address state.
669
+ state:
670
+ )
671
+ end
672
+
673
+ sig do
674
+ override.returns(
675
+ {
676
+ city: T.nilable(String),
677
+ line1: T.nilable(String),
678
+ postal_code: T.nilable(String),
679
+ state: T.nilable(String)
680
+ }
681
+ )
682
+ end
683
+ def to_hash
684
+ end
685
+ end
686
+
610
687
  class Rejection < Increase::Internal::Type::BaseModel
611
688
  OrHash =
612
689
  T.type_alias do