context.dev 2.17.1 → 2.19.0

data/lib/context_dev/models/web_extract_response.rb

@@ -1,287 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::Web#extract
-    class WebExtractResponse < 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::WebExtractResponse::CacheMetadata]
-      required :cache_metadata, -> { ContextDev::Models::WebExtractResponse::CacheMetadata }
-
-      # @!attribute data
-      #   Extracted data matching the request schema
-      #
-      #   @return [Hash{Symbol=>Object}]
-      required :data, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
-
-      # @!attribute metadata
-      #
-      #   @return [ContextDev::Models::WebExtractResponse::Metadata]
-      required :metadata, -> { ContextDev::Models::WebExtractResponse::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 status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String]
-      required :status, String
-
-      # @!attribute url
-      #   The starting URL that was analyzed
-      #
-      #   @return [String]
-      required :url, String
-
-      # @!attribute urls_analyzed
-      #   List of URLs whose Markdown was used for extraction
-      #
-      #   @return [Array<String>]
-      required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
-
-      # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
-      #
-      #   @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
-
-      # @!attribute partial
-      #   True when the timeout ended processing and this response contains only usable
-      #   results completed so far. Unfinished results are omitted.
-      #
-      #   @return [Boolean, nil]
-      optional :partial, ContextDev::Internal::Type::Boolean
-
-      # @!method initialize(cache_metadata:, data:, metadata:, request_id:, status:, url:, urls_analyzed:, key_metadata: nil, partial: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::WebExtractResponse} for more details.
-      #
-      #   @param cache_metadata [ContextDev::Models::WebExtractResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
-      #
-      #   @param data [Hash{Symbol=>Object}] Extracted data matching the request schema
-      #
-      #   @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
-      #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-      #
-      #   @param url [String] The starting URL that was analyzed
-      #
-      #   @param urls_analyzed [Array<String>] List of URLs whose Markdown was used for extraction
-      #
-      #   @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-      #
-      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
-
-      # @see ContextDev::Models::WebExtractResponse#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::WebExtractResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::WebExtractResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebExtractResponse::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::WebExtractResponse::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::WebExtractResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @see ContextDev::Models::WebExtractResponse#metadata
-      class Metadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute max_crawl_depth
-        #
-        #   @return [Integer]
-        required :max_crawl_depth, Integer, api_name: :maxCrawlDepth
-
-        # @!attribute num_blocked
-        #   Number of crawled pages excluded because they were anti-bot challenges, error
-        #   pages, or parked-domain placeholders.
-        #
-        #   @return [Integer]
-        required :num_blocked, Integer, api_name: :numBlocked
-
-        # @!attribute num_failed
-        #
-        #   @return [Integer]
-        required :num_failed, Integer, api_name: :numFailed
-
-        # @!attribute num_skipped
-        #
-        #   @return [Integer]
-        required :num_skipped, Integer, api_name: :numSkipped
-
-        # @!attribute num_succeeded
-        #
-        #   @return [Integer]
-        required :num_succeeded, Integer, api_name: :numSucceeded
-
-        # @!attribute num_urls
-        #
-        #   @return [Integer]
-        required :num_urls, Integer, api_name: :numUrls
-
-        # @!attribute actions_applied
-        #   One verified outcome per requested browser action, in request order.
-        #
-        #   @return [Array<ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied>, nil]
-        optional :actions_applied,
-                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied] },
-                 api_name: :actionsApplied
-
-        # @!method initialize(max_crawl_depth:, num_blocked:, num_failed:, num_skipped:, num_succeeded:, num_urls:, actions_applied: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::WebExtractResponse::Metadata} for more details.
-        #
-        #   @param max_crawl_depth [Integer]
-        #
-        #   @param num_blocked [Integer] Number of crawled pages excluded because they were anti-bot challenges, error pa
-        #
-        #   @param num_failed [Integer]
-        #
-        #   @param num_skipped [Integer]
-        #
-        #   @param num_succeeded [Integer]
-        #
-        #   @param num_urls [Integer]
-        #
-        #   @param actions_applied [Array<ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied>] One verified outcome per requested browser action, in request order.
-
-        class ActionsApplied < ContextDev::Internal::Type::BaseModel
-          # @!attribute instruction
-          #
-          #   @return [String]
-          required :instruction, String
-
-          # @!attribute status
-          #   Applied means the requested page state was visibly verified. Failed means it was
-          #   not verified. Skipped means it was not attempted.
-          #
-          #   @return [Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status]
-          required :status, enum: -> { ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status }
-
-          # @!attribute completion_evidence
-          #   Visible page evidence used to verify an applied action.
-          #
-          #   @return [String, nil]
-          optional :completion_evidence, String, api_name: :completionEvidence
-
-          # @!attribute duration_ms
-          #
-          #   @return [Float, nil]
-          optional :duration_ms, Float, api_name: :durationMs
-
-          # @!attribute error
-          #
-          #   @return [String, nil]
-          optional :error, String
-
-          # @!attribute method_
-          #
-          #   @return [String, nil]
-          optional :method_, String, api_name: :method
-
-          # @!attribute target_description
-          #
-          #   @return [String, nil]
-          optional :target_description, String, api_name: :targetDescription
-
-          # @!method initialize(instruction:, status:, completion_evidence: nil, duration_ms: nil, error: nil, method_: nil, target_description: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied} for more
-          #   details.
-          #
-          #   @param instruction [String]
-          #
-          #   @param status [Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status] Applied means the requested page state was visibly verified. Failed means it was
-          #
-          #   @param completion_evidence [String] Visible page evidence used to verify an applied action.
-          #
-          #   @param duration_ms [Float]
-          #
-          #   @param error [String]
-          #
-          #   @param method_ [String]
-          #
-          #   @param target_description [String]
-
-          # Applied means the requested page state was visibly verified. Failed means it was
-          # not verified. Skipped means it was not attempted.
-          #
-          # @see ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied#status
-          module Status
-            extend ContextDev::Internal::Type::Enum
-
-            APPLIED = :applied
-            FAILED = :failed
-            SKIPPED = :skipped
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-      end
-
-      # @see ContextDev::Models::WebExtractResponse#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_bytes_params.rb

@@ -1,344 +0,0 @@
-# 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