@weftlabs/sdk 0.25.0

package/docs/Purchase.md

@@ -0,0 +1,58 @@
+
+# Purchase
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`status` | string
+`amountUsd` | string
+`recipientAddress` | string
+`network` | string
+`protocol` | string
+`context` | string
+`txHash` | string
+`rejectReason` | string
+`failureReason` | string
+`idempotencyKey` | string
+`signedAt` | Date
+`settledAt` | Date
+`artifact` | [PurchaseArtifact](PurchaseArtifact.md)
+
+## Example
+
+```typescript
+import type { Purchase } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "amountUsd": null,
+  "recipientAddress": null,
+  "network": null,
+  "protocol": null,
+  "context": null,
+  "txHash": null,
+  "rejectReason": null,
+  "failureReason": null,
+  "idempotencyKey": null,
+  "signedAt": null,
+  "settledAt": null,
+  "artifact": null,
+} satisfies Purchase
+
+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 Purchase
+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/PurchaseArtifact.md

@@ -0,0 +1,38 @@
+
+# PurchaseArtifact
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`merchantUrl` | string
+`bytes` | number
+`mime` | string
+
+## Example
+
+```typescript
+import type { PurchaseArtifact } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "merchantUrl": null,
+  "bytes": null,
+  "mime": null,
+} satisfies PurchaseArtifact
+
+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 PurchaseArtifact
+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/PurchaseListResponse.md

@@ -0,0 +1,34 @@
+
+# PurchaseListResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Purchase>](Purchase.md)
+`pagination` | [Pagination](Pagination.md)
+
+## Example
+
+```typescript
+import type { PurchaseListResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "pagination": null,
+} satisfies PurchaseListResponse
+
+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 PurchaseListResponse
+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/PurchaseResponse.md

@@ -0,0 +1,32 @@
+
+# PurchaseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Purchase](Purchase.md)
+
+## Example
+
+```typescript
+import type { PurchaseResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies PurchaseResponse
+
+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 PurchaseResponse
+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/PurchasesApi.md

@@ -0,0 +1,157 @@
+# PurchasesApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getPurchase**](PurchasesApi.md#getpurchase) | **GET** /api/v1/purchases/{id} | Get a buyer purchase |
+| [**listPurchases**](PurchasesApi.md#listpurchases) | **GET** /api/v1/purchases | List buyer purchases |
+
+
+
+## getPurchase
+
+> PurchaseResponse getPurchase(id)
+
+Get a buyer purchase
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PurchasesApi,
+} from '@weftlabs/sdk';
+import type { GetPurchaseRequest } 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 PurchasesApi(config);
+
+  const body = {
+    // number | Purchase ID
+    id: 56,
+  } satisfies GetPurchaseRequest;
+
+  try {
+    const data = await api.getPurchase(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | Purchase ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**PurchaseResponse**](PurchaseResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Buyer purchase details |  -  |
+| **401** | Unauthorized — missing or non-buyer-scoped credential |  -  |
+| **403** | OAuth token lacks the `balance` scope. |  -  |
+| **404** | Purchase not found or owned by another buyer |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPurchases
+
+> PurchaseListResponse listPurchases(page, perPage)
+
+List buyer purchases
+
+Returns the authenticated buyer\'s signing and settlement ledger. Unlike `/api/v1/payments`, this endpoint is User-scoped and backed by `signed_events`, so rejected and pending attempts are included.  Scoped to the buyer\'s own merchant spend, matching the dashboard\'s Purchases page. Internal signings are excluded: historical refill self-transfers (`rebalance`) and operator signings (`manual`) are not payments the buyer made and never appear here.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PurchasesApi,
+} from '@weftlabs/sdk';
+import type { ListPurchasesRequest } 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 PurchasesApi(config);
+
+  const body = {
+    // number | Page number (optional)
+    page: 56,
+    // number | Items per page (optional)
+    perPage: 56,
+  } satisfies ListPurchasesRequest;
+
+  try {
+    const data = await api.listPurchases(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
+| **perPage** | `number` | Items per page | [Optional] [Defaults to `25`] |
+
+### Return type
+
+[**PurchaseListResponse**](PurchaseListResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Buyer purchase ledger |  -  |
+| **401** | Unauthorized — missing or non-buyer-scoped credential |  -  |
+| **403** | OAuth token lacks the `balance` scope. |  -  |
+
+[[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/RateLimitResponse.md

@@ -0,0 +1,34 @@
+
+# RateLimitResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`errorDescription` | string
+
+## Example
+
+```typescript
+import type { RateLimitResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "errorDescription": null,
+} satisfies RateLimitResponse
+
+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 RateLimitResponse
+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/ResendConfirmationRequest.md

@@ -0,0 +1,32 @@
+
+# ResendConfirmationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+
+## Example
+
+```typescript
+import type { ResendConfirmationRequest } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+} satisfies ResendConfirmationRequest
+
+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 ResendConfirmationRequest
+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/ResourceEnrollmentRequest.md

@@ -0,0 +1,39 @@
+
+# ResourceEnrollmentRequest
+
+`slug` and `category` are accepted but silently ignored — the server generates the slug from `name`, and category is a post-claim concern.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | string
+`name` | string
+`description` | string
+`walletAddress` | string
+
+## Example
+
+```typescript
+import type { ResourceEnrollmentRequest } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": agent,
+  "name": Self-Enrolled Bot,
+  "description": null,
+  "walletAddress": null,
+} satisfies ResourceEnrollmentRequest
+
+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 ResourceEnrollmentRequest
+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/ResourceEnrollmentResponse.md

@@ -0,0 +1,32 @@
+
+# ResourceEnrollmentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [EnrolledResource](EnrolledResource.md)
+
+## Example
+
+```typescript
+import type { ResourceEnrollmentResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ResourceEnrollmentResponse
+
+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 ResourceEnrollmentResponse
+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/ResourceStats.md

@@ -0,0 +1,45 @@
+
+# ResourceStats
+
+Aggregate public payment stats for the resource.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalPaid` | number
+`totalReceived` | number
+`paymentsMade` | number
+`paymentsReceived` | number
+`uniqueCounterparties` | number
+`firstSeen` | Date
+`lastActive` | Date
+
+## Example
+
+```typescript
+import type { ResourceStats } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalPaid": null,
+  "totalReceived": null,
+  "paymentsMade": null,
+  "paymentsReceived": null,
+  "uniqueCounterparties": null,
+  "firstSeen": null,
+  "lastActive": null,
+} satisfies ResourceStats
+
+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 ResourceStats
+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/ResourcesApi.md

@@ -0,0 +1,77 @@
+# ResourcesApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**enrollResource**](ResourcesApi.md#enrollresource) | **POST** /api/v1/resources/enroll | Self-enroll a ghost resource (public, no auth) |
+
+
+
+## enrollResource
+
+> ResourceEnrollmentResponse enrollResource(resourceEnrollmentRequest)
+
+Self-enroll a ghost resource (public, no auth)
+
+Lets an unauthenticated agent (or its operator) self-enroll a Resource as a \"ghost\" (no owning provider). The server generates the `slug` and a single-use `claim_token`; the response also carries a `claim_url` the agent hands to its human controller to claim the resource from the dashboard.  Client-supplied `slug` and `category` are silently ignored: slugs are server-generated from `name` (so callers cannot squat on reserved names), and `category` is a post-claim concern set by a real human.  Rate-limited to 10 enrollments/hour/IP.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ResourcesApi,
+} from '@weftlabs/sdk';
+import type { EnrollResourceRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new ResourcesApi();
+
+  const body = {
+    // ResourceEnrollmentRequest
+    resourceEnrollmentRequest: ...,
+  } satisfies EnrollResourceRequest;
+
+  try {
+    const data = await api.enrollResource(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resourceEnrollmentRequest** | [ResourceEnrollmentRequest](ResourceEnrollmentRequest.md) |  | |
+
+### Return type
+
+[**ResourceEnrollmentResponse**](ResourceEnrollmentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Ghost resource created |  -  |
+| **422** | Validation error (missing/blank fields, or unknown `kind`) |  -  |
+| **429** | Rate limit exceeded (10 enrollments/hour/IP) |  -  |
+
+[[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/SearchAccessMethod.md

@@ -0,0 +1,52 @@
+
+# SearchAccessMethod
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessMethodId` | string
+`protocol` | string
+`scheme` | string
+`network` | string
+`asset` | string
+`assetDecimals` | number
+`price` | object
+`merchant` | object
+`terms` | object
+`status` | string
+`weftFetch` | [SearchWeftFetchCompatibility](SearchWeftFetchCompatibility.md)
+
+## Example
+
+```typescript
+import type { SearchAccessMethod } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessMethodId": null,
+  "protocol": null,
+  "scheme": null,
+  "network": null,
+  "asset": null,
+  "assetDecimals": null,
+  "price": null,
+  "merchant": null,
+  "terms": null,
+  "status": null,
+  "weftFetch": null,
+} satisfies SearchAccessMethod
+
+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 SearchAccessMethod
+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)