weft-sdk 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e775cf997288fdba0aa7f683151c65e424094c00372d8c9e5d2ea208b3bc612c
-  data.tar.gz: 1d3037ce451839110db577f5868e46da4752f3747e2f3127efc0a1c9056077a6
+  metadata.gz: 2e058e7cf838e956dce96d330b50c6b1cf78bdcd0d1a2448343e3211141a8a1c
+  data.tar.gz: 0ebc49eccbf10a9253303c7db8a17f824a75e8ca5fdc33d2dc9f78b5772447cf
 SHA512:
-  metadata.gz: 5c3280da4ac8d59787603f338d18d467f63c232a8d4822f403932e7358fc5037c398ece7d680eb629a6e34f4a67699c235786700d38a681393cb9844fd6d9942
-  data.tar.gz: 63acc6a32fede26c10ef7ba55b759d8a90924857b225baf40ead7eed36105e25a81b7ad39d7a2d64911b26c6dc90bd9d9df4ee5ea4ab2b3df359a093d5e60735
+  metadata.gz: 15dad9aa192c0489e4c49102504ef2b49ce113de6f27e5e901f97c75cb24fd4cd34b9260ddb0818e931da7c71fb91b439e74fcc181bb770caf71aa6becb21056
+  data.tar.gz: dee0eef998b860af12b5aea5e0e950266e0549bb68b0509e76ece7d66f0d1ed90e177a427ee3a62db024ae2ec1e441a3300fd9f5e8edc7bba574db3e46236d32

data/docs/ApiKeyListResponse.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Array<ApiKey>**](ApiKey.md) |  |  |
+| **pagination** | [**Pagination**](Pagination.md) |  |  |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'weft-sdk'
 
 instance = Weft::ApiKeyListResponse.new(
-  data: null
+  data: null,
+  pagination: null
 )
 ```
 

data/docs/BalanceApi.md

@@ -0,0 +1,74 @@
+# Weft::BalanceApi
+
+All URIs are relative to *https://api.weftlabs.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_balance**](BalanceApi.md#get_balance) | **GET** /api/v1/balance | Get wallet, spending policy, and current-window spend |
+
+
+## get_balance
+
+> <BalanceResponse> get_balance
+
+Get wallet, spending policy, and current-window spend
+
+Read-only snapshot for the buyer behind the bearer token. The response always includes a `promo` block — values are zero in v1 and fill in once the freemium promo ledger ships, without a shape change. `wallet.balance_usdc` is fetched live from Privy; if Privy is unreachable the field returns `\"0.00\"` rather than erroring the whole call.  Account-scoped: the bearer must be a buyer-scoped API key. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'weft-sdk'
+# setup authorization
+Weft.configure do |config|
+  # Configure Bearer authorization (APIKey): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Weft::BalanceApi.new
+
+begin
+  # Get wallet, spending policy, and current-window spend
+  result = api_instance.get_balance
+  p result
+rescue Weft::ApiError => e
+  puts "Error when calling BalanceApi->get_balance: #{e}"
+end
+```
+
+#### Using the get_balance_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BalanceResponse>, Integer, Hash)> get_balance_with_http_info
+
+```ruby
+begin
+  # Get wallet, spending policy, and current-window spend
+  data, status_code, headers = api_instance.get_balance_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceResponse>
+rescue Weft::ApiError => e
+  puts "Error when calling BalanceApi->get_balance_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BalanceResponse**](BalanceResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BalanceResponse.md

@@ -0,0 +1,26 @@
+# Weft::BalanceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promo** | [**PromoBalance**](PromoBalance.md) |  |  |
+| **wallet** | [**Wallet**](Wallet.md) |  |  |
+| **spent_today_usd** | **String** | USD spent in the current calendar day (UTC), 2dp. |  |
+| **spent_week_usd** | **String** | USD spent in the current calendar week (UTC, Monday start), 2dp. |  |
+| **policy** | [**SpendingPolicy**](SpendingPolicy.md) |  |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::BalanceResponse.new(
+  promo: null,
+  wallet: null,
+  spent_today_usd: 0.42,
+  spent_week_usd: 3.10,
+  policy: null
+)
+```
+

data/docs/DefaultApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://api.weftlabs.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_api_docs**](DefaultApi.md#get_api_docs) | **GET** /api/v1/docs | Fetch OpenAPI spec |
+| [**get_open_api_document**](DefaultApi.md#get_open_api_document) | **GET** /docs/openapi.yaml | Fetch this OpenAPI document |
 
 
-## get_api_docs
+## get_open_api_document
 
-> String get_api_docs
+> String get_open_api_document
 
-Fetch OpenAPI spec
+Fetch this OpenAPI document
 
 ### Examples
 
@@ -22,29 +22,29 @@ require 'weft-sdk'
 api_instance = Weft::DefaultApi.new
 
 begin
-  # Fetch OpenAPI spec
-  result = api_instance.get_api_docs
+  # Fetch this OpenAPI document
+  result = api_instance.get_open_api_document
   p result
 rescue Weft::ApiError => e
-  puts "Error when calling DefaultApi->get_api_docs: #{e}"
+  puts "Error when calling DefaultApi->get_open_api_document: #{e}"
 end
 ```
 
-#### Using the get_api_docs_with_http_info variant
+#### Using the get_open_api_document_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(String, Integer, Hash)> get_api_docs_with_http_info
+> <Array(String, Integer, Hash)> get_open_api_document_with_http_info
 
 ```ruby
 begin
-  # Fetch OpenAPI spec
-  data, status_code, headers = api_instance.get_api_docs_with_http_info
+  # Fetch this OpenAPI document
+  data, status_code, headers = api_instance.get_open_api_document_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => String
 rescue Weft::ApiError => e
-  puts "Error when calling DefaultApi->get_api_docs_with_http_info: #{e}"
+  puts "Error when calling DefaultApi->get_open_api_document_with_http_info: #{e}"
 end
 ```
 

data/docs/Error.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** |  |  |
-| **message** | **String** |  |  |
-| **details** | **Object** |  | [optional] |
-| **request_id** | **String** |  | [optional] |
+| **code** | **String** | Stable machine-readable error code (snake_case). |  |
+| **message** | **String** | Human-readable error description. |  |
+| **details** | **Object** | Optional structured context about the failure. | [optional] |
+| **request_id** | **String** | Correlates with server logs; include when reporting bugs. | [optional] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'weft-sdk'
 
 instance = Weft::Error.new(
-  code: null,
-  message: null,
+  code: validation_failed,
+  message: Email has already been taken,
   details: null,
-  request_id: null
+  request_id: req_01HX9F3K7B2N4P8Q1R6T8Y2Z5
 )
 ```
 

data/docs/FetchApi.md

@@ -0,0 +1,77 @@
+# Weft::FetchApi
+
+All URIs are relative to *https://api.weftlabs.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**fetch**](FetchApi.md#fetch) | **POST** /api/v1/fetch | Pay-and-fetch any URL (x402 proxy) |
+
+
+## fetch
+
+> <FetchResponse> fetch(fetch_request)
+
+Pay-and-fetch any URL (x402 proxy)
+
+Universal x402 fetch proxy. The caller provides a target `url`, a hard `max_cost_usd` ceiling, and optional `method` / `body` / `headers`. Weft:    1. Issues the request.   2. On `402 Payment Required`, parses the merchant's challenge.   3. Compares the asking price to `max_cost_usd` and the      buyer's policy (`max_tx_usd`, daily/weekly limits).   4. Signs an EIP-3009 transfer from the buyer's wallet.   5. Replays the request with the `X-Payment` header.   6. Streams the upstream artifact back, base64-encoded under      `body_base64`, with `paid_usd`, `tx_hash`, and the      merchant's reputation snapshot.  Errors are structured with a stable `error` code, and each error response carries the buyer's `policy`, `balance`, and a `dashboard_url` so a CLI can render an actionable message without a second round-trip.  Account-scoped: the bearer must be a buyer-scoped API key.  **Forwarded headers:** the caller's `headers` are passed through to the upstream, except a denylist of hop-by-hop and Weft-internal headers (`host`, `authorization`, `cookie`, `proxy-authorization`, `x-forwarded-*`, `x-real-ip`, `x-payment`, `connection`, `upgrade`). Up to 32 headers, 4 KB of combined value bytes. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'weft-sdk'
+# setup authorization
+Weft.configure do |config|
+  # Configure Bearer authorization (APIKey): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Weft::FetchApi.new
+fetch_request = Weft::FetchRequest.new({url: 'https://x402.api.agentmail.to/v0/inboxes'}) # FetchRequest | 
+
+begin
+  # Pay-and-fetch any URL (x402 proxy)
+  result = api_instance.fetch(fetch_request)
+  p result
+rescue Weft::ApiError => e
+  puts "Error when calling FetchApi->fetch: #{e}"
+end
+```
+
+#### Using the fetch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FetchResponse>, Integer, Hash)> fetch_with_http_info(fetch_request)
+
+```ruby
+begin
+  # Pay-and-fetch any URL (x402 proxy)
+  data, status_code, headers = api_instance.fetch_with_http_info(fetch_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FetchResponse>
+rescue Weft::ApiError => e
+  puts "Error when calling FetchApi->fetch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fetch_request** | [**FetchRequest**](FetchRequest.md) |  |  |
+
+### Return type
+
+[**FetchResponse**](FetchResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FetchBalanceSnapshot.md

@@ -0,0 +1,22 @@
+# Weft::FetchBalanceSnapshot
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **promo_usd** | **String** |  |  |
+| **wallet_usdc** | **String** |  |  |
+| **spent_today_usd** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::FetchBalanceSnapshot.new(
+  promo_usd: 0.00,
+  wallet_usdc: 12.34,
+  spent_today_usd: 0.42
+)
+```
+

data/docs/FetchErrorResponse.md

@@ -0,0 +1,26 @@
+# Weft::FetchErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Stable error code. |  |
+| **details** | **Hash<String, Object>** | Optional context. Shape varies by error code. |  |
+| **policy** | [**SpendingPolicy**](SpendingPolicy.md) |  |  |
+| **balance** | [**FetchBalanceSnapshot**](FetchBalanceSnapshot.md) |  |  |
+| **dashboard_url** | **String** | Deep-link to the dashboard's policy page. |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::FetchErrorResponse.new(
+  error: EXCEEDED_MAX_COST,
+  details: null,
+  policy: null,
+  balance: null,
+  dashboard_url: null
+)
+```
+

data/docs/FetchRequest.md

@@ -0,0 +1,26 @@
+# Weft::FetchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Target URL. Must pass Weft's URL safety check (no SSRF / private IP ranges). |  |
+| **max_cost_usd** | **String** | Hard ceiling on what the buyer is willing to pay. Defaults to `0.10` USD. | [optional][default to '0.10'] |
+| **method** | **String** | HTTP method to use against the upstream. | [optional][default to 'GET'] |
+| **body** | [**FetchRequestBody**](FetchRequestBody.md) |  | [optional] |
+| **headers** | **Hash<String, String>** | Headers forwarded to the upstream. Up to 32 headers, 4 KB total. The following are silently stripped: `host`, `authorization`, `cookie`, `proxy-authorization`, `x-forwarded-*`, `x-real-ip`, `x-payment`, `connection`, `upgrade`.  | [optional] |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::FetchRequest.new(
+  url: https://x402.api.agentmail.to/v0/inboxes,
+  max_cost_usd: 0.05,
+  method: null,
+  body: null,
+  headers: {Accept=application/json, User-Agent=my-agent/1.0}
+)
+```
+

data/docs/FetchRequestBody.md

@@ -0,0 +1,49 @@
+# Weft::FetchRequestBody
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'weft-sdk'
+
+Weft::FetchRequestBody.openapi_one_of
+# =>
+# [
+#   :'Object',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'weft-sdk'
+
+Weft::FetchRequestBody.build(data)
+# => #<Object:0x00007fdd4aab02a0>
+
+Weft::FetchRequestBody.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Object`
+- `String`
+- `nil` (if no type matches)
+

data/docs/FetchResponse.md

@@ -0,0 +1,30 @@
+# Weft::FetchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **Integer** | HTTP status returned by the upstream after the paid replay. |  |
+| **headers** | **Hash<String, String>** | Response headers from the upstream. |  |
+| **body_base64** | **String** | Base64-encoded response body. Empty string for empty bodies. |  |
+| **paid_usd** | **String** | USD amount actually settled. Null for free upstreams. |  |
+| **tx_hash** | **String** | Settlement transaction hash. Null for free upstreams. |  |
+| **artifact_id** | **String** | Internal artifact identifier if the response was persisted. |  |
+| **merchant** | [**Merchant**](Merchant.md) | Merchant reputation snapshot. Null for free upstreams. |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::FetchResponse.new(
+  status: 200,
+  headers: null,
+  body_base64: null,
+  paid_usd: 0.002,
+  tx_hash: null,
+  artifact_id: null,
+  merchant: null
+)
+```
+

data/docs/Merchant.md

@@ -0,0 +1,24 @@
+# Weft::Merchant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | **String** | EVM address that received the payment. |  |
+| **settlement_count** | **Integer** | All-time settlement count for this merchant address. |  |
+| **first_seen_at** | **Time** | First time Weft observed a payment to this address. |  |
+| **dispute_count** | **Integer** | All-time dispute count for this merchant address. |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::Merchant.new(
+  address: null,
+  settlement_count: null,
+  first_seen_at: null,
+  dispute_count: null
+)
+```
+

data/docs/PromoBalance.md

@@ -0,0 +1,22 @@
+# Weft::PromoBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance_usd** | **String** |  |  |
+| **scope** | **String** | Where the promo can be spent. |  |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::PromoBalance.new(
+  balance_usd: 0.00,
+  scope: weft-search,
+  expires_at: null
+)
+```
+

data/docs/SearchAgentCard.md

@@ -0,0 +1,34 @@
+# Weft::SearchAgentCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **protocol_version** | **String** |  | [optional] |
+| **capabilities** | **Hash<String, Object>** |  | [optional] |
+| **default_input_modes** | **Array<String>** |  | [optional] |
+| **default_output_modes** | **Array<String>** |  | [optional] |
+| **skills** | [**Array<SearchSkill>**](SearchSkill.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::SearchAgentCard.new(
+  name: null,
+  description: null,
+  url: null,
+  version: null,
+  protocol_version: null,
+  capabilities: null,
+  default_input_modes: null,
+  default_output_modes: null,
+  skills: null
+)
+```
+

data/docs/SearchApi.md

@@ -0,0 +1,77 @@
+# Weft::SearchApi
+
+All URIs are relative to *https://api.weftlabs.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**search**](SearchApi.md#search) | **POST** /api/v1/search | Search the Weft index |
+
+
+## search
+
+> <SearchResponse> search(search_request)
+
+Search the Weft index
+
+Semantic search over the Weft index of paid agent resources. The request body carries a free-text `query`, an optional `limit`, and an optional `filters` object that narrows by price band, payment protocol, agent protocol, or domain tag. Filters are applied as a post-filter after the embedding score is computed.  Backend selection is server-side via the `SEARCH_BACKEND` env var: `mock` (default, reads YAML fixtures and sets `_mock: true` in the response) or `platform` (proxies to the upstream search service). Both backends return the same envelope.  Account-scoped: the bearer token must be a buyer-scoped API key. Free for authenticated buyers in v1; billing is planned for a later release.  Response negotiation: `Accept: application/json` (default) returns the structured envelope; `Accept: text/markdown` returns a rendered Markdown digest of the same results — useful for piping into a chat UI or LLM prompt. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'weft-sdk'
+# setup authorization
+Weft.configure do |config|
+  # Configure Bearer authorization (APIKey): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Weft::SearchApi.new
+search_request = Weft::SearchRequest.new({query: 'send email from an agent'}) # SearchRequest | 
+
+begin
+  # Search the Weft index
+  result = api_instance.search(search_request)
+  p result
+rescue Weft::ApiError => e
+  puts "Error when calling SearchApi->search: #{e}"
+end
+```
+
+#### Using the search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchResponse>, Integer, Hash)> search_with_http_info(search_request)
+
+```ruby
+begin
+  # Search the Weft index
+  data, status_code, headers = api_instance.search_with_http_info(search_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchResponse>
+rescue Weft::ApiError => e
+  puts "Error when calling SearchApi->search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_request** | [**SearchRequest**](SearchRequest.md) |  |  |
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, text/markdown
+

data/docs/SearchEndpoints.md

@@ -0,0 +1,24 @@
+# Weft::SearchEndpoints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **a2a** | **String** |  | [optional] |
+| **mcp** | **String** |  | [optional] |
+| **openapi** | **String** | URL to the agent's OpenAPI document. | [optional] |
+| **weft_fetch_target** | **String** | Base URL the `weft_fetch` MCP tool should target for this agent. | [optional] |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::SearchEndpoints.new(
+  a2a: null,
+  mcp: null,
+  openapi: null,
+  weft_fetch_target: null
+)
+```
+

data/docs/SearchErrorResponse.md

@@ -0,0 +1,20 @@
+# Weft::SearchErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Stable error code. |  |
+| **details** | **Hash<String, Object>** | Optional context. Shape varies by error code. | [optional] |
+
+## Example
+
+```ruby
+require 'weft-sdk'
+
+instance = Weft::SearchErrorResponse.new(
+  error: null,
+  details: null
+)
+```
+