increase 1.167.0 → 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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +0 -4
  5. data/lib/increase/models.rb +0 -8
  6. data/lib/increase/resources/simulations.rb +0 -4
  7. data/lib/increase/version.rb +1 -1
  8. data/lib/increase.rb +0 -7
  9. data/rbi/increase/client.rbi +0 -3
  10. data/rbi/increase/models.rbi +0 -8
  11. data/rbi/increase/resources/simulations.rbi +0 -3
  12. data/sig/increase/client.rbs +0 -2
  13. data/sig/increase/models.rbs +0 -8
  14. data/sig/increase/resources/simulations.rbs +0 -2
  15. metadata +1 -22
  16. data/lib/increase/models/document.rb +0 -160
  17. data/lib/increase/models/document_create_params.rb +0 -93
  18. data/lib/increase/models/document_list_params.rb +0 -152
  19. data/lib/increase/models/document_retrieve_params.rb +0 -14
  20. data/lib/increase/models/simulations/document_create_params.rb +0 -24
  21. data/lib/increase/resources/documents.rb +0 -99
  22. data/lib/increase/resources/simulations/documents.rb +0 -38
  23. data/rbi/increase/models/document.rbi +0 -249
  24. data/rbi/increase/models/document_create_params.rbi +0 -191
  25. data/rbi/increase/models/document_list_params.rbi +0 -296
  26. data/rbi/increase/models/document_retrieve_params.rbi +0 -27
  27. data/rbi/increase/models/simulations/document_create_params.rbi +0 -45
  28. data/rbi/increase/resources/documents.rbi +0 -81
  29. data/rbi/increase/resources/simulations/documents.rbi +0 -28
  30. data/sig/increase/models/document.rbs +0 -122
  31. data/sig/increase/models/document_create_params.rbs +0 -83
  32. data/sig/increase/models/document_list_params.rbs +0 -153
  33. data/sig/increase/models/document_retrieve_params.rbs +0 -15
  34. data/sig/increase/models/simulations/document_create_params.rbs +0 -25
  35. data/sig/increase/resources/documents.rbs +0 -29
  36. data/sig/increase/resources/simulations/documents.rbs +0 -14
@@ -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
@@ -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,45 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- module Simulations
6
- class DocumentCreateParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- OrHash =
11
- T.type_alias do
12
- T.any(
13
- Increase::Simulations::DocumentCreateParams,
14
- Increase::Internal::AnyHash
15
- )
16
- end
17
-
18
- # The identifier of the Account the tax document is for.
19
- sig { returns(String) }
20
- attr_accessor :account_id
21
-
22
- sig do
23
- params(
24
- account_id: String,
25
- request_options: Increase::RequestOptions::OrHash
26
- ).returns(T.attached_class)
27
- end
28
- def self.new(
29
- # The identifier of the Account the tax document is for.
30
- account_id:,
31
- request_options: {}
32
- )
33
- end
34
-
35
- sig do
36
- override.returns(
37
- { account_id: String, request_options: Increase::RequestOptions }
38
- )
39
- end
40
- def to_hash
41
- end
42
- end
43
- end
44
- end
45
- end
@@ -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,28 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Resources
5
- class Simulations
6
- class Documents
7
- # Simulates an tax document being created for an account.
8
- sig do
9
- params(
10
- account_id: String,
11
- request_options: Increase::RequestOptions::OrHash
12
- ).returns(Increase::Document)
13
- end
14
- def create(
15
- # The identifier of the Account the tax document is for.
16
- account_id:,
17
- request_options: {}
18
- )
19
- end
20
-
21
- # @api private
22
- sig { params(client: Increase::Client).returns(T.attached_class) }
23
- def self.new(client:)
24
- end
25
- end
26
- end
27
- end
28
- end