context.dev 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441310ead23b6111ba1f51ac02adc5ee730e83a200712f0462a93da65bc9839f
-  data.tar.gz: 503cc3805332b56e8f3f16c8aaf39aee232e417dcd912450925cd1fe89dc9671
+  metadata.gz: 624f1916305dc7e83b1cc7e40d4dbe2deb53bb14d073ae36a760317d4f65aba8
+  data.tar.gz: 01ebeecf67e7682bfd322fb1d4359af7e3b438465c03215c85efb8fe6bd57c64
 SHA512:
-  metadata.gz: ed1f83de696ab32087ae193f0d89ec188528b4a4671851962526b4c9dfcf31d159d9aa970ba9c6c766c5b910cfd91c509335853c06d0893126ef963330dc85f4
-  data.tar.gz: 6b3bddf5bdc32cf2b76a6971d227af43ca209f95f1bc555aec3a9477b24560f757590f92b9c98abeb42ce1acd2c0a7190f72fd8becee750f1653ed73a9ef270c
+  metadata.gz: 5942d089d87c49d8b591e5857a217a8535d9a7ec5eda8d64254f24131e9702a87f7c1fe31c5e4d1a89e6f8c95190c4e6c123857bcfd36fa6a7790e76994441e4
+  data.tar.gz: 06c2131494e4170ca7afdef11a43edd5368327541dec98e568a3e56fa8c168d89789bafb67054873d33bc8bc3168ae50dec60a9c8174d68411330593bb119f8a

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 2.6.0 (2026-07-31)
+
+Full Changelog: [v2.5.0...v2.6.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.5.0...v2.6.0)
+
+### Features
+
+* **api:** api update ([cedd9b1](https://github.com/context-dot-dev/context-ruby-sdk/commit/cedd9b1191e1297236c2aa6dede3fa640380b651))
+* **api:** api update ([98fedb9](https://github.com/context-dot-dev/context-ruby-sdk/commit/98fedb99aae187cff9284efd0a6c574b1b71d749))
+* **api:** api update ([7a5cc9a](https://github.com/context-dot-dev/context-ruby-sdk/commit/7a5cc9aa3bd2c746d0e47a58fbc426453db3b8c7))
+* **api:** api update ([6cfd0e8](https://github.com/context-dot-dev/context-ruby-sdk/commit/6cfd0e80f3860cfbddd595ac4c72461075775415))
+* **api:** api update ([99bdfb2](https://github.com/context-dot-dev/context-ruby-sdk/commit/99bdfb24af9adfac64ee68ca714fb1176c1d61c0))
+* **api:** manual updates ([d7a4669](https://github.com/context-dot-dev/context-ruby-sdk/commit/d7a46695c2ba5ec1f54eaedec751bfd1d1559c4b))
+
 ## 2.5.0 (2026-07-22)
 
 Full Changelog: [v2.4.0...v2.5.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.4.0...v2.5.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.5.0"
+gem "context.dev", "~> 2.6.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/client.rb

@@ -43,6 +43,9 @@ module ContextDev
     # @return [ContextDev::Resources::Monitors]
     attr_reader :monitors
 
+    # @return [ContextDev::Resources::Batch]
+    attr_reader :batch
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -111,6 +114,7 @@ module ContextDev
       @industry = ContextDev::Resources::Industry.new(client: self)
       @utility = ContextDev::Resources::Utility.new(client: self)
       @monitors = ContextDev::Resources::Monitors.new(client: self)
+      @batch = ContextDev::Resources::Batch.new(client: self)
     end
   end
 end

data/lib/context_dev/models/batch_cancel_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#cancel
+    class BatchCancelParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute batch_id
+      #   ID of the batch to retrieve or cancel.
+      #
+      #   @return [String]
+      required :batch_id, String
+
+      # @!method initialize(batch_id:, request_options: {})
+      #   @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/context_dev/models/batch_cancel_response.rb

@@ -0,0 +1,354 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#cancel
+    class BatchCancelResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute id
+      #   Batch ID used to retrieve or cancel the job.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute credits
+      #   Reserved and used credits.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Credits]
+      required :credits, -> { ContextDev::Models::BatchCancelResponse::Credits }
+
+      # @!attribute error
+      #   Why the batch failed.
+      #
+      #   @return [ContextDev::Models::Error, nil]
+      required :error, -> { ContextDev::Error }, nil?: true
+
+      # @!attribute errors
+      #   Page failures grouped by error code.
+      #
+      #   @return [Array<ContextDev::Models::ErrorCount>]
+      required :errors, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::ErrorCount] }
+
+      # @!attribute input
+      #   Submission counts.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Input]
+      required :input, -> { ContextDev::Models::BatchCancelResponse::Input }
+
+      # @!attribute mode
+      #   How pages are selected.
+      #
+      #   @return [Symbol, ContextDev::Models::BatchCancelResponse::Mode]
+      required :mode, enum: -> { ContextDev::Models::BatchCancelResponse::Mode }
+
+      # @!attribute progress
+      #   Current processing counts. Use `status` to check completion.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Progress]
+      required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
+
+      # @!attribute results
+      #   Download links available when the batch finishes. GET /batch/{batch_id}/results
+      #   serves the same records as paginated JSON.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Results, nil]
+      required :results, -> { ContextDev::Models::BatchCancelResponse::Results }, nil?: true
+
+      # @!attribute status
+      #   Current state. `completed`, `cancelled`, and `failed` are final.
+      #
+      #   @return [Symbol, ContextDev::Models::BatchCancelResponse::Status]
+      required :status, enum: -> { ContextDev::Models::BatchCancelResponse::Status }
+
+      # @!attribute tags
+      #   Tags stored on the batch at submission.
+      #
+      #   @return [Array<String>]
+      required :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute timing
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Timing]
+      required :timing, -> { ContextDev::Models::BatchCancelResponse::Timing }
+
+      # @!attribute type
+      #   Output format.
+      #
+      #   @return [Symbol, ContextDev::Models::BatchCancelResponse::Type]
+      required :type, enum: -> { ContextDev::Models::BatchCancelResponse::Type }
+
+      # @!attribute key_metadata
+      #   API key usage for this request.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }
+
+      # @!method initialize(id:, credits:, error:, errors:, input:, mode:, progress:, results:, status:, tags:, timing:, type:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchCancelResponse} for more details.
+      #
+      #   @param id [String] Batch ID used to retrieve or cancel the job.
+      #
+      #   @param credits [ContextDev::Models::BatchCancelResponse::Credits] Reserved and used credits.
+      #
+      #   @param error [ContextDev::Models::Error, nil] Why the batch failed.
+      #
+      #   @param errors [Array<ContextDev::Models::ErrorCount>] Page failures grouped by error code.
+      #
+      #   @param input [ContextDev::Models::BatchCancelResponse::Input] Submission counts.
+      #
+      #   @param mode [Symbol, ContextDev::Models::BatchCancelResponse::Mode] How pages are selected.
+      #
+      #   @param progress [ContextDev::Models::BatchCancelResponse::Progress] Current processing counts. Use `status` to check completion.
+      #
+      #   @param results [ContextDev::Models::BatchCancelResponse::Results, nil] Download links available when the batch finishes. GET /batch/{batch_id}/results
+      #
+      #   @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Current state. `completed`, `cancelled`, and `failed` are final.
+      #
+      #   @param tags [Array<String>] Tags stored on the batch at submission.
+      #
+      #   @param timing [ContextDev::Models::BatchCancelResponse::Timing]
+      #
+      #   @param type [Symbol, ContextDev::Models::BatchCancelResponse::Type] Output format.
+      #
+      #   @param key_metadata [ContextDev::Models::BatchCancelResponse::KeyMetadata] API key usage for this request.
+
+      # @see ContextDev::Models::BatchCancelResponse#credits
+      class Credits < ContextDev::Internal::Type::BaseModel
+        # @!attribute charged
+        #   Credits used by successful pages.
+        #
+        #   @return [Integer]
+        required :charged, Integer
+
+        # @!attribute estimated
+        #   Credits reserved when the batch was accepted.
+        #
+        #   @return [Integer]
+        required :estimated, Integer
+
+        # @!method initialize(charged:, estimated:)
+        #   Reserved and used credits.
+        #
+        #   @param charged [Integer] Credits used by successful pages.
+        #
+        #   @param estimated [Integer] Credits reserved when the batch was accepted.
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#input
+      class Input < ContextDev::Internal::Type::BaseModel
+        # @!attribute accepted
+        #   Pages accepted, or the crawl page limit. Credits are reserved for this count.
+        #
+        #   @return [Integer]
+        required :accepted, Integer
+
+        # @!attribute duplicates
+        #   Duplicate URL and `itemId` pairs skipped. Always 0 for crawls.
+        #
+        #   @return [Integer]
+        required :duplicates, Integer
+
+        # @!attribute invalid
+        #   Pages rejected during validation.
+        #
+        #   @return [Integer]
+        required :invalid, Integer
+
+        # @!attribute submitted
+        #   Pages submitted before validation. For a crawl, the page limit.
+        #
+        #   @return [Integer]
+        required :submitted, Integer
+
+        # @!method initialize(accepted:, duplicates:, invalid:, submitted:)
+        #   Submission counts.
+        #
+        #   @param accepted [Integer] Pages accepted, or the crawl page limit. Credits are reserved for this count.
+        #
+        #   @param duplicates [Integer] Duplicate URL and `itemId` pairs skipped. Always 0 for crawls.
+        #
+        #   @param invalid [Integer] Pages rejected during validation.
+        #
+        #   @param submitted [Integer] Pages submitted before validation. For a crawl, the page limit.
+      end
+
+      # How pages are selected.
+      #
+      # @see ContextDev::Models::BatchCancelResponse#mode
+      module Mode
+        extend ContextDev::Internal::Type::Enum
+
+        SCRAPE = :scrape
+        CRAWL = :crawl
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#progress
+      class Progress < ContextDev::Internal::Type::BaseModel
+        # @!attribute failed
+        #   Pages that could not be scraped.
+        #
+        #   @return [Integer]
+        required :failed, Integer
+
+        # @!attribute pending
+        #   Accepted pages not yet attempted. Always 0 once the batch completes; a crawl can
+        #   finish under its page limit when the site has no more reachable pages.
+        #
+        #   @return [Integer]
+        required :pending, Integer
+
+        # @!attribute succeeded
+        #   Pages scraped successfully.
+        #
+        #   @return [Integer]
+        required :succeeded, Integer
+
+        # @!method initialize(failed:, pending:, succeeded:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BatchCancelResponse::Progress} for more details.
+        #
+        #   Current processing counts. Use `status` to check completion.
+        #
+        #   @param failed [Integer] Pages that could not be scraped.
+        #
+        #   @param pending [Integer] Accepted pages not yet attempted. Always 0 once the batch completes; a crawl can
+        #
+        #   @param succeeded [Integer] Pages scraped successfully.
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#results
+      class Results < ContextDev::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   When the download URLs expire.
+        #
+        #   @return [String]
+        required :expires_at, String
+
+        # @!attribute files
+        #   Result files. Order is not guaranteed.
+        #
+        #   @return [Array<ContextDev::Models::BatchCancelResponse::Results::File>]
+        required :files,
+                 -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BatchCancelResponse::Results::File] }
+
+        # @!method initialize(expires_at:, files:)
+        #   Download links available when the batch finishes. GET /batch/{batch_id}/results
+        #   serves the same records as paginated JSON.
+        #
+        #   @param expires_at [String] When the download URLs expire.
+        #
+        #   @param files [Array<ContextDev::Models::BatchCancelResponse::Results::File>] Result files. Order is not guaranteed.
+
+        class File < ContextDev::Internal::Type::BaseModel
+          # @!attribute bytes
+          #   Compressed file size in bytes.
+          #
+          #   @return [Integer]
+          required :bytes, Integer
+
+          # @!attribute items
+          #   Results in this file.
+          #
+          #   @return [Integer]
+          required :items, Integer
+
+          # @!attribute url
+          #   Temporary URL for a gzipped NDJSON file.
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(bytes:, items:, url:)
+          #   @param bytes [Integer] Compressed file size in bytes.
+          #
+          #   @param items [Integer] Results in this file.
+          #
+          #   @param url [String] Temporary URL for a gzipped NDJSON file.
+        end
+      end
+
+      # Current state. `completed`, `cancelled`, and `failed` are final.
+      #
+      # @see ContextDev::Models::BatchCancelResponse#status
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        QUEUED = :queued
+        RUNNING = :running
+        CANCELLING = :cancelling
+        COMPLETED = :completed
+        CANCELLED = :cancelled
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#timing
+      class Timing < ContextDev::Internal::Type::BaseModel
+        # @!attribute completed_at
+        #   When processing finished. Null while active.
+        #
+        #   @return [String, nil]
+        required :completed_at, String, nil?: true
+
+        # @!attribute created_at
+        #   When the batch was created.
+        #
+        #   @return [String]
+        required :created_at, String
+
+        # @!attribute started_at
+        #   When processing started. Null while queued.
+        #
+        #   @return [String, nil]
+        required :started_at, String, nil?: true
+
+        # @!method initialize(completed_at:, created_at:, started_at:)
+        #   @param completed_at [String, nil] When processing finished. Null while active.
+        #
+        #   @param created_at [String] When the batch was created.
+        #
+        #   @param started_at [String, nil] When processing started. Null while queued.
+      end
+
+      # Output format.
+      #
+      # @see ContextDev::Models::BatchCancelResponse#type
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        MARKDOWN = :markdown
+        HTML = :html
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   API key usage for this request.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+    end
+  end
+end

data/lib/context_dev/models/batch_get_results_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#get_results
+    class BatchGetResultsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute batch_id
+      #   ID of the batch to retrieve or cancel.
+      #
+      #   @return [String]
+      required :batch_id, String
+
+      # @!attribute cursor
+      #   next_cursor from the previous page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Records per page. Defaults to 25. A page can close early so its payload stays
+      #   under ~8 MB; rely on next_cursor rather than counting records.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(batch_id:, cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchGetResultsParams} for more details.
+      #
+      #   @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      #   @param cursor [String] next_cursor from the previous page.
+      #
+      #   @param limit [Integer] Records per page. Defaults to 25. A page can close early so its payload stays un
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end