fastpixapi 0.0.1 → 1.1.0

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

@@ -0,0 +1,27 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # UpdateMediaStatus - Determines the media's status, which can be one of the possible values.
+      class UpdateMediaStatus < T::Enum
+
+
+        enums do
+          CREATED = new('Created')
+          DOWNLOADING = new('Downloading')
+          DOWNLOADED = new('Downloaded')
+          VALIDATING = new('Validating')
+          IN_QUEUE = new('In Queue')
+          PROCESSING = new('Processing')
+          READY = new('Ready')
+          FAILED = new('Failed')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,27 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class UpdateMediaTrack
+        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_client/models/components/update_media_track.rbi

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class UpdatePlaylistRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # New name to the playlist.
+        field :name, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('name'), required: true } }
+        # Updated description to the playlist.
+        field :description, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('description'), required: true } }
+
+        sig { params(name: ::String, description: ::String).void }
+        def initialize(name:, description:)
+          @name = name
+          @description = description
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @name == other.name
+          return false unless @description == other.description
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+# 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 UpdateTrackRequest
+        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') } }
+        # 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), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
+        def initialize(url: 'http://commondatastorage.googleapis.com/codeskulptor-assets/sounddogs/thrust.vtt', language_code: 'fr', language_name: 'French')
+          @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 @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/updatetrackrequest.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::UpdateTrackRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::UpdateTrackRequest
+  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/updatetrackresponse.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 UpdateTrackResponse
+        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::UpdateTrackResponseType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::UpdateTrackResponseType, 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::UpdateTrackResponseType), 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/updatetrackresponse.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::UpdateTrackResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::UpdateTrackResponse
+  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/updatetrackresponse_type.rb

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

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

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

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

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Restrictions based on the user agent
+      class UserAgentRestrictions
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Policy action type
+        field :default_policy, Crystalline::Nilable.new(Models::Components::PolicyAction), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('defaultPolicy'), 'decoder': Utils.enum_from_string(Models::Components::PolicyAction, true) } }
+        # A list of user agents that are explicitly allowed access
+        field :allow, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('allow') } }
+        # A list of user agents that are explicitly denied access
+        field :deny, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('deny') } }
+
+        sig { params(default_policy: T.nilable(Models::Components::PolicyAction), allow: T.nilable(T::Array[::String]), deny: T.nilable(T::Array[::String])).void }
+        def initialize(default_policy: nil, allow: nil, deny: nil)
+          @default_policy = default_policy
+          @allow = allow
+          @deny = deny
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @default_policy == other.default_policy
+          return false unless @allow == other.allow
+          return false unless @deny == other.deny
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::UserAgentRestrictions
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::UserAgentRestrictions
+  def default_policy(); end
+  def default_policy=(str_); end
+  def allow(); end
+  def allow=(str_); end
+  def deny(); end
+  def deny=(str_); end
+end

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

@@ -0,0 +1,24 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # UserAgentsDefaultPolicy - Specifies the default access policy for user agents (browsers, bots, etc.).
+      # If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` lists. 
+      # If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` lists.
+      # 
+      class UserAgentsDefaultPolicy < T::Enum
+
+
+        enums do
+          ALLOW = new('allow')
+          DENY = new('deny')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,52 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class VideoInput
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Defines the type of input.
+        # 
+        field :type, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), required: true } }
+        # The url of the intro video which is to be added at the start of the video.
+        # 
+        field :intro_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('introUrl') } }
+        # The url of the outro video which is to be added at the end of the video.
+        # 
+        field :outro_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('outroUrl') } }
+        # The list of the startTime-endTime of the segments to be removed from the actual video.
+        # 
+        field :expunge_segments, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('expungeSegments') } }
+        # A list of media segments to be added or processed. Each segment includes details such as the URL of the media file and instructions on where it should be inserted in the final media composition. A segment can either specify an exact timestamp  (`insertAt`) or indicate that it should be added at the end (`insertAtEnd`).
+        field :segments, Crystalline::Nilable.new(Crystalline::Array.new(Crystalline::Union.new(Models::Components::VideoInputSegment1, Models::Components::VideoInputSegment2))), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('segments') } }
+
+        sig { params(type: ::String, intro_url: T.nilable(::String), outro_url: T.nilable(::String), expunge_segments: T.nilable(T::Array[::String]), segments: T.nilable(T::Array[T.any(Models::Components::VideoInputSegment1, Models::Components::VideoInputSegment2)])).void }
+        def initialize(type:, intro_url: nil, outro_url: nil, expunge_segments: nil, segments: nil)
+          @type = type
+          @intro_url = intro_url
+          @outro_url = outro_url
+          @expunge_segments = expunge_segments
+          @segments = segments
+        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 @intro_url == other.intro_url
+          return false unless @outro_url == other.outro_url
+          return false unless @expunge_segments == other.expunge_segments
+          return false unless @segments == other.segments
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::VideoInput
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::VideoInput
+  def type(); end
+  def type=(str_); end
+  def intro_url(); end
+  def intro_url=(str_); end
+  def outro_url(); end
+  def outro_url=(str_); end
+  def expunge_segments(); end
+  def expunge_segments=(str_); end
+  def segments(); end
+  def segments=(str_); end
+end

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class VideoInputSegment1
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # URL of the segment to be added.
+        field :url, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url'), required: true } }
+        # The timestamp at which the segment should be inserted.
+        field :insert_at, ::Integer, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('insertAt'), required: true } }
+
+        sig { params(url: ::String, insert_at: ::Integer).void }
+        def initialize(url:, insert_at:)
+          @url = url
+          @insert_at = insert_at
+        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 @insert_at == other.insert_at
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class VideoInputSegment2
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # URL of the segment to be added.
+        field :url, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url'), required: true } }
+        # Flag indicating the segment should be inserted at the end.
+        field :insert_at_end, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('insertAtEnd'), required: true } }
+
+        sig { params(url: ::String, insert_at_end: T::Boolean).void }
+        def initialize(url:, insert_at_end:)
+          @url = url
+          @insert_at_end = insert_at_end
+        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 @insert_at_end == other.insert_at_end
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,27 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class VideoInputSegmentUnion
+        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_client/models/components/videoinput_segment_union.rbi

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

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

@@ -0,0 +1,52 @@
+# 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 VideoTrack
+        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. This option is mandatory.
+        field :type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type') } }
+        # Track width denotes the range of widths applicable to a specific track. Currently, this setting can be modified only for video tracks
+        field :width, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('width') } }
+        # Track height denotes the range of height applicable to a specific track. Currently, this setting can be modified only for video tracks.
+        field :height, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('height') } }
+        # Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
+        field :frame_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('frameRate') } }
+        # 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') } }
+
+        sig { params(id: T.nilable(::String), type: T.nilable(::String), width: T.nilable(::Float), height: T.nilable(::Float), frame_rate: T.nilable(::String), status: T.nilable(::String)).void }
+        def initialize(id: nil, type: nil, width: nil, height: nil, frame_rate: nil, status: nil)
+          @id = id
+          @type = type
+          @width = width
+          @height = height
+          @frame_rate = frame_rate
+          @status = status
+        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 @width == other.width
+          return false unless @height == other.height
+          return false unless @frame_rate == other.frame_rate
+          return false unless @status == other.status
+          true
+        end
+      end
+    end
+  end
+end