@firmenakte/api-client 2.11.8 → 2.22.0

package/README.md

@@ -39,6 +39,33 @@ controller.abort();
 await request;
 ```
 
+## v2
+
+The v2 API is the subpath `@firmenakte/api-client/v2`; the package's root export stays v1. Its
+client has one method per operation, named by the operation's `operationId` in the
+[v2 reference](https://docs.firmenakte.at/openapi-v2.json):
+
+```ts
+import { createApiClient, isApiError } from "@firmenakte/api-client/v2";
+
+const client = createApiClient({ apiKey: process.env.FIRMENAKTE_KEY });
+const { data: company, response } = await client.getCompany({ path: { id: "fnr:56247t" } });
+console.log(company.name, response.headers.get("X-Credits-Charged"));
+
+try {
+  await client.getCompany({ path: { id: "fnr:999999x" } });
+} catch (error) {
+  if (!isApiError(error)) throw error; // no answer: network failure, timeout or abort
+  console.log(error.status, error.problem?.detail);
+}
+```
+
+Each method takes `{ path, query, body, headers }` as the operation defines them, plus any `fetch`
+option such as `signal`; path parameters are encoded for you. A 2xx answer resolves with
+`{ data, request, response }`. Anything else rejects with an `ApiError`: `status`, the problem JSON
+as `problem`, and the `response`. File downloads (`getExportFile`, `getDocumentContent`,
+`getLicenseExtract`) take `parseAs: "blob"` or `"stream"`.
+
 ## Credits and rate limits
 
 API calls use your account's weekly credits, shared across all its keys. Free includes 50,