Class: Dataleon::Resources::Individuals::Documents

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Documents

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 Documents.

Parameters:



59
60
61
 
# File 'lib/dataleon/resources/individuals/documents.rb', line 59

def initialize(client:)
  @client = client
end

Instance Method Details

#list(individual_id, request_options: {}) ⇒ Dataleon::Models::Individuals::DocumentResponse

Get documents to an individuals

Parameters:

  • individual_id (String) —

    ID of the individual to upload document

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

Returns:

See Also:



18
19
20
21
22
23
24
25
 
# File 'lib/dataleon/resources/individuals/documents.rb', line 18

def list(individual_id, params = {})
  @client.request(
    method: :get,
    path: ["individuals/%1$s/documents", individual_id],
    model: Dataleon::Individuals::DocumentResponse,
    options: params[:request_options]
  )
end

#upload(individual_id, document_type:, file: nil, url: nil, request_options: {}) ⇒ Dataleon::Models::Individuals::GenericDocument

Upload documents to an individual

Parameters:

Returns:

See Also:



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/dataleon/resources/individuals/documents.rb', line 44

def upload(individual_id, params)
  parsed, options = Dataleon::Individuals::DocumentUploadParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["individuals/%1$s/documents", individual_id],
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: Dataleon::Individuals::GenericDocument,
    options: options
  )
end