context.dev 2.15.0 → 2.17.0

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

@@ -5,13 +5,25 @@ module ContextDev
     module Webhooks
       # @see ContextDev::Resources::Webhooks::Deliveries#retrieve
       class DeliveryRetrieveResponse < ContextDev::Models::Webhooks::Delivery
+        # @!attribute request_id
+        #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   it when contacting support about a failed request.
+        #
+        #   @return [String]
+        required :request_id, String
+
         # @!attribute key_metadata
         #   Credit usage, included whenever a valid API key is provided.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata }
 
-        # @!method initialize(key_metadata: nil)
+        # @!method initialize(request_id:, key_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryRetrieveResponse} for more details.
+        #
+        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #
         #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
         class KeyMetadata < ContextDev::Internal::Type::BaseModel

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

@@ -11,15 +11,27 @@ module ContextDev
         #   @return [String]
         required :id, String
 
+        # @!attribute request_id
+        #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   it when contacting support about a failed request.
+        #
+        #   @return [String]
+        required :request_id, String
+
         # @!attribute key_metadata
         #   Credit usage, included whenever a valid API key is provided.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata }
 
-        # @!method initialize(id:, key_metadata: nil)
+        # @!method initialize(id:, request_id:, key_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryRetryResponse} for more details.
+        #
         #   @param id [String] Delivery ID.
         #
+        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #
         #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
         # @see ContextDev::Models::Webhooks::DeliveryRetryResponse#key_metadata

data/lib/context_dev/models.rb

@@ -71,6 +71,10 @@ module ContextDev
 
   Intake = ContextDev::Models::Intake
 
+  LogListParams = ContextDev::Models::LogListParams
+
+  LogRetrieveParams = ContextDev::Models::LogRetrieveParams
+
   MonitorCreateParams = ContextDev::Models::MonitorCreateParams
 
   MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
@@ -109,6 +113,8 @@ module ContextDev
 
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 
+  WebAnswersParams = ContextDev::Models::WebAnswersParams
+
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
 
   WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
@@ -127,6 +133,8 @@ module ContextDev
 
   WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
 
+  WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
+
   WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
 
   WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams

data/lib/context_dev/resources/ai.rb

@@ -9,7 +9,7 @@ module ContextDev
       # Given a single URL, determines if it is a product page and extracts the product
       # information.
       #
-      # @overload extract_product(url:, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload extract_product(url:, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param url [String] The product page URL to extract product data from.
       #
@@ -17,7 +17,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::AIExtractProductParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/brand.rb

@@ -36,7 +36,7 @@ module ContextDev
       # information: domain, title, colors, logos, and backdrops. Optimized for faster
       # responses and reduced data transfer.
       #
-      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve simplified brand data for
       #
@@ -46,7 +46,7 @@ module ContextDev
       #
       # @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -59,7 +59,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-simplified",
-          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_opts: "timeoutOpts"),
           model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
           options: options
         )

data/lib/context_dev/resources/industry.rb

@@ -8,7 +8,7 @@ module ContextDev
       #
       # Classify any brand into 2022 NAICS industry codes from its domain or name.
       #
-      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided,
       #
@@ -18,7 +18,7 @@ module ContextDev
       #
       # @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
+      # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -34,7 +34,7 @@ module ContextDev
           query: query.transform_keys(
             max_results: "maxResults",
             min_results: "minResults",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::IndustryRetrieveNaicsResponse,
           options: options
@@ -48,7 +48,7 @@ module ContextDev
       # domain or name. Choose between the original SIC system (`original_sic`) or the
       # latest SIC list maintained by the SEC (`latest_sec`).
       #
-      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, type: nil, request_options: {})
+      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve SIC code for. If a valid domain is provided, i
       #
@@ -58,7 +58,7 @@ module ContextDev
       #
       # @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
+      # @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
       #
@@ -76,7 +76,7 @@ module ContextDev
           query: query.transform_keys(
             max_results: "maxResults",
             min_results: "minResults",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::IndustryRetrieveSicResponse,
           options: options

data/lib/context_dev/resources/logs.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    # Read your organization's API request logs to debug failed calls. These endpoints
+    # cost no credits and use a separate rate limit.
+    class Logs
+      # Get one logged API call, including its request input and response body.
+      #
+      # @overload retrieve(request_id, request_options: {})
+      #
+      # @param request_id [String] The request ID of the logged API call.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::LogRetrieveResponse]
+      #
+      # @see ContextDev::Models::LogRetrieveParams
+      def retrieve(request_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["logs/%1$s", request_id],
+          model: ContextDev::Models::LogRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::LogListParams} for more details.
+      #
+      # List your organization's API requests, newest first. Defaults to the last 24
+      # hours.
+      #
+      # @overload list(error_code: nil, errors_only: nil, from: nil, key_id: nil, limit: nil, page: nil, path: nil, search: nil, status_code: nil, tags: nil, to: nil, request_options: {})
+      #
+      # @param error_code [String] Filter by the `error_code` returned in the response.
+      #
+      # @param errors_only [Boolean] Only include requests that returned a 4xx or 5xx status.
+      #
+      # @param from [Time] Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
+      #
+      # @param key_id [String] Filter by the API key that made the request.
+      #
+      # @param limit [Integer] Number of log entries per page.
+      #
+      # @param page [Integer] Page number, starting at 1.
+      #
+      # @param path [String] Filter by endpoint path, with or without the /v1 prefix.
+      #
+      # @param search [String] Case-insensitive substring match against the request query and body, e.g. a doma
+      #
+      # @param status_code [Integer] Filter by exact HTTP status code.
+      #
+      # @param tags [String] Comma-separated request tags. Matches requests carrying any of them. Up to 20 ta
+      #
+      # @param to [Time] Only include requests at or before this ISO 8601 timestamp. Defaults to now.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::LogListResponse]
+      #
+      # @see ContextDev::Models::LogListParams
+      def list(params = {})
+        parsed, options = ContextDev::LogListParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "logs",
+          query: query,
+          model: ContextDev::Models::LogListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/people.rb

@@ -11,7 +11,7 @@ module ContextDev
       # plans. Successful requests cost 20 credits. Disposable and free email addresses
       # (like gmail.com, yahoo.com) will throw a 422 error.
       #
-      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param company [ContextDev::Models::PersonEnrichParams::Company]
       #
@@ -27,7 +27,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/utility.rb

@@ -12,7 +12,7 @@ module ContextDev
       # or an email whose domain is extracted and validated (free email providers and
       # disposable email addresses are not allowed).
       #
-      # @overload prefetch(identifier:, type:, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload prefetch(identifier:, type:, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param identifier [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier] Identifier of the target to prefetch. Provide exactly one of domain or email.
       #
@@ -20,7 +20,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #