@weftlabs/sdk 0.25.0

package/docs/SearchApi.md

@@ -0,0 +1,86 @@
+# SearchApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**search**](SearchApi.md#searchoperation) | **POST** /api/v1/search | Search the Weft index |
+
+
+
+## search
+
+> SearchResponse search(searchRequest)
+
+Search the Weft index
+
+Semantic search over the Weft index of paid agent resources. The request body is the weft-search-platform `/v1/search` contract: a free-text `query`, optional `max_results`, and optional structured `filters` (price / price_atomic / type / protocol — the canonical FilterSpec v1 vocabulary, vendored verbatim from the platform). Price is a dual representation of one constraint: `price` in USD decimal strings (the reasoning form) XOR `price_atomic` in integer micro-USD (the settlement form) — mutually exclusive, set at most one.  Account-scoped: the bearer token must be a buyer-scoped API key, an OAuth token carrying `search`, or a pending or claimed `wbt_*` bootstrap bearer. Pending bootstrap access uses an anonymous bootstrap identity; after claim, the promoted bearer uses its bound User. Rejection, cancellation, expiry, and revocation end bootstrap search. Bootstrap search is limited to 60 requests per credential and 120 per IP each hour before native credential promotion.  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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SearchApi,
+} from '@weftlabs/sdk';
+import type { SearchOperationRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const config = new Configuration({
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SearchApi(config);
+
+  const body = {
+    // SearchRequest
+    searchRequest: ...,
+  } satisfies SearchOperationRequest;
+
+  try {
+    const data = await api.search(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **searchRequest** | [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`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Search results |  -  |
+| **401** | Unauthorized — missing or non-buyer-scoped API key |  -  |
+| **403** | The OAuth access token authenticated but lacks the `search` scope (RFC 6750 `insufficient_scope`). Carries a `WWW-Authenticate: Bearer error=\"insufficient_scope\", scope=\"search\"` header. `wk_` API keys are unscoped and never see this.  |  -  |
+| **406** | The requested response format is not JSON or Markdown. |  -  |
+| **422** | Invalid request — empty/missing `query`, out-of-range `max_results`, an unknown top-level parameter, or invalid `filters` (unknown filter key/operator, bad enum value, or a sub-filter without exactly one operator). See the `error` code.  |  -  |
+| **429** | Bootstrap search rate limit exceeded |  -  |
+| **502** | Search service unavailable |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCapabilityRef.md

@@ -0,0 +1,34 @@
+
+# SearchCapabilityRef
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`capabilityId` | string
+`capabilityType` | string
+
+## Example
+
+```typescript
+import type { SearchCapabilityRef } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "capabilityId": null,
+  "capabilityType": null,
+} satisfies SearchCapabilityRef
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCapabilityRef
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCuratedCallability.md

@@ -0,0 +1,34 @@
+
+# SearchCuratedCallability
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`missing` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchCuratedCallability } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "missing": null,
+} satisfies SearchCuratedCallability
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCuratedCallability
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCuratedExecution.md

@@ -0,0 +1,32 @@
+
+# SearchCuratedExecution
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mode` | string
+
+## Example
+
+```typescript
+import type { SearchCuratedExecution } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mode": null,
+} satisfies SearchCuratedExecution
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCuratedExecution
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCuratedOperation.md

@@ -0,0 +1,36 @@
+
+# SearchCuratedOperation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { SearchCuratedOperation } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+} satisfies SearchCuratedOperation
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCuratedOperation
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCuratedService.md

@@ -0,0 +1,34 @@
+
+# SearchCuratedService
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { SearchCuratedService } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+} satisfies SearchCuratedService
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCuratedService
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchCuratedSource.md

@@ -0,0 +1,36 @@
+
+# SearchCuratedSource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`catalog` | string
+`snapshotVersion` | number
+`capturedAt` | Date
+
+## Example
+
+```typescript
+import type { SearchCuratedSource } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "catalog": null,
+  "snapshotVersion": null,
+  "capturedAt": null,
+} satisfies SearchCuratedSource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchCuratedSource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchEndpointCall.md

@@ -0,0 +1,39 @@
+
+# SearchEndpointCall
+
+The machine-readable call contract for this endpoint: the verb, the provider-declared argument schema, and the worked examples. Always present; an endpoint whose provider declares nothing carries an empty `method` and null members rather than an absent block, so a caller can always read `input_schema` without a presence check. Combine with the hit\'s `url` to construct the request.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`method` | string
+`inputSchema` | object
+`exampleRequest` | object
+`exampleResponse` | any
+
+## Example
+
+```typescript
+import type { SearchEndpointCall } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "inputSchema": null,
+  "exampleRequest": null,
+  "exampleResponse": null,
+} satisfies SearchEndpointCall
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchEndpointCall
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchEndpointHit.md

@@ -0,0 +1,74 @@
+
+# SearchEndpointHit
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`endpointId` | string
+`url` | string
+`resourceType` | string
+`primaryProtocol` | string
+`call` | [SearchEndpointCall](SearchEndpointCall.md)
+`price` | [SearchEndpointPrice](SearchEndpointPrice.md)
+`payment` | [Array<SearchPaymentOffer>](SearchPaymentOffer.md)
+`accessMethods` | [Array<SearchAccessMethod>](SearchAccessMethod.md)
+`service` | [SearchCuratedService](SearchCuratedService.md)
+`operation` | [SearchCuratedOperation](SearchCuratedOperation.md)
+`outputSchema` | object
+`output` | object
+`execution` | [SearchCuratedExecution](SearchCuratedExecution.md)
+`callability` | [SearchCuratedCallability](SearchCuratedCallability.md)
+`compatibility` | object
+`source` | [SearchCuratedSource](SearchCuratedSource.md)
+`operatorType` | string
+`operatedById` | string
+`settledViaFacilitatorId` | string
+`settlements` | number
+`lastVerifiedAt` | Date
+`latencyP50Ms` | number
+
+## Example
+
+```typescript
+import type { SearchEndpointHit } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "endpointId": null,
+  "url": null,
+  "resourceType": null,
+  "primaryProtocol": null,
+  "call": null,
+  "price": null,
+  "payment": null,
+  "accessMethods": null,
+  "service": null,
+  "operation": null,
+  "outputSchema": null,
+  "output": null,
+  "execution": null,
+  "callability": null,
+  "compatibility": null,
+  "source": null,
+  "operatorType": null,
+  "operatedById": null,
+  "settledViaFacilitatorId": null,
+  "settlements": null,
+  "lastVerifiedAt": null,
+  "latencyP50Ms": null,
+} satisfies SearchEndpointHit
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchEndpointHit
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchEndpointPrice.md

@@ -0,0 +1,41 @@
+
+# SearchEndpointPrice
+
+Price + provenance + freshness for this (endpoint × capability) pairing. Always present; an unpriced endpoint carries null amounts rather than an absent block, so a caller never has to distinguish \"free\" from \"we do not know\".
+
+## Properties
+
+Name | Type
+------------ | -------------
+`indexedUsd` | string
+`atomic` | number
+`source` | string
+`lastObservedAt` | Date
+`liveVerified` | boolean
+
+## Example
+
+```typescript
+import type { SearchEndpointPrice } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "indexedUsd": null,
+  "atomic": null,
+  "source": null,
+  "lastObservedAt": null,
+  "liveVerified": null,
+} satisfies SearchEndpointPrice
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchEndpointPrice
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchErrorResponse.md

@@ -0,0 +1,35 @@
+
+# SearchErrorResponse
+
+Bespoke error envelope returned by `/api/v1/search` for `422`, `502`, and `500` responses. It differs from the standard `ErrorResponse` envelope (no nested `code`/`message`/`request_id`); SDK clients should handle both shapes for this endpoint until the controller is migrated to the standard envelope.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`details` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SearchErrorResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "details": null,
+} satisfies SearchErrorResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchErrorResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchExecutionModeFilter.md

@@ -0,0 +1,34 @@
+
+# SearchExecutionModeFilter
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`eq` | string
+`_in` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchExecutionModeFilter } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "eq": null,
+  "_in": null,
+} satisfies SearchExecutionModeFilter
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchExecutionModeFilter
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchFilterSpec.md

@@ -0,0 +1,49 @@
+
+# SearchFilterSpec
+
+Structured hard constraints on the query — the weft-search-platform `FilterSpec` v1 typed subset, vendored verbatim (D1 contract). Every field is optional; an empty object is the no-filter query. Set fields are ANDed. Each sub-filter takes exactly one operator; unknown filter keys and unknown operators are rejected (`422 INVALID_FILTERS`).  `price` (USD decimal strings) and `price_atomic` (integer micro-USD) are two representations of ONE price constraint — the reasoning form and the settlement form. They are MUTUALLY EXCLUSIVE: setting both is `422 INVALID_FILTERS`. A JSON number in `price` is rejected (only decimal strings), so `{lte: 5}` can never be mis-read as 5 micro-dollars.  The canonical enum value sets are pinned to the platform spec by the CI drift gate (`docs/contracts/search-platform.openapi.yaml`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`price` | [SearchPriceUsdFilter](SearchPriceUsdFilter.md)
+`priceAtomic` | [SearchPriceAtomicFilter](SearchPriceAtomicFilter.md)
+`type` | [SearchResourceTypeFilter](SearchResourceTypeFilter.md)
+`protocol` | [SearchProtocolFilter](SearchProtocolFilter.md)
+`category` | [SearchStringSetFilter](SearchStringSetFilter.md)
+`method` | [SearchMethodFilter](SearchMethodFilter.md)
+`executionMode` | [SearchExecutionModeFilter](SearchExecutionModeFilter.md)
+`weftFetchCompatible` | boolean
+`includeUnknownPrices` | boolean
+
+## Example
+
+```typescript
+import type { SearchFilterSpec } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "price": null,
+  "priceAtomic": null,
+  "type": null,
+  "protocol": null,
+  "category": null,
+  "method": null,
+  "executionMode": null,
+  "weftFetchCompatible": null,
+  "includeUnknownPrices": null,
+} satisfies SearchFilterSpec
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchFilterSpec
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchMethodFilter.md

@@ -0,0 +1,34 @@
+
+# SearchMethodFilter
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`eq` | string
+`_in` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchMethodFilter } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "eq": null,
+  "_in": null,
+} satisfies SearchMethodFilter
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchMethodFilter
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SearchPaymentOffer.md

@@ -0,0 +1,47 @@
+
+# SearchPaymentOffer
+
+One settlement route the endpoint\'s own 402 challenge published — a (rail × network × asset × payee) tuple a caller can settle against directly with its own SDK.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`protocol` | string
+`scheme` | string
+`network` | string
+`asset` | string
+`amount` | string
+`payTo` | string
+`maxTimeoutSeconds` | number
+`facilitator` | string
+
+## Example
+
+```typescript
+import type { SearchPaymentOffer } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "protocol": null,
+  "scheme": null,
+  "network": null,
+  "asset": null,
+  "amount": null,
+  "payTo": null,
+  "maxTimeoutSeconds": null,
+  "facilitator": null,
+} satisfies SearchPaymentOffer
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SearchPaymentOffer
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)