@zinn-digital/sdk 0.0.0-stage → 0.1.1347

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Neil Lock — CEO, Zinn Digital® Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# @zinn-digital/sdk — TypeScript client for the Zinn Digital Platform API
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A fully typed client for the [Zinn Digital](https://zinndigital.com/developers/sdk-typescript) public API. Every path,
+parameter and response type is generated from the platform's OpenAPI specification, and a new version is
+published automatically whenever the specification changes.
+
+```bash
+npm install @zinn-digital/sdk
+```
+
+```ts
+import { createApiClient } from "@zinn-digital/sdk";
+
+const api = createApiClient({ baseUrl: "https://api.zinndigital.com" });
+
+// Public catalogue endpoints need no key.
+const { data: regions } = await api.GET("/v1/catalog/regions");
+
+// Everything else uses a per-organisation API key (create one on the dashboard's API keys page).
+api.use({
+  onRequest: ({ request }) => {
+    request.headers.set("Authorization", `Bearer ${process.env.ZINN_API_KEY}`);
+  },
+});
+const { data: sites, error } = await api.GET("/v1/sites");
+```
+
+The client is [openapi-fetch](https://openapi-ts.dev/openapi-fetch); `components`, `paths` and
+`operations` types are exported for your own code (`import type { components } from "@zinn-digital/sdk"`).
+
+- Guide: https://zinndigital.com/developers/sdk-typescript
+- API reference: https://zinndigital.com/developers/api
+- Licence: MIT