increase 1.41.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 +9 -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/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/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/resources/exports.rbs +1 -0
- metadata +1 -1
@@ -12,6 +12,10 @@ module Increase
|
|
12
12
|
sig { returns(String) }
|
13
13
|
attr_accessor :id
|
14
14
|
|
15
|
+
# The account that sent the ACH Prenotification.
|
16
|
+
sig { returns(T.nilable(String)) }
|
17
|
+
attr_accessor :account_id
|
18
|
+
|
15
19
|
# The destination account number.
|
16
20
|
sig { returns(String) }
|
17
21
|
attr_accessor :account_number
|
@@ -61,6 +65,15 @@ module Increase
|
|
61
65
|
sig { returns(T.nilable(String)) }
|
62
66
|
attr_accessor :idempotency_key
|
63
67
|
|
68
|
+
# Your identifier for the recipient.
|
69
|
+
sig { returns(T.nilable(String)) }
|
70
|
+
attr_accessor :individual_id
|
71
|
+
|
72
|
+
# The name of the recipient. This value is informational and not verified by the
|
73
|
+
# recipient's bank.
|
74
|
+
sig { returns(T.nilable(String)) }
|
75
|
+
attr_accessor :individual_name
|
76
|
+
|
64
77
|
# If the receiving bank notifies that future transfers should use different
|
65
78
|
# details, this will contain those details.
|
66
79
|
sig do
|
@@ -88,6 +101,16 @@ module Increase
|
|
88
101
|
sig { returns(String) }
|
89
102
|
attr_accessor :routing_number
|
90
103
|
|
104
|
+
# The Standard Entry Class (SEC) code to use for the ACH Prenotification.
|
105
|
+
sig do
|
106
|
+
returns(
|
107
|
+
T.nilable(
|
108
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
109
|
+
)
|
110
|
+
)
|
111
|
+
end
|
112
|
+
attr_accessor :standard_entry_class_code
|
113
|
+
|
91
114
|
# The lifecycle status of the ACH Prenotification.
|
92
115
|
sig { returns(Increase::ACHPrenotification::Status::TaggedSymbol) }
|
93
116
|
attr_accessor :status
|
@@ -102,6 +125,7 @@ module Increase
|
|
102
125
|
sig do
|
103
126
|
params(
|
104
127
|
id: String,
|
128
|
+
account_id: T.nilable(String),
|
105
129
|
account_number: String,
|
106
130
|
addendum: T.nilable(String),
|
107
131
|
company_descriptive_date: T.nilable(String),
|
@@ -115,6 +139,8 @@ module Increase
|
|
115
139
|
),
|
116
140
|
effective_date: T.nilable(Time),
|
117
141
|
idempotency_key: T.nilable(String),
|
142
|
+
individual_id: T.nilable(String),
|
143
|
+
individual_name: T.nilable(String),
|
118
144
|
notifications_of_change:
|
119
145
|
T::Array[
|
120
146
|
Increase::ACHPrenotification::NotificationsOfChange::OrHash
|
@@ -124,6 +150,10 @@ module Increase
|
|
124
150
|
Increase::ACHPrenotification::PrenotificationReturn::OrHash
|
125
151
|
),
|
126
152
|
routing_number: String,
|
153
|
+
standard_entry_class_code:
|
154
|
+
T.nilable(
|
155
|
+
Increase::ACHPrenotification::StandardEntryClassCode::OrSymbol
|
156
|
+
),
|
127
157
|
status: Increase::ACHPrenotification::Status::OrSymbol,
|
128
158
|
type: Increase::ACHPrenotification::Type::OrSymbol
|
129
159
|
).returns(T.attached_class)
|
@@ -131,6 +161,8 @@ module Increase
|
|
131
161
|
def self.new(
|
132
162
|
# The ACH Prenotification's identifier.
|
133
163
|
id:,
|
164
|
+
# The account that sent the ACH Prenotification.
|
165
|
+
account_id:,
|
134
166
|
# The destination account number.
|
135
167
|
account_number:,
|
136
168
|
# Additional information for the recipient.
|
@@ -154,6 +186,11 @@ module Increase
|
|
154
186
|
# Increase and is used to ensure that a request is only processed once. Learn more
|
155
187
|
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
156
188
|
idempotency_key:,
|
189
|
+
# Your identifier for the recipient.
|
190
|
+
individual_id:,
|
191
|
+
# The name of the recipient. This value is informational and not verified by the
|
192
|
+
# recipient's bank.
|
193
|
+
individual_name:,
|
157
194
|
# If the receiving bank notifies that future transfers should use different
|
158
195
|
# details, this will contain those details.
|
159
196
|
notifications_of_change:,
|
@@ -161,6 +198,8 @@ module Increase
|
|
161
198
|
prenotification_return:,
|
162
199
|
# The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
163
200
|
routing_number:,
|
201
|
+
# The Standard Entry Class (SEC) code to use for the ACH Prenotification.
|
202
|
+
standard_entry_class_code:,
|
164
203
|
# The lifecycle status of the ACH Prenotification.
|
165
204
|
status:,
|
166
205
|
# A constant representing the object's type. For this resource it will always be
|
@@ -173,6 +212,7 @@ module Increase
|
|
173
212
|
override.returns(
|
174
213
|
{
|
175
214
|
id: String,
|
215
|
+
account_id: T.nilable(String),
|
176
216
|
account_number: String,
|
177
217
|
addendum: T.nilable(String),
|
178
218
|
company_descriptive_date: T.nilable(String),
|
@@ -186,11 +226,17 @@ module Increase
|
|
186
226
|
),
|
187
227
|
effective_date: T.nilable(Time),
|
188
228
|
idempotency_key: T.nilable(String),
|
229
|
+
individual_id: T.nilable(String),
|
230
|
+
individual_name: T.nilable(String),
|
189
231
|
notifications_of_change:
|
190
232
|
T::Array[Increase::ACHPrenotification::NotificationsOfChange],
|
191
233
|
prenotification_return:
|
192
234
|
T.nilable(Increase::ACHPrenotification::PrenotificationReturn),
|
193
235
|
routing_number: String,
|
236
|
+
standard_entry_class_code:
|
237
|
+
T.nilable(
|
238
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
239
|
+
),
|
194
240
|
status: Increase::ACHPrenotification::Status::TaggedSymbol,
|
195
241
|
type: Increase::ACHPrenotification::Type::TaggedSymbol
|
196
242
|
}
|
@@ -1027,6 +1073,55 @@ module Increase
|
|
1027
1073
|
end
|
1028
1074
|
end
|
1029
1075
|
|
1076
|
+
# The Standard Entry Class (SEC) code to use for the ACH Prenotification.
|
1077
|
+
module StandardEntryClassCode
|
1078
|
+
extend Increase::Internal::Type::Enum
|
1079
|
+
|
1080
|
+
TaggedSymbol =
|
1081
|
+
T.type_alias do
|
1082
|
+
T.all(Symbol, Increase::ACHPrenotification::StandardEntryClassCode)
|
1083
|
+
end
|
1084
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1085
|
+
|
1086
|
+
# Corporate Credit and Debit (CCD).
|
1087
|
+
CORPORATE_CREDIT_OR_DEBIT =
|
1088
|
+
T.let(
|
1089
|
+
:corporate_credit_or_debit,
|
1090
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
1091
|
+
)
|
1092
|
+
|
1093
|
+
# Corporate Trade Exchange (CTX).
|
1094
|
+
CORPORATE_TRADE_EXCHANGE =
|
1095
|
+
T.let(
|
1096
|
+
:corporate_trade_exchange,
|
1097
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
1098
|
+
)
|
1099
|
+
|
1100
|
+
# Prearranged Payments and Deposits (PPD).
|
1101
|
+
PREARRANGED_PAYMENTS_AND_DEPOSIT =
|
1102
|
+
T.let(
|
1103
|
+
:prearranged_payments_and_deposit,
|
1104
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
1105
|
+
)
|
1106
|
+
|
1107
|
+
# Internet Initiated (WEB).
|
1108
|
+
INTERNET_INITIATED =
|
1109
|
+
T.let(
|
1110
|
+
:internet_initiated,
|
1111
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
1112
|
+
)
|
1113
|
+
|
1114
|
+
sig do
|
1115
|
+
override.returns(
|
1116
|
+
T::Array[
|
1117
|
+
Increase::ACHPrenotification::StandardEntryClassCode::TaggedSymbol
|
1118
|
+
]
|
1119
|
+
)
|
1120
|
+
end
|
1121
|
+
def self.values
|
1122
|
+
end
|
1123
|
+
end
|
1124
|
+
|
1030
1125
|
# The lifecycle status of the ACH Prenotification.
|
1031
1126
|
module Status
|
1032
1127
|
extend Increase::Internal::Type::Enum
|
@@ -14,7 +14,7 @@ module Increase
|
|
14
14
|
)
|
15
15
|
end
|
16
16
|
|
17
|
-
# The Increase identifier for the account that will send the
|
17
|
+
# The Increase identifier for the account that will send the ACH Prenotification.
|
18
18
|
sig { returns(String) }
|
19
19
|
attr_accessor :account_id
|
20
20
|
|
@@ -34,21 +34,21 @@ module Increase
|
|
34
34
|
sig { params(addendum: String).void }
|
35
35
|
attr_writer :addendum
|
36
36
|
|
37
|
-
# The description of the date of the
|
37
|
+
# The description of the date of the ACH Prenotification.
|
38
38
|
sig { returns(T.nilable(String)) }
|
39
39
|
attr_reader :company_descriptive_date
|
40
40
|
|
41
41
|
sig { params(company_descriptive_date: String).void }
|
42
42
|
attr_writer :company_descriptive_date
|
43
43
|
|
44
|
-
# The data you choose to associate with the
|
44
|
+
# The data you choose to associate with the ACH Prenotification.
|
45
45
|
sig { returns(T.nilable(String)) }
|
46
46
|
attr_reader :company_discretionary_data
|
47
47
|
|
48
48
|
sig { params(company_discretionary_data: String).void }
|
49
49
|
attr_writer :company_discretionary_data
|
50
50
|
|
51
|
-
# The description
|
51
|
+
# The description you wish to be shown to the recipient.
|
52
52
|
sig { returns(T.nilable(String)) }
|
53
53
|
attr_reader :company_entry_description
|
54
54
|
|
@@ -80,7 +80,7 @@ module Increase
|
|
80
80
|
end
|
81
81
|
attr_writer :credit_debit_indicator
|
82
82
|
|
83
|
-
# The
|
83
|
+
# The ACH Prenotification effective date in
|
84
84
|
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
85
85
|
sig { returns(T.nilable(Date)) }
|
86
86
|
attr_reader :effective_date
|
@@ -88,15 +88,15 @@ module Increase
|
|
88
88
|
sig { params(effective_date: Date).void }
|
89
89
|
attr_writer :effective_date
|
90
90
|
|
91
|
-
# Your identifier for the
|
91
|
+
# Your identifier for the recipient.
|
92
92
|
sig { returns(T.nilable(String)) }
|
93
93
|
attr_reader :individual_id
|
94
94
|
|
95
95
|
sig { params(individual_id: String).void }
|
96
96
|
attr_writer :individual_id
|
97
97
|
|
98
|
-
# The name of
|
99
|
-
#
|
98
|
+
# The name of therecipient. This value is informational and not verified by the
|
99
|
+
# recipient's bank.
|
100
100
|
sig { returns(T.nilable(String)) }
|
101
101
|
attr_reader :individual_name
|
102
102
|
|
@@ -142,7 +142,7 @@ module Increase
|
|
142
142
|
).returns(T.attached_class)
|
143
143
|
end
|
144
144
|
def self.new(
|
145
|
-
# The Increase identifier for the account that will send the
|
145
|
+
# The Increase identifier for the account that will send the ACH Prenotification.
|
146
146
|
account_id:,
|
147
147
|
# The account number for the destination account.
|
148
148
|
account_number:,
|
@@ -151,23 +151,23 @@ module Increase
|
|
151
151
|
routing_number:,
|
152
152
|
# Additional information that will be sent to the recipient.
|
153
153
|
addendum: nil,
|
154
|
-
# The description of the date of the
|
154
|
+
# The description of the date of the ACH Prenotification.
|
155
155
|
company_descriptive_date: nil,
|
156
|
-
# The data you choose to associate with the
|
156
|
+
# The data you choose to associate with the ACH Prenotification.
|
157
157
|
company_discretionary_data: nil,
|
158
|
-
# The description
|
158
|
+
# The description you wish to be shown to the recipient.
|
159
159
|
company_entry_description: nil,
|
160
160
|
# The name by which the recipient knows you.
|
161
161
|
company_name: nil,
|
162
162
|
# Whether the Prenotification is for a future debit or credit.
|
163
163
|
credit_debit_indicator: nil,
|
164
|
-
# The
|
164
|
+
# The ACH Prenotification effective date in
|
165
165
|
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
166
166
|
effective_date: nil,
|
167
|
-
# Your identifier for the
|
167
|
+
# Your identifier for the recipient.
|
168
168
|
individual_id: nil,
|
169
|
-
# The name of
|
170
|
-
#
|
169
|
+
# The name of therecipient. This value is informational and not verified by the
|
170
|
+
# recipient's bank.
|
171
171
|
individual_name: nil,
|
172
172
|
# The Standard Entry Class (SEC) code to use for the ACH Prenotification.
|
173
173
|
standard_entry_class_code: nil,
|
@@ -28,6 +28,10 @@ module Increase
|
|
28
28
|
sig { returns(String) }
|
29
29
|
attr_accessor :account_id
|
30
30
|
|
31
|
+
# The ID of the Card Token that was used to validate the card.
|
32
|
+
sig { returns(String) }
|
33
|
+
attr_accessor :card_token_id
|
34
|
+
|
31
35
|
# The cardholder's first name.
|
32
36
|
sig { returns(T.nilable(String)) }
|
33
37
|
attr_accessor :cardholder_first_name
|
@@ -132,6 +136,7 @@ module Increase
|
|
132
136
|
id: String,
|
133
137
|
acceptance: T.nilable(Increase::CardValidation::Acceptance::OrHash),
|
134
138
|
account_id: String,
|
139
|
+
card_token_id: String,
|
135
140
|
cardholder_first_name: T.nilable(String),
|
136
141
|
cardholder_last_name: T.nilable(String),
|
137
142
|
cardholder_middle_name: T.nilable(String),
|
@@ -159,6 +164,8 @@ module Increase
|
|
159
164
|
acceptance:,
|
160
165
|
# The identifier of the Account from which to send the validation.
|
161
166
|
account_id:,
|
167
|
+
# The ID of the Card Token that was used to validate the card.
|
168
|
+
card_token_id:,
|
162
169
|
# The cardholder's first name.
|
163
170
|
cardholder_first_name:,
|
164
171
|
# The cardholder's last name.
|
@@ -210,6 +217,7 @@ module Increase
|
|
210
217
|
id: String,
|
211
218
|
acceptance: T.nilable(Increase::CardValidation::Acceptance),
|
212
219
|
account_id: String,
|
220
|
+
card_token_id: String,
|
213
221
|
cardholder_first_name: T.nilable(String),
|
214
222
|
cardholder_last_name: T.nilable(String),
|
215
223
|
cardholder_middle_name: T.nilable(String),
|
@@ -41,6 +41,12 @@ module Increase
|
|
41
41
|
sig { returns(T.nilable(String)) }
|
42
42
|
attr_accessor :approved_inbound_check_deposit_id
|
43
43
|
|
44
|
+
# How the account's available balance should be checked.
|
45
|
+
sig do
|
46
|
+
returns(T.nilable(Increase::CheckTransfer::BalanceCheck::TaggedSymbol))
|
47
|
+
end
|
48
|
+
attr_accessor :balance_check
|
49
|
+
|
44
50
|
# If your account requires approvals for transfers and the transfer was not
|
45
51
|
# approved, this will contain details of the cancellation.
|
46
52
|
sig { returns(T.nilable(Increase::CheckTransfer::Cancellation)) }
|
@@ -184,6 +190,8 @@ module Increase
|
|
184
190
|
amount: Integer,
|
185
191
|
approval: T.nilable(Increase::CheckTransfer::Approval::OrHash),
|
186
192
|
approved_inbound_check_deposit_id: T.nilable(String),
|
193
|
+
balance_check:
|
194
|
+
T.nilable(Increase::CheckTransfer::BalanceCheck::OrSymbol),
|
187
195
|
cancellation:
|
188
196
|
T.nilable(Increase::CheckTransfer::Cancellation::OrHash),
|
189
197
|
check_number: String,
|
@@ -222,6 +230,8 @@ module Increase
|
|
222
230
|
# If the Check Transfer was successfully deposited, this will contain the
|
223
231
|
# identifier of the Inbound Check Deposit object with details of the deposit.
|
224
232
|
approved_inbound_check_deposit_id:,
|
233
|
+
# How the account's available balance should be checked.
|
234
|
+
balance_check:,
|
225
235
|
# If your account requires approvals for transfers and the transfer was not
|
226
236
|
# approved, this will contain details of the cancellation.
|
227
237
|
cancellation:,
|
@@ -282,6 +292,8 @@ module Increase
|
|
282
292
|
amount: Integer,
|
283
293
|
approval: T.nilable(Increase::CheckTransfer::Approval),
|
284
294
|
approved_inbound_check_deposit_id: T.nilable(String),
|
295
|
+
balance_check:
|
296
|
+
T.nilable(Increase::CheckTransfer::BalanceCheck::TaggedSymbol),
|
285
297
|
cancellation: T.nilable(Increase::CheckTransfer::Cancellation),
|
286
298
|
check_number: String,
|
287
299
|
created_at: Time,
|
@@ -352,6 +364,29 @@ module Increase
|
|
352
364
|
end
|
353
365
|
end
|
354
366
|
|
367
|
+
# How the account's available balance should be checked.
|
368
|
+
module BalanceCheck
|
369
|
+
extend Increase::Internal::Type::Enum
|
370
|
+
|
371
|
+
TaggedSymbol =
|
372
|
+
T.type_alias { T.all(Symbol, Increase::CheckTransfer::BalanceCheck) }
|
373
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
374
|
+
|
375
|
+
# 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.
|
376
|
+
FULL = T.let(:full, Increase::CheckTransfer::BalanceCheck::TaggedSymbol)
|
377
|
+
|
378
|
+
# No balance check will performed; a zero-dollar Pending Transaction will be created.
|
379
|
+
NONE = T.let(:none, Increase::CheckTransfer::BalanceCheck::TaggedSymbol)
|
380
|
+
|
381
|
+
sig do
|
382
|
+
override.returns(
|
383
|
+
T::Array[Increase::CheckTransfer::BalanceCheck::TaggedSymbol]
|
384
|
+
)
|
385
|
+
end
|
386
|
+
def self.values
|
387
|
+
end
|
388
|
+
end
|
389
|
+
|
355
390
|
class Cancellation < Increase::Internal::Type::BaseModel
|
356
391
|
OrHash =
|
357
392
|
T.type_alias do
|
@@ -120,6 +120,13 @@ module Increase
|
|
120
120
|
Increase::Export::Category::TaggedSymbol
|
121
121
|
)
|
122
122
|
|
123
|
+
# Export a BAI2 file of transactions and balances for a given date and optional Account.
|
124
|
+
ACCOUNT_STATEMENT_BAI2 =
|
125
|
+
T.let(
|
126
|
+
:account_statement_bai2,
|
127
|
+
Increase::Export::Category::TaggedSymbol
|
128
|
+
)
|
129
|
+
|
123
130
|
# Export a CSV of all transactions for a given time range.
|
124
131
|
TRANSACTION_CSV =
|
125
132
|
T.let(:transaction_csv, Increase::Export::Category::TaggedSymbol)
|
@@ -15,6 +15,21 @@ module Increase
|
|
15
15
|
sig { returns(Increase::ExportCreateParams::Category::OrSymbol) }
|
16
16
|
attr_accessor :category
|
17
17
|
|
18
|
+
# Options for the created export. Required if `category` is equal to
|
19
|
+
# `account_statement_bai2`.
|
20
|
+
sig do
|
21
|
+
returns(T.nilable(Increase::ExportCreateParams::AccountStatementBai2))
|
22
|
+
end
|
23
|
+
attr_reader :account_statement_bai2
|
24
|
+
|
25
|
+
sig do
|
26
|
+
params(
|
27
|
+
account_statement_bai2:
|
28
|
+
Increase::ExportCreateParams::AccountStatementBai2::OrHash
|
29
|
+
).void
|
30
|
+
end
|
31
|
+
attr_writer :account_statement_bai2
|
32
|
+
|
18
33
|
# Options for the created export. Required if `category` is equal to
|
19
34
|
# `account_statement_ofx`.
|
20
35
|
sig do
|
@@ -90,6 +105,8 @@ module Increase
|
|
90
105
|
sig do
|
91
106
|
params(
|
92
107
|
category: Increase::ExportCreateParams::Category::OrSymbol,
|
108
|
+
account_statement_bai2:
|
109
|
+
Increase::ExportCreateParams::AccountStatementBai2::OrHash,
|
93
110
|
account_statement_ofx:
|
94
111
|
Increase::ExportCreateParams::AccountStatementOfx::OrHash,
|
95
112
|
balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
|
@@ -105,6 +122,9 @@ module Increase
|
|
105
122
|
# The type of Export to create.
|
106
123
|
category:,
|
107
124
|
# Options for the created export. Required if `category` is equal to
|
125
|
+
# `account_statement_bai2`.
|
126
|
+
account_statement_bai2: nil,
|
127
|
+
# Options for the created export. Required if `category` is equal to
|
108
128
|
# `account_statement_ofx`.
|
109
129
|
account_statement_ofx: nil,
|
110
130
|
# Options for the created export. Required if `category` is equal to
|
@@ -128,6 +148,8 @@ module Increase
|
|
128
148
|
override.returns(
|
129
149
|
{
|
130
150
|
category: Increase::ExportCreateParams::Category::OrSymbol,
|
151
|
+
account_statement_bai2:
|
152
|
+
Increase::ExportCreateParams::AccountStatementBai2,
|
131
153
|
account_statement_ofx:
|
132
154
|
Increase::ExportCreateParams::AccountStatementOfx,
|
133
155
|
balance_csv: Increase::ExportCreateParams::BalanceCsv,
|
@@ -158,6 +180,13 @@ module Increase
|
|
158
180
|
Increase::ExportCreateParams::Category::TaggedSymbol
|
159
181
|
)
|
160
182
|
|
183
|
+
# Export a BAI2 file of transactions and balances for a given date and optional Account.
|
184
|
+
ACCOUNT_STATEMENT_BAI2 =
|
185
|
+
T.let(
|
186
|
+
:account_statement_bai2,
|
187
|
+
Increase::ExportCreateParams::Category::TaggedSymbol
|
188
|
+
)
|
189
|
+
|
161
190
|
# Export a CSV of all transactions for a given time range.
|
162
191
|
TRANSACTION_CSV =
|
163
192
|
T.let(
|
@@ -202,6 +231,57 @@ module Increase
|
|
202
231
|
end
|
203
232
|
end
|
204
233
|
|
234
|
+
class AccountStatementBai2 < Increase::Internal::Type::BaseModel
|
235
|
+
OrHash =
|
236
|
+
T.type_alias do
|
237
|
+
T.any(
|
238
|
+
Increase::ExportCreateParams::AccountStatementBai2,
|
239
|
+
Increase::Internal::AnyHash
|
240
|
+
)
|
241
|
+
end
|
242
|
+
|
243
|
+
# The Account to create a BAI2 report for. If not provided, all open accounts will
|
244
|
+
# be included.
|
245
|
+
sig { returns(T.nilable(String)) }
|
246
|
+
attr_reader :account_id
|
247
|
+
|
248
|
+
sig { params(account_id: String).void }
|
249
|
+
attr_writer :account_id
|
250
|
+
|
251
|
+
# The date to create a BAI2 report for. If not provided, the current date will be
|
252
|
+
# used. The timezone is UTC. If the current date is used, the report will include
|
253
|
+
# intraday balances, otherwise it will include end-of-day balances for the
|
254
|
+
# provided date.
|
255
|
+
sig { returns(T.nilable(Date)) }
|
256
|
+
attr_reader :effective_date
|
257
|
+
|
258
|
+
sig { params(effective_date: Date).void }
|
259
|
+
attr_writer :effective_date
|
260
|
+
|
261
|
+
# Options for the created export. Required if `category` is equal to
|
262
|
+
# `account_statement_bai2`.
|
263
|
+
sig do
|
264
|
+
params(account_id: String, effective_date: Date).returns(
|
265
|
+
T.attached_class
|
266
|
+
)
|
267
|
+
end
|
268
|
+
def self.new(
|
269
|
+
# The Account to create a BAI2 report for. If not provided, all open accounts will
|
270
|
+
# be included.
|
271
|
+
account_id: nil,
|
272
|
+
# The date to create a BAI2 report for. If not provided, the current date will be
|
273
|
+
# used. The timezone is UTC. If the current date is used, the report will include
|
274
|
+
# intraday balances, otherwise it will include end-of-day balances for the
|
275
|
+
# provided date.
|
276
|
+
effective_date: nil
|
277
|
+
)
|
278
|
+
end
|
279
|
+
|
280
|
+
sig { override.returns({ account_id: String, effective_date: Date }) }
|
281
|
+
def to_hash
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
205
285
|
class AccountStatementOfx < Increase::Internal::Type::BaseModel
|
206
286
|
OrHash =
|
207
287
|
T.type_alias do
|
@@ -170,6 +170,13 @@ module Increase
|
|
170
170
|
Increase::ExportListParams::Category::In::TaggedSymbol
|
171
171
|
)
|
172
172
|
|
173
|
+
# Export a BAI2 file of transactions and balances for a given date and optional Account.
|
174
|
+
ACCOUNT_STATEMENT_BAI2 =
|
175
|
+
T.let(
|
176
|
+
:account_statement_bai2,
|
177
|
+
Increase::ExportListParams::Category::In::TaggedSymbol
|
178
|
+
)
|
179
|
+
|
173
180
|
# Export a CSV of all transactions for a given time range.
|
174
181
|
TRANSACTION_CSV =
|
175
182
|
T.let(
|
@@ -21,6 +21,10 @@ module Increase
|
|
21
21
|
sig { returns(Time) }
|
22
22
|
attr_accessor :created_at
|
23
23
|
|
24
|
+
# The contact email for the account owner, to be shared with IntraFi.
|
25
|
+
sig { returns(T.nilable(String)) }
|
26
|
+
attr_accessor :email_address
|
27
|
+
|
24
28
|
# The idempotency key you chose for this object. This value is unique across
|
25
29
|
# Increase and is used to ensure that a request is only processed once. Learn more
|
26
30
|
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
@@ -54,6 +58,7 @@ module Increase
|
|
54
58
|
id: String,
|
55
59
|
account_id: String,
|
56
60
|
created_at: Time,
|
61
|
+
email_address: T.nilable(String),
|
57
62
|
idempotency_key: T.nilable(String),
|
58
63
|
intrafi_id: String,
|
59
64
|
status: Increase::IntrafiAccountEnrollment::Status::OrSymbol,
|
@@ -68,6 +73,8 @@ module Increase
|
|
68
73
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
69
74
|
# the enrollment was created.
|
70
75
|
created_at:,
|
76
|
+
# The contact email for the account owner, to be shared with IntraFi.
|
77
|
+
email_address:,
|
71
78
|
# The idempotency key you chose for this object. This value is unique across
|
72
79
|
# Increase and is used to ensure that a request is only processed once. Learn more
|
73
80
|
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
@@ -90,6 +97,7 @@ module Increase
|
|
90
97
|
id: String,
|
91
98
|
account_id: String,
|
92
99
|
created_at: Time,
|
100
|
+
email_address: T.nilable(String),
|
93
101
|
idempotency_key: T.nilable(String),
|
94
102
|
intrafi_id: String,
|
95
103
|
status: Increase::IntrafiAccountEnrollment::Status::TaggedSymbol,
|
@@ -25,7 +25,7 @@ module Increase
|
|
25
25
|
).returns(Increase::ACHPrenotification)
|
26
26
|
end
|
27
27
|
def create(
|
28
|
-
# The Increase identifier for the account that will send the
|
28
|
+
# The Increase identifier for the account that will send the ACH Prenotification.
|
29
29
|
account_id:,
|
30
30
|
# The account number for the destination account.
|
31
31
|
account_number:,
|
@@ -34,23 +34,23 @@ module Increase
|
|
34
34
|
routing_number:,
|
35
35
|
# Additional information that will be sent to the recipient.
|
36
36
|
addendum: nil,
|
37
|
-
# The description of the date of the
|
37
|
+
# The description of the date of the ACH Prenotification.
|
38
38
|
company_descriptive_date: nil,
|
39
|
-
# The data you choose to associate with the
|
39
|
+
# The data you choose to associate with the ACH Prenotification.
|
40
40
|
company_discretionary_data: nil,
|
41
|
-
# The description
|
41
|
+
# The description you wish to be shown to the recipient.
|
42
42
|
company_entry_description: nil,
|
43
43
|
# The name by which the recipient knows you.
|
44
44
|
company_name: nil,
|
45
45
|
# Whether the Prenotification is for a future debit or credit.
|
46
46
|
credit_debit_indicator: nil,
|
47
|
-
# The
|
47
|
+
# The ACH Prenotification effective date in
|
48
48
|
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
49
49
|
effective_date: nil,
|
50
|
-
# Your identifier for the
|
50
|
+
# Your identifier for the recipient.
|
51
51
|
individual_id: nil,
|
52
|
-
# The name of
|
53
|
-
#
|
52
|
+
# The name of therecipient. This value is informational and not verified by the
|
53
|
+
# recipient's bank.
|
54
54
|
individual_name: nil,
|
55
55
|
# The Standard Entry Class (SEC) code to use for the ACH Prenotification.
|
56
56
|
standard_entry_class_code: nil,
|
@@ -7,6 +7,8 @@ module Increase
|
|
7
7
|
sig do
|
8
8
|
params(
|
9
9
|
category: Increase::ExportCreateParams::Category::OrSymbol,
|
10
|
+
account_statement_bai2:
|
11
|
+
Increase::ExportCreateParams::AccountStatementBai2::OrHash,
|
10
12
|
account_statement_ofx:
|
11
13
|
Increase::ExportCreateParams::AccountStatementOfx::OrHash,
|
12
14
|
balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
|
@@ -22,6 +24,9 @@ module Increase
|
|
22
24
|
# The type of Export to create.
|
23
25
|
category:,
|
24
26
|
# Options for the created export. Required if `category` is equal to
|
27
|
+
# `account_statement_bai2`.
|
28
|
+
account_statement_bai2: nil,
|
29
|
+
# Options for the created export. Required if `category` is equal to
|
25
30
|
# `account_statement_ofx`.
|
26
31
|
account_statement_ofx: nil,
|
27
32
|
# Options for the created export. Required if `category` is equal to
|