context.dev 1.36.0 → 2.0.0

data/lib/context_dev/models/utility_prefetch_by_email_params.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Utility#prefetch_by_email
-    class UtilityPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute email
-      #   Email address to prefetch brand data for. The domain will be extracted from the
-      #   email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
-      #   addresses are not allowed.
-      #
-      #   @return [String]
-      required :email, String
-
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
-      #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
-
-      # @!method initialize(email:, timeout_ms: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::UtilityPrefetchByEmailParams} for more details.
-      #
-      #   @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
-      #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/context_dev/models/utility_prefetch_by_email_response.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Utility#prefetch_by_email
-    class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel
-      # @!attribute domain
-      #   The domain that was queued for prefetching
-      #
-      #   @return [String, nil]
-      optional :domain, 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.
-      #
-      #   @return [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata }
-
-      # @!attribute message
-      #   Success message
-      #
-      #   @return [String, nil]
-      optional :message, String
-
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::UtilityPrefetchByEmailResponse} for more details.
-      #
-      #   @param domain [String] The domain that was queued for prefetching
-      #
-      #   @param key_metadata [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
-      #
-      #   @param message [String] Success message
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-
-      # @see ContextDev::Models::UtilityPrefetchByEmailResponse#key_metadata
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
-        #
-        #   @return [Integer]
-        required :credits_consumed, Integer
-
-        # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
-        #
-        #   @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.
-        #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
-        #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
-      end
-    end
-  end
-end

data/rbi/context_dev/models/ai_ai_query_params.rbi

@@ -1,504 +0,0 @@
-# typed: strong
-
-module ContextDev
-  module Models
-    class AIAIQueryParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(ContextDev::AIAIQueryParams, ContextDev::Internal::AnyHash)
-        end
-
-      # Array of data points to extract from the website
-      sig { returns(T::Array[ContextDev::AIAIQueryParams::DataToExtract]) }
-      attr_accessor :data_to_extract
-
-      # The domain name to analyze
-      sig { returns(String) }
-      attr_accessor :domain
-
-      # Optional object specifying which pages to analyze
-      sig { returns(T.nilable(ContextDev::AIAIQueryParams::SpecificPages)) }
-      attr_reader :specific_pages
-
-      sig do
-        params(
-          specific_pages: ContextDev::AIAIQueryParams::SpecificPages::OrHash
-        ).void
-      end
-      attr_writer :specific_pages
-
-      # Optional timeout in milliseconds for the request. If the request takes longer
-      # than this value, it will be aborted with a 408 status code. Maximum allowed
-      # value is 300000ms (5 minutes).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
-
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
-
-      sig do
-        params(
-          data_to_extract:
-            T::Array[ContextDev::AIAIQueryParams::DataToExtract::OrHash],
-          domain: String,
-          specific_pages: ContextDev::AIAIQueryParams::SpecificPages::OrHash,
-          timeout_ms: Integer,
-          request_options: ContextDev::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Array of data points to extract from the website
-        data_to_extract:,
-        # The domain name to analyze
-        domain:,
-        # Optional object specifying which pages to analyze
-        specific_pages: nil,
-        # Optional timeout in milliseconds for the request. If the request takes longer
-        # than this value, it will be aborted with a 408 status code. Maximum allowed
-        # value is 300000ms (5 minutes).
-        timeout_ms: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            data_to_extract:
-              T::Array[ContextDev::AIAIQueryParams::DataToExtract],
-            domain: String,
-            specific_pages: ContextDev::AIAIQueryParams::SpecificPages,
-            timeout_ms: Integer,
-            request_options: ContextDev::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class DataToExtract < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::AIAIQueryParams::DataToExtract,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Description of what to extract
-        sig { returns(String) }
-        attr_accessor :datapoint_description
-
-        # Example of the expected value
-        sig { returns(String) }
-        attr_accessor :datapoint_example
-
-        # Name of the data point to extract
-        sig { returns(String) }
-        attr_accessor :datapoint_name
-
-        # Type of the data point
-        sig do
-          returns(
-            ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol
-          )
-        end
-        attr_accessor :datapoint_type
-
-        # Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
-        # Use 'object' to extract an array of objects matching a schema.
-        sig do
-          returns(
-            T.nilable(
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol
-            )
-          )
-        end
-        attr_reader :datapoint_list_type
-
-        sig do
-          params(
-            datapoint_list_type:
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol
-          ).void
-        end
-        attr_writer :datapoint_list_type
-
-        # Schema definition for objects when datapoint_list_type is 'object'. Provide a
-        # map of field names to their scalar types.
-        sig do
-          returns(
-            T.nilable(
-              T::Hash[
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol
-              ]
-            )
-          )
-        end
-        attr_reader :datapoint_object_schema
-
-        sig do
-          params(
-            datapoint_object_schema:
-              T::Hash[
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol
-              ]
-          ).void
-        end
-        attr_writer :datapoint_object_schema
-
-        sig do
-          params(
-            datapoint_description: String,
-            datapoint_example: String,
-            datapoint_name: String,
-            datapoint_type:
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol,
-            datapoint_list_type:
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol,
-            datapoint_object_schema:
-              T::Hash[
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol
-              ]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Description of what to extract
-          datapoint_description:,
-          # Example of the expected value
-          datapoint_example:,
-          # Name of the data point to extract
-          datapoint_name:,
-          # Type of the data point
-          datapoint_type:,
-          # Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
-          # Use 'object' to extract an array of objects matching a schema.
-          datapoint_list_type: nil,
-          # Schema definition for objects when datapoint_list_type is 'object'. Provide a
-          # map of field names to their scalar types.
-          datapoint_object_schema: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              datapoint_description: String,
-              datapoint_example: String,
-              datapoint_name: String,
-              datapoint_type:
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol,
-              datapoint_list_type:
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol,
-              datapoint_object_schema:
-                T::Hash[
-                  Symbol,
-                  ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol
-                ]
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Type of the data point
-        module DatapointType
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TEXT =
-            T.let(
-              :text,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-          NUMBER =
-            T.let(
-              :number,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-          DATE =
-            T.let(
-              :date,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-          BOOLEAN =
-            T.let(
-              :boolean,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-          LIST =
-            T.let(
-              :list,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-          URL =
-            T.let(
-              :url,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
-        # Use 'object' to extract an array of objects matching a schema.
-        module DatapointListType
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointListType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          STRING =
-            T.let(
-              :string,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          TEXT =
-            T.let(
-              :text,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          NUMBER =
-            T.let(
-              :number,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          DATE =
-            T.let(
-              :date,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          BOOLEAN =
-            T.let(
-              :boolean,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          LIST =
-            T.let(
-              :list,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          URL =
-            T.let(
-              :url,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-          OBJECT =
-            T.let(
-              :object,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        module DatapointObjectSchema
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          STRING =
-            T.let(
-              :string,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol
-            )
-          NUMBER =
-            T.let(
-              :number,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol
-            )
-          DATE =
-            T.let(
-              :date,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol
-            )
-          BOOLEAN =
-            T.let(
-              :boolean,
-              ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      class SpecificPages < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::AIAIQueryParams::SpecificPages,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Whether to analyze the about us page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :about_us
-
-        sig { params(about_us: T::Boolean).void }
-        attr_writer :about_us
-
-        # Whether to analyze the blog
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :blog
-
-        sig { params(blog: T::Boolean).void }
-        attr_writer :blog
-
-        # Whether to analyze the careers page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :careers
-
-        sig { params(careers: T::Boolean).void }
-        attr_writer :careers
-
-        # Whether to analyze the contact us page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :contact_us
-
-        sig { params(contact_us: T::Boolean).void }
-        attr_writer :contact_us
-
-        # Whether to analyze the FAQ page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :faq
-
-        sig { params(faq: T::Boolean).void }
-        attr_writer :faq
-
-        # Whether to analyze the home page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :home_page
-
-        sig { params(home_page: T::Boolean).void }
-        attr_writer :home_page
-
-        # Whether to analyze the pricing page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :pricing
-
-        sig { params(pricing: T::Boolean).void }
-        attr_writer :pricing
-
-        # Whether to analyze the privacy policy page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :privacy_policy
-
-        sig { params(privacy_policy: T::Boolean).void }
-        attr_writer :privacy_policy
-
-        # Whether to analyze the terms and conditions page
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :terms_and_conditions
-
-        sig { params(terms_and_conditions: T::Boolean).void }
-        attr_writer :terms_and_conditions
-
-        # Optional object specifying which pages to analyze
-        sig do
-          params(
-            about_us: T::Boolean,
-            blog: T::Boolean,
-            careers: T::Boolean,
-            contact_us: T::Boolean,
-            faq: T::Boolean,
-            home_page: T::Boolean,
-            pricing: T::Boolean,
-            privacy_policy: T::Boolean,
-            terms_and_conditions: T::Boolean
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Whether to analyze the about us page
-          about_us: nil,
-          # Whether to analyze the blog
-          blog: nil,
-          # Whether to analyze the careers page
-          careers: nil,
-          # Whether to analyze the contact us page
-          contact_us: nil,
-          # Whether to analyze the FAQ page
-          faq: nil,
-          # Whether to analyze the home page
-          home_page: nil,
-          # Whether to analyze the pricing page
-          pricing: nil,
-          # Whether to analyze the privacy policy page
-          privacy_policy: nil,
-          # Whether to analyze the terms and conditions page
-          terms_and_conditions: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              about_us: T::Boolean,
-              blog: T::Boolean,
-              careers: T::Boolean,
-              contact_us: T::Boolean,
-              faq: T::Boolean,
-              home_page: T::Boolean,
-              pricing: T::Boolean,
-              privacy_policy: T::Boolean,
-              terms_and_conditions: T::Boolean
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end