@weftlabs/sdk 0.25.0

package/docs/MeResponse.md

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

@@ -0,0 +1,56 @@
+
+# MeResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`principalType` | string
+`id` | number
+`name` | string
+`slug` | string
+`kind` | string
+`apiKey` | [MeApiKey](MeApiKey.md)
+`email` | string
+`displayName` | string
+`status` | string
+`buyerEnabled` | boolean
+`sellerEnabled` | boolean
+`provisioningStatus` | string
+`wallet` | [PrincipalWallet](PrincipalWallet.md)
+
+## Example
+
+```typescript
+import type { MeResponseData } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "principalType": null,
+  "id": null,
+  "name": null,
+  "slug": null,
+  "kind": null,
+  "apiKey": null,
+  "email": null,
+  "displayName": null,
+  "status": null,
+  "buyerEnabled": null,
+  "sellerEnabled": null,
+  "provisioningStatus": null,
+  "wallet": null,
+} satisfies MeResponseData
+
+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 MeResponseData
+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/MessageResponse.md

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

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

@@ -0,0 +1,39 @@
+
+# ModelError
+
+A single error inside an `ErrorResponse` envelope. `code` is the stable machine-readable identifier (snake_case), `message` is human-readable, `details` carries optional structured context (e.g. validation field breakdown), and `request_id` correlates with server logs for debugging.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`details` | object
+`requestId` | string
+
+## Example
+
+```typescript
+import type { ModelError } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": validation_failed,
+  "message": Email has already been taken,
+  "details": null,
+  "requestId": req_01HX9F3K7B2N4P8Q1R6T8Y2Z5,
+} satisfies ModelError
+
+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 ModelError
+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/Pagination.md

@@ -0,0 +1,38 @@
+
+# Pagination
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`perPage` | number
+`total` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { Pagination } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "perPage": null,
+  "total": null,
+  "totalPages": null,
+} satisfies Pagination
+
+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 Pagination
+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/PasswordResetRequest.md

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

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

@@ -0,0 +1,56 @@
+
+# Payment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`txHash` | string
+`payerAddress` | string
+`recipientAddress` | string
+`amount` | number
+`amountFormatted` | string
+`currency` | string
+`network` | string
+`resourceUrl` | string
+`resourceHost` | string
+`settlementLatencyMs` | number
+`settledAt` | Date
+`apiKeyName` | string
+
+## Example
+
+```typescript
+import type { Payment } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "txHash": null,
+  "payerAddress": null,
+  "recipientAddress": null,
+  "amount": null,
+  "amountFormatted": null,
+  "currency": null,
+  "network": null,
+  "resourceUrl": null,
+  "resourceHost": null,
+  "settlementLatencyMs": null,
+  "settledAt": null,
+  "apiKeyName": null,
+} satisfies Payment
+
+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 Payment
+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/PaymentListResponse.md

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

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

@@ -0,0 +1,154 @@
+# PaymentsApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getPayment**](PaymentsApi.md#getpayment) | **GET** /api/v1/payments/{id} | Get payment details |
+| [**listPayments**](PaymentsApi.md#listpayments) | **GET** /api/v1/payments | List payments |
+
+
+
+## getPayment
+
+> PaymentResponse getPayment(id)
+
+Get payment details
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PaymentsApi,
+} from '@weftlabs/sdk';
+import type { GetPaymentRequest } 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 PaymentsApi(config);
+
+  const body = {
+    // number | Payment ID
+    id: 56,
+  } satisfies GetPaymentRequest;
+
+  try {
+    const data = await api.getPayment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `number` | Payment ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**PaymentResponse**](PaymentResponse.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** | Payment details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Payment not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPayments
+
+> PaymentListResponse listPayments(page, perPage)
+
+List payments
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PaymentsApi,
+} from '@weftlabs/sdk';
+import type { ListPaymentsRequest } 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 PaymentsApi(config);
+
+  const body = {
+    // number | Page number (optional)
+    page: 56,
+    // number | Items per page (optional)
+    perPage: 56,
+  } satisfies ListPaymentsRequest;
+
+  try {
+    const data = await api.listPayments(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
+
+[**PaymentListResponse**](PaymentListResponse.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** | List of payments |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | The credential authenticated but has no organization context (`ORGANIZATION_REQUIRED`). Account-scoped (buyer) keys cannot read this org-scoped endpoint.  |  -  |
+
+[[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/PrincipalWallet.md

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

@@ -0,0 +1,37 @@
+
+# PromoBalance
+
+Freemium promo credit. v1 returns zero values; once the promo ledger ships (deferred from spec 10), real balances appear here without a shape change.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`balanceUsd` | string
+`scope` | string
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { PromoBalance } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "balanceUsd": 0.00,
+  "scope": weft-search,
+  "expiresAt": null,
+} satisfies PromoBalance
+
+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 PromoBalance
+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)