Class: MethodRuby::Models::EntityRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::EntityRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/entity_retrieve_params.rb,
sig/method_ruby/models/entity_retrieve_params.rbs

Overview

See Also:

• MethodRuby::Resources::Entities#retrieve

Defined Under Namespace

Modules: Expand, MethodVersion

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::MethodRuby

Instance Attribute Summary

• #entity_id ⇒ String
• #expand ⇒ Array<Symbol, MethodRuby::Models::EntityRetrieveParams::Expand>^?

  Expand related entity resources inline.

• #method_version ⇒ Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/method_ruby/models/entity_retrieve_params.rbs', line 25

def initialize: (

Instance Attribute Details

#entity_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/method_ruby/models/entity_retrieve_params.rb', line 13

required :entity_id, String

#expand ⇒ Array<Symbol, MethodRuby::Models::EntityRetrieveParams::Expand>^?

Expand related entity resources inline. Supports the entity expandable fields documented by the API validator for entity list and retrieve operations.

Returns:

• (Array<Symbol, MethodRuby::Models::EntityRetrieveParams::Expand>, nil)

# File 'lib/method_ruby/models/entity_retrieve_params.rb', line 25

optional :expand,
-> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::EntityRetrieveParams::Expand] }

#method_version ⇒ Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion

Parameters:

• value (MethodRuby::Models::EntityRetrieveParams::method_version)

Returns:

• (Symbol, MethodRuby::Models::EntityRetrieveParams::MethodVersion)

# File 'lib/method_ruby/models/entity_retrieve_params.rb', line 18

required :method_version, enum: -> { MethodRuby::EntityRetrieveParams::MethodVersion }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/entity_retrieve_params.rb', line 45

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/method_ruby/models/entity_retrieve_params.rbs', line 32

def to_hash: -> {