context.dev 2.18.0 → 2.19.0

data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi}

@@ -2,16 +2,13 @@
 
 module ContextDev
   module Models
-    class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel
+    class WebMapURLsParams < ContextDev::Internal::Type::BaseModel
       extend ContextDev::Internal::Type::RequestParameters::Converter
       include ContextDev::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(
-            ContextDev::WebWebScrapeSitemapParams,
-            ContextDev::Internal::AnyHash
-          )
+          T.any(ContextDev::WebMapURLsParams, ContextDev::Internal::AnyHash)
         end
 
       # Domain to build a sitemap for
@@ -71,15 +68,12 @@ module ContextDev
       # Optional request deadline and behavior on timeout. For GET requests, use
       # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
       # timeoutOpts object.
-      sig do
-        returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::TimeoutOpts))
-      end
+      sig { returns(T.nilable(ContextDev::WebMapURLsParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
       sig do
         params(
-          timeout_opts:
-            ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash
+          timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts::OrHash
         ).void
       end
       attr_writer :timeout_opts
@@ -97,14 +91,10 @@ module ContextDev
       # omitted. Requires zero data retention to be enabled for your organization
       # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
       # Successful ZDR responses include X-Context-ZDR: true.
-      sig do
-        returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol))
-      end
+      sig { returns(T.nilable(ContextDev::WebMapURLsParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
-      sig do
-        params(zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol).void
-      end
+      sig { params(zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol).void }
       attr_writer :zdr
 
       sig do
@@ -116,10 +106,9 @@ module ContextDev
           search: String,
           sitemap_url: String,
           tags: T::Array[String],
-          timeout_opts:
-            ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash,
+          timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts::OrHash,
           url_regex: String,
-          zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
+          zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -173,9 +162,9 @@ module ContextDev
             search: String,
             sitemap_url: String,
             tags: T::Array[String],
-            timeout_opts: ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
+            timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts,
             url_regex: String,
-            zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
+            zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -187,7 +176,7 @@ module ContextDev
         OrHash =
           T.type_alias do
             T.any(
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
+              ContextDev::WebMapURLsParams::TimeoutOpts,
               ContextDev::Internal::AnyHash
             )
           end
@@ -203,7 +192,7 @@ module ContextDev
         sig do
           returns(
             T.nilable(
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
+              ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
             )
           )
         end
@@ -212,7 +201,7 @@ module ContextDev
         sig do
           params(
             behavior:
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
+              ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
           ).void
         end
         attr_writer :behavior
@@ -224,7 +213,7 @@ module ContextDev
           params(
             milliseconds: Integer,
             behavior:
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
+              ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
@@ -243,7 +232,7 @@ module ContextDev
             {
               milliseconds: Integer,
               behavior:
-                ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
+                ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
             }
           )
         end
@@ -259,28 +248,25 @@ module ContextDev
 
           TaggedSymbol =
             T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior
-              )
+              T.all(Symbol, ContextDev::WebMapURLsParams::TimeoutOpts::Behavior)
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           FAIL =
             T.let(
               :fail,
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
+              ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
             )
           RETURN_PARTIAL =
             T.let(
               :"return-partial",
-              ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
+              ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
             )
 
           sig do
             override.returns(
               T::Array[
-                ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
+                ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
               ]
             )
           end
@@ -298,25 +284,17 @@ module ContextDev
         extend ContextDev::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, ContextDev::WebWebScrapeSitemapParams::Zdr)
-          end
+          T.type_alias { T.all(Symbol, ContextDev::WebMapURLsParams::Zdr) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         ENABLED =
-          T.let(
-            :enabled,
-            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
-          )
+          T.let(:enabled, ContextDev::WebMapURLsParams::Zdr::TaggedSymbol)
         DISABLED =
-          T.let(
-            :disabled,
-            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
-          )
+          T.let(:disabled, ContextDev::WebMapURLsParams::Zdr::TaggedSymbol)
 
         sig do
           override.returns(
-            T::Array[ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol]
+            T::Array[ContextDev::WebMapURLsParams::Zdr::TaggedSymbol]
           )
         end
         def self.values

data/rbi/context_dev/models/web_map_urls_response.rbi

@@ -0,0 +1,226 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebMapURLsResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebMapURLsResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      sig do
+        returns(ContextDev::Models::WebMapURLsResponse::Success::TaggedBoolean)
+      end
+      attr_accessor :success
+
+      sig { returns(T::Array[ContextDev::Models::WebMapURLsResponse::URL]) }
+      attr_accessor :urls
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(T.nilable(ContextDev::Models::WebMapURLsResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebMapURLsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
+      sig do
+        params(
+          domain: String,
+          request_id: String,
+          success: ContextDev::Models::WebMapURLsResponse::Success::OrBoolean,
+          urls: T::Array[ContextDev::Models::WebMapURLsResponse::URL::OrHash],
+          key_metadata:
+            ContextDev::Models::WebMapURLsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        domain:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
+        success:,
+        urls:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil,
+        partial: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            domain: String,
+            request_id: String,
+            success:
+              ContextDev::Models::WebMapURLsResponse::Success::TaggedBoolean,
+            urls: T::Array[ContextDev::Models::WebMapURLsResponse::URL],
+            key_metadata: ContextDev::Models::WebMapURLsResponse::KeyMetadata,
+            partial: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, ContextDev::Models::WebMapURLsResponse::Success)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            ContextDev::Models::WebMapURLsResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebMapURLsResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class URL < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebMapURLsResponse::URL,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :keywords
+
+        sig { params(keywords: T::Array[String]).void }
+        attr_writer :keywords
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :title
+
+        sig { params(title: String).void }
+        attr_writer :title
+
+        sig do
+          params(
+            url: String,
+            description: String,
+            keywords: T::Array[String],
+            language: String,
+            title: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          url:,
+          description: nil,
+          keywords: nil,
+          language: nil,
+          title: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              url: String,
+              description: String,
+              keywords: T::Array[String],
+              language: String,
+              title: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebMapURLsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits used by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits used by this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end