@postpeer/node 0.7.0 → 0.8.1

package/CHANGELOG.md

@@ -1,134 +1,13 @@
 # Changelog
 
-## 0.7.0 (2026-05-19)
+## 0.8.1
 
-Full Changelog: [v0.6.0...v0.7.0](https://github.com/PostPeer-API/postpeer-node/compare/v0.6.0...v0.7.0)
+- Standardized the public SDK class name as `PostPeer` throughout generated code and documentation.
 
-### Features
+## 0.8.0
 
-* **api:** api update ([3ea6c9c](https://github.com/PostPeer-API/postpeer-node/commit/3ea6c9cd024624c0780f12b15a666f484a3cfa12))
-* **api:** api update ([92bcd6e](https://github.com/PostPeer-API/postpeer-node/commit/92bcd6e92baf495de01fa30194810c03ddeb73fd))
-* **api:** api update ([71fe758](https://github.com/PostPeer-API/postpeer-node/commit/71fe7580cc67c705e868208f430af8ef18e10399))
-* **api:** api update ([ba583d0](https://github.com/PostPeer-API/postpeer-node/commit/ba583d0b9bfea6ea5657f8d73e832b3d5ab0a056))
-* **api:** api update ([01f1907](https://github.com/PostPeer-API/postpeer-node/commit/01f1907a729f7e0fdbf1aa7b133553d4397417c1))
-* **api:** api update ([7395420](https://github.com/PostPeer-API/postpeer-node/commit/7395420c425cb7d6efe09f53b5a45f0a9450c5cf))
+- Rebuilt the SDK with Hey API from the PostPeer OpenAPI specification.
+- Added the `PostPeer` client with retries, timeouts, and typed errors.
+- Simplified generation, testing, packaging, and releases.
 
-
-### Bug Fixes
-
-* **typescript:** upgrade tsc-multi so that it works with Node 26 ([790d61c](https://github.com/PostPeer-API/postpeer-node/commit/790d61cba30fb1f83076f686ccfa2e586e958c5e))
-
-
-### Chores
-
-* redact api-key headers in debug logs ([9f4b4c0](https://github.com/PostPeer-API/postpeer-node/commit/9f4b4c000fb771ea8d1e510043537e1cbfb438e4))
-* **tests:** remove redundant File import ([6f6647f](https://github.com/PostPeer-API/postpeer-node/commit/6f6647fdb4e21d9576a3898d724aefbaeecd1af9))
-
-
-### Documentation
-
-* update http mcp docs ([a7586bf](https://github.com/PostPeer-API/postpeer-node/commit/a7586bfc91be444612dc4137409c97fe89cc1617))
-
-## 0.6.0 (2026-04-30)
-
-Full Changelog: [v0.5.0...v0.6.0](https://github.com/PostPeer-API/postpeer-node/compare/v0.5.0...v0.6.0)
-
-### Features
-
-* **api:** api update ([d2e32a9](https://github.com/PostPeer-API/postpeer-node/commit/d2e32a9b1ed5f1ba0fffc0937262f97945840299))
-* **api:** api update ([7fe25ac](https://github.com/PostPeer-API/postpeer-node/commit/7fe25ac62bd8fff2b4a8595bdf2354247125bee8))
-* **api:** api update ([0f4244a](https://github.com/PostPeer-API/postpeer-node/commit/0f4244a93883c46284d9a3aae68fed3ee3dd470a))
-* **api:** manual updates ([1a587f1](https://github.com/PostPeer-API/postpeer-node/commit/1a587f1d8d28cc22aa7a60065238bf27739a90b2))
-* support setting headers via env ([da2c3df](https://github.com/PostPeer-API/postpeer-node/commit/da2c3df88282d1a007a836853a407271db3fcb43))
-
-
-### Chores
-
-* avoid formatting file that gets changed during releases ([bbec615](https://github.com/PostPeer-API/postpeer-node/commit/bbec6155e6d2255bd46e504ddaf932f84f829763))
-* **format:** run eslint and prettier separately ([6da828b](https://github.com/PostPeer-API/postpeer-node/commit/6da828bb9a28fb72bb3b73e7c582d98369b6b320))
-* **internal:** codegen related update ([a02ee4a](https://github.com/PostPeer-API/postpeer-node/commit/a02ee4a29b99d489770e63d73bf784d1b92e2eb3))
-
-## 0.5.0 (2026-04-27)
-
-Full Changelog: [v0.4.0...v0.5.0](https://github.com/PostPeer-API/postpeer-node/compare/v0.4.0...v0.5.0)
-
-### Features
-
-* **api:** api update ([4d62307](https://github.com/PostPeer-API/postpeer-node/commit/4d6230790ddd0f60eb57b8f98b0361cbf16f4904))
-* **api:** api update ([9411834](https://github.com/PostPeer-API/postpeer-node/commit/9411834d9792457de0fc2904e31a8128c21f2c5d))
-
-
-### Chores
-
-* **formatter:** run prettier and eslint separately ([80fe4b5](https://github.com/PostPeer-API/postpeer-node/commit/80fe4b51aabe1b22f5275c2f1c09c360f994f75c))
-* **internal:** more robust bootstrap script ([b581aeb](https://github.com/PostPeer-API/postpeer-node/commit/b581aeb94a851b78096edeee23bea88f491a5f9a))
-* restructure docs search code ([162a5ca](https://github.com/PostPeer-API/postpeer-node/commit/162a5ca3ff9decf80a52a5e8849ab1bd32e84d17))
-
-## 0.4.0 (2026-04-16)
-
-Full Changelog: [v0.3.1...v0.4.0](https://github.com/PostPeer-API/postpeer-node/compare/v0.3.1...v0.4.0)
-
-### Features
-
-* **api:** manual updates ([f6c645f](https://github.com/PostPeer-API/postpeer-node/commit/f6c645f270e89f136b31e6eb77deee347721cc3c))
-
-
-### Chores
-
-* sync repo ([64cc226](https://github.com/PostPeer-API/postpeer-node/commit/64cc226bdaec83152c6fe31c843a952a50ea1b52))
-* update SDK settings ([726ba8c](https://github.com/PostPeer-API/postpeer-node/commit/726ba8cc5e14a8fec6eee1f2c8062254ad7ab49d))
-
-## 0.3.1 (2026-04-16)
-
-Full Changelog: [v0.3.0...v0.3.1](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.3.0...v0.3.1)
-
-## 0.3.0 (2026-04-16)
-
-Full Changelog: [v0.2.0...v0.3.0](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.2.0...v0.3.0)
-
-### Features
-
-* **api:** manual updates ([0e51c04](https://github.com/PostPeer-API/postpeer-typescript/commit/0e51c04af30a1656bfd425e2f5efcac90c05f9f8))
-
-
-### Chores
-
-* remove custom code ([0f67ec6](https://github.com/PostPeer-API/postpeer-typescript/commit/0f67ec6be9415fc5fb2471c878f02007fe632a02))
-* update SDK settings ([bda5df5](https://github.com/PostPeer-API/postpeer-typescript/commit/bda5df5817239e8cb162a3c1b69cc661fb6ac6f0))
-
-## 0.2.0 (2026-04-16)
-
-Full Changelog: [v0.1.2...v0.2.0](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.1.2...v0.2.0)
-
-### Features
-
-* **api:** api update ([06b89da](https://github.com/PostPeer-API/postpeer-typescript/commit/06b89dad537b8cca199c69dcba8a5239012dc591))
-
-## 0.1.2 (2026-04-15)
-
-Full Changelog: [v0.1.1...v0.1.2](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.1.1...v0.1.2)
-
-## 0.1.1 (2026-04-15)
-
-Full Changelog: [v0.1.0...v0.1.1](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.1.0...v0.1.1)
-
-### Chores
-
-* configure new SDK language ([3ea01db](https://github.com/PostPeer-API/postpeer-typescript/commit/3ea01db9930bbcbcb20e3216db9d1e75f3ef21c9))
-
-## 0.1.0 (2026-04-15)
-
-Full Changelog: [v0.0.1...v0.1.0](https://github.com/PostPeer-API/postpeer-typescript/compare/v0.0.1...v0.1.0)
-
-### Features
-
-* **api:** manual updates ([77ced69](https://github.com/PostPeer-API/postpeer-typescript/commit/77ced69d5ab0d5840ad15b8bf0026620021b1b31))
-
-
-### Chores
-
-* configure new SDK language ([656bd65](https://github.com/PostPeer-API/postpeer-typescript/commit/656bd653dd11e873734b34cba9f8b117ba50ee59))
-* update SDK settings ([9256963](https://github.com/PostPeer-API/postpeer-typescript/commit/9256963d1e1bfdfa976d477545618c64ed092360))
-* update SDK settings ([24f8c7b](https://github.com/PostPeer-API/postpeer-typescript/commit/24f8c7b95dd8412634fb90832b64a2b0e1c48e02))
-* update SDK settings ([f630304](https://github.com/PostPeer-API/postpeer-typescript/commit/f630304937e27a2bb454d7d9198011859d1f3e22))
-* update SDK settings ([76cf155](https://github.com/PostPeer-API/postpeer-typescript/commit/76cf15568d0738279cc7e77eb03510dc2d5f8d9c))
+Earlier release history remains available in Git tags.

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2026 Postpeer
+   Copyright 2026 PostPeer
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,364 +1,142 @@
-# PostPeer TypeScript API Library
+# PostPeer Node.js SDK
 
-[![NPM version](<https://img.shields.io/npm/v/@postpeer/node.svg?label=npm%20(stable)>)](https://npmjs.org/package/@postpeer/node) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@postpeer/node)
-
-This library provides convenient access to the PostPeer REST API from server-side TypeScript or JavaScript.
-
-
-## MCP Server
-
-Use the Postpeer MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
-
-[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=postpeer-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsInBvc3RwZWVyLW1jcCJdLCJlbnYiOnsiUE9TVFBFRVJfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)
-[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22postpeer-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22postpeer-mcp%22%5D%2C%22env%22%3A%7B%22POSTPEER_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
-
-> Note: You may need to set environment variables in your MCP client.
+The official TypeScript SDK for the [PostPeer API](https://postpeer.dev), generated from PostPeer's OpenAPI contract with [Hey API](https://heyapi.dev/).
 
 ## Installation
 
-```sh
+```bash
 npm install @postpeer/node
 ```
 
-## Usage
+Node.js 20 or newer is required.
 
-The full API of this library can be found in [api.md](api.md).
+## Quick start
 
-<!-- prettier-ignore -->
-```js
-import Postpeer from '@postpeer/node';
-
-const client = new Postpeer({
-  apiKey: process.env['POSTPEER_API_KEY'], // This is the default and can be omitted
-});
-
-const response = await client.health.check();
-
-console.log(response.ok);
-```
-
-### Request & Response types
-
-This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
-
-<!-- prettier-ignore -->
 ```ts
-import Postpeer from '@postpeer/node';
-
-const client = new Postpeer({
-  apiKey: process.env['POSTPEER_API_KEY'], // This is the default and can be omitted
-});
-
-const response: Postpeer.HealthCheckResponse = await client.health.check();
-```
-
-Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
-
-## Handling errors
-
-When the library is unable to connect to the API,
-or if the API returns a non-success status code (i.e., 4xx or 5xx response),
-a subclass of `APIError` will be thrown:
-
-<!-- prettier-ignore -->
-```ts
-const response = await client.health.check().catch(async (err) => {
-  if (err instanceof Postpeer.APIError) {
-    console.log(err.status); // 400
-    console.log(err.name); // BadRequestError
-    console.log(err.headers); // {server: 'nginx', ...}
-  } else {
-    throw err;
-  }
-});
-```
-
-Error codes are as follows:
-
-| Status Code | Error Type                 |
-| ----------- | -------------------------- |
-| 400         | `BadRequestError`          |
-| 401         | `AuthenticationError`      |
-| 403         | `PermissionDeniedError`    |
-| 404         | `NotFoundError`            |
-| 422         | `UnprocessableEntityError` |
-| 429         | `RateLimitError`           |
-| >=500       | `InternalServerError`      |
-| N/A         | `APIConnectionError`       |
-
-### Retries
+import PostPeer from '@postpeer/node';
 
-Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
-429 Rate Limit, and >=500 Internal errors will all be retried by default.
+const client = new PostPeer(); // Uses POSTPEER_API_KEY
 
-You can use the `maxRetries` option to configure or disable this:
-
-<!-- prettier-ignore -->
-```js
-// Configure the default for all requests:
-const client = new Postpeer({
-  maxRetries: 0, // default is 2
-});
-
-// Or, configure per-request:
-await client.health.check({
-  maxRetries: 5,
-});
-```
-
-### Timeouts
-
-Requests time out after 1 minute by default. You can configure this with a `timeout` option:
-
-<!-- prettier-ignore -->
-```ts
-// Configure the default for all requests:
-const client = new Postpeer({
-  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
-});
-
-// Override per-request:
-await client.health.check({
-  timeout: 5 * 1000,
+const { data: post } = await client.posts.create({
+  body: {
+    content: 'Hello from PostPeer!',
+    platforms: [{ platform: 'twitter', accountId: 'integration-id' }],
+    publishNow: true,
+  },
 });
-```
-
-On timeout, an `APIConnectionTimeoutError` is thrown.
 
-Note that requests which time out will be [retried twice by default](#retries).
-
-## Advanced Usage
-
-### Accessing raw Response data (e.g., headers)
-
-The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
-This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
-
-You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
-Unlike `.asResponse()` this method consumes the body, returning once it is parsed.
-
-<!-- prettier-ignore -->
-```ts
-const client = new Postpeer();
-
-const response = await client.health.check().asResponse();
-console.log(response.headers.get('X-My-Header'));
-console.log(response.statusText); // access the underlying Response object
-
-const { data: response, response: raw } = await client.health.check().withResponse();
-console.log(raw.headers.get('X-My-Header'));
-console.log(response.ok);
+console.log(post);
 ```
 
-### Logging
-
-> [!IMPORTANT]
-> All log messages are intended for debugging only. The format and content of log messages
-> may change between releases.
-
-#### Log levels
-
-The log level can be configured in two ways:
-
-1. Via the `POSTPEER_LOG` environment variable
-2. Using the `logLevel` client option (overrides the environment variable if set)
+You can also pass the key directly:
 
 ```ts
-import Postpeer from '@postpeer/node';
-
-const client = new Postpeer({
-  logLevel: 'debug', // Show all log messages
+const client = new PostPeer({
+  apiKey: 'your-access-key',
 });
 ```
 
-Available log levels, from most to least verbose:
-
-- `'debug'` - Show debug messages, info, warnings, and errors
-- `'info'` - Show info messages, warnings, and errors
-- `'warn'` - Show warnings and errors (default)
-- `'error'` - Show only errors
-- `'off'` - Disable all logging
-
-At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.
-Some authentication-related headers are redacted, but sensitive data in request and response bodies
-may still be visible.
-
-#### Custom logger
-
-By default, this library logs to `globalThis.console`. You can also provide a custom logger.
-Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.
-
-When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages
-below the configured level will not be sent to your logger.
+## Configuration
 
 ```ts
-import Postpeer from '@postpeer/node';
-import pino from 'pino';
-
-const logger = pino();
-
-const client = new Postpeer({
-  logger: logger.child({ name: 'Postpeer' }),
-  logLevel: 'debug', // Send all messages to pino, allowing it to filter
+const client = new PostPeer({
+  apiKey: 'your-access-key',
+  baseURL: 'https://api.postpeer.dev',
+  timeout: 60_000,
+  maxRetries: 2,
+  defaultHeaders: { 'X-Application': 'my-app' },
+  fetch: customFetch,
 });
 ```
 
-### Making custom/undocumented requests
+Every `PostPeer` instance owns an isolated HTTP client, so separate API keys and base URLs do not interfere with one another.
 
-This library is typed for convenient access to the documented API. If you need to access undocumented
-endpoints, params, or response properties, the library can still be used.
+## Resources
 
-#### Undocumented endpoints
-
-To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.
-Options on the client, such as retries, will be respected when making these requests.
+The SDK follows the API's resource structure:
 
 ```ts
-await client.post('/some/path', {
-  body: { some_prop: 'foo' },
-  query: { some_query_arg: 'bar' },
-});
-```
-
-#### Undocumented request params
-
-To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented
-parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
-send will be sent as-is.
+client.health.check();
+client.health.verifyAccessKey();
+
+client.posts.create({ body });
+client.posts.list({ query });
+client.posts.get({ path: { postId } });
+client.posts.delete({ path: { postId } });
+client.posts.scheduled.list();
+client.posts.scheduled.cancel({ path: { postId } });
+client.posts.scheduled.reschedule({ path: { postId }, body });
+
+client.connect.getOAuthUrl({ path: { platform }, query });
+client.connect.integrations.list();
+client.connect.integrations.disconnect({ path: { id } });
+
+client.profiles.list();
+client.apps.list();
+client.notifications.list();
+client.platforms.list();
+client.media.upload({ body });
+client.analytics.get({ query });
+client.usage.get();
+client.pinterest.getBoards({ query });
+client.tiktok.getCreatorInfo({ query });
+client.ai.write({ body });
+client.ai.generateImage({ body });
+```
+
+Request parameters are grouped under `body`, `path`, `query`, and `headers`. Responses include `data`, `request`, and `response`, giving you access to the parsed result and the native Fetch objects.
+
+## Error handling
 
 ```ts
-client.health.check({
-  // ...
-  // @ts-expect-error baz is not yet public
-  baz: 'undocumented option',
-});
-```
-
-For requests with the `GET` verb, any extra params will be in the query, all other requests will send the
-extra param in the body.
-
-If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request
-options.
+import PostPeer, { NotFoundError, RateLimitError } from '@postpeer/node';
 
-#### Undocumented response properties
+const client = new PostPeer();
 
-To access undocumented response properties, you may access the response object with `// @ts-expect-error` on
-the response object, or cast the response object to the requisite type. Like the request params, we do not
-validate or strip extra properties from the response from the API.
-
-### Customizing the fetch client
-
-By default, this library expects a global `fetch` function is defined.
-
-If you want to use a different `fetch` function, you can either polyfill the global:
-
-```ts
-import fetch from 'my-fetch';
-
-globalThis.fetch = fetch;
-```
-
-Or pass it to the client:
-
-```ts
-import Postpeer from '@postpeer/node';
-import fetch from 'my-fetch';
-
-const client = new Postpeer({ fetch });
+try {
+  await client.posts.get({ path: { postId: 'missing' } });
+} catch (error) {
+  if (error instanceof NotFoundError) {
+    console.error(error.status, error.requestId, error.message);
+  } else if (error instanceof RateLimitError) {
+    console.error('PostPeer rate limit reached');
+  }
+}
 ```
 
-### Fetch options
+The SDK exports typed API, connection, timeout, and user-abort errors.
 
-If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
+## Updating the generated SDK
 
-```ts
-import Postpeer from '@postpeer/node';
+The OpenAPI specification and npm releases are intentionally separate.
 
-const client = new Postpeer({
-  fetchOptions: {
-    // `RequestInit` options
-  },
-});
+```bash
+pnpm spec:fetch
+pnpm generate
+pnpm check
 ```
 
-#### Configuring proxies
-
-To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy
-options to requests:
+Commit `openapi.json` and `src/generated` together. This updates the code but does not publish a package.
 
-<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
-
-```ts
-import Postpeer from '@postpeer/node';
-import * as undici from 'undici';
+For a release, update `package.json`, `src/version.ts`, and `CHANGELOG.md`, run `pnpm check`, then publish with `npm publish --access public`.
 
-const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
-const client = new Postpeer({
-  fetchOptions: {
-    dispatcher: proxyAgent,
-  },
-});
-```
+Generated files under `src/generated` must not be edited by hand.
 
-<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
+## Versioning
 
-```ts
-import Postpeer from '@postpeer/node';
+PostPeer uses conservative pre-1.0 versioning:
 
-const client = new Postpeer({
-  fetchOptions: {
-    proxy: 'http://localhost:8888',
-  },
-});
-```
+- `0.8.0` is the first Hey API release.
+- Compatible fixes and additions remain in `0.8.x`.
+- A breaking SDK change moves to `0.9.0`.
+- `1.0.0` will be published only when the SDK contract is considered mature.
 
-<img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
+OpenAPI changes may accumulate before a package release.
 
-```ts
-import Postpeer from 'npm:@postpeer/node';
+## Development
 
-const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
-const client = new Postpeer({
-  fetchOptions: {
-    client: httpClient,
-  },
-});
+```bash
+pnpm install
+pnpm generate
+pnpm check
 ```
-
-## Frequently Asked Questions
-
-## Semantic versioning
-
-This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
-
-1. Changes that only affect static types, without breaking runtime behavior.
-2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
-3. Changes that we do not expect to impact the vast majority of users in practice.
-
-We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
-
-We are keen for your feedback; please open an [issue](https://www.github.com/PostPeer-API/postpeer-node/issues) with questions, bugs, or suggestions.
-
-## Requirements
-
-TypeScript >= 4.9 is supported.
-
-The following runtimes are supported:
-
-- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
-- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
-- Deno v1.28.0 or higher.
-- Bun 1.0 or later.
-- Cloudflare Workers.
-- Vercel Edge Runtime.
-- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
-- Nitro v2.6 or greater.
-
-Note that React Native is not supported at this time.
-
-If you are interested in other runtime environments, please open or upvote an issue on GitHub.
-
-## Contributing
-
-See [the contributing documentation](./CONTRIBUTING.md).