From 82b79e8c9078456ee2cf3ff4d3379d6f2732cddf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 10 Jul 2026 03:46:00 +0000 Subject: [PATCH 01/11] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index c2cc39a5..6f63fc82 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-ecb277557634e2f0838ea196e2b21f11924f65e133c7977e8c2e1a603b8df466.yml -openapi_spec_hash: 798ce4cb042389a1179bf9af6fc1173d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-de547897d4a30447212ce36430a932cf186efd91844bd8ea0757a1cde4ce40e1.yml +openapi_spec_hash: efa1b29865560c7817495b20c1b62fad config_hash: ff35e224e809656528c44163aa41bebd From 626d1054da9622e88469bb9c3b755f43d1d75280 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 10 Jul 2026 23:22:13 +0000 Subject: [PATCH 02/11] feat(api): api update --- .stats.yml | 4 +-- .../monitor_retrieve_change_response.rb | 20 +++++++------- .../monitor_retrieve_change_response.rbi | 27 +++++++++---------- .../monitor_retrieve_change_response.rbs | 18 ++++++------- test/context_dev/resources/monitors_test.rb | 4 +-- 5 files changed, 34 insertions(+), 39 deletions(-) diff --git a/.stats.yml b/.stats.yml index 6f63fc82..a9bd7b9c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-de547897d4a30447212ce36430a932cf186efd91844bd8ea0757a1cde4ce40e1.yml -openapi_spec_hash: efa1b29865560c7817495b20c1b62fad +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-e3b1fd2a6aecb6cac87a0a2f4f811dedc261ae162cceced0841b5184ba609308.yml +openapi_spec_hash: 28e4c0d0599e1f7153838a465f9cf5b5 config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev/models/monitor_retrieve_change_response.rb b/lib/context_dev/models/monitor_retrieve_change_response.rb index 36a71cb2..6b8ba7a6 100644 --- a/lib/context_dev/models/monitor_retrieve_change_response.rb +++ b/lib/context_dev/models/monitor_retrieve_change_response.rb @@ -43,6 +43,12 @@ class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel # @return [String] required :summary, String + # @!attribute tags + # User-defined tags for grouping and filtering monitors and their changes. + # + # @return [Array] + required :tags, ContextDev::Internal::Type::ArrayOf[String] + # @!attribute target_type # # @return [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType] @@ -123,13 +129,7 @@ class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel # @return [Array, nil] optional :removed_urls, ContextDev::Internal::Type::ArrayOf[String] - # @!attribute tags - # User-defined tags for grouping and filtering monitors and their changes. - # - # @return [Array, nil] - optional :tags, ContextDev::Internal::Type::ArrayOf[String] - - # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, run_id:, summary:, target_type:, title:, url:, added_url_count: nil, added_urls: nil, after_text_excerpt: nil, before_text_excerpt: nil, confidence: nil, diff: nil, evidence: nil, importance: nil, matched_url_count: nil, matched_urls: nil, removed_url_count: nil, removed_urls: nil, tags: nil) + # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, run_id:, summary:, tags:, target_type:, title:, url:, added_url_count: nil, added_urls: nil, after_text_excerpt: nil, before_text_excerpt: nil, confidence: nil, diff: nil, evidence: nil, importance: nil, matched_url_count: nil, matched_urls: nil, removed_url_count: nil, removed_urls: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorRetrieveChangeResponse} for more details. # @@ -137,7 +137,7 @@ class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel # `change_detection_type` describe the change, and which optional fields are # present depends on them (page: `diff` + excerpts; sitemap: # `added_urls`/`removed_urls`; semantic: - # `query`/`confidence`/`importance`/`evidence`/`matched_urls`). + # `confidence`/`importance`/`evidence`/`matched_urls`). # # @param id [String] # @@ -153,6 +153,8 @@ class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel # # @param summary [String] # + # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. + # # @param target_type [Symbol, ContextDev::Models::MonitorRetrieveChangeResponse::TargetType] # # @param title [String] @@ -182,8 +184,6 @@ class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel # @param removed_url_count [Integer] # # @param removed_urls [Array] At most 500 URLs are included; the corresponding count field is always exact. - # - # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. # @see ContextDev::Models::MonitorRetrieveChangeResponse#change_detection_type module ChangeDetectionType diff --git a/rbi/context_dev/models/monitor_retrieve_change_response.rbi b/rbi/context_dev/models/monitor_retrieve_change_response.rbi index cfa48154..c6e43212 100644 --- a/rbi/context_dev/models/monitor_retrieve_change_response.rbi +++ b/rbi/context_dev/models/monitor_retrieve_change_response.rbi @@ -43,6 +43,10 @@ module ContextDev sig { returns(String) } attr_accessor :summary + # User-defined tags for grouping and filtering monitors and their changes. + sig { returns(T::Array[String]) } + attr_accessor :tags + sig do returns( ContextDev::Models::MonitorRetrieveChangeResponse::TargetType::TaggedSymbol @@ -158,18 +162,11 @@ module ContextDev sig { params(removed_urls: T::Array[String]).void } attr_writer :removed_urls - # User-defined tags for grouping and filtering monitors and their changes. - sig { returns(T.nilable(T::Array[String])) } - attr_reader :tags - - sig { params(tags: T::Array[String]).void } - attr_writer :tags - # A detected change. `mode` is the constant `web`; `target_type` and # `change_detection_type` describe the change, and which optional fields are # present depends on them (page: `diff` + excerpts; sitemap: # `added_urls`/`removed_urls`; semantic: - # `query`/`confidence`/`importance`/`evidence`/`matched_urls`). + # `confidence`/`importance`/`evidence`/`matched_urls`). sig do params( id: String, @@ -181,6 +178,7 @@ module ContextDev monitor_id: String, run_id: String, summary: String, + tags: T::Array[String], target_type: ContextDev::Models::MonitorRetrieveChangeResponse::TargetType::OrSymbol, title: String, @@ -200,8 +198,7 @@ module ContextDev matched_url_count: Integer, matched_urls: T::Array[String], removed_url_count: Integer, - removed_urls: T::Array[String], - tags: T::Array[String] + removed_urls: T::Array[String] ).returns(T.attached_class) end def self.new( @@ -215,6 +212,8 @@ module ContextDev # The run that detected this change. run_id:, summary:, + # User-defined tags for grouping and filtering monitors and their changes. + tags:, target_type:, title:, url:, @@ -233,9 +232,7 @@ module ContextDev matched_urls: nil, removed_url_count: nil, # At most 500 URLs are included; the corresponding count field is always exact. - removed_urls: nil, - # User-defined tags for grouping and filtering monitors and their changes. - tags: nil + removed_urls: nil ) end @@ -251,6 +248,7 @@ module ContextDev monitor_id: String, run_id: String, summary: String, + tags: T::Array[String], target_type: ContextDev::Models::MonitorRetrieveChangeResponse::TargetType::TaggedSymbol, title: String, @@ -270,8 +268,7 @@ module ContextDev matched_url_count: Integer, matched_urls: T::Array[String], removed_url_count: Integer, - removed_urls: T::Array[String], - tags: T::Array[String] + removed_urls: T::Array[String] } ) end diff --git a/sig/context_dev/models/monitor_retrieve_change_response.rbs b/sig/context_dev/models/monitor_retrieve_change_response.rbs index fce957ac..90edba46 100644 --- a/sig/context_dev/models/monitor_retrieve_change_response.rbs +++ b/sig/context_dev/models/monitor_retrieve_change_response.rbs @@ -9,6 +9,7 @@ module ContextDev monitor_id: String, run_id: String, summary: String, + tags: ::Array[String], target_type: ContextDev::Models::MonitorRetrieveChangeResponse::target_type, title: String, url: String, @@ -23,8 +24,7 @@ module ContextDev matched_url_count: Integer, matched_urls: ::Array[String], removed_url_count: Integer, - removed_urls: ::Array[String], - tags: ::Array[String] + removed_urls: ::Array[String] } class MonitorRetrieveChangeResponse < ContextDev::Internal::Type::BaseModel @@ -42,6 +42,8 @@ module ContextDev attr_accessor summary: String + attr_accessor tags: ::Array[String] + attr_accessor target_type: ContextDev::Models::MonitorRetrieveChangeResponse::target_type attr_accessor title: String @@ -100,10 +102,6 @@ module ContextDev def removed_urls=: (::Array[String]) -> ::Array[String] - attr_reader tags: ::Array[String]? - - def tags=: (::Array[String]) -> ::Array[String] - def initialize: ( id: String, change_detection_type: ContextDev::Models::MonitorRetrieveChangeResponse::change_detection_type, @@ -112,6 +110,7 @@ module ContextDev monitor_id: String, run_id: String, summary: String, + tags: ::Array[String], target_type: ContextDev::Models::MonitorRetrieveChangeResponse::target_type, title: String, url: String, @@ -126,8 +125,7 @@ module ContextDev ?matched_url_count: Integer, ?matched_urls: ::Array[String], ?removed_url_count: Integer, - ?removed_urls: ::Array[String], - ?tags: ::Array[String] + ?removed_urls: ::Array[String] ) -> void def to_hash: -> { @@ -138,6 +136,7 @@ module ContextDev monitor_id: String, run_id: String, summary: String, + tags: ::Array[String], target_type: ContextDev::Models::MonitorRetrieveChangeResponse::target_type, title: String, url: String, @@ -152,8 +151,7 @@ module ContextDev matched_url_count: Integer, matched_urls: ::Array[String], removed_url_count: Integer, - removed_urls: ::Array[String], - tags: ::Array[String] + removed_urls: ::Array[String] } type change_detection_type = :exact | :semantic diff --git a/test/context_dev/resources/monitors_test.rb b/test/context_dev/resources/monitors_test.rb index ef45e4b5..e6aa0715 100644 --- a/test/context_dev/resources/monitors_test.rb +++ b/test/context_dev/resources/monitors_test.rb @@ -227,6 +227,7 @@ def test_retrieve_change monitor_id: String, run_id: String, summary: String, + tags: ^(ContextDev::Internal::Type::ArrayOf[String]), target_type: ContextDev::Models::MonitorRetrieveChangeResponse::TargetType, title: String, url: String, @@ -241,8 +242,7 @@ def test_retrieve_change matched_url_count: Integer | nil, matched_urls: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil, removed_url_count: Integer | nil, - removed_urls: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil, - tags: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil + removed_urls: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil } end end From 03fa3ac3c7c61aba88846db890bf4d3fd22d1086 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 11 Jul 2026 02:22:48 +0000 Subject: [PATCH 03/11] feat(api): api update --- .stats.yml | 4 +- .../models/monitor_create_response.rb | 72 ++++++++- .../models/monitor_list_response.rb | 76 ++++++++- .../models/monitor_retrieve_response.rb | 73 ++++++++- .../models/monitor_update_response.rb | 72 ++++++++- .../models/monitor_create_response.rbi | 148 +++++++++++++++++- .../models/monitor_list_response.rbi | 148 +++++++++++++++++- .../models/monitor_retrieve_response.rbi | 148 +++++++++++++++++- .../models/monitor_update_response.rbi | 148 +++++++++++++++++- .../models/monitor_create_response.rbs | 55 ++++++- .../models/monitor_list_response.rbs | 55 ++++++- .../models/monitor_retrieve_response.rbs | 55 ++++++- .../models/monitor_update_response.rbs | 55 ++++++- test/context_dev/resources/monitors_test.rb | 9 +- 14 files changed, 1090 insertions(+), 28 deletions(-) diff --git a/.stats.yml b/.stats.yml index a9bd7b9c..c1de7fe8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-e3b1fd2a6aecb6cac87a0a2f4f811dedc261ae162cceced0841b5184ba609308.yml -openapi_spec_hash: 28e4c0d0599e1f7153838a465f9cf5b5 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d60fed3d26479d1ee76b77df8415390504542522e7188792a23bf77b9f37ed63.yml +openapi_spec_hash: 263672c59d9b01c50f7d2307fbd82ec0 config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev/models/monitor_create_response.rb b/lib/context_dev/models/monitor_create_response.rb index 18606a0c..b8351949 100644 --- a/lib/context_dev/models/monitor_create_response.rb +++ b/lib/context_dev/models/monitor_create_response.rb @@ -103,7 +103,15 @@ class MonitorCreateResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::MonitorCreateResponse::Webhook, nil] optional :webhook, -> { ContextDev::Models::MonitorCreateResponse::Webhook }, nil?: true - # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil) + # @!attribute webhook_failure + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @return [ContextDev::Models::MonitorCreateResponse::WebhookFailure, nil] + optional :webhook_failure, -> { ContextDev::Models::MonitorCreateResponse::WebhookFailure }, nil?: true + + # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorCreateResponse} for more details. # @@ -141,6 +149,8 @@ class MonitorCreateResponse < ContextDev::Internal::Type::BaseModel # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. # # @param webhook [ContextDev::Models::MonitorCreateResponse::Webhook, nil] + # + # @param webhook_failure [ContextDev::Models::MonitorCreateResponse::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries # Discriminated union describing how changes are detected. # @@ -608,6 +618,66 @@ class Webhook < ContextDev::Internal::Type::BaseModel # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X end + + # @see ContextDev::Models::MonitorCreateResponse#webhook_failure + class WebhookFailure < ContextDev::Internal::Type::BaseModel + # @!attribute consecutive_failures + # Number of consecutive delivery attempts that did not succeed. + # + # @return [Integer] + required :consecutive_failures, Integer + + # @!attribute last_failed_at + # + # @return [Time] + required :last_failed_at, Time + + # @!attribute last_message + # Human-readable description of the most recent failure. + # + # @return [String] + required :last_message, String + + # @!attribute last_status + # Outcome of the most recent failed delivery. 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. + # + # @return [Symbol, ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus] + required :last_status, enum: -> { ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus } + + # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorCreateResponse::WebhookFailure} for more details. + # + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed. + # + # @param last_failed_at [Time] + # + # @param last_message [String] Human-readable description of the most recent failure. + # + # @param last_status [Symbol, ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f + + # Outcome of the most recent failed delivery. 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. + # + # @see ContextDev::Models::MonitorCreateResponse::WebhookFailure#last_status + module LastStatus + extend ContextDev::Internal::Type::Enum + + REJECTED = :rejected + FAILED = :failed + SKIPPED_UNSAFE_URL = :skipped_unsafe_url + + # @!method self.values + # @return [Array] + end + end end end end diff --git a/lib/context_dev/models/monitor_list_response.rb b/lib/context_dev/models/monitor_list_response.rb index 75a70bfa..19ffa99c 100644 --- a/lib/context_dev/models/monitor_list_response.rb +++ b/lib/context_dev/models/monitor_list_response.rb @@ -124,7 +124,17 @@ class Data < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::MonitorListResponse::Data::Webhook, nil] optional :webhook, -> { ContextDev::Models::MonitorListResponse::Data::Webhook }, nil?: true - # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil) + # @!attribute webhook_failure + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @return [ContextDev::Models::MonitorListResponse::Data::WebhookFailure, nil] + optional :webhook_failure, + -> { ContextDev::Models::MonitorListResponse::Data::WebhookFailure }, + nil?: true + + # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListResponse::Data} for more details. # @@ -162,6 +172,8 @@ class Data < ContextDev::Internal::Type::BaseModel # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. # # @param webhook [ContextDev::Models::MonitorListResponse::Data::Webhook, nil] + # + # @param webhook_failure [ContextDev::Models::MonitorListResponse::Data::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries # Discriminated union describing how changes are detected. # @@ -630,6 +642,68 @@ class Webhook < ContextDev::Internal::Type::BaseModel # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X end + + # @see ContextDev::Models::MonitorListResponse::Data#webhook_failure + class WebhookFailure < ContextDev::Internal::Type::BaseModel + # @!attribute consecutive_failures + # Number of consecutive delivery attempts that did not succeed. + # + # @return [Integer] + required :consecutive_failures, Integer + + # @!attribute last_failed_at + # + # @return [Time] + required :last_failed_at, Time + + # @!attribute last_message + # Human-readable description of the most recent failure. + # + # @return [String] + required :last_message, String + + # @!attribute last_status + # Outcome of the most recent failed delivery. 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. + # + # @return [Symbol, ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus] + required :last_status, + enum: -> { ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus } + + # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorListResponse::Data::WebhookFailure} for more + # details. + # + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed. + # + # @param last_failed_at [Time] + # + # @param last_message [String] Human-readable description of the most recent failure. + # + # @param last_status [Symbol, ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f + + # Outcome of the most recent failed delivery. 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. + # + # @see ContextDev::Models::MonitorListResponse::Data::WebhookFailure#last_status + module LastStatus + extend ContextDev::Internal::Type::Enum + + REJECTED = :rejected + FAILED = :failed + SKIPPED_UNSAFE_URL = :skipped_unsafe_url + + # @!method self.values + # @return [Array] + end + end end end end diff --git a/lib/context_dev/models/monitor_retrieve_response.rb b/lib/context_dev/models/monitor_retrieve_response.rb index beecd0b4..0b256178 100644 --- a/lib/context_dev/models/monitor_retrieve_response.rb +++ b/lib/context_dev/models/monitor_retrieve_response.rb @@ -103,7 +103,15 @@ class MonitorRetrieveResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::MonitorRetrieveResponse::Webhook, nil] optional :webhook, -> { ContextDev::Models::MonitorRetrieveResponse::Webhook }, nil?: true - # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil) + # @!attribute webhook_failure + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @return [ContextDev::Models::MonitorRetrieveResponse::WebhookFailure, nil] + optional :webhook_failure, -> { ContextDev::Models::MonitorRetrieveResponse::WebhookFailure }, nil?: true + + # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorRetrieveResponse} for more details. # @@ -141,6 +149,8 @@ class MonitorRetrieveResponse < ContextDev::Internal::Type::BaseModel # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. # # @param webhook [ContextDev::Models::MonitorRetrieveResponse::Webhook, nil] + # + # @param webhook_failure [ContextDev::Models::MonitorRetrieveResponse::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries # Discriminated union describing how changes are detected. # @@ -608,6 +618,67 @@ class Webhook < ContextDev::Internal::Type::BaseModel # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X end + + # @see ContextDev::Models::MonitorRetrieveResponse#webhook_failure + class WebhookFailure < ContextDev::Internal::Type::BaseModel + # @!attribute consecutive_failures + # Number of consecutive delivery attempts that did not succeed. + # + # @return [Integer] + required :consecutive_failures, Integer + + # @!attribute last_failed_at + # + # @return [Time] + required :last_failed_at, Time + + # @!attribute last_message + # Human-readable description of the most recent failure. + # + # @return [String] + required :last_message, String + + # @!attribute last_status + # Outcome of the most recent failed delivery. 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. + # + # @return [Symbol, ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus] + required :last_status, + enum: -> { ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus } + + # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorRetrieveResponse::WebhookFailure} for more details. + # + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed. + # + # @param last_failed_at [Time] + # + # @param last_message [String] Human-readable description of the most recent failure. + # + # @param last_status [Symbol, ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f + + # Outcome of the most recent failed delivery. 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. + # + # @see ContextDev::Models::MonitorRetrieveResponse::WebhookFailure#last_status + module LastStatus + extend ContextDev::Internal::Type::Enum + + REJECTED = :rejected + FAILED = :failed + SKIPPED_UNSAFE_URL = :skipped_unsafe_url + + # @!method self.values + # @return [Array] + end + end end end end diff --git a/lib/context_dev/models/monitor_update_response.rb b/lib/context_dev/models/monitor_update_response.rb index 30aa47b4..7b56bdf4 100644 --- a/lib/context_dev/models/monitor_update_response.rb +++ b/lib/context_dev/models/monitor_update_response.rb @@ -103,7 +103,15 @@ class MonitorUpdateResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::MonitorUpdateResponse::Webhook, nil] optional :webhook, -> { ContextDev::Models::MonitorUpdateResponse::Webhook }, nil?: true - # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil) + # @!attribute webhook_failure + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @return [ContextDev::Models::MonitorUpdateResponse::WebhookFailure, nil] + optional :webhook_failure, -> { ContextDev::Models::MonitorUpdateResponse::WebhookFailure }, nil?: true + + # @!method initialize(id:, change_detection:, created_at:, mode:, name:, schedule:, status:, target:, updated_at:, baseline: nil, last_change_at: nil, last_error: nil, last_run_at: nil, next_run_at: nil, tags: nil, webhook: nil, webhook_failure: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorUpdateResponse} for more details. # @@ -141,6 +149,8 @@ class MonitorUpdateResponse < ContextDev::Internal::Type::BaseModel # @param tags [Array] User-defined tags for grouping and filtering monitors and their changes. # # @param webhook [ContextDev::Models::MonitorUpdateResponse::Webhook, nil] + # + # @param webhook_failure [ContextDev::Models::MonitorUpdateResponse::WebhookFailure, nil] Present while webhook deliveries are failing consecutively; null when deliveries # Discriminated union describing how changes are detected. # @@ -608,6 +618,66 @@ class Webhook < ContextDev::Internal::Type::BaseModel # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X end + + # @see ContextDev::Models::MonitorUpdateResponse#webhook_failure + class WebhookFailure < ContextDev::Internal::Type::BaseModel + # @!attribute consecutive_failures + # Number of consecutive delivery attempts that did not succeed. + # + # @return [Integer] + required :consecutive_failures, Integer + + # @!attribute last_failed_at + # + # @return [Time] + required :last_failed_at, Time + + # @!attribute last_message + # Human-readable description of the most recent failure. + # + # @return [String] + required :last_message, String + + # @!attribute last_status + # Outcome of the most recent failed delivery. 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. + # + # @return [Symbol, ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus] + required :last_status, enum: -> { ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus } + + # @!method initialize(consecutive_failures:, last_failed_at:, last_message:, last_status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorUpdateResponse::WebhookFailure} for more details. + # + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + # + # @param consecutive_failures [Integer] Number of consecutive delivery attempts that did not succeed. + # + # @param last_failed_at [Time] + # + # @param last_message [String] Human-readable description of the most recent failure. + # + # @param last_status [Symbol, ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus] Outcome of the most recent failed delivery. rejected means a non-2xx response; f + + # Outcome of the most recent failed delivery. 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. + # + # @see ContextDev::Models::MonitorUpdateResponse::WebhookFailure#last_status + module LastStatus + extend ContextDev::Internal::Type::Enum + + REJECTED = :rejected + FAILED = :failed + SKIPPED_UNSAFE_URL = :skipped_unsafe_url + + # @!method self.values + # @return [Array] + end + end end end end diff --git a/rbi/context_dev/models/monitor_create_response.rbi b/rbi/context_dev/models/monitor_create_response.rbi index 950848ee..8d35a685 100644 --- a/rbi/context_dev/models/monitor_create_response.rbi +++ b/rbi/context_dev/models/monitor_create_response.rbi @@ -128,6 +128,26 @@ module ContextDev end attr_writer :webhook + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + returns( + T.nilable(ContextDev::Models::MonitorCreateResponse::WebhookFailure) + ) + end + attr_reader :webhook_failure + + sig do + params( + webhook_failure: + T.nilable( + ContextDev::Models::MonitorCreateResponse::WebhookFailure::OrHash + ) + ).void + end + attr_writer :webhook_failure + # A web monitor. `mode` is the constant `web`; behavior is described by `target` # (page/sitemap/extract) and `change_detection` (exact/semantic). sig do @@ -169,6 +189,10 @@ module ContextDev webhook: T.nilable( ContextDev::Models::MonitorCreateResponse::Webhook::OrHash + ), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorCreateResponse::WebhookFailure::OrHash ) ).returns(T.attached_class) end @@ -207,7 +231,11 @@ module ContextDev next_run_at: nil, # User-defined tags for grouping and filtering monitors and their changes. tags: nil, - webhook: nil + webhook: nil, + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + webhook_failure: nil ) end @@ -236,7 +264,11 @@ module ContextDev next_run_at: T.nilable(Time), tags: T::Array[String], webhook: - T.nilable(ContextDev::Models::MonitorCreateResponse::Webhook) + T.nilable(ContextDev::Models::MonitorCreateResponse::Webhook), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorCreateResponse::WebhookFailure + ) } ) end @@ -1025,6 +1057,118 @@ module ContextDev def to_hash end end + + class WebhookFailure < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::MonitorCreateResponse::WebhookFailure, + ContextDev::Internal::AnyHash + ) + end + + # Number of consecutive delivery attempts that did not succeed. + sig { returns(Integer) } + attr_accessor :consecutive_failures + + sig { returns(Time) } + attr_accessor :last_failed_at + + # Human-readable description of the most recent failure. + sig { returns(String) } + attr_accessor :last_message + + # Outcome of the most recent failed delivery. 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 do + returns( + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + end + attr_accessor :last_status + + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + params( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Number of consecutive delivery attempts that did not succeed. + consecutive_failures:, + last_failed_at:, + # Human-readable description of the most recent failure. + last_message:, + # Outcome of the most recent failed delivery. 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. + last_status: + ) + end + + sig do + override.returns( + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + } + ) + end + def to_hash + end + + # Outcome of the most recent failed delivery. 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 LastStatus + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REJECTED = + T.let( + :rejected, + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + FAILED = + T.let( + :failed, + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + SKIPPED_UNSAFE_URL = + T.let( + :skipped_unsafe_url, + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorCreateResponse::WebhookFailure::LastStatus::TaggedSymbol + ] + ) + end + def self.values + end + end + end end end end diff --git a/rbi/context_dev/models/monitor_list_response.rbi b/rbi/context_dev/models/monitor_list_response.rbi index 8880b51f..e76fc628 100644 --- a/rbi/context_dev/models/monitor_list_response.rbi +++ b/rbi/context_dev/models/monitor_list_response.rbi @@ -179,6 +179,28 @@ module ContextDev end attr_writer :webhook + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + returns( + T.nilable( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure + ) + ) + end + attr_reader :webhook_failure + + sig do + params( + webhook_failure: + T.nilable( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::OrHash + ) + ).void + end + attr_writer :webhook_failure + # A web monitor. `mode` is the constant `web`; behavior is described by `target` # (page/sitemap/extract) and `change_detection` (exact/semantic). sig do @@ -222,6 +244,10 @@ module ContextDev webhook: T.nilable( ContextDev::Models::MonitorListResponse::Data::Webhook::OrHash + ), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::OrHash ) ).returns(T.attached_class) end @@ -260,7 +286,11 @@ module ContextDev next_run_at: nil, # User-defined tags for grouping and filtering monitors and their changes. tags: nil, - webhook: nil + webhook: nil, + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + webhook_failure: nil ) end @@ -295,6 +325,10 @@ module ContextDev webhook: T.nilable( ContextDev::Models::MonitorListResponse::Data::Webhook + ), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure ) } ) @@ -1093,6 +1127,118 @@ module ContextDev def to_hash end end + + class WebhookFailure < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure, + ContextDev::Internal::AnyHash + ) + end + + # Number of consecutive delivery attempts that did not succeed. + sig { returns(Integer) } + attr_accessor :consecutive_failures + + sig { returns(Time) } + attr_accessor :last_failed_at + + # Human-readable description of the most recent failure. + sig { returns(String) } + attr_accessor :last_message + + # Outcome of the most recent failed delivery. 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 do + returns( + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + ) + end + attr_accessor :last_status + + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + params( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Number of consecutive delivery attempts that did not succeed. + consecutive_failures:, + last_failed_at:, + # Human-readable description of the most recent failure. + last_message:, + # Outcome of the most recent failed delivery. 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. + last_status: + ) + end + + sig do + override.returns( + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + } + ) + end + def to_hash + end + + # Outcome of the most recent failed delivery. 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 LastStatus + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REJECTED = + T.let( + :rejected, + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + ) + FAILED = + T.let( + :failed, + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + ) + SKIPPED_UNSAFE_URL = + T.let( + :skipped_unsafe_url, + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorListResponse::Data::WebhookFailure::LastStatus::TaggedSymbol + ] + ) + end + def self.values + end + end + end end end end diff --git a/rbi/context_dev/models/monitor_retrieve_response.rbi b/rbi/context_dev/models/monitor_retrieve_response.rbi index 82d6890b..f932bc5b 100644 --- a/rbi/context_dev/models/monitor_retrieve_response.rbi +++ b/rbi/context_dev/models/monitor_retrieve_response.rbi @@ -133,6 +133,26 @@ module ContextDev end attr_writer :webhook + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + returns( + T.nilable(ContextDev::Models::MonitorRetrieveResponse::WebhookFailure) + ) + end + attr_reader :webhook_failure + + sig do + params( + webhook_failure: + T.nilable( + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::OrHash + ) + ).void + end + attr_writer :webhook_failure + # A web monitor. `mode` is the constant `web`; behavior is described by `target` # (page/sitemap/extract) and `change_detection` (exact/semantic). sig do @@ -175,6 +195,10 @@ module ContextDev webhook: T.nilable( ContextDev::Models::MonitorRetrieveResponse::Webhook::OrHash + ), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::OrHash ) ).returns(T.attached_class) end @@ -213,7 +237,11 @@ module ContextDev next_run_at: nil, # User-defined tags for grouping and filtering monitors and their changes. tags: nil, - webhook: nil + webhook: nil, + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + webhook_failure: nil ) end @@ -244,7 +272,11 @@ module ContextDev next_run_at: T.nilable(Time), tags: T::Array[String], webhook: - T.nilable(ContextDev::Models::MonitorRetrieveResponse::Webhook) + T.nilable(ContextDev::Models::MonitorRetrieveResponse::Webhook), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure + ) } ) end @@ -1033,6 +1065,118 @@ module ContextDev def to_hash end end + + class WebhookFailure < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure, + ContextDev::Internal::AnyHash + ) + end + + # Number of consecutive delivery attempts that did not succeed. + sig { returns(Integer) } + attr_accessor :consecutive_failures + + sig { returns(Time) } + attr_accessor :last_failed_at + + # Human-readable description of the most recent failure. + sig { returns(String) } + attr_accessor :last_message + + # Outcome of the most recent failed delivery. 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 do + returns( + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + end + attr_accessor :last_status + + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + params( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Number of consecutive delivery attempts that did not succeed. + consecutive_failures:, + last_failed_at:, + # Human-readable description of the most recent failure. + last_message:, + # Outcome of the most recent failed delivery. 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. + last_status: + ) + end + + sig do + override.returns( + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + } + ) + end + def to_hash + end + + # Outcome of the most recent failed delivery. 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 LastStatus + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REJECTED = + T.let( + :rejected, + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + FAILED = + T.let( + :failed, + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + SKIPPED_UNSAFE_URL = + T.let( + :skipped_unsafe_url, + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::LastStatus::TaggedSymbol + ] + ) + end + def self.values + end + end + end end end end diff --git a/rbi/context_dev/models/monitor_update_response.rbi b/rbi/context_dev/models/monitor_update_response.rbi index 3c221122..a1ab8181 100644 --- a/rbi/context_dev/models/monitor_update_response.rbi +++ b/rbi/context_dev/models/monitor_update_response.rbi @@ -128,6 +128,26 @@ module ContextDev end attr_writer :webhook + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + returns( + T.nilable(ContextDev::Models::MonitorUpdateResponse::WebhookFailure) + ) + end + attr_reader :webhook_failure + + sig do + params( + webhook_failure: + T.nilable( + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::OrHash + ) + ).void + end + attr_writer :webhook_failure + # A web monitor. `mode` is the constant `web`; behavior is described by `target` # (page/sitemap/extract) and `change_detection` (exact/semantic). sig do @@ -169,6 +189,10 @@ module ContextDev webhook: T.nilable( ContextDev::Models::MonitorUpdateResponse::Webhook::OrHash + ), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::OrHash ) ).returns(T.attached_class) end @@ -207,7 +231,11 @@ module ContextDev next_run_at: nil, # User-defined tags for grouping and filtering monitors and their changes. tags: nil, - webhook: nil + webhook: nil, + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + webhook_failure: nil ) end @@ -236,7 +264,11 @@ module ContextDev next_run_at: T.nilable(Time), tags: T::Array[String], webhook: - T.nilable(ContextDev::Models::MonitorUpdateResponse::Webhook) + T.nilable(ContextDev::Models::MonitorUpdateResponse::Webhook), + webhook_failure: + T.nilable( + ContextDev::Models::MonitorUpdateResponse::WebhookFailure + ) } ) end @@ -1025,6 +1057,118 @@ module ContextDev def to_hash end end + + class WebhookFailure < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::MonitorUpdateResponse::WebhookFailure, + ContextDev::Internal::AnyHash + ) + end + + # Number of consecutive delivery attempts that did not succeed. + sig { returns(Integer) } + attr_accessor :consecutive_failures + + sig { returns(Time) } + attr_accessor :last_failed_at + + # Human-readable description of the most recent failure. + sig { returns(String) } + attr_accessor :last_message + + # Outcome of the most recent failed delivery. 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 do + returns( + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + end + attr_accessor :last_status + + # Present while webhook deliveries are failing consecutively; null when deliveries + # are healthy or no webhook is configured. Cleared on the next successful delivery + # and when the webhook URL changes. + sig do + params( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Number of consecutive delivery attempts that did not succeed. + consecutive_failures:, + last_failed_at:, + # Human-readable description of the most recent failure. + last_message:, + # Outcome of the most recent failed delivery. 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. + last_status: + ) + end + + sig do + override.returns( + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + } + ) + end + def to_hash + end + + # Outcome of the most recent failed delivery. 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 LastStatus + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REJECTED = + T.let( + :rejected, + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + FAILED = + T.let( + :failed, + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + SKIPPED_UNSAFE_URL = + T.let( + :skipped_unsafe_url, + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorUpdateResponse::WebhookFailure::LastStatus::TaggedSymbol + ] + ) + end + def self.values + end + end + end end end end diff --git a/sig/context_dev/models/monitor_create_response.rbs b/sig/context_dev/models/monitor_create_response.rbs index 5da4f02d..40b794f3 100644 --- a/sig/context_dev/models/monitor_create_response.rbs +++ b/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 = @@ -428,6 +433,50 @@ module ContextDev def to_hash: -> { url: String, secret: String } 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 end diff --git a/sig/context_dev/models/monitor_list_response.rbs b/sig/context_dev/models/monitor_list_response.rbs index 4a2c304a..978ecc0f 100644 --- a/sig/context_dev/models/monitor_list_response.rbs +++ b/sig/context_dev/models/monitor_list_response.rbs @@ -43,7 +43,8 @@ module ContextDev last_run_at: Time?, next_run_at: Time?, tags: ::Array[String], - webhook: ContextDev::Models::MonitorListResponse::Data::Webhook? + webhook: ContextDev::Models::MonitorListResponse::Data::Webhook?, + webhook_failure: ContextDev::Models::MonitorListResponse::Data::WebhookFailure? } class Data < ContextDev::Internal::Type::BaseModel @@ -81,6 +82,8 @@ module ContextDev attr_accessor webhook: ContextDev::Models::MonitorListResponse::Data::Webhook? + attr_accessor webhook_failure: ContextDev::Models::MonitorListResponse::Data::WebhookFailure? + def initialize: ( id: String, change_detection: ContextDev::Models::MonitorListResponse::Data::change_detection, @@ -97,7 +100,8 @@ module ContextDev ?last_run_at: Time?, ?next_run_at: Time?, ?tags: ::Array[String], - ?webhook: ContextDev::Models::MonitorListResponse::Data::Webhook? + ?webhook: ContextDev::Models::MonitorListResponse::Data::Webhook?, + ?webhook_failure: ContextDev::Models::MonitorListResponse::Data::WebhookFailure? ) -> void def to_hash: -> { @@ -116,7 +120,8 @@ module ContextDev last_run_at: Time?, next_run_at: Time?, tags: ::Array[String], - webhook: ContextDev::Models::MonitorListResponse::Data::Webhook? + webhook: ContextDev::Models::MonitorListResponse::Data::Webhook?, + webhook_failure: ContextDev::Models::MonitorListResponse::Data::WebhookFailure? } type change_detection = @@ -454,6 +459,50 @@ module ContextDev def to_hash: -> { url: String, secret: String } end + + type webhook_failure = + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorListResponse::Data::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::MonitorListResponse::Data::WebhookFailure::last_status + + def initialize: ( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorListResponse::Data::WebhookFailure::last_status + ) -> void + + def to_hash: -> { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorListResponse::Data::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::MonitorListResponse::Data::WebhookFailure::last_status] + end + end end end end diff --git a/sig/context_dev/models/monitor_retrieve_response.rbs b/sig/context_dev/models/monitor_retrieve_response.rbs index a125a997..103a0c4b 100644 --- a/sig/context_dev/models/monitor_retrieve_response.rbs +++ b/sig/context_dev/models/monitor_retrieve_response.rbs @@ -17,7 +17,8 @@ module ContextDev last_run_at: Time?, next_run_at: Time?, tags: ::Array[String], - webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook? + webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook?, + webhook_failure: ContextDev::Models::MonitorRetrieveResponse::WebhookFailure? } class MonitorRetrieveResponse < ContextDev::Internal::Type::BaseModel @@ -55,6 +56,8 @@ module ContextDev attr_accessor webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook? + attr_accessor webhook_failure: ContextDev::Models::MonitorRetrieveResponse::WebhookFailure? + def initialize: ( id: String, change_detection: ContextDev::Models::MonitorRetrieveResponse::change_detection, @@ -71,7 +74,8 @@ module ContextDev ?last_run_at: Time?, ?next_run_at: Time?, ?tags: ::Array[String], - ?webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook? + ?webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook?, + ?webhook_failure: ContextDev::Models::MonitorRetrieveResponse::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::MonitorRetrieveResponse::Webhook? + webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook?, + webhook_failure: ContextDev::Models::MonitorRetrieveResponse::WebhookFailure? } type change_detection = @@ -428,6 +433,50 @@ module ContextDev def to_hash: -> { url: String, secret: String } end + + type webhook_failure = + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorRetrieveResponse::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::MonitorRetrieveResponse::WebhookFailure::last_status + + def initialize: ( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorRetrieveResponse::WebhookFailure::last_status + ) -> void + + def to_hash: -> { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorRetrieveResponse::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::MonitorRetrieveResponse::WebhookFailure::last_status] + end + end end end end diff --git a/sig/context_dev/models/monitor_update_response.rbs b/sig/context_dev/models/monitor_update_response.rbs index e473c21d..3b67a2b8 100644 --- a/sig/context_dev/models/monitor_update_response.rbs +++ b/sig/context_dev/models/monitor_update_response.rbs @@ -17,7 +17,8 @@ module ContextDev last_run_at: Time?, next_run_at: Time?, tags: ::Array[String], - webhook: ContextDev::Models::MonitorUpdateResponse::Webhook? + webhook: ContextDev::Models::MonitorUpdateResponse::Webhook?, + webhook_failure: ContextDev::Models::MonitorUpdateResponse::WebhookFailure? } class MonitorUpdateResponse < ContextDev::Internal::Type::BaseModel @@ -55,6 +56,8 @@ module ContextDev attr_accessor webhook: ContextDev::Models::MonitorUpdateResponse::Webhook? + attr_accessor webhook_failure: ContextDev::Models::MonitorUpdateResponse::WebhookFailure? + def initialize: ( id: String, change_detection: ContextDev::Models::MonitorUpdateResponse::change_detection, @@ -71,7 +74,8 @@ module ContextDev ?last_run_at: Time?, ?next_run_at: Time?, ?tags: ::Array[String], - ?webhook: ContextDev::Models::MonitorUpdateResponse::Webhook? + ?webhook: ContextDev::Models::MonitorUpdateResponse::Webhook?, + ?webhook_failure: ContextDev::Models::MonitorUpdateResponse::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::MonitorUpdateResponse::Webhook? + webhook: ContextDev::Models::MonitorUpdateResponse::Webhook?, + webhook_failure: ContextDev::Models::MonitorUpdateResponse::WebhookFailure? } type change_detection = @@ -428,6 +433,50 @@ module ContextDev def to_hash: -> { url: String, secret: String } end + + type webhook_failure = + { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorUpdateResponse::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::MonitorUpdateResponse::WebhookFailure::last_status + + def initialize: ( + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorUpdateResponse::WebhookFailure::last_status + ) -> void + + def to_hash: -> { + consecutive_failures: Integer, + last_failed_at: Time, + last_message: String, + last_status: ContextDev::Models::MonitorUpdateResponse::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::MonitorUpdateResponse::WebhookFailure::last_status] + end + end end end end diff --git a/test/context_dev/resources/monitors_test.rb b/test/context_dev/resources/monitors_test.rb index e6aa0715..453607b9 100644 --- a/test/context_dev/resources/monitors_test.rb +++ b/test/context_dev/resources/monitors_test.rb @@ -35,7 +35,8 @@ def test_create_required_params last_run_at: Time | nil, next_run_at: Time | nil, tags: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil, - webhook: ContextDev::Models::MonitorCreateResponse::Webhook | nil + webhook: ContextDev::Models::MonitorCreateResponse::Webhook | nil, + webhook_failure: ContextDev::Models::MonitorCreateResponse::WebhookFailure | nil } end end @@ -66,7 +67,8 @@ def test_retrieve last_run_at: Time | nil, next_run_at: Time | nil, tags: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil, - webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook | nil + webhook: ContextDev::Models::MonitorRetrieveResponse::Webhook | nil, + webhook_failure: ContextDev::Models::MonitorRetrieveResponse::WebhookFailure | nil } end end @@ -97,7 +99,8 @@ def test_update last_run_at: Time | nil, next_run_at: Time | nil, tags: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil, - webhook: ContextDev::Models::MonitorUpdateResponse::Webhook | nil + webhook: ContextDev::Models::MonitorUpdateResponse::Webhook | nil, + webhook_failure: ContextDev::Models::MonitorUpdateResponse::WebhookFailure | nil } end end From d4c601ea30aa1d47ef041d0439ab8b5d976cc8e2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 11 Jul 2026 22:00:45 +0000 Subject: [PATCH 04/11] feat(api): api update --- .stats.yml | 4 ++-- .../models/web_web_scrape_md_response.rb | 12 +++++++++++- lib/context_dev/resources/web.rb | 17 ++++++++++++++++- .../models/web_web_scrape_md_response.rbi | 12 ++++++++++++ rbi/context_dev/resources/web.rbi | 17 ++++++++++++++++- .../models/web_web_scrape_md_response.rbs | 5 +++++ test/context_dev/resources/web_test.rb | 1 + 7 files changed, 63 insertions(+), 5 deletions(-) diff --git a/.stats.yml b/.stats.yml index c1de7fe8..a5e78070 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d60fed3d26479d1ee76b77df8415390504542522e7188792a23bf77b9f37ed63.yml -openapi_spec_hash: 263672c59d9b01c50f7d2307fbd82ec0 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-adab8df19dce27396e4a0e698287f083e1f932e63b85fd8dd4d54f80f0e0b5a8.yml +openapi_spec_hash: 717fea46f446ff97bad627f200963fd7 config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev/models/web_web_scrape_md_response.rb b/lib/context_dev/models/web_web_scrape_md_response.rb index 1bd6d03a..afb0f5e2 100644 --- a/lib/context_dev/models/web_web_scrape_md_response.rb +++ b/lib/context_dev/models/web_web_scrape_md_response.rb @@ -4,6 +4,14 @@ module ContextDev module Models # @see ContextDev::Resources::Web#web_scrape_md class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + # @!attribute content_length + # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result + # and compare small values against your workload's minimum useful-content + # threshold. + # + # @return [Integer] + required :content_length, Integer, api_name: :contentLength + # @!attribute markdown # Page content converted to GitHub Flavored Markdown # @@ -35,10 +43,12 @@ class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil] optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } - # @!method initialize(markdown:, metadata:, success:, url:, key_metadata: nil) + # @!method initialize(content_length:, markdown:, metadata:, success:, url:, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeMdResponse} for more details. # + # @param content_length [Integer] UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result an + # # @param markdown [String] Page content converted to GitHub Flavored Markdown # # @param metadata [ContextDev::Models::WebWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML. diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 2c1f4590..c2e1b37a 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -426,7 +426,22 @@ def web_scrape_images(params) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeMdParams} for more details. # - # 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 | # # @overload web_scrape_md(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # diff --git a/rbi/context_dev/models/web_web_scrape_md_response.rbi b/rbi/context_dev/models/web_web_scrape_md_response.rbi index 657b53d8..06a64b8d 100644 --- a/rbi/context_dev/models/web_web_scrape_md_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_response.rbi @@ -11,6 +11,12 @@ module ContextDev ) end + # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result + # and compare small values against your workload's minimum useful-content + # threshold. + sig { returns(Integer) } + attr_accessor :content_length + # Page content converted to GitHub Flavored Markdown sig { returns(String) } attr_accessor :markdown @@ -57,6 +63,7 @@ module ContextDev sig do params( + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata::OrHash, @@ -68,6 +75,10 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result + # and compare small values against your workload's minimum useful-content + # threshold. + content_length:, # Page content converted to GitHub Flavored Markdown markdown:, # Metadata extracted from the scraped page HTML. @@ -85,6 +96,7 @@ module ContextDev sig do override.returns( { + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, success: diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index 1c5366c6..8c007bc4 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -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, diff --git a/sig/context_dev/models/web_web_scrape_md_response.rbs b/sig/context_dev/models/web_web_scrape_md_response.rbs index f4ecf257..ba93554b 100644 --- a/sig/context_dev/models/web_web_scrape_md_response.rbs +++ b/sig/context_dev/models/web_web_scrape_md_response.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_web_scrape_md_response = { + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, success: ContextDev::Models::WebWebScrapeMdResponse::success, @@ -10,6 +11,8 @@ module ContextDev } class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + attr_accessor content_length: Integer + attr_accessor markdown: String attr_accessor metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata @@ -25,6 +28,7 @@ module ContextDev ) -> ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata def initialize: ( + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, success: ContextDev::Models::WebWebScrapeMdResponse::success, @@ -33,6 +37,7 @@ module ContextDev ) -> void def to_hash: -> { + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, success: ContextDev::Models::WebWebScrapeMdResponse::success, diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb index 422e7650..8b35a29a 100644 --- a/test/context_dev/resources/web_test.rb +++ b/test/context_dev/resources/web_test.rb @@ -199,6 +199,7 @@ def test_web_scrape_md_required_params assert_pattern do response => { + content_length: Integer, markdown: String, metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata, success: ContextDev::Models::WebWebScrapeMdResponse::Success, From d68d31dc5aa77ad154789b6cf91e0b8558353214 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 11 Jul 2026 22:21:42 +0000 Subject: [PATCH 05/11] feat(api): api update --- .stats.yml | 4 +- lib/context_dev/client.rb | 5 +- .../models/monitor_create_params.rb | 31 +++++- .../models/monitor_create_response.rb | 28 ++++- .../monitor_list_account_runs_response.rb | 54 +++++++-- .../models/monitor_list_response.rb | 28 ++++- .../models/monitor_list_runs_response.rb | 53 +++++++-- .../models/monitor_retrieve_response.rb | 28 ++++- .../models/monitor_update_params.rb | 31 +++++- .../models/monitor_update_response.rb | 28 ++++- lib/context_dev/resources/monitors.rb | 5 +- rbi/context_dev/client.rbi | 5 +- .../models/monitor_create_params.rbi | 90 ++++++++++++++- .../models/monitor_create_response.rbi | 92 +++++++++++++++- .../monitor_list_account_runs_response.rbi | 103 ++++++++++++++++-- .../models/monitor_list_response.rbi | 92 +++++++++++++++- .../models/monitor_list_runs_response.rbi | 103 ++++++++++++++++-- .../models/monitor_retrieve_response.rbi | 92 +++++++++++++++- .../models/monitor_update_params.rbi | 90 ++++++++++++++- .../models/monitor_update_response.rbi | 92 +++++++++++++++- rbi/context_dev/resources/monitors.rbi | 5 +- .../models/monitor_create_params.rbs | 35 +++++- .../models/monitor_create_response.rbs | 36 +++++- .../monitor_list_account_runs_response.rbs | 25 +++++ .../models/monitor_list_response.rbs | 36 +++++- .../models/monitor_list_runs_response.rbs | 25 +++++ .../models/monitor_retrieve_response.rbs | 36 +++++- .../models/monitor_update_params.rbs | 35 +++++- .../models/monitor_update_response.rbs | 36 +++++- 29 files changed, 1211 insertions(+), 112 deletions(-) diff --git a/.stats.yml b/.stats.yml index a5e78070..951a04e0 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-adab8df19dce27396e4a0e698287f083e1f932e63b85fd8dd4d54f80f0e0b5a8.yml -openapi_spec_hash: 717fea46f446ff97bad627f200963fd7 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-ecf38e27f0c2544a8965f6cee827927343a926e1ab511aa7b34e8aa7d1866c8e.yml +openapi_spec_hash: c5767791a19b95c52ef073902fa5da77 config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev/client.rb b/lib/context_dev/client.rb index ceedd945..61eeb8f4 100644 --- a/lib/context_dev/client.rb +++ b/lib/context_dev/client.rb @@ -34,8 +34,9 @@ class Client < ContextDev::Internal::Transport::BaseClient attr_reader :utility # 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. # @return [ContextDev::Resources::Monitors] attr_reader :monitors diff --git a/lib/context_dev/models/monitor_create_params.rb b/lib/context_dev/models/monitor_create_params.rb index eb22d2d1..e3452982 100644 --- a/lib/context_dev/models/monitor_create_params.rb +++ b/lib/context_dev/models/monitor_create_params.rb @@ -356,13 +356,38 @@ module Mode class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String - # @!method initialize(url:) - # @param url [String] Webhook URL called when a change is detected. + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorCreateParams::Webhook::Event] } + + # @!method initialize(url:, events: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorCreateParams::Webhook} for more details. + # + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/context_dev/models/monitor_create_response.rb b/lib/context_dev/models/monitor_create_response.rb index b8351949..2187983a 100644 --- a/lib/context_dev/models/monitor_create_response.rb +++ b/lib/context_dev/models/monitor_create_response.rb @@ -593,11 +593,21 @@ class LastError < ContextDev::Internal::Type::BaseModel # @see ContextDev::Models::MonitorCreateResponse#webhook class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorCreateResponse::Webhook::Event] } + response_only do # @!attribute secret # Signing secret used to verify webhook authenticity. Each delivery includes an @@ -610,13 +620,25 @@ class Webhook < ContextDev::Internal::Type::BaseModel optional :secret, String end - # @!method initialize(url:, secret: nil) + # @!method initialize(url:, events: nil, secret: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorCreateResponse::Webhook} for more details. # - # @param url [String] Webhook URL called when a change is detected. + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end # @see ContextDev::Models::MonitorCreateResponse#webhook_failure diff --git a/lib/context_dev/models/monitor_list_account_runs_response.rb b/lib/context_dev/models/monitor_list_account_runs_response.rb index 737260f3..455cfdc1 100644 --- a/lib/context_dev/models/monitor_list_account_runs_response.rb +++ b/lib/context_dev/models/monitor_list_account_runs_response.rb @@ -106,16 +106,27 @@ class Data < ContextDev::Internal::Type::BaseModel # @return [Time, nil] optional :started_at, Time, nil?: true + # @!attribute webhook_deliveries + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + # + # @return [Array, nil] + optional :webhook_deliveries, + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] } + # @!attribute webhook_delivery - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # @deprecated + # + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. # # @return [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery, nil] optional :webhook_delivery, -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery } - # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_delivery: nil) + # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListAccountRunsResponse::Data} for more details. # @@ -147,7 +158,9 @@ class Data < ContextDev::Internal::Type::BaseModel # # @param started_at [Time, nil] # - # @param webhook_delivery [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] The webhook delivery attempted for a change detected by this run. Omitted when n + # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir + # + # @param webhook_delivery [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#change_detection_type module ChangeDetectionType @@ -233,7 +246,6 @@ module SkipReason # @return [Array] end - # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#webhook_delivery class WebhookDelivery < ContextDev::Internal::Type::BaseModel # @!attribute attempted_at # @@ -247,6 +259,14 @@ class WebhookDelivery < ContextDev::Internal::Type::BaseModel -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error }, nil?: true + # @!attribute event + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @return [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event] + required :event, + enum: -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event } + # @!attribute event_id # Identifier sent in the X-Context-Id header. # @@ -269,19 +289,17 @@ class WebhookDelivery < ContextDev::Internal::Type::BaseModel required :status, enum: -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status } - # @!method initialize(attempted_at:, error:, event_id:, http_status:, status:) + # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery} for # more details. # - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. - # # @param attempted_at [Time] # # @param error [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error, nil] # + # @param event [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event] The event this delivery carried. Deliveries recorded before event selection exis + # # @param event_id [String] Identifier sent in the X-Context-Id header. # # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received @@ -305,6 +323,20 @@ class Error < ContextDev::Internal::Type::BaseModel # @param message [String] end + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @see ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery#event + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + 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. diff --git a/lib/context_dev/models/monitor_list_response.rb b/lib/context_dev/models/monitor_list_response.rb index 19ffa99c..988b5853 100644 --- a/lib/context_dev/models/monitor_list_response.rb +++ b/lib/context_dev/models/monitor_list_response.rb @@ -617,11 +617,21 @@ class LastError < ContextDev::Internal::Type::BaseModel # @see ContextDev::Models::MonitorListResponse::Data#webhook class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorListResponse::Data::Webhook::Event] } + response_only do # @!attribute secret # Signing secret used to verify webhook authenticity. Each delivery includes an @@ -634,13 +644,25 @@ class Webhook < ContextDev::Internal::Type::BaseModel optional :secret, String end - # @!method initialize(url:, secret: nil) + # @!method initialize(url:, events: nil, secret: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListResponse::Data::Webhook} for more details. # - # @param url [String] Webhook URL called when a change is detected. + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end # @see ContextDev::Models::MonitorListResponse::Data#webhook_failure diff --git a/lib/context_dev/models/monitor_list_runs_response.rb b/lib/context_dev/models/monitor_list_runs_response.rb index ec4abc25..9a86e14a 100644 --- a/lib/context_dev/models/monitor_list_runs_response.rb +++ b/lib/context_dev/models/monitor_list_runs_response.rb @@ -106,15 +106,26 @@ class Data < ContextDev::Internal::Type::BaseModel # @return [Time, nil] optional :started_at, Time, nil?: true + # @!attribute webhook_deliveries + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + # + # @return [Array, nil] + optional :webhook_deliveries, + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] } + # @!attribute webhook_delivery - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # @deprecated + # + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. # # @return [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery, nil] optional :webhook_delivery, -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery } - # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_delivery: nil) + # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListRunsResponse::Data} for more details. # @@ -146,7 +157,9 @@ class Data < ContextDev::Internal::Type::BaseModel # # @param started_at [Time, nil] # - # @param webhook_delivery [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] The webhook delivery attempted for a change detected by this run. Omitted when n + # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir + # + # @param webhook_delivery [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type module ChangeDetectionType @@ -232,7 +245,6 @@ module SkipReason # @return [Array] end - # @see ContextDev::Models::MonitorListRunsResponse::Data#webhook_delivery class WebhookDelivery < ContextDev::Internal::Type::BaseModel # @!attribute attempted_at # @@ -246,6 +258,13 @@ class WebhookDelivery < ContextDev::Internal::Type::BaseModel -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error }, nil?: true + # @!attribute event + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event] + required :event, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event } + # @!attribute event_id # Identifier sent in the X-Context-Id header. # @@ -267,19 +286,17 @@ class WebhookDelivery < ContextDev::Internal::Type::BaseModel # @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status] required :status, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status } - # @!method initialize(attempted_at:, error:, event_id:, http_status:, status:) + # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery} for more # details. # - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. - # # @param attempted_at [Time] # # @param error [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, nil] # + # @param event [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event] The event this delivery carried. Deliveries recorded before event selection exis + # # @param event_id [String] Identifier sent in the X-Context-Id header. # # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received @@ -303,6 +320,20 @@ class Error < ContextDev::Internal::Type::BaseModel # @param message [String] end + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#event + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + 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. diff --git a/lib/context_dev/models/monitor_retrieve_response.rb b/lib/context_dev/models/monitor_retrieve_response.rb index 0b256178..3ce485af 100644 --- a/lib/context_dev/models/monitor_retrieve_response.rb +++ b/lib/context_dev/models/monitor_retrieve_response.rb @@ -593,11 +593,21 @@ class LastError < ContextDev::Internal::Type::BaseModel # @see ContextDev::Models::MonitorRetrieveResponse#webhook class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorRetrieveResponse::Webhook::Event] } + response_only do # @!attribute secret # Signing secret used to verify webhook authenticity. Each delivery includes an @@ -610,13 +620,25 @@ class Webhook < ContextDev::Internal::Type::BaseModel optional :secret, String end - # @!method initialize(url:, secret: nil) + # @!method initialize(url:, events: nil, secret: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorRetrieveResponse::Webhook} for more details. # - # @param url [String] Webhook URL called when a change is detected. + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end # @see ContextDev::Models::MonitorRetrieveResponse#webhook_failure diff --git a/lib/context_dev/models/monitor_update_params.rb b/lib/context_dev/models/monitor_update_params.rb index 3836e321..35c1f9e1 100644 --- a/lib/context_dev/models/monitor_update_params.rb +++ b/lib/context_dev/models/monitor_update_params.rb @@ -361,15 +361,40 @@ class Extract < ContextDev::Internal::Type::BaseModel class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String - # @!method initialize(url:) + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorUpdateParams::Webhook::Event] } + + # @!method initialize(url:, events: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::MonitorUpdateParams::Webhook} for more details. + # # Set to null to remove the webhook. # - # @param url [String] Webhook URL called when a change is detected. + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/context_dev/models/monitor_update_response.rb b/lib/context_dev/models/monitor_update_response.rb index 7b56bdf4..027fe36b 100644 --- a/lib/context_dev/models/monitor_update_response.rb +++ b/lib/context_dev/models/monitor_update_response.rb @@ -593,11 +593,21 @@ class LastError < ContextDev::Internal::Type::BaseModel # @see ContextDev::Models::MonitorUpdateResponse#webhook class Webhook < ContextDev::Internal::Type::BaseModel # @!attribute url - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. # # @return [String] required :url, String + # @!attribute events + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + # + # @return [Array, nil] + optional :events, + -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorUpdateResponse::Webhook::Event] } + response_only do # @!attribute secret # Signing secret used to verify webhook authenticity. Each delivery includes an @@ -610,13 +620,25 @@ class Webhook < ContextDev::Internal::Type::BaseModel optional :secret, String end - # @!method initialize(url:, secret: nil) + # @!method initialize(url:, events: nil, secret: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorUpdateResponse::Webhook} for more details. # - # @param url [String] Webhook URL called when a change is detected. + # @param url [String] Webhook URL events are delivered to. + # + # @param events [Array] Events delivered to this endpoint. `change.detected` fires only when a run detec # # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X + + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + end end # @see ContextDev::Models::MonitorUpdateResponse#webhook_failure diff --git a/lib/context_dev/resources/monitors.rb b/lib/context_dev/resources/monitors.rb index baaab6e9..f5263907 100644 --- a/lib/context_dev/resources/monitors.rb +++ b/lib/context_dev/resources/monitors.rb @@ -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 # Some parameter documentations has been truncated, see # {ContextDev::Models::MonitorCreateParams} for more details. diff --git a/rbi/context_dev/client.rbi b/rbi/context_dev/client.rbi index ee3a64d1..663ea2ed 100644 --- a/rbi/context_dev/client.rbi +++ b/rbi/context_dev/client.rbi @@ -29,8 +29,9 @@ module ContextDev attr_reader :utility # 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. sig { returns(ContextDev::Resources::Monitors) } attr_reader :monitors diff --git a/rbi/context_dev/models/monitor_create_params.rbi b/rbi/context_dev/models/monitor_create_params.rbi index 7e09eefe..ec99f358 100644 --- a/rbi/context_dev/models/monitor_create_params.rbi +++ b/rbi/context_dev/models/monitor_create_params.rbi @@ -631,20 +631,100 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url - sig { params(url: String).returns(T.attached_class) } + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + + sig do + params( + url: String, + events: + T::Array[ + ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol + ] + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. - url: + # Webhook URL events are delivered to. + url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::MonitorCreateParams::Webhook::Event) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::MonitorCreateParams::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::MonitorCreateParams::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::MonitorCreateParams::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/rbi/context_dev/models/monitor_create_response.rbi b/rbi/context_dev/models/monitor_create_response.rbi index 8d35a685..29a3ae33 100644 --- a/rbi/context_dev/models/monitor_create_response.rbi +++ b/rbi/context_dev/models/monitor_create_response.rbi @@ -1025,10 +1025,35 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::Models::MonitorCreateResponse::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1040,10 +1065,24 @@ module ContextDev sig { params(secret: String).void } attr_writer :secret - sig { params(url: String, secret: String).returns(T.attached_class) } + sig do + params( + url: String, + events: + T::Array[ + ContextDev::Models::MonitorCreateResponse::Webhook::Event::OrSymbol + ], + secret: String + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil, # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1053,9 +1092,54 @@ module ContextDev ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorCreateResponse::Webhook::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end class WebhookFailure < ContextDev::Internal::Type::BaseModel diff --git a/rbi/context_dev/models/monitor_list_account_runs_response.rbi b/rbi/context_dev/models/monitor_list_account_runs_response.rbi index 60ff1165..3ce6f16d 100644 --- a/rbi/context_dev/models/monitor_list_account_runs_response.rbi +++ b/rbi/context_dev/models/monitor_list_account_runs_response.rbi @@ -148,9 +148,33 @@ module ContextDev sig { returns(T.nilable(Time)) } attr_accessor :started_at - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + ] + ) + ) + end + attr_reader :webhook_deliveries + + sig do + params( + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash + ] + ).void + end + attr_writer :webhook_deliveries + + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. sig do returns( T.nilable( @@ -194,6 +218,10 @@ module ContextDev ContextDev::Models::MonitorListAccountRunsResponse::Data::SkipReason::OrSymbol ), started_at: T.nilable(Time), + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash + ], webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash ).returns(T.attached_class) @@ -220,9 +248,13 @@ module ContextDev # Why a skipped run never executed; null unless status is `skipped`. skip_reason: nil, started_at: nil, - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + webhook_deliveries: nil, + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. webhook_delivery: nil ) end @@ -254,6 +286,10 @@ module ContextDev ContextDev::Models::MonitorListAccountRunsResponse::Data::SkipReason::TaggedSymbol ), started_at: T.nilable(Time), + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + ], webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery } @@ -518,6 +554,15 @@ module ContextDev end attr_writer :error + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + sig do + returns( + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + end + attr_accessor :event + # Identifier sent in the X-Context-Id header. sig { returns(String) } attr_accessor :event_id @@ -537,9 +582,6 @@ module ContextDev end attr_accessor :status - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. sig do params( attempted_at: Time, @@ -547,6 +589,8 @@ module ContextDev T.nilable( ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error::OrHash ), + event: + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::OrSymbol, event_id: String, http_status: T.nilable(Integer), status: @@ -556,6 +600,9 @@ module ContextDev 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 @@ -576,6 +623,8 @@ module ContextDev T.nilable( ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error ), + event: + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol, event_id: String, http_status: T.nilable(Integer), status: @@ -612,6 +661,42 @@ module ContextDev 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 do + T.all( + Symbol, + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorListAccountRunsResponse::Data::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. diff --git a/rbi/context_dev/models/monitor_list_response.rbi b/rbi/context_dev/models/monitor_list_response.rbi index e76fc628..6ac31ca8 100644 --- a/rbi/context_dev/models/monitor_list_response.rbi +++ b/rbi/context_dev/models/monitor_list_response.rbi @@ -1095,10 +1095,35 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1110,10 +1135,24 @@ module ContextDev sig { params(secret: String).void } attr_writer :secret - sig { params(url: String, secret: String).returns(T.attached_class) } + sig do + params( + url: String, + events: + T::Array[ + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::OrSymbol + ], + secret: String + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil, # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1123,9 +1162,54 @@ module ContextDev ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorListResponse::Data::Webhook::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end class WebhookFailure < ContextDev::Internal::Type::BaseModel diff --git a/rbi/context_dev/models/monitor_list_runs_response.rbi b/rbi/context_dev/models/monitor_list_runs_response.rbi index 43e5097f..0c43c1a6 100644 --- a/rbi/context_dev/models/monitor_list_runs_response.rbi +++ b/rbi/context_dev/models/monitor_list_runs_response.rbi @@ -139,9 +139,33 @@ module ContextDev sig { returns(T.nilable(Time)) } attr_accessor :started_at - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + ] + ) + ) + end + attr_reader :webhook_deliveries + + sig do + params( + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash + ] + ).void + end + attr_writer :webhook_deliveries + + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. sig do returns( T.nilable( @@ -185,6 +209,10 @@ module ContextDev ContextDev::Models::MonitorListRunsResponse::Data::SkipReason::OrSymbol ), started_at: T.nilable(Time), + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash + ], webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash ).returns(T.attached_class) @@ -211,9 +239,13 @@ module ContextDev # Why a skipped run never executed; null unless status is `skipped`. skip_reason: nil, started_at: nil, - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. + # All webhook deliveries attempted by this run — one per subscribed event that + # fired. Omitted when no webhook was attempted, including runs created before + # event selection was added. + webhook_deliveries: nil, + # Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # can deliver multiple events. Omitted when no webhook was attempted, including + # historical runs created before delivery tracking was added. webhook_delivery: nil ) end @@ -245,6 +277,10 @@ module ContextDev ContextDev::Models::MonitorListRunsResponse::Data::SkipReason::TaggedSymbol ), started_at: T.nilable(Time), + webhook_deliveries: + T::Array[ + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + ], webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery } @@ -509,6 +545,15 @@ module ContextDev end attr_writer :error + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + sig do + returns( + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + end + attr_accessor :event + # Identifier sent in the X-Context-Id header. sig { returns(String) } attr_accessor :event_id @@ -528,9 +573,6 @@ module ContextDev end attr_accessor :status - # The webhook delivery attempted for a change detected by this run. Omitted when - # no webhook was attempted, including historical runs created before delivery - # tracking was added. sig do params( attempted_at: Time, @@ -538,6 +580,8 @@ module ContextDev T.nilable( ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error::OrHash ), + event: + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::OrSymbol, event_id: String, http_status: T.nilable(Integer), status: @@ -547,6 +591,9 @@ module ContextDev 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 @@ -567,6 +614,8 @@ module ContextDev T.nilable( ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error ), + event: + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol, event_id: String, http_status: T.nilable(Integer), status: @@ -603,6 +652,42 @@ module ContextDev 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 do + T.all( + Symbol, + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorListRunsResponse::Data::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. diff --git a/rbi/context_dev/models/monitor_retrieve_response.rbi b/rbi/context_dev/models/monitor_retrieve_response.rbi index f932bc5b..4756f83a 100644 --- a/rbi/context_dev/models/monitor_retrieve_response.rbi +++ b/rbi/context_dev/models/monitor_retrieve_response.rbi @@ -1033,10 +1033,35 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1048,10 +1073,24 @@ module ContextDev sig { params(secret: String).void } attr_writer :secret - sig { params(url: String, secret: String).returns(T.attached_class) } + sig do + params( + url: String, + events: + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::OrSymbol + ], + secret: String + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil, # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1061,9 +1100,54 @@ module ContextDev ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end class WebhookFailure < ContextDev::Internal::Type::BaseModel diff --git a/rbi/context_dev/models/monitor_update_params.rbi b/rbi/context_dev/models/monitor_update_params.rbi index 2a7a7ac0..50248015 100644 --- a/rbi/context_dev/models/monitor_update_params.rbi +++ b/rbi/context_dev/models/monitor_update_params.rbi @@ -670,21 +670,101 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + # Set to null to remove the webhook. - sig { params(url: String).returns(T.attached_class) } + sig do + params( + url: String, + events: + T::Array[ + ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol + ] + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. - url: + # Webhook URL events are delivered to. + url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::MonitorUpdateParams::Webhook::Event) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::MonitorUpdateParams::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::MonitorUpdateParams::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::MonitorUpdateParams::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/rbi/context_dev/models/monitor_update_response.rbi b/rbi/context_dev/models/monitor_update_response.rbi index a1ab8181..773c94bd 100644 --- a/rbi/context_dev/models/monitor_update_response.rbi +++ b/rbi/context_dev/models/monitor_update_response.rbi @@ -1025,10 +1025,35 @@ module ContextDev ) end - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. sig { returns(String) } attr_accessor :url + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + sig do + returns( + T.nilable( + T::Array[ + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol + ] + ) + ) + end + attr_reader :events + + sig do + params( + events: + T::Array[ + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::OrSymbol + ] + ).void + end + attr_writer :events + # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1040,10 +1065,24 @@ module ContextDev sig { params(secret: String).void } attr_writer :secret - sig { params(url: String, secret: String).returns(T.attached_class) } + sig do + params( + url: String, + events: + T::Array[ + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::OrSymbol + ], + secret: String + ).returns(T.attached_class) + end def self.new( - # Webhook URL called when a change is detected. + # Webhook URL events are delivered to. url:, + # Events delivered to this endpoint. `change.detected` fires only when a run + # detects a change; `run.completed` fires on every completed run — including runs + # that detected no change — and embeds the change when one was detected. Defaults + # to `["change.detected"]` when omitted. + events: nil, # Signing secret used to verify webhook authenticity. Each delivery includes an # `X-Context-Signature: t=,v1=` header, where the HMAC is SHA-256 over # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time @@ -1053,9 +1092,54 @@ module ContextDev ) end - sig { override.returns({ url: String, secret: String }) } + sig do + override.returns( + { + url: String, + events: + T::Array[ + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol + ], + secret: String + } + ) + end def to_hash end + + module Event + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::MonitorUpdateResponse::Webhook::Event + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHANGE_DETECTED = + T.let( + :"change.detected", + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol + ) + RUN_COMPLETED = + T.let( + :"run.completed", + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol + ] + ) + end + def self.values + end + end end class WebhookFailure < ContextDev::Internal::Type::BaseModel diff --git a/rbi/context_dev/resources/monitors.rbi b/rbi/context_dev/resources/monitors.rbi index 92b6b8bd..f5aa5393 100644 --- a/rbi/context_dev/resources/monitors.rbi +++ b/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 diff --git a/sig/context_dev/models/monitor_create_params.rbs b/sig/context_dev/models/monitor_create_params.rbs index b6e48e4e..c49a4169 100644 --- a/sig/context_dev/models/monitor_create_params.rbs +++ b/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 diff --git a/sig/context_dev/models/monitor_create_response.rbs b/sig/context_dev/models/monitor_create_response.rbs index 40b794f3..799e2e71 100644 --- a/sig/context_dev/models/monitor_create_response.rbs +++ b/sig/context_dev/models/monitor_create_response.rbs @@ -420,18 +420,48 @@ 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 + } - 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::MonitorCreateResponse::Webhook::event] + end end type webhook_failure = diff --git a/sig/context_dev/models/monitor_list_account_runs_response.rbs b/sig/context_dev/models/monitor_list_account_runs_response.rbs index fda81130..8952e25b 100644 --- a/sig/context_dev/models/monitor_list_account_runs_response.rbs +++ b/sig/context_dev/models/monitor_list_account_runs_response.rbs @@ -42,6 +42,7 @@ module ContextDev error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, started_at: Time?, + webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery } @@ -74,6 +75,12 @@ module ContextDev attr_accessor started_at: Time? + attr_reader webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery]? + + def webhook_deliveries=: ( + ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] + ) -> ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] + attr_reader webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery? def webhook_delivery=: ( @@ -95,6 +102,7 @@ module ContextDev ?error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, ?skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, ?started_at: Time?, + ?webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], ?webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery ) -> void @@ -113,6 +121,7 @@ module ContextDev error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, started_at: Time?, + webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery } @@ -192,6 +201,7 @@ module ContextDev { attempted_at: Time, error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status @@ -202,6 +212,8 @@ module ContextDev attr_accessor error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error? + attr_accessor event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event + attr_accessor event_id: String attr_accessor http_status: Integer? @@ -211,6 +223,7 @@ module ContextDev def initialize: ( attempted_at: Time, error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status @@ -219,6 +232,7 @@ module ContextDev def to_hash: -> { attempted_at: Time, error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status @@ -236,6 +250,17 @@ module ContextDev def to_hash: -> { code: String, message: String } end + 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::MonitorListAccountRunsResponse::Data::WebhookDelivery::event] + end + type status = :delivered | :rejected | :failed | :skipped_unsafe_url module Status diff --git a/sig/context_dev/models/monitor_list_response.rbs b/sig/context_dev/models/monitor_list_response.rbs index 978ecc0f..4867b274 100644 --- a/sig/context_dev/models/monitor_list_response.rbs +++ b/sig/context_dev/models/monitor_list_response.rbs @@ -446,18 +446,48 @@ module ContextDev def to_hash: -> { code: String, message: String } end - type webhook = { url: String, secret: String } + type webhook = + { + url: String, + events: ::Array[ContextDev::Models::MonitorListResponse::Data::Webhook::event], + secret: String + } class Webhook < ContextDev::Internal::Type::BaseModel attr_accessor url: String + attr_reader events: ::Array[ContextDev::Models::MonitorListResponse::Data::Webhook::event]? + + def events=: ( + ::Array[ContextDev::Models::MonitorListResponse::Data::Webhook::event] + ) -> ::Array[ContextDev::Models::MonitorListResponse::Data::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::MonitorListResponse::Data::Webhook::event], + ?secret: String + ) -> void + + def to_hash: -> { + url: String, + events: ::Array[ContextDev::Models::MonitorListResponse::Data::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::MonitorListResponse::Data::Webhook::event] + end end type webhook_failure = diff --git a/sig/context_dev/models/monitor_list_runs_response.rbs b/sig/context_dev/models/monitor_list_runs_response.rbs index 1fb39a18..6bf77e09 100644 --- a/sig/context_dev/models/monitor_list_runs_response.rbs +++ b/sig/context_dev/models/monitor_list_runs_response.rbs @@ -42,6 +42,7 @@ module ContextDev error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, started_at: Time?, + webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery } @@ -74,6 +75,12 @@ module ContextDev attr_accessor started_at: Time? + attr_reader webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery]? + + def webhook_deliveries=: ( + ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] + ) -> ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] + attr_reader webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery? def webhook_delivery=: ( @@ -95,6 +102,7 @@ module ContextDev ?error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, ?skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, ?started_at: Time?, + ?webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], ?webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery ) -> void @@ -113,6 +121,7 @@ module ContextDev error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, started_at: Time?, + webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery } @@ -192,6 +201,7 @@ module ContextDev { attempted_at: Time, error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status @@ -202,6 +212,8 @@ module ContextDev attr_accessor error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error? + attr_accessor event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event + attr_accessor event_id: String attr_accessor http_status: Integer? @@ -211,6 +223,7 @@ module ContextDev def initialize: ( attempted_at: Time, error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status @@ -219,6 +232,7 @@ module ContextDev def to_hash: -> { attempted_at: Time, error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, + event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, event_id: String, http_status: Integer?, status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status @@ -236,6 +250,17 @@ module ContextDev def to_hash: -> { code: String, message: String } end + 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::MonitorListRunsResponse::Data::WebhookDelivery::event] + end + type status = :delivered | :rejected | :failed | :skipped_unsafe_url module Status diff --git a/sig/context_dev/models/monitor_retrieve_response.rbs b/sig/context_dev/models/monitor_retrieve_response.rbs index 103a0c4b..4838d7bf 100644 --- a/sig/context_dev/models/monitor_retrieve_response.rbs +++ b/sig/context_dev/models/monitor_retrieve_response.rbs @@ -420,18 +420,48 @@ module ContextDev def to_hash: -> { code: String, message: String } end - type webhook = { url: String, secret: String } + type webhook = + { + url: String, + events: ::Array[ContextDev::Models::MonitorRetrieveResponse::Webhook::event], + secret: String + } class Webhook < ContextDev::Internal::Type::BaseModel attr_accessor url: String + attr_reader events: ::Array[ContextDev::Models::MonitorRetrieveResponse::Webhook::event]? + + def events=: ( + ::Array[ContextDev::Models::MonitorRetrieveResponse::Webhook::event] + ) -> ::Array[ContextDev::Models::MonitorRetrieveResponse::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::MonitorRetrieveResponse::Webhook::event], + ?secret: String + ) -> void + + def to_hash: -> { + url: String, + events: ::Array[ContextDev::Models::MonitorRetrieveResponse::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::MonitorRetrieveResponse::Webhook::event] + end end type webhook_failure = diff --git a/sig/context_dev/models/monitor_update_params.rbs b/sig/context_dev/models/monitor_update_params.rbs index 35cb1462..d709e609 100644 --- a/sig/context_dev/models/monitor_update_params.rbs +++ b/sig/context_dev/models/monitor_update_params.rbs @@ -307,14 +307,43 @@ module ContextDev def self?.variants: -> ::Array[ContextDev::Models::MonitorUpdateParams::target] end - type webhook = { url: String, secret: String } + type webhook = + { + url: String, + events: ::Array[ContextDev::Models::MonitorUpdateParams::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::MonitorUpdateParams::Webhook::event]? + + def events=: ( + ::Array[ContextDev::Models::MonitorUpdateParams::Webhook::event] + ) -> ::Array[ContextDev::Models::MonitorUpdateParams::Webhook::event] + + def initialize: ( + url: String, + ?events: ::Array[ContextDev::Models::MonitorUpdateParams::Webhook::event] + ) -> void + + def to_hash: -> { + url: String, + events: ::Array[ContextDev::Models::MonitorUpdateParams::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::MonitorUpdateParams::Webhook::event] + end end end end diff --git a/sig/context_dev/models/monitor_update_response.rbs b/sig/context_dev/models/monitor_update_response.rbs index 3b67a2b8..2009d7a3 100644 --- a/sig/context_dev/models/monitor_update_response.rbs +++ b/sig/context_dev/models/monitor_update_response.rbs @@ -420,18 +420,48 @@ module ContextDev def to_hash: -> { code: String, message: String } end - type webhook = { url: String, secret: String } + type webhook = + { + url: String, + events: ::Array[ContextDev::Models::MonitorUpdateResponse::Webhook::event], + secret: String + } class Webhook < ContextDev::Internal::Type::BaseModel attr_accessor url: String + attr_reader events: ::Array[ContextDev::Models::MonitorUpdateResponse::Webhook::event]? + + def events=: ( + ::Array[ContextDev::Models::MonitorUpdateResponse::Webhook::event] + ) -> ::Array[ContextDev::Models::MonitorUpdateResponse::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::MonitorUpdateResponse::Webhook::event], + ?secret: String + ) -> void + + def to_hash: -> { + url: String, + events: ::Array[ContextDev::Models::MonitorUpdateResponse::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::MonitorUpdateResponse::Webhook::event] + end end type webhook_failure = From 9d0f398fe3dc2af74c57bca6c8c520a073a25a29 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 11 Jul 2026 23:27:38 +0000 Subject: [PATCH 06/11] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 951a04e0..26e1f0f9 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-ecf38e27f0c2544a8965f6cee827927343a926e1ab511aa7b34e8aa7d1866c8e.yml -openapi_spec_hash: c5767791a19b95c52ef073902fa5da77 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-21b399a0388f04e48b9d8d95f51f622088c5b15b1e17d2988c38583902b9f685.yml +openapi_spec_hash: 6952c95545d272388a655652fc8e7662 config_hash: ff35e224e809656528c44163aa41bebd From bdd3176c7f507880adb7becae314b816c6bbe9bc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 06:05:27 +0000 Subject: [PATCH 07/11] feat(api): api update --- .stats.yml | 4 +-- .../models/web_web_crawl_md_params.rb | 22 +++++++++---- .../models/web_web_scrape_html_params.rb | 22 +++++++++---- .../models/web_web_scrape_md_params.rb | 22 +++++++++---- lib/context_dev/resources/web.rb | 6 ++-- .../models/web_web_crawl_md_params.rbi | 33 +++++++++++++++---- .../models/web_web_scrape_html_params.rbi | 33 +++++++++++++++---- .../models/web_web_scrape_md_params.rbi | 33 +++++++++++++++---- rbi/context_dev/resources/web.rbi | 12 +++---- .../models/web_web_crawl_md_params.rbs | 15 +++++++-- .../models/web_web_scrape_html_params.rbs | 15 +++++++-- .../models/web_web_scrape_md_params.rbs | 15 +++++++-- 12 files changed, 176 insertions(+), 56 deletions(-) diff --git a/.stats.yml b/.stats.yml index 26e1f0f9..f0f1a280 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-21b399a0388f04e48b9d8d95f51f622088c5b15b1e17d2988c38583902b9f685.yml -openapi_spec_hash: 6952c95545d272388a655652fc8e7662 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-48b7ece3103b7778fbb3fc822ac3e28f8758a220f16a9a74383a0e15f2a381e2.yml +openapi_spec_hash: b1dcb462be67fc1ad751463f01d21d21 config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev/models/web_web_crawl_md_params.rb b/lib/context_dev/models/web_web_crawl_md_params.rb index d7ea5861..c1a62fc1 100644 --- a/lib/context_dev/models/web_web_crawl_md_params.rb +++ b/lib/context_dev/models/web_web_crawl_md_params.rb @@ -86,8 +86,8 @@ class WebWebCrawlMdParams < ContextDev::Internal::Type::BaseModel optional :max_pages, Integer, api_name: :maxPages # @!attribute pdf - # 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. # # @return [ContextDev::Models::WebWebCrawlMdParams::Pdf, nil] optional :pdf, -> { ContextDev::WebWebCrawlMdParams::Pdf } @@ -169,7 +169,7 @@ class WebWebCrawlMdParams < ContextDev::Internal::Type::BaseModel # # @param max_pages [Integer] Maximum number of pages to crawl. Hard cap: 500. # - # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr # @@ -410,6 +410,14 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :end_, Integer, api_name: :end + # @!attribute ocr + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + # + # @return [Boolean, nil] + optional :ocr, ContextDev::Internal::Type::Boolean + # @!attribute should_parse # When true, PDF pages are fetched and parsed. When false, PDF pages are skipped # entirely (not included in results and not counted as failures). @@ -423,15 +431,17 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :start, Integer - # @!method initialize(end_: nil, should_parse: nil, start: nil) + # @!method initialize(end_: nil, ocr: nil, should_parse: nil, start: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebCrawlMdParams::Pdf} for more details. # - # 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. # # @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus # + # @param ocr [Boolean] When true, detect and OCR images embedded in the selected PDF pages, inserting r + # # @param should_parse [Boolean] When true, PDF pages are fetched and parsed. When false, PDF pages are skipped e # # @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. diff --git a/lib/context_dev/models/web_web_scrape_html_params.rb b/lib/context_dev/models/web_web_scrape_html_params.rb index c0af65a7..3266d49d 100644 --- a/lib/context_dev/models/web_web_scrape_html_params.rb +++ b/lib/context_dev/models/web_web_scrape_html_params.rb @@ -59,8 +59,8 @@ class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel optional :max_age_ms, Integer # @!attribute pdf - # 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. # # @return [ContextDev::Models::WebWebScrapeHTMLParams::Pdf, nil] optional :pdf, -> { ContextDev::WebWebScrapeHTMLParams::Pdf } @@ -113,7 +113,7 @@ class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr # @@ -347,6 +347,14 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :end_, Integer, api_name: :end + # @!attribute ocr + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + # + # @return [Boolean, nil] + optional :ocr, ContextDev::Internal::Type::Boolean + # @!attribute should_parse # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. @@ -360,15 +368,17 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :start, Integer - # @!method initialize(end_: nil, should_parse: nil, start: nil) + # @!method initialize(end_: nil, ocr: nil, should_parse: nil, start: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeHTMLParams::Pdf} for more details. # - # 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. # # @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus # + # @param ocr [Boolean] When true, detect and OCR images embedded in the selected PDF pages, inserting r + # # @param should_parse [Boolean] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # # @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. diff --git a/lib/context_dev/models/web_web_scrape_md_params.rb b/lib/context_dev/models/web_web_scrape_md_params.rb index 4f01f269..15e70ac8 100644 --- a/lib/context_dev/models/web_web_scrape_md_params.rb +++ b/lib/context_dev/models/web_web_scrape_md_params.rb @@ -72,8 +72,8 @@ class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel optional :max_age_ms, Integer # @!attribute pdf - # 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. # # @return [ContextDev::Models::WebWebScrapeMdParams::Pdf, nil] optional :pdf, -> { ContextDev::WebWebScrapeMdParams::Pdf } @@ -136,7 +136,7 @@ class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before conv # @@ -372,6 +372,14 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :end_, Integer, api_name: :end + # @!attribute ocr + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + # + # @return [Boolean, nil] + optional :ocr, ContextDev::Internal::Type::Boolean + # @!attribute should_parse # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. @@ -385,15 +393,17 @@ class Pdf < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :start, Integer - # @!method initialize(end_: nil, should_parse: nil, start: nil) + # @!method initialize(end_: nil, ocr: nil, should_parse: nil, start: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeMdParams::Pdf} for more details. # - # 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. # # @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus # + # @param ocr [Boolean] When true, detect and OCR images embedded in the selected PDF pages, inserting r + # # @param should_parse [Boolean] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # # @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index c2e1b37a..ceaf9e47 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -289,7 +289,7 @@ def search(params) # # @param max_pages [Integer] Maximum number of pages to crawl. Hard cap: 500. # - # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr # @@ -342,7 +342,7 @@ def web_crawl_md(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr # @@ -463,7 +463,7 @@ def web_scrape_images(params) # # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y # - # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu + # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image # # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before conv # diff --git a/rbi/context_dev/models/web_web_crawl_md_params.rbi b/rbi/context_dev/models/web_web_crawl_md_params.rbi index 86ce4594..3539b987 100644 --- a/rbi/context_dev/models/web_web_crawl_md_params.rbi +++ b/rbi/context_dev/models/web_web_crawl_md_params.rbi @@ -101,8 +101,8 @@ module ContextDev sig { params(max_pages: Integer).void } attr_writer :max_pages - # 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. sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::Pdf)) } attr_reader :pdf @@ -226,8 +226,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 @@ -528,6 +528,15 @@ module ContextDev sig { params(end_: Integer).void } attr_writer :end_ + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :ocr + + sig { params(ocr: T::Boolean).void } + attr_writer :ocr + # When true, PDF pages are fetched and parsed. When false, PDF pages are skipped # entirely (not included in results and not counted as failures). sig { returns(T.nilable(T::Boolean)) } @@ -543,11 +552,12 @@ module ContextDev sig { params(start: Integer).void } attr_writer :start - # 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. sig do params( end_: Integer, + ocr: T::Boolean, should_parse: T::Boolean, start: Integer ).returns(T.attached_class) @@ -556,6 +566,10 @@ module ContextDev # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. # Must be greater than or equal to start when both are provided. end_: nil, + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + ocr: nil, # When true, PDF pages are fetched and parsed. When false, PDF pages are skipped # entirely (not included in results and not counted as failures). should_parse: nil, @@ -566,7 +580,12 @@ module ContextDev sig do override.returns( - { end_: Integer, should_parse: T::Boolean, start: Integer } + { + end_: Integer, + ocr: T::Boolean, + should_parse: T::Boolean, + start: Integer + } ) end def to_hash diff --git a/rbi/context_dev/models/web_web_scrape_html_params.rbi b/rbi/context_dev/models/web_web_scrape_html_params.rbi index 582cfc3f..97373bae 100644 --- a/rbi/context_dev/models/web_web_scrape_html_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_params.rbi @@ -77,8 +77,8 @@ module ContextDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms - # 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. sig { returns(T.nilable(ContextDev::WebWebScrapeHTMLParams::Pdf)) } attr_reader :pdf @@ -160,8 +160,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 @@ -649,6 +649,15 @@ module ContextDev sig { params(end_: Integer).void } attr_writer :end_ + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :ocr + + sig { params(ocr: T::Boolean).void } + attr_writer :ocr + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. sig { returns(T.nilable(T::Boolean)) } @@ -664,11 +673,12 @@ module ContextDev sig { params(start: Integer).void } attr_writer :start - # 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. sig do params( end_: Integer, + ocr: T::Boolean, should_parse: T::Boolean, start: Integer ).returns(T.attached_class) @@ -677,6 +687,10 @@ module ContextDev # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. # Must be greater than or equal to start when both are provided. end_: nil, + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + ocr: nil, # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. should_parse: nil, @@ -687,7 +701,12 @@ module ContextDev sig do override.returns( - { end_: Integer, should_parse: T::Boolean, start: Integer } + { + end_: Integer, + ocr: T::Boolean, + should_parse: T::Boolean, + start: Integer + } ) end def to_hash diff --git a/rbi/context_dev/models/web_web_scrape_md_params.rbi b/rbi/context_dev/models/web_web_scrape_md_params.rbi index eb9767da..cf50f4e0 100644 --- a/rbi/context_dev/models/web_web_scrape_md_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_params.rbi @@ -87,8 +87,8 @@ module ContextDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms - # 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. sig { returns(T.nilable(ContextDev::WebWebScrapeMdParams::Pdf)) } attr_reader :pdf @@ -185,8 +185,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 @@ -475,6 +475,15 @@ module ContextDev sig { params(end_: Integer).void } attr_writer :end_ + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :ocr + + sig { params(ocr: T::Boolean).void } + attr_writer :ocr + # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. sig { returns(T.nilable(T::Boolean)) } @@ -490,11 +499,12 @@ module ContextDev sig { params(start: Integer).void } attr_writer :start - # 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. sig do params( end_: Integer, + ocr: T::Boolean, should_parse: T::Boolean, start: Integer ).returns(T.attached_class) @@ -503,6 +513,10 @@ module ContextDev # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. # Must be greater than or equal to start when both are provided. end_: nil, + # When true, detect and OCR images embedded in the selected PDF pages, inserting + # recognized text at each image's position in page reading order while preserving + # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback. + ocr: nil, # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and # a 400 WEBSITE_ACCESS_ERROR is returned. should_parse: nil, @@ -513,7 +527,12 @@ module ContextDev sig do override.returns( - { end_: Integer, should_parse: T::Boolean, start: Integer } + { + end_: Integer, + ocr: T::Boolean, + should_parse: T::Boolean, + start: Integer + } ) end def to_hash diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index 8c007bc4..be31aac3 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/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 @@ -547,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 diff --git a/sig/context_dev/models/web_web_crawl_md_params.rbs b/sig/context_dev/models/web_web_crawl_md_params.rbs index 63117d94..033fe072 100644 --- a/sig/context_dev/models/web_web_crawl_md_params.rbs +++ b/sig/context_dev/models/web_web_crawl_md_params.rbs @@ -569,13 +569,18 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebCrawlMdParams::country] end - type pdf = { end_: Integer, should_parse: bool, start: Integer } + type pdf = + { end_: Integer, ocr: bool, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel attr_reader end_: Integer? def end_=: (Integer) -> Integer + attr_reader ocr: bool? + + def ocr=: (bool) -> bool + attr_reader should_parse: bool? def should_parse=: (bool) -> bool @@ -586,11 +591,17 @@ module ContextDev def initialize: ( ?end_: Integer, + ?ocr: bool, ?should_parse: bool, ?start: Integer ) -> void - def to_hash: -> { end_: Integer, should_parse: bool, start: Integer } + def to_hash: -> { + end_: Integer, + ocr: bool, + should_parse: bool, + start: Integer + } end end end diff --git a/sig/context_dev/models/web_web_scrape_html_params.rbs b/sig/context_dev/models/web_web_scrape_html_params.rbs index d059dc72..b58ef1ad 100644 --- a/sig/context_dev/models/web_web_scrape_html_params.rbs +++ b/sig/context_dev/models/web_web_scrape_html_params.rbs @@ -520,13 +520,18 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeHTMLParams::country] end - type pdf = { end_: Integer, should_parse: bool, start: Integer } + type pdf = + { end_: Integer, ocr: bool, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel attr_reader end_: Integer? def end_=: (Integer) -> Integer + attr_reader ocr: bool? + + def ocr=: (bool) -> bool + attr_reader should_parse: bool? def should_parse=: (bool) -> bool @@ -537,11 +542,17 @@ module ContextDev def initialize: ( ?end_: Integer, + ?ocr: bool, ?should_parse: bool, ?start: Integer ) -> void - def to_hash: -> { end_: Integer, should_parse: bool, start: Integer } + def to_hash: -> { + end_: Integer, + ocr: bool, + should_parse: bool, + start: Integer + } end end end diff --git a/sig/context_dev/models/web_web_scrape_md_params.rbs b/sig/context_dev/models/web_web_scrape_md_params.rbs index 96c753ca..5df459cb 100644 --- a/sig/context_dev/models/web_web_scrape_md_params.rbs +++ b/sig/context_dev/models/web_web_scrape_md_params.rbs @@ -541,13 +541,18 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeMdParams::country] end - type pdf = { end_: Integer, should_parse: bool, start: Integer } + type pdf = + { end_: Integer, ocr: bool, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel attr_reader end_: Integer? def end_=: (Integer) -> Integer + attr_reader ocr: bool? + + def ocr=: (bool) -> bool + attr_reader should_parse: bool? def should_parse=: (bool) -> bool @@ -558,11 +563,17 @@ module ContextDev def initialize: ( ?end_: Integer, + ?ocr: bool, ?should_parse: bool, ?start: Integer ) -> void - def to_hash: -> { end_: Integer, should_parse: bool, start: Integer } + def to_hash: -> { + end_: Integer, + ocr: bool, + should_parse: bool, + start: Integer + } end end end From 4e4d9449df4f103f462d31a2232838c714313e2b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 06:53:08 +0000 Subject: [PATCH 08/11] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f0f1a280..66d8d6b5 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-48b7ece3103b7778fbb3fc822ac3e28f8758a220f16a9a74383a0e15f2a381e2.yml -openapi_spec_hash: b1dcb462be67fc1ad751463f01d21d21 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-2b4fb3b310c35a1036b88e33c7252f42716d05ef19ea4d462426e0a28e0294a3.yml +openapi_spec_hash: cda6b6aaf724e39575e1848f3ea6eb10 config_hash: ff35e224e809656528c44163aa41bebd From 3fd960488c341f082b6d312dda927aeee23dccff Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 07:51:48 +0000 Subject: [PATCH 09/11] feat(api): api update --- .stats.yml | 4 +- lib/context_dev.rb | 1 + lib/context_dev/models.rb | 2 + .../monitor_list_account_runs_response.rb | 123 +------- .../models/monitor_list_runs_response.rb | 120 +------- lib/context_dev/models/webhook_delivery.rb | 109 +++++++ rbi/context_dev/models.rbi | 2 + .../monitor_list_account_runs_response.rbi | 266 +----------------- .../models/monitor_list_runs_response.rbi | 266 +----------------- rbi/context_dev/models/webhook_delivery.rbi | 172 +++++++++++ sig/context_dev/models.rbs | 2 + .../monitor_list_account_runs_response.rbs | 102 +------ .../models/monitor_list_runs_response.rbs | 102 +------ sig/context_dev/models/webhook_delivery.rbs | 81 ++++++ 14 files changed, 423 insertions(+), 929 deletions(-) create mode 100644 lib/context_dev/models/webhook_delivery.rb create mode 100644 rbi/context_dev/models/webhook_delivery.rbi create mode 100644 sig/context_dev/models/webhook_delivery.rbs diff --git a/.stats.yml b/.stats.yml index 66d8d6b5..3d6d2e8c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-2b4fb3b310c35a1036b88e33c7252f42716d05ef19ea4d462426e0a28e0294a3.yml -openapi_spec_hash: cda6b6aaf724e39575e1848f3ea6eb10 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-27dde3a14459d2e2ade277b142906f33c1b9e04c05b91ae9eb10b798eb82eb0b.yml +openapi_spec_hash: bf7879be38ebf3397a939c80b261a47a config_hash: ff35e224e809656528c44163aa41bebd diff --git a/lib/context_dev.rb b/lib/context_dev.rb index 9763b745..570508c7 100644 --- a/lib/context_dev.rb +++ b/lib/context_dev.rb @@ -96,6 +96,7 @@ require_relative "context_dev/models/web_extract_response" require_relative "context_dev/models/web_extract_styleguide_params" require_relative "context_dev/models/web_extract_styleguide_response" +require_relative "context_dev/models/webhook_delivery" require_relative "context_dev/models/web_screenshot_params" require_relative "context_dev/models/web_screenshot_response" require_relative "context_dev/models/web_search_params" diff --git a/lib/context_dev/models.rb b/lib/context_dev/models.rb index c1d9bfbd..9161be2a 100644 --- a/lib/context_dev/models.rb +++ b/lib/context_dev/models.rb @@ -83,6 +83,8 @@ module ContextDev WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams + WebhookDelivery = ContextDev::Models::WebhookDelivery + WebScreenshotParams = ContextDev::Models::WebScreenshotParams WebSearchParams = ContextDev::Models::WebSearchParams diff --git a/lib/context_dev/models/monitor_list_account_runs_response.rb b/lib/context_dev/models/monitor_list_account_runs_response.rb index 455cfdc1..802167dc 100644 --- a/lib/context_dev/models/monitor_list_account_runs_response.rb +++ b/lib/context_dev/models/monitor_list_account_runs_response.rb @@ -111,9 +111,8 @@ class Data < ContextDev::Internal::Type::BaseModel # fired. Omitted when no webhook was attempted, including runs created before # event selection was added. # - # @return [Array, nil] - optional :webhook_deliveries, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] } + # @return [Array, nil] + optional :webhook_deliveries, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::WebhookDelivery] } # @!attribute webhook_delivery # @deprecated @@ -122,9 +121,8 @@ class Data < ContextDev::Internal::Type::BaseModel # can deliver multiple events. Omitted when no webhook was attempted, including # historical runs created before delivery tracking was added. # - # @return [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery, nil] - optional :webhook_delivery, - -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery } + # @return [ContextDev::Models::WebhookDelivery, nil] + optional :webhook_delivery, -> { ContextDev::WebhookDelivery } # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil) # Some parameter documentations has been truncated, see @@ -158,9 +156,9 @@ class Data < ContextDev::Internal::Type::BaseModel # # @param started_at [Time, nil] # - # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir + # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir # - # @param webhook_delivery [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#change_detection_type module ChangeDetectionType @@ -245,115 +243,6 @@ module SkipReason # @!method self.values # @return [Array] end - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - # @!attribute attempted_at - # - # @return [Time] - required :attempted_at, Time - - # @!attribute error - # - # @return [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error, nil] - required :error, - -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error }, - nil?: true - - # @!attribute event - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - # - # @return [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event] - required :event, - enum: -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event } - - # @!attribute event_id - # Identifier sent in the X-Context-Id header. - # - # @return [String] - required :event_id, String - - # @!attribute http_status - # The endpoint's final HTTP response status, or null when no response was - # received. - # - # @return [Integer, nil] - required :http_status, Integer, nil?: true - - # @!attribute 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. - # - # @return [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status] - required :status, - enum: -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status } - - # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:) - # Some parameter documentations has been truncated, see - # {ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery} for - # more details. - # - # @param attempted_at [Time] - # - # @param error [ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error, nil] - # - # @param event [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event] The event this delivery carried. Deliveries recorded before event selection exis - # - # @param event_id [String] Identifier sent in the X-Context-Id header. - # - # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received - # - # @param status [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status] Delivery outcome. delivered means any 2xx response; rejected means a non-2xx res - - # @see ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery#error - class Error < ContextDev::Internal::Type::BaseModel - # @!attribute code - # - # @return [String] - required :code, String - - # @!attribute message - # - # @return [String] - required :message, String - - # @!method initialize(code:, message:) - # @param code [String] - # @param message [String] - end - - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - # - # @see ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery#event - module Event - extend ContextDev::Internal::Type::Enum - - CHANGE_DETECTED = :"change.detected" - RUN_COMPLETED = :"run.completed" - - # @!method self.values - # @return [Array] - 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. - # - # @see ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery#status - module Status - extend ContextDev::Internal::Type::Enum - - DELIVERED = :delivered - REJECTED = :rejected - FAILED = :failed - SKIPPED_UNSAFE_URL = :skipped_unsafe_url - - # @!method self.values - # @return [Array] - end - end end end end diff --git a/lib/context_dev/models/monitor_list_runs_response.rb b/lib/context_dev/models/monitor_list_runs_response.rb index 9a86e14a..a4ce61d4 100644 --- a/lib/context_dev/models/monitor_list_runs_response.rb +++ b/lib/context_dev/models/monitor_list_runs_response.rb @@ -111,9 +111,8 @@ class Data < ContextDev::Internal::Type::BaseModel # fired. Omitted when no webhook was attempted, including runs created before # event selection was added. # - # @return [Array, nil] - optional :webhook_deliveries, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] } + # @return [Array, nil] + optional :webhook_deliveries, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::WebhookDelivery] } # @!attribute webhook_delivery # @deprecated @@ -122,8 +121,8 @@ class Data < ContextDev::Internal::Type::BaseModel # can deliver multiple events. Omitted when no webhook was attempted, including # historical runs created before delivery tracking was added. # - # @return [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery, nil] - optional :webhook_delivery, -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery } + # @return [ContextDev::Models::WebhookDelivery, nil] + optional :webhook_delivery, -> { ContextDev::WebhookDelivery } # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil) # Some parameter documentations has been truncated, see @@ -157,9 +156,9 @@ class Data < ContextDev::Internal::Type::BaseModel # # @param started_at [Time, nil] # - # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir + # @param webhook_deliveries [Array] All webhook deliveries attempted by this run — one per subscribed event that fir # - # @param webhook_delivery [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run + # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type module ChangeDetectionType @@ -244,113 +243,6 @@ module SkipReason # @!method self.values # @return [Array] end - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - # @!attribute attempted_at - # - # @return [Time] - required :attempted_at, Time - - # @!attribute error - # - # @return [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, nil] - required :error, - -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error }, - nil?: true - - # @!attribute event - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - # - # @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event] - required :event, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event } - - # @!attribute event_id - # Identifier sent in the X-Context-Id header. - # - # @return [String] - required :event_id, String - - # @!attribute http_status - # The endpoint's final HTTP response status, or null when no response was - # received. - # - # @return [Integer, nil] - required :http_status, Integer, nil?: true - - # @!attribute 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. - # - # @return [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status] - required :status, enum: -> { ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status } - - # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:) - # Some parameter documentations has been truncated, see - # {ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery} for more - # details. - # - # @param attempted_at [Time] - # - # @param error [ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, nil] - # - # @param event [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event] The event this delivery carried. Deliveries recorded before event selection exis - # - # @param event_id [String] Identifier sent in the X-Context-Id header. - # - # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received - # - # @param status [Symbol, ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status] Delivery outcome. delivered means any 2xx response; rejected means a non-2xx res - - # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#error - class Error < ContextDev::Internal::Type::BaseModel - # @!attribute code - # - # @return [String] - required :code, String - - # @!attribute message - # - # @return [String] - required :message, String - - # @!method initialize(code:, message:) - # @param code [String] - # @param message [String] - end - - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - # - # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#event - module Event - extend ContextDev::Internal::Type::Enum - - CHANGE_DETECTED = :"change.detected" - RUN_COMPLETED = :"run.completed" - - # @!method self.values - # @return [Array] - 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. - # - # @see ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery#status - module Status - extend ContextDev::Internal::Type::Enum - - DELIVERED = :delivered - REJECTED = :rejected - FAILED = :failed - SKIPPED_UNSAFE_URL = :skipped_unsafe_url - - # @!method self.values - # @return [Array] - end - end end end end diff --git a/lib/context_dev/models/webhook_delivery.rb b/lib/context_dev/models/webhook_delivery.rb new file mode 100644 index 00000000..b52e80b6 --- /dev/null +++ b/lib/context_dev/models/webhook_delivery.rb @@ -0,0 +1,109 @@ +# frozen_string_literal: true + +module ContextDev + module Models + class WebhookDelivery < ContextDev::Internal::Type::BaseModel + # @!attribute attempted_at + # + # @return [Time] + required :attempted_at, Time + + # @!attribute error + # + # @return [ContextDev::Models::WebhookDelivery::Error, nil] + required :error, -> { ContextDev::WebhookDelivery::Error }, nil?: true + + # @!attribute event + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @return [Symbol, ContextDev::Models::WebhookDelivery::Event] + required :event, enum: -> { ContextDev::WebhookDelivery::Event } + + # @!attribute event_id + # Identifier sent in the X-Context-Id header. + # + # @return [String] + required :event_id, String + + # @!attribute http_status + # The endpoint's final HTTP response status, or null when no response was + # received. + # + # @return [Integer, nil] + required :http_status, Integer, nil?: true + + # @!attribute 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. + # + # @return [Symbol, ContextDev::Models::WebhookDelivery::Status] + required :status, enum: -> { ContextDev::WebhookDelivery::Status } + + # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebhookDelivery} for more details. + # + # @param attempted_at [Time] + # + # @param error [ContextDev::Models::WebhookDelivery::Error, nil] + # + # @param event [Symbol, ContextDev::Models::WebhookDelivery::Event] The event this delivery carried. Deliveries recorded before event selection exis + # + # @param event_id [String] Identifier sent in the X-Context-Id header. + # + # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received + # + # @param status [Symbol, ContextDev::Models::WebhookDelivery::Status] Delivery outcome. delivered means any 2xx response; rejected means a non-2xx res + + # @see ContextDev::Models::WebhookDelivery#error + class Error < ContextDev::Internal::Type::BaseModel + # @!attribute code + # + # @return [String] + required :code, String + + # @!attribute message + # + # @return [String] + required :message, String + + # @!method initialize(code:, message:) + # @param code [String] + # @param message [String] + end + + # The event this delivery carried. Deliveries recorded before event selection + # existed report change.detected. + # + # @see ContextDev::Models::WebhookDelivery#event + module Event + extend ContextDev::Internal::Type::Enum + + CHANGE_DETECTED = :"change.detected" + RUN_COMPLETED = :"run.completed" + + # @!method self.values + # @return [Array] + 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. + # + # @see ContextDev::Models::WebhookDelivery#status + module Status + extend ContextDev::Internal::Type::Enum + + DELIVERED = :delivered + REJECTED = :rejected + FAILED = :failed + SKIPPED_UNSAFE_URL = :skipped_unsafe_url + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/rbi/context_dev/models.rbi b/rbi/context_dev/models.rbi index 771a2040..6de7c548 100644 --- a/rbi/context_dev/models.rbi +++ b/rbi/context_dev/models.rbi @@ -48,6 +48,8 @@ module ContextDev WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams + WebhookDelivery = ContextDev::Models::WebhookDelivery + WebScreenshotParams = ContextDev::Models::WebScreenshotParams WebSearchParams = ContextDev::Models::WebSearchParams diff --git a/rbi/context_dev/models/monitor_list_account_runs_response.rbi b/rbi/context_dev/models/monitor_list_account_runs_response.rbi index 3ce6f16d..51275f7b 100644 --- a/rbi/context_dev/models/monitor_list_account_runs_response.rbi +++ b/rbi/context_dev/models/monitor_list_account_runs_response.rbi @@ -151,23 +151,12 @@ module ContextDev # All webhook deliveries attempted by this run — one per subscribed event that # fired. Omitted when no webhook was attempted, including runs created before # event selection was added. - sig do - returns( - T.nilable( - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery - ] - ) - ) - end + sig { returns(T.nilable(T::Array[ContextDev::WebhookDelivery])) } attr_reader :webhook_deliveries sig do params( - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash - ] + webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash] ).void end attr_writer :webhook_deliveries @@ -175,20 +164,11 @@ module ContextDev # Deprecated: use `webhook_deliveries`, which records every attempt now that a run # can deliver multiple events. Omitted when no webhook was attempted, including # historical runs created before delivery tracking was added. - sig do - returns( - T.nilable( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery - ) - ) - end + sig { returns(T.nilable(ContextDev::WebhookDelivery)) } attr_reader :webhook_delivery sig do - params( - webhook_delivery: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash - ).void + params(webhook_delivery: ContextDev::WebhookDelivery::OrHash).void end attr_writer :webhook_delivery @@ -218,12 +198,8 @@ module ContextDev ContextDev::Models::MonitorListAccountRunsResponse::Data::SkipReason::OrSymbol ), started_at: T.nilable(Time), - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash - ], - webhook_delivery: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::OrHash + webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash], + webhook_delivery: ContextDev::WebhookDelivery::OrHash ).returns(T.attached_class) end def self.new( @@ -286,12 +262,8 @@ module ContextDev ContextDev::Models::MonitorListAccountRunsResponse::Data::SkipReason::TaggedSymbol ), started_at: T.nilable(Time), - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery - ], - webhook_delivery: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + webhook_deliveries: T::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } ) end @@ -522,228 +494,6 @@ module ContextDev def self.values end end - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery, - ContextDev::Internal::AnyHash - ) - end - - sig { returns(Time) } - attr_accessor :attempted_at - - sig do - returns( - T.nilable( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error - ) - ) - end - attr_reader :error - - sig do - params( - error: - T.nilable( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error::OrHash - ) - ).void - end - attr_writer :error - - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - sig do - returns( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - end - 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 do - returns( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - end - attr_accessor :status - - sig do - params( - attempted_at: Time, - error: - T.nilable( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error::OrHash - ), - event: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::OrSymbol, - event_id: String, - http_status: T.nilable(Integer), - status: - ContextDev::Models::MonitorListAccountRunsResponse::Data::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::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error - ), - event: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol, - event_id: String, - http_status: T.nilable(Integer), - status: - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - } - ) - end - def to_hash - end - - class Error < ContextDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error, - ContextDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :code - - sig { returns(String) } - attr_accessor :message - - sig do - params(code: String, message: String).returns(T.attached_class) - end - 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 do - T.all( - Symbol, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CHANGE_DETECTED = - T.let( - :"change.detected", - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - RUN_COMPLETED = - T.let( - :"run.completed", - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::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 do - T.all( - Symbol, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DELIVERED = - T.let( - :delivered, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - REJECTED = - T.let( - :rejected, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - FAILED = - T.let( - :failed, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - SKIPPED_UNSAFE_URL = - T.let( - :skipped_unsafe_url, - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end end end end diff --git a/rbi/context_dev/models/monitor_list_runs_response.rbi b/rbi/context_dev/models/monitor_list_runs_response.rbi index 0c43c1a6..7d2def95 100644 --- a/rbi/context_dev/models/monitor_list_runs_response.rbi +++ b/rbi/context_dev/models/monitor_list_runs_response.rbi @@ -142,23 +142,12 @@ module ContextDev # All webhook deliveries attempted by this run — one per subscribed event that # fired. Omitted when no webhook was attempted, including runs created before # event selection was added. - sig do - returns( - T.nilable( - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery - ] - ) - ) - end + sig { returns(T.nilable(T::Array[ContextDev::WebhookDelivery])) } attr_reader :webhook_deliveries sig do params( - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash - ] + webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash] ).void end attr_writer :webhook_deliveries @@ -166,20 +155,11 @@ module ContextDev # Deprecated: use `webhook_deliveries`, which records every attempt now that a run # can deliver multiple events. Omitted when no webhook was attempted, including # historical runs created before delivery tracking was added. - sig do - returns( - T.nilable( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery - ) - ) - end + sig { returns(T.nilable(ContextDev::WebhookDelivery)) } attr_reader :webhook_delivery sig do - params( - webhook_delivery: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash - ).void + params(webhook_delivery: ContextDev::WebhookDelivery::OrHash).void end attr_writer :webhook_delivery @@ -209,12 +189,8 @@ module ContextDev ContextDev::Models::MonitorListRunsResponse::Data::SkipReason::OrSymbol ), started_at: T.nilable(Time), - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash - ], - webhook_delivery: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::OrHash + webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash], + webhook_delivery: ContextDev::WebhookDelivery::OrHash ).returns(T.attached_class) end def self.new( @@ -277,12 +253,8 @@ module ContextDev ContextDev::Models::MonitorListRunsResponse::Data::SkipReason::TaggedSymbol ), started_at: T.nilable(Time), - webhook_deliveries: - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery - ], - webhook_delivery: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + webhook_deliveries: T::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } ) end @@ -513,228 +485,6 @@ module ContextDev def self.values end end - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery, - ContextDev::Internal::AnyHash - ) - end - - sig { returns(Time) } - attr_accessor :attempted_at - - sig do - returns( - T.nilable( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error - ) - ) - end - attr_reader :error - - sig do - params( - error: - T.nilable( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error::OrHash - ) - ).void - end - attr_writer :error - - # The event this delivery carried. Deliveries recorded before event selection - # existed report change.detected. - sig do - returns( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - end - 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 do - returns( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - end - attr_accessor :status - - sig do - params( - attempted_at: Time, - error: - T.nilable( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error::OrHash - ), - event: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::OrSymbol, - event_id: String, - http_status: T.nilable(Integer), - status: - ContextDev::Models::MonitorListRunsResponse::Data::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::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error - ), - event: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol, - event_id: String, - http_status: T.nilable(Integer), - status: - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - } - ) - end - def to_hash - end - - class Error < ContextDev::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error, - ContextDev::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :code - - sig { returns(String) } - attr_accessor :message - - sig do - params(code: String, message: String).returns(T.attached_class) - end - 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 do - T.all( - Symbol, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CHANGE_DETECTED = - T.let( - :"change.detected", - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - RUN_COMPLETED = - T.let( - :"run.completed", - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Event::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::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 do - T.all( - Symbol, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DELIVERED = - T.let( - :delivered, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - REJECTED = - T.let( - :rejected, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - FAILED = - T.let( - :failed, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - SKIPPED_UNSAFE_URL = - T.let( - :skipped_unsafe_url, - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end end end end diff --git a/rbi/context_dev/models/webhook_delivery.rbi b/rbi/context_dev/models/webhook_delivery.rbi new file mode 100644 index 00000000..c80e0859 --- /dev/null +++ b/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 diff --git a/sig/context_dev/models.rbs b/sig/context_dev/models.rbs index 23979701..5c2fff02 100644 --- a/sig/context_dev/models.rbs +++ b/sig/context_dev/models.rbs @@ -43,6 +43,8 @@ module ContextDev class WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams + class WebhookDelivery = ContextDev::Models::WebhookDelivery + class WebScreenshotParams = ContextDev::Models::WebScreenshotParams class WebSearchParams = ContextDev::Models::WebSearchParams diff --git a/sig/context_dev/models/monitor_list_account_runs_response.rbs b/sig/context_dev/models/monitor_list_account_runs_response.rbs index 8952e25b..0fa3d57a 100644 --- a/sig/context_dev/models/monitor_list_account_runs_response.rbs +++ b/sig/context_dev/models/monitor_list_account_runs_response.rbs @@ -42,8 +42,8 @@ module ContextDev error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, started_at: Time?, - webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], - webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } class Data < ContextDev::Internal::Type::BaseModel @@ -75,17 +75,17 @@ module ContextDev attr_accessor started_at: Time? - attr_reader webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery]? + attr_reader webhook_deliveries: ::Array[ContextDev::WebhookDelivery]? def webhook_deliveries=: ( - ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] - ) -> ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery] + ::Array[ContextDev::WebhookDelivery] + ) -> ::Array[ContextDev::WebhookDelivery] - attr_reader webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery? + attr_reader webhook_delivery: ContextDev::WebhookDelivery? def webhook_delivery=: ( - ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery - ) -> ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + ContextDev::WebhookDelivery + ) -> ContextDev::WebhookDelivery def initialize: ( id: String, @@ -102,8 +102,8 @@ module ContextDev ?error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, ?skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, ?started_at: Time?, - ?webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], - ?webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + ?webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + ?webhook_delivery: ContextDev::WebhookDelivery ) -> void def to_hash: -> { @@ -121,8 +121,8 @@ module ContextDev error: ContextDev::Models::MonitorListAccountRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason?, started_at: Time?, - webhook_deliveries: ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery], - webhook_delivery: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery + webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } type change_detection_type = :exact | :semantic @@ -196,84 +196,6 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::skip_reason] end - - type webhook_delivery = - { - attempted_at: Time, - error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status - } - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - attr_accessor attempted_at: Time - - attr_accessor error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error? - - attr_accessor event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event - - attr_accessor event_id: String - - attr_accessor http_status: Integer? - - attr_accessor status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status - - def initialize: ( - attempted_at: Time, - error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status - ) -> void - - def to_hash: -> { - attempted_at: Time, - error: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status - } - - type error = { code: String, message: String } - - class Error < ContextDev::Internal::Type::BaseModel - attr_accessor code: String - - attr_accessor message: String - - def initialize: (code: String, message: String) -> void - - def to_hash: -> { code: String, message: String } - end - - 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::MonitorListAccountRunsResponse::Data::WebhookDelivery::event] - end - - type status = :delivered | :rejected | :failed | :skipped_unsafe_url - - module Status - extend ContextDev::Internal::Type::Enum - - DELIVERED: :delivered - REJECTED: :rejected - FAILED: :failed - SKIPPED_UNSAFE_URL: :skipped_unsafe_url - - def self?.values: -> ::Array[ContextDev::Models::MonitorListAccountRunsResponse::Data::WebhookDelivery::status] - end - end end end end diff --git a/sig/context_dev/models/monitor_list_runs_response.rbs b/sig/context_dev/models/monitor_list_runs_response.rbs index 6bf77e09..ee5bdcf4 100644 --- a/sig/context_dev/models/monitor_list_runs_response.rbs +++ b/sig/context_dev/models/monitor_list_runs_response.rbs @@ -42,8 +42,8 @@ module ContextDev error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, started_at: Time?, - webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], - webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } class Data < ContextDev::Internal::Type::BaseModel @@ -75,17 +75,17 @@ module ContextDev attr_accessor started_at: Time? - attr_reader webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery]? + attr_reader webhook_deliveries: ::Array[ContextDev::WebhookDelivery]? def webhook_deliveries=: ( - ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] - ) -> ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery] + ::Array[ContextDev::WebhookDelivery] + ) -> ::Array[ContextDev::WebhookDelivery] - attr_reader webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery? + attr_reader webhook_delivery: ContextDev::WebhookDelivery? def webhook_delivery=: ( - ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery - ) -> ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + ContextDev::WebhookDelivery + ) -> ContextDev::WebhookDelivery def initialize: ( id: String, @@ -102,8 +102,8 @@ module ContextDev ?error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, ?skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, ?started_at: Time?, - ?webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], - ?webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + ?webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + ?webhook_delivery: ContextDev::WebhookDelivery ) -> void def to_hash: -> { @@ -121,8 +121,8 @@ module ContextDev error: ContextDev::Models::MonitorListRunsResponse::Data::Error?, skip_reason: ContextDev::Models::MonitorListRunsResponse::Data::skip_reason?, started_at: Time?, - webhook_deliveries: ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery], - webhook_delivery: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery + webhook_deliveries: ::Array[ContextDev::WebhookDelivery], + webhook_delivery: ContextDev::WebhookDelivery } type change_detection_type = :exact | :semantic @@ -196,84 +196,6 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::MonitorListRunsResponse::Data::skip_reason] end - - type webhook_delivery = - { - attempted_at: Time, - error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status - } - - class WebhookDelivery < ContextDev::Internal::Type::BaseModel - attr_accessor attempted_at: Time - - attr_accessor error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error? - - attr_accessor event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event - - attr_accessor event_id: String - - attr_accessor http_status: Integer? - - attr_accessor status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status - - def initialize: ( - attempted_at: Time, - error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status - ) -> void - - def to_hash: -> { - attempted_at: Time, - error: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::Error?, - event: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::event, - event_id: String, - http_status: Integer?, - status: ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status - } - - type error = { code: String, message: String } - - class Error < ContextDev::Internal::Type::BaseModel - attr_accessor code: String - - attr_accessor message: String - - def initialize: (code: String, message: String) -> void - - def to_hash: -> { code: String, message: String } - end - - 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::MonitorListRunsResponse::Data::WebhookDelivery::event] - end - - type status = :delivered | :rejected | :failed | :skipped_unsafe_url - - module Status - extend ContextDev::Internal::Type::Enum - - DELIVERED: :delivered - REJECTED: :rejected - FAILED: :failed - SKIPPED_UNSAFE_URL: :skipped_unsafe_url - - def self?.values: -> ::Array[ContextDev::Models::MonitorListRunsResponse::Data::WebhookDelivery::status] - end - end end end end diff --git a/sig/context_dev/models/webhook_delivery.rbs b/sig/context_dev/models/webhook_delivery.rbs new file mode 100644 index 00000000..7120f647 --- /dev/null +++ b/sig/context_dev/models/webhook_delivery.rbs @@ -0,0 +1,81 @@ +module ContextDev + module Models + type webhook_delivery = + { + attempted_at: Time, + error: ContextDev::WebhookDelivery::Error?, + event: ContextDev::Models::WebhookDelivery::event, + event_id: String, + http_status: Integer?, + status: ContextDev::Models::WebhookDelivery::status + } + + class WebhookDelivery < ContextDev::Internal::Type::BaseModel + attr_accessor attempted_at: Time + + attr_accessor error: ContextDev::WebhookDelivery::Error? + + attr_accessor event: ContextDev::Models::WebhookDelivery::event + + attr_accessor event_id: String + + attr_accessor http_status: Integer? + + attr_accessor status: ContextDev::Models::WebhookDelivery::status + + def initialize: ( + attempted_at: Time, + error: ContextDev::WebhookDelivery::Error?, + event: ContextDev::Models::WebhookDelivery::event, + event_id: String, + http_status: Integer?, + status: ContextDev::Models::WebhookDelivery::status + ) -> void + + def to_hash: -> { + attempted_at: Time, + error: ContextDev::WebhookDelivery::Error?, + event: ContextDev::Models::WebhookDelivery::event, + event_id: String, + http_status: Integer?, + status: ContextDev::Models::WebhookDelivery::status + } + + type error = { code: String, message: String } + + class Error < ContextDev::Internal::Type::BaseModel + attr_accessor code: String + + attr_accessor message: String + + def initialize: (code: String, message: String) -> void + + def to_hash: -> { code: String, message: String } + end + + 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::WebhookDelivery::event] + end + + type status = :delivered | :rejected | :failed | :skipped_unsafe_url + + module Status + extend ContextDev::Internal::Type::Enum + + DELIVERED: :delivered + REJECTED: :rejected + FAILED: :failed + SKIPPED_UNSAFE_URL: :skipped_unsafe_url + + def self?.values: -> ::Array[ContextDev::Models::WebhookDelivery::status] + end + end + end +end From b7f6b2c0a5bb91cc065bcc2ef497c9999414262c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 07:57:16 +0000 Subject: [PATCH 10/11] feat(api): manual updates --- .stats.yml | 6 +- lib/context_dev.rb | 3 + lib/context_dev/client.rb | 4 + lib/context_dev/internal/type/base_model.rb | 10 +- lib/context_dev/models.rb | 2 + lib/context_dev/models/parse_handle_params.rb | 110 +++++ .../models/parse_handle_response.rb | 132 ++++++ lib/context_dev/resources/parse.rb | 63 +++ rbi/context_dev/client.rbi | 3 + rbi/context_dev/models.rbi | 2 + .../models/parse_handle_params.rbi | 163 ++++++++ .../models/parse_handle_response.rbi | 377 ++++++++++++++++++ rbi/context_dev/resources/parse.rbi | 65 +++ sig/context_dev/client.rbs | 2 + sig/context_dev/models.rbs | 2 + .../models/parse_handle_params.rbs | 96 +++++ .../models/parse_handle_response.rbs | 159 ++++++++ sig/context_dev/resources/parse.rbs | 22 + test/context_dev/resources/parse_test.rb | 24 ++ 19 files changed, 1237 insertions(+), 8 deletions(-) create mode 100644 lib/context_dev/models/parse_handle_params.rb create mode 100644 lib/context_dev/models/parse_handle_response.rb create mode 100644 lib/context_dev/resources/parse.rb create mode 100644 rbi/context_dev/models/parse_handle_params.rbi create mode 100644 rbi/context_dev/models/parse_handle_response.rbi create mode 100644 rbi/context_dev/resources/parse.rbi create mode 100644 sig/context_dev/models/parse_handle_params.rbs create mode 100644 sig/context_dev/models/parse_handle_response.rbs create mode 100644 sig/context_dev/resources/parse.rbs create mode 100644 test/context_dev/resources/parse_test.rb diff --git a/.stats.yml b/.stats.yml index 3d6d2e8c..1ba53488 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 29 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-27dde3a14459d2e2ade277b142906f33c1b9e04c05b91ae9eb10b798eb82eb0b.yml +configured_endpoints: 30 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-c90f13e3cf4b9ae6a1d8f22c0e7285ab12d412d3a659a51a247a97adc7f08121.yml openapi_spec_hash: bf7879be38ebf3397a939c80b261a47a -config_hash: ff35e224e809656528c44163aa41bebd +config_hash: daabb160675d86b354711da1e77e5129 diff --git a/lib/context_dev.rb b/lib/context_dev.rb index 570508c7..fcf9547d 100644 --- a/lib/context_dev.rb +++ b/lib/context_dev.rb @@ -86,6 +86,8 @@ require_relative "context_dev/models/monitor_run_response" require_relative "context_dev/models/monitor_update_params" require_relative "context_dev/models/monitor_update_response" +require_relative "context_dev/models/parse_handle_params" +require_relative "context_dev/models/parse_handle_response" require_relative "context_dev/models/utility_prefetch_params" require_relative "context_dev/models/utility_prefetch_response" require_relative "context_dev/models/web_extract_competitors_params" @@ -116,5 +118,6 @@ require_relative "context_dev/resources/brand" require_relative "context_dev/resources/industry" require_relative "context_dev/resources/monitors" +require_relative "context_dev/resources/parse" require_relative "context_dev/resources/utility" require_relative "context_dev/resources/web" diff --git a/lib/context_dev/client.rb b/lib/context_dev/client.rb index 61eeb8f4..c7135c38 100644 --- a/lib/context_dev/client.rb +++ b/lib/context_dev/client.rb @@ -18,6 +18,9 @@ class Client < ContextDev::Internal::Transport::BaseClient # @return [String] attr_reader :api_key + # @return [ContextDev::Resources::Parse] + attr_reader :parse + # @return [ContextDev::Resources::Web] attr_reader :web @@ -101,6 +104,7 @@ def initialize( headers: headers ) + @parse = ContextDev::Resources::Parse.new(client: self) @web = ContextDev::Resources::Web.new(client: self) @ai = ContextDev::Resources::AI.new(client: self) @brand = ContextDev::Resources::Brand.new(client: self) diff --git a/lib/context_dev/internal/type/base_model.rb b/lib/context_dev/internal/type/base_model.rb index af0e1db9..ef52b8dd 100644 --- a/lib/context_dev/internal/type/base_model.rb +++ b/lib/context_dev/internal/type/base_model.rb @@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `web_extract_response` is a `ContextDev::Models::WebExtractResponse` - # web_extract_response => { - # data: data, - # metadata: metadata, - # status: status + # # `parse_handle_response` is a `ContextDev::Models::ParseHandleResponse` + # parse_handle_response => { + # markdown: markdown, + # success: success, + # type: type # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/context_dev/models.rb b/lib/context_dev/models.rb index 9161be2a..1472ae90 100644 --- a/lib/context_dev/models.rb +++ b/lib/context_dev/models.rb @@ -73,6 +73,8 @@ module ContextDev MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams + ParseHandleParams = ContextDev::Models::ParseHandleParams + UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams diff --git a/lib/context_dev/models/parse_handle_params.rb b/lib/context_dev/models/parse_handle_params.rb new file mode 100644 index 00000000..12ccdf50 --- /dev/null +++ b/lib/context_dev/models/parse_handle_params.rb @@ -0,0 +1,110 @@ +# frozen_string_literal: true + +module ContextDev + module Models + # @see ContextDev::Resources::Parse#handle + class ParseHandleParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + # @!attribute body + # + # @return [Pathname, StringIO, IO, String, ContextDev::FilePart] + required :body, ContextDev::Internal::Type::FileInput + + # @!attribute base_url + # Optional HTTP(S) source document URL used to resolve relative links and image + # references. Relative references remain relative when omitted. + # + # @return [String, nil] + optional :base_url, String + + # @!attribute extension + # Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, + # md, py, rtf, jpg, png, or txt. + # + # @return [String, nil] + optional :extension, String + + # @!attribute filename + # Optional filename hint used to infer the extension when extension is omitted. + # + # @return [String, nil] + optional :filename, String + + # @!attribute include_images + # Include image references in Markdown output + # + # @return [Boolean, nil] + optional :include_images, ContextDev::Internal::Type::Boolean + + # @!attribute include_links + # Preserve hyperlinks in Markdown output + # + # @return [Boolean, nil] + optional :include_links, ContextDev::Internal::Type::Boolean + + # @!attribute ocr + # 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. + # + # @return [Boolean, nil] + optional :ocr, ContextDev::Internal::Type::Boolean + + # @!attribute pdf_end + # 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. + # + # @return [Integer, nil] + optional :pdf_end, Integer + + # @!attribute pdf_start + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + # + # @return [Integer, nil] + optional :pdf_start, Integer + + # @!attribute shorten_base64_images + # Shorten base64-encoded image data in the Markdown output + # + # @return [Boolean, nil] + optional :shorten_base64_images, ContextDev::Internal::Type::Boolean + + # @!attribute use_main_content_only + # Extract only the main content from HTML-like inputs + # + # @return [Boolean, nil] + optional :use_main_content_only, ContextDev::Internal::Type::Boolean + + # @!method initialize(body:, base_url: nil, extension: nil, filename: nil, include_images: nil, include_links: nil, ocr: nil, pdf_end: nil, pdf_start: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::ParseHandleParams} for more details. + # + # @param body [Pathname, StringIO, IO, String, ContextDev::FilePart] + # + # @param base_url [String] Optional HTTP(S) source document URL used to resolve relative links and image re + # + # @param extension [String] Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, md + # + # @param filename [String] Optional filename hint used to infer the extension when extension is omitted. + # + # @param include_images [Boolean] Include image references in Markdown output + # + # @param include_links [Boolean] Preserve hyperlinks in Markdown output + # + # @param ocr [Boolean] When true for PDF inputs, detect and OCR images embedded in the selected pages, + # + # @param pdf_end [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus + # + # @param pdf_start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page. + # + # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output + # + # @param use_main_content_only [Boolean] Extract only the main content from HTML-like inputs + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/context_dev/models/parse_handle_response.rb b/lib/context_dev/models/parse_handle_response.rb new file mode 100644 index 00000000..9ea71ae7 --- /dev/null +++ b/lib/context_dev/models/parse_handle_response.rb @@ -0,0 +1,132 @@ +# frozen_string_literal: true + +module ContextDev + module Models + # @see ContextDev::Resources::Parse#handle + class ParseHandleResponse < ContextDev::Internal::Type::BaseModel + # @!attribute markdown + # Input bytes converted to GitHub Flavored Markdown + # + # @return [String] + required :markdown, String + + # @!attribute success + # Indicates success + # + # @return [Boolean, ContextDev::Models::ParseHandleResponse::Success] + required :success, enum: -> { ContextDev::Models::ParseHandleResponse::Success } + + # @!attribute type + # Detected content type used for parsing + # + # @return [Symbol, ContextDev::Models::ParseHandleResponse::Type] + required :type, enum: -> { ContextDev::Models::ParseHandleResponse::Type } + + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::ParseHandleResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata } + + # @!method initialize(markdown:, success:, type:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::ParseHandleResponse} for more details. + # + # @param markdown [String] Input bytes converted to GitHub Flavored Markdown + # + # @param success [Boolean, ContextDev::Models::ParseHandleResponse::Success] Indicates success + # + # @param type [Symbol, ContextDev::Models::ParseHandleResponse::Type] Detected content type used for parsing + # + # @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + + # Indicates success + # + # @see ContextDev::Models::ParseHandleResponse#success + module Success + extend ContextDev::Internal::Type::Enum + + TRUE = true + + # @!method self.values + # @return [Array] + end + + # Detected content type used for parsing + # + # @see ContextDev::Models::ParseHandleResponse#type + module Type + extend ContextDev::Internal::Type::Enum + + HTML = :html + XML = :xml + JSON = :json + JSONL = :jsonl + TEXT = :text + CSV = :csv + TSV = :tsv + MARKDOWN = :markdown + YAML = :yaml + PYTHON = :python + JAVA = :java + JAVASCRIPT = :javascript + PHP = :php + SHELL = :shell + RUBY = :ruby + TYPESCRIPT = :typescript + RTF = :rtf + SRT = :srt + CSS = :css + SCSS = :scss + LESS = :less + STYLUS = :stylus + SASS = :sass + SVG = :svg + PDF = :pdf + DOCX = :docx + DOC = :doc + XLSX = :xlsx + XLS = :xls + PPTX = :pptx + PPT = :ppt + JPG = :jpg + PNG = :png + GIF = :gif + BMP = :bmp + TIFF = :tiff + WEBP = :webp + PPM = :ppm + PBM = :pbm + PGM = :pgm + PNM = :pnm + + # @!method self.values + # @return [Array] + end + + # @see ContextDev::Models::ParseHandleResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + end + end +end diff --git a/lib/context_dev/resources/parse.rb b/lib/context_dev/resources/parse.rb new file mode 100644 index 00000000..0e998fe7 --- /dev/null +++ b/lib/context_dev/resources/parse.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class Parse + # Some parameter documentations has been truncated, see + # {ContextDev::Models::ParseHandleParams} for more details. + # + # Converts raw text, source code, web/data, PDF, Microsoft Office, and image bytes + # into LLM-usable Markdown. + # + # @overload handle(body:, base_url: nil, extension: nil, filename: nil, include_images: nil, include_links: nil, ocr: nil, pdf_end: nil, pdf_start: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {}) + # + # @param body [Pathname, StringIO, IO, String, ContextDev::FilePart] Body param + # + # @param base_url [String] Query param: Optional HTTP(S) source document URL used to resolve relative links + # + # @param extension [String] Query param: Optional file extension hint, such as pdf, docx, xlsx, pptx, html, + # + # @param filename [String] Query param: Optional filename hint used to infer the extension when extension i + # + # @param include_images [Boolean] Query param: Include image references in Markdown output + # + # @param include_links [Boolean] Query param: Preserve hyperlinks in Markdown output + # + # @param ocr [Boolean] Query param: When true for PDF inputs, detect and OCR images embedded in the sel + # + # @param pdf_end [Integer] Query param: Last 1-based PDF page to parse. When omitted, parsing ends at the l + # + # @param pdf_start [Integer] Query param: First 1-based PDF page to parse. When omitted, parsing starts at th + # + # @param shorten_base64_images [Boolean] Query param: Shorten base64-encoded image data in the Markdown output + # + # @param use_main_content_only [Boolean] Query param: Extract only the main content from HTML-like inputs + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::ParseHandleResponse] + # + # @see ContextDev::Models::ParseHandleParams + def handle(params) + parsed, options = ContextDev::ParseHandleParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed.except(:body)) + @client.request( + method: :post, + path: "parse", + query: query, + headers: {"content-type" => "application/octet-stream"}, + body: parsed[:body], + model: ContextDev::Models::ParseHandleResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/rbi/context_dev/client.rbi b/rbi/context_dev/client.rbi index 663ea2ed..92268a1a 100644 --- a/rbi/context_dev/client.rbi +++ b/rbi/context_dev/client.rbi @@ -13,6 +13,9 @@ module ContextDev sig { returns(String) } attr_reader :api_key + sig { returns(ContextDev::Resources::Parse) } + attr_reader :parse + sig { returns(ContextDev::Resources::Web) } attr_reader :web diff --git a/rbi/context_dev/models.rbi b/rbi/context_dev/models.rbi index 6de7c548..a5523d3d 100644 --- a/rbi/context_dev/models.rbi +++ b/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 diff --git a/rbi/context_dev/models/parse_handle_params.rbi b/rbi/context_dev/models/parse_handle_params.rbi new file mode 100644 index 00000000..507d3579 --- /dev/null +++ b/rbi/context_dev/models/parse_handle_params.rbi @@ -0,0 +1,163 @@ +# typed: strong + +module ContextDev + module Models + class ParseHandleParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(ContextDev::ParseHandleParams, ContextDev::Internal::AnyHash) + end + + sig { returns(ContextDev::Internal::FileInput) } + attr_accessor :body + + # Optional HTTP(S) source document URL used to resolve relative links and image + # references. Relative references remain relative when omitted. + sig { returns(T.nilable(String)) } + attr_reader :base_url + + sig { params(base_url: String).void } + attr_writer :base_url + + # Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, + # md, py, rtf, jpg, png, or txt. + sig { returns(T.nilable(String)) } + attr_reader :extension + + sig { params(extension: String).void } + attr_writer :extension + + # Optional filename hint used to infer the extension when extension is omitted. + sig { returns(T.nilable(String)) } + attr_reader :filename + + sig { params(filename: String).void } + attr_writer :filename + + # Include image references in Markdown output + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_images + + sig { params(include_images: T::Boolean).void } + attr_writer :include_images + + # Preserve hyperlinks in Markdown output + sig { returns(T.nilable(T::Boolean)) } + attr_reader :include_links + + sig { params(include_links: T::Boolean).void } + attr_writer :include_links + + # 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. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :ocr + + sig { params(ocr: T::Boolean).void } + attr_writer :ocr + + # 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. + sig { returns(T.nilable(Integer)) } + attr_reader :pdf_end + + sig { params(pdf_end: Integer).void } + attr_writer :pdf_end + + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + sig { returns(T.nilable(Integer)) } + attr_reader :pdf_start + + sig { params(pdf_start: Integer).void } + attr_writer :pdf_start + + # Shorten base64-encoded image data in the Markdown output + sig { returns(T.nilable(T::Boolean)) } + attr_reader :shorten_base64_images + + sig { params(shorten_base64_images: T::Boolean).void } + attr_writer :shorten_base64_images + + # Extract only the main content from HTML-like inputs + sig { returns(T.nilable(T::Boolean)) } + attr_reader :use_main_content_only + + sig { params(use_main_content_only: T::Boolean).void } + attr_writer :use_main_content_only + + 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(T.attached_class) + end + def self.new( + body:, + # Optional HTTP(S) source document URL used to resolve relative links and image + # references. Relative references remain relative when omitted. + base_url: nil, + # Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, + # md, py, rtf, jpg, png, or txt. + extension: nil, + # Optional filename hint used to infer the extension when extension is omitted. + filename: nil, + # Include image references in Markdown output + include_images: nil, + # Preserve hyperlinks in Markdown output + include_links: nil, + # 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, + # 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, + # First 1-based PDF page to parse. When omitted, parsing starts at the first page. + pdf_start: nil, + # Shorten base64-encoded image data in the Markdown output + shorten_base64_images: nil, + # Extract only the main content from HTML-like inputs + use_main_content_only: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + 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 + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/context_dev/models/parse_handle_response.rbi b/rbi/context_dev/models/parse_handle_response.rbi new file mode 100644 index 00000000..a1f15fd2 --- /dev/null +++ b/rbi/context_dev/models/parse_handle_response.rbi @@ -0,0 +1,377 @@ +# typed: strong + +module ContextDev + module Models + class ParseHandleResponse < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::ParseHandleResponse, + ContextDev::Internal::AnyHash + ) + end + + # Input bytes converted to GitHub Flavored Markdown + sig { returns(String) } + attr_accessor :markdown + + # Indicates success + sig do + returns(ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean) + end + attr_accessor :success + + # Detected content type used for parsing + sig do + returns(ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol) + end + attr_accessor :type + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(ContextDev::Models::ParseHandleResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::ParseHandleResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + + sig do + params( + markdown: String, + success: ContextDev::Models::ParseHandleResponse::Success::OrBoolean, + type: ContextDev::Models::ParseHandleResponse::Type::OrSymbol, + key_metadata: + ContextDev::Models::ParseHandleResponse::KeyMetadata::OrHash + ).returns(T.attached_class) + end + def self.new( + # Input bytes converted to GitHub Flavored Markdown + markdown:, + # Indicates success + success:, + # Detected content type used for parsing + type:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil + ) + end + + sig do + override.returns( + { + markdown: String, + success: + ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean, + type: ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol, + key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata + } + ) + end + def to_hash + end + + # Indicates success + module Success + extend ContextDev::Internal::Type::Enum + + TaggedBoolean = + T.type_alias do + T.all(T::Boolean, ContextDev::Models::ParseHandleResponse::Success) + end + OrBoolean = T.type_alias { T::Boolean } + + TRUE = + T.let( + true, + ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean + ] + ) + end + def self.values + end + end + + # Detected content type used for parsing + module Type + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::Models::ParseHandleResponse::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HTML = + T.let( + :html, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + XML = + T.let( + :xml, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + JSON = + T.let( + :json, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + JSONL = + T.let( + :jsonl, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + TEXT = + T.let( + :text, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + CSV = + T.let( + :csv, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + TSV = + T.let( + :tsv, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + MARKDOWN = + T.let( + :markdown, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + YAML = + T.let( + :yaml, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PYTHON = + T.let( + :python, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + JAVA = + T.let( + :java, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + JAVASCRIPT = + T.let( + :javascript, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PHP = + T.let( + :php, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + SHELL = + T.let( + :shell, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + RUBY = + T.let( + :ruby, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + TYPESCRIPT = + T.let( + :typescript, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + RTF = + T.let( + :rtf, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + SRT = + T.let( + :srt, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + CSS = + T.let( + :css, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + SCSS = + T.let( + :scss, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + LESS = + T.let( + :less, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + STYLUS = + T.let( + :stylus, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + SASS = + T.let( + :sass, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + SVG = + T.let( + :svg, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PDF = + T.let( + :pdf, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + DOCX = + T.let( + :docx, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + DOC = + T.let( + :doc, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + XLSX = + T.let( + :xlsx, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + XLS = + T.let( + :xls, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PPTX = + T.let( + :pptx, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PPT = + T.let( + :ppt, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + JPG = + T.let( + :jpg, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PNG = + T.let( + :png, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + GIF = + T.let( + :gif, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + BMP = + T.let( + :bmp, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + TIFF = + T.let( + :tiff, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + WEBP = + T.let( + :webp, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PPM = + T.let( + :ppm, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PBM = + T.let( + :pbm, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PGM = + T.let( + :pgm, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + PNM = + T.let( + :pnm, + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::ParseHandleResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/context_dev/resources/parse.rbi b/rbi/context_dev/resources/parse.rbi new file mode 100644 index 00000000..47a64342 --- /dev/null +++ b/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 diff --git a/sig/context_dev/client.rbs b/sig/context_dev/client.rbs index 62cf92ed..396dd038 100644 --- a/sig/context_dev/client.rbs +++ b/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 diff --git a/sig/context_dev/models.rbs b/sig/context_dev/models.rbs index 5c2fff02..41201247 100644 --- a/sig/context_dev/models.rbs +++ b/sig/context_dev/models.rbs @@ -33,6 +33,8 @@ module ContextDev class MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams + class ParseHandleParams = ContextDev::Models::ParseHandleParams + class UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams class WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams diff --git a/sig/context_dev/models/parse_handle_params.rbs b/sig/context_dev/models/parse_handle_params.rbs new file mode 100644 index 00000000..41a06635 --- /dev/null +++ b/sig/context_dev/models/parse_handle_params.rbs @@ -0,0 +1,96 @@ +module ContextDev + module Models + type parse_handle_params = + { + body: ContextDev::Internal::file_input, + base_url: String, + extension: String, + filename: String, + include_images: bool, + include_links: bool, + ocr: bool, + pdf_end: Integer, + pdf_start: Integer, + :shorten_base64_images => bool, + use_main_content_only: bool + } + & ContextDev::Internal::Type::request_parameters + + class ParseHandleParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + attr_accessor body: ContextDev::Internal::file_input + + attr_reader base_url: String? + + def base_url=: (String) -> String + + attr_reader extension: String? + + def extension=: (String) -> String + + attr_reader filename: String? + + def filename=: (String) -> String + + attr_reader include_images: bool? + + def include_images=: (bool) -> bool + + attr_reader include_links: bool? + + def include_links=: (bool) -> bool + + attr_reader ocr: bool? + + def ocr=: (bool) -> bool + + attr_reader pdf_end: Integer? + + def pdf_end=: (Integer) -> Integer + + attr_reader pdf_start: Integer? + + def pdf_start=: (Integer) -> Integer + + attr_reader shorten_base64_images: bool? + + def shorten_base64_images=: (bool) -> bool + + attr_reader use_main_content_only: bool? + + def use_main_content_only=: (bool) -> bool + + def initialize: ( + body: ContextDev::Internal::file_input, + ?base_url: String, + ?extension: String, + ?filename: String, + ?include_images: bool, + ?include_links: bool, + ?ocr: bool, + ?pdf_end: Integer, + ?pdf_start: Integer, + ?shorten_base64_images: bool, + ?use_main_content_only: bool, + ?request_options: ContextDev::request_opts + ) -> void + + def to_hash: -> { + body: ContextDev::Internal::file_input, + base_url: String, + extension: String, + filename: String, + include_images: bool, + include_links: bool, + ocr: bool, + pdf_end: Integer, + pdf_start: Integer, + :shorten_base64_images => bool, + use_main_content_only: bool, + request_options: ContextDev::RequestOptions + } + end + end +end diff --git a/sig/context_dev/models/parse_handle_response.rbs b/sig/context_dev/models/parse_handle_response.rbs new file mode 100644 index 00000000..eb3a7caa --- /dev/null +++ b/sig/context_dev/models/parse_handle_response.rbs @@ -0,0 +1,159 @@ +module ContextDev + module Models + type parse_handle_response = + { + markdown: String, + success: ContextDev::Models::ParseHandleResponse::success, + type: ContextDev::Models::ParseHandleResponse::type_, + key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata + } + + class ParseHandleResponse < ContextDev::Internal::Type::BaseModel + attr_accessor markdown: String + + attr_accessor success: ContextDev::Models::ParseHandleResponse::success + + attr_accessor type: ContextDev::Models::ParseHandleResponse::type_ + + attr_reader key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::ParseHandleResponse::KeyMetadata + ) -> ContextDev::Models::ParseHandleResponse::KeyMetadata + + def initialize: ( + markdown: String, + success: ContextDev::Models::ParseHandleResponse::success, + type: ContextDev::Models::ParseHandleResponse::type_, + ?key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata + ) -> void + + def to_hash: -> { + markdown: String, + success: ContextDev::Models::ParseHandleResponse::success, + type: ContextDev::Models::ParseHandleResponse::type_, + key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata + } + + type success = true + + module Success + extend ContextDev::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[ContextDev::Models::ParseHandleResponse::success] + end + + type type_ = + :html + | :xml + | :json + | :jsonl + | :text + | :csv + | :tsv + | :markdown + | :yaml + | :python + | :java + | :javascript + | :php + | :shell + | :ruby + | :typescript + | :rtf + | :srt + | :css + | :scss + | :less + | :stylus + | :sass + | :svg + | :pdf + | :docx + | :doc + | :xlsx + | :xls + | :pptx + | :ppt + | :jpg + | :png + | :gif + | :bmp + | :tiff + | :webp + | :ppm + | :pbm + | :pgm + | :pnm + + module Type + extend ContextDev::Internal::Type::Enum + + HTML: :html + XML: :xml + JSON: :json + JSONL: :jsonl + TEXT: :text + CSV: :csv + TSV: :tsv + MARKDOWN: :markdown + YAML: :yaml + PYTHON: :python + JAVA: :java + JAVASCRIPT: :javascript + PHP: :php + SHELL: :shell + RUBY: :ruby + TYPESCRIPT: :typescript + RTF: :rtf + SRT: :srt + CSS: :css + SCSS: :scss + LESS: :less + STYLUS: :stylus + SASS: :sass + SVG: :svg + PDF: :pdf + DOCX: :docx + DOC: :doc + XLSX: :xlsx + XLS: :xls + PPTX: :pptx + PPT: :ppt + JPG: :jpg + PNG: :png + GIF: :gif + BMP: :bmp + TIFF: :tiff + WEBP: :webp + PPM: :ppm + PBM: :pbm + PGM: :pgm + PNM: :pnm + + def self?.values: -> ::Array[ContextDev::Models::ParseHandleResponse::type_] + end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + end + end +end diff --git a/sig/context_dev/resources/parse.rbs b/sig/context_dev/resources/parse.rbs new file mode 100644 index 00000000..f22b9fa6 --- /dev/null +++ b/sig/context_dev/resources/parse.rbs @@ -0,0 +1,22 @@ +module ContextDev + module Resources + class Parse + def handle: ( + body: ContextDev::Internal::file_input, + ?base_url: String, + ?extension: String, + ?filename: String, + ?include_images: bool, + ?include_links: bool, + ?ocr: bool, + ?pdf_end: Integer, + ?pdf_start: Integer, + ?shorten_base64_images: bool, + ?use_main_content_only: bool, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::ParseHandleResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/test/context_dev/resources/parse_test.rb b/test/context_dev/resources/parse_test.rb new file mode 100644 index 00000000..b9d98ec3 --- /dev/null +++ b/test/context_dev/resources/parse_test.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::ParseTest < ContextDev::Test::ResourceTest + def test_handle_required_params + skip("Mock server tests are disabled") + + response = @context_dev.parse.handle(body: StringIO.new("Example data")) + + assert_pattern do + response => ContextDev::Models::ParseHandleResponse + end + + assert_pattern do + response => { + markdown: String, + success: ContextDev::Models::ParseHandleResponse::Success, + type: ContextDev::Models::ParseHandleResponse::Type, + key_metadata: ContextDev::Models::ParseHandleResponse::KeyMetadata | nil + } + end + end +end From ee712d9b9f1a4e7c1338f5545bbfd1d105c3d036 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 12 Jul 2026 07:57:39 +0000 Subject: [PATCH 11/11] release: 2.3.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 14 ++++++++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/context_dev/version.rb | 2 +- 5 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index bfc26f9c..75ec52fc 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.2.0" + ".": "2.3.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 6291fb64..e97d8f56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## 2.3.0 (2026-07-12) + +Full Changelog: [v2.2.0...v2.3.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.2.0...v2.3.0) + +### Features + +* **api:** api update ([3fd9604](https://github.com/context-dot-dev/context-ruby-sdk/commit/3fd960488c341f082b6d312dda927aeee23dccff)) +* **api:** api update ([bdd3176](https://github.com/context-dot-dev/context-ruby-sdk/commit/bdd3176c7f507880adb7becae314b816c6bbe9bc)) +* **api:** api update ([d68d31d](https://github.com/context-dot-dev/context-ruby-sdk/commit/d68d31dc5aa77ad154789b6cf91e0b8558353214)) +* **api:** api update ([d4c601e](https://github.com/context-dot-dev/context-ruby-sdk/commit/d4c601ea30aa1d47ef041d0439ab8b5d976cc8e2)) +* **api:** api update ([03fa3ac](https://github.com/context-dot-dev/context-ruby-sdk/commit/03fa3ac3c7c61aba88846db890bf4d3fd22d1086)) +* **api:** api update ([626d105](https://github.com/context-dot-dev/context-ruby-sdk/commit/626d1054da9622e88469bb9c3b755f43d1d75280)) +* **api:** manual updates ([b7f6b2c](https://github.com/context-dot-dev/context-ruby-sdk/commit/b7f6b2c0a5bb91cc065bcc2ef497c9999414262c)) + ## 2.2.0 (2026-07-10) Full Changelog: [v2.1.0...v2.2.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.1.0...v2.2.0) diff --git a/Gemfile.lock b/Gemfile.lock index 21c9bee4..c76e641d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (2.2.0) + context.dev (2.3.0) cgi connection_pool diff --git a/README.md b/README.md index da568522..a54389e3 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 2.2.0" +gem "context.dev", "~> 2.3.0" ``` diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 227c96cd..59db45d2 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "2.2.0" + VERSION = "2.3.0" end