quicknode_sdk 0.1.0.pre.alpha.30-arm64-darwin → 0.2.0-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca47000f499548721392daba3eb202f4c9f62e68321d1c4e7a9ff27606c33e5e
-  data.tar.gz: aa5ab13290b1fd8bf40e6acfccca50d733a57240a3d8f571e84f04086f1b0c68
+  metadata.gz: 731055e0f33dbdcce951cc7ba34b2716d77d10ec4e54944f34209bb9f4cbb7a1
+  data.tar.gz: ee8f6a32939e6ec7d5f29459939716017c3d79d2581a3b0da4945ef5710c16a9
 SHA512:
-  metadata.gz: 83e4e8610a3cde96623565b78a8e9fb7ec633aad8529f26326a9cde8b07b5781aad84c245abb4747a10e32f7faf40f6f9b1b3e56614c95bf72a2b82628b145bf
-  data.tar.gz: 5a160492ac8bce3d3ff9c531a4b2577bdd23c07093ba9c134e4ac1f319347c1242045ae457d429cf8d6eb16adddcc0f7839c2ab1470477edbd7157b09043d10c
+  metadata.gz: a234e1b45fbbeabbc6a1ff4d9d38a7aec0f86991b984145829e179a954a902af79ed9ca9006ca2ce7d30e5cbda792cc1cf7f389740c0e6e9feb023340b3e8271
+  data.tar.gz: a4e158b5299cd826eb0a667cff6e13c73317c5cf6e6f736f51c9ef5481cc3a707c919b60455af3f79d3b146e41b59e24bebf1ce288c9a8bdd876b8c4cac993bd

data/README.md

@@ -4,6 +4,8 @@ Ruby bindings for the Quicknode SDK.
 
 This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quicknode/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process.
 
+> **Pre-1.0**: While on `0.x`, releases may contain breaking changes. Check the [release notes](https://github.com/quicknode/sdk/releases) before upgrading.
+
 ## Table of Contents
 
 - [Installation](#installation)
@@ -137,7 +139,9 @@ Snippets assume `qn` was already constructed via the Quick Start. Optional param
 
 ### Language conventions
 
-- Methods are **blocking** (not async). Parameters are a single Hash with symbol keys. Responses that carry data are returned as a `Hash` with indifferent access — `resp[:data]` and `resp["data"]` both work. Unknown parameter keys raise `ArgumentError`.
+- Methods are **blocking** (not async). Parameters are a single Hash with symbol keys. Unknown parameter keys raise `ArgumentError`.
+- **Response shape.** Every method that returns data returns a `QuicknodeSdk::IndifferentHash` — a plain `Hash` subclass with `Hashie::Extensions::IndifferentAccess`. Access values with `resp[:data]`, `resp["data"]`, or `resp.dig(:data, :id)`. Nested hashes and arrays are wrapped recursively, so symbol or string keys work at every level. **Dot accessors (`resp.data.id`) do not work** — there is no `MethodAccess` extension on this class. Use `[]` or `dig`.
+- **Pagination key naming differs across products** because the underlying APIs do. Admin list endpoints return `resp[:pagination]` (`{ total, limit, offset }`); streams and webhooks list endpoints return `resp[:pageInfo]` (same shape, camelCase). Per-method `**Returns**` blocks note which one applies.
 
 ---
 
@@ -833,13 +837,13 @@ Returns the rate-limit rows currently enforced on the endpoint, each identifying
 
 **Parameters**: `id` (endpoint id, required).
 
-**Returns**: `GetRateLimitsResponse` (as a `Hashie::Mash`) with `data.rate_limits: Array<RateLimitEntry>`.
+**Returns**: `GetRateLimitsResponse` (as an `IndifferentHash`) with `data[:rate_limits]: Array<RateLimitEntry>`.
 
 ```ruby
 # Ruby
 resp = qn.admin.get_rate_limits(id: "123")
-resp.data.rate_limits.each do |row|
-  puts "#{row.bucket} #{row.rate_limit} #{row.source} #{row.id}"
+resp.dig(:data, :rate_limits)&.each do |row|
+  puts "#{row[:bucket]} #{row[:rate_limit]} #{row[:source]} #{row[:id]}"
 end
 ```
 
@@ -864,14 +868,14 @@ Returns the HTTP and WebSocket URLs for the endpoint without fetching the full e
 
 **Parameters**: `id` (endpoint id, required).
 
-**Returns**: `GetEndpointUrlsResponse` (as a `Hashie::Mash`) with `data.http_url`, `data.wss_url`, and `data.multichain_urls`.
+**Returns**: `GetEndpointUrlsResponse` (as an `IndifferentHash`) with `data[:http_url]`, `data[:wss_url]`, and `data[:multichain_urls]`.
 
 ```ruby
 # Ruby
 resp = qn.admin.get_endpoint_urls(id: "123")
-puts resp.data.http_url
-resp.data.multichain_urls&.each do |network, urls|
-  puts "#{network} #{urls.http_url}"
+puts resp.dig(:data, :http_url)
+resp.dig(:data, :multichain_urls)&.each do |network, urls|
+  puts "#{network} #{urls[:http_url]}"
 end
 ```
 
@@ -883,7 +887,7 @@ Returns metric series for an endpoint over a time period.
 
 **Parameters**: `id` (endpoint id, required); body: `period` (`"hour"` | `"day"` | `"week"` | `"month"`), `metric` (e.g. `"method_calls_over_time"`, `"response_status_breakdown"`).
 
-**Returns**: `GetEndpointMetricsResponse` (as a `Hashie::Mash`) with `data: Array<EndpointMetric>`. Each `EndpointMetric` has `tag: Array<String>` and `data: Array<Array<Integer>>` of `[timestamp, value]` pairs. Single-axis series (e.g. `response_time_over_time` with a percentile) come back as a one-element tag like `["p95"]`; multi-axis series come back as `["network", "arbitrum-mainnet"]`.
+**Returns**: `GetEndpointMetricsResponse` (as an `IndifferentHash`) with `data: Array<EndpointMetric>`. Each `EndpointMetric` has `tag: Array<String>` and `data: Array<Array<Integer>>` of `[timestamp, value]` pairs. Single-axis series (e.g. `response_time_over_time` with a percentile) come back as a one-element tag like `["p95"]`; multi-axis series come back as `["network", "arbitrum-mainnet"]`.
 
 ```ruby
 # Ruby
@@ -900,7 +904,7 @@ Returns account-level metric series. Supports an optional `percentile` (e.g. `"p
 
 **Parameters**: `period` (required), `metric` (required), `percentile` (string, optional).
 
-**Returns**: `GetAccountMetricsResponse` (as a `Hashie::Mash`) with `data: Array<EndpointMetric>`. See `get_endpoint_metrics` above for the `tag: Array<String>` shape.
+**Returns**: `GetAccountMetricsResponse` (as an `IndifferentHash`) with `data: Array<EndpointMetric>`. See `get_endpoint_metrics` above for the `tag: Array<String>` shape.
 
 ```ruby
 # Ruby
@@ -1010,13 +1014,13 @@ resp = qn.admin.list_tags
 
 Renames an account-level tag.
 
-**Parameters**: `tag_id` (i32, required); body: `label` (string, required).
+**Parameters**: `id` (i32, required — the tag id); body: `label` (string, required).
 
 **Returns**: `RenameTagResponse` with updated `AccountTag`.
 
 ```ruby
 # Ruby
-resp = qn.admin.rename_tag(tag_id: 42, label: "staging")
+resp = qn.admin.rename_tag(id: 42, label: "staging")
 ```
 
 ##### `delete_account_tag` / `deleteAccountTag`
@@ -1032,6 +1036,24 @@ Deletes a tag from the account. The tag must first be removed from any endpoints
 qn.admin.delete_account_tag(id: 42)
 ```
 
+#### Tag / delete method parameter quick-reference
+
+The pattern across the Admin client: `id:` always names the **parent** resource. The child resource takes its own `<child>_id:`. The two account-level tag operations collapse to a single `id:` (the tag id) because there is no parent endpoint.
+
+| Method | Required keys |
+|---|---|
+| `delete_tag` (per-endpoint) | `id:` (endpoint id), `tag_id:` |
+| `delete_account_tag` | `id:` (tag id) |
+| `rename_tag` | `id:` (tag id), `label:` |
+| `delete_token` | `id:` (endpoint id), `token_id:` |
+| `delete_referrer` | `id:`, `referrer_id:` |
+| `delete_ip` | `id:`, `ip_id:` |
+| `delete_domain_mask` | `id:`, `domain_mask_id:` |
+| `delete_jwt` | `id:`, `jwt_id:` |
+| `delete_method_rate_limit` | `id:`, `method_rate_limit_id:` |
+| `delete_request_filter` | `id:`, `request_filter_id:` |
+| `delete_rate_limit_override` | `id:`, `override_id:` |
+
 ---
 
 ### Streams Client
@@ -1048,20 +1070,16 @@ Enums used across stream methods:
 - **`FilterLanguage`**: `Javascript`, `Go`, `Wasm`.
 - **`StreamMetadataLocation`**: `Body`, `Header`, `None`.
 
-Destinations are expressed via `DestinationAttributes`. Each variant wraps an attribute struct:
+Destinations are expressed via `DestinationAttributes`. Each variant wraps an attribute struct. On returned `Stream` records, `destination_attributes` is **flat** (no `attributes:` nesting) — access fields directly with `resp.dig(:destination_attributes, :url)`.
+
 
 | Variant | Struct | Key fields |
 |---|---|---|
 | `Webhook` | `WebhookAttributes` | `url`, `max_retry`, `retry_interval_sec`, `post_timeout_sec`, `compression`, `security_token?` |
 | `S3` | `S3Attributes` | `endpoint`, `access_key`, `secret_key`, `bucket`, `object_prefix`, `compression`, `file_type`, `max_retry`, `retry_interval_sec`, `use_ssl?` |
 | `Azure` | `AzureAttributes` | `storage_account`, `sas_token`, `container`, `compression`, `file_type`, `max_retry`, `retry_interval_sec`, `blob_prefix?` |
-| `Postgres` | `PostgresAttributes` | `host`, `port`, `username`, `password`, `database`, `schema`, `table`, `max_retry`, `retry_interval_sec`, `use_ssl?` |
-| `Mysql` | `MysqlAttributes` | `host`, `port`, `username`, `password`, `database`, `table`, `max_retry`, `retry_interval_sec`, `use_ssl?` |
-| `Mongo` | `MongoAttributes` | `connection_string`, `database`, `collection`, `max_retry`, `retry_interval_sec` |
-| `Clickhouse` | `ClickhouseAttributes` | `host`, `port`, `username`, `password`, `database`, `table`, `max_retry`, `retry_interval_sec`, `use_ssl?` |
-| `Snowflake` | `SnowflakeAttributes` | `account`, `warehouse`, `database`, `schema`, `table`, `username`, `private_key`, `max_retry`, `retry_interval_sec` |
-| `Kafka` | `KafkaAttributes` | `bootstrap_servers`, `topic`, `compression`, `max_retry`, `retry_interval_sec` |
-| `Redis` | `RedisAttributes` | `host`, `port`, `username`, `password`, `key`, `max_retry`, `retry_interval_sec`, `use_ssl?` |
+| `Postgres` | `PostgresAttributes` | `host`, `port?` (default `5432`), `username`, `password`, `database`, `table_name`, `sslmode`, `max_retry?`, `retry_interval_sec?` |
+| `Kafka` | `KafkaAttributes` | `bootstrap_servers`, `topic_name`, `compression_type`, `batch_size?`, `linger_ms?`, `max_message_bytes?`, `timeout_sec?`, `max_retry?`, `retry_interval_sec?`, `username?`, `password?`, `protocol?`, `mechanisms?` |
 
 Wrapper naming per language:
 
@@ -1109,7 +1127,7 @@ Paginated list of streams on the account.
 
 **Parameters** (all optional): `offset` (i64), `limit` (i64), `order_by` (string), `order_direction` (`"asc"` | `"desc"`), `stream_type` (string).
 
-**Returns**: `ListStreamsResponse` with `data: Stream[]` and `page_info`.
+**Returns**: `ListStreamsResponse` with `data: Stream[]` and `pageInfo` (camelCase on the wire — access as `resp[:pageInfo][:total]`).
 
 ```ruby
 # Ruby
@@ -1250,7 +1268,7 @@ Accessed as `qn.webhooks`. Creates webhooks from filter templates and manages th
 | Factory | Argument struct | Fields |
 |---|---|---|
 | `evm_wallet_filter` | `EvmWalletFilterTemplate` | `wallets: string[]` |
-| `evm_contract_events` | `EvmContractEventsTemplate` | `contracts: string[]`, `event_hashes?: string[]` |
+| `evm_contract_events` | `EvmContractEventsTemplate` | `contracts: string[]`, `eventHashes?: string[]` (camelCase — `event_hashes` is rejected by the API) |
 | `evm_abi_filter` | `EvmAbiFilterTemplate` | `abi: string` (JSON), `contracts: string[]` |
 | `solana_wallet_filter` | `SolanaWalletFilterTemplate` | `accounts: string[]` |
 | `bitcoin_wallet_filter` | `BitcoinWalletFilterTemplate` | `wallets: string[]` |
@@ -1262,7 +1280,7 @@ Accessed as `qn.webhooks`. Creates webhooks from filter templates and manages th
 
 `WebhookStartFrom`: `Last` (resume from last delivered block) or `Latest` (start from newest).
 
-In Ruby, `template_args` is passed as a JSON string under the key `template_args_json`; destination is passed as a JSON string under `destination_attributes_json`.
+In Ruby, `template_args` is passed as a JSON string under the key `template_args_json` on every template-aware method. The destination is passed as a JSON string under `destination_attributes_json` on `create_webhook_from_template` and `update_webhook`. **`update_webhook_template` cannot change the destination** — it accepts only `webhook_id`, `template_args_json`, `name?`, and `notification_email?`.
 
 #### Webhooks methods
 
@@ -1333,9 +1351,9 @@ webhook = qn.webhooks.update_webhook(id: "wh-1", name: "Renamed Webhook")
 
 ##### `update_webhook_template` / `updateWebhookTemplate`
 
-Updates the template args (and optionally name, email, destination) on an existing template-backed webhook.
+Updates the template args (and optionally name and notification email) on an existing template-backed webhook. The destination cannot be changed after creation — to point a webhook at a new URL or storage backend, create a new one.
 
-**Parameters**: `webhook_id` (required), `template_args` (required); optional: `name`, `notification_email`, `destination_attributes`.
+**Parameters**: `webhook_id` (required), `template_args_json` (required — JSON string); optional: `name`, `notification_email`.
 
 **Returns**: updated `Webhook`.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quicknode_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.30
+  version: 0.2.0
 platform: arm64-darwin
 authors:
 - Quicknode
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-27 00:00:00.000000000 Z
+date: 2026-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie