Class: Dataleon::Resources::Individuals

Inherits:
Object
  • Object
show all
Defined in:
lib/dataleon/resources/individuals.rb,
lib/dataleon/resources/individuals/documents.rb

Defined Under Namespace

Classes: Documents

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Individuals

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Individuals.

Parameters:



160
161
162
163
 
# File 'lib/dataleon/resources/individuals.rb', line 160

def initialize(client:)
  @client = client
  @documents = Dataleon::Resources::Individuals::Documents.new(client: client)
end

Instance Attribute Details

#documents ⇒ Dataleon::Resources::Individuals::Documents (readonly)

Returns:



7
8
9
 
# File 'lib/dataleon/resources/individuals.rb', line 7

def documents
  @documents
end

Instance Method Details

#create(workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {}) ⇒ Dataleon::Models::Individual

Some parameter documentations has been truncated, see Models::IndividualCreateParams for more details.

Create a new individual

Parameters:

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/dataleon/resources/individuals.rb', line 29

def create(params)
  parsed, options = Dataleon::IndividualCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "individuals",
    body: parsed,
    model: Dataleon::Individual,
    options: options
  )
end

#delete(individual_id, request_options: {}) ⇒ nil

Delete an individual by ID

Parameters:

  • individual_id (String) —

    ID of the individual to delete

  • request_options (Dataleon::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



148
149
150
151
152
153
154
155
 
# File 'lib/dataleon/resources/individuals.rb', line 148

def delete(individual_id, params = {})
  @client.request(
    method: :delete,
    path: ["individuals/%1$s", individual_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(end_date: nil, limit: nil, offset: nil, source_id: nil, start_date: nil, state: nil, status: nil, workspace_id: nil, request_options: {}) ⇒ Array<Dataleon::Models::Individual>

Get all individuals

Parameters:

  • end_date (Date) —

    Filter individuals created before this date (format YYYY-MM-DD)

  • limit (Integer) —

    Number of results to return (between 1 and 100)

  • offset (Integer) —

    Number of results to offset (must be ≥ 0)

  • source_id (String) —

    Filter by source ID

  • start_date (Date) —

    Filter individuals created after this date (format YYYY-MM-DD)

  • state (Symbol, Dataleon::Models::IndividualListParams::State) —

    Filter by individual status (must be one of the allowed values)

  • status (Symbol, Dataleon::Models::IndividualListParams::Status) —

    Filter by individual status (must be one of the allowed values)

  • workspace_id (String) —

    Filter by workspace ID

  • request_options (Dataleon::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/dataleon/resources/individuals.rb', line 125

def list(params = {})
  parsed, options = Dataleon::IndividualListParams.dump_request(params)
  query = Dataleon::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "individuals",
    query: query,
    model: Dataleon::Internal::Type::ArrayOf[Dataleon::Individual],
    options: options
  )
end

#retrieve(individual_id, document: nil, scope: nil, request_options: {}) ⇒ Dataleon::Models::Individual

Get an individual by ID

Parameters:

  • individual_id (String) —

    ID of the individual

  • document (Boolean) —

    Include document information

  • scope (String) —

    Scope filter (id or scope)

  • request_options (Dataleon::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/dataleon/resources/individuals.rb', line 55

def retrieve(individual_id, params = {})
  parsed, options = Dataleon::IndividualRetrieveParams.dump_request(params)
  query = Dataleon::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["individuals/%1$s", individual_id],
    query: query,
    model: Dataleon::Individual,
    options: options
  )
end

#update(individual_id, workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {}) ⇒ Dataleon::Models::Individual

Some parameter documentations has been truncated, see Models::IndividualUpdateParams for more details.

Update an individual by ID

Parameters:

Returns:

See Also:



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/dataleon/resources/individuals.rb', line 89

def update(individual_id, params)
  parsed, options = Dataleon::IndividualUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["individuals/%1$s", individual_id],
    body: parsed,
    model: Dataleon::Individual,
    options: options
  )
end