Module: Straddle::Models::RepresentativeListParams::Level

Extended by:

Internal::Type::Enum

Defined in:

lib/straddle/models/representative_list_params.rb,
sig/straddle/models/representative_list_params.rbs

Constant Summary

ACCOUNT =

Returns:

• (:account)

:account

PLATFORM =

Returns:

• (:platform)

:platform

Instance Method Summary

• #initialize(account_id: nil, level: nil, organization_id: nil, page_number: nil, page_size: nil, platform_id: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {}) ⇒ Object
• #self?.values ⇒ ::Array[Straddle::Models::RepresentativeListParams::level]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(account_id: nil, level: nil, organization_id: nil, page_number: nil, page_size: nil, platform_id: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {}) ⇒ Object

Parameters:

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

  Account ID used to filter the results.

• level (Symbol, Straddle::Models::RepresentativeListParams::Level) (defaults to: nil) —

  Scope of representatives to return.

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

  Organization ID used to filter the results.

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

  Page number. Defaults to 1.

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

  Number of results per page. Defaults to 100. Maximum 1000.

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

  Platform ID used to filter the results.

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

  Field used to sort results. Defaults to id.

• sort_order (Symbol, Straddle::Models::RepresentativeListParams::SortOrder) (defaults to: nil) —

  Sort direction. Defaults to asc.

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

  Optional client-generated identifier for tracing a series of related requests.

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

  Optional client-generated identifier for tracing one request.

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

# File 'lib/straddle/models/representative_list_params.rb', line 93

module Level
  extend Straddle::Internal::Type::Enum

  ACCOUNT = :account
  PLATFORM = :platform

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Straddle::Models::RepresentativeListParams::level]

Returns:

• (::Array[Straddle::Models::RepresentativeListParams::level])

# File 'sig/straddle/models/representative_list_params.rbs', line 102

def self?.values: -> ::Array[Straddle::Models::RepresentativeListParams::level]