Class: Spotted::Models::Playlists::TrackUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/spotted/models/playlists/track_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(body_uris: nil, insert_before: nil, range_length: nil, range_start: nil, snapshot_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::Playlists::TrackUpdateParams for more details.

Parameters:

  • body_uris (Array<String>) (defaults to: nil)
  • insert_before (Integer) (defaults to: nil) —

    The position where the items should be inserted.<br/>To reorder the items to the

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

    The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of

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

    The position of the first item to be reordered.

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

    The playlist’s snapshot ID against which you want to make the changes.

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



# File 'lib/spotted/models/playlists/track_update_params.rb', line 49

Instance Attribute Details

#body_uris ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


14
 
# File 'lib/spotted/models/playlists/track_update_params.rb', line 14

optional :body_uris, Spotted::Internal::Type::ArrayOf[String], api_name: :uris

#insert_before ⇒ Integer?

The position where the items should be inserted.<br/>To reorder the items to the end of the playlist, simply set insert_before to the position after the last item.<br/>Examples:<br/>To reorder the first item to the last position in a playlist with 10 items, set range_start to 0, and insert_before to 10.<br/>To reorder the last item in a playlist with 10 items to the start of the playlist, set range_start to 9, and insert_before to 0.

Returns:

  • (Integer, nil) 


25
 
# File 'lib/spotted/models/playlists/track_update_params.rb', line 25

optional :insert_before, Integer

#range_length ⇒ Integer?

The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of items to be reordered begins from the range_start position, and includes the range_length subsequent items.<br/>Example:<br/>To move the items at index 9-10 to the start of the playlist, range_start is set to 9, and range_length is set to 2.

Returns:

  • (Integer, nil) 


35
 
# File 'lib/spotted/models/playlists/track_update_params.rb', line 35

optional :range_length, Integer

#range_start ⇒ Integer?

The position of the first item to be reordered.

Returns:

  • (Integer, nil) 


41
 
# File 'lib/spotted/models/playlists/track_update_params.rb', line 41

optional :range_start, Integer

#snapshot_id ⇒ String?

The playlist’s snapshot ID against which you want to make the changes.

Returns:

  • (String, nil) 


47
 
# File 'lib/spotted/models/playlists/track_update_params.rb', line 47

optional :snapshot_id, String