@weftlabs/sdk 0.25.0

package/docs/CreateApiKeyRequest.md

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

@@ -0,0 +1,65 @@
+# DocumentationApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getOpenApiDocument**](DocumentationApi.md#getopenapidocument) | **GET** /docs/openapi.yaml | Fetch this OpenAPI document |
+
+
+
+## getOpenApiDocument
+
+> string getOpenApiDocument()
+
+Fetch this OpenAPI document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentationApi,
+} from '@weftlabs/sdk';
+import type { GetOpenApiDocumentRequest } from '@weftlabs/sdk';
+
+async function example() {
+  console.log("🚀 Testing @weftlabs/sdk SDK...");
+  const api = new DocumentationApi();
+
+  try {
+    const data = await api.getOpenApiDocument();
+    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
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/yaml`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OpenAPI 3.1 document (YAML) |  -  |
+
+[[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/EnrolledResource.md

@@ -0,0 +1,59 @@
+
+# EnrolledResource
+
+The `:created` view of a ghost resource. Adds `stats`, the single-use `claim_token`, and the `claim_url` to the base resource shape. The claim fields appear ONLY on this enrollment response — never in list or read views.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`slug` | string
+`description` | string
+`kind` | string
+`visibility` | string
+`walletAddress` | string
+`category` | string
+`verified` | boolean
+`claimed` | boolean
+`createdAt` | Date
+`stats` | [ResourceStats](ResourceStats.md)
+`claimToken` | string
+`claimUrl` | string
+
+## Example
+
+```typescript
+import type { EnrolledResource } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "slug": null,
+  "description": null,
+  "kind": agent,
+  "visibility": public_profile,
+  "walletAddress": null,
+  "category": null,
+  "verified": null,
+  "claimed": null,
+  "createdAt": null,
+  "stats": null,
+  "claimToken": null,
+  "claimUrl": null,
+} satisfies EnrolledResource
+
+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 EnrolledResource
+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/ErrorResponse.md

@@ -0,0 +1,33 @@
+
+# ErrorResponse
+
+Standard error envelope returned by all `/api/v1` endpoints except `/search` and `/fetch` (which use bespoke envelopes carrying additional context). `error.code` is stable across releases and safe to branch on; `error.message` is human-readable and may change.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | Error
+
+## Example
+
+```typescript
+import type { ErrorResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+} satisfies ErrorResponse
+
+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 ErrorResponse
+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/Fetch403Response.md

@@ -0,0 +1,44 @@
+
+# Fetch403Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`details` | { [key: string]: any; }
+`policy` | [SpendingPolicy](SpendingPolicy.md)
+`balance` | [FetchBalanceSnapshot](FetchBalanceSnapshot.md)
+`dashboardUrl` | string
+`errorDescription` | string
+`scope` | string
+
+## Example
+
+```typescript
+import type { Fetch403Response } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": insufficient_scope,
+  "details": null,
+  "policy": null,
+  "balance": null,
+  "dashboardUrl": null,
+  "errorDescription": The access token does not include the required scope.,
+  "scope": balance,
+} satisfies Fetch403Response
+
+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 Fetch403Response
+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/FetchApi.md

@@ -0,0 +1,91 @@
+# FetchApi
+
+All URIs are relative to *https://weft.network*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**fetch**](FetchApi.md#fetchoperation) | **POST** /api/v1/fetch | Pay-and-fetch any URL (x402/MPP proxy) |
+
+
+
+## fetch
+
+> FetchResponse fetch(fetchRequest, idempotencyKey)
+
+Pay-and-fetch any URL (x402/MPP proxy)
+
+Universal x402/MPP fetch proxy. The caller provides a target `url`, a hard `max_cost_usd` ceiling, and optional `method` / `body` / `headers`. Weft:    1. Issues the request.   2. On `402 Payment Required`, selects a supported x402 or MPP challenge.   3. Compares the asking price to `max_cost_usd` and the      buyer\'s policy (`max_tx_usd`, daily/weekly limits).   4. Authorizes payment from the buyer\'s wallet on the selected rail.   5. Replays the request with the protocol-specific payment credential.   6. Streams the upstream artifact back, base64-encoded under       `body_base64`, with `paid_usd`, `held_usd`, `payment_status`,       `tx_hash`, and `protocol`. `paid_usd`      is \"0.00\" until the charge is CONFIRMED settled — a signed-but-      unsettled hold (the common case for x402, which settles      asynchronously) reports its amount in `held_usd` instead, never      in `paid_usd`.  Errors are structured with a stable `error` code, and each error response carries the buyer\'s `policy`, `balance`, and a `dashboard_url` so a CLI can render an actionable message without a second round-trip.  Account-scoped: the bearer must be a buyer-scoped API key, an OAuth access token carrying `fetch`, or a claimed `wbt_*` bearer.  **Forwarded headers:** the caller\'s `headers` are passed through to the upstream, except a denylist of hop-by-hop and Weft-internal headers (`host`, `authorization`, `cookie`, `proxy-authorization`, `x-forwarded-*`, `x-real-ip`, `x-payment`, `connection`, `upgrade`). Up to 32 headers, 4 KB of combined value bytes.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FetchApi,
+} from '@weftlabs/sdk';
+import type { FetchOperationRequest } 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 FetchApi(config);
+
+  const body = {
+    // FetchRequest
+    fetchRequest: ...,
+    // string | Opaque caller-generated retry key. Reusing the same key for the same buyer converges on one paid fetch; keys are hashed and namespaced by buyer before storage. Send this header for every unattended or retryable paid request.  (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies FetchOperationRequest;
+
+  try {
+    const data = await api.fetch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **fetchRequest** | [FetchRequest](FetchRequest.md) |  | |
+| **idempotencyKey** | `string` | Opaque caller-generated retry key. Reusing the same key for the same buyer converges on one paid fetch; keys are hashed and namespaced by buyer before storage. Send this header for every unattended or retryable paid request.  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FetchResponse**](FetchResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paid fetch succeeded; artifact streamed back base64-encoded. |  -  |
+| **401** | Unauthorized — missing or non-buyer-scoped API key |  -  |
+| **402** | Payment refused. `EXCEEDED_MAX_COST` (over the caller cap) or `INSUFFICIENT_BALANCE` (the buyer is genuinely short — `details.asset`, when present, names the exact token the failed check read). Both use `FetchErrorResponse`.  |  -  |
+| **403** | Policy violation, missing Crossmint payment permission (`PAYMENT_AUTHORIZATION_REQUIRED` — `details` carries the wallet-page URL where the authenticated user can enable payments), denylisted recipient, or a merchant challenge on a chain outside the wallet\'s own environment — a testnet wallet may not pay a mainnet challenge, nor the reverse (`WALLET_ENVIRONMENT_MISMATCH`; terminal, not retryable). All four use `FetchErrorResponse`. Alternatively an OAuth access token lacking the `fetch` scope (`InsufficientScopeResponse`, RFC 6750 `insufficient_scope`, with a `WWW-Authenticate` challenge). The two envelopes are disjoint; branch on the `error` value.  |  -  |
+| **409** | `IDEMPOTENCY_CONFLICT` — this buyer already used the supplied `Idempotency-Key` for a different fetch request. Generate a new key for the new operation; retry the original operation unchanged.  Or `WALLET_SETUP_INCOMPLETE` — the buyer\'s wallet has not been created yet, so there is nothing to pay from. `details.wallet_url` carries the page where the authenticated user finishes setup. No retry succeeds until they do.  Or `ACCOUNT_CLOSING` — account closure has started, so the wallet cannot reserve a new payment.  Or `DELIVERY_REPLAY_UNAVAILABLE` — the merchant already returned a successful response for this settled MPP payment, but Weft could not persist its bytes for replay. The merchant is not called again; `details.tx_hash` identifies the settled payment. All four use `FetchErrorResponse`.  |  -  |
+| **413** | Upstream artifact exceeded the proxy\'s size cap. |  -  |
+| **422** | Invalid request fields, method, cost, body, headers, idempotency key, or URL. `UNSUPPORTED_ASSET` means the merchant requested an asset this wallet cannot settle. `UNSUPPORTED_PAYMENT_METHOD` means the MPP challenge requested a method Weft cannot execute.  |  -  |
+| **424** | `MERCHANT_RETURNED_NON_402` — the upstream merchant is at fault: it did not return a 402, or its 402 challenge was invalid. A 4xx (not 5xx) because Weft behaved correctly and the caller should act on `details.reason` (e.g. pick another merchant); it also keeps the error envelope intact through CDNs that replace 5xx bodies.  `PAID_DELIVERY_FAILED` — the MPP payment settled, but the merchant did not deliver a successful response. `details.tx_hash` identifies the settled payment; `details.merchant_status` is present when the merchant returned an HTTP response.  |  -  |
+| **502** | Settlement signing failed on Weft\'s side (`SETTLEMENT_FAILED`). `details.reason` carries the wallet-provider sentence and `details.protocol` names the rail it failed on (`x402` or `mpp`) — a 402 may announce both, and Weft picks one, so the rail is not derivable from the merchant or the URL. Absent only when the failure happened while building the credential, which already identifies its own rail.  |  -  |
+| **504** | `MERCHANT_TIMEOUT` — the upstream merchant did not complete the challenge or paid request inside Weft\'s transport budget. `details.phase` names the request. When it is `paid`, `details.payment_may_have_moved` is true because the credential was already sent. Retry the identical operation with the same `Idempotency-Key`.  `SETTLEMENT_PENDING` — the payment was submitted and the wallet provider had not reached a terminal state before Weft\'s polling budget ran out. NOTHING is known to have failed: the charge may already have settled, so this is not `SETTLEMENT_FAILED` and the amount is not lost. `details.retry_with_same_idempotency_key` is `true`.  Retry the identical request shortly. Sending the same `Idempotency-Key` resumes the same provider operation; a caller that sends no key is also safe, because Weft resumes its own in-flight operation for the same merchant, amount and network rather than opening a second one. Either way the retry resolves the original payment instead of charging twice.  |  -  |
+
+[[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/FetchBalanceSnapshot.md

@@ -0,0 +1,41 @@
+
+# FetchBalanceSnapshot
+
+Compact balance snapshot returned inside `FetchErrorResponse`. Less rich than `BalanceResponse` — just the fields a CLI needs to explain why a fetch failed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`promoUsd` | string
+`walletUsdc` | string
+`totalUsd` | string
+`spentTodayUsd` | string
+`policyUsedTodayUsd` | string
+
+## Example
+
+```typescript
+import type { FetchBalanceSnapshot } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "promoUsd": 0.00,
+  "walletUsdc": 12.34,
+  "totalUsd": 12.34,
+  "spentTodayUsd": 0.42,
+  "policyUsedTodayUsd": 0.72,
+} satisfies FetchBalanceSnapshot
+
+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 FetchBalanceSnapshot
+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/FetchErrorResponse.md

@@ -0,0 +1,41 @@
+
+# FetchErrorResponse
+
+Bespoke error envelope for `/api/v1/fetch`. Every error carries the buyer\'s current `policy`, `balance`, and a `dashboard_url` so a CLI can render an actionable message without a second round-trip.  `error` values include the fixed codes listed below plus the `POLICY_VIOLATION_<REASON>` family, where `<REASON>` is the violated policy field (`MAX_TX`, `DAILY`, or `WEEKLY` — see `PolicyViolation::REASONS`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`details` | { [key: string]: any; }
+`policy` | [SpendingPolicy](SpendingPolicy.md)
+`balance` | [FetchBalanceSnapshot](FetchBalanceSnapshot.md)
+`dashboardUrl` | string
+
+## Example
+
+```typescript
+import type { FetchErrorResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": EXCEEDED_MAX_COST,
+  "details": null,
+  "policy": null,
+  "balance": null,
+  "dashboardUrl": null,
+} satisfies FetchErrorResponse
+
+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 FetchErrorResponse
+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/FetchRequest.md

@@ -0,0 +1,46 @@
+
+# FetchRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`maxCostUsd` | string
+`method` | string
+`body` | [FetchRequestBody](FetchRequestBody.md)
+`headers` | { [key: string]: string; }
+`searchId` | string
+`operationId` | string
+`accessMethodId` | string
+
+## Example
+
+```typescript
+import type { FetchRequest } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": https://x402.api.agentmail.to/v0/inboxes,
+  "maxCostUsd": 0.05,
+  "method": null,
+  "body": null,
+  "headers": {Accept=application/json, User-Agent=my-agent/1.0},
+  "searchId": 11111111-1111-4111-8111-111111111111,
+  "operationId": null,
+  "accessMethodId": null,
+} satisfies FetchRequest
+
+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 FetchRequest
+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/FetchRequestBody.md

@@ -0,0 +1,31 @@
+
+# FetchRequestBody
+
+Request body forwarded to the upstream. Pass `null` for GET.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FetchRequestBody } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FetchRequestBody
+
+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 FetchRequestBody
+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/FetchResponse.md

@@ -0,0 +1,49 @@
+
+# FetchResponse
+
+Successful fetch envelope. `body_base64` is the upstream artifact bytes, base64-encoded. `paid_usd`, `held_usd`, `payment_status`, `tx_hash`, and `protocol` describe the payment and settlement state.  `paid_usd` is \"0.00\" (never the nominal charge amount) until the charge is CONFIRMED settled on-chain — a signed-but-unsettled hold reports its amount in `held_usd` instead. This is a deliberate honesty fix: earlier versions of this endpoint returned the nominal amount in `paid_usd` unconditionally, even when the charge never settled.  **Money string format.** Every USD amount on this surface is exact to the micro-dollar and never narrower than two decimals: a whole-cent amount renders \"0.50\", a sub-cent amount keeps its real precision (\"0.000892\"), and zero renders \"0.00\". Amounts are never rounded — an agent reconciling its own spend reads the truth, not a display value. Parse these as decimals; do NOT compare them as strings against a bare zero literal.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | number
+`headers` | { [key: string]: string; }
+`bodyBase64` | string
+`paidUsd` | string
+`heldUsd` | string
+`paymentStatus` | string
+`txHash` | string
+`protocol` | string
+`artifactId` | number
+
+## Example
+
+```typescript
+import type { FetchResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": 200,
+  "headers": null,
+  "bodyBase64": null,
+  "paidUsd": 0.002,
+  "heldUsd": 0.002,
+  "paymentStatus": pending,
+  "txHash": null,
+  "protocol": null,
+  "artifactId": null,
+} satisfies FetchResponse
+
+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 FetchResponse
+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/InsufficientScopeResponse.md

@@ -0,0 +1,37 @@
+
+# InsufficientScopeResponse
+
+RFC 6750 §3.1 `insufficient_scope` error. Returned with HTTP 403 and a `WWW-Authenticate: Bearer error=\"insufficient_scope\", scope=\"...\"` header when an OAuth access token authenticates successfully but does not carry the scope the endpoint requires. Only OAuth bearer tokens are scope-gated; `wk_`-prefixed API keys are unscoped and never see this response.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`errorDescription` | string
+`scope` | string
+
+## Example
+
+```typescript
+import type { InsufficientScopeResponse } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": insufficient_scope,
+  "errorDescription": The access token does not include the required scope.,
+  "scope": balance,
+} satisfies InsufficientScopeResponse
+
+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 InsufficientScopeResponse
+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/MeApiKey.md

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

@@ -0,0 +1,37 @@
+
+# MeApiKeyCreator
+
+The user who minted this API key, surfaced for audit rendering only. `null` if that user has since left the Organization. NEVER use for authorization.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`email` | string
+`displayName` | string
+
+## Example
+
+```typescript
+import type { MeApiKeyCreator } from '@weftlabs/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "displayName": null,
+} satisfies MeApiKeyCreator
+
+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 MeApiKeyCreator
+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)