fastpixapi 0.0.1 → 1.1.0

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Date range with start and end dates.
+      class DateRange
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :start_date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('startDate') } }
+
+        field :end_date, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('endDate') } }
+
+        sig { params(start_date: T.nilable(::String), end_date: T.nilable(::String)).void }
+        def initialize(start_date: nil, end_date: nil)
+          @start_date = start_date
+          @end_date = end_date
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @start_date == other.start_date
+          return false unless @end_date == other.end_date
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class DefaultError
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Shows if the request was completed successfully. 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') } }
+        # Contains details about the error if the request failed.
+        field :error, Crystalline::Nilable.new(Models::Components::Error), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('error') } }
+
+        sig { params(success: T.nilable(T::Boolean), error: T.nilable(Models::Components::Error)).void }
+        def initialize(success: nil, error: nil)
+          @success = success
+          @error = error
+        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 @error == other.error
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

@@ -0,0 +1,57 @@
+# 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 DirectUpload
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The unique identifier assigned to the media when created. The value must be a valid UUID.
+        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') } }
+        # Determines the media's status, which can be one of the possible values.
+        field :status, Crystalline::Nilable.new(Models::Components::DirectUploadStatus), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('status'), 'decoder': Utils.enum_from_string(Models::Components::DirectUploadStatus, true) } }
+        # The url hosts the media file for FastPix, which needs to be download to use further.  It supports formats like MP3, MP4, MOV, MKV, or TS, and includes text tracks for subtitles/CC (SRT file/VTT file). While FastPix can handle various audio and video formats and codecs, using standard inputs can help with optimal processing speed.
+        field :url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('url') } }
+        # Upload media directly from a device using the url name or enter "*" to allow all.
+        field :cors_origin, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('corsOrigin') } }
+
+        field :push_media_settings, Crystalline::Nilable.new(Models::Components::DirectUploadResponse), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('pushMediaSettings') } }
+        # The duration set for the validity of the upload URL. If the upload isn't completed within this timespan, it's marked as timed out.
+        # 
+        field :timeout, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('timeout') } }
+
+        sig { params(upload_id: T.nilable(::String), trial: T.nilable(T::Boolean), status: T.nilable(Models::Components::DirectUploadStatus), url: T.nilable(::String), cors_origin: T.nilable(::String), push_media_settings: T.nilable(Models::Components::DirectUploadResponse), timeout: T.nilable(::Float)).void }
+        def initialize(upload_id: nil, trial: nil, status: nil, url: nil, cors_origin: nil, push_media_settings: nil, timeout: 14_400.0)
+          @upload_id = upload_id
+          @trial = trial
+          @status = status
+          @url = url
+          @cors_origin = cors_origin
+          @push_media_settings = push_media_settings
+          @timeout = timeout
+        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 @push_media_settings == other.push_media_settings
+          return false unless @timeout == other.timeout
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::DirectUpload
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::DirectUpload
+  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 push_media_settings(); end
+  def push_media_settings=(str_); end
+  def timeout(); end
+  def timeout=(str_); end
+end

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

@@ -0,0 +1,20 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # DirectUploadStatus - Determines the media's status, which can be one of the possible values.
+      class DirectUploadStatus < T::Enum
+
+
+        enums do
+          WAITING = new('waiting')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,51 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class DirectUploadResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :playback_ids, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::PlaybackId)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('playbackIds') } }
+        # 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 quality tier applied to the media.
+        field :media_quality, Crystalline::Nilable.new(Models::Components::DirectUploadResponseMediaQuality), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('mediaQuality'), 'decoder': Utils.enum_from_string(Models::Components::DirectUploadResponseMediaQuality, true) } }
+        # The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it.
+        # 
+        field :source_access, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('sourceAccess') } }
+        # Enhance the quality and volume of the audio track. This is available for pre-recorded content only.
+        # 
+        field :optimize_audio, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('optimizeAudio') } }
+
+        sig { params(playback_ids: T.nilable(T::Array[Models::Components::PlaybackId]), metadata: T.nilable(T::Hash[Symbol, ::String]), media_quality: T.nilable(Models::Components::DirectUploadResponseMediaQuality), source_access: T.nilable(T::Boolean), optimize_audio: T.nilable(T::Boolean)).void }
+        def initialize(playback_ids: nil, metadata: nil, media_quality: nil, source_access: nil, optimize_audio: nil)
+          @playback_ids = playback_ids
+          @metadata = metadata
+          @media_quality = media_quality
+          @source_access = source_access
+          @optimize_audio = optimize_audio
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @playback_ids == other.playback_ids
+          return false unless @metadata == other.metadata
+          return false unless @media_quality == other.media_quality
+          return false unless @source_access == other.source_access
+          return false unless @optimize_audio == other.optimize_audio
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::DirectUploadResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::DirectUploadResponse
+  def playback_ids(); end
+  def playback_ids=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+  def media_quality(); end
+  def media_quality=(str_); end
+  def source_access(); end
+  def source_access=(str_); end
+  def optimize_audio(); end
+  def optimize_audio=(str_); end
+end

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

@@ -0,0 +1,22 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # DirectUploadResponseMediaQuality - The quality tier applied to the media.
+      class DirectUploadResponseMediaQuality < T::Enum
+
+
+        enums do
+          STANDARD = new('standard')
+          PRO = new('pro')
+          PREMIUM = new('premium')
+        end
+      end
+    end
+  end
+end

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

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

data/lib/fastpix_client/models/components/domainrestrictions.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 originating domain of a request
+      class DomainRestrictions
+        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 domain names or patterns 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 domain names or patterns 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/domainrestrictions.rbi

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,41 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Contains details about the error if the request failed.
+      class Error
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The HTTP status code that explains the type of error (for example, 400 for a bad request, 404 for not found).
+        field :code, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('code') } }
+        # A short message describing what went wrong.
+        field :message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('message') } }
+        # A detailed explanation of the error and what caused it. May also include links to documentation or tips for fixing the issue.  
+        # 
+        field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('description') } }
+
+        sig { params(code: T.nilable(::Integer), message: T.nilable(::String), description: T.nilable(::String)).void }
+        def initialize(code: nil, message: nil, description: nil)
+          @code = code
+          @message = message
+          @description = description
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @code == other.code
+          return false unless @message == other.message
+          return false unless @description == other.description
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::Error
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::Error
+  def code(); end
+  def code=(str_); end
+  def message(); end
+  def message=(str_); end
+  def description(); end
+  def description=(str_); end
+end

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

@@ -0,0 +1,60 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class ErrorDetails
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # views affected by the specific errors.
+        field :percentage, Crystalline::Nilable.new(Crystalline::Union.new(::Integer, ::Float)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('percentage') } }
+        # Information about the specific error.
+        field :notes, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('notes') } }
+        # error message or description.
+        field :message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('message') } }
+        # The timestamp of when the error was last observed.
+        field :last_seen, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('lastSeen') } }
+        # Unique identifier for the error instance.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # A brief description of the error.
+        field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('description') } }
+        # Number of occurrences of the specific error.
+        field :count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('count') } }
+        # Error code associated with the specific error.
+        field :code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('code') } }
+
+        sig { params(percentage: T.nilable(T.any(::Integer, ::Float)), notes: T.nilable(::String), message: T.nilable(::String), last_seen: T.nilable(::String), id: T.nilable(::String), description: T.nilable(::String), count: T.nilable(::Integer), code: T.nilable(::String)).void }
+        def initialize(percentage: nil, notes: nil, message: nil, last_seen: nil, id: nil, description: nil, count: nil, code: nil)
+          @percentage = percentage
+          @notes = notes
+          @message = message
+          @last_seen = last_seen
+          @id = id
+          @description = description
+          @count = count
+          @code = code
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @percentage == other.percentage
+          return false unless @notes == other.notes
+          return false unless @message == other.message
+          return false unless @last_seen == other.last_seen
+          return false unless @id == other.id
+          return false unless @description == other.description
+          return false unless @count == other.count
+          return false unless @code == other.code
+          true
+        end
+      end
+    end
+  end
+end