ittybit 0.8.7 → 0.9.0

data/lib/ittybit/signatures/types/signatures_create_response_links.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Signatures
+    class SignaturesCreateResponseLinks
+      # @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::Signatures::SignaturesCreateResponseLinks]
+      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 SignaturesCreateResponseLinks
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Signatures::SignaturesCreateResponseLinks]
+      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 SignaturesCreateResponseLinks 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

data/lib/ittybit/signatures/types/signatures_create_response_meta.rb

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

data/lib/ittybit/signatures/types/signatures_create_response_meta_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Signatures
+    class SignaturesCreateResponseMetaType
+      OBJECT = "object"
+      LIST = "list"
+    end
+  end
+end

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"
 
@@ -17,21 +18,23 @@ module Ittybit
       @request_client = request_client
     end
 
+    # Retrieves a paginated list of all tasks for the current project.
+    #
     # @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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.list
     def list(page: nil, limit: nil, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -44,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
@@ -52,18 +55,18 @@ 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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.create(request: {"file_id":"file_abcdefgh1234","kind":"image","width":320,"format":"png","ref":"thumbnail"})
     def create(request: nil, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -76,25 +79,25 @@ 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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.get(id: "task_abcdefgh1234")
     def get(id:, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -109,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.
@@ -120,13 +123,13 @@ module Ittybit
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.get_task_config
     def get_task_config(request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -155,22 +158,24 @@ module Ittybit
       @request_client = request_client
     end
 
+    # Retrieves a paginated list of all tasks for the current project.
+    #
     # @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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.list
     def list(page: nil, limit: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -183,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
 
@@ -192,19 +197,19 @@ 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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.create(request: {"file_id":"file_abcdefgh1234","kind":"image","width":320,"format":"png","ref":"thumbnail"})
     def create(request: nil, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -217,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
 
@@ -225,19 +230,19 @@ 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",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.get(id: "task_abcdefgh1234")
     def get(id:, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -252,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
 
@@ -264,14 +269,14 @@ module Ittybit
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.tasks.get_task_config
     def get_task_config(request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),

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