Class: WhopSDK::Models::SupportChannelListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/support_channel_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Order, View

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(after: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, open_: nil, order: nil, view: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::SupportChannelListParams for more details.

Parameters:

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

    Returns the elements in the list that come after the specified cursor.

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

    Returns the elements in the list that come before the specified cursor.

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

    The unique identifier of the company to list support channels for. Includes chan

  • direction (Symbol, WhopSDK::Models::Direction, nil) (defaults to: nil) —

    The direction of the sort.

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

    Returns the first n elements from the list.

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

    Returns the last n elements from the list.

  • open_ (Boolean, nil) (defaults to: nil) —

    Whether to filter by open or resolved support channels. Set to true to only retu

  • order (Symbol, WhopSDK::Models::SupportChannelListParams::Order, nil) (defaults to: nil) —

    Sort options for message channels

  • view (Symbol, WhopSDK::Models::SupportChannelListParams::View, nil) (defaults to: nil) —

    The perspective to filter support channels by.

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



# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 67

Instance Attribute Details

#after ⇒ String?

Returns the elements in the list that come after the specified cursor.

Returns:

  • (String, nil) 


14
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 14

optional :after, String, nil?: true

#before ⇒ String?

Returns the elements in the list that come before the specified cursor.

Returns:

  • (String, nil) 


20
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 20

optional :before, String, nil?: true

#company_id ⇒ String?

The unique identifier of the company to list support channels for. Includes channels of child companies. When omitted, returns support channels across all companies the user has access to.

Returns:

  • (String, nil) 


28
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 28

optional :company_id, String, nil?: true

#direction ⇒ Symbol, ...

The direction of the sort.

Returns:



34
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 34

optional :direction, enum: -> { WhopSDK::Direction }, nil?: true

#first ⇒ Integer?

Returns the first n elements from the list.

Returns:

  • (Integer, nil) 


40
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 40

optional :first, Integer, nil?: true

#last ⇒ Integer?

Returns the last n elements from the list.

Returns:

  • (Integer, nil) 


46
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 46

optional :last, Integer, nil?: true

#open_ ⇒ Boolean?

Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels.

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 53

optional :open_, WhopSDK::Internal::Type::Boolean, nil?: true

#order ⇒ Symbol, ...

Sort options for message channels

Returns:



59
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 59

optional :order, enum: -> { WhopSDK::SupportChannelListParams::Order }, nil?: true

#view ⇒ Symbol, ...

The perspective to filter support channels by.

Returns:



65
 
# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 65

optional :view, enum: -> { WhopSDK::SupportChannelListParams::View }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/support_channel_list_params.rb', line 98