Class: Spotted::Models::Me::TopListTopTracksParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Spotted::Models::Me::TopListTopTracksParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/spotted/models/me/top_list_top_tracks_params.rb

Overview

See Also:

• Resources::Me::Top#list_top_tracks

Instance Attribute Summary

• #limit ⇒ Integer^?

  The maximum number of items to return.

• #offset ⇒ Integer^?

  The index of the first item to return.

• #time_range ⇒ String^?

  Over what time frame the affinities are computed.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, offset: nil, time_range: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see TopListTopTracksParams for more details.

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(limit: nil, offset: nil, time_range: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::Me::TopListTopTracksParams for more details.

Parameters:

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

  The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

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

  The index of the first item to return. Default: 0 (the first item). Use with lim

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

  Over what time frame the affinities are computed. Valid values: ‘long_term` (cal

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

# File 'lib/spotted/models/me/top_list_top_tracks_params.rb', line 33

Instance Attribute Details

#limit ⇒ Integer^?

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Returns:

• (Integer, nil)

# File 'lib/spotted/models/me/top_list_top_tracks_params.rb', line 15

optional :limit, Integer

#offset ⇒ Integer^?

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Returns:

• (Integer, nil)

# File 'lib/spotted/models/me/top_list_top_tracks_params.rb', line 22

optional :offset, Integer

#time_range ⇒ String^?

Over what time frame the affinities are computed. Valid values: ‘long_term` (calculated from ~1 year of data and including all new data as it becomes available), `medium_term` (approximately last 6 months), `short_term` (approximately last 4 weeks). Default: `medium_term`

Returns:

• (String, nil)

# File 'lib/spotted/models/me/top_list_top_tracks_params.rb', line 31

optional :time_range, String