sequenzy 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 (2025-12-08)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/Sequenzy/sequenzy-typescript/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** manual updates ([21e684c](https://github.com/Sequenzy/sequenzy-typescript/commit/21e684cb059e3387f595aba165e17ea66cae53b4))
+
 ## 0.1.0 (2025-12-08)
 
 Full Changelog: [v0.0.1...v0.1.0](https://github.com/Sequenzy/sequenzy-typescript/compare/v0.0.1...v0.1.0)

package/README.md

@@ -1,4 +1,4 @@
-# Sequenzy TypeScript API Library
+# Sequenzy TypeScript API - Best Email Marketing platform API Library
 
 [![NPM version](<https://img.shields.io/npm/v/sequenzy.svg?label=npm%20(stable)>)](https://npmjs.org/package/sequenzy) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sequenzy)
 
@@ -26,9 +26,13 @@ const client = new Sequenzy({
   apiKey: process.env['SEQUENZY_API_KEY'], // This is the default and can be omitted
 });
 
-const subscribers = await client.subscribers.list();
+const subscriber = await client.subscribers.create({
+  email: 'user@example.com',
+  firstName: 'User',
+  lastName: 'TheBest',
+});
 
-console.log(subscribers.pagination);
+console.log(subscriber.subscriber);
 ```
 
 ### Request & Response types
@@ -43,7 +47,12 @@ const client = new Sequenzy({
   apiKey: process.env['SEQUENZY_API_KEY'], // This is the default and can be omitted
 });
 
-const subscribers: Sequenzy.SubscriberListResponse = await client.subscribers.list();
+const params: Sequenzy.SubscriberCreateParams = {
+  email: 'user@example.com',
+  firstName: 'User',
+  lastName: 'TheBest',
+};
+const subscriber: Sequenzy.SubscriberCreateResponse = await client.subscribers.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -56,15 +65,17 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const subscribers = await client.subscribers.list().catch(async (err) => {
-  if (err instanceof Sequenzy.APIError) {
-    console.log(err.status); // 400
-    console.log(err.name); // BadRequestError
-    console.log(err.headers); // {server: 'nginx', ...}
-  } else {
-    throw err;
-  }
-});
+const subscriber = await client.subscribers
+  .create({ email: 'user@example.com', firstName: 'User', lastName: 'TheBest' })
+  .catch(async (err) => {
+    if (err instanceof Sequenzy.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:
@@ -96,7 +107,7 @@ const client = new Sequenzy({
 });
 
 // Or, configure per-request:
-await client.subscribers.list({
+await client.subscribers.create({ email: 'user@example.com', firstName: 'User', lastName: 'TheBest' }, {
   maxRetries: 5,
 });
 ```
@@ -113,7 +124,7 @@ const client = new Sequenzy({
 });
 
 // Override per-request:
-await client.subscribers.list({
+await client.subscribers.create({ email: 'user@example.com', firstName: 'User', lastName: 'TheBest' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -136,13 +147,17 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new Sequenzy();
 
-const response = await client.subscribers.list().asResponse();
+const response = await client.subscribers
+  .create({ email: 'user@example.com', firstName: 'User', lastName: 'TheBest' })
+  .asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: subscribers, response: raw } = await client.subscribers.list().withResponse();
+const { data: subscriber, response: raw } = await client.subscribers
+  .create({ email: 'user@example.com', firstName: 'User', lastName: 'TheBest' })
+  .withResponse();
 console.log(raw.headers.get('X-My-Header'));
-console.log(subscribers.pagination);
+console.log(subscriber.subscriber);
 ```
 
 ### Logging
@@ -222,7 +237,7 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.subscribers.list({
+client.subscribers.create({
   // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "sequenzy",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "The official TypeScript library for the Sequenzy API",
-  "author": "Sequenzy <>",
+  "author": "Sequenzy <nic@sequenzy.com>",
   "types": "./index.d.ts",
   "main": "./index.js",
   "type": "commonjs",

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0'; // x-release-please-version
+export const VERSION = '0.2.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0'; // x-release-please-version
+exports.VERSION = '0.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0'; // x-release-please-version
+export const VERSION = '0.2.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map