Class: Trycourier::Models::TenantListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/tenant_list_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

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(has_more: , items: , type: , url: , cursor: nil, next_url: nil) ⇒ Object

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

Parameters:

  • has_more (Boolean) (defaults to: ) —

    Set to true when there are more pages that can be retrieved.

  • items (Array<Trycourier::Models::Tenant>) (defaults to: ) —

    An array of Tenants

  • type (Symbol, Trycourier::Models::TenantListResponse::Type) (defaults to: ) —

    Always set to “list”. Represents the type of this object.

  • url (String) (defaults to: ) —

    A url that may be used to generate these results.

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

    A pointer to the next page of results. Defined only when has_more is set to true

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

    A url that may be used to generate fetch the next set of results.




# File 'lib/trycourier/models/tenant_list_response.rb', line 45

Instance Attribute Details

#cursor ⇒ String?

A pointer to the next page of results. Defined only when has_more is set to true.

Returns:

  • (String, nil) 


36
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 36

optional :cursor, String, nil?: true

#has_more ⇒ Boolean

Set to true when there are more pages that can be retrieved.

Returns:

  • (Boolean) 


11
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 11

required :has_more, Trycourier::Internal::Type::Boolean

#items ⇒ Array<Trycourier::Models::Tenant>

An array of Tenants

Returns:



17
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 17

required :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Tenant] }

#next_url ⇒ String?

A url that may be used to generate fetch the next set of results. Defined only when has_more is set to true

Returns:

  • (String, nil) 


43
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 43

optional :next_url, String, nil?: true

#type ⇒ Symbol, Trycourier::Models::TenantListResponse::Type

Always set to “list”. Represents the type of this object.

Returns:



23
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 23

required :type, enum: -> { Trycourier::Models::TenantListResponse::Type }

#url ⇒ String

A url that may be used to generate these results.

Returns:

  • (String) 


29
 
# File 'lib/trycourier/models/tenant_list_response.rb', line 29

required :url, String