Class: Trycourier::Models::TenantListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/trycourier/models/tenant_list_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(cursor: nil, limit: nil, parent_tenant_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::TenantListParams for more details.

Parameters:

  • cursor (String, nil) (defaults to: nil) —

    Continue the pagination with the next cursor

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

    The number of tenants to return

  • parent_tenant_id (String, nil) (defaults to: nil) —

    Filter the list of tenants by parent_id

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



# File 'lib/trycourier/models/tenant_list_params.rb', line 28

Instance Attribute Details

#cursor ⇒ String?

Continue the pagination with the next cursor

Returns:

  • (String, nil) 


14
 
# File 'lib/trycourier/models/tenant_list_params.rb', line 14

optional :cursor, String, nil?: true

#limit ⇒ Integer?

The number of tenants to return (defaults to 20, maximum value of 100)

Returns:

  • (Integer, nil) 


20
 
# File 'lib/trycourier/models/tenant_list_params.rb', line 20

optional :limit, Integer, nil?: true

#parent_tenant_id ⇒ String?

Filter the list of tenants by parent_id

Returns:

  • (String, nil) 


26
 
# File 'lib/trycourier/models/tenant_list_params.rb', line 26

optional :parent_tenant_id, String, nil?: true