increase 1.113.0 → 1.115.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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +8 -0
  5. data/lib/increase/models/card_payment.rb +160 -4
  6. data/lib/increase/models/declined_transaction.rb +40 -1
  7. data/lib/increase/models/fednow_transfer.rb +516 -0
  8. data/lib/increase/models/fednow_transfer_approve_params.rb +14 -0
  9. data/lib/increase/models/fednow_transfer_cancel_params.rb +14 -0
  10. data/lib/increase/models/fednow_transfer_create_params.rb +188 -0
  11. data/lib/increase/models/fednow_transfer_list_params.rb +170 -0
  12. data/lib/increase/models/fednow_transfer_retrieve_params.rb +14 -0
  13. data/lib/increase/models/inbound_fednow_transfer.rb +278 -0
  14. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +100 -0
  15. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +14 -0
  16. data/lib/increase/models/pending_transaction.rb +42 -1
  17. data/lib/increase/models/real_time_decision.rb +40 -1
  18. data/lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb +64 -0
  19. data/lib/increase/models/transaction.rb +40 -1
  20. data/lib/increase/models.rb +18 -0
  21. data/lib/increase/resources/fednow_transfers.rb +159 -0
  22. data/lib/increase/resources/inbound_fednow_transfers.rb +68 -0
  23. data/lib/increase/resources/simulations/inbound_fednow_transfers.rb +49 -0
  24. data/lib/increase/resources/simulations.rb +4 -0
  25. data/lib/increase/version.rb +1 -1
  26. data/lib/increase.rb +13 -0
  27. data/rbi/increase/client.rbi +6 -0
  28. data/rbi/increase/models/card_payment.rbi +288 -0
  29. data/rbi/increase/models/declined_transaction.rbi +72 -0
  30. data/rbi/increase/models/fednow_transfer.rbi +877 -0
  31. data/rbi/increase/models/fednow_transfer_approve_params.rbi +30 -0
  32. data/rbi/increase/models/fednow_transfer_cancel_params.rbi +30 -0
  33. data/rbi/increase/models/fednow_transfer_create_params.rbi +289 -0
  34. data/rbi/increase/models/fednow_transfer_list_params.rbi +334 -0
  35. data/rbi/increase/models/fednow_transfer_retrieve_params.rbi +30 -0
  36. data/rbi/increase/models/inbound_fednow_transfer.rbi +444 -0
  37. data/rbi/increase/models/inbound_fednow_transfer_list_params.rbi +177 -0
  38. data/rbi/increase/models/inbound_fednow_transfer_retrieve_params.rbi +30 -0
  39. data/rbi/increase/models/pending_transaction.rbi +72 -0
  40. data/rbi/increase/models/real_time_decision.rbi +72 -0
  41. data/rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi +100 -0
  42. data/rbi/increase/models/transaction.rbi +72 -0
  43. data/rbi/increase/models.rbi +20 -0
  44. data/rbi/increase/resources/fednow_transfers.rbi +138 -0
  45. data/rbi/increase/resources/inbound_fednow_transfers.rbi +54 -0
  46. data/rbi/increase/resources/simulations/inbound_fednow_transfers.rbi +44 -0
  47. data/rbi/increase/resources/simulations.rbi +3 -0
  48. data/sig/increase/client.rbs +4 -0
  49. data/sig/increase/models/card_payment.rbs +68 -0
  50. data/sig/increase/models/declined_transaction.rbs +17 -0
  51. data/sig/increase/models/fednow_transfer.rbs +404 -0
  52. data/sig/increase/models/fednow_transfer_approve_params.rbs +15 -0
  53. data/sig/increase/models/fednow_transfer_cancel_params.rbs +15 -0
  54. data/sig/increase/models/fednow_transfer_create_params.rbs +155 -0
  55. data/sig/increase/models/fednow_transfer_list_params.rbs +174 -0
  56. data/sig/increase/models/fednow_transfer_retrieve_params.rbs +15 -0
  57. data/sig/increase/models/inbound_fednow_transfer.rbs +223 -0
  58. data/sig/increase/models/inbound_fednow_transfer_list_params.rbs +93 -0
  59. data/sig/increase/models/inbound_fednow_transfer_retrieve_params.rbs +15 -0
  60. data/sig/increase/models/pending_transaction.rbs +17 -0
  61. data/sig/increase/models/real_time_decision.rbs +17 -0
  62. data/sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs +61 -0
  63. data/sig/increase/models/transaction.rbs +17 -0
  64. data/sig/increase/models.rbs +18 -0
  65. data/sig/increase/resources/fednow_transfers.rbs +49 -0
  66. data/sig/increase/resources/inbound_fednow_transfers.rbs +21 -0
  67. data/sig/increase/resources/simulations/inbound_fednow_transfers.rbs +19 -0
  68. data/sig/increase/resources/simulations.rbs +2 -0
  69. metadata +41 -2
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::InboundFednowTransfers#list
6
+ class InboundFednowTransferListParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute account_id
11
+ # Filter Inbound FedNow Transfers to those belonging to the specified Account.
12
+ #
13
+ # @return [String, nil]
14
+ optional :account_id, String
15
+
16
+ # @!attribute account_number_id
17
+ # Filter Inbound FedNow Transfers to ones belonging to the specified Account
18
+ # Number.
19
+ #
20
+ # @return [String, nil]
21
+ optional :account_number_id, String
22
+
23
+ # @!attribute created_at
24
+ #
25
+ # @return [Increase::Models::InboundFednowTransferListParams::CreatedAt, nil]
26
+ optional :created_at, -> { Increase::InboundFednowTransferListParams::CreatedAt }
27
+
28
+ # @!attribute cursor
29
+ # Return the page of entries after this one.
30
+ #
31
+ # @return [String, nil]
32
+ optional :cursor, String
33
+
34
+ # @!attribute limit
35
+ # Limit the size of the list that is returned. The default (and maximum) is 100
36
+ # objects.
37
+ #
38
+ # @return [Integer, nil]
39
+ optional :limit, Integer
40
+
41
+ # @!method initialize(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
42
+ # Some parameter documentations has been truncated, see
43
+ # {Increase::Models::InboundFednowTransferListParams} for more details.
44
+ #
45
+ # @param account_id [String] Filter Inbound FedNow Transfers to those belonging to the specified Account.
46
+ #
47
+ # @param account_number_id [String] Filter Inbound FedNow Transfers to ones belonging to the specified Account Numbe
48
+ #
49
+ # @param created_at [Increase::Models::InboundFednowTransferListParams::CreatedAt]
50
+ #
51
+ # @param cursor [String] Return the page of entries after this one.
52
+ #
53
+ # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
54
+ #
55
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
56
+
57
+ class CreatedAt < Increase::Internal::Type::BaseModel
58
+ # @!attribute after
59
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
60
+ # timestamp.
61
+ #
62
+ # @return [Time, nil]
63
+ optional :after, Time
64
+
65
+ # @!attribute before
66
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
67
+ # timestamp.
68
+ #
69
+ # @return [Time, nil]
70
+ optional :before, Time
71
+
72
+ # @!attribute on_or_after
73
+ # Return results on or after this
74
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
75
+ #
76
+ # @return [Time, nil]
77
+ optional :on_or_after, Time
78
+
79
+ # @!attribute on_or_before
80
+ # Return results on or before this
81
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
82
+ #
83
+ # @return [Time, nil]
84
+ optional :on_or_before, Time
85
+
86
+ # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
87
+ # Some parameter documentations has been truncated, see
88
+ # {Increase::Models::InboundFednowTransferListParams::CreatedAt} for more details.
89
+ #
90
+ # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
91
+ #
92
+ # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
93
+ #
94
+ # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
95
+ #
96
+ # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::InboundFednowTransfers#retrieve
6
+ class InboundFednowTransferRetrieveParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -767,6 +767,16 @@ module Increase
767
767
  },
768
768
  nil?: true
769
769
 
770
+ # @!attribute original
771
+ # The original pre-authorized amount.
772
+ #
773
+ # @return [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original, nil]
774
+ required :original,
775
+ -> {
776
+ Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original
777
+ },
778
+ nil?: true
779
+
770
780
  # @!attribute prescription
771
781
  # The part of this transaction amount that was for healthcare prescriptions.
772
782
  #
@@ -837,7 +847,7 @@ module Increase
837
847
  },
838
848
  nil?: true
839
849
 
840
- # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
850
+ # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
841
851
  # Some parameter documentations has been truncated, see
842
852
  # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts}
843
853
  # for more details.
@@ -850,6 +860,8 @@ module Increase
850
860
  #
851
861
  # @param dental [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
852
862
  #
863
+ # @param original [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original, nil] The original pre-authorized amount.
864
+ #
853
865
  # @param prescription [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
854
866
  #
855
867
  # @param surcharge [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
@@ -922,6 +934,35 @@ module Increase
922
934
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
923
935
  end
924
936
 
937
+ # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#original
938
+ class Original < Increase::Internal::Type::BaseModel
939
+ # @!attribute amount
940
+ # The amount in minor units of the `currency` field. The amount is positive if it
941
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
942
+ # subtracted from the amount (such as a discount).
943
+ #
944
+ # @return [Integer]
945
+ required :amount, Integer
946
+
947
+ # @!attribute currency
948
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
949
+ # amount's currency.
950
+ #
951
+ # @return [String]
952
+ required :currency, String
953
+
954
+ # @!method initialize(amount:, currency:)
955
+ # Some parameter documentations has been truncated, see
956
+ # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original}
957
+ # for more details.
958
+ #
959
+ # The original pre-authorized amount.
960
+ #
961
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
962
+ #
963
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
964
+ end
965
+
925
966
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#prescription
926
967
  class Prescription < Increase::Internal::Type::BaseModel
927
968
  # @!attribute amount
@@ -502,6 +502,14 @@ module Increase
502
502
  -> { Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental },
503
503
  nil?: true
504
504
 
505
+ # @!attribute original
506
+ # The original pre-authorized amount.
507
+ #
508
+ # @return [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original, nil]
509
+ required :original,
510
+ -> { Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original },
511
+ nil?: true
512
+
505
513
  # @!attribute prescription
506
514
  # The part of this transaction amount that was for healthcare prescriptions.
507
515
  #
@@ -558,7 +566,7 @@ module Increase
558
566
  -> { Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts::Vision },
559
567
  nil?: true
560
568
 
561
- # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
569
+ # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
562
570
  # Some parameter documentations has been truncated, see
563
571
  # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts} for
564
572
  # more details.
@@ -571,6 +579,8 @@ module Increase
571
579
  #
572
580
  # @param dental [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
573
581
  #
582
+ # @param original [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original, nil] The original pre-authorized amount.
583
+ #
574
584
  # @param prescription [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
575
585
  #
576
586
  # @param surcharge [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
@@ -643,6 +653,35 @@ module Increase
643
653
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
644
654
  end
645
655
 
656
+ # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#original
657
+ class Original < Increase::Internal::Type::BaseModel
658
+ # @!attribute amount
659
+ # The amount in minor units of the `currency` field. The amount is positive if it
660
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
661
+ # subtracted from the amount (such as a discount).
662
+ #
663
+ # @return [Integer]
664
+ required :amount, Integer
665
+
666
+ # @!attribute currency
667
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
668
+ # amount's currency.
669
+ #
670
+ # @return [String]
671
+ required :currency, String
672
+
673
+ # @!method initialize(amount:, currency:)
674
+ # Some parameter documentations has been truncated, see
675
+ # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original}
676
+ # for more details.
677
+ #
678
+ # The original pre-authorized amount.
679
+ #
680
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
681
+ #
682
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
683
+ end
684
+
646
685
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#prescription
647
686
  class Prescription < Increase::Internal::Type::BaseModel
648
687
  # @!attribute amount
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::InboundFednowTransfers#create
7
+ class InboundFednowTransferCreateParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute account_number_id
12
+ # The identifier of the Account Number the inbound FedNow Transfer is for.
13
+ #
14
+ # @return [String]
15
+ required :account_number_id, String
16
+
17
+ # @!attribute amount
18
+ # The transfer amount in USD cents. Must be positive.
19
+ #
20
+ # @return [Integer]
21
+ required :amount, Integer
22
+
23
+ # @!attribute debtor_account_number
24
+ # The account number of the account that sent the transfer.
25
+ #
26
+ # @return [String, nil]
27
+ optional :debtor_account_number, String
28
+
29
+ # @!attribute debtor_name
30
+ # The name provided by the sender of the transfer.
31
+ #
32
+ # @return [String, nil]
33
+ optional :debtor_name, String
34
+
35
+ # @!attribute debtor_routing_number
36
+ # The routing number of the account that sent the transfer.
37
+ #
38
+ # @return [String, nil]
39
+ optional :debtor_routing_number, String
40
+
41
+ # @!attribute unstructured_remittance_information
42
+ # Additional information included with the transfer.
43
+ #
44
+ # @return [String, nil]
45
+ optional :unstructured_remittance_information, String
46
+
47
+ # @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, unstructured_remittance_information: nil, request_options: {})
48
+ # @param account_number_id [String] The identifier of the Account Number the inbound FedNow Transfer is for.
49
+ #
50
+ # @param amount [Integer] The transfer amount in USD cents. Must be positive.
51
+ #
52
+ # @param debtor_account_number [String] The account number of the account that sent the transfer.
53
+ #
54
+ # @param debtor_name [String] The name provided by the sender of the transfer.
55
+ #
56
+ # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
57
+ #
58
+ # @param unstructured_remittance_information [String] Additional information included with the transfer.
59
+ #
60
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
61
+ end
62
+ end
63
+ end
64
+ end
@@ -1567,6 +1567,14 @@ module Increase
1567
1567
  -> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Dental },
1568
1568
  nil?: true
1569
1569
 
1570
+ # @!attribute original
1571
+ # The original pre-authorized amount.
1572
+ #
1573
+ # @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil]
1574
+ required :original,
1575
+ -> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Original },
1576
+ nil?: true
1577
+
1570
1578
  # @!attribute prescription
1571
1579
  # The part of this transaction amount that was for healthcare prescriptions.
1572
1580
  #
@@ -1623,7 +1631,7 @@ module Increase
1623
1631
  -> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts::Vision },
1624
1632
  nil?: true
1625
1633
 
1626
- # @!method initialize(clinic:, dental:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1634
+ # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1627
1635
  # Some parameter documentations has been truncated, see
1628
1636
  # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts} for
1629
1637
  # more details.
@@ -1636,6 +1644,8 @@ module Increase
1636
1644
  #
1637
1645
  # @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
1638
1646
  #
1647
+ # @param original [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil] The original pre-authorized amount.
1648
+ #
1639
1649
  # @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
1640
1650
  #
1641
1651
  # @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
@@ -1708,6 +1718,35 @@ module Increase
1708
1718
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1709
1719
  end
1710
1720
 
1721
+ # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#original
1722
+ class Original < Increase::Internal::Type::BaseModel
1723
+ # @!attribute amount
1724
+ # The amount in minor units of the `currency` field. The amount is positive if it
1725
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1726
+ # subtracted from the amount (such as a discount).
1727
+ #
1728
+ # @return [Integer]
1729
+ required :amount, Integer
1730
+
1731
+ # @!attribute currency
1732
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1733
+ # amount's currency.
1734
+ #
1735
+ # @return [String]
1736
+ required :currency, String
1737
+
1738
+ # @!method initialize(amount:, currency:)
1739
+ # Some parameter documentations has been truncated, see
1740
+ # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original}
1741
+ # for more details.
1742
+ #
1743
+ # The original pre-authorized amount.
1744
+ #
1745
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1746
+ #
1747
+ # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1748
+ end
1749
+
1711
1750
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#prescription
1712
1751
  class Prescription < Increase::Internal::Type::BaseModel
1713
1752
  # @!attribute amount
@@ -317,6 +317,18 @@ module Increase
317
317
 
318
318
  ExternalAccountUpdateParams = Increase::Models::ExternalAccountUpdateParams
319
319
 
320
+ FednowTransfer = Increase::Models::FednowTransfer
321
+
322
+ FednowTransferApproveParams = Increase::Models::FednowTransferApproveParams
323
+
324
+ FednowTransferCancelParams = Increase::Models::FednowTransferCancelParams
325
+
326
+ FednowTransferCreateParams = Increase::Models::FednowTransferCreateParams
327
+
328
+ FednowTransferListParams = Increase::Models::FednowTransferListParams
329
+
330
+ FednowTransferRetrieveParams = Increase::Models::FednowTransferRetrieveParams
331
+
320
332
  File = Increase::Models::File
321
333
 
322
334
  FileCreateParams = Increase::Models::FileCreateParams
@@ -356,6 +368,12 @@ module Increase
356
368
 
357
369
  InboundCheckDepositReturnParams = Increase::Models::InboundCheckDepositReturnParams
358
370
 
371
+ InboundFednowTransfer = Increase::Models::InboundFednowTransfer
372
+
373
+ InboundFednowTransferListParams = Increase::Models::InboundFednowTransferListParams
374
+
375
+ InboundFednowTransferRetrieveParams = Increase::Models::InboundFednowTransferRetrieveParams
376
+
359
377
  InboundMailItem = Increase::Models::InboundMailItem
360
378
 
361
379
  InboundMailItemListParams = Increase::Models::InboundMailItemListParams
@@ -0,0 +1,159 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class FednowTransfers
6
+ # Some parameter documentations has been truncated, see
7
+ # {Increase::Models::FednowTransferCreateParams} for more details.
8
+ #
9
+ # Create a FedNow Transfer
10
+ #
11
+ # @overload create(account_id:, amount:, creditor_name:, debtor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, creditor_address: nil, debtor_address: nil, external_account_id: nil, require_approval: nil, routing_number: nil, request_options: {})
12
+ #
13
+ # @param account_id [String] The identifier for the account that will send the transfer.
14
+ #
15
+ # @param amount [Integer] The amount, in minor units, to send to the creditor.
16
+ #
17
+ # @param creditor_name [String] The creditor's name.
18
+ #
19
+ # @param debtor_name [String] The debtor's name.
20
+ #
21
+ # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
22
+ #
23
+ # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
24
+ #
25
+ # @param account_number [String] The creditor's account number.
26
+ #
27
+ # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress] The creditor's address.
28
+ #
29
+ # @param debtor_address [Increase::Models::FednowTransferCreateParams::DebtorAddress] The debtor's address.
30
+ #
31
+ # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
32
+ #
33
+ # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
34
+ #
35
+ # @param routing_number [String] The creditor's bank account routing number.
36
+ #
37
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
38
+ #
39
+ # @return [Increase::Models::FednowTransfer]
40
+ #
41
+ # @see Increase::Models::FednowTransferCreateParams
42
+ def create(params)
43
+ parsed, options = Increase::FednowTransferCreateParams.dump_request(params)
44
+ @client.request(
45
+ method: :post,
46
+ path: "fednow_transfers",
47
+ body: parsed,
48
+ model: Increase::FednowTransfer,
49
+ options: options
50
+ )
51
+ end
52
+
53
+ # Retrieve a FedNow Transfer
54
+ #
55
+ # @overload retrieve(fednow_transfer_id, request_options: {})
56
+ #
57
+ # @param fednow_transfer_id [String] The identifier of the FedNow Transfer.
58
+ #
59
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
60
+ #
61
+ # @return [Increase::Models::FednowTransfer]
62
+ #
63
+ # @see Increase::Models::FednowTransferRetrieveParams
64
+ def retrieve(fednow_transfer_id, params = {})
65
+ @client.request(
66
+ method: :get,
67
+ path: ["fednow_transfers/%1$s", fednow_transfer_id],
68
+ model: Increase::FednowTransfer,
69
+ options: params[:request_options]
70
+ )
71
+ end
72
+
73
+ # Some parameter documentations has been truncated, see
74
+ # {Increase::Models::FednowTransferListParams} for more details.
75
+ #
76
+ # List FedNow Transfers
77
+ #
78
+ # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
79
+ #
80
+ # @param account_id [String] Filter FedNow Transfers to those that originated from the specified Account.
81
+ #
82
+ # @param created_at [Increase::Models::FednowTransferListParams::CreatedAt]
83
+ #
84
+ # @param cursor [String] Return the page of entries after this one.
85
+ #
86
+ # @param external_account_id [String] Filter FedNow Transfers to those made to the specified External Account.
87
+ #
88
+ # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
89
+ #
90
+ # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
91
+ #
92
+ # @param status [Increase::Models::FednowTransferListParams::Status]
93
+ #
94
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
95
+ #
96
+ # @return [Increase::Internal::Page<Increase::Models::FednowTransfer>]
97
+ #
98
+ # @see Increase::Models::FednowTransferListParams
99
+ def list(params = {})
100
+ parsed, options = Increase::FednowTransferListParams.dump_request(params)
101
+ @client.request(
102
+ method: :get,
103
+ path: "fednow_transfers",
104
+ query: parsed,
105
+ page: Increase::Internal::Page,
106
+ model: Increase::FednowTransfer,
107
+ options: options
108
+ )
109
+ end
110
+
111
+ # Approve a FedNow Transfer
112
+ #
113
+ # @overload approve(fednow_transfer_id, request_options: {})
114
+ #
115
+ # @param fednow_transfer_id [String] The identifier of the FedNow Transfer to approve.
116
+ #
117
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
118
+ #
119
+ # @return [Increase::Models::FednowTransfer]
120
+ #
121
+ # @see Increase::Models::FednowTransferApproveParams
122
+ def approve(fednow_transfer_id, params = {})
123
+ @client.request(
124
+ method: :post,
125
+ path: ["fednow_transfers/%1$s/approve", fednow_transfer_id],
126
+ model: Increase::FednowTransfer,
127
+ options: params[:request_options]
128
+ )
129
+ end
130
+
131
+ # Cancel a pending FedNow Transfer
132
+ #
133
+ # @overload cancel(fednow_transfer_id, request_options: {})
134
+ #
135
+ # @param fednow_transfer_id [String] The identifier of the pending FedNow Transfer to cancel.
136
+ #
137
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
138
+ #
139
+ # @return [Increase::Models::FednowTransfer]
140
+ #
141
+ # @see Increase::Models::FednowTransferCancelParams
142
+ def cancel(fednow_transfer_id, params = {})
143
+ @client.request(
144
+ method: :post,
145
+ path: ["fednow_transfers/%1$s/cancel", fednow_transfer_id],
146
+ model: Increase::FednowTransfer,
147
+ options: params[:request_options]
148
+ )
149
+ end
150
+
151
+ # @api private
152
+ #
153
+ # @param client [Increase::Client]
154
+ def initialize(client:)
155
+ @client = client
156
+ end
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class InboundFednowTransfers
6
+ # Retrieve an Inbound FedNow Transfer
7
+ #
8
+ # @overload retrieve(inbound_fednow_transfer_id, request_options: {})
9
+ #
10
+ # @param inbound_fednow_transfer_id [String] The identifier of the Inbound FedNow Transfer to get details for.
11
+ #
12
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
13
+ #
14
+ # @return [Increase::Models::InboundFednowTransfer]
15
+ #
16
+ # @see Increase::Models::InboundFednowTransferRetrieveParams
17
+ def retrieve(inbound_fednow_transfer_id, params = {})
18
+ @client.request(
19
+ method: :get,
20
+ path: ["inbound_fednow_transfers/%1$s", inbound_fednow_transfer_id],
21
+ model: Increase::InboundFednowTransfer,
22
+ options: params[:request_options]
23
+ )
24
+ end
25
+
26
+ # Some parameter documentations has been truncated, see
27
+ # {Increase::Models::InboundFednowTransferListParams} for more details.
28
+ #
29
+ # List Inbound FedNow Transfers
30
+ #
31
+ # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
32
+ #
33
+ # @param account_id [String] Filter Inbound FedNow Transfers to those belonging to the specified Account.
34
+ #
35
+ # @param account_number_id [String] Filter Inbound FedNow Transfers to ones belonging to the specified Account Numbe
36
+ #
37
+ # @param created_at [Increase::Models::InboundFednowTransferListParams::CreatedAt]
38
+ #
39
+ # @param cursor [String] Return the page of entries after this one.
40
+ #
41
+ # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
42
+ #
43
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
44
+ #
45
+ # @return [Increase::Internal::Page<Increase::Models::InboundFednowTransfer>]
46
+ #
47
+ # @see Increase::Models::InboundFednowTransferListParams
48
+ def list(params = {})
49
+ parsed, options = Increase::InboundFednowTransferListParams.dump_request(params)
50
+ @client.request(
51
+ method: :get,
52
+ path: "inbound_fednow_transfers",
53
+ query: parsed,
54
+ page: Increase::Internal::Page,
55
+ model: Increase::InboundFednowTransfer,
56
+ options: options
57
+ )
58
+ end
59
+
60
+ # @api private
61
+ #
62
+ # @param client [Increase::Client]
63
+ def initialize(client:)
64
+ @client = client
65
+ end
66
+ end
67
+ end
68
+ end