fastpixapi 0.0.1 → 1.0.0

data/lib/fastpix_api_sdk/models/components/metricsbreakdowndetails.rb

@@ -0,0 +1,48 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+
+      class MetricsBreakdownDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The specific metric value calculated based on the applied filters.
+        field :value, Crystalline::Nilable.new(Crystalline::Union.new(::Integer, ::Float)), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('value'), required: true } }
+        # Total count of view sessions for a paricular video content.
+        field :views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('views') } }
+        # Total time watched across all views, represented in milliseconds.
+        field :total_watch_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('totalWatchTime') } }
+        # Total time spent playing the video, represented in milliseconds.
+        field :total_playing_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('totalPlayingTime') } }
+        # the value of dimension or filter value on which the aggregation is to be applied.
+        field :field, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('field') } }
+
+        sig { params(value: T.nilable(T.any(::Integer, ::Float)), views: T.nilable(::Integer), total_watch_time: T.nilable(::Integer), total_playing_time: T.nilable(::Integer), field: T.nilable(::String)).void }
+        def initialize(value: nil, views: nil, total_watch_time: nil, total_playing_time: nil, field: nil)
+          @value = value
+          @views = views
+          @total_watch_time = total_watch_time
+          @total_playing_time = total_playing_time
+          @field = field
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @value == other.value
+          return false unless @views == other.views
+          return false unless @total_watch_time == other.total_watch_time
+          return false unless @total_playing_time == other.total_playing_time
+          return false unless @field == other.field
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricsbreakdowndetails.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::MetricsBreakdownDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::MetricsBreakdownDetails
+  def value(); end
+  def value=(str_); end
+  def views(); end
+  def views=(str_); end
+  def total_watch_time(); end
+  def total_watch_time=(str_); end
+  def total_playing_time(); end
+  def total_playing_time=(str_); end
+  def field(); end
+  def field=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/metricsbreakdowndetails_value.rb

@@ -0,0 +1,27 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # The specific metric value calculated based on the applied filters.
+      class MetricsBreakdownDetailsValue
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        
+        def initialize; end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricsbreakdowndetails_value.rbi

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

data/lib/fastpix_api_sdk/models/components/metricscomparisondetails.rb

@@ -0,0 +1,49 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+
+      class MetricsComparisonDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The specific metric value calculated based on the applied filters.
+        field :value, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('value') } }
+        # value can be score that ranges from 0 to 100
+        field :type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('type') } }
+        # value can be score that ranges from 0 to 100
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('name') } }
+        # The metric field represents the name of the Key Performance Indicator (KPI) being tracked or analyzed. It identifies a specific measurable aspect of the video playback experience, such as buffering time, video start failure rate, or playback quality.
+        # 
+        field :metric, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('metric') } }
+
+        field :items, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Item)), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('items') } }
+
+        sig { params(value: T.nilable(::Integer), type: T.nilable(::String), name: T.nilable(::String), metric: T.nilable(::String), items: T.nilable(T::Array[Models::Components::Item])).void }
+        def initialize(value: nil, type: nil, name: nil, metric: nil, items: nil)
+          @value = value
+          @type = type
+          @name = name
+          @metric = metric
+          @items = items
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @value == other.value
+          return false unless @type == other.type
+          return false unless @name == other.name
+          return false unless @metric == other.metric
+          return false unless @items == other.items
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricscomparisondetails.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::MetricsComparisonDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::MetricsComparisonDetails
+  def value(); end
+  def value=(str_); end
+  def type(); end
+  def type=(str_); end
+  def name(); end
+  def name=(str_); end
+  def metric(); end
+  def metric=(str_); end
+  def items(); end
+  def items=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/metricsoveralldatadetails.rb

@@ -0,0 +1,52 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # Retrieves overall values for a specified metric
+      class MetricsOverallDataDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # metric value calculated based on the applied filters.
+        field :value, Crystalline::Nilable.new(Crystalline::Union.new(::Integer, ::Float)), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('value') } }
+        # Total time watched across all views, represented in milliseconds.
+        field :total_watch_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('totalWatchTime') } }
+        # The count of unique viewers who interacted with the content.
+        field :unique_views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('uniqueViews') } }
+        # The total number of views recorded.
+        field :total_views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('totalViews') } }
+        # Total time spent playing the video, represented in milliseconds.
+        field :total_play_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('totalPlayTime') } }
+        # A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan.
+        field :global_value, Crystalline::Nilable.new(Crystalline::Union.new(::Integer, ::Float)), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('globalValue') } }
+
+        sig { params(value: T.nilable(T.any(::Integer, ::Float)), total_watch_time: T.nilable(::Integer), unique_views: T.nilable(::Integer), total_views: T.nilable(::Integer), total_play_time: T.nilable(::Integer), global_value: T.nilable(T.any(::Integer, ::Float))).void }
+        def initialize(value: nil, total_watch_time: nil, unique_views: nil, total_views: nil, total_play_time: nil, global_value: nil)
+          @value = value
+          @total_watch_time = total_watch_time
+          @unique_views = unique_views
+          @total_views = total_views
+          @total_play_time = total_play_time
+          @global_value = global_value
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @value == other.value
+          return false unless @total_watch_time == other.total_watch_time
+          return false unless @unique_views == other.unique_views
+          return false unless @total_views == other.total_views
+          return false unless @total_play_time == other.total_play_time
+          return false unless @global_value == other.global_value
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricsoveralldatadetails.rbi

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::MetricsOverallDataDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::MetricsOverallDataDetails
+  def value(); end
+  def value=(str_); end
+  def total_watch_time(); end
+  def total_watch_time=(str_); end
+  def unique_views(); end
+  def unique_views=(str_); end
+  def total_views(); end
+  def total_views=(str_); end
+  def total_play_time(); end
+  def total_play_time=(str_); end
+  def global_value(); end
+  def global_value=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/metricsoveralldatadetails_value.rb

@@ -0,0 +1,27 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # metric value calculated based on the applied filters.
+      class MetricsOverallDataDetailsValue
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        
+        def initialize; end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricsoveralldatadetails_value.rbi

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

data/lib/fastpix_api_sdk/models/components/metricsoverallmetadatadetails.rb

@@ -0,0 +1,32 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # Metadata that has to be paased for metric calculations.
+      class MetricsOverallMetaDataDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # defines the field or dimension on which the aggregation is to be   applied.
+        field :aggregation, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('aggregation') } }
+
+        sig { params(aggregation: T.nilable(::String)).void }
+        def initialize(aggregation: nil)
+          @aggregation = aggregation
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @aggregation == other.aggregation
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricsoverallmetadatadetails.rbi

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

data/lib/fastpix_api_sdk/models/components/metricstimeseriesdatadetails.rb

@@ -0,0 +1,40 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # The metric's value at specific time intervals.
+      class MetricsTimeseriesDataDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The timestamp for the data point indicating when the metric value was recorded.
+        field :interval_time, Crystalline::Nilable.new(::DateTime), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('intervalTime'), 'decoder': Utils.datetime_from_iso_format(true) } }
+        # The value of the specified metric at the given interval.
+        field :metric_value, Crystalline::Nilable.new(Crystalline::Union.new(::Integer, ::Float)), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('metricValue') } }
+        # The total number of views recorded during that interval.
+        field :number_of_views, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('numberOfViews') } }
+
+        sig { params(interval_time: T.nilable(::DateTime), metric_value: T.nilable(T.any(::Integer, ::Float)), number_of_views: T.nilable(::Integer)).void }
+        def initialize(interval_time: nil, metric_value: nil, number_of_views: nil)
+          @interval_time = interval_time
+          @metric_value = metric_value
+          @number_of_views = number_of_views
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @interval_time == other.interval_time
+          return false unless @metric_value == other.metric_value
+          return false unless @number_of_views == other.number_of_views
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricstimeseriesdatadetails.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::MetricsTimeseriesDataDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::MetricsTimeseriesDataDetails
+  def interval_time(); end
+  def interval_time=(str_); end
+  def metric_value(); end
+  def metric_value=(str_); end
+  def number_of_views(); end
+  def number_of_views=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/metricstimeseriesmetadatadetails.rb

@@ -0,0 +1,36 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # Retrieves breakdown values for a specified metric and timespan
+      class MetricsTimeseriesMetaDataDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # the unit for aggregating the timeseries data.
+        field :granularity, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('granularity') } }
+        # defines the field or dimension on which the aggregation is to be   applied.
+        field :aggregation, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('aggregation') } }
+
+        sig { params(granularity: T.nilable(::String), aggregation: T.nilable(::String)).void }
+        def initialize(granularity: nil, aggregation: nil)
+          @granularity = granularity
+          @aggregation = aggregation
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @granularity == other.granularity
+          return false unless @aggregation == other.aggregation
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricstimeseriesmetadatadetails.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::MetricsTimeseriesMetaDataDetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::MetricsTimeseriesMetaDataDetails
+  def granularity(); end
+  def granularity=(str_); end
+  def aggregation(); end
+  def aggregation=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/metricvalue.rb

@@ -0,0 +1,27 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+      # The value of the specified metric at the given interval.
+      class MetricValue
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        
+        def initialize; end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/metricvalue.rbi

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

data/lib/fastpix_api_sdk/models/components/moderation.rb

@@ -1,4 +1,3 @@
-# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 
 # typed: true
 # frozen_string_literal: true
@@ -13,11 +12,10 @@ module FastpixApiSDK
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # Defines the type of input. Possible values include video, audio, av.
-        # 
-        field :type, Models::Components::CreateMediaRequestType, { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::CreateMediaRequestType, false) } }
+        # Type of media content
+        field :type, Models::Components::MediaType, { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::MediaType, false) } }
 
-        sig { params(type: Models::Components::CreateMediaRequestType).void }
+        sig { params(type: Models::Components::MediaType).void }
         def initialize(type:)
           @type = type
         end

data/lib/fastpix_api_sdk/models/components/moderation.rbi

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

data/lib/fastpix_api_sdk/models/components/moderationresponse.rb

@@ -0,0 +1,36 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+
+      class ModerationResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :media_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('mediaId') } }
+
+        field :is_moderation_enabled, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('isModerationEnabled') } }
+
+        sig { params(media_id: T.nilable(::String), is_moderation_enabled: T.nilable(T::Boolean)).void }
+        def initialize(media_id: nil, is_moderation_enabled: nil)
+          @media_id = media_id
+          @is_moderation_enabled = is_moderation_enabled
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @media_id == other.media_id
+          return false unless @is_moderation_enabled == other.is_moderation_enabled
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/moderationresponse.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::ModerationResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::ModerationResponse
+  def media_id(); end
+  def media_id=(str_); end
+  def is_moderation_enabled(); end
+  def is_moderation_enabled=(str_); end
+end

data/lib/fastpix_api_sdk/models/components/namedentitiesresponse.rb

@@ -0,0 +1,36 @@
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixApiSDK
+  module Models
+    module Components
+    
+
+      class NamedEntitiesResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :media_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('mediaId') } }
+
+        field :is_generated_named_entities, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixApiSDK::Utils.field_name('isGeneratedNamedEntities') } }
+
+        sig { params(media_id: T.nilable(::String), is_generated_named_entities: T.nilable(T::Boolean)).void }
+        def initialize(media_id: nil, is_generated_named_entities: nil)
+          @media_id = media_id
+          @is_generated_named_entities = is_generated_named_entities
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @media_id == other.media_id
+          return false unless @is_generated_named_entities == other.is_generated_named_entities
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_api_sdk/models/components/namedentitiesresponse.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixApiSDK::Models::Components::NamedEntitiesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixApiSDK::Models::Components::NamedEntitiesResponse
+  def media_id(); end
+  def media_id=(str_); end
+  def is_generated_named_entities(); end
+  def is_generated_named_entities=(str_); end
+end