codeforge-main-middesk-api-sdk 1.0.0

package/README.md

@@ -0,0 +1,138 @@
+> **Unofficial SDK** — generated from @codeforge-main/middesk-api-sdk's public OpenAPI specification by the [CodeForge platform](https://www.code-forge.net). Not affiliated with or endorsed by @codeforge-main/middesk-api-sdk.
+
+---
+
+# codeforge-main-middesk-api-sdk
+
+Version 1.0.0
+
+## Install
+
+```bash
+npm install codeforge-main-middesk-api-sdk
+```
+
+```bash
+yarn add codeforge-main-middesk-api-sdk
+```
+
+```bash
+pnpm add codeforge-main-middesk-api-sdk
+```
+
+## Usage
+
+This SDK is exposed as a single, fully typed client class. Construct it once with your
+shared configuration and call any API operation as a method — each returns the deserialized
+response alongside HTTP metadata.
+
+```ts
+import { MiddeskClient } from 'codeforge-main-middesk-api-sdk'
+
+const client = new MiddeskClient({
+	baseUrl: 'https://api.middesk.com',
+	auth: { type: 'bearer', token: 'YOUR_API_TOKEN' },
+})
+
+const response = await client.listBusinesses()
+
+console.log(response.status) // HTTP status code
+console.log(response.data)   // typed as ListBusinessesResponse
+```
+
+The client holds the shared configuration (`baseUrl`, `auth`, `retry`, `hooks`).
+Each method accepts a per-call context extending `HttpClientContext` — supply the
+operation-specific `payload` / `parameters`, and override any shared field per call.
+
+### Available operations
+
+- `listBusinesses`
+- `createBusiness`
+- `getBusiness`
+- `updateBusiness`
+- `getBusinessPdf`
+- `listOrders`
+- `createOrder`
+- `getOrder`
+- `getOrderById`
+- `updateOrder`
+- `listBusinessBatches`
+- `createBusinessBatch`
+- `getBusinessBatch`
+- `getBusinessBatchCsv`
+- `listSignals`
+- `createSignal`
+- `getSignal`
+- `getBusinessMonitor`
+- `createBusinessMonitor`
+- `updateBusinessMonitor`
+- `deleteBusinessMonitor`
+- `bulkDisableMonitors`
+- `listLiens`
+- `createLien`
+- `createLienFilingsInBatch`
+- `createRegistration`
+- `createLienTermination`
+- `listBusinessPolicyResults`
+- `getBusinessReview`
+- `listActions`
+- `createAction`
+- `getAction`
+- `getTinMatchAvailability`
+- `getBusinessWebsite`
+- `listConnections`
+- `getBusinessTimeline`
+- `listRegistrationRequests`
+- `createRegistrationRequest`
+- `getRegistrationRequest`
+- `deleteRegistrationRequest`
+- `getRegistrationRequestGuestDashboard`
+- `listInformationRequests`
+- `createApplication`
+- `createCompany`
+- `searchJurisdictions`
+- `listJurisdictions`
+- `listQuestions`
+- `listMailItems`
+- `getMailItem`
+- `updateMailItem`
+- `listAgents`
+- `getAgent`
+- `listAgentThreads`
+- `createAgentThread`
+- `getAgentThread`
+- `listAgentRuns`
+- `createAgentRun`
+- `getAgentRun`
+- `submitAgentRunFeedback`
+- `streamAgentRunEvents`
+- `autocompleteBusinessIdentities`
+- `business`
+- `listWebhooks`
+- `createWebhook`
+- `getWebhook`
+- `updateWebhook`
+- `deleteWebhook`
+- `listWebhookEventSchemas`
+- `createWebhookEventSchema`
+- `getWebhookEventSchema`
+- `updateWebhookEventSchema`
+- `deleteWebhookEventSchema`
+- `getOidcKeys`
+- `listDocuments`
+- `getDocument`
+- `getDocumentDownloadUrl`
+- `getRiskAssessments`
+- `getLatestRiskAssessment`
+- `getRiskAssessment`
+
+## Validation
+
+Every model is plain data — the shape it has on the wire. This SDK carries no schemas and
+no runtime dependency, so nothing is validated for you: `response.data` is the parsed body
+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.