fastpixapi 0.0.1 → 1.1.0

data/lib/fastpix_client/models/operations/list_live_clips_response.rb

@@ -0,0 +1,48 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+
+      class ListLiveClipsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # List of video media
+        field :object, Crystalline::Nilable.new(Models::Operations::ListLiveClipsResponseBody)
+        # See the range of possible <a href="https://docs.fastpix.io/reference/error-codes">error</a> responses and their status codes.
+        field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListLiveClipsResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
+        def initialize(content_type:, status_code:, raw_response:, object: nil, default_error: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @object = object
+          @default_error = default_error
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @object == other.object
+          return false unless @default_error == other.default_error
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_live_clips_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListLiveClipsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListLiveClipsResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def object(); end
+  def object=(str_); end
+  def default_error(); end
+  def default_error=(str_); end
+end

data/lib/fastpix_client/models/operations/list_live_clips_responsebody.rb

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # List of video media
+      class ListLiveClipsResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Demonstrates whether the request is successful or not.
+        field :success, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success') } }
+        # Displays the result of the request.
+        field :data, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::LiveMediaClips)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+        # Pagination organizes content into pages for better readability and navigation.
+        field :pagination, Crystalline::Nilable.new(Models::Components::Pagination), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('pagination') } }
+
+        sig { params(success: T.nilable(T::Boolean), data: T.nilable(T::Array[Models::Components::LiveMediaClips]), pagination: T.nilable(Models::Components::Pagination)).void }
+        def initialize(success: nil, data: nil, pagination: nil)
+          @success = success
+          @data = data
+          @pagination = pagination
+        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
+          return false unless @pagination == other.pagination
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_live_clips_responsebody.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListLiveClipsResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListLiveClipsResponseBody
+  def success(); end
+  def success=(str_); end
+  def data(); end
+  def data=(str_); end
+  def pagination(); end
+  def pagination=(str_); end
+end

data/lib/fastpix_client/models/operations/list_media_request.rb

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+
+      class ListMediaRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Limit specifies the maximum number of items to display per page.
+        field :limit, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
+        # Offset determines the starting point for data retrieval within a paginated list.
+        field :offset, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'offset', 'style': 'form', 'explode': true } }
+        # The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).
+        field :order_by, Crystalline::Nilable.new(Models::Components::SortOrder), { 'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': true } }
+
+        sig { params(limit: T.nilable(::Integer), offset: T.nilable(::Integer), order_by: T.nilable(Models::Components::SortOrder)).void }
+        def initialize(limit: 10, offset: 1, order_by: Models::Components::SortOrder::DESC)
+          @limit = limit
+          @offset = offset
+          @order_by = order_by
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @limit == other.limit
+          return false unless @offset == other.offset
+          return false unless @order_by == other.order_by
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_media_request.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListMediaRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListMediaRequest
+  def limit(); end
+  def limit=(str_); end
+  def offset(); end
+  def offset=(str_); end
+  def order_by(); end
+  def order_by=(str_); end
+end

data/lib/fastpix_client/models/operations/list_media_response.rb

@@ -0,0 +1,48 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+
+      class ListMediaResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # List of video media
+        field :object, Crystalline::Nilable.new(Models::Operations::ListMediaResponseBody)
+        # See the range of possible <a href="https://docs.fastpix.io/reference/error-codes">error</a> responses and their status codes.
+        field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListMediaResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
+        def initialize(content_type:, status_code:, raw_response:, object: nil, default_error: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @object = object
+          @default_error = default_error
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @object == other.object
+          return false unless @default_error == other.default_error
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_media_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListMediaResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListMediaResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def object(); end
+  def object=(str_); end
+  def default_error(); end
+  def default_error=(str_); end
+end

data/lib/fastpix_client/models/operations/list_media_responsebody.rb

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # List of video media
+      class ListMediaResponseBody
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Demonstrates whether the request is successful or not.
+        field :success, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success') } }
+        # Displays the result of the request.
+        field :data, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::GetAllMediaResponse)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+        # Pagination organizes content into pages for better readability and navigation.
+        field :pagination, Crystalline::Nilable.new(Models::Components::Pagination), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('pagination') } }
+
+        sig { params(success: T.nilable(T::Boolean), data: T.nilable(T::Array[Models::Components::GetAllMediaResponse]), pagination: T.nilable(Models::Components::Pagination)).void }
+        def initialize(success: nil, data: nil, pagination: nil)
+          @success = success
+          @data = data
+          @pagination = pagination
+        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
+          return false unless @pagination == other.pagination
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_media_responsebody.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListMediaResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListMediaResponseBody
+  def success(); end
+  def success=(str_); end
+  def data(); end
+  def data=(str_); end
+  def pagination(); end
+  def pagination=(str_); end
+end

data/lib/fastpix_client/models/operations/list_overall_values_metricid.rb

@@ -0,0 +1,46 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # ListOverallValuesMetricId - Pass metric Id
+      # 
+      class ListOverallValuesMetricId < T::Enum
+
+
+        enums do
+          VIEWS = new('views')
+          UNIQUE_VIEWERS = new('unique_viewers')
+          PLAYING_TIME = new('playing_time')
+          QUALITY_OF_EXPERIENCE_SCORE = new('quality_of_experience_score')
+          PLAYBACK_SCORE = new('playback_score')
+          PLAYBACK_FAILURE_PERCENTAGE = new('playback_failure_percentage')
+          EXIT_BEFORE_VIDEO_START = new('exit_before_video_start')
+          VIDEO_STARTUP_FAILURE_PERCENTAGE = new('video_startup_failure_percentage')
+          STARTUP_SCORE = new('startup_score')
+          VIDEO_STARTUP_TIME = new('video_startup_time')
+          PLAYER_STARTUP_TIME = new('player_startup_time')
+          PAGE_LOAD_TIME = new('page_load_time')
+          TOTAL_STARTUP_TIME = new('total_startup_time')
+          LIVE_STREAM_LATENCY = new('live_stream_latency')
+          AVERAGE_BITRATE = new('average_bitrate')
+          BUFFER_COUNT = new('buffer_count')
+          RENDER_QUALITY_SCORE = new('render_quality_score')
+          AVG_UPSCALING = new('avg_upscaling')
+          AVG_DOWNSCALING = new('avg_downscaling')
+          MAX_UPSCALING = new('max_upscaling')
+          MAX_DOWNSCALING = new('max_downscaling')
+          JUMP_LATENCY = new('jump_latency')
+          STABILITY_SCORE = new('stability_score')
+          BUFFER_RATIO = new('buffer_ratio')
+          BUFFER_FREQUENCY = new('buffer_frequency')
+          BUFFER_FILL = new('buffer_fill')
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_overall_values_metricid.rbi

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

data/lib/fastpix_client/models/operations/list_overall_values_request.rb

@@ -0,0 +1,58 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+
+      class ListOverallValuesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Pass metric Id
+        # 
+        field :metric_id, Models::Operations::ListOverallValuesMetricId, { 'path_param': { 'field_name': 'metricId', 'style': 'simple', 'explode': false } }
+        # This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
+        # 
+        # **Accepted formats are:**
+        # 
+        # array of epoch timestamps for example 
+        # `timespan[]=1498867200&timespan[]=1498953600`
+        # 
+        # duration string for example  
+        # `timespan[]=24:hours` or `timespan[]=7:days`
+        # 
+        field :timespan, Crystalline::Nilable.new(Models::Operations::ListOverallValuesTimespan), { 'query_param': { 'field_name': 'timespan[]', 'style': 'form', 'explode': true } }
+        # Pass the dimensions and their corresponding values you want to filter the views by. For excluding the values in the filter we can pass "!" before the filter value. The list of filters can be obtained from list of dimensions endpoint.
+        # Example Values : [ browser_name:Chrome , os_name:macOS , !device_name:Galaxy ]
+        # 
+        field :filterby, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'filterby[]', 'style': 'form', 'explode': true } }
+        # The measurement for the given metrics.
+        # Possible Values : [95th, median, avg, count or sum]
+        # 
+        field :measurement, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'measurement', 'style': 'form', 'explode': true } }
+
+        sig { params(metric_id: Models::Operations::ListOverallValuesMetricId, timespan: T.nilable(Models::Operations::ListOverallValuesTimespan), filterby: T.nilable(::String), measurement: T.nilable(::String)).void }
+        def initialize(metric_id:, timespan: nil, filterby: nil, measurement: 'avg')
+          @metric_id = metric_id
+          @timespan = timespan
+          @filterby = filterby
+          @measurement = measurement
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @metric_id == other.metric_id
+          return false unless @timespan == other.timespan
+          return false unless @filterby == other.filterby
+          return false unless @measurement == other.measurement
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_overall_values_request.rbi

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListOverallValuesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListOverallValuesRequest
+  def metric_id(); end
+  def metric_id=(str_); end
+  def timespan(); end
+  def timespan=(str_); end
+  def filterby(); end
+  def filterby=(str_); end
+  def measurement(); end
+  def measurement=(str_); end
+end

data/lib/fastpix_client/models/operations/list_overall_values_response.rb

@@ -0,0 +1,48 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+
+      class ListOverallValuesResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+        # Get filter/ dimension value details by dimension name.
+        field :object, Crystalline::Nilable.new(Models::Operations::ListOverallValuesResponseBody)
+        # See the range of possible <a href="https://docs.fastpix.io/reference/error-codes">error</a> responses and their status codes.
+        field :default_error, Crystalline::Nilable.new(Models::Components::DefaultError)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, object: T.nilable(Models::Operations::ListOverallValuesResponseBody), default_error: T.nilable(Models::Components::DefaultError)).void }
+        def initialize(content_type:, status_code:, raw_response:, object: nil, default_error: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @object = object
+          @default_error = default_error
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @object == other.object
+          return false unless @default_error == other.default_error
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_overall_values_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListOverallValuesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListOverallValuesResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def object(); end
+  def object=(str_); end
+  def default_error(); end
+  def default_error=(str_); end
+end

data/lib/fastpix_client/models/operations/list_overall_values_responsebody.rb

@@ -0,0 +1,45 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # Get filter/ dimension value details by dimension name.
+      class ListOverallValuesResponseBody
+        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') } }
+        # metadata that has to be paased for metric calculations.
+        field :metadata, Crystalline::Nilable.new(Models::Components::MetricsOverallmetadataDetails), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('metadata') } }
+        # Retrieves overall values for a specified metric
+        field :data, Crystalline::Nilable.new(Models::Components::MetricsOverallDataDetails), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+        # The timespan from and to details displayed in the form of unix epoch timestamps.
+        # 
+        field :timespan, Crystalline::Nilable.new(Crystalline::Array.new(::Integer)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('timespan') } }
+
+        sig { params(success: T.nilable(T::Boolean), metadata: T.nilable(Models::Components::MetricsOverallmetadataDetails), data: T.nilable(Models::Components::MetricsOverallDataDetails), timespan: T.nilable(T::Array[::Integer])).void }
+        def initialize(success: nil, metadata: nil, data: nil, timespan: nil)
+          @success = success
+          @metadata = metadata
+          @data = data
+          @timespan = timespan
+        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 @metadata == other.metadata
+          return false unless @data == other.data
+          return false unless @timespan == other.timespan
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_overall_values_responsebody.rbi

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Operations::ListOverallValuesResponseBody
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Operations::ListOverallValuesResponseBody
+  def success(); end
+  def success=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+  def data(); end
+  def data=(str_); end
+  def timespan(); end
+  def timespan=(str_); end
+end

data/lib/fastpix_client/models/operations/list_overall_values_timespan_.rb

@@ -0,0 +1,34 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # ListOverallValuesTimespan - This parameter specifies the time span between which the video views list must be retrieved by. You can provide either from and to unix epoch timestamps or time duration. The scope of duration is between 60 minutes to 30 days.
+      # 
+      # **Accepted formats are:**
+      # 
+      # array of epoch timestamps for example 
+      # `timespan[]=1498867200&timespan[]=1498953600`
+      # 
+      # duration string for example  
+      # `timespan[]=24:hours` or `timespan[]=7:days`
+      # 
+      class ListOverallValuesTimespan < T::Enum
+
+
+        enums do
+          SIXTYMINUTES = new('60:minutes')
+          SIXHOURS = new('6:hours')
+          TWENTY_FOURHOURS = new('24:hours')
+          THREEDAYS = new('3:days')
+          SEVENDAYS = new('7:days')
+          THIRTYDAYS = new('30:days')
+        end
+      end
+    end
+  end
+end

data/lib/fastpix_client/models/operations/list_overall_values_timespan_.rbi

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

data/lib/fastpix_client/models/operations/list_playback_ids_accesspolicy.rb

@@ -0,0 +1,22 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Operations
+      # ListPlaybackIdsAccessPolicy - The access policy set for the playback ID.
+      class ListPlaybackIdsAccessPolicy < T::Enum
+
+
+        enums do
+          PUBLIC = new('public')
+          PRIVATE = new('private')
+          DRM = new('drm')
+        end
+      end
+    end
+  end
+end