hatchet-sdk 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be1774bd178f9f0894c60a509906ffebd7fe8f1a46e6cd115d9c7697a3dd53a6
-  data.tar.gz: 4b95d1af25208d79c676971b591a5eb48a9e303a7da8b471eef4c211c88c082d
+  metadata.gz: bf12b2683a7b26125e459a66b28acfa0d0c04cc5a4b148cadcce6a29f69b53ea
+  data.tar.gz: ea2fc0114f0a8d236d899b1713c85e5383bf83ab19cc0099020d680f35501db0
 SHA512:
-  metadata.gz: afc688f0fefb4dfb586930df4fa9565fe4b19fe40ccd0420b023ed1955d0f0d324cf4f21e77d015c0890d99372ff59169514ece787b682e20859eb3595a1341b
-  data.tar.gz: dddfa86c822f506aa768fb233243a063e8f4b405f7fa6a2295474ae2e65b2d8bcf4ae59490cd8bd0f9b13d20c561e755217dda95402df91597d780b9e0dd3708
+  metadata.gz: fd9e284829bb0ede7127685699cd79e0c5283d693aee9bc5e6e201cd2518e20c08e83e884054a3325bda3c0435e5743ff35137f6ebb44cbeea9383b83617250b
+  data.tar.gz: 7ac930e2413632481a339e892cbc932fc205d15c6012a2f9e4ea43fe002282c40a24a6f47d555c1fd222c285ee16a2c5155595a2405c89fd3c975ce86e77a32c

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to Hatchet's Ruby SDK will be documented in this changelog.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.0] - 2026-09-23
+
+### Added
+
+- Added `pause` and `unpause` methods to the workflows client (`hatchet.workflows.pause(workflow_id, queue_ttl:)`) and to workflows (`workflow.pause(queue_ttl:)`). `queue_ttl` is how long runs stay queued while the workflow is paused, in seconds or as a duration string, and the behavior (`QUEUE` or `DROP`) for cron and scheduled runs triggered while paused can optionally be set, both defaulting to `QUEUE`.
+
 ## [0.8.1] - 2026-10-05
 
 ### Fixed

data/lib/hatchet/features/workflows.rb

@@ -82,6 +82,51 @@ module Hatchet
       def delete(workflow_id)
         @workflow_api.workflow_delete(workflow_id)
       end
+
+      # Pause a workflow. While paused, new runs of the workflow are queued but not started.
+      #
+      # @param workflow_id [String] The ID of the workflow to pause
+      # @param queue_ttl [Integer, String] How long runs stay queued while the workflow is paused before they are dropped, in seconds or as a duration string (e.g. "1h30m")
+      # @param paused_workflow_cron_run_queue_behavior [String] The behavior of cron runs triggered while the workflow is paused ("QUEUE" or "DROP")
+      # @param paused_workflow_scheduled_run_queue_behavior [String] The behavior of scheduled runs triggered while the workflow is paused ("QUEUE" or "DROP")
+      # @return [HatchetSdkRest::Workflow] The updated workflow
+      # @raise [HatchetSdkRest::ApiError] If the API request fails
+      # @example
+      #   hatchet.workflows.pause("workflow-123", queue_ttl: 3600)
+      def pause(
+        workflow_id,
+        queue_ttl:,
+        paused_workflow_cron_run_queue_behavior: HatchetSdkRest::WorkflowPauseScheduledCronRunQueueBehavior::QUEUE,
+        paused_workflow_scheduled_run_queue_behavior: HatchetSdkRest::WorkflowPauseScheduledCronRunQueueBehavior::QUEUE
+      )
+        pause_request = HatchetSdkRest::PauseWorkflowRequestPause.new(
+          action: "pause",
+          paused_workflow_queue_ttl: queue_ttl.is_a?(String) ? queue_ttl : "#{queue_ttl}s",
+          paused_workflow_cron_run_queue_behavior: paused_workflow_cron_run_queue_behavior,
+          paused_workflow_scheduled_run_queue_behavior: paused_workflow_scheduled_run_queue_behavior,
+        )
+
+        @workflow_api.workflow_update(
+          workflow_id,
+          HatchetSdkRest::WorkflowUpdateRequest.new(pause: pause_request),
+        )
+      end
+
+      # Unpause a workflow
+      #
+      # @param workflow_id [String] The ID of the workflow to unpause
+      # @return [HatchetSdkRest::Workflow] The updated workflow
+      # @raise [HatchetSdkRest::ApiError] If the API request fails
+      # @example
+      #   hatchet.workflows.unpause("workflow-123")
+      def unpause(workflow_id)
+        @workflow_api.workflow_update(
+          workflow_id,
+          HatchetSdkRest::WorkflowUpdateRequest.new(
+            pause: HatchetSdkRest::PauseWorkflowRequestUnpause.new(action: "unpause"),
+          ),
+        )
+      end
     end
   end
 end

data/lib/hatchet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hatchet
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/lib/hatchet/workflow.rb

@@ -348,6 +348,29 @@ module Hatchet
       )
     end
 
+    # Pause this workflow. While paused, new runs of the workflow are queued but not started.
+    #
+    # @param queue_ttl [Integer, String] How long runs stay queued while the workflow is paused before they are dropped, in seconds or as a duration string (e.g. "1h30m")
+    # @param paused_workflow_cron_run_queue_behavior [String] The behavior of cron runs triggered while the workflow is paused ("QUEUE" or "DROP")
+    # @param paused_workflow_scheduled_run_queue_behavior [String] The behavior of scheduled runs triggered while the workflow is paused ("QUEUE" or "DROP")
+    # @return [HatchetSdkRest::Workflow] The updated workflow
+    # @raise [Hatchet::Error] If no client is associated with the workflow
+    def pause(queue_ttl:, **opts)
+      raise Error, "No client associated with workflow #{@name}" unless @client
+
+      @client.workflows.pause(id, queue_ttl: queue_ttl, **opts)
+    end
+
+    # Unpause this workflow.
+    #
+    # @return [HatchetSdkRest::Workflow] The updated workflow
+    # @raise [Hatchet::Error] If no client is associated with the workflow
+    def unpause
+      raise Error, "No client associated with workflow #{@name}" unless @client
+
+      @client.workflows.unpause(id)
+    end
+
     private
 
     # Resolve the workflow UUID by looking up the workflow by name via the REST API.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet-sdk
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - gabriel ruttner