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
@@ -102,8 +102,8 @@ module Increase
102
102
  sig { returns(Increase::Resources::Simulations::AccountStatements) }
103
103
  attr_reader :account_statements
104
104
 
105
- sig { returns(Increase::Resources::Simulations::Documents) }
106
- attr_reader :documents
105
+ sig { returns(Increase::Resources::Simulations::Exports) }
106
+ attr_reader :exports
107
107
 
108
108
  sig { returns(Increase::Resources::Simulations::CardTokens) }
109
109
  attr_reader :card_tokens
@@ -91,8 +91,6 @@ module Increase
91
91
 
92
92
  attr_reader file_links: Increase::Resources::FileLinks
93
93
 
94
- attr_reader documents: Increase::Resources::Documents
95
-
96
94
  attr_reader exports: Increase::Resources::Exports
97
95
 
98
96
  attr_reader events: Increase::Resources::Events
@@ -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,
@@ -1,10 +1,10 @@
1
1
  module Increase
2
2
  module Models
3
3
  module Simulations
4
- type document_create_params =
4
+ type export_create_params =
5
5
  { account_id: String } & Increase::Internal::Type::request_parameters
6
6
 
7
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
7
+ class ExportCreateParams < Increase::Internal::Type::BaseModel
8
8
  extend Increase::Internal::Type::RequestParameters::Converter
9
9
  include Increase::Internal::Type::RequestParameters
10
10
 
@@ -209,14 +209,6 @@ module Increase
209
209
 
210
210
  class DigitalWalletTokenRetrieveParams = Increase::Models::DigitalWalletTokenRetrieveParams
211
211
 
212
- class Document = Increase::Models::Document
213
-
214
- class DocumentCreateParams = Increase::Models::DocumentCreateParams
215
-
216
- class DocumentListParams = Increase::Models::DocumentListParams
217
-
218
- class DocumentRetrieveParams = Increase::Models::DocumentRetrieveParams
219
-
220
212
  class Entity = Increase::Models::Entity
221
213
 
222
214
  class EntityArchiveBeneficialOwnerParams = Increase::Models::EntityArchiveBeneficialOwnerParams
@@ -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
@@ -1,11 +1,11 @@
1
1
  module Increase
2
2
  module Resources
3
3
  class Simulations
4
- class Documents
4
+ class Exports
5
5
  def create: (
6
6
  account_id: String,
7
7
  ?request_options: Increase::request_opts
8
- ) -> Increase::Document
8
+ ) -> Increase::Export
9
9
 
10
10
  def initialize: (client: Increase::Client) -> void
11
11
  end
@@ -59,7 +59,7 @@ module Increase
59
59
 
60
60
  attr_reader account_statements: Increase::Resources::Simulations::AccountStatements
61
61
 
62
- attr_reader documents: Increase::Resources::Simulations::Documents
62
+ attr_reader exports: Increase::Resources::Simulations::Exports
63
63
 
64
64
  attr_reader card_tokens: Increase::Resources::Simulations::CardTokens
65
65
 
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.168.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -161,10 +161,6 @@ files:
161
161
  - lib/increase/models/digital_wallet_token.rb
162
162
  - lib/increase/models/digital_wallet_token_list_params.rb
163
163
  - lib/increase/models/digital_wallet_token_retrieve_params.rb
164
- - lib/increase/models/document.rb
165
- - lib/increase/models/document_create_params.rb
166
- - lib/increase/models/document_list_params.rb
167
- - lib/increase/models/document_retrieve_params.rb
168
164
  - lib/increase/models/entity.rb
169
165
  - lib/increase/models/entity_archive_beneficial_owner_params.rb
170
166
  - lib/increase/models/entity_archive_params.rb
@@ -316,7 +312,7 @@ files:
316
312
  - lib/increase/models/simulations/check_transfer_mail_params.rb
317
313
  - lib/increase/models/simulations/digital_wallet_token_request_create_params.rb
318
314
  - lib/increase/models/simulations/digital_wallet_token_request_create_response.rb
319
- - lib/increase/models/simulations/document_create_params.rb
315
+ - lib/increase/models/simulations/export_create_params.rb
320
316
  - lib/increase/models/simulations/inbound_ach_transfer_create_params.rb
321
317
  - lib/increase/models/simulations/inbound_check_deposit_create_params.rb
322
318
  - lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb
@@ -371,7 +367,6 @@ files:
371
367
  - lib/increase/resources/declined_transactions.rb
372
368
  - lib/increase/resources/digital_card_profiles.rb
373
369
  - lib/increase/resources/digital_wallet_tokens.rb
374
- - lib/increase/resources/documents.rb
375
370
  - lib/increase/resources/entities.rb
376
371
  - lib/increase/resources/event_subscriptions.rb
377
372
  - lib/increase/resources/events.rb
@@ -419,7 +414,7 @@ files:
419
414
  - lib/increase/resources/simulations/check_deposits.rb
420
415
  - lib/increase/resources/simulations/check_transfers.rb
421
416
  - lib/increase/resources/simulations/digital_wallet_token_requests.rb
422
- - lib/increase/resources/simulations/documents.rb
417
+ - lib/increase/resources/simulations/exports.rb
423
418
  - lib/increase/resources/simulations/inbound_ach_transfers.rb
424
419
  - lib/increase/resources/simulations/inbound_check_deposits.rb
425
420
  - lib/increase/resources/simulations/inbound_fednow_transfers.rb
@@ -565,10 +560,6 @@ files:
565
560
  - rbi/increase/models/digital_wallet_token.rbi
566
561
  - rbi/increase/models/digital_wallet_token_list_params.rbi
567
562
  - rbi/increase/models/digital_wallet_token_retrieve_params.rbi
568
- - rbi/increase/models/document.rbi
569
- - rbi/increase/models/document_create_params.rbi
570
- - rbi/increase/models/document_list_params.rbi
571
- - rbi/increase/models/document_retrieve_params.rbi
572
563
  - rbi/increase/models/entity.rbi
573
564
  - rbi/increase/models/entity_archive_beneficial_owner_params.rbi
574
565
  - rbi/increase/models/entity_archive_params.rbi
@@ -720,7 +711,7 @@ files:
720
711
  - rbi/increase/models/simulations/check_transfer_mail_params.rbi
721
712
  - rbi/increase/models/simulations/digital_wallet_token_request_create_params.rbi
722
713
  - rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi
723
- - rbi/increase/models/simulations/document_create_params.rbi
714
+ - rbi/increase/models/simulations/export_create_params.rbi
724
715
  - rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi
725
716
  - rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi
726
717
  - rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi
@@ -775,7 +766,6 @@ files:
775
766
  - rbi/increase/resources/declined_transactions.rbi
776
767
  - rbi/increase/resources/digital_card_profiles.rbi
777
768
  - rbi/increase/resources/digital_wallet_tokens.rbi
778
- - rbi/increase/resources/documents.rbi
779
769
  - rbi/increase/resources/entities.rbi
780
770
  - rbi/increase/resources/event_subscriptions.rbi
781
771
  - rbi/increase/resources/events.rbi
@@ -823,7 +813,7 @@ files:
823
813
  - rbi/increase/resources/simulations/check_deposits.rbi
824
814
  - rbi/increase/resources/simulations/check_transfers.rbi
825
815
  - rbi/increase/resources/simulations/digital_wallet_token_requests.rbi
826
- - rbi/increase/resources/simulations/documents.rbi
816
+ - rbi/increase/resources/simulations/exports.rbi
827
817
  - rbi/increase/resources/simulations/inbound_ach_transfers.rbi
828
818
  - rbi/increase/resources/simulations/inbound_check_deposits.rbi
829
819
  - rbi/increase/resources/simulations/inbound_fednow_transfers.rbi
@@ -968,10 +958,6 @@ files:
968
958
  - sig/increase/models/digital_wallet_token.rbs
969
959
  - sig/increase/models/digital_wallet_token_list_params.rbs
970
960
  - sig/increase/models/digital_wallet_token_retrieve_params.rbs
971
- - sig/increase/models/document.rbs
972
- - sig/increase/models/document_create_params.rbs
973
- - sig/increase/models/document_list_params.rbs
974
- - sig/increase/models/document_retrieve_params.rbs
975
961
  - sig/increase/models/entity.rbs
976
962
  - sig/increase/models/entity_archive_beneficial_owner_params.rbs
977
963
  - sig/increase/models/entity_archive_params.rbs
@@ -1123,7 +1109,7 @@ files:
1123
1109
  - sig/increase/models/simulations/check_transfer_mail_params.rbs
1124
1110
  - sig/increase/models/simulations/digital_wallet_token_request_create_params.rbs
1125
1111
  - sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs
1126
- - sig/increase/models/simulations/document_create_params.rbs
1112
+ - sig/increase/models/simulations/export_create_params.rbs
1127
1113
  - sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs
1128
1114
  - sig/increase/models/simulations/inbound_check_deposit_create_params.rbs
1129
1115
  - sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs
@@ -1178,7 +1164,6 @@ files:
1178
1164
  - sig/increase/resources/declined_transactions.rbs
1179
1165
  - sig/increase/resources/digital_card_profiles.rbs
1180
1166
  - sig/increase/resources/digital_wallet_tokens.rbs
1181
- - sig/increase/resources/documents.rbs
1182
1167
  - sig/increase/resources/entities.rbs
1183
1168
  - sig/increase/resources/event_subscriptions.rbs
1184
1169
  - sig/increase/resources/events.rbs
@@ -1226,7 +1211,7 @@ files:
1226
1211
  - sig/increase/resources/simulations/check_deposits.rbs
1227
1212
  - sig/increase/resources/simulations/check_transfers.rbs
1228
1213
  - sig/increase/resources/simulations/digital_wallet_token_requests.rbs
1229
- - sig/increase/resources/simulations/documents.rbs
1214
+ - sig/increase/resources/simulations/exports.rbs
1230
1215
  - sig/increase/resources/simulations/inbound_ach_transfers.rbs
1231
1216
  - sig/increase/resources/simulations/inbound_check_deposits.rbs
1232
1217
  - sig/increase/resources/simulations/inbound_fednow_transfers.rbs
@@ -1,160 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::Documents#create
6
- class Document < Increase::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The Document identifier.
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute account_verification_letter
14
- # Properties of an account verification letter document.
15
- #
16
- # @return [Increase::Models::Document::AccountVerificationLetter, nil]
17
- required :account_verification_letter, -> { Increase::Document::AccountVerificationLetter }, nil?: true
18
-
19
- # @!attribute category
20
- # The type of document.
21
- #
22
- # @return [Symbol, Increase::Models::Document::Category]
23
- required :category, enum: -> { Increase::Document::Category }
24
-
25
- # @!attribute created_at
26
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
27
- # Document was created.
28
- #
29
- # @return [Time]
30
- required :created_at, Time
31
-
32
- # @!attribute entity_id
33
- # The identifier of the Entity the document was generated for.
34
- #
35
- # @return [String, nil]
36
- required :entity_id, String, nil?: true
37
-
38
- # @!attribute file_id
39
- # The identifier of the File containing the Document's contents.
40
- #
41
- # @return [String]
42
- required :file_id, String
43
-
44
- # @!attribute funding_instructions
45
- # Properties of a funding instructions document.
46
- #
47
- # @return [Increase::Models::Document::FundingInstructions, nil]
48
- required :funding_instructions, -> { Increase::Document::FundingInstructions }, nil?: true
49
-
50
- # @!attribute idempotency_key
51
- # The idempotency key you chose for this object. This value is unique across
52
- # Increase and is used to ensure that a request is only processed once. Learn more
53
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
54
- #
55
- # @return [String, nil]
56
- required :idempotency_key, String, nil?: true
57
-
58
- # @!attribute type
59
- # A constant representing the object's type. For this resource it will always be
60
- # `document`.
61
- #
62
- # @return [Symbol, Increase::Models::Document::Type]
63
- required :type, enum: -> { Increase::Document::Type }
64
-
65
- # @!method initialize(id:, account_verification_letter:, category:, created_at:, entity_id:, file_id:, funding_instructions:, idempotency_key:, type:)
66
- # Some parameter documentations has been truncated, see
67
- # {Increase::Models::Document} for more details.
68
- #
69
- # Increase generates certain documents / forms automatically for your application;
70
- # they can be listed here.
71
- #
72
- # @param id [String] The Document identifier.
73
- #
74
- # @param account_verification_letter [Increase::Models::Document::AccountVerificationLetter, nil] Properties of an account verification letter document.
75
- #
76
- # @param category [Symbol, Increase::Models::Document::Category] The type of document.
77
- #
78
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Documen
79
- #
80
- # @param entity_id [String, nil] The identifier of the Entity the document was generated for.
81
- #
82
- # @param file_id [String] The identifier of the File containing the Document's contents.
83
- #
84
- # @param funding_instructions [Increase::Models::Document::FundingInstructions, nil] Properties of a funding instructions document.
85
- #
86
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
87
- #
88
- # @param type [Symbol, Increase::Models::Document::Type] A constant representing the object's type. For this resource it will always be `
89
-
90
- # @see Increase::Models::Document#account_verification_letter
91
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
92
- # @!attribute account_number_id
93
- # The identifier of the Account Number the document was generated for.
94
- #
95
- # @return [String]
96
- required :account_number_id, String
97
-
98
- # @!method initialize(account_number_id:)
99
- # Properties of an account verification letter document.
100
- #
101
- # @param account_number_id [String] The identifier of the Account Number the document was generated for.
102
- end
103
-
104
- # The type of document.
105
- #
106
- # @see Increase::Models::Document#category
107
- module Category
108
- extend Increase::Internal::Type::Enum
109
-
110
- # Internal Revenue Service Form 1099-INT.
111
- FORM_1099_INT = :form_1099_int
112
-
113
- # Internal Revenue Service Form 1099-MISC.
114
- FORM_1099_MISC = :form_1099_misc
115
-
116
- # A document submitted in response to a proof of authorization request for an ACH transfer.
117
- PROOF_OF_AUTHORIZATION = :proof_of_authorization
118
-
119
- # Company information, such a policies or procedures, typically submitted during our due diligence process.
120
- COMPANY_INFORMATION = :company_information
121
-
122
- # An account verification letter.
123
- ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
124
-
125
- # Funding instructions.
126
- FUNDING_INSTRUCTIONS = :funding_instructions
127
-
128
- # @!method self.values
129
- # @return [Array<Symbol>]
130
- end
131
-
132
- # @see Increase::Models::Document#funding_instructions
133
- class FundingInstructions < Increase::Internal::Type::BaseModel
134
- # @!attribute account_number_id
135
- # The identifier of the Account Number the document was generated for.
136
- #
137
- # @return [String]
138
- required :account_number_id, String
139
-
140
- # @!method initialize(account_number_id:)
141
- # Properties of a funding instructions document.
142
- #
143
- # @param account_number_id [String] The identifier of the Account Number the document was generated for.
144
- end
145
-
146
- # A constant representing the object's type. For this resource it will always be
147
- # `document`.
148
- #
149
- # @see Increase::Models::Document#type
150
- module Type
151
- extend Increase::Internal::Type::Enum
152
-
153
- DOCUMENT = :document
154
-
155
- # @!method self.values
156
- # @return [Array<Symbol>]
157
- end
158
- end
159
- end
160
- end
@@ -1,93 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::Documents#create
6
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute category
11
- # The type of document to create.
12
- #
13
- # @return [Symbol, Increase::Models::DocumentCreateParams::Category]
14
- required :category, enum: -> { Increase::DocumentCreateParams::Category }
15
-
16
- # @!attribute account_verification_letter
17
- # An account verification letter. Required if and only if `category` is
18
- # `account_verification_letter`.
19
- #
20
- # @return [Increase::Models::DocumentCreateParams::AccountVerificationLetter, nil]
21
- optional :account_verification_letter, -> { Increase::DocumentCreateParams::AccountVerificationLetter }
22
-
23
- # @!attribute funding_instructions
24
- # Funding instructions. Required if and only if `category` is
25
- # `funding_instructions`.
26
- #
27
- # @return [Increase::Models::DocumentCreateParams::FundingInstructions, nil]
28
- optional :funding_instructions, -> { Increase::DocumentCreateParams::FundingInstructions }
29
-
30
- # @!method initialize(category:, account_verification_letter: nil, funding_instructions: nil, request_options: {})
31
- # Some parameter documentations has been truncated, see
32
- # {Increase::Models::DocumentCreateParams} for more details.
33
- #
34
- # @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create.
35
- #
36
- # @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter. Required if and only if `category` is `account_v
37
- #
38
- # @param funding_instructions [Increase::Models::DocumentCreateParams::FundingInstructions] Funding instructions. Required if and only if `category` is `funding_instruction
39
- #
40
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
41
-
42
- # The type of document to create.
43
- module Category
44
- extend Increase::Internal::Type::Enum
45
-
46
- # An account verification letter.
47
- ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
48
-
49
- # Funding instructions.
50
- FUNDING_INSTRUCTIONS = :funding_instructions
51
-
52
- # @!method self.values
53
- # @return [Array<Symbol>]
54
- end
55
-
56
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
57
- # @!attribute account_number_id
58
- # The Account Number the bank letter should be generated for.
59
- #
60
- # @return [String]
61
- required :account_number_id, String
62
-
63
- # @!attribute balance_date
64
- # If provided, the letter will include the Account's balance as of the date.
65
- #
66
- # @return [Date, nil]
67
- optional :balance_date, Date
68
-
69
- # @!method initialize(account_number_id:, balance_date: nil)
70
- # An account verification letter. Required if and only if `category` is
71
- # `account_verification_letter`.
72
- #
73
- # @param account_number_id [String] The Account Number the bank letter should be generated for.
74
- #
75
- # @param balance_date [Date] If provided, the letter will include the Account's balance as of the date.
76
- end
77
-
78
- class FundingInstructions < Increase::Internal::Type::BaseModel
79
- # @!attribute account_number_id
80
- # The Account Number the funding instructions should be generated for.
81
- #
82
- # @return [String]
83
- required :account_number_id, String
84
-
85
- # @!method initialize(account_number_id:)
86
- # Funding instructions. Required if and only if `category` is
87
- # `funding_instructions`.
88
- #
89
- # @param account_number_id [String] The Account Number the funding instructions should be generated for.
90
- end
91
- end
92
- end
93
- end