fastpixapi 0.0.1 → 1.1.0

data/lib/fastpix_client/models/components/views.rbi

@@ -0,0 +1,257 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::Views
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::Views
+  def beacon_domain(); end
+  def beacon_domain=(str_); end
+  def custom(); end
+  def custom=(str_); end
+  def exit_before_video_start(); end
+  def exit_before_video_start=(str_); end
+  def insert_timestamp(); end
+  def insert_timestamp=(str_); end
+  def ip_address(); end
+  def ip_address=(str_); end
+  def os_version(); end
+  def os_version=(str_); end
+  def player_autoplay_on(); end
+  def player_autoplay_on=(str_); end
+  def player_preload_on(); end
+  def player_preload_on=(str_); end
+  def player_remote_played(); end
+  def player_remote_played=(str_); end
+  def used_full_screen(); end
+  def used_full_screen=(str_); end
+  def video_startup_failed(); end
+  def video_startup_failed=(str_); end
+  def view_has_ad(); end
+  def view_has_ad=(str_); end
+  def view_has_error(); end
+  def view_has_error=(str_); end
+  def view_id(); end
+  def view_id=(str_); end
+  def workspace_id(); end
+  def workspace_id=(str_); end
+  def events(); end
+  def events=(str_); end
+  def asn_id(); end
+  def asn_id=(str_); end
+  def asn_name(); end
+  def asn_name=(str_); end
+  def average_bitrate(); end
+  def average_bitrate=(str_); end
+  def avg_downscaling(); end
+  def avg_downscaling=(str_); end
+  def avg_request_latency(); end
+  def avg_request_latency=(str_); end
+  def avg_request_throughput(); end
+  def avg_request_throughput=(str_); end
+  def avg_upscaling(); end
+  def avg_upscaling=(str_); end
+  def browser_engine(); end
+  def browser_engine=(str_); end
+  def browser_name(); end
+  def browser_name=(str_); end
+  def browser_version(); end
+  def browser_version=(str_); end
+  def buffer_count(); end
+  def buffer_count=(str_); end
+  def buffer_fill(); end
+  def buffer_fill=(str_); end
+  def buffer_frequency(); end
+  def buffer_frequency=(str_); end
+  def buffer_ratio(); end
+  def buffer_ratio=(str_); end
+  def cdn(); end
+  def cdn=(str_); end
+  def city(); end
+  def city=(str_); end
+  def connection_type(); end
+  def connection_type=(str_); end
+  def continent(); end
+  def continent=(str_); end
+  def country(); end
+  def country=(str_); end
+  def country_code(); end
+  def country_code=(str_); end
+  def device_manufacturer(); end
+  def device_manufacturer=(str_); end
+  def device_model(); end
+  def device_model=(str_); end
+  def device_name(); end
+  def device_name=(str_); end
+  def device_type(); end
+  def device_type=(str_); end
+  def drm_type(); end
+  def drm_type=(str_); end
+  def dropped_frame_count(); end
+  def dropped_frame_count=(str_); end
+  def error_code(); end
+  def error_code=(str_); end
+  def error_context(); end
+  def error_context=(str_); end
+  def error_id(); end
+  def error_id=(str_); end
+  def error_message(); end
+  def error_message=(str_); end
+  def experiment_name(); end
+  def experiment_name=(str_); end
+  def fp_api_version(); end
+  def fp_api_version=(str_); end
+  def fp_embed(); end
+  def fp_embed=(str_); end
+  def fp_embed_version(); end
+  def fp_embed_version=(str_); end
+  def fp_live_stream_id(); end
+  def fp_live_stream_id=(str_); end
+  def fp_playback_id(); end
+  def fp_playback_id=(str_); end
+  def fp_sdk(); end
+  def fp_sdk=(str_); end
+  def fp_sdk_version(); end
+  def fp_sdk_version=(str_); end
+  def fp_viewer_id(); end
+  def fp_viewer_id=(str_); end
+  def jump_latency(); end
+  def jump_latency=(str_); end
+  def latitude(); end
+  def latitude=(str_); end
+  def live_stream_latency(); end
+  def live_stream_latency=(str_); end
+  def longitude(); end
+  def longitude=(str_); end
+  def max_downscaling(); end
+  def max_downscaling=(str_); end
+  def max_request_latency(); end
+  def max_request_latency=(str_); end
+  def max_upscaling(); end
+  def max_upscaling=(str_); end
+  def media_id(); end
+  def media_id=(str_); end
+  def os_name(); end
+  def os_name=(str_); end
+  def page_context(); end
+  def page_context=(str_); end
+  def page_load_time(); end
+  def page_load_time=(str_); end
+  def playback_score(); end
+  def playback_score=(str_); end
+  def player_height(); end
+  def player_height=(str_); end
+  def player_initialization_time(); end
+  def player_initialization_time=(str_); end
+  def player_instance_id(); end
+  def player_instance_id=(str_); end
+  def player_language(); end
+  def player_language=(str_); end
+  def player_name(); end
+  def player_name=(str_); end
+  def player_poster(); end
+  def player_poster=(str_); end
+  def player_resolution(); end
+  def player_resolution=(str_); end
+  def player_software_name(); end
+  def player_software_name=(str_); end
+  def player_software_version(); end
+  def player_software_version=(str_); end
+  def player_source_domain(); end
+  def player_source_domain=(str_); end
+  def player_source_height(); end
+  def player_source_height=(str_); end
+  def player_source_width(); end
+  def player_source_width=(str_); end
+  def player_version(); end
+  def player_version=(str_); end
+  def player_view_count(); end
+  def player_view_count=(str_); end
+  def player_width(); end
+  def player_width=(str_); end
+  def property_id(); end
+  def property_id=(str_); end
+  def quality_of_experience_score(); end
+  def quality_of_experience_score=(str_); end
+  def region(); end
+  def region=(str_); end
+  def render_quality_score(); end
+  def render_quality_score=(str_); end
+  def session_id(); end
+  def session_id=(str_); end
+  def sign(); end
+  def sign=(str_); end
+  def stability_score(); end
+  def stability_score=(str_); end
+  def startup_score(); end
+  def startup_score=(str_); end
+  def sub_property_id(); end
+  def sub_property_id=(str_); end
+  def total_startup_time(); end
+  def total_startup_time=(str_); end
+  def updated_timestamp(); end
+  def updated_timestamp=(str_); end
+  def user_agent(); end
+  def user_agent=(str_); end
+  def video_content_type(); end
+  def video_content_type=(str_); end
+  def video_duration(); end
+  def video_duration=(str_); end
+  def video_encoding_variant(); end
+  def video_encoding_variant=(str_); end
+  def video_id(); end
+  def video_id=(str_); end
+  def video_language(); end
+  def video_language=(str_); end
+  def video_producer(); end
+  def video_producer=(str_); end
+  def video_resolution(); end
+  def video_resolution=(str_); end
+  def video_series(); end
+  def video_series=(str_); end
+  def video_source_domain(); end
+  def video_source_domain=(str_); end
+  def video_source_duration(); end
+  def video_source_duration=(str_); end
+  def video_source_hostname(); end
+  def video_source_hostname=(str_); end
+  def video_source_stream_type(); end
+  def video_source_stream_type=(str_); end
+  def video_source_type(); end
+  def video_source_type=(str_); end
+  def video_source_url(); end
+  def video_source_url=(str_); end
+  def video_startup_time(); end
+  def video_startup_time=(str_); end
+  def video_title(); end
+  def video_title=(str_); end
+  def video_variant_id(); end
+  def video_variant_id=(str_); end
+  def video_variant_name(); end
+  def video_variant_name=(str_); end
+  def view_end(); end
+  def view_end=(str_); end
+  def view_max_playhead_position(); end
+  def view_max_playhead_position=(str_); end
+  def view_page_url(); end
+  def view_page_url=(str_); end
+  def view_playing_time(); end
+  def view_playing_time=(str_); end
+  def view_seeked_count(); end
+  def view_seeked_count=(str_); end
+  def view_seeked_duration(); end
+  def view_seeked_duration=(str_); end
+  def view_session_id(); end
+  def view_session_id=(str_); end
+  def view_start(); end
+  def view_start=(str_); end
+  def view_total_content_playback_time(); end
+  def view_total_content_playback_time=(str_); end
+  def viewer_id(); end
+  def viewer_id=(str_); end
+  def watch_time(); end
+  def watch_time=(str_); end
+end

data/lib/fastpix_client/models/components/viewsbytopcontentdetails.rb

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Retrieves a list of the top video views
+      class ViewsByTopContentDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Title of the video
+        field :video_title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('videoTitle') } }
+        # Total count of view sessions for a particular video content.
+        field :views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('views') } }
+        # Total count of unique video viewers for particular video content.
+        field :unique_views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('uniqueViews') } }
+
+        sig { params(video_title: T.nilable(::String), views: T.nilable(::Integer), unique_views: T.nilable(::Integer)).void }
+        def initialize(video_title: nil, views: nil, unique_views: nil)
+          @video_title = video_title
+          @views = views
+          @unique_views = unique_views
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @video_title == other.video_title
+          return false unless @views == other.views
+          return false unless @unique_views == other.unique_views
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/viewsbytopcontentdetails.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::ViewsByTopContentDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::ViewsByTopContentDetails
+  def video_title(); end
+  def video_title=(str_); end
+  def views(); end
+  def views=(str_); end
+  def unique_views(); end
+  def unique_views=(str_); end
+end

data/lib/fastpix_client/models/components/viewscountresponse.rb

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class ViewsCountResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Shows the request status. Returns true for success and false for failure.
+        field :success, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success') } }
+        # Contains the view count details.
+        field :data, Crystalline::Nilable.new(Models::Components::ViewsCountResponseData), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+
+        sig { params(success: T.nilable(T::Boolean), data: T.nilable(Models::Components::ViewsCountResponseData)).void }
+        def initialize(success: nil, data: nil)
+          @success = success
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @success == other.success
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/viewscountresponse.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::ViewsCountResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::ViewsCountResponse
+  def success(); end
+  def success=(str_); end
+  def data(); end
+  def data=(str_); end
+end

data/lib/fastpix_client/models/components/viewscountresponse_data.rb

@@ -0,0 +1,32 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Contains the view count details.
+      class ViewsCountResponseData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Number of views for the stream or resource.
+        field :views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('views') } }
+
+        sig { params(views: T.nilable(::Integer)).void }
+        def initialize(views: nil)
+          @views = views
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @views == other.views
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/viewscountresponse_data.rbi

@@ -0,0 +1,13 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::ViewsCountResponseData
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::ViewsCountResponseData
+  def views(); end
+  def views=(str_); end
+end

data/lib/fastpix_client/models/components/viewslist.rb

@@ -0,0 +1,88 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class ViewsList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier for the viewing session of the user.
+        # 
+        field :view_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('viewId') } }
+        # Operating System signifies the software platform utilized by the viewer
+        # 
+        field :operating_system, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('operatingSystem') } }
+        # The browser name of the viewer.
+        # 
+        field :application, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('application') } }
+        # The start timestamp of the video view.
+        # 
+        field :view_start_time, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('viewStartTime') } }
+        # The end timestamp of the video view.
+        # 
+        field :view_end_time, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('viewEndTime') } }
+        # The title of the Video.
+        # 
+        field :video_title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('videoTitle') } }
+        # The code which represents specific issues or failures that occur during playback. These can be implementation specific.
+        # 
+        field :error_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('errorCode') } }
+        # The notifications or messages that inform users or developers about issues or failures that have occurred during the playback representing error codes.
+        # 
+        field :error_message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('errorMessage') } }
+        # The unique identifier for the error that occurred during playback.
+        # 
+        field :error_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('errorId') } }
+        # Country of the viewer.
+        # 
+        field :country, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('country') } }
+        # The watch time represents the time spent watching the video including staruptime, playback time ,buffering time.
+        # 
+        field :view_watch_time, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('viewWatchTime') } }
+        # The viewer experience encapsulated in the form of score while watching the video.
+        # 
+        field :qoe_score, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('QoeScore') } }
+
+        sig { params(view_id: T.nilable(::String), operating_system: T.nilable(::String), application: T.nilable(::String), view_start_time: T.nilable(::String), view_end_time: T.nilable(::String), video_title: T.nilable(::String), error_code: T.nilable(::String), error_message: T.nilable(::String), error_id: T.nilable(::String), country: T.nilable(::String), view_watch_time: T.nilable(::Float), qoe_score: T.nilable(::Float)).void }
+        def initialize(view_id: nil, operating_system: nil, application: nil, view_start_time: nil, view_end_time: nil, video_title: nil, error_code: nil, error_message: nil, error_id: nil, country: nil, view_watch_time: nil, qoe_score: nil)
+          @view_id = view_id
+          @operating_system = operating_system
+          @application = application
+          @view_start_time = view_start_time
+          @view_end_time = view_end_time
+          @video_title = video_title
+          @error_code = error_code
+          @error_message = error_message
+          @error_id = error_id
+          @country = country
+          @view_watch_time = view_watch_time
+          @qoe_score = qoe_score
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @view_id == other.view_id
+          return false unless @operating_system == other.operating_system
+          return false unless @application == other.application
+          return false unless @view_start_time == other.view_start_time
+          return false unless @view_end_time == other.view_end_time
+          return false unless @video_title == other.video_title
+          return false unless @error_code == other.error_code
+          return false unless @error_message == other.error_message
+          return false unless @error_id == other.error_id
+          return false unless @country == other.country
+          return false unless @view_watch_time == other.view_watch_time
+          return false unless @qoe_score == other.qoe_score
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/viewslist.rbi

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::ViewsList
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::ViewsList
+  def view_id(); end
+  def view_id=(str_); end
+  def operating_system(); end
+  def operating_system=(str_); end
+  def application(); end
+  def application=(str_); end
+  def view_start_time(); end
+  def view_start_time=(str_); end
+  def view_end_time(); end
+  def view_end_time=(str_); end
+  def video_title(); end
+  def video_title=(str_); end
+  def error_code(); end
+  def error_code=(str_); end
+  def error_message(); end
+  def error_message=(str_); end
+  def error_id(); end
+  def error_id=(str_); end
+  def country(); end
+  def country=(str_); end
+  def view_watch_time(); end
+  def view_watch_time=(str_); end
+  def qoe_score(); end
+  def qoe_score=(str_); end
+end

data/lib/fastpix_client/models/components/watermarkinput.rb

@@ -0,0 +1,56 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Contains configuration details for applying a watermark overlay to a video.  
+      # The watermark is placed over the media content during processing.  
+      # For detailed setup steps and customization options, refer to the 
+      # <a href="https://docs.fastpix.io/docs/watermark-your-videos" target="_blank">FastPix Watermark Guide</a>.
+      # 
+      class WatermarkInput
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Type of overlay (currently only supports "watermark").
+        field :type, Models::Components::WatermarkInputType, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::WatermarkInputType, false) } }
+        # URL of the watermark image.
+        field :url, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url'), required: true } }
+
+        field :placement, Crystalline::Nilable.new(Models::Components::Placement), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('placement') } }
+        # Width of the watermark in percentage or pixels.
+        field :width, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('width') } }
+        # Height of the watermark in percentage or pixels.
+        field :height, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('height') } }
+        # Opacity of the watermark in percentage.
+        field :opacity, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('opacity') } }
+
+        sig { params(type: Models::Components::WatermarkInputType, url: ::String, placement: T.nilable(Models::Components::Placement), width: T.nilable(::String), height: T.nilable(::String), opacity: T.nilable(::String)).void }
+        def initialize(type:, url:, placement: nil, width: nil, height: nil, opacity: nil)
+          @type = type
+          @url = url
+          @placement = placement
+          @width = width
+          @height = height
+          @opacity = opacity
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @type == other.type
+          return false unless @url == other.url
+          return false unless @placement == other.placement
+          return false unless @width == other.width
+          return false unless @height == other.height
+          return false unless @opacity == other.opacity
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/watermarkinput.rbi

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::WatermarkInput
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::WatermarkInput
+  def type(); end
+  def type=(str_); end
+  def url(); end
+  def url=(str_); end
+  def placement(); end
+  def placement=(str_); end
+  def width(); end
+  def width=(str_); end
+  def height(); end
+  def height=(str_); end
+  def opacity(); end
+  def opacity=(str_); end
+end

data/lib/fastpix_client/models/components/watermarkinput_type.rb

@@ -0,0 +1,20 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # WatermarkInputType - Type of overlay (currently only supports "watermark").
+      class WatermarkInputType < T::Enum
+
+
+        enums do
+          WATERMARK = new('watermark')
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/components/watermarkinput_type.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::WatermarkInputType
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::WatermarkInputType
+end

data/lib/fastpix_client/models/components/xalign.rb

@@ -0,0 +1,22 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # XAlign - Horizontal alignment of the watermark.
+      class XAlign < T::Enum
+
+
+        enums do
+          LEFT = new('left')
+          CENTER = new('center')
+          RIGHT = new('right')
+        end
+      end
+    end
+  end
+end