Class: Dataleon::Models::IndividualCreateParams::Person

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

Defined Under Namespace

Modules: Gender

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(birthday: nil, email: nil, first_name: nil, gender: nil, last_name: nil, maiden_name: nil, nationality: nil, phone_number: nil) ⇒ Object

Personal information about the individual.

Parameters:

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

    Date of birth in DD/MM/YYYY format.

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

    Email address of the individual.

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

    First name of the individual.

  • gender (Symbol, Dataleon::Models::IndividualCreateParams::Person::Gender) (defaults to: nil) —

    Gender of the individual (M for male, F for female).

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

    Last name (family name) of the individual.

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

    Maiden name, if applicable.

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

    Nationality of the individual (ISO 3166-1 alpha-3 country code).

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

    Phone number of the individual.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/dataleon/models/individual_create_params.rb', line 49

class Person < Dataleon::Internal::Type::BaseModel
  # @!attribute birthday
  #   Date of birth in DD/MM/YYYY format.
  #
  #   @return [String, nil]
  optional :birthday, String

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

  # @!attribute first_name
  #   First name of the individual.
  #
  #   @return [String, nil]
  optional :first_name, String

  # @!attribute gender
  #   Gender of the individual (M for male, F for female).
  #
  #   @return [Symbol, Dataleon::Models::IndividualCreateParams::Person::Gender, nil]
  optional :gender, enum: -> { Dataleon::IndividualCreateParams::Person::Gender }

  # @!attribute last_name
  #   Last name (family name) of the individual.
  #
  #   @return [String, nil]
  optional :last_name, String

  # @!attribute maiden_name
  #   Maiden name, if applicable.
  #
  #   @return [String, nil]
  optional :maiden_name, String

  # @!attribute nationality
  #   Nationality of the individual (ISO 3166-1 alpha-3 country code).
  #
  #   @return [String, nil]
  optional :nationality, String

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

  # @!method initialize(birthday: nil, email: nil, first_name: nil, gender: nil, last_name: nil, maiden_name: nil, nationality: nil, phone_number: nil)
  #   Personal information about the individual.
  #
  #   @param birthday [String] Date of birth in DD/MM/YYYY format.
  #
  #   @param email [String] Email address of the individual.
  #
  #   @param first_name [String] First name of the individual.
  #
  #   @param gender [Symbol, Dataleon::Models::IndividualCreateParams::Person::Gender] Gender of the individual (M for male, F for female).
  #
  #   @param last_name [String] Last name (family name) of the individual.
  #
  #   @param maiden_name [String] Maiden name, if applicable.
  #
  #   @param nationality [String] Nationality of the individual (ISO 3166-1 alpha-3 country code).
  #
  #   @param phone_number [String] Phone number of the individual.

  # Gender of the individual (M for male, F for female).
  #
  # @see Dataleon::Models::IndividualCreateParams::Person#gender
  module Gender
    extend Dataleon::Internal::Type::Enum

    M = :M
    F = :F

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

Instance Attribute Details

#birthday ⇒ String?

Date of birth in DD/MM/YYYY format.

Returns:

  • (String, nil) 


54
 
# File 'lib/dataleon/models/individual_create_params.rb', line 54

optional :birthday, String

#email ⇒ String?

Email address of the individual.

Returns:

  • (String, nil) 


60
 
# File 'lib/dataleon/models/individual_create_params.rb', line 60

optional :email, String

#first_name ⇒ String?

First name of the individual.

Returns:

  • (String, nil) 


66
 
# File 'lib/dataleon/models/individual_create_params.rb', line 66

optional :first_name, String

#gender ⇒ Symbol, ...

Gender of the individual (M for male, F for female).

Returns:



72
 
# File 'lib/dataleon/models/individual_create_params.rb', line 72

optional :gender, enum: -> { Dataleon::IndividualCreateParams::Person::Gender }

#last_name ⇒ String?

Last name (family name) of the individual.

Returns:

  • (String, nil) 


78
 
# File 'lib/dataleon/models/individual_create_params.rb', line 78

optional :last_name, String

#maiden_name ⇒ String?

Maiden name, if applicable.

Returns:

  • (String, nil) 


84
 
# File 'lib/dataleon/models/individual_create_params.rb', line 84

optional :maiden_name, String

#nationality ⇒ String?

Nationality of the individual (ISO 3166-1 alpha-3 country code).

Returns:

  • (String, nil) 


90
 
# File 'lib/dataleon/models/individual_create_params.rb', line 90

optional :nationality, String

#phone_number ⇒ String?

Phone number of the individual.

Returns:

  • (String, nil) 


96
 
# File 'lib/dataleon/models/individual_create_params.rb', line 96

optional :phone_number, String