context.dev 2.1.0 → 2.3.0

data/rbi/context_dev/models/webhook_delivery.rbi

@@ -0,0 +1,172 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebhookDelivery < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::WebhookDelivery, ContextDev::Internal::AnyHash)
+        end
+
+      sig { returns(Time) }
+      attr_accessor :attempted_at
+
+      sig { returns(T.nilable(ContextDev::WebhookDelivery::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error: T.nilable(ContextDev::WebhookDelivery::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # The event this delivery carried. Deliveries recorded before event selection
+      # existed report change.detected.
+      sig { returns(ContextDev::WebhookDelivery::Event::TaggedSymbol) }
+      attr_accessor :event
+
+      # Identifier sent in the X-Context-Id header.
+      sig { returns(String) }
+      attr_accessor :event_id
+
+      # The endpoint's final HTTP response status, or null when no response was
+      # received.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :http_status
+
+      # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
+      # response; failed means no HTTP response was received; skipped_unsafe_url means
+      # the URL failed the public-endpoint safety check.
+      sig { returns(ContextDev::WebhookDelivery::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig do
+        params(
+          attempted_at: Time,
+          error: T.nilable(ContextDev::WebhookDelivery::Error::OrHash),
+          event: ContextDev::WebhookDelivery::Event::OrSymbol,
+          event_id: String,
+          http_status: T.nilable(Integer),
+          status: ContextDev::WebhookDelivery::Status::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        attempted_at:,
+        error:,
+        # The event this delivery carried. Deliveries recorded before event selection
+        # existed report change.detected.
+        event:,
+        # Identifier sent in the X-Context-Id header.
+        event_id:,
+        # The endpoint's final HTTP response status, or null when no response was
+        # received.
+        http_status:,
+        # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
+        # response; failed means no HTTP response was received; skipped_unsafe_url means
+        # the URL failed the public-endpoint safety check.
+        status:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            attempted_at: Time,
+            error: T.nilable(ContextDev::WebhookDelivery::Error),
+            event: ContextDev::WebhookDelivery::Event::TaggedSymbol,
+            event_id: String,
+            http_status: T.nilable(Integer),
+            status: ContextDev::WebhookDelivery::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Error < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebhookDelivery::Error,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :code
+
+        sig { returns(String) }
+        attr_accessor :message
+
+        sig { params(code: String, message: String).returns(T.attached_class) }
+        def self.new(code:, message:)
+        end
+
+        sig { override.returns({ code: String, message: String }) }
+        def to_hash
+        end
+      end
+
+      # The event this delivery carried. Deliveries recorded before event selection
+      # existed report change.detected.
+      module Event
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebhookDelivery::Event) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CHANGE_DETECTED =
+          T.let(
+            :"change.detected",
+            ContextDev::WebhookDelivery::Event::TaggedSymbol
+          )
+        RUN_COMPLETED =
+          T.let(
+            :"run.completed",
+            ContextDev::WebhookDelivery::Event::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebhookDelivery::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
+      # response; failed means no HTTP response was received; skipped_unsafe_url means
+      # the URL failed the public-endpoint safety check.
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebhookDelivery::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DELIVERED =
+          T.let(:delivered, ContextDev::WebhookDelivery::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, ContextDev::WebhookDelivery::Status::TaggedSymbol)
+        FAILED =
+          T.let(:failed, ContextDev::WebhookDelivery::Status::TaggedSymbol)
+        SKIPPED_UNSAFE_URL =
+          T.let(
+            :skipped_unsafe_url,
+            ContextDev::WebhookDelivery::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebhookDelivery::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models.rbi

@@ -38,6 +38,8 @@ module ContextDev
 
   MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
 
+  ParseHandleParams = ContextDev::Models::ParseHandleParams
+
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
@@ -48,6 +50,8 @@ module ContextDev
 
   WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams
 
+  WebhookDelivery = ContextDev::Models::WebhookDelivery
+
   WebScreenshotParams = ContextDev::Models::WebScreenshotParams
 
   WebSearchParams = ContextDev::Models::WebSearchParams

data/rbi/context_dev/resources/monitors.rbi

@@ -3,8 +3,9 @@
 module ContextDev
   module Resources
     # Monitor pages, sitemaps, and extracted website data for exact or semantic
-    # changes. The change.detected webhook payload is documented by the
-    # MonitorsChangeDetectedWebhookPayload schema.
+    # changes. Webhook payloads are documented by the
+    # MonitorsChangeDetectedWebhookPayload and MonitorsRunCompletedWebhookPayload
+    # schemas.
     class Monitors
       # Creates a monitor. The request body is a union of the supported target/change
       # detection combinations. The monitor runs immediately after creation to create

data/rbi/context_dev/resources/parse.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module ContextDev
+  module Resources
+    class Parse
+      # Converts raw text, source code, web/data, PDF, Microsoft Office, and image bytes
+      # into LLM-usable Markdown.
+      sig do
+        params(
+          body: ContextDev::Internal::FileInput,
+          base_url: String,
+          extension: String,
+          filename: String,
+          include_images: T::Boolean,
+          include_links: T::Boolean,
+          ocr: T::Boolean,
+          pdf_end: Integer,
+          pdf_start: Integer,
+          shorten_base64_images: T::Boolean,
+          use_main_content_only: T::Boolean,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::ParseHandleResponse)
+      end
+      def handle(
+        # Body param
+        body:,
+        # Query param: Optional HTTP(S) source document URL used to resolve relative links
+        # and image references. Relative references remain relative when omitted.
+        base_url: nil,
+        # Query param: Optional file extension hint, such as pdf, docx, xlsx, pptx, html,
+        # json, csv, md, py, rtf, jpg, png, or txt.
+        extension: nil,
+        # Query param: Optional filename hint used to infer the extension when extension
+        # is omitted.
+        filename: nil,
+        # Query param: Include image references in Markdown output
+        include_images: nil,
+        # Query param: Preserve hyperlinks in Markdown output
+        include_links: nil,
+        # Query param: When true for PDF inputs, detect and OCR images embedded in the
+        # selected pages, inserting recognized text at each image's position in page
+        # reading order while preserving the PDF text layer. pdfStart/pdfEnd limit the
+        # inclusive page range. This is separate from automatic scanned-PDF OCR fallback.
+        ocr: nil,
+        # Query param: Last 1-based PDF page to parse. When omitted, parsing ends at the
+        # last page. Must be greater than or equal to pdfStart when both are provided.
+        pdf_end: nil,
+        # Query param: First 1-based PDF page to parse. When omitted, parsing starts at
+        # the first page.
+        pdf_start: nil,
+        # Query param: Shorten base64-encoded image data in the Markdown output
+        shorten_base64_images: nil,
+        # Query param: Extract only the main content from HTML-like inputs
+        use_main_content_only: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ContextDev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/context_dev/resources/web.rbi

@@ -344,8 +344,8 @@ module ContextDev
         max_depth: nil,
         # Maximum number of pages to crawl. Hard cap: 500.
         max_pages: nil,
-        # PDF parsing controls. Use start/end to limit text extraction and OCR to an
-        # inclusive 1-based page range.
+        # PDF parsing controls. Use start/end to limit text extraction and embedded-image
+        # detection/OCR to an inclusive 1-based page range.
         pdf: nil,
         # When true, waits briefly for CSS and transition animations to settle before
         # extracting each crawled page. Defaults to false. This adds a bit of latency in
@@ -416,8 +416,8 @@ module ContextDev
         # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
         # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
         max_age_ms: nil,
-        # PDF parsing controls. Use start/end to limit text extraction and OCR to an
-        # inclusive 1-based page range.
+        # PDF parsing controls. Use start/end to limit text extraction and embedded-image
+        # detection/OCR to an inclusive 1-based page range.
         pdf: nil,
         # When true, waits briefly for CSS and transition animations to settle before
         # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
@@ -482,7 +482,22 @@ module ContextDev
       )
       end
 
-      # Scrapes the given URL into LLM usable Markdown.
+      # Scrapes the given URL into LLM usable Markdown. Inspect key_metadata on JSON
+      # responses from a recognized API key; use error_code to distinguish stable
+      # failure categories.
+      #
+      # ### Billing & errors
+      #
+      # | HTTP status | Billed?        | Meaning                                                                                  |
+      # | ----------- | -------------- | ---------------------------------------------------------------------------------------- |
+      # | 200         | Yes — 1 credit | Successful scrape, including a zero-length result when includeSelectors matched nothing  |
+      # | 400         | No             | Invalid input, skipped PDF, or the page could not be scraped                             |
+      # | 401 / 403   | No             | Invalid/disabled key, insufficient permissions, or credits exhausted; inspect error_code |
+      # | 404         | No             | Target page returned or fingerprinted as not found                                       |
+      # | 408         | No             | Request timed out                                                                        |
+      # | 415         | No             | Unsupported content type                                                                 |
+      # | 429         | No             | Per-minute rate limit exceeded; honor Retry-After                                        |
+      # | 500         | No             | Internal error                                                                           |
       sig do
         params(
           url: String,
@@ -532,8 +547,8 @@ module ContextDev
         # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
         # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
         max_age_ms: nil,
-        # PDF parsing controls. Use start/end to limit text extraction and OCR to an
-        # inclusive 1-based page range.
+        # PDF parsing controls. Use start/end to limit text extraction and embedded-image
+        # detection/OCR to an inclusive 1-based page range.
         pdf: nil,
         # When true, waits briefly for CSS and transition animations to settle before
         # converting to Markdown. Defaults to false. This adds a bit of latency in

data/sig/context_dev/client.rbs

@@ -10,6 +10,8 @@ module ContextDev
 
     attr_reader api_key: String
 
+    attr_reader parse: ContextDev::Resources::Parse
+
     attr_reader web: ContextDev::Resources::Web
 
     attr_reader ai: ContextDev::Resources::AI

data/sig/context_dev/models/monitor_create_params.rbs

@@ -287,14 +287,43 @@ module ContextDev
         def self?.values: -> ::Array[ContextDev::Models::MonitorCreateParams::mode]
       end
 
-      type webhook = { url: String, secret: String }
+      type webhook =
+        {
+          url: String,
+          events: ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event],
+          secret: String
+        }
 
       class Webhook < ContextDev::Internal::Type::BaseModel
         attr_accessor url: String
 
-        def initialize: (url: String) -> void
+        attr_reader events: ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event]?
+
+        def events=: (
+          ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event]
+        ) -> ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event]
+
+        def initialize: (
+          url: String,
+          ?events: ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event]
+        ) -> void
+
+        def to_hash: -> {
+          url: String,
+          events: ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event],
+          secret: String
+        }
 
-        def to_hash: -> { url: String, secret: String }
+        type event = :"change.detected" | :"run.completed"
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          CHANGE_DETECTED: :"change.detected"
+          RUN_COMPLETED: :"run.completed"
+
+          def self?.values: -> ::Array[ContextDev::Models::MonitorCreateParams::Webhook::event]
+        end
       end
     end
   end

data/sig/context_dev/models/monitor_create_response.rbs

@@ -17,7 +17,8 @@ module ContextDev
         last_run_at: Time?,
         next_run_at: Time?,
         tags: ::Array[String],
-        webhook: ContextDev::Models::MonitorCreateResponse::Webhook?
+        webhook: ContextDev::Models::MonitorCreateResponse::Webhook?,
+        webhook_failure: ContextDev::Models::MonitorCreateResponse::WebhookFailure?
       }
 
     class MonitorCreateResponse < ContextDev::Internal::Type::BaseModel
@@ -55,6 +56,8 @@ module ContextDev
 
       attr_accessor webhook: ContextDev::Models::MonitorCreateResponse::Webhook?
 
+      attr_accessor webhook_failure: ContextDev::Models::MonitorCreateResponse::WebhookFailure?
+
       def initialize: (
         id: String,
         change_detection: ContextDev::Models::MonitorCreateResponse::change_detection,
@@ -71,7 +74,8 @@ module ContextDev
         ?last_run_at: Time?,
         ?next_run_at: Time?,
         ?tags: ::Array[String],
-        ?webhook: ContextDev::Models::MonitorCreateResponse::Webhook?
+        ?webhook: ContextDev::Models::MonitorCreateResponse::Webhook?,
+        ?webhook_failure: ContextDev::Models::MonitorCreateResponse::WebhookFailure?
       ) -> void
 
       def to_hash: -> {
@@ -90,7 +94,8 @@ module ContextDev
         last_run_at: Time?,
         next_run_at: Time?,
         tags: ::Array[String],
-        webhook: ContextDev::Models::MonitorCreateResponse::Webhook?
+        webhook: ContextDev::Models::MonitorCreateResponse::Webhook?,
+        webhook_failure: ContextDev::Models::MonitorCreateResponse::WebhookFailure?
       }
 
       type change_detection =
@@ -415,18 +420,92 @@ module ContextDev
         def to_hash: -> { code: String, message: String }
       end
 
-      type webhook = { url: String, secret: String }
+      type webhook =
+        {
+          url: String,
+          events: ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event],
+          secret: String
+        }
 
       class Webhook < ContextDev::Internal::Type::BaseModel
         attr_accessor url: String
 
+        attr_reader events: ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event]?
+
+        def events=: (
+          ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event]
+        ) -> ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event]
+
         attr_reader secret: String?
 
         def secret=: (String) -> String
 
-        def initialize: (url: String, ?secret: String) -> void
+        def initialize: (
+          url: String,
+          ?events: ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event],
+          ?secret: String
+        ) -> void
+
+        def to_hash: -> {
+          url: String,
+          events: ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event],
+          secret: String
+        }
+
+        type event = :"change.detected" | :"run.completed"
+
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          CHANGE_DETECTED: :"change.detected"
+          RUN_COMPLETED: :"run.completed"
 
-        def to_hash: -> { url: String, secret: String }
+          def self?.values: -> ::Array[ContextDev::Models::MonitorCreateResponse::Webhook::event]
+        end
+      end
+
+      type webhook_failure =
+        {
+          consecutive_failures: Integer,
+          last_failed_at: Time,
+          last_message: String,
+          last_status: ContextDev::Models::MonitorCreateResponse::WebhookFailure::last_status
+        }
+
+      class WebhookFailure < ContextDev::Internal::Type::BaseModel
+        attr_accessor consecutive_failures: Integer
+
+        attr_accessor last_failed_at: Time
+
+        attr_accessor last_message: String
+
+        attr_accessor last_status: ContextDev::Models::MonitorCreateResponse::WebhookFailure::last_status
+
+        def initialize: (
+          consecutive_failures: Integer,
+          last_failed_at: Time,
+          last_message: String,
+          last_status: ContextDev::Models::MonitorCreateResponse::WebhookFailure::last_status
+        ) -> void
+
+        def to_hash: -> {
+          consecutive_failures: Integer,
+          last_failed_at: Time,
+          last_message: String,
+          last_status: ContextDev::Models::MonitorCreateResponse::WebhookFailure::last_status
+        }
+
+        type last_status = :rejected | :failed | :skipped_unsafe_url
+
+        module LastStatus
+          extend ContextDev::Internal::Type::Enum
+
+          REJECTED: :rejected
+          FAILED: :failed
+          SKIPPED_UNSAFE_URL: :skipped_unsafe_url
+
+          def self?.values: -> ::Array[ContextDev::Models::MonitorCreateResponse::WebhookFailure::last_status]
+        end
       end
     end
   end

data/sig/context_dev/models/monitor_list_account_runs_response.rbs

@@ -41,7 +41,9 @@ module ContextDev
           completed_at: Time?,
           error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?,
           skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?,
-          started_at: Time?
+          started_at: Time?,
+          webhook_deliveries: ::Array[ContextDev::WebhookDelivery],
+          webhook_delivery: ContextDev::WebhookDelivery
         }
 
       class Data < ContextDev::Internal::Type::BaseModel
@@ -73,6 +75,18 @@ module ContextDev
 
         attr_accessor started_at: Time?
 
+        attr_reader webhook_deliveries: ::Array[ContextDev::WebhookDelivery]?
+
+        def webhook_deliveries=: (
+          ::Array[ContextDev::WebhookDelivery]
+        ) -> ::Array[ContextDev::WebhookDelivery]
+
+        attr_reader webhook_delivery: ContextDev::WebhookDelivery?
+
+        def webhook_delivery=: (
+          ContextDev::WebhookDelivery
+        ) -> ContextDev::WebhookDelivery
+
         def initialize: (
           id: String,
           baseline_created: bool,
@@ -87,7 +101,9 @@ module ContextDev
           ?completed_at: Time?,
           ?error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?,
           ?skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?,
-          ?started_at: Time?
+          ?started_at: Time?,
+          ?webhook_deliveries: ::Array[ContextDev::WebhookDelivery],
+          ?webhook_delivery: ContextDev::WebhookDelivery
         ) -> void
 
         def to_hash: -> {
@@ -104,7 +120,9 @@ module ContextDev
           completed_at: Time?,
           error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?,
           skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?,
-          started_at: Time?
+          started_at: Time?,
+          webhook_deliveries: ::Array[ContextDev::WebhookDelivery],
+          webhook_delivery: ContextDev::WebhookDelivery
         }
 
         type change_detection_type = :exact | :semantic