context.dev 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c5f92b8b65317b72386a6582682ef62851cef787995be6a72be151b4aa40fb
-  data.tar.gz: 3e3a50df8e1e9d2cebdfb69de6f5c4ca0f29fee113b9c616c12b12f73515a29c
+  metadata.gz: 69a2da1329540a2c1c0c290e8a62fbf719dfd285d7bafa68f0f1bae6a691d46d
+  data.tar.gz: 6bb32ce7431dbc1d7e831d6401058a52e6fec88bce87f782c12bc77a2f94d945
 SHA512:
-  metadata.gz: ce4193c612f2b34aced1bd14795a8e914b1aac8fd89178a654249db944163516ed7abde812992c6b070f4b1c05ff3dc74b0c3a3157645394f05b39a3b18c50ba
-  data.tar.gz: 62118c6e0913a9653616fd42121f3bacbc4b473f187430c0be61fd6fe496a046b4f1f831c1df748a14f4bde33fbcfe532f0afd92e13ae11bf604bea5207efdc7
+  metadata.gz: 05f9612ffb040bf683cf176f4c29054037587a7896fce546afc631b0c412075a5292bdcb60ef8d7cf7aa9b665ba8b555d2a4e8f6697989e9effb1eed243597b5
+  data.tar.gz: a98751043b31c39b8005fe357584cbddbd0685b8af8e400c6ca3f227f49cee25a07e6c4346d773be85bac7a4480d5e3ac0d32c9496c5b7b775c7fc41dfc5a01b

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 2.9.0 (2026-08-07)
+
+Full Changelog: [v2.8.0...v2.9.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.8.0...v2.9.0)
+
+### Features
+
+* **api:** api update ([ea29f67](https://github.com/context-dot-dev/context-ruby-sdk/commit/ea29f67042bd6fd9b987d7ad4ad9f8993a871653))
+* **api:** api update ([e7c64e4](https://github.com/context-dot-dev/context-ruby-sdk/commit/e7c64e4540db4cc313d70cebe5409739b052e567))
+* **api:** api update ([975de89](https://github.com/context-dot-dev/context-ruby-sdk/commit/975de893c9145f20f541a443730d7d99f575a313))
+* **api:** api update ([a1f13c2](https://github.com/context-dot-dev/context-ruby-sdk/commit/a1f13c2244b0ac81a58c350e6cba79875e0c4bf1))
+* **api:** api update ([e7cfd87](https://github.com/context-dot-dev/context-ruby-sdk/commit/e7cfd87ff2e163f572cc33ee4b6af5be79811d03))
+* **api:** api update ([c827408](https://github.com/context-dot-dev/context-ruby-sdk/commit/c8274088947813e1090d6232190b5333c025696a))
+* **api:** api update ([5c09f03](https://github.com/context-dot-dev/context-ruby-sdk/commit/5c09f03dd90cda2cad388ac2605d6cadebf0e137))
+* **api:** manual updates ([cf2f79f](https://github.com/context-dot-dev/context-ruby-sdk/commit/cf2f79ff77dca3e57069cfac612e7fd333a8d83f))
+
 ## 2.8.0 (2026-08-05)
 
 Full Changelog: [v2.7.0...v2.8.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.7.0...v2.8.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.8.0"
+gem "context.dev", "~> 2.9.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/client.rb

@@ -43,9 +43,13 @@ module ContextDev
     # @return [ContextDev::Resources::Monitors]
     attr_reader :monitors
 
+    # Scrape many pages or crawl a site asynchronously.
     # @return [ContextDev::Resources::Batch]
     attr_reader :batch
 
+    # @return [ContextDev::Resources::People]
+    attr_reader :people
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -115,6 +119,7 @@ module ContextDev
       @utility = ContextDev::Resources::Utility.new(client: self)
       @monitors = ContextDev::Resources::Monitors.new(client: self)
       @batch = ContextDev::Resources::Batch.new(client: self)
+      @people = ContextDev::Resources::People.new(client: self)
     end
   end
 end

data/lib/context_dev/models/batch_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#delete
+    class BatchDeleteParams < 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_delete_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Batch#delete
+    class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute id
+      #   ID of the deleted batch.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute deleted
+      #   Always true on success.
+      #
+      #   @return [Boolean, nil]
+      optional :deleted, ContextDev::Internal::Type::Boolean
+
+      # @!attribute key_metadata
+      #   Metadata about the API key used for the request. Included in every response
+      #   whenever a valid API key is provided, even when the response status is not 200.
+      #
+      #   @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
+
+      # @!method initialize(id: nil, deleted: nil, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchDeleteResponse} for more details.
+      #
+      #   @param id [String] ID of the deleted batch.
+      #
+      #   @param deleted [Boolean] Always true on success.
+      #
+      #   @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+
+      # @see ContextDev::Models::BatchDeleteResponse#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:)
+        #   Metadata about the API key used for the request. Included in every response
+        #   whenever a valid API key is provided, even when the response status is not 200.
+        #
+        #   @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_response.rb

@@ -109,7 +109,17 @@ module ContextDev
           #   @return [Hash{Symbol=>Object}, nil]
           optional :meta, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
 
-          # @!method initialize(final_url:, http_status:, metadata:, url:, html: nil, item_id: nil, markdown: nil, meta: nil, status: :ok)
+          # @!attribute ocr_pages
+          #   PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
+          #   bills 1 credit on top of the page base credit; absent when no OCR ran.
+          #
+          #   @return [Integer, nil]
+          optional :ocr_pages, Integer
+
+          # @!method initialize(final_url:, http_status:, metadata:, url:, html: nil, item_id: nil, markdown: nil, meta: nil, ocr_pages: nil, status: :ok)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::BatchGetResultsResponse::Data::Ok} for more details.
+          #
           #   A page the batch fetched successfully.
           #
           #   @param final_url [String] URL the content was read from, after redirects.
@@ -128,6 +138,8 @@ module ContextDev
           #
           #   @param meta [Hash{Symbol=>Object}] Caller-supplied metadata echoed from submission.
           #
+          #   @param ocr_pages [Integer] PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
+          #
           #   @param status [Symbol, :ok] The page was scraped.
 
           # @see ContextDev::Models::BatchGetResultsResponse::Data::Ok#metadata

data/lib/context_dev/models/batch_list_response.rb

@@ -160,12 +160,19 @@ module ContextDev
         # @see ContextDev::Models::BatchListResponse::Data#credits
         class Credits < ContextDev::Internal::Type::BaseModel
           # @!attribute net
-          #   `reserved` minus `refunded` — what the batch has cost so far. Equal to
-          #   `reserved` until the batch settles.
+          #   `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+          #   Equal to `reserved` until the batch settles.
           #
           #   @return [Integer]
           required :net, Integer
 
+          # @!attribute ocr_charged
+          #   Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
+          #   page, on top of `reserved`. Stays 0 until the batch settles.
+          #
+          #   @return [Integer]
+          required :ocr_charged, Integer
+
           # @!attribute refunded
           #   Credits returned for pages that did not succeed. Stays 0 until the batch reaches
           #   a final status, then settles in one movement.
@@ -180,13 +187,15 @@ module ContextDev
           #   @return [Integer]
           required :reserved, Integer
 
-          # @!method initialize(net:, refunded:, reserved:)
+          # @!method initialize(net:, ocr_charged:, refunded:, reserved:)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::BatchListResponse::Data::Credits} for more details.
           #
           #   What this batch has done to your credit balance.
           #
-          #   @param net [Integer] `reserved` minus `refunded` — what the batch has cost so far. Equal to `reserved
+          #   @param net [Integer] `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+          #
+          #   @param ocr_charged [Integer] Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered p
           #
           #   @param refunded [Integer] Credits returned for pages that did not succeed. Stays 0 until the batch reaches
           #

data/lib/context_dev/models/batch_retrieve_response.rb

@@ -137,12 +137,19 @@ module ContextDev
       # @see ContextDev::Models::BatchRetrieveResponse#credits
       class Credits < ContextDev::Internal::Type::BaseModel
         # @!attribute net
-        #   `reserved` minus `refunded` — what the batch has cost so far. Equal to
-        #   `reserved` until the batch settles.
+        #   `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+        #   Equal to `reserved` until the batch settles.
         #
         #   @return [Integer]
         required :net, Integer
 
+        # @!attribute ocr_charged
+        #   Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
+        #   page, on top of `reserved`. Stays 0 until the batch settles.
+        #
+        #   @return [Integer]
+        required :ocr_charged, Integer
+
         # @!attribute refunded
         #   Credits returned for pages that did not succeed. Stays 0 until the batch reaches
         #   a final status, then settles in one movement.
@@ -157,13 +164,15 @@ module ContextDev
         #   @return [Integer]
         required :reserved, Integer
 
-        # @!method initialize(net:, refunded:, reserved:)
+        # @!method initialize(net:, ocr_charged:, refunded:, reserved:)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::BatchRetrieveResponse::Credits} for more details.
         #
         #   What this batch has done to your credit balance.
         #
-        #   @param net [Integer] `reserved` minus `refunded` — what the batch has cost so far. Equal to `reserved
+        #   @param net [Integer] `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+        #
+        #   @param ocr_charged [Integer] Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered p
         #
         #   @param refunded [Integer] Credits returned for pages that did not succeed. Stays 0 until the batch reaches
         #