fastpixapi 1.0.0 → 1.1.0

data/lib/fastpix_client/models/components/createplaybackid_domains.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 (for example, whether requests from certain websites should be allowed or blocked).
+      class CreatePlaybackIdDomains
+        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 domains 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 domains that are explicitly blocked from accessing the resource.
+        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/createplaybackid_domains.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::CreatePlaybackIdDomains
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::CreatePlaybackIdDomains
+  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/createplaybackid_useragents.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 (which is typically a string sent by browsers or bots identifying themselves).
+      class CreatePlaybackIdUserAgents
+        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 specific user agents that are allowed to access the resource.
+        field :allow, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('allow') } }
+        # A list of specific user agents that are blocked.
+        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/createplaybackid_useragents.rbi

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

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

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

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

@@ -0,0 +1,48 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class CreatePlaylistRequestManual
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Name of the playlist.
+        field :name, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('name'), required: true } }
+        # Unique string value assigned by user to the playlist.
+        field :reference_id, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('referenceId'), required: true } }
+        # Manual playlist type (no `playOrder`).
+        field :type, Models::Components::CreatePlaylistRequestManualType, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::CreatePlaylistRequestManualType, false) } }
+        # Description for a playlist (Optional).
+        field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('description') } }
+        # Optional parameter to limit no. of media in a playlist.
+        field :limit, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('limit') } }
+
+        sig { params(name: ::String, reference_id: ::String, type: Models::Components::CreatePlaylistRequestManualType, description: T.nilable(::String), limit: T.nilable(::Integer)).void }
+        def initialize(name:, reference_id:, type:, description: nil, limit: 1000)
+          @name = name
+          @reference_id = reference_id
+          @type = type
+          @description = description
+          @limit = limit
+        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 @reference_id == other.reference_id
+          return false unless @type == other.type
+          return false unless @description == other.description
+          return false unless @limit == other.limit
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # CreatePlaylistRequestManualType - Manual playlist type (no `playOrder`).
+      class CreatePlaylistRequestManualType < T::Enum
+
+
+        enums do
+          MANUAL = new('manual')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,56 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class CreatePlaylistRequestSmart
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Name of the playlist.
+        field :name, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('name'), required: true } }
+        # Unique string value assigned by user to the playlist.
+        field :reference_id, ::String, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('referenceId'), required: true } }
+        # For a smart playlist metadata is required.
+        field :type, Models::Components::CreatePlaylistRequestSmartType, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('type'), required: true, 'decoder': Utils.enum_from_string(Models::Components::CreatePlaylistRequestSmartType, false) } }
+        # Determines the insertion order of media into playlist.
+        field :play_order, Models::Components::PlaylistOrder, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('playOrder'), required: true, 'decoder': Utils.enum_from_string(Models::Components::PlaylistOrder, false) } }
+        # 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`.
+        field :metadata, Models::Components::Metadata, { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('metadata'), required: true } }
+        # Description for a playlist (Optional).
+        field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('description') } }
+        # Optional parameter to limit no. of media in a playlist.
+        field :limit, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('limit') } }
+
+        sig { params(name: ::String, reference_id: ::String, type: Models::Components::CreatePlaylistRequestSmartType, play_order: Models::Components::PlaylistOrder, metadata: Models::Components::Metadata, description: T.nilable(::String), limit: T.nilable(::Integer)).void }
+        def initialize(name:, reference_id:, type:, play_order:, metadata:, description: nil, limit: 1000)
+          @name = name
+          @reference_id = reference_id
+          @type = type
+          @play_order = play_order
+          @metadata = metadata
+          @description = description
+          @limit = limit
+        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 @reference_id == other.reference_id
+          return false unless @type == other.type
+          return false unless @play_order == other.play_order
+          return false unless @metadata == other.metadata
+          return false unless @description == other.description
+          return false unless @limit == other.limit
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class FastpixClient::Models::Components::CreatePlaylistRequestSmart
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class FastpixClient::Models::Components::CreatePlaylistRequestSmart
+  def name(); end
+  def name=(str_); end
+  def reference_id(); end
+  def reference_id=(str_); end
+  def type(); end
+  def type=(str_); end
+  def play_order(); end
+  def play_order=(str_); end
+  def metadata(); end
+  def metadata=(str_); end
+  def description(); end
+  def description=(str_); end
+  def limit(); end
+  def limit=(str_); end
+end

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

@@ -0,0 +1,20 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # CreatePlaylistRequestSmartType - For a smart playlist metadata is required.
+      class CreatePlaylistRequestSmartType < T::Enum
+
+
+        enums do
+          SMART = new('smart')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,36 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class CreateResponse
+        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') } }
+        # Displays the result of the request.
+        field :data, Crystalline::Nilable.new(Models::Components::CreateSigningKeyResponseDTO), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
+
+        sig { params(success: T.nilable(T::Boolean), data: T.nilable(Models::Components::CreateSigningKeyResponseDTO)).void }
+        def initialize(success: nil, data: nil)
+          @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/createresponse.rbi

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

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

@@ -0,0 +1,40 @@
+# 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 CreateSigningKeyResponseDTO
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A unique identifier is generated by FastPix for the signing keys.
+        field :id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('id') } }
+        # A private key is a byte encoded secret key used to create a signed JSON Web Token (JWT) for authentication.
+        field :private_key, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('privateKey') } }
+        # Time the Signing key was generated, defined as a localDateTime (UTC Time).
+        field :created_at, Crystalline::Nilable.new(::DateTime), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('createdAt'), 'decoder': Utils.datetime_from_iso_format(true) } }
+
+        sig { params(id: T.nilable(::String), private_key: T.nilable(::String), created_at: T.nilable(::DateTime)).void }
+        def initialize(id: nil, private_key: nil, created_at: nil)
+          @id = id
+          @private_key = private_key
+          @created_at = created_at
+        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 @private_key == other.private_key
+          return false unless @created_at == other.created_at
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,43 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+
+      class Custom1
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Unique identifier for a custom dimension used to categorize or segment analytics data (for example, custom_1).
+        # 
+        field :dimension_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('dimensionName') } }
+        # A user-friendly display label that represents the corresponding custom dimension in analytics dashboards and reports; users can assign a specific name based on their tracking needs.
+        # 
+        field :display_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('displayName') } }
+        # Allows assigning user-friendly data values such as email addresses, identifiers, or other meaningful information.
+        # 
+        field :value, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('value') } }
+
+        sig { params(dimension_name: T.nilable(::String), display_name: T.nilable(::String), value: T.nilable(::String)).void }
+        def initialize(dimension_name: nil, display_name: nil, value: nil)
+          @dimension_name = dimension_name
+          @display_name = display_name
+          @value = value
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @dimension_name == other.dimension_name
+          return false unless @display_name == other.display_name
+          return false unless @value == other.value
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # User defined metadata. Only accessible once it is enabled in the organization settings.
+      # 
+      class Custom2
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A list of custom dimension objects.
+        field :custom, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Custom1)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('Custom') } }
+
+        sig { params(custom: T.nilable(T::Array[Models::Components::Custom1])).void }
+        def initialize(custom: nil)
+          @custom = custom
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @custom == other.custom
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,45 @@
+# Generated code for FastPix API SDK.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module FastpixClient
+  module Models
+    module Components
+      # Pagination organizes content into pages for better readability and navigation.
+      class DataPagination
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The total number of records retrieved within the timespan.
+        # 
+        field :total_records, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('totalRecords') } }
+        # The current offset value. 
+        # 
+        # Default: 1
+        # 
+        field :current_offset, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('currentOffset') } }
+        # The total number of offsets based on limit.
+        # 
+        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/datapagination.rbi

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