increase 1.248.0 → 1.250.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/increase/models/beneficial_owner_create_params.rb +387 -0
- data/lib/increase/models/check_transfer.rb +28 -7
- data/lib/increase/models/check_transfer_create_params.rb +37 -7
- data/lib/increase/models/entity_beneficial_owner.rb +12 -2
- data/lib/increase/models/file.rb +3 -0
- data/lib/increase/models/file_create_params.rb +3 -0
- data/lib/increase/models/file_list_params.rb +3 -0
- data/lib/increase/models.rb +2 -0
- data/lib/increase/resources/beneficial_owners.rb +31 -0
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +1 -0
- data/rbi/increase/models/beneficial_owner_create_params.rbi +698 -0
- data/rbi/increase/models/check_transfer.rbi +56 -9
- data/rbi/increase/models/check_transfer_create_params.rbi +72 -11
- data/rbi/increase/models/entity_beneficial_owner.rbi +12 -0
- data/rbi/increase/models/file.rbi +4 -0
- data/rbi/increase/models/file_create_params.rbi +7 -0
- data/rbi/increase/models/file_list_params.rbi +7 -0
- data/rbi/increase/models.rbi +2 -0
- data/rbi/increase/resources/beneficial_owners.rbi +26 -0
- data/sig/increase/models/beneficial_owner_create_params.rbs +319 -0
- data/sig/increase/models/check_transfer.rbs +16 -4
- data/sig/increase/models/check_transfer_create_params.rbs +23 -5
- data/sig/increase/models/entity_beneficial_owner.rbs +5 -0
- data/sig/increase/models/file.rbs +4 -0
- data/sig/increase/models/file_create_params.rbs +4 -0
- data/sig/increase/models/file_list_params.rbs +4 -0
- data/sig/increase/models.rbs +2 -0
- data/sig/increase/resources/beneficial_owners.rbs +8 -0
- metadata +4 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 482e24a49b50e6d1a98949b016d8b3b389f2149eef96fb31f4753e66b7978b59
|
|
4
|
+
data.tar.gz: 26b3535b4cbe13b5f36f6a4275766fafc8bfcd8aacca33397271abe805bb9da7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 96a7a7c649c76a77c84ad2640fe628104d34f37c78758c1ed163ecd8783cfff2b4563944871628cde5ef70d168804e40ccdfdcb8b3f69d8fcd0bda29ca4befa9
|
|
7
|
+
data.tar.gz: ec7ae0fd1834d2766e50d08a92b782c3fef353b05569337060a3fb0f45ede47a1f1873afb2b8596e415ebad6d304485cb02a0ff028c1ca7bc5d573931213ade8
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.250.0 (2026-03-12)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.249.0...v1.250.0](https://github.com/Increase/increase-ruby/compare/v1.249.0...v1.250.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([7ebc531](https://github.com/Increase/increase-ruby/commit/7ebc5310d5083507af85b1550834fd7cf8197c6a))
|
|
10
|
+
|
|
11
|
+
## 1.249.0 (2026-03-12)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v1.248.0...v1.249.0](https://github.com/Increase/increase-ruby/compare/v1.248.0...v1.249.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([b39504e](https://github.com/Increase/increase-ruby/commit/b39504e3d1a396dcbab69610cf1171af44a43bf1))
|
|
18
|
+
|
|
3
19
|
## 1.248.0 (2026-03-12)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v1.247.0...v1.248.0](https://github.com/Increase/increase-ruby/compare/v1.247.0...v1.248.0)
|
data/README.md
CHANGED
|
@@ -0,0 +1,387 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::BeneficialOwners#create
|
|
6
|
+
class BeneficialOwnerCreateParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute entity_id
|
|
11
|
+
# The identifier of the Entity to associate with the new Beneficial Owner.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :entity_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute individual
|
|
17
|
+
# Personal details for the beneficial owner.
|
|
18
|
+
#
|
|
19
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual]
|
|
20
|
+
required :individual, -> { Increase::BeneficialOwnerCreateParams::Individual }
|
|
21
|
+
|
|
22
|
+
# @!attribute prongs
|
|
23
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
24
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
25
|
+
# array containing both.
|
|
26
|
+
#
|
|
27
|
+
# @return [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
|
|
28
|
+
required :prongs,
|
|
29
|
+
-> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerCreateParams::Prong] }
|
|
30
|
+
|
|
31
|
+
# @!attribute company_title
|
|
32
|
+
# This person's role or title within the entity.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :company_title, String
|
|
36
|
+
|
|
37
|
+
# @!method initialize(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {Increase::Models::BeneficialOwnerCreateParams} for more details.
|
|
40
|
+
#
|
|
41
|
+
# @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
|
|
42
|
+
#
|
|
43
|
+
# @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
|
|
44
|
+
#
|
|
45
|
+
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
|
|
46
|
+
#
|
|
47
|
+
# @param company_title [String] This person's role or title within the entity.
|
|
48
|
+
#
|
|
49
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
50
|
+
|
|
51
|
+
class Individual < Increase::Internal::Type::BaseModel
|
|
52
|
+
# @!attribute address
|
|
53
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
54
|
+
# PMB's are disallowed.
|
|
55
|
+
#
|
|
56
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Address]
|
|
57
|
+
required :address, -> { Increase::BeneficialOwnerCreateParams::Individual::Address }
|
|
58
|
+
|
|
59
|
+
# @!attribute date_of_birth
|
|
60
|
+
# The person's date of birth in YYYY-MM-DD format.
|
|
61
|
+
#
|
|
62
|
+
# @return [Date]
|
|
63
|
+
required :date_of_birth, Date
|
|
64
|
+
|
|
65
|
+
# @!attribute identification
|
|
66
|
+
# A means of verifying the person's identity.
|
|
67
|
+
#
|
|
68
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification]
|
|
69
|
+
required :identification, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification }
|
|
70
|
+
|
|
71
|
+
# @!attribute name
|
|
72
|
+
# The person's legal name.
|
|
73
|
+
#
|
|
74
|
+
# @return [String]
|
|
75
|
+
required :name, String
|
|
76
|
+
|
|
77
|
+
# @!attribute confirmed_no_us_tax_id
|
|
78
|
+
# The identification method for an individual can only be a passport, driver's
|
|
79
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
80
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
81
|
+
# Number).
|
|
82
|
+
#
|
|
83
|
+
# @return [Boolean, nil]
|
|
84
|
+
optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
|
|
85
|
+
|
|
86
|
+
# @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
|
|
87
|
+
# Some parameter documentations has been truncated, see
|
|
88
|
+
# {Increase::Models::BeneficialOwnerCreateParams::Individual} for more details.
|
|
89
|
+
#
|
|
90
|
+
# Personal details for the beneficial owner.
|
|
91
|
+
#
|
|
92
|
+
# @param address [Increase::Models::BeneficialOwnerCreateParams::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
|
|
93
|
+
#
|
|
94
|
+
# @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
|
|
95
|
+
#
|
|
96
|
+
# @param identification [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification] A means of verifying the person's identity.
|
|
97
|
+
#
|
|
98
|
+
# @param name [String] The person's legal name.
|
|
99
|
+
#
|
|
100
|
+
# @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
|
|
101
|
+
|
|
102
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual#address
|
|
103
|
+
class Address < Increase::Internal::Type::BaseModel
|
|
104
|
+
# @!attribute city
|
|
105
|
+
# The city, district, town, or village of the address.
|
|
106
|
+
#
|
|
107
|
+
# @return [String]
|
|
108
|
+
required :city, String
|
|
109
|
+
|
|
110
|
+
# @!attribute country
|
|
111
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
112
|
+
#
|
|
113
|
+
# @return [String]
|
|
114
|
+
required :country, String
|
|
115
|
+
|
|
116
|
+
# @!attribute line1
|
|
117
|
+
# The first line of the address. This is usually the street number and street.
|
|
118
|
+
#
|
|
119
|
+
# @return [String]
|
|
120
|
+
required :line1, String
|
|
121
|
+
|
|
122
|
+
# @!attribute line2
|
|
123
|
+
# The second line of the address. This might be the floor or room number.
|
|
124
|
+
#
|
|
125
|
+
# @return [String, nil]
|
|
126
|
+
optional :line2, String
|
|
127
|
+
|
|
128
|
+
# @!attribute state
|
|
129
|
+
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
130
|
+
# state, province, or region of the address. Required in certain countries.
|
|
131
|
+
#
|
|
132
|
+
# @return [String, nil]
|
|
133
|
+
optional :state, String
|
|
134
|
+
|
|
135
|
+
# @!attribute zip
|
|
136
|
+
# The ZIP or postal code of the address. Required in certain countries.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
optional :zip, String
|
|
140
|
+
|
|
141
|
+
# @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
|
|
142
|
+
# Some parameter documentations has been truncated, see
|
|
143
|
+
# {Increase::Models::BeneficialOwnerCreateParams::Individual::Address} for more
|
|
144
|
+
# details.
|
|
145
|
+
#
|
|
146
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
147
|
+
# PMB's are disallowed.
|
|
148
|
+
#
|
|
149
|
+
# @param city [String] The city, district, town, or village of the address.
|
|
150
|
+
#
|
|
151
|
+
# @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
152
|
+
#
|
|
153
|
+
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
154
|
+
#
|
|
155
|
+
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
|
156
|
+
#
|
|
157
|
+
# @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
|
|
158
|
+
#
|
|
159
|
+
# @param zip [String] The ZIP or postal code of the address. Required in certain countries.
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual#identification
|
|
163
|
+
class Identification < Increase::Internal::Type::BaseModel
|
|
164
|
+
# @!attribute method_
|
|
165
|
+
# A method that can be used to verify the individual's identity.
|
|
166
|
+
#
|
|
167
|
+
# @return [Symbol, Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Method]
|
|
168
|
+
required :method_,
|
|
169
|
+
enum: -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Method },
|
|
170
|
+
api_name: :method
|
|
171
|
+
|
|
172
|
+
# @!attribute number
|
|
173
|
+
# An identification number that can be used to verify the individual's identity,
|
|
174
|
+
# such as a social security number.
|
|
175
|
+
#
|
|
176
|
+
# @return [String]
|
|
177
|
+
required :number, String
|
|
178
|
+
|
|
179
|
+
# @!attribute drivers_license
|
|
180
|
+
# Information about the United States driver's license used for identification.
|
|
181
|
+
# Required if `method` is equal to `drivers_license`.
|
|
182
|
+
#
|
|
183
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense, nil]
|
|
184
|
+
optional :drivers_license,
|
|
185
|
+
-> { Increase::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense }
|
|
186
|
+
|
|
187
|
+
# @!attribute other
|
|
188
|
+
# Information about the identification document provided. Required if `method` is
|
|
189
|
+
# equal to `other`.
|
|
190
|
+
#
|
|
191
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other, nil]
|
|
192
|
+
optional :other, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Other }
|
|
193
|
+
|
|
194
|
+
# @!attribute passport
|
|
195
|
+
# Information about the passport used for identification. Required if `method` is
|
|
196
|
+
# equal to `passport`.
|
|
197
|
+
#
|
|
198
|
+
# @return [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport, nil]
|
|
199
|
+
optional :passport, -> { Increase::BeneficialOwnerCreateParams::Individual::Identification::Passport }
|
|
200
|
+
|
|
201
|
+
# @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
|
|
202
|
+
# Some parameter documentations has been truncated, see
|
|
203
|
+
# {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification} for
|
|
204
|
+
# more details.
|
|
205
|
+
#
|
|
206
|
+
# A means of verifying the person's identity.
|
|
207
|
+
#
|
|
208
|
+
# @param method_ [Symbol, Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Method] A method that can be used to verify the individual's identity.
|
|
209
|
+
#
|
|
210
|
+
# @param number [String] An identification number that can be used to verify the individual's identity, s
|
|
211
|
+
#
|
|
212
|
+
# @param drivers_license [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
|
|
213
|
+
#
|
|
214
|
+
# @param other [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
|
|
215
|
+
#
|
|
216
|
+
# @param passport [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
|
|
217
|
+
|
|
218
|
+
# A method that can be used to verify the individual's identity.
|
|
219
|
+
#
|
|
220
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#method_
|
|
221
|
+
module Method
|
|
222
|
+
extend Increase::Internal::Type::Enum
|
|
223
|
+
|
|
224
|
+
# A social security number.
|
|
225
|
+
SOCIAL_SECURITY_NUMBER = :social_security_number
|
|
226
|
+
|
|
227
|
+
# An individual taxpayer identification number (ITIN).
|
|
228
|
+
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
|
|
229
|
+
|
|
230
|
+
# A passport number.
|
|
231
|
+
PASSPORT = :passport
|
|
232
|
+
|
|
233
|
+
# A driver's license number.
|
|
234
|
+
DRIVERS_LICENSE = :drivers_license
|
|
235
|
+
|
|
236
|
+
# Another identifying document.
|
|
237
|
+
OTHER = :other
|
|
238
|
+
|
|
239
|
+
# @!method self.values
|
|
240
|
+
# @return [Array<Symbol>]
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#drivers_license
|
|
244
|
+
class DriversLicense < Increase::Internal::Type::BaseModel
|
|
245
|
+
# @!attribute expiration_date
|
|
246
|
+
# The driver's license's expiration date in YYYY-MM-DD format.
|
|
247
|
+
#
|
|
248
|
+
# @return [Date]
|
|
249
|
+
required :expiration_date, Date
|
|
250
|
+
|
|
251
|
+
# @!attribute file_id
|
|
252
|
+
# The identifier of the File containing the front of the driver's license.
|
|
253
|
+
#
|
|
254
|
+
# @return [String]
|
|
255
|
+
required :file_id, String
|
|
256
|
+
|
|
257
|
+
# @!attribute state
|
|
258
|
+
# The state that issued the provided driver's license.
|
|
259
|
+
#
|
|
260
|
+
# @return [String]
|
|
261
|
+
required :state, String
|
|
262
|
+
|
|
263
|
+
# @!attribute back_file_id
|
|
264
|
+
# The identifier of the File containing the back of the driver's license.
|
|
265
|
+
#
|
|
266
|
+
# @return [String, nil]
|
|
267
|
+
optional :back_file_id, String
|
|
268
|
+
|
|
269
|
+
# @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
|
|
270
|
+
# Information about the United States driver's license used for identification.
|
|
271
|
+
# Required if `method` is equal to `drivers_license`.
|
|
272
|
+
#
|
|
273
|
+
# @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
|
|
274
|
+
#
|
|
275
|
+
# @param file_id [String] The identifier of the File containing the front of the driver's license.
|
|
276
|
+
#
|
|
277
|
+
# @param state [String] The state that issued the provided driver's license.
|
|
278
|
+
#
|
|
279
|
+
# @param back_file_id [String] The identifier of the File containing the back of the driver's license.
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#other
|
|
283
|
+
class Other < Increase::Internal::Type::BaseModel
|
|
284
|
+
# @!attribute country
|
|
285
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
286
|
+
# document (e.g., `US`).
|
|
287
|
+
#
|
|
288
|
+
# @return [String]
|
|
289
|
+
required :country, String
|
|
290
|
+
|
|
291
|
+
# @!attribute description
|
|
292
|
+
# A description of the document submitted.
|
|
293
|
+
#
|
|
294
|
+
# @return [String]
|
|
295
|
+
required :description, String
|
|
296
|
+
|
|
297
|
+
# @!attribute file_id
|
|
298
|
+
# The identifier of the File containing the front of the document.
|
|
299
|
+
#
|
|
300
|
+
# @return [String]
|
|
301
|
+
required :file_id, String
|
|
302
|
+
|
|
303
|
+
# @!attribute back_file_id
|
|
304
|
+
# The identifier of the File containing the back of the document. Not every
|
|
305
|
+
# document has a reverse side.
|
|
306
|
+
#
|
|
307
|
+
# @return [String, nil]
|
|
308
|
+
optional :back_file_id, String
|
|
309
|
+
|
|
310
|
+
# @!attribute expiration_date
|
|
311
|
+
# The document's expiration date in YYYY-MM-DD format.
|
|
312
|
+
#
|
|
313
|
+
# @return [Date, nil]
|
|
314
|
+
optional :expiration_date, Date
|
|
315
|
+
|
|
316
|
+
# @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
|
|
317
|
+
# Some parameter documentations has been truncated, see
|
|
318
|
+
# {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Other}
|
|
319
|
+
# for more details.
|
|
320
|
+
#
|
|
321
|
+
# Information about the identification document provided. Required if `method` is
|
|
322
|
+
# equal to `other`.
|
|
323
|
+
#
|
|
324
|
+
# @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
|
|
325
|
+
#
|
|
326
|
+
# @param description [String] A description of the document submitted.
|
|
327
|
+
#
|
|
328
|
+
# @param file_id [String] The identifier of the File containing the front of the document.
|
|
329
|
+
#
|
|
330
|
+
# @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
|
|
331
|
+
#
|
|
332
|
+
# @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# @see Increase::Models::BeneficialOwnerCreateParams::Individual::Identification#passport
|
|
336
|
+
class Passport < Increase::Internal::Type::BaseModel
|
|
337
|
+
# @!attribute country
|
|
338
|
+
# The two-character ISO 3166-1 code representing the country that issued the
|
|
339
|
+
# document (e.g., `US`).
|
|
340
|
+
#
|
|
341
|
+
# @return [String]
|
|
342
|
+
required :country, String
|
|
343
|
+
|
|
344
|
+
# @!attribute expiration_date
|
|
345
|
+
# The passport's expiration date in YYYY-MM-DD format.
|
|
346
|
+
#
|
|
347
|
+
# @return [Date]
|
|
348
|
+
required :expiration_date, Date
|
|
349
|
+
|
|
350
|
+
# @!attribute file_id
|
|
351
|
+
# The identifier of the File containing the passport.
|
|
352
|
+
#
|
|
353
|
+
# @return [String]
|
|
354
|
+
required :file_id, String
|
|
355
|
+
|
|
356
|
+
# @!method initialize(country:, expiration_date:, file_id:)
|
|
357
|
+
# Some parameter documentations has been truncated, see
|
|
358
|
+
# {Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::Passport}
|
|
359
|
+
# for more details.
|
|
360
|
+
#
|
|
361
|
+
# Information about the passport used for identification. Required if `method` is
|
|
362
|
+
# equal to `passport`.
|
|
363
|
+
#
|
|
364
|
+
# @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
|
|
365
|
+
#
|
|
366
|
+
# @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
|
|
367
|
+
#
|
|
368
|
+
# @param file_id [String] The identifier of the File containing the passport.
|
|
369
|
+
end
|
|
370
|
+
end
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
module Prong
|
|
374
|
+
extend Increase::Internal::Type::Enum
|
|
375
|
+
|
|
376
|
+
# A person with 25% or greater direct or indirect ownership of the entity.
|
|
377
|
+
OWNERSHIP = :ownership
|
|
378
|
+
|
|
379
|
+
# A person who manages, directs, or has significant control of the entity.
|
|
380
|
+
CONTROL = :control
|
|
381
|
+
|
|
382
|
+
# @!method self.values
|
|
383
|
+
# @return [Array<Symbol>]
|
|
384
|
+
end
|
|
385
|
+
end
|
|
386
|
+
end
|
|
387
|
+
end
|
|
@@ -511,12 +511,11 @@ module Increase
|
|
|
511
511
|
},
|
|
512
512
|
nil?: true
|
|
513
513
|
|
|
514
|
-
# @!attribute
|
|
515
|
-
# The
|
|
516
|
-
# blank, the check will be printed with 'No signature required'.
|
|
514
|
+
# @!attribute signature
|
|
515
|
+
# The signature that will appear on the check.
|
|
517
516
|
#
|
|
518
|
-
# @return [
|
|
519
|
-
required :
|
|
517
|
+
# @return [Increase::Models::CheckTransfer::PhysicalCheck::Signature]
|
|
518
|
+
required :signature, -> { Increase::CheckTransfer::PhysicalCheck::Signature }
|
|
520
519
|
|
|
521
520
|
# @!attribute tracking_updates
|
|
522
521
|
# Tracking updates relating to the physical check's delivery.
|
|
@@ -525,7 +524,7 @@ module Increase
|
|
|
525
524
|
required :tracking_updates,
|
|
526
525
|
-> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
|
|
527
526
|
|
|
528
|
-
# @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:,
|
|
527
|
+
# @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:, signature:, tracking_updates:)
|
|
529
528
|
# Some parameter documentations has been truncated, see
|
|
530
529
|
# {Increase::Models::CheckTransfer::PhysicalCheck} for more details.
|
|
531
530
|
#
|
|
@@ -550,7 +549,7 @@ module Increase
|
|
|
550
549
|
#
|
|
551
550
|
# @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] The shipping method for the check.
|
|
552
551
|
#
|
|
553
|
-
# @param
|
|
552
|
+
# @param signature [Increase::Models::CheckTransfer::PhysicalCheck::Signature] The signature that will appear on the check.
|
|
554
553
|
#
|
|
555
554
|
# @param tracking_updates [Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>] Tracking updates relating to the physical check's delivery.
|
|
556
555
|
|
|
@@ -715,6 +714,28 @@ module Increase
|
|
|
715
714
|
# @return [Array<Symbol>]
|
|
716
715
|
end
|
|
717
716
|
|
|
717
|
+
# @see Increase::Models::CheckTransfer::PhysicalCheck#signature
|
|
718
|
+
class Signature < Increase::Internal::Type::BaseModel
|
|
719
|
+
# @!attribute image_file_id
|
|
720
|
+
# The ID of a File containing a PNG of the signature.
|
|
721
|
+
#
|
|
722
|
+
# @return [String, nil]
|
|
723
|
+
required :image_file_id, String, nil?: true
|
|
724
|
+
|
|
725
|
+
# @!attribute text
|
|
726
|
+
# The text that will appear as the signature on the check in cursive font.
|
|
727
|
+
#
|
|
728
|
+
# @return [String, nil]
|
|
729
|
+
required :text, String, nil?: true
|
|
730
|
+
|
|
731
|
+
# @!method initialize(image_file_id:, text:)
|
|
732
|
+
# The signature that will appear on the check.
|
|
733
|
+
#
|
|
734
|
+
# @param image_file_id [String, nil] The ID of a File containing a PNG of the signature.
|
|
735
|
+
#
|
|
736
|
+
# @param text [String, nil] The text that will appear as the signature on the check in cursive font.
|
|
737
|
+
end
|
|
738
|
+
|
|
718
739
|
class TrackingUpdate < Increase::Internal::Type::BaseModel
|
|
719
740
|
# @!attribute category
|
|
720
741
|
# The type of tracking event.
|
|
@@ -198,14 +198,15 @@ module Increase
|
|
|
198
198
|
# @return [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod, nil]
|
|
199
199
|
optional :shipping_method, enum: -> { Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod }
|
|
200
200
|
|
|
201
|
-
# @!attribute
|
|
202
|
-
# The
|
|
203
|
-
#
|
|
201
|
+
# @!attribute signature
|
|
202
|
+
# The signature that will appear on the check. If not provided, the check will be
|
|
203
|
+
# printed with 'No Signature Required'. At most one of `text` and `image_file_id`
|
|
204
|
+
# may be provided.
|
|
204
205
|
#
|
|
205
|
-
# @return [
|
|
206
|
-
optional :
|
|
206
|
+
# @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature, nil]
|
|
207
|
+
optional :signature, -> { Increase::CheckTransferCreateParams::PhysicalCheck::Signature }
|
|
207
208
|
|
|
208
|
-
# @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, payer: nil, return_address: nil, shipping_method: nil,
|
|
209
|
+
# @!method initialize(mailing_address:, memo:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, payer: nil, return_address: nil, shipping_method: nil, signature: nil)
|
|
209
210
|
# Some parameter documentations has been truncated, see
|
|
210
211
|
# {Increase::Models::CheckTransferCreateParams::PhysicalCheck} for more details.
|
|
211
212
|
#
|
|
@@ -231,7 +232,7 @@ module Increase
|
|
|
231
232
|
#
|
|
232
233
|
# @param shipping_method [Symbol, Increase::Models::CheckTransferCreateParams::PhysicalCheck::ShippingMethod] How to ship the check. For details on pricing, timing, and restrictions, see htt
|
|
233
234
|
#
|
|
234
|
-
# @param
|
|
235
|
+
# @param signature [Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature] The signature that will appear on the check. If not provided, the check will be
|
|
235
236
|
|
|
236
237
|
# @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#mailing_address
|
|
237
238
|
class MailingAddress < Increase::Internal::Type::BaseModel
|
|
@@ -399,6 +400,35 @@ module Increase
|
|
|
399
400
|
# @!method self.values
|
|
400
401
|
# @return [Array<Symbol>]
|
|
401
402
|
end
|
|
403
|
+
|
|
404
|
+
# @see Increase::Models::CheckTransferCreateParams::PhysicalCheck#signature
|
|
405
|
+
class Signature < Increase::Internal::Type::BaseModel
|
|
406
|
+
# @!attribute image_file_id
|
|
407
|
+
# The ID of a File containing a PNG of the signature. This must have
|
|
408
|
+
# `purpose: check_signature` and be a 1320x120 pixel PNG.
|
|
409
|
+
#
|
|
410
|
+
# @return [String, nil]
|
|
411
|
+
optional :image_file_id, String
|
|
412
|
+
|
|
413
|
+
# @!attribute text
|
|
414
|
+
# The text that will appear as the signature on the check in cursive font.
|
|
415
|
+
#
|
|
416
|
+
# @return [String, nil]
|
|
417
|
+
optional :text, String
|
|
418
|
+
|
|
419
|
+
# @!method initialize(image_file_id: nil, text: nil)
|
|
420
|
+
# Some parameter documentations has been truncated, see
|
|
421
|
+
# {Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature} for more
|
|
422
|
+
# details.
|
|
423
|
+
#
|
|
424
|
+
# The signature that will appear on the check. If not provided, the check will be
|
|
425
|
+
# printed with 'No Signature Required'. At most one of `text` and `image_file_id`
|
|
426
|
+
# may be provided.
|
|
427
|
+
#
|
|
428
|
+
# @param image_file_id [String] The ID of a File containing a PNG of the signature. This must have `purpose: che
|
|
429
|
+
#
|
|
430
|
+
# @param text [String] The text that will appear as the signature on the check in cursive font.
|
|
431
|
+
end
|
|
402
432
|
end
|
|
403
433
|
|
|
404
434
|
class ThirdParty < Increase::Internal::Type::BaseModel
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Models
|
|
5
|
-
# @see Increase::Resources::BeneficialOwners#
|
|
5
|
+
# @see Increase::Resources::BeneficialOwners#create
|
|
6
6
|
class EntityBeneficialOwner < Increase::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
8
|
# The identifier of this beneficial owner.
|
|
@@ -23,6 +23,14 @@ module Increase
|
|
|
23
23
|
# @return [Time]
|
|
24
24
|
required :created_at, Time
|
|
25
25
|
|
|
26
|
+
# @!attribute idempotency_key
|
|
27
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
28
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
29
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
required :idempotency_key, String, nil?: true
|
|
33
|
+
|
|
26
34
|
# @!attribute individual
|
|
27
35
|
# Personal details for the beneficial owner.
|
|
28
36
|
#
|
|
@@ -42,7 +50,7 @@ module Increase
|
|
|
42
50
|
# @return [Symbol, Increase::Models::EntityBeneficialOwner::Type]
|
|
43
51
|
required :type, enum: -> { Increase::EntityBeneficialOwner::Type }
|
|
44
52
|
|
|
45
|
-
# @!method initialize(id:, company_title:, created_at:, individual:, prongs:, type:)
|
|
53
|
+
# @!method initialize(id:, company_title:, created_at:, idempotency_key:, individual:, prongs:, type:)
|
|
46
54
|
# Some parameter documentations has been truncated, see
|
|
47
55
|
# {Increase::Models::EntityBeneficialOwner} for more details.
|
|
48
56
|
#
|
|
@@ -58,6 +66,8 @@ module Increase
|
|
|
58
66
|
#
|
|
59
67
|
# @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Benefic
|
|
60
68
|
#
|
|
69
|
+
# @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
|
|
70
|
+
#
|
|
61
71
|
# @param individual [Increase::Models::EntityBeneficialOwner::Individual] Personal details for the beneficial owner.
|
|
62
72
|
#
|
|
63
73
|
# @param prongs [Array<Symbol, Increase::Models::EntityBeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
|
data/lib/increase/models/file.rb
CHANGED
|
@@ -138,6 +138,9 @@ module Increase
|
|
|
138
138
|
# An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
|
|
139
139
|
CHECK_VOUCHER_IMAGE = :check_voucher_image
|
|
140
140
|
|
|
141
|
+
# A signature image to be printed on a check. This must be a 1320x120 pixel PNG.
|
|
142
|
+
CHECK_SIGNATURE = :check_signature
|
|
143
|
+
|
|
141
144
|
# A scanned mail item sent to Increase.
|
|
142
145
|
INBOUND_MAIL_ITEM = :inbound_mail_item
|
|
143
146
|
|
|
@@ -61,6 +61,9 @@ module Increase
|
|
|
61
61
|
# An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
|
|
62
62
|
CHECK_VOUCHER_IMAGE = :check_voucher_image
|
|
63
63
|
|
|
64
|
+
# A signature image to be printed on a check. This must be a 1320x120 pixel PNG.
|
|
65
|
+
CHECK_SIGNATURE = :check_signature
|
|
66
|
+
|
|
64
67
|
# IRS Form SS-4.
|
|
65
68
|
FORM_SS_4 = :form_ss_4
|
|
66
69
|
|
|
@@ -140,6 +140,9 @@ module Increase
|
|
|
140
140
|
# An image to be used as the check voucher image, which is printed in the middle of the trifold area of a check. This must be a 2550x1100 pixel PNG.
|
|
141
141
|
CHECK_VOUCHER_IMAGE = :check_voucher_image
|
|
142
142
|
|
|
143
|
+
# A signature image to be printed on a check. This must be a 1320x120 pixel PNG.
|
|
144
|
+
CHECK_SIGNATURE = :check_signature
|
|
145
|
+
|
|
143
146
|
# A scanned mail item sent to Increase.
|
|
144
147
|
INBOUND_MAIL_ITEM = :inbound_mail_item
|
|
145
148
|
|
data/lib/increase/models.rb
CHANGED
|
@@ -105,6 +105,8 @@ module Increase
|
|
|
105
105
|
|
|
106
106
|
BeneficialOwnerArchiveParams = Increase::Models::BeneficialOwnerArchiveParams
|
|
107
107
|
|
|
108
|
+
BeneficialOwnerCreateParams = Increase::Models::BeneficialOwnerCreateParams
|
|
109
|
+
|
|
108
110
|
BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
|
|
109
111
|
|
|
110
112
|
BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
|