ittybit 0.8.14 → 0.9.0

data/lib/ittybit/tasks/client.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/task_list_response"
-require_relative "../types/task_response"
+require_relative "types/tasks_list_response"
+require_relative "types/tasks_create_response"
+require_relative "types/tasks_get_response"
 require "json"
 require "async"
 
@@ -22,7 +23,7 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskListResponse]
+    # @return [Ittybit::Tasks::TasksListResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -46,7 +47,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
       end
-      Ittybit::TaskListResponse.from_json(json_object: response.body)
+      Ittybit::Tasks::TasksListResponse.from_json(json_object: response.body)
     end
 
     # Creates a new task item. See [Tasks](/docs/tasks) for detailed coverage of all
@@ -54,7 +55,7 @@ module Ittybit
     #
     # @param request [Object]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskResponse]
+    # @return [Ittybit::Tasks::TasksCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -78,14 +79,14 @@ module Ittybit
         req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
       end
-      Ittybit::TaskResponse.from_json(json_object: response.body)
+      Ittybit::Tasks::TasksCreateResponse.from_json(json_object: response.body)
     end
 
     # Retrieves the task object for a task with the given ID.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskResponse]
+    # @return [Ittybit::Tasks::TasksGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -111,7 +112,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/tasks/#{id}"
       end
-      Ittybit::TaskResponse.from_json(json_object: response.body)
+      Ittybit::Tasks::TasksGetResponse.from_json(json_object: response.body)
     end
 
     # Retrieves available task kinds and their configuration options.
@@ -162,7 +163,7 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskListResponse]
+    # @return [Ittybit::Tasks::TasksListResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -187,7 +188,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
         end
-        Ittybit::TaskListResponse.from_json(json_object: response.body)
+        Ittybit::Tasks::TasksListResponse.from_json(json_object: response.body)
       end
     end
 
@@ -196,7 +197,7 @@ module Ittybit
     #
     # @param request [Object]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskResponse]
+    # @return [Ittybit::Tasks::TasksCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -221,7 +222,7 @@ module Ittybit
           req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/tasks"
         end
-        Ittybit::TaskResponse.from_json(json_object: response.body)
+        Ittybit::Tasks::TasksCreateResponse.from_json(json_object: response.body)
       end
     end
 
@@ -229,7 +230,7 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::TaskResponse]
+    # @return [Ittybit::Tasks::TasksGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -256,7 +257,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/tasks/#{id}"
         end
-        Ittybit::TaskResponse.from_json(json_object: response.body)
+        Ittybit::Tasks::TasksGetResponse.from_json(json_object: response.body)
       end
     end
 

data/lib/ittybit/tasks/types/tasks_create_response.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "tasks_create_response_meta"
+require_relative "tasks_create_response_data"
+require_relative "tasks_create_response_error"
+require_relative "tasks_create_response_links"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponse
+      # @return [Ittybit::Tasks::TasksCreateResponseMeta]
+      attr_reader :meta
+      # @return [Ittybit::Tasks::TasksCreateResponseData]
+      attr_reader :data
+      # @return [Ittybit::Tasks::TasksCreateResponseError]
+      attr_reader :error
+      # @return [Ittybit::Tasks::TasksCreateResponseLinks]
+      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::Tasks::TasksCreateResponseMeta]
+      # @param data [Ittybit::Tasks::TasksCreateResponseData]
+      # @param error [Ittybit::Tasks::TasksCreateResponseError]
+      # @param links [Ittybit::Tasks::TasksCreateResponseLinks]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Tasks::TasksCreateResponse]
+      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, "error": error, "links": links }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TasksCreateResponse
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Tasks::TasksCreateResponse]
+      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::Tasks::TasksCreateResponseMeta.from_json(json_object: meta)
+        end
+        if parsed_json["data"].nil?
+          data = nil
+        else
+          data = parsed_json["data"].to_json
+          data = Ittybit::Tasks::TasksCreateResponseData.from_json(json_object: data)
+        end
+        if parsed_json["error"].nil?
+          error = nil
+        else
+          error = parsed_json["error"].to_json
+          error = Ittybit::Tasks::TasksCreateResponseError.from_json(json_object: error)
+        end
+        if parsed_json["links"].nil?
+          links = nil
+        else
+          links = parsed_json["links"].to_json
+          links = Ittybit::Tasks::TasksCreateResponseLinks.from_json(json_object: links)
+        end
+        new(
+          meta: meta,
+          data: data,
+          error: error,
+          links: links,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of TasksCreateResponse 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::Tasks::TasksCreateResponseMeta.validate_raw(obj: obj.meta)
+        obj.data.nil? || Ittybit::Tasks::TasksCreateResponseData.validate_raw(obj: obj.data)
+        obj.error.nil? || Ittybit::Tasks::TasksCreateResponseError.validate_raw(obj: obj.error)
+        obj.links.nil? || Ittybit::Tasks::TasksCreateResponseLinks.validate_raw(obj: obj.links)
+      end
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_data.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative "tasks_create_response_data_kind"
+require_relative "tasks_create_response_data_status"
+require "date"
+require_relative "tasks_create_response_data_results"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseData
+      # @return [String]
+      attr_reader :id
+      # @return [String]
+      attr_reader :object
+      # @return [Ittybit::Tasks::TasksCreateResponseDataKind]
+      attr_reader :kind
+      # @return [Hash{String => Object}]
+      attr_reader :input
+      # @return [Hash{String => Object}]
+      attr_reader :options
+      # @return [Hash{String => Object}]
+      attr_reader :output
+      # @return [Ittybit::Tasks::TasksCreateResponseDataStatus]
+      attr_reader :status
+      # @return [Integer]
+      attr_reader :progress
+      # @return [String]
+      attr_reader :error
+      # @return [String]
+      attr_reader :created_by
+      # @return [DateTime]
+      attr_reader :created
+      # @return [DateTime]
+      attr_reader :updated
+      # @return [String]
+      attr_reader :parent_id
+      # @return [Array<Object>]
+      attr_reader :workflow
+      # @return [Ittybit::Tasks::TasksCreateResponseDataResults]
+      attr_reader :results
+      # @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]
+      # @param object [String]
+      # @param kind [Ittybit::Tasks::TasksCreateResponseDataKind]
+      # @param input [Hash{String => Object}]
+      # @param options [Hash{String => Object}]
+      # @param output [Hash{String => Object}]
+      # @param status [Ittybit::Tasks::TasksCreateResponseDataStatus]
+      # @param progress [Integer]
+      # @param error [String]
+      # @param created_by [String]
+      # @param created [DateTime]
+      # @param updated [DateTime]
+      # @param parent_id [String]
+      # @param workflow [Array<Object>]
+      # @param results [Ittybit::Tasks::TasksCreateResponseDataResults]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Tasks::TasksCreateResponseData]
+      def initialize(id:, object:, kind:, status:, created:, updated:, input: OMIT, options: OMIT, output: OMIT, progress: OMIT,
+                     error: OMIT, created_by: OMIT, parent_id: OMIT, workflow: OMIT, results: OMIT, additional_properties: nil)
+        @id = id
+        @object = object
+        @kind = kind
+        @input = input if input != OMIT
+        @options = options if options != OMIT
+        @output = output if output != OMIT
+        @status = status
+        @progress = progress if progress != OMIT
+        @error = error if error != OMIT
+        @created_by = created_by if created_by != OMIT
+        @created = created
+        @updated = updated
+        @parent_id = parent_id if parent_id != OMIT
+        @workflow = workflow if workflow != OMIT
+        @results = results if results != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "object": object,
+          "kind": kind,
+          "input": input,
+          "options": options,
+          "output": output,
+          "status": status,
+          "progress": progress,
+          "error": error,
+          "created_by": created_by,
+          "created": created,
+          "updated": updated,
+          "parent_id": parent_id,
+          "workflow": workflow,
+          "results": results
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TasksCreateResponseData
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Tasks::TasksCreateResponseData]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        object = parsed_json["object"]
+        kind = parsed_json["kind"]
+        input = parsed_json["input"]
+        options = parsed_json["options"]
+        output = parsed_json["output"]
+        status = parsed_json["status"]
+        progress = parsed_json["progress"]
+        error = parsed_json["error"]
+        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?)
+        parent_id = parsed_json["parent_id"]
+        workflow = parsed_json["workflow"]
+        if parsed_json["results"].nil?
+          results = nil
+        else
+          results = parsed_json["results"].to_json
+          results = Ittybit::Tasks::TasksCreateResponseDataResults.from_json(json_object: results)
+        end
+        new(
+          id: id,
+          object: object,
+          kind: kind,
+          input: input,
+          options: options,
+          output: output,
+          status: status,
+          progress: progress,
+          error: error,
+          created_by: created_by,
+          created: created,
+          updated: updated,
+          parent_id: parent_id,
+          workflow: workflow,
+          results: results,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of TasksCreateResponseData 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.object.is_a?(String) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
+        obj.kind.is_a?(Ittybit::Tasks::TasksCreateResponseDataKind) != false || raise("Passed value for field obj.kind is not the expected type, validation failed.")
+        obj.input&.is_a?(Hash) != false || raise("Passed value for field obj.input is not the expected type, validation failed.")
+        obj.options&.is_a?(Hash) != false || raise("Passed value for field obj.options is not the expected type, validation failed.")
+        obj.output&.is_a?(Hash) != false || raise("Passed value for field obj.output is not the expected type, validation failed.")
+        obj.status.is_a?(Ittybit::Tasks::TasksCreateResponseDataStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.progress&.is_a?(Integer) != false || raise("Passed value for field obj.progress is not the expected type, validation failed.")
+        obj.error&.is_a?(String) != false || raise("Passed value for field obj.error 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.parent_id&.is_a?(String) != false || raise("Passed value for field obj.parent_id is not the expected type, validation failed.")
+        obj.workflow&.is_a?(Array) != false || raise("Passed value for field obj.workflow is not the expected type, validation failed.")
+        obj.results.nil? || Ittybit::Tasks::TasksCreateResponseDataResults.validate_raw(obj: obj.results)
+      end
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_data_kind.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseDataKind
+      INGEST = "ingest"
+      VIDEO = "video"
+      IMAGE = "image"
+      AUDIO = "audio"
+      CHAPTERS = "chapters"
+      SUBTITLES = "subtitles"
+      THUMBNAILS = "thumbnails"
+      NSFW = "nsfw"
+      SPEECH = "speech"
+      DESCRIPTION = "description"
+      OUTLINE = "outline"
+      PROMPT = "prompt"
+      WORKFLOW = "workflow"
+      CONDITIONS = "conditions"
+      HTTP = "http"
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_data_results.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseDataResults
+      # @return [Array<Hash{String => Object}>]
+      attr_reader :passed
+      # @return [Array<Hash{String => Object}>]
+      attr_reader :failed
+      # @return [Boolean]
+      attr_reader :continue
+      # @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 passed [Array<Hash{String => Object}>]
+      # @param failed [Array<Hash{String => Object}>]
+      # @param continue [Boolean]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Tasks::TasksCreateResponseDataResults]
+      def initialize(passed: OMIT, failed: OMIT, continue: OMIT, additional_properties: nil)
+        @passed = passed if passed != OMIT
+        @failed = failed if failed != OMIT
+        @continue = continue if continue != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "passed": passed, "failed": failed, "continue": continue }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TasksCreateResponseDataResults
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Tasks::TasksCreateResponseDataResults]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        passed = parsed_json["passed"]
+        failed = parsed_json["failed"]
+        continue = parsed_json["continue"]
+        new(
+          passed: passed,
+          failed: failed,
+          continue: continue,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of TasksCreateResponseDataResults 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.passed&.is_a?(Array) != false || raise("Passed value for field obj.passed is not the expected type, validation failed.")
+        obj.failed&.is_a?(Array) != false || raise("Passed value for field obj.failed is not the expected type, validation failed.")
+        obj.continue&.is_a?(Boolean) != false || raise("Passed value for field obj.continue is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_data_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseDataStatus
+      PENDING = "pending"
+      WAITING = "waiting"
+      PROCESSING = "processing"
+      READY = "ready"
+      COMPLETED = "completed"
+      FAILED = "failed"
+      ERROR = "error"
+      CANCELLED = "cancelled"
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_error.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseError
+      # @return [String]
+      attr_reader :message
+      # @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 message [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Tasks::TasksCreateResponseError]
+      def initialize(message: OMIT, additional_properties: nil)
+        @message = message if message != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "message": message }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TasksCreateResponseError
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Tasks::TasksCreateResponseError]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message = parsed_json["message"]
+        new(message: message, additional_properties: struct)
+      end
+
+      # Serialize an instance of TasksCreateResponseError 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.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/ittybit/tasks/types/tasks_create_response_links.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Tasks
+    class TasksCreateResponseLinks
+      # @return [String]
+      attr_reader :self_
+      # @return [String]
+      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]
+      # @param parent [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Tasks::TasksCreateResponseLinks]
+      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 TasksCreateResponseLinks
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Tasks::TasksCreateResponseLinks]
+      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 TasksCreateResponseLinks 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
+end