increase 1.357.0 → 1.358.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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_statement.rb +12 -8
  4. data/lib/increase/models/card.rb +106 -1
  5. data/lib/increase/models/card_create_params.rb +63 -1
  6. data/lib/increase/models/card_renew_params.rb +22 -0
  7. data/lib/increase/models/entity_create_params.rb +8 -4
  8. data/lib/increase/models/entity_update_params.rb +8 -4
  9. data/lib/increase/models/export.rb +12 -12
  10. data/lib/increase/models/export_create_params.rb +19 -18
  11. data/lib/increase/models/inbound_fednow_transfer.rb +12 -3
  12. data/lib/increase/models/physical_card.rb +23 -1
  13. data/lib/increase/models/transaction.rb +6 -0
  14. data/lib/increase/models.rb +2 -0
  15. data/lib/increase/resources/cards.rb +29 -1
  16. data/lib/increase/resources/digital_card_profiles.rb +2 -2
  17. data/lib/increase/resources/files.rb +3 -1
  18. data/lib/increase/resources/intrafi_account_enrollments.rb +2 -2
  19. data/lib/increase/resources/physical_card_profiles.rb +1 -1
  20. data/lib/increase/resources/supplemental_documents.rb +2 -2
  21. data/lib/increase/version.rb +1 -1
  22. data/lib/increase.rb +1 -0
  23. data/rbi/increase/models/account_statement.rbi +12 -8
  24. data/rbi/increase/models/card.rbi +162 -0
  25. data/rbi/increase/models/card_create_params.rbi +120 -0
  26. data/rbi/increase/models/card_renew_params.rbi +40 -0
  27. data/rbi/increase/models/entity_create_params.rbi +8 -4
  28. data/rbi/increase/models/entity_update_params.rbi +8 -4
  29. data/rbi/increase/models/export.rbi +12 -12
  30. data/rbi/increase/models/export_create_params.rbi +18 -18
  31. data/rbi/increase/models/inbound_fednow_transfer.rbi +10 -2
  32. data/rbi/increase/models/physical_card.rbi +20 -0
  33. data/rbi/increase/models/transaction.rbi +14 -0
  34. data/rbi/increase/models.rbi +2 -0
  35. data/rbi/increase/resources/cards.rbi +22 -0
  36. data/rbi/increase/resources/digital_card_profiles.rbi +2 -2
  37. data/rbi/increase/resources/files.rbi +3 -1
  38. data/rbi/increase/resources/intrafi_account_enrollments.rbi +2 -2
  39. data/rbi/increase/resources/physical_card_profiles.rbi +1 -1
  40. data/rbi/increase/resources/supplemental_documents.rbi +2 -2
  41. data/sig/increase/models/card.rbs +79 -0
  42. data/sig/increase/models/card_create_params.rbs +52 -1
  43. data/sig/increase/models/card_renew_params.rbs +23 -0
  44. data/sig/increase/models/inbound_fednow_transfer.rbs +5 -0
  45. data/sig/increase/models/physical_card.rbs +10 -0
  46. data/sig/increase/models/transaction.rbs +8 -0
  47. data/sig/increase/models.rbs +2 -0
  48. data/sig/increase/resources/cards.rbs +6 -0
  49. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f01d0ab2d4c4e7d3224af1f12d5a47d8038890b0f4248c24c62e5450b6431d9d
4
- data.tar.gz: 35131164b9241ae6e520e93d7f2aa0d846bd3f06647fe848176086a73d10cd5b
3
+ metadata.gz: 5177cdfe1239c7b4bab3d9f51e69c9a6ec59bf783e85dfbce359eb8c83cfdddb
4
+ data.tar.gz: 3c656b8ed86c9a50b74b58d36a6c990bf07b4bea04a3038b415a0a21063ef8c8
5
5
  SHA512:
6
- metadata.gz: 67f1ac07446b1090ce316d5837dd05cde561a9d5e0667d401cf1cb09db06bdc7df41bcd8aea5a32a62f50742b12dae6519b0b8b8c7cfc8f6f194a7e44b8c0217
7
- data.tar.gz: 22ad7e0c82f0293d2c5986e9930db31791c99df74fcf68b4a41cddb9ca7b2b1c26e29fd0aa6fbad6815767a6f30b9871628d83bc4b5421f467d4fa096412a457
6
+ metadata.gz: 7993401711f57c8f5eef204efcc1a95b1e08a9b8597a09696283f9315ecf1d1b66581571a1c562cc51955253ab2629504157ed7facd2522f4ba29b3cc82e2048
7
+ data.tar.gz: 2245649be2c54f647dcfd2703671bf6461813129652e3185767c12a698c6f9151b90e71e2a6433237d94dad1a424c3a847eff0413286dd2a759121568a6eae21
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.357.0"
18
+ gem "increase", "~> 1.358.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -50,8 +50,9 @@ module Increase
50
50
  # @!attribute statement_period_end
51
51
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
52
52
  # of the period the Account Statement covers. The statement covers all
53
- # transactions up to, but not including this timestamp. Usually, this is the
54
- # beginning of the following month.
53
+ # transactions up to, but not including this timestamp. Statement periods are
54
+ # measured in UTC days, so this is usually midnight UTC on the first day of the
55
+ # following month.
55
56
  #
56
57
  # @return [Time]
57
58
  required :statement_period_end, Time
@@ -59,8 +60,9 @@ module Increase
59
60
  # @!attribute statement_period_start
60
61
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
61
62
  # start of the period the Account Statement covers. This is the first moment of
62
- # the statement period and is inclusive. Usually, this is the beginning of the
63
- # month this statement covers.
63
+ # the statement period and is inclusive. Statement periods are measured in UTC
64
+ # days, so this is usually midnight UTC on the first day of the month this
65
+ # statement covers.
64
66
  #
65
67
  # @return [Time]
66
68
  required :statement_period_start, Time
@@ -96,14 +98,16 @@ module Increase
96
98
  # @param statement_period_end [Time]
97
99
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
98
100
  # of the period the Account Statement covers. The statement covers all
99
- # transactions up to, but not including this timestamp. Usually, this is the
100
- # beginning of the following month.
101
+ # transactions up to, but not including this timestamp. Statement periods are
102
+ # measured in UTC days, so this is usually midnight UTC on the first day of the
103
+ # following month.
101
104
  #
102
105
  # @param statement_period_start [Time]
103
106
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
104
107
  # start of the period the Account Statement covers. This is the first moment of
105
- # the statement period and is inclusive. Usually, this is the beginning of the
106
- # month this statement covers.
108
+ # the statement period and is inclusive. Statement periods are measured in UTC
109
+ # days, so this is usually midnight UTC on the first day of the month this
110
+ # statement covers.
107
111
  #
108
112
  # @param type [Symbol, Increase::Models::AccountStatement::Type]
109
113
  # A constant representing the object's type. For this resource it will always be
@@ -94,6 +94,19 @@ module Increase
94
94
  # @return [String]
95
95
  required :last4, String
96
96
 
97
+ # @!attribute renewals
98
+ # Completed renewals of this Card, sorted by `renewed_at` in ascending order. Each
99
+ # renewal records the expiration date the Card had before it was renewed.
100
+ #
101
+ # @return [Array<Increase::Models::Card::Renewal>]
102
+ required :renewals, -> { Increase::Internal::Type::ArrayOf[Increase::Card::Renewal] }
103
+
104
+ # @!attribute replacement_for
105
+ # Details about the Card this Card replaces, if it was created as a replacement.
106
+ #
107
+ # @return [Increase::Models::Card::ReplacementFor, nil]
108
+ required :replacement_for, -> { Increase::Card::ReplacementFor }, nil?: true
109
+
97
110
  # @!attribute status
98
111
  # This indicates if payments can be made with the card.
99
112
  #
@@ -107,7 +120,7 @@ module Increase
107
120
  # @return [Symbol, Increase::Models::Card::Type]
108
121
  required :type, enum: -> { Increase::Card::Type }
109
122
 
110
- # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, cardholder_name:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
123
+ # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, cardholder_name:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, renewals:, replacement_for:, status:, type:)
111
124
  # Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work
112
125
  # for online purchases after you create them. All cards work on a good funds
113
126
  # model, and maintain a maximum limit of 100% of the Account’s available balance
@@ -153,6 +166,13 @@ module Increase
153
166
  #
154
167
  # @param last4 [String] The last 4 digits of the Card's Primary Account Number.
155
168
  #
169
+ # @param renewals [Array<Increase::Models::Card::Renewal>]
170
+ # Completed renewals of this Card, sorted by `renewed_at` in ascending order. Each
171
+ # renewal records the expiration date the Card had before it was renewed.
172
+ #
173
+ # @param replacement_for [Increase::Models::Card::ReplacementFor, nil]
174
+ # Details about the Card this Card replaces, if it was created as a replacement.
175
+ #
156
176
  # @param status [Symbol, Increase::Models::Card::Status]
157
177
  # This indicates if payments can be made with the card.
158
178
  #
@@ -696,6 +716,91 @@ module Increase
696
716
  # over SMS.
697
717
  end
698
718
 
719
+ class Renewal < Increase::Internal::Type::BaseModel
720
+ # @!attribute previous_expiration_month
721
+ # The month the Card expired in before this renewal, in M format (e.g., August is
722
+ # 8).
723
+ #
724
+ # @return [Integer]
725
+ required :previous_expiration_month, Integer
726
+
727
+ # @!attribute previous_expiration_year
728
+ # The year the Card expired in before this renewal, in YYYY format (e.g., 2025).
729
+ #
730
+ # @return [Integer]
731
+ required :previous_expiration_year, Integer
732
+
733
+ # @!attribute renewed_at
734
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
735
+ # the Card was renewed.
736
+ #
737
+ # @return [Time]
738
+ required :renewed_at, Time
739
+
740
+ # @!method initialize(previous_expiration_month:, previous_expiration_year:, renewed_at:)
741
+ # @param previous_expiration_month [Integer]
742
+ # The month the Card expired in before this renewal, in M format (e.g., August is
743
+ # 8).
744
+ #
745
+ # @param previous_expiration_year [Integer]
746
+ # The year the Card expired in before this renewal, in YYYY format (e.g., 2025).
747
+ #
748
+ # @param renewed_at [Time]
749
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
750
+ # the Card was renewed.
751
+ end
752
+
753
+ # @see Increase::Models::Card#replacement_for
754
+ class ReplacementFor < Increase::Internal::Type::BaseModel
755
+ # @!attribute card_id
756
+ # The identifier of the replaced Card.
757
+ #
758
+ # @return [String]
759
+ required :card_id, String
760
+
761
+ # @!attribute reason
762
+ # Why the Card was replaced. Only `expiring` notifies merchants that have the
763
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
764
+ # replaced Card that have not been deactivated to the new Card.
765
+ #
766
+ # @return [Symbol, Increase::Models::Card::ReplacementFor::Reason]
767
+ required :reason, enum: -> { Increase::Card::ReplacementFor::Reason }
768
+
769
+ # @!method initialize(card_id:, reason:)
770
+ # Details about the Card this Card replaces, if it was created as a replacement.
771
+ #
772
+ # @param card_id [String] The identifier of the replaced Card.
773
+ #
774
+ # @param reason [Symbol, Increase::Models::Card::ReplacementFor::Reason]
775
+ # Why the Card was replaced. Only `expiring` notifies merchants that have the
776
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
777
+ # replaced Card that have not been deactivated to the new Card.
778
+
779
+ # Why the Card was replaced. Only `expiring` notifies merchants that have the
780
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
781
+ # replaced Card that have not been deactivated to the new Card.
782
+ #
783
+ # @see Increase::Models::Card::ReplacementFor#reason
784
+ module Reason
785
+ extend Increase::Internal::Type::Enum
786
+
787
+ # The replaced card is expiring. Merchants with the replaced card on file will be notified of the new card, and its digital wallet tokens that have not been deactivated will move to the new card.
788
+ EXPIRING = :expiring
789
+
790
+ # The replaced card was lost. Merchants will not be notified of the new card.
791
+ LOST = :lost
792
+
793
+ # The replaced card was stolen. Merchants will not be notified of the new card.
794
+ STOLEN = :stolen
795
+
796
+ # The replaced card was used fraudulently. Merchants will not be notified of the new card.
797
+ FRAUD = :fraud
798
+
799
+ # @!method self.values
800
+ # @return [Array<Symbol>]
801
+ end
802
+ end
803
+
699
804
  # This indicates if payments can be made with the card.
700
805
  #
701
806
  # @see Increase::Models::Card#status
@@ -55,7 +55,14 @@ module Increase
55
55
  # @return [String, nil]
56
56
  optional :entity_id, String
57
57
 
58
- # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
58
+ # @!attribute replacement_for
59
+ # Details about the Card this Card replaces. Supply this when issuing a new Card
60
+ # to take over from an existing one. The replaced Card is not canceled.
61
+ #
62
+ # @return [Increase::Models::CardCreateParams::ReplacementFor, nil]
63
+ optional :replacement_for, -> { Increase::CardCreateParams::ReplacementFor }
64
+
65
+ # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, replacement_for: nil, request_options: {})
59
66
  # @param account_id [String] The Account the card should belong to.
60
67
  #
61
68
  # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
@@ -80,6 +87,10 @@ module Increase
80
87
  # The Entity the card belongs to. You only need to supply this in rare situations
81
88
  # when the card is not for the Account holder.
82
89
  #
90
+ # @param replacement_for [Increase::Models::CardCreateParams::ReplacementFor]
91
+ # Details about the Card this Card replaces. Supply this when issuing a new Card
92
+ # to take over from an existing one. The replaced Card is not canceled.
93
+ #
83
94
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
84
95
 
85
96
  class AuthorizationControls < Increase::Internal::Type::BaseModel
@@ -598,6 +609,57 @@ module Increase
598
609
  # A phone number that can be used to contact and verify the cardholder via
599
610
  # one-time passcode over SMS.
600
611
  end
612
+
613
+ class ReplacementFor < Increase::Internal::Type::BaseModel
614
+ # @!attribute card_id
615
+ # The identifier of the Card being replaced.
616
+ #
617
+ # @return [String]
618
+ required :card_id, String
619
+
620
+ # @!attribute reason
621
+ # Why the Card is being replaced. Only `expiring` notifies merchants that have the
622
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
623
+ # replaced Card that have not been deactivated to the new Card.
624
+ #
625
+ # @return [Symbol, Increase::Models::CardCreateParams::ReplacementFor::Reason]
626
+ required :reason, enum: -> { Increase::CardCreateParams::ReplacementFor::Reason }
627
+
628
+ # @!method initialize(card_id:, reason:)
629
+ # Details about the Card this Card replaces. Supply this when issuing a new Card
630
+ # to take over from an existing one. The replaced Card is not canceled.
631
+ #
632
+ # @param card_id [String] The identifier of the Card being replaced.
633
+ #
634
+ # @param reason [Symbol, Increase::Models::CardCreateParams::ReplacementFor::Reason]
635
+ # Why the Card is being replaced. Only `expiring` notifies merchants that have the
636
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
637
+ # replaced Card that have not been deactivated to the new Card.
638
+
639
+ # Why the Card is being replaced. Only `expiring` notifies merchants that have the
640
+ # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
641
+ # replaced Card that have not been deactivated to the new Card.
642
+ #
643
+ # @see Increase::Models::CardCreateParams::ReplacementFor#reason
644
+ module Reason
645
+ extend Increase::Internal::Type::Enum
646
+
647
+ # The replaced card is expiring. Merchants with the replaced card on file will be notified of the new card, and its digital wallet tokens that have not been deactivated will move to the new card.
648
+ EXPIRING = :expiring
649
+
650
+ # The replaced card was lost. Merchants will not be notified of the new card.
651
+ LOST = :lost
652
+
653
+ # The replaced card was stolen. Merchants will not be notified of the new card.
654
+ STOLEN = :stolen
655
+
656
+ # The replaced card was used fraudulently. Merchants will not be notified of the new card.
657
+ FRAUD = :fraud
658
+
659
+ # @!method self.values
660
+ # @return [Array<Symbol>]
661
+ end
662
+ end
601
663
  end
602
664
  end
603
665
  end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::Cards#renew
6
+ class CardRenewParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute card_id
11
+ # The identifier of the Card to renew.
12
+ #
13
+ # @return [String]
14
+ required :card_id, String
15
+
16
+ # @!method initialize(card_id:, request_options: {})
17
+ # @param card_id [String] The identifier of the Card to renew.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -228,7 +228,8 @@ module Increase
228
228
  # @!attribute industry_code
229
229
  # The North American Industry Classification System (NAICS) code for the
230
230
  # corporation's primary line of business. This is a number, like `5132` for
231
- # `Software Publishers`. A full list of classification codes is available
231
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
232
+ # classification codes is available
232
233
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
233
234
  #
234
235
  # @return [String, nil]
@@ -280,7 +281,8 @@ module Increase
280
281
  # @param industry_code [String]
281
282
  # The North American Industry Classification System (NAICS) code for the
282
283
  # corporation's primary line of business. This is a number, like `5132` for
283
- # `Software Publishers`. A full list of classification codes is available
284
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
285
+ # classification codes is available
284
286
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
285
287
  #
286
288
  # @param website [String]
@@ -1749,7 +1751,8 @@ module Increase
1749
1751
  # @!attribute industry_code
1750
1752
  # The North American Industry Classification System (NAICS) code for the sole
1751
1753
  # proprietorship's primary line of business. This is a number, like `5132` for
1752
- # `Software Publishers`. A full list of classification codes is available
1754
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
1755
+ # classification codes is available
1753
1756
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1754
1757
  #
1755
1758
  # @return [String, nil]
@@ -1792,7 +1795,8 @@ module Increase
1792
1795
  # @param industry_code [String]
1793
1796
  # The North American Industry Classification System (NAICS) code for the sole
1794
1797
  # proprietorship's primary line of business. This is a number, like `5132` for
1795
- # `Software Publishers`. A full list of classification codes is available
1798
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
1799
+ # classification codes is available
1796
1800
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1797
1801
  #
1798
1802
  # @param tax_identifier [String]
@@ -147,7 +147,8 @@ module Increase
147
147
  # @!attribute industry_code
148
148
  # The North American Industry Classification System (NAICS) code for the
149
149
  # corporation's primary line of business. This is a number, like `5132` for
150
- # `Software Publishers`. A full list of classification codes is available
150
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
151
+ # classification codes is available
151
152
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
152
153
  #
153
154
  # @return [String, nil]
@@ -192,7 +193,8 @@ module Increase
192
193
  # @param industry_code [String]
193
194
  # The North American Industry Classification System (NAICS) code for the
194
195
  # corporation's primary line of business. This is a number, like `5132` for
195
- # `Software Publishers`. A full list of classification codes is available
196
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
197
+ # classification codes is available
196
198
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
197
199
  #
198
200
  # @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier]
@@ -791,7 +793,8 @@ module Increase
791
793
  # @!attribute industry_code
792
794
  # The North American Industry Classification System (NAICS) code for the sole
793
795
  # proprietorship's primary line of business. This is a number, like `5132` for
794
- # `Software Publishers`. A full list of classification codes is available
796
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
797
+ # classification codes is available
795
798
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
796
799
  #
797
800
  # @return [String, nil]
@@ -832,7 +835,8 @@ module Increase
832
835
  # @param industry_code [String]
833
836
  # The North American Industry Classification System (NAICS) code for the sole
834
837
  # proprietorship's primary line of business. This is a number, like `5132` for
835
- # `Software Publishers`. A full list of classification codes is available
838
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
839
+ # classification codes is available
836
840
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
837
841
  #
838
842
  # @param sole_proprietor [Increase::Models::EntityUpdateParams::SoleProprietorship::SoleProprietor]
@@ -257,7 +257,7 @@ module Increase
257
257
  required :account_id, String, nil?: true
258
258
 
259
259
  # @!attribute effective_date
260
- # The date for which to retrieve the balance.
260
+ # The UTC date for which to retrieve the balance.
261
261
  #
262
262
  # @return [Date, nil]
263
263
  required :effective_date, Date, nil?: true
@@ -274,7 +274,7 @@ module Increase
274
274
  #
275
275
  # @param account_id [String, nil] Filter results by Account.
276
276
  #
277
- # @param effective_date [Date, nil] The date for which to retrieve the balance.
277
+ # @param effective_date [Date, nil] The UTC date for which to retrieve the balance.
278
278
  #
279
279
  # @param program_id [String, nil] Filter results by Program.
280
280
  end
@@ -334,7 +334,7 @@ module Increase
334
334
  required :account_number_id, String
335
335
 
336
336
  # @!attribute balance_date
337
- # The date of the balance to include in the letter.
337
+ # The UTC date of the balance to include in the letter.
338
338
  #
339
339
  # @return [Date, nil]
340
340
  required :balance_date, Date, nil?: true
@@ -345,7 +345,7 @@ module Increase
345
345
  #
346
346
  # @param account_number_id [String] The Account Number to create a letter for.
347
347
  #
348
- # @param balance_date [Date, nil] The date of the balance to include in the letter.
348
+ # @param balance_date [Date, nil] The UTC date of the balance to include in the letter.
349
349
  end
350
350
 
351
351
  # @see Increase::Models::Export#balance_csv
@@ -403,13 +403,13 @@ module Increase
403
403
  required :bookkeeping_account_id, String, nil?: true
404
404
 
405
405
  # @!attribute on_or_after_date
406
- # Filter balances to those on or after this date.
406
+ # Filter balances to those on or after this UTC date.
407
407
  #
408
408
  # @return [Date, nil]
409
409
  required :on_or_after_date, Date, nil?: true
410
410
 
411
411
  # @!attribute on_or_before_date
412
- # Filter balances to those on or before this date.
412
+ # Filter balances to those on or before this UTC date.
413
413
  #
414
414
  # @return [Date, nil]
415
415
  required :on_or_before_date, Date, nil?: true
@@ -420,9 +420,9 @@ module Increase
420
420
  #
421
421
  # @param bookkeeping_account_id [String, nil] Filter results by Bookkeeping Account.
422
422
  #
423
- # @param on_or_after_date [Date, nil] Filter balances to those on or after this date.
423
+ # @param on_or_after_date [Date, nil] Filter balances to those on or after this UTC date.
424
424
  #
425
- # @param on_or_before_date [Date, nil] Filter balances to those on or before this date.
425
+ # @param on_or_before_date [Date, nil] Filter balances to those on or before this UTC date.
426
426
  end
427
427
 
428
428
  # The category of the Export. We may add additional possible values for this enum
@@ -490,13 +490,13 @@ module Increase
490
490
  required :account_id, String, nil?: true
491
491
 
492
492
  # @!attribute on_or_after_date
493
- # Filter balances on or after this date.
493
+ # Filter balances on or after this UTC date.
494
494
  #
495
495
  # @return [Date, nil]
496
496
  required :on_or_after_date, Date, nil?: true
497
497
 
498
498
  # @!attribute on_or_before_date
499
- # Filter balances on or before this date.
499
+ # Filter balances on or before this UTC date.
500
500
  #
501
501
  # @return [Date, nil]
502
502
  required :on_or_before_date, Date, nil?: true
@@ -507,9 +507,9 @@ module Increase
507
507
  #
508
508
  # @param account_id [String, nil] Filter results by Account.
509
509
  #
510
- # @param on_or_after_date [Date, nil] Filter balances on or after this date.
510
+ # @param on_or_after_date [Date, nil] Filter balances on or after this UTC date.
511
511
  #
512
- # @param on_or_before_date [Date, nil] Filter balances on or before this date.
512
+ # @param on_or_before_date [Date, nil] Filter balances on or before this UTC date.
513
513
  end
514
514
 
515
515
  # @see Increase::Models::Export#dashboard_table_csv
@@ -187,10 +187,9 @@ module Increase
187
187
  optional :account_id, String
188
188
 
189
189
  # @!attribute effective_date
190
- # The date to create a BAI2 report for. If not provided, the current date will be
191
- # used. The timezone is UTC. If the current date is used, the report will include
192
- # intraday balances, otherwise it will include end-of-day balances for the
193
- # provided date.
190
+ # The UTC date to create a BAI2 report for. If not provided, the current date will
191
+ # be used. If the current date is used, the report will include intraday balances,
192
+ # otherwise it will include end-of-day balances for the provided date.
194
193
  #
195
194
  # @return [Date, nil]
196
195
  optional :effective_date, Date
@@ -211,10 +210,9 @@ module Increase
211
210
  # be included.
212
211
  #
213
212
  # @param effective_date [Date]
214
- # The date to create a BAI2 report for. If not provided, the current date will be
215
- # used. The timezone is UTC. If the current date is used, the report will include
216
- # intraday balances, otherwise it will include end-of-day balances for the
217
- # provided date.
213
+ # The UTC date to create a BAI2 report for. If not provided, the current date will
214
+ # be used. If the current date is used, the report will include intraday balances,
215
+ # otherwise it will include end-of-day balances for the provided date.
218
216
  #
219
217
  # @param program_id [String]
220
218
  # The Program to create a BAI2 report for. If not provided, all open accounts will
@@ -274,7 +272,8 @@ module Increase
274
272
  required :account_number_id, String
275
273
 
276
274
  # @!attribute balance_date
277
- # The date of the balance to include in the letter. Defaults to the current date.
275
+ # The UTC date of the balance to include in the letter. Defaults to the current
276
+ # date.
278
277
  #
279
278
  # @return [Date, nil]
280
279
  optional :balance_date, Date
@@ -285,7 +284,9 @@ module Increase
285
284
  #
286
285
  # @param account_number_id [String] The Account Number to create a letter for.
287
286
  #
288
- # @param balance_date [Date] The date of the balance to include in the letter. Defaults to the current date.
287
+ # @param balance_date [Date]
288
+ # The UTC date of the balance to include in the letter. Defaults to the current
289
+ # date.
289
290
  end
290
291
 
291
292
  class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -297,13 +298,13 @@ module Increase
297
298
  optional :bookkeeping_account_id, String
298
299
 
299
300
  # @!attribute on_or_after_date
300
- # Filter exported Balances to those on or after this date.
301
+ # Filter exported Balances to those on or after this UTC date.
301
302
  #
302
303
  # @return [Date, nil]
303
304
  optional :on_or_after_date, Date
304
305
 
305
306
  # @!attribute on_or_before_date
306
- # Filter exported Balances to those on or before this date.
307
+ # Filter exported Balances to those on or before this UTC date.
307
308
  #
308
309
  # @return [Date, nil]
309
310
  optional :on_or_before_date, Date
@@ -316,9 +317,9 @@ module Increase
316
317
  # Filter exported Bookkeeping Account Balances to the specified Bookkeeping
317
318
  # Account.
318
319
  #
319
- # @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
320
+ # @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
320
321
  #
321
- # @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
322
+ # @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
322
323
  end
323
324
 
324
325
  class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -329,13 +330,13 @@ module Increase
329
330
  optional :account_id, String
330
331
 
331
332
  # @!attribute on_or_after_date
332
- # Filter exported Balances to those on or after this date.
333
+ # Filter exported Balances to those on or after this UTC date.
333
334
  #
334
335
  # @return [Date, nil]
335
336
  optional :on_or_after_date, Date
336
337
 
337
338
  # @!attribute on_or_before_date
338
- # Filter exported Balances to those on or before this date.
339
+ # Filter exported Balances to those on or before this UTC date.
339
340
  #
340
341
  # @return [Date, nil]
341
342
  optional :on_or_before_date, Date
@@ -346,9 +347,9 @@ module Increase
346
347
  #
347
348
  # @param account_id [String] Filter exported Balances to the specified Account.
348
349
  #
349
- # @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
350
+ # @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
350
351
  #
351
- # @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
352
+ # @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
352
353
  end
353
354
 
354
355
  class EntityCsv < Increase::Internal::Type::BaseModel
@@ -84,6 +84,12 @@ module Increase
84
84
  # @return [String, nil]
85
85
  required :end_to_end_identification, String, nil?: true
86
86
 
87
+ # @!attribute message_identification
88
+ # The FedNow network identification of the transfer.
89
+ #
90
+ # @return [String]
91
+ required :message_identification, String
92
+
87
93
  # @!attribute status
88
94
  # The lifecycle status of the transfer.
89
95
  #
@@ -98,7 +104,7 @@ module Increase
98
104
  required :transaction_id, String, nil?: true
99
105
 
100
106
  # @!attribute transaction_identification
101
- # The FedNow network identification of the transfer.
107
+ # An optional identifier for the transfer set by the sending bank.
102
108
  #
103
109
  # @return [String, nil]
104
110
  required :transaction_identification, String, nil?: true
@@ -124,7 +130,7 @@ module Increase
124
130
  # @return [String, nil]
125
131
  required :unstructured_remittance_information, String, nil?: true
126
132
 
127
- # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
133
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, message_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
128
134
  # An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
129
135
  # your account.
130
136
  #
@@ -162,6 +168,8 @@ module Increase
162
168
  # @param end_to_end_identification [String, nil]
163
169
  # A free-form reference string set by the sender, to help identify the transfer.
164
170
  #
171
+ # @param message_identification [String] The FedNow network identification of the transfer.
172
+ #
165
173
  # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
166
174
  # The lifecycle status of the transfer.
167
175
  #
@@ -169,7 +177,8 @@ module Increase
169
177
  # The identifier of the Transaction object created when the transfer was
170
178
  # confirmed.
171
179
  #
172
- # @param transaction_identification [String, nil] The FedNow network identification of the transfer.
180
+ # @param transaction_identification [String, nil]
181
+ # An optional identifier for the transfer set by the sending bank.
173
182
  #
174
183
  # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
175
184
  # A constant representing the object's type. For this resource it will always be