increase 1.166.1 → 1.167.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 196e6b116a53d982181ad1485313afb13f680200d6c9fad43751d6a0891c212e
4
- data.tar.gz: c17efddaf33b807889acce712a01b4795018e7b3876c4376cfb7ce2698c23c7b
3
+ metadata.gz: d8c8214f5201735e5453c5f1e0917ed33635244b1a1940c635bae3900474c69f
4
+ data.tar.gz: cab9f60a6e6dfac4225fc030293bd81283e698575a1c46bed91057516bb47405
5
5
  SHA512:
6
- metadata.gz: 1ccc0039065357b7db207ccbe182a5428fa03f2cf6fd50d62825e3fcd9a4d9840c6d36ae9d3a2b85c540b86e2b8697790b6fc057d94731f4cecea3cb630222ec
7
- data.tar.gz: 0f844e51756523ac124abe4a96b29e228d292861793248de70bc260cabacc82f464b7362b1e9d161129ad05b9a9d33ddbbbe6a21886cd86faae36f53e8114f7b
6
+ metadata.gz: eee3f8fa0d9018b71087c69008e8a71f88017c0f1332d3fd9f66ca686009f8e743ebc0158c1d103c5f2b3b91e99ec948be3ae7d406825c8b12c0afc267bc6065
7
+ data.tar.gz: 00c0f96a7b2fad56ec768619d3b2192b123761a6c1bdc2e6d077fe562ac1483cd96f163f59bb36f1d73f484d3f292eafb269c0ddc75be11a66841a9c7e23b9c7
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.167.0 (2025-12-18)
4
+
5
+ Full Changelog: [v1.166.1...v1.167.0](https://github.com/Increase/increase-ruby/compare/v1.166.1...v1.167.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([8083993](https://github.com/Increase/increase-ruby/commit/80839936c4b528bb4c1070c5382196cba2206ad3))
10
+
3
11
  ## 1.166.1 (2025-12-18)
4
12
 
5
13
  Full Changelog: [v1.166.0...v1.166.1](https://github.com/Increase/increase-ruby/compare/v1.166.0...v1.166.1)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.166.1"
18
+ gem "increase", "~> 1.167.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -62,10 +62,10 @@ module Increase
62
62
  # Some parameter documentations has been truncated, see {Increase::Models::Export}
63
63
  # for more details.
64
64
  #
65
- # Exports are batch summaries of your Increase data. You can make them from the
66
- # API or dashboard. Since they can take a while, they are generated
67
- # asynchronously. We send a webhook when they are ready. For more information,
68
- # please read our
65
+ # Exports are generated files. Some exports can contain a lot of data, like a CSV
66
+ # of your transactions. Others can be a single document, like a tax form. Since
67
+ # they can take a while, they are generated asynchronously. We send a webhook when
68
+ # they are ready. For more information, please read our
69
69
  # [Exports documentation](https://increase.com/documentation/exports).
70
70
  #
71
71
  # @param id [String] The Export identifier.
@@ -27,6 +27,13 @@ module Increase
27
27
  # @return [Increase::Models::ExportCreateParams::AccountStatementOfx, nil]
28
28
  optional :account_statement_ofx, -> { Increase::ExportCreateParams::AccountStatementOfx }
29
29
 
30
+ # @!attribute account_verification_letter
31
+ # Options for the created export. Required if `category` is equal to
32
+ # `account_verification_letter`.
33
+ #
34
+ # @return [Increase::Models::ExportCreateParams::AccountVerificationLetter, nil]
35
+ optional :account_verification_letter, -> { Increase::ExportCreateParams::AccountVerificationLetter }
36
+
30
37
  # @!attribute balance_csv
31
38
  # Options for the created export. Required if `category` is equal to
32
39
  # `balance_csv`.
@@ -48,6 +55,13 @@ module Increase
48
55
  # @return [Increase::Models::ExportCreateParams::EntityCsv, nil]
49
56
  optional :entity_csv, -> { Increase::ExportCreateParams::EntityCsv }
50
57
 
58
+ # @!attribute funding_instructions
59
+ # Options for the created export. Required if `category` is equal to
60
+ # `funding_instructions`.
61
+ #
62
+ # @return [Increase::Models::ExportCreateParams::FundingInstructions, nil]
63
+ optional :funding_instructions, -> { Increase::ExportCreateParams::FundingInstructions }
64
+
51
65
  # @!attribute transaction_csv
52
66
  # Options for the created export. Required if `category` is equal to
53
67
  # `transaction_csv`.
@@ -61,7 +75,7 @@ module Increase
61
75
  # @return [Increase::Models::ExportCreateParams::VendorCsv, nil]
62
76
  optional :vendor_csv, -> { Increase::ExportCreateParams::VendorCsv }
63
77
 
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: {})
78
+ # @!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, request_options: {})
65
79
  # Some parameter documentations has been truncated, see
66
80
  # {Increase::Models::ExportCreateParams} for more details.
67
81
  #
@@ -71,6 +85,8 @@ module Increase
71
85
  #
72
86
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
73
87
  #
88
+ # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
89
+ #
74
90
  # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
75
91
  #
76
92
  # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
@@ -78,6 +94,8 @@ module Increase
78
94
  #
79
95
  # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
80
96
  #
97
+ # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
98
+ #
81
99
  # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
82
100
  # `transaction\_
83
101
  #
@@ -110,6 +128,12 @@ module Increase
110
128
  # Export a CSV of vendors added to the third-party risk management dashboard.
111
129
  VENDOR_CSV = :vendor_csv
112
130
 
131
+ # A PDF of an account verification letter.
132
+ ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
133
+
134
+ # A PDF of funding instructions.
135
+ FUNDING_INSTRUCTIONS = :funding_instructions
136
+
113
137
  # @!method self.values
114
138
  # @return [Array<Symbol>]
115
139
  end
@@ -220,6 +244,28 @@ module Increase
220
244
  end
221
245
  end
222
246
 
247
+ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
248
+ # @!attribute account_number_id
249
+ # The Account Number to create a letter for.
250
+ #
251
+ # @return [String]
252
+ required :account_number_id, String
253
+
254
+ # @!attribute balance_date
255
+ # The date of the balance to include in the letter. Defaults to the current date.
256
+ #
257
+ # @return [Date, nil]
258
+ optional :balance_date, Date
259
+
260
+ # @!method initialize(account_number_id:, balance_date: nil)
261
+ # Options for the created export. Required if `category` is equal to
262
+ # `account_verification_letter`.
263
+ #
264
+ # @param account_number_id [String] The Account Number to create a letter for.
265
+ #
266
+ # @param balance_date [Date] The date of the balance to include in the letter. Defaults to the current date.
267
+ end
268
+
223
269
  class BalanceCsv < Increase::Internal::Type::BaseModel
224
270
  # @!attribute account_id
225
271
  # Filter exported Transactions to the specified Account.
@@ -414,6 +460,20 @@ module Increase
414
460
  end
415
461
  end
416
462
 
463
+ class FundingInstructions < Increase::Internal::Type::BaseModel
464
+ # @!attribute account_number_id
465
+ # The Account Number to create funding instructions for.
466
+ #
467
+ # @return [String]
468
+ required :account_number_id, String
469
+
470
+ # @!method initialize(account_number_id:)
471
+ # Options for the created export. Required if `category` is equal to
472
+ # `funding_instructions`.
473
+ #
474
+ # @param account_number_id [String] The Account Number to create funding instructions for.
475
+ end
476
+
417
477
  class TransactionCsv < Increase::Internal::Type::BaseModel
418
478
  # @!attribute account_id
419
479
  # Filter exported Transactions to the specified Account.
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::Exports#create
7
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute account_id
12
+ # The identifier of the Account the tax document is for.
13
+ #
14
+ # @return [String]
15
+ required :account_id, String
16
+
17
+ # @!method initialize(account_id:, request_options: {})
18
+ # @param account_id [String] The identifier of the Account the tax document is for.
19
+ #
20
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
24
+ 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, 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, account_verification_letter: nil, balance_csv: nil, bookkeeping_account_balance_csv: nil, entity_csv: nil, funding_instructions: 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
  #
@@ -16,6 +16,8 @@ module Increase
16
16
  #
17
17
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx] Options for the created export. Required if `category` is equal to `account_stat
18
18
  #
19
+ # @param account_verification_letter [Increase::Models::ExportCreateParams::AccountVerificationLetter] Options for the created export. Required if `category` is equal to `account_veri
20
+ #
19
21
  # @param balance_csv [Increase::Models::ExportCreateParams::BalanceCsv] Options for the created export. Required if `category` is equal to `balance_csv`
20
22
  #
21
23
  # @param bookkeeping_account_balance_csv [Increase::Models::ExportCreateParams::BookkeepingAccountBalanceCsv] Options for the created export. Required if `category` is equal to
@@ -23,6 +25,8 @@ module Increase
23
25
  #
24
26
  # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
25
27
  #
28
+ # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
29
+ #
26
30
  # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
27
31
  # `transaction\_
28
32
  #
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class Exports
7
+ # Simulates a tax form export being generated.
8
+ #
9
+ # @overload create(account_id:, request_options: {})
10
+ #
11
+ # @param account_id [String] The identifier of the Account the tax document is for.
12
+ #
13
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
14
+ #
15
+ # @return [Increase::Models::Export]
16
+ #
17
+ # @see Increase::Models::Simulations::ExportCreateParams
18
+ def create(params)
19
+ parsed, options = Increase::Simulations::ExportCreateParams.dump_request(params)
20
+ @client.request(
21
+ method: :post,
22
+ path: "simulations/exports",
23
+ body: parsed,
24
+ model: Increase::Export,
25
+ options: options
26
+ )
27
+ end
28
+
29
+ # @api private
30
+ #
31
+ # @param client [Increase::Client]
32
+ def initialize(client:)
33
+ @client = client
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -93,6 +93,9 @@ module Increase
93
93
  # @return [Increase::Resources::Simulations::Documents]
94
94
  attr_reader :documents
95
95
 
96
+ # @return [Increase::Resources::Simulations::Exports]
97
+ attr_reader :exports
98
+
96
99
  # @return [Increase::Resources::Simulations::CardTokens]
97
100
  attr_reader :card_tokens
98
101
 
@@ -136,6 +139,7 @@ module Increase
136
139
  @programs = Increase::Resources::Simulations::Programs.new(client: client)
137
140
  @account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
138
141
  @documents = Increase::Resources::Simulations::Documents.new(client: client)
142
+ @exports = Increase::Resources::Simulations::Exports.new(client: client)
139
143
  @card_tokens = Increase::Resources::Simulations::CardTokens.new(client: client)
140
144
  end
141
145
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.166.1"
4
+ VERSION = "1.167.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -314,6 +314,7 @@ require_relative "increase/models/simulations/check_transfer_mail_params"
314
314
  require_relative "increase/models/simulations/digital_wallet_token_request_create_params"
315
315
  require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
316
316
  require_relative "increase/models/simulations/document_create_params"
317
+ require_relative "increase/models/simulations/export_create_params"
317
318
  require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
318
319
  require_relative "increase/models/simulations/inbound_check_deposit_create_params"
319
320
  require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
@@ -417,6 +418,7 @@ require_relative "increase/resources/simulations/check_deposits"
417
418
  require_relative "increase/resources/simulations/check_transfers"
418
419
  require_relative "increase/resources/simulations/digital_wallet_token_requests"
419
420
  require_relative "increase/resources/simulations/documents"
421
+ require_relative "increase/resources/simulations/exports"
420
422
  require_relative "increase/resources/simulations/inbound_ach_transfers"
421
423
  require_relative "increase/resources/simulations/inbound_check_deposits"
422
424
  require_relative "increase/resources/simulations/inbound_fednow_transfers"
@@ -44,10 +44,10 @@ module Increase
44
44
  sig { returns(Increase::Export::Type::TaggedSymbol) }
45
45
  attr_accessor :type
46
46
 
47
- # Exports are batch summaries of your Increase data. You can make them from the
48
- # API or dashboard. Since they can take a while, they are generated
49
- # asynchronously. We send a webhook when they are ready. For more information,
50
- # please read our
47
+ # Exports are generated files. Some exports can contain a lot of data, like a CSV
48
+ # of your transactions. Others can be a single document, like a tax form. Since
49
+ # they can take a while, they are generated asynchronously. We send a webhook when
50
+ # they are ready. For more information, please read our
51
51
  # [Exports documentation](https://increase.com/documentation/exports).
52
52
  sig do
53
53
  params(
@@ -45,6 +45,23 @@ module Increase
45
45
  end
46
46
  attr_writer :account_statement_ofx
47
47
 
48
+ # Options for the created export. Required if `category` is equal to
49
+ # `account_verification_letter`.
50
+ sig do
51
+ returns(
52
+ T.nilable(Increase::ExportCreateParams::AccountVerificationLetter)
53
+ )
54
+ end
55
+ attr_reader :account_verification_letter
56
+
57
+ sig do
58
+ params(
59
+ account_verification_letter:
60
+ Increase::ExportCreateParams::AccountVerificationLetter::OrHash
61
+ ).void
62
+ end
63
+ attr_writer :account_verification_letter
64
+
48
65
  # Options for the created export. Required if `category` is equal to
49
66
  # `balance_csv`.
50
67
  sig { returns(T.nilable(Increase::ExportCreateParams::BalanceCsv)) }
@@ -83,6 +100,21 @@ module Increase
83
100
  end
84
101
  attr_writer :entity_csv
85
102
 
103
+ # Options for the created export. Required if `category` is equal to
104
+ # `funding_instructions`.
105
+ sig do
106
+ returns(T.nilable(Increase::ExportCreateParams::FundingInstructions))
107
+ end
108
+ attr_reader :funding_instructions
109
+
110
+ sig do
111
+ params(
112
+ funding_instructions:
113
+ Increase::ExportCreateParams::FundingInstructions::OrHash
114
+ ).void
115
+ end
116
+ attr_writer :funding_instructions
117
+
86
118
  # Options for the created export. Required if `category` is equal to
87
119
  # `transaction_csv`.
88
120
  sig { returns(T.nilable(Increase::ExportCreateParams::TransactionCsv)) }
@@ -111,10 +143,14 @@ module Increase
111
143
  Increase::ExportCreateParams::AccountStatementBai2::OrHash,
112
144
  account_statement_ofx:
113
145
  Increase::ExportCreateParams::AccountStatementOfx::OrHash,
146
+ account_verification_letter:
147
+ Increase::ExportCreateParams::AccountVerificationLetter::OrHash,
114
148
  balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
115
149
  bookkeeping_account_balance_csv:
116
150
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv::OrHash,
117
151
  entity_csv: Increase::ExportCreateParams::EntityCsv::OrHash,
152
+ funding_instructions:
153
+ Increase::ExportCreateParams::FundingInstructions::OrHash,
118
154
  transaction_csv: Increase::ExportCreateParams::TransactionCsv::OrHash,
119
155
  vendor_csv: Increase::ExportCreateParams::VendorCsv::OrHash,
120
156
  request_options: Increase::RequestOptions::OrHash
@@ -130,6 +166,9 @@ module Increase
130
166
  # `account_statement_ofx`.
131
167
  account_statement_ofx: nil,
132
168
  # Options for the created export. Required if `category` is equal to
169
+ # `account_verification_letter`.
170
+ account_verification_letter: nil,
171
+ # Options for the created export. Required if `category` is equal to
133
172
  # `balance_csv`.
134
173
  balance_csv: nil,
135
174
  # Options for the created export. Required if `category` is equal to
@@ -138,6 +177,9 @@ module Increase
138
177
  # Options for the created export. Required if `category` is equal to `entity_csv`.
139
178
  entity_csv: nil,
140
179
  # Options for the created export. Required if `category` is equal to
180
+ # `funding_instructions`.
181
+ funding_instructions: nil,
182
+ # Options for the created export. Required if `category` is equal to
141
183
  # `transaction_csv`.
142
184
  transaction_csv: nil,
143
185
  # Options for the created export. Required if `category` is equal to `vendor_csv`.
@@ -154,10 +196,14 @@ module Increase
154
196
  Increase::ExportCreateParams::AccountStatementBai2,
155
197
  account_statement_ofx:
156
198
  Increase::ExportCreateParams::AccountStatementOfx,
199
+ account_verification_letter:
200
+ Increase::ExportCreateParams::AccountVerificationLetter,
157
201
  balance_csv: Increase::ExportCreateParams::BalanceCsv,
158
202
  bookkeeping_account_balance_csv:
159
203
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
160
204
  entity_csv: Increase::ExportCreateParams::EntityCsv,
205
+ funding_instructions:
206
+ Increase::ExportCreateParams::FundingInstructions,
161
207
  transaction_csv: Increase::ExportCreateParams::TransactionCsv,
162
208
  vendor_csv: Increase::ExportCreateParams::VendorCsv,
163
209
  request_options: Increase::RequestOptions
@@ -224,6 +270,20 @@ module Increase
224
270
  Increase::ExportCreateParams::Category::TaggedSymbol
225
271
  )
226
272
 
273
+ # A PDF of an account verification letter.
274
+ ACCOUNT_VERIFICATION_LETTER =
275
+ T.let(
276
+ :account_verification_letter,
277
+ Increase::ExportCreateParams::Category::TaggedSymbol
278
+ )
279
+
280
+ # A PDF of funding instructions.
281
+ FUNDING_INSTRUCTIONS =
282
+ T.let(
283
+ :funding_instructions,
284
+ Increase::ExportCreateParams::Category::TaggedSymbol
285
+ )
286
+
227
287
  sig do
228
288
  override.returns(
229
289
  T::Array[Increase::ExportCreateParams::Category::TaggedSymbol]
@@ -442,6 +502,48 @@ module Increase
442
502
  end
443
503
  end
444
504
 
505
+ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
506
+ OrHash =
507
+ T.type_alias do
508
+ T.any(
509
+ Increase::ExportCreateParams::AccountVerificationLetter,
510
+ Increase::Internal::AnyHash
511
+ )
512
+ end
513
+
514
+ # The Account Number to create a letter for.
515
+ sig { returns(String) }
516
+ attr_accessor :account_number_id
517
+
518
+ # The date of the balance to include in the letter. Defaults to the current date.
519
+ sig { returns(T.nilable(Date)) }
520
+ attr_reader :balance_date
521
+
522
+ sig { params(balance_date: Date).void }
523
+ attr_writer :balance_date
524
+
525
+ # Options for the created export. Required if `category` is equal to
526
+ # `account_verification_letter`.
527
+ sig do
528
+ params(account_number_id: String, balance_date: Date).returns(
529
+ T.attached_class
530
+ )
531
+ end
532
+ def self.new(
533
+ # The Account Number to create a letter for.
534
+ account_number_id:,
535
+ # The date of the balance to include in the letter. Defaults to the current date.
536
+ balance_date: nil
537
+ )
538
+ end
539
+
540
+ sig do
541
+ override.returns({ account_number_id: String, balance_date: Date })
542
+ end
543
+ def to_hash
544
+ end
545
+ end
546
+
445
547
  class BalanceCsv < Increase::Internal::Type::BaseModel
446
548
  OrHash =
447
549
  T.type_alias do
@@ -875,6 +977,33 @@ module Increase
875
977
  end
876
978
  end
877
979
 
980
+ class FundingInstructions < Increase::Internal::Type::BaseModel
981
+ OrHash =
982
+ T.type_alias do
983
+ T.any(
984
+ Increase::ExportCreateParams::FundingInstructions,
985
+ Increase::Internal::AnyHash
986
+ )
987
+ end
988
+
989
+ # The Account Number to create funding instructions for.
990
+ sig { returns(String) }
991
+ attr_accessor :account_number_id
992
+
993
+ # Options for the created export. Required if `category` is equal to
994
+ # `funding_instructions`.
995
+ sig { params(account_number_id: String).returns(T.attached_class) }
996
+ def self.new(
997
+ # The Account Number to create funding instructions for.
998
+ account_number_id:
999
+ )
1000
+ end
1001
+
1002
+ sig { override.returns({ account_number_id: String }) }
1003
+ def to_hash
1004
+ end
1005
+ end
1006
+
878
1007
  class TransactionCsv < Increase::Internal::Type::BaseModel
879
1008
  OrHash =
880
1009
  T.type_alias do
@@ -0,0 +1,45 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ Increase::Simulations::ExportCreateParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Account the tax document is for.
19
+ sig { returns(String) }
20
+ attr_accessor :account_id
21
+
22
+ sig do
23
+ params(
24
+ account_id: String,
25
+ request_options: Increase::RequestOptions::OrHash
26
+ ).returns(T.attached_class)
27
+ end
28
+ def self.new(
29
+ # The identifier of the Account the tax document is for.
30
+ account_id:,
31
+ request_options: {}
32
+ )
33
+ end
34
+
35
+ sig do
36
+ override.returns(
37
+ { account_id: String, request_options: Increase::RequestOptions }
38
+ )
39
+ end
40
+ def to_hash
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -11,10 +11,14 @@ module Increase
11
11
  Increase::ExportCreateParams::AccountStatementBai2::OrHash,
12
12
  account_statement_ofx:
13
13
  Increase::ExportCreateParams::AccountStatementOfx::OrHash,
14
+ account_verification_letter:
15
+ Increase::ExportCreateParams::AccountVerificationLetter::OrHash,
14
16
  balance_csv: Increase::ExportCreateParams::BalanceCsv::OrHash,
15
17
  bookkeeping_account_balance_csv:
16
18
  Increase::ExportCreateParams::BookkeepingAccountBalanceCsv::OrHash,
17
19
  entity_csv: Increase::ExportCreateParams::EntityCsv::OrHash,
20
+ funding_instructions:
21
+ Increase::ExportCreateParams::FundingInstructions::OrHash,
18
22
  transaction_csv: Increase::ExportCreateParams::TransactionCsv::OrHash,
19
23
  vendor_csv: Increase::ExportCreateParams::VendorCsv::OrHash,
20
24
  request_options: Increase::RequestOptions::OrHash
@@ -30,6 +34,9 @@ module Increase
30
34
  # `account_statement_ofx`.
31
35
  account_statement_ofx: nil,
32
36
  # Options for the created export. Required if `category` is equal to
37
+ # `account_verification_letter`.
38
+ account_verification_letter: nil,
39
+ # Options for the created export. Required if `category` is equal to
33
40
  # `balance_csv`.
34
41
  balance_csv: nil,
35
42
  # Options for the created export. Required if `category` is equal to
@@ -38,6 +45,9 @@ module Increase
38
45
  # Options for the created export. Required if `category` is equal to `entity_csv`.
39
46
  entity_csv: nil,
40
47
  # Options for the created export. Required if `category` is equal to
48
+ # `funding_instructions`.
49
+ funding_instructions: nil,
50
+ # Options for the created export. Required if `category` is equal to
41
51
  # `transaction_csv`.
42
52
  transaction_csv: nil,
43
53
  # Options for the created export. Required if `category` is equal to `vendor_csv`.
@@ -0,0 +1,28 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class Exports
7
+ # Simulates a tax form export being generated.
8
+ sig do
9
+ params(
10
+ account_id: String,
11
+ request_options: Increase::RequestOptions::OrHash
12
+ ).returns(Increase::Export)
13
+ end
14
+ def create(
15
+ # The identifier of the Account the tax document is for.
16
+ account_id:,
17
+ request_options: {}
18
+ )
19
+ end
20
+
21
+ # @api private
22
+ sig { params(client: Increase::Client).returns(T.attached_class) }
23
+ def self.new(client:)
24
+ end
25
+ end
26
+ end
27
+ end
28
+ end
@@ -105,6 +105,9 @@ module Increase
105
105
  sig { returns(Increase::Resources::Simulations::Documents) }
106
106
  attr_reader :documents
107
107
 
108
+ sig { returns(Increase::Resources::Simulations::Exports) }
109
+ attr_reader :exports
110
+
108
111
  sig { returns(Increase::Resources::Simulations::CardTokens) }
109
112
  attr_reader :card_tokens
110
113
 
@@ -5,9 +5,11 @@ module Increase
5
5
  category: Increase::Models::ExportCreateParams::category,
6
6
  :account_statement_bai2 => Increase::ExportCreateParams::AccountStatementBai2,
7
7
  account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx,
8
+ account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
8
9
  balance_csv: Increase::ExportCreateParams::BalanceCsv,
9
10
  bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
10
11
  entity_csv: Increase::ExportCreateParams::EntityCsv,
12
+ funding_instructions: Increase::ExportCreateParams::FundingInstructions,
11
13
  transaction_csv: Increase::ExportCreateParams::TransactionCsv,
12
14
  vendor_csv: Increase::ExportCreateParams::VendorCsv
13
15
  }
@@ -31,6 +33,12 @@ module Increase
31
33
  Increase::ExportCreateParams::AccountStatementOfx
32
34
  ) -> Increase::ExportCreateParams::AccountStatementOfx
33
35
 
36
+ attr_reader account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter?
37
+
38
+ def account_verification_letter=: (
39
+ Increase::ExportCreateParams::AccountVerificationLetter
40
+ ) -> Increase::ExportCreateParams::AccountVerificationLetter
41
+
34
42
  attr_reader balance_csv: Increase::ExportCreateParams::BalanceCsv?
35
43
 
36
44
  def balance_csv=: (
@@ -49,6 +57,12 @@ module Increase
49
57
  Increase::ExportCreateParams::EntityCsv
50
58
  ) -> Increase::ExportCreateParams::EntityCsv
51
59
 
60
+ attr_reader funding_instructions: Increase::ExportCreateParams::FundingInstructions?
61
+
62
+ def funding_instructions=: (
63
+ Increase::ExportCreateParams::FundingInstructions
64
+ ) -> Increase::ExportCreateParams::FundingInstructions
65
+
52
66
  attr_reader transaction_csv: Increase::ExportCreateParams::TransactionCsv?
53
67
 
54
68
  def transaction_csv=: (
@@ -65,9 +79,11 @@ module Increase
65
79
  category: Increase::Models::ExportCreateParams::category,
66
80
  ?account_statement_bai2: Increase::ExportCreateParams::AccountStatementBai2,
67
81
  ?account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx,
82
+ ?account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
68
83
  ?balance_csv: Increase::ExportCreateParams::BalanceCsv,
69
84
  ?bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
70
85
  ?entity_csv: Increase::ExportCreateParams::EntityCsv,
86
+ ?funding_instructions: Increase::ExportCreateParams::FundingInstructions,
71
87
  ?transaction_csv: Increase::ExportCreateParams::TransactionCsv,
72
88
  ?vendor_csv: Increase::ExportCreateParams::VendorCsv,
73
89
  ?request_options: Increase::request_opts
@@ -77,9 +93,11 @@ module Increase
77
93
  category: Increase::Models::ExportCreateParams::category,
78
94
  :account_statement_bai2 => Increase::ExportCreateParams::AccountStatementBai2,
79
95
  account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx,
96
+ account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
80
97
  balance_csv: Increase::ExportCreateParams::BalanceCsv,
81
98
  bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
82
99
  entity_csv: Increase::ExportCreateParams::EntityCsv,
100
+ funding_instructions: Increase::ExportCreateParams::FundingInstructions,
83
101
  transaction_csv: Increase::ExportCreateParams::TransactionCsv,
84
102
  vendor_csv: Increase::ExportCreateParams::VendorCsv,
85
103
  request_options: Increase::RequestOptions
@@ -93,6 +111,8 @@ module Increase
93
111
  | :bookkeeping_account_balance_csv
94
112
  | :entity_csv
95
113
  | :vendor_csv
114
+ | :account_verification_letter
115
+ | :funding_instructions
96
116
 
97
117
  module Category
98
118
  extend Increase::Internal::Type::Enum
@@ -118,6 +138,12 @@ module Increase
118
138
  # Export a CSV of vendors added to the third-party risk management dashboard.
119
139
  VENDOR_CSV: :vendor_csv
120
140
 
141
+ # A PDF of an account verification letter.
142
+ ACCOUNT_VERIFICATION_LETTER: :account_verification_letter
143
+
144
+ # A PDF of funding instructions.
145
+ FUNDING_INSTRUCTIONS: :funding_instructions
146
+
121
147
  def self?.values: -> ::Array[Increase::Models::ExportCreateParams::category]
122
148
  end
123
149
 
@@ -211,6 +237,21 @@ module Increase
211
237
  end
212
238
  end
213
239
 
240
+ type account_verification_letter =
241
+ { account_number_id: String, balance_date: Date }
242
+
243
+ class AccountVerificationLetter < Increase::Internal::Type::BaseModel
244
+ attr_accessor account_number_id: String
245
+
246
+ attr_reader balance_date: Date?
247
+
248
+ def balance_date=: (Date) -> Date
249
+
250
+ def initialize: (account_number_id: String, ?balance_date: Date) -> void
251
+
252
+ def to_hash: -> { account_number_id: String, balance_date: Date }
253
+ end
254
+
214
255
  type balance_csv =
215
256
  {
216
257
  account_id: String,
@@ -397,6 +438,16 @@ module Increase
397
438
  end
398
439
  end
399
440
 
441
+ type funding_instructions = { account_number_id: String }
442
+
443
+ class FundingInstructions < Increase::Internal::Type::BaseModel
444
+ attr_accessor account_number_id: String
445
+
446
+ def initialize: (account_number_id: String) -> void
447
+
448
+ def to_hash: -> { account_number_id: String }
449
+ end
450
+
400
451
  type transaction_csv =
401
452
  {
402
453
  account_id: String,
@@ -0,0 +1,25 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type export_create_params =
5
+ { account_id: String } & Increase::Internal::Type::request_parameters
6
+
7
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ attr_accessor account_id: String
12
+
13
+ def initialize: (
14
+ account_id: String,
15
+ ?request_options: Increase::request_opts
16
+ ) -> void
17
+
18
+ def to_hash: -> {
19
+ account_id: String,
20
+ request_options: Increase::RequestOptions
21
+ }
22
+ end
23
+ end
24
+ end
25
+ end
@@ -5,9 +5,11 @@ module Increase
5
5
  category: Increase::Models::ExportCreateParams::category,
6
6
  ?account_statement_bai2: Increase::ExportCreateParams::AccountStatementBai2,
7
7
  ?account_statement_ofx: Increase::ExportCreateParams::AccountStatementOfx,
8
+ ?account_verification_letter: Increase::ExportCreateParams::AccountVerificationLetter,
8
9
  ?balance_csv: Increase::ExportCreateParams::BalanceCsv,
9
10
  ?bookkeeping_account_balance_csv: Increase::ExportCreateParams::BookkeepingAccountBalanceCsv,
10
11
  ?entity_csv: Increase::ExportCreateParams::EntityCsv,
12
+ ?funding_instructions: Increase::ExportCreateParams::FundingInstructions,
11
13
  ?transaction_csv: Increase::ExportCreateParams::TransactionCsv,
12
14
  ?vendor_csv: Increase::ExportCreateParams::VendorCsv,
13
15
  ?request_options: Increase::request_opts
@@ -0,0 +1,14 @@
1
+ module Increase
2
+ module Resources
3
+ class Simulations
4
+ class Exports
5
+ def create: (
6
+ account_id: String,
7
+ ?request_options: Increase::request_opts
8
+ ) -> Increase::Export
9
+
10
+ def initialize: (client: Increase::Client) -> void
11
+ end
12
+ end
13
+ end
14
+ end
@@ -61,6 +61,8 @@ module Increase
61
61
 
62
62
  attr_reader documents: Increase::Resources::Simulations::Documents
63
63
 
64
+ attr_reader exports: Increase::Resources::Simulations::Exports
65
+
64
66
  attr_reader card_tokens: Increase::Resources::Simulations::CardTokens
65
67
 
66
68
  def initialize: (client: Increase::Client) -> void
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.166.1
4
+ version: 1.167.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -317,6 +317,7 @@ files:
317
317
  - lib/increase/models/simulations/digital_wallet_token_request_create_params.rb
318
318
  - lib/increase/models/simulations/digital_wallet_token_request_create_response.rb
319
319
  - lib/increase/models/simulations/document_create_params.rb
320
+ - lib/increase/models/simulations/export_create_params.rb
320
321
  - lib/increase/models/simulations/inbound_ach_transfer_create_params.rb
321
322
  - lib/increase/models/simulations/inbound_check_deposit_create_params.rb
322
323
  - lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb
@@ -420,6 +421,7 @@ files:
420
421
  - lib/increase/resources/simulations/check_transfers.rb
421
422
  - lib/increase/resources/simulations/digital_wallet_token_requests.rb
422
423
  - lib/increase/resources/simulations/documents.rb
424
+ - lib/increase/resources/simulations/exports.rb
423
425
  - lib/increase/resources/simulations/inbound_ach_transfers.rb
424
426
  - lib/increase/resources/simulations/inbound_check_deposits.rb
425
427
  - lib/increase/resources/simulations/inbound_fednow_transfers.rb
@@ -721,6 +723,7 @@ files:
721
723
  - rbi/increase/models/simulations/digital_wallet_token_request_create_params.rbi
722
724
  - rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi
723
725
  - rbi/increase/models/simulations/document_create_params.rbi
726
+ - rbi/increase/models/simulations/export_create_params.rbi
724
727
  - rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi
725
728
  - rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi
726
729
  - rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi
@@ -824,6 +827,7 @@ files:
824
827
  - rbi/increase/resources/simulations/check_transfers.rbi
825
828
  - rbi/increase/resources/simulations/digital_wallet_token_requests.rbi
826
829
  - rbi/increase/resources/simulations/documents.rbi
830
+ - rbi/increase/resources/simulations/exports.rbi
827
831
  - rbi/increase/resources/simulations/inbound_ach_transfers.rbi
828
832
  - rbi/increase/resources/simulations/inbound_check_deposits.rbi
829
833
  - rbi/increase/resources/simulations/inbound_fednow_transfers.rbi
@@ -1124,6 +1128,7 @@ files:
1124
1128
  - sig/increase/models/simulations/digital_wallet_token_request_create_params.rbs
1125
1129
  - sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs
1126
1130
  - sig/increase/models/simulations/document_create_params.rbs
1131
+ - sig/increase/models/simulations/export_create_params.rbs
1127
1132
  - sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs
1128
1133
  - sig/increase/models/simulations/inbound_check_deposit_create_params.rbs
1129
1134
  - sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs
@@ -1227,6 +1232,7 @@ files:
1227
1232
  - sig/increase/resources/simulations/check_transfers.rbs
1228
1233
  - sig/increase/resources/simulations/digital_wallet_token_requests.rbs
1229
1234
  - sig/increase/resources/simulations/documents.rbs
1235
+ - sig/increase/resources/simulations/exports.rbs
1230
1236
  - sig/increase/resources/simulations/inbound_ach_transfers.rbs
1231
1237
  - sig/increase/resources/simulations/inbound_check_deposits.rbs
1232
1238
  - sig/increase/resources/simulations/inbound_fednow_transfers.rbs