Module: MethodRuby::Models::EntityListParams::MethodVersion

Extended by:
Internal::Type::Enum
Defined in:
lib/method_ruby/models/entity_list_params.rb

Constant Summary collapse

METHOD_VERSION_2025_12_01 =
:"2025-12-01"

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

Instance Method Details

#initialize(method_version:, expand: nil, from_date: nil, name: nil, page: nil, page_cursor: nil, page_limit: nil, status: nil, to_date: nil, type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MethodRuby::Models::EntityListParams for more details.

Parameters:

  • method_version (Symbol, MethodRuby::Models::EntityListParams::MethodVersion)
  • expand (Array<Symbol, MethodRuby::Models::EntityListParams::Expand>) (defaults to: nil)

    Expand related entity resources inline. Supports the entity expandable fields

  • from_date (Date) (defaults to: nil)

    Filter results from this date (inclusive, YYYY-MM-DD format).

  • name (String) (defaults to: nil)

    Filter entities by their name.

  • page (Integer) (defaults to: nil)

    Page number for pagination (1-indexed).

  • page_cursor (String) (defaults to: nil)

    Cursor for cursor-based pagination. Use the value from ‘Pagination-Page-Cursor-N

  • page_limit (Integer) (defaults to: nil)

    Number of items per page.

  • status (Symbol, MethodRuby::Models::EntityListParams::Status) (defaults to: nil)

    Filter entities by status.

  • to_date (Date) (defaults to: nil)

    Filter results to this date (inclusive, YYYY-MM-DD format).

  • type (Symbol, MethodRuby::Models::EntityListParams::Type) (defaults to: nil)

    Filter entities by type.

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


97
98
99
100
101
102
103
104
# File 'lib/method_ruby/models/entity_list_params.rb', line 97

module MethodVersion
  extend MethodRuby::Internal::Type::Enum

  METHOD_VERSION_2025_12_01 = :"2025-12-01"

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