Class: Cadenya::Models::Tenants::SubjectListParams

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

Overview

See Also:

  • Cadenya::Resources::Tenants::Subjects#list

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(tenant_id:, workspace_id: nil, cursor: nil, include_info: nil, limit: nil, query: nil, sort_order: nil, request_options: {}) ⇒ Object

Parameters:

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

    Pagination cursor from previous response.

  • include_info (Boolean) (defaults to: nil) —

    When true, the info field on each returned subject is populated.

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

    Maximum number of results to return.

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

    Substring match against the subject's name and external_id.

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

    Sort order for results (asc or desc by creation time).

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



# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 51

Instance Attribute Details

#cursor ⇒ String?

Pagination cursor from previous response.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 25

optional :cursor, String

#include_info ⇒ Boolean?

When true, the info field on each returned subject is populated.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


31
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 31

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

#limit ⇒ Integer?

Maximum number of results to return.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


37
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 37

optional :limit, Integer

#query ⇒ String?

Substring match against the subject's name and external_id.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 43

optional :query, String

#sort_order ⇒ String?

Sort order for results (asc or desc by creation time).

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 49

optional :sort_order, String

#tenant_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 19

required :tenant_id, String

#workspace_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


14
 
# File 'lib/cadenya/models/tenants/subject_list_params.rb', line 14

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


57
 
# File 'sig/cadenya/models/tenants/subject_list_params.rbs', line 57

def to_hash: -> {