synthient 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2696f98934be28fdf82de9ebc74ef028b180b804eaf314ae4e58503ffcb11ae9
+  data.tar.gz: 5135ce3a26b57f2f3058ad23d271395fdb5386537e2f3766514bc2e0905dee78
+SHA512:
+  metadata.gz: 473ce8cd208288961a5aa3cef6e49b8de98981281cb3962d4cd089eb41217f6847484f912850f328c0df248e898c64462ad4a6f22d2049864b3ee8f7a96c1222
+  data.tar.gz: f7cf2f3ec63a98f9c89adbf1fd4b2d799097bf18263934482a7bc4fc92bab15c7cd4b437b152bbf5c33f9011950cc2a838435f8011a40f609227088c58411641

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Synthient
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,420 @@
+<p align="center">
+  <a href="https://synthient.com">
+    <img src="https://raw.githubusercontent.com/synthient/synthient-ruby/main/assets/logo.svg" height="96" alt="Synthient logo">
+  </a>
+</p>
+<h3 align="center">Synthient</h3>
+<p align="center">High-fidelity data on residential proxies, VPNs, and other anonymized IPs.</p>
+<p align="center">
+  <a href="https://docs.synthient.com">Documentation</a> ·
+  <a href="https://rubydoc.info/gems/synthient">API reference</a> ·
+  <a href="https://docs.synthient.com/misc/support">Support</a>
+</p>
+
+# synthient-ruby
+
+The `synthient` gem is the official Ruby SDK for the [Synthient API](https://docs.synthient.com): IP and domain intelligence, account details, and real-time and bulk data feeds.
+
+[![Gem Version](https://img.shields.io/gem/v/synthient)](https://rubygems.org/gems/synthient)
+[![test](https://github.com/synthient/synthient-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/synthient/synthient-ruby/actions/workflows/test.yml)
+[![lint](https://github.com/synthient/synthient-ruby/actions/workflows/lint.yml/badge.svg)](https://github.com/synthient/synthient-ruby/actions/workflows/lint.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/synthient/synthient-ruby/blob/main/LICENSE)
+
+## Table of Contents
+
+- [synthient-ruby](#synthient-ruby)
+  - [SDK Installation](#sdk-installation)
+  - [Requirements](#requirements)
+  - [API Keys](#api-keys)
+  - [Authentication](#authentication)
+  - [SDK Example Usage](#sdk-example-usage)
+  - [Available Resources and Operations](#available-resources-and-operations)
+  - [Streaming](#streaming)
+  - [Pagination](#pagination)
+  - [Downloads](#downloads)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Error Handling](#error-handling)
+  - [Server Selection](#server-selection)
+  - [Custom HTTP Client](#custom-http-client)
+  - [Debugging](#debugging)
+  - [gRPC Schema](#grpc-schema)
+- [Development](#development)
+  - [Maturity](#maturity)
+  - [Contributions](#contributions)
+  - [License](#license)
+
+## SDK Installation
+
+### Bundler
+
+```sh
+bundle add synthient
+```
+
+### RubyGems
+
+```sh
+gem install synthient
+```
+
+### gRPC schema fetcher
+
+The [gRPC schema fetcher](#grpc-schema) is part of the gem but needs the `grpc` and `google-protobuf` gems:
+
+```sh
+bundle add grpc google-protobuf
+```
+
+## Requirements
+
+Ruby 3.3 or later. The gem uses only Ruby's standard library. It ships RBS signatures, so [Steep](https://github.com/soutaro/steep) can check your calls with `library "synthient"` in your Steepfile.
+
+## API Keys
+
+Every request needs a Synthient API key. Keys are issued from the Synthient dashboard; if you don't have one, [contact us](mailto:contact@synthient.com). A key's scopes decide what it can call: `BASIC` covers the lookups and `account`, and each feed has its own scopes, listed under [Feeds](#feeds).
+
+If a request fails even though you are sending a key:
+
+- **401 Unauthorized**: the key is malformed, unknown, or revoked.
+- **402 Payment Required**: the team is out of lookup credits.
+- **403 Forbidden**: the key lacks the scope for that endpoint or feed.
+
+`account` shows the key's scopes and the team's remaining credits.
+
+## Authentication
+
+This SDK supports the following security scheme:
+
+| Name      | Type    | Scheme             | Environment Variable |
+| --------- | ------- | ------------------ | -------------------- |
+| `api_key` | API key | `x-api-key` header | `SYNTHIENT_API_KEY`  |
+
+`Synthient::Client.new` reads the key from `SYNTHIENT_API_KEY`. To read it from somewhere else, such as a secret manager, pass `api_key:`:
+
+```ruby
+client = Synthient::Client.new(api_key: ENV.fetch("SYNTHIENT_PRODUCTION_KEY"))
+```
+
+Creating a client makes no network calls. To check a key, call `account`, which costs no credits.
+
+## SDK Example Usage
+
+### Look up an IP address
+
+Get the network, location, and risk intelligence for an IPv4 or IPv6 address, given as a `String` or an `IPAddr`. Each lookup costs one credit; failed lookups are free.
+
+```ruby
+require "synthient"
+
+client = Synthient::Client.new # reads SYNTHIENT_API_KEY
+
+info = client.lookup_ip("8.8.8.8")
+intelligence = info.intelligence
+puts "#{intelligence.risk_score} #{intelligence.categories.join(", ")}" if intelligence
+
+client.close
+```
+
+`network`, `location`, and `intelligence` are nil when the API has no data for them. Responses are frozen `Data` objects that support `to_h` and pattern matching.
+
+A client keeps its connections open and is safe to share between threads, so create one, reuse it, and call `close` when you are done. The examples below reuse `client`, and runnable programs are in [examples](https://github.com/synthient/synthient-ruby/tree/main/examples).
+
+### Look up many IP addresses
+
+Look up as many as 1000 addresses in one request for `ceil(n * 0.9)` credits. Private and reserved addresses are skipped and duplicates are merged, so match results by `ip`.
+
+```ruby
+results = client.lookup_ips(["8.8.8.8", "1.1.1.1"])
+results.each do |result|
+  puts "#{result.ip} #{result.intelligence&.risk_score}"
+end
+```
+
+### Look up a domain
+
+Get the honeypot traffic observed for a domain and its most recent events. Each lookup costs one credit.
+
+```ruby
+domain = client.lookup_domain("example.com", limit: 10)
+puts "#{domain.status} #{domain.stats.events_24h}"
+domain.recent_events.each do |event|
+  puts "#{event.timestamp.iso8601} #{event.target_subdomain} #{event.port}"
+end
+```
+
+### Check your account
+
+Get the key's account, scopes, and remaining lookup credits, at no cost.
+
+```ruby
+account = client.account
+puts "#{account.organization.name} #{account.scopes.join(", ")} #{account.lookup_quota.credits}"
+```
+
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [Client](https://rubydoc.info/gems/synthient/Synthient/Client)
+
+- [`lookup_ip`](https://rubydoc.info/gems/synthient/Synthient/Client#lookup_ip-instance_method) - Look up an IPv4 or IPv6 address
+- [`lookup_ips`](https://rubydoc.info/gems/synthient/Synthient/Client#lookup_ips-instance_method) - Look up as many as 1000 addresses in one request
+- [`lookup_domain`](https://rubydoc.info/gems/synthient/Synthient/Client#lookup_domain-instance_method) - Look up the honeypot traffic observed for a domain
+- [`account`](https://rubydoc.info/gems/synthient/Synthient/Client#account-instance_method) - Get the key's account, scopes, and remaining lookup credits
+- [`health`](https://rubydoc.info/gems/synthient/Synthient/Client#health-instance_method) - Check that the API and its dependencies are healthy
+
+### [Feeds](https://rubydoc.info/gems/synthient/Synthient/Feed)
+
+Each feed is a method of the client, such as `client.proxies`, and has the same methods:
+
+- [`stream`](https://rubydoc.info/gems/synthient/Synthient/Feed#stream-instance_method) - Yield the feed's real-time events
+- [`list_exports`](https://rubydoc.info/gems/synthient/Synthient/Feed#list_exports-instance_method) - List one page of the feed's Parquet exports, newest first
+- [`each_export`](https://rubydoc.info/gems/synthient/Synthient/Feed#each_export-instance_method) - Yield every export, fetching pages as needed
+- [`export_meta`](https://rubydoc.info/gems/synthient/Synthient/Feed#export_meta-instance_method) - Get an export's checksum, size, row count, and Parquet schema
+- [`download`](https://rubydoc.info/gems/synthient/Synthient/Feed#download-instance_method) - Download an export's Parquet file in chunks
+- [`download_url`](https://rubydoc.info/gems/synthient/Synthient/Feed#download_url-instance_method) - Get a presigned URL for an export's Parquet file, valid for 24 hours
+
+| Method         | Data                                          | Event type         | Stream scope            | Export scope          |
+| -------------- | --------------------------------------------- | ------------------ | ----------------------- | --------------------- |
+| `proxies`      | Residential, mobile, and datacenter proxies   | `ProxyEvent`       | `PROXY_FIREHOSE`        | `PROXY_FEEDS`         |
+| `anonymizers`  | VPN and anonymizer IP ranges                  | `AnonymizerEvent`  | `ANONYMIZERS_STREAM`    | `ANONYMIZERS_FEED`    |
+| `torrents`     | BitTorrent DHT and tracker peers              | `TorrentEvent`     | `TORRENTS_STREAM`       | `TORRENTS_FEED`       |
+| `ja4t`         | JA4T TCP fingerprints                         | `JA4TEvent`        | `JA4T_STREAM`           | `JA4T_FEED`           |
+| `helios_http`  | Helios honeypot HTTP requests                 | `HeliosHTTPEvent`  | `HONEYPOT_HTTP_STREAM`  | `HONEYPOT_HTTP_FEED`  |
+| `helios_https` | Helios honeypot TLS ClientHellos              | `HeliosHTTPSEvent` | `HONEYPOT_HTTPS_STREAM` | `HONEYPOT_HTTPS_FEED` |
+| `helios_dns`   | Helios honeypot tunnel destinations           | `HeliosDNSEvent`   | `HONEYPOT_DNS_STREAM`   | `HONEYPOT_DNS_FEED`   |
+| `helios_adb`   | Helios honeypot Android Debug Bridge commands | `HeliosADBEvent`   | `HONEYPOT_ADB_STREAM`   | `HONEYPOT_ADB_FEED`   |
+
+</details>
+
+## Streaming
+
+`stream` yields a feed's real-time events. Each call opens a connection, and breaking out of the block closes it:
+
+```ruby
+loop do
+  client.proxies.stream do |event|
+    puts "#{event.ip} #{event.provider} #{event.type}"
+  end
+rescue Synthient::APIError => e
+  raise if [401, 403].include?(e.status)
+
+  warn "proxy stream: #{e.message}"
+  # Avoid reconnecting in a tight loop.
+  sleep 2
+rescue Synthient::Error => e
+  warn "proxy stream: #{e.message}"
+  sleep 2
+end
+```
+
+- The server closes each stream after up to 30 minutes. `stream` then returns normally, and the loop reconnects at once.
+- A 401 or 403 stops the loop, because reconnecting can't fix a rejected key or a missing scope.
+- Any other failure raises a `Synthient::Error`, and the loop waits 2 seconds before reconnecting.
+- Events sent while disconnected are missed. The API has no resume cursor.
+
+Without a block, `stream` returns an `Enumerator` that connects when you iterate it.
+
+## Pagination
+
+`list_exports` returns one page of a feed's exports, newest first. Pass `page.next_cursor` as `cursor:` to get the next page; it is nil on the last one.
+
+```ruby
+page = client.proxies.list_exports(limit: 50)
+page.exports.each do |export|
+  puts "#{export.id} #{export.kind} #{export.row_count}"
+end
+```
+
+`each_export` fetches the pages for you as the block needs them:
+
+```ruby
+client.proxies.each_export do |export|
+  puts "#{export.id} #{export.kind} #{export.row_count}"
+end
+```
+
+Without a block, it returns an `Enumerator`, so `client.proxies.each_export.first(10)` fetches only the pages it needs.
+
+On the first page, the newest hourly export has the ID `"latest"`, a moving alias for the freshest export. Its `date` and `hour` give its stable ID, such as `"2026-10-14/21"`.
+
+## Downloads
+
+Exports are Parquet files. `download` yields a file's bytes in chunks as they arrive:
+
+```ruby
+File.open("proxies.parquet", "wb") do |file|
+  client.proxies.download("latest") { |chunk| file.write(chunk) }
+end
+```
+
+- Name an export by its `id` from a listing, by `"latest"`, or by a `Date` or `Time` for a UTC day or hour.
+- `export_meta` returns the file's SHA-256 `checksum`. Use a fixed ID for both calls, because `"latest"` can move between them.
+- `download_url` returns a presigned URL that works without a key for 24 hours, so treat it as a secret. Your API key is never sent to the storage host.
+- Hourly exports roll into the daily export shortly after 00:30 UTC the next day. After that, a request for the hour raises a 400.
+
+## Retries
+
+The client retries a failed request up to twice, backing off exponentially with jitter and honoring `Retry-After`:
+
+| Requests                    | Retried on                                                                                   |
+| --------------------------- | -------------------------------------------------------------------------------------------- |
+| Account and feed requests   | 500, 502, 503, and 504, most network failures, and 429 with `Retry-After`                    |
+| Billed lookups and `health` | Only 429 with `Retry-After`, which comes before any work, so a lookup is never charged twice |
+
+A 429 without `Retry-After` means the monthly request budget is spent or too many streams are open, so it is raised at once. Downloads from the storage host are never retried.
+
+Set the number of retries with `max_retries:`. Zero disables them:
+
+```ruby
+client = Synthient::Client.new(max_retries: 4)
+```
+
+## Timeouts
+
+The client sets no overall timeout, because streams and downloads are long-lived. Instead, `timeout:` limits each read or write, 60 seconds by default, and `open_timeout:` limits connecting, 10 seconds by default:
+
+```ruby
+client = Synthient::Client.new(timeout: 30, open_timeout: 5)
+```
+
+The server sends a blank keepalive line on a quiet stream about every 15 seconds, so keep `timeout:` above that. Running out of time raises `Synthient::TimeoutError`.
+
+## Error Handling
+
+A request that fails with an error status raises a [`Synthient::APIError`](https://rubydoc.info/gems/synthient/Synthient/APIError):
+
+| Attribute     | Type                          | Description                                  |
+| ------------- | ----------------------------- | -------------------------------------------- |
+| `status`      | `Integer`                     | HTTP status code, such as `404`              |
+| `type`        | `String?`                     | URI identifying the problem type             |
+| `title`       | `String?`                     | Short summary of the problem type            |
+| `detail`      | `String?`                     | Explanation of this occurrence               |
+| `errors`      | `Hash[String, Array[String]]` | Validation messages by request field         |
+| `request_id`  | `String?`                     | Request ID to give Synthient support         |
+| `retry_after` | `Numeric?`                    | Seconds the server asked you to wait, or nil |
+
+Its `message` holds only the HTTP status, so it is safe to log. The attributes hold untrusted server data.
+
+### Example
+
+```ruby
+begin
+  client.lookup_ip("8.8.8.8")
+rescue Synthient::APIError => e
+  case e.status
+  when 402
+    puts "out of lookup credits"
+  when 429
+    puts e.retry_after ? "rate limited, retry after #{e.retry_after}s" : "monthly request budget spent"
+  else
+    puts "request #{e.request_id} failed: #{e.detail || e.title}"
+  end
+end
+```
+
+### Error Types
+
+- [`Synthient::Error`](https://rubydoc.info/gems/synthient/Synthient/Error): the base class of every error the SDK raises for a failed request.
+- [`Synthient::APIError`](https://rubydoc.info/gems/synthient/Synthient/APIError): the API, or the storage host during `download`, returned an error status.
+- [`Synthient::ConnectionError`](https://rubydoc.info/gems/synthient/Synthient/ConnectionError): the request couldn't be sent or the response couldn't be read.
+- [`Synthient::TimeoutError`](https://rubydoc.info/gems/synthient/Synthient/TimeoutError): a `ConnectionError` for a connect, read, or write that ran out of time.
+- [`Synthient::DecodeError`](https://rubydoc.info/gems/synthient/Synthient/DecodeError): a successful response didn't match the API schema.
+- `ArgumentError` and `TypeError`: invalid arguments, such as a missing API key, raised before any request is sent.
+- `IOError`: the client was used after `close`.
+
+<details><summary>Status codes</summary>
+
+<br />
+
+| Status | Meaning                                                                                          |
+| ------ | ------------------------------------------------------------------------------------------------ |
+| 400    | The request is invalid, such as an hourly export that was rolled up                              |
+| 401    | The API key is malformed, unknown, or revoked                                                    |
+| 402    | The team is out of lookup credits                                                                |
+| 403    | The key lacks the scope for the endpoint or feed                                                 |
+| 404    | The export doesn't exist, or a daily export is still rolling up (`retry_after` is set)           |
+| 422    | The input is invalid, such as a private address or a malformed domain                            |
+| 429    | Rate limited if `retry_after` is set; otherwise the budget is spent or too many streams are open |
+| 5xx    | The server failed                                                                                |
+
+</details>
+
+## Server Selection
+
+### Override Server URL Per-Client
+
+The default server is `https://api.synthient.com/api/v4`. Use `base_url:` to send requests elsewhere, such as a mock server in tests:
+
+```ruby
+client = Synthient::Client.new(base_url: "http://localhost:8080/api/v4")
+```
+
+## Custom HTTP Client
+
+The client uses Ruby's `Net::HTTP` and doesn't accept a replacement. To use a proxy, set `http_proxy`:
+
+```sh
+export http_proxy=http://proxy.example.com:8080
+```
+
+- `Net::HTTP` uses `http_proxy` for HTTPS requests too and ignores `https_proxy`. `no_proxy` exempts hosts.
+- Export downloads from storage go through the same proxy.
+- `Net::HTTP`'s own retry is off, so a stale keep-alive connection never resends a billed lookup.
+
+`user_agent: "my-app/1.2"` adds your product token to the `User-Agent` header.
+
+## Debugging
+
+`response_hook:` takes any callable and calls it after every API response, including retries, pages, and stream handshakes, with a `Synthient::ResponseMetadata` holding the status, request ID, rate limit, and headers:
+
+```ruby
+client = Synthient::Client.new(
+  response_hook: lambda do |meta|
+    warn "status=#{meta.status} request_id=#{meta.request_id}"
+    limit = meta.rate_limit
+    warn "rate limit: #{limit.remaining} of #{limit.limit} left" if limit
+  end
+)
+```
+
+The hook runs on the thread that made the request, and exceptions it raises propagate to that call.
+
+> [!WARNING]
+> Response headers can contain secrets, such as presigned download URLs. Avoid logging `meta.headers` in production.
+
+## gRPC Schema
+
+[`Synthient::GRPCSchema`](https://rubydoc.info/gems/synthient/Synthient/GRPCSchema) fetches the protobuf schema of the [Synthient gRPC API](https://docs.synthient.com/grpc) through server reflection:
+
+```ruby
+require "synthient/grpcschema"
+
+begin
+  schema = Synthient::GRPCSchema.fetch # reads SYNTHIENT_API_KEY
+rescue Synthient::GRPCSchema::SchemaError => e
+  explanation = Synthient::GRPCSchema.explain(e)
+  abort explanation ? "#{explanation} #{e.message}" : e.message
+end
+schema.descriptor_set.file.each do |file|
+  puts "#{file.name} #{file.package}"
+end
+```
+
+`schema.descriptor_set` is a `Google::Protobuf::FileDescriptorSet`. `explain` describes common gRPC errors in plain language.
+
+# Development
+
+## Maturity
+
+This SDK follows [Semantic Versioning](https://semver.org). Breaking changes ship only in a new major version, so a constraint such as `gem "synthient", "~> 1.0"` never picks them up.
+
+## Contributions
+
+Bug reports and feature requests are welcome as [GitHub issues](https://github.com/synthient/synthient-ruby/issues). For questions about the API or your account, contact [Synthient support](https://docs.synthient.com/misc/support).
+
+## License
+
+[Apache 2.0](https://github.com/synthient/synthient-ruby/blob/main/LICENSE)