Module: Straddle::Models::OrganizationListParams::SortOrder

Extended by:
Internal::Type::Enum
Defined in:
lib/straddle/models/organization_list_params.rb,
sig/straddle/models/organization_list_params.rbs

Constant Summary collapse

ASC =

Returns:

  • (:asc) 
:asc
DESC =

Returns:

  • (:desc) 
:desc

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, 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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/straddle/models/organization_list_params.rb', line 83

Instance Method Details

#initialize(external_id: nil, name: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {}) ⇒ Object

Parameters:

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

    Your external ID for the organization.

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

    Organization name. Supports partial matches.

  • 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.

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

    Field used to sort results. Defaults to id.

  • sort_order (Symbol, Straddle::Models::OrganizationListParams::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: {}) 


77
78
79
80
81
82
83
84
85
 
# File 'lib/straddle/models/organization_list_params.rb', line 77

module SortOrder
  extend Straddle::Internal::Type::Enum

  ASC = :asc
  DESC = :desc

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

#self?.values ⇒ ::Array[Straddle::Models::OrganizationListParams::sort_order]

Returns:

  • (::Array[Straddle::Models::OrganizationListParams::sort_order]) 


86
 
# File 'sig/straddle/models/organization_list_params.rbs', line 86

def self?.values: -> ::Array[Straddle::Models::OrganizationListParams::sort_order]