context.dev 2.14.0 → 2.15.0

data/lib/context_dev/models/web_web_scrape_images_response.rb

@@ -40,8 +40,7 @@ module ContextDev
                api_name: :actionsApplied
 
       # @!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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
@@ -60,7 +59,7 @@ module ContextDev
       #
       #   @param actions_applied [Array<ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
       #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebScrapeImagesResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -337,24 +336,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_web_scrape_md_params.rb

@@ -111,9 +111,8 @@ module ContextDev
       optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -181,7 +180,7 @@ module ContextDev
       #
       #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_web_scrape_md_response.rb

@@ -68,8 +68,7 @@ module ContextDev
       optional :html, String
 
       # @!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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
@@ -96,7 +95,7 @@ module ContextDev
       #
       #   @param html [String] Only present when includeHTML=true: the page HTML the Markdown was converted fro
       #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebScrapeMdResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -505,24 +504,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebScrapeMdResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/web_web_scrape_sitemap_params.rb

@@ -51,9 +51,8 @@ module ContextDev
       optional :sitemap_url, String
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -98,7 +97,7 @@ module ContextDev
       #
       #   @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/web_web_scrape_sitemap_response.rb

@@ -30,8 +30,7 @@ module ContextDev
       required :urls, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
@@ -48,7 +47,7 @@ module ContextDev
       #
       #   @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
       #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
       class Meta < ContextDev::Internal::Type::BaseModel
@@ -103,24 +102,23 @@ module ContextDev
       # @see ContextDev::Models::WebWebScrapeSitemapResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/webhook_delivery.rb

@@ -41,7 +41,13 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebhookDelivery::Status]
       required :status, enum: -> { ContextDev::WebhookDelivery::Status }
 
-      # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:)
+      # @!attribute delivery_id
+      #   Delivery ID for status checks and retries, when available.
+      #
+      #   @return [String, nil]
+      optional :delivery_id, String
+
+      # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:, delivery_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebhookDelivery} for more details.
       #
@@ -56,6 +62,8 @@ module ContextDev
       #   @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
+      #
+      #   @param delivery_id [String] Delivery ID for status checks and retries, when available.
 
       # @see ContextDev::Models::WebhookDelivery#error
       class Error < ContextDev::Internal::Type::BaseModel

data/lib/context_dev/models/webhooks/attempt.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      class Attempt < ContextDev::Internal::Type::BaseModel
+        # @!attribute attempt
+        #   Attempt number, starting at 1.
+        #
+        #   @return [Integer]
+        required :attempt, Integer
+
+        # @!attribute completed_at
+        #   Completion time, or null while in progress.
+        #
+        #   @return [Time, nil]
+        required :completed_at, Time, nil?: true
+
+        # @!attribute error
+        #   Attempt error, or null if none.
+        #
+        #   @return [ContextDev::Models::Webhooks::Attempt::Error, nil]
+        required :error, -> { ContextDev::Webhooks::Attempt::Error }, nil?: true
+
+        # @!attribute http_status
+        #   HTTP response status, or null if no response was received.
+        #
+        #   @return [Integer, nil]
+        required :http_status, Integer, nil?: true
+
+        # @!attribute started_at
+        #   Attempt start time.
+        #
+        #   @return [Time]
+        required :started_at, Time
+
+        # @!attribute trigger
+        #   What started this attempt.
+        #
+        #   @return [Symbol, ContextDev::Models::Webhooks::Attempt::Trigger]
+        required :trigger, enum: -> { ContextDev::Webhooks::Attempt::Trigger }
+
+        # @!attribute url
+        #   URL used for this attempt.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(attempt:, completed_at:, error:, http_status:, started_at:, trigger:, url:)
+        #   @param attempt [Integer] Attempt number, starting at 1.
+        #
+        #   @param completed_at [Time, nil] Completion time, or null while in progress.
+        #
+        #   @param error [ContextDev::Models::Webhooks::Attempt::Error, nil] Attempt error, or null if none.
+        #
+        #   @param http_status [Integer, nil] HTTP response status, or null if no response was received.
+        #
+        #   @param started_at [Time] Attempt start time.
+        #
+        #   @param trigger [Symbol, ContextDev::Models::Webhooks::Attempt::Trigger] What started this attempt.
+        #
+        #   @param url [String] URL used for this attempt.
+
+        # @see ContextDev::Models::Webhooks::Attempt#error
+        class Error < ContextDev::Internal::Type::BaseModel
+          # @!attribute code
+          #   Error code.
+          #
+          #   @return [String]
+          required :code, String
+
+          # @!attribute message
+          #   Error details.
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!method initialize(code:, message:)
+          #   Attempt error, or null if none.
+          #
+          #   @param code [String] Error code.
+          #
+          #   @param message [String] Error details.
+        end
+
+        # What started this attempt.
+        #
+        # @see ContextDev::Models::Webhooks::Attempt#trigger
+        module Trigger
+          extend ContextDev::Internal::Type::Enum
+
+          INITIAL = :initial
+          AUTOMATIC = :automatic
+          MANUAL = :manual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      class Delivery < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #   Delivery ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   Event creation time.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute delivered_at
+        #   Last successful delivery time, or null if never delivered.
+        #
+        #   @return [Time, nil]
+        required :delivered_at, Time, nil?: true
+
+        # @!attribute event
+        #   Webhook event type.
+        #
+        #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Event]
+        required :event, enum: -> { ContextDev::Webhooks::Delivery::Event }
+
+        # @!attribute event_id
+        #   Stable event ID for deduplicating received webhooks.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute last_attempt
+        #   Latest attempt, or null if none.
+        #
+        #   @return [ContextDev::Models::Webhooks::Attempt, nil]
+        required :last_attempt, -> { ContextDev::Webhooks::Attempt }, nil?: true
+
+        # @!attribute last_error
+        #   Latest delivery error, or null if none.
+        #
+        #   @return [ContextDev::Models::Webhooks::Delivery::LastError, nil]
+        required :last_error, -> { ContextDev::Webhooks::Delivery::LastError }, nil?: true
+
+        # @!attribute next_attempt_at
+        #   Next scheduled attempt, or null if none.
+        #
+        #   @return [Time, nil]
+        required :next_attempt_at, Time, nil?: true
+
+        # @!attribute retry_
+        #   Webhook retry settings. Use {} for the default schedule.
+        #
+        #   @return [ContextDev::Models::RetryConfig]
+        required :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
+
+        # @!attribute retry_expires_at
+        #   Manual retry deadline, seven days after event creation.
+        #
+        #   @return [Time]
+        required :retry_expires_at, Time
+
+        # @!attribute source
+        #   Batch or monitor run that produced the event.
+        #
+        #   @return [ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor]
+        required :source, union: -> { ContextDev::Webhooks::Delivery::Source }
+
+        # @!attribute status
+        #   Current delivery status.
+        #
+        #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Status]
+        required :status, enum: -> { ContextDev::Webhooks::Delivery::Status }
+
+        # @!attribute url
+        #   Webhook destination URL.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, created_at:, delivered_at:, event:, event_id:, last_attempt:, last_error:, next_attempt_at:, retry_:, retry_expires_at:, source:, status:, url:)
+        #   @param id [String] Delivery ID.
+        #
+        #   @param created_at [Time] Event creation time.
+        #
+        #   @param delivered_at [Time, nil] Last successful delivery time, or null if never delivered.
+        #
+        #   @param event [Symbol, ContextDev::Models::Webhooks::Delivery::Event] Webhook event type.
+        #
+        #   @param event_id [String] Stable event ID for deduplicating received webhooks.
+        #
+        #   @param last_attempt [ContextDev::Models::Webhooks::Attempt, nil] Latest attempt, or null if none.
+        #
+        #   @param last_error [ContextDev::Models::Webhooks::Delivery::LastError, nil] Latest delivery error, or null if none.
+        #
+        #   @param next_attempt_at [Time, nil] Next scheduled attempt, or null if none.
+        #
+        #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
+        #
+        #   @param retry_expires_at [Time] Manual retry deadline, seven days after event creation.
+        #
+        #   @param source [ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor] Batch or monitor run that produced the event.
+        #
+        #   @param status [Symbol, ContextDev::Models::Webhooks::Delivery::Status] Current delivery status.
+        #
+        #   @param url [String] Webhook destination URL.
+
+        # Webhook event type.
+        #
+        # @see ContextDev::Models::Webhooks::Delivery#event
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          BATCH_COMPLETED = :"batch.completed"
+          BATCH_FAILED = :"batch.failed"
+          BATCH_CANCELLED = :"batch.cancelled"
+          CHANGE_DETECTED = :"change.detected"
+          RUN_COMPLETED = :"run.completed"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see ContextDev::Models::Webhooks::Delivery#last_error
+        class LastError < ContextDev::Internal::Type::BaseModel
+          # @!attribute code
+          #   Error code.
+          #
+          #   @return [String]
+          required :code, String
+
+          # @!attribute message
+          #   Error details.
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!method initialize(code:, message:)
+          #   Latest delivery error, or null if none.
+          #
+          #   @param code [String] Error code.
+          #
+          #   @param message [String] Error details.
+        end
+
+        # Batch or monitor run that produced the event.
+        #
+        # @see ContextDev::Models::Webhooks::Delivery#source
+        module Source
+          extend ContextDev::Internal::Type::Union
+
+          variant -> { ContextDev::Webhooks::Delivery::Source::Batch }
+
+          variant -> { ContextDev::Webhooks::Delivery::Source::Monitor }
+
+          class Batch < ContextDev::Internal::Type::BaseModel
+            # @!attribute batch_id
+            #   Batch ID.
+            #
+            #   @return [String]
+            required :batch_id, String
+
+            # @!attribute type
+            #   Delivery source.
+            #
+            #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type]
+            required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Batch::Type }
+
+            # @!method initialize(batch_id:, type:)
+            #   @param batch_id [String] Batch ID.
+            #
+            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type] Delivery source.
+
+            # Delivery source.
+            #
+            # @see ContextDev::Models::Webhooks::Delivery::Source::Batch#type
+            module Type
+              extend ContextDev::Internal::Type::Enum
+
+              BATCH = :batch
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Monitor < ContextDev::Internal::Type::BaseModel
+            # @!attribute monitor_id
+            #   Monitor ID.
+            #
+            #   @return [String]
+            required :monitor_id, String
+
+            # @!attribute run_id
+            #   Monitor run ID.
+            #
+            #   @return [String]
+            required :run_id, String
+
+            # @!attribute type
+            #   Delivery source.
+            #
+            #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type]
+            required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Monitor::Type }
+
+            # @!method initialize(monitor_id:, run_id:, type:)
+            #   @param monitor_id [String] Monitor ID.
+            #
+            #   @param run_id [String] Monitor run ID.
+            #
+            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type] Delivery source.
+
+            # Delivery source.
+            #
+            # @see ContextDev::Models::Webhooks::Delivery::Source::Monitor#type
+            module Type
+              extend ContextDev::Internal::Type::Enum
+
+              MONITOR = :monitor
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor)]
+        end
+
+        # Current delivery status.
+        #
+        # @see ContextDev::Models::Webhooks::Delivery#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          PENDING = :pending
+          DELIVERING = :delivering
+          RETRYING = :retrying
+          DELIVERED = :delivered
+          FAILED = :failed
+          CANCELLED = :cancelled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#list_attempts
+      class DeliveryListAttemptsParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        # @!attribute delivery_id
+        #   Delivery ID.
+        #
+        #   @return [String]
+        required :delivery_id, String
+
+        # @!attribute cursor
+        #   The next_cursor from the previous response.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #   Number of attempts to return.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute tags
+        #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        #   characters.
+        #
+        #   @return [Array<String>, nil]
+        optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(delivery_id:, cursor: nil, limit: nil, tags: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryListAttemptsParams} for more details.
+        #
+        #   @param delivery_id [String] Delivery ID.
+        #
+        #   @param cursor [String] The next_cursor from the previous response.
+        #
+        #   @param limit [Integer] Number of attempts to return.
+        #
+        #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        #
+        #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end