fastpixapi 0.0.1 → 1.1.0

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

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

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

@@ -0,0 +1,44 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Contains details about the track being added to the media file.
+      class AddTrackRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The direct URL of the track file. It must point to a valid audio or subtitle file.
+        field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url') } }
+        # Specifies the type of track being added. It can be either `audio` or `subtitle`.
+        field :type, Crystalline::Nilable.new(Models::Components::AddTrackRequestType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::AddTrackRequestType, true) } }
+        # The BCP 47 language code representing the track’s language.
+        field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
+        # The full name of the language corresponding to the `languageCode`.
+        field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
+
+        sig { params(url: T.nilable(::String), type: T.nilable(Models::Components::AddTrackRequestType), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
+        def initialize(url: 'https://static.fastpix.io/music-1.mp3', type: Models::Components::AddTrackRequestType::AUDIO, language_code: 'it', language_name: 'Italian')
+          @url = url
+          @type = type
+          @language_code = language_code
+          @language_name = language_name
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @url == other.url
+          return false unless @type == other.type
+          return false unless @language_code == other.language_code
+          return false unless @language_name == other.language_name
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::AddTrackRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::AddTrackRequest
+  def url(); end
+  def url=(str_); end
+  def type(); end
+  def type=(str_); end
+  def language_code(); end
+  def language_code=(str_); end
+  def language_name(); end
+  def language_name=(str_); end
+end

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # AddTrackRequestType - Specifies the type of track being added. It can be either `audio` or `subtitle`.
+      class AddTrackRequestType < T::Enum
+
+
+        enums do
+          AUDIO = new('audio')
+          SUBTITLE = new('subtitle')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,48 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Contains details about the track that was added or updated.
+      class AddTrackResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier of the track.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # Specifies the type of track (audio or subtitle).
+        field :type, Crystalline::Nilable.new(Models::Components::AddTrackResponseType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::AddTrackResponseType, true) } }
+        # The direct URL of the track file.
+        field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url') } }
+        # The BCP 47 language code representing the track's language.
+        field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
+        # The full name of the language corresponding to the `languageCode`.
+        field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
+
+        sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AddTrackResponseType), url: T.nilable(::String), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
+        def initialize(id: nil, type: nil, url: nil, language_code: nil, language_name: nil)
+          @id = id
+          @type = type
+          @url = url
+          @language_code = language_code
+          @language_name = language_name
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @id == other.id
+          return false unless @type == other.type
+          return false unless @url == other.url
+          return false unless @language_code == other.language_code
+          return false unless @language_name == other.language_name
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::AddTrackResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::AddTrackResponse
+  def id(); end
+  def id=(str_); end
+  def type(); end
+  def type=(str_); end
+  def url(); end
+  def url=(str_); end
+  def language_code(); end
+  def language_code=(str_); end
+  def language_name(); end
+  def language_name=(str_); end
+end

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # AddTrackResponseType - Specifies the type of track (audio or subtitle).
+      class AddTrackResponseType < T::Enum
+
+
+        enums do
+          AUDIO = new('audio')
+          SUBTITLE = new('subtitle')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Represents an AI response record containing status and data for AI-generated features like summary, chapters, named entities, or moderation.
+      class AiResponseRecord
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The status of the AI processing (for example, "available", "preparing", "failed").
+        field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
+        # The AI-generated content data. Can be a Map, List, or other structured data depending on the AI feature type.
+        field :data, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+
+        sig { params(status: T.nilable(::String), data: T.nilable(T::Hash[Symbol, ::Object])).void }
+        def initialize(status: nil, data: nil)
+          @status = status
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @status == other.status
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Represents an AI response record containing status and data for AI-generated features like summary, chapters, named entities, or moderation.
+      class AiSummaryRecord
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The status of the AI processing (for example, "available", "preparing", "failed").
+        field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
+        # The AI-generated summary of the media content. This field contains the processed textual output produced by the AI once summarization is complete.
+        field :data, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+
+        sig { params(status: T.nilable(::String), data: T.nilable(::String)).void }
+        def initialize(status: nil, data: nil)
+          @status = status
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @status == other.status
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class AudioInput
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Type of overlay (currently only supports "audio").
+        field :type, Models::Components::AudioInputType, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::AudioInputType, false) } }
+        # URL of the audio track to replace the existing audio in the video.
+        field :swap_track_url, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('swapTrackUrl'), required: true } }
+        # List of additional audio tracks to overlay on the video.
+        field :impose_tracks, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::ImposeTrack)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('imposeTracks') } }
+
+        sig { params(type: Models::Components::AudioInputType, swap_track_url: ::String, impose_tracks: T.nilable(T::Array[Models::Components::ImposeTrack])).void }
+        def initialize(type:, swap_track_url:, impose_tracks: nil)
+          @type = type
+          @swap_track_url = swap_track_url
+          @impose_tracks = impose_tracks
+        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 @swap_track_url == other.swap_track_url
+          return false unless @impose_tracks == other.impose_tracks
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::AudioInput
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::AudioInput
+  def type(); end
+  def type=(str_); end
+  def swap_track_url(); end
+  def swap_track_url=(str_); end
+  def impose_tracks(); end
+  def impose_tracks=(str_); end
+end

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

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

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

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

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

@@ -0,0 +1,50 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # A media consists of different media tracks, like video, audio, and subtitle, all combined.
+      class AudioTrack
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # FastPix generates a unique identifier for each track.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # Defines the type of input track.
+        field :type, Crystalline::Nilable.new(Models::Components::AudioTrackType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::AudioTrackType, true) } }
+        # Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
+        field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
+        # Name of the language in which the subtitles will be generated.
+        # 
+        field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
+        # Language codes are concise, standardized symbols that denote languages, utilizing either two or three characters for identification. The language code must be compliant with the BCP 47 standard to ensure compatibility. (for text only).
+        # 
+        field :language_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageCode') } }
+
+        sig { params(id: T.nilable(::String), type: T.nilable(Models::Components::AudioTrackType), status: T.nilable(::String), language_name: T.nilable(::String), language_code: T.nilable(::String)).void }
+        def initialize(id: nil, type: nil, status: nil, language_name: nil, language_code: nil)
+          @id = id
+          @type = type
+          @status = status
+          @language_name = language_name
+          @language_code = language_code
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @id == other.id
+          return false unless @type == other.type
+          return false unless @status == other.status
+          return false unless @language_name == other.language_name
+          return false unless @language_code == other.language_code
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::AudioTrack
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::AudioTrack
+  def id(); end
+  def id=(str_); end
+  def type(); end
+  def type=(str_); end
+  def status(); end
+  def status=(str_); end
+  def language_name(); end
+  def language_name=(str_); end
+  def language_code(); end
+  def language_code=(str_); end
+end

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

@@ -0,0 +1,20 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # AudioTrackType - Defines the type of input track.
+      class AudioTrackType < T::Enum
+
+
+        enums do
+          AUDIO = new('audio')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # BasicAccessPolicy - Basic access policy for media content
+      class BasicAccessPolicy < T::Enum
+
+
+        enums do
+          PUBLIC = new('public')
+          PRIVATE = new('private')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class BrowserNameDimensiondetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The specific metric value calculated based on the applied filters.
+        field :value, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('value') } }
+        # The count of unique viewers who interacted with the content.
+        field :unique_count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('uniqueCount') } }
+        # The count of viewers.
+        field :count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('count') } }
+
+        sig { params(value: T.nilable(::String), unique_count: T.nilable(::Integer), count: T.nilable(::Integer)).void }
+        def initialize(value: nil, unique_count: nil, count: nil)
+          @value = value
+          @unique_count = unique_count
+          @count = count
+        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 @unique_count == other.unique_count
+          return false unless @count == other.count
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::BrowserNameDimensiondetails
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::BrowserNameDimensiondetails
+  def value(); end
+  def value=(str_); end
+  def unique_count(); end
+  def unique_count=(str_); end
+  def count(); end
+  def count=(str_); end
+end

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class ChaptersResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :media_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('mediaId') } }
+
+        field :is_chapters_enabled, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('isChaptersEnabled') } }
+
+        sig { params(media_id: T.nilable(::String), is_chapters_enabled: T.nilable(T::Boolean)).void }
+        def initialize(media_id: nil, is_chapters_enabled: nil)
+          @media_id = media_id
+          @is_chapters_enabled = is_chapters_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_chapters_enabled == other.is_chapters_enabled
+          true
+        end
+      end
+    end
+  end
+end