Class: Dataleon::Models::IndividualListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dataleon/models/individual_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: State, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(end_date: nil, limit: nil, offset: nil, source_id: nil, start_date: nil, state: nil, status: nil, workspace_id: nil, request_options: {}) ⇒ Object

Parameters:

  • end_date (Date) (defaults to: nil) —

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

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

    Number of results to return (between 1 and 100)

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

    Number of results to offset (must be ≥ 0)

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

    Filter by source ID

  • start_date (Date) (defaults to: nil) —

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

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

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

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

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

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

    Filter by workspace ID

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



# File 'lib/dataleon/models/individual_list_params.rb', line 58

Instance Attribute Details

#end_date ⇒ Date?

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

Returns:

  • (Date, nil) 


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

optional :end_date, Date

#limit ⇒ Integer?

Number of results to return (between 1 and 100)

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#offset ⇒ Integer?

Number of results to offset (must be ≥ 0)

Returns:

  • (Integer, nil) 


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

optional :offset, Integer

#source_id ⇒ String?

Filter by source ID

Returns:

  • (String, nil) 


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

optional :source_id, String

#start_date ⇒ Date?

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

Returns:

  • (Date, nil) 


38
 
# File 'lib/dataleon/models/individual_list_params.rb', line 38

optional :start_date, Date

#state ⇒ Symbol, ...

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

Returns:



44
 
# File 'lib/dataleon/models/individual_list_params.rb', line 44

optional :state, enum: -> { Dataleon::IndividualListParams::State }

#status ⇒ Symbol, ...

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

Returns:



50
 
# File 'lib/dataleon/models/individual_list_params.rb', line 50

optional :status, enum: -> { Dataleon::IndividualListParams::Status }

#workspace_id ⇒ String?

Filter by workspace ID

Returns:

  • (String, nil) 


56
 
# File 'lib/dataleon/models/individual_list_params.rb', line 56

optional :workspace_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/dataleon/models/individual_list_params.rb', line 91