Class: Dataleon::Models::Individuals::Kbis::Member

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dataleon/models/individuals/kbis.rb

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: nil, address: nil, birthday: nil, birthplace: nil, country: nil, email: nil, first_name: nil, is_beneficial_owner: nil, is_delegator: nil, last_name: nil, liveness_verification: nil, name: nil, ownership_percentage: nil, phone_number: nil, postal_code: nil, registration_id: nil, relation: nil, roles: nil, source: nil, status: nil, type: nil, workspace_id: nil) ⇒ Object

A member (person or entity) associated with the company from a KBIS document.

Parameters:

  • id (String) (defaults to: nil) —

    Unique identifier for the member.

  • address (String) (defaults to: nil) —

    Address of the member.

  • birthday (Time) (defaults to: nil) —

    Birth date of the person (only if type = person).

  • birthplace (String) (defaults to: nil) —

    Place of birth (only if type = person).

  • country (String) (defaults to: nil) —

    Country of residence or registration.

  • email (String) (defaults to: nil) —

    Email address of the member.

  • first_name (String) (defaults to: nil) —

    First name of the person (only if type = person).

  • is_beneficial_owner (Boolean) (defaults to: nil) —

    Indicates if this member is a beneficial owner.

  • is_delegator (Boolean) (defaults to: nil) —

    Indicates if this member is a delegator.

  • last_name (String) (defaults to: nil) —

    Last name of the person (only if type = person).

  • liveness_verification (Boolean) (defaults to: nil) —

    Indicates if the member passed liveness verification.

  • name (String) (defaults to: nil) —

    Name of the company (only if type = company).

  • ownership_percentage (Integer) (defaults to: nil) —

    Ownership percentage held by the member.

  • phone_number (String) (defaults to: nil) —

    Phone number of the member.

  • postal_code (String) (defaults to: nil) —

    Postal code of the member’s address.

  • registration_id (String) (defaults to: nil) —

    Company registration number (if type = company).

  • relation (String) (defaults to: nil) —

    Type of relation (e.g., shareholder, director).

  • roles (String) (defaults to: nil) —

    Roles held by the member (e.g., legal_representative or shareholder).

  • source (String) (defaults to: nil) —

    Source of the data (e.g., gouv, user, company).

  • status (String) (defaults to: nil) —

    Current status of the member.

  • type (Symbol, Dataleon::Models::Individuals::Kbis::Member::Type) (defaults to: nil) —

    Type of entity (company or person).

  • workspace_id (String) (defaults to: nil) —

    Workspace identifier for internal tracking.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 130

class Member < Dataleon::Internal::Type::BaseModel
  # @!attribute id
  #   Unique identifier for the member.
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute address
  #   Address of the member.
  #
  #   @return [String, nil]
  optional :address, String

  # @!attribute birthday
  #   Birth date of the person (only if type = person).
  #
  #   @return [Time, nil]
  optional :birthday, Time

  # @!attribute birthplace
  #   Place of birth (only if type = person).
  #
  #   @return [String, nil]
  optional :birthplace, String

  # @!attribute country
  #   Country of residence or registration.
  #
  #   @return [String, nil]
  optional :country, String

  # @!attribute email
  #   Email address of the member.
  #
  #   @return [String, nil]
  optional :email, String

  # @!attribute first_name
  #   First name of the person (only if type = person).
  #
  #   @return [String, nil]
  optional :first_name, String

  # @!attribute is_beneficial_owner
  #   Indicates if this member is a beneficial owner.
  #
  #   @return [Boolean, nil]
  optional :is_beneficial_owner, Dataleon::Internal::Type::Boolean

  # @!attribute is_delegator
  #   Indicates if this member is a delegator.
  #
  #   @return [Boolean, nil]
  optional :is_delegator, Dataleon::Internal::Type::Boolean

  # @!attribute last_name
  #   Last name of the person (only if type = person).
  #
  #   @return [String, nil]
  optional :last_name, String

  # @!attribute liveness_verification
  #   Indicates if the member passed liveness verification.
  #
  #   @return [Boolean, nil]
  optional :liveness_verification, Dataleon::Internal::Type::Boolean

  # @!attribute name
  #   Name of the company (only if type = company).
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute ownership_percentage
  #   Ownership percentage held by the member.
  #
  #   @return [Integer, nil]
  optional :ownership_percentage, Integer

  # @!attribute phone_number
  #   Phone number of the member.
  #
  #   @return [String, nil]
  optional :phone_number, String

  # @!attribute postal_code
  #   Postal code of the member's address.
  #
  #   @return [String, nil]
  optional :postal_code, String

  # @!attribute registration_id
  #   Company registration number (if type = company).
  #
  #   @return [String, nil]
  optional :registration_id, String

  # @!attribute relation
  #   Type of relation (e.g., shareholder, director).
  #
  #   @return [String, nil]
  optional :relation, String

  # @!attribute roles
  #   Roles held by the member (e.g., legal_representative or shareholder).
  #
  #   @return [String, nil]
  optional :roles, String

  # @!attribute source
  #   Source of the data (e.g., gouv, user, company).
  #
  #   @return [String, nil]
  optional :source, String

  # @!attribute status
  #   Current status of the member.
  #
  #   @return [String, nil]
  optional :status, String

  # @!attribute type
  #   Type of entity (company or person).
  #
  #   @return [Symbol, Dataleon::Models::Individuals::Kbis::Member::Type, nil]
  optional :type, enum: -> { Dataleon::Individuals::Kbis::Member::Type }

  # @!attribute workspace_id
  #   Workspace identifier for internal tracking.
  #
  #   @return [String, nil]
  optional :workspace_id, String

  # @!method initialize(id: nil, address: nil, birthday: nil, birthplace: nil, country: nil, email: nil, first_name: nil, is_beneficial_owner: nil, is_delegator: nil, last_name: nil, liveness_verification: nil, name: nil, ownership_percentage: nil, phone_number: nil, postal_code: nil, registration_id: nil, relation: nil, roles: nil, source: nil, status: nil, type: nil, workspace_id: nil)
  #   A member (person or entity) associated with the company from a KBIS document.
  #
  #   @param id [String] Unique identifier for the member.
  #
  #   @param address [String] Address of the member.
  #
  #   @param birthday [Time] Birth date of the person (only if type = person).
  #
  #   @param birthplace [String] Place of birth (only if type = person).
  #
  #   @param country [String] Country of residence or registration.
  #
  #   @param email [String] Email address of the member.
  #
  #   @param first_name [String] First name of the person (only if type = person).
  #
  #   @param is_beneficial_owner [Boolean] Indicates if this member is a beneficial owner.
  #
  #   @param is_delegator [Boolean] Indicates if this member is a delegator.
  #
  #   @param last_name [String] Last name of the person (only if type = person).
  #
  #   @param liveness_verification [Boolean] Indicates if the member passed liveness verification.
  #
  #   @param name [String] Name of the company (only if type = company).
  #
  #   @param ownership_percentage [Integer] Ownership percentage held by the member.
  #
  #   @param phone_number [String] Phone number of the member.
  #
  #   @param postal_code [String] Postal code of the member's address.
  #
  #   @param registration_id [String] Company registration number (if type = company).
  #
  #   @param relation [String] Type of relation (e.g., shareholder, director).
  #
  #   @param roles [String] Roles held by the member (e.g., legal_representative or shareholder).
  #
  #   @param source [String] Source of the data (e.g., gouv, user, company).
  #
  #   @param status [String] Current status of the member.
  #
  #   @param type [Symbol, Dataleon::Models::Individuals::Kbis::Member::Type] Type of entity (company or person).
  #
  #   @param workspace_id [String] Workspace identifier for internal tracking.

  # Type of entity (company or person).
  #
  # @see Dataleon::Models::Individuals::Kbis::Member#type
  module Type
    extend Dataleon::Internal::Type::Enum

    COMPANY = :company
    PERSON = :person

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#address ⇒ String?

Address of the member.

Returns:

  • (String, nil) 


141
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 141

optional :address, String

#birthday ⇒ Time?

Birth date of the person (only if type = person).

Returns:

  • (Time, nil) 


147
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 147

optional :birthday, Time

#birthplace ⇒ String?

Place of birth (only if type = person).

Returns:

  • (String, nil) 


153
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 153

optional :birthplace, String

#country ⇒ String?

Country of residence or registration.

Returns:

  • (String, nil) 


159
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 159

optional :country, String

#email ⇒ String?

Email address of the member.

Returns:

  • (String, nil) 


165
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 165

optional :email, String

#first_name ⇒ String?

First name of the person (only if type = person).

Returns:

  • (String, nil) 


171
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 171

optional :first_name, String

#id ⇒ String?

Unique identifier for the member.

Returns:

  • (String, nil) 


135
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 135

optional :id, String

#is_beneficial_owner ⇒ Boolean?

Indicates if this member is a beneficial owner.

Returns:

  • (Boolean, nil) 


177
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 177

optional :is_beneficial_owner, Dataleon::Internal::Type::Boolean

#is_delegator ⇒ Boolean?

Indicates if this member is a delegator.

Returns:

  • (Boolean, nil) 


183
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 183

optional :is_delegator, Dataleon::Internal::Type::Boolean

#last_name ⇒ String?

Last name of the person (only if type = person).

Returns:

  • (String, nil) 


189
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 189

optional :last_name, String

#liveness_verification ⇒ Boolean?

Indicates if the member passed liveness verification.

Returns:

  • (Boolean, nil) 


195
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 195

optional :liveness_verification, Dataleon::Internal::Type::Boolean

#name ⇒ String?

Name of the company (only if type = company).

Returns:

  • (String, nil) 


201
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 201

optional :name, String

#ownership_percentage ⇒ Integer?

Ownership percentage held by the member.

Returns:

  • (Integer, nil) 


207
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 207

optional :ownership_percentage, Integer

#phone_number ⇒ String?

Phone number of the member.

Returns:

  • (String, nil) 


213
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 213

optional :phone_number, String

#postal_code ⇒ String?

Postal code of the member’s address.

Returns:

  • (String, nil) 


219
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 219

optional :postal_code, String

#registration_id ⇒ String?

Company registration number (if type = company).

Returns:

  • (String, nil) 


225
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 225

optional :registration_id, String

#relation ⇒ String?

Type of relation (e.g., shareholder, director).

Returns:

  • (String, nil) 


231
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 231

optional :relation, String

#roles ⇒ String?

Roles held by the member (e.g., legal_representative or shareholder).

Returns:

  • (String, nil) 


237
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 237

optional :roles, String

#source ⇒ String?

Source of the data (e.g., gouv, user, company).

Returns:

  • (String, nil) 


243
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 243

optional :source, String

#status ⇒ String?

Current status of the member.

Returns:

  • (String, nil) 


249
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 249

optional :status, String

#type ⇒ Symbol, ...

Type of entity (company or person).

Returns:



255
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 255

optional :type, enum: -> { Dataleon::Individuals::Kbis::Member::Type }

#workspace_id ⇒ String?

Workspace identifier for internal tracking.

Returns:

  • (String, nil) 


261
 
# File 'lib/dataleon/models/individuals/kbis.rb', line 261

optional :workspace_id, String