codeforge-main-middesk-api-sdk 1.0.0 → 1.1.0

package/README.md

@@ -4,7 +4,12 @@
 
 # codeforge-main-middesk-api-sdk
 
-Version 1.0.0
+Version 1.1.0
+
+Full generator behavior documentation: https://www.code-forge.net/docs
+
+Requires Node 20+ (or a modern browser) — the generated transport uses `AbortSignal.any`
+and `AbortSignal.timeout`.
 
 ## Install
 
@@ -125,6 +130,105 @@ operation-specific `payload` / `parameters`, and override any shared field per c
 - `getRiskAssessments`
 - `getLatestRiskAssessment`
 - `getRiskAssessment`
+- `listSubAccounts`
+- `createSubAccount`
+- `getSubAccount`
+- `updateSubAccount`
+- `listSubAccountApiKeys`
+- `createSubAccountApiKey`
+- `deleteSubAccountApiKey`
+
+## Transport
+
+Every request goes through the same transport: a per-attempt timeout, cancellation via
+`AbortSignal`, and an optional custom `fetch`.
+
+```ts
+const client = new MiddeskClient({
+	timeoutMs: 10_000, // default 60000ms, applied fresh to each retry attempt
+})
+
+const controller = new AbortController()
+setTimeout(() => controller.abort(), 5_000)
+
+await client.listBusinesses({ signal: controller.signal })
+```
+
+`timeoutMs` is per attempt, not per call — a request that times out and then retries gets a
+fresh timer on each attempt, and throws `TimeoutError` if every attempt times out. A
+caller-triggered `AbortSignal` is never retried; a timeout is, under the same rule as a
+network error. Streaming operations ignore `timeoutMs` and support only caller
+cancellation.
+
+### Custom fetch
+
+Pass a `fetch` implementation to route every request through it — a proxy included, via
+[undici](https://github.com/nodejs/undici)'s `ProxyAgent`:
+
+```ts
+import { ProxyAgent, fetch as undiciFetch } from 'undici'
+
+const dispatcher = new ProxyAgent('http://localhost:8080')
+const client = new MiddeskClient({
+	fetch: (url, init) => undiciFetch(url, { ...init, dispatcher }),
+})
+```
+
+`hooks.makeRequest` wins when both are set — it replaces the whole transport, and `fetch`
+is read only by the built-in one.
+
+### Raw requests
+
+An endpoint the generated operations don’t model is still reachable, through the same
+auth, retries, timeout and hooks:
+
+```ts
+const { data, response } = await client.get('/v1/status')
+await client.post('/v1/events', { body: { type: 'ping' } })
+
+// the general form, for a method the verb helpers don’t cover:
+await client.request({ method: 'OPTIONS', path: '/v1/status' })
+```
+
+`path` is joined onto `baseUrl` with the `URL` constructor — a leading `/` resolves from
+the origin (dropping any path segment `baseUrl` itself carries); a relative segment
+appends after it. A plain-object `body` is JSON-serialized with a JSON `Content-Type`;
+pass an already-encoded value (a `string`, `FormData`, ...) to send anything else.
+`data` parses by the response’s own `Content-Type`: JSON via `.json()`, a textual type
+via `.text()`, anything else as a `Blob`.
+
+## Errors
+
+A non-OK response throws one of these `HttpError` subclasses, picked by an exact status
+match first, then any `>= 500` response as `InternalServerError`, then plain `HttpError`
+for anything else. Every one of them is also an `instanceof HttpError`, so a catch-all
+keeps working alongside a narrower check.
+
+| Class | Status |
+| --- | --- |
+| `BadRequestError` | 400 |
+| `AuthenticationError` | 401 |
+| `PermissionDeniedError` | 403 |
+| `NotFoundError` | 404 |
+| `ConflictError` | 409 |
+| `UnprocessableEntityError` | 422 |
+| `RateLimitError` | 429 |
+| `InternalServerError` | any `>= 500` |
+
+```ts
+import { HttpError, NotFoundError } from 'codeforge-main-middesk-api-sdk'
+
+try {
+	await client.listBusinesses()
+} catch (error) {
+	if (error instanceof NotFoundError) {
+		// error.status is narrowed to 404
+	} else if (error instanceof HttpError) {
+		// any other non-OK response — error.status is number
+	}
+	throw error
+}
+```
 
 ## Validation
 
@@ -135,4 +239,4 @@ typed as the operation declares it.
 Regenerate the SDK with validation schemas turned on to get a zod schema exported beside
 every model type.
 
-> Generated by CodeForge v0.86.0.
+> Generated by CodeForge v0.86.5.