context.dev 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441310ead23b6111ba1f51ac02adc5ee730e83a200712f0462a93da65bc9839f
-  data.tar.gz: 503cc3805332b56e8f3f16c8aaf39aee232e417dcd912450925cd1fe89dc9671
+  metadata.gz: e324f1e33503f55a47664f8196dc0f07abf62c1c4fed5e9d09baee669939f16f
+  data.tar.gz: 43c6f5ec7f3e210ec6ea287db7ffee80cbd6c6f0c8fca7438ea8625540787127
 SHA512:
-  metadata.gz: ed1f83de696ab32087ae193f0d89ec188528b4a4671851962526b4c9dfcf31d159d9aa970ba9c6c766c5b910cfd91c509335853c06d0893126ef963330dc85f4
-  data.tar.gz: 6b3bddf5bdc32cf2b76a6971d227af43ca209f95f1bc555aec3a9477b24560f757590f92b9c98abeb42ce1acd2c0a7190f72fd8becee750f1653ed73a9ef270c
+  metadata.gz: a0da6fbb0005114984cc6ee0ee233ae6b0b81666442ed342937cdf93469ece8acd041d7c25560ace5adbdc5e2c8a8e921ca931c3bd8216a04d56d6f9fd721ed0
+  data.tar.gz: 2dea9ed22d8eac728dcb0defaebf1a345fd8c1a2e649dd0a416e59639492fd04db7d3d34f94186f3cb613161deff4ac579f9002360d5c43cab474ab63ff004b5

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 2.7.0 (2026-08-01)
+
+Full Changelog: [v2.6.0...v2.7.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.6.0...v2.7.0)
+
+### Features
+
+* **api:** api update ([b0bdc3e](https://github.com/context-dot-dev/context-ruby-sdk/commit/b0bdc3ec9322ce5854177cdaff808caaba427746))
+* **api:** api update ([17848b3](https://github.com/context-dot-dev/context-ruby-sdk/commit/17848b313dcbd098b21902bd2bd2cab6d9ad5ce2))
+* **api:** api update ([4db7386](https://github.com/context-dot-dev/context-ruby-sdk/commit/4db7386bf6f686a33beae7817ec9122e1adad47f))
+
+## 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.7.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,241 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#cancel
+    class BatchCancelResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute id
+      #   Batch ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute crawl
+      #   The crawl controls as submitted, so the limits requested can be compared against
+      #   what the crawl reached.
+      #
+      #   @return [ContextDev::Models::CrawlControls, nil]
+      required :crawl, -> { ContextDev::CrawlControls }, nil?: true
+
+      # @!attribute credits
+      #   What this batch cost so far.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Credits]
+      required :credits, -> { ContextDev::Models::BatchCancelResponse::Credits }
+
+      # @!attribute format_
+      #   What each page is returned as.
+      #
+      #   @return [Symbol, ContextDev::Models::BatchCancelResponse::Format]
+      required :format_, enum: -> { ContextDev::Models::BatchCancelResponse::Format }, api_name: :format
+
+      # @!attribute input
+      #   What submission took in, and what it charged for.
+      #
+      #   @return [ContextDev::Models::Intake]
+      required :input, -> { ContextDev::Intake }
+
+      # @!attribute mode
+      #   How pages were selected.
+      #
+      #   @return [Symbol, ContextDev::Models::BatchCancelResponse::Mode]
+      required :mode, enum: -> { ContextDev::Models::BatchCancelResponse::Mode }
+
+      # @!attribute page_errors
+      #   Page failures so far, grouped by error code and sorted by count.
+      #
+      #   @return [Array<ContextDev::Models::PageErrorCount>]
+      required :page_errors, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PageErrorCount] }
+
+      # @!attribute progress
+      #   How far the batch got before cancellation.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Progress]
+      required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
+
+      # @!attribute status
+      #   Always `cancelling`. Work already in flight finishes; the batch reaches
+      #   `cancelled` shortly after.
+      #
+      #   @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
+      #   There is no finish time yet — the batch is still winding down.
+      #
+      #   @return [ContextDev::Models::BatchCancelResponse::Timing]
+      required :timing, -> { ContextDev::Models::BatchCancelResponse::Timing }
+
+      # @!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:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, status:, tags:, timing:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchCancelResponse} for more details.
+      #
+      #   @param id [String] Batch ID.
+      #
+      #   @param crawl [ContextDev::Models::CrawlControls, nil] The crawl controls as submitted, so the limits requested can be compared against
+      #
+      #   @param credits [ContextDev::Models::BatchCancelResponse::Credits] What this batch cost so far.
+      #
+      #   @param format_ [Symbol, ContextDev::Models::BatchCancelResponse::Format] What each page is returned as.
+      #
+      #   @param input [ContextDev::Models::Intake] What submission took in, and what it charged for.
+      #
+      #   @param mode [Symbol, ContextDev::Models::BatchCancelResponse::Mode] How pages were selected.
+      #
+      #   @param page_errors [Array<ContextDev::Models::PageErrorCount>] Page failures so far, grouped by error code and sorted by count.
+      #
+      #   @param progress [ContextDev::Models::BatchCancelResponse::Progress] How far the batch got before cancellation.
+      #
+      #   @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Always `cancelling`. Work already in flight finishes; the batch reaches `cancell
+      #
+      #   @param tags [Array<String>] Tags stored on the batch at submission.
+      #
+      #   @param timing [ContextDev::Models::BatchCancelResponse::Timing] There is no finish time yet — the batch is still winding down.
+      #
+      #   @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 reserved
+        #   Credits debited at submission. The unspent remainder is refunded once the batch
+        #   settles — read `credits.refunded` from GET /batch/{batch_id} then.
+        #
+        #   @return [Integer]
+        required :reserved, Integer
+
+        # @!method initialize(reserved:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BatchCancelResponse::Credits} for more details.
+        #
+        #   What this batch cost so far.
+        #
+        #   @param reserved [Integer] Credits debited at submission. The unspent remainder is refunded once the batch
+      end
+
+      # What each page is returned as.
+      #
+      # @see ContextDev::Models::BatchCancelResponse#format_
+      module Format
+        extend ContextDev::Internal::Type::Enum
+
+        MARKDOWN = :markdown
+        HTML = :html
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # How pages were 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 before the request landed.
+        #
+        #   @return [Integer]
+        required :failed, Integer
+
+        # @!attribute pending
+        #   Reserved pages that will now be skipped, and refunded when the batch settles.
+        #
+        #   @return [Integer]
+        required :pending, Integer
+
+        # @!attribute succeeded
+        #   Pages scraped successfully before the request landed.
+        #
+        #   @return [Integer]
+        required :succeeded, Integer
+
+        # @!method initialize(failed:, pending:, succeeded:)
+        #   How far the batch got before cancellation.
+        #
+        #   @param failed [Integer] Pages that could not be scraped before the request landed.
+        #
+        #   @param pending [Integer] Reserved pages that will now be skipped, and refunded when the batch settles.
+        #
+        #   @param succeeded [Integer] Pages scraped successfully before the request landed.
+      end
+
+      # Always `cancelling`. Work already in flight finishes; the batch reaches
+      # `cancelled` shortly after.
+      #
+      # @see ContextDev::Models::BatchCancelResponse#status
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        CANCELLING = :cancelling
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see ContextDev::Models::BatchCancelResponse#timing
+      class Timing < ContextDev::Internal::Type::BaseModel
+        # @!attribute created_at
+        #   When the batch was created.
+        #
+        #   @return [String]
+        required :created_at, String
+
+        # @!attribute started_at
+        #   When processing started. Null if it was cancelled while still queued.
+        #
+        #   @return [String, nil]
+        required :started_at, String, nil?: true
+
+        # @!method initialize(created_at:, started_at:)
+        #   There is no finish time yet — the batch is still winding down.
+        #
+        #   @param created_at [String] When the batch was created.
+        #
+        #   @param started_at [String, nil] When processing started. Null if it was cancelled while still queued.
+      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