deeprails 0.11.0 → 0.13.0

data/lib/deeprails/models/workflow_event_detail_response.rb

@@ -0,0 +1,314 @@
+# frozen_string_literal: true
+
+module Deeprails
+  module Models
+    # @see Deeprails::Resources::Defend#retrieve_event
+    class WorkflowEventDetailResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute evaluation_history
+      #   History of evaluations for the event.
+      #
+      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>]
+      required :evaluation_history,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::EvaluationHistory] }
+
+      # @!attribute evaluation_result
+      #   Evaluation result consisting of average scores and rationales for each of the
+      #   evaluated guardrail metrics.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+      # @!attribute event_id
+      #   A unique workflow event ID.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_status
+      #   Status of the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EventStatus]
+      required :event_status, enum: -> { Deeprails::WorkflowEventDetailResponse::EventStatus }
+
+      # @!attribute filtered
+      #   Whether the event was filtered and requires improvement.
+      #
+      #   @return [Boolean]
+      required :filtered, Deeprails::Internal::Type::Boolean
+
+      # @!attribute improved_model_output
+      #   Improved model output after improvement tool was applied and each metric passed
+      #   evaluation.
+      #
+      #   @return [String]
+      required :improved_model_output, String
+
+      # @!attribute improvement_tool_status
+      #   Status of the improvement tool used to improve the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil]
+      required :improvement_tool_status,
+               enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolStatus },
+               nil?: true
+
+      # @!attribute improvement_tool_type
+      #   Type of improvement tool used to improve the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolType]
+      required :improvement_tool_type, enum: -> { Deeprails::WorkflowEventDetailResponse::ImprovementToolType }
+
+      # @!attribute threshold_type
+      #   Type of thresholds used to evaluate the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType]
+      required :threshold_type, enum: -> { Deeprails::WorkflowEventDetailResponse::ThresholdType }
+
+      # @!attribute workflow_id
+      #   Workflow ID associated with the event.
+      #
+      #   @return [String]
+      required :workflow_id, String
+
+      # @!attribute automatic_hallucination_tolerance_levels
+      #   Mapping of guardrail metric names to tolerance values. Values are strings
+      #   (`low`, `medium`, `high`) representing automatic tolerance levels.
+      #
+      #   @return [Hash{Symbol=>Symbol, Deeprails::Models::WorkflowEventDetailResponse::AutomaticHallucinationToleranceLevel}, nil]
+      optional :automatic_hallucination_tolerance_levels,
+               -> { Deeprails::Internal::Type::HashOf[enum: Deeprails::WorkflowEventDetailResponse::AutomaticHallucinationToleranceLevel] }
+
+      # @!attribute capabilities
+      #   Extended AI capabilities available to the event, if any. Can be `web_search`
+      #   and/or `file_search`.
+      #
+      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::Capability>, nil]
+      optional :capabilities,
+               -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::Capability] }
+
+      # @!attribute custom_hallucination_threshold_values
+      #   Mapping of guardrail metric names to threshold values. Values are floating point
+      #   numbers (0.0-1.0) representing custom thresholds.
+      #
+      #   @return [Hash{Symbol=>Float}, nil]
+      optional :custom_hallucination_threshold_values, Deeprails::Internal::Type::HashOf[Float]
+
+      # @!attribute files
+      #   List of files available to the event, if any. Will only be present if
+      #   `file_search` is enabled.
+      #
+      #   @return [Array<Deeprails::Models::WorkflowEventDetailResponse::File>, nil]
+      optional :files, -> { Deeprails::Internal::Type::ArrayOf[Deeprails::WorkflowEventDetailResponse::File] }
+
+      # @!method initialize(evaluation_history:, evaluation_result:, event_id:, event_status:, filtered:, improved_model_output:, improvement_tool_status:, improvement_tool_type:, threshold_type:, workflow_id:, automatic_hallucination_tolerance_levels: nil, capabilities: nil, custom_hallucination_threshold_values: nil, files: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Deeprails::Models::WorkflowEventDetailResponse} for more details.
+      #
+      #   @param evaluation_history [Array<Deeprails::Models::WorkflowEventDetailResponse::EvaluationHistory>] History of evaluations for the event.
+      #
+      #   @param evaluation_result [Hash{Symbol=>Object}] Evaluation result consisting of average scores and rationales for each of the ev
+      #
+      #   @param event_id [String] A unique workflow event ID.
+      #
+      #   @param event_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::EventStatus] Status of the event.
+      #
+      #   @param filtered [Boolean] Whether the event was filtered and requires improvement.
+      #
+      #   @param improved_model_output [String] Improved model output after improvement tool was applied and each metric passed
+      #
+      #   @param improvement_tool_status [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolStatus, nil] Status of the improvement tool used to improve the event.
+      #
+      #   @param improvement_tool_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ImprovementToolType] Type of improvement tool used to improve the event.
+      #
+      #   @param threshold_type [Symbol, Deeprails::Models::WorkflowEventDetailResponse::ThresholdType] Type of thresholds used to evaluate the event.
+      #
+      #   @param workflow_id [String] Workflow ID associated with the event.
+      #
+      #   @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::WorkflowEventDetailResponse::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metric names to tolerance values. Values are strings (`low`
+      #
+      #   @param capabilities [Array<Deeprails::Models::WorkflowEventDetailResponse::Capability>] Extended AI capabilities available to the event, if any. Can be `web_search` and
+      #
+      #   @param custom_hallucination_threshold_values [Hash{Symbol=>Float}] Mapping of guardrail metric names to threshold values. Values are floating point
+      #
+      #   @param files [Array<Deeprails::Models::WorkflowEventDetailResponse::File>] List of files available to the event, if any. Will only be present if `file_sear
+
+      class EvaluationHistory < Deeprails::Internal::Type::BaseModel
+        # @!attribute attempt
+        #
+        #   @return [String, nil]
+        optional :attempt, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute error_message
+        #
+        #   @return [String, nil]
+        optional :error_message, String
+
+        # @!attribute evaluation_result
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :evaluation_result, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+        # @!attribute evaluation_status
+        #
+        #   @return [String, nil]
+        optional :evaluation_status, String
+
+        # @!attribute evaluation_total_cost
+        #
+        #   @return [Float, nil]
+        optional :evaluation_total_cost, Float
+
+        # @!attribute guardrail_metrics
+        #
+        #   @return [Array<String>, nil]
+        optional :guardrail_metrics, Deeprails::Internal::Type::ArrayOf[String]
+
+        # @!attribute model_input
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :model_input, Deeprails::Internal::Type::HashOf[Deeprails::Internal::Type::Unknown]
+
+        # @!attribute model_output
+        #
+        #   @return [String, nil]
+        optional :model_output, String
+
+        # @!attribute modified_at
+        #
+        #   @return [Time, nil]
+        optional :modified_at, Time
+
+        # @!attribute nametag
+        #
+        #   @return [String, nil]
+        optional :nametag, String
+
+        # @!attribute progress
+        #
+        #   @return [Integer, nil]
+        optional :progress, Integer
+
+        # @!attribute run_mode
+        #
+        #   @return [String, nil]
+        optional :run_mode, String
+
+        # @!method initialize(attempt: nil, created_at: nil, error_message: nil, evaluation_result: nil, evaluation_status: nil, evaluation_total_cost: nil, guardrail_metrics: nil, model_input: nil, model_output: nil, modified_at: nil, nametag: nil, progress: nil, run_mode: nil)
+        #   @param attempt [String]
+        #   @param created_at [Time]
+        #   @param error_message [String]
+        #   @param evaluation_result [Hash{Symbol=>Object}]
+        #   @param evaluation_status [String]
+        #   @param evaluation_total_cost [Float]
+        #   @param guardrail_metrics [Array<String>]
+        #   @param model_input [Hash{Symbol=>Object}]
+        #   @param model_output [String]
+        #   @param modified_at [Time]
+        #   @param nametag [String]
+        #   @param progress [Integer]
+        #   @param run_mode [String]
+      end
+
+      # Status of the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#event_status
+      module EventStatus
+        extend Deeprails::Internal::Type::Enum
+
+        IN_PROGRESS = :"In Progress"
+        COMPLETED = :Completed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the improvement tool used to improve the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_tool_status
+      module ImprovementToolStatus
+        extend Deeprails::Internal::Type::Enum
+
+        IMPROVED = :improved
+        FAILED_ON_MAX_RETRIES = :"failed on max retries"
+        IMPROVEMENT_REQUIRED = :improvement_required
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Type of improvement tool used to improve the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#improvement_tool_type
+      module ImprovementToolType
+        extend Deeprails::Internal::Type::Enum
+
+        REGEN = :regen
+        FIXIT = :fixit
+        DO_NOTHING = :do_nothing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Type of thresholds used to evaluate the event.
+      #
+      # @see Deeprails::Models::WorkflowEventDetailResponse#threshold_type
+      module ThresholdType
+        extend Deeprails::Internal::Type::Enum
+
+        CUSTOM = :custom
+        AUTOMATIC = :automatic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module AutomaticHallucinationToleranceLevel
+        extend Deeprails::Internal::Type::Enum
+
+        LOW = :low
+        MEDIUM = :medium
+        HIGH = :high
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Capability < Deeprails::Internal::Type::BaseModel
+        # @!attribute capability
+        #
+        #   @return [String, nil]
+        optional :capability, String
+
+        # @!method initialize(capability: nil)
+        #   @param capability [String]
+      end
+
+      class File < Deeprails::Internal::Type::BaseModel
+        # @!attribute file_id
+        #
+        #   @return [String, nil]
+        optional :file_id, String
+
+        # @!attribute file_name
+        #
+        #   @return [String, nil]
+        optional :file_name, String
+
+        # @!attribute file_size
+        #
+        #   @return [Integer, nil]
+        optional :file_size, Integer
+
+        # @!method initialize(file_id: nil, file_name: nil, file_size: nil)
+        #   @param file_id [String]
+        #   @param file_name [String]
+        #   @param file_size [Integer]
+      end
+    end
+  end
+end

data/lib/deeprails/models/workflow_event_response.rb

@@ -2,54 +2,53 @@
 
 module Deeprails
   module Models
-    # @see Deeprails::Resources::Defend#retrieve_event
+    # @see Deeprails::Resources::Defend#submit_event
     class WorkflowEventResponse < Deeprails::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   The time the event was created in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
       # @!attribute event_id
       #   A unique workflow event ID.
       #
       #   @return [String]
       required :event_id, String
 
+      # @!attribute status
+      #   Status of the event.
+      #
+      #   @return [Symbol, Deeprails::Models::WorkflowEventResponse::Status]
+      required :status, enum: -> { Deeprails::WorkflowEventResponse::Status }
+
       # @!attribute workflow_id
       #   Workflow ID associated with the event.
       #
       #   @return [String]
       required :workflow_id, String
 
-      # @!attribute attempt_number
-      #   Count of improvement attempts for the event. If greater than one then all
-      #   previous improvement attempts failed.
-      #
-      #   @return [Integer, nil]
-      optional :attempt_number, Integer
-
-      # @!attribute evaluation_id
-      #   A unique evaluation ID associated with this event. Every event has one or more
-      #   evaluation attempts.
-      #
-      #   @return [String, nil]
-      optional :evaluation_id, String
-
-      # @!attribute filtered
-      #   `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
-      #   failed any of the guardrail metrics.
-      #
-      #   @return [Boolean, nil]
-      optional :filtered, Deeprails::Internal::Type::Boolean
-
-      # @!method initialize(event_id:, workflow_id:, attempt_number: nil, evaluation_id: nil, filtered: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Deeprails::Models::WorkflowEventResponse} for more details.
+      # @!method initialize(created_at:, event_id:, status:, workflow_id:)
+      #   @param created_at [Time] The time the event was created in UTC.
       #
       #   @param event_id [String] A unique workflow event ID.
       #
-      #   @param workflow_id [String] Workflow ID associated with the event.
-      #
-      #   @param attempt_number [Integer] Count of improvement attempts for the event. If greater than one then all previ
+      #   @param status [Symbol, Deeprails::Models::WorkflowEventResponse::Status] Status of the event.
       #
-      #   @param evaluation_id [String] A unique evaluation ID associated with this event. Every event has one or more
+      #   @param workflow_id [String] Workflow ID associated with the event.
+
+      # Status of the event.
       #
-      #   @param filtered [Boolean] `False` if evaluation passed all of the guardrail metrics, `True` if evaluation
+      # @see Deeprails::Models::WorkflowEventResponse#status
+      module Status
+        extend Deeprails::Internal::Type::Enum
+
+        IN_PROGRESS = :"In Progress"
+        COMPLETED = :Completed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/deeprails/models.rb

@@ -39,6 +39,8 @@ module Deeprails
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  DefendCreateResponse = Deeprails::Models::DefendCreateResponse
+
   DefendCreateWorkflowParams = Deeprails::Models::DefendCreateWorkflowParams
 
   DefendResponse = Deeprails::Models::DefendResponse
@@ -49,6 +51,8 @@ module Deeprails
 
   DefendSubmitEventParams = Deeprails::Models::DefendSubmitEventParams
 
+  DefendUpdateResponse = Deeprails::Models::DefendUpdateResponse
+
   DefendUpdateWorkflowParams = Deeprails::Models::DefendUpdateWorkflowParams
 
   FileResponse = Deeprails::Models::FileResponse
@@ -57,11 +61,15 @@ module Deeprails
 
   MonitorCreateParams = Deeprails::Models::MonitorCreateParams
 
+  MonitorCreateResponse = Deeprails::Models::MonitorCreateResponse
+
   MonitorDetailResponse = Deeprails::Models::MonitorDetailResponse
 
+  MonitorEventDetailResponse = Deeprails::Models::MonitorEventDetailResponse
+
   MonitorEventResponse = Deeprails::Models::MonitorEventResponse
 
-  MonitorResponse = Deeprails::Models::MonitorResponse
+  MonitorRetrieveEventParams = Deeprails::Models::MonitorRetrieveEventParams
 
   MonitorRetrieveParams = Deeprails::Models::MonitorRetrieveParams
 
@@ -69,5 +77,9 @@ module Deeprails
 
   MonitorUpdateParams = Deeprails::Models::MonitorUpdateParams
 
+  MonitorUpdateResponse = Deeprails::Models::MonitorUpdateResponse
+
+  WorkflowEventDetailResponse = Deeprails::Models::WorkflowEventDetailResponse
+
   WorkflowEventResponse = Deeprails::Models::WorkflowEventResponse
 end

data/lib/deeprails/resources/defend.rb

@@ -9,13 +9,13 @@ module Deeprails
       # Use this endpoint to create a new guardrail workflow with optional guardrail
       # thresholds and improvement actions
       #
-      # @overload create_workflow(improvement_action:, name:, type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {})
+      # @overload create_workflow(improvement_action:, name:, threshold_type:, automatic_hallucination_tolerance_levels: nil, custom_hallucination_threshold_values: nil, description: nil, file_search: nil, max_improvement_attempts: nil, web_search: nil, request_options: {})
       #
-      # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or guardrail metrics for the wo
+      # @param improvement_action [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ImprovementAction] The action used to improve outputs that fail one or more guardrail metrics for t
       #
       # @param name [String] Name of the workflow.
       #
-      # @param type [Symbol, Deeprails::Models::DefendCreateWorkflowParams::Type] Type of thresholds to use for the workflow, either `automatic` or `custom`. Aut
+      # @param threshold_type [Symbol, Deeprails::Models::DefendCreateWorkflowParams::ThresholdType] Type of thresholds to use for the workflow, either `automatic` or `custom`. Aut
       #
       # @param automatic_hallucination_tolerance_levels [Hash{Symbol=>Symbol, Deeprails::Models::DefendCreateWorkflowParams::AutomaticHallucinationToleranceLevel}] Mapping of guardrail metrics to hallucination tolerance levels
       #
@@ -25,13 +25,13 @@ module Deeprails
       #
       # @param file_search [Array<String>] An array of file IDs to search in the workflow's evaluations. Files must be uplo
       #
-      # @param max_improvement_attempts [Integer] Max. number of improvement action retries until a given event passes the guardra
+      # @param max_improvement_attempts [Integer] Max. number of improvement action attempts until a given event passes the guardr
       #
       # @param web_search [Boolean] Whether to enable web search for this workflow's evaluations. Defaults to false.
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::DefendResponse]
+      # @return [Deeprails::Models::DefendCreateResponse]
       #
       # @see Deeprails::Models::DefendCreateWorkflowParams
       def create_workflow(params)
@@ -40,7 +40,7 @@ module Deeprails
           method: :post,
           path: "defend",
           body: parsed,
-          model: Deeprails::DefendResponse,
+          model: Deeprails::DefendCreateResponse,
           options: options
         )
       end
@@ -55,7 +55,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::WorkflowEventResponse]
+      # @return [Deeprails::Models::WorkflowEventDetailResponse]
       #
       # @see Deeprails::Models::DefendRetrieveEventParams
       def retrieve_event(event_id, params)
@@ -67,28 +67,35 @@ module Deeprails
         @client.request(
           method: :get,
           path: ["defend/%1$s/events/%2$s", workflow_id, event_id],
-          model: Deeprails::WorkflowEventResponse,
+          model: Deeprails::WorkflowEventDetailResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Deeprails::Models::DefendRetrieveWorkflowParams} for more details.
+      #
       # Use this endpoint to retrieve the details for a specific defend workflow
       #
-      # @overload retrieve_workflow(workflow_id, request_options: {})
+      # @overload retrieve_workflow(workflow_id, limit: nil, request_options: {})
       #
       # @param workflow_id [String] The ID of the workflow to retrieve.
       #
+      # @param limit [Integer] Limit the number of returned events associated with this workflow. Defaults to
+      #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Deeprails::Models::DefendResponse]
       #
       # @see Deeprails::Models::DefendRetrieveWorkflowParams
       def retrieve_workflow(workflow_id, params = {})
+        parsed, options = Deeprails::DefendRetrieveWorkflowParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["defend/%1$s", workflow_id],
+          query: parsed,
           model: Deeprails::DefendResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -128,7 +135,7 @@ module Deeprails
         )
       end
 
-      # Use this endpoint to update an existing guardrail workflow
+      # Use this endpoint to update an existing defend workflow
       #
       # @overload update_workflow(workflow_id, description: nil, name: nil, request_options: {})
       #
@@ -140,7 +147,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::DefendResponse]
+      # @return [Deeprails::Models::DefendUpdateResponse]
       #
       # @see Deeprails::Models::DefendUpdateWorkflowParams
       def update_workflow(workflow_id, params = {})
@@ -149,7 +156,7 @@ module Deeprails
           method: :put,
           path: ["defend/%1$s", workflow_id],
           body: parsed,
-          model: Deeprails::DefendResponse,
+          model: Deeprails::DefendUpdateResponse,
           options: options
         )
       end

data/lib/deeprails/resources/files.rb

@@ -7,7 +7,7 @@ module Deeprails
       #
       # @overload upload(file:, request_options: {})
       #
-      # @param file [Pathname, StringIO, IO, String, Deeprails::FilePart] The contents of the file to upload.
+      # @param file [Array<String>] The contents of the file to upload.
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/deeprails/resources/monitor.rb

@@ -23,7 +23,7 @@ module Deeprails
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::MonitorResponse]
+      # @return [Deeprails::Models::MonitorCreateResponse]
       #
       # @see Deeprails::Models::MonitorCreateParams
       def create(params)
@@ -32,11 +32,14 @@ module Deeprails
           method: :post,
           path: "monitor",
           body: parsed,
-          model: Deeprails::MonitorResponse,
+          model: Deeprails::MonitorCreateResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Deeprails::Models::MonitorRetrieveParams} for more details.
+      #
       # Use this endpoint to retrieve the details and evaluations associated with a
       # specific monitor
       #
@@ -44,7 +47,7 @@ module Deeprails
       #
       # @param monitor_id [String] The ID of the monitor to retrieve.
       #
-      # @param limit [Integer] Limit the returned events associated with this monitor. Defaults to 10.
+      # @param limit [Integer] Limit the number of returned evaluations associated with this monitor. Defaults
       #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -68,19 +71,19 @@ module Deeprails
       # Use this endpoint to update the name, description, or status of an existing
       # monitor
       #
-      # @overload update(monitor_id, description: nil, monitor_status: nil, name: nil, request_options: {})
+      # @overload update(monitor_id, description: nil, name: nil, status: nil, request_options: {})
       #
       # @param monitor_id [String] The ID of the monitor to edit.
       #
       # @param description [String] Description of the monitor.
       #
-      # @param monitor_status [Symbol, Deeprails::Models::MonitorUpdateParams::MonitorStatus] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
-      #
       # @param name [String] Name of the monitor.
       #
+      # @param status [Symbol, Deeprails::Models::MonitorUpdateParams::Status] Status of the monitor. Can be `active` or `inactive`. Inactive monitors no lon
+      #
       # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Deeprails::Models::MonitorResponse]
+      # @return [Deeprails::Models::MonitorUpdateResponse]
       #
       # @see Deeprails::Models::MonitorUpdateParams
       def update(monitor_id, params = {})
@@ -89,7 +92,34 @@ module Deeprails
           method: :put,
           path: ["monitor/%1$s", monitor_id],
           body: parsed,
-          model: Deeprails::MonitorResponse,
+          model: Deeprails::MonitorUpdateResponse,
+          options: options
+        )
+      end
+
+      # Use this endpoint to retrieve the details of a specific monitor event
+      #
+      # @overload retrieve_event(event_id, monitor_id:, request_options: {})
+      #
+      # @param event_id [String] The ID of the requested monitor event.
+      #
+      # @param monitor_id [String] The ID of the monitor associated with this event.
+      #
+      # @param request_options [Deeprails::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Deeprails::Models::MonitorEventDetailResponse]
+      #
+      # @see Deeprails::Models::MonitorRetrieveEventParams
+      def retrieve_event(event_id, params)
+        parsed, options = Deeprails::MonitorRetrieveEventParams.dump_request(params)
+        monitor_id =
+          parsed.delete(:monitor_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["monitor/%1$s/events/%2$s", monitor_id, event_id],
+          model: Deeprails::MonitorEventDetailResponse,
           options: options
         )
       end

data/lib/deeprails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deeprails
-  VERSION = "0.11.0"
+  VERSION = "0.13.0"
 end