Class: Dataleon::Models::Individuals::DocumentUploadParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dataleon::Models::Individuals::DocumentUploadParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dataleon/models/individuals/document_upload_params.rb

Overview

See Also:

• Resources::Individuals::Documents#upload

Defined Under Namespace

Modules: DocumentType

Instance Attribute Summary

• #document_type ⇒ Symbol, Dataleon::Models::Individuals::DocumentUploadParams::DocumentType

  Filter by document type for upload (must be one of the allowed values).

• #file ⇒ Pathname, ...

  File to upload (required).

• #individual_id ⇒ String
• #url ⇒ String^?

  URL of the file to upload (either ‘file` or `url` is required).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(individual_id:, document_type:, file: nil, url: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(individual_id:, document_type:, file: nil, url: nil, request_options: {}) ⇒ Object

Parameters:

• individual_id (String)
• document_type (Symbol, Dataleon::Models::Individuals::DocumentUploadParams::DocumentType) —

  Filter by document type for upload (must be one of the allowed values)

• file (Pathname, StringIO, IO, String, Dataleon::FilePart) (defaults to: nil) —

  File to upload (required)

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

  URL of the file to upload (either ‘file` or `url` is required)

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

# File 'lib/dataleon/models/individuals/document_upload_params.rb', line 34

Instance Attribute Details

#document_type ⇒ Symbol, Dataleon::Models::Individuals::DocumentUploadParams::DocumentType

Filter by document type for upload (must be one of the allowed values)

Returns:

• (Symbol, Dataleon::Models::Individuals::DocumentUploadParams::DocumentType)

# File 'lib/dataleon/models/individuals/document_upload_params.rb', line 20

required :document_type, enum: -> { Dataleon::Individuals::DocumentUploadParams::DocumentType }

#file ⇒ Pathname, ...

File to upload (required)

Returns:

• (Pathname, StringIO, IO, String, Dataleon::FilePart, nil)

# File 'lib/dataleon/models/individuals/document_upload_params.rb', line 26

optional :file, Dataleon::Internal::Type::FileInput

#individual_id ⇒ String

Returns:

• (String)

# File 'lib/dataleon/models/individuals/document_upload_params.rb', line 14

required :individual_id, String

#url ⇒ String^?

URL of the file to upload (either ‘file` or `url` is required)

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/document_upload_params.rb', line 32

optional :url, String