increase 1.167.0 → 1.169.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 (42) 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/simulations/export_create_params.rb +43 -6
  6. data/lib/increase/models.rb +0 -8
  7. data/lib/increase/resources/simulations/exports.rb +11 -3
  8. data/lib/increase/resources/simulations.rb +0 -4
  9. data/lib/increase/version.rb +1 -1
  10. data/lib/increase.rb +0 -7
  11. data/rbi/increase/client.rbi +0 -3
  12. data/rbi/increase/models/simulations/export_create_params.rbi +93 -7
  13. data/rbi/increase/models.rbi +0 -8
  14. data/rbi/increase/resources/simulations/exports.rbi +13 -4
  15. data/rbi/increase/resources/simulations.rbi +0 -3
  16. data/sig/increase/client.rbs +0 -2
  17. data/sig/increase/models/simulations/export_create_params.rbs +37 -4
  18. data/sig/increase/models.rbs +0 -8
  19. data/sig/increase/resources/simulations/exports.rbs +2 -1
  20. data/sig/increase/resources/simulations.rbs +0 -2
  21. metadata +2 -23
  22. data/lib/increase/models/document.rb +0 -160
  23. data/lib/increase/models/document_create_params.rb +0 -93
  24. data/lib/increase/models/document_list_params.rb +0 -152
  25. data/lib/increase/models/document_retrieve_params.rb +0 -14
  26. data/lib/increase/models/simulations/document_create_params.rb +0 -24
  27. data/lib/increase/resources/documents.rb +0 -99
  28. data/lib/increase/resources/simulations/documents.rb +0 -38
  29. data/rbi/increase/models/document.rbi +0 -249
  30. data/rbi/increase/models/document_create_params.rbi +0 -191
  31. data/rbi/increase/models/document_list_params.rbi +0 -296
  32. data/rbi/increase/models/document_retrieve_params.rbi +0 -27
  33. data/rbi/increase/models/simulations/document_create_params.rbi +0 -45
  34. data/rbi/increase/resources/documents.rbi +0 -81
  35. data/rbi/increase/resources/simulations/documents.rbi +0 -28
  36. data/sig/increase/models/document.rbs +0 -122
  37. data/sig/increase/models/document_create_params.rbs +0 -83
  38. data/sig/increase/models/document_list_params.rbs +0 -153
  39. data/sig/increase/models/document_retrieve_params.rbs +0 -15
  40. data/sig/increase/models/simulations/document_create_params.rbs +0 -25
  41. data/sig/increase/resources/documents.rbs +0 -29
  42. data/sig/increase/resources/simulations/documents.rbs +0 -14
@@ -1,249 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class Document < Increase::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias { T.any(Increase::Document, Increase::Internal::AnyHash) }
8
-
9
- # The Document identifier.
10
- sig { returns(String) }
11
- attr_accessor :id
12
-
13
- # Properties of an account verification letter document.
14
- sig { returns(T.nilable(Increase::Document::AccountVerificationLetter)) }
15
- attr_reader :account_verification_letter
16
-
17
- sig do
18
- params(
19
- account_verification_letter:
20
- T.nilable(Increase::Document::AccountVerificationLetter::OrHash)
21
- ).void
22
- end
23
- attr_writer :account_verification_letter
24
-
25
- # The type of document.
26
- sig { returns(Increase::Document::Category::TaggedSymbol) }
27
- attr_accessor :category
28
-
29
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
30
- # Document was created.
31
- sig { returns(Time) }
32
- attr_accessor :created_at
33
-
34
- # The identifier of the Entity the document was generated for.
35
- sig { returns(T.nilable(String)) }
36
- attr_accessor :entity_id
37
-
38
- # The identifier of the File containing the Document's contents.
39
- sig { returns(String) }
40
- attr_accessor :file_id
41
-
42
- # Properties of a funding instructions document.
43
- sig { returns(T.nilable(Increase::Document::FundingInstructions)) }
44
- attr_reader :funding_instructions
45
-
46
- sig do
47
- params(
48
- funding_instructions:
49
- T.nilable(Increase::Document::FundingInstructions::OrHash)
50
- ).void
51
- end
52
- attr_writer :funding_instructions
53
-
54
- # The idempotency key you chose for this object. This value is unique across
55
- # Increase and is used to ensure that a request is only processed once. Learn more
56
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
57
- sig { returns(T.nilable(String)) }
58
- attr_accessor :idempotency_key
59
-
60
- # A constant representing the object's type. For this resource it will always be
61
- # `document`.
62
- sig { returns(Increase::Document::Type::TaggedSymbol) }
63
- attr_accessor :type
64
-
65
- # Increase generates certain documents / forms automatically for your application;
66
- # they can be listed here.
67
- sig do
68
- params(
69
- id: String,
70
- account_verification_letter:
71
- T.nilable(Increase::Document::AccountVerificationLetter::OrHash),
72
- category: Increase::Document::Category::OrSymbol,
73
- created_at: Time,
74
- entity_id: T.nilable(String),
75
- file_id: String,
76
- funding_instructions:
77
- T.nilable(Increase::Document::FundingInstructions::OrHash),
78
- idempotency_key: T.nilable(String),
79
- type: Increase::Document::Type::OrSymbol
80
- ).returns(T.attached_class)
81
- end
82
- def self.new(
83
- # The Document identifier.
84
- id:,
85
- # Properties of an account verification letter document.
86
- account_verification_letter:,
87
- # The type of document.
88
- category:,
89
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
90
- # Document was created.
91
- created_at:,
92
- # The identifier of the Entity the document was generated for.
93
- entity_id:,
94
- # The identifier of the File containing the Document's contents.
95
- file_id:,
96
- # Properties of a funding instructions document.
97
- funding_instructions:,
98
- # The idempotency key you chose for this object. This value is unique across
99
- # Increase and is used to ensure that a request is only processed once. Learn more
100
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
101
- idempotency_key:,
102
- # A constant representing the object's type. For this resource it will always be
103
- # `document`.
104
- type:
105
- )
106
- end
107
-
108
- sig do
109
- override.returns(
110
- {
111
- id: String,
112
- account_verification_letter:
113
- T.nilable(Increase::Document::AccountVerificationLetter),
114
- category: Increase::Document::Category::TaggedSymbol,
115
- created_at: Time,
116
- entity_id: T.nilable(String),
117
- file_id: String,
118
- funding_instructions:
119
- T.nilable(Increase::Document::FundingInstructions),
120
- idempotency_key: T.nilable(String),
121
- type: Increase::Document::Type::TaggedSymbol
122
- }
123
- )
124
- end
125
- def to_hash
126
- end
127
-
128
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
129
- OrHash =
130
- T.type_alias do
131
- T.any(
132
- Increase::Document::AccountVerificationLetter,
133
- Increase::Internal::AnyHash
134
- )
135
- end
136
-
137
- # The identifier of the Account Number the document was generated for.
138
- sig { returns(String) }
139
- attr_accessor :account_number_id
140
-
141
- # Properties of an account verification letter document.
142
- sig { params(account_number_id: String).returns(T.attached_class) }
143
- def self.new(
144
- # The identifier of the Account Number the document was generated for.
145
- account_number_id:
146
- )
147
- end
148
-
149
- sig { override.returns({ account_number_id: String }) }
150
- def to_hash
151
- end
152
- end
153
-
154
- # The type of document.
155
- module Category
156
- extend Increase::Internal::Type::Enum
157
-
158
- TaggedSymbol =
159
- T.type_alias { T.all(Symbol, Increase::Document::Category) }
160
- OrSymbol = T.type_alias { T.any(Symbol, String) }
161
-
162
- # Internal Revenue Service Form 1099-INT.
163
- FORM_1099_INT =
164
- T.let(:form_1099_int, Increase::Document::Category::TaggedSymbol)
165
-
166
- # Internal Revenue Service Form 1099-MISC.
167
- FORM_1099_MISC =
168
- T.let(:form_1099_misc, Increase::Document::Category::TaggedSymbol)
169
-
170
- # A document submitted in response to a proof of authorization request for an ACH transfer.
171
- PROOF_OF_AUTHORIZATION =
172
- T.let(
173
- :proof_of_authorization,
174
- Increase::Document::Category::TaggedSymbol
175
- )
176
-
177
- # Company information, such a policies or procedures, typically submitted during our due diligence process.
178
- COMPANY_INFORMATION =
179
- T.let(
180
- :company_information,
181
- Increase::Document::Category::TaggedSymbol
182
- )
183
-
184
- # An account verification letter.
185
- ACCOUNT_VERIFICATION_LETTER =
186
- T.let(
187
- :account_verification_letter,
188
- Increase::Document::Category::TaggedSymbol
189
- )
190
-
191
- # Funding instructions.
192
- FUNDING_INSTRUCTIONS =
193
- T.let(
194
- :funding_instructions,
195
- Increase::Document::Category::TaggedSymbol
196
- )
197
-
198
- sig do
199
- override.returns(T::Array[Increase::Document::Category::TaggedSymbol])
200
- end
201
- def self.values
202
- end
203
- end
204
-
205
- class FundingInstructions < Increase::Internal::Type::BaseModel
206
- OrHash =
207
- T.type_alias do
208
- T.any(
209
- Increase::Document::FundingInstructions,
210
- Increase::Internal::AnyHash
211
- )
212
- end
213
-
214
- # The identifier of the Account Number the document was generated for.
215
- sig { returns(String) }
216
- attr_accessor :account_number_id
217
-
218
- # Properties of a funding instructions document.
219
- sig { params(account_number_id: String).returns(T.attached_class) }
220
- def self.new(
221
- # The identifier of the Account Number the document was generated for.
222
- account_number_id:
223
- )
224
- end
225
-
226
- sig { override.returns({ account_number_id: String }) }
227
- def to_hash
228
- end
229
- end
230
-
231
- # A constant representing the object's type. For this resource it will always be
232
- # `document`.
233
- module Type
234
- extend Increase::Internal::Type::Enum
235
-
236
- TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Document::Type) }
237
- OrSymbol = T.type_alias { T.any(Symbol, String) }
238
-
239
- DOCUMENT = T.let(:document, Increase::Document::Type::TaggedSymbol)
240
-
241
- sig do
242
- override.returns(T::Array[Increase::Document::Type::TaggedSymbol])
243
- end
244
- def self.values
245
- end
246
- end
247
- end
248
- end
249
- end
@@ -1,191 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
6
- extend Increase::Internal::Type::RequestParameters::Converter
7
- include Increase::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(Increase::DocumentCreateParams, Increase::Internal::AnyHash)
12
- end
13
-
14
- # The type of document to create.
15
- sig { returns(Increase::DocumentCreateParams::Category::OrSymbol) }
16
- attr_accessor :category
17
-
18
- # An account verification letter. Required if and only if `category` is
19
- # `account_verification_letter`.
20
- sig do
21
- returns(
22
- T.nilable(Increase::DocumentCreateParams::AccountVerificationLetter)
23
- )
24
- end
25
- attr_reader :account_verification_letter
26
-
27
- sig do
28
- params(
29
- account_verification_letter:
30
- Increase::DocumentCreateParams::AccountVerificationLetter::OrHash
31
- ).void
32
- end
33
- attr_writer :account_verification_letter
34
-
35
- # Funding instructions. Required if and only if `category` is
36
- # `funding_instructions`.
37
- sig do
38
- returns(T.nilable(Increase::DocumentCreateParams::FundingInstructions))
39
- end
40
- attr_reader :funding_instructions
41
-
42
- sig do
43
- params(
44
- funding_instructions:
45
- Increase::DocumentCreateParams::FundingInstructions::OrHash
46
- ).void
47
- end
48
- attr_writer :funding_instructions
49
-
50
- sig do
51
- params(
52
- category: Increase::DocumentCreateParams::Category::OrSymbol,
53
- account_verification_letter:
54
- Increase::DocumentCreateParams::AccountVerificationLetter::OrHash,
55
- funding_instructions:
56
- Increase::DocumentCreateParams::FundingInstructions::OrHash,
57
- request_options: Increase::RequestOptions::OrHash
58
- ).returns(T.attached_class)
59
- end
60
- def self.new(
61
- # The type of document to create.
62
- category:,
63
- # An account verification letter. Required if and only if `category` is
64
- # `account_verification_letter`.
65
- account_verification_letter: nil,
66
- # Funding instructions. Required if and only if `category` is
67
- # `funding_instructions`.
68
- funding_instructions: nil,
69
- request_options: {}
70
- )
71
- end
72
-
73
- sig do
74
- override.returns(
75
- {
76
- category: Increase::DocumentCreateParams::Category::OrSymbol,
77
- account_verification_letter:
78
- Increase::DocumentCreateParams::AccountVerificationLetter,
79
- funding_instructions:
80
- Increase::DocumentCreateParams::FundingInstructions,
81
- request_options: Increase::RequestOptions
82
- }
83
- )
84
- end
85
- def to_hash
86
- end
87
-
88
- # The type of document to create.
89
- module Category
90
- extend Increase::Internal::Type::Enum
91
-
92
- TaggedSymbol =
93
- T.type_alias do
94
- T.all(Symbol, Increase::DocumentCreateParams::Category)
95
- end
96
- OrSymbol = T.type_alias { T.any(Symbol, String) }
97
-
98
- # An account verification letter.
99
- ACCOUNT_VERIFICATION_LETTER =
100
- T.let(
101
- :account_verification_letter,
102
- Increase::DocumentCreateParams::Category::TaggedSymbol
103
- )
104
-
105
- # Funding instructions.
106
- FUNDING_INSTRUCTIONS =
107
- T.let(
108
- :funding_instructions,
109
- Increase::DocumentCreateParams::Category::TaggedSymbol
110
- )
111
-
112
- sig do
113
- override.returns(
114
- T::Array[Increase::DocumentCreateParams::Category::TaggedSymbol]
115
- )
116
- end
117
- def self.values
118
- end
119
- end
120
-
121
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
122
- OrHash =
123
- T.type_alias do
124
- T.any(
125
- Increase::DocumentCreateParams::AccountVerificationLetter,
126
- Increase::Internal::AnyHash
127
- )
128
- end
129
-
130
- # The Account Number the bank letter should be generated for.
131
- sig { returns(String) }
132
- attr_accessor :account_number_id
133
-
134
- # If provided, the letter will include the Account's balance as of the date.
135
- sig { returns(T.nilable(Date)) }
136
- attr_reader :balance_date
137
-
138
- sig { params(balance_date: Date).void }
139
- attr_writer :balance_date
140
-
141
- # An account verification letter. Required if and only if `category` is
142
- # `account_verification_letter`.
143
- sig do
144
- params(account_number_id: String, balance_date: Date).returns(
145
- T.attached_class
146
- )
147
- end
148
- def self.new(
149
- # The Account Number the bank letter should be generated for.
150
- account_number_id:,
151
- # If provided, the letter will include the Account's balance as of the date.
152
- balance_date: nil
153
- )
154
- end
155
-
156
- sig do
157
- override.returns({ account_number_id: String, balance_date: Date })
158
- end
159
- def to_hash
160
- end
161
- end
162
-
163
- class FundingInstructions < Increase::Internal::Type::BaseModel
164
- OrHash =
165
- T.type_alias do
166
- T.any(
167
- Increase::DocumentCreateParams::FundingInstructions,
168
- Increase::Internal::AnyHash
169
- )
170
- end
171
-
172
- # The Account Number the funding instructions should be generated for.
173
- sig { returns(String) }
174
- attr_accessor :account_number_id
175
-
176
- # Funding instructions. Required if and only if `category` is
177
- # `funding_instructions`.
178
- sig { params(account_number_id: String).returns(T.attached_class) }
179
- def self.new(
180
- # The Account Number the funding instructions should be generated for.
181
- account_number_id:
182
- )
183
- end
184
-
185
- sig { override.returns({ account_number_id: String }) }
186
- def to_hash
187
- end
188
- end
189
- end
190
- end
191
- end