ittybit 0.7.5.2 → 0.8.0

data/lib/ittybit/types/{confirmation_response_data.rb → confirmation.rb}

@@ -4,7 +4,7 @@ require "ostruct"
 require "json"
 
 module Ittybit
-  class ConfirmationResponseData
+  class Confirmation
     # @return [String]
     attr_reader :message
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -17,17 +17,19 @@ module Ittybit
 
     # @param message [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Ittybit::ConfirmationResponseData]
-    def initialize(message:, additional_properties: nil)
-      @message = message
+    # @return [Ittybit::Confirmation]
+    def initialize(message: OMIT, additional_properties: nil)
+      @message = message if message != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "message": message }
+      @_field_set = { "message": message }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
-    # Deserialize a JSON object to an instance of ConfirmationResponseData
+    # Deserialize a JSON object to an instance of Confirmation
     #
     # @param json_object [String]
-    # @return [Ittybit::ConfirmationResponseData]
+    # @return [Ittybit::Confirmation]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -35,7 +37,7 @@ module Ittybit
       new(message: message, additional_properties: struct)
     end
 
-    # Serialize an instance of ConfirmationResponseData to a JSON object
+    # Serialize an instance of Confirmation to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -49,7 +51,7 @@ module Ittybit
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
     end
   end
 end

data/lib/ittybit/types/confirmation_response.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "meta"
-require_relative "confirmation_response_data"
+require_relative "confirmation"
+require_relative "error"
 require_relative "links"
 require "ostruct"
 require "json"
@@ -10,8 +11,10 @@ module Ittybit
   class ConfirmationResponse
     # @return [Ittybit::META]
     attr_reader :meta
-    # @return [Ittybit::ConfirmationResponseData]
+    # @return [Ittybit::Confirmation]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::Links]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -23,16 +26,18 @@ module Ittybit
     OMIT = Object.new
 
     # @param meta [Ittybit::META]
-    # @param data [Ittybit::ConfirmationResponseData]
+    # @param data [Ittybit::Confirmation]
+    # @param error [Ittybit::Error]
     # @param links [Ittybit::Links]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::ConfirmationResponse]
-    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -49,7 +54,13 @@ module Ittybit
         data = nil
       else
         data = parsed_json["data"].to_json
-        data = Ittybit::ConfirmationResponseData.from_json(json_object: data)
+        data = Ittybit::Confirmation.from_json(json_object: data)
+      end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
       end
       if parsed_json["links"].nil?
         links = nil
@@ -60,6 +71,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -80,7 +92,8 @@ module Ittybit
     # @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::ConfirmationResponseData.validate_raw(obj: obj.data)
+      obj.data.nil? || Ittybit::Confirmation.validate_raw(obj: obj.data)
+      obj.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::Links.validate_raw(obj: obj.links)
     end
   end

data/lib/ittybit/types/file.rb

@@ -9,71 +9,69 @@ require "json"
 
 module Ittybit
   class File
-    # @return [String] Unique identifier for the file.
+    # @return [String]
     attr_reader :id
-    # @return [String] Identifier for the parent media object.
+    # @return [String]
     attr_reader :media_id
-    # @return [Ittybit::FileObject] Object type
+    # @return [Ittybit::FileObject]
     attr_reader :object
-    # @return [Ittybit::FileKind] The general type of media.
+    # @return [Ittybit::FileKind]
     attr_reader :kind
-    # @return [String] MIME type.
+    # @return [String]
     attr_reader :type
-    # @return [String] Codec of the file.
+    # @return [String]
     attr_reader :codec
-    # @return [String] Container of the file.
+    # @return [String]
     attr_reader :container
-    # @return [Integer] Width in pixels (for image/video).
+    # @return [Integer]
     attr_reader :width
-    # @return [Integer] Height in pixels (for image/video).
+    # @return [Integer]
     attr_reader :height
-    # @return [String] Orientation of the file.
+    # @return [String]
     attr_reader :orientation
-    # @return [Float] Rotation value for image files with embedded EXIF data.
+    # @return [Float]
     attr_reader :rotation
-    # @return [Boolean] Indicates if the file has alpha channel.
+    # @return [Boolean]
     attr_reader :transparency
-    # @return [Boolean] Indicates if the file is animated (image only).
+    # @return [Boolean]
     attr_reader :animated
-    # @return [Integer] Number of frames in the file.
+    # @return [Integer]
     attr_reader :frames
-    # @return [Float] Duration in seconds (for audio/video).
+    # @return [Float]
     attr_reader :duration
-    # @return [Float] Frames per second (for video).
+    # @return [Float]
     attr_reader :fps
-    # @return [Integer] File size in bytes.
+    # @return [Integer]
     attr_reader :filesize
-    # @return [Integer] Bitrate for audio/video files.
+    # @return [Integer]
     attr_reader :bitrate
-    # @return [String] Language code (e.g., en, es, fr).
+    # @return [String]
     attr_reader :language
-    # @return [String] Label to be used by players (tracks only).
+    # @return [String]
     attr_reader :label
-    # @return [String] Optional reference value. If set, the file URL will be included in the parent
-    #  media `urls` object.
+    # @return [String]
     attr_reader :ref
-    # @return [String] The folder path where the file is stored.
+    # @return [String]
     attr_reader :folder
-    # @return [String] The name of the file.
+    # @return [String]
     attr_reader :filename
-    # @return [String] Publicly accessible URL for the file.
+    # @return [String]
     attr_reader :url
-    # @return [String] Base64 encoded placeholder image for the file.
+    # @return [String]
     attr_reader :placeholder
-    # @return [String] Dominant background color hex code.
+    # @return [String]
     attr_reader :background
-    # @return [Hash{String => Object}] User-defined key-value metadata.
+    # @return [Hash{String => Object}]
     attr_reader :metadata
-    # @return [Boolean] Indicates this is the original file rather than a variant.
+    # @return [Boolean]
     attr_reader :original
-    # @return [String] ID of the entity (e.g., task, automation, or upload request) that created this
-    #  file.
+    # @return [String]
     attr_reader :created_by
-    # @return [DateTime] Timestamp when the file record was created.
+    # @return [DateTime]
     attr_reader :created
-    # @return [DateTime] Timestamp when the file record was last updated.
+    # @return [DateTime]
     attr_reader :updated
-    # @return [Ittybit::FileStatus] Processing status of the file.
+    # @return [Ittybit::FileStatus]
     attr_reader :status
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -83,40 +81,38 @@ module Ittybit
 
     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 id [String]
+    # @param media_id [String]
+    # @param object [Ittybit::FileObject]
+    # @param kind [Ittybit::FileKind]
+    # @param type [String]
+    # @param codec [String]
+    # @param container [String]
+    # @param width [Integer]
+    # @param height [Integer]
+    # @param orientation [String]
+    # @param rotation [Float]
+    # @param transparency [Boolean]
+    # @param animated [Boolean]
+    # @param frames [Integer]
+    # @param duration [Float]
+    # @param fps [Float]
+    # @param filesize [Integer]
+    # @param bitrate [Integer]
+    # @param language [String]
+    # @param label [String]
+    # @param ref [String]
+    # @param folder [String]
+    # @param filename [String]
+    # @param url [String]
+    # @param placeholder [String]
+    # @param background [String]
+    # @param metadata [Hash{String => Object}]
+    # @param original [Boolean]
+    # @param created_by [String]
+    # @param created [DateTime]
+    # @param updated [DateTime]
+    # @param status [Ittybit::FileStatus]
     # @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,

data/lib/ittybit/types/file_kind.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Ittybit
-  # The general type of media.
   class FileKind
     VIDEO = "video"
     IMAGE = "image"

data/lib/ittybit/types/file_list_response.rb

@@ -2,6 +2,7 @@
 
 require_relative "meta_list"
 require_relative "file"
+require_relative "error"
 require_relative "links_list"
 require "ostruct"
 require "json"
@@ -12,6 +13,8 @@ module Ittybit
     attr_reader :meta
     # @return [Array<Ittybit::File>]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::LinksList]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -24,15 +27,17 @@ module Ittybit
 
     # @param meta [Ittybit::MetaList]
     # @param data [Array<Ittybit::File>]
+    # @param error [Ittybit::Error]
     # @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)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -54,6 +59,12 @@ module Ittybit
         item = item.to_json
         Ittybit::File.from_json(json_object: item)
       end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
+      end
       if parsed_json["links"].nil?
         links = nil
       else
@@ -63,6 +74,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -84,6 +96,7 @@ module Ittybit
     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.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::LinksList.validate_raw(obj: obj.links)
     end
   end

data/lib/ittybit/types/file_object.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Ittybit
-  # Object type
   class FileObject
     SOURCE = "source"
     TRACK = "track"

data/lib/ittybit/types/file_response.rb

@@ -2,6 +2,7 @@
 
 require_relative "meta"
 require_relative "file"
+require_relative "error"
 require_relative "links"
 require "ostruct"
 require "json"
@@ -12,6 +13,8 @@ module Ittybit
     attr_reader :meta
     # @return [Ittybit::File]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::Links]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -24,15 +27,17 @@ module Ittybit
 
     # @param meta [Ittybit::META]
     # @param data [Ittybit::File]
+    # @param error [Ittybit::Error]
     # @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)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -51,6 +56,12 @@ module Ittybit
         data = parsed_json["data"].to_json
         data = Ittybit::File.from_json(json_object: data)
       end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
+      end
       if parsed_json["links"].nil?
         links = nil
       else
@@ -60,6 +71,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -81,6 +93,7 @@ module Ittybit
     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.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::Links.validate_raw(obj: obj.links)
     end
   end

data/lib/ittybit/types/file_status.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Ittybit
-  # Processing status of the file.
   class FileStatus
     WAITING = "waiting"
     PROCESSING = "processing"

data/lib/ittybit/types/links.rb

@@ -5,9 +5,9 @@ require "json"
 
 module Ittybit
   class Links
-    # @return [String] The absolute URL of the current request, potentially including query parameters.
+    # @return [String]
     attr_reader :self_
-    # @return [String] URL for the parent resource.
+    # @return [String]
     attr_reader :parent
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -17,8 +17,8 @@ module Ittybit
 
     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 self_ [String]
+    # @param parent [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::Links]
     def initialize(self_: OMIT, parent: OMIT, additional_properties: nil)

data/lib/ittybit/types/links_list.rb

@@ -5,17 +5,15 @@ require "json"
 
 module Ittybit
   class LinksList
-    # @return [String] The absolute URL of the current request, potentially including query parameters.
+    # @return [String]
     attr_reader :self_
-    # @return [String] URL for the next page of results.
+    # @return [String]
+    attr_reader :first
+    # @return [String]
     attr_reader :next_
-    # @return [String] URL for the previous page of results.
+    # @return [String]
     attr_reader :prev
-    # @return [String] URL for the parent resource.
-    attr_reader :parent
-    # @return [String] URL for the first page of results.
-    attr_reader :first
-    # @return [String] URL for the last page of results.
+    # @return [String]
     attr_reader :last
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -25,31 +23,21 @@ module Ittybit
 
     OMIT = Object.new
 
-    # @param self_ [String] The absolute URL of the current request, potentially including query parameters.
-    # @param next_ [String] URL for the next page of results.
-    # @param prev [String] URL for the previous page of results.
-    # @param parent [String] URL for the parent resource.
-    # @param first [String] URL for the first page of results.
-    # @param last [String] URL for the last page of results.
+    # @param self_ [String]
+    # @param first [String]
+    # @param next_ [String]
+    # @param prev [String]
+    # @param last [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::LinksList]
-    def initialize(self_: OMIT, next_: OMIT, prev: OMIT, parent: OMIT, first: OMIT, last: OMIT,
-                   additional_properties: nil)
+    def initialize(self_: OMIT, first: OMIT, next_: OMIT, prev: OMIT, last: OMIT, additional_properties: nil)
       @self_ = self_ if self_ != OMIT
+      @first = first if first != OMIT
       @next_ = next_ if next_ != OMIT
       @prev = prev if prev != OMIT
-      @parent = parent if parent != OMIT
-      @first = first if first != OMIT
       @last = last if last != OMIT
       @additional_properties = additional_properties
-      @_field_set = {
-        "self": self_,
-        "next": next_,
-        "prev": prev,
-        "parent": parent,
-        "first": first,
-        "last": last
-      }.reject do |_k, v|
+      @_field_set = { "self": self_, "first": first, "next": next_, "prev": prev, "last": last }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -62,17 +50,15 @@ module Ittybit
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       self_ = parsed_json["self"]
+      first = parsed_json["first"]
       next_ = parsed_json["next"]
       prev = parsed_json["prev"]
-      parent = parsed_json["parent"]
-      first = parsed_json["first"]
       last = parsed_json["last"]
       new(
         self_: self_,
+        first: first,
         next_: next_,
         prev: prev,
-        parent: parent,
-        first: first,
         last: last,
         additional_properties: struct
       )
@@ -93,10 +79,9 @@ module Ittybit
     # @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.first&.is_a?(String) != false || raise("Passed value for field obj.first is not the expected type, validation failed.")
       obj.next_&.is_a?(String) != false || raise("Passed value for field obj.next_ is not the expected type, validation failed.")
       obj.prev&.is_a?(String) != false || raise("Passed value for field obj.prev 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.")
-      obj.first&.is_a?(String) != false || raise("Passed value for field obj.first is not the expected type, validation failed.")
       obj.last&.is_a?(String) != false || raise("Passed value for field obj.last is not the expected type, validation failed.")
     end
   end