context.dev 2.18.0 → 2.20.0

data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb}

@@ -2,8 +2,8 @@
 
 module ContextDev
   module Models
-    # @see ContextDev::Resources::Web#web_scrape_sitemap
-    class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel
+    # @see ContextDev::Resources::Web#map_urls
+    class WebMapURLsParams < ContextDev::Internal::Type::BaseModel
       extend ContextDev::Internal::Type::RequestParameters::Converter
       include ContextDev::Internal::Type::RequestParameters
 
@@ -62,8 +62,8 @@ module ContextDev
       #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
       #   timeoutOpts object.
       #
-      #   @return [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts, nil]
-      optional :timeout_opts, -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts }
+      #   @return [ContextDev::Models::WebMapURLsParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebMapURLsParams::TimeoutOpts }
 
       # @!attribute url_regex
       #   Optional RE2-compatible regex pattern. Only URLs matching this pattern are
@@ -79,12 +79,12 @@ module ContextDev
       #   (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
       #   Successful ZDR responses include X-Context-ZDR: true.
       #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
-      optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
+      #   @return [Symbol, ContextDev::Models::WebMapURLsParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebMapURLsParams::Zdr }
 
       # @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_opts: nil, url_regex: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
+      #   {ContextDev::Models::WebMapURLsParams} for more details.
       #
       #   @param domain [String] Domain to build a sitemap for
       #
@@ -100,11 +100,11 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_opts [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::WebMapURLsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
       #
-      #   @param zdr [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::WebMapURLsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -121,12 +121,12 @@ module ContextDev
         #   available, the request still fails without charging credits. Partial results are
         #   not cached as complete results.
         #
-        #   @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior, nil]
-        optional :behavior, enum: -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior }
+        #   @return [Symbol, ContextDev::Models::WebMapURLsParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebMapURLsParams::TimeoutOpts::Behavior }
 
         # @!method initialize(milliseconds:, behavior: nil)
         #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts} for more details.
+        #   {ContextDev::Models::WebMapURLsParams::TimeoutOpts} for more details.
         #
         #   Optional request deadline and behavior on timeout. For GET requests, use
         #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
@@ -134,14 +134,14 @@ module ContextDev
         #
         #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
         #
-        #   @param behavior [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::WebMapURLsParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
 
         # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
         # credits. "return-partial" returns usable results collected so far; if none are
         # available, the request still fails without charging credits. Partial results are
         # not cached as complete results.
         #
-        # @see ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts#behavior
+        # @see ContextDev::Models::WebMapURLsParams::TimeoutOpts#behavior
         module Behavior
           extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/web_map_urls_response.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Web#map_urls
+    class WebMapURLsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute domain
+      #
+      #   @return [String]
+      required :domain, 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 success
+      #
+      #   @return [Boolean, ContextDev::Models::WebMapURLsResponse::Success]
+      required :success, enum: -> { ContextDev::Models::WebMapURLsResponse::Success }
+
+      # @!attribute urls
+      #
+      #   @return [Array<ContextDev::Models::WebMapURLsResponse::URL>]
+      required :urls, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebMapURLsResponse::URL] }
+
+      # @!attribute key_metadata
+      #   Credit usage, included whenever a valid API key is provided.
+      #
+      #   @return [ContextDev::Models::WebMapURLsResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebMapURLsResponse::KeyMetadata }
+
+      # @!attribute partial
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(domain:, request_id:, success:, urls:, key_metadata: nil, partial: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebMapURLsResponse} for more details.
+      #
+      #   @param domain [String]
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
+      #   @param success [Boolean, ContextDev::Models::WebMapURLsResponse::Success]
+      #
+      #   @param urls [Array<ContextDev::Models::WebMapURLsResponse::URL>]
+      #
+      #   @param key_metadata [ContextDev::Models::WebMapURLsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean]
+
+      # @see ContextDev::Models::WebMapURLsResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+
+      class URL < ContextDev::Internal::Type::BaseModel
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute keywords
+        #
+        #   @return [Array<String>, nil]
+        optional :keywords, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute language
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!method initialize(url:, description: nil, keywords: nil, language: nil, title: nil)
+        #   @param url [String]
+        #   @param description [String]
+        #   @param keywords [Array<String>]
+        #   @param language [String]
+        #   @param title [String]
+      end
+
+      # @see ContextDev::Models::WebMapURLsResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   Credits used by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   Credits remaining for your organization.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @param credits_consumed [Integer] Credits used by this request.
+        #
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
+      end
+    end
+  end
+end