Class: Cadenya::Models::TenantRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cadenya/models/tenant_retrieve_params.rb,
sig/cadenya/models/tenant_retrieve_params.rbs

Overview

See Also:

  • Cadenya::Resources::Tenants#retrieve

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(id:, workspace_id: nil, include_info: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • workspace_id (String) (defaults to: nil)
  • include_info (Boolean) (defaults to: nil) —

    When true, the info field is populated.

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



# File 'lib/cadenya/models/tenant_retrieve_params.rb', line 26

Instance Attribute Details

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/cadenya/models/tenant_retrieve_params.rb', line 18

required :id, String

#include_info ⇒ Boolean?

When true, the info field is populated.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


24
 
# File 'lib/cadenya/models/tenant_retrieve_params.rb', line 24

optional :include_info, Cadenya::Internal::Type::Boolean

#workspace_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


13
 
# File 'lib/cadenya/models/tenant_retrieve_params.rb', line 13

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/cadenya/models/tenant_retrieve_params.rbs', line 28

def to_hash: -> {