spotted 0.1.0

data/rbi/spotted/models/simplified_episode_object.rbi

@@ -0,0 +1,289 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class SimplifiedEpisodeObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::SimplifiedEpisodeObject, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # episode.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # A URL to a 30 second preview (MP3 format) of the episode. `null` if not
+      # available.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :audio_preview_url
+
+      # A description of the episode. HTML tags are stripped away from this field, use
+      # `html_description` field in case HTML tags are needed.
+      sig { returns(String) }
+      attr_accessor :description
+
+      # The episode length in milliseconds.
+      sig { returns(Integer) }
+      attr_accessor :duration_ms
+
+      # Whether or not the episode has explicit content (true = yes it does; false = no
+      # it does not OR unknown).
+      sig { returns(T::Boolean) }
+      attr_accessor :explicit
+
+      # External URLs for this episode.
+      sig { returns(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 providing full details of the episode.
+      sig { returns(String) }
+      attr_accessor :href
+
+      # A description of the episode. This field may contain HTML tags.
+      sig { returns(String) }
+      attr_accessor :html_description
+
+      # The cover art for the episode in various sizes, widest first.
+      sig { returns(T::Array[Spotted::ImageObject]) }
+      attr_accessor :images
+
+      # True if the episode is hosted outside of Spotify's CDN.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_externally_hosted
+
+      # True if the episode is playable in the given market. Otherwise false.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_playable
+
+      # A list of the languages used in the episode, identified by their
+      # [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+      sig { returns(T::Array[String]) }
+      attr_accessor :languages
+
+      # The name of the episode.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The date the episode was first released, for example `"1981-12-15"`. Depending
+      # on the precision, it might be shown as `"1981"` or `"1981-12"`.
+      sig { returns(String) }
+      attr_accessor :release_date
+
+      # The precision with which `release_date` value is known.
+      sig do
+        returns(
+          Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol
+        )
+      end
+      attr_accessor :release_date_precision
+
+      # The object type.
+      sig { returns(Spotted::SimplifiedEpisodeObject::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # episode.
+      sig { returns(String) }
+      attr_accessor :uri
+
+      # The language used in the episode, identified by a
+      # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. This field is deprecated
+      # and might be removed in the future. Please use the `languages` field instead.
+      sig { returns(T.nilable(String)) }
+      attr_reader :language
+
+      sig { params(language: String).void }
+      attr_writer :language
+
+      # Included in the response when a content restriction is applied.
+      sig { returns(T.nilable(Spotted::EpisodeRestrictionObject)) }
+      attr_reader :restrictions
+
+      sig do
+        params(restrictions: Spotted::EpisodeRestrictionObject::OrHash).void
+      end
+      attr_writer :restrictions
+
+      # The user's most recent position in the episode. Set if the supplied access token
+      # is a user token and has the scope 'user-read-playback-position'.
+      sig { returns(T.nilable(Spotted::ResumePointObject)) }
+      attr_reader :resume_point
+
+      sig { params(resume_point: Spotted::ResumePointObject::OrHash).void }
+      attr_writer :resume_point
+
+      sig do
+        params(
+          id: String,
+          audio_preview_url: T.nilable(String),
+          description: String,
+          duration_ms: Integer,
+          explicit: T::Boolean,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          html_description: String,
+          images: T::Array[Spotted::ImageObject::OrHash],
+          is_externally_hosted: T::Boolean,
+          is_playable: T::Boolean,
+          languages: T::Array[String],
+          name: String,
+          release_date: String,
+          release_date_precision:
+            Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::OrSymbol,
+          type: Spotted::SimplifiedEpisodeObject::Type::OrSymbol,
+          uri: String,
+          language: String,
+          restrictions: Spotted::EpisodeRestrictionObject::OrHash,
+          resume_point: Spotted::ResumePointObject::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # episode.
+        id:,
+        # A URL to a 30 second preview (MP3 format) of the episode. `null` if not
+        # available.
+        audio_preview_url:,
+        # A description of the episode. HTML tags are stripped away from this field, use
+        # `html_description` field in case HTML tags are needed.
+        description:,
+        # The episode length in milliseconds.
+        duration_ms:,
+        # Whether or not the episode has explicit content (true = yes it does; false = no
+        # it does not OR unknown).
+        explicit:,
+        # External URLs for this episode.
+        external_urls:,
+        # A link to the Web API endpoint providing full details of the episode.
+        href:,
+        # A description of the episode. This field may contain HTML tags.
+        html_description:,
+        # The cover art for the episode in various sizes, widest first.
+        images:,
+        # True if the episode is hosted outside of Spotify's CDN.
+        is_externally_hosted:,
+        # True if the episode is playable in the given market. Otherwise false.
+        is_playable:,
+        # A list of the languages used in the episode, identified by their
+        # [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+        languages:,
+        # The name of the episode.
+        name:,
+        # The date the episode was first released, for example `"1981-12-15"`. Depending
+        # on the precision, it might be shown as `"1981"` or `"1981-12"`.
+        release_date:,
+        # The precision with which `release_date` value is known.
+        release_date_precision:,
+        # The object type.
+        type:,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # episode.
+        uri:,
+        # The language used in the episode, identified by a
+        # [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code. This field is deprecated
+        # and might be removed in the future. Please use the `languages` field instead.
+        language: nil,
+        # Included in the response when a content restriction is applied.
+        restrictions: nil,
+        # The user's most recent position in the episode. Set if the supplied access token
+        # is a user token and has the scope 'user-read-playback-position'.
+        resume_point: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            audio_preview_url: T.nilable(String),
+            description: String,
+            duration_ms: Integer,
+            explicit: T::Boolean,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            html_description: String,
+            images: T::Array[Spotted::ImageObject],
+            is_externally_hosted: T::Boolean,
+            is_playable: T::Boolean,
+            languages: T::Array[String],
+            name: String,
+            release_date: String,
+            release_date_precision:
+              Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol,
+            type: Spotted::SimplifiedEpisodeObject::Type::TaggedSymbol,
+            uri: String,
+            language: String,
+            restrictions: Spotted::EpisodeRestrictionObject,
+            resume_point: Spotted::ResumePointObject
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The precision with which `release_date` value is known.
+      module ReleaseDatePrecision
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        YEAR =
+          T.let(
+            :year,
+            Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :month,
+            Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol
+          )
+        DAY =
+          T.let(
+            :day,
+            Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Spotted::SimplifiedEpisodeObject::ReleaseDatePrecision::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The object type.
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Spotted::SimplifiedEpisodeObject::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EPISODE =
+          T.let(:episode, Spotted::SimplifiedEpisodeObject::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Spotted::SimplifiedEpisodeObject::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/spotted/models/simplified_playlist_object.rbi

@@ -0,0 +1,230 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class SimplifiedPlaylistObject < Spotted::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::SimplifiedPlaylistObject, Spotted::Internal::AnyHash)
+        end
+
+      # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # playlist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # `true` if the owner allows other users to modify the playlist.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :collaborative
+
+      sig { params(collaborative: T::Boolean).void }
+      attr_writer :collaborative
+
+      # The playlist description. _Only returned for modified, verified playlists,
+      # otherwise_ `null`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # Known external URLs for this playlist.
+      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 providing full details of the playlist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :href
+
+      sig { params(href: String).void }
+      attr_writer :href
+
+      # Images for the playlist. The array may be empty or contain up to three images.
+      # The images are returned by size in descending order. See
+      # [Working with Playlists](/documentation/web-api/concepts/playlists). _**Note**:
+      # If returned, the source URL for the image (`url`) is temporary and will expire
+      # in less than a day._
+      sig { returns(T.nilable(T::Array[Spotted::ImageObject])) }
+      attr_reader :images
+
+      sig { params(images: T::Array[Spotted::ImageObject::OrHash]).void }
+      attr_writer :images
+
+      # The name of the playlist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The user who owns the playlist
+      sig { returns(T.nilable(Spotted::SimplifiedPlaylistObject::Owner)) }
+      attr_reader :owner
+
+      sig do
+        params(owner: Spotted::SimplifiedPlaylistObject::Owner::OrHash).void
+      end
+      attr_writer :owner
+
+      # The playlist's public/private status (if it is added to the user's profile):
+      # `true` the playlist is public, `false` the playlist is 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
+
+      # The version identifier for the current playlist. Can be supplied in other
+      # requests to target a specific playlist version
+      sig { returns(T.nilable(String)) }
+      attr_reader :snapshot_id
+
+      sig { params(snapshot_id: String).void }
+      attr_writer :snapshot_id
+
+      # A collection containing a link ( `href` ) to the Web API endpoint where full
+      # details of the playlist's tracks can be retrieved, along with the `total` number
+      # of tracks in the playlist. Note, a track object may be `null`. This can happen
+      # if a track is no longer available.
+      sig { returns(T.nilable(Spotted::PlaylistTracksRefObject)) }
+      attr_reader :tracks
+
+      sig { params(tracks: Spotted::PlaylistTracksRefObject::OrHash).void }
+      attr_writer :tracks
+
+      # The object type: "playlist"
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      # playlist.
+      sig { returns(T.nilable(String)) }
+      attr_reader :uri
+
+      sig { params(uri: String).void }
+      attr_writer :uri
+
+      sig do
+        params(
+          id: String,
+          collaborative: T::Boolean,
+          description: String,
+          external_urls: Spotted::ExternalURLObject::OrHash,
+          href: String,
+          images: T::Array[Spotted::ImageObject::OrHash],
+          name: String,
+          owner: Spotted::SimplifiedPlaylistObject::Owner::OrHash,
+          public: T::Boolean,
+          snapshot_id: String,
+          tracks: Spotted::PlaylistTracksRefObject::OrHash,
+          type: String,
+          uri: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # playlist.
+        id: nil,
+        # `true` if the owner allows other users to modify the playlist.
+        collaborative: nil,
+        # The playlist description. _Only returned for modified, verified playlists,
+        # otherwise_ `null`.
+        description: nil,
+        # Known external URLs for this playlist.
+        external_urls: nil,
+        # A link to the Web API endpoint providing full details of the playlist.
+        href: nil,
+        # Images for the playlist. The array may be empty or contain up to three images.
+        # The images are returned by size in descending order. See
+        # [Working with Playlists](/documentation/web-api/concepts/playlists). _**Note**:
+        # If returned, the source URL for the image (`url`) is temporary and will expire
+        # in less than a day._
+        images: nil,
+        # The name of the playlist.
+        name: nil,
+        # The user who owns the playlist
+        owner: nil,
+        # The playlist's public/private status (if it is added to the user's profile):
+        # `true` the playlist is public, `false` the playlist is 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,
+        # The version identifier for the current playlist. Can be supplied in other
+        # requests to target a specific playlist version
+        snapshot_id: nil,
+        # A collection containing a link ( `href` ) to the Web API endpoint where full
+        # details of the playlist's tracks can be retrieved, along with the `total` number
+        # of tracks in the playlist. Note, a track object may be `null`. This can happen
+        # if a track is no longer available.
+        tracks: nil,
+        # The object type: "playlist"
+        type: nil,
+        # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # playlist.
+        uri: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            collaborative: T::Boolean,
+            description: String,
+            external_urls: Spotted::ExternalURLObject,
+            href: String,
+            images: T::Array[Spotted::ImageObject],
+            name: String,
+            owner: Spotted::SimplifiedPlaylistObject::Owner,
+            public: T::Boolean,
+            snapshot_id: String,
+            tracks: Spotted::PlaylistTracksRefObject,
+            type: String,
+            uri: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Owner < Spotted::Models::PlaylistUserObject
+        OrHash =
+          T.type_alias do
+            T.any(
+              Spotted::SimplifiedPlaylistObject::Owner,
+              Spotted::Internal::AnyHash
+            )
+          end
+
+        # The name displayed on the user's profile. `null` if not available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :display_name
+
+        # The user who owns the playlist
+        sig do
+          params(display_name: T.nilable(String)).returns(T.attached_class)
+        end
+        def self.new(
+          # The name displayed on the user's profile. `null` if not available.
+          display_name: nil
+        )
+        end
+
+        sig { override.returns({ display_name: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end