Class: Dataleon::Models::CompanyRetrieveParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(company_id:, document: nil, scope: nil, request_options: {}) ⇒ Object

Parameters:

  • company_id (String)
  • document (Boolean) (defaults to: nil) —

    Include document signed url

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

    Scope filter (id or scope)

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



# File 'lib/dataleon/models/company_retrieve_params.rb', line 27

Instance Attribute Details

#company_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/dataleon/models/company_retrieve_params.rb', line 13

required :company_id, String

#document ⇒ Boolean?

Include document signed url

Returns:

  • (Boolean, nil) 


19
 
# File 'lib/dataleon/models/company_retrieve_params.rb', line 19

optional :document, Dataleon::Internal::Type::Boolean

#scope ⇒ String?

Scope filter (id or scope)

Returns:

  • (String, nil) 


25
 
# File 'lib/dataleon/models/company_retrieve_params.rb', line 25

optional :scope, String