Release 0.0.244

Author: fern-api[bot]

README.md

@@ -1,89 +1,144 @@
 # Beehiiv TypeScript Library
 
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/)
-[![npm shield](https://img.shields.io/npm/v/beehiiv)](https://www.npmjs.com/package/beehiiv)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fbeehiiv%2Ftypescript-sdk)
+[![npm shield](https://img.shields.io/npm/v/@beehiiv/sdk)](https://www.npmjs.com/package/@beehiiv/sdk)
 
-The Beehiiv TypeScript library provides convenient access to the Beehiiv Public API from JavaScript/TypeScript.
+The Beehiiv TypeScript library provides convenient access to the Beehiiv API from TypeScript.
 
 ## Documentation
 
 API reference documentation is available [here](https://developers.beehiiv.com/docs/v2/o3elujhmkik1d-beehiiv-api).
 
-## Reference
-
-A full reference of the SDK is available [here](./reference.md).
-
 ## Installation
 
-```bash
-npm install --save beehiiv
-# or
-yarn add beehiiv
+```sh
+npm i -s @beehiiv/sdk
 ```
 
-In Deno (1.25+) you can import by doing: 
+## Reference
 
-```ts
-import { Beehiv } from "npm:beehiv";
-```
+A full reference for this library is available [here](./reference.md).
 
 ## Usage
 
-```typescript
-import { BeehiivClient, Beehiiv } from 'beehiiv';
+Instantiate and use the client with the following:
 
-const beehiiv = new BeehiivClient({
-  token: "token...", // Defaults to process.env.BEEHIIV_API_KEY
-});
+```typescript
+import { BeehiivClient } from "@beehiiv/sdk";
 
-const response =  await beehiiv.subscriptions.create(
-    "pub_11c6387f-1d31-40c7-85ee-4a2da0c63001", 
+const client = new BeehiivClient({ token: "YOUR_TOKEN" });
+await client.automationJourneys.create(
+    "pub_00000000-0000-0000-0000-000000000000",
+    "aut_00000000-0000-0000-0000-000000000000",
     {
-        email: "...@email.com",
-    },
+        email: "test@example.com",
+        doubleOptOverride: "on",
+    }
 );
 ```
 
-## Request and Response Types
+## Request And Response Types
 
-The SDK exports all request and response types as TypeScript interfaces. Simply 
-import them under the `Beehiiv` namespace: 
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
 
-```ts
-import { Beehiiv } from "beehiiv"; 
+```typescript
+import { Beehiiv } from "@beehiiv/sdk";
 
-const publication: Beehiiv.Publication = {
-    id: "pub_...",
-    name: "Some publication",
-    referralProgramEnabled: true,
-    created: 1713226240
+const request: Beehiiv.AutomationJourneysCreateRequest = {
+    ...
 };
 ```
 
 ## Exception Handling
 
-When the API returns a non-success status code (4xx or 5xx response), 
-a subclass of [BeehiivError](./src/errors/BeehiivError.ts) will be thrown:
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
 
-```ts
-import { BeehiivError } from 'beehiiv';
+```typescript
+import { BeehiivError } from "@beehiiv/sdk";
 
 try {
-   await beehiiv.subscriptions.create(
-      "pub_11c6387f-1d31-40c7-85ee-4a2da0c63001", 
-      {
-          email: "...@email.com",
-      },
-  );
+    await client.automationJourneys.create(...);
 } catch (err) {
-  if (err instanceof BeehiivError) {
-    console.log(err.statusCode); 
-    console.log(err.message);
-    console.log(err.body); 
-  }
+    if (err instanceof BeehiivError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
 }
 ```
 
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.automationJourneys.create(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.automationJourneys.create(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.automationJourneys.create(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { BeehiivClient } from "@beehiiv/sdk";
+
+const client = new BeehiivClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
 ## Retries
 
 The TypeScript SDK is instrumented with automatic retries with exponential backoff. A request will be
@@ -92,12 +147,12 @@ than the configured retry limit (default: 2).
 
 A request is deemed retriable when any of the following HTTP status codes is returned:
 
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-  
-Use the `maxRetries` request option to configure this behavior. 
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
 
 ```ts
 const response = await beehiiv.subscriptions.create(..., {
@@ -107,8 +162,8 @@ const response = await beehiiv.subscriptions.create(..., {
 
 ## Timeouts
 
-The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to 
-configure this behavior. 
+The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to
+configure this behavior.
 
 ```ts
 const response = await beehiiv.subscriptions.create(..., {
@@ -118,23 +173,23 @@ const response = await beehiiv.subscriptions.create(..., {
 
 ## Runtime compatiblity
 
-The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK 
-works in the following runtimes: 
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK
+works in the following runtimes:
 
 The following runtimes are supported:
 
-- Node.js 15+ 
-- Vercel 
-- Cloudflare Workers
-- Deno v1.25+
-- Bun 1.0+
-- React Native
+-   Node.js 15+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
 
 ### Customizing Fetch client
 
-The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're 
-running in an unsupported environment, this provides a way for you to break the glass and 
-ensure the SDK works. 
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're
+running in an unsupported environment, this provides a way for you to break the glass and
+ensure the SDK works.
 
 ```ts
 import { BeehiivClient } from 'beehiiv';
@@ -147,14 +202,17 @@ const beehiiv = new BeehiivClient({
 
 ## Beta status
 
-This SDK is in beta, and there may be breaking changes between versions without a major version update. 
-Therefore, we recommend pinning the package version to a specific version in your package.json file. 
-This way, you can install the same version each time without breaking changes unless you are 
+This SDK is in beta, and there may be breaking changes between versions without a major version update.
+Therefore, we recommend pinning the package version to a specific version in your package.json file.
+This way, you can install the same version each time without breaking changes unless you are
 intentionally looking for the latest version.
 
 ## Contributing
 
-While we value open-source contributions to this SDK, this library is generated programmatically. 
-Additions made directly to this library would have to be moved over to our generation code, 
-otherwise they would be overwritten upon the next generated release. Feel free to open a 
-PR as a proof of concept, but know that we will not be able to merge it as-is. 
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package.json

@@ -1,6 +1,6 @@
 {
-    "name": "beehiiv",
-    "version": "0.1.3",
+    "name": "@beehiiv/sdk",
+    "version": "0.0.244",
     "private": false,
     "repository": "https://github.com/beehiiv/typescript-sdk",
     "main": "./index.js",
@@ -17,12 +17,17 @@
         "formdata-node": "^6.0.3",
         "node-fetch": "2.7.0",
         "qs": "6.11.2",
+        "readable-stream": "^4.5.2",
         "js-base64": "3.7.2"
     },
     "devDependencies": {
         "@types/url-join": "4.0.1",
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
+        "@types/readable-stream": "^4.0.15",
+        "fetch-mock-jest": "^1.5.1",
+        "webpack": "^5.94.0",
+        "ts-loader": "^9.3.1",
         "jest": "29.7.0",
         "@types/jest": "29.5.5",
         "ts-jest": "29.1.1",