fastpixapi 0.0.1 → 1.1.0

data/lib/fastpix_client/models/components/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
+      # MediaStatus - Determines the media’s status, which can be one of the possible values.
+      class MediaStatus < 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/media_status.rbi

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

data/lib/fastpix_client/models/components/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 MediaTrack
+        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/media_track.rbi

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

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

@@ -0,0 +1,73 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Response returned when an upload is cancelled.
+      class MediaCancelResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier of the cancelled upload.
+        field :upload_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('uploadId') } }
+        # Indicates if the upload was a trial.
+        field :trial, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('trial') } }
+        # The status of the upload after cancellation.
+        field :status, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status') } }
+        # The upload URL (if available) after cancellation.
+        field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url') } }
+        # CORS origin allowed for the upload.
+        field :cors_origin, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('corsOrigin') } }
+        # The maximum resolution allowed for the upload.
+        field :max_resolution, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('maxResolution') } }
+        # The access policy for the upload.
+        field :access_policy, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('accessPolicy') } }
+        # You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
+        # 
+        field :metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('metadata') } }
+        # The timeout value for the upload.
+        field :timeout, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('timeout') } }
+        # Title of the media file.
+        field :title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('title') } }
+        # The unique identifier of the user who created this media.
+        field :creator_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('creatorId') } }
+
+        sig { params(upload_id: T.nilable(::String), trial: T.nilable(T::Boolean), status: T.nilable(::String), url: T.nilable(::String), cors_origin: T.nilable(::String), max_resolution: T.nilable(::String), access_policy: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::String]), timeout: T.nilable(::Integer), title: T.nilable(::String), creator_id: T.nilable(::String)).void }
+        def initialize(upload_id: nil, trial: nil, status: nil, url: nil, cors_origin: nil, max_resolution: nil, access_policy: nil, metadata: nil, timeout: nil, title: nil, creator_id: nil)
+          @upload_id = upload_id
+          @trial = trial
+          @status = status
+          @url = url
+          @cors_origin = cors_origin
+          @max_resolution = max_resolution
+          @access_policy = access_policy
+          @metadata = metadata
+          @timeout = timeout
+          @title = title
+          @creator_id = creator_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @upload_id == other.upload_id
+          return false unless @trial == other.trial
+          return false unless @status == other.status
+          return false unless @url == other.url
+          return false unless @cors_origin == other.cors_origin
+          return false unless @max_resolution == other.max_resolution
+          return false unless @access_policy == other.access_policy
+          return false unless @metadata == other.metadata
+          return false unless @timeout == other.timeout
+          return false unless @title == other.title
+          return false unless @creator_id == other.creator_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::MediaCancelResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::MediaCancelResponse
+  def upload_id(); end
+  def upload_id=(str_); end
+  def trial(); end
+  def trial=(str_); end
+  def status(); end
+  def status=(str_); end
+  def url(); end
+  def url=(str_); end
+  def cors_origin(); end
+  def cors_origin=(str_); end
+  def max_resolution(); end
+  def max_resolution=(str_); end
+  def access_policy(); end
+  def access_policy=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+  def timeout(); end
+  def timeout=(str_); end
+  def title(); end
+  def title=(str_); end
+  def creator_id(); end
+  def creator_id=(str_); end
+end

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

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class MediaClipResponse
+        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') } }
+
+        field :data, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::MediaClipResponseData)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+
+        field :pagination, Crystalline::Nilable.new(Models::Components::MediaClipResponsePagination), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('pagination') } }
+
+        sig { params(success: T.nilable(T::Boolean), data: T.nilable(T::Array[Models::Components::MediaClipResponseData]), pagination: T.nilable(Models::Components::MediaClipResponsePagination)).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/components/mediaclipresponse.rbi

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

@@ -0,0 +1,52 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class MediaClipResponseData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier assigned to the media by FastPix.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # Duration of the media in HH:MM:SS format.
+        field :duration, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('duration') } }
+        # The current processing status of the media.
+        field :status, Crystalline::Nilable.new(Models::Components::MediaClipResponseStatus), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status'), 'decoder': Utils.enum_from_string(Models::Components::MediaClipResponseStatus, true) } }
+        # A video thumbnail that acts as a preview image for the video.
+        field :thumbnail, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('thumbnail') } }
+        # Timestamp of when the media was created.
+        field :created_at, Crystalline::Nilable.new(::DateTime), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('createdAt'), 'decoder': Utils.datetime_from_iso_format(true) } }
+
+        field :playback_ids, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::MediaClipResponsePlaybackId)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('playbackIds') } }
+
+        sig { params(id: T.nilable(::String), duration: T.nilable(::String), status: T.nilable(Models::Components::MediaClipResponseStatus), thumbnail: T.nilable(::String), created_at: T.nilable(::DateTime), playback_ids: T.nilable(T::Array[Models::Components::MediaClipResponsePlaybackId])).void }
+        def initialize(id: nil, duration: nil, status: nil, thumbnail: nil, created_at: nil, playback_ids: nil)
+          @id = id
+          @duration = duration
+          @status = status
+          @thumbnail = thumbnail
+          @created_at = created_at
+          @playback_ids = playback_ids
+        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 @duration == other.duration
+          return false unless @status == other.status
+          return false unless @thumbnail == other.thumbnail
+          return false unless @created_at == other.created_at
+          return false unless @playback_ids == other.playback_ids
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::MediaClipResponseData
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::MediaClipResponseData
+  def id(); end
+  def id=(str_); end
+  def duration(); end
+  def duration=(str_); end
+  def status(); end
+  def status=(str_); end
+  def thumbnail(); end
+  def thumbnail=(str_); end
+  def created_at(); end
+  def created_at=(str_); end
+  def playback_ids(); end
+  def playback_ids=(str_); end
+end

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

@@ -0,0 +1,40 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class MediaClipResponsePagination
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Total number of records available.
+        field :total_records, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('totalRecords') } }
+        # The starting offset of the current result set.
+        field :current_offset, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('currentOffset') } }
+        # The number of items returned in the current response.
+        field :offset_count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('offsetCount') } }
+
+        sig { params(total_records: T.nilable(::Integer), current_offset: T.nilable(::Integer), offset_count: T.nilable(::Integer)).void }
+        def initialize(total_records: nil, current_offset: nil, offset_count: nil)
+          @total_records = total_records
+          @current_offset = current_offset
+          @offset_count = offset_count
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @total_records == other.total_records
+          return false unless @current_offset == other.current_offset
+          return false unless @offset_count == other.offset_count
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::MediaClipResponsePagination
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::MediaClipResponsePagination
+  def total_records(); end
+  def total_records=(str_); end
+  def current_offset(); end
+  def current_offset=(str_); end
+  def offset_count(); end
+  def offset_count=(str_); end
+end

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class MediaClipResponsePlaybackId
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier for playback.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # The access policy of the playback.
+        field :access_policy, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('accessPolicy') } }
+
+        sig { params(id: T.nilable(::String), access_policy: T.nilable(::String)).void }
+        def initialize(id: nil, access_policy: nil)
+          @id = id
+          @access_policy = access_policy
+        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 @access_policy == other.access_policy
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,27 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # MediaClipResponseStatus - The current processing status of the media.
+      class MediaClipResponseStatus < 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/mediaclipresponse_status.rbi

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

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

@@ -0,0 +1,32 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # The list of mediaId(s) you want to perform the operation on.
+      class MediaIdsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :media_ids, Crystalline::Array.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('mediaIds'), required: true } }
+
+        sig { params(media_ids: T::Array[::String]).void }
+        def initialize(media_ids:)
+          @media_ids = media_ids
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @media_ids == other.media_ids
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # MediaType - Type of media content
+      class MediaType < T::Enum
+
+
+        enums do
+          VIDEO = new('video')
+          AUDIO = new('audio')
+          AV = new('av')
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastpix_client/models/components/metadata.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 Metadata
+        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/metadata.rbi

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

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