@weftlabs/sdk 0.25.0

package/docs/ApiKeyCreatedResponse.md

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

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

@@ -0,0 +1,408 @@
+# AuthApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**confirmAccount**](AuthApi.md#confirmaccount) | **POST** /api/v1/auth/confirm | Confirm an account |
+| [**requestPasswordReset**](AuthApi.md#requestpasswordreset) | **POST** /api/v1/auth/password/reset | Request password reset |
+| [**resendConfirmation**](AuthApi.md#resendconfirmationoperation) | **POST** /api/v1/auth/resend-confirmation | Resend confirmation email |
+| [**signIn**](AuthApi.md#signinoperation) | **POST** /api/v1/auth/sign_in | Sign in with email and password |
+| [**signUp**](AuthApi.md#signupoperation) | **POST** /api/v1/auth/sign_up | Create an account |
+| [**updatePassword**](AuthApi.md#updatepassword) | **POST** /api/v1/auth/password/update | Update password with reset token |
+
+
+
+## confirmAccount
+
+> AuthResponse confirmAccount(confirmRequest)
+
+Confirm an account
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { ConfirmAccountRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // ConfirmRequest
+    confirmRequest: ...,
+  } satisfies ConfirmAccountRequest;
+
+  try {
+    const data = await api.confirmAccount(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **confirmRequest** | [ConfirmRequest](ConfirmRequest.md) |  | |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Account confirmed |  -  |
+| **422** | Invalid token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## requestPasswordReset
+
+> MessageResponse requestPasswordReset(passwordResetRequest)
+
+Request password reset
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { RequestPasswordResetRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // PasswordResetRequest
+    passwordResetRequest: ...,
+  } satisfies RequestPasswordResetRequest;
+
+  try {
+    const data = await api.requestPasswordReset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **passwordResetRequest** | [PasswordResetRequest](PasswordResetRequest.md) |  | |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Reset email sent |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## resendConfirmation
+
+> MessageResponse resendConfirmation(resendConfirmationRequest)
+
+Resend confirmation email
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { ResendConfirmationOperationRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // ResendConfirmationRequest
+    resendConfirmationRequest: ...,
+  } satisfies ResendConfirmationOperationRequest;
+
+  try {
+    const data = await api.resendConfirmation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resendConfirmationRequest** | [ResendConfirmationRequest](ResendConfirmationRequest.md) |  | |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Confirmation sent |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## signIn
+
+> AuthResponse signIn(signInRequest)
+
+Sign in with email and password
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { SignInOperationRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // SignInRequest
+    signInRequest: ...,
+  } satisfies SignInOperationRequest;
+
+  try {
+    const data = await api.signIn(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **signInRequest** | [SignInRequest](SignInRequest.md) |  | |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Signed in |  -  |
+| **401** | Invalid credentials |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## signUp
+
+> AuthResponse signUp(signUpRequest)
+
+Create an account
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { SignUpOperationRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // SignUpRequest
+    signUpRequest: ...,
+  } satisfies SignUpOperationRequest;
+
+  try {
+    const data = await api.signUp(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **signUpRequest** | [SignUpRequest](SignUpRequest.md) |  | |
+
+### Return type
+
+[**AuthResponse**](AuthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Account created |  -  |
+| **422** | Validation error |  -  |
+| **429** | Rate limit exceeded (20 accounts/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)
+
+
+## updatePassword
+
+> MessageResponse updatePassword(passwordUpdateRequest)
+
+Update password with reset token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '@weftlabs/sdk';
+import type { UpdatePasswordRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AuthApi();
+
+  const body = {
+    // PasswordUpdateRequest
+    passwordUpdateRequest: ...,
+  } satisfies UpdatePasswordRequest;
+
+  try {
+    const data = await api.updatePassword(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **passwordUpdateRequest** | [PasswordUpdateRequest](PasswordUpdateRequest.md) |  | |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Password updated |  -  |
+| **422** | Invalid or expired reset token |  -  |
+
+[[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/AuthResponse.md

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

@@ -0,0 +1,36 @@
+
+# AuthResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | [User](User.md)
+`token` | string
+`confirmationRequired` | boolean
+
+## Example
+
+```typescript
+import type { AuthResponseData } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "token": null,
+  "confirmationRequired": null,
+} satisfies AuthResponseData
+
+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 AuthResponseData
+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/BalanceApi.md

@@ -0,0 +1,73 @@
+# BalanceApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getBalance**](BalanceApi.md#getbalance) | **GET** /api/v1/balance | Get wallet, spending policy, and current-window spend |
+
+
+
+## getBalance
+
+> BalanceResponse getBalance()
+
+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. The Base USDC balance is fetched server-side through Crossmint. If Crossmint is unreachable, the balance fields are `null`; consumers must not interpret that as zero.  Account-scoped: the bearer must be a buyer-scoped API key, an OAuth access token carrying `balance`, or a claimed `wbt_*` bearer.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BalanceApi,
+} from '@weftlabs/sdk';
+import type { GetBalanceRequest } 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 BalanceApi(config);
+
+  try {
+    const data = await api.getBalance();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### 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`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Wallet + policy + spend snapshot |  -  |
+| **401** | Unauthorized — missing or non-buyer-scoped API key |  -  |
+| **403** | The OAuth access token authenticated but lacks the `balance` scope (RFC 6750 `insufficient_scope`). Carries a `WWW-Authenticate: Bearer error=\"insufficient_scope\", scope=\"balance\"` header. `wk_` API keys are unscoped and never see this.  |  -  |
+
+[[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/BalanceResponse.md

@@ -0,0 +1,45 @@
+
+# BalanceResponse
+
+Buyer\'s wallet snapshot. Note: unlike `/me` / `/payments` / `/api_keys`, this endpoint does NOT use a `data:` envelope — the response object is the snapshot directly.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`promo` | [PromoBalance](PromoBalance.md)
+`wallet` | [Wallet](Wallet.md)
+`spentTodayUsd` | string
+`spentWeekUsd` | string
+`policyUsedTodayUsd` | string
+`policyUsedWeekUsd` | string
+`policy` | [SpendingPolicy](SpendingPolicy.md)
+
+## Example
+
+```typescript
+import type { BalanceResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "promo": null,
+  "wallet": null,
+  "spentTodayUsd": 0.0005,
+  "spentWeekUsd": 3.10,
+  "policyUsedTodayUsd": 0.30,
+  "policyUsedWeekUsd": 3.30,
+  "policy": null,
+} satisfies BalanceResponse
+
+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 BalanceResponse
+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/ConfirmRequest.md

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