@weftlabs/sdk 0.25.0

package/docs/AccountApi.md

@@ -0,0 +1,72 @@
+# AccountApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMe**](AccountApi.md#getme) | **GET** /api/v1/me | Get the current credential principal |
+
+
+
+## getMe
+
+> MeResponse getMe()
+
+Get the current credential principal
+
+Returns the seller Organization represented by an `ax_live_*` resource key, or the buyer User represented by a `wk_*` account key, OAuth access token, or claimed `wbt_*` bearer. Branch on `data.principal_type`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AccountApi,
+} from '@weftlabs/sdk';
+import type { GetMeRequest } 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 AccountApi(config);
+
+  try {
+    const data = await api.getMe();
+    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
+
+[**MeResponse**](MeResponse.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** | Current Organization or User principal |  -  |
+| **401** | Unauthorized |  -  |
+
+[[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/AccountBootstrapApproval.md

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

@@ -0,0 +1,44 @@
+
+# AccountBootstrapCreated
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`capabilities` | Set<string>
+`expiresAt` | Date
+`approval` | [AccountBootstrapCreatedApproval](AccountBootstrapCreatedApproval.md)
+`temporaryApiKey` | string
+`deviceCode` | string
+
+## Example
+
+```typescript
+import type { AccountBootstrapCreated } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "capabilities": null,
+  "expiresAt": null,
+  "approval": null,
+  "temporaryApiKey": null,
+  "deviceCode": null,
+} satisfies AccountBootstrapCreated
+
+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 AccountBootstrapCreated
+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/AccountBootstrapCreatedApproval.md

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

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

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

@@ -0,0 +1,40 @@
+
+# AccountBootstrapStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`capabilities` | Set<string>
+`expiresAt` | Date
+`approval` | [AccountBootstrapApproval](AccountBootstrapApproval.md)
+
+## Example
+
+```typescript
+import type { AccountBootstrapStatus } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "capabilities": null,
+  "expiresAt": null,
+  "approval": null,
+} satisfies AccountBootstrapStatus
+
+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 AccountBootstrapStatus
+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/AccountBootstrapStatusResponse.md

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

@@ -0,0 +1,43 @@
+
+# AccountDetails
+
+The Organization that owns the authenticated API key — the principal in API v1 (the key represents an Org, not a person). `api_key` carries audit info about the key itself, including the user who minted it (`created_by`, which may be `null` if that user has left the Org).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`principalType` | string
+`id` | number
+`name` | string
+`slug` | string
+`kind` | string
+`apiKey` | [MeApiKey](MeApiKey.md)
+
+## Example
+
+```typescript
+import type { AccountDetails } 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,
+} satisfies AccountDetails
+
+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 AccountDetails
+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/AgentBootstrapApi.md

@@ -0,0 +1,223 @@
+# AgentBootstrapApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelAccountBootstrap**](AgentBootstrapApi.md#cancelaccountbootstrap) | **DELETE** /api/v1/account_bootstraps/{id} | Cancel or revoke a bootstrap credential |
+| [**createAccountBootstrap**](AgentBootstrapApi.md#createaccountbootstrap) | **POST** /api/v1/account_bootstraps | Create a temporary agent bootstrap |
+| [**getAccountBootstrap**](AgentBootstrapApi.md#getaccountbootstrap) | **GET** /api/v1/account_bootstraps/{id} | Read bootstrap lifecycle status |
+
+
+
+## cancelAccountBootstrap
+
+> AccountBootstrapStatusResponse cancelAccountBootstrap(id)
+
+Cancel or revoke a bootstrap credential
+
+A pending bootstrap becomes rejected. A claimed promoted credential becomes revoked and fails every subsequent request immediately.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentBootstrapApi,
+} from '@weftlabs/sdk';
+import type { CancelAccountBootstrapRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const config = new Configuration({
+    // Configure HTTP bearer authorization: bootstrapAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AgentBootstrapApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies CancelAccountBootstrapRequest;
+
+  try {
+    const data = await api.cancelAccountBootstrap(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AccountBootstrapStatusResponse**](AccountBootstrapStatusResponse.md)
+
+### Authorization
+
+[bootstrapAuth](../README.md#bootstrapAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rejected or revoked terminal lifecycle status |  -  |
+| **401** | Unknown ID or non-matching bootstrap credential |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createAccountBootstrap
+
+> AccountBootstrapCreatedResponse createAccountBootstrap(accountBootstrapRequest)
+
+Create a temporary agent bootstrap
+
+Creates a 30-minute, search-only bootstrap and emails a separate claim link to the supplied address. Human approval binds the same `wbt_*` bearer to the account and promotes it to the fixed durable capability set. The response is deliberately identical for new and existing account emails and never contains the claim token. Rate limits apply per IP and normalized email; request bodies over 4 KiB are rejected before parsing. The bootstrap row and one-time credentials are committed only after the mail relay accepts the claim email. A retryable 503 leaves no bootstrap row behind.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentBootstrapApi,
+} from '@weftlabs/sdk';
+import type { CreateAccountBootstrapRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new AgentBootstrapApi();
+
+  const body = {
+    // AccountBootstrapRequest
+    accountBootstrapRequest: ...,
+  } satisfies CreateAccountBootstrapRequest;
+
+  try {
+    const data = await api.createAccountBootstrap(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountBootstrapRequest** | [AccountBootstrapRequest](AccountBootstrapRequest.md) |  | |
+
+### Return type
+
+[**AccountBootstrapCreatedResponse**](AccountBootstrapCreatedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Bootstrap created after the claim email is accepted for delivery |  -  |
+| **503** | Claim email delivery is temporarily unavailable; no bootstrap was created and the request may be retried |  * Retry-After - Suggested delay before retrying, in seconds. <br>  |
+| **413** | Request body exceeds the 4 KiB limit |  -  |
+| **422** | Invalid bootstrap context |  -  |
+| **429** | Rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getAccountBootstrap
+
+> AccountBootstrapStatusResponse getAccountBootstrap(id)
+
+Read bootstrap lifecycle status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentBootstrapApi,
+} from '@weftlabs/sdk';
+import type { GetAccountBootstrapRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const config = new Configuration({
+    // Configure HTTP bearer authorization: bootstrapAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AgentBootstrapApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies GetAccountBootstrapRequest;
+
+  try {
+    const data = await api.getAccountBootstrap(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AccountBootstrapStatusResponse**](AccountBootstrapStatusResponse.md)
+
+### Authorization
+
+[bootstrapAuth](../README.md#bootstrapAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current lifecycle and polling guidance while the credential can authenticate |  -  |
+| **401** | Unknown ID or non-matching bootstrap credential |  -  |
+
+[[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/ApiKey.md

@@ -0,0 +1,42 @@
+
+# ApiKey
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`keyPrefix` | string
+`lastUsedAt` | Date
+`revokedAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKey } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "keyPrefix": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+  "createdAt": null,
+} satisfies ApiKey
+
+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 ApiKey
+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/ApiKeyCreated.md

@@ -0,0 +1,40 @@
+
+# ApiKeyCreated
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`keyPrefix` | string
+`rawKey` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKeyCreated } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "keyPrefix": null,
+  "rawKey": null,
+  "createdAt": null,
+} satisfies ApiKeyCreated
+
+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 ApiKeyCreated
+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)