Class: ContextDev::Models::NewsSearchParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::NewsSearchParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/context_dev/models/news_search_params.rb,
sig/context_dev/models/news_search_params.rbs

Overview

See Also:

• ContextDev::Resources::News#search

Defined Under Namespace

Classes: FilterBy, SearchBy, SortBy

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ContextDev

Instance Attribute Summary

• #cursor ⇒ String^?

  Opaque next_cursor from the previous response, or null for the first page.

• #filter_by ⇒ ContextDev::Models::NewsSearchParams::FilterBy^?

  Optional result filters.

• #limit ⇒ Integer^?

  Maximum results to return.

• #search_by ⇒ ContextDev::Models::NewsSearchParams::SearchBy

  What to search for.

• #sort_by ⇒ ContextDev::Models::NewsSearchParams::SortBy^?

  Result ordering.

• #tags ⇒ Array<String>^?

  Optional tags for tracking usage.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/context_dev/models/news_search_params.rbs', line 42

def initialize: (

Instance Attribute Details

#cursor ⇒ String^?

Opaque next_cursor from the previous response, or null for the first page.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/context_dev/models/news_search_params.rb', line 20

optional :cursor, String, nil?: true

#filter_by ⇒ ContextDev::Models::NewsSearchParams::FilterBy^?

Optional result filters.

Returns:

• (ContextDev::Models::NewsSearchParams::FilterBy, nil)

# File 'lib/context_dev/models/news_search_params.rb', line 26

optional :filter_by, -> { ContextDev::NewsSearchParams::FilterBy }, api_name: :filterBy

#limit ⇒ Integer^?

Maximum results to return. Defaults to 10.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/context_dev/models/news_search_params.rb', line 32

optional :limit, Integer

#search_by ⇒ ContextDev::Models::NewsSearchParams::SearchBy

What to search for.

Parameters:

• value (ContextDev::NewsSearchParams::SearchBy)

Returns:

• (ContextDev::Models::NewsSearchParams::SearchBy)

# File 'lib/context_dev/models/news_search_params.rb', line 14

required :search_by, -> { ContextDev::NewsSearchParams::SearchBy }, api_name: :searchBy

#sort_by ⇒ ContextDev::Models::NewsSearchParams::SortBy^?

Result ordering. Defaults to newest.

Returns:

• (ContextDev::Models::NewsSearchParams::SortBy, nil)

# File 'lib/context_dev/models/news_search_params.rb', line 38

optional :sort_by, -> { ContextDev::NewsSearchParams::SortBy }, api_name: :sortBy

#tags ⇒ Array<String>^?

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/context_dev/models/news_search_params.rb', line 44

optional :tags, ContextDev::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/context_dev/models/news_search_params.rb', line 290

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/news_search_params.rbs', line 52

def to_hash: -> {