fastpixapi 0.0.1 → 1.1.0

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Required when the playlist type is `smart`. Media created between `startDate` and `endDate` of `createdDate` is added. Optionally, you can include media based on `updatedDate`.
+      class PlaylistByIdResponseMetadata
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Date range with start and end dates.
+        field :created_date, Crystalline::Nilable.new(Models::Components::DateRange), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('createdDate') } }
+        # Date range with start and end dates.
+        field :updated_date, Crystalline::Nilable.new(Models::Components::DateRange), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('updatedDate') } }
+
+        sig { params(created_date: T.nilable(Models::Components::DateRange), updated_date: T.nilable(Models::Components::DateRange)).void }
+        def initialize(created_date: nil, updated_date: nil)
+          @created_date = created_date
+          @updated_date = updated_date
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @created_date == other.created_date
+          return false unless @updated_date == other.updated_date
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Displays the result of the request.
+      class PlaylistCreatedResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Shows the request status. Returns true for success and false for failure.
+        field :success, Crystalline::Boolean.new, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success'), required: true } }
+
+        field :data, Crystalline::Union.new(Models::Components::PlaylistByIdResponseDataManual, Models::Components::PlaylistByIdResponseDataSmart), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data'), required: true }, 'discriminator': 'type', 'discriminator_mapping': { 'manual' => Models::Components::PlaylistByIdResponseDataManual, 'smart' => Models::Components::PlaylistByIdResponseDataSmart } }
+
+        sig { params(success: T::Boolean, data: T.any(Models::Components::PlaylistByIdResponseDataManual, Models::Components::PlaylistByIdResponseDataSmart)).void }
+        def initialize(success:, data:)
+          @success = success
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @success == other.success
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

@@ -0,0 +1,32 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class PlaylistDeleteResponse
+        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') } }
+
+        sig { params(success: T.nilable(T::Boolean)).void }
+        def initialize(success: nil)
+          @success = success
+        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
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,52 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class PlaylistItem
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique id of the playlist
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # The name of the playlist set by the user
+        field :name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('name') } }
+        # type of the playlist, when it was created
+        field :type, Crystalline::Nilable.new(Models::Components::PlaylistItemType), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), 'decoder': Utils.enum_from_string(Models::Components::PlaylistItemType, true) } }
+        # Unique string value assigned by user to the playlist.
+        field :reference_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('referenceId') } }
+        # Timestamp of playlist creation.
+        field :created_at, Crystalline::Nilable.new(::DateTime), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('createdAt'), 'decoder': Utils.datetime_from_iso_format(true) } }
+        # No. of media present in the playlist
+        field :media_count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('mediaCount') } }
+
+        sig { params(id: T.nilable(::String), name: T.nilable(::String), type: T.nilable(Models::Components::PlaylistItemType), reference_id: T.nilable(::String), created_at: T.nilable(::DateTime), media_count: T.nilable(::Integer)).void }
+        def initialize(id: nil, name: nil, type: nil, reference_id: nil, created_at: nil, media_count: nil)
+          @id = id
+          @name = name
+          @type = type
+          @reference_id = reference_id
+          @created_at = created_at
+          @media_count = media_count
+        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 @name == other.name
+          return false unless @type == other.type
+          return false unless @reference_id == other.reference_id
+          return false unless @created_at == other.created_at
+          return false unless @media_count == other.media_count
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::PlaylistItem
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::PlaylistItem
+  def id(); end
+  def id=(str_); end
+  def name(); end
+  def name=(str_); end
+  def type(); end
+  def type=(str_); end
+  def reference_id(); end
+  def reference_id=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def media_count(); end
+  def media_count=(str_); end
+end

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # PlaylistItemType - type of the playlist, when it was created
+      class PlaylistItemType < T::Enum
+
+
+        enums do
+          MANUAL = new('manual')
+          SMART = new('smart')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # PlaylistOrder - Determines the insertion order of media into playlist.
+      class PlaylistOrder < T::Enum
+
+
+        enums do
+          CREATED_DATE_ASC = new('createdDate ASC')
+          CREATED_DATE_DESC = new('createdDate DESC')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # PolicyAction - Policy action type
+      class PolicyAction < T::Enum
+
+
+        enums do
+          ALLOW = new('allow')
+          DENY = new('deny')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,28 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Represents the unique identifier assigned to a FastPix property, which is associated with a specific workspace or project. It helps link playback and analytics data to the correct property configuration.
+      # 
+      class PropertyId
+        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/propertyid.rbi

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

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

@@ -0,0 +1,73 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class PullVideoInput
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Start time indicates where encoding must begin within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the start time is 3 minutes (180 seconds). Note: Start time is always mentioned in seconds.
+        # 
+        field :start_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('startTime') } }
+        # End time indicates where encoding must end within the video file. For example, if you want to encode a segment from 3 minutes (180 seconds) to 6 minutes (360 seconds) in a 10-minute (600 seconds) video, the end time is 6 minutes (360 seconds). Note: End time is always mentioned in seconds.
+        # 
+        field :end_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('endTime') } }
+        # The URL of the **intro video** to be added at the beginning of the media file.  
+        # The URL must be **valid, publicly accessible, and downloadable** so that FastPix can fetch the file successfully.  
+        # Supported video formats include **MP4, MOV, MKV, and TS** for optimal processing performance.
+        # 
+        field :intro_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('introUrl') } }
+        # The URL of the **outro video** to be added at the end of the media file.  
+        # The URL must be **valid, publicly accessible, and downloadable** so that FastPix can retrieve the file successfully.  
+        # Supported video formats include **MP4, MOV, MKV, and TS** for best compatibility and processing speed.
+        # 
+        field :outro_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('outroUrl') } }
+        # The list of start and end times (in seconds) 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 must be added at the end (`insertAtEnd`).
+        field :segments, Crystalline::Nilable.new(Crystalline::Array.new(Crystalline::Union.new(Models::Components::PullVideoInputSegment1, Models::Components::PullVideoInputSegment2))), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('segments') } }
+        # Defines the type of input.
+        # 
+        field :type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type') } }
+        # The URL hosts the media file for FastPix, which needs to be downloaded to use further. It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles or closed captions (SRT/VTT files). The URL must be valid, publicly accessible, and downloadable to ensure FastPix can fetch the file successfully.
+        # 
+        # While FastPix can handle various audio and video formats and codecs, using standard and widely supported formats helps achieve optimal processing speed.
+        # 
+        field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url') } }
+
+        sig { params(start_time: T.nilable(::Integer), end_time: T.nilable(::Integer), 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::PullVideoInputSegment1, Models::Components::PullVideoInputSegment2)]), type: T.nilable(::String), url: T.nilable(::String)).void }
+        def initialize(start_time: nil, end_time: nil, intro_url: nil, outro_url: nil, expunge_segments: nil, segments: nil, type: 'video', url: 'https://static.fastpix.io/fp-sample-video.mp4')
+          @start_time = start_time
+          @end_time = end_time
+          @intro_url = intro_url
+          @outro_url = outro_url
+          @expunge_segments = expunge_segments
+          @segments = segments
+          @type = type
+          @url = url
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @start_time == other.start_time
+          return false unless @end_time == other.end_time
+          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
+          return false unless @type == other.type
+          return false unless @url == other.url
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::PullVideoInput
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::PullVideoInput
+  def start_time(); end
+  def start_time=(str_); end
+  def end_time(); end
+  def end_time=(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
+  def type(); end
+  def type=(str_); end
+  def url(); end
+  def url=(str_); end
+end

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

@@ -0,0 +1,39 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class PullVideoInputSegment1
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The URL of the **video segment** to be added.  
+        # The URL must be **valid, publicly accessible, and downloadable** so that FastPix can retrieve and process the segment successfully.  
+        # Supported video formats include **MP4, MOV, MKV, and TS** for best compatibility and performance.
+        # 
+        field :url, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url'), required: true } }
+        # The timestamp(in seconds) at which the segment must 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/pullvideoinput_segment_1.rbi

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

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

@@ -0,0 +1,39 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class PullVideoInputSegment2
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The URL of the **video segment** to be added.  
+        # The URL must be **valid, publicly accessible, and downloadable** so that FastPix can retrieve and process the segment successfully.  
+        # Supported video formats include **MP4, MOV, MKV, and TS** for best compatibility and performance.
+        # 
+        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/pullvideoinput_segment_2.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::PullVideoInputSegment2
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::PullVideoInputSegment2
+  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/pullvideoinput_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 PullVideoInputSegmentUnion
+        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