Merge pull request #5 from sentdm/release-please--branches--main--changes--next--components--sentdm

release: 0.1.0

Author: arbianst

.github/workflows/publish-npm.yml

@@ -0,0 +1,35 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/sentdm/sent-dm-typescript/actions/workflows/publish-npm.yml
+name: Publish NPM
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install dependencies
+        run: |
+          pnpm install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_DM_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -17,4 +17,6 @@ jobs:
       - name: Check release environment
         run: |
           bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_DM_NPM_TOKEN || secrets.NPM_TOKEN }}
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.0.2"
+  ".": "0.1.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 19
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-fb283b0282d8115510162d29245bfd0675d14efaade908f6d9289aa10c841be7.yml
-openapi_spec_hash: aef4eefbcccbb9301feaca95070f2181
-config_hash: 37152ed2d55a206f1b8110620f1d42fd
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-37465954227cd4e96920805a44aa6cf9a51da1f0073be89bbcb69cf32ef6cf22.yml
+openapi_spec_hash: 145f3fc12cd69c9f6799ded0f10c6ad3
+config_hash: 56966cd0f66591925f8fd02ad6808fb0

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.1.0 (2026-01-27)
+
+Full Changelog: [v0.0.2...v0.1.0](https://github.com/sentdm/sent-dm-typescript/compare/v0.0.2...v0.1.0)
+
+### Features
+
+* **api:** api update ([90af63d](https://github.com/sentdm/sent-dm-typescript/commit/90af63def1b37c62cd10d818db86835eaa64e3cf))
+* **api:** api update ([3c42d45](https://github.com/sentdm/sent-dm-typescript/commit/3c42d45342ead25067d7d07660332bfee2588261))
+* **api:** api update ([6bcd93b](https://github.com/sentdm/sent-dm-typescript/commit/6bcd93b49152c503583a8835efd16b0b21d4d353))
+* **api:** manual updates ([6afef55](https://github.com/sentdm/sent-dm-typescript/commit/6afef551585e5a32567be6237570f7faac3a28c1))
+* **api:** manual updates ([bb13ec3](https://github.com/sentdm/sent-dm-typescript/commit/bb13ec38564a88ab10f355310d517fee4063bc5b))
+* **api:** manual updates ([409a82f](https://github.com/sentdm/sent-dm-typescript/commit/409a82f1b482acd42483ca2f2cf0d0476bb858d6))
+* **api:** manual updates ([453d073](https://github.com/sentdm/sent-dm-typescript/commit/453d073a13c4e3249284a5f7a86227bf16a7d5b1))
+* **api:** manual updates ([def2439](https://github.com/sentdm/sent-dm-typescript/commit/def2439e2765ff44f9b33e5569bf95db85981bb5))
+* **api:** manual updates ([e1026b2](https://github.com/sentdm/sent-dm-typescript/commit/e1026b220ac28c5c5342a89ce24dcaba45a99630))
+
+
+### Chores
+
+* update SDK settings ([7e0f5e5](https://github.com/sentdm/sent-dm-typescript/commit/7e0f5e54dfef8fbb28e7621da1a1ae33722a0252))
+* update SDK settings ([a380082](https://github.com/sentdm/sent-dm-typescript/commit/a3800828e740feb6530b127940a9fd4180b19b20))
+* update SDK settings ([71675f9](https://github.com/sentdm/sent-dm-typescript/commit/71675f9ee4d99832f05aa3ed43866e5886d05505))
+
 ## 0.0.2 (2026-01-26)
 
 Full Changelog: [v0.0.1...v0.0.2](https://github.com/sentdm/sent-dm-typescript/compare/v0.0.1...v0.0.2)

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd sent-dm-typescript
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link sent-dm
+$ yarn link sentdm
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global sent-dm
+$ pnpm link -—global sentdm
 ```
 
 ## Running tests
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ pnpm fix
 ```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/sentdm/sent-dm-typescript/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

README.md

@@ -1,6 +1,6 @@
 # Sent Dm TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/sent-dm.svg?label=npm%20(stable)>)](https://npmjs.org/package/sent-dm) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sent-dm)
+[![NPM version](<https://img.shields.io/npm/v/sentdm.svg?label=npm%20(stable)>)](https://npmjs.org/package/sentdm) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sentdm)
 
 This library provides convenient access to the Sent Dm REST API from server-side TypeScript or JavaScript.
 
@@ -11,25 +11,27 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://git@github.com:sentdm/sent-dm-typescript.git
+npm install sentdm
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install sent-dm`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
-  customerAuthScheme: process.env['SENT_DM_CUSTOMER_AUTH_SCHEME'], // This is the default and can be omitted
+  apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
+  senderID: process.env['SENT_DM_SENDER_ID'], // This is the default and can be omitted
 });
 
-await client.templates.delete('REPLACE_ME');
+await client.messages.sendToPhone({
+  phoneNumber: '+1234567890',
+  templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+  templateVariables: { name: 'John Doe', order_id: '12345' },
+});
 ```
 
 ### Request & Response types
@@ -38,13 +40,19 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
-  customerAuthScheme: process.env['SENT_DM_CUSTOMER_AUTH_SCHEME'], // This is the default and can be omitted
+  apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
+  senderID: process.env['SENT_DM_SENDER_ID'], // This is the default and can be omitted
 });
 
-await client.templates.delete('REPLACE_ME');
+const params: SentDm.MessageSendToPhoneParams = {
+  phoneNumber: '+1234567890',
+  templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+  templateVariables: { name: 'John Doe', order_id: '12345' },
+};
+await client.messages.sendToPhone(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -57,15 +65,21 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const response = await client.templates.delete('REPLACE_ME').catch(async (err) => {
-  if (err instanceof SentDm.APIError) {
-    console.log(err.status); // 400
-    console.log(err.name); // BadRequestError
-    console.log(err.headers); // {server: 'nginx', ...}
-  } else {
-    throw err;
-  }
-});
+const response = await client.messages
+  .sendToPhone({
+    phoneNumber: '+1234567890',
+    templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+    templateVariables: { name: 'John Doe', order_id: '12345' },
+  })
+  .catch(async (err) => {
+    if (err instanceof SentDm.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:
@@ -97,7 +111,11 @@ const client = new SentDm({
 });
 
 // Or, configure per-request:
-await client.templates.delete('REPLACE_ME', {
+await client.messages.sendToPhone({
+  phoneNumber: '+1234567890',
+  templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+  templateVariables: { name: 'John Doe', order_id: '12345' },
+}, {
   maxRetries: 5,
 });
 ```
@@ -114,7 +132,11 @@ const client = new SentDm({
 });
 
 // Override per-request:
-await client.templates.delete('REPLACE_ME', {
+await client.messages.sendToPhone({
+  phoneNumber: '+1234567890',
+  templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+  templateVariables: { name: 'John Doe', order_id: '12345' },
+}, {
   timeout: 5 * 1000,
 });
 ```
@@ -137,11 +159,23 @@ Unlike `.asResponse()` this method consumes the body, returning once it is parse
 ```ts
 const client = new SentDm();
 
-const response = await client.templates.delete('REPLACE_ME').asResponse();
+const response = await client.messages
+  .sendToPhone({
+    phoneNumber: '+1234567890',
+    templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+    templateVariables: { name: 'John Doe', order_id: '12345' },
+  })
+  .asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
-const { data: result, response: raw } = await client.templates.delete('REPLACE_ME').withResponse();
+const { data: result, response: raw } = await client.messages
+  .sendToPhone({
+    phoneNumber: '+1234567890',
+    templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+    templateVariables: { name: 'John Doe', order_id: '12345' },
+  })
+  .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(result);
 ```
@@ -160,7 +194,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
   logLevel: 'debug', // Show all log messages
@@ -188,7 +222,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
 below the configured level will not be sent to your logger.
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 import pino from 'pino';
 
 const logger = pino();
@@ -223,7 +257,7 @@ parameter. This library doesn't validate at runtime that the request matches the
 send will be sent as-is.
 
 ```ts
-client.templates.delete({
+client.messages.sendToPhone({
   // ...
   // @ts-expect-error baz is not yet public
   baz: 'undocumented option',
@@ -257,7 +291,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 import fetch from 'my-fetch';
 
 const client = new SentDm({ fetch });
@@ -268,7 +302,7 @@ const client = new SentDm({ fetch });
 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.)
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
   fetchOptions: {
@@ -285,7 +319,7 @@ options to requests:
 <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 SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -299,7 +333,7 @@ const client = new SentDm({
 <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>
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
   fetchOptions: {
@@ -311,7 +345,7 @@ const client = new SentDm({
 <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>
 
 ```ts
-import SentDm from 'npm:sent-dm';
+import SentDm from 'npm:sentdm';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new SentDm({

bin/check-release-environment

@@ -2,6 +2,10 @@
 
 errors=()
 
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+fi
+
 lenErrors=${#errors[@]}
 
 if [[ lenErrors -gt 0 ]]; then

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^sent-dm(/.*)?',
+              regex: '^sentdm(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],

jest.config.ts

@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^sent-dm$': '<rootDir>/src/index.ts',
-    '^sent-dm/(.*)$': '<rootDir>/src/$1',
+    '^sentdm$': '<rootDir>/src/index.ts',
+    '^sentdm/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',