Class: FinchAPI::Models::Jobs::ManualRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/finch_api/models/jobs/manual_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(entity_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::Jobs::ManualRetrieveParams for more details.

Parameters:

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

    The entity ID to use when authenticating with a multi-account token. Required wh

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



# File 'lib/finch_api/models/jobs/manual_retrieve_params.rb', line 19

Instance Attribute Details

#entity_id ⇒ String?

The entity ID to use when authenticating with a multi-account token. Required when using a multi-account token to specify which entity’s data to access. Example: ‘123e4567-e89b-12d3-a456-426614174000`

Returns:

  • (String, nil) 


17
 
# File 'lib/finch_api/models/jobs/manual_retrieve_params.rb', line 17

optional :entity_id, String