increase 1.41.0 → 1.43.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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/ach_prenotification.rb +58 -1
  5. data/lib/increase/models/ach_prenotification_create_params.rb +15 -15
  6. data/lib/increase/models/card_validation.rb +9 -1
  7. data/lib/increase/models/check_transfer.rb +25 -1
  8. data/lib/increase/models/export.rb +3 -0
  9. data/lib/increase/models/export_create_params.rb +42 -1
  10. data/lib/increase/models/export_list_params.rb +3 -0
  11. data/lib/increase/models/intrafi_account_enrollment.rb +9 -1
  12. data/lib/increase/resources/ach_prenotifications.rb +7 -7
  13. data/lib/increase/resources/exports.rb +3 -1
  14. data/lib/increase/resources/real_time_payments_transfers.rb +2 -2
  15. data/lib/increase/version.rb +1 -1
  16. data/rbi/increase/models/ach_prenotification.rbi +95 -0
  17. data/rbi/increase/models/ach_prenotification_create_params.rbi +16 -16
  18. data/rbi/increase/models/card_validation.rbi +8 -0
  19. data/rbi/increase/models/check_transfer.rbi +35 -0
  20. data/rbi/increase/models/export.rbi +7 -0
  21. data/rbi/increase/models/export_create_params.rbi +80 -0
  22. data/rbi/increase/models/export_list_params.rbi +7 -0
  23. data/rbi/increase/models/intrafi_account_enrollment.rbi +8 -0
  24. data/rbi/increase/resources/ach_prenotifications.rbi +8 -8
  25. data/rbi/increase/resources/exports.rbi +5 -0
  26. data/rbi/increase/resources/real_time_payments_transfers.rbi +2 -2
  27. data/sig/increase/models/ach_prenotification.rbs +44 -0
  28. data/sig/increase/models/card_validation.rbs +5 -0
  29. data/sig/increase/models/check_transfer.rbs +19 -0
  30. data/sig/increase/models/export.rbs +4 -0
  31. data/sig/increase/models/export_create_params.rbs +29 -0
  32. data/sig/increase/models/export_list_params.rbs +4 -0
  33. data/sig/increase/models/intrafi_account_enrollment.rbs +5 -0
  34. data/sig/increase/resources/exports.rbs +1 -0
  35. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ad2109026838ecd009f8f585a9d78d811a54ea51119a6ee90d58591e6971073c
4
- data.tar.gz: b2d38b611af5a6aefb3fffd696dc6ce1b8c52caf1f5c0f4b9e01c0eddf3c3a4d
3
+ metadata.gz: a57ecc770225bdbc7ba167bd392716d0f6efbbb2ce0604171ffa148fc71dfe02
4
+ data.tar.gz: c5f76210785aa79edd64949f3faa3c28e7a88b8e94b160ff3da39fd145f09592
5
5
  SHA512:
6
- metadata.gz: 3152036589ca7ce8ca66c18df6527b70e83041006fb5759819debebfe45c769c9bb9b5ee55f86e0fac76b9d1297c379d94f0798d2a1a40eb5c9d1e0bf97c41bc
7
- data.tar.gz: 9e8ab6d12ab52ee63af4d16053696bab16b9a7812830533fa892b741b1de898f5e2fc9c592c15fb3178a62f9c45e05d342f169efbcac4d896d277e9ea1958c9c
6
+ metadata.gz: 4f361daa77d03aa58f84957a9674ab3dba80e5a0ac84951080782a11b606c41071cecc4aceac8db26b57d30b1477ac5c611eaefb4194f3e9b23495e57aa693d7
7
+ data.tar.gz: '08a099bd8c76075d018b4959e9cb41c5522f9690c59e0bd1ce9ee34c03f5a19630b2195c6a3f08a8b26bb0c34e98632ca0c537703f7b31c83e67a1f0a5d4ed95'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.43.0 (2025-08-20)
4
+
5
+ Full Changelog: [v1.42.0...v1.43.0](https://github.com/Increase/increase-ruby/compare/v1.42.0...v1.43.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([833acde](https://github.com/Increase/increase-ruby/commit/833acdeac127dc43d05dfe725fd2e2d5e7b52d6f))
10
+
11
+ ## 1.42.0 (2025-08-20)
12
+
13
+ Full Changelog: [v1.41.0...v1.42.0](https://github.com/Increase/increase-ruby/compare/v1.41.0...v1.42.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([e975675](https://github.com/Increase/increase-ruby/commit/e9756757032d120e4a778dc5ce990386e03f05bf))
18
+ * **api:** api update ([965f3c0](https://github.com/Increase/increase-ruby/commit/965f3c0470e25fb0be5eafe1d0d3ae339bafa72a))
19
+
3
20
  ## 1.41.0 (2025-08-20)
4
21
 
5
22
  Full Changelog: [v1.40.0...v1.41.0](https://github.com/Increase/increase-ruby/compare/v1.40.0...v1.41.0)
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.41.0"
18
+ gem "increase", "~> 1.43.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The account that sent the ACH Prenotification.
15
+ #
16
+ # @return [String, nil]
17
+ required :account_id, String, nil?: true
18
+
13
19
  # @!attribute account_number
14
20
  # The destination account number.
15
21
  #
@@ -75,6 +81,19 @@ module Increase
75
81
  # @return [String, nil]
76
82
  required :idempotency_key, String, nil?: true
77
83
 
84
+ # @!attribute individual_id
85
+ # Your identifier for the recipient.
86
+ #
87
+ # @return [String, nil]
88
+ required :individual_id, String, nil?: true
89
+
90
+ # @!attribute individual_name
91
+ # The name of the recipient. This value is informational and not verified by the
92
+ # recipient's bank.
93
+ #
94
+ # @return [String, nil]
95
+ required :individual_name, String, nil?: true
96
+
78
97
  # @!attribute notifications_of_change
79
98
  # If the receiving bank notifies that future transfers should use different
80
99
  # details, this will contain those details.
@@ -95,6 +114,14 @@ module Increase
95
114
  # @return [String]
96
115
  required :routing_number, String
97
116
 
117
+ # @!attribute standard_entry_class_code
118
+ # The Standard Entry Class (SEC) code to use for the ACH Prenotification.
119
+ #
120
+ # @return [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil]
121
+ required :standard_entry_class_code,
122
+ enum: -> { Increase::ACHPrenotification::StandardEntryClassCode },
123
+ nil?: true
124
+
98
125
  # @!attribute status
99
126
  # The lifecycle status of the ACH Prenotification.
100
127
  #
@@ -108,7 +135,7 @@ module Increase
108
135
  # @return [Symbol, Increase::Models::ACHPrenotification::Type]
109
136
  required :type, enum: -> { Increase::ACHPrenotification::Type }
110
137
 
111
- # @!method initialize(id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, notifications_of_change:, prenotification_return:, routing_number:, status:, type:)
138
+ # @!method initialize(id:, account_id:, account_number:, addendum:, company_descriptive_date:, company_discretionary_data:, company_entry_description:, company_name:, created_at:, credit_debit_indicator:, effective_date:, idempotency_key:, individual_id:, individual_name:, notifications_of_change:, prenotification_return:, routing_number:, standard_entry_class_code:, status:, type:)
112
139
  # Some parameter documentations has been truncated, see
113
140
  # {Increase::Models::ACHPrenotification} for more details.
114
141
  #
@@ -117,6 +144,8 @@ module Increase
117
144
  #
118
145
  # @param id [String] The ACH Prenotification's identifier.
119
146
  #
147
+ # @param account_id [String, nil] The account that sent the ACH Prenotification.
148
+ #
120
149
  # @param account_number [String] The destination account number.
121
150
  #
122
151
  # @param addendum [String, nil] Additional information for the recipient.
@@ -137,12 +166,18 @@ module Increase
137
166
  #
138
167
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
139
168
  #
169
+ # @param individual_id [String, nil] Your identifier for the recipient.
170
+ #
171
+ # @param individual_name [String, nil] The name of the recipient. This value is informational and not verified by the r
172
+ #
140
173
  # @param notifications_of_change [Array<Increase::Models::ACHPrenotification::NotificationsOfChange>] If the receiving bank notifies that future transfers should use different detail
141
174
  #
142
175
  # @param prenotification_return [Increase::Models::ACHPrenotification::PrenotificationReturn, nil] If your prenotification is returned, this will contain details of the return.
143
176
  #
144
177
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
145
178
  #
179
+ # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotification::StandardEntryClassCode, nil] The Standard Entry Class (SEC) code to use for the ACH Prenotification.
180
+ #
146
181
  # @param status [Symbol, Increase::Models::ACHPrenotification::Status] The lifecycle status of the ACH Prenotification.
147
182
  #
148
183
  # @param type [Symbol, Increase::Models::ACHPrenotification::Type] A constant representing the object's type. For this resource it will always be `
@@ -523,6 +558,28 @@ module Increase
523
558
  end
524
559
  end
525
560
 
561
+ # The Standard Entry Class (SEC) code to use for the ACH Prenotification.
562
+ #
563
+ # @see Increase::Models::ACHPrenotification#standard_entry_class_code
564
+ module StandardEntryClassCode
565
+ extend Increase::Internal::Type::Enum
566
+
567
+ # Corporate Credit and Debit (CCD).
568
+ CORPORATE_CREDIT_OR_DEBIT = :corporate_credit_or_debit
569
+
570
+ # Corporate Trade Exchange (CTX).
571
+ CORPORATE_TRADE_EXCHANGE = :corporate_trade_exchange
572
+
573
+ # Prearranged Payments and Deposits (PPD).
574
+ PREARRANGED_PAYMENTS_AND_DEPOSIT = :prearranged_payments_and_deposit
575
+
576
+ # Internet Initiated (WEB).
577
+ INTERNET_INITIATED = :internet_initiated
578
+
579
+ # @!method self.values
580
+ # @return [Array<Symbol>]
581
+ end
582
+
526
583
  # The lifecycle status of the ACH Prenotification.
527
584
  #
528
585
  # @see Increase::Models::ACHPrenotification#status
@@ -8,7 +8,7 @@ module Increase
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute account_id
11
- # The Increase identifier for the account that will send the transfer.
11
+ # The Increase identifier for the account that will send the ACH Prenotification.
12
12
  #
13
13
  # @return [String]
14
14
  required :account_id, String
@@ -33,19 +33,19 @@ module Increase
33
33
  optional :addendum, String
34
34
 
35
35
  # @!attribute company_descriptive_date
36
- # The description of the date of the transfer.
36
+ # The description of the date of the ACH Prenotification.
37
37
  #
38
38
  # @return [String, nil]
39
39
  optional :company_descriptive_date, String
40
40
 
41
41
  # @!attribute company_discretionary_data
42
- # The data you choose to associate with the transfer.
42
+ # The data you choose to associate with the ACH Prenotification.
43
43
  #
44
44
  # @return [String, nil]
45
45
  optional :company_discretionary_data, String
46
46
 
47
47
  # @!attribute company_entry_description
48
- # The description of the transfer you wish to be shown to the recipient.
48
+ # The description you wish to be shown to the recipient.
49
49
  #
50
50
  # @return [String, nil]
51
51
  optional :company_entry_description, String
@@ -64,21 +64,21 @@ module Increase
64
64
  enum: -> { Increase::ACHPrenotificationCreateParams::CreditDebitIndicator }
65
65
 
66
66
  # @!attribute effective_date
67
- # The transfer effective date in
67
+ # The ACH Prenotification effective date in
68
68
  # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
69
69
  #
70
70
  # @return [Date, nil]
71
71
  optional :effective_date, Date
72
72
 
73
73
  # @!attribute individual_id
74
- # Your identifier for the transfer recipient.
74
+ # Your identifier for the recipient.
75
75
  #
76
76
  # @return [String, nil]
77
77
  optional :individual_id, String
78
78
 
79
79
  # @!attribute individual_name
80
- # The name of the transfer recipient. This value is information and not verified
81
- # by the recipient's bank.
80
+ # The name of therecipient. This value is informational and not verified by the
81
+ # recipient's bank.
82
82
  #
83
83
  # @return [String, nil]
84
84
  optional :individual_name, String
@@ -94,7 +94,7 @@ module Increase
94
94
  # Some parameter documentations has been truncated, see
95
95
  # {Increase::Models::ACHPrenotificationCreateParams} for more details.
96
96
  #
97
- # @param account_id [String] The Increase identifier for the account that will send the transfer.
97
+ # @param account_id [String] The Increase identifier for the account that will send the ACH Prenotification.
98
98
  #
99
99
  # @param account_number [String] The account number for the destination account.
100
100
  #
@@ -102,21 +102,21 @@ module Increase
102
102
  #
103
103
  # @param addendum [String] Additional information that will be sent to the recipient.
104
104
  #
105
- # @param company_descriptive_date [String] The description of the date of the transfer.
105
+ # @param company_descriptive_date [String] The description of the date of the ACH Prenotification.
106
106
  #
107
- # @param company_discretionary_data [String] The data you choose to associate with the transfer.
107
+ # @param company_discretionary_data [String] The data you choose to associate with the ACH Prenotification.
108
108
  #
109
- # @param company_entry_description [String] The description of the transfer you wish to be shown to the recipient.
109
+ # @param company_entry_description [String] The description you wish to be shown to the recipient.
110
110
  #
111
111
  # @param company_name [String] The name by which the recipient knows you.
112
112
  #
113
113
  # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit.
114
114
  #
115
- # @param effective_date [Date] The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601
115
+ # @param effective_date [Date] The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wi
116
116
  #
117
- # @param individual_id [String] Your identifier for the transfer recipient.
117
+ # @param individual_id [String] Your identifier for the recipient.
118
118
  #
119
- # @param individual_name [String] The name of the transfer recipient. This value is information and not verified b
119
+ # @param individual_name [String] The name of therecipient. This value is informational and not verified by the re
120
120
  #
121
121
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the ACH Prenotification.
122
122
  #
@@ -23,6 +23,12 @@ module Increase
23
23
  # @return [String]
24
24
  required :account_id, String
25
25
 
26
+ # @!attribute card_token_id
27
+ # The ID of the Card Token that was used to validate the card.
28
+ #
29
+ # @return [String]
30
+ required :card_token_id, String
31
+
26
32
  # @!attribute cardholder_first_name
27
33
  # The cardholder's first name.
28
34
  #
@@ -133,7 +139,7 @@ module Increase
133
139
  # @return [Symbol, Increase::Models::CardValidation::Type]
134
140
  required :type, enum: -> { Increase::CardValidation::Type }
135
141
 
136
- # @!method initialize(id:, acceptance:, account_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, status:, submission:, type:)
142
+ # @!method initialize(id:, acceptance:, account_id:, card_token_id:, cardholder_first_name:, cardholder_last_name:, cardholder_middle_name:, cardholder_postal_code:, cardholder_street_address:, created_at:, created_by:, decline:, idempotency_key:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, status:, submission:, type:)
137
143
  # Some parameter documentations has been truncated, see
138
144
  # {Increase::Models::CardValidation} for more details.
139
145
  #
@@ -146,6 +152,8 @@ module Increase
146
152
  #
147
153
  # @param account_id [String] The identifier of the Account from which to send the validation.
148
154
  #
155
+ # @param card_token_id [String] The ID of the Card Token that was used to validate the card.
156
+ #
149
157
  # @param cardholder_first_name [String, nil] The cardholder's first name.
150
158
  #
151
159
  # @param cardholder_last_name [String, nil] The cardholder's last name.
@@ -42,6 +42,12 @@ module Increase
42
42
  # @return [String, nil]
43
43
  required :approved_inbound_check_deposit_id, String, nil?: true
44
44
 
45
+ # @!attribute balance_check
46
+ # How the account's available balance should be checked.
47
+ #
48
+ # @return [Symbol, Increase::Models::CheckTransfer::BalanceCheck, nil]
49
+ required :balance_check, enum: -> { Increase::CheckTransfer::BalanceCheck }, nil?: true
50
+
45
51
  # @!attribute cancellation
46
52
  # If your account requires approvals for transfers and the transfer was not
47
53
  # approved, this will contain details of the cancellation.
@@ -158,7 +164,7 @@ module Increase
158
164
  # @return [Symbol, Increase::Models::CheckTransfer::Type]
159
165
  required :type, enum: -> { Increase::CheckTransfer::Type }
160
166
 
161
- # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:)
167
+ # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, balance_check:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:)
162
168
  # Some parameter documentations has been truncated, see
163
169
  # {Increase::Models::CheckTransfer} for more details.
164
170
  #
@@ -177,6 +183,8 @@ module Increase
177
183
  #
178
184
  # @param approved_inbound_check_deposit_id [String, nil] If the Check Transfer was successfully deposited, this will contain the identifi
179
185
  #
186
+ # @param balance_check [Symbol, Increase::Models::CheckTransfer::BalanceCheck, nil] How the account's available balance should be checked.
187
+ #
180
188
  # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
181
189
  #
182
190
  # @param check_number [String] The check number printed on the check.
@@ -239,6 +247,22 @@ module Increase
239
247
  # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
240
248
  end
241
249
 
250
+ # How the account's available balance should be checked.
251
+ #
252
+ # @see Increase::Models::CheckTransfer#balance_check
253
+ module BalanceCheck
254
+ extend Increase::Internal::Type::Enum
255
+
256
+ # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
257
+ FULL = :full
258
+
259
+ # No balance check will performed; a zero-dollar Pending Transaction will be created.
260
+ NONE = :none
261
+
262
+ # @!method self.values
263
+ # @return [Array<Symbol>]
264
+ end
265
+
242
266
  # @see Increase::Models::CheckTransfer#cancellation
243
267
  class Cancellation < Increase::Internal::Type::BaseModel
244
268
  # @!attribute canceled_at
@@ -94,6 +94,9 @@ module Increase
94
94
  # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
95
95
  ACCOUNT_STATEMENT_OFX = :account_statement_ofx
96
96
 
97
+ # Export a BAI2 file of transactions and balances for a given date and optional Account.
98
+ ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
99
+
97
100
  # Export a CSV of all transactions for a given time range.
98
101
  TRANSACTION_CSV = :transaction_csv
99
102
 
@@ -13,6 +13,13 @@ module Increase
13
13
  # @return [Symbol, Increase::Models::ExportCreateParams::Category]
14
14
  required :category, enum: -> { Increase::ExportCreateParams::Category }
15
15
 
16
+ # @!attribute account_statement_bai2
17
+ # Options for the created export. Required if `category` is equal to
18
+ # `account_statement_bai2`.
19
+ #
20
+ # @return [Increase::Models::ExportCreateParams::AccountStatementBai2, nil]
21
+ optional :account_statement_bai2, -> { Increase::ExportCreateParams::AccountStatementBai2 }
22
+
16
23
  # @!attribute account_statement_ofx
17
24
  # Options for the created export. Required if `category` is equal to
18
25
  # `account_statement_ofx`.
@@ -54,12 +61,14 @@ module Increase
54
61
  # @return [Object, nil]
55
62
  optional :vendor_csv, Increase::Internal::Type::Unknown
56
63
 
57
- # @!method initialize(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {})
64
+ # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {})
58
65
  # Some parameter documentations has been truncated, see
59
66
  # {Increase::Models::ExportCreateParams} for more details.
60
67
  #
61
68
  # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
62
69
  #
70
+ # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat
71
+ #
63
72
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
64
73
  #
65
74
  # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
@@ -83,6 +92,9 @@ module Increase
83
92
  # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
84
93
  ACCOUNT_STATEMENT_OFX = :account_statement_ofx
85
94
 
95
+ # Export a BAI2 file of transactions and balances for a given date and optional Account.
96
+ ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
97
+
86
98
  # Export a CSV of all transactions for a given time range.
87
99
  TRANSACTION_CSV = :transaction_csv
88
100
 
@@ -102,6 +114,35 @@ module Increase
102
114
  # @return [Array<Symbol>]
103
115
  end
104
116
 
117
+ class AccountStatementBai2 < Increase::Internal::Type::BaseModel
118
+ # @!attribute account_id
119
+ # The Account to create a BAI2 report for. If not provided, all open accounts will
120
+ # be included.
121
+ #
122
+ # @return [String, nil]
123
+ optional :account_id, String
124
+
125
+ # @!attribute effective_date
126
+ # The date to create a BAI2 report for. If not provided, the current date will be
127
+ # used. The timezone is UTC. If the current date is used, the report will include
128
+ # intraday balances, otherwise it will include end-of-day balances for the
129
+ # provided date.
130
+ #
131
+ # @return [Date, nil]
132
+ optional :effective_date, Date
133
+
134
+ # @!method initialize(account_id: nil, effective_date: nil)
135
+ # Some parameter documentations has been truncated, see
136
+ # {Increase::Models::ExportCreateParams::AccountStatementBai2} for more details.
137
+ #
138
+ # Options for the created export. Required if `category` is equal to
139
+ # `account_statement_bai2`.
140
+ #
141
+ # @param account_id [String] The Account to create a BAI2 report for. If not provided, all open accounts will
142
+ #
143
+ # @param effective_date [Date] The date to create a BAI2 report for. If not provided, the current date will be
144
+ end
145
+
105
146
  class AccountStatementOfx < Increase::Internal::Type::BaseModel
106
147
  # @!attribute account_id
107
148
  # The Account to create a statement for.
@@ -85,6 +85,9 @@ module Increase
85
85
  # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
86
86
  ACCOUNT_STATEMENT_OFX = :account_statement_ofx
87
87
 
88
+ # Export a BAI2 file of transactions and balances for a given date and optional Account.
89
+ ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
90
+
88
91
  # Export a CSV of all transactions for a given time range.
89
92
  TRANSACTION_CSV = :transaction_csv
90
93
 
@@ -23,6 +23,12 @@ module Increase
23
23
  # @return [Time]
24
24
  required :created_at, Time
25
25
 
26
+ # @!attribute email_address
27
+ # The contact email for the account owner, to be shared with IntraFi.
28
+ #
29
+ # @return [String, nil]
30
+ required :email_address, String, nil?: true
31
+
26
32
  # @!attribute idempotency_key
27
33
  # The idempotency key you chose for this object. This value is unique across
28
34
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -52,7 +58,7 @@ module Increase
52
58
  # @return [Symbol, Increase::Models::IntrafiAccountEnrollment::Type]
53
59
  required :type, enum: -> { Increase::IntrafiAccountEnrollment::Type }
54
60
 
55
- # @!method initialize(id:, account_id:, created_at:, idempotency_key:, intrafi_id:, status:, type:)
61
+ # @!method initialize(id:, account_id:, created_at:, email_address:, idempotency_key:, intrafi_id:, status:, type:)
56
62
  # Some parameter documentations has been truncated, see
57
63
  # {Increase::Models::IntrafiAccountEnrollment} for more details.
58
64
  #
@@ -70,6 +76,8 @@ module Increase
70
76
  #
71
77
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
72
78
  #
79
+ # @param email_address [String, nil] The contact email for the account owner, to be shared with IntraFi.
80
+ #
73
81
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
74
82
  #
75
83
  # @param intrafi_id [String] The identifier of the account in IntraFi's system. This identifier will be print
@@ -10,7 +10,7 @@ module Increase
10
10
  #
11
11
  # @overload create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {})
12
12
  #
13
- # @param account_id [String] The Increase identifier for the account that will send the transfer.
13
+ # @param account_id [String] The Increase identifier for the account that will send the ACH Prenotification.
14
14
  #
15
15
  # @param account_number [String] The account number for the destination account.
16
16
  #
@@ -18,21 +18,21 @@ module Increase
18
18
  #
19
19
  # @param addendum [String] Additional information that will be sent to the recipient.
20
20
  #
21
- # @param company_descriptive_date [String] The description of the date of the transfer.
21
+ # @param company_descriptive_date [String] The description of the date of the ACH Prenotification.
22
22
  #
23
- # @param company_discretionary_data [String] The data you choose to associate with the transfer.
23
+ # @param company_discretionary_data [String] The data you choose to associate with the ACH Prenotification.
24
24
  #
25
- # @param company_entry_description [String] The description of the transfer you wish to be shown to the recipient.
25
+ # @param company_entry_description [String] The description you wish to be shown to the recipient.
26
26
  #
27
27
  # @param company_name [String] The name by which the recipient knows you.
28
28
  #
29
29
  # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit.
30
30
  #
31
- # @param effective_date [Date] The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601
31
+ # @param effective_date [Date] The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wi
32
32
  #
33
- # @param individual_id [String] Your identifier for the transfer recipient.
33
+ # @param individual_id [String] Your identifier for the recipient.
34
34
  #
35
- # @param individual_name [String] The name of the transfer recipient. This value is information and not verified b
35
+ # @param individual_name [String] The name of therecipient. This value is informational and not verified by the re
36
36
  #
37
37
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The Standard Entry Class (SEC) code to use for the ACH Prenotification.
38
38
  #
@@ -8,10 +8,12 @@ module Increase
8
8
  #
9
9
  # Create an Export
10
10
  #
11
- # @overload create(category:, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {})
11
+ # @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, transaction_csv: nil, vendor_csv: nil, request_options: {})
12
12
  #
13
13
  # @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
14
14
  #
15
+ # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2] Options for the created export. Required if `category` is equal to `account_stat
16
+ #
15
17
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
16
18
  #
17
19
  # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
@@ -106,7 +106,7 @@ module Increase
106
106
  )
107
107
  end
108
108
 
109
- # Approves an Real-Time Payments Transfer in a pending_approval state.
109
+ # Approves a Real-Time Payments Transfer in a pending_approval state.
110
110
  #
111
111
  # @overload approve(real_time_payments_transfer_id, request_options: {})
112
112
  #
@@ -126,7 +126,7 @@ module Increase
126
126
  )
127
127
  end
128
128
 
129
- # Cancels an Real-Time Payments Transfer in a pending_approval state.
129
+ # Cancels a Real-Time Payments Transfer in a pending_approval state.
130
130
  #
131
131
  # @overload cancel(real_time_payments_transfer_id, request_options: {})
132
132
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.41.0"
4
+ VERSION = "1.43.0"
5
5
  end