spotted 0.1.0

data/lib/spotted/models/me/player_get_devices_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#get_devices
+      class PlayerGetDevicesResponse < Spotted::Internal::Type::BaseModel
+        # @!attribute devices
+        #
+        #   @return [Array<Spotted::Models::Me::DeviceObject>]
+        required :devices, -> { Spotted::Internal::Type::ArrayOf[Spotted::Me::DeviceObject] }
+
+        # @!method initialize(devices:)
+        #   @param devices [Array<Spotted::Models::Me::DeviceObject>]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_get_state_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#get_state
+      class PlayerGetStateParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute additional_types
+        #   A comma-separated list of item types that your client supports besides the
+        #   default `track` type. Valid types are: `track` and `episode`.<br/> _**Note**:
+        #   This parameter was introduced to allow existing clients to maintain their
+        #   current behaviour and might be deprecated in the future._<br/> In addition to
+        #   providing this parameter, make sure that your client properly handles cases of
+        #   new types in the future by checking against the `type` field of each object.
+        #
+        #   @return [String, nil]
+        optional :additional_types, String
+
+        # @!attribute market
+        #   An
+        #   [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+        #   If a country code is specified, only content that is available in that market
+        #   will be returned.<br/> If a valid user access token is specified in the request
+        #   header, the country associated with the user account will take priority over
+        #   this parameter.<br/> _**Note**: If neither market or user country are provided,
+        #   the content is considered unavailable for the client._<br/> Users can view the
+        #   country that is associated with their account in the
+        #   [account settings](https://www.spotify.com/account/overview/).
+        #
+        #   @return [String, nil]
+        optional :market, String
+
+        # @!method initialize(additional_types: nil, market: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerGetStateParams} for more details.
+        #
+        #   @param additional_types [String] A comma-separated list of item types that your client supports besides the defau
+        #
+        #   @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_get_state_response.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#get_state
+      class PlayerGetStateResponse < Spotted::Internal::Type::BaseModel
+        # @!attribute actions
+        #   Allows to update the user interface based on which playback actions are
+        #   available within the current context.
+        #
+        #   @return [Spotted::Models::Me::PlayerGetStateResponse::Actions, nil]
+        optional :actions, -> { Spotted::Models::Me::PlayerGetStateResponse::Actions }
+
+        # @!attribute context
+        #   A Context Object. Can be `null`.
+        #
+        #   @return [Spotted::Models::Me::ContextObject, nil]
+        optional :context, -> { Spotted::Me::ContextObject }
+
+        # @!attribute currently_playing_type
+        #   The object type of the currently playing item. Can be one of `track`, `episode`,
+        #   `ad` or `unknown`.
+        #
+        #   @return [String, nil]
+        optional :currently_playing_type, String
+
+        # @!attribute device
+        #   The device that is currently active.
+        #
+        #   @return [Spotted::Models::Me::DeviceObject, nil]
+        optional :device, -> { Spotted::Me::DeviceObject }
+
+        # @!attribute is_playing
+        #   If something is currently playing, return `true`.
+        #
+        #   @return [Boolean, nil]
+        optional :is_playing, Spotted::Internal::Type::Boolean
+
+        # @!attribute item
+        #   The currently playing track or episode. Can be `null`.
+        #
+        #   @return [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject, nil]
+        optional :item, union: -> { Spotted::Models::Me::PlayerGetStateResponse::Item }
+
+        # @!attribute progress_ms
+        #   Progress into the currently playing track or episode. Can be `null`.
+        #
+        #   @return [Integer, nil]
+        optional :progress_ms, Integer
+
+        # @!attribute repeat_state
+        #   off, track, context
+        #
+        #   @return [String, nil]
+        optional :repeat_state, String
+
+        # @!attribute shuffle_state
+        #   If shuffle is on or off.
+        #
+        #   @return [Boolean, nil]
+        optional :shuffle_state, Spotted::Internal::Type::Boolean
+
+        # @!attribute timestamp
+        #   Unix Millisecond Timestamp when playback state was last changed (play, pause,
+        #   skip, scrub, new song, etc.).
+        #
+        #   @return [Integer, nil]
+        optional :timestamp, Integer
+
+        # @!method initialize(actions: nil, context: nil, currently_playing_type: nil, device: nil, is_playing: nil, item: nil, progress_ms: nil, repeat_state: nil, shuffle_state: nil, timestamp: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerGetStateResponse} for more details.
+        #
+        #   @param actions [Spotted::Models::Me::PlayerGetStateResponse::Actions] Allows to update the user interface based on which playback actions are availabl
+        #
+        #   @param context [Spotted::Models::Me::ContextObject] A Context Object. Can be `null`.
+        #
+        #   @param currently_playing_type [String] The object type of the currently playing item. Can be one of `track`, `episode`,
+        #
+        #   @param device [Spotted::Models::Me::DeviceObject] The device that is currently active.
+        #
+        #   @param is_playing [Boolean] If something is currently playing, return `true`.
+        #
+        #   @param item [Spotted::Models::TrackObject, Spotted::Models::EpisodeObject] The currently playing track or episode. Can be `null`.
+        #
+        #   @param progress_ms [Integer] Progress into the currently playing track or episode. Can be `null`.
+        #
+        #   @param repeat_state [String] off, track, context
+        #
+        #   @param shuffle_state [Boolean] If shuffle is on or off.
+        #
+        #   @param timestamp [Integer] Unix Millisecond Timestamp when playback state was last changed (play, pause, sk
+
+        # @see Spotted::Models::Me::PlayerGetStateResponse#actions
+        class Actions < Spotted::Internal::Type::BaseModel
+          # @!attribute interrupting_playback
+          #   Interrupting playback. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :interrupting_playback, Spotted::Internal::Type::Boolean
+
+          # @!attribute pausing
+          #   Pausing. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :pausing, Spotted::Internal::Type::Boolean
+
+          # @!attribute resuming
+          #   Resuming. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :resuming, Spotted::Internal::Type::Boolean
+
+          # @!attribute seeking
+          #   Seeking playback location. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :seeking, Spotted::Internal::Type::Boolean
+
+          # @!attribute skipping_next
+          #   Skipping to the next context. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :skipping_next, Spotted::Internal::Type::Boolean
+
+          # @!attribute skipping_prev
+          #   Skipping to the previous context. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :skipping_prev, Spotted::Internal::Type::Boolean
+
+          # @!attribute toggling_repeat_context
+          #   Toggling repeat context flag. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :toggling_repeat_context, Spotted::Internal::Type::Boolean
+
+          # @!attribute toggling_repeat_track
+          #   Toggling repeat track flag. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :toggling_repeat_track, Spotted::Internal::Type::Boolean
+
+          # @!attribute toggling_shuffle
+          #   Toggling shuffle flag. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :toggling_shuffle, Spotted::Internal::Type::Boolean
+
+          # @!attribute transferring_playback
+          #   Transfering playback between devices. Optional field.
+          #
+          #   @return [Boolean, nil]
+          optional :transferring_playback, Spotted::Internal::Type::Boolean
+
+          # @!method initialize(interrupting_playback: nil, pausing: nil, resuming: nil, seeking: nil, skipping_next: nil, skipping_prev: nil, toggling_repeat_context: nil, toggling_repeat_track: nil, toggling_shuffle: nil, transferring_playback: nil)
+          #   Allows to update the user interface based on which playback actions are
+          #   available within the current context.
+          #
+          #   @param interrupting_playback [Boolean] Interrupting playback. Optional field.
+          #
+          #   @param pausing [Boolean] Pausing. Optional field.
+          #
+          #   @param resuming [Boolean] Resuming. Optional field.
+          #
+          #   @param seeking [Boolean] Seeking playback location. Optional field.
+          #
+          #   @param skipping_next [Boolean] Skipping to the next context. Optional field.
+          #
+          #   @param skipping_prev [Boolean] Skipping to the previous context. Optional field.
+          #
+          #   @param toggling_repeat_context [Boolean] Toggling repeat context flag. Optional field.
+          #
+          #   @param toggling_repeat_track [Boolean] Toggling repeat track flag. Optional field.
+          #
+          #   @param toggling_shuffle [Boolean] Toggling shuffle flag. Optional field.
+          #
+          #   @param transferring_playback [Boolean] Transfering playback between devices. Optional field.
+        end
+
+        # The currently playing track or episode. Can be `null`.
+        #
+        # @see Spotted::Models::Me::PlayerGetStateResponse#item
+        module Item
+          extend Spotted::Internal::Type::Union
+
+          discriminator :type
+
+          variant :track, -> { Spotted::TrackObject }
+
+          variant :episode, -> { Spotted::EpisodeObject }
+
+          # @!method self.variants
+          #   @return [Array(Spotted::Models::TrackObject, Spotted::Models::EpisodeObject)]
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_list_recently_played_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#list_recently_played
+      class PlayerListRecentlyPlayedParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   A Unix timestamp in milliseconds. Returns all items after (but not including)
+        #   this cursor position. If `after` is specified, `before` must not be specified.
+        #
+        #   @return [Integer, nil]
+        optional :after, Integer
+
+        # @!attribute before
+        #   A Unix timestamp in milliseconds. Returns all items before (but not including)
+        #   this cursor position. If `before` is specified, `after` must not be specified.
+        #
+        #   @return [Integer, nil]
+        optional :before, Integer
+
+        # @!attribute limit
+        #   The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerListRecentlyPlayedParams} for more details.
+        #
+        #   @param after [Integer] A Unix timestamp in milliseconds. Returns all items
+        #
+        #   @param before [Integer] A Unix timestamp in milliseconds. Returns all items
+        #
+        #   @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_list_recently_played_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#list_recently_played
+      class PlayerListRecentlyPlayedResponse < Spotted::Internal::Type::BaseModel
+        # @!attribute context
+        #   The context the track was played from.
+        #
+        #   @return [Spotted::Models::Me::ContextObject, nil]
+        optional :context, -> { Spotted::Me::ContextObject }
+
+        # @!attribute played_at
+        #   The date and time the track was played.
+        #
+        #   @return [Time, nil]
+        optional :played_at, Time
+
+        # @!attribute track
+        #   The track the user listened to.
+        #
+        #   @return [Spotted::Models::TrackObject, nil]
+        optional :track, -> { Spotted::TrackObject }
+
+        # @!method initialize(context: nil, played_at: nil, track: nil)
+        #   @param context [Spotted::Models::Me::ContextObject] The context the track was played from.
+        #
+        #   @param played_at [Time] The date and time the track was played.
+        #
+        #   @param track [Spotted::Models::TrackObject] The track the user listened to.
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_pause_playback_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#pause_playback
+      class PlayerPausePlaybackParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerPausePlaybackParams} for more details.
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If not supplied, the user's curr
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_seek_to_position_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#seek_to_position
+      class PlayerSeekToPositionParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute position_ms
+        #   The position in milliseconds to seek to. Must be a positive number. Passing in a
+        #   position that is greater than the length of the track will cause the player to
+        #   start playing the next song.
+        #
+        #   @return [Integer]
+        required :position_ms, Integer
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(position_ms:, device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerSeekToPositionParams} for more details.
+        #
+        #   @param position_ms [Integer] The position in milliseconds to seek to. Must be a
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_set_repeat_mode_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#set_repeat_mode
+      class PlayerSetRepeatModeParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute state
+        #   **track**, **context** or **off**.<br/> **track** will repeat the current
+        #   track.<br/> **context** will repeat the current context.<br/> **off** will turn
+        #   repeat off.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(state:, device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerSetRepeatModeParams} for more details.
+        #
+        #   @param state [String] **track**, **context** or **off**.<br/>
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_set_volume_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#set_volume
+      class PlayerSetVolumeParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute volume_percent
+        #   The volume to set. Must be a value from 0 to 100 inclusive.
+        #
+        #   @return [Integer]
+        required :volume_percent, Integer
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(volume_percent:, device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerSetVolumeParams} for more details.
+        #
+        #   @param volume_percent [Integer] The volume to set. Must be a value from 0 to 100 inclusive.
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If not supplied, the user's curr
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_skip_next_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#skip_next
+      class PlayerSkipNextParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerSkipNextParams} for more details.
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If not supplied, the user's curr
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_skip_previous_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#skip_previous
+      class PlayerSkipPreviousParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerSkipPreviousParams} for more details.
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_start_playback_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#start_playback
+      class PlayerStartPlaybackParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!attribute context_uri
+        #   Optional. Spotify URI of the context to play. Valid contexts are albums, artists
+        #   & playlists. `{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}`
+        #
+        #   @return [String, nil]
+        optional :context_uri, String
+
+        # @!attribute offset
+        #   Optional. Indicates from where in the context playback should start. Only
+        #   available when context_uri corresponds to an album or playlist object "position"
+        #   is zero based and can’t be negative. Example: `"offset": {"position": 5}` "uri"
+        #   is a string representing the uri of the item to start at. Example:
+        #   `"offset": {"uri": "spotify:track:1301WleyT98MSxVHPZCA6M"}`
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :offset, Spotted::Internal::Type::HashOf[Spotted::Internal::Type::Unknown]
+
+        # @!attribute position_ms
+        #   Indicates from what position to start playback. Must be a positive number.
+        #   Passing in a position that is greater than the length of the track will cause
+        #   the player to start playing the next song.
+        #
+        #   @return [Integer, nil]
+        optional :position_ms, Integer
+
+        # @!attribute uris
+        #   Optional. A JSON array of the Spotify track URIs to play. For example:
+        #   `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}`
+        #
+        #   @return [Array<String>, nil]
+        optional :uris, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(device_id: nil, context_uri: nil, offset: nil, position_ms: nil, uris: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerStartPlaybackParams} for more details.
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If not supplied, the user's curr
+        #
+        #   @param context_uri [String] Optional. Spotify URI of the context to play.
+        #
+        #   @param offset [Hash{Symbol=>Object}] Optional. Indicates from where in the context playback should start. Only availa
+        #
+        #   @param position_ms [Integer] Indicates from what position to start playback. Must be a positive number. Passi
+        #
+        #   @param uris [Array<String>] Optional. A JSON array of the Spotify track URIs to play.
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/me/player_toggle_shuffle_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Me
+      # @see Spotted::Resources::Me::Player#toggle_shuffle
+      class PlayerToggleShuffleParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute state
+        #   **true** : Shuffle user's playback.<br/> **false** : Do not shuffle user's
+        #   playback.
+        #
+        #   @return [Boolean]
+        required :state, Spotted::Internal::Type::Boolean
+
+        # @!attribute device_id
+        #   The id of the device this command is targeting. If not supplied, the user's
+        #   currently active device is the target.
+        #
+        #   @return [String, nil]
+        optional :device_id, String
+
+        # @!method initialize(state:, device_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Me::PlayerToggleShuffleParams} for more details.
+        #
+        #   @param state [Boolean] **true** : Shuffle user's playback.<br/>
+        #
+        #   @param device_id [String] The id of the device this command is targeting. If
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end