plex_ruby_sdk 0.13.1 → 0.17.0

data/lib/plex_ruby_sdk/models/operations/get_search_all_libraries_media.rb

@@ -13,59 +13,65 @@ module PlexRubySDK
         extend T::Sig
         include Crystalline::MetadataFields
 
-
-        field :container, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
-
+        # Unique media identifier.
         field :id, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('id') } }
-
-        field :part, T::Array[Models::Operations::GetSearchAllLibrariesPart], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Part') } }
-
+        # Aspect ratio of the video.
         field :aspect_ratio, T.nilable(::Float), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('aspectRatio') } }
-
+        # Number of audio channels.
         field :audio_channels, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioChannels') } }
-
+        # Audio codec used.
         field :audio_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioCodec') } }
-
+        # The audio profile used for the media (e.g., DTS, Dolby Digital, etc.).
         field :audio_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('audioProfile') } }
-
+        # Bitrate in bits per second.
         field :bitrate, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('bitrate') } }
+        # Container format of the media.
+        field :container, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('container') } }
 
+        field :display_offset, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('displayOffset') } }
+        # Duration of the media in milliseconds.
         field :duration, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('duration') } }
-
+        # Indicates whether the media has 64-bit offsets.
+        # This is relevant for media files that may require larger offsets than what 32-bit integers can provide.
+        # 
         field :has64bit_offsets, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('has64bitOffsets') } }
-
+        # Indicates whether voice activity is detected.
         field :has_voice_activity, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('hasVoiceActivity') } }
-
+        # Video height in pixels.
         field :height, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('height') } }
+        # Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
+        field :optimized_for_streaming, T.nilable(T.any(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming1, T::Boolean)), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('optimizedForStreaming') } }
 
-        field :optimized_for_streaming, T.nilable(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('optimizedForStreaming'), 'decoder': Utils.enum_from_string(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming, true) } }
-
+        field :part, T.nilable(T::Array[Models::Operations::GetSearchAllLibrariesPart]), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('Part') } }
+        # Video codec used.
         field :video_codec, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoCodec') } }
-
+        # Frame rate of the video. Values found include NTSC, PAL, 24p
+        # 
         field :video_frame_rate, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoFrameRate') } }
-
+        # Video profile (e.g., main 10).
         field :video_profile, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoProfile') } }
-
+        # Video resolution (e.g., 4k).
         field :video_resolution, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('videoResolution') } }
-
+        # Video width in pixels.
         field :width, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('width') } }
 
 
-        sig { params(container: ::String, id: ::Integer, part: T::Array[Models::Operations::GetSearchAllLibrariesPart], aspect_ratio: T.nilable(::Float), audio_channels: T.nilable(::Integer), audio_codec: T.nilable(::String), audio_profile: T.nilable(::String), bitrate: T.nilable(::Integer), duration: T.nilable(::Integer), has64bit_offsets: T.nilable(T::Boolean), has_voice_activity: T.nilable(T::Boolean), height: T.nilable(::Integer), optimized_for_streaming: T.nilable(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming), video_codec: T.nilable(::String), video_frame_rate: T.nilable(::String), video_profile: T.nilable(::String), video_resolution: T.nilable(::String), width: T.nilable(::Integer)).void }
-        def initialize(container: nil, id: nil, part: nil, aspect_ratio: nil, audio_channels: nil, audio_codec: nil, audio_profile: nil, bitrate: nil, duration: nil, has64bit_offsets: nil, has_voice_activity: nil, height: nil, optimized_for_streaming: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil)
-          @container = container
+        sig { params(id: ::Integer, aspect_ratio: T.nilable(::Float), audio_channels: T.nilable(::Integer), audio_codec: T.nilable(::String), audio_profile: T.nilable(::String), bitrate: T.nilable(::Integer), container: T.nilable(::String), display_offset: T.nilable(::Integer), duration: T.nilable(::Integer), has64bit_offsets: T.nilable(T::Boolean), has_voice_activity: T.nilable(T::Boolean), height: T.nilable(::Integer), optimized_for_streaming: T.nilable(T.any(Models::Operations::GetSearchAllLibrariesOptimizedForStreaming1, T::Boolean)), part: T.nilable(T::Array[Models::Operations::GetSearchAllLibrariesPart]), video_codec: T.nilable(::String), video_frame_rate: T.nilable(::String), video_profile: T.nilable(::String), video_resolution: T.nilable(::String), width: T.nilable(::Integer)).void }
+        def initialize(id: nil, aspect_ratio: nil, audio_channels: nil, audio_codec: nil, audio_profile: nil, bitrate: nil, container: nil, display_offset: nil, duration: nil, has64bit_offsets: nil, has_voice_activity: nil, height: nil, optimized_for_streaming: nil, part: nil, video_codec: nil, video_frame_rate: nil, video_profile: nil, video_resolution: nil, width: nil)
           @id = id
-          @part = part
           @aspect_ratio = aspect_ratio
           @audio_channels = audio_channels
           @audio_codec = audio_codec
           @audio_profile = audio_profile
           @bitrate = bitrate
+          @container = container
+          @display_offset = display_offset
           @duration = duration
           @has64bit_offsets = has64bit_offsets
           @has_voice_activity = has_voice_activity
           @height = height
           @optimized_for_streaming = optimized_for_streaming
+          @part = part
           @video_codec = video_codec
           @video_frame_rate = video_frame_rate
           @video_profile = video_profile
@@ -75,19 +81,20 @@ module PlexRubySDK
 
         def ==(other)
           return false unless other.is_a? self.class
-          return false unless @container == other.container
           return false unless @id == other.id
-          return false unless @part == other.part
           return false unless @aspect_ratio == other.aspect_ratio
           return false unless @audio_channels == other.audio_channels
           return false unless @audio_codec == other.audio_codec
           return false unless @audio_profile == other.audio_profile
           return false unless @bitrate == other.bitrate
+          return false unless @container == other.container
+          return false unless @display_offset == other.display_offset
           return false unless @duration == other.duration
           return false unless @has64bit_offsets == other.has64bit_offsets
           return false unless @has_voice_activity == other.has_voice_activity
           return false unless @height == other.height
           return false unless @optimized_for_streaming == other.optimized_for_streaming
+          return false unless @part == other.part
           return false unless @video_codec == other.video_codec
           return false unless @video_frame_rate == other.video_frame_rate
           return false unless @video_profile == other.video_profile

data/lib/plex_ruby_sdk/models/operations/get_search_all_libraries_mediacontainer.rb

@@ -13,22 +13,50 @@ module PlexRubySDK
         extend T::Sig
         include Crystalline::MetadataFields
 
+        # Indicates whether syncing is allowed.
+        field :allow_sync, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('allowSync') } }
+        # An plugin identifier for the media container.
+        field :identifier, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('identifier') } }
+        # The prefix used for media tag resource paths.
+        field :media_tag_prefix, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagPrefix') } }
+        # The version number for media tags.
+        field :media_tag_version, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('mediaTagVersion') } }
 
         field :search_result, T::Array[Models::Operations::SearchResult], { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('SearchResult') } }
+        # Number of media items returned in this response.
+        field :size, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
+        # The unique identifier for the library section.
+        field :library_section_id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionID') } }
+        # The title of the library section.
+        field :library_section_title, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionTitle') } }
+        # The universally unique identifier for the library section.
+        field :library_section_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('librarySectionUUID') } }
 
-        field :size, ::Float, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('size') } }
 
-
-        sig { params(search_result: T::Array[Models::Operations::SearchResult], size: ::Float).void }
-        def initialize(search_result: nil, size: nil)
+        sig { params(allow_sync: T::Boolean, identifier: ::String, media_tag_prefix: ::String, media_tag_version: ::Integer, search_result: T::Array[Models::Operations::SearchResult], size: ::Integer, library_section_id: T.nilable(::Integer), library_section_title: T.nilable(::String), library_section_uuid: T.nilable(::String)).void }
+        def initialize(allow_sync: nil, identifier: nil, media_tag_prefix: nil, media_tag_version: nil, search_result: nil, size: nil, library_section_id: nil, library_section_title: nil, library_section_uuid: nil)
+          @allow_sync = allow_sync
+          @identifier = identifier
+          @media_tag_prefix = media_tag_prefix
+          @media_tag_version = media_tag_version
           @search_result = search_result
           @size = size
+          @library_section_id = library_section_id
+          @library_section_title = library_section_title
+          @library_section_uuid = library_section_uuid
         end
 
         def ==(other)
           return false unless other.is_a? self.class
+          return false unless @allow_sync == other.allow_sync
+          return false unless @identifier == other.identifier
+          return false unless @media_tag_prefix == other.media_tag_prefix
+          return false unless @media_tag_version == other.media_tag_version
           return false unless @search_result == other.search_result
           return false unless @size == other.size
+          return false unless @library_section_id == other.library_section_id
+          return false unless @library_section_title == other.library_section_title
+          return false unless @library_section_uuid == other.library_section_uuid
           true
         end
       end