Merge pull request #5 from TeamWarp/release-please--branches--main--changes--next--components--warp-hr

release: 0.4.0

Author: rankincodes

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.3.0"
+  ".": "0.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 7
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-rankincodes%2Fwarp-hr-6296f9b186eaefb8024bb8ed36bf6fcee617d961d6573edf459b16f8d2aa817d.yml
 openapi_spec_hash: cf0ee8d21b63aa9f1f58dfbc2e47d5fc
-config_hash: 44ef6a781020403d8a5806cab899873a
+config_hash: 367d32641c74325e24480a4c423e97a1

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.4.0 (2025-12-26)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/TeamWarp/warp-sdk-typescript/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([ea9020e](https://github.com/TeamWarp/warp-sdk-typescript/commit/ea9020ede4440daf459c8e7f3073b483201dce96))
+* **api:** manual updates ([775b5f0](https://github.com/TeamWarp/warp-sdk-typescript/commit/775b5f0cc7545ce3770e201bd9c1f45e53123ff4))
+
 ## 0.3.0 (2025-12-26)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/TeamWarp/warp-sdk-typescript/compare/v0.2.0...v0.3.0)

README.md

@@ -23,7 +23,7 @@ The full API of this library can be found in [api.md](api.md).
 import WarpHr from 'warp-hr';
 
 const client = new WarpHr({
-  apiKey: process.env['WARP_HR_API_KEY'], // This is the default and can be omitted
+  apiKey: process.env['WARP_API_KEY'], // This is the default and can be omitted
 });
 
 const page = await client.timeOff.policies.list();
@@ -41,7 +41,7 @@ This library includes TypeScript definitions for all request params and response
 import WarpHr from 'warp-hr';
 
 const client = new WarpHr({
-  apiKey: process.env['WARP_HR_API_KEY'], // This is the default and can be omitted
+  apiKey: process.env['WARP_API_KEY'], // This is the default and can be omitted
 });
 
 const [policyListResponse]: [WarpHr.TimeOff.PolicyListResponse] = await client.timeOff.policies.list();

SECURITY.md

@@ -18,6 +18,10 @@ before making any information public.
 If you encounter security issues that are not directly related to SDKs but pertain to the services
 or products provided by Warp Hr, please follow the respective company's security reporting guidelines.
 
+### Warp Hr Terms and Policies
+
+Please contact adam@joinwarp.com for any questions or concerns regarding the security of our services.
+
 ---
 
 Thank you for helping us keep the SDKs and systems they interact with secure.

package.json

@@ -1,8 +1,8 @@
 {
   "name": "warp-hr",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "The official TypeScript library for the Warp Hr API",
-  "author": "Warp Hr <>",
+  "author": "Warp Hr <adam@joinwarp.com>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",

src/client.ts

@@ -53,7 +53,7 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['WARP_HR_API_KEY'].
+   * Defaults to process.env['WARP_API_KEY'].
    */
   apiKey?: string | undefined;
 
@@ -147,7 +147,7 @@ export class WarpHr {
   /**
    * API Client for interfacing with the Warp Hr API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['WARP_HR_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.apiKey=process.env['WARP_API_KEY'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['WARP_HR_BASE_URL'] ?? https://api.joinwarp.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -158,12 +158,12 @@ export class WarpHr {
    */
   constructor({
     baseURL = readEnv('WARP_HR_BASE_URL'),
-    apiKey = readEnv('WARP_HR_API_KEY'),
+    apiKey = readEnv('WARP_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.WarpHrError(
-        "The WARP_HR_API_KEY environment variable is missing or empty; either provide it, or instantiate the WarpHr client with an apiKey option, like new WarpHr({ apiKey: 'My API Key' }).",
+        "The WARP_API_KEY environment variable is missing or empty; either provide it, or instantiate the WarpHr client with an apiKey option, like new WarpHr({ apiKey: 'My API Key' }).",
       );
     }
 

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

tests/index.test.ts

@@ -413,14 +413,14 @@ describe('instantiate client', () => {
 
   test('with environment variable arguments', () => {
     // set options via env var
-    process.env['WARP_HR_API_KEY'] = 'My API Key';
+    process.env['WARP_API_KEY'] = 'My API Key';
     const client = new WarpHr();
     expect(client.apiKey).toBe('My API Key');
   });
 
   test('with overridden environment variable arguments', () => {
     // set options via env var
-    process.env['WARP_HR_API_KEY'] = 'another My API Key';
+    process.env['WARP_API_KEY'] = 'another My API Key';
     const client = new WarpHr({ apiKey: 'My API Key' });
     expect(client.apiKey).toBe('My API Key');
   });