increase 1.166.1 → 1.168.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +0 -4
  5. data/lib/increase/models/export.rb +4 -4
  6. data/lib/increase/models/export_create_params.rb +61 -1
  7. data/lib/increase/models/simulations/{document_create_params.rb → export_create_params.rb} +2 -2
  8. data/lib/increase/models.rb +0 -8
  9. data/lib/increase/resources/exports.rb +5 -1
  10. data/lib/increase/resources/simulations/{documents.rb → exports.rb} +7 -7
  11. data/lib/increase/resources/simulations.rb +3 -3
  12. data/lib/increase/version.rb +1 -1
  13. data/lib/increase.rb +2 -7
  14. data/rbi/increase/client.rbi +0 -3
  15. data/rbi/increase/models/export.rbi +4 -4
  16. data/rbi/increase/models/export_create_params.rbi +129 -0
  17. data/rbi/increase/models/simulations/{document_create_params.rbi → export_create_params.rbi} +2 -2
  18. data/rbi/increase/models.rbi +0 -8
  19. data/rbi/increase/resources/exports.rbi +10 -0
  20. data/rbi/increase/resources/simulations/{documents.rbi → exports.rbi} +3 -3
  21. data/rbi/increase/resources/simulations.rbi +2 -2
  22. data/sig/increase/client.rbs +0 -2
  23. data/sig/increase/models/export_create_params.rbs +51 -0
  24. data/sig/increase/models/simulations/{document_create_params.rbs → export_create_params.rbs} +2 -2
  25. data/sig/increase/models.rbs +0 -8
  26. data/sig/increase/resources/exports.rbs +2 -0
  27. data/sig/increase/resources/simulations/{documents.rbs → exports.rbs} +2 -2
  28. data/sig/increase/resources/simulations.rbs +1 -1
  29. metadata +7 -22
  30. data/lib/increase/models/document.rb +0 -160
  31. data/lib/increase/models/document_create_params.rb +0 -93
  32. data/lib/increase/models/document_list_params.rb +0 -152
  33. data/lib/increase/models/document_retrieve_params.rb +0 -14
  34. data/lib/increase/resources/documents.rb +0 -99
  35. data/rbi/increase/models/document.rbi +0 -249
  36. data/rbi/increase/models/document_create_params.rbi +0 -191
  37. data/rbi/increase/models/document_list_params.rbi +0 -296
  38. data/rbi/increase/models/document_retrieve_params.rbi +0 -27
  39. data/rbi/increase/resources/documents.rbi +0 -81
  40. data/sig/increase/models/document.rbs +0 -122
  41. data/sig/increase/models/document_create_params.rbs +0 -83
  42. data/sig/increase/models/document_list_params.rbs +0 -153
  43. data/sig/increase/models/document_retrieve_params.rbs +0 -15
  44. data/sig/increase/resources/documents.rbs +0 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 196e6b116a53d982181ad1485313afb13f680200d6c9fad43751d6a0891c212e
4
- data.tar.gz: c17efddaf33b807889acce712a01b4795018e7b3876c4376cfb7ce2698c23c7b
3
+ metadata.gz: e74750d65eacbe23b0115fa5f47d3f6615b53b81b8f48b410c14b29348cfc5eb
4
+ data.tar.gz: b3d07a59de5dc3e93619b356d07c8dd0203bbfe6ce66d261af2f139fe0524aba
5
5
  SHA512:
6
- metadata.gz: 1ccc0039065357b7db207ccbe182a5428fa03f2cf6fd50d62825e3fcd9a4d9840c6d36ae9d3a2b85c540b86e2b8697790b6fc057d94731f4cecea3cb630222ec
7
- data.tar.gz: 0f844e51756523ac124abe4a96b29e228d292861793248de70bc260cabacc82f464b7362b1e9d161129ad05b9a9d33ddbbbe6a21886cd86faae36f53e8114f7b
6
+ metadata.gz: b7694fa2206a3cbcbd0440c378105ed3209a103b2ff3c07664bebda2cdadd1e2c4aaad081f544ae5017e9b18ad107fcb1fefa1d155524478c9ea9a02e7edc794
7
+ data.tar.gz: b3131f1a74d2ba3f669ee430f97e03a5c7b48eb1210a602a775c1980bb919e33a812bcf3a10b4b23dd77dd4eaa8586be80372b92ce138a92fcd7a8f758bee223
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.168.0 (2025-12-18)
4
+
5
+ Full Changelog: [v1.167.0...v1.168.0](https://github.com/Increase/increase-ruby/compare/v1.167.0...v1.168.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([f4ce01f](https://github.com/Increase/increase-ruby/commit/f4ce01fb3e3b0c52bf5079921ab01f3979de944f))
10
+
11
+ ## 1.167.0 (2025-12-18)
12
+
13
+ Full Changelog: [v1.166.1...v1.167.0](https://github.com/Increase/increase-ruby/compare/v1.166.1...v1.167.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([8083993](https://github.com/Increase/increase-ruby/commit/80839936c4b528bb4c1070c5382196cba2206ad3))
18
+
3
19
  ## 1.166.1 (2025-12-18)
4
20
 
5
21
  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.168.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -137,9 +137,6 @@ module Increase
137
137
  # @return [Increase::Resources::FileLinks]
138
138
  attr_reader :file_links
139
139
 
140
- # @return [Increase::Resources::Documents]
141
- attr_reader :documents
142
-
143
140
  # @return [Increase::Resources::Exports]
144
141
  attr_reader :exports
145
142
 
@@ -295,7 +292,6 @@ module Increase
295
292
  @account_statements = Increase::Resources::AccountStatements.new(client: self)
296
293
  @files = Increase::Resources::Files.new(client: self)
297
294
  @file_links = Increase::Resources::FileLinks.new(client: self)
298
- @documents = Increase::Resources::Documents.new(client: self)
299
295
  @exports = Increase::Resources::Exports.new(client: self)
300
296
  @events = Increase::Resources::Events.new(client: self)
301
297
  @event_subscriptions = Increase::Resources::EventSubscriptions.new(client: self)
@@ -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.
@@ -3,8 +3,8 @@
3
3
  module Increase
4
4
  module Models
5
5
  module Simulations
6
- # @see Increase::Resources::Simulations::Documents#create
7
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
6
+ # @see Increase::Resources::Simulations::Exports#create
7
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
8
8
  extend Increase::Internal::Type::RequestParameters::Converter
9
9
  include Increase::Internal::Type::RequestParameters
10
10
 
@@ -249,14 +249,6 @@ module Increase
249
249
 
250
250
  DigitalWalletTokenRetrieveParams = Increase::Models::DigitalWalletTokenRetrieveParams
251
251
 
252
- Document = Increase::Models::Document
253
-
254
- DocumentCreateParams = Increase::Models::DocumentCreateParams
255
-
256
- DocumentListParams = Increase::Models::DocumentListParams
257
-
258
- DocumentRetrieveParams = Increase::Models::DocumentRetrieveParams
259
-
260
252
  Entity = Increase::Models::Entity
261
253
 
262
254
  EntityArchiveBeneficialOwnerParams = Increase::Models::EntityArchiveBeneficialOwnerParams
@@ -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
  #
@@ -3,8 +3,8 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Simulations
6
- class Documents
7
- # Simulates an tax document being created for an account.
6
+ class Exports
7
+ # Simulates a tax form export being generated.
8
8
  #
9
9
  # @overload create(account_id:, request_options: {})
10
10
  #
@@ -12,16 +12,16 @@ module Increase
12
12
  #
13
13
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
14
14
  #
15
- # @return [Increase::Models::Document]
15
+ # @return [Increase::Models::Export]
16
16
  #
17
- # @see Increase::Models::Simulations::DocumentCreateParams
17
+ # @see Increase::Models::Simulations::ExportCreateParams
18
18
  def create(params)
19
- parsed, options = Increase::Simulations::DocumentCreateParams.dump_request(params)
19
+ parsed, options = Increase::Simulations::ExportCreateParams.dump_request(params)
20
20
  @client.request(
21
21
  method: :post,
22
- path: "simulations/documents",
22
+ path: "simulations/exports",
23
23
  body: parsed,
24
- model: Increase::Document,
24
+ model: Increase::Export,
25
25
  options: options
26
26
  )
27
27
  end
@@ -90,8 +90,8 @@ module Increase
90
90
  # @return [Increase::Resources::Simulations::AccountStatements]
91
91
  attr_reader :account_statements
92
92
 
93
- # @return [Increase::Resources::Simulations::Documents]
94
- attr_reader :documents
93
+ # @return [Increase::Resources::Simulations::Exports]
94
+ attr_reader :exports
95
95
 
96
96
  # @return [Increase::Resources::Simulations::CardTokens]
97
97
  attr_reader :card_tokens
@@ -135,7 +135,7 @@ module Increase
135
135
  @inbound_mail_items = Increase::Resources::Simulations::InboundMailItems.new(client: client)
136
136
  @programs = Increase::Resources::Simulations::Programs.new(client: client)
137
137
  @account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
138
- @documents = Increase::Resources::Simulations::Documents.new(client: client)
138
+ @exports = Increase::Resources::Simulations::Exports.new(client: client)
139
139
  @card_tokens = Increase::Resources::Simulations::CardTokens.new(client: client)
140
140
  end
141
141
  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.168.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -158,10 +158,6 @@ require_relative "increase/models/digital_card_profile_retrieve_params"
158
158
  require_relative "increase/models/digital_wallet_token"
159
159
  require_relative "increase/models/digital_wallet_token_list_params"
160
160
  require_relative "increase/models/digital_wallet_token_retrieve_params"
161
- require_relative "increase/models/document"
162
- require_relative "increase/models/document_create_params"
163
- require_relative "increase/models/document_list_params"
164
- require_relative "increase/models/document_retrieve_params"
165
161
  require_relative "increase/models/entity"
166
162
  require_relative "increase/models/entity_archive_beneficial_owner_params"
167
163
  require_relative "increase/models/entity_archive_params"
@@ -313,7 +309,7 @@ require_relative "increase/models/simulations/check_deposit_submit_params"
313
309
  require_relative "increase/models/simulations/check_transfer_mail_params"
314
310
  require_relative "increase/models/simulations/digital_wallet_token_request_create_params"
315
311
  require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
316
- require_relative "increase/models/simulations/document_create_params"
312
+ require_relative "increase/models/simulations/export_create_params"
317
313
  require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
318
314
  require_relative "increase/models/simulations/inbound_check_deposit_create_params"
319
315
  require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
@@ -368,7 +364,6 @@ require_relative "increase/resources/check_transfers"
368
364
  require_relative "increase/resources/declined_transactions"
369
365
  require_relative "increase/resources/digital_card_profiles"
370
366
  require_relative "increase/resources/digital_wallet_tokens"
371
- require_relative "increase/resources/documents"
372
367
  require_relative "increase/resources/entities"
373
368
  require_relative "increase/resources/events"
374
369
  require_relative "increase/resources/event_subscriptions"
@@ -416,7 +411,7 @@ require_relative "increase/resources/simulations/card_tokens"
416
411
  require_relative "increase/resources/simulations/check_deposits"
417
412
  require_relative "increase/resources/simulations/check_transfers"
418
413
  require_relative "increase/resources/simulations/digital_wallet_token_requests"
419
- require_relative "increase/resources/simulations/documents"
414
+ require_relative "increase/resources/simulations/exports"
420
415
  require_relative "increase/resources/simulations/inbound_ach_transfers"
421
416
  require_relative "increase/resources/simulations/inbound_check_deposits"
422
417
  require_relative "increase/resources/simulations/inbound_fednow_transfers"
@@ -136,9 +136,6 @@ module Increase
136
136
  sig { returns(Increase::Resources::FileLinks) }
137
137
  attr_reader :file_links
138
138
 
139
- sig { returns(Increase::Resources::Documents) }
140
- attr_reader :documents
141
-
142
139
  sig { returns(Increase::Resources::Exports) }
143
140
  attr_reader :exports
144
141
 
@@ -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
@@ -3,14 +3,14 @@
3
3
  module Increase
4
4
  module Models
5
5
  module Simulations
6
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
6
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
10
  OrHash =
11
11
  T.type_alias do
12
12
  T.any(
13
- Increase::Simulations::DocumentCreateParams,
13
+ Increase::Simulations::ExportCreateParams,
14
14
  Increase::Internal::AnyHash
15
15
  )
16
16
  end
@@ -236,14 +236,6 @@ module Increase
236
236
  DigitalWalletTokenRetrieveParams =
237
237
  Increase::Models::DigitalWalletTokenRetrieveParams
238
238
 
239
- Document = Increase::Models::Document
240
-
241
- DocumentCreateParams = Increase::Models::DocumentCreateParams
242
-
243
- DocumentListParams = Increase::Models::DocumentListParams
244
-
245
- DocumentRetrieveParams = Increase::Models::DocumentRetrieveParams
246
-
247
239
  Entity = Increase::Models::Entity
248
240
 
249
241
  EntityArchiveBeneficialOwnerParams =
@@ -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`.
@@ -3,13 +3,13 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Simulations
6
- class Documents
7
- # Simulates an tax document being created for an account.
6
+ class Exports
7
+ # Simulates a tax form export being generated.
8
8
  sig do
9
9
  params(
10
10
  account_id: String,
11
11
  request_options: Increase::RequestOptions::OrHash
12
- ).returns(Increase::Document)
12
+ ).returns(Increase::Export)
13
13
  end
14
14
  def create(
15
15
  # The identifier of the Account the tax document is for.