increase 1.40.0 → 1.42.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/increase/models/ach_prenotification.rb +58 -1
- data/lib/increase/models/ach_prenotification_create_params.rb +15 -15
- data/lib/increase/models/card_validation.rb +9 -1
- data/lib/increase/models/check_transfer.rb +25 -1
- data/lib/increase/models/export.rb +3 -0
- data/lib/increase/models/export_create_params.rb +42 -1
- data/lib/increase/models/export_list_params.rb +3 -0
- data/lib/increase/models/intrafi_account_enrollment.rb +9 -1
- data/lib/increase/models/transaction.rb +30 -1
- data/lib/increase/models/transaction_list_params.rb +3 -0
- data/lib/increase/resources/ach_prenotifications.rb +7 -7
- data/lib/increase/resources/exports.rb +3 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/ach_prenotification.rbi +95 -0
- data/rbi/increase/models/ach_prenotification_create_params.rbi +16 -16
- data/rbi/increase/models/card_validation.rbi +8 -0
- data/rbi/increase/models/check_transfer.rbi +35 -0
- data/rbi/increase/models/export.rbi +7 -0
- data/rbi/increase/models/export_create_params.rbi +80 -0
- data/rbi/increase/models/export_list_params.rbi +7 -0
- data/rbi/increase/models/intrafi_account_enrollment.rbi +8 -0
- data/rbi/increase/models/transaction.rbi +63 -0
- data/rbi/increase/models/transaction_list_params.rbi +7 -0
- data/rbi/increase/resources/ach_prenotifications.rbi +8 -8
- data/rbi/increase/resources/exports.rbi +5 -0
- data/sig/increase/models/ach_prenotification.rbs +44 -0
- data/sig/increase/models/card_validation.rbs +5 -0
- data/sig/increase/models/check_transfer.rbs +19 -0
- data/sig/increase/models/export.rbs +4 -0
- data/sig/increase/models/export_create_params.rbs +29 -0
- data/sig/increase/models/export_list_params.rbs +4 -0
- data/sig/increase/models/intrafi_account_enrollment.rbs +5 -0
- data/sig/increase/models/transaction.rbs +19 -0
- data/sig/increase/models/transaction_list_params.rbs +4 -0
- data/sig/increase/resources/exports.rbs +1 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c57da5dc6fc00e465a563cfa8c98217e8148d0c06dc5a7af2c673d6dab3218e2
|
4
|
+
data.tar.gz: 9d0a8df196481d21309f69d57ea6d8621024f35c2e0c62c03459650447f48bbf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6173996d7d3278bbd0b3912f26d2ab51a8573089d4f162b91e493a3f8a309e01c367c0b980cb2dbb744830475c3108cdfbb317e1751be3e77a5e4e49feb67d08
|
7
|
+
data.tar.gz: 4d8c8427e657b52991ef51024d8dc1ef521abbda35fb5baca2324917b029fa2a2ad468478008dee3aacb8fbf063cbfbdb3d721efc6173c32c8ccbe5b106c6b96
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,22 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.42.0 (2025-08-20)
|
4
|
+
|
5
|
+
Full Changelog: [v1.41.0...v1.42.0](https://github.com/Increase/increase-ruby/compare/v1.41.0...v1.42.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([e975675](https://github.com/Increase/increase-ruby/commit/e9756757032d120e4a778dc5ce990386e03f05bf))
|
10
|
+
* **api:** api update ([965f3c0](https://github.com/Increase/increase-ruby/commit/965f3c0470e25fb0be5eafe1d0d3ae339bafa72a))
|
11
|
+
|
12
|
+
## 1.41.0 (2025-08-20)
|
13
|
+
|
14
|
+
Full Changelog: [v1.40.0...v1.41.0](https://github.com/Increase/increase-ruby/compare/v1.40.0...v1.41.0)
|
15
|
+
|
16
|
+
### Features
|
17
|
+
|
18
|
+
* **api:** api update ([94299db](https://github.com/Increase/increase-ruby/commit/94299db1b856eb40e9a504c7e0cbd582bdf1936b))
|
19
|
+
|
3
20
|
## 1.40.0 (2025-08-20)
|
4
21
|
|
5
22
|
Full Changelog: [v1.39.0...v1.40.0](https://github.com/Increase/increase-ruby/compare/v1.39.0...v1.40.0)
|
data/README.md
CHANGED
@@ -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
|
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
|
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
|
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
|
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
|
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
|
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
|
81
|
-
#
|
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
|
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
|
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
|
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
|
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
|
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
|
117
|
+
# @param individual_id [String] Your identifier for the recipient.
|
118
118
|
#
|
119
|
-
# @param individual_name [String] The name of
|
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
|
@@ -484,6 +484,14 @@ module Increase
|
|
484
484
|
-> { Increase::Transaction::Source::SwiftTransferIntention },
|
485
485
|
nil?: true
|
486
486
|
|
487
|
+
# @!attribute swift_transfer_return
|
488
|
+
# A Swift Transfer Return object. This field will be present in the JSON response
|
489
|
+
# if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
|
490
|
+
# Return is created when a Swift Transfer is returned by the receiving bank.
|
491
|
+
#
|
492
|
+
# @return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil]
|
493
|
+
required :swift_transfer_return, -> { Increase::Transaction::Source::SwiftTransferReturn }, nil?: true
|
494
|
+
|
487
495
|
# @!attribute wire_transfer_intention
|
488
496
|
# A Wire Transfer Intention object. This field will be present in the JSON
|
489
497
|
# response if and only if `category` is equal to `wire_transfer_intention`. A Wire
|
@@ -496,7 +504,7 @@ module Increase
|
|
496
504
|
},
|
497
505
|
nil?: true
|
498
506
|
|
499
|
-
# @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, wire_transfer_intention:)
|
507
|
+
# @!method initialize(account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_real_time_payments_transfer_decline:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, swift_transfer_return:, wire_transfer_intention:)
|
500
508
|
# Some parameter documentations has been truncated, see
|
501
509
|
# {Increase::Models::Transaction::Source} for more details.
|
502
510
|
#
|
@@ -569,6 +577,8 @@ module Increase
|
|
569
577
|
#
|
570
578
|
# @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil] A Swift Transfer Intention object. This field will be present in the JSON respon
|
571
579
|
#
|
580
|
+
# @param swift_transfer_return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil] A Swift Transfer Return object. This field will be present in the JSON response
|
581
|
+
#
|
572
582
|
# @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] A Wire Transfer Intention object. This field will be present in the JSON respons
|
573
583
|
|
574
584
|
# @see Increase::Models::Transaction::Source#account_transfer_intention
|
@@ -4231,6 +4241,9 @@ module Increase
|
|
4231
4241
|
# Swift Transfer Intention: details will be under the `swift_transfer_intention` object.
|
4232
4242
|
SWIFT_TRANSFER_INTENTION = :swift_transfer_intention
|
4233
4243
|
|
4244
|
+
# Swift Transfer Return: details will be under the `swift_transfer_return` object.
|
4245
|
+
SWIFT_TRANSFER_RETURN = :swift_transfer_return
|
4246
|
+
|
4234
4247
|
# Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.
|
4235
4248
|
CARD_PUSH_TRANSFER_ACCEPTANCE = :card_push_transfer_acceptance
|
4236
4249
|
|
@@ -5873,6 +5886,22 @@ module Increase
|
|
5873
5886
|
# @param transfer_id [String] The identifier of the Swift Transfer that led to this Transaction.
|
5874
5887
|
end
|
5875
5888
|
|
5889
|
+
# @see Increase::Models::Transaction::Source#swift_transfer_return
|
5890
|
+
class SwiftTransferReturn < Increase::Internal::Type::BaseModel
|
5891
|
+
# @!attribute transfer_id
|
5892
|
+
# The identifier of the Swift Transfer that led to this Transaction.
|
5893
|
+
#
|
5894
|
+
# @return [String]
|
5895
|
+
required :transfer_id, String
|
5896
|
+
|
5897
|
+
# @!method initialize(transfer_id:)
|
5898
|
+
# A Swift Transfer Return object. This field will be present in the JSON response
|
5899
|
+
# if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
|
5900
|
+
# Return is created when a Swift Transfer is returned by the receiving bank.
|
5901
|
+
#
|
5902
|
+
# @param transfer_id [String] The identifier of the Swift Transfer that led to this Transaction.
|
5903
|
+
end
|
5904
|
+
|
5876
5905
|
# @see Increase::Models::Transaction::Source#wire_transfer_intention
|
5877
5906
|
class WireTransferIntention < Increase::Internal::Type::BaseModel
|
5878
5907
|
# @!attribute account_number
|
@@ -172,6 +172,9 @@ module Increase
|
|
172
172
|
# Swift Transfer Intention: details will be under the `swift_transfer_intention` object.
|
173
173
|
SWIFT_TRANSFER_INTENTION = :swift_transfer_intention
|
174
174
|
|
175
|
+
# Swift Transfer Return: details will be under the `swift_transfer_return` object.
|
176
|
+
SWIFT_TRANSFER_RETURN = :swift_transfer_return
|
177
|
+
|
175
178
|
# Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.
|
176
179
|
CARD_PUSH_TRANSFER_ACCEPTANCE = :card_push_transfer_acceptance
|
177
180
|
|
@@ -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
|
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
|
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
|
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
|
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
|
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
|
33
|
+
# @param individual_id [String] Your identifier for the recipient.
|
34
34
|
#
|
35
|
-
# @param individual_name [String] The name of
|
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`
|
data/lib/increase/version.rb
CHANGED