diff --git a/.release-please-manifest.json b/.release-please-manifest.json index f3dbfd2a..4eb89879 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.26.0" + ".": "1.27.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index deed0132..7e84f7a6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 24 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-1785aa93e6fb2784640a4c32eb0221f0b31aa06644d090f72f8533524aeef7c6.yml +configured_endpoints: 25 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-30ba67603321f69c2ba0432320c45caa4727ebbe353bea8874c9e7db8b95b09e.yml openapi_spec_hash: 7dc1fadcec32637e795f641a0e97c63e -config_hash: cf2c7f48b329e0a61612b30cd2755ad1 +config_hash: f86a4e06ae5ed725aa79d58d7a8dc27c diff --git a/CHANGELOG.md b/CHANGELOG.md index b74bacbc..ad36a35e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 1.27.0 (2026-06-01) + +Full Changelog: [v1.26.0...v1.27.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.26.0...v1.27.0) + +### Features + +* **api:** manual updates ([e3971dc](https://github.com/context-dot-dev/context-ruby-sdk/commit/e3971dcc3b94f5b998562f8ecb82a292cc8f00bd)) + ## 1.26.0 (2026-06-01) Full Changelog: [v1.25.0...v1.26.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.25.0...v1.26.0) diff --git a/Gemfile.lock b/Gemfile.lock index 5ac30fe2..df1bf28e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (1.26.0) + context.dev (1.27.0) cgi connection_pool diff --git a/README.md b/README.md index f86f616a..7ec6e03f 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 1.26.0" +gem "context.dev", "~> 1.27.0" ``` diff --git a/lib/context_dev.rb b/lib/context_dev.rb index cc510200..ab592cf8 100644 --- a/lib/context_dev.rb +++ b/lib/context_dev.rb @@ -80,6 +80,8 @@ require_relative "context_dev/models/utility_prefetch_by_email_response" require_relative "context_dev/models/utility_prefetch_params" require_relative "context_dev/models/utility_prefetch_response" +require_relative "context_dev/models/web_extract_competitors_params" +require_relative "context_dev/models/web_extract_competitors_response" require_relative "context_dev/models/web_extract_fonts_params" require_relative "context_dev/models/web_extract_fonts_response" require_relative "context_dev/models/web_extract_params" diff --git a/lib/context_dev/models.rb b/lib/context_dev/models.rb index 601e3b55..e72f9f83 100644 --- a/lib/context_dev/models.rb +++ b/lib/context_dev/models.rb @@ -67,6 +67,8 @@ module ContextDev UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams + WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams + WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams WebExtractParams = ContextDev::Models::WebExtractParams diff --git a/lib/context_dev/models/web_extract_competitors_params.rb b/lib/context_dev/models/web_extract_competitors_params.rb new file mode 100644 index 00000000..6a0939a9 --- /dev/null +++ b/lib/context_dev/models/web_extract_competitors_params.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +module ContextDev + module Models + # @see ContextDev::Resources::Web#extract_competitors + class WebExtractCompetitorsParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + # @!attribute domain + # Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # and normalized to their domain. + # + # @return [String] + required :domain, String + + # @!attribute num_competitors + # Exact number of direct competitors to return. Defaults to 5. + # + # @return [Integer, nil] + optional :num_competitors, Integer + + # @!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 + + # @!method initialize(domain:, num_competitors: nil, timeout_ms: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractCompetitorsParams} for more details. + # + # @param domain [String] Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # + # @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5. + # + # @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 diff --git a/lib/context_dev/models/web_extract_competitors_response.rb b/lib/context_dev/models/web_extract_competitors_response.rb new file mode 100644 index 00000000..81a13003 --- /dev/null +++ b/lib/context_dev/models/web_extract_competitors_response.rb @@ -0,0 +1,157 @@ +# frozen_string_literal: true + +module ContextDev + module Models + # @see ContextDev::Resources::Web#extract_competitors + class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel + # @!attribute competitors + # Direct competitors ordered by relevance and confidence. + # + # @return [Array] + required :competitors, + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractCompetitorsResponse::Competitor] } + + # @!attribute domain + # Normalized input domain. + # + # @return [String] + required :domain, String + + # @!attribute status + # Status of the response. + # + # @return [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] + required :status, enum: -> { ContextDev::Models::WebExtractCompetitorsResponse::Status } + + # @!attribute target + # Target company profile inferred from the landing page. + # + # @return [ContextDev::Models::WebExtractCompetitorsResponse::Target] + required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target } + + # @!method initialize(competitors:, domain:, status:, target:) + # @param competitors [Array] Direct competitors ordered by relevance and confidence. + # + # @param domain [String] Normalized input domain. + # + # @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response. + # + # @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page. + + class Competitor < ContextDev::Internal::Type::BaseModel + # @!attribute confidence + # Confidence that this company is a direct competitor. + # + # @return [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence] + required :confidence, + enum: -> { ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence } + + # @!attribute description + # Short description of the competitor. + # + # @return [String] + required :description, String + + # @!attribute domain + # Competitor's normalized official domain. + # + # @return [String] + required :domain, String + + # @!attribute name + # Competitor company or product name. + # + # @return [String] + required :name, String + + # @!attribute source_urls + # Search result URLs used as evidence for this competitor. + # + # @return [Array] + required :source_urls, ContextDev::Internal::Type::ArrayOf[String], api_name: :sourceUrls + + # @!attribute url + # Competitor website URL. + # + # @return [String] + required :url, String + + # @!method initialize(confidence:, description:, domain:, name:, source_urls:, url:) + # @param confidence [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence] Confidence that this company is a direct competitor. + # + # @param description [String] Short description of the competitor. + # + # @param domain [String] Competitor's normalized official domain. + # + # @param name [String] Competitor company or product name. + # + # @param source_urls [Array] Search result URLs used as evidence for this competitor. + # + # @param url [String] Competitor website URL. + + # Confidence that this company is a direct competitor. + # + # @see ContextDev::Models::WebExtractCompetitorsResponse::Competitor#confidence + module Confidence + extend ContextDev::Internal::Type::Enum + + HIGH = :high + MEDIUM = :medium + + # @!method self.values + # @return [Array] + end + end + + # Status of the response. + # + # @see ContextDev::Models::WebExtractCompetitorsResponse#status + module Status + extend ContextDev::Internal::Type::Enum + + OK = :ok + + # @!method self.values + # @return [Array] + end + + # @see ContextDev::Models::WebExtractCompetitorsResponse#target + class Target < ContextDev::Internal::Type::BaseModel + # @!attribute company_name + # Company or product name inferred from the landing page. + # + # @return [String] + required :company_name, String, api_name: :companyName + + # @!attribute field + # Specific operating field, product category, or market. + # + # @return [String] + required :field, String + + # @!attribute field_description + # One-sentence description of what the target company sells and who it serves. + # + # @return [String] + required :field_description, String, api_name: :fieldDescription + + # @!attribute website_url + # Resolved URL used for the landing page analysis. + # + # @return [String] + required :website_url, String, api_name: :websiteUrl + + # @!method initialize(company_name:, field:, field_description:, website_url:) + # Target company profile inferred from the landing page. + # + # @param company_name [String] Company or product name inferred from the landing page. + # + # @param field [String] Specific operating field, product category, or market. + # + # @param field_description [String] One-sentence description of what the target company sells and who it serves. + # + # @param website_url [String] Resolved URL used for the landing page analysis. + end + end + end +end diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 573aafce..2d7c70d6 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -49,6 +49,37 @@ def extract(params) ) end + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractCompetitorsParams} for more details. + # + # Analyze a company's landing page and web search evidence to return direct + # competitors for the same product or market. + # + # @overload extract_competitors(domain:, num_competitors: nil, timeout_ms: nil, request_options: {}) + # + # @param domain [String] Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # + # @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5. + # + # @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}, nil] + # + # @return [ContextDev::Models::WebExtractCompetitorsResponse] + # + # @see ContextDev::Models::WebExtractCompetitorsParams + def extract_competitors(params) + parsed, options = ContextDev::WebExtractCompetitorsParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "web/competitors", + query: query.transform_keys(num_competitors: "numCompetitors", timeout_ms: "timeoutMS"), + model: ContextDev::Models::WebExtractCompetitorsResponse, + options: options + ) + end + # Some parameter documentations has been truncated, see # {ContextDev::Models::WebExtractFontsParams} for more details. # diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 038a158c..e577be49 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "1.26.0" + VERSION = "1.27.0" end diff --git a/rbi/context_dev/models.rbi b/rbi/context_dev/models.rbi index 147b94fa..a68287c8 100644 --- a/rbi/context_dev/models.rbi +++ b/rbi/context_dev/models.rbi @@ -32,6 +32,8 @@ module ContextDev UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams + WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams + WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams WebExtractParams = ContextDev::Models::WebExtractParams diff --git a/rbi/context_dev/models/web_extract_competitors_params.rbi b/rbi/context_dev/models/web_extract_competitors_params.rbi new file mode 100644 index 00000000..0e5d4a44 --- /dev/null +++ b/rbi/context_dev/models/web_extract_competitors_params.rbi @@ -0,0 +1,74 @@ +# typed: strong + +module ContextDev + module Models + class WebExtractCompetitorsParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + ContextDev::WebExtractCompetitorsParams, + ContextDev::Internal::AnyHash + ) + end + + # Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # and normalized to their domain. + sig { returns(String) } + attr_accessor :domain + + # Exact number of direct competitors to return. Defaults to 5. + sig { returns(T.nilable(Integer)) } + attr_reader :num_competitors + + sig { params(num_competitors: Integer).void } + attr_writer :num_competitors + + # 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( + domain: String, + num_competitors: Integer, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # and normalized to their domain. + domain:, + # Exact number of direct competitors to return. Defaults to 5. + num_competitors: 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( + { + domain: String, + num_competitors: Integer, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/context_dev/models/web_extract_competitors_response.rbi b/rbi/context_dev/models/web_extract_competitors_response.rbi new file mode 100644 index 00000000..80837800 --- /dev/null +++ b/rbi/context_dev/models/web_extract_competitors_response.rbi @@ -0,0 +1,297 @@ +# typed: strong + +module ContextDev + module Models + class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractCompetitorsResponse, + ContextDev::Internal::AnyHash + ) + end + + # Direct competitors ordered by relevance and confidence. + sig do + returns( + T::Array[ + ContextDev::Models::WebExtractCompetitorsResponse::Competitor + ] + ) + end + attr_accessor :competitors + + # Normalized input domain. + sig { returns(String) } + attr_accessor :domain + + # Status of the response. + sig do + returns( + ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol + ) + end + attr_accessor :status + + # Target company profile inferred from the landing page. + sig { returns(ContextDev::Models::WebExtractCompetitorsResponse::Target) } + attr_reader :target + + sig do + params( + target: + ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash + ).void + end + attr_writer :target + + sig do + params( + competitors: + T::Array[ + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::OrHash + ], + domain: String, + status: + ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol, + target: + ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash + ).returns(T.attached_class) + end + def self.new( + # Direct competitors ordered by relevance and confidence. + competitors:, + # Normalized input domain. + domain:, + # Status of the response. + status:, + # Target company profile inferred from the landing page. + target: + ) + end + + sig do + override.returns( + { + competitors: + T::Array[ + ContextDev::Models::WebExtractCompetitorsResponse::Competitor + ], + domain: String, + status: + ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol, + target: ContextDev::Models::WebExtractCompetitorsResponse::Target + } + ) + end + def to_hash + end + + class Competitor < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractCompetitorsResponse::Competitor, + ContextDev::Internal::AnyHash + ) + end + + # Confidence that this company is a direct competitor. + sig do + returns( + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol + ) + end + attr_accessor :confidence + + # Short description of the competitor. + sig { returns(String) } + attr_accessor :description + + # Competitor's normalized official domain. + sig { returns(String) } + attr_accessor :domain + + # Competitor company or product name. + sig { returns(String) } + attr_accessor :name + + # Search result URLs used as evidence for this competitor. + sig { returns(T::Array[String]) } + attr_accessor :source_urls + + # Competitor website URL. + sig { returns(String) } + attr_accessor :url + + sig do + params( + confidence: + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::OrSymbol, + description: String, + domain: String, + name: String, + source_urls: T::Array[String], + url: String + ).returns(T.attached_class) + end + def self.new( + # Confidence that this company is a direct competitor. + confidence:, + # Short description of the competitor. + description:, + # Competitor's normalized official domain. + domain:, + # Competitor company or product name. + name:, + # Search result URLs used as evidence for this competitor. + source_urls:, + # Competitor website URL. + url: + ) + end + + sig do + override.returns( + { + confidence: + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol, + description: String, + domain: String, + name: String, + source_urls: T::Array[String], + url: String + } + ) + end + def to_hash + end + + # Confidence that this company is a direct competitor. + module Confidence + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + HIGH = + T.let( + :high, + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol + ) + MEDIUM = + T.let( + :medium, + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + # Status of the response. + module Status + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + ContextDev::Models::WebExtractCompetitorsResponse::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OK = + T.let( + :ok, + ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Target < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractCompetitorsResponse::Target, + ContextDev::Internal::AnyHash + ) + end + + # Company or product name inferred from the landing page. + sig { returns(String) } + attr_accessor :company_name + + # Specific operating field, product category, or market. + sig { returns(String) } + attr_accessor :field + + # One-sentence description of what the target company sells and who it serves. + sig { returns(String) } + attr_accessor :field_description + + # Resolved URL used for the landing page analysis. + sig { returns(String) } + attr_accessor :website_url + + # Target company profile inferred from the landing page. + sig do + params( + company_name: String, + field: String, + field_description: String, + website_url: String + ).returns(T.attached_class) + end + def self.new( + # Company or product name inferred from the landing page. + company_name:, + # Specific operating field, product category, or market. + field:, + # One-sentence description of what the target company sells and who it serves. + field_description:, + # Resolved URL used for the landing page analysis. + website_url: + ) + end + + sig do + override.returns( + { + company_name: String, + field: String, + field_description: String, + website_url: String + } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index de0d342b..67b456f0 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -60,6 +60,30 @@ module ContextDev ) end + # Analyze a company's landing page and web search evidence to return direct + # competitors for the same product or market. + sig do + params( + domain: String, + num_competitors: Integer, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebExtractCompetitorsResponse) + end + def extract_competitors( + # Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted + # and normalized to their domain. + domain:, + # Exact number of direct competitors to return. Defaults to 5. + num_competitors: 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 + # Scrape font information from a website including font families, usage # statistics, fallbacks, and element/word counts. sig do diff --git a/sig/context_dev/models.rbs b/sig/context_dev/models.rbs index 322e9ff9..5cb39a14 100644 --- a/sig/context_dev/models.rbs +++ b/sig/context_dev/models.rbs @@ -27,6 +27,8 @@ module ContextDev class UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams + class WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams + class WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams class WebExtractParams = ContextDev::Models::WebExtractParams diff --git a/sig/context_dev/models/web_extract_competitors_params.rbs b/sig/context_dev/models/web_extract_competitors_params.rbs new file mode 100644 index 00000000..ddf1bf53 --- /dev/null +++ b/sig/context_dev/models/web_extract_competitors_params.rbs @@ -0,0 +1,36 @@ +module ContextDev + module Models + type web_extract_competitors_params = + { domain: String, num_competitors: Integer, timeout_ms: Integer } + & ContextDev::Internal::Type::request_parameters + + class WebExtractCompetitorsParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + attr_accessor domain: String + + attr_reader num_competitors: Integer? + + def num_competitors=: (Integer) -> Integer + + attr_reader timeout_ms: Integer? + + def timeout_ms=: (Integer) -> Integer + + def initialize: ( + domain: String, + ?num_competitors: Integer, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> void + + def to_hash: -> { + domain: String, + num_competitors: Integer, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions + } + end + end +end diff --git a/sig/context_dev/models/web_extract_competitors_response.rbs b/sig/context_dev/models/web_extract_competitors_response.rbs new file mode 100644 index 00000000..544d68a4 --- /dev/null +++ b/sig/context_dev/models/web_extract_competitors_response.rbs @@ -0,0 +1,130 @@ +module ContextDev + module Models + type web_extract_competitors_response = + { + competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], + domain: String, + status: ContextDev::Models::WebExtractCompetitorsResponse::status, + target: ContextDev::Models::WebExtractCompetitorsResponse::Target + } + + class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel + attr_accessor competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor] + + attr_accessor domain: String + + attr_accessor status: ContextDev::Models::WebExtractCompetitorsResponse::status + + attr_accessor target: ContextDev::Models::WebExtractCompetitorsResponse::Target + + def initialize: ( + competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], + domain: String, + status: ContextDev::Models::WebExtractCompetitorsResponse::status, + target: ContextDev::Models::WebExtractCompetitorsResponse::Target + ) -> void + + def to_hash: -> { + competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], + domain: String, + status: ContextDev::Models::WebExtractCompetitorsResponse::status, + target: ContextDev::Models::WebExtractCompetitorsResponse::Target + } + + type competitor = + { + confidence: ContextDev::Models::WebExtractCompetitorsResponse::Competitor::confidence, + description: String, + domain: String, + name: String, + source_urls: ::Array[String], + url: String + } + + class Competitor < ContextDev::Internal::Type::BaseModel + attr_accessor confidence: ContextDev::Models::WebExtractCompetitorsResponse::Competitor::confidence + + attr_accessor description: String + + attr_accessor domain: String + + attr_accessor name: String + + attr_accessor source_urls: ::Array[String] + + attr_accessor url: String + + def initialize: ( + confidence: ContextDev::Models::WebExtractCompetitorsResponse::Competitor::confidence, + description: String, + domain: String, + name: String, + source_urls: ::Array[String], + url: String + ) -> void + + def to_hash: -> { + confidence: ContextDev::Models::WebExtractCompetitorsResponse::Competitor::confidence, + description: String, + domain: String, + name: String, + source_urls: ::Array[String], + url: String + } + + type confidence = :high | :medium + + module Confidence + extend ContextDev::Internal::Type::Enum + + HIGH: :high + MEDIUM: :medium + + def self?.values: -> ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor::confidence] + end + end + + type status = :ok + + module Status + extend ContextDev::Internal::Type::Enum + + OK: :ok + + def self?.values: -> ::Array[ContextDev::Models::WebExtractCompetitorsResponse::status] + end + + type target = + { + company_name: String, + field: String, + field_description: String, + website_url: String + } + + class Target < ContextDev::Internal::Type::BaseModel + attr_accessor company_name: String + + attr_accessor field: String + + attr_accessor field_description: String + + attr_accessor website_url: String + + def initialize: ( + company_name: String, + field: String, + field_description: String, + website_url: String + ) -> void + + def to_hash: -> { + company_name: String, + field: String, + field_description: String, + website_url: String + } + end + end + end +end diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index e2259474..cec0432a 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -16,6 +16,13 @@ module ContextDev ?request_options: ContextDev::request_opts ) -> ContextDev::Models::WebExtractResponse + def extract_competitors: ( + domain: String, + ?num_competitors: Integer, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebExtractCompetitorsResponse + def extract_fonts: ( ?direct_url: String, ?domain: String, diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb index a1a5fb59..6b131d34 100644 --- a/test/context_dev/resources/web_test.rb +++ b/test/context_dev/resources/web_test.rb @@ -27,6 +27,25 @@ def test_extract_required_params end end + def test_extract_competitors_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.extract_competitors(domain: "xxx") + + assert_pattern do + response => ContextDev::Models::WebExtractCompetitorsResponse + end + + assert_pattern do + response => { + competitors: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractCompetitorsResponse::Competitor]), + domain: String, + status: ContextDev::Models::WebExtractCompetitorsResponse::Status, + target: ContextDev::Models::WebExtractCompetitorsResponse::Target + } + end + end + def test_extract_fonts skip("Mock server tests are disabled")