increase 1.284.1 → 1.287.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 +185 -0
- data/README.md +1 -1
- data/lib/increase/client.rb +4 -0
- data/lib/increase/models/entity_onboarding_session.rb +135 -0
- data/lib/increase/models/entity_onboarding_session_create_params.rb +45 -0
- data/lib/increase/models/entity_onboarding_session_expire_params.rb +22 -0
- data/lib/increase/models/entity_onboarding_session_list_params.rb +85 -0
- data/lib/increase/models/entity_onboarding_session_retrieve_params.rb +22 -0
- data/lib/increase/models/export.rb +53 -10
- data/lib/increase/models/export_create_params.rb +51 -33
- data/lib/increase/models/export_list_params.rb +3 -0
- data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +24 -0
- data/lib/increase/models.rb +10 -0
- data/lib/increase/resources/entity_onboarding_sessions.rb +116 -0
- data/lib/increase/resources/exports.rb +3 -1
- data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +39 -0
- data/lib/increase/resources/simulations.rb +5 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +8 -0
- data/rbi/increase/client.rbi +3 -0
- data/rbi/increase/models/entity_onboarding_session.rbi +190 -0
- data/rbi/increase/models/entity_onboarding_session_create_params.rbi +73 -0
- data/rbi/increase/models/entity_onboarding_session_expire_params.rbi +46 -0
- data/rbi/increase/models/entity_onboarding_session_list_params.rbi +194 -0
- data/rbi/increase/models/entity_onboarding_session_retrieve_params.rbi +46 -0
- data/rbi/increase/models/export.rbi +92 -11
- data/rbi/increase/models/export_create_params.rbi +101 -50
- data/rbi/increase/models/export_list_params.rbi +7 -0
- data/rbi/increase/models/simulations/entity_onboarding_session_submit_params.rbi +48 -0
- data/rbi/increase/models.rbi +14 -0
- data/rbi/increase/resources/entity_onboarding_sessions.rbi +90 -0
- data/rbi/increase/resources/exports.rbi +5 -0
- data/rbi/increase/resources/simulations/entity_onboarding_sessions.rbi +31 -0
- data/rbi/increase/resources/simulations.rbi +5 -0
- data/sig/increase/client.rbs +2 -0
- data/sig/increase/models/entity_onboarding_session.rbs +89 -0
- data/sig/increase/models/entity_onboarding_session_create_params.rbs +34 -0
- data/sig/increase/models/entity_onboarding_session_expire_params.rbs +24 -0
- data/sig/increase/models/entity_onboarding_session_list_params.rbs +86 -0
- data/sig/increase/models/entity_onboarding_session_retrieve_params.rbs +24 -0
- data/sig/increase/models/export.rbs +41 -5
- data/sig/increase/models/export_create_params.rbs +45 -22
- data/sig/increase/models/export_list_params.rbs +4 -0
- data/sig/increase/models/simulations/entity_onboarding_session_submit_params.rbs +26 -0
- data/sig/increase/models.rbs +10 -0
- data/sig/increase/resources/entity_onboarding_sessions.rbs +32 -0
- data/sig/increase/resources/exports.rbs +1 -0
- data/sig/increase/resources/simulations/entity_onboarding_sessions.rbs +14 -0
- data/sig/increase/resources/simulations.rbs +2 -0
- metadata +26 -2
|
@@ -60,6 +60,13 @@ module Increase
|
|
|
60
60
|
# @return [Time]
|
|
61
61
|
required :created_at, Time
|
|
62
62
|
|
|
63
|
+
# @!attribute daily_account_balance_csv
|
|
64
|
+
# Details of the daily account balance CSV export. This field will be present when
|
|
65
|
+
# the `category` is equal to `daily_account_balance_csv`.
|
|
66
|
+
#
|
|
67
|
+
# @return [Increase::Models::Export::DailyAccountBalanceCsv, nil]
|
|
68
|
+
required :daily_account_balance_csv, -> { Increase::Export::DailyAccountBalanceCsv }, nil?: true
|
|
69
|
+
|
|
63
70
|
# @!attribute dashboard_table_csv
|
|
64
71
|
# Details of the dashboard table CSV export. This field will be present when the
|
|
65
72
|
# `category` is equal to `dashboard_table_csv`.
|
|
@@ -151,7 +158,7 @@ module Increase
|
|
|
151
158
|
# @return [Increase::Models::Export::VoidedCheck, nil]
|
|
152
159
|
required :voided_check, -> { Increase::Export::VoidedCheck }, nil?: true
|
|
153
160
|
|
|
154
|
-
# @!method initialize(id:, account_statement_bai2:, account_statement_ofx:, account_verification_letter:, balance_csv:, bookkeeping_account_balance_csv:, category:, created_at:, dashboard_table_csv:, entity_csv:, fee_csv:, form_1099_int:, form_1099_misc:, funding_instructions:, idempotency_key:, result:, status:, transaction_csv:, type:, vendor_csv:, voided_check:)
|
|
161
|
+
# @!method initialize(id:, account_statement_bai2:, account_statement_ofx:, account_verification_letter:, balance_csv:, bookkeeping_account_balance_csv:, category:, created_at:, daily_account_balance_csv:, dashboard_table_csv:, entity_csv:, fee_csv:, form_1099_int:, form_1099_misc:, funding_instructions:, idempotency_key:, result:, status:, transaction_csv:, type:, vendor_csv:, voided_check:)
|
|
155
162
|
# Some parameter documentations has been truncated, see {Increase::Models::Export}
|
|
156
163
|
# for more details.
|
|
157
164
|
#
|
|
@@ -177,6 +184,8 @@ module Increase
|
|
|
177
184
|
#
|
|
178
185
|
# @param created_at [Time] The time the Export was created.
|
|
179
186
|
#
|
|
187
|
+
# @param daily_account_balance_csv [Increase::Models::Export::DailyAccountBalanceCsv, nil] Details of the daily account balance CSV export. This field will be present when
|
|
188
|
+
#
|
|
180
189
|
# @param dashboard_table_csv [Increase::Models::Export::DashboardTableCsv, nil] Details of the dashboard table CSV export. This field will be present when the `
|
|
181
190
|
#
|
|
182
191
|
# @param entity_csv [Increase::Models::Export::EntityCsv, nil] Details of the entity CSV export. This field will be present when the `category`
|
|
@@ -258,24 +267,24 @@ module Increase
|
|
|
258
267
|
|
|
259
268
|
# @see Increase::Models::Export::AccountStatementOfx#created_at
|
|
260
269
|
class CreatedAt < Increase::Internal::Type::BaseModel
|
|
261
|
-
# @!attribute after
|
|
262
|
-
# Filter results to transactions created after this time.
|
|
263
|
-
#
|
|
264
|
-
# @return [Time, nil]
|
|
265
|
-
required :after, Time, nil?: true
|
|
266
|
-
|
|
267
270
|
# @!attribute before
|
|
268
271
|
# Filter results to transactions created before this time.
|
|
269
272
|
#
|
|
270
273
|
# @return [Time, nil]
|
|
271
274
|
required :before, Time, nil?: true
|
|
272
275
|
|
|
273
|
-
# @!
|
|
274
|
-
# Filter
|
|
276
|
+
# @!attribute on_or_after
|
|
277
|
+
# Filter results to transactions created on or after this time.
|
|
275
278
|
#
|
|
276
|
-
# @
|
|
279
|
+
# @return [Time, nil]
|
|
280
|
+
required :on_or_after, Time, nil?: true
|
|
281
|
+
|
|
282
|
+
# @!method initialize(before:, on_or_after:)
|
|
283
|
+
# Filter transactions by their created date.
|
|
277
284
|
#
|
|
278
285
|
# @param before [Time, nil] Filter results to transactions created before this time.
|
|
286
|
+
#
|
|
287
|
+
# @param on_or_after [Time, nil] Filter results to transactions created on or after this time.
|
|
279
288
|
end
|
|
280
289
|
end
|
|
281
290
|
|
|
@@ -441,10 +450,44 @@ module Increase
|
|
|
441
450
|
# A PDF of a voided check.
|
|
442
451
|
VOIDED_CHECK = :voided_check
|
|
443
452
|
|
|
453
|
+
# Export a CSV of daily account balances with starting and ending balances for a given date range.
|
|
454
|
+
DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
|
|
455
|
+
|
|
444
456
|
# @!method self.values
|
|
445
457
|
# @return [Array<Symbol>]
|
|
446
458
|
end
|
|
447
459
|
|
|
460
|
+
# @see Increase::Models::Export#daily_account_balance_csv
|
|
461
|
+
class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
|
|
462
|
+
# @!attribute account_id
|
|
463
|
+
# Filter results by Account.
|
|
464
|
+
#
|
|
465
|
+
# @return [String, nil]
|
|
466
|
+
required :account_id, String, nil?: true
|
|
467
|
+
|
|
468
|
+
# @!attribute on_or_after_date
|
|
469
|
+
# Filter balances on or after this date.
|
|
470
|
+
#
|
|
471
|
+
# @return [Date, nil]
|
|
472
|
+
required :on_or_after_date, Date, nil?: true
|
|
473
|
+
|
|
474
|
+
# @!attribute on_or_before_date
|
|
475
|
+
# Filter balances on or before this date.
|
|
476
|
+
#
|
|
477
|
+
# @return [Date, nil]
|
|
478
|
+
required :on_or_before_date, Date, nil?: true
|
|
479
|
+
|
|
480
|
+
# @!method initialize(account_id:, on_or_after_date:, on_or_before_date:)
|
|
481
|
+
# Details of the daily account balance CSV export. This field will be present when
|
|
482
|
+
# the `category` is equal to `daily_account_balance_csv`.
|
|
483
|
+
#
|
|
484
|
+
# @param account_id [String, nil] Filter results by Account.
|
|
485
|
+
#
|
|
486
|
+
# @param on_or_after_date [Date, nil] Filter balances on or after this date.
|
|
487
|
+
#
|
|
488
|
+
# @param on_or_before_date [Date, nil] Filter balances on or before this date.
|
|
489
|
+
end
|
|
490
|
+
|
|
448
491
|
# @see Increase::Models::Export#dashboard_table_csv
|
|
449
492
|
class DashboardTableCsv < Increase::Internal::Type::BaseModel
|
|
450
493
|
# @!method initialize
|
|
@@ -49,6 +49,13 @@ module Increase
|
|
|
49
49
|
optional :bookkeeping_account_balance_csv,
|
|
50
50
|
-> { Increase::ExportCreateParams::BookkeepingAccountBalanceCsv }
|
|
51
51
|
|
|
52
|
+
# @!attribute daily_account_balance_csv
|
|
53
|
+
# Options for the created export. Required if `category` is equal to
|
|
54
|
+
# `daily_account_balance_csv`.
|
|
55
|
+
#
|
|
56
|
+
# @return [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv, nil]
|
|
57
|
+
optional :daily_account_balance_csv, -> { Increase::ExportCreateParams::DailyAccountBalanceCsv }
|
|
58
|
+
|
|
52
59
|
# @!attribute entity_csv
|
|
53
60
|
# Options for the created export. Required if `category` is equal to `entity_csv`.
|
|
54
61
|
#
|
|
@@ -82,7 +89,7 @@ module Increase
|
|
|
82
89
|
# @return [Increase::Models::ExportCreateParams::VoidedCheck, nil]
|
|
83
90
|
optional :voided_check, -> { Increase::ExportCreateParams::VoidedCheck }
|
|
84
91
|
|
|
85
|
-
# @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
|
|
92
|
+
# @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
|
|
86
93
|
# Some parameter documentations has been truncated, see
|
|
87
94
|
# {Increase::Models::ExportCreateParams} for more details.
|
|
88
95
|
#
|
|
@@ -99,6 +106,8 @@ module Increase
|
|
|
99
106
|
# @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
|
|
100
107
|
# `bookkeeping\_
|
|
101
108
|
#
|
|
109
|
+
# @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
|
|
110
|
+
#
|
|
102
111
|
# @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
|
|
103
112
|
#
|
|
104
113
|
# @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
|
|
@@ -146,6 +155,9 @@ module Increase
|
|
|
146
155
|
# A PDF of a voided check.
|
|
147
156
|
VOIDED_CHECK = :voided_check
|
|
148
157
|
|
|
158
|
+
# Export a CSV of daily account balances with starting and ending balances for a given date range.
|
|
159
|
+
DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
|
|
160
|
+
|
|
149
161
|
# @!method self.values
|
|
150
162
|
# @return [Array<Symbol>]
|
|
151
163
|
end
|
|
@@ -196,7 +208,7 @@ module Increase
|
|
|
196
208
|
required :account_id, String
|
|
197
209
|
|
|
198
210
|
# @!attribute created_at
|
|
199
|
-
# Filter
|
|
211
|
+
# Filter transactions by their created date.
|
|
200
212
|
#
|
|
201
213
|
# @return [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt, nil]
|
|
202
214
|
optional :created_at, -> { Increase::ExportCreateParams::AccountStatementOfx::CreatedAt }
|
|
@@ -207,52 +219,28 @@ module Increase
|
|
|
207
219
|
#
|
|
208
220
|
# @param account_id [String] The Account to create a statement for.
|
|
209
221
|
#
|
|
210
|
-
# @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] Filter
|
|
222
|
+
# @param created_at [Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt] Filter transactions by their created date.
|
|
211
223
|
|
|
212
224
|
# @see Increase::Models::ExportCreateParams::AccountStatementOfx#created_at
|
|
213
225
|
class CreatedAt < Increase::Internal::Type::BaseModel
|
|
214
|
-
# @!attribute after
|
|
215
|
-
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
216
|
-
# timestamp.
|
|
217
|
-
#
|
|
218
|
-
# @return [Time, nil]
|
|
219
|
-
optional :after, Time
|
|
220
|
-
|
|
221
226
|
# @!attribute before
|
|
222
|
-
#
|
|
223
|
-
# timestamp.
|
|
227
|
+
# Filter results to transactions created before this time.
|
|
224
228
|
#
|
|
225
229
|
# @return [Time, nil]
|
|
226
230
|
optional :before, Time
|
|
227
231
|
|
|
228
232
|
# @!attribute on_or_after
|
|
229
|
-
#
|
|
230
|
-
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
233
|
+
# Filter results to transactions created on or after this time.
|
|
231
234
|
#
|
|
232
235
|
# @return [Time, nil]
|
|
233
236
|
optional :on_or_after, Time
|
|
234
237
|
|
|
235
|
-
# @!
|
|
236
|
-
#
|
|
237
|
-
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
238
|
-
#
|
|
239
|
-
# @return [Time, nil]
|
|
240
|
-
optional :on_or_before, Time
|
|
241
|
-
|
|
242
|
-
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
243
|
-
# Some parameter documentations has been truncated, see
|
|
244
|
-
# {Increase::Models::ExportCreateParams::AccountStatementOfx::CreatedAt} for more
|
|
245
|
-
# details.
|
|
238
|
+
# @!method initialize(before: nil, on_or_after: nil)
|
|
239
|
+
# Filter transactions by their created date.
|
|
246
240
|
#
|
|
247
|
-
# Filter results
|
|
248
|
-
#
|
|
249
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
250
|
-
#
|
|
251
|
-
# @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
|
|
252
|
-
#
|
|
253
|
-
# @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
|
|
241
|
+
# @param before [Time] Filter results to transactions created before this time.
|
|
254
242
|
#
|
|
255
|
-
# @param
|
|
243
|
+
# @param on_or_after [Time] Filter results to transactions created on or after this time.
|
|
256
244
|
end
|
|
257
245
|
end
|
|
258
246
|
|
|
@@ -418,6 +406,36 @@ module Increase
|
|
|
418
406
|
end
|
|
419
407
|
end
|
|
420
408
|
|
|
409
|
+
class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
|
|
410
|
+
# @!attribute account_id
|
|
411
|
+
# Filter exported Balances to the specified Account.
|
|
412
|
+
#
|
|
413
|
+
# @return [String, nil]
|
|
414
|
+
optional :account_id, String
|
|
415
|
+
|
|
416
|
+
# @!attribute on_or_after_date
|
|
417
|
+
# Filter exported Balances to those on or after this date.
|
|
418
|
+
#
|
|
419
|
+
# @return [Date, nil]
|
|
420
|
+
optional :on_or_after_date, Date
|
|
421
|
+
|
|
422
|
+
# @!attribute on_or_before_date
|
|
423
|
+
# Filter exported Balances to those on or before this date.
|
|
424
|
+
#
|
|
425
|
+
# @return [Date, nil]
|
|
426
|
+
optional :on_or_before_date, Date
|
|
427
|
+
|
|
428
|
+
# @!method initialize(account_id: nil, on_or_after_date: nil, on_or_before_date: nil)
|
|
429
|
+
# Options for the created export. Required if `category` is equal to
|
|
430
|
+
# `daily_account_balance_csv`.
|
|
431
|
+
#
|
|
432
|
+
# @param account_id [String] Filter exported Balances to the specified Account.
|
|
433
|
+
#
|
|
434
|
+
# @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
|
|
435
|
+
#
|
|
436
|
+
# @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
|
|
437
|
+
end
|
|
438
|
+
|
|
421
439
|
class EntityCsv < Increase::Internal::Type::BaseModel
|
|
422
440
|
# @!method initialize
|
|
423
441
|
# Options for the created export. Required if `category` is equal to `entity_csv`.
|
|
@@ -123,6 +123,9 @@ module Increase
|
|
|
123
123
|
# A PDF of a voided check.
|
|
124
124
|
VOIDED_CHECK = :voided_check
|
|
125
125
|
|
|
126
|
+
# Export a CSV of daily account balances with starting and ending balances for a given date range.
|
|
127
|
+
DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
|
|
128
|
+
|
|
126
129
|
# @!method self.values
|
|
127
130
|
# @return [Array<Symbol>]
|
|
128
131
|
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
module Simulations
|
|
6
|
+
# @see Increase::Resources::Simulations::EntityOnboardingSessions#submit
|
|
7
|
+
class EntityOnboardingSessionSubmitParams < Increase::Internal::Type::BaseModel
|
|
8
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Increase::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute entity_onboarding_session_id
|
|
12
|
+
# The identifier of the Entity Onboarding Session you wish to submit.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :entity_onboarding_session_id, String
|
|
16
|
+
|
|
17
|
+
# @!method initialize(entity_onboarding_session_id:, request_options: {})
|
|
18
|
+
# @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session you wish to submit.
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
data/lib/increase/models.rb
CHANGED
|
@@ -269,6 +269,16 @@ module Increase
|
|
|
269
269
|
|
|
270
270
|
EntityListParams = Increase::Models::EntityListParams
|
|
271
271
|
|
|
272
|
+
EntityOnboardingSession = Increase::Models::EntityOnboardingSession
|
|
273
|
+
|
|
274
|
+
EntityOnboardingSessionCreateParams = Increase::Models::EntityOnboardingSessionCreateParams
|
|
275
|
+
|
|
276
|
+
EntityOnboardingSessionExpireParams = Increase::Models::EntityOnboardingSessionExpireParams
|
|
277
|
+
|
|
278
|
+
EntityOnboardingSessionListParams = Increase::Models::EntityOnboardingSessionListParams
|
|
279
|
+
|
|
280
|
+
EntityOnboardingSessionRetrieveParams = Increase::Models::EntityOnboardingSessionRetrieveParams
|
|
281
|
+
|
|
272
282
|
EntityRetrieveParams = Increase::Models::EntityRetrieveParams
|
|
273
283
|
|
|
274
284
|
EntitySupplementalDocument = Increase::Models::EntitySupplementalDocument
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Resources
|
|
5
|
+
class EntityOnboardingSessions
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {Increase::Models::EntityOnboardingSessionCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Create an Entity Onboarding Session
|
|
10
|
+
#
|
|
11
|
+
# @overload create(program_id:, redirect_url:, entity_id: nil, request_options: {})
|
|
12
|
+
#
|
|
13
|
+
# @param program_id [String] The identifier of the Program the Entity will be onboarded to.
|
|
14
|
+
#
|
|
15
|
+
# @param redirect_url [String] The URL to redirect the customer to after they complete the onboarding form. The
|
|
16
|
+
#
|
|
17
|
+
# @param entity_id [String] The identifier of an existing Entity to associate with the onboarding session. I
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
20
|
+
#
|
|
21
|
+
# @return [Increase::Models::EntityOnboardingSession]
|
|
22
|
+
#
|
|
23
|
+
# @see Increase::Models::EntityOnboardingSessionCreateParams
|
|
24
|
+
def create(params)
|
|
25
|
+
parsed, options = Increase::EntityOnboardingSessionCreateParams.dump_request(params)
|
|
26
|
+
@client.request(
|
|
27
|
+
method: :post,
|
|
28
|
+
path: "entity_onboarding_sessions",
|
|
29
|
+
body: parsed,
|
|
30
|
+
model: Increase::EntityOnboardingSession,
|
|
31
|
+
options: options
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Retrieve an Entity Onboarding Session
|
|
36
|
+
#
|
|
37
|
+
# @overload retrieve(entity_onboarding_session_id, request_options: {})
|
|
38
|
+
#
|
|
39
|
+
# @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session.
|
|
40
|
+
#
|
|
41
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
42
|
+
#
|
|
43
|
+
# @return [Increase::Models::EntityOnboardingSession]
|
|
44
|
+
#
|
|
45
|
+
# @see Increase::Models::EntityOnboardingSessionRetrieveParams
|
|
46
|
+
def retrieve(entity_onboarding_session_id, params = {})
|
|
47
|
+
@client.request(
|
|
48
|
+
method: :get,
|
|
49
|
+
path: ["entity_onboarding_sessions/%1$s", entity_onboarding_session_id],
|
|
50
|
+
model: Increase::EntityOnboardingSession,
|
|
51
|
+
options: params[:request_options]
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Some parameter documentations has been truncated, see
|
|
56
|
+
# {Increase::Models::EntityOnboardingSessionListParams} for more details.
|
|
57
|
+
#
|
|
58
|
+
# List Entity Onboarding Session
|
|
59
|
+
#
|
|
60
|
+
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
61
|
+
#
|
|
62
|
+
# @param cursor [String] Return the page of entries after this one.
|
|
63
|
+
#
|
|
64
|
+
# @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
|
|
65
|
+
#
|
|
66
|
+
# @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
|
|
67
|
+
#
|
|
68
|
+
# @param status [Increase::Models::EntityOnboardingSessionListParams::Status]
|
|
69
|
+
#
|
|
70
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
71
|
+
#
|
|
72
|
+
# @return [Increase::Internal::Page<Increase::Models::EntityOnboardingSession>]
|
|
73
|
+
#
|
|
74
|
+
# @see Increase::Models::EntityOnboardingSessionListParams
|
|
75
|
+
def list(params = {})
|
|
76
|
+
parsed, options = Increase::EntityOnboardingSessionListParams.dump_request(params)
|
|
77
|
+
query = Increase::Internal::Util.encode_query_params(parsed)
|
|
78
|
+
@client.request(
|
|
79
|
+
method: :get,
|
|
80
|
+
path: "entity_onboarding_sessions",
|
|
81
|
+
query: query,
|
|
82
|
+
page: Increase::Internal::Page,
|
|
83
|
+
model: Increase::EntityOnboardingSession,
|
|
84
|
+
options: options
|
|
85
|
+
)
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Expire an Entity Onboarding Session
|
|
89
|
+
#
|
|
90
|
+
# @overload expire(entity_onboarding_session_id, request_options: {})
|
|
91
|
+
#
|
|
92
|
+
# @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session to expire.
|
|
93
|
+
#
|
|
94
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
|
+
#
|
|
96
|
+
# @return [Increase::Models::EntityOnboardingSession]
|
|
97
|
+
#
|
|
98
|
+
# @see Increase::Models::EntityOnboardingSessionExpireParams
|
|
99
|
+
def expire(entity_onboarding_session_id, params = {})
|
|
100
|
+
@client.request(
|
|
101
|
+
method: :post,
|
|
102
|
+
path: ["entity_onboarding_sessions/%1$s/expire", entity_onboarding_session_id],
|
|
103
|
+
model: Increase::EntityOnboardingSession,
|
|
104
|
+
options: params[:request_options]
|
|
105
|
+
)
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# @api private
|
|
109
|
+
#
|
|
110
|
+
# @param client [Increase::Client]
|
|
111
|
+
def initialize(client:)
|
|
112
|
+
@client = client
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
end
|
|
@@ -8,7 +8,7 @@ module Increase
|
|
|
8
8
|
#
|
|
9
9
|
# Create an Export
|
|
10
10
|
#
|
|
11
|
-
# @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
|
|
11
|
+
# @overload create(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
|
|
12
12
|
#
|
|
13
13
|
# @param category [Symbol, Increase::Models::ExportCreateParams::Category] The type of Export to create.
|
|
14
14
|
#
|
|
@@ -23,6 +23,8 @@ module Increase
|
|
|
23
23
|
# @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
|
|
24
24
|
# `bookkeeping\_
|
|
25
25
|
#
|
|
26
|
+
# @param daily_account_balance_csv [Increase::Models::ExportCreateParams::DailyAccountBalanceCsv] Options for the created export. Required if `category` is equal to `daily_accoun
|
|
27
|
+
#
|
|
26
28
|
# @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
|
|
27
29
|
#
|
|
28
30
|
# @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Resources
|
|
5
|
+
class Simulations
|
|
6
|
+
class EntityOnboardingSessions
|
|
7
|
+
# Simulates the submission of an
|
|
8
|
+
# [Entity Onboarding Session](#entity-onboarding-sessions). This session must have
|
|
9
|
+
# a `status` of `active`. After submission, the session will transition to
|
|
10
|
+
# `expired` and a new Entity will be created.
|
|
11
|
+
#
|
|
12
|
+
# @overload submit(entity_onboarding_session_id, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param entity_onboarding_session_id [String] The identifier of the Entity Onboarding Session you wish to submit.
|
|
15
|
+
#
|
|
16
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
|
+
#
|
|
18
|
+
# @return [Increase::Models::EntityOnboardingSession]
|
|
19
|
+
#
|
|
20
|
+
# @see Increase::Models::Simulations::EntityOnboardingSessionSubmitParams
|
|
21
|
+
def submit(entity_onboarding_session_id, params = {})
|
|
22
|
+
@client.request(
|
|
23
|
+
method: :post,
|
|
24
|
+
path: ["simulations/entity_onboarding_sessions/%1$s/submit", entity_onboarding_session_id],
|
|
25
|
+
model: Increase::EntityOnboardingSession,
|
|
26
|
+
options: params[:request_options]
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# @api private
|
|
31
|
+
#
|
|
32
|
+
# @param client [Increase::Client]
|
|
33
|
+
def initialize(client:)
|
|
34
|
+
@client = client
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -87,6 +87,9 @@ module Increase
|
|
|
87
87
|
# @return [Increase::Resources::Simulations::InboundMailItems]
|
|
88
88
|
attr_reader :inbound_mail_items
|
|
89
89
|
|
|
90
|
+
# @return [Increase::Resources::Simulations::EntityOnboardingSessions]
|
|
91
|
+
attr_reader :entity_onboarding_sessions
|
|
92
|
+
|
|
90
93
|
# @return [Increase::Resources::Simulations::Programs]
|
|
91
94
|
attr_reader :programs
|
|
92
95
|
|
|
@@ -137,6 +140,8 @@ module Increase
|
|
|
137
140
|
@inbound_fednow_transfers = Increase::Resources::Simulations::InboundFednowTransfers.new(client: client)
|
|
138
141
|
@check_deposits = Increase::Resources::Simulations::CheckDeposits.new(client: client)
|
|
139
142
|
@inbound_mail_items = Increase::Resources::Simulations::InboundMailItems.new(client: client)
|
|
143
|
+
@entity_onboarding_sessions =
|
|
144
|
+
Increase::Resources::Simulations::EntityOnboardingSessions.new(client: client)
|
|
140
145
|
@programs = Increase::Resources::Simulations::Programs.new(client: client)
|
|
141
146
|
@account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
|
|
142
147
|
@exports = Increase::Resources::Simulations::Exports.new(client: client)
|
data/lib/increase/version.rb
CHANGED
data/lib/increase.rb
CHANGED
|
@@ -169,6 +169,11 @@ require_relative "increase/models/entity_archive_params"
|
|
|
169
169
|
require_relative "increase/models/entity_beneficial_owner"
|
|
170
170
|
require_relative "increase/models/entity_create_params"
|
|
171
171
|
require_relative "increase/models/entity_list_params"
|
|
172
|
+
require_relative "increase/models/entity_onboarding_session"
|
|
173
|
+
require_relative "increase/models/entity_onboarding_session_create_params"
|
|
174
|
+
require_relative "increase/models/entity_onboarding_session_expire_params"
|
|
175
|
+
require_relative "increase/models/entity_onboarding_session_list_params"
|
|
176
|
+
require_relative "increase/models/entity_onboarding_session_retrieve_params"
|
|
172
177
|
require_relative "increase/models/entity_retrieve_params"
|
|
173
178
|
require_relative "increase/models/entity_supplemental_document"
|
|
174
179
|
require_relative "increase/models/entity_update_params"
|
|
@@ -315,6 +320,7 @@ require_relative "increase/models/simulations/check_deposit_submit_params"
|
|
|
315
320
|
require_relative "increase/models/simulations/check_transfer_mail_params"
|
|
316
321
|
require_relative "increase/models/simulations/digital_wallet_token_request_create_params"
|
|
317
322
|
require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
|
|
323
|
+
require_relative "increase/models/simulations/entity_onboarding_session_submit_params"
|
|
318
324
|
require_relative "increase/models/simulations/export_create_params"
|
|
319
325
|
require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
|
|
320
326
|
require_relative "increase/models/simulations/inbound_check_deposit_adjustment_params"
|
|
@@ -380,6 +386,7 @@ require_relative "increase/resources/declined_transactions"
|
|
|
380
386
|
require_relative "increase/resources/digital_card_profiles"
|
|
381
387
|
require_relative "increase/resources/digital_wallet_tokens"
|
|
382
388
|
require_relative "increase/resources/entities"
|
|
389
|
+
require_relative "increase/resources/entity_onboarding_sessions"
|
|
383
390
|
require_relative "increase/resources/events"
|
|
384
391
|
require_relative "increase/resources/event_subscriptions"
|
|
385
392
|
require_relative "increase/resources/exports"
|
|
@@ -427,6 +434,7 @@ require_relative "increase/resources/simulations/card_tokens"
|
|
|
427
434
|
require_relative "increase/resources/simulations/check_deposits"
|
|
428
435
|
require_relative "increase/resources/simulations/check_transfers"
|
|
429
436
|
require_relative "increase/resources/simulations/digital_wallet_token_requests"
|
|
437
|
+
require_relative "increase/resources/simulations/entity_onboarding_sessions"
|
|
430
438
|
require_relative "increase/resources/simulations/exports"
|
|
431
439
|
require_relative "increase/resources/simulations/inbound_ach_transfers"
|
|
432
440
|
require_relative "increase/resources/simulations/inbound_check_deposits"
|
data/rbi/increase/client.rbi
CHANGED
|
@@ -133,6 +133,9 @@ module Increase
|
|
|
133
133
|
sig { returns(Increase::Resources::SupplementalDocuments) }
|
|
134
134
|
attr_reader :supplemental_documents
|
|
135
135
|
|
|
136
|
+
sig { returns(Increase::Resources::EntityOnboardingSessions) }
|
|
137
|
+
attr_reader :entity_onboarding_sessions
|
|
138
|
+
|
|
136
139
|
sig { returns(Increase::Resources::Programs) }
|
|
137
140
|
attr_reader :programs
|
|
138
141
|
|