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
@@ -1,296 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class DocumentListParams < 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::DocumentListParams, Increase::Internal::AnyHash)
12
- end
13
-
14
- sig { returns(T.nilable(Increase::DocumentListParams::Category)) }
15
- attr_reader :category
16
-
17
- sig do
18
- params(category: Increase::DocumentListParams::Category::OrHash).void
19
- end
20
- attr_writer :category
21
-
22
- sig { returns(T.nilable(Increase::DocumentListParams::CreatedAt)) }
23
- attr_reader :created_at
24
-
25
- sig do
26
- params(created_at: Increase::DocumentListParams::CreatedAt::OrHash).void
27
- end
28
- attr_writer :created_at
29
-
30
- # Return the page of entries after this one.
31
- sig { returns(T.nilable(String)) }
32
- attr_reader :cursor
33
-
34
- sig { params(cursor: String).void }
35
- attr_writer :cursor
36
-
37
- # Filter Documents to ones belonging to the specified Entity.
38
- sig { returns(T.nilable(String)) }
39
- attr_reader :entity_id
40
-
41
- sig { params(entity_id: String).void }
42
- attr_writer :entity_id
43
-
44
- # Filter records to the one with the specified `idempotency_key` you chose for
45
- # that object. This value is unique across Increase and is used to ensure that a
46
- # request is only processed once. Learn more about
47
- # [idempotency](https://increase.com/documentation/idempotency-keys).
48
- sig { returns(T.nilable(String)) }
49
- attr_reader :idempotency_key
50
-
51
- sig { params(idempotency_key: String).void }
52
- attr_writer :idempotency_key
53
-
54
- # Limit the size of the list that is returned. The default (and maximum) is 100
55
- # objects.
56
- sig { returns(T.nilable(Integer)) }
57
- attr_reader :limit
58
-
59
- sig { params(limit: Integer).void }
60
- attr_writer :limit
61
-
62
- sig do
63
- params(
64
- category: Increase::DocumentListParams::Category::OrHash,
65
- created_at: Increase::DocumentListParams::CreatedAt::OrHash,
66
- cursor: String,
67
- entity_id: String,
68
- idempotency_key: String,
69
- limit: Integer,
70
- request_options: Increase::RequestOptions::OrHash
71
- ).returns(T.attached_class)
72
- end
73
- def self.new(
74
- category: nil,
75
- created_at: nil,
76
- # Return the page of entries after this one.
77
- cursor: nil,
78
- # Filter Documents to ones belonging to the specified Entity.
79
- entity_id: nil,
80
- # Filter records to the one with the specified `idempotency_key` you chose for
81
- # that object. This value is unique across Increase and is used to ensure that a
82
- # request is only processed once. Learn more about
83
- # [idempotency](https://increase.com/documentation/idempotency-keys).
84
- idempotency_key: nil,
85
- # Limit the size of the list that is returned. The default (and maximum) is 100
86
- # objects.
87
- limit: nil,
88
- request_options: {}
89
- )
90
- end
91
-
92
- sig do
93
- override.returns(
94
- {
95
- category: Increase::DocumentListParams::Category,
96
- created_at: Increase::DocumentListParams::CreatedAt,
97
- cursor: String,
98
- entity_id: String,
99
- idempotency_key: String,
100
- limit: Integer,
101
- request_options: Increase::RequestOptions
102
- }
103
- )
104
- end
105
- def to_hash
106
- end
107
-
108
- class Category < Increase::Internal::Type::BaseModel
109
- OrHash =
110
- T.type_alias do
111
- T.any(
112
- Increase::DocumentListParams::Category,
113
- Increase::Internal::AnyHash
114
- )
115
- end
116
-
117
- # Filter Documents for those with the specified category or categories. For GET
118
- # requests, this should be encoded as a comma-delimited string, such as
119
- # `?in=one,two,three`.
120
- sig do
121
- returns(
122
- T.nilable(
123
- T::Array[Increase::DocumentListParams::Category::In::OrSymbol]
124
- )
125
- )
126
- end
127
- attr_reader :in_
128
-
129
- sig do
130
- params(
131
- in_: T::Array[Increase::DocumentListParams::Category::In::OrSymbol]
132
- ).void
133
- end
134
- attr_writer :in_
135
-
136
- sig do
137
- params(
138
- in_: T::Array[Increase::DocumentListParams::Category::In::OrSymbol]
139
- ).returns(T.attached_class)
140
- end
141
- def self.new(
142
- # Filter Documents for those with the specified category or categories. For GET
143
- # requests, this should be encoded as a comma-delimited string, such as
144
- # `?in=one,two,three`.
145
- in_: nil
146
- )
147
- end
148
-
149
- sig do
150
- override.returns(
151
- {
152
- in_:
153
- T::Array[Increase::DocumentListParams::Category::In::OrSymbol]
154
- }
155
- )
156
- end
157
- def to_hash
158
- end
159
-
160
- module In
161
- extend Increase::Internal::Type::Enum
162
-
163
- TaggedSymbol =
164
- T.type_alias do
165
- T.all(Symbol, Increase::DocumentListParams::Category::In)
166
- end
167
- OrSymbol = T.type_alias { T.any(Symbol, String) }
168
-
169
- # Internal Revenue Service Form 1099-INT.
170
- FORM_1099_INT =
171
- T.let(
172
- :form_1099_int,
173
- Increase::DocumentListParams::Category::In::TaggedSymbol
174
- )
175
-
176
- # Internal Revenue Service Form 1099-MISC.
177
- FORM_1099_MISC =
178
- T.let(
179
- :form_1099_misc,
180
- Increase::DocumentListParams::Category::In::TaggedSymbol
181
- )
182
-
183
- # A document submitted in response to a proof of authorization request for an ACH transfer.
184
- PROOF_OF_AUTHORIZATION =
185
- T.let(
186
- :proof_of_authorization,
187
- Increase::DocumentListParams::Category::In::TaggedSymbol
188
- )
189
-
190
- # Company information, such a policies or procedures, typically submitted during our due diligence process.
191
- COMPANY_INFORMATION =
192
- T.let(
193
- :company_information,
194
- Increase::DocumentListParams::Category::In::TaggedSymbol
195
- )
196
-
197
- # An account verification letter.
198
- ACCOUNT_VERIFICATION_LETTER =
199
- T.let(
200
- :account_verification_letter,
201
- Increase::DocumentListParams::Category::In::TaggedSymbol
202
- )
203
-
204
- # Funding instructions.
205
- FUNDING_INSTRUCTIONS =
206
- T.let(
207
- :funding_instructions,
208
- Increase::DocumentListParams::Category::In::TaggedSymbol
209
- )
210
-
211
- sig do
212
- override.returns(
213
- T::Array[Increase::DocumentListParams::Category::In::TaggedSymbol]
214
- )
215
- end
216
- def self.values
217
- end
218
- end
219
- end
220
-
221
- class CreatedAt < Increase::Internal::Type::BaseModel
222
- OrHash =
223
- T.type_alias do
224
- T.any(
225
- Increase::DocumentListParams::CreatedAt,
226
- Increase::Internal::AnyHash
227
- )
228
- end
229
-
230
- # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
231
- # timestamp.
232
- sig { returns(T.nilable(Time)) }
233
- attr_reader :after
234
-
235
- sig { params(after: Time).void }
236
- attr_writer :after
237
-
238
- # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
239
- # timestamp.
240
- sig { returns(T.nilable(Time)) }
241
- attr_reader :before
242
-
243
- sig { params(before: Time).void }
244
- attr_writer :before
245
-
246
- # Return results on or after this
247
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
248
- sig { returns(T.nilable(Time)) }
249
- attr_reader :on_or_after
250
-
251
- sig { params(on_or_after: Time).void }
252
- attr_writer :on_or_after
253
-
254
- # Return results on or before this
255
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
256
- sig { returns(T.nilable(Time)) }
257
- attr_reader :on_or_before
258
-
259
- sig { params(on_or_before: Time).void }
260
- attr_writer :on_or_before
261
-
262
- sig do
263
- params(
264
- after: Time,
265
- before: Time,
266
- on_or_after: Time,
267
- on_or_before: Time
268
- ).returns(T.attached_class)
269
- end
270
- def self.new(
271
- # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
272
- # timestamp.
273
- after: nil,
274
- # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
275
- # timestamp.
276
- before: nil,
277
- # Return results on or after this
278
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
279
- on_or_after: nil,
280
- # Return results on or before this
281
- # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
282
- on_or_before: nil
283
- )
284
- end
285
-
286
- sig do
287
- override.returns(
288
- { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
289
- )
290
- end
291
- def to_hash
292
- end
293
- end
294
- end
295
- end
296
- end
@@ -1,27 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class DocumentRetrieveParams < 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::DocumentRetrieveParams, Increase::Internal::AnyHash)
12
- end
13
-
14
- sig do
15
- params(request_options: Increase::RequestOptions::OrHash).returns(
16
- T.attached_class
17
- )
18
- end
19
- def self.new(request_options: {})
20
- end
21
-
22
- sig { override.returns({ request_options: Increase::RequestOptions }) }
23
- def to_hash
24
- end
25
- end
26
- end
27
- end
@@ -1,81 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Resources
5
- class Documents
6
- # Create a Document
7
- sig do
8
- params(
9
- category: Increase::DocumentCreateParams::Category::OrSymbol,
10
- account_verification_letter:
11
- Increase::DocumentCreateParams::AccountVerificationLetter::OrHash,
12
- funding_instructions:
13
- Increase::DocumentCreateParams::FundingInstructions::OrHash,
14
- request_options: Increase::RequestOptions::OrHash
15
- ).returns(Increase::Document)
16
- end
17
- def create(
18
- # The type of document to create.
19
- category:,
20
- # An account verification letter. Required if and only if `category` is
21
- # `account_verification_letter`.
22
- account_verification_letter: nil,
23
- # Funding instructions. Required if and only if `category` is
24
- # `funding_instructions`.
25
- funding_instructions: nil,
26
- request_options: {}
27
- )
28
- end
29
-
30
- # Retrieve a Document
31
- sig do
32
- params(
33
- document_id: String,
34
- request_options: Increase::RequestOptions::OrHash
35
- ).returns(Increase::Document)
36
- end
37
- def retrieve(
38
- # The identifier of the Document to retrieve.
39
- document_id,
40
- request_options: {}
41
- )
42
- end
43
-
44
- # List Documents
45
- sig do
46
- params(
47
- category: Increase::DocumentListParams::Category::OrHash,
48
- created_at: Increase::DocumentListParams::CreatedAt::OrHash,
49
- cursor: String,
50
- entity_id: String,
51
- idempotency_key: String,
52
- limit: Integer,
53
- request_options: Increase::RequestOptions::OrHash
54
- ).returns(Increase::Internal::Page[Increase::Document])
55
- end
56
- def list(
57
- category: nil,
58
- created_at: nil,
59
- # Return the page of entries after this one.
60
- cursor: nil,
61
- # Filter Documents to ones belonging to the specified Entity.
62
- entity_id: nil,
63
- # Filter records to the one with the specified `idempotency_key` you chose for
64
- # that object. This value is unique across Increase and is used to ensure that a
65
- # request is only processed once. Learn more about
66
- # [idempotency](https://increase.com/documentation/idempotency-keys).
67
- idempotency_key: nil,
68
- # Limit the size of the list that is returned. The default (and maximum) is 100
69
- # objects.
70
- limit: nil,
71
- request_options: {}
72
- )
73
- end
74
-
75
- # @api private
76
- sig { params(client: Increase::Client).returns(T.attached_class) }
77
- def self.new(client:)
78
- end
79
- end
80
- end
81
- end
@@ -1,122 +0,0 @@
1
- module Increase
2
- module Models
3
- type document =
4
- {
5
- id: String,
6
- account_verification_letter: Increase::Document::AccountVerificationLetter?,
7
- category: Increase::Models::Document::category,
8
- created_at: Time,
9
- entity_id: String?,
10
- file_id: String,
11
- funding_instructions: Increase::Document::FundingInstructions?,
12
- idempotency_key: String?,
13
- type: Increase::Models::Document::type_
14
- }
15
-
16
- class Document < Increase::Internal::Type::BaseModel
17
- attr_accessor id: String
18
-
19
- attr_accessor account_verification_letter: Increase::Document::AccountVerificationLetter?
20
-
21
- attr_accessor category: Increase::Models::Document::category
22
-
23
- attr_accessor created_at: Time
24
-
25
- attr_accessor entity_id: String?
26
-
27
- attr_accessor file_id: String
28
-
29
- attr_accessor funding_instructions: Increase::Document::FundingInstructions?
30
-
31
- attr_accessor idempotency_key: String?
32
-
33
- attr_accessor type: Increase::Models::Document::type_
34
-
35
- def initialize: (
36
- id: String,
37
- account_verification_letter: Increase::Document::AccountVerificationLetter?,
38
- category: Increase::Models::Document::category,
39
- created_at: Time,
40
- entity_id: String?,
41
- file_id: String,
42
- funding_instructions: Increase::Document::FundingInstructions?,
43
- idempotency_key: String?,
44
- type: Increase::Models::Document::type_
45
- ) -> void
46
-
47
- def to_hash: -> {
48
- id: String,
49
- account_verification_letter: Increase::Document::AccountVerificationLetter?,
50
- category: Increase::Models::Document::category,
51
- created_at: Time,
52
- entity_id: String?,
53
- file_id: String,
54
- funding_instructions: Increase::Document::FundingInstructions?,
55
- idempotency_key: String?,
56
- type: Increase::Models::Document::type_
57
- }
58
-
59
- type account_verification_letter = { account_number_id: String }
60
-
61
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
62
- attr_accessor account_number_id: String
63
-
64
- def initialize: (account_number_id: String) -> void
65
-
66
- def to_hash: -> { account_number_id: String }
67
- end
68
-
69
- type category =
70
- :form_1099_int
71
- | :form_1099_misc
72
- | :proof_of_authorization
73
- | :company_information
74
- | :account_verification_letter
75
- | :funding_instructions
76
-
77
- module Category
78
- extend Increase::Internal::Type::Enum
79
-
80
- # Internal Revenue Service Form 1099-INT.
81
- FORM_1099_INT: :form_1099_int
82
-
83
- # Internal Revenue Service Form 1099-MISC.
84
- FORM_1099_MISC: :form_1099_misc
85
-
86
- # A document submitted in response to a proof of authorization request for an ACH transfer.
87
- PROOF_OF_AUTHORIZATION: :proof_of_authorization
88
-
89
- # Company information, such a policies or procedures, typically submitted during our due diligence process.
90
- COMPANY_INFORMATION: :company_information
91
-
92
- # An account verification letter.
93
- ACCOUNT_VERIFICATION_LETTER: :account_verification_letter
94
-
95
- # Funding instructions.
96
- FUNDING_INSTRUCTIONS: :funding_instructions
97
-
98
- def self?.values: -> ::Array[Increase::Models::Document::category]
99
- end
100
-
101
- type funding_instructions = { account_number_id: String }
102
-
103
- class FundingInstructions < Increase::Internal::Type::BaseModel
104
- attr_accessor account_number_id: String
105
-
106
- def initialize: (account_number_id: String) -> void
107
-
108
- def to_hash: -> { account_number_id: String }
109
- end
110
-
111
- type type_ = :document
112
-
113
- module Type
114
- extend Increase::Internal::Type::Enum
115
-
116
- DOCUMENT: :document
117
-
118
- def self?.values: -> ::Array[Increase::Models::Document::type_]
119
- end
120
- end
121
- end
122
- end
@@ -1,83 +0,0 @@
1
- module Increase
2
- module Models
3
- type document_create_params =
4
- {
5
- category: Increase::Models::DocumentCreateParams::category,
6
- account_verification_letter: Increase::DocumentCreateParams::AccountVerificationLetter,
7
- funding_instructions: Increase::DocumentCreateParams::FundingInstructions
8
- }
9
- & Increase::Internal::Type::request_parameters
10
-
11
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
12
- extend Increase::Internal::Type::RequestParameters::Converter
13
- include Increase::Internal::Type::RequestParameters
14
-
15
- attr_accessor category: Increase::Models::DocumentCreateParams::category
16
-
17
- attr_reader account_verification_letter: Increase::DocumentCreateParams::AccountVerificationLetter?
18
-
19
- def account_verification_letter=: (
20
- Increase::DocumentCreateParams::AccountVerificationLetter
21
- ) -> Increase::DocumentCreateParams::AccountVerificationLetter
22
-
23
- attr_reader funding_instructions: Increase::DocumentCreateParams::FundingInstructions?
24
-
25
- def funding_instructions=: (
26
- Increase::DocumentCreateParams::FundingInstructions
27
- ) -> Increase::DocumentCreateParams::FundingInstructions
28
-
29
- def initialize: (
30
- category: Increase::Models::DocumentCreateParams::category,
31
- ?account_verification_letter: Increase::DocumentCreateParams::AccountVerificationLetter,
32
- ?funding_instructions: Increase::DocumentCreateParams::FundingInstructions,
33
- ?request_options: Increase::request_opts
34
- ) -> void
35
-
36
- def to_hash: -> {
37
- category: Increase::Models::DocumentCreateParams::category,
38
- account_verification_letter: Increase::DocumentCreateParams::AccountVerificationLetter,
39
- funding_instructions: Increase::DocumentCreateParams::FundingInstructions,
40
- request_options: Increase::RequestOptions
41
- }
42
-
43
- type category = :account_verification_letter | :funding_instructions
44
-
45
- module Category
46
- extend Increase::Internal::Type::Enum
47
-
48
- # An account verification letter.
49
- ACCOUNT_VERIFICATION_LETTER: :account_verification_letter
50
-
51
- # Funding instructions.
52
- FUNDING_INSTRUCTIONS: :funding_instructions
53
-
54
- def self?.values: -> ::Array[Increase::Models::DocumentCreateParams::category]
55
- end
56
-
57
- type account_verification_letter =
58
- { account_number_id: String, balance_date: Date }
59
-
60
- class AccountVerificationLetter < Increase::Internal::Type::BaseModel
61
- attr_accessor account_number_id: String
62
-
63
- attr_reader balance_date: Date?
64
-
65
- def balance_date=: (Date) -> Date
66
-
67
- def initialize: (account_number_id: String, ?balance_date: Date) -> void
68
-
69
- def to_hash: -> { account_number_id: String, balance_date: Date }
70
- end
71
-
72
- type funding_instructions = { account_number_id: String }
73
-
74
- class FundingInstructions < Increase::Internal::Type::BaseModel
75
- attr_accessor account_number_id: String
76
-
77
- def initialize: (account_number_id: String) -> void
78
-
79
- def to_hash: -> { account_number_id: String }
80
- end
81
- end
82
- end
83
- end