ittybit 0.7.4

data/lib/ittybit/types/file.rb

@@ -0,0 +1,319 @@
+# frozen_string_literal: true
+
+require_relative "file_object"
+require_relative "file_kind"
+require "date"
+require_relative "file_status"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class File
+    # @return [String] Unique identifier for the file.
+    attr_reader :id
+    # @return [String] Identifier for the parent media object.
+    attr_reader :media_id
+    # @return [Ittybit::FileObject] Object type
+    attr_reader :object
+    # @return [Ittybit::FileKind] The general type of media.
+    attr_reader :kind
+    # @return [String] MIME type.
+    attr_reader :type
+    # @return [String] Codec of the file.
+    attr_reader :codec
+    # @return [String] Container of the file.
+    attr_reader :container
+    # @return [Integer] Width in pixels (for image/video).
+    attr_reader :width
+    # @return [Integer] Height in pixels (for image/video).
+    attr_reader :height
+    # @return [String] Orientation of the file.
+    attr_reader :orientation
+    # @return [Float] Rotation value for image files with embedded EXIF data.
+    attr_reader :rotation
+    # @return [Boolean] Indicates if the file has alpha channel.
+    attr_reader :transparency
+    # @return [Boolean] Indicates if the file is animated (image only).
+    attr_reader :animated
+    # @return [Integer] Number of frames in the file.
+    attr_reader :frames
+    # @return [Float] Duration in seconds (for audio/video).
+    attr_reader :duration
+    # @return [Float] Frames per second (for video).
+    attr_reader :fps
+    # @return [Integer] File size in bytes.
+    attr_reader :filesize
+    # @return [Integer] Bitrate for audio/video files.
+    attr_reader :bitrate
+    # @return [String] Language code (e.g., en, es, fr).
+    attr_reader :language
+    # @return [String] Label to be used by players (tracks only).
+    attr_reader :label
+    # @return [String] Optional reference value. If set, the file URL will be included in the parent
+    #  media `urls` object.
+    attr_reader :ref
+    # @return [String] The folder path where the file is stored.
+    attr_reader :folder
+    # @return [String] The name of the file.
+    attr_reader :filename
+    # @return [String] Publicly accessible URL for the file.
+    attr_reader :url
+    # @return [String] Base64 encoded placeholder image for the file.
+    attr_reader :placeholder
+    # @return [String] Dominant background color hex code.
+    attr_reader :background
+    # @return [Hash{String => Object}] User-defined key-value metadata.
+    attr_reader :metadata
+    # @return [Boolean] Indicates this is the original file rather than a variant.
+    attr_reader :original
+    # @return [String] ID of the entity (e.g., task, automation, or upload request) that created this
+    #  file.
+    attr_reader :created_by
+    # @return [DateTime] Timestamp when the file record was created.
+    attr_reader :created
+    # @return [DateTime] Timestamp when the file record was last updated.
+    attr_reader :updated
+    # @return [Ittybit::FileStatus] Processing status of the file.
+    attr_reader :status
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] Unique identifier for the file.
+    # @param media_id [String] Identifier for the parent media object.
+    # @param object [Ittybit::FileObject] Object type
+    # @param kind [Ittybit::FileKind] The general type of media.
+    # @param type [String] MIME type.
+    # @param codec [String] Codec of the file.
+    # @param container [String] Container of the file.
+    # @param width [Integer] Width in pixels (for image/video).
+    # @param height [Integer] Height in pixels (for image/video).
+    # @param orientation [String] Orientation of the file.
+    # @param rotation [Float] Rotation value for image files with embedded EXIF data.
+    # @param transparency [Boolean] Indicates if the file has alpha channel.
+    # @param animated [Boolean] Indicates if the file is animated (image only).
+    # @param frames [Integer] Number of frames in the file.
+    # @param duration [Float] Duration in seconds (for audio/video).
+    # @param fps [Float] Frames per second (for video).
+    # @param filesize [Integer] File size in bytes.
+    # @param bitrate [Integer] Bitrate for audio/video files.
+    # @param language [String] Language code (e.g., en, es, fr).
+    # @param label [String] Label to be used by players (tracks only).
+    # @param ref [String] Optional reference value. If set, the file URL will be included in the parent
+    #  media `urls` object.
+    # @param folder [String] The folder path where the file is stored.
+    # @param filename [String] The name of the file.
+    # @param url [String] Publicly accessible URL for the file.
+    # @param placeholder [String] Base64 encoded placeholder image for the file.
+    # @param background [String] Dominant background color hex code.
+    # @param metadata [Hash{String => Object}] User-defined key-value metadata.
+    # @param original [Boolean] Indicates this is the original file rather than a variant.
+    # @param created_by [String] ID of the entity (e.g., task, automation, or upload request) that created this
+    #  file.
+    # @param created [DateTime] Timestamp when the file record was created.
+    # @param updated [DateTime] Timestamp when the file record was last updated.
+    # @param status [Ittybit::FileStatus] Processing status of the file.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Ittybit::File]
+    def initialize(id:, media_id:, object:, kind:, type:, filesize:, url:, created:, updated:, status:, codec: OMIT, container: OMIT, width: OMIT, height: OMIT,
+                   orientation: OMIT, rotation: OMIT, transparency: OMIT, animated: OMIT, frames: OMIT, duration: OMIT, fps: OMIT, bitrate: OMIT, language: OMIT, label: OMIT, ref: OMIT, folder: OMIT, filename: OMIT, placeholder: OMIT, background: OMIT, metadata: OMIT, original: OMIT, created_by: OMIT, additional_properties: nil)
+      @id = id
+      @media_id = media_id
+      @object = object
+      @kind = kind
+      @type = type
+      @codec = codec if codec != OMIT
+      @container = container if container != OMIT
+      @width = width if width != OMIT
+      @height = height if height != OMIT
+      @orientation = orientation if orientation != OMIT
+      @rotation = rotation if rotation != OMIT
+      @transparency = transparency if transparency != OMIT
+      @animated = animated if animated != OMIT
+      @frames = frames if frames != OMIT
+      @duration = duration if duration != OMIT
+      @fps = fps if fps != OMIT
+      @filesize = filesize
+      @bitrate = bitrate if bitrate != OMIT
+      @language = language if language != OMIT
+      @label = label if label != OMIT
+      @ref = ref if ref != OMIT
+      @folder = folder if folder != OMIT
+      @filename = filename if filename != OMIT
+      @url = url
+      @placeholder = placeholder if placeholder != OMIT
+      @background = background if background != OMIT
+      @metadata = metadata if metadata != OMIT
+      @original = original if original != OMIT
+      @created_by = created_by if created_by != OMIT
+      @created = created
+      @updated = updated
+      @status = status
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "media_id": media_id,
+        "object": object,
+        "kind": kind,
+        "type": type,
+        "codec": codec,
+        "container": container,
+        "width": width,
+        "height": height,
+        "orientation": orientation,
+        "rotation": rotation,
+        "transparency": transparency,
+        "animated": animated,
+        "frames": frames,
+        "duration": duration,
+        "fps": fps,
+        "filesize": filesize,
+        "bitrate": bitrate,
+        "language": language,
+        "label": label,
+        "ref": ref,
+        "folder": folder,
+        "filename": filename,
+        "url": url,
+        "placeholder": placeholder,
+        "background": background,
+        "metadata": metadata,
+        "original": original,
+        "created_by": created_by,
+        "created": created,
+        "updated": updated,
+        "status": status
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of File
+    #
+    # @param json_object [String]
+    # @return [Ittybit::File]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      media_id = parsed_json["media_id"]
+      object = parsed_json["object"]
+      kind = parsed_json["kind"]
+      type = parsed_json["type"]
+      codec = parsed_json["codec"]
+      container = parsed_json["container"]
+      width = parsed_json["width"]
+      height = parsed_json["height"]
+      orientation = parsed_json["orientation"]
+      rotation = parsed_json["rotation"]
+      transparency = parsed_json["transparency"]
+      animated = parsed_json["animated"]
+      frames = parsed_json["frames"]
+      duration = parsed_json["duration"]
+      fps = parsed_json["fps"]
+      filesize = parsed_json["filesize"]
+      bitrate = parsed_json["bitrate"]
+      language = parsed_json["language"]
+      label = parsed_json["label"]
+      ref = parsed_json["ref"]
+      folder = parsed_json["folder"]
+      filename = parsed_json["filename"]
+      url = parsed_json["url"]
+      placeholder = parsed_json["placeholder"]
+      background = parsed_json["background"]
+      metadata = parsed_json["metadata"]
+      original = parsed_json["original"]
+      created_by = parsed_json["created_by"]
+      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
+      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
+      status = parsed_json["status"]
+      new(
+        id: id,
+        media_id: media_id,
+        object: object,
+        kind: kind,
+        type: type,
+        codec: codec,
+        container: container,
+        width: width,
+        height: height,
+        orientation: orientation,
+        rotation: rotation,
+        transparency: transparency,
+        animated: animated,
+        frames: frames,
+        duration: duration,
+        fps: fps,
+        filesize: filesize,
+        bitrate: bitrate,
+        language: language,
+        label: label,
+        ref: ref,
+        folder: folder,
+        filename: filename,
+        url: url,
+        placeholder: placeholder,
+        background: background,
+        metadata: metadata,
+        original: original,
+        created_by: created_by,
+        created: created,
+        updated: updated,
+        status: status,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of File to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.media_id.is_a?(String) != false || raise("Passed value for field obj.media_id is not the expected type, validation failed.")
+      obj.object.is_a?(Ittybit::FileObject) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
+      obj.kind.is_a?(Ittybit::FileKind) != false || raise("Passed value for field obj.kind is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.codec&.is_a?(String) != false || raise("Passed value for field obj.codec is not the expected type, validation failed.")
+      obj.container&.is_a?(String) != false || raise("Passed value for field obj.container is not the expected type, validation failed.")
+      obj.width&.is_a?(Integer) != false || raise("Passed value for field obj.width is not the expected type, validation failed.")
+      obj.height&.is_a?(Integer) != false || raise("Passed value for field obj.height is not the expected type, validation failed.")
+      obj.orientation&.is_a?(String) != false || raise("Passed value for field obj.orientation is not the expected type, validation failed.")
+      obj.rotation&.is_a?(Float) != false || raise("Passed value for field obj.rotation is not the expected type, validation failed.")
+      obj.transparency&.is_a?(Boolean) != false || raise("Passed value for field obj.transparency is not the expected type, validation failed.")
+      obj.animated&.is_a?(Boolean) != false || raise("Passed value for field obj.animated is not the expected type, validation failed.")
+      obj.frames&.is_a?(Integer) != false || raise("Passed value for field obj.frames is not the expected type, validation failed.")
+      obj.duration&.is_a?(Float) != false || raise("Passed value for field obj.duration is not the expected type, validation failed.")
+      obj.fps&.is_a?(Float) != false || raise("Passed value for field obj.fps is not the expected type, validation failed.")
+      obj.filesize.is_a?(Integer) != false || raise("Passed value for field obj.filesize is not the expected type, validation failed.")
+      obj.bitrate&.is_a?(Integer) != false || raise("Passed value for field obj.bitrate is not the expected type, validation failed.")
+      obj.language&.is_a?(String) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+      obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
+      obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
+      obj.folder&.is_a?(String) != false || raise("Passed value for field obj.folder is not the expected type, validation failed.")
+      obj.filename&.is_a?(String) != false || raise("Passed value for field obj.filename is not the expected type, validation failed.")
+      obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      obj.placeholder&.is_a?(String) != false || raise("Passed value for field obj.placeholder is not the expected type, validation failed.")
+      obj.background&.is_a?(String) != false || raise("Passed value for field obj.background is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+      obj.original&.is_a?(Boolean) != false || raise("Passed value for field obj.original is not the expected type, validation failed.")
+      obj.created_by&.is_a?(String) != false || raise("Passed value for field obj.created_by is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+      obj.status.is_a?(Ittybit::FileStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/ittybit/types/file_kind.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ittybit
+  # The general type of media.
+  class FileKind
+    VIDEO = "video"
+    IMAGE = "image"
+    AUDIO = "audio"
+  end
+end

data/lib/ittybit/types/file_list_response.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "meta_list"
+require_relative "file"
+require_relative "links_list"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class FileListResponse
+    # @return [Ittybit::MetaList]
+    attr_reader :meta
+    # @return [Array<Ittybit::File>]
+    attr_reader :data
+    # @return [Ittybit::LinksList]
+    attr_reader :links
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param meta [Ittybit::MetaList]
+    # @param data [Array<Ittybit::File>]
+    # @param links [Ittybit::LinksList]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Ittybit::FileListResponse]
+    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+      @meta = meta if meta != OMIT
+      @data = data if data != OMIT
+      @links = links if links != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FileListResponse
+    #
+    # @param json_object [String]
+    # @return [Ittybit::FileListResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["meta"].nil?
+        meta = nil
+      else
+        meta = parsed_json["meta"].to_json
+        meta = Ittybit::MetaList.from_json(json_object: meta)
+      end
+      data = parsed_json["data"]&.map do |item|
+        item = item.to_json
+        Ittybit::File.from_json(json_object: item)
+      end
+      if parsed_json["links"].nil?
+        links = nil
+      else
+        links = parsed_json["links"].to_json
+        links = Ittybit::LinksList.from_json(json_object: links)
+      end
+      new(
+        meta: meta,
+        data: data,
+        links: links,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FileListResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.meta.nil? || Ittybit::MetaList.validate_raw(obj: obj.meta)
+      obj.data&.is_a?(Array) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+      obj.links.nil? || Ittybit::LinksList.validate_raw(obj: obj.links)
+    end
+  end
+end

data/lib/ittybit/types/file_object.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ittybit
+  # Object type
+  class FileObject
+    SOURCE = "source"
+    TRACK = "track"
+    INTELLIGENCE = "intelligence"
+  end
+end

data/lib/ittybit/types/file_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "meta"
+require_relative "file"
+require_relative "links"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class FileResponse
+    # @return [Ittybit::META]
+    attr_reader :meta
+    # @return [Ittybit::File]
+    attr_reader :data
+    # @return [Ittybit::Links]
+    attr_reader :links
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param meta [Ittybit::META]
+    # @param data [Ittybit::File]
+    # @param links [Ittybit::Links]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Ittybit::FileResponse]
+    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+      @meta = meta if meta != OMIT
+      @data = data if data != OMIT
+      @links = links if links != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FileResponse
+    #
+    # @param json_object [String]
+    # @return [Ittybit::FileResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      meta = parsed_json["meta"]
+      if parsed_json["data"].nil?
+        data = nil
+      else
+        data = parsed_json["data"].to_json
+        data = Ittybit::File.from_json(json_object: data)
+      end
+      if parsed_json["links"].nil?
+        links = nil
+      else
+        links = parsed_json["links"].to_json
+        links = Ittybit::Links.from_json(json_object: links)
+      end
+      new(
+        meta: meta,
+        data: data,
+        links: links,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FileResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.meta&.is_a?(Object) != false || raise("Passed value for field obj.meta is not the expected type, validation failed.")
+      obj.data.nil? || Ittybit::File.validate_raw(obj: obj.data)
+      obj.links.nil? || Ittybit::Links.validate_raw(obj: obj.links)
+    end
+  end
+end

data/lib/ittybit/types/file_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ittybit
+  # Processing status of the file.
+  class FileStatus
+    WAITING = "waiting"
+    PROCESSING = "processing"
+    READY = "ready"
+    FAILED = "failed"
+  end
+end

data/lib/ittybit/types/links.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Links
+    # @return [String] The absolute URL of the current request, potentially including query parameters.
+    attr_reader :self_
+    # @return [String] URL for the parent resource.
+    attr_reader :parent
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param self_ [String] The absolute URL of the current request, potentially including query parameters.
+    # @param parent [String] URL for the parent resource.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Ittybit::Links]
+    def initialize(self_: OMIT, parent: OMIT, additional_properties: nil)
+      @self_ = self_ if self_ != OMIT
+      @parent = parent if parent != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "self": self_, "parent": parent }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Links
+    #
+    # @param json_object [String]
+    # @return [Ittybit::Links]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      self_ = parsed_json["self"]
+      parent = parsed_json["parent"]
+      new(
+        self_: self_,
+        parent: parent,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Links to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.self_&.is_a?(String) != false || raise("Passed value for field obj.self_ is not the expected type, validation failed.")
+      obj.parent&.is_a?(String) != false || raise("Passed value for field obj.parent is not the expected type, validation failed.")
+    end
+  end
+end