temporalio 1.5.0 → 1.6.0

data/sig/temporalio/client/schedule.rbs

@@ -0,0 +1,337 @@
+module Temporalio
+  class Client
+    class Schedule
+      attr_reader action: Action
+      attr_reader spec: Spec
+      attr_reader policy: Policy
+      attr_reader state: State
+
+      def self._from_proto: (
+        Api::Schedule::V1::Schedule raw_schedule,
+        Converters::DataConverter data_converter
+      ) -> Schedule
+
+      def initialize: (
+        action: Action,
+        spec: Spec,
+        ?policy: Policy,
+        ?state: State
+      ) -> void
+
+      def _to_proto: (Converters::DataConverter data_converter) -> Api::Schedule::V1::Schedule
+
+      def with: (**untyped) -> Schedule
+
+      class Description
+        attr_reader id: String
+        attr_reader schedule: Schedule
+        attr_reader info: Schedule::Info
+        attr_reader raw_description: Api::WorkflowService::V1::DescribeScheduleResponse
+
+        def initialize: (
+          id: String,
+          raw_description: Api::WorkflowService::V1::DescribeScheduleResponse,
+          data_converter: Converters::DataConverter
+        ) -> void
+
+        def memo: -> Hash[String, Object?]?
+        def search_attributes: -> SearchAttributes?
+      end
+
+      class Info
+        attr_reader num_actions: Integer
+        attr_reader num_actions_missed_catchup_window: Integer
+        attr_reader num_actions_skipped_overlap: Integer
+        attr_reader running_actions: Array[ActionExecution]
+        attr_reader recent_actions: Array[ActionResult]
+        attr_reader next_action_times: Array[Time]
+        attr_reader created_at: Time
+        attr_reader last_updated_at: Time?
+
+        def initialize: (raw_info: Api::Schedule::V1::ScheduleInfo) -> void
+      end
+
+      module Action
+        def self._from_proto: (
+          Api::Schedule::V1::ScheduleAction raw_action,
+          Converters::DataConverter data_converter
+        ) -> Action
+
+        def _to_proto: (Converters::DataConverter data_converter) -> Api::Schedule::V1::ScheduleAction
+
+        class StartWorkflow
+          include Action
+
+          attr_reader workflow: singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String
+          attr_reader args: Array[Object?]
+          attr_reader id: String
+          attr_reader task_queue: String
+          attr_reader static_summary: String?
+          attr_reader static_details: String?
+          attr_reader execution_timeout: duration?
+          attr_reader run_timeout: duration?
+          attr_reader task_timeout: duration?
+          attr_reader retry_policy: RetryPolicy?
+          attr_reader memo: Hash[String, Object?]?
+          attr_reader search_attributes: SearchAttributes?
+          attr_reader priority: Priority
+          attr_reader arg_hints: Array[Object]?
+          attr_reader headers: Hash[String, Object?]?
+
+          def self.new: (
+            singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow,
+            *Object? args,
+            id: String,
+            task_queue: String,
+            ?static_summary: String?,
+            ?static_details: String?,
+            ?execution_timeout: duration?,
+            ?run_timeout: duration?,
+            ?task_timeout: duration?,
+            ?retry_policy: RetryPolicy?,
+            ?memo: Hash[String, Object?]?,
+            ?search_attributes: SearchAttributes?,
+            ?priority: Priority,
+            ?arg_hints: Array[Object]?,
+            ?headers: Hash[String, Object?]?
+          ) -> StartWorkflow
+
+          def self._from_proto: (
+            Api::Workflow::V1::NewWorkflowExecutionInfo raw_info,
+            Converters::DataConverter data_converter
+          ) -> StartWorkflow
+
+          def with: (**untyped) -> StartWorkflow
+
+          def _to_proto: (Converters::DataConverter data_converter) -> Api::Schedule::V1::ScheduleAction
+        end
+      end
+
+      module OverlapPolicy
+        type enum = Integer
+    
+        SKIP: enum
+        BUFFER_ONE: enum
+        BUFFER_ALL: enum
+        CANCEL_OTHER: enum
+        TERMINATE_OTHER: enum
+        ALLOW_ALL: enum
+      end
+
+      class Backfill
+        attr_reader start_at: Time
+        attr_reader end_at: Time
+        attr_reader overlap: OverlapPolicy::enum?
+
+        def initialize: (
+          start_at: Time,
+          end_at: Time,
+          ?overlap: OverlapPolicy::enum?
+        ) -> void
+
+        def _to_proto: -> Api::Schedule::V1::BackfillRequest
+      end
+
+      module ActionExecution
+        class StartWorkflow
+          include ActionExecution
+
+          attr_reader workflow_id: String
+          attr_reader first_execution_run_id: String
+
+          def initialize: (raw_execution: Api::Common::V1::WorkflowExecution) -> void
+        end
+      end
+
+      class ActionResult
+        attr_reader schedule_at: Time
+        attr_reader started_at: Time
+        attr_reader action: ActionExecution
+
+        def initialize: (raw_result: Api::Schedule::V1::ScheduleActionResult) -> void
+      end
+
+      class Spec
+        attr_reader calendars: Array[Calendar]
+        attr_reader intervals: Array[Interval]
+        attr_reader cron_expressions: Array[String]
+        attr_reader skip: Array[Calendar]
+        attr_reader start_at: Time?
+        attr_reader end_at: Time?
+        attr_reader jitter: Float?
+        attr_reader time_zone_name: String?
+
+        def self._from_proto: (Api::Schedule::V1::ScheduleSpec raw_spec) -> Spec
+
+        def initialize: (
+          ?calendars: Array[Calendar],
+          ?intervals: Array[Interval],
+          ?cron_expressions: Array[String],
+          ?skip: Array[Calendar],
+          ?start_at: Time?,
+          ?end_at: Time?,
+          ?jitter: Float?,
+          ?time_zone_name: String?
+        ) -> void
+
+        def _to_proto: -> Api::Schedule::V1::ScheduleSpec
+
+        def with: (**untyped) -> Spec
+
+        class Calendar
+          attr_reader second: Array[Schedule::Range]
+          attr_reader minute: Array[Schedule::Range]
+          attr_reader hour: Array[Schedule::Range]
+          attr_reader day_of_month: Array[Schedule::Range]
+          attr_reader month: Array[Schedule::Range]
+          attr_reader year: Array[Schedule::Range]
+          attr_reader day_of_week: Array[Schedule::Range]
+          attr_reader comment: String?
+
+          def self._from_proto: (Api::Schedule::V1::StructuredCalendarSpec raw_cal) -> Calendar
+
+          def initialize: (
+            ?second: Array[Schedule::Range],
+            ?minute: Array[Schedule::Range],
+            ?hour: Array[Schedule::Range],
+            ?day_of_month: Array[Schedule::Range],
+            ?month: Array[Schedule::Range],
+            ?year: Array[Schedule::Range],
+            ?day_of_week: Array[Schedule::Range],
+            ?comment: String?
+          ) -> void
+
+          def _to_proto: -> Api::Schedule::V1::StructuredCalendarSpec
+        end
+
+        class Interval
+          attr_reader every: duration
+          attr_reader offset: duration?
+
+          def self._from_proto: (Api::Schedule::V1::IntervalSpec raw_int) -> Interval
+
+          def initialize: (
+            every: duration,
+            ?offset: duration?
+          ) -> void
+
+          def _to_proto: -> Api::Schedule::V1::IntervalSpec
+        end
+      end
+
+      class Range
+        attr_reader start: Integer
+        attr_reader finish: Integer
+        attr_reader step: Integer
+
+        def self.new: (
+          Integer start,
+          ?Integer finish,
+          ?Integer step
+        ) -> Range
+
+        def self._from_proto: (Api::Schedule::V1::Range raw_range) -> Range
+        def self._from_protos: (Google::Protobuf::RepeatedField raw_ranges) -> Array[Range]
+        def self._to_protos: (Array[Range] ranges) -> Array[Api::Schedule::V1::Range]
+
+        def _to_proto: -> Api::Schedule::V1::Range
+      end
+
+      class Policy
+        attr_reader overlap: OverlapPolicy::enum
+        attr_reader catchup_window: duration
+        attr_reader pause_on_failure: bool
+
+        def self._from_proto: (Api::Schedule::V1::SchedulePolicies raw_policies) -> Policy
+
+        def initialize: (
+          ?overlap: OverlapPolicy::enum,
+          ?catchup_window: duration,
+          ?pause_on_failure: bool
+        ) -> void
+
+        def _to_proto: -> Api::Schedule::V1::SchedulePolicies
+      end
+
+      class State
+        attr_reader note: String?
+        attr_reader paused: bool
+        attr_reader limited_actions: bool
+        attr_reader remaining_actions: Integer
+
+        def self._from_proto: (Api::Schedule::V1::ScheduleState raw_state) -> State
+
+        def initialize: (
+          ?note: String?,
+          ?paused: bool,
+          ?limited_actions: bool,
+          ?remaining_actions: Integer
+        ) -> void
+
+        def _to_proto: -> Api::Schedule::V1::ScheduleState
+      end
+
+      class Update
+        attr_reader schedule: Schedule
+        attr_reader search_attributes: SearchAttributes?
+
+        def initialize: (
+          schedule: Schedule,
+          ?search_attributes: SearchAttributes?
+        ) -> void
+
+        class Input
+          attr_reader description: Description
+
+          def initialize: (description: Description) -> void
+        end
+      end
+
+      module List
+        class Description
+          attr_reader id: String
+          attr_reader schedule: Schedule?
+          attr_reader info: Info?
+          attr_reader raw_entry: Api::Schedule::V1::ScheduleListEntry
+
+          def initialize: (
+            raw_entry: Api::Schedule::V1::ScheduleListEntry,
+            data_converter: Converters::DataConverter
+          ) -> void
+        end
+
+        class Schedule
+          attr_reader action: Action
+          attr_reader spec: Spec
+          attr_reader state: State
+
+          def initialize: (raw_info: Api::Schedule::V1::ScheduleListInfo) -> void
+        end
+
+        module Action
+          class StartWorkflow
+            include Action
+
+            attr_reader workflow: String
+
+            def initialize: (workflow: String) -> void
+          end
+        end
+
+        class Info
+          attr_reader recent_actions: Array[ActionResult]
+          attr_reader next_action_times: Array[Time]
+
+          def initialize: (raw_info: Api::Schedule::V1::ScheduleListInfo) -> void
+        end
+
+        class State
+          attr_reader note: String?
+          attr_reader paused: bool
+
+          def initialize: (raw_info: Api::Schedule::V1::ScheduleListInfo) -> void
+        end
+      end
+    end
+  end
+end

data/sig/temporalio/client/schedule_handle.rbs

@@ -0,0 +1,44 @@
+module Temporalio
+  class Client
+    class ScheduleHandle
+      attr_reader id: String
+
+      def initialize: (
+        client: Client,
+        id: String
+      ) -> void
+
+      def backfill: (
+        *Schedule::Backfill backfills,
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def delete: (
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def describe: (
+        ?rpc_options: RPCOptions?
+      ) -> Schedule::Description
+
+      def pause: (
+        ?note: String,
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def trigger: (
+        ?overlap: Schedule::OverlapPolicy::enum?,
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def unpause: (
+        ?note: String,
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def update: (
+        ?rpc_options: RPCOptions?
+      ) { (Schedule::Update::Input) -> Schedule::Update? } -> void
+    end
+  end
+end

data/sig/temporalio/client/with_start_workflow_operation.rbs

@@ -0,0 +1,82 @@
+module Temporalio
+  class Client
+    class WithStartWorkflowOperation
+      class Options
+        attr_reader workflow: String
+        attr_reader args: Array[Object?]
+        attr_reader id: String
+        attr_reader task_queue: String
+        attr_reader static_summary: String?
+        attr_reader static_details: String?
+        attr_reader execution_timeout: duration?
+        attr_reader run_timeout: duration?
+        attr_reader task_timeout: duration?
+        attr_reader id_reuse_policy: WorkflowIDReusePolicy::enum
+        attr_reader id_conflict_policy: WorkflowIDConflictPolicy::enum
+        attr_reader retry_policy: RetryPolicy?
+        attr_reader cron_schedule: String?
+        attr_reader memo: Hash[String | Symbol, Object?]?
+        attr_reader search_attributes: SearchAttributes?
+        attr_reader start_delay: duration?
+        attr_reader priority: Priority
+        attr_reader arg_hints: Array[Object]?
+        attr_reader result_hint: Object?
+        attr_reader headers: Hash[String, Object?]
+
+        def initialize: (
+          workflow: String,
+          args: Array[Object?],
+          id: String,
+          task_queue: String,
+          static_summary: String?,
+          static_details: String?,
+          execution_timeout: duration?,
+          run_timeout: duration?,
+          task_timeout: duration?,
+          id_reuse_policy: WorkflowIDReusePolicy::enum,
+          id_conflict_policy: WorkflowIDConflictPolicy::enum,
+          retry_policy: RetryPolicy?,
+          cron_schedule: String?,
+          memo: Hash[String | Symbol, Object?]?,
+          search_attributes: SearchAttributes?,
+          start_delay: duration?,
+          priority: Priority,
+          arg_hints: Array[Object]?,
+          result_hint: Object?,
+          headers: Hash[String, Object?]
+        ) -> void
+      end
+
+      attr_accessor options: Options
+
+      def initialize: (
+        singleton(Workflow::Definition) | Workflow::Definition::Info | Symbol | String workflow,
+        *Object? args,
+        id: String,
+        task_queue: String,
+        ?static_summary: String?,
+        ?static_details: String?,
+        ?execution_timeout: duration?,
+        ?run_timeout: duration?,
+        ?task_timeout: duration?,
+        ?id_reuse_policy: WorkflowIDReusePolicy::enum,
+        ?id_conflict_policy: WorkflowIDConflictPolicy::enum,
+        ?retry_policy: RetryPolicy?,
+        ?cron_schedule: String?,
+        ?memo: Hash[String | Symbol, Object?]?,
+        ?search_attributes: SearchAttributes?,
+        ?start_delay: duration?,
+        ?priority: Priority,
+        ?arg_hints: Array[Object]?,
+        ?result_hint: Object?,
+        ?headers: Hash[String, Object?]
+      ) -> void
+
+      def workflow_handle: () -> WorkflowHandle
+                         | (wait: bool) -> WorkflowHandle?
+
+      def _set_workflow_handle: (WorkflowHandle | Exception value) -> void
+      def _mark_used: -> void
+    end
+  end
+end

data/sig/temporalio/client/workflow_execution.rbs

@@ -0,0 +1,37 @@
+module Temporalio
+  class Client
+    class WorkflowExecution
+      attr_reader raw_info: Api::Workflow::V1::WorkflowExecutionInfo
+
+      def initialize: (Api::Workflow::V1::WorkflowExecutionInfo raw_info, Converters::DataConverter data_converter) -> void
+
+      def close_time: -> Time?
+      def execution_time: -> Time?
+      def history_length: -> Integer
+      def id: -> String
+      def memo: -> Hash[String, Object?]
+      def parent_id: -> String?
+      def parent_run_id: -> String?
+      def run_id: -> String
+      def search_attributes: -> SearchAttributes?
+      def start_time: -> Time
+      def status: -> WorkflowExecutionStatus::enum
+      def task_queue: -> String
+      def workflow_type: -> String
+
+      class Description < WorkflowExecution
+        attr_reader raw_description: Api::WorkflowService::V1::DescribeWorkflowExecutionResponse
+
+        def initialize: (
+          Api::WorkflowService::V1::DescribeWorkflowExecutionResponse raw_description,
+          Converters::DataConverter data_converter
+        ) -> void
+
+        def static_summary: -> String?
+        def static_details: -> String?
+
+        private def user_metadata: -> [String?, String?]
+      end
+    end
+  end
+end

data/sig/temporalio/client/workflow_execution_count.rbs

@@ -0,0 +1,17 @@
+module Temporalio
+  class Client
+    class WorkflowExecutionCount
+      attr_reader count: Integer
+      attr_reader groups: Array[AggregationGroup]
+
+      def initialize: (Integer count, Array[AggregationGroup] groups) -> void
+
+      class AggregationGroup
+        attr_reader count: Integer
+        attr_reader group_values: Array[Object?]
+
+        def initialize: (Integer count, Array[Object?] group_values) -> void
+      end
+    end
+  end
+end

data/sig/temporalio/client/workflow_execution_status.rbs

@@ -0,0 +1,16 @@
+
+module Temporalio
+  class Client
+    module WorkflowExecutionStatus
+      type enum = Integer
+
+      RUNNING: enum
+      COMPLETED: enum
+      FAILED: enum
+      CANCELED: enum
+      TERMINATED: enum
+      CONTINUED_AS_NEW: enum
+      TIMED_OUT: enum
+    end
+  end
+end

data/sig/temporalio/client/workflow_handle.rbs

@@ -0,0 +1,95 @@
+module Temporalio
+  class Client
+    class WorkflowHandle
+      attr_reader id: String
+      attr_reader run_id: String?
+      attr_reader result_run_id: String?
+      attr_reader first_execution_run_id: String?
+      attr_reader result_hint: Object?
+
+      def initialize: (
+        client: Client,
+        id: String,
+        run_id: String?,
+        result_run_id: String?,
+        first_execution_run_id: String?,
+        result_hint: Object?
+      ) -> void
+
+      def result: (
+        ?follow_runs: bool,
+        ?result_hint: Object?,
+        ?rpc_options: RPCOptions?
+      ) -> Object?
+
+      def describe: (
+        ?rpc_options: RPCOptions?
+      ) -> WorkflowExecution::Description
+
+      def fetch_history: (
+        ?event_filter_type: Integer,
+        ?skip_archival: bool,
+        ?rpc_options: RPCOptions?
+      ) -> WorkflowHistory
+
+      def fetch_history_events: (
+        ?wait_new_event: bool,
+        ?event_filter_type: Integer,
+        ?skip_archival: bool,
+        ?specific_run_id: String?,
+        ?rpc_options: RPCOptions?
+      ) -> Enumerator[Api::History::V1::HistoryEvent, Api::History::V1::HistoryEvent]
+
+      def signal: (
+        Workflow::Definition::Signal | Symbol | String signal,
+        *Object? args,
+        ?arg_hints: Array[Object]?,
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def query: (
+        Workflow::Definition::Query | Symbol | String query,
+        *Object? args,
+        ?reject_condition: WorkflowQueryRejectCondition::enum?,
+        ?arg_hints: Array[Object]?,
+        ?result_hint: Object?,
+        ?rpc_options: RPCOptions?
+      ) -> Object?
+
+      def start_update: (
+        Workflow::Definition::Update | Symbol | String update,
+        *Object? args,
+        wait_for_stage: WorkflowUpdateWaitStage::enum,
+        ?id: String,
+        ?arg_hints: Array[Object]?,
+        ?result_hint: Object?,
+        ?rpc_options: RPCOptions?
+      ) -> WorkflowUpdateHandle
+
+      def execute_update: (
+        Workflow::Definition::Update | Symbol | String update,
+        *Object? args,
+        ?id: String,
+        ?arg_hints: Array[Object]?,
+        ?result_hint: Object?,
+        ?rpc_options: RPCOptions?
+      ) -> Object?
+
+      def update_handle: (
+        String id,
+        ?specific_run_id: String?,
+        ?result_hint: Object?
+      ) -> WorkflowUpdateHandle
+
+      def cancel: (
+        ?rpc_options: RPCOptions?
+      ) -> void
+
+      def terminate: (
+        ?String? reason,
+        ?details: Array[Object?],
+        ?rpc_options: RPCOptions?
+      ) -> void
+    end
+  end
+end

data/sig/temporalio/client/workflow_query_reject_condition.rbs

@@ -0,0 +1,12 @@
+
+module Temporalio
+  class Client
+    module WorkflowQueryRejectCondition
+      type enum = Integer
+
+      NONE: enum
+      NOT_OPEN: enum
+      NOT_COMPLETED_CLEANLY: enum
+    end
+  end
+end

data/sig/temporalio/client/workflow_update_handle.rbs

@@ -0,0 +1,26 @@
+module Temporalio
+  class Client
+    class WorkflowUpdateHandle
+      attr_reader id: String
+      attr_reader workflow_id: String
+      attr_reader workflow_run_id: String?
+      attr_reader result_hint: Object?
+
+      def initialize: (
+        client: Client,
+        id: String,
+        workflow_id: String,
+        workflow_run_id: String?,
+        known_outcome: Api::Update::V1::Outcome?,
+        result_hint: Object?
+      ) -> void
+
+      def result_obtained?: -> bool
+
+      def result: (
+        ?result_hint: Object?,
+        ?rpc_options: RPCOptions?
+      ) -> Object?
+    end
+  end
+end

data/sig/temporalio/client/workflow_update_wait_stage.rbs

@@ -0,0 +1,12 @@
+
+module Temporalio
+  class Client
+    module WorkflowUpdateWaitStage
+      type enum = Integer
+
+      ADMITTED: enum
+      ACCEPTED: enum
+      COMPLETED: enum
+    end
+  end
+end