context.dev 2.18.0 → 2.20.0

data/lib/context_dev/models/web_web_scrape_screenshot_params.rb

@@ -1,471 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Web#web_scrape_screenshot
-    class WebWebScrapeScreenshotParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute url
-      #
-      #   @return [String]
-      required :url, String
-
-      # @!attribute clear_popups
-      #   Optional parameter for comprehensive popup cleanup. If 'true', the browser
-      #   dismisses detected cookie/consent UI and clears other detected obstructive
-      #   popups and overlays before capture. If 'false' or not provided, this parameter
-      #   requests no cleanup; handleCookiePopup can still request cookie/consent handling
-      #   independently.
-      #
-      #   @return [Boolean, nil]
-      optional :clear_popups, ContextDev::Internal::Type::Boolean
-
-      # @!attribute color_scheme
-      #   Optional parameter to choose the site's visual theme in the screenshot. Use
-      #   'light' or 'dark' when the site offers both appearances.
-      #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::ColorScheme, nil]
-      optional :color_scheme, enum: -> { ContextDev::WebWebScrapeScreenshotParams::ColorScheme }
-
-      # @!attribute country
-      #   Fetch the target page through a residential proxy in this country (ISO 3166-1
-      #   alpha-2).
-      #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::Country, nil]
-      optional :country, enum: -> { ContextDev::WebWebScrapeScreenshotParams::Country }
-
-      # @!attribute full_screenshot
-      #   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).
-      #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::FullScreenshot, nil]
-      optional :full_screenshot, enum: -> { ContextDev::WebWebScrapeScreenshotParams::FullScreenshot }
-
-      # @!attribute handle_cookie_popup
-      #   Optional parameter to control cookie/consent popup handling. If 'true', we
-      #   dismiss cookie banner before capture. If 'false' or not provided, captures the
-      #   page without that step.
-      #
-      #   @return [Boolean, nil]
-      optional :handle_cookie_popup, ContextDev::Internal::Type::Boolean
-
-      # @!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, nil?: true
-
-      # @!attribute scroll_offset
-      #   Optional vertical scroll offset in pixels for capturing a long page in
-      #   viewport-sized chunks. When provided, the full page is captured once and the
-      #   returned image is the viewport-sized slice that begins at this Y offset (e.g.
-      #   request scrollOffset=0, then 1080, then 2160 to walk a 1920x1080 landing page
-      #   top to bottom). The final slice may be shorter than the viewport height. Takes
-      #   precedence over fullScreenshot. Max: 100000.
-      #
-      #   @return [Integer, nil]
-      optional :scroll_offset, Integer, nil?: true
-
-      # @!attribute tags
-      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-      #   characters.
-      #
-      #   @return [Array<String>, nil]
-      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
-
-      # @!attribute timeout_opts
-      #   Optional request deadline and behavior on timeout. For GET requests, use
-      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      #   timeoutOpts object.
-      #
-      #   @return [ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts, nil]
-      optional :timeout_opts, -> { ContextDev::WebWebScrapeScreenshotParams::TimeoutOpts }
-
-      # @!attribute viewport
-      #   Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
-      #
-      #   @return [ContextDev::Models::WebWebScrapeScreenshotParams::Viewport, nil]
-      optional :viewport, -> { ContextDev::WebWebScrapeScreenshotParams::Viewport }
-
-      # @!attribute wait_for_ms
-      #   Optional browser wait time in milliseconds after initial page load before taking
-      #   the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
-      #   omitted. When combined with timeoutOpts, timeoutOpts.milliseconds must be at
-      #   least waitForMs + 10000 ms; a shorter deadline is rejected with 400
-      #   TIMEOUT_TOO_SHORT_FOR_WAIT.
-      #
-      #   @return [Integer, nil]
-      optional :wait_for_ms, Integer, nil?: true
-
-      # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. Requires zero data retention to be enabled for your organization
-      #   (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      #   Successful ZDR responses include X-Context-ZDR: true.
-      #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::Zdr, nil]
-      optional :zdr, enum: -> { ContextDev::WebWebScrapeScreenshotParams::Zdr }
-
-      # @!method initialize(url:, clear_popups: nil, color_scheme: nil, country: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebWebScrapeScreenshotParams} for more details.
-      #
-      #   @param url [String]
-      #
-      #   @param clear_popups [Boolean] Optional parameter for comprehensive popup cleanup. If 'true', the browser dismi
-      #
-      #   @param color_scheme [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
-      #
-      #   @param country [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
-      #
-      #   @param full_screenshot [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
-      #
-      #   @param handle_cookie_popup [Boolean] Optional parameter to control cookie/consent popup handling. If 'true', we dismi
-      #
-      #   @param max_age_ms [Integer, nil] Return a cached screenshot if a prior screenshot for the same parameters exists
-      #
-      #   @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
-      #
-      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
-      #
-      #   @param timeout_opts [ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
-      #
-      #   @param viewport [ContextDev::Models::WebWebScrapeScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
-      #
-      #   @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before taking
-      #
-      #   @param zdr [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
-      #
-      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
-
-      # Optional parameter to choose the site's visual theme in the screenshot. Use
-      # 'light' or 'dark' when the site offers both appearances.
-      module ColorScheme
-        extend ContextDev::Internal::Type::Enum
-
-        LIGHT = :light
-        DARK = :dark
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Fetch the target page through a residential proxy in this country (ISO 3166-1
-      # alpha-2).
-      module Country
-        extend ContextDev::Internal::Type::Enum
-
-        AD = :ad
-        AE = :ae
-        AF = :af
-        AG = :ag
-        AI = :ai
-        AL = :al
-        AM = :am
-        AO = :ao
-        AR = :ar
-        AT = :at
-        AU = :au
-        AW = :aw
-        AZ = :az
-        BA = :ba
-        BB = :bb
-        BD = :bd
-        BE = :be
-        BF = :bf
-        BG = :bg
-        BH = :bh
-        BI = :bi
-        BJ = :bj
-        BM = :bm
-        BN = :bn
-        BO = :bo
-        BQ = :bq
-        BR = :br
-        BS = :bs
-        BW = :bw
-        BY = :by
-        BZ = :bz
-        CA = :ca
-        CD = :cd
-        CF = :cf
-        CG = :cg
-        CH = :ch
-        CI = :ci
-        CL = :cl
-        CM = :cm
-        CN = :cn
-        CO = :co
-        CR = :cr
-        CV = :cv
-        CW = :cw
-        CY = :cy
-        CZ = :cz
-        DE = :de
-        DJ = :dj
-        DK = :dk
-        DM = :dm
-        DO = :do
-        DZ = :dz
-        EC = :ec
-        EE = :ee
-        EG = :eg
-        ES = :es
-        ET = :et
-        FI = :fi
-        FJ = :fj
-        FR = :fr
-        GA = :ga
-        GB = :gb
-        GD = :gd
-        GE = :ge
-        GF = :gf
-        GG = :gg
-        GH = :gh
-        GM = :gm
-        GN = :gn
-        GP = :gp
-        GQ = :gq
-        GR = :gr
-        GT = :gt
-        GU = :gu
-        GW = :gw
-        GY = :gy
-        HK = :hk
-        HN = :hn
-        HR = :hr
-        HT = :ht
-        HU = :hu
-        ID = :id
-        IE = :ie
-        IL = :il
-        IM = :im
-        IN = :in
-        IQ = :iq
-        IR = :ir
-        IS = :is
-        IT = :it
-        JE = :je
-        JM = :jm
-        JO = :jo
-        JP = :jp
-        KE = :ke
-        KG = :kg
-        KH = :kh
-        KN = :kn
-        KR = :kr
-        KW = :kw
-        KY = :ky
-        KZ = :kz
-        LA = :la
-        LB = :lb
-        LC = :lc
-        LK = :lk
-        LR = :lr
-        LS = :ls
-        LT = :lt
-        LU = :lu
-        LV = :lv
-        LY = :ly
-        MA = :ma
-        MC = :mc
-        MD = :md
-        ME = :me
-        MF = :mf
-        MG = :mg
-        MK = :mk
-        ML = :ml
-        MM = :mm
-        MN = :mn
-        MO = :mo
-        MQ = :mq
-        MR = :mr
-        MT = :mt
-        MU = :mu
-        MV = :mv
-        MW = :mw
-        MX = :mx
-        MY = :my
-        MZ = :mz
-        NA = :na
-        NC = :nc
-        NE = :ne
-        NG = :ng
-        NI = :ni
-        NL = :nl
-        NO = :no
-        NP = :np
-        NZ = :nz
-        OM = :om
-        PA = :pa
-        PE = :pe
-        PF = :pf
-        PG = :pg
-        PH = :ph
-        PK = :pk
-        PL = :pl
-        PR = :pr
-        PS = :ps
-        PT = :pt
-        PY = :py
-        QA = :qa
-        RE = :re
-        RO = :ro
-        RS = :rs
-        RU = :ru
-        RW = :rw
-        SA = :sa
-        SC = :sc
-        SD = :sd
-        SE = :se
-        SG = :sg
-        SI = :si
-        SK = :sk
-        SL = :sl
-        SM = :sm
-        SN = :sn
-        SO = :so
-        SR = :sr
-        SS = :ss
-        ST = :st
-        SV = :sv
-        SX = :sx
-        SY = :sy
-        SZ = :sz
-        TC = :tc
-        TD = :td
-        TG = :tg
-        TH = :th
-        TJ = :tj
-        TL = :tl
-        TM = :tm
-        TN = :tn
-        TR = :tr
-        TT = :tt
-        TW = :tw
-        TZ = :tz
-        UA = :ua
-        UG = :ug
-        US = :us
-        UY = :uy
-        UZ = :uz
-        VC = :vc
-        VE = :ve
-        VG = :vg
-        VI = :vi
-        VN = :vn
-        YE = :ye
-        YT = :yt
-        ZA = :za
-        ZM = :zm
-        ZW = :zw
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # 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).
-      module FullScreenshot
-        extend ContextDev::Internal::Type::Enum
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
-        # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-        #
-        #   @return [Integer]
-        required :milliseconds, Integer
-
-        # @!attribute behavior
-        #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        #   credits. "return-partial" returns usable results collected so far; if none are
-        #   available, the request still fails without charging credits. Partial results are
-        #   not cached as complete results. "return-partial" requires milliseconds of at
-        #   least 5000.
-        #
-        #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts::Behavior, nil]
-        optional :behavior, enum: -> { ContextDev::WebWebScrapeScreenshotParams::TimeoutOpts::Behavior }
-
-        # @!method initialize(milliseconds:, behavior: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts} for more
-        #   details.
-        #
-        #   Optional request deadline and behavior on timeout. For GET requests, use
-        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        #   timeoutOpts object.
-        #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
-        #
-        #   @param behavior [Symbol, ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results. "return-partial" requires milliseconds of at
-        # least 5000.
-        #
-        # @see ContextDev::Models::WebWebScrapeScreenshotParams::TimeoutOpts#behavior
-        module Behavior
-          extend ContextDev::Internal::Type::Enum
-
-          FAIL = :fail
-          RETURN_PARTIAL = :"return-partial"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      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
-
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
-      module Zdr
-        extend ContextDev::Internal::Type::Enum
-
-        ENABLED = :enabled
-        DISABLED = :disabled
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/context_dev/models/web_web_scrape_screenshot_response.rb

@@ -1,169 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Web#web_scrape_screenshot
-    class WebWebScrapeScreenshotResponse < ContextDev::Internal::Type::BaseModel
-      # @!attribute cache_metadata
-      #   Cache outcome for this response. Composite responses are hits only when every
-      #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-      #   oldest contributing hit.
-      #
-      #   @return [ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata]
-      required :cache_metadata, -> { ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata }
-
-      # @!attribute height
-      #   Height of the returned image in pixels.
-      #
-      #   @return [Integer]
-      required :height, Integer
-
-      # @!attribute request_id
-      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #   it when contacting support about a failed request.
-      #
-      #   @return [String]
-      required :request_id, String
-
-      # @!attribute screenshot
-      #   Public image URL for standard requests, or an in-memory data URL when ZDR is
-      #   enabled.
-      #
-      #   @return [String]
-      required :screenshot, String
-
-      # @!attribute url
-      #   The requested page URL.
-      #
-      #   @return [String]
-      required :url, String
-
-      # @!attribute width
-      #   Width of the returned image in pixels.
-      #
-      #   @return [Integer]
-      required :width, Integer
-
-      # @!attribute final_dom_state
-      #   How complete the returned content is. `loaded` means the page finished the waits
-      #   the request asked for. `still-loading` only occurs with
-      #   timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      #   reached first, so the content reflects the DOM at that moment and late-rendering
-      #   parts may be missing. Partial results are billed at the base request cost.
-      #
-      #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState, nil]
-      optional :final_dom_state,
-               enum: -> { ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState },
-               api_name: :finalDOMState
-
-      # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
-      #
-      #   @return [ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata }
-
-      # @!method initialize(cache_metadata:, height:, request_id:, screenshot:, url:, width:, final_dom_state: nil, key_metadata: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebWebScrapeScreenshotResponse} for more details.
-      #
-      #   @param cache_metadata [ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
-      #
-      #   @param height [Integer] Height of the returned image in pixels.
-      #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #
-      #   @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR is ena
-      #
-      #   @param url [String] The requested page URL.
-      #
-      #   @param width [Integer] Width of the returned image in pixels.
-      #
-      #   @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeScreenshotResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
-      #
-      #   @param key_metadata [ContextDev::Models::WebWebScrapeScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-
-      # @see ContextDev::Models::WebWebScrapeScreenshotResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata} for more
-        #   details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::WebWebScrapeScreenshotResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # How complete the returned content is. `loaded` means the page finished the waits
-      # the request asked for. `still-loading` only occurs with
-      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
-      # reached first, so the content reflects the DOM at that moment and late-rendering
-      # parts may be missing. Partial results are billed at the base request cost.
-      #
-      # @see ContextDev::Models::WebWebScrapeScreenshotResponse#final_dom_state
-      module FinalDomState
-        extend ContextDev::Internal::Type::Enum
-
-        LOADED = :loaded
-        STILL_LOADING = :"still-loading"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see ContextDev::Models::WebWebScrapeScreenshotResponse#key_metadata
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute credits_consumed
-        #   Credits used by this request.
-        #
-        #   @return [Integer]
-        required :credits_consumed, Integer
-
-        # @!attribute credits_remaining
-        #   Credits remaining for your organization.
-        #
-        #   @return [Integer]
-        required :credits_remaining, Integer
-
-        # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
-        #
-        #   @param credits_consumed [Integer] Credits used by this request.
-        #
-        #   @param credits_remaining [Integer] Credits remaining for your organization.
-      end
-    end
-  end
-end