context.dev 2.15.0 → 2.17.0

data/lib/context_dev/models/web_web_crawl_md_response.rb

@@ -17,6 +17,13 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
       required :metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::Metadata }
 
+      # @!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 results
       #
       #   @return [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
@@ -29,7 +36,15 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, metadata:, results:, key_metadata: nil)
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(cache_metadata:, metadata:, request_id:, results:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdResponse} for more details.
       #
@@ -37,9 +52,13 @@ module ContextDev
       #
       #   @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
       #
       #   @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
 
       # @see ContextDev::Models::WebWebCrawlMdResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel

data/lib/context_dev/models/web_web_scrape_bytes_params.rb

@@ -0,0 +1,344 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Web#web_scrape_bytes
+    class WebWebScrapeBytesParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Full HTTP(S) URL of the resource to download, such as an image, PDF, or page.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute country
+      #   Fetch the target page through a residential proxy in this country (ISO 3166-1
+      #   alpha-2).
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Country, nil]
+      optional :country, enum: -> { ContextDev::WebWebScrapeBytesParams::Country }
+
+      # @!attribute headers
+      #   Optional outbound HTTP headers, such as Referer, Cookie, or Authorization. Send
+      #   as a JSON object or deep-object query params such as
+      #   headers[Referer]=https://example.com/. Host, Content-Length, and hop-by-hop
+      #   transport headers are rejected. Authorization and cookies are removed when a
+      #   redirect changes origin.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, ContextDev::Internal::Type::HashOf[String]
+
+      # @!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::WebWebScrapeBytesParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebScrapeBytesParams::TimeoutOpts }
+
+      # @!attribute zdr
+      #   Set to enabled to bypass shared caches and omit request and response content
+      #   from retained usage logs. 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::WebWebScrapeBytesParams::Zdr, nil]
+      optional :zdr, enum: -> { ContextDev::WebWebScrapeBytesParams::Zdr }
+
+      # @!method initialize(url:, country: nil, headers: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeBytesParams} for more details.
+      #
+      #   @param url [String] Full HTTP(S) URL of the resource to download, such as an image, PDF, or page.
+      #
+      #   @param country [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
+      #
+      #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers, such as Referer, Cookie, or Authorization. Send
+      #
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      #
+      #   @param timeout_opts [ContextDev::Models::WebWebScrapeBytesParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #
+      #   @param zdr [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+
+      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. This endpoint supports "fail": return 408
+        #   REQUEST_TIMEOUT without charging credits.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebScrapeBytesParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebScrapeBytesParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeBytesParams::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::WebWebScrapeBytesParams::TimeoutOpts::Behavior] What to do at the deadline. This endpoint supports "fail": return 408 REQUEST_TI
+
+        # What to do at the deadline. This endpoint supports "fail": return 408
+        # REQUEST_TIMEOUT without charging credits.
+        #
+        # @see ContextDev::Models::WebWebScrapeBytesParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. 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_bytes_response.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Web#web_scrape_bytes
+    class WebWebScrapeBytesResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute bytes
+      #   Base64-encoded resource bytes, without a data URI prefix. Decode this field to
+      #   recover the downloaded file.
+      #
+      #   @return [String]
+      required :bytes, String
+
+      # @!attribute content_length
+      #   Number of decoded resource bytes, before base64 encoding.
+      #
+      #   @return [Integer]
+      required :content_length, Integer, api_name: :contentLength
+
+      # @!attribute content_type
+      #   The Content-Type returned by the origin, including any charset. Defaults to
+      #   application/octet-stream when absent.
+      #
+      #   @return [String]
+      required :content_type, String, api_name: :contentType
+
+      # @!attribute encoding
+      #
+      #   @return [Symbol, ContextDev::Models::WebWebScrapeBytesResponse::Encoding]
+      required :encoding, enum: -> { ContextDev::Models::WebWebScrapeBytesResponse::Encoding }
+
+      # @!attribute final_url
+      #   The resource URL after redirects.
+      #
+      #   @return [String]
+      required :final_url, String, api_name: :finalUrl
+
+      # @!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 status_code
+      #   HTTP status returned by the origin.
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :statusCode
+
+      # @!attribute success
+      #
+      #   @return [Boolean, ContextDev::Models::WebWebScrapeBytesResponse::Success]
+      required :success, enum: -> { ContextDev::Models::WebWebScrapeBytesResponse::Success }
+
+      # @!attribute url
+      #   The requested resource URL.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute key_metadata
+      #   Credit usage, included whenever a valid API key is provided.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata }
+
+      # @!method initialize(bytes:, content_length:, content_type:, encoding:, final_url:, request_id:, status_code:, success:, url:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeBytesResponse} for more details.
+      #
+      #   @param bytes [String] Base64-encoded resource bytes, without a data URI prefix. Decode this field to r
+      #
+      #   @param content_length [Integer] Number of decoded resource bytes, before base64 encoding.
+      #
+      #   @param content_type [String] The Content-Type returned by the origin, including any charset. Defaults to appl
+      #
+      #   @param encoding [Symbol, ContextDev::Models::WebWebScrapeBytesResponse::Encoding]
+      #
+      #   @param final_url [String] The resource URL after redirects.
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
+      #   @param status_code [Integer] HTTP status returned by the origin.
+      #
+      #   @param success [Boolean, ContextDev::Models::WebWebScrapeBytesResponse::Success]
+      #
+      #   @param url [String] The requested resource URL.
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeBytesResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+      # @see ContextDev::Models::WebWebScrapeBytesResponse#encoding
+      module Encoding
+        extend ContextDev::Internal::Type::Enum
+
+        BASE64 = :base64
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::WebWebScrapeBytesResponse#success
+      module Success
+        extend ContextDev::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+
+      # @see ContextDev::Models::WebWebScrapeBytesResponse#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

data/lib/context_dev/models/web_web_scrape_html_params.rb

@@ -90,13 +90,13 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
+      # @!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 [Integer, nil]
-      optional :timeout_ms, Integer
+      #   @return [ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebScrapeHTMLParams::TimeoutOpts }
 
       # @!attribute use_main_content_only
       #   When true, return only the page's main content in the HTML response, excluding
@@ -107,7 +107,9 @@ module ContextDev
 
       # @!attribute wait_for_ms
       #   Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
-      #   30000 (30 seconds).
+      #   30000 (30 seconds). 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
@@ -121,7 +123,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebWebScrapeHTMLParams::Zdr }
 
-      # @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
       #
@@ -147,7 +149,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
       #
@@ -566,6 +568,53 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       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 15000.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebScrapeHTMLParams::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::WebWebScrapeHTMLParams::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 15000.
+        #
+        # @see ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # Set to enabled to bypass shared caches and omit request and response content
       # from retained usage logs. Requires zero data retention to be enabled for your
       # organization (contact support@context.dev), otherwise the request fails with