handinger 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecd40670a310e06ad0f0b33baa0f620b434bb11398f45a9e44e9c536533441bd
-  data.tar.gz: 18bf80c24a1126bb839e73146ec8d5aab5c62aba54fbdf8d56f32a0fb3c97ec1
+  metadata.gz: c9a4079727251cf6facfe9b5ade402158b369721afabd58044758ec3097d08e9
+  data.tar.gz: 8ee02c942394761ba33414318f021a38f2c30f25a943d0c1ebf071165ab533d0
 SHA512:
-  metadata.gz: 7520dd4bf1e744831db561b4bc1af8ac9aea2c767f5f477e81604a6d7b1a4a45fc70328bf569832e774eed201bf7bff0ea0c6a80c015f6fea1130caeb6367b91
-  data.tar.gz: 40b7e0965ddc840e39988a2d3659d31d3a47074770054149e4c31534ddbee84162eb16ab61ae0831b8dba59b6bd312691223526e06c0dae9a8ff269fef63465f
+  metadata.gz: 3764c4d0dd72181c6b175478914d8c4f8a7791d4e412994f3d46d939c09aea17441ca0ba13a783beb122182466eac545eaee7d0a5ca19aa3ae76c14f89735178
+  data.tar.gz: 48b83da43ba817718a9e78cce13c4eab1fc8453bdaf55689e4d5f114e547c383cc713ed960ab14d003cdc7fc900444e197d6ab4e6b7e7083ea0ff5fe969a2830

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.7.0 (2026-05-11)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/Ramensoft/handinger-ruby/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* Add Webhook API docs ([a35a412](https://github.com/Ramensoft/handinger-ruby/commit/a35a412297f5103e8856e2da5d72891a3dde3a91))
+
+## 0.6.0 (2026-05-11)
+
+Full Changelog: [v0.5.0...v0.6.0](https://github.com/Ramensoft/handinger-ruby/compare/v0.5.0...v0.6.0)
+
+### Features
+
+* **api:** api update ([7c72012](https://github.com/Ramensoft/handinger-ruby/commit/7c72012ce98e7d806881133cff1c1625a1bfcdac))
+
 ## 0.5.0 (2026-05-11)
 
 Full Changelog: [v0.4.0...v0.5.0](https://github.com/Ramensoft/handinger-ruby/compare/v0.4.0...v0.5.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "handinger", "~> 0.5.0"
+gem "handinger", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/handinger/models/worker.rb

@@ -41,8 +41,8 @@ module Handinger
 
       # @!attribute object
       #
-      #   @return [Symbol, Handinger::Models::Worker::Object]
-      required :object, enum: -> { Handinger::Worker::Object }
+      #   @return [Symbol, :worker]
+      required :object, const: :worker
 
       # @!attribute output
       #
@@ -87,7 +87,7 @@ module Handinger
       #   @return [Handinger::Models::Worker::Usage, nil]
       optional :usage, -> { Handinger::Worker::Usage }
 
-      # @!method initialize(id:, created_at:, error:, files:, incomplete_details:, messages:, metadata:, object:, output:, output_text:, running:, sources:, status:, structured_output:, url:, usage: nil)
+      # @!method initialize(id:, created_at:, error:, files:, incomplete_details:, messages:, metadata:, output:, output_text:, running:, sources:, status:, structured_output:, url:, usage: nil, object: :worker)
       #   @param id [String]
       #
       #   @param created_at [Integer, nil]
@@ -102,8 +102,6 @@ module Handinger
       #
       #   @param metadata [Hash{Symbol=>Object}]
       #
-      #   @param object [Symbol, Handinger::Models::Worker::Object]
-      #
       #   @param output [Array<Handinger::Models::Worker::Output>]
       #
       #   @param output_text [String]
@@ -119,6 +117,8 @@ module Handinger
       #   @param url [String] Web URL of the worker in the Handinger dashboard.
       #
       #   @param usage [Handinger::Models::Worker::Usage]
+      #
+      #   @param object [Symbol, :worker]
 
       class File < Handinger::Internal::Type::BaseModel
         # @!attribute filename
@@ -142,16 +142,6 @@ module Handinger
         #   @param url [String]
       end
 
-      # @see Handinger::Models::Worker#object
-      module Object
-        extend Handinger::Internal::Type::Enum
-
-        WORKER = :worker
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       class Output < Handinger::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -165,25 +155,25 @@ module Handinger
 
         # @!attribute role
         #
-        #   @return [Symbol, Handinger::Models::Worker::Output::Role]
-        required :role, enum: -> { Handinger::Worker::Output::Role }
+        #   @return [Symbol, :assistant]
+        required :role, const: :assistant
 
         # @!attribute status
         #
-        #   @return [Symbol, Handinger::Models::Worker::Output::Status]
-        required :status, enum: -> { Handinger::Worker::Output::Status }
+        #   @return [Symbol, :completed]
+        required :status, const: :completed
 
         # @!attribute type
         #
-        #   @return [Symbol, Handinger::Models::Worker::Output::Type]
-        required :type, enum: -> { Handinger::Worker::Output::Type }
+        #   @return [Symbol, :message]
+        required :type, const: :message
 
-        # @!method initialize(id:, content:, role:, status:, type:)
+        # @!method initialize(id:, content:, role: :assistant, status: :completed, type: :message)
         #   @param id [String]
         #   @param content [Array<Handinger::Models::Worker::Output::Content>]
-        #   @param role [Symbol, Handinger::Models::Worker::Output::Role]
-        #   @param status [Symbol, Handinger::Models::Worker::Output::Status]
-        #   @param type [Symbol, Handinger::Models::Worker::Output::Type]
+        #   @param role [Symbol, :assistant]
+        #   @param status [Symbol, :completed]
+        #   @param type [Symbol, :message]
 
         class Content < Handinger::Internal::Type::BaseModel
           # @!attribute text
@@ -193,52 +183,12 @@ module Handinger
 
           # @!attribute type
           #
-          #   @return [Symbol, Handinger::Models::Worker::Output::Content::Type]
-          required :type, enum: -> { Handinger::Worker::Output::Content::Type }
+          #   @return [Symbol, :output_text]
+          required :type, const: :output_text
 
-          # @!method initialize(text:, type:)
+          # @!method initialize(text:, type: :output_text)
           #   @param text [String]
-          #   @param type [Symbol, Handinger::Models::Worker::Output::Content::Type]
-
-          # @see Handinger::Models::Worker::Output::Content#type
-          module Type
-            extend Handinger::Internal::Type::Enum
-
-            OUTPUT_TEXT = :output_text
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        # @see Handinger::Models::Worker::Output#role
-        module Role
-          extend Handinger::Internal::Type::Enum
-
-          ASSISTANT = :assistant
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Handinger::Models::Worker::Output#status
-        module Status
-          extend Handinger::Internal::Type::Enum
-
-          COMPLETED = :completed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Handinger::Models::Worker::Output#type
-        module Type
-          extend Handinger::Internal::Type::Enum
-
-          MESSAGE = :message
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
+          #   @param type [Symbol, :output_text]
         end
       end
 
@@ -255,29 +205,19 @@ module Handinger
 
         # @!attribute type
         #
-        #   @return [Symbol, Handinger::Models::Worker::Source::Type]
-        required :type, enum: -> { Handinger::Worker::Source::Type }
+        #   @return [Symbol, :url]
+        required :type, const: :url
 
         # @!attribute url
         #
         #   @return [String]
         required :url, String
 
-        # @!method initialize(id:, title:, type:, url:)
+        # @!method initialize(id:, title:, url:, type: :url)
         #   @param id [String]
         #   @param title [String, nil]
-        #   @param type [Symbol, Handinger::Models::Worker::Source::Type]
         #   @param url [String]
-
-        # @see Handinger::Models::Worker::Source#type
-        module Type
-          extend Handinger::Internal::Type::Enum
-
-          URL = :url
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #   @param type [Symbol, :url]
       end
 
       # @see Handinger::Models::Worker#status

data/lib/handinger/models/workers/update_webhook.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      class UpdateWebhook < Handinger::Internal::Type::BaseModel
+        # @!attribute url
+        #   HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to
+        #   remove the webhook and clear its token.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Handinger::Models::Workers::UpdateWebhook} for more details.
+        #
+        #   @param url [String, nil] HTTPS endpoint Handinger should POST to when a task finishes. Pass `null` to rem
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#retrieve
+      class Webhook < Handinger::Internal::Type::BaseModel
+        # @!attribute token
+        #   Shared secret sent in the `X-Handinger-Token` header on each delivery. `null`
+        #   when no webhook is configured.
+        #
+        #   @return [String, nil]
+        required :token, String, nil?: true
+
+        # @!attribute url
+        #   HTTPS endpoint that receives webhook deliveries when a task completes. `null`
+        #   when no webhook is configured.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(token:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Handinger::Models::Workers::Webhook} for more details.
+        #
+        #   @param token [String, nil] Shared secret sent in the `X-Handinger-Token` header on each delivery. `null` wh
+        #
+        #   @param url [String, nil] HTTPS endpoint that receives webhook deliveries when a task completes. `null` wh
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#delete
+      class WebhookDeleteParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_execution.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      class WebhookExecution < Handinger::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute duration_ms
+        #   Wall-clock time spent on the delivery attempt.
+        #
+        #   @return [Integer]
+        required :duration_ms, Integer, api_name: :durationMs
+
+        # @!attribute error_message
+        #   Failure reason when `requestStatus` is `error`.
+        #
+        #   @return [String, nil]
+        required :error_message, String, api_name: :errorMessage, nil?: true
+
+        # @!attribute request_status
+        #   `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        #   @return [Symbol, Handinger::Models::Workers::WebhookExecution::RequestStatus]
+        required :request_status,
+                 enum: -> { Handinger::Workers::WebhookExecution::RequestStatus },
+                 api_name: :requestStatus
+
+        # @!attribute response_status
+        #   HTTP status returned by the endpoint, when reachable.
+        #
+        #   @return [Integer, nil]
+        required :response_status, Integer, api_name: :responseStatus, nil?: true
+
+        # @!attribute task_id
+        #   Task that triggered the delivery, when available.
+        #
+        #   @return [String, nil]
+        required :task_id, String, api_name: :taskId, nil?: true
+
+        # @!attribute task_title
+        #   Title of the originating task, when available.
+        #
+        #   @return [String, nil]
+        required :task_title, String, api_name: :taskTitle, nil?: true
+
+        # @!attribute url
+        #   Endpoint Handinger attempted to deliver to.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String, api_name: :workerId
+
+        # @!method initialize(id:, created_at:, duration_ms:, error_message:, request_status:, response_status:, task_id:, task_title:, url:, worker_id:)
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param duration_ms [Integer] Wall-clock time spent on the delivery attempt.
+        #
+        #   @param error_message [String, nil] Failure reason when `requestStatus` is `error`.
+        #
+        #   @param request_status [Symbol, Handinger::Models::Workers::WebhookExecution::RequestStatus] `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        #   @param response_status [Integer, nil] HTTP status returned by the endpoint, when reachable.
+        #
+        #   @param task_id [String, nil] Task that triggered the delivery, when available.
+        #
+        #   @param task_title [String, nil] Title of the originating task, when available.
+        #
+        #   @param url [String] Endpoint Handinger attempted to deliver to.
+        #
+        #   @param worker_id [String]
+
+        # `success` when the endpoint returned a 2xx response, `error` otherwise.
+        #
+        # @see Handinger::Models::Workers::WebhookExecution#request_status
+        module RequestStatus
+          extend Handinger::Internal::Type::Enum
+
+          SUCCESS = :success
+          ERROR = :error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_execution_list.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#list_executions
+      class WebhookExecutionList < Handinger::Internal::Type::BaseModel
+        # @!attribute logs
+        #
+        #   @return [Array<Handinger::Models::Workers::WebhookExecution>]
+        required :logs, -> { Handinger::Internal::Type::ArrayOf[Handinger::Workers::WebhookExecution] }
+
+        # @!attribute page
+        #   Current page number.
+        #
+        #   @return [Integer]
+        required :page, Integer
+
+        # @!attribute page_count
+        #   Total number of pages available.
+        #
+        #   @return [Integer]
+        required :page_count, Integer, api_name: :pageCount
+
+        # @!attribute total_count
+        #   Total number of executions recorded.
+        #
+        #   @return [Integer]
+        required :total_count, Integer, api_name: :totalCount
+
+        # @!method initialize(logs:, page:, page_count:, total_count:)
+        #   @param logs [Array<Handinger::Models::Workers::WebhookExecution>]
+        #
+        #   @param page [Integer] Current page number.
+        #
+        #   @param page_count [Integer] Total number of pages available.
+        #
+        #   @param total_count [Integer] Total number of executions recorded.
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_list_executions_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#list_executions
+      class WebhookListExecutionsParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!attribute page
+        #   Page number (1-indexed). Defaults to 1.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!method initialize(worker_id:, page: nil, request_options: {})
+        #   @param worker_id [String]
+        #
+        #   @param page [Integer] Page number (1-indexed). Defaults to 1.
+        #
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_regenerate_token_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#regenerate_token
+      class WebhookRegenerateTokenParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#retrieve
+      class WebhookRetrieveParams < Handinger::Internal::Type::BaseModel
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/handinger/models/workers/webhook_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Handinger
+  module Models
+    module Workers
+      # @see Handinger::Resources::Workers::Webhooks#update
+      class WebhookUpdateParams < Handinger::Models::Workers::UpdateWebhook
+        extend Handinger::Internal::Type::RequestParameters::Converter
+        include Handinger::Internal::Type::RequestParameters
+
+        # @!attribute worker_id
+        #
+        #   @return [String]
+        required :worker_id, String
+
+        # @!method initialize(worker_id:, request_options: {})
+        #   @param worker_id [String]
+        #   @param request_options [Handinger::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end