diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 7ccfe12c..bc845f32 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.15.0" + ".": "1.16.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 7ac6ab77..7f12b687 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 22 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-44904c513baa439f294b23964ea368ad52863e13328980f9cac5a8e78cbb58cb.yml -openapi_spec_hash: 9bb50ca838166fb474d28009a7edbd49 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d880c25aee159e1260e23dfa3685b1bb9e35b02a1927adecbff32664ba8e11a4.yml +openapi_spec_hash: aa96a6030390bca0b4cdfa2363961807 config_hash: 70354330f92ce169beabc98696ebb9a3 diff --git a/CHANGELOG.md b/CHANGELOG.md index 60f942ae..75f2ccbe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 1.16.0 (2026-05-07) + +Full Changelog: [v1.15.0...v1.16.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.15.0...v1.16.0) + +### Features + +* **api:** api update ([f0b1f3a](https://github.com/context-dot-dev/context-ruby-sdk/commit/f0b1f3afd885c44cb464393b57d944fa27a6c0b5)) + ## 1.15.0 (2026-05-06) Full Changelog: [v1.14.0...v1.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.14.0...v1.15.0) diff --git a/Gemfile.lock b/Gemfile.lock index 5a52844f..8a267339 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (1.15.0) + context.dev (1.16.0) cgi connection_pool diff --git a/README.md b/README.md index 4a4709d9..41bd0a02 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 1.15.0" +gem "context.dev", "~> 1.16.0" ``` diff --git a/lib/context_dev/models/web_screenshot_params.rb b/lib/context_dev/models/web_screenshot_params.rb index ba31f61c..661953af 100644 --- a/lib/context_dev/models/web_screenshot_params.rb +++ b/lib/context_dev/models/web_screenshot_params.rb @@ -31,6 +31,14 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # @return [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot, nil] optional :full_screenshot, enum: -> { ContextDev::WebScreenshotParams::FullScreenshot } + # @!attribute max_age_ms + # Return a cached screenshot if a prior screenshot for the same parameters exists + # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh. + # + # @return [Integer, nil] + optional :max_age_ms, Integer + # @!attribute page # 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 @@ -49,7 +57,13 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # @return [Symbol, ContextDev::Models::WebScreenshotParams::Prioritize, nil] optional :prioritize, enum: -> { ContextDev::WebScreenshotParams::Prioritize } - # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # @!attribute viewport + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + # + # @return [ContextDev::Models::WebScreenshotParams::Viewport, nil] + optional :viewport, -> { ContextDev::WebScreenshotParams::Viewport } + + # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, max_age_ms: nil, page: nil, prioritize: nil, viewport: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebScreenshotParams} for more details. # @@ -59,10 +73,14 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # # @param full_screenshot [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc # + # @param max_age_ms [Integer] Return a cached screenshot if a prior screenshot for the same parameters exists + # # @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 viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] # Optional parameter to determine screenshot type. If 'true', takes a full page @@ -111,6 +129,27 @@ module Prioritize # @!method self.values # @return [Array] end + + class Viewport < ContextDev::Internal::Type::BaseModel + # @!attribute height + # Viewport height in pixels. + # + # @return [Integer, nil] + optional :height, Integer + + # @!attribute width + # Viewport width in pixels. + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(height: nil, width: nil) + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + # + # @param height [Integer] Viewport height in pixels. + # + # @param width [Integer] Viewport width in pixels. + end end end end diff --git a/lib/context_dev/models/web_screenshot_response.rb b/lib/context_dev/models/web_screenshot_response.rb index 270820dd..d4f32197 100644 --- a/lib/context_dev/models/web_screenshot_response.rb +++ b/lib/context_dev/models/web_screenshot_response.rb @@ -16,6 +16,12 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute height + # Height in pixels of the returned screenshot image + # + # @return [Integer, nil] + optional :height, Integer + # @!attribute screenshot # Public URL of the uploaded screenshot image # @@ -36,16 +42,26 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :status, String - # @!method initialize(code: nil, domain: nil, screenshot: nil, screenshot_type: nil, status: nil) + # @!attribute width + # Width in pixels of the returned screenshot image + # + # @return [Integer, nil] + optional :width, Integer + + # @!method initialize(code: nil, domain: nil, height: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil) # @param code [Integer] HTTP status code # # @param domain [String] The normalized domain that was processed # + # @param height [Integer] Height in pixels of the returned screenshot image + # # @param screenshot [String] Public URL of the uploaded screenshot image # # @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured # # @param status [String] Status of the response, e.g., 'ok' + # + # @param width [Integer] Width in pixels of the returned screenshot image # Type of screenshot that was captured # diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 456810bd..b3367348 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -70,7 +70,7 @@ def extract_styleguide(params = {}) # # Capture a screenshot of a website. # - # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, page: nil, prioritize: nil, request_options: {}) + # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, max_age_ms: nil, page: nil, prioritize: nil, viewport: nil, request_options: {}) # # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https # @@ -78,10 +78,14 @@ def extract_styleguide(params = {}) # # @param full_screenshot [Symbol, ContextDev::Models::WebScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc # + # @param max_age_ms [Integer] Return a cached screenshot if a prior screenshot for the same parameters exists + # # @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 viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [ContextDev::Models::WebScreenshotResponse] @@ -93,7 +97,11 @@ def screenshot(params = {}) @client.request( method: :get, path: "web/screenshot", - query: query.transform_keys(direct_url: "directUrl", full_screenshot: "fullScreenshot"), + query: query.transform_keys( + direct_url: "directUrl", + full_screenshot: "fullScreenshot", + max_age_ms: "maxAgeMs" + ), model: ContextDev::Models::WebScreenshotResponse, options: options ) diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 325131a0..dd992a65 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "1.15.0" + VERSION = "1.16.0" end diff --git a/rbi/context_dev/models/web_screenshot_params.rbi b/rbi/context_dev/models/web_screenshot_params.rbi index c0098221..eb65d5d3 100644 --- a/rbi/context_dev/models/web_screenshot_params.rbi +++ b/rbi/context_dev/models/web_screenshot_params.rbi @@ -47,6 +47,15 @@ module ContextDev end attr_writer :full_screenshot + # Return a cached screenshot if a prior screenshot for the same parameters exists + # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh. + sig { returns(T.nilable(Integer)) } + attr_reader :max_age_ms + + sig { params(max_age_ms: Integer).void } + attr_writer :max_age_ms + # 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 @@ -77,14 +86,25 @@ module ContextDev end attr_writer :prioritize + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + sig { returns(T.nilable(ContextDev::WebScreenshotParams::Viewport)) } + attr_reader :viewport + + sig do + params(viewport: ContextDev::WebScreenshotParams::Viewport::OrHash).void + end + attr_writer :viewport + sig do params( direct_url: String, domain: String, full_screenshot: ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + max_age_ms: Integer, page: ContextDev::WebScreenshotParams::Page::OrSymbol, prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, + viewport: ContextDev::WebScreenshotParams::Viewport::OrHash, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) end @@ -101,6 +121,10 @@ module ContextDev # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). full_screenshot: nil, + # Return a cached screenshot if a prior screenshot for the same parameters exists + # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh. + max_age_ms: 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 @@ -111,6 +135,8 @@ module ContextDev # faster capture with basic quality. If 'quality', optimizes for higher quality # with longer wait times. Defaults to 'quality' if not provided. prioritize: nil, + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + viewport: nil, request_options: {} ) end @@ -122,8 +148,10 @@ module ContextDev domain: String, full_screenshot: ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + max_age_ms: Integer, page: ContextDev::WebScreenshotParams::Page::OrSymbol, prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, + viewport: ContextDev::WebScreenshotParams::Viewport, request_options: ContextDev::RequestOptions } ) @@ -233,6 +261,46 @@ module ContextDev def self.values end end + + class Viewport < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::WebScreenshotParams::Viewport, + ContextDev::Internal::AnyHash + ) + end + + # Viewport height in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + + # Viewport width in pixels. + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + sig do + params(height: Integer, width: Integer).returns(T.attached_class) + end + def self.new( + # Viewport height in pixels. + height: nil, + # Viewport width in pixels. + width: nil + ) + end + + sig { override.returns({ height: Integer, width: Integer }) } + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_screenshot_response.rbi b/rbi/context_dev/models/web_screenshot_response.rbi index 96777ae1..fb7dd0d5 100644 --- a/rbi/context_dev/models/web_screenshot_response.rbi +++ b/rbi/context_dev/models/web_screenshot_response.rbi @@ -25,6 +25,13 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Height in pixels of the returned screenshot image + sig { returns(T.nilable(Integer)) } + attr_reader :height + + sig { params(height: Integer).void } + attr_writer :height + # Public URL of the uploaded screenshot image sig { returns(T.nilable(String)) } attr_reader :screenshot @@ -57,14 +64,23 @@ module ContextDev sig { params(status: String).void } attr_writer :status + # Width in pixels of the returned screenshot image + sig { returns(T.nilable(Integer)) } + attr_reader :width + + sig { params(width: Integer).void } + attr_writer :width + sig do params( code: Integer, domain: String, + height: Integer, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol, - status: String + status: String, + width: Integer ).returns(T.attached_class) end def self.new( @@ -72,12 +88,16 @@ module ContextDev code: nil, # The normalized domain that was processed domain: nil, + # Height in pixels of the returned screenshot image + height: nil, # Public URL of the uploaded screenshot image screenshot: nil, # Type of screenshot that was captured screenshot_type: nil, # Status of the response, e.g., 'ok' - status: nil + status: nil, + # Width in pixels of the returned screenshot image + width: nil ) end @@ -86,10 +106,12 @@ module ContextDev { code: Integer, domain: String, + height: Integer, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol, - status: String + status: String, + width: Integer } ) end diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index d9703072..0e6cd5e2 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -65,8 +65,10 @@ module ContextDev domain: String, full_screenshot: ContextDev::WebScreenshotParams::FullScreenshot::OrSymbol, + max_age_ms: Integer, page: ContextDev::WebScreenshotParams::Page::OrSymbol, prioritize: ContextDev::WebScreenshotParams::Prioritize::OrSymbol, + viewport: ContextDev::WebScreenshotParams::Viewport::OrHash, request_options: ContextDev::RequestOptions::OrHash ).returns(ContextDev::Models::WebScreenshotResponse) end @@ -83,6 +85,10 @@ module ContextDev # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). full_screenshot: nil, + # Return a cached screenshot if a prior screenshot for the same parameters exists + # and is younger than this many milliseconds. Defaults to 1 day (86400000 ms) when + # omitted. Max is 30 days (2592000000 ms). Set to 0 to always capture fresh. + max_age_ms: 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 @@ -93,6 +99,8 @@ module ContextDev # faster capture with basic quality. If 'quality', optimizes for higher quality # with longer wait times. Defaults to 'quality' if not provided. prioritize: nil, + # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080. + viewport: nil, request_options: {} ) end diff --git a/sig/context_dev/models/web_screenshot_params.rbs b/sig/context_dev/models/web_screenshot_params.rbs index dd9f81ea..1f9de9a0 100644 --- a/sig/context_dev/models/web_screenshot_params.rbs +++ b/sig/context_dev/models/web_screenshot_params.rbs @@ -5,8 +5,10 @@ module ContextDev direct_url: String, domain: String, full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + max_age_ms: Integer, page: ContextDev::Models::WebScreenshotParams::page, - prioritize: ContextDev::Models::WebScreenshotParams::prioritize + prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + viewport: ContextDev::WebScreenshotParams::Viewport } & ContextDev::Internal::Type::request_parameters @@ -28,6 +30,10 @@ module ContextDev ContextDev::Models::WebScreenshotParams::full_screenshot ) -> ContextDev::Models::WebScreenshotParams::full_screenshot + attr_reader max_age_ms: Integer? + + def max_age_ms=: (Integer) -> Integer + attr_reader page: ContextDev::Models::WebScreenshotParams::page? def page=: ( @@ -40,12 +46,20 @@ module ContextDev ContextDev::Models::WebScreenshotParams::prioritize ) -> ContextDev::Models::WebScreenshotParams::prioritize + attr_reader viewport: ContextDev::WebScreenshotParams::Viewport? + + def viewport=: ( + ContextDev::WebScreenshotParams::Viewport + ) -> ContextDev::WebScreenshotParams::Viewport + def initialize: ( ?direct_url: String, ?domain: String, ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + ?max_age_ms: Integer, ?page: ContextDev::Models::WebScreenshotParams::page, ?prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + ?viewport: ContextDev::WebScreenshotParams::Viewport, ?request_options: ContextDev::request_opts ) -> void @@ -53,8 +67,10 @@ module ContextDev direct_url: String, domain: String, full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + max_age_ms: Integer, page: ContextDev::Models::WebScreenshotParams::page, prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + viewport: ContextDev::WebScreenshotParams::Viewport, request_options: ContextDev::RequestOptions } @@ -104,6 +120,22 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::prioritize] end + + type viewport = { height: Integer, width: Integer } + + class Viewport < ContextDev::Internal::Type::BaseModel + attr_reader height: Integer? + + def height=: (Integer) -> Integer + + attr_reader width: Integer? + + def width=: (Integer) -> Integer + + def initialize: (?height: Integer, ?width: Integer) -> void + + def to_hash: -> { height: Integer, width: Integer } + end end end end diff --git a/sig/context_dev/models/web_screenshot_response.rbs b/sig/context_dev/models/web_screenshot_response.rbs index eb698c60..754db149 100644 --- a/sig/context_dev/models/web_screenshot_response.rbs +++ b/sig/context_dev/models/web_screenshot_response.rbs @@ -4,9 +4,11 @@ module ContextDev { code: Integer, domain: String, + height: Integer, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, - status: String + status: String, + width: Integer } class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel @@ -18,6 +20,10 @@ module ContextDev def domain=: (String) -> String + attr_reader height: Integer? + + def height=: (Integer) -> Integer + attr_reader screenshot: String? def screenshot=: (String) -> String @@ -32,20 +38,28 @@ module ContextDev def status=: (String) -> String + attr_reader width: Integer? + + def width=: (Integer) -> Integer + def initialize: ( ?code: Integer, ?domain: String, + ?height: Integer, ?screenshot: String, ?screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, - ?status: String + ?status: String, + ?width: Integer ) -> void def to_hash: -> { code: Integer, domain: String, + height: Integer, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, - status: String + status: String, + width: Integer } type screenshot_type = :viewport | :fullPage diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index e4660a5e..42eea19d 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -19,8 +19,10 @@ module ContextDev ?direct_url: String, ?domain: String, ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, + ?max_age_ms: Integer, ?page: ContextDev::Models::WebScreenshotParams::page, ?prioritize: ContextDev::Models::WebScreenshotParams::prioritize, + ?viewport: ContextDev::WebScreenshotParams::Viewport, ?request_options: ContextDev::request_opts ) -> ContextDev::Models::WebScreenshotResponse diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb index ca30d945..081c4d6c 100644 --- a/test/context_dev/resources/web_test.rb +++ b/test/context_dev/resources/web_test.rb @@ -55,9 +55,11 @@ def test_screenshot response => { code: Integer | nil, domain: String | nil, + height: Integer | nil, screenshot: String | nil, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType | nil, - status: String | nil + status: String | nil, + width: Integer | nil } end end