context.dev 2.17.1 → 2.19.0

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