spotted 0.1.0

data/rbi/spotted/models/playlist_update_params.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class PlaylistUpdateParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::PlaylistUpdateParams, Spotted::Internal::AnyHash)
+        end
+
+      # If `true`, the playlist will become collaborative and other users will be able
+      # to modify the playlist in their Spotify client. <br/> _**Note**: You can only
+      # set `collaborative` to `true` on non-public playlists._
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :collaborative
+
+      sig { params(collaborative: T::Boolean).void }
+      attr_writer :collaborative
+
+      # Value for playlist description as displayed in Spotify Clients and in the Web
+      # API.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # The new name for the playlist, for example `"My New Playlist Title"`
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The playlist's public/private status (if it should be added to the user's
+      # profile or not): `true` the playlist will be public, `false` the playlist will
+      # be private, `null` the playlist status is not relevant. For more about
+      # public/private status, see
+      # [Working with Playlists](/documentation/web-api/concepts/playlists)
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :public
+
+      sig { params(public: T::Boolean).void }
+      attr_writer :public
+
+      sig do
+        params(
+          collaborative: T::Boolean,
+          description: String,
+          name: String,
+          public: T::Boolean,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # If `true`, the playlist will become collaborative and other users will be able
+        # to modify the playlist in their Spotify client. <br/> _**Note**: You can only
+        # set `collaborative` to `true` on non-public playlists._
+        collaborative: nil,
+        # Value for playlist description as displayed in Spotify Clients and in the Web
+        # API.
+        description: nil,
+        # The new name for the playlist, for example `"My New Playlist Title"`
+        name: nil,
+        # The playlist's public/private status (if it should be added to the user's
+        # profile or not): `true` the playlist will be public, `false` the playlist will
+        # be private, `null` the playlist status is not relevant. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        public: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            collaborative: T::Boolean,
+            description: String,
+            name: String,
+            public: T::Boolean,
+            request_options: Spotted::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlist_user_object.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class PlaylistUserObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::PlaylistUserObject, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this
+      # user.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Known public external URLs for this user.
+      sig { returns(T.nilable(Spotted::ExternalURLObject)) }
+      attr_reader :external_urls
+
+      sig { params(external_urls: Spotted::ExternalURLObject::OrHash).void }
+      attr_writer :external_urls
+
+      # A link to the Web API endpoint for this user.
+      sig { returns(T.nilable(String)) }
+      attr_reader :href
+
+      sig { params(href: String).void }
+      attr_writer :href
+
+      # The object type.
+      sig do
+        returns(T.nilable(Spotted::PlaylistUserObject::Type::TaggedSymbol))
+      end
+      attr_reader :type
+
+      sig { params(type: Spotted::PlaylistUserObject::Type::OrSymbol).void }
+      attr_writer :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this
+      # user.
+      sig { returns(T.nilable(String)) }
+      attr_reader :uri
+
+      sig { params(uri: String).void }
+      attr_writer :uri
+
+      sig do
+        params(
+          id: String,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          type: Spotted::PlaylistUserObject::Type::OrSymbol,
+          uri: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this
+        # user.
+        id: nil,
+        # Known public external URLs for this user.
+        external_urls: nil,
+        # A link to the Web API endpoint for this user.
+        href: nil,
+        # The object type.
+        type: nil,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this
+        # user.
+        uri: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            type: Spotted::PlaylistUserObject::Type::TaggedSymbol,
+            uri: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The object type.
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Spotted::PlaylistUserObject::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        USER = T.let(:user, Spotted::PlaylistUserObject::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Spotted::PlaylistUserObject::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/follower_check_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class FollowerCheckParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::FollowerCheckParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # **Deprecated** A single item list containing current user's
+        # [Spotify Username](/documentation/web-api/concepts/spotify-uris-ids). Maximum: 1
+        # id.
+        sig { returns(T.nilable(String)) }
+        attr_reader :ids
+
+        sig { params(ids: String).void }
+        attr_writer :ids
+
+        sig do
+          params(
+            ids: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # **Deprecated** A single item list containing current user's
+          # [Spotify Username](/documentation/web-api/concepts/spotify-uris-ids). Maximum: 1
+          # id.
+          ids: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { ids: String, request_options: Spotted::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/follower_check_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      FollowerCheckResponse =
+        T.let(
+          Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
+          Spotted::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/spotted/models/playlists/follower_follow_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class FollowerFollowParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::FollowerFollowParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # Defaults to `true`. If `true` the playlist will be included in user's public
+        # playlists (added to profile), if `false` it will remain private. For more about
+        # public/private status, see
+        # [Working with Playlists](/documentation/web-api/concepts/playlists)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :public
+
+        sig { params(public: T::Boolean).void }
+        attr_writer :public
+
+        sig do
+          params(
+            public: T::Boolean,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Defaults to `true`. If `true` the playlist will be included in user's public
+          # playlists (added to profile), if `false` it will remain private. For more about
+          # public/private status, see
+          # [Working with Playlists](/documentation/web-api/concepts/playlists)
+          public: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { public: T::Boolean, request_options: Spotted::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/follower_unfollow_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class FollowerUnfollowParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::FollowerUnfollowParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Spotted::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Spotted::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/image_list_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class ImageListParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::ImageListParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Spotted::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Spotted::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/image_list_response.rbi

@@ -0,0 +1,13 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      ImageListResponse =
+        T.let(
+          Spotted::Internal::Type::ArrayOf[Spotted::ImageObject],
+          Spotted::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/spotted/models/playlists/image_update_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class ImageUpdateParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::ImageUpdateParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # Base64 encoded JPEG image data, maximum payload size is 256 KB.
+        sig { returns(String) }
+        attr_accessor :body
+
+        sig do
+          params(
+            body: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Base64 encoded JPEG image data, maximum payload size is 256 KB.
+          body:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { body: String, request_options: Spotted::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/track_add_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class TrackAddParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Playlists::TrackAddParams,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The position to insert the items, a zero-based index. For example, to insert the
+        # items in the first position: `position=0` ; to insert the items in the third
+        # position: `position=2`. If omitted, the items will be appended to the playlist.
+        # Items are added in the order they appear in the uris array. For example:
+        # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3}`
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :body_position
+
+        sig { params(body_position: Integer).void }
+        attr_writer :body_position
+
+        # A JSON array of the
+        # [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
+        # example:
+        # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A
+        # maximum of 100 items can be added in one request. _**Note**: if the `uris`
+        # parameter is present in the query string, any URIs listed here in the body will
+        # be ignored._
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :body_uris
+
+        sig { params(body_uris: T::Array[String]).void }
+        attr_writer :body_uris
+
+        sig do
+          params(
+            body_position: Integer,
+            body_uris: T::Array[String],
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The position to insert the items, a zero-based index. For example, to insert the
+          # items in the first position: `position=0` ; to insert the items in the third
+          # position: `position=2`. If omitted, the items will be appended to the playlist.
+          # Items are added in the order they appear in the uris array. For example:
+          # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3}`
+          body_position: nil,
+          # A JSON array of the
+          # [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
+          # example:
+          # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A
+          # maximum of 100 items can be added in one request. _**Note**: if the `uris`
+          # parameter is present in the query string, any URIs listed here in the body will
+          # be ignored._
+          body_uris: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              body_position: Integer,
+              body_uris: T::Array[String],
+              request_options: Spotted::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/playlists/track_add_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Spotted
+  module Models
+    module Playlists
+      class TrackAddResponse < Spotted::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::Models::Playlists::TrackAddResponse,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :snapshot_id
+
+        sig { params(snapshot_id: String).void }
+        attr_writer :snapshot_id
+
+        sig { params(snapshot_id: String).returns(T.attached_class) }
+        def self.new(snapshot_id: nil)
+        end
+
+        sig { override.returns({ snapshot_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end