diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3d2ac0bd..10f30916 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0" + ".": "0.2.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index bc49c222..c4d39225 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 20 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev%2Fcontext.dev-c5d5abb4b31f6e352e3e02b47120e3f444377c1c564f141ebe0988b86ba5932e.yml -openapi_spec_hash: 8ef4803fbe33ae6472a4b8f660be7921 -config_hash: a144af00e5e74176674d0ea954cc02c5 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev%2Fcontext.dev-c2e94e0c758b1aaba120c2a4231842fff0a120acc471fe24c7a81221e13a0482.yml +openapi_spec_hash: aabc231b46b1ca3375882f96c378c665 +config_hash: ab5135cc119f83ae2821f9445ed99d16 diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ed45b21..3afa75a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## 0.2.0 (2026-03-18) + +Full Changelog: [v0.1.0...v0.2.0](https://github.com/brand-dot-dev/context-ruby-sdk/compare/v0.1.0...v0.2.0) + +### Features + +* **api:** api update ([ff1db16](https://github.com/brand-dot-dev/context-ruby-sdk/commit/ff1db1692a06315279532c93a05722223cb2c7ee)) +* **api:** manual updates ([d120a5d](https://github.com/brand-dot-dev/context-ruby-sdk/commit/d120a5dde6665acced2c75394beb6910389e344e)) +* **api:** manual updates ([fe32a5e](https://github.com/brand-dot-dev/context-ruby-sdk/commit/fe32a5e431bf152d8b0966f9927efcd8ebc3b5c1)) + ## 0.1.0 (2026-03-18) Full Changelog: [v0.0.2...v0.1.0](https://github.com/brand-dot-dev/context-ruby-sdk/compare/v0.0.2...v0.1.0) diff --git a/Gemfile.lock b/Gemfile.lock index 53ede653..16c98f8d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (0.1.0) + context.dev (0.2.0) cgi connection_pool diff --git a/README.md b/README.md index 5dec886b..2b06fc81 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", "~> 0.1.0" +gem "context.dev", "~> 0.2.0" ``` @@ -206,25 +206,25 @@ context_dev.brand.retrieve(**params) Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: ```ruby -# :albanian -puts(ContextDev::BrandRetrieveParams::ForceLanguage::ALBANIAN) +# :true +puts(ContextDev::WebScreenshotParams::FullScreenshot::TRUE) -# Revealed type: `T.all(ContextDev::BrandRetrieveParams::ForceLanguage, Symbol)` -T.reveal_type(ContextDev::BrandRetrieveParams::ForceLanguage::ALBANIAN) +# Revealed type: `T.all(ContextDev::WebScreenshotParams::FullScreenshot, Symbol)` +T.reveal_type(ContextDev::WebScreenshotParams::FullScreenshot::TRUE) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: ```ruby # Using the enum constants preserves the tagged type information: -context_dev.brand.retrieve( - force_language: ContextDev::BrandRetrieveParams::ForceLanguage::ALBANIAN, +context_dev.web.screenshot( + full_screenshot: ContextDev::WebScreenshotParams::FullScreenshot::TRUE, # … ) # Literal values are also permissible: -context_dev.brand.retrieve( - force_language: :albanian, +context_dev.web.screenshot( + full_screenshot: :true, # … ) ``` diff --git a/lib/context_dev.rb b/lib/context_dev.rb index 9eb3c033..ca1d98a3 100644 --- a/lib/context_dev.rb +++ b/lib/context_dev.rb @@ -52,20 +52,14 @@ require_relative "context_dev/internal/transport/base_client" require_relative "context_dev/internal/transport/pooled_net_requester" require_relative "context_dev/client" -require_relative "context_dev/models/brand_ai_product_params" -require_relative "context_dev/models/brand_ai_product_response" -require_relative "context_dev/models/brand_ai_products_params" -require_relative "context_dev/models/brand_ai_products_response" -require_relative "context_dev/models/brand_ai_query_params" -require_relative "context_dev/models/brand_ai_query_response" -require_relative "context_dev/models/brand_fonts_params" -require_relative "context_dev/models/brand_fonts_response" +require_relative "context_dev/models/ai_ai_query_params" +require_relative "context_dev/models/ai_ai_query_response" +require_relative "context_dev/models/ai_extract_product_params" +require_relative "context_dev/models/ai_extract_product_response" +require_relative "context_dev/models/ai_extract_products_params" +require_relative "context_dev/models/ai_extract_products_response" require_relative "context_dev/models/brand_identify_from_transaction_params" require_relative "context_dev/models/brand_identify_from_transaction_response" -require_relative "context_dev/models/brand_prefetch_by_email_params" -require_relative "context_dev/models/brand_prefetch_by_email_response" -require_relative "context_dev/models/brand_prefetch_params" -require_relative "context_dev/models/brand_prefetch_response" require_relative "context_dev/models/brand_retrieve_by_email_params" require_relative "context_dev/models/brand_retrieve_by_email_response" require_relative "context_dev/models/brand_retrieve_by_isin_params" @@ -74,23 +68,34 @@ require_relative "context_dev/models/brand_retrieve_by_name_response" require_relative "context_dev/models/brand_retrieve_by_ticker_params" require_relative "context_dev/models/brand_retrieve_by_ticker_response" -require_relative "context_dev/models/brand_retrieve_naics_params" -require_relative "context_dev/models/brand_retrieve_naics_response" require_relative "context_dev/models/brand_retrieve_params" require_relative "context_dev/models/brand_retrieve_response" require_relative "context_dev/models/brand_retrieve_simplified_params" require_relative "context_dev/models/brand_retrieve_simplified_response" -require_relative "context_dev/models/brand_screenshot_params" -require_relative "context_dev/models/brand_screenshot_response" -require_relative "context_dev/models/brand_styleguide_params" -require_relative "context_dev/models/brand_styleguide_response" -require_relative "context_dev/models/brand_web_scrape_html_params" -require_relative "context_dev/models/brand_web_scrape_html_response" -require_relative "context_dev/models/brand_web_scrape_images_params" -require_relative "context_dev/models/brand_web_scrape_images_response" -require_relative "context_dev/models/brand_web_scrape_md_params" -require_relative "context_dev/models/brand_web_scrape_md_response" -require_relative "context_dev/models/brand_web_scrape_sitemap_params" -require_relative "context_dev/models/brand_web_scrape_sitemap_response" +require_relative "context_dev/models/industry_retrieve_naics_params" +require_relative "context_dev/models/industry_retrieve_naics_response" +require_relative "context_dev/models/style_extract_fonts_params" +require_relative "context_dev/models/style_extract_fonts_response" +require_relative "context_dev/models/style_extract_styleguide_params" +require_relative "context_dev/models/style_extract_styleguide_response" +require_relative "context_dev/models/utility_prefetch_by_email_params" +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_screenshot_params" +require_relative "context_dev/models/web_screenshot_response" +require_relative "context_dev/models/web_web_scrape_html_params" +require_relative "context_dev/models/web_web_scrape_html_response" +require_relative "context_dev/models/web_web_scrape_images_params" +require_relative "context_dev/models/web_web_scrape_images_response" +require_relative "context_dev/models/web_web_scrape_md_params" +require_relative "context_dev/models/web_web_scrape_md_response" +require_relative "context_dev/models/web_web_scrape_sitemap_params" +require_relative "context_dev/models/web_web_scrape_sitemap_response" require_relative "context_dev/models" +require_relative "context_dev/resources/ai" require_relative "context_dev/resources/brand" +require_relative "context_dev/resources/industry" +require_relative "context_dev/resources/style" +require_relative "context_dev/resources/utility" +require_relative "context_dev/resources/web" diff --git a/lib/context_dev/client.rb b/lib/context_dev/client.rb index 2a62aefb..5015189f 100644 --- a/lib/context_dev/client.rb +++ b/lib/context_dev/client.rb @@ -18,9 +18,24 @@ class Client < ContextDev::Internal::Transport::BaseClient # @return [String] attr_reader :api_key + # @return [ContextDev::Resources::Web] + attr_reader :web + + # @return [ContextDev::Resources::AI] + attr_reader :ai + + # @return [ContextDev::Resources::Style] + attr_reader :style + # @return [ContextDev::Resources::Brand] attr_reader :brand + # @return [ContextDev::Resources::Industry] + attr_reader :industry + + # @return [ContextDev::Resources::Utility] + attr_reader :utility + # @api private # # @return [Hash{String=>String}] @@ -68,7 +83,12 @@ def initialize( max_retry_delay: max_retry_delay ) + @web = ContextDev::Resources::Web.new(client: self) + @ai = ContextDev::Resources::AI.new(client: self) + @style = ContextDev::Resources::Style.new(client: self) @brand = ContextDev::Resources::Brand.new(client: self) + @industry = ContextDev::Resources::Industry.new(client: self) + @utility = ContextDev::Resources::Utility.new(client: self) end end end diff --git a/lib/context_dev/internal/type/base_model.rb b/lib/context_dev/internal/type/base_model.rb index beddca7e..179eff15 100644 --- a/lib/context_dev/internal/type/base_model.rb +++ b/lib/context_dev/internal/type/base_model.rb @@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false) # @return [Hash{Symbol=>Object}] # # @example - # # `brand_retrieve_response` is a `ContextDev::Models::BrandRetrieveResponse` - # brand_retrieve_response => { - # brand: brand, + # # `web_screenshot_response` is a `ContextDev::Models::WebScreenshotResponse` + # web_screenshot_response => { # code: code, - # status: status + # domain: domain, + # screenshot: screenshot # } def deconstruct_keys(keys) (keys || self.class.known_fields.keys) diff --git a/lib/context_dev/models.rb b/lib/context_dev/models.rb index 1c5bfc0c..45dea9e9 100644 --- a/lib/context_dev/models.rb +++ b/lib/context_dev/models.rb @@ -39,20 +39,14 @@ module ContextDev mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } } end - BrandAIProductParams = ContextDev::Models::BrandAIProductParams + AIAIQueryParams = ContextDev::Models::AIAIQueryParams - BrandAIProductsParams = ContextDev::Models::BrandAIProductsParams + AIExtractProductParams = ContextDev::Models::AIExtractProductParams - BrandAIQueryParams = ContextDev::Models::BrandAIQueryParams - - BrandFontsParams = ContextDev::Models::BrandFontsParams + AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams - BrandPrefetchByEmailParams = ContextDev::Models::BrandPrefetchByEmailParams - - BrandPrefetchParams = ContextDev::Models::BrandPrefetchParams - BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams @@ -61,21 +55,27 @@ module ContextDev BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams - BrandRetrieveNaicsParams = ContextDev::Models::BrandRetrieveNaicsParams - BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams - BrandScreenshotParams = ContextDev::Models::BrandScreenshotParams + IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams + + StyleExtractFontsParams = ContextDev::Models::StyleExtractFontsParams + + StyleExtractStyleguideParams = ContextDev::Models::StyleExtractStyleguideParams + + UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams + + UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams - BrandStyleguideParams = ContextDev::Models::BrandStyleguideParams + WebScreenshotParams = ContextDev::Models::WebScreenshotParams - BrandWebScrapeHTMLParams = ContextDev::Models::BrandWebScrapeHTMLParams + WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams - BrandWebScrapeImagesParams = ContextDev::Models::BrandWebScrapeImagesParams + WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams - BrandWebScrapeMdParams = ContextDev::Models::BrandWebScrapeMdParams + WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams - BrandWebScrapeSitemapParams = ContextDev::Models::BrandWebScrapeSitemapParams + WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams end diff --git a/lib/context_dev/models/brand_ai_query_params.rb b/lib/context_dev/models/ai_ai_query_params.rb similarity index 77% rename from lib/context_dev/models/brand_ai_query_params.rb rename to lib/context_dev/models/ai_ai_query_params.rb index dbffd1ee..750181ef 100644 --- a/lib/context_dev/models/brand_ai_query_params.rb +++ b/lib/context_dev/models/ai_ai_query_params.rb @@ -2,17 +2,17 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_query - class BrandAIQueryParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#ai_query + class AIAIQueryParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters # @!attribute data_to_extract # Array of data points to extract from the website # - # @return [Array] + # @return [Array] required :data_to_extract, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::BrandAIQueryParams::DataToExtract] } + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::AIAIQueryParams::DataToExtract] } # @!attribute domain # The domain name to analyze @@ -23,8 +23,8 @@ class BrandAIQueryParams < ContextDev::Internal::Type::BaseModel # @!attribute specific_pages # Optional object specifying which pages to analyze # - # @return [ContextDev::Models::BrandAIQueryParams::SpecificPages, nil] - optional :specific_pages, -> { ContextDev::BrandAIQueryParams::SpecificPages } + # @return [ContextDev::Models::AIAIQueryParams::SpecificPages, nil] + optional :specific_pages, -> { ContextDev::AIAIQueryParams::SpecificPages } # @!attribute timeout_ms # Optional timeout in milliseconds for the request. If the request takes longer @@ -36,13 +36,13 @@ class BrandAIQueryParams < ContextDev::Internal::Type::BaseModel # @!method initialize(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIQueryParams} for more details. + # {ContextDev::Models::AIAIQueryParams} for more details. # - # @param data_to_extract [Array] Array of data points to extract from the website + # @param data_to_extract [Array] Array of data points to extract from the website # # @param domain [String] The domain name to analyze # - # @param specific_pages [ContextDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze + # @param specific_pages [ContextDev::Models::AIAIQueryParams::SpecificPages] Optional object specifying which pages to analyze # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # @@ -70,28 +70,27 @@ class DataToExtract < ContextDev::Internal::Type::BaseModel # @!attribute datapoint_type # Type of the data point # - # @return [Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointType] - required :datapoint_type, enum: -> { ContextDev::BrandAIQueryParams::DataToExtract::DatapointType } + # @return [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointType] + required :datapoint_type, enum: -> { ContextDev::AIAIQueryParams::DataToExtract::DatapointType } # @!attribute datapoint_list_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. # - # @return [Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointListType, nil] - optional :datapoint_list_type, - enum: -> { ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType } + # @return [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointListType, nil] + optional :datapoint_list_type, enum: -> { ContextDev::AIAIQueryParams::DataToExtract::DatapointListType } # @!attribute datapoint_object_schema # Schema definition for objects when datapoint_list_type is 'object'. Provide a # map of field names to their scalar types. # - # @return [Hash{Symbol=>Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointObjectSchema}, nil] + # @return [Hash{Symbol=>Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointObjectSchema}, nil] optional :datapoint_object_schema, - -> { ContextDev::Internal::Type::HashOf[enum: ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema] } + -> { ContextDev::Internal::Type::HashOf[enum: ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema] } # @!method initialize(datapoint_description:, datapoint_example:, datapoint_name:, datapoint_type:, datapoint_list_type: nil, datapoint_object_schema: nil) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIQueryParams::DataToExtract} for more details. + # {ContextDev::Models::AIAIQueryParams::DataToExtract} for more details. # # @param datapoint_description [String] Description of what to extract # @@ -99,15 +98,15 @@ class DataToExtract < ContextDev::Internal::Type::BaseModel # # @param datapoint_name [String] Name of the data point to extract # - # @param datapoint_type [Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointType] Type of the data point + # @param datapoint_type [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointType] Type of the data point # - # @param datapoint_list_type [Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointListType] Type of items in the list when datapoint_type is 'list'. Defaults to 'string'. U + # @param datapoint_list_type [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointListType] Type of items in the list when datapoint_type is 'list'. Defaults to 'string'. U # - # @param datapoint_object_schema [Hash{Symbol=>Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::DatapointObjectSchema}] Schema definition for objects when datapoint_list_type is 'object'. Provide a ma + # @param datapoint_object_schema [Hash{Symbol=>Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointObjectSchema}] Schema definition for objects when datapoint_list_type is 'object'. Provide a ma # Type of the data point # - # @see ContextDev::Models::BrandAIQueryParams::DataToExtract#datapoint_type + # @see ContextDev::Models::AIAIQueryParams::DataToExtract#datapoint_type module DatapointType extend ContextDev::Internal::Type::Enum @@ -125,7 +124,7 @@ module DatapointType # 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. # - # @see ContextDev::Models::BrandAIQueryParams::DataToExtract#datapoint_list_type + # @see ContextDev::Models::AIAIQueryParams::DataToExtract#datapoint_list_type module DatapointListType extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_ai_query_response.rb b/lib/context_dev/models/ai_ai_query_response.rb similarity index 75% rename from lib/context_dev/models/brand_ai_query_response.rb rename to lib/context_dev/models/ai_ai_query_response.rb index 6cde1a85..fc23b0ef 100644 --- a/lib/context_dev/models/brand_ai_query_response.rb +++ b/lib/context_dev/models/ai_ai_query_response.rb @@ -2,14 +2,14 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_query - class BrandAIQueryResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#ai_query + class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel # @!attribute data_extracted # Array of extracted data points # - # @return [Array, nil] + # @return [Array, nil] optional :data_extracted, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandAIQueryResponse::DataExtracted] } + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIAIQueryResponse::DataExtracted] } # @!attribute domain # The domain that was analyzed @@ -30,7 +30,7 @@ class BrandAIQueryResponse < ContextDev::Internal::Type::BaseModel optional :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String] # @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil) - # @param data_extracted [Array] Array of extracted data points + # @param data_extracted [Array] Array of extracted data points # # @param domain [String] The domain that was analyzed # @@ -51,11 +51,11 @@ class DataExtracted < ContextDev::Internal::Type::BaseModel # # @return [String, Float, Boolean, Array, Array, Array, nil] optional :datapoint_value, - union: -> { ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue } + union: -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue } # @!method initialize(datapoint_name: nil, datapoint_value: nil) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIQueryResponse::DataExtracted} for more details. + # {ContextDev::Models::AIAIQueryResponse::DataExtracted} for more details. # # @param datapoint_name [String] Name of the extracted data point # @@ -64,7 +64,7 @@ class DataExtracted < ContextDev::Internal::Type::BaseModel # Value of the extracted data point. Can be a primitive type, an array of # primitives, or an array of objects when datapoint_list_type is 'object'. # - # @see ContextDev::Models::BrandAIQueryResponse::DataExtracted#datapoint_value + # @see ContextDev::Models::AIAIQueryResponse::DataExtracted#datapoint_value module DatapointValue extend ContextDev::Internal::Type::Union @@ -74,11 +74,11 @@ module DatapointValue variant ContextDev::Internal::Type::Boolean - variant -> { ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::StringArray } + variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::StringArray } - variant -> { ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::FloatArray } + variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::FloatArray } - variant -> { ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::UnionMember5Array } + variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::UnionMember5Array } # @!method self.variants # @return [Array(String, Float, Boolean, Array, Array, Array)] diff --git a/lib/context_dev/models/brand_ai_product_params.rb b/lib/context_dev/models/ai_extract_product_params.rb similarity index 84% rename from lib/context_dev/models/brand_ai_product_params.rb rename to lib/context_dev/models/ai_extract_product_params.rb index 9d968572..1fc7d187 100644 --- a/lib/context_dev/models/brand_ai_product_params.rb +++ b/lib/context_dev/models/ai_extract_product_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_product - class BrandAIProductParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#extract_product + class AIExtractProductParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -22,7 +22,7 @@ class BrandAIProductParams < ContextDev::Internal::Type::BaseModel # @!method initialize(url:, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIProductParams} for more details. + # {ContextDev::Models::AIExtractProductParams} for more details. # # @param url [String] The product page URL to extract product data from. # diff --git a/lib/context_dev/models/brand_ai_product_response.rb b/lib/context_dev/models/ai_extract_product_response.rb similarity index 74% rename from lib/context_dev/models/brand_ai_product_response.rb rename to lib/context_dev/models/ai_extract_product_response.rb index 04997e62..8c54fd0e 100644 --- a/lib/context_dev/models/brand_ai_product_response.rb +++ b/lib/context_dev/models/ai_extract_product_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_product - class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#extract_product + class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel # @!attribute is_product_page # Whether the given URL is a product detail page # @@ -13,25 +13,25 @@ class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel # @!attribute platform # The detected ecommerce platform, or null if not a product page # - # @return [Symbol, ContextDev::Models::BrandAIProductResponse::Platform, nil] - optional :platform, enum: -> { ContextDev::Models::BrandAIProductResponse::Platform }, nil?: true + # @return [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] + optional :platform, enum: -> { ContextDev::Models::AIExtractProductResponse::Platform }, nil?: true # @!attribute product # The extracted product data, or null if not a product page # - # @return [ContextDev::Models::BrandAIProductResponse::Product, nil] - optional :product, -> { ContextDev::Models::BrandAIProductResponse::Product }, nil?: true + # @return [ContextDev::Models::AIExtractProductResponse::Product, nil] + optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true # @!method initialize(is_product_page: nil, platform: nil, product: nil) # @param is_product_page [Boolean] Whether the given URL is a product detail page # - # @param platform [Symbol, ContextDev::Models::BrandAIProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page + # @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page # - # @param product [ContextDev::Models::BrandAIProductResponse::Product, nil] The extracted product data, or null if not a product page + # @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page # The detected ecommerce platform, or null if not a product page # - # @see ContextDev::Models::BrandAIProductResponse#platform + # @see ContextDev::Models::AIExtractProductResponse#platform module Platform extend ContextDev::Internal::Type::Enum @@ -44,7 +44,7 @@ module Platform # @return [Array] end - # @see ContextDev::Models::BrandAIProductResponse#product + # @see ContextDev::Models::AIExtractProductResponse#product class Product < ContextDev::Internal::Type::BaseModel # @!attribute description # Description of the product @@ -85,9 +85,9 @@ class Product < ContextDev::Internal::Type::BaseModel # @!attribute billing_frequency # Billing frequency for the product # - # @return [Symbol, ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency, nil] + # @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency, nil] optional :billing_frequency, - enum: -> { ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency }, + enum: -> { ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency }, nil?: true # @!attribute category @@ -117,9 +117,9 @@ class Product < ContextDev::Internal::Type::BaseModel # @!attribute pricing_model # Pricing model for the product # - # @return [Symbol, ContextDev::Models::BrandAIProductResponse::Product::PricingModel, nil] + # @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::PricingModel, nil] optional :pricing_model, - enum: -> { ContextDev::Models::BrandAIProductResponse::Product::PricingModel }, + enum: -> { ContextDev::Models::AIExtractProductResponse::Product::PricingModel }, nil?: true # @!attribute url @@ -143,7 +143,7 @@ class Product < ContextDev::Internal::Type::BaseModel # # @param target_audience [Array] Target audience for the product (array of strings) # - # @param billing_frequency [Symbol, ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency, nil] Billing frequency for the product + # @param billing_frequency [Symbol, ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency, nil] Billing frequency for the product # # @param category [String, nil] Category of the product # @@ -153,13 +153,13 @@ class Product < ContextDev::Internal::Type::BaseModel # # @param price [Float, nil] Price of the product # - # @param pricing_model [Symbol, ContextDev::Models::BrandAIProductResponse::Product::PricingModel, nil] Pricing model for the product + # @param pricing_model [Symbol, ContextDev::Models::AIExtractProductResponse::Product::PricingModel, nil] Pricing model for the product # # @param url [String, nil] URL to the product page # Billing frequency for the product # - # @see ContextDev::Models::BrandAIProductResponse::Product#billing_frequency + # @see ContextDev::Models::AIExtractProductResponse::Product#billing_frequency module BillingFrequency extend ContextDev::Internal::Type::Enum @@ -174,7 +174,7 @@ module BillingFrequency # Pricing model for the product # - # @see ContextDev::Models::BrandAIProductResponse::Product#pricing_model + # @see ContextDev::Models::AIExtractProductResponse::Product#pricing_model module PricingModel extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_ai_products_params.rb b/lib/context_dev/models/ai_extract_products_params.rb similarity index 75% rename from lib/context_dev/models/brand_ai_products_params.rb rename to lib/context_dev/models/ai_extract_products_params.rb index 71aa7e91..baa73a56 100644 --- a/lib/context_dev/models/brand_ai_products_params.rb +++ b/lib/context_dev/models/ai_extract_products_params.rb @@ -2,26 +2,26 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_products - class BrandAIProductsParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#extract_products + class AIExtractProductsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters # @!attribute body # - # @return [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL] - required :body, union: -> { ContextDev::BrandAIProductsParams::Body } + # @return [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL] + required :body, union: -> { ContextDev::AIExtractProductsParams::Body } # @!method initialize(body:, request_options: {}) - # @param body [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL] + # @param body [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL] # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] module Body extend ContextDev::Internal::Type::Union - variant -> { ContextDev::BrandAIProductsParams::Body::ByDomain } + variant -> { ContextDev::AIExtractProductsParams::Body::ByDomain } - variant -> { ContextDev::BrandAIProductsParams::Body::ByDirectURL } + variant -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL } class ByDomain < ContextDev::Internal::Type::BaseModel # @!attribute domain @@ -45,7 +45,7 @@ class ByDomain < ContextDev::Internal::Type::BaseModel # @!method initialize(domain:, max_products: nil, timeout_ms: nil) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIProductsParams::Body::ByDomain} for more details. + # {ContextDev::Models::AIExtractProductsParams::Body::ByDomain} for more details. # # @param domain [String] The domain name to analyze. # @@ -77,7 +77,8 @@ class ByDirectURL < ContextDev::Internal::Type::BaseModel # @!method initialize(direct_url:, max_products: nil, timeout_ms: nil) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL} for more details. + # {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL} for more + # details. # # @param direct_url [String] A specific URL to use directly as the starting point for extraction without doma # @@ -87,7 +88,7 @@ class ByDirectURL < ContextDev::Internal::Type::BaseModel end # @!method self.variants - # @return [Array(ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL)] + # @return [Array(ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL)] end end end diff --git a/lib/context_dev/models/brand_ai_products_response.rb b/lib/context_dev/models/ai_extract_products_response.rb similarity index 78% rename from lib/context_dev/models/brand_ai_products_response.rb rename to lib/context_dev/models/ai_extract_products_response.rb index 22b748ed..dbf201e9 100644 --- a/lib/context_dev/models/brand_ai_products_response.rb +++ b/lib/context_dev/models/ai_extract_products_response.rb @@ -2,17 +2,17 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#ai_products - class BrandAIProductsResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::AI#extract_products + class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel # @!attribute products # Array of products extracted from the website # - # @return [Array, nil] + # @return [Array, nil] optional :products, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandAIProductsResponse::Product] } + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] } # @!method initialize(products: nil) - # @param products [Array] Array of products extracted from the website + # @param products [Array] Array of products extracted from the website class Product < ContextDev::Internal::Type::BaseModel # @!attribute description @@ -54,9 +54,9 @@ class Product < ContextDev::Internal::Type::BaseModel # @!attribute billing_frequency # Billing frequency for the product # - # @return [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil] + # @return [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency, nil] optional :billing_frequency, - enum: -> { ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency }, + enum: -> { ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency }, nil?: true # @!attribute category @@ -86,9 +86,9 @@ class Product < ContextDev::Internal::Type::BaseModel # @!attribute pricing_model # Pricing model for the product # - # @return [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] + # @return [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::PricingModel, nil] optional :pricing_model, - enum: -> { ContextDev::Models::BrandAIProductsResponse::Product::PricingModel }, + enum: -> { ContextDev::Models::AIExtractProductsResponse::Product::PricingModel }, nil?: true # @!attribute url @@ -110,7 +110,7 @@ class Product < ContextDev::Internal::Type::BaseModel # # @param target_audience [Array] Target audience for the product (array of strings) # - # @param billing_frequency [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency, nil] Billing frequency for the product + # @param billing_frequency [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency, nil] Billing frequency for the product # # @param category [String, nil] Category of the product # @@ -120,13 +120,13 @@ class Product < ContextDev::Internal::Type::BaseModel # # @param price [Float, nil] Price of the product # - # @param pricing_model [Symbol, ContextDev::Models::BrandAIProductsResponse::Product::PricingModel, nil] Pricing model for the product + # @param pricing_model [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::PricingModel, nil] Pricing model for the product # # @param url [String, nil] URL to the product page # Billing frequency for the product # - # @see ContextDev::Models::BrandAIProductsResponse::Product#billing_frequency + # @see ContextDev::Models::AIExtractProductsResponse::Product#billing_frequency module BillingFrequency extend ContextDev::Internal::Type::Enum @@ -141,7 +141,7 @@ module BillingFrequency # Pricing model for the product # - # @see ContextDev::Models::BrandAIProductsResponse::Product#pricing_model + # @see ContextDev::Models::AIExtractProductsResponse::Product#pricing_model module PricingModel extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_identify_from_transaction_params.rb b/lib/context_dev/models/brand_identify_from_transaction_params.rb index 0e8d11f2..d7c74032 100644 --- a/lib/context_dev/models/brand_identify_from_transaction_params.rb +++ b/lib/context_dev/models/brand_identify_from_transaction_params.rb @@ -351,6 +351,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -370,6 +371,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -392,6 +394,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_by_email_params.rb b/lib/context_dev/models/brand_retrieve_by_email_params.rb index f4f6618d..bbcfa99e 100644 --- a/lib/context_dev/models/brand_retrieve_by_email_params.rb +++ b/lib/context_dev/models/brand_retrieve_by_email_params.rb @@ -60,6 +60,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -79,6 +80,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -101,6 +103,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_by_isin_params.rb b/lib/context_dev/models/brand_retrieve_by_isin_params.rb index b1dae7f0..bc3c36a9 100644 --- a/lib/context_dev/models/brand_retrieve_by_isin_params.rb +++ b/lib/context_dev/models/brand_retrieve_by_isin_params.rb @@ -60,6 +60,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -79,6 +80,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -101,6 +103,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_by_name_params.rb b/lib/context_dev/models/brand_retrieve_by_name_params.rb index 2255adc9..c057af69 100644 --- a/lib/context_dev/models/brand_retrieve_by_name_params.rb +++ b/lib/context_dev/models/brand_retrieve_by_name_params.rb @@ -317,6 +317,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -336,6 +337,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -358,6 +360,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_by_ticker_params.rb b/lib/context_dev/models/brand_retrieve_by_ticker_params.rb index 2ca436f3..de841c37 100644 --- a/lib/context_dev/models/brand_retrieve_by_ticker_params.rb +++ b/lib/context_dev/models/brand_retrieve_by_ticker_params.rb @@ -67,6 +67,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -86,6 +87,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -108,6 +110,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_params.rb b/lib/context_dev/models/brand_retrieve_params.rb index c48ffc6b..a2d18b58 100644 --- a/lib/context_dev/models/brand_retrieve_params.rb +++ b/lib/context_dev/models/brand_retrieve_params.rb @@ -61,6 +61,7 @@ module ForceLanguage AZERI = :azeri BENGALI = :bengali BULGARIAN = :bulgarian + CANTONESE = :cantonese CEBUANO = :cebuano CROATIAN = :croatian CZECH = :czech @@ -80,6 +81,7 @@ module ForceLanguage INDONESIAN = :indonesian ITALIAN = :italian KAZAKH = :kazakh + KOREAN = :korean KYRGYZ = :kyrgyz LATIN = :latin LATVIAN = :latvian @@ -102,6 +104,7 @@ module ForceLanguage SWAHILI = :swahili SWEDISH = :swedish TAGALOG = :tagalog + THAI = :thai TURKISH = :turkish UKRAINIAN = :ukrainian URDU = :urdu diff --git a/lib/context_dev/models/brand_retrieve_naics_params.rb b/lib/context_dev/models/industry_retrieve_naics_params.rb similarity index 90% rename from lib/context_dev/models/brand_retrieve_naics_params.rb rename to lib/context_dev/models/industry_retrieve_naics_params.rb index 76336816..4863d92c 100644 --- a/lib/context_dev/models/brand_retrieve_naics_params.rb +++ b/lib/context_dev/models/industry_retrieve_naics_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#retrieve_naics - class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Industry#retrieve_naics + class IndustryRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -38,7 +38,7 @@ class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandRetrieveNaicsParams} for more details. + # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details. # # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided # diff --git a/lib/context_dev/models/brand_retrieve_naics_response.rb b/lib/context_dev/models/industry_retrieve_naics_response.rb similarity index 69% rename from lib/context_dev/models/brand_retrieve_naics_response.rb rename to lib/context_dev/models/industry_retrieve_naics_response.rb index 8c3a72ea..a41ac3a7 100644 --- a/lib/context_dev/models/brand_retrieve_naics_response.rb +++ b/lib/context_dev/models/industry_retrieve_naics_response.rb @@ -2,14 +2,14 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#retrieve_naics - class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Industry#retrieve_naics + class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel # @!attribute codes # Array of NAICS codes and titles. # - # @return [Array, nil] + # @return [Array, nil] optional :codes, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveNaicsResponse::Code] } + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::IndustryRetrieveNaicsResponse::Code] } # @!attribute domain # Domain found for the brand @@ -30,7 +30,7 @@ class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel optional :type, String # @!method initialize(codes: nil, domain: nil, status: nil, type: nil) - # @param codes [Array] Array of NAICS codes and titles. + # @param codes [Array] Array of NAICS codes and titles. # # @param domain [String] Domain found for the brand # @@ -48,8 +48,8 @@ class Code < ContextDev::Internal::Type::BaseModel # @!attribute confidence # Confidence level for how well this NAICS code matches the company description # - # @return [Symbol, ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] - required :confidence, enum: -> { ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence } + # @return [Symbol, ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence] + required :confidence, enum: -> { ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence } # @!attribute name # NAICS title @@ -60,13 +60,13 @@ class Code < ContextDev::Internal::Type::BaseModel # @!method initialize(code:, confidence:, name:) # @param code [String] NAICS code # - # @param confidence [Symbol, ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence] Confidence level for how well this NAICS code matches the company description + # @param confidence [Symbol, ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence] Confidence level for how well this NAICS code matches the company description # # @param name [String] NAICS title # Confidence level for how well this NAICS code matches the company description # - # @see ContextDev::Models::BrandRetrieveNaicsResponse::Code#confidence + # @see ContextDev::Models::IndustryRetrieveNaicsResponse::Code#confidence module Confidence extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_fonts_params.rb b/lib/context_dev/models/style_extract_fonts_params.rb similarity index 86% rename from lib/context_dev/models/brand_fonts_params.rb rename to lib/context_dev/models/style_extract_fonts_params.rb index 68274d3e..a38e4d4a 100644 --- a/lib/context_dev/models/brand_fonts_params.rb +++ b/lib/context_dev/models/style_extract_fonts_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#fonts - class BrandFontsParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Style#extract_fonts + class StyleExtractFontsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -24,7 +24,7 @@ class BrandFontsParams < ContextDev::Internal::Type::BaseModel # @!method initialize(domain:, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandFontsParams} for more details. + # {ContextDev::Models::StyleExtractFontsParams} for more details. # # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai # diff --git a/lib/context_dev/models/brand_fonts_response.rb b/lib/context_dev/models/style_extract_fonts_response.rb similarity index 86% rename from lib/context_dev/models/brand_fonts_response.rb rename to lib/context_dev/models/style_extract_fonts_response.rb index e8df49a1..8c71a3cb 100644 --- a/lib/context_dev/models/brand_fonts_response.rb +++ b/lib/context_dev/models/style_extract_fonts_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#fonts - class BrandFontsResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Style#extract_fonts + class StyleExtractFontsResponse < ContextDev::Internal::Type::BaseModel # @!attribute code # HTTP status code, e.g., 200 # @@ -19,8 +19,9 @@ class BrandFontsResponse < ContextDev::Internal::Type::BaseModel # @!attribute fonts # Array of font usage information # - # @return [Array] - required :fonts, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandFontsResponse::Font] } + # @return [Array] + required :fonts, + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::StyleExtractFontsResponse::Font] } # @!attribute status # Status of the response, e.g., 'ok' @@ -33,7 +34,7 @@ class BrandFontsResponse < ContextDev::Internal::Type::BaseModel # # @param domain [String] The normalized domain that was processed # - # @param fonts [Array] Array of font usage information + # @param fonts [Array] Array of font usage information # # @param status [String] Status of the response, e.g., 'ok' diff --git a/lib/context_dev/models/brand_styleguide_params.rb b/lib/context_dev/models/style_extract_styleguide_params.rb similarity index 81% rename from lib/context_dev/models/brand_styleguide_params.rb rename to lib/context_dev/models/style_extract_styleguide_params.rb index b67f6445..82c93ac5 100644 --- a/lib/context_dev/models/brand_styleguide_params.rb +++ b/lib/context_dev/models/style_extract_styleguide_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#styleguide - class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Style#extract_styleguide + class StyleExtractStyleguideParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -27,8 +27,8 @@ class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel # optimizes for higher quality with longer wait times. Defaults to 'quality' if # not provided. # - # @return [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize, nil] - optional :prioritize, enum: -> { ContextDev::BrandStyleguideParams::Prioritize } + # @return [Symbol, ContextDev::Models::StyleExtractStyleguideParams::Prioritize, nil] + optional :prioritize, enum: -> { ContextDev::StyleExtractStyleguideParams::Prioritize } # @!attribute timeout_ms # Optional timeout in milliseconds for the request. If the request takes longer @@ -40,13 +40,13 @@ class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel # @!method initialize(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandStyleguideParams} for more details. + # {ContextDev::Models::StyleExtractStyleguideParams} for more details. # # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio # # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The # - # @param prioritize [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I + # @param prioritize [Symbol, ContextDev::Models::StyleExtractStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # diff --git a/lib/context_dev/models/brand_styleguide_response.rb b/lib/context_dev/models/style_extract_styleguide_response.rb similarity index 73% rename from lib/context_dev/models/brand_styleguide_response.rb rename to lib/context_dev/models/style_extract_styleguide_response.rb index 9e1ace18..057ed40a 100644 --- a/lib/context_dev/models/brand_styleguide_response.rb +++ b/lib/context_dev/models/style_extract_styleguide_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#styleguide - class BrandStyleguideResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Style#extract_styleguide + class StyleExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel # @!attribute code # HTTP status code # @@ -25,8 +25,8 @@ class BrandStyleguideResponse < ContextDev::Internal::Type::BaseModel # @!attribute styleguide # Comprehensive styleguide data extracted from the website # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide, nil] - optional :styleguide, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide, nil] + optional :styleguide, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide } # @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil) # @param code [Integer] HTTP status code @@ -35,64 +35,64 @@ class BrandStyleguideResponse < ContextDev::Internal::Type::BaseModel # # @param status [String] Status of the response, e.g., 'ok' # - # @param styleguide [ContextDev::Models::BrandStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website + # @param styleguide [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website - # @see ContextDev::Models::BrandStyleguideResponse#styleguide + # @see ContextDev::Models::StyleExtractStyleguideResponse#styleguide class Styleguide < ContextDev::Internal::Type::BaseModel # @!attribute colors # Primary colors used on the website # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, nil] - optional :colors, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, nil] + optional :colors, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors } # @!attribute components # UI component styles # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, nil] - optional :components, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, nil] + optional :components, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components } # @!attribute element_spacing # Spacing system used on the website # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, nil] + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, nil] optional :element_spacing, - -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing }, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing }, api_name: :elementSpacing # @!attribute mode # The primary color mode of the website design # - # @return [Symbol, ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode, nil] - optional :mode, enum: -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode } + # @return [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode, nil] + optional :mode, enum: -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode } # @!attribute shadows # Shadow styles used on the website # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, nil] - optional :shadows, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, nil] + optional :shadows, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows } # @!attribute typography # Typography styles used on the website # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography, nil] - optional :typography, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography, nil] + optional :typography, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography } # @!method initialize(colors: nil, components: nil, element_spacing: nil, mode: nil, shadows: nil, typography: nil) # Comprehensive styleguide data extracted from the website # - # @param colors [ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors] Primary colors used on the website + # @param colors [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors] Primary colors used on the website # - # @param components [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components] UI component styles + # @param components [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components] UI component styles # - # @param element_spacing [ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website + # @param element_spacing [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website # - # @param mode [Symbol, ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode] The primary color mode of the website design + # @param mode [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode] The primary color mode of the website design # - # @param shadows [ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website + # @param shadows [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website # - # @param typography [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography] Typography styles used on the website + # @param typography [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography] Typography styles used on the website - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#colors + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#colors class Colors < ContextDev::Internal::Type::BaseModel # @!attribute accent # Accent color of the website (hex format) @@ -122,59 +122,61 @@ class Colors < ContextDev::Internal::Type::BaseModel # @param text [String] Text color of the website (hex format) end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#components + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#components class Components < ContextDev::Internal::Type::BaseModel # @!attribute button # Button component styles # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, nil] - optional :button, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, nil] + optional :button, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button } # @!attribute card # Card component style # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, nil] - optional :card, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card, nil] + optional :card, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card } # @!method initialize(button: nil, card: nil) # UI component styles # - # @param button [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button] Button component styles + # @param button [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button] Button component styles # - # @param card [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card] Card component style + # @param card [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card] Card component style - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Components#button + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components#button class Button < ContextDev::Internal::Type::BaseModel # @!attribute link # Link button style # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, nil] - optional :link, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, nil] + optional :link, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link } # @!attribute primary # Primary button style # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, nil] + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, nil] optional :primary, - -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary } + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary } # @!attribute secondary # Secondary button style # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, nil] + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary, nil] optional :secondary, - -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary } + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary } # @!method initialize(link: nil, primary: nil, secondary: nil) # Button component styles # - # @param link [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link] Link button style + # @param link [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link] Link button style # - # @param primary [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary] Primary button style + # @param primary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary] Primary button style # - # @param secondary [ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary] Secondary button style + # @param secondary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary] Secondary button style - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#link + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#link class Link < ContextDev::Internal::Type::BaseModel # @!attribute background_color # @@ -247,7 +249,7 @@ class Link < ContextDev::Internal::Type::BaseModel # @param text_decoration [String] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#primary + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#primary class Primary < ContextDev::Internal::Type::BaseModel # @!attribute background_color # @@ -320,7 +322,7 @@ class Primary < ContextDev::Internal::Type::BaseModel # @param text_decoration [String] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#secondary + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#secondary class Secondary < ContextDev::Internal::Type::BaseModel # @!attribute background_color # @@ -394,7 +396,7 @@ class Secondary < ContextDev::Internal::Type::BaseModel end end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Components#card + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components#card class Card < ContextDev::Internal::Type::BaseModel # @!attribute background_color # @@ -450,7 +452,7 @@ class Card < ContextDev::Internal::Type::BaseModel end end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#element_spacing + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#element_spacing class ElementSpacing < ContextDev::Internal::Type::BaseModel # @!attribute lg # Large spacing value @@ -498,7 +500,7 @@ class ElementSpacing < ContextDev::Internal::Type::BaseModel # The primary color mode of the website design # - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#mode + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#mode module Mode extend ContextDev::Internal::Type::Enum @@ -509,7 +511,7 @@ module Mode # @return [Array] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#shadows + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#shadows class Shadows < ContextDev::Internal::Type::BaseModel # @!attribute inner # Inner shadow value @@ -555,58 +557,65 @@ class Shadows < ContextDev::Internal::Type::BaseModel # @param xl [String] Extra large shadow value end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide#typography + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#typography class Typography < ContextDev::Internal::Type::BaseModel # @!attribute headings # Heading styles # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, nil] - optional :headings, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, nil] + optional :headings, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings } # @!attribute p_ # Paragraph text styles # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, nil] - optional :p_, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P }, api_name: :p + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P, nil] + optional :p_, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P }, + api_name: :p # @!method initialize(headings: nil, p_: nil) # Typography styles used on the website # - # @param headings [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings] Heading styles + # @param headings [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings] Heading styles # - # @param p_ [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P] Paragraph text styles + # @param p_ [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P] Paragraph text styles - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography#headings + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#headings class Headings < ContextDev::Internal::Type::BaseModel # @!attribute h1 # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, nil] - optional :h1, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, nil] + optional :h1, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1 } # @!attribute h2 # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, nil] - optional :h2, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, nil] + optional :h2, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2 } # @!attribute h3 # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, nil] - optional :h3, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, nil] + optional :h3, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3 } # @!attribute h4 # - # @return [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4, nil] - optional :h4, -> { ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 } + # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4, nil] + optional :h4, + -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 } # @!method initialize(h1: nil, h2: nil, h3: nil, h4: nil) # Heading styles # - # @param h1 [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1] - # @param h2 [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2] - # @param h3 [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3] - # @param h4 [ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4] + # @param h1 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1] + # @param h2 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2] + # @param h3 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3] + # @param h4 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4] - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h1 + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h1 class H1 < ContextDev::Internal::Type::BaseModel # @!attribute font_family # @@ -641,7 +650,7 @@ class H1 < ContextDev::Internal::Type::BaseModel # @param line_height [String] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h2 + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h2 class H2 < ContextDev::Internal::Type::BaseModel # @!attribute font_family # @@ -676,7 +685,7 @@ class H2 < ContextDev::Internal::Type::BaseModel # @param line_height [String] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h3 + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h3 class H3 < ContextDev::Internal::Type::BaseModel # @!attribute font_family # @@ -711,7 +720,7 @@ class H3 < ContextDev::Internal::Type::BaseModel # @param line_height [String] end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h4 + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h4 class H4 < ContextDev::Internal::Type::BaseModel # @!attribute font_family # @@ -747,7 +756,7 @@ class H4 < ContextDev::Internal::Type::BaseModel end end - # @see ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography#p_ + # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#p_ class P < ContextDev::Internal::Type::BaseModel # @!attribute font_family # diff --git a/lib/context_dev/models/brand_prefetch_by_email_params.rb b/lib/context_dev/models/utility_prefetch_by_email_params.rb similarity index 86% rename from lib/context_dev/models/brand_prefetch_by_email_params.rb rename to lib/context_dev/models/utility_prefetch_by_email_params.rb index 9538ac0f..6ee39c3c 100644 --- a/lib/context_dev/models/brand_prefetch_by_email_params.rb +++ b/lib/context_dev/models/utility_prefetch_by_email_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#prefetch_by_email - class BrandPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Utility#prefetch_by_email + class UtilityPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -25,7 +25,7 @@ class BrandPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel # @!method initialize(email:, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandPrefetchByEmailParams} for more details. + # {ContextDev::Models::UtilityPrefetchByEmailParams} for more details. # # @param email [String] Email address to prefetch brand data for. The domain will be extracted from the # diff --git a/lib/context_dev/models/brand_prefetch_by_email_response.rb b/lib/context_dev/models/utility_prefetch_by_email_response.rb similarity index 84% rename from lib/context_dev/models/brand_prefetch_by_email_response.rb rename to lib/context_dev/models/utility_prefetch_by_email_response.rb index ddf92724..accc0694 100644 --- a/lib/context_dev/models/brand_prefetch_by_email_response.rb +++ b/lib/context_dev/models/utility_prefetch_by_email_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#prefetch_by_email - class BrandPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Utility#prefetch_by_email + class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel # @!attribute domain # The domain that was queued for prefetching # diff --git a/lib/context_dev/models/brand_prefetch_params.rb b/lib/context_dev/models/utility_prefetch_params.rb similarity index 85% rename from lib/context_dev/models/brand_prefetch_params.rb rename to lib/context_dev/models/utility_prefetch_params.rb index e58e699c..58b3e170 100644 --- a/lib/context_dev/models/brand_prefetch_params.rb +++ b/lib/context_dev/models/utility_prefetch_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#prefetch - class BrandPrefetchParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Utility#prefetch + class UtilityPrefetchParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -23,7 +23,7 @@ class BrandPrefetchParams < ContextDev::Internal::Type::BaseModel # @!method initialize(domain:, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandPrefetchParams} for more details. + # {ContextDev::Models::UtilityPrefetchParams} for more details. # # @param domain [String] Domain name to prefetch brand data for # diff --git a/lib/context_dev/models/brand_prefetch_response.rb b/lib/context_dev/models/utility_prefetch_response.rb similarity index 86% rename from lib/context_dev/models/brand_prefetch_response.rb rename to lib/context_dev/models/utility_prefetch_response.rb index 14ce574f..ec08d18a 100644 --- a/lib/context_dev/models/brand_prefetch_response.rb +++ b/lib/context_dev/models/utility_prefetch_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#prefetch - class BrandPrefetchResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Utility#prefetch + class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel # @!attribute domain # The domain that was queued for prefetching # diff --git a/lib/context_dev/models/brand_screenshot_params.rb b/lib/context_dev/models/web_screenshot_params.rb similarity index 72% rename from lib/context_dev/models/brand_screenshot_params.rb rename to lib/context_dev/models/web_screenshot_params.rb index db7893e2..26776784 100644 --- a/lib/context_dev/models/brand_screenshot_params.rb +++ b/lib/context_dev/models/web_screenshot_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#screenshot - class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#screenshot + class WebScreenshotParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -19,8 +19,8 @@ class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). # - # @return [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot, nil] - optional :full_screenshot, enum: -> { ContextDev::BrandScreenshotParams::FullScreenshot } + # @return [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot, nil] + optional :full_screenshot, enum: -> { ContextDev::WebScreenshotParams::FullScreenshot } # @!attribute page # Optional parameter to specify which page type to screenshot. If provided, the @@ -28,28 +28,28 @@ class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel # appropriate URL for the specified page type (30 supported languages). If not # provided, screenshots the main domain landing page. # - # @return [Symbol, ContextDev::Models::BrandScreenshotParams::Page, nil] - optional :page, enum: -> { ContextDev::BrandScreenshotParams::Page } + # @return [Symbol, ContextDev::Models::WebScreenshotParams::Page, nil] + optional :page, enum: -> { ContextDev::WebScreenshotParams::Page } # @!attribute prioritize # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for # faster capture with basic quality. If 'quality', optimizes for higher quality # with longer wait times. Defaults to 'quality' if not provided. # - # @return [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize, nil] - optional :prioritize, enum: -> { ContextDev::BrandScreenshotParams::Prioritize } + # @return [Symbol, ContextDev::Models::WebScreenshotParams::Prioritize, nil] + optional :prioritize, enum: -> { ContextDev::WebScreenshotParams::Prioritize } # @!method initialize(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandScreenshotParams} for more details. + # {ContextDev::Models::WebScreenshotParams} for more details. # # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai # - # @param full_screenshot [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc + # @param full_screenshot [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc # - # @param page [Symbol, ContextDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy + # @param page [Symbol, ContextDev::Models::WebScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy # - # @param prioritize [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f + # @param prioritize [Symbol, ContextDev::Models::WebScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/context_dev/models/brand_screenshot_response.rb b/lib/context_dev/models/web_screenshot_response.rb similarity index 74% rename from lib/context_dev/models/brand_screenshot_response.rb rename to lib/context_dev/models/web_screenshot_response.rb index 3f6a6175..270820dd 100644 --- a/lib/context_dev/models/brand_screenshot_response.rb +++ b/lib/context_dev/models/web_screenshot_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#screenshot - class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#screenshot + class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @!attribute code # HTTP status code # @@ -25,9 +25,9 @@ class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel # @!attribute screenshot_type # Type of screenshot that was captured # - # @return [Symbol, ContextDev::Models::BrandScreenshotResponse::ScreenshotType, nil] + # @return [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType, nil] optional :screenshot_type, - enum: -> { ContextDev::Models::BrandScreenshotResponse::ScreenshotType }, + enum: -> { ContextDev::Models::WebScreenshotResponse::ScreenshotType }, api_name: :screenshotType # @!attribute status @@ -43,13 +43,13 @@ class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel # # @param screenshot [String] Public URL of the uploaded screenshot image # - # @param screenshot_type [Symbol, ContextDev::Models::BrandScreenshotResponse::ScreenshotType] Type of screenshot that was captured + # @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured # # @param status [String] Status of the response, e.g., 'ok' # Type of screenshot that was captured # - # @see ContextDev::Models::BrandScreenshotResponse#screenshot_type + # @see ContextDev::Models::WebScreenshotResponse#screenshot_type module ScreenshotType extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_web_scrape_html_params.rb b/lib/context_dev/models/web_web_scrape_html_params.rb similarity index 82% rename from lib/context_dev/models/brand_web_scrape_html_params.rb rename to lib/context_dev/models/web_web_scrape_html_params.rb index 3b2fc449..837e5cbe 100644 --- a/lib/context_dev/models/brand_web_scrape_html_params.rb +++ b/lib/context_dev/models/web_web_scrape_html_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_html - class BrandWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_html + class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/lib/context_dev/models/brand_web_scrape_html_response.rb b/lib/context_dev/models/web_web_scrape_html_response.rb similarity index 61% rename from lib/context_dev/models/brand_web_scrape_html_response.rb rename to lib/context_dev/models/web_web_scrape_html_response.rb index 179191ee..457d41b4 100644 --- a/lib/context_dev/models/brand_web_scrape_html_response.rb +++ b/lib/context_dev/models/web_web_scrape_html_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_html - class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_html + class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @!attribute html # Raw HTML content of the page # @@ -13,8 +13,8 @@ class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @!attribute success # Indicates success # - # @return [Boolean, ContextDev::Models::BrandWebScrapeHTMLResponse::Success] - required :success, enum: -> { ContextDev::Models::BrandWebScrapeHTMLResponse::Success } + # @return [Boolean, ContextDev::Models::WebWebScrapeHTMLResponse::Success] + required :success, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::Success } # @!attribute url # The URL that was scraped @@ -25,13 +25,13 @@ class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @!method initialize(html:, success:, url:) # @param html [String] Raw HTML content of the page # - # @param success [Boolean, ContextDev::Models::BrandWebScrapeHTMLResponse::Success] Indicates success + # @param success [Boolean, ContextDev::Models::WebWebScrapeHTMLResponse::Success] Indicates success # # @param url [String] The URL that was scraped # Indicates success # - # @see ContextDev::Models::BrandWebScrapeHTMLResponse#success + # @see ContextDev::Models::WebWebScrapeHTMLResponse#success module Success extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_web_scrape_images_params.rb b/lib/context_dev/models/web_web_scrape_images_params.rb similarity index 82% rename from lib/context_dev/models/brand_web_scrape_images_params.rb rename to lib/context_dev/models/web_web_scrape_images_params.rb index afd50c53..e33fe0f3 100644 --- a/lib/context_dev/models/brand_web_scrape_images_params.rb +++ b/lib/context_dev/models/web_web_scrape_images_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_images - class BrandWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_images + class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/lib/context_dev/models/brand_web_scrape_images_response.rb b/lib/context_dev/models/web_web_scrape_images_response.rb similarity index 59% rename from lib/context_dev/models/brand_web_scrape_images_response.rb rename to lib/context_dev/models/web_web_scrape_images_response.rb index 7104ac19..59179077 100644 --- a/lib/context_dev/models/brand_web_scrape_images_response.rb +++ b/lib/context_dev/models/web_web_scrape_images_response.rb @@ -2,20 +2,20 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_images - class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_images + class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel # @!attribute images # Array of scraped images # - # @return [Array] + # @return [Array] required :images, - -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandWebScrapeImagesResponse::Image] } + -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] } # @!attribute success # Indicates success # - # @return [Boolean, ContextDev::Models::BrandWebScrapeImagesResponse::Success] - required :success, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Success } + # @return [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] + required :success, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Success } # @!attribute url # The URL that was scraped @@ -24,9 +24,9 @@ class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel required :url, String # @!method initialize(images:, success:, url:) - # @param images [Array] Array of scraped images + # @param images [Array] Array of scraped images # - # @param success [Boolean, ContextDev::Models::BrandWebScrapeImagesResponse::Success] Indicates success + # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Indicates success # # @param url [String] The URL that was scraped @@ -40,8 +40,8 @@ class Image < ContextDev::Internal::Type::BaseModel # @!attribute element # The HTML element the image was found in # - # @return [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element] - required :element, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element } + # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] + required :element, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Element } # @!attribute src # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI @@ -52,21 +52,21 @@ class Image < ContextDev::Internal::Type::BaseModel # @!attribute type # The type/format of the src value # - # @return [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type] - required :type, enum: -> { ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type } + # @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] + required :type, enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::Image::Type } # @!method initialize(alt:, element:, src:, type:) # @param alt [String, nil] Alt text of the image, or null if not present # - # @param element [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element] The HTML element the image was found in + # @param element [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Element] The HTML element the image was found in # # @param src [String] The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI # - # @param type [Symbol, ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type] The type/format of the src value + # @param type [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::Image::Type] The type/format of the src value # The HTML element the image was found in # - # @see ContextDev::Models::BrandWebScrapeImagesResponse::Image#element + # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#element module Element extend ContextDev::Internal::Type::Enum @@ -82,7 +82,7 @@ module Element # The type/format of the src value # - # @see ContextDev::Models::BrandWebScrapeImagesResponse::Image#type + # @see ContextDev::Models::WebWebScrapeImagesResponse::Image#type module Type extend ContextDev::Internal::Type::Enum @@ -97,7 +97,7 @@ module Type # Indicates success # - # @see ContextDev::Models::BrandWebScrapeImagesResponse#success + # @see ContextDev::Models::WebWebScrapeImagesResponse#success module Success extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_web_scrape_md_params.rb b/lib/context_dev/models/web_web_scrape_md_params.rb similarity index 89% rename from lib/context_dev/models/brand_web_scrape_md_params.rb rename to lib/context_dev/models/web_web_scrape_md_params.rb index bf6979bb..fe9ebb9c 100644 --- a/lib/context_dev/models/brand_web_scrape_md_params.rb +++ b/lib/context_dev/models/web_web_scrape_md_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_md - class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_md + class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -34,7 +34,7 @@ class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandWebScrapeMdParams} for more details. + # {ContextDev::Models::WebWebScrapeMdParams} for more details. # # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro # diff --git a/lib/context_dev/models/brand_web_scrape_md_response.rb b/lib/context_dev/models/web_web_scrape_md_response.rb similarity index 63% rename from lib/context_dev/models/brand_web_scrape_md_response.rb rename to lib/context_dev/models/web_web_scrape_md_response.rb index 2e10c662..27669f06 100644 --- a/lib/context_dev/models/brand_web_scrape_md_response.rb +++ b/lib/context_dev/models/web_web_scrape_md_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_md - class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_md + class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @!attribute markdown # Page content converted to GitHub Flavored Markdown # @@ -13,8 +13,8 @@ class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @!attribute success # Indicates success # - # @return [Boolean, ContextDev::Models::BrandWebScrapeMdResponse::Success] - required :success, enum: -> { ContextDev::Models::BrandWebScrapeMdResponse::Success } + # @return [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] + required :success, enum: -> { ContextDev::Models::WebWebScrapeMdResponse::Success } # @!attribute url # The URL that was scraped @@ -25,13 +25,13 @@ class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @!method initialize(markdown:, success:, url:) # @param markdown [String] Page content converted to GitHub Flavored Markdown # - # @param success [Boolean, ContextDev::Models::BrandWebScrapeMdResponse::Success] Indicates success + # @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success # # @param url [String] The URL that was scraped # Indicates success # - # @see ContextDev::Models::BrandWebScrapeMdResponse#success + # @see ContextDev::Models::WebWebScrapeMdResponse#success module Success extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/models/brand_web_scrape_sitemap_params.rb b/lib/context_dev/models/web_web_scrape_sitemap_params.rb similarity index 78% rename from lib/context_dev/models/brand_web_scrape_sitemap_params.rb rename to lib/context_dev/models/web_web_scrape_sitemap_params.rb index e1388296..84ec06a9 100644 --- a/lib/context_dev/models/brand_web_scrape_sitemap_params.rb +++ b/lib/context_dev/models/web_web_scrape_sitemap_params.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_sitemap - class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_sitemap + class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -16,7 +16,7 @@ class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel # @!method initialize(domain:, request_options: {}) # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandWebScrapeSitemapParams} for more details. + # {ContextDev::Models::WebWebScrapeSitemapParams} for more details. # # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto # diff --git a/lib/context_dev/models/brand_web_scrape_sitemap_response.rb b/lib/context_dev/models/web_web_scrape_sitemap_response.rb similarity index 74% rename from lib/context_dev/models/brand_web_scrape_sitemap_response.rb rename to lib/context_dev/models/web_web_scrape_sitemap_response.rb index edd5fdd5..ca75c043 100644 --- a/lib/context_dev/models/brand_web_scrape_sitemap_response.rb +++ b/lib/context_dev/models/web_web_scrape_sitemap_response.rb @@ -2,8 +2,8 @@ module ContextDev module Models - # @see ContextDev::Resources::Brand#web_scrape_sitemap - class BrandWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel + # @see ContextDev::Resources::Web#web_scrape_sitemap + class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel # @!attribute domain # The normalized domain that was crawled # @@ -13,14 +13,14 @@ class BrandWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel # @!attribute meta # Metadata about the sitemap crawl operation # - # @return [ContextDev::Models::BrandWebScrapeSitemapResponse::Meta] - required :meta, -> { ContextDev::Models::BrandWebScrapeSitemapResponse::Meta } + # @return [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] + required :meta, -> { ContextDev::Models::WebWebScrapeSitemapResponse::Meta } # @!attribute success # Indicates success # - # @return [Boolean, ContextDev::Models::BrandWebScrapeSitemapResponse::Success] - required :success, enum: -> { ContextDev::Models::BrandWebScrapeSitemapResponse::Success } + # @return [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] + required :success, enum: -> { ContextDev::Models::WebWebScrapeSitemapResponse::Success } # @!attribute urls # Array of discovered page URLs from the sitemap (max 500) @@ -31,13 +31,13 @@ class BrandWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel # @!method initialize(domain:, meta:, success:, urls:) # @param domain [String] The normalized domain that was crawled # - # @param meta [ContextDev::Models::BrandWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation + # @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation # - # @param success [Boolean, ContextDev::Models::BrandWebScrapeSitemapResponse::Success] Indicates success + # @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success # # @param urls [Array] Array of discovered page URLs from the sitemap (max 500) - # @see ContextDev::Models::BrandWebScrapeSitemapResponse#meta + # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta class Meta < ContextDev::Internal::Type::BaseModel # @!attribute errors # Number of errors encountered during crawling @@ -77,7 +77,7 @@ class Meta < ContextDev::Internal::Type::BaseModel # Indicates success # - # @see ContextDev::Models::BrandWebScrapeSitemapResponse#success + # @see ContextDev::Models::WebWebScrapeSitemapResponse#success module Success extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/resources/ai.rb b/lib/context_dev/resources/ai.rb new file mode 100644 index 00000000..e137de4a --- /dev/null +++ b/lib/context_dev/resources/ai.rb @@ -0,0 +1,99 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class AI + # Some parameter documentations has been truncated, see + # {ContextDev::Models::AIAIQueryParams} for more details. + # + # Use AI to extract specific data points from a brand's website. The AI will crawl + # the website and extract the requested information based on the provided data + # points. + # + # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {}) + # + # @param data_to_extract [Array] Array of data points to extract from the website + # + # @param domain [String] The domain name to analyze + # + # @param specific_pages [ContextDev::Models::AIAIQueryParams::SpecificPages] Optional object specifying which pages to analyze + # + # @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::AIAIQueryResponse] + # + # @see ContextDev::Models::AIAIQueryParams + def ai_query(params) + parsed, options = ContextDev::AIAIQueryParams.dump_request(params) + @client.request( + method: :post, + path: "brand/ai/query", + body: parsed, + model: ContextDev::Models::AIAIQueryResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {ContextDev::Models::AIExtractProductParams} for more details. + # + # Beta feature: Given a single URL, determines if it is a product detail page, + # classifies the platform/product type, and extracts the product information. + # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. + # + # @overload extract_product(url:, timeout_ms: nil, request_options: {}) + # + # @param url [String] The product page URL to extract product data from. + # + # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::AIExtractProductResponse] + # + # @see ContextDev::Models::AIExtractProductParams + def extract_product(params) + parsed, options = ContextDev::AIExtractProductParams.dump_request(params) + @client.request( + method: :post, + path: "brand/ai/product", + body: parsed, + model: ContextDev::Models::AIExtractProductResponse, + options: options + ) + end + + # Beta feature: Extract product information from a brand's website. Brand.dev will + # analyze the website and return a list of products with details such as name, + # description, image, pricing, features, and more. + # + # @overload extract_products(body:, request_options: {}) + # + # @param body [ContextDev::Models::AIExtractProductsParams::Body::ByDomain, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL] + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::AIExtractProductsResponse] + # + # @see ContextDev::Models::AIExtractProductsParams + def extract_products(params) + parsed, options = ContextDev::AIExtractProductsParams.dump_request(params) + @client.request( + method: :post, + path: "brand/ai/products", + body: parsed[:body], + model: ContextDev::Models::AIExtractProductsResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/context_dev/resources/brand.rb b/lib/context_dev/resources/brand.rb index 7050590c..6b92fe35 100644 --- a/lib/context_dev/resources/brand.rb +++ b/lib/context_dev/resources/brand.rb @@ -36,120 +36,6 @@ def retrieve(params) ) end - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIProductParams} for more details. - # - # Beta feature: Given a single URL, determines if it is a product detail page, - # classifies the platform/product type, and extracts the product information. - # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. - # - # @overload ai_product(url:, timeout_ms: nil, request_options: {}) - # - # @param url [String] The product page URL to extract product data from. - # - # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. Maximum allowed value is 30000 - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandAIProductResponse] - # - # @see ContextDev::Models::BrandAIProductParams - def ai_product(params) - parsed, options = ContextDev::BrandAIProductParams.dump_request(params) - @client.request( - method: :post, - path: "brand/ai/product", - body: parsed, - model: ContextDev::Models::BrandAIProductResponse, - options: options - ) - end - - # Beta feature: Extract product information from a brand's website. Brand.dev will - # analyze the website and return a list of products with details such as name, - # description, image, pricing, features, and more. - # - # @overload ai_products(body:, request_options: {}) - # - # @param body [ContextDev::Models::BrandAIProductsParams::Body::ByDomain, ContextDev::Models::BrandAIProductsParams::Body::ByDirectURL] - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandAIProductsResponse] - # - # @see ContextDev::Models::BrandAIProductsParams - def ai_products(params) - parsed, options = ContextDev::BrandAIProductsParams.dump_request(params) - @client.request( - method: :post, - path: "brand/ai/products", - body: parsed[:body], - model: ContextDev::Models::BrandAIProductsResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandAIQueryParams} for more details. - # - # Use AI to extract specific data points from a brand's website. The AI will crawl - # the website and extract the requested information based on the provided data - # points. - # - # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {}) - # - # @param data_to_extract [Array] Array of data points to extract from the website - # - # @param domain [String] The domain name to analyze - # - # @param specific_pages [ContextDev::Models::BrandAIQueryParams::SpecificPages] Optional object specifying which pages to analyze - # - # @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::BrandAIQueryResponse] - # - # @see ContextDev::Models::BrandAIQueryParams - def ai_query(params) - parsed, options = ContextDev::BrandAIQueryParams.dump_request(params) - @client.request( - method: :post, - path: "brand/ai/query", - body: parsed, - model: ContextDev::Models::BrandAIQueryResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandFontsParams} for more details. - # - # Extract font information from a brand's website including font families, usage - # statistics, fallbacks, and element/word counts. - # - # @overload fonts(domain:, timeout_ms: nil, request_options: {}) - # - # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai - # - # @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::BrandFontsResponse] - # - # @see ContextDev::Models::BrandFontsParams - def fonts(params) - parsed, options = ContextDev::BrandFontsParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/fonts", - query: query.transform_keys(timeout_ms: "timeoutMS"), - model: ContextDev::Models::BrandFontsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {ContextDev::Models::BrandIdentifyFromTransactionParams} for more details. # @@ -193,68 +79,6 @@ def identify_from_transaction(params) ) end - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandPrefetchParams} for more details. - # - # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint does not charge credits and is available for paid - # customers to optimize future requests. [You must be on a paid plan to use this - # endpoint] - # - # @overload prefetch(domain:, timeout_ms: nil, request_options: {}) - # - # @param domain [String] Domain name to prefetch brand data for - # - # @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::BrandPrefetchResponse] - # - # @see ContextDev::Models::BrandPrefetchParams - def prefetch(params) - parsed, options = ContextDev::BrandPrefetchParams.dump_request(params) - @client.request( - method: :post, - path: "brand/prefetch", - body: parsed, - model: ContextDev::Models::BrandPrefetchResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandPrefetchByEmailParams} for more details. - # - # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint accepts an email address, extracts the domain from it, - # validates that it's not a disposable or free email provider, and queues the - # domain for prefetching. This endpoint does not charge credits and is available - # for paid customers to optimize future requests. [You must be on a paid plan to - # use this endpoint] - # - # @overload prefetch_by_email(email:, timeout_ms: nil, request_options: {}) - # - # @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}, nil] - # - # @return [ContextDev::Models::BrandPrefetchByEmailResponse] - # - # @see ContextDev::Models::BrandPrefetchByEmailParams - def prefetch_by_email(params) - parsed, options = ContextDev::BrandPrefetchByEmailParams.dump_request(params) - @client.request( - method: :post, - path: "brand/prefetch-by-email", - body: parsed, - model: ContextDev::Models::BrandPrefetchByEmailResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {ContextDev::Models::BrandRetrieveByEmailParams} for more details. # @@ -394,42 +218,6 @@ def retrieve_by_ticker(params) ) end - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandRetrieveNaicsParams} for more details. - # - # Endpoint to classify any brand into a 2022 NAICS code. - # - # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {}) - # - # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # - # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5 - # - # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - # - # @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::BrandRetrieveNaicsResponse] - # - # @see ContextDev::Models::BrandRetrieveNaicsParams - def retrieve_naics(params) - parsed, options = ContextDev::BrandRetrieveNaicsParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/naics", - query: query.transform_keys( - max_results: "maxResults", - min_results: "minResults", - timeout_ms: "timeoutMS" - ), - model: ContextDev::Models::BrandRetrieveNaicsResponse, - options: options - ) - end - # Some parameter documentations has been truncated, see # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details. # @@ -460,191 +248,6 @@ def retrieve_simplified(params) ) end - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandScreenshotParams} for more details. - # - # Capture a screenshot of a website. Supports both viewport (standard browser - # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to - # the uploaded screenshot image hosted on our CDN. - # - # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) - # - # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai - # - # @param full_screenshot [Symbol, ContextDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc - # - # @param page [Symbol, ContextDev::Models::BrandScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy - # - # @param prioritize [Symbol, ContextDev::Models::BrandScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandScreenshotResponse] - # - # @see ContextDev::Models::BrandScreenshotParams - def screenshot(params) - parsed, options = ContextDev::BrandScreenshotParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/screenshot", - query: query.transform_keys(full_screenshot: "fullScreenshot"), - model: ContextDev::Models::BrandScreenshotResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandStyleguideParams} for more details. - # - # Automatically extract comprehensive design system information from a brand's - # website including colors, typography, spacing, shadows, and UI components. - # Either 'domain' or 'directUrl' must be provided as a query parameter, but not - # both. - # - # @overload styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {}) - # - # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio - # - # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # - # @param prioritize [Symbol, ContextDev::Models::BrandStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I - # - # @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::BrandStyleguideResponse] - # - # @see ContextDev::Models::BrandStyleguideParams - def styleguide(params = {}) - parsed, options = ContextDev::BrandStyleguideParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "brand/styleguide", - query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"), - model: ContextDev::Models::BrandStyleguideResponse, - options: options - ) - end - - # Scrapes the given URL and returns the raw HTML content of the page. Uses - # automatic proxy escalation to handle blocked sites. - # - # @overload web_scrape_html(url:, request_options: {}) - # - # @param url [String] Full URL to scrape (must include http:// or https:// protocol) - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandWebScrapeHTMLResponse] - # - # @see ContextDev::Models::BrandWebScrapeHTMLParams - def web_scrape_html(params) - parsed, options = ContextDev::BrandWebScrapeHTMLParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "web/scrape/html", - query: query, - model: ContextDev::Models::BrandWebScrapeHTMLResponse, - options: options - ) - end - - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. - # - # @overload web_scrape_images(url:, request_options: {}) - # - # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandWebScrapeImagesResponse] - # - # @see ContextDev::Models::BrandWebScrapeImagesParams - def web_scrape_images(params) - parsed, options = ContextDev::BrandWebScrapeImagesParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "web/scrape/images", - query: query, - model: ContextDev::Models::BrandWebScrapeImagesResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandWebScrapeMdParams} for more details. - # - # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown - # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked - # sites. - # - # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {}) - # - # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro - # - # @param include_images [Boolean] Include image references in Markdown output - # - # @param include_links [Boolean] Preserve hyperlinks in Markdown output - # - # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandWebScrapeMdResponse] - # - # @see ContextDev::Models::BrandWebScrapeMdParams - def web_scrape_md(params) - parsed, options = ContextDev::BrandWebScrapeMdParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "web/scrape/markdown", - query: query.transform_keys( - include_images: "includeImages", - include_links: "includeLinks", - shorten_base64_images: "shortenBase64Images" - ), - model: ContextDev::Models::BrandWebScrapeMdResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {ContextDev::Models::BrandWebScrapeSitemapParams} for more details. - # - # Crawls the sitemap of the given domain and returns all discovered page URLs. - # Supports sitemap index files (recursive), parallel fetching with concurrency - # control, deduplication, and filters out non-page resources (images, PDFs, etc.). - # - # @overload web_scrape_sitemap(domain:, request_options: {}) - # - # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto - # - # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [ContextDev::Models::BrandWebScrapeSitemapResponse] - # - # @see ContextDev::Models::BrandWebScrapeSitemapParams - def web_scrape_sitemap(params) - parsed, options = ContextDev::BrandWebScrapeSitemapParams.dump_request(params) - query = ContextDev::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "web/scrape/sitemap", - query: query, - model: ContextDev::Models::BrandWebScrapeSitemapResponse, - options: options - ) - end - # @api private # # @param client [ContextDev::Client] diff --git a/lib/context_dev/resources/industry.rb b/lib/context_dev/resources/industry.rb new file mode 100644 index 00000000..fc0d4171 --- /dev/null +++ b/lib/context_dev/resources/industry.rb @@ -0,0 +1,50 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class Industry + # Some parameter documentations has been truncated, see + # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details. + # + # Endpoint to classify any brand into a 2022 NAICS code. + # + # @overload retrieve_naics(input:, max_results: nil, min_results: nil, timeout_ms: nil, request_options: {}) + # + # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided + # + # @param max_results [Integer] Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5 + # + # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. + # + # @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::IndustryRetrieveNaicsResponse] + # + # @see ContextDev::Models::IndustryRetrieveNaicsParams + def retrieve_naics(params) + parsed, options = ContextDev::IndustryRetrieveNaicsParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "brand/naics", + query: query.transform_keys( + max_results: "maxResults", + min_results: "minResults", + timeout_ms: "timeoutMS" + ), + model: ContextDev::Models::IndustryRetrieveNaicsResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/context_dev/resources/style.rb b/lib/context_dev/resources/style.rb new file mode 100644 index 00000000..33a2daca --- /dev/null +++ b/lib/context_dev/resources/style.rb @@ -0,0 +1,78 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class Style + # Some parameter documentations has been truncated, see + # {ContextDev::Models::StyleExtractFontsParams} for more details. + # + # Extract font information from a brand's website including font families, usage + # statistics, fallbacks, and element/word counts. + # + # @overload extract_fonts(domain:, timeout_ms: nil, request_options: {}) + # + # @param domain [String] Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The domai + # + # @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::StyleExtractFontsResponse] + # + # @see ContextDev::Models::StyleExtractFontsParams + def extract_fonts(params) + parsed, options = ContextDev::StyleExtractFontsParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "brand/fonts", + query: query.transform_keys(timeout_ms: "timeoutMS"), + model: ContextDev::Models::StyleExtractFontsResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {ContextDev::Models::StyleExtractStyleguideParams} for more details. + # + # Automatically extract comprehensive design system information from a brand's + # website including colors, typography, spacing, shadows, and UI components. + # Either 'domain' or 'directUrl' must be provided as a query parameter, but not + # both. + # + # @overload extract_styleguide(direct_url: nil, domain: nil, prioritize: nil, timeout_ms: nil, request_options: {}) + # + # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio + # + # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The + # + # @param prioritize [Symbol, ContextDev::Models::StyleExtractStyleguideParams::Prioritize] Optional parameter to prioritize screenshot capture for styleguide extraction. I + # + # @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::StyleExtractStyleguideResponse] + # + # @see ContextDev::Models::StyleExtractStyleguideParams + def extract_styleguide(params = {}) + parsed, options = ContextDev::StyleExtractStyleguideParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "brand/styleguide", + query: query.transform_keys(direct_url: "directUrl", timeout_ms: "timeoutMS"), + model: ContextDev::Models::StyleExtractStyleguideResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/context_dev/resources/utility.rb b/lib/context_dev/resources/utility.rb new file mode 100644 index 00000000..83849e53 --- /dev/null +++ b/lib/context_dev/resources/utility.rb @@ -0,0 +1,76 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class Utility + # Some parameter documentations has been truncated, see + # {ContextDev::Models::UtilityPrefetchParams} for more details. + # + # Signal that you may fetch brand data for a particular domain soon to improve + # latency. This endpoint does not charge credits and is available for paid + # customers to optimize future requests. [You must be on a paid plan to use this + # endpoint] + # + # @overload prefetch(domain:, timeout_ms: nil, request_options: {}) + # + # @param domain [String] Domain name to prefetch brand data for + # + # @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::UtilityPrefetchResponse] + # + # @see ContextDev::Models::UtilityPrefetchParams + def prefetch(params) + parsed, options = ContextDev::UtilityPrefetchParams.dump_request(params) + @client.request( + method: :post, + path: "brand/prefetch", + body: parsed, + model: ContextDev::Models::UtilityPrefetchResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {ContextDev::Models::UtilityPrefetchByEmailParams} for more details. + # + # Signal that you may fetch brand data for a particular domain soon to improve + # latency. This endpoint accepts an email address, extracts the domain from it, + # validates that it's not a disposable or free email provider, and queues the + # domain for prefetching. This endpoint does not charge credits and is available + # for paid customers to optimize future requests. [You must be on a paid plan to + # use this endpoint] + # + # @overload prefetch_by_email(email:, timeout_ms: nil, request_options: {}) + # + # @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}, nil] + # + # @return [ContextDev::Models::UtilityPrefetchByEmailResponse] + # + # @see ContextDev::Models::UtilityPrefetchByEmailParams + def prefetch_by_email(params) + parsed, options = ContextDev::UtilityPrefetchByEmailParams.dump_request(params) + @client.request( + method: :post, + path: "brand/prefetch-by-email", + body: parsed, + model: ContextDev::Models::UtilityPrefetchByEmailResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb new file mode 100644 index 00000000..cace8769 --- /dev/null +++ b/lib/context_dev/resources/web.rb @@ -0,0 +1,164 @@ +# frozen_string_literal: true + +module ContextDev + module Resources + class Web + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebScreenshotParams} for more details. + # + # Capture a screenshot of a website. Supports both viewport (standard browser + # view) and full-page screenshots. Can also screenshot specific page types (login, + # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to + # the uploaded screenshot image hosted on our CDN. + # + # @overload screenshot(domain:, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # + # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai + # + # @param full_screenshot [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc + # + # @param page [Symbol, ContextDev::Models::WebScreenshotParams::Page] Optional parameter to specify which page type to screenshot. If provided, the sy + # + # @param prioritize [Symbol, ContextDev::Models::WebScreenshotParams::Prioritize] Optional parameter to prioritize screenshot capture. If 'speed', optimizes for f + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::WebScreenshotResponse] + # + # @see ContextDev::Models::WebScreenshotParams + def screenshot(params) + parsed, options = ContextDev::WebScreenshotParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "brand/screenshot", + query: query.transform_keys(full_screenshot: "fullScreenshot"), + model: ContextDev::Models::WebScreenshotResponse, + options: options + ) + end + + # Scrapes the given URL and returns the raw HTML content of the page. Uses + # automatic proxy escalation to handle blocked sites. + # + # @overload web_scrape_html(url:, request_options: {}) + # + # @param url [String] Full URL to scrape (must include http:// or https:// protocol) + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::WebWebScrapeHTMLResponse] + # + # @see ContextDev::Models::WebWebScrapeHTMLParams + def web_scrape_html(params) + parsed, options = ContextDev::WebWebScrapeHTMLParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "web/scrape/html", + query: query, + model: ContextDev::Models::WebWebScrapeHTMLResponse, + options: options + ) + end + + # Scrapes all images from the given URL. Extracts images from img, svg, + # picture/source, link, and video elements including inline SVGs, base64 data + # URIs, and standard URLs. + # + # @overload web_scrape_images(url:, request_options: {}) + # + # @param url [String] Full URL to scrape images from (must include http:// or https:// protocol) + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::WebWebScrapeImagesResponse] + # + # @see ContextDev::Models::WebWebScrapeImagesParams + def web_scrape_images(params) + parsed, options = ContextDev::WebWebScrapeImagesParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "web/scrape/images", + query: query, + model: ContextDev::Models::WebWebScrapeImagesResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeMdParams} for more details. + # + # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown + # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked + # sites. + # + # @overload web_scrape_md(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, request_options: {}) + # + # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro + # + # @param include_images [Boolean] Include image references in Markdown output + # + # @param include_links [Boolean] Preserve hyperlinks in Markdown output + # + # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::WebWebScrapeMdResponse] + # + # @see ContextDev::Models::WebWebScrapeMdParams + def web_scrape_md(params) + parsed, options = ContextDev::WebWebScrapeMdParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "web/scrape/markdown", + query: query.transform_keys( + include_images: "includeImages", + include_links: "includeLinks", + shorten_base64_images: "shortenBase64Images" + ), + model: ContextDev::Models::WebWebScrapeMdResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeSitemapParams} for more details. + # + # Crawls the sitemap of the given domain and returns all discovered page URLs. + # Supports sitemap index files (recursive), parallel fetching with concurrency + # control, deduplication, and filters out non-page resources (images, PDFs, etc.). + # + # @overload web_scrape_sitemap(domain:, request_options: {}) + # + # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto + # + # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [ContextDev::Models::WebWebScrapeSitemapResponse] + # + # @see ContextDev::Models::WebWebScrapeSitemapParams + def web_scrape_sitemap(params) + parsed, options = ContextDev::WebWebScrapeSitemapParams.dump_request(params) + query = ContextDev::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "web/scrape/sitemap", + query: query, + model: ContextDev::Models::WebWebScrapeSitemapResponse, + options: options + ) + end + + # @api private + # + # @param client [ContextDev::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 7fdff81d..5eaf3802 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "0.1.0" + VERSION = "0.2.0" end diff --git a/rbi/context_dev/client.rbi b/rbi/context_dev/client.rbi index 02390c46..e54985c8 100644 --- a/rbi/context_dev/client.rbi +++ b/rbi/context_dev/client.rbi @@ -13,9 +13,24 @@ module ContextDev sig { returns(String) } attr_reader :api_key + sig { returns(ContextDev::Resources::Web) } + attr_reader :web + + sig { returns(ContextDev::Resources::AI) } + attr_reader :ai + + sig { returns(ContextDev::Resources::Style) } + attr_reader :style + sig { returns(ContextDev::Resources::Brand) } attr_reader :brand + sig { returns(ContextDev::Resources::Industry) } + attr_reader :industry + + sig { returns(ContextDev::Resources::Utility) } + attr_reader :utility + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers diff --git a/rbi/context_dev/models.rbi b/rbi/context_dev/models.rbi index 6ec25312..3bcbeafe 100644 --- a/rbi/context_dev/models.rbi +++ b/rbi/context_dev/models.rbi @@ -1,21 +1,15 @@ # typed: strong module ContextDev - BrandAIProductParams = ContextDev::Models::BrandAIProductParams + AIAIQueryParams = ContextDev::Models::AIAIQueryParams - BrandAIProductsParams = ContextDev::Models::BrandAIProductsParams + AIExtractProductParams = ContextDev::Models::AIExtractProductParams - BrandAIQueryParams = ContextDev::Models::BrandAIQueryParams - - BrandFontsParams = ContextDev::Models::BrandFontsParams + AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams - BrandPrefetchByEmailParams = ContextDev::Models::BrandPrefetchByEmailParams - - BrandPrefetchParams = ContextDev::Models::BrandPrefetchParams - BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams @@ -24,22 +18,30 @@ module ContextDev BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams - BrandRetrieveNaicsParams = ContextDev::Models::BrandRetrieveNaicsParams - BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams - BrandScreenshotParams = ContextDev::Models::BrandScreenshotParams + IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams + + StyleExtractFontsParams = ContextDev::Models::StyleExtractFontsParams + + StyleExtractStyleguideParams = + ContextDev::Models::StyleExtractStyleguideParams + + UtilityPrefetchByEmailParams = + ContextDev::Models::UtilityPrefetchByEmailParams + + UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams - BrandStyleguideParams = ContextDev::Models::BrandStyleguideParams + WebScreenshotParams = ContextDev::Models::WebScreenshotParams - BrandWebScrapeHTMLParams = ContextDev::Models::BrandWebScrapeHTMLParams + WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams - BrandWebScrapeImagesParams = ContextDev::Models::BrandWebScrapeImagesParams + WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams - BrandWebScrapeMdParams = ContextDev::Models::BrandWebScrapeMdParams + WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams - BrandWebScrapeSitemapParams = ContextDev::Models::BrandWebScrapeSitemapParams + WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams end diff --git a/rbi/context_dev/models/brand_ai_query_params.rbi b/rbi/context_dev/models/ai_ai_query_params.rbi similarity index 74% rename from rbi/context_dev/models/brand_ai_query_params.rbi rename to rbi/context_dev/models/ai_ai_query_params.rbi index f5d92faf..d7aa7632 100644 --- a/rbi/context_dev/models/brand_ai_query_params.rbi +++ b/rbi/context_dev/models/ai_ai_query_params.rbi @@ -2,17 +2,17 @@ module ContextDev module Models - class BrandAIQueryParams < ContextDev::Internal::Type::BaseModel + 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::BrandAIQueryParams, ContextDev::Internal::AnyHash) + T.any(ContextDev::AIAIQueryParams, ContextDev::Internal::AnyHash) end # Array of data points to extract from the website - sig { returns(T::Array[ContextDev::BrandAIQueryParams::DataToExtract]) } + sig { returns(T::Array[ContextDev::AIAIQueryParams::DataToExtract]) } attr_accessor :data_to_extract # The domain name to analyze @@ -20,12 +20,12 @@ module ContextDev attr_accessor :domain # Optional object specifying which pages to analyze - sig { returns(T.nilable(ContextDev::BrandAIQueryParams::SpecificPages)) } + sig { returns(T.nilable(ContextDev::AIAIQueryParams::SpecificPages)) } attr_reader :specific_pages sig do params( - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages::OrHash + specific_pages: ContextDev::AIAIQueryParams::SpecificPages::OrHash ).void end attr_writer :specific_pages @@ -42,9 +42,9 @@ module ContextDev sig do params( data_to_extract: - T::Array[ContextDev::BrandAIQueryParams::DataToExtract::OrHash], + T::Array[ContextDev::AIAIQueryParams::DataToExtract::OrHash], domain: String, - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages::OrHash, + specific_pages: ContextDev::AIAIQueryParams::SpecificPages::OrHash, timeout_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -68,9 +68,9 @@ module ContextDev override.returns( { data_to_extract: - T::Array[ContextDev::BrandAIQueryParams::DataToExtract], + T::Array[ContextDev::AIAIQueryParams::DataToExtract], domain: String, - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages, + specific_pages: ContextDev::AIAIQueryParams::SpecificPages, timeout_ms: Integer, request_options: ContextDev::RequestOptions } @@ -83,7 +83,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::BrandAIQueryParams::DataToExtract, + ContextDev::AIAIQueryParams::DataToExtract, ContextDev::Internal::AnyHash ) end @@ -103,7 +103,7 @@ module ContextDev # Type of the data point sig do returns( - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol ) end attr_accessor :datapoint_type @@ -113,7 +113,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol ) ) end @@ -122,7 +122,7 @@ module ContextDev sig do params( datapoint_list_type: - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol ).void end attr_writer :datapoint_list_type @@ -134,7 +134,7 @@ module ContextDev T.nilable( T::Hash[ Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol ] ) ) @@ -146,7 +146,7 @@ module ContextDev datapoint_object_schema: T::Hash[ Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol ] ).void end @@ -158,13 +158,13 @@ module ContextDev datapoint_example: String, datapoint_name: String, datapoint_type: - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol, + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol, datapoint_list_type: - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::OrSymbol, + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol, datapoint_object_schema: T::Hash[ Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol ] ).returns(T.attached_class) end @@ -193,13 +193,13 @@ module ContextDev datapoint_example: String, datapoint_name: String, datapoint_type: - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::OrSymbol, + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::OrSymbol, datapoint_list_type: - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::OrSymbol, + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::OrSymbol, datapoint_object_schema: T::Hash[ Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::OrSymbol ] } ) @@ -215,7 +215,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType + ContextDev::AIAIQueryParams::DataToExtract::DatapointType ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -223,38 +223,38 @@ module ContextDev TEXT = T.let( :text, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) NUMBER = T.let( :number, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) DATE = T.let( :date, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) BOOLEAN = T.let( :boolean, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) LIST = T.let( :list, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) URL = T.let( :url, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::BrandAIQueryParams::DataToExtract::DatapointType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointType::TaggedSymbol ] ) end @@ -271,7 +271,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -279,48 +279,48 @@ module ContextDev STRING = T.let( :string, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) TEXT = T.let( :text, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) NUMBER = T.let( :number, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) DATE = T.let( :date, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) BOOLEAN = T.let( :boolean, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) LIST = T.let( :list, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) URL = T.let( :url, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) OBJECT = T.let( :object, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::BrandAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointListType::TaggedSymbol ] ) end @@ -335,7 +335,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -343,28 +343,28 @@ module ContextDev STRING = T.let( :string, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol ) NUMBER = T.let( :number, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol ) DATE = T.let( :date, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol ) BOOLEAN = T.let( :boolean, - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::BrandAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol + ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema::TaggedSymbol ] ) end @@ -377,7 +377,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::BrandAIQueryParams::SpecificPages, + ContextDev::AIAIQueryParams::SpecificPages, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_ai_query_response.rbi b/rbi/context_dev/models/ai_ai_query_response.rbi similarity index 82% rename from rbi/context_dev/models/brand_ai_query_response.rbi rename to rbi/context_dev/models/ai_ai_query_response.rbi index 2da060ca..09a245f3 100644 --- a/rbi/context_dev/models/brand_ai_query_response.rbi +++ b/rbi/context_dev/models/ai_ai_query_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandAIQueryResponse < ContextDev::Internal::Type::BaseModel + class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIQueryResponse, + ContextDev::Models::AIAIQueryResponse, ContextDev::Internal::AnyHash ) end @@ -15,7 +15,7 @@ module ContextDev sig do returns( T.nilable( - T::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted] + T::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted] ) ) end @@ -25,7 +25,7 @@ module ContextDev params( data_extracted: T::Array[ - ContextDev::Models::BrandAIQueryResponse::DataExtracted::OrHash + ContextDev::Models::AIAIQueryResponse::DataExtracted::OrHash ] ).void end @@ -56,7 +56,7 @@ module ContextDev params( data_extracted: T::Array[ - ContextDev::Models::BrandAIQueryResponse::DataExtracted::OrHash + ContextDev::Models::AIAIQueryResponse::DataExtracted::OrHash ], domain: String, status: String, @@ -79,7 +79,7 @@ module ContextDev override.returns( { data_extracted: - T::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted], + T::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, status: String, urls_analyzed: T::Array[String] @@ -93,7 +93,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIQueryResponse::DataExtracted, + ContextDev::Models::AIAIQueryResponse::DataExtracted, ContextDev::Internal::AnyHash ) end @@ -110,7 +110,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants + ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::Variants ) ) end @@ -119,7 +119,7 @@ module ContextDev sig do params( datapoint_value: - ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants + ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::Variants ).void end attr_writer :datapoint_value @@ -128,7 +128,7 @@ module ContextDev params( datapoint_name: String, datapoint_value: - ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants + ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::Variants ).returns(T.attached_class) end def self.new( @@ -145,7 +145,7 @@ module ContextDev { datapoint_name: String, datapoint_value: - ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants + ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::Variants } ) end @@ -172,7 +172,7 @@ module ContextDev sig do override.returns( T::Array[ - ContextDev::Models::BrandAIQueryResponse::DataExtracted::DatapointValue::Variants + ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::Variants ] ) end diff --git a/rbi/context_dev/models/brand_ai_product_params.rbi b/rbi/context_dev/models/ai_extract_product_params.rbi similarity index 87% rename from rbi/context_dev/models/brand_ai_product_params.rbi rename to rbi/context_dev/models/ai_extract_product_params.rbi index 823ecee1..0a8934d5 100644 --- a/rbi/context_dev/models/brand_ai_product_params.rbi +++ b/rbi/context_dev/models/ai_extract_product_params.rbi @@ -2,13 +2,16 @@ module ContextDev module Models - class BrandAIProductParams < ContextDev::Internal::Type::BaseModel + class AIExtractProductParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(ContextDev::BrandAIProductParams, ContextDev::Internal::AnyHash) + T.any( + ContextDev::AIExtractProductParams, + ContextDev::Internal::AnyHash + ) end # The product page URL to extract product data from. diff --git a/rbi/context_dev/models/brand_ai_product_response.rbi b/rbi/context_dev/models/ai_extract_product_response.rbi similarity index 73% rename from rbi/context_dev/models/brand_ai_product_response.rbi rename to rbi/context_dev/models/ai_extract_product_response.rbi index 4b5da477..a5dacb86 100644 --- a/rbi/context_dev/models/brand_ai_product_response.rbi +++ b/rbi/context_dev/models/ai_extract_product_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel + class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIProductResponse, + ContextDev::Models::AIExtractProductResponse, ContextDev::Internal::AnyHash ) end @@ -22,7 +22,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ) ) end @@ -30,7 +30,9 @@ module ContextDev # The extracted product data, or null if not a product page sig do - returns(T.nilable(ContextDev::Models::BrandAIProductResponse::Product)) + returns( + T.nilable(ContextDev::Models::AIExtractProductResponse::Product) + ) end attr_reader :product @@ -38,7 +40,7 @@ module ContextDev params( product: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::OrHash + ContextDev::Models::AIExtractProductResponse::Product::OrHash ) ).void end @@ -49,11 +51,11 @@ module ContextDev is_product_page: T::Boolean, platform: T.nilable( - ContextDev::Models::BrandAIProductResponse::Platform::OrSymbol + ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol ), product: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::OrHash + ContextDev::Models::AIExtractProductResponse::Product::OrHash ) ).returns(T.attached_class) end @@ -73,10 +75,10 @@ module ContextDev is_product_page: T::Boolean, platform: T.nilable( - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ), product: - T.nilable(ContextDev::Models::BrandAIProductResponse::Product) + T.nilable(ContextDev::Models::AIExtractProductResponse::Product) } ) end @@ -89,35 +91,38 @@ module ContextDev TaggedSymbol = T.type_alias do - T.all(Symbol, ContextDev::Models::BrandAIProductResponse::Platform) + T.all( + Symbol, + ContextDev::Models::AIExtractProductResponse::Platform + ) end OrSymbol = T.type_alias { T.any(Symbol, String) } AMAZON = T.let( :amazon, - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ) TIKTOK_SHOP = T.let( :tiktok_shop, - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ) ETSY = T.let( :etsy, - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ) GENERIC = T.let( :generic, - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandAIProductResponse::Platform::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol ] ) end @@ -129,7 +134,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIProductResponse::Product, + ContextDev::Models::AIExtractProductResponse::Product, ContextDev::Internal::AnyHash ) end @@ -162,7 +167,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ) ) end @@ -188,7 +193,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) ) end @@ -209,7 +214,7 @@ module ContextDev target_audience: T::Array[String], billing_frequency: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::OrSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::OrSymbol ), category: T.nilable(String), currency: T.nilable(String), @@ -217,7 +222,7 @@ module ContextDev price: T.nilable(Float), pricing_model: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::OrSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::OrSymbol ), url: T.nilable(String) ).returns(T.attached_class) @@ -263,7 +268,7 @@ module ContextDev target_audience: T::Array[String], billing_frequency: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ), category: T.nilable(String), currency: T.nilable(String), @@ -271,7 +276,7 @@ module ContextDev price: T.nilable(Float), pricing_model: T.nilable( - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ), url: T.nilable(String) } @@ -288,7 +293,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -296,28 +301,28 @@ module ContextDev MONTHLY = T.let( :monthly, - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ) YEARLY = T.let( :yearly, - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ) ONE_TIME = T.let( :one_time, - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ) USAGE_BASED = T.let( :usage_based, - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandAIProductResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency::TaggedSymbol ] ) end @@ -333,7 +338,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel + ContextDev::Models::AIExtractProductResponse::Product::PricingModel ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -341,33 +346,33 @@ module ContextDev PER_SEAT = T.let( :per_seat, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) FLAT = T.let( :flat, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) TIERED = T.let( :tiered, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) FREEMIUM = T.let( :freemium, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) CUSTOM = T.let( :custom, - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandAIProductResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductResponse::Product::PricingModel::TaggedSymbol ] ) end diff --git a/rbi/context_dev/models/brand_ai_products_params.rbi b/rbi/context_dev/models/ai_extract_products_params.rbi similarity index 83% rename from rbi/context_dev/models/brand_ai_products_params.rbi rename to rbi/context_dev/models/ai_extract_products_params.rbi index 3fcc2b12..c0d91f62 100644 --- a/rbi/context_dev/models/brand_ai_products_params.rbi +++ b/rbi/context_dev/models/ai_extract_products_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandAIProductsParams < ContextDev::Internal::Type::BaseModel + class AIExtractProductsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandAIProductsParams, + ContextDev::AIExtractProductsParams, ContextDev::Internal::AnyHash ) end @@ -17,8 +17,8 @@ module ContextDev sig do returns( T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain, - ContextDev::BrandAIProductsParams::Body::ByDirectURL + ContextDev::AIExtractProductsParams::Body::ByDomain, + ContextDev::AIExtractProductsParams::Body::ByDirectURL ) ) end @@ -28,8 +28,8 @@ module ContextDev params( body: T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain::OrHash, - ContextDev::BrandAIProductsParams::Body::ByDirectURL::OrHash + ContextDev::AIExtractProductsParams::Body::ByDomain::OrHash, + ContextDev::AIExtractProductsParams::Body::ByDirectURL::OrHash ), request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -42,8 +42,8 @@ module ContextDev { body: T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain, - ContextDev::BrandAIProductsParams::Body::ByDirectURL + ContextDev::AIExtractProductsParams::Body::ByDomain, + ContextDev::AIExtractProductsParams::Body::ByDirectURL ), request_options: ContextDev::RequestOptions } @@ -58,8 +58,8 @@ module ContextDev Variants = T.type_alias do T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain, - ContextDev::BrandAIProductsParams::Body::ByDirectURL + ContextDev::AIExtractProductsParams::Body::ByDomain, + ContextDev::AIExtractProductsParams::Body::ByDirectURL ) end @@ -67,7 +67,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain, + ContextDev::AIExtractProductsParams::Body::ByDomain, ContextDev::Internal::AnyHash ) end @@ -122,7 +122,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::BrandAIProductsParams::Body::ByDirectURL, + ContextDev::AIExtractProductsParams::Body::ByDirectURL, ContextDev::Internal::AnyHash ) end @@ -177,7 +177,7 @@ module ContextDev sig do override.returns( - T::Array[ContextDev::BrandAIProductsParams::Body::Variants] + T::Array[ContextDev::AIExtractProductsParams::Body::Variants] ) end def self.variants diff --git a/rbi/context_dev/models/brand_ai_products_response.rbi b/rbi/context_dev/models/ai_extract_products_response.rbi similarity index 75% rename from rbi/context_dev/models/brand_ai_products_response.rbi rename to rbi/context_dev/models/ai_extract_products_response.rbi index aa937bc3..495aefee 100644 --- a/rbi/context_dev/models/brand_ai_products_response.rbi +++ b/rbi/context_dev/models/ai_extract_products_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandAIProductsResponse < ContextDev::Internal::Type::BaseModel + class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIProductsResponse, + ContextDev::Models::AIExtractProductsResponse, ContextDev::Internal::AnyHash ) end @@ -15,7 +15,7 @@ module ContextDev sig do returns( T.nilable( - T::Array[ContextDev::Models::BrandAIProductsResponse::Product] + T::Array[ContextDev::Models::AIExtractProductsResponse::Product] ) ) end @@ -25,7 +25,7 @@ module ContextDev params( products: T::Array[ - ContextDev::Models::BrandAIProductsResponse::Product::OrHash + ContextDev::Models::AIExtractProductsResponse::Product::OrHash ] ).void end @@ -35,7 +35,7 @@ module ContextDev params( products: T::Array[ - ContextDev::Models::BrandAIProductsResponse::Product::OrHash + ContextDev::Models::AIExtractProductsResponse::Product::OrHash ] ).returns(T.attached_class) end @@ -49,7 +49,7 @@ module ContextDev override.returns( { products: - T::Array[ContextDev::Models::BrandAIProductsResponse::Product] + T::Array[ContextDev::Models::AIExtractProductsResponse::Product] } ) end @@ -60,7 +60,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandAIProductsResponse::Product, + ContextDev::Models::AIExtractProductsResponse::Product, ContextDev::Internal::AnyHash ) end @@ -93,7 +93,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ) ) end @@ -119,7 +119,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) ) end @@ -139,7 +139,7 @@ module ContextDev target_audience: T::Array[String], billing_frequency: T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::OrSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::OrSymbol ), category: T.nilable(String), currency: T.nilable(String), @@ -147,7 +147,7 @@ module ContextDev price: T.nilable(Float), pricing_model: T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::OrSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::OrSymbol ), url: T.nilable(String) ).returns(T.attached_class) @@ -193,7 +193,7 @@ module ContextDev target_audience: T::Array[String], billing_frequency: T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ), category: T.nilable(String), currency: T.nilable(String), @@ -201,7 +201,7 @@ module ContextDev price: T.nilable(Float), pricing_model: T.nilable( - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ), url: T.nilable(String) } @@ -218,7 +218,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -226,28 +226,28 @@ module ContextDev MONTHLY = T.let( :monthly, - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ) YEARLY = T.let( :yearly, - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ) ONE_TIME = T.let( :one_time, - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ) USAGE_BASED = T.let( :usage_based, - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandAIProductsResponse::Product::BillingFrequency::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol ] ) end @@ -263,7 +263,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -271,33 +271,33 @@ module ContextDev PER_SEAT = T.let( :per_seat, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) FLAT = T.let( :flat, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) TIERED = T.let( :tiered, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) FREEMIUM = T.let( :freemium, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) CUSTOM = T.let( :custom, - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandAIProductsResponse::Product::PricingModel::TaggedSymbol + ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol ] ) end diff --git a/rbi/context_dev/models/brand_identify_from_transaction_params.rbi b/rbi/context_dev/models/brand_identify_from_transaction_params.rbi index f23a344e..6e6dcd91 100644 --- a/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +++ b/rbi/context_dev/models/brand_identify_from_transaction_params.rbi @@ -1431,6 +1431,11 @@ module ContextDev :bulgarian, ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -1526,6 +1531,11 @@ module ContextDev :kazakh, ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -1636,6 +1646,11 @@ module ContextDev :tagalog, ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_by_email_params.rbi b/rbi/context_dev/models/brand_retrieve_by_email_params.rbi index 76b6ef3e..e4668635 100644 --- a/rbi/context_dev/models/brand_retrieve_by_email_params.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_email_params.rbi @@ -135,6 +135,11 @@ module ContextDev :bulgarian, ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -230,6 +235,11 @@ module ContextDev :kazakh, ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -340,6 +350,11 @@ module ContextDev :tagalog, ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandRetrieveByEmailParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi b/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi index 64f54748..d552ecb7 100644 --- a/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi @@ -135,6 +135,11 @@ module ContextDev :bulgarian, ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -230,6 +235,11 @@ module ContextDev :kazakh, ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -340,6 +350,11 @@ module ContextDev :tagalog, ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandRetrieveByIsinParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_by_name_params.rbi b/rbi/context_dev/models/brand_retrieve_by_name_params.rbi index eb37db65..48291376 100644 --- a/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_name_params.rbi @@ -1374,6 +1374,11 @@ module ContextDev :bulgarian, ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -1469,6 +1474,11 @@ module ContextDev :kazakh, ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -1579,6 +1589,11 @@ module ContextDev :tagalog, ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandRetrieveByNameParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi b/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi index 182e979f..2eeb23dc 100644 --- a/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi @@ -160,6 +160,11 @@ module ContextDev :bulgarian, ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -255,6 +260,11 @@ module ContextDev :kazakh, ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -365,6 +375,11 @@ module ContextDev :tagalog, ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandRetrieveByTickerParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_params.rbi b/rbi/context_dev/models/brand_retrieve_params.rbi index 4610e29c..a6e54f69 100644 --- a/rbi/context_dev/models/brand_retrieve_params.rbi +++ b/rbi/context_dev/models/brand_retrieve_params.rbi @@ -131,6 +131,11 @@ module ContextDev :bulgarian, ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + CANTONESE = + T.let( + :cantonese, + ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) CEBUANO = T.let( :cebuano, @@ -226,6 +231,11 @@ module ContextDev :kazakh, ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + KOREAN = + T.let( + :korean, + ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) KYRGYZ = T.let( :kyrgyz, @@ -336,6 +346,11 @@ module ContextDev :tagalog, ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol ) + THAI = + T.let( + :thai, + ContextDev::BrandRetrieveParams::ForceLanguage::TaggedSymbol + ) TURKISH = T.let( :turkish, diff --git a/rbi/context_dev/models/brand_retrieve_naics_params.rbi b/rbi/context_dev/models/industry_retrieve_naics_params.rbi similarity index 95% rename from rbi/context_dev/models/brand_retrieve_naics_params.rbi rename to rbi/context_dev/models/industry_retrieve_naics_params.rbi index 7684633a..a8590228 100644 --- a/rbi/context_dev/models/brand_retrieve_naics_params.rbi +++ b/rbi/context_dev/models/industry_retrieve_naics_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel + class IndustryRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandRetrieveNaicsParams, + ContextDev::IndustryRetrieveNaicsParams, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_retrieve_naics_response.rbi b/rbi/context_dev/models/industry_retrieve_naics_response.rbi similarity index 73% rename from rbi/context_dev/models/brand_retrieve_naics_response.rbi rename to rbi/context_dev/models/industry_retrieve_naics_response.rbi index 3f2669cd..4434e141 100644 --- a/rbi/context_dev/models/brand_retrieve_naics_response.rbi +++ b/rbi/context_dev/models/industry_retrieve_naics_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel + class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandRetrieveNaicsResponse, + ContextDev::Models::IndustryRetrieveNaicsResponse, ContextDev::Internal::AnyHash ) end @@ -15,7 +15,7 @@ module ContextDev sig do returns( T.nilable( - T::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code] + T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code] ) ) end @@ -25,7 +25,7 @@ module ContextDev params( codes: T::Array[ - ContextDev::Models::BrandRetrieveNaicsResponse::Code::OrHash + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash ] ).void end @@ -56,7 +56,7 @@ module ContextDev params( codes: T::Array[ - ContextDev::Models::BrandRetrieveNaicsResponse::Code::OrHash + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash ], domain: String, status: String, @@ -79,7 +79,7 @@ module ContextDev override.returns( { codes: - T::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code], + T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, status: String, type: String @@ -93,7 +93,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandRetrieveNaicsResponse::Code, + ContextDev::Models::IndustryRetrieveNaicsResponse::Code, ContextDev::Internal::AnyHash ) end @@ -105,7 +105,7 @@ module ContextDev # Confidence level for how well this NAICS code matches the company description sig do returns( - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol ) end attr_accessor :confidence @@ -118,7 +118,7 @@ module ContextDev params( code: String, confidence: - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::OrSymbol, + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::OrSymbol, name: String ).returns(T.attached_class) end @@ -137,7 +137,7 @@ module ContextDev { code: String, confidence: - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol, + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol, name: String } ) @@ -153,7 +153,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -161,23 +161,23 @@ module ContextDev HIGH = T.let( :high, - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol ) MEDIUM = T.let( :medium, - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol ) LOW = T.let( :low, - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandRetrieveNaicsResponse::Code::Confidence::TaggedSymbol + ContextDev::Models::IndustryRetrieveNaicsResponse::Code::Confidence::TaggedSymbol ] ) end diff --git a/rbi/context_dev/models/brand_fonts_params.rbi b/rbi/context_dev/models/style_extract_fonts_params.rbi similarity index 89% rename from rbi/context_dev/models/brand_fonts_params.rbi rename to rbi/context_dev/models/style_extract_fonts_params.rbi index b7ddc507..22fb658b 100644 --- a/rbi/context_dev/models/brand_fonts_params.rbi +++ b/rbi/context_dev/models/style_extract_fonts_params.rbi @@ -2,13 +2,16 @@ module ContextDev module Models - class BrandFontsParams < ContextDev::Internal::Type::BaseModel + class StyleExtractFontsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(ContextDev::BrandFontsParams, ContextDev::Internal::AnyHash) + T.any( + ContextDev::StyleExtractFontsParams, + ContextDev::Internal::AnyHash + ) end # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The diff --git a/rbi/context_dev/models/brand_fonts_response.rbi b/rbi/context_dev/models/style_extract_fonts_response.rbi similarity index 86% rename from rbi/context_dev/models/brand_fonts_response.rbi rename to rbi/context_dev/models/style_extract_fonts_response.rbi index 0795c81f..b90b5f22 100644 --- a/rbi/context_dev/models/brand_fonts_response.rbi +++ b/rbi/context_dev/models/style_extract_fonts_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandFontsResponse < ContextDev::Internal::Type::BaseModel + class StyleExtractFontsResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandFontsResponse, + ContextDev::Models::StyleExtractFontsResponse, ContextDev::Internal::AnyHash ) end @@ -20,7 +20,9 @@ module ContextDev attr_accessor :domain # Array of font usage information - sig { returns(T::Array[ContextDev::Models::BrandFontsResponse::Font]) } + sig do + returns(T::Array[ContextDev::Models::StyleExtractFontsResponse::Font]) + end attr_accessor :fonts # Status of the response, e.g., 'ok' @@ -31,7 +33,10 @@ module ContextDev params( code: Integer, domain: String, - fonts: T::Array[ContextDev::Models::BrandFontsResponse::Font::OrHash], + fonts: + T::Array[ + ContextDev::Models::StyleExtractFontsResponse::Font::OrHash + ], status: String ).returns(T.attached_class) end @@ -52,7 +57,8 @@ module ContextDev { code: Integer, domain: String, - fonts: T::Array[ContextDev::Models::BrandFontsResponse::Font], + fonts: + T::Array[ContextDev::Models::StyleExtractFontsResponse::Font], status: String } ) @@ -64,7 +70,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandFontsResponse::Font, + ContextDev::Models::StyleExtractFontsResponse::Font, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_styleguide_params.rbi b/rbi/context_dev/models/style_extract_styleguide_params.rbi similarity index 82% rename from rbi/context_dev/models/brand_styleguide_params.rbi rename to rbi/context_dev/models/style_extract_styleguide_params.rbi index d6456a3d..b1243946 100644 --- a/rbi/context_dev/models/brand_styleguide_params.rbi +++ b/rbi/context_dev/models/style_extract_styleguide_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel + class StyleExtractStyleguideParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandStyleguideParams, + ContextDev::StyleExtractStyleguideParams, ContextDev::Internal::AnyHash ) end @@ -36,14 +36,17 @@ module ContextDev # not provided. sig do returns( - T.nilable(ContextDev::BrandStyleguideParams::Prioritize::OrSymbol) + T.nilable( + ContextDev::StyleExtractStyleguideParams::Prioritize::OrSymbol + ) ) end attr_reader :prioritize sig do params( - prioritize: ContextDev::BrandStyleguideParams::Prioritize::OrSymbol + prioritize: + ContextDev::StyleExtractStyleguideParams::Prioritize::OrSymbol ).void end attr_writer :prioritize @@ -61,7 +64,8 @@ module ContextDev params( direct_url: String, domain: String, - prioritize: ContextDev::BrandStyleguideParams::Prioritize::OrSymbol, + prioritize: + ContextDev::StyleExtractStyleguideParams::Prioritize::OrSymbol, timeout_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) @@ -91,7 +95,8 @@ module ContextDev { direct_url: String, domain: String, - prioritize: ContextDev::BrandStyleguideParams::Prioritize::OrSymbol, + prioritize: + ContextDev::StyleExtractStyleguideParams::Prioritize::OrSymbol, timeout_ms: Integer, request_options: ContextDev::RequestOptions } @@ -109,25 +114,25 @@ module ContextDev TaggedSymbol = T.type_alias do - T.all(Symbol, ContextDev::BrandStyleguideParams::Prioritize) + T.all(Symbol, ContextDev::StyleExtractStyleguideParams::Prioritize) end OrSymbol = T.type_alias { T.any(Symbol, String) } SPEED = T.let( :speed, - ContextDev::BrandStyleguideParams::Prioritize::TaggedSymbol + ContextDev::StyleExtractStyleguideParams::Prioritize::TaggedSymbol ) QUALITY = T.let( :quality, - ContextDev::BrandStyleguideParams::Prioritize::TaggedSymbol + ContextDev::StyleExtractStyleguideParams::Prioritize::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::BrandStyleguideParams::Prioritize::TaggedSymbol + ContextDev::StyleExtractStyleguideParams::Prioritize::TaggedSymbol ] ) end diff --git a/rbi/context_dev/models/brand_styleguide_response.rbi b/rbi/context_dev/models/style_extract_styleguide_response.rbi similarity index 81% rename from rbi/context_dev/models/brand_styleguide_response.rbi rename to rbi/context_dev/models/style_extract_styleguide_response.rbi index fa31a2c3..56c01994 100644 --- a/rbi/context_dev/models/brand_styleguide_response.rbi +++ b/rbi/context_dev/models/style_extract_styleguide_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandStyleguideResponse < ContextDev::Internal::Type::BaseModel + class StyleExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse, + ContextDev::Models::StyleExtractStyleguideResponse, ContextDev::Internal::AnyHash ) end @@ -35,7 +35,9 @@ module ContextDev # Comprehensive styleguide data extracted from the website sig do returns( - T.nilable(ContextDev::Models::BrandStyleguideResponse::Styleguide) + T.nilable( + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide + ) ) end attr_reader :styleguide @@ -43,7 +45,7 @@ module ContextDev sig do params( styleguide: - ContextDev::Models::BrandStyleguideResponse::Styleguide::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::OrHash ).void end attr_writer :styleguide @@ -54,7 +56,7 @@ module ContextDev domain: String, status: String, styleguide: - ContextDev::Models::BrandStyleguideResponse::Styleguide::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::OrHash ).returns(T.attached_class) end def self.new( @@ -75,7 +77,8 @@ module ContextDev code: Integer, domain: String, status: String, - styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide + styleguide: + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide } ) end @@ -86,7 +89,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide, ContextDev::Internal::AnyHash ) end @@ -95,7 +98,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors ) ) end @@ -104,7 +107,7 @@ module ContextDev sig do params( colors: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors::OrHash ).void end attr_writer :colors @@ -113,7 +116,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components ) ) end @@ -122,7 +125,7 @@ module ContextDev sig do params( components: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::OrHash ).void end attr_writer :components @@ -131,7 +134,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing ) ) end @@ -140,7 +143,7 @@ module ContextDev sig do params( element_spacing: - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing::OrHash ).void end attr_writer :element_spacing @@ -149,7 +152,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::TaggedSymbol ) ) end @@ -158,7 +161,7 @@ module ContextDev sig do params( mode: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::OrSymbol + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::OrSymbol ).void end attr_writer :mode @@ -167,7 +170,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows ) ) end @@ -176,7 +179,7 @@ module ContextDev sig do params( shadows: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows::OrHash ).void end attr_writer :shadows @@ -185,7 +188,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography ) ) end @@ -194,7 +197,7 @@ module ContextDev sig do params( typography: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::OrHash ).void end attr_writer :typography @@ -203,17 +206,17 @@ module ContextDev sig do params( colors: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors::OrHash, components: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::OrHash, element_spacing: - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing::OrHash, mode: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::OrSymbol, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::OrSymbol, shadows: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows::OrHash, typography: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::OrHash ).returns(T.attached_class) end def self.new( @@ -236,17 +239,17 @@ module ContextDev override.returns( { colors: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, components: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, element_spacing: - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, mode: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::TaggedSymbol, shadows: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, typography: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography } ) end @@ -257,7 +260,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, ContextDev::Internal::AnyHash ) end @@ -312,7 +315,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, ContextDev::Internal::AnyHash ) end @@ -321,7 +324,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button ) ) end @@ -330,7 +333,7 @@ module ContextDev sig do params( button: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::OrHash ).void end attr_writer :button @@ -339,7 +342,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card ) ) end @@ -348,7 +351,7 @@ module ContextDev sig do params( card: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card::OrHash ).void end attr_writer :card @@ -357,9 +360,9 @@ module ContextDev sig do params( button: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::OrHash, card: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card::OrHash ).returns(T.attached_class) end def self.new( @@ -374,9 +377,9 @@ module ContextDev override.returns( { button: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, card: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card } ) end @@ -387,7 +390,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, ContextDev::Internal::AnyHash ) end @@ -396,7 +399,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link ) ) end @@ -405,7 +408,7 @@ module ContextDev sig do params( link: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link::OrHash ).void end attr_writer :link @@ -414,7 +417,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary ) ) end @@ -423,7 +426,7 @@ module ContextDev sig do params( primary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary::OrHash ).void end attr_writer :primary @@ -432,7 +435,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary ) ) end @@ -441,7 +444,7 @@ module ContextDev sig do params( secondary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash ).void end attr_writer :secondary @@ -450,11 +453,11 @@ module ContextDev sig do params( link: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link::OrHash, primary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary::OrHash, secondary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary::OrHash ).returns(T.attached_class) end def self.new( @@ -471,11 +474,11 @@ module ContextDev override.returns( { link: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, primary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, secondary: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary } ) end @@ -486,7 +489,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, ContextDev::Internal::AnyHash ) end @@ -613,7 +616,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, ContextDev::Internal::AnyHash ) end @@ -740,7 +743,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary, ContextDev::Internal::AnyHash ) end @@ -868,7 +871,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card, ContextDev::Internal::AnyHash ) end @@ -969,7 +972,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, ContextDev::Internal::AnyHash ) end @@ -1050,7 +1053,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1058,18 +1061,18 @@ module ContextDev LIGHT = T.let( :light, - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::TaggedSymbol ) DARK = T.let( :dark, - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandStyleguideResponse::Styleguide::Mode::TaggedSymbol + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode::TaggedSymbol ] ) end @@ -1081,7 +1084,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, ContextDev::Internal::AnyHash ) end @@ -1158,7 +1161,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography, ContextDev::Internal::AnyHash ) end @@ -1167,7 +1170,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings ) ) end @@ -1176,7 +1179,7 @@ module ContextDev sig do params( headings: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::OrHash ).void end attr_writer :headings @@ -1185,7 +1188,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P ) ) end @@ -1194,7 +1197,7 @@ module ContextDev sig do params( p_: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P::OrHash ).void end attr_writer :p_ @@ -1203,9 +1206,9 @@ module ContextDev sig do params( headings: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::OrHash, p_: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P::OrHash ).returns(T.attached_class) end def self.new( @@ -1220,9 +1223,9 @@ module ContextDev override.returns( { headings: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, p_: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P } ) end @@ -1233,7 +1236,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, ContextDev::Internal::AnyHash ) end @@ -1241,7 +1244,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1 ) ) end @@ -1250,7 +1253,7 @@ module ContextDev sig do params( h1: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash ).void end attr_writer :h1 @@ -1258,7 +1261,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2 ) ) end @@ -1267,7 +1270,7 @@ module ContextDev sig do params( h2: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash ).void end attr_writer :h2 @@ -1275,7 +1278,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3 ) ) end @@ -1284,7 +1287,7 @@ module ContextDev sig do params( h3: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash ).void end attr_writer :h3 @@ -1292,7 +1295,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 ) ) end @@ -1301,7 +1304,7 @@ module ContextDev sig do params( h4: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash ).void end attr_writer :h4 @@ -1310,13 +1313,13 @@ module ContextDev sig do params( h1: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1::OrHash, h2: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2::OrHash, h3: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3::OrHash, h4: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4::OrHash ).returns(T.attached_class) end def self.new(h1: nil, h2: nil, h3: nil, h4: nil) @@ -1326,13 +1329,13 @@ module ContextDev override.returns( { h1: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, h2: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, h3: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, h4: - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 } ) end @@ -1343,7 +1346,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, ContextDev::Internal::AnyHash ) end @@ -1415,7 +1418,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, ContextDev::Internal::AnyHash ) end @@ -1487,7 +1490,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, ContextDev::Internal::AnyHash ) end @@ -1559,7 +1562,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4, ContextDev::Internal::AnyHash ) end @@ -1632,7 +1635,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_prefetch_by_email_params.rbi b/rbi/context_dev/models/utility_prefetch_by_email_params.rbi similarity index 93% rename from rbi/context_dev/models/brand_prefetch_by_email_params.rbi rename to rbi/context_dev/models/utility_prefetch_by_email_params.rbi index 49f8ce54..f4a1ed66 100644 --- a/rbi/context_dev/models/brand_prefetch_by_email_params.rbi +++ b/rbi/context_dev/models/utility_prefetch_by_email_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandPrefetchByEmailParams, + ContextDev::UtilityPrefetchByEmailParams, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_prefetch_by_email_response.rbi b/rbi/context_dev/models/utility_prefetch_by_email_response.rbi similarity index 89% rename from rbi/context_dev/models/brand_prefetch_by_email_response.rbi rename to rbi/context_dev/models/utility_prefetch_by_email_response.rbi index 2b59b2e4..6a962cfd 100644 --- a/rbi/context_dev/models/brand_prefetch_by_email_response.rbi +++ b/rbi/context_dev/models/utility_prefetch_by_email_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandPrefetchByEmailResponse, + ContextDev::Models::UtilityPrefetchByEmailResponse, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_prefetch_params.rbi b/rbi/context_dev/models/utility_prefetch_params.rbi similarity index 88% rename from rbi/context_dev/models/brand_prefetch_params.rbi rename to rbi/context_dev/models/utility_prefetch_params.rbi index 27a375e9..a7a3554e 100644 --- a/rbi/context_dev/models/brand_prefetch_params.rbi +++ b/rbi/context_dev/models/utility_prefetch_params.rbi @@ -2,13 +2,16 @@ module ContextDev module Models - class BrandPrefetchParams < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any(ContextDev::BrandPrefetchParams, ContextDev::Internal::AnyHash) + T.any( + ContextDev::UtilityPrefetchParams, + ContextDev::Internal::AnyHash + ) end # Domain name to prefetch brand data for diff --git a/rbi/context_dev/models/brand_prefetch_response.rbi b/rbi/context_dev/models/utility_prefetch_response.rbi similarity index 90% rename from rbi/context_dev/models/brand_prefetch_response.rbi rename to rbi/context_dev/models/utility_prefetch_response.rbi index 3c7ce04e..e5589a5d 100644 --- a/rbi/context_dev/models/brand_prefetch_response.rbi +++ b/rbi/context_dev/models/utility_prefetch_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandPrefetchResponse < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandPrefetchResponse, + ContextDev::Models::UtilityPrefetchResponse, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_screenshot_params.rbi b/rbi/context_dev/models/web_screenshot_params.rbi similarity index 68% rename from rbi/context_dev/models/brand_screenshot_params.rbi rename to rbi/context_dev/models/web_screenshot_params.rbi index 91ef5dd6..47d4d9f2 100644 --- a/rbi/context_dev/models/brand_screenshot_params.rbi +++ b/rbi/context_dev/models/web_screenshot_params.rbi @@ -2,16 +2,13 @@ module ContextDev module Models - class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel + class WebScreenshotParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any( - ContextDev::BrandScreenshotParams, - ContextDev::Internal::AnyHash - ) + T.any(ContextDev::WebScreenshotParams, ContextDev::Internal::AnyHash) end # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The @@ -24,7 +21,7 @@ module ContextDev # screenshot (standard browser view). sig do returns( - T.nilable(ContextDev::BrandScreenshotParams::FullScreenshot::OrSymbol) + T.nilable(ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol) ) end attr_reader :full_screenshot @@ -32,7 +29,7 @@ module ContextDev sig do params( full_screenshot: - ContextDev::BrandScreenshotParams::FullScreenshot::OrSymbol + ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol ).void end attr_writer :full_screenshot @@ -42,13 +39,11 @@ module ContextDev # appropriate URL for the specified page type (30 supported languages). If not # provided, screenshots the main domain landing page. sig do - returns(T.nilable(ContextDev::BrandScreenshotParams::Page::OrSymbol)) + returns(T.nilable(ContextDev::WebScreenshotParams::Page::OrSymbol)) end attr_reader :page - sig do - params(page: ContextDev::BrandScreenshotParams::Page::OrSymbol).void - end + sig { params(page: ContextDev::WebScreenshotParams::Page::OrSymbol).void } attr_writer :page # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for @@ -56,14 +51,14 @@ module ContextDev # with longer wait times. Defaults to 'quality' if not provided. sig do returns( - T.nilable(ContextDev::BrandScreenshotParams::Prioritize::OrSymbol) + T.nilable(ContextDev::WebScreenshotParams::Prioritize::OrSymbol) ) end attr_reader :prioritize sig do params( - prioritize: ContextDev::BrandScreenshotParams::Prioritize::OrSymbol + prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol ).void end attr_writer :prioritize @@ -72,9 +67,9 @@ module ContextDev params( domain: String, full_screenshot: - ContextDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: ContextDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: ContextDev::BrandScreenshotParams::Prioritize::OrSymbol, + ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + page: ContextDev::WebScreenshotParams::Page::OrSymbol, + prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -104,9 +99,9 @@ module ContextDev { domain: String, full_screenshot: - ContextDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: ContextDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: ContextDev::BrandScreenshotParams::Prioritize::OrSymbol, + ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + page: ContextDev::WebScreenshotParams::Page::OrSymbol, + prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, request_options: ContextDev::RequestOptions } ) @@ -122,25 +117,25 @@ module ContextDev TaggedSymbol = T.type_alias do - T.all(Symbol, ContextDev::BrandScreenshotParams::FullScreenshot) + T.all(Symbol, ContextDev::WebScreenshotParams::FullScreenshot) end OrSymbol = T.type_alias { T.any(Symbol, String) } TRUE = T.let( :true, - ContextDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol + ContextDev::WebScreenshotParams::FullScreenshot::TaggedSymbol ) FALSE = T.let( :false, - ContextDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol + ContextDev::WebScreenshotParams::FullScreenshot::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::BrandScreenshotParams::FullScreenshot::TaggedSymbol + ContextDev::WebScreenshotParams::FullScreenshot::TaggedSymbol ] ) end @@ -156,31 +151,28 @@ module ContextDev extend ContextDev::Internal::Type::Enum TaggedSymbol = - T.type_alias do - T.all(Symbol, ContextDev::BrandScreenshotParams::Page) - end + T.type_alias { T.all(Symbol, ContextDev::WebScreenshotParams::Page) } OrSymbol = T.type_alias { T.any(Symbol, String) } LOGIN = - T.let(:login, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:login, ContextDev::WebScreenshotParams::Page::TaggedSymbol) SIGNUP = - T.let(:signup, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) - BLOG = - T.let(:blog, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:signup, ContextDev::WebScreenshotParams::Page::TaggedSymbol) + BLOG = T.let(:blog, ContextDev::WebScreenshotParams::Page::TaggedSymbol) CAREERS = - T.let(:careers, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:careers, ContextDev::WebScreenshotParams::Page::TaggedSymbol) PRICING = - T.let(:pricing, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:pricing, ContextDev::WebScreenshotParams::Page::TaggedSymbol) TERMS = - T.let(:terms, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:terms, ContextDev::WebScreenshotParams::Page::TaggedSymbol) PRIVACY = - T.let(:privacy, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:privacy, ContextDev::WebScreenshotParams::Page::TaggedSymbol) CONTACT = - T.let(:contact, ContextDev::BrandScreenshotParams::Page::TaggedSymbol) + T.let(:contact, ContextDev::WebScreenshotParams::Page::TaggedSymbol) sig do override.returns( - T::Array[ContextDev::BrandScreenshotParams::Page::TaggedSymbol] + T::Array[ContextDev::WebScreenshotParams::Page::TaggedSymbol] ) end def self.values @@ -195,26 +187,24 @@ module ContextDev TaggedSymbol = T.type_alias do - T.all(Symbol, ContextDev::BrandScreenshotParams::Prioritize) + T.all(Symbol, ContextDev::WebScreenshotParams::Prioritize) end OrSymbol = T.type_alias { T.any(Symbol, String) } SPEED = T.let( :speed, - ContextDev::BrandScreenshotParams::Prioritize::TaggedSymbol + ContextDev::WebScreenshotParams::Prioritize::TaggedSymbol ) QUALITY = T.let( :quality, - ContextDev::BrandScreenshotParams::Prioritize::TaggedSymbol + ContextDev::WebScreenshotParams::Prioritize::TaggedSymbol ) sig do override.returns( - T::Array[ - ContextDev::BrandScreenshotParams::Prioritize::TaggedSymbol - ] + T::Array[ContextDev::WebScreenshotParams::Prioritize::TaggedSymbol] ) end def self.values diff --git a/rbi/context_dev/models/brand_screenshot_response.rbi b/rbi/context_dev/models/web_screenshot_response.rbi similarity index 77% rename from rbi/context_dev/models/brand_screenshot_response.rbi rename to rbi/context_dev/models/web_screenshot_response.rbi index 746d177e..96777ae1 100644 --- a/rbi/context_dev/models/brand_screenshot_response.rbi +++ b/rbi/context_dev/models/web_screenshot_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel + class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandScreenshotResponse, + ContextDev::Models::WebScreenshotResponse, ContextDev::Internal::AnyHash ) end @@ -36,7 +36,7 @@ module ContextDev sig do returns( T.nilable( - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol + ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol ) ) end @@ -45,7 +45,7 @@ module ContextDev sig do params( screenshot_type: - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol + ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol ).void end attr_writer :screenshot_type @@ -63,7 +63,7 @@ module ContextDev domain: String, screenshot: String, screenshot_type: - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::OrSymbol, + ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol, status: String ).returns(T.attached_class) end @@ -88,7 +88,7 @@ module ContextDev domain: String, screenshot: String, screenshot_type: - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol, + ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol, status: String } ) @@ -104,7 +104,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandScreenshotResponse::ScreenshotType + ContextDev::Models::WebScreenshotResponse::ScreenshotType ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -112,18 +112,18 @@ module ContextDev VIEWPORT = T.let( :viewport, - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol + ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol ) FULL_PAGE = T.let( :fullPage, - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol + ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandScreenshotResponse::ScreenshotType::TaggedSymbol + ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol ] ) end diff --git a/rbi/context_dev/models/brand_web_scrape_html_params.rbi b/rbi/context_dev/models/web_web_scrape_html_params.rbi similarity index 88% rename from rbi/context_dev/models/brand_web_scrape_html_params.rbi rename to rbi/context_dev/models/web_web_scrape_html_params.rbi index ccc149e1..87d62926 100644 --- a/rbi/context_dev/models/brand_web_scrape_html_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandWebScrapeHTMLParams, + ContextDev::WebWebScrapeHTMLParams, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_web_scrape_html_response.rbi b/rbi/context_dev/models/web_web_scrape_html_response.rbi similarity index 72% rename from rbi/context_dev/models/brand_web_scrape_html_response.rbi rename to rbi/context_dev/models/web_web_scrape_html_response.rbi index 2f31da57..52f3eb90 100644 --- a/rbi/context_dev/models/brand_web_scrape_html_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel + class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeHTMLResponse, + ContextDev::Models::WebWebScrapeHTMLResponse, ContextDev::Internal::AnyHash ) end @@ -18,7 +18,7 @@ module ContextDev # Indicates success sig do returns( - ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean ) end attr_accessor :success @@ -31,7 +31,7 @@ module ContextDev params( html: String, success: - ContextDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean, + ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean, url: String ).returns(T.attached_class) end @@ -50,7 +50,7 @@ module ContextDev { html: String, success: - ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean, + ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean, url: String } ) @@ -66,7 +66,7 @@ module ContextDev T.type_alias do T.all( T::Boolean, - ContextDev::Models::BrandWebScrapeHTMLResponse::Success + ContextDev::Models::WebWebScrapeHTMLResponse::Success ) end OrBoolean = T.type_alias { T::Boolean } @@ -74,13 +74,13 @@ module ContextDev TRUE = T.let( true, - ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean ] ) end diff --git a/rbi/context_dev/models/brand_web_scrape_images_params.rbi b/rbi/context_dev/models/web_web_scrape_images_params.rbi similarity index 88% rename from rbi/context_dev/models/brand_web_scrape_images_params.rbi rename to rbi/context_dev/models/web_web_scrape_images_params.rbi index c3cdc839..ec03311c 100644 --- a/rbi/context_dev/models/brand_web_scrape_images_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandWebScrapeImagesParams, + ContextDev::WebWebScrapeImagesParams, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_web_scrape_images_response.rbi b/rbi/context_dev/models/web_web_scrape_images_response.rbi similarity index 66% rename from rbi/context_dev/models/brand_web_scrape_images_response.rbi rename to rbi/context_dev/models/web_web_scrape_images_response.rbi index 2daf347f..1b770c3c 100644 --- a/rbi/context_dev/models/brand_web_scrape_images_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_response.rbi @@ -2,27 +2,25 @@ module ContextDev module Models - class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel + class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeImagesResponse, + ContextDev::Models::WebWebScrapeImagesResponse, ContextDev::Internal::AnyHash ) end # Array of scraped images sig do - returns( - T::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image] - ) + returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image]) end attr_accessor :images # Indicates success sig do returns( - ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean ) end attr_accessor :success @@ -35,10 +33,10 @@ module ContextDev params( images: T::Array[ - ContextDev::Models::BrandWebScrapeImagesResponse::Image::OrHash + ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash ], success: - ContextDev::Models::BrandWebScrapeImagesResponse::Success::OrBoolean, + ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean, url: String ).returns(T.attached_class) end @@ -56,9 +54,9 @@ module ContextDev override.returns( { images: - T::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image], + T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: - ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean, + ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean, url: String } ) @@ -70,7 +68,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeImagesResponse::Image, + ContextDev::Models::WebWebScrapeImagesResponse::Image, ContextDev::Internal::AnyHash ) end @@ -82,7 +80,7 @@ module ContextDev # The HTML element the image was found in sig do returns( - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) end attr_accessor :element @@ -94,7 +92,7 @@ module ContextDev # The type/format of the src value sig do returns( - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol ) end attr_accessor :type @@ -103,10 +101,10 @@ module ContextDev params( alt: T.nilable(String), element: - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::OrSymbol, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::OrSymbol, src: String, type: - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::OrSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol ).returns(T.attached_class) end def self.new( @@ -126,10 +124,10 @@ module ContextDev { alt: T.nilable(String), element: - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol, + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol, src: String, type: - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol } ) end @@ -144,7 +142,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -152,33 +150,33 @@ module ContextDev IMG = T.let( :img, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) SVG = T.let( :svg, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) LINK = T.let( :link, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) SOURCE = T.let( :source, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) VIDEO = T.let( :video, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol ] ) end @@ -194,7 +192,7 @@ module ContextDev T.type_alias do T.all( Symbol, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -202,23 +200,23 @@ module ContextDev URL = T.let( :url, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol ) HTML = T.let( :html, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol ) BASE64 = T.let( :base64, - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol + ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol ] ) end @@ -235,7 +233,7 @@ module ContextDev T.type_alias do T.all( T::Boolean, - ContextDev::Models::BrandWebScrapeImagesResponse::Success + ContextDev::Models::WebWebScrapeImagesResponse::Success ) end OrBoolean = T.type_alias { T::Boolean } @@ -243,13 +241,13 @@ module ContextDev TRUE = T.let( true, - ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean ] ) end diff --git a/rbi/context_dev/models/brand_web_scrape_md_params.rbi b/rbi/context_dev/models/web_web_scrape_md_params.rbi similarity index 91% rename from rbi/context_dev/models/brand_web_scrape_md_params.rbi rename to rbi/context_dev/models/web_web_scrape_md_params.rbi index ccc189b1..cb70bd31 100644 --- a/rbi/context_dev/models/brand_web_scrape_md_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_params.rbi @@ -2,16 +2,13 @@ module ContextDev module Models - class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any( - ContextDev::BrandWebScrapeMdParams, - ContextDev::Internal::AnyHash - ) + T.any(ContextDev::WebWebScrapeMdParams, ContextDev::Internal::AnyHash) end # Full URL to scrape and convert to markdown (must include http:// or https:// diff --git a/rbi/context_dev/models/brand_web_scrape_md_response.rbi b/rbi/context_dev/models/web_web_scrape_md_response.rbi similarity index 73% rename from rbi/context_dev/models/brand_web_scrape_md_response.rbi rename to rbi/context_dev/models/web_web_scrape_md_response.rbi index c4ef59d8..ab7326e9 100644 --- a/rbi/context_dev/models/brand_web_scrape_md_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeMdResponse, + ContextDev::Models::WebWebScrapeMdResponse, ContextDev::Internal::AnyHash ) end @@ -18,7 +18,7 @@ module ContextDev # Indicates success sig do returns( - ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean ) end attr_accessor :success @@ -31,7 +31,7 @@ module ContextDev params( markdown: String, success: - ContextDev::Models::BrandWebScrapeMdResponse::Success::OrBoolean, + ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean, url: String ).returns(T.attached_class) end @@ -50,7 +50,7 @@ module ContextDev { markdown: String, success: - ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean, + ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean, url: String } ) @@ -66,7 +66,7 @@ module ContextDev T.type_alias do T.all( T::Boolean, - ContextDev::Models::BrandWebScrapeMdResponse::Success + ContextDev::Models::WebWebScrapeMdResponse::Success ) end OrBoolean = T.type_alias { T::Boolean } @@ -74,13 +74,13 @@ module ContextDev TRUE = T.let( true, - ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean ] ) end diff --git a/rbi/context_dev/models/brand_web_scrape_sitemap_params.rbi b/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi similarity index 88% rename from rbi/context_dev/models/brand_web_scrape_sitemap_params.rbi rename to rbi/context_dev/models/web_web_scrape_sitemap_params.rbi index cd7a6e2e..0273ad55 100644 --- a/rbi/context_dev/models/brand_web_scrape_sitemap_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi @@ -2,14 +2,14 @@ module ContextDev module Models - class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters OrHash = T.type_alias do T.any( - ContextDev::BrandWebScrapeSitemapParams, + ContextDev::WebWebScrapeSitemapParams, ContextDev::Internal::AnyHash ) end diff --git a/rbi/context_dev/models/brand_web_scrape_sitemap_response.rbi b/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi similarity index 78% rename from rbi/context_dev/models/brand_web_scrape_sitemap_response.rbi rename to rbi/context_dev/models/web_web_scrape_sitemap_response.rbi index 1d4a2d4f..1bf73fff 100644 --- a/rbi/context_dev/models/brand_web_scrape_sitemap_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi @@ -2,11 +2,11 @@ module ContextDev module Models - class BrandWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel + class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeSitemapResponse, + ContextDev::Models::WebWebScrapeSitemapResponse, ContextDev::Internal::AnyHash ) end @@ -16,12 +16,12 @@ module ContextDev attr_accessor :domain # Metadata about the sitemap crawl operation - sig { returns(ContextDev::Models::BrandWebScrapeSitemapResponse::Meta) } + sig { returns(ContextDev::Models::WebWebScrapeSitemapResponse::Meta) } attr_reader :meta sig do params( - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta::OrHash + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash ).void end attr_writer :meta @@ -29,7 +29,7 @@ module ContextDev # Indicates success sig do returns( - ContextDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean ) end attr_accessor :success @@ -41,9 +41,9 @@ module ContextDev sig do params( domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta::OrHash, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash, success: - ContextDev::Models::BrandWebScrapeSitemapResponse::Success::OrBoolean, + ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean, urls: T::Array[String] ).returns(T.attached_class) end @@ -63,9 +63,9 @@ module ContextDev override.returns( { domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: - ContextDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean, + ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean, urls: T::Array[String] } ) @@ -77,7 +77,7 @@ module ContextDev OrHash = T.type_alias do T.any( - ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, + ContextDev::Models::WebWebScrapeSitemapResponse::Meta, ContextDev::Internal::AnyHash ) end @@ -141,7 +141,7 @@ module ContextDev T.type_alias do T.all( T::Boolean, - ContextDev::Models::BrandWebScrapeSitemapResponse::Success + ContextDev::Models::WebWebScrapeSitemapResponse::Success ) end OrBoolean = T.type_alias { T::Boolean } @@ -149,13 +149,13 @@ module ContextDev TRUE = T.let( true, - ContextDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean ) sig do override.returns( T::Array[ - ContextDev::Models::BrandWebScrapeSitemapResponse::Success::TaggedBoolean + ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean ] ) end diff --git a/rbi/context_dev/resources/ai.rbi b/rbi/context_dev/resources/ai.rbi new file mode 100644 index 00000000..586be751 --- /dev/null +++ b/rbi/context_dev/resources/ai.rbi @@ -0,0 +1,76 @@ +# typed: strong + +module ContextDev + module Resources + class AI + # Use AI to extract specific data points from a brand's website. The AI will crawl + # the website and extract the requested information based on the provided data + # points. + 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(ContextDev::Models::AIAIQueryResponse) + end + def ai_query( + # 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 + + # Beta feature: Given a single URL, determines if it is a product detail page, + # classifies the platform/product type, and extracts the product information. + # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. + sig do + params( + url: String, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::AIExtractProductResponse) + end + def extract_product( + # The product page URL to extract product data from. + url:, + # Optional timeout in milliseconds for the request. Maximum allowed value is + # 300000ms (5 minutes). + timeout_ms: nil, + request_options: {} + ) + end + + # Beta feature: Extract product information from a brand's website. Brand.dev will + # analyze the website and return a list of products with details such as name, + # description, image, pricing, features, and more. + sig do + params( + body: + T.any( + ContextDev::AIExtractProductsParams::Body::ByDomain::OrHash, + ContextDev::AIExtractProductsParams::Body::ByDirectURL::OrHash + ), + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::AIExtractProductsResponse) + end + def extract_products(body:, request_options: {}) + end + + # @api private + sig { params(client: ContextDev::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/context_dev/resources/brand.rbi b/rbi/context_dev/resources/brand.rbi index 0171a59d..fdbf6a5a 100644 --- a/rbi/context_dev/resources/brand.rbi +++ b/rbi/context_dev/resources/brand.rbi @@ -34,91 +34,6 @@ module ContextDev ) end - # Beta feature: Given a single URL, determines if it is a product detail page, - # classifies the platform/product type, and extracts the product information. - # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites. - sig do - params( - url: String, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandAIProductResponse) - end - def ai_product( - # The product page URL to extract product data from. - url:, - # Optional timeout in milliseconds for the request. Maximum allowed value is - # 300000ms (5 minutes). - timeout_ms: nil, - request_options: {} - ) - end - - # Beta feature: Extract product information from a brand's website. Brand.dev will - # analyze the website and return a list of products with details such as name, - # description, image, pricing, features, and more. - sig do - params( - body: - T.any( - ContextDev::BrandAIProductsParams::Body::ByDomain::OrHash, - ContextDev::BrandAIProductsParams::Body::ByDirectURL::OrHash - ), - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandAIProductsResponse) - end - def ai_products(body:, request_options: {}) - end - - # Use AI to extract specific data points from a brand's website. The AI will crawl - # the website and extract the requested information based on the provided data - # points. - sig do - params( - data_to_extract: - T::Array[ContextDev::BrandAIQueryParams::DataToExtract::OrHash], - domain: String, - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages::OrHash, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandAIQueryResponse) - end - def ai_query( - # 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 - - # Extract font information from a brand's website including font families, usage - # statistics, fallbacks, and element/word counts. - sig do - params( - domain: String, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandFontsResponse) - end - def fonts( - # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain:, - # 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 - # Endpoint specially designed for platforms that want to identify transaction data # by the transaction title. sig do @@ -168,54 +83,6 @@ module ContextDev ) end - # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint does not charge credits and is available for paid - # customers to optimize future requests. [You must be on a paid plan to use this - # endpoint] - sig do - params( - domain: String, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandPrefetchResponse) - end - def prefetch( - # Domain name to prefetch brand data for - domain:, - # 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 - - # Signal that you may fetch brand data for a particular domain soon to improve - # latency. This endpoint accepts an email address, extracts the domain from it, - # validates that it's not a disposable or free email provider, and queues the - # domain for prefetching. This endpoint does not charge credits and is available - # for paid customers to optimize future requests. [You must be on a paid plan to - # use this endpoint] - sig do - params( - email: String, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandPrefetchByEmailResponse) - end - def prefetch_by_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. - email:, - # 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 - # Retrieve brand information using an email address while detecting disposable and # free email addresses. This endpoint extracts the domain from the email address # and returns brand data for that domain. Disposable and free email addresses @@ -350,34 +217,6 @@ module ContextDev ) end - # Endpoint to classify any brand into a 2022 NAICS code. - sig do - params( - input: String, - max_results: Integer, - min_results: Integer, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandRetrieveNaicsResponse) - end - def retrieve_naics( - # Brand domain or title to retrieve NAICS code for. If a valid domain is provided - # in `input`, it will be used for classification, otherwise, we will search for - # the brand using the provided title. - input:, - # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults - # to 5. - max_results: nil, - # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. - min_results: 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 - # Returns a simplified version of brand data containing only essential # information: domain, title, colors, logos, and backdrops. This endpoint is # optimized for faster responses and reduced data transfer. @@ -399,148 +238,6 @@ module ContextDev ) end - # Capture a screenshot of a website. Supports both viewport (standard browser - # view) and full-page screenshots. Can also screenshot specific page types (login, - # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to - # the uploaded screenshot image hosted on our CDN. - sig do - params( - domain: String, - full_screenshot: - ContextDev::BrandScreenshotParams::FullScreenshot::OrSymbol, - page: ContextDev::BrandScreenshotParams::Page::OrSymbol, - prioritize: ContextDev::BrandScreenshotParams::Prioritize::OrSymbol, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandScreenshotResponse) - end - def screenshot( - # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain:, - # Optional parameter to determine screenshot type. If 'true', takes a full page - # screenshot capturing all content. If 'false' or not provided, takes a viewport - # screenshot (standard browser view). - full_screenshot: nil, - # Optional parameter to specify which page type to screenshot. If provided, the - # system will scrape the domain's links and use heuristics to find the most - # appropriate URL for the specified page type (30 supported languages). If not - # provided, screenshots the main domain landing page. - page: nil, - # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for - # faster capture with basic quality. If 'quality', optimizes for higher quality - # with longer wait times. Defaults to 'quality' if not provided. - prioritize: nil, - request_options: {} - ) - end - - # Automatically extract comprehensive design system information from a brand's - # website including colors, typography, spacing, shadows, and UI components. - # Either 'domain' or 'directUrl' must be provided as a query parameter, but not - # both. - sig do - params( - direct_url: String, - domain: String, - prioritize: ContextDev::BrandStyleguideParams::Prioritize::OrSymbol, - timeout_ms: Integer, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandStyleguideResponse) - end - def styleguide( - # A specific URL to fetch the styleguide from directly, bypassing domain - # resolution (e.g., 'https://example.com/design-system'). - direct_url: nil, - # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The - # domain will be automatically normalized and validated. - domain: nil, - # Optional parameter to prioritize screenshot capture for styleguide extraction. - # If 'speed', optimizes for faster capture with basic quality. If 'quality', - # optimizes for higher quality with longer wait times. Defaults to 'quality' if - # not provided. - prioritize: 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 - - # Scrapes the given URL and returns the raw HTML content of the page. Uses - # automatic proxy escalation to handle blocked sites. - sig do - params( - url: String, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandWebScrapeHTMLResponse) - end - def web_scrape_html( - # Full URL to scrape (must include http:// or https:// protocol) - url:, - request_options: {} - ) - end - - # Scrapes all images from the given URL. Extracts images from img, svg, - # picture/source, link, and video elements including inline SVGs, base64 data - # URIs, and standard URLs. - sig do - params( - url: String, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandWebScrapeImagesResponse) - end - def web_scrape_images( - # Full URL to scrape images from (must include http:// or https:// protocol) - url:, - request_options: {} - ) - end - - # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown - # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked - # sites. - sig do - params( - url: String, - include_images: T::Boolean, - include_links: T::Boolean, - shorten_base64_images: T::Boolean, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandWebScrapeMdResponse) - end - def web_scrape_md( - # Full URL to scrape and convert to markdown (must include http:// or https:// - # protocol) - url:, - # Include image references in Markdown output - include_images: nil, - # Preserve hyperlinks in Markdown output - include_links: nil, - # Shorten base64-encoded image data in the Markdown output - shorten_base64_images: nil, - request_options: {} - ) - end - - # Crawls the sitemap of the given domain and returns all discovered page URLs. - # Supports sitemap index files (recursive), parallel fetching with concurrency - # control, deduplication, and filters out non-page resources (images, PDFs, etc.). - sig do - params( - domain: String, - request_options: ContextDev::RequestOptions::OrHash - ).returns(ContextDev::Models::BrandWebScrapeSitemapResponse) - end - def web_scrape_sitemap( - # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be - # automatically normalized and validated. - domain:, - request_options: {} - ) - end - # @api private sig { params(client: ContextDev::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/context_dev/resources/industry.rbi b/rbi/context_dev/resources/industry.rbi new file mode 100644 index 00000000..563db4dd --- /dev/null +++ b/rbi/context_dev/resources/industry.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module ContextDev + module Resources + class Industry + # Endpoint to classify any brand into a 2022 NAICS code. + sig do + params( + input: String, + max_results: Integer, + min_results: Integer, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::IndustryRetrieveNaicsResponse) + end + def retrieve_naics( + # Brand domain or title to retrieve NAICS code for. If a valid domain is provided + # in `input`, it will be used for classification, otherwise, we will search for + # the brand using the provided title. + input:, + # Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults + # to 5. + max_results: nil, + # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1. + min_results: 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 + + # @api private + sig { params(client: ContextDev::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/context_dev/resources/style.rbi b/rbi/context_dev/resources/style.rbi new file mode 100644 index 00000000..bc221077 --- /dev/null +++ b/rbi/context_dev/resources/style.rbi @@ -0,0 +1,67 @@ +# typed: strong + +module ContextDev + module Resources + class Style + # Extract font information from a brand's website including font families, usage + # statistics, fallbacks, and element/word counts. + sig do + params( + domain: String, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::StyleExtractFontsResponse) + end + def extract_fonts( + # Domain name to extract fonts from (e.g., 'example.com', 'google.com'). The + # domain will be automatically normalized and validated. + domain:, + # 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 + + # Automatically extract comprehensive design system information from a brand's + # website including colors, typography, spacing, shadows, and UI components. + # Either 'domain' or 'directUrl' must be provided as a query parameter, but not + # both. + sig do + params( + direct_url: String, + domain: String, + prioritize: + ContextDev::StyleExtractStyleguideParams::Prioritize::OrSymbol, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::StyleExtractStyleguideResponse) + end + def extract_styleguide( + # A specific URL to fetch the styleguide from directly, bypassing domain + # resolution (e.g., 'https://example.com/design-system'). + direct_url: nil, + # Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The + # domain will be automatically normalized and validated. + domain: nil, + # Optional parameter to prioritize screenshot capture for styleguide extraction. + # If 'speed', optimizes for faster capture with basic quality. If 'quality', + # optimizes for higher quality with longer wait times. Defaults to 'quality' if + # not provided. + prioritize: 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 + + # @api private + sig { params(client: ContextDev::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/context_dev/resources/utility.rbi b/rbi/context_dev/resources/utility.rbi new file mode 100644 index 00000000..0301cad6 --- /dev/null +++ b/rbi/context_dev/resources/utility.rbi @@ -0,0 +1,60 @@ +# typed: strong + +module ContextDev + module Resources + class Utility + # Signal that you may fetch brand data for a particular domain soon to improve + # latency. This endpoint does not charge credits and is available for paid + # customers to optimize future requests. [You must be on a paid plan to use this + # endpoint] + sig do + params( + domain: String, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::UtilityPrefetchResponse) + end + def prefetch( + # Domain name to prefetch brand data for + domain:, + # 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 + + # Signal that you may fetch brand data for a particular domain soon to improve + # latency. This endpoint accepts an email address, extracts the domain from it, + # validates that it's not a disposable or free email provider, and queues the + # domain for prefetching. This endpoint does not charge credits and is available + # for paid customers to optimize future requests. [You must be on a paid plan to + # use this endpoint] + sig do + params( + email: String, + timeout_ms: Integer, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::UtilityPrefetchByEmailResponse) + end + def prefetch_by_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. + email:, + # 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 + + # @api private + sig { params(client: ContextDev::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi new file mode 100644 index 00000000..e097d6df --- /dev/null +++ b/rbi/context_dev/resources/web.rbi @@ -0,0 +1,121 @@ +# typed: strong + +module ContextDev + module Resources + class Web + # Capture a screenshot of a website. Supports both viewport (standard browser + # view) and full-page screenshots. Can also screenshot specific page types (login, + # pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to + # the uploaded screenshot image hosted on our CDN. + sig do + params( + domain: String, + full_screenshot: + ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + page: ContextDev::WebScreenshotParams::Page::OrSymbol, + prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebScreenshotResponse) + end + def screenshot( + # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The + # domain will be automatically normalized and validated. + domain:, + # Optional parameter to determine screenshot type. If 'true', takes a full page + # screenshot capturing all content. If 'false' or not provided, takes a viewport + # screenshot (standard browser view). + full_screenshot: nil, + # Optional parameter to specify which page type to screenshot. If provided, the + # system will scrape the domain's links and use heuristics to find the most + # appropriate URL for the specified page type (30 supported languages). If not + # provided, screenshots the main domain landing page. + page: nil, + # Optional parameter to prioritize screenshot capture. If 'speed', optimizes for + # faster capture with basic quality. If 'quality', optimizes for higher quality + # with longer wait times. Defaults to 'quality' if not provided. + prioritize: nil, + request_options: {} + ) + end + + # Scrapes the given URL and returns the raw HTML content of the page. Uses + # automatic proxy escalation to handle blocked sites. + sig do + params( + url: String, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebWebScrapeHTMLResponse) + end + def web_scrape_html( + # Full URL to scrape (must include http:// or https:// protocol) + url:, + request_options: {} + ) + end + + # Scrapes all images from the given URL. Extracts images from img, svg, + # picture/source, link, and video elements including inline SVGs, base64 data + # URIs, and standard URLs. + sig do + params( + url: String, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebWebScrapeImagesResponse) + end + def web_scrape_images( + # Full URL to scrape images from (must include http:// or https:// protocol) + url:, + request_options: {} + ) + end + + # Scrapes the given URL, converts the HTML content to GitHub Flavored Markdown + # (GFM), and returns the result. Uses automatic proxy escalation to handle blocked + # sites. + sig do + params( + url: String, + include_images: T::Boolean, + include_links: T::Boolean, + shorten_base64_images: T::Boolean, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebWebScrapeMdResponse) + end + def web_scrape_md( + # Full URL to scrape and convert to markdown (must include http:// or https:// + # protocol) + url:, + # Include image references in Markdown output + include_images: nil, + # Preserve hyperlinks in Markdown output + include_links: nil, + # Shorten base64-encoded image data in the Markdown output + shorten_base64_images: nil, + request_options: {} + ) + end + + # Crawls the sitemap of the given domain and returns all discovered page URLs. + # Supports sitemap index files (recursive), parallel fetching with concurrency + # control, deduplication, and filters out non-page resources (images, PDFs, etc.). + sig do + params( + domain: String, + request_options: ContextDev::RequestOptions::OrHash + ).returns(ContextDev::Models::WebWebScrapeSitemapResponse) + end + def web_scrape_sitemap( + # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be + # automatically normalized and validated. + domain:, + request_options: {} + ) + end + + # @api private + sig { params(client: ContextDev::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/sig/context_dev/client.rbs b/sig/context_dev/client.rbs index ad5be487..1e3fd4de 100644 --- a/sig/context_dev/client.rbs +++ b/sig/context_dev/client.rbs @@ -10,8 +10,18 @@ module ContextDev attr_reader api_key: String + attr_reader web: ContextDev::Resources::Web + + attr_reader ai: ContextDev::Resources::AI + + attr_reader style: ContextDev::Resources::Style + attr_reader brand: ContextDev::Resources::Brand + attr_reader industry: ContextDev::Resources::Industry + + attr_reader utility: ContextDev::Resources::Utility + private def auth_headers: -> ::Hash[String, String] def initialize: ( diff --git a/sig/context_dev/models.rbs b/sig/context_dev/models.rbs index 409ef25b..07f73437 100644 --- a/sig/context_dev/models.rbs +++ b/sig/context_dev/models.rbs @@ -1,18 +1,12 @@ module ContextDev - class BrandAIProductParams = ContextDev::Models::BrandAIProductParams + class AIAIQueryParams = ContextDev::Models::AIAIQueryParams - class BrandAIProductsParams = ContextDev::Models::BrandAIProductsParams + class AIExtractProductParams = ContextDev::Models::AIExtractProductParams - class BrandAIQueryParams = ContextDev::Models::BrandAIQueryParams - - class BrandFontsParams = ContextDev::Models::BrandFontsParams + class AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams class BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams - class BrandPrefetchByEmailParams = ContextDev::Models::BrandPrefetchByEmailParams - - class BrandPrefetchParams = ContextDev::Models::BrandPrefetchParams - class BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams class BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams @@ -21,21 +15,27 @@ module ContextDev class BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams - class BrandRetrieveNaicsParams = ContextDev::Models::BrandRetrieveNaicsParams - class BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams class BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams - class BrandScreenshotParams = ContextDev::Models::BrandScreenshotParams + class IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams + + class StyleExtractFontsParams = ContextDev::Models::StyleExtractFontsParams + + class StyleExtractStyleguideParams = ContextDev::Models::StyleExtractStyleguideParams + + class UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams + + class UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams - class BrandStyleguideParams = ContextDev::Models::BrandStyleguideParams + class WebScreenshotParams = ContextDev::Models::WebScreenshotParams - class BrandWebScrapeHTMLParams = ContextDev::Models::BrandWebScrapeHTMLParams + class WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams - class BrandWebScrapeImagesParams = ContextDev::Models::BrandWebScrapeImagesParams + class WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams - class BrandWebScrapeMdParams = ContextDev::Models::BrandWebScrapeMdParams + class WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams - class BrandWebScrapeSitemapParams = ContextDev::Models::BrandWebScrapeSitemapParams + class WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams end diff --git a/sig/context_dev/models/brand_ai_query_params.rbs b/sig/context_dev/models/ai_ai_query_params.rbs similarity index 63% rename from sig/context_dev/models/brand_ai_query_params.rbs rename to sig/context_dev/models/ai_ai_query_params.rbs index afbb7831..bff42beb 100644 --- a/sig/context_dev/models/brand_ai_query_params.rbs +++ b/sig/context_dev/models/ai_ai_query_params.rbs @@ -1,44 +1,44 @@ module ContextDev module Models - type brand_ai_query_params = + type aiai_query_params = { - data_to_extract: ::Array[ContextDev::BrandAIQueryParams::DataToExtract], + data_to_extract: ::Array[ContextDev::AIAIQueryParams::DataToExtract], domain: String, - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages, + specific_pages: ContextDev::AIAIQueryParams::SpecificPages, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandAIQueryParams < ContextDev::Internal::Type::BaseModel + class AIAIQueryParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters - attr_accessor data_to_extract: ::Array[ContextDev::BrandAIQueryParams::DataToExtract] + attr_accessor data_to_extract: ::Array[ContextDev::AIAIQueryParams::DataToExtract] attr_accessor domain: String - attr_reader specific_pages: ContextDev::BrandAIQueryParams::SpecificPages? + attr_reader specific_pages: ContextDev::AIAIQueryParams::SpecificPages? def specific_pages=: ( - ContextDev::BrandAIQueryParams::SpecificPages - ) -> ContextDev::BrandAIQueryParams::SpecificPages + ContextDev::AIAIQueryParams::SpecificPages + ) -> ContextDev::AIAIQueryParams::SpecificPages attr_reader timeout_ms: Integer? def timeout_ms=: (Integer) -> Integer def initialize: ( - data_to_extract: ::Array[ContextDev::BrandAIQueryParams::DataToExtract], + data_to_extract: ::Array[ContextDev::AIAIQueryParams::DataToExtract], domain: String, - ?specific_pages: ContextDev::BrandAIQueryParams::SpecificPages, + ?specific_pages: ContextDev::AIAIQueryParams::SpecificPages, ?timeout_ms: Integer, ?request_options: ContextDev::request_opts ) -> void def to_hash: -> { - data_to_extract: ::Array[ContextDev::BrandAIQueryParams::DataToExtract], + data_to_extract: ::Array[ContextDev::AIAIQueryParams::DataToExtract], domain: String, - specific_pages: ContextDev::BrandAIQueryParams::SpecificPages, + specific_pages: ContextDev::AIAIQueryParams::SpecificPages, timeout_ms: Integer, request_options: ContextDev::RequestOptions } @@ -48,9 +48,9 @@ module ContextDev datapoint_description: String, datapoint_example: String, datapoint_name: String, - datapoint_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type, - datapoint_list_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type, - datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] + datapoint_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_type, + datapoint_list_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type, + datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] } class DataToExtract < ContextDev::Internal::Type::BaseModel @@ -60,36 +60,36 @@ module ContextDev attr_accessor datapoint_name: String - attr_accessor datapoint_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type + attr_accessor datapoint_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_type - attr_reader datapoint_list_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type? + attr_reader datapoint_list_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type? def datapoint_list_type=: ( - ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type - ) -> ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type + ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type + ) -> ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type - attr_reader datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema]? + attr_reader datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema]? def datapoint_object_schema=: ( - ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] - ) -> ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] + ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] + ) -> ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] def initialize: ( datapoint_description: String, datapoint_example: String, datapoint_name: String, - datapoint_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type, - ?datapoint_list_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type, - ?datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] + datapoint_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_type, + ?datapoint_list_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type, + ?datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] ) -> void def to_hash: -> { datapoint_description: String, datapoint_example: String, datapoint_name: String, - datapoint_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type, - datapoint_list_type: ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type, - datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] + datapoint_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_type, + datapoint_list_type: ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type, + datapoint_object_schema: ::Hash[Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] } type datapoint_type = :text | :number | :date | :boolean | :list | :url @@ -104,7 +104,7 @@ module ContextDev LIST: :list URL: :url - def self?.values: -> ::Array[ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_type] + def self?.values: -> ::Array[ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_type] end type datapoint_list_type = @@ -122,7 +122,7 @@ module ContextDev URL: :url OBJECT: :object - def self?.values: -> ::Array[ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_list_type] + def self?.values: -> ::Array[ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_list_type] end type datapoint_object_schema = :string | :number | :date | :boolean @@ -135,7 +135,7 @@ module ContextDev DATE: :date BOOLEAN: :boolean - def self?.values: -> ::Array[ContextDev::Models::BrandAIQueryParams::DataToExtract::datapoint_object_schema] + def self?.values: -> ::Array[ContextDev::Models::AIAIQueryParams::DataToExtract::datapoint_object_schema] end end diff --git a/sig/context_dev/models/brand_ai_query_response.rbs b/sig/context_dev/models/ai_ai_query_response.rbs similarity index 55% rename from sig/context_dev/models/brand_ai_query_response.rbs rename to sig/context_dev/models/ai_ai_query_response.rbs index ea8b6b7f..6e982cad 100644 --- a/sig/context_dev/models/brand_ai_query_response.rbs +++ b/sig/context_dev/models/ai_ai_query_response.rbs @@ -1,19 +1,19 @@ module ContextDev module Models - type brand_ai_query_response = + type aiai_query_response = { - data_extracted: ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted], + data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, status: String, urls_analyzed: ::Array[String] } - class BrandAIQueryResponse < ContextDev::Internal::Type::BaseModel - attr_reader data_extracted: ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted]? + class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel + attr_reader data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted]? def data_extracted=: ( - ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted] - ) -> ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted] + ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted] + ) -> ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted] attr_reader domain: String? @@ -28,14 +28,14 @@ module ContextDev def urls_analyzed=: (::Array[String]) -> ::Array[String] def initialize: ( - ?data_extracted: ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted], + ?data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], ?domain: String, ?status: String, ?urls_analyzed: ::Array[String] ) -> void def to_hash: -> { - data_extracted: ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted], + data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, status: String, urls_analyzed: ::Array[String] @@ -44,7 +44,7 @@ module ContextDev type data_extracted = { datapoint_name: String, - datapoint_value: ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value + datapoint_value: ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value } class DataExtracted < ContextDev::Internal::Type::BaseModel @@ -52,20 +52,20 @@ module ContextDev def datapoint_name=: (String) -> String - attr_reader datapoint_value: ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value? + attr_reader datapoint_value: ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value? def datapoint_value=: ( - ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value - ) -> ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value + ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value + ) -> ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value def initialize: ( ?datapoint_name: String, - ?datapoint_value: ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value + ?datapoint_value: ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value ) -> void def to_hash: -> { datapoint_name: String, - datapoint_value: ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value + datapoint_value: ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value } type datapoint_value = @@ -79,7 +79,7 @@ module ContextDev module DatapointValue extend ContextDev::Internal::Type::Union - def self?.variants: -> ::Array[ContextDev::Models::BrandAIQueryResponse::DataExtracted::datapoint_value] + def self?.variants: -> ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted::datapoint_value] StringArray: ContextDev::Internal::Type::Converter diff --git a/sig/context_dev/models/brand_ai_product_params.rbs b/sig/context_dev/models/ai_extract_product_params.rbs similarity index 86% rename from sig/context_dev/models/brand_ai_product_params.rbs rename to sig/context_dev/models/ai_extract_product_params.rbs index 9b777c25..516063e1 100644 --- a/sig/context_dev/models/brand_ai_product_params.rbs +++ b/sig/context_dev/models/ai_extract_product_params.rbs @@ -1,10 +1,10 @@ module ContextDev module Models - type brand_ai_product_params = + type ai_extract_product_params = { url: String, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandAIProductParams < ContextDev::Internal::Type::BaseModel + class AIExtractProductParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_ai_product_response.rbs b/sig/context_dev/models/ai_extract_product_response.rbs similarity index 60% rename from sig/context_dev/models/brand_ai_product_response.rbs rename to sig/context_dev/models/ai_extract_product_response.rbs index 31d72880..c10fac5d 100644 --- a/sig/context_dev/models/brand_ai_product_response.rbs +++ b/sig/context_dev/models/ai_extract_product_response.rbs @@ -1,31 +1,31 @@ module ContextDev module Models - type brand_ai_product_response = + type ai_extract_product_response = { is_product_page: bool, - platform: ContextDev::Models::BrandAIProductResponse::platform?, - product: ContextDev::Models::BrandAIProductResponse::Product? + platform: ContextDev::Models::AIExtractProductResponse::platform?, + product: ContextDev::Models::AIExtractProductResponse::Product? } - class BrandAIProductResponse < ContextDev::Internal::Type::BaseModel + class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel attr_reader is_product_page: bool? def is_product_page=: (bool) -> bool - attr_accessor platform: ContextDev::Models::BrandAIProductResponse::platform? + attr_accessor platform: ContextDev::Models::AIExtractProductResponse::platform? - attr_accessor product: ContextDev::Models::BrandAIProductResponse::Product? + attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product? def initialize: ( ?is_product_page: bool, - ?platform: ContextDev::Models::BrandAIProductResponse::platform?, - ?product: ContextDev::Models::BrandAIProductResponse::Product? + ?platform: ContextDev::Models::AIExtractProductResponse::platform?, + ?product: ContextDev::Models::AIExtractProductResponse::Product? ) -> void def to_hash: -> { is_product_page: bool, - platform: ContextDev::Models::BrandAIProductResponse::platform?, - product: ContextDev::Models::BrandAIProductResponse::Product? + platform: ContextDev::Models::AIExtractProductResponse::platform?, + product: ContextDev::Models::AIExtractProductResponse::Product? } type platform = :amazon | :tiktok_shop | :etsy | :generic @@ -38,7 +38,7 @@ module ContextDev ETSY: :etsy GENERIC: :generic - def self?.values: -> ::Array[ContextDev::Models::BrandAIProductResponse::platform] + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::platform] end type product = @@ -49,12 +49,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - billing_frequency: ContextDev::Models::BrandAIProductResponse::Product::billing_frequency?, + billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?, category: String?, currency: String?, image_url: String?, price: Float?, - pricing_model: ContextDev::Models::BrandAIProductResponse::Product::pricing_model?, + pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?, url: String? } @@ -71,7 +71,7 @@ module ContextDev attr_accessor target_audience: ::Array[String] - attr_accessor billing_frequency: ContextDev::Models::BrandAIProductResponse::Product::billing_frequency? + attr_accessor billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency? attr_accessor category: String? @@ -81,7 +81,7 @@ module ContextDev attr_accessor price: Float? - attr_accessor pricing_model: ContextDev::Models::BrandAIProductResponse::Product::pricing_model? + attr_accessor pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model? attr_accessor url: String? @@ -92,12 +92,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - ?billing_frequency: ContextDev::Models::BrandAIProductResponse::Product::billing_frequency?, + ?billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?, ?category: String?, ?currency: String?, ?image_url: String?, ?price: Float?, - ?pricing_model: ContextDev::Models::BrandAIProductResponse::Product::pricing_model?, + ?pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?, ?url: String? ) -> void @@ -108,12 +108,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - billing_frequency: ContextDev::Models::BrandAIProductResponse::Product::billing_frequency?, + billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?, category: String?, currency: String?, image_url: String?, price: Float?, - pricing_model: ContextDev::Models::BrandAIProductResponse::Product::pricing_model?, + pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?, url: String? } @@ -127,7 +127,7 @@ module ContextDev ONE_TIME: :one_time USAGE_BASED: :usage_based - def self?.values: -> ::Array[ContextDev::Models::BrandAIProductResponse::Product::billing_frequency] + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::billing_frequency] end type pricing_model = :per_seat | :flat | :tiered | :freemium | :custom @@ -141,7 +141,7 @@ module ContextDev FREEMIUM: :freemium CUSTOM: :custom - def self?.values: -> ::Array[ContextDev::Models::BrandAIProductResponse::Product::pricing_model] + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::pricing_model] end end end diff --git a/sig/context_dev/models/brand_ai_products_params.rbs b/sig/context_dev/models/ai_extract_products_params.rbs similarity index 76% rename from sig/context_dev/models/brand_ai_products_params.rbs rename to sig/context_dev/models/ai_extract_products_params.rbs index a17f78ce..f51d13e7 100644 --- a/sig/context_dev/models/brand_ai_products_params.rbs +++ b/sig/context_dev/models/ai_extract_products_params.rbs @@ -1,28 +1,28 @@ module ContextDev module Models - type brand_ai_products_params = - { body: ContextDev::Models::BrandAIProductsParams::body } + type ai_extract_products_params = + { body: ContextDev::Models::AIExtractProductsParams::body } & ContextDev::Internal::Type::request_parameters - class BrandAIProductsParams < ContextDev::Internal::Type::BaseModel + class AIExtractProductsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters - attr_accessor body: ContextDev::Models::BrandAIProductsParams::body + attr_accessor body: ContextDev::Models::AIExtractProductsParams::body def initialize: ( - body: ContextDev::Models::BrandAIProductsParams::body, + body: ContextDev::Models::AIExtractProductsParams::body, ?request_options: ContextDev::request_opts ) -> void def to_hash: -> { - body: ContextDev::Models::BrandAIProductsParams::body, + body: ContextDev::Models::AIExtractProductsParams::body, request_options: ContextDev::RequestOptions } type body = - ContextDev::BrandAIProductsParams::Body::ByDomain - | ContextDev::BrandAIProductsParams::Body::ByDirectURL + ContextDev::AIExtractProductsParams::Body::ByDomain + | ContextDev::AIExtractProductsParams::Body::ByDirectURL module Body extend ContextDev::Internal::Type::Union @@ -81,7 +81,7 @@ module ContextDev } end - def self?.variants: -> ::Array[ContextDev::Models::BrandAIProductsParams::body] + def self?.variants: -> ::Array[ContextDev::Models::AIExtractProductsParams::body] end end end diff --git a/sig/context_dev/models/brand_ai_products_response.rbs b/sig/context_dev/models/ai_extract_products_response.rbs similarity index 59% rename from sig/context_dev/models/brand_ai_products_response.rbs rename to sig/context_dev/models/ai_extract_products_response.rbs index 88280438..2e9094b5 100644 --- a/sig/context_dev/models/brand_ai_products_response.rbs +++ b/sig/context_dev/models/ai_extract_products_response.rbs @@ -1,23 +1,23 @@ module ContextDev module Models - type brand_ai_products_response = + type ai_extract_products_response = { - products: ::Array[ContextDev::Models::BrandAIProductsResponse::Product] + products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } - class BrandAIProductsResponse < ContextDev::Internal::Type::BaseModel - attr_reader products: ::Array[ContextDev::Models::BrandAIProductsResponse::Product]? + class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel + attr_reader products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]? def products=: ( - ::Array[ContextDev::Models::BrandAIProductsResponse::Product] - ) -> ::Array[ContextDev::Models::BrandAIProductsResponse::Product] + ::Array[ContextDev::Models::AIExtractProductsResponse::Product] + ) -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product] def initialize: ( - ?products: ::Array[ContextDev::Models::BrandAIProductsResponse::Product] + ?products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] ) -> void def to_hash: -> { - products: ::Array[ContextDev::Models::BrandAIProductsResponse::Product] + products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } type product = @@ -28,12 +28,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - billing_frequency: ContextDev::Models::BrandAIProductsResponse::Product::billing_frequency?, + billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?, category: String?, currency: String?, image_url: String?, price: Float?, - pricing_model: ContextDev::Models::BrandAIProductsResponse::Product::pricing_model?, + pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?, url: String? } @@ -50,7 +50,7 @@ module ContextDev attr_accessor target_audience: ::Array[String] - attr_accessor billing_frequency: ContextDev::Models::BrandAIProductsResponse::Product::billing_frequency? + attr_accessor billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency? attr_accessor category: String? @@ -60,7 +60,7 @@ module ContextDev attr_accessor price: Float? - attr_accessor pricing_model: ContextDev::Models::BrandAIProductsResponse::Product::pricing_model? + attr_accessor pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model? attr_accessor url: String? @@ -71,12 +71,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - ?billing_frequency: ContextDev::Models::BrandAIProductsResponse::Product::billing_frequency?, + ?billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?, ?category: String?, ?currency: String?, ?image_url: String?, ?price: Float?, - ?pricing_model: ContextDev::Models::BrandAIProductsResponse::Product::pricing_model?, + ?pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?, ?url: String? ) -> void @@ -87,12 +87,12 @@ module ContextDev name: String, tags: ::Array[String], target_audience: ::Array[String], - billing_frequency: ContextDev::Models::BrandAIProductsResponse::Product::billing_frequency?, + billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?, category: String?, currency: String?, image_url: String?, price: Float?, - pricing_model: ContextDev::Models::BrandAIProductsResponse::Product::pricing_model?, + pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?, url: String? } @@ -106,7 +106,7 @@ module ContextDev ONE_TIME: :one_time USAGE_BASED: :usage_based - def self?.values: -> ::Array[ContextDev::Models::BrandAIProductsResponse::Product::billing_frequency] + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency] end type pricing_model = :per_seat | :flat | :tiered | :freemium | :custom @@ -120,7 +120,7 @@ module ContextDev FREEMIUM: :freemium CUSTOM: :custom - def self?.values: -> ::Array[ContextDev::Models::BrandAIProductsResponse::Product::pricing_model] + def self?.values: -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product::pricing_model] end end end diff --git a/sig/context_dev/models/brand_identify_from_transaction_params.rbs b/sig/context_dev/models/brand_identify_from_transaction_params.rbs index cb9cd55a..d8d5aa3b 100644 --- a/sig/context_dev/models/brand_identify_from_transaction_params.rbs +++ b/sig/context_dev/models/brand_identify_from_transaction_params.rbs @@ -575,6 +575,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -594,6 +595,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -616,6 +618,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -631,6 +634,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -650,6 +654,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -672,6 +677,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_retrieve_by_email_params.rbs b/sig/context_dev/models/brand_retrieve_by_email_params.rbs index 4a17268b..c07d9826 100644 --- a/sig/context_dev/models/brand_retrieve_by_email_params.rbs +++ b/sig/context_dev/models/brand_retrieve_by_email_params.rbs @@ -51,6 +51,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -70,6 +71,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -92,6 +94,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -107,6 +110,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -126,6 +130,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -148,6 +153,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_retrieve_by_isin_params.rbs b/sig/context_dev/models/brand_retrieve_by_isin_params.rbs index 8c644305..91eee81b 100644 --- a/sig/context_dev/models/brand_retrieve_by_isin_params.rbs +++ b/sig/context_dev/models/brand_retrieve_by_isin_params.rbs @@ -51,6 +51,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -70,6 +71,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -92,6 +94,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -107,6 +110,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -126,6 +130,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -148,6 +153,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_retrieve_by_name_params.rbs b/sig/context_dev/models/brand_retrieve_by_name_params.rbs index 0c6f1079..96d801bc 100644 --- a/sig/context_dev/models/brand_retrieve_by_name_params.rbs +++ b/sig/context_dev/models/brand_retrieve_by_name_params.rbs @@ -547,6 +547,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -566,6 +567,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -588,6 +590,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -603,6 +606,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -622,6 +626,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -644,6 +649,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs b/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs index ceaf995a..4cc092f9 100644 --- a/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs +++ b/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs @@ -60,6 +60,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -79,6 +80,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -101,6 +103,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -116,6 +119,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -135,6 +139,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -157,6 +162,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_retrieve_params.rbs b/sig/context_dev/models/brand_retrieve_params.rbs index 68475e82..2f271b9f 100644 --- a/sig/context_dev/models/brand_retrieve_params.rbs +++ b/sig/context_dev/models/brand_retrieve_params.rbs @@ -51,6 +51,7 @@ module ContextDev | :azeri | :bengali | :bulgarian + | :cantonese | :cebuano | :croatian | :czech @@ -70,6 +71,7 @@ module ContextDev | :indonesian | :italian | :kazakh + | :korean | :kyrgyz | :latin | :latvian @@ -92,6 +94,7 @@ module ContextDev | :swahili | :swedish | :tagalog + | :thai | :turkish | :ukrainian | :urdu @@ -107,6 +110,7 @@ module ContextDev AZERI: :azeri BENGALI: :bengali BULGARIAN: :bulgarian + CANTONESE: :cantonese CEBUANO: :cebuano CROATIAN: :croatian CZECH: :czech @@ -126,6 +130,7 @@ module ContextDev INDONESIAN: :indonesian ITALIAN: :italian KAZAKH: :kazakh + KOREAN: :korean KYRGYZ: :kyrgyz LATIN: :latin LATVIAN: :latvian @@ -148,6 +153,7 @@ module ContextDev SWAHILI: :swahili SWEDISH: :swedish TAGALOG: :tagalog + THAI: :thai TURKISH: :turkish UKRAINIAN: :ukrainian URDU: :urdu diff --git a/sig/context_dev/models/brand_screenshot_params.rbs b/sig/context_dev/models/brand_screenshot_params.rbs deleted file mode 100644 index eaa8148d..00000000 --- a/sig/context_dev/models/brand_screenshot_params.rbs +++ /dev/null @@ -1,100 +0,0 @@ -module ContextDev - module Models - type brand_screenshot_params = - { - domain: String, - full_screenshot: ContextDev::Models::BrandScreenshotParams::full_screenshot, - page: ContextDev::Models::BrandScreenshotParams::page, - prioritize: ContextDev::Models::BrandScreenshotParams::prioritize - } - & ContextDev::Internal::Type::request_parameters - - class BrandScreenshotParams < ContextDev::Internal::Type::BaseModel - extend ContextDev::Internal::Type::RequestParameters::Converter - include ContextDev::Internal::Type::RequestParameters - - attr_accessor domain: String - - attr_reader full_screenshot: ContextDev::Models::BrandScreenshotParams::full_screenshot? - - def full_screenshot=: ( - ContextDev::Models::BrandScreenshotParams::full_screenshot - ) -> ContextDev::Models::BrandScreenshotParams::full_screenshot - - attr_reader page: ContextDev::Models::BrandScreenshotParams::page? - - def page=: ( - ContextDev::Models::BrandScreenshotParams::page - ) -> ContextDev::Models::BrandScreenshotParams::page - - attr_reader prioritize: ContextDev::Models::BrandScreenshotParams::prioritize? - - def prioritize=: ( - ContextDev::Models::BrandScreenshotParams::prioritize - ) -> ContextDev::Models::BrandScreenshotParams::prioritize - - def initialize: ( - domain: String, - ?full_screenshot: ContextDev::Models::BrandScreenshotParams::full_screenshot, - ?page: ContextDev::Models::BrandScreenshotParams::page, - ?prioritize: ContextDev::Models::BrandScreenshotParams::prioritize, - ?request_options: ContextDev::request_opts - ) -> void - - def to_hash: -> { - domain: String, - full_screenshot: ContextDev::Models::BrandScreenshotParams::full_screenshot, - page: ContextDev::Models::BrandScreenshotParams::page, - prioritize: ContextDev::Models::BrandScreenshotParams::prioritize, - request_options: ContextDev::RequestOptions - } - - type full_screenshot = :true | :false - - module FullScreenshot - extend ContextDev::Internal::Type::Enum - - TRUE: :true - FALSE: :false - - def self?.values: -> ::Array[ContextDev::Models::BrandScreenshotParams::full_screenshot] - end - - type page = - :login - | :signup - | :blog - | :careers - | :pricing - | :terms - | :privacy - | :contact - - module Page - extend ContextDev::Internal::Type::Enum - - LOGIN: :login - SIGNUP: :signup - BLOG: :blog - CAREERS: :careers - PRICING: :pricing - TERMS: :terms - PRIVACY: :privacy - CONTACT: :contact - - def self?.values: -> ::Array[ContextDev::Models::BrandScreenshotParams::page] - end - - type prioritize = :speed | :quality - - module Prioritize - extend ContextDev::Internal::Type::Enum - - SPEED: :speed - QUALITY: :quality - - def self?.values: -> ::Array[ContextDev::Models::BrandScreenshotParams::prioritize] - end - end - end -end diff --git a/sig/context_dev/models/brand_web_scrape_html_response.rbs b/sig/context_dev/models/brand_web_scrape_html_response.rbs deleted file mode 100644 index 26b88e95..00000000 --- a/sig/context_dev/models/brand_web_scrape_html_response.rbs +++ /dev/null @@ -1,40 +0,0 @@ -module ContextDev - module Models - type brand_web_scrape_html_response = - { - html: String, - success: ContextDev::Models::BrandWebScrapeHTMLResponse::success, - url: String - } - - class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel - attr_accessor html: String - - attr_accessor success: ContextDev::Models::BrandWebScrapeHTMLResponse::success - - attr_accessor url: String - - def initialize: ( - html: String, - success: ContextDev::Models::BrandWebScrapeHTMLResponse::success, - url: String - ) -> void - - def to_hash: -> { - html: String, - success: ContextDev::Models::BrandWebScrapeHTMLResponse::success, - url: String - } - - type success = true - - module Success - extend ContextDev::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeHTMLResponse::success] - end - end - end -end diff --git a/sig/context_dev/models/brand_web_scrape_images_response.rbs b/sig/context_dev/models/brand_web_scrape_images_response.rbs deleted file mode 100644 index 848c9c48..00000000 --- a/sig/context_dev/models/brand_web_scrape_images_response.rbs +++ /dev/null @@ -1,98 +0,0 @@ -module ContextDev - module Models - type brand_web_scrape_images_response = - { - images: ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image], - success: ContextDev::Models::BrandWebScrapeImagesResponse::success, - url: String - } - - class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel - attr_accessor images: ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image] - - attr_accessor success: ContextDev::Models::BrandWebScrapeImagesResponse::success - - attr_accessor url: String - - def initialize: ( - images: ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image], - success: ContextDev::Models::BrandWebScrapeImagesResponse::success, - url: String - ) -> void - - def to_hash: -> { - images: ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image], - success: ContextDev::Models::BrandWebScrapeImagesResponse::success, - url: String - } - - type image = - { - alt: String?, - element: ContextDev::Models::BrandWebScrapeImagesResponse::Image::element, - src: String, - type: ContextDev::Models::BrandWebScrapeImagesResponse::Image::type_ - } - - class Image < ContextDev::Internal::Type::BaseModel - attr_accessor alt: String? - - attr_accessor element: ContextDev::Models::BrandWebScrapeImagesResponse::Image::element - - attr_accessor src: String - - attr_accessor type: ContextDev::Models::BrandWebScrapeImagesResponse::Image::type_ - - def initialize: ( - alt: String?, - element: ContextDev::Models::BrandWebScrapeImagesResponse::Image::element, - src: String, - type: ContextDev::Models::BrandWebScrapeImagesResponse::Image::type_ - ) -> void - - def to_hash: -> { - alt: String?, - element: ContextDev::Models::BrandWebScrapeImagesResponse::Image::element, - src: String, - type: ContextDev::Models::BrandWebScrapeImagesResponse::Image::type_ - } - - type element = :img | :svg | :link | :source | :video - - module Element - extend ContextDev::Internal::Type::Enum - - IMG: :img - SVG: :svg - LINK: :link - SOURCE: :source - VIDEO: :video - - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image::element] - end - - type type_ = :url | :html | :base64 - - module Type - extend ContextDev::Internal::Type::Enum - - URL: :url - HTML: :html - BASE64: :base64 - - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image::type_] - end - end - - type success = true - - module Success - extend ContextDev::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeImagesResponse::success] - end - end - end -end diff --git a/sig/context_dev/models/brand_web_scrape_md_response.rbs b/sig/context_dev/models/brand_web_scrape_md_response.rbs deleted file mode 100644 index 4cdb13af..00000000 --- a/sig/context_dev/models/brand_web_scrape_md_response.rbs +++ /dev/null @@ -1,40 +0,0 @@ -module ContextDev - module Models - type brand_web_scrape_md_response = - { - markdown: String, - success: ContextDev::Models::BrandWebScrapeMdResponse::success, - url: String - } - - class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel - attr_accessor markdown: String - - attr_accessor success: ContextDev::Models::BrandWebScrapeMdResponse::success - - attr_accessor url: String - - def initialize: ( - markdown: String, - success: ContextDev::Models::BrandWebScrapeMdResponse::success, - url: String - ) -> void - - def to_hash: -> { - markdown: String, - success: ContextDev::Models::BrandWebScrapeMdResponse::success, - url: String - } - - type success = true - - module Success - extend ContextDev::Internal::Type::Enum - - TRUE: true - - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeMdResponse::success] - end - end - end -end diff --git a/sig/context_dev/models/brand_retrieve_naics_params.rbs b/sig/context_dev/models/industry_retrieve_naics_params.rbs similarity index 89% rename from sig/context_dev/models/brand_retrieve_naics_params.rbs rename to sig/context_dev/models/industry_retrieve_naics_params.rbs index 64e1f822..2d963c28 100644 --- a/sig/context_dev/models/brand_retrieve_naics_params.rbs +++ b/sig/context_dev/models/industry_retrieve_naics_params.rbs @@ -1,6 +1,6 @@ module ContextDev module Models - type brand_retrieve_naics_params = + type industry_retrieve_naics_params = { input: String, max_results: Integer, @@ -9,7 +9,7 @@ module ContextDev } & ContextDev::Internal::Type::request_parameters - class BrandRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel + class IndustryRetrieveNaicsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_retrieve_naics_response.rbs b/sig/context_dev/models/industry_retrieve_naics_response.rbs similarity index 52% rename from sig/context_dev/models/brand_retrieve_naics_response.rbs rename to sig/context_dev/models/industry_retrieve_naics_response.rbs index b7ef84b3..3cdc639d 100644 --- a/sig/context_dev/models/brand_retrieve_naics_response.rbs +++ b/sig/context_dev/models/industry_retrieve_naics_response.rbs @@ -1,19 +1,19 @@ module ContextDev module Models - type brand_retrieve_naics_response = + type industry_retrieve_naics_response = { - codes: ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code], + codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, status: String, type: String } - class BrandRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel - attr_reader codes: ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code]? + class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel + attr_reader codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code]? def codes=: ( - ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code] - ) -> ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code] + ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code] + ) -> ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code] attr_reader domain: String? @@ -28,14 +28,14 @@ module ContextDev def type=: (String) -> String def initialize: ( - ?codes: ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code], + ?codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], ?domain: String, ?status: String, ?type: String ) -> void def to_hash: -> { - codes: ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code], + codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, status: String, type: String @@ -44,26 +44,26 @@ module ContextDev type code = { code: String, - confidence: ContextDev::Models::BrandRetrieveNaicsResponse::Code::confidence, + confidence: ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence, name: String } class Code < ContextDev::Internal::Type::BaseModel attr_accessor code: String - attr_accessor confidence: ContextDev::Models::BrandRetrieveNaicsResponse::Code::confidence + attr_accessor confidence: ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence attr_accessor name: String def initialize: ( code: String, - confidence: ContextDev::Models::BrandRetrieveNaicsResponse::Code::confidence, + confidence: ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence, name: String ) -> void def to_hash: -> { code: String, - confidence: ContextDev::Models::BrandRetrieveNaicsResponse::Code::confidence, + confidence: ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence, name: String } @@ -76,7 +76,7 @@ module ContextDev MEDIUM: :medium LOW: :low - def self?.values: -> ::Array[ContextDev::Models::BrandRetrieveNaicsResponse::Code::confidence] + def self?.values: -> ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence] end end end diff --git a/sig/context_dev/models/brand_fonts_params.rbs b/sig/context_dev/models/style_extract_fonts_params.rbs similarity index 86% rename from sig/context_dev/models/brand_fonts_params.rbs rename to sig/context_dev/models/style_extract_fonts_params.rbs index 44fb4885..20ea7962 100644 --- a/sig/context_dev/models/brand_fonts_params.rbs +++ b/sig/context_dev/models/style_extract_fonts_params.rbs @@ -1,10 +1,10 @@ module ContextDev module Models - type brand_fonts_params = + type style_extract_fonts_params = { domain: String, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandFontsParams < ContextDev::Internal::Type::BaseModel + class StyleExtractFontsParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_fonts_response.rbs b/sig/context_dev/models/style_extract_fonts_response.rbs similarity index 78% rename from sig/context_dev/models/brand_fonts_response.rbs rename to sig/context_dev/models/style_extract_fonts_response.rbs index 26f5a175..1028f587 100644 --- a/sig/context_dev/models/brand_fonts_response.rbs +++ b/sig/context_dev/models/style_extract_fonts_response.rbs @@ -1,33 +1,33 @@ module ContextDev module Models - type brand_fonts_response = + type style_extract_fonts_response = { code: Integer, domain: String, - fonts: ::Array[ContextDev::Models::BrandFontsResponse::Font], + fonts: ::Array[ContextDev::Models::StyleExtractFontsResponse::Font], status: String } - class BrandFontsResponse < ContextDev::Internal::Type::BaseModel + class StyleExtractFontsResponse < ContextDev::Internal::Type::BaseModel attr_accessor code: Integer attr_accessor domain: String - attr_accessor fonts: ::Array[ContextDev::Models::BrandFontsResponse::Font] + attr_accessor fonts: ::Array[ContextDev::Models::StyleExtractFontsResponse::Font] attr_accessor status: String def initialize: ( code: Integer, domain: String, - fonts: ::Array[ContextDev::Models::BrandFontsResponse::Font], + fonts: ::Array[ContextDev::Models::StyleExtractFontsResponse::Font], status: String ) -> void def to_hash: -> { code: Integer, domain: String, - fonts: ::Array[ContextDev::Models::BrandFontsResponse::Font], + fonts: ::Array[ContextDev::Models::StyleExtractFontsResponse::Font], status: String } diff --git a/sig/context_dev/models/brand_styleguide_params.rbs b/sig/context_dev/models/style_extract_styleguide_params.rbs similarity index 61% rename from sig/context_dev/models/brand_styleguide_params.rbs rename to sig/context_dev/models/style_extract_styleguide_params.rbs index 0c6b3bc9..c56ddf4e 100644 --- a/sig/context_dev/models/brand_styleguide_params.rbs +++ b/sig/context_dev/models/style_extract_styleguide_params.rbs @@ -1,15 +1,15 @@ module ContextDev module Models - type brand_styleguide_params = + type style_extract_styleguide_params = { direct_url: String, domain: String, - prioritize: ContextDev::Models::BrandStyleguideParams::prioritize, + prioritize: ContextDev::Models::StyleExtractStyleguideParams::prioritize, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandStyleguideParams < ContextDev::Internal::Type::BaseModel + class StyleExtractStyleguideParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters @@ -21,11 +21,11 @@ module ContextDev def domain=: (String) -> String - attr_reader prioritize: ContextDev::Models::BrandStyleguideParams::prioritize? + attr_reader prioritize: ContextDev::Models::StyleExtractStyleguideParams::prioritize? def prioritize=: ( - ContextDev::Models::BrandStyleguideParams::prioritize - ) -> ContextDev::Models::BrandStyleguideParams::prioritize + ContextDev::Models::StyleExtractStyleguideParams::prioritize + ) -> ContextDev::Models::StyleExtractStyleguideParams::prioritize attr_reader timeout_ms: Integer? @@ -34,7 +34,7 @@ module ContextDev def initialize: ( ?direct_url: String, ?domain: String, - ?prioritize: ContextDev::Models::BrandStyleguideParams::prioritize, + ?prioritize: ContextDev::Models::StyleExtractStyleguideParams::prioritize, ?timeout_ms: Integer, ?request_options: ContextDev::request_opts ) -> void @@ -42,7 +42,7 @@ module ContextDev def to_hash: -> { direct_url: String, domain: String, - prioritize: ContextDev::Models::BrandStyleguideParams::prioritize, + prioritize: ContextDev::Models::StyleExtractStyleguideParams::prioritize, timeout_ms: Integer, request_options: ContextDev::RequestOptions } @@ -55,7 +55,7 @@ module ContextDev SPEED: :speed QUALITY: :quality - def self?.values: -> ::Array[ContextDev::Models::BrandStyleguideParams::prioritize] + def self?.values: -> ::Array[ContextDev::Models::StyleExtractStyleguideParams::prioritize] end end end diff --git a/sig/context_dev/models/brand_styleguide_response.rbs b/sig/context_dev/models/style_extract_styleguide_response.rbs similarity index 65% rename from sig/context_dev/models/brand_styleguide_response.rbs rename to sig/context_dev/models/style_extract_styleguide_response.rbs index 8b1c8b5d..4a72556b 100644 --- a/sig/context_dev/models/brand_styleguide_response.rbs +++ b/sig/context_dev/models/style_extract_styleguide_response.rbs @@ -1,14 +1,14 @@ module ContextDev module Models - type brand_styleguide_response = + type style_extract_styleguide_response = { code: Integer, domain: String, status: String, - styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide + styleguide: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide } - class BrandStyleguideResponse < ContextDev::Internal::Type::BaseModel + class StyleExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel attr_reader code: Integer? def code=: (Integer) -> Integer @@ -21,89 +21,89 @@ module ContextDev def status=: (String) -> String - attr_reader styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide? + attr_reader styleguide: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide? def styleguide=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide def initialize: ( ?code: Integer, ?domain: String, ?status: String, - ?styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide + ?styleguide: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide ) -> void def to_hash: -> { code: Integer, domain: String, status: String, - styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide + styleguide: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide } type styleguide = { - colors: ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - mode: ContextDev::Models::BrandStyleguideResponse::Styleguide::mode, - shadows: ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + colors: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, + components: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, + element_spacing: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, + mode: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode, + shadows: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, + typography: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography } class Styleguide < ContextDev::Internal::Type::BaseModel - attr_reader colors: ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors? + attr_reader colors: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors? def colors=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors - attr_reader components: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components? + attr_reader components: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components? def components=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components - attr_reader element_spacing: ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing? + attr_reader element_spacing: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing? def element_spacing=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing - attr_reader mode: ContextDev::Models::BrandStyleguideResponse::Styleguide::mode? + attr_reader mode: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode? def mode=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::mode - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::mode + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode - attr_reader shadows: ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows? + attr_reader shadows: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows? def shadows=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows - attr_reader typography: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography? + attr_reader typography: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography? def typography=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography def initialize: ( - ?colors: ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, - ?components: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, - ?element_spacing: ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - ?mode: ContextDev::Models::BrandStyleguideResponse::Styleguide::mode, - ?shadows: ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - ?typography: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + ?colors: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, + ?components: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, + ?element_spacing: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, + ?mode: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode, + ?shadows: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, + ?typography: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography ) -> void def to_hash: -> { - colors: ContextDev::Models::BrandStyleguideResponse::Styleguide::Colors, - components: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components, - element_spacing: ContextDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, - mode: ContextDev::Models::BrandStyleguideResponse::Styleguide::mode, - shadows: ContextDev::Models::BrandStyleguideResponse::Styleguide::Shadows, - typography: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography + colors: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors, + components: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components, + element_spacing: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing, + mode: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode, + shadows: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows, + typography: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography } type colors = { accent: String, background: String, text: String } @@ -132,69 +132,69 @@ module ContextDev type components = { - button: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - card: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + button: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, + card: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card } class Components < ContextDev::Internal::Type::BaseModel - attr_reader button: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button? + attr_reader button: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button? def button=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button - attr_reader card: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card? + attr_reader card: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card? def card=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card def initialize: ( - ?button: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - ?card: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + ?button: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, + ?card: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card ) -> void def to_hash: -> { - button: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, - card: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Card + button: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button, + card: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card } type button = { - link: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - primary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - secondary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + link: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, + primary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, + secondary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary } class Button < ContextDev::Internal::Type::BaseModel - attr_reader link: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link? + attr_reader link: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link? def link=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link - attr_reader primary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary? + attr_reader primary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary? def primary=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary - attr_reader secondary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary? + attr_reader secondary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary? def secondary=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary def initialize: ( - ?link: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - ?primary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - ?secondary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + ?link: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, + ?primary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, + ?secondary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary ) -> void def to_hash: -> { - link: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, - primary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, - secondary: ContextDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary + link: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, + primary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, + secondary: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary } type link = @@ -583,7 +583,7 @@ module ContextDev LIGHT: :light DARK: :dark - def self?.values: -> ::Array[ContextDev::Models::BrandStyleguideResponse::Styleguide::mode] + def self?.values: -> ::Array[ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::mode] end type shadows = @@ -629,78 +629,78 @@ module ContextDev type typography = { - headings: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - p_: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + headings: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, + p_: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P } class Typography < ContextDev::Internal::Type::BaseModel - attr_reader headings: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings? + attr_reader headings: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings? def headings=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings - attr_reader p_: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P? + attr_reader p_: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P? def p_=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P def initialize: ( - ?headings: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - ?p_: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + ?headings: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, + ?p_: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P ) -> void def to_hash: -> { - headings: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, - p_: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::P + headings: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings, + p_: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P } type headings = { - :h1 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - :h2 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - :h3 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - :h4 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + :h1 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, + :h2 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, + :h3 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, + :h4 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 } class Headings < ContextDev::Internal::Type::BaseModel - attr_reader h1: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1? + attr_reader h1: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1? def h1=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1 + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1 - attr_reader h2: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2? + attr_reader h2: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2? def h2=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2 + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2 - attr_reader h3: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3? + attr_reader h3: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3? def h3=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3 + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3 - attr_reader h4: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4? + attr_reader h4: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4? def h4=: ( - ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 - ) -> ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 + ) -> ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 def initialize: ( - ?h1: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - ?h2: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - ?h3: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - ?h4: ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + ?h1: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, + ?h2: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, + ?h3: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, + ?h4: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 ) -> void def to_hash: -> { - :h1 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, - :h2 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, - :h3 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, - :h4 => ContextDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 + :h1 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, + :h2 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, + :h3 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, + :h4 => ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 } type h1 = diff --git a/sig/context_dev/models/brand_prefetch_by_email_params.rbs b/sig/context_dev/models/utility_prefetch_by_email_params.rbs similarity index 84% rename from sig/context_dev/models/brand_prefetch_by_email_params.rbs rename to sig/context_dev/models/utility_prefetch_by_email_params.rbs index cabc01fa..5537be58 100644 --- a/sig/context_dev/models/brand_prefetch_by_email_params.rbs +++ b/sig/context_dev/models/utility_prefetch_by_email_params.rbs @@ -1,10 +1,10 @@ module ContextDev module Models - type brand_prefetch_by_email_params = + type utility_prefetch_by_email_params = { email: String, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchByEmailParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_prefetch_by_email_response.rbs b/sig/context_dev/models/utility_prefetch_by_email_response.rbs similarity index 80% rename from sig/context_dev/models/brand_prefetch_by_email_response.rbs rename to sig/context_dev/models/utility_prefetch_by_email_response.rbs index e0c4ddf0..7ec243fe 100644 --- a/sig/context_dev/models/brand_prefetch_by_email_response.rbs +++ b/sig/context_dev/models/utility_prefetch_by_email_response.rbs @@ -1,9 +1,9 @@ module ContextDev module Models - type brand_prefetch_by_email_response = + type utility_prefetch_by_email_response = { domain: String, message: String, status: String } - class BrandPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String diff --git a/sig/context_dev/models/brand_prefetch_params.rbs b/sig/context_dev/models/utility_prefetch_params.rbs similarity index 86% rename from sig/context_dev/models/brand_prefetch_params.rbs rename to sig/context_dev/models/utility_prefetch_params.rbs index 6a7d4f82..8e254103 100644 --- a/sig/context_dev/models/brand_prefetch_params.rbs +++ b/sig/context_dev/models/utility_prefetch_params.rbs @@ -1,10 +1,10 @@ module ContextDev module Models - type brand_prefetch_params = + type utility_prefetch_params = { domain: String, timeout_ms: Integer } & ContextDev::Internal::Type::request_parameters - class BrandPrefetchParams < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_prefetch_response.rbs b/sig/context_dev/models/utility_prefetch_response.rbs similarity index 82% rename from sig/context_dev/models/brand_prefetch_response.rbs rename to sig/context_dev/models/utility_prefetch_response.rbs index 443a2d13..fe435ec4 100644 --- a/sig/context_dev/models/brand_prefetch_response.rbs +++ b/sig/context_dev/models/utility_prefetch_response.rbs @@ -1,9 +1,9 @@ module ContextDev module Models - type brand_prefetch_response = + type utility_prefetch_response = { domain: String, message: String, status: String } - class BrandPrefetchResponse < ContextDev::Internal::Type::BaseModel + class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String diff --git a/sig/context_dev/models/web_screenshot_params.rbs b/sig/context_dev/models/web_screenshot_params.rbs new file mode 100644 index 00000000..4dbb2ed9 --- /dev/null +++ b/sig/context_dev/models/web_screenshot_params.rbs @@ -0,0 +1,100 @@ +module ContextDev + module Models + type web_screenshot_params = + { + domain: String, + full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + page: ContextDev::Models::WebScreenshotParams::page, + prioritize: ContextDev::Models::WebScreenshotParams::prioritize + } + & ContextDev::Internal::Type::request_parameters + + class WebScreenshotParams < ContextDev::Internal::Type::BaseModel + extend ContextDev::Internal::Type::RequestParameters::Converter + include ContextDev::Internal::Type::RequestParameters + + attr_accessor domain: String + + attr_reader full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot? + + def full_screenshot=: ( + ContextDev::Models::WebScreenshotParams::full_screenshot + ) -> ContextDev::Models::WebScreenshotParams::full_screenshot + + attr_reader page: ContextDev::Models::WebScreenshotParams::page? + + def page=: ( + ContextDev::Models::WebScreenshotParams::page + ) -> ContextDev::Models::WebScreenshotParams::page + + attr_reader prioritize: ContextDev::Models::WebScreenshotParams::prioritize? + + def prioritize=: ( + ContextDev::Models::WebScreenshotParams::prioritize + ) -> ContextDev::Models::WebScreenshotParams::prioritize + + def initialize: ( + domain: String, + ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + ?page: ContextDev::Models::WebScreenshotParams::page, + ?prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + ?request_options: ContextDev::request_opts + ) -> void + + def to_hash: -> { + domain: String, + full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + page: ContextDev::Models::WebScreenshotParams::page, + prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + request_options: ContextDev::RequestOptions + } + + type full_screenshot = :true | :false + + module FullScreenshot + extend ContextDev::Internal::Type::Enum + + TRUE: :true + FALSE: :false + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::full_screenshot] + end + + type page = + :login + | :signup + | :blog + | :careers + | :pricing + | :terms + | :privacy + | :contact + + module Page + extend ContextDev::Internal::Type::Enum + + LOGIN: :login + SIGNUP: :signup + BLOG: :blog + CAREERS: :careers + PRICING: :pricing + TERMS: :terms + PRIVACY: :privacy + CONTACT: :contact + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::page] + end + + type prioritize = :speed | :quality + + module Prioritize + extend ContextDev::Internal::Type::Enum + + SPEED: :speed + QUALITY: :quality + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::prioritize] + end + end + end +end diff --git a/sig/context_dev/models/brand_screenshot_response.rbs b/sig/context_dev/models/web_screenshot_response.rbs similarity index 57% rename from sig/context_dev/models/brand_screenshot_response.rbs rename to sig/context_dev/models/web_screenshot_response.rbs index e8da2510..eb698c60 100644 --- a/sig/context_dev/models/brand_screenshot_response.rbs +++ b/sig/context_dev/models/web_screenshot_response.rbs @@ -1,15 +1,15 @@ module ContextDev module Models - type brand_screenshot_response = + type web_screenshot_response = { code: Integer, domain: String, screenshot: String, - screenshot_type: ContextDev::Models::BrandScreenshotResponse::screenshot_type, + screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, status: String } - class BrandScreenshotResponse < ContextDev::Internal::Type::BaseModel + class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel attr_reader code: Integer? def code=: (Integer) -> Integer @@ -22,11 +22,11 @@ module ContextDev def screenshot=: (String) -> String - attr_reader screenshot_type: ContextDev::Models::BrandScreenshotResponse::screenshot_type? + attr_reader screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type? def screenshot_type=: ( - ContextDev::Models::BrandScreenshotResponse::screenshot_type - ) -> ContextDev::Models::BrandScreenshotResponse::screenshot_type + ContextDev::Models::WebScreenshotResponse::screenshot_type + ) -> ContextDev::Models::WebScreenshotResponse::screenshot_type attr_reader status: String? @@ -36,7 +36,7 @@ module ContextDev ?code: Integer, ?domain: String, ?screenshot: String, - ?screenshot_type: ContextDev::Models::BrandScreenshotResponse::screenshot_type, + ?screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, ?status: String ) -> void @@ -44,7 +44,7 @@ module ContextDev code: Integer, domain: String, screenshot: String, - screenshot_type: ContextDev::Models::BrandScreenshotResponse::screenshot_type, + screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, status: String } @@ -56,7 +56,7 @@ module ContextDev VIEWPORT: :viewport FULL_PAGE: :fullPage - def self?.values: -> ::Array[ContextDev::Models::BrandScreenshotResponse::screenshot_type] + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotResponse::screenshot_type] end end end diff --git a/sig/context_dev/models/brand_web_scrape_images_params.rbs b/sig/context_dev/models/web_web_scrape_html_params.rbs similarity index 80% rename from sig/context_dev/models/brand_web_scrape_images_params.rbs rename to sig/context_dev/models/web_web_scrape_html_params.rbs index cbdf65be..343dc814 100644 --- a/sig/context_dev/models/brand_web_scrape_images_params.rbs +++ b/sig/context_dev/models/web_web_scrape_html_params.rbs @@ -1,9 +1,9 @@ module ContextDev module Models - type brand_web_scrape_images_params = + type web_web_scrape_html_params = { url: String } & ContextDev::Internal::Type::request_parameters - class BrandWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/web_web_scrape_html_response.rbs b/sig/context_dev/models/web_web_scrape_html_response.rbs new file mode 100644 index 00000000..ad04dfcb --- /dev/null +++ b/sig/context_dev/models/web_web_scrape_html_response.rbs @@ -0,0 +1,40 @@ +module ContextDev + module Models + type web_web_scrape_html_response = + { + html: String, + success: ContextDev::Models::WebWebScrapeHTMLResponse::success, + url: String + } + + class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel + attr_accessor html: String + + attr_accessor success: ContextDev::Models::WebWebScrapeHTMLResponse::success + + attr_accessor url: String + + def initialize: ( + html: String, + success: ContextDev::Models::WebWebScrapeHTMLResponse::success, + url: String + ) -> void + + def to_hash: -> { + html: String, + success: ContextDev::Models::WebWebScrapeHTMLResponse::success, + url: String + } + + type success = true + + module Success + extend ContextDev::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeHTMLResponse::success] + end + end + end +end diff --git a/sig/context_dev/models/brand_web_scrape_html_params.rbs b/sig/context_dev/models/web_web_scrape_images_params.rbs similarity index 83% rename from sig/context_dev/models/brand_web_scrape_html_params.rbs rename to sig/context_dev/models/web_web_scrape_images_params.rbs index 253e887d..1c62b6f5 100644 --- a/sig/context_dev/models/brand_web_scrape_html_params.rbs +++ b/sig/context_dev/models/web_web_scrape_images_params.rbs @@ -1,9 +1,9 @@ module ContextDev module Models - type brand_web_scrape_html_params = + type web_web_scrape_images_params = { url: String } & ContextDev::Internal::Type::request_parameters - class BrandWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/web_web_scrape_images_response.rbs b/sig/context_dev/models/web_web_scrape_images_response.rbs new file mode 100644 index 00000000..cba9274a --- /dev/null +++ b/sig/context_dev/models/web_web_scrape_images_response.rbs @@ -0,0 +1,98 @@ +module ContextDev + module Models + type web_web_scrape_images_response = + { + images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], + success: ContextDev::Models::WebWebScrapeImagesResponse::success, + url: String + } + + class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel + attr_accessor images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image] + + attr_accessor success: ContextDev::Models::WebWebScrapeImagesResponse::success + + attr_accessor url: String + + def initialize: ( + images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], + success: ContextDev::Models::WebWebScrapeImagesResponse::success, + url: String + ) -> void + + def to_hash: -> { + images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], + success: ContextDev::Models::WebWebScrapeImagesResponse::success, + url: String + } + + type image = + { + alt: String?, + element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, + src: String, + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + } + + class Image < ContextDev::Internal::Type::BaseModel + attr_accessor alt: String? + + attr_accessor element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element + + attr_accessor src: String + + attr_accessor type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + + def initialize: ( + alt: String?, + element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, + src: String, + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + ) -> void + + def to_hash: -> { + alt: String?, + element: ContextDev::Models::WebWebScrapeImagesResponse::Image::element, + src: String, + type: ContextDev::Models::WebWebScrapeImagesResponse::Image::type_ + } + + type element = :img | :svg | :link | :source | :video + + module Element + extend ContextDev::Internal::Type::Enum + + IMG: :img + SVG: :svg + LINK: :link + SOURCE: :source + VIDEO: :video + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image::element] + end + + type type_ = :url | :html | :base64 + + module Type + extend ContextDev::Internal::Type::Enum + + URL: :url + HTML: :html + BASE64: :base64 + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image::type_] + end + end + + type success = true + + module Success + extend ContextDev::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::success] + end + end + end +end diff --git a/sig/context_dev/models/brand_web_scrape_md_params.rbs b/sig/context_dev/models/web_web_scrape_md_params.rbs similarity index 90% rename from sig/context_dev/models/brand_web_scrape_md_params.rbs rename to sig/context_dev/models/web_web_scrape_md_params.rbs index de70f85f..b435802a 100644 --- a/sig/context_dev/models/brand_web_scrape_md_params.rbs +++ b/sig/context_dev/models/web_web_scrape_md_params.rbs @@ -1,6 +1,6 @@ module ContextDev module Models - type brand_web_scrape_md_params = + type web_web_scrape_md_params = { url: String, include_images: bool, @@ -9,7 +9,7 @@ module ContextDev } & ContextDev::Internal::Type::request_parameters - class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/web_web_scrape_md_response.rbs b/sig/context_dev/models/web_web_scrape_md_response.rbs new file mode 100644 index 00000000..3938531d --- /dev/null +++ b/sig/context_dev/models/web_web_scrape_md_response.rbs @@ -0,0 +1,40 @@ +module ContextDev + module Models + type web_web_scrape_md_response = + { + markdown: String, + success: ContextDev::Models::WebWebScrapeMdResponse::success, + url: String + } + + class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel + attr_accessor markdown: String + + attr_accessor success: ContextDev::Models::WebWebScrapeMdResponse::success + + attr_accessor url: String + + def initialize: ( + markdown: String, + success: ContextDev::Models::WebWebScrapeMdResponse::success, + url: String + ) -> void + + def to_hash: -> { + markdown: String, + success: ContextDev::Models::WebWebScrapeMdResponse::success, + url: String + } + + type success = true + + module Success + extend ContextDev::Internal::Type::Enum + + TRUE: true + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeMdResponse::success] + end + end + end +end diff --git a/sig/context_dev/models/brand_web_scrape_sitemap_params.rbs b/sig/context_dev/models/web_web_scrape_sitemap_params.rbs similarity index 81% rename from sig/context_dev/models/brand_web_scrape_sitemap_params.rbs rename to sig/context_dev/models/web_web_scrape_sitemap_params.rbs index 42143a83..27c6dc07 100644 --- a/sig/context_dev/models/brand_web_scrape_sitemap_params.rbs +++ b/sig/context_dev/models/web_web_scrape_sitemap_params.rbs @@ -1,9 +1,9 @@ module ContextDev module Models - type brand_web_scrape_sitemap_params = + type web_web_scrape_sitemap_params = { domain: String } & ContextDev::Internal::Type::request_parameters - class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel + class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters diff --git a/sig/context_dev/models/brand_web_scrape_sitemap_response.rbs b/sig/context_dev/models/web_web_scrape_sitemap_response.rbs similarity index 61% rename from sig/context_dev/models/brand_web_scrape_sitemap_response.rbs rename to sig/context_dev/models/web_web_scrape_sitemap_response.rbs index ccb9962e..7e25dd99 100644 --- a/sig/context_dev/models/brand_web_scrape_sitemap_response.rbs +++ b/sig/context_dev/models/web_web_scrape_sitemap_response.rbs @@ -1,33 +1,33 @@ module ContextDev module Models - type brand_web_scrape_sitemap_response = + type web_web_scrape_sitemap_response = { domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, - success: ContextDev::Models::BrandWebScrapeSitemapResponse::success, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, + success: ContextDev::Models::WebWebScrapeSitemapResponse::success, urls: ::Array[String] } - class BrandWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel + class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel attr_accessor domain: String - attr_accessor meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta + attr_accessor meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta - attr_accessor success: ContextDev::Models::BrandWebScrapeSitemapResponse::success + attr_accessor success: ContextDev::Models::WebWebScrapeSitemapResponse::success attr_accessor urls: ::Array[String] def initialize: ( domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, - success: ContextDev::Models::BrandWebScrapeSitemapResponse::success, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, + success: ContextDev::Models::WebWebScrapeSitemapResponse::success, urls: ::Array[String] ) -> void def to_hash: -> { domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, - success: ContextDev::Models::BrandWebScrapeSitemapResponse::success, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, + success: ContextDev::Models::WebWebScrapeSitemapResponse::success, urls: ::Array[String] } @@ -70,7 +70,7 @@ module ContextDev TRUE: true - def self?.values: -> ::Array[ContextDev::Models::BrandWebScrapeSitemapResponse::success] + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeSitemapResponse::success] end end end diff --git a/sig/context_dev/resources/ai.rbs b/sig/context_dev/resources/ai.rbs new file mode 100644 index 00000000..51587505 --- /dev/null +++ b/sig/context_dev/resources/ai.rbs @@ -0,0 +1,26 @@ +module ContextDev + module Resources + class AI + def ai_query: ( + data_to_extract: ::Array[ContextDev::AIAIQueryParams::DataToExtract], + domain: String, + ?specific_pages: ContextDev::AIAIQueryParams::SpecificPages, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::AIAIQueryResponse + + def extract_product: ( + url: String, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::AIExtractProductResponse + + def extract_products: ( + body: ContextDev::Models::AIExtractProductsParams::body, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::AIExtractProductsResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/sig/context_dev/resources/brand.rbs b/sig/context_dev/resources/brand.rbs index fdb4cec5..f947e75b 100644 --- a/sig/context_dev/resources/brand.rbs +++ b/sig/context_dev/resources/brand.rbs @@ -9,31 +9,6 @@ module ContextDev ?request_options: ContextDev::request_opts ) -> ContextDev::Models::BrandRetrieveResponse - def ai_product: ( - url: String, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandAIProductResponse - - def ai_products: ( - body: ContextDev::Models::BrandAIProductsParams::body, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandAIProductsResponse - - def ai_query: ( - data_to_extract: ::Array[ContextDev::BrandAIQueryParams::DataToExtract], - domain: String, - ?specific_pages: ContextDev::BrandAIQueryParams::SpecificPages, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandAIQueryResponse - - def fonts: ( - domain: String, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandFontsResponse - def identify_from_transaction: ( transaction_info: String, ?city: String, @@ -47,18 +22,6 @@ module ContextDev ?request_options: ContextDev::request_opts ) -> ContextDev::Models::BrandIdentifyFromTransactionResponse - def prefetch: ( - domain: String, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandPrefetchResponse - - def prefetch_by_email: ( - email: String, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandPrefetchByEmailResponse - def retrieve_by_email: ( email: String, ?force_language: ContextDev::Models::BrandRetrieveByEmailParams::force_language, @@ -93,59 +56,12 @@ module ContextDev ?request_options: ContextDev::request_opts ) -> ContextDev::Models::BrandRetrieveByTickerResponse - def retrieve_naics: ( - input: String, - ?max_results: Integer, - ?min_results: Integer, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandRetrieveNaicsResponse - def retrieve_simplified: ( domain: String, ?timeout_ms: Integer, ?request_options: ContextDev::request_opts ) -> ContextDev::Models::BrandRetrieveSimplifiedResponse - def screenshot: ( - domain: String, - ?full_screenshot: ContextDev::Models::BrandScreenshotParams::full_screenshot, - ?page: ContextDev::Models::BrandScreenshotParams::page, - ?prioritize: ContextDev::Models::BrandScreenshotParams::prioritize, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandScreenshotResponse - - def styleguide: ( - ?direct_url: String, - ?domain: String, - ?prioritize: ContextDev::Models::BrandStyleguideParams::prioritize, - ?timeout_ms: Integer, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandStyleguideResponse - - def web_scrape_html: ( - url: String, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandWebScrapeHTMLResponse - - def web_scrape_images: ( - url: String, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandWebScrapeImagesResponse - - def web_scrape_md: ( - url: String, - ?include_images: bool, - ?include_links: bool, - ?shorten_base64_images: bool, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandWebScrapeMdResponse - - def web_scrape_sitemap: ( - domain: String, - ?request_options: ContextDev::request_opts - ) -> ContextDev::Models::BrandWebScrapeSitemapResponse - def initialize: (client: ContextDev::Client) -> void end end diff --git a/sig/context_dev/resources/industry.rbs b/sig/context_dev/resources/industry.rbs new file mode 100644 index 00000000..c0568529 --- /dev/null +++ b/sig/context_dev/resources/industry.rbs @@ -0,0 +1,15 @@ +module ContextDev + module Resources + class Industry + def retrieve_naics: ( + input: String, + ?max_results: Integer, + ?min_results: Integer, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::IndustryRetrieveNaicsResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/sig/context_dev/resources/style.rbs b/sig/context_dev/resources/style.rbs new file mode 100644 index 00000000..0bb5f6d7 --- /dev/null +++ b/sig/context_dev/resources/style.rbs @@ -0,0 +1,21 @@ +module ContextDev + module Resources + class Style + def extract_fonts: ( + domain: String, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::StyleExtractFontsResponse + + def extract_styleguide: ( + ?direct_url: String, + ?domain: String, + ?prioritize: ContextDev::Models::StyleExtractStyleguideParams::prioritize, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::StyleExtractStyleguideResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/sig/context_dev/resources/utility.rbs b/sig/context_dev/resources/utility.rbs new file mode 100644 index 00000000..316b3687 --- /dev/null +++ b/sig/context_dev/resources/utility.rbs @@ -0,0 +1,19 @@ +module ContextDev + module Resources + class Utility + def prefetch: ( + domain: String, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::UtilityPrefetchResponse + + def prefetch_by_email: ( + email: String, + ?timeout_ms: Integer, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::UtilityPrefetchByEmailResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs new file mode 100644 index 00000000..14dd5d95 --- /dev/null +++ b/sig/context_dev/resources/web.rbs @@ -0,0 +1,38 @@ +module ContextDev + module Resources + class Web + def screenshot: ( + domain: String, + ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + ?page: ContextDev::Models::WebScreenshotParams::page, + ?prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebScreenshotResponse + + def web_scrape_html: ( + url: String, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebWebScrapeHTMLResponse + + def web_scrape_images: ( + url: String, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebWebScrapeImagesResponse + + def web_scrape_md: ( + url: String, + ?include_images: bool, + ?include_links: bool, + ?shorten_base64_images: bool, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebWebScrapeMdResponse + + def web_scrape_sitemap: ( + domain: String, + ?request_options: ContextDev::request_opts + ) -> ContextDev::Models::WebWebScrapeSitemapResponse + + def initialize: (client: ContextDev::Client) -> void + end + end +end diff --git a/test/context_dev/resources/ai_test.rb b/test/context_dev/resources/ai_test.rb new file mode 100644 index 00000000..903f499a --- /dev/null +++ b/test/context_dev/resources/ai_test.rb @@ -0,0 +1,69 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::AITest < ContextDev::Test::ResourceTest + def test_ai_query_required_params + skip("Mock server tests are disabled") + + response = + @context_dev.ai.ai_query( + data_to_extract: [ + { + datapoint_description: "datapoint_description", + datapoint_example: "datapoint_example", + datapoint_name: "datapoint_name", + datapoint_type: :text + } + ], + domain: "domain" + ) + + assert_pattern do + response => ContextDev::Models::AIAIQueryResponse + end + + assert_pattern do + response => { + data_extracted: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIAIQueryResponse::DataExtracted]) | nil, + domain: String | nil, + status: String | nil, + urls_analyzed: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil + } + end + end + + def test_extract_product_required_params + skip("Mock server tests are disabled") + + response = @context_dev.ai.extract_product(url: "https://example.com") + + assert_pattern do + response => ContextDev::Models::AIExtractProductResponse + end + + assert_pattern do + response => { + is_product_page: ContextDev::Internal::Type::Boolean | nil, + platform: ContextDev::Models::AIExtractProductResponse::Platform | nil, + product: ContextDev::Models::AIExtractProductResponse::Product | nil + } + end + end + + def test_extract_products_required_params + skip("Mock server tests are disabled") + + response = @context_dev.ai.extract_products(body: {domain: "domain"}) + + assert_pattern do + response => ContextDev::Models::AIExtractProductsResponse + end + + assert_pattern do + response => { + products: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product]) | nil + } + end + end +end diff --git a/test/context_dev/resources/brand_test.rb b/test/context_dev/resources/brand_test.rb index b20bdf8d..7d164ccc 100644 --- a/test/context_dev/resources/brand_test.rb +++ b/test/context_dev/resources/brand_test.rb @@ -21,89 +21,6 @@ def test_retrieve_required_params end end - def test_ai_product_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.ai_product(url: "https://example.com") - - assert_pattern do - response => ContextDev::Models::BrandAIProductResponse - end - - assert_pattern do - response => { - is_product_page: ContextDev::Internal::Type::Boolean | nil, - platform: ContextDev::Models::BrandAIProductResponse::Platform | nil, - product: ContextDev::Models::BrandAIProductResponse::Product | nil - } - end - end - - def test_ai_products_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.ai_products(body: {domain: "domain"}) - - assert_pattern do - response => ContextDev::Models::BrandAIProductsResponse - end - - assert_pattern do - response => { - products: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandAIProductsResponse::Product]) | nil - } - end - end - - def test_ai_query_required_params - skip("Mock server tests are disabled") - - response = - @context_dev.brand.ai_query( - data_to_extract: [ - { - datapoint_description: "datapoint_description", - datapoint_example: "datapoint_example", - datapoint_name: "datapoint_name", - datapoint_type: :text - } - ], - domain: "domain" - ) - - assert_pattern do - response => ContextDev::Models::BrandAIQueryResponse - end - - assert_pattern do - response => { - data_extracted: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandAIQueryResponse::DataExtracted]) | nil, - domain: String | nil, - status: String | nil, - urls_analyzed: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil - } - end - end - - def test_fonts_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.fonts(domain: "domain") - - assert_pattern do - response => ContextDev::Models::BrandFontsResponse - end - - assert_pattern do - response => { - code: Integer, - domain: String, - fonts: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandFontsResponse::Font]), - status: String - } - end - end - def test_identify_from_transaction_required_params skip("Mock server tests are disabled") @@ -122,42 +39,6 @@ def test_identify_from_transaction_required_params end end - def test_prefetch_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.prefetch(domain: "domain") - - assert_pattern do - response => ContextDev::Models::BrandPrefetchResponse - end - - assert_pattern do - response => { - domain: String | nil, - message: String | nil, - status: String | nil - } - end - end - - def test_prefetch_by_email_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.prefetch_by_email(email: "dev@stainless.com") - - assert_pattern do - response => ContextDev::Models::BrandPrefetchByEmailResponse - end - - assert_pattern do - response => { - domain: String | nil, - message: String | nil, - status: String | nil - } - end - end - def test_retrieve_by_email_required_params skip("Mock server tests are disabled") @@ -230,25 +111,6 @@ def test_retrieve_by_ticker_required_params end end - def test_retrieve_naics_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.retrieve_naics(input: "input") - - assert_pattern do - response => ContextDev::Models::BrandRetrieveNaicsResponse - end - - assert_pattern do - response => { - codes: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandRetrieveNaicsResponse::Code]) | nil, - domain: String | nil, - status: String | nil, - type: String | nil - } - end - end - def test_retrieve_simplified_required_params skip("Mock server tests are disabled") @@ -266,116 +128,4 @@ def test_retrieve_simplified_required_params } end end - - def test_screenshot_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.screenshot(domain: "domain") - - assert_pattern do - response => ContextDev::Models::BrandScreenshotResponse - end - - assert_pattern do - response => { - code: Integer | nil, - domain: String | nil, - screenshot: String | nil, - screenshot_type: ContextDev::Models::BrandScreenshotResponse::ScreenshotType | nil, - status: String | nil - } - end - end - - def test_styleguide - skip("Mock server tests are disabled") - - response = @context_dev.brand.styleguide - - assert_pattern do - response => ContextDev::Models::BrandStyleguideResponse - end - - assert_pattern do - response => { - code: Integer | nil, - domain: String | nil, - status: String | nil, - styleguide: ContextDev::Models::BrandStyleguideResponse::Styleguide | nil - } - end - end - - def test_web_scrape_html_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.web_scrape_html(url: "https://example.com") - - assert_pattern do - response => ContextDev::Models::BrandWebScrapeHTMLResponse - end - - assert_pattern do - response => { - html: String, - success: ContextDev::Models::BrandWebScrapeHTMLResponse::Success, - url: String - } - end - end - - def test_web_scrape_images_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.web_scrape_images(url: "https://example.com") - - assert_pattern do - response => ContextDev::Models::BrandWebScrapeImagesResponse - end - - assert_pattern do - response => { - images: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandWebScrapeImagesResponse::Image]), - success: ContextDev::Models::BrandWebScrapeImagesResponse::Success, - url: String - } - end - end - - def test_web_scrape_md_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.web_scrape_md(url: "https://example.com") - - assert_pattern do - response => ContextDev::Models::BrandWebScrapeMdResponse - end - - assert_pattern do - response => { - markdown: String, - success: ContextDev::Models::BrandWebScrapeMdResponse::Success, - url: String - } - end - end - - def test_web_scrape_sitemap_required_params - skip("Mock server tests are disabled") - - response = @context_dev.brand.web_scrape_sitemap(domain: "domain") - - assert_pattern do - response => ContextDev::Models::BrandWebScrapeSitemapResponse - end - - assert_pattern do - response => { - domain: String, - meta: ContextDev::Models::BrandWebScrapeSitemapResponse::Meta, - success: ContextDev::Models::BrandWebScrapeSitemapResponse::Success, - urls: ^(ContextDev::Internal::Type::ArrayOf[String]) - } - end - end end diff --git a/test/context_dev/resources/industry_test.rb b/test/context_dev/resources/industry_test.rb new file mode 100644 index 00000000..78099a13 --- /dev/null +++ b/test/context_dev/resources/industry_test.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::IndustryTest < ContextDev::Test::ResourceTest + def test_retrieve_naics_required_params + skip("Mock server tests are disabled") + + response = @context_dev.industry.retrieve_naics(input: "input") + + assert_pattern do + response => ContextDev::Models::IndustryRetrieveNaicsResponse + end + + assert_pattern do + response => { + codes: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::IndustryRetrieveNaicsResponse::Code]) | nil, + domain: String | nil, + status: String | nil, + type: String | nil + } + end + end +end diff --git a/test/context_dev/resources/style_test.rb b/test/context_dev/resources/style_test.rb new file mode 100644 index 00000000..3300c4b4 --- /dev/null +++ b/test/context_dev/resources/style_test.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::StyleTest < ContextDev::Test::ResourceTest + def test_extract_fonts_required_params + skip("Mock server tests are disabled") + + response = @context_dev.style.extract_fonts(domain: "domain") + + assert_pattern do + response => ContextDev::Models::StyleExtractFontsResponse + end + + assert_pattern do + response => { + code: Integer, + domain: String, + fonts: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::StyleExtractFontsResponse::Font]), + status: String + } + end + end + + def test_extract_styleguide + skip("Mock server tests are disabled") + + response = @context_dev.style.extract_styleguide + + assert_pattern do + response => ContextDev::Models::StyleExtractStyleguideResponse + end + + assert_pattern do + response => { + code: Integer | nil, + domain: String | nil, + status: String | nil, + styleguide: ContextDev::Models::StyleExtractStyleguideResponse::Styleguide | nil + } + end + end +end diff --git a/test/context_dev/resources/utility_test.rb b/test/context_dev/resources/utility_test.rb new file mode 100644 index 00000000..105ff620 --- /dev/null +++ b/test/context_dev/resources/utility_test.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::UtilityTest < ContextDev::Test::ResourceTest + def test_prefetch_required_params + skip("Mock server tests are disabled") + + response = @context_dev.utility.prefetch(domain: "domain") + + assert_pattern do + response => ContextDev::Models::UtilityPrefetchResponse + end + + assert_pattern do + response => { + domain: String | nil, + message: String | nil, + status: String | nil + } + end + end + + def test_prefetch_by_email_required_params + skip("Mock server tests are disabled") + + response = @context_dev.utility.prefetch_by_email(email: "dev@stainless.com") + + assert_pattern do + response => ContextDev::Models::UtilityPrefetchByEmailResponse + end + + assert_pattern do + response => { + domain: String | nil, + message: String | nil, + status: String | nil + } + end + end +end diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb new file mode 100644 index 00000000..81a1103d --- /dev/null +++ b/test/context_dev/resources/web_test.rb @@ -0,0 +1,98 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class ContextDev::Test::Resources::WebTest < ContextDev::Test::ResourceTest + def test_screenshot_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.screenshot(domain: "domain") + + assert_pattern do + response => ContextDev::Models::WebScreenshotResponse + end + + assert_pattern do + response => { + code: Integer | nil, + domain: String | nil, + screenshot: String | nil, + screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType | nil, + status: String | nil + } + end + end + + def test_web_scrape_html_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.web_scrape_html(url: "https://example.com") + + assert_pattern do + response => ContextDev::Models::WebWebScrapeHTMLResponse + end + + assert_pattern do + response => { + html: String, + success: ContextDev::Models::WebWebScrapeHTMLResponse::Success, + url: String + } + end + end + + def test_web_scrape_images_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.web_scrape_images(url: "https://example.com") + + assert_pattern do + response => ContextDev::Models::WebWebScrapeImagesResponse + end + + assert_pattern do + response => { + images: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image]), + success: ContextDev::Models::WebWebScrapeImagesResponse::Success, + url: String + } + end + end + + def test_web_scrape_md_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.web_scrape_md(url: "https://example.com") + + assert_pattern do + response => ContextDev::Models::WebWebScrapeMdResponse + end + + assert_pattern do + response => { + markdown: String, + success: ContextDev::Models::WebWebScrapeMdResponse::Success, + url: String + } + end + end + + def test_web_scrape_sitemap_required_params + skip("Mock server tests are disabled") + + response = @context_dev.web.web_scrape_sitemap(domain: "domain") + + assert_pattern do + response => ContextDev::Models::WebWebScrapeSitemapResponse + end + + assert_pattern do + response => { + domain: String, + meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, + success: ContextDev::Models::WebWebScrapeSitemapResponse::Success, + urls: ^(ContextDev::Internal::Type::ArrayOf[String]) + } + end + end +end