pingram 0.0.2-alpha.11 → 0.0.2-alpha.12

package/README.md

@@ -20,10 +20,10 @@ npm install pingram
 Import and initialize the client:
 
 ```typescript
-import { NotificationAPIClient } from 'pingram';
+import { Pingram } from 'pingram';
 
 // Server-side: Secret Key (Bearer token)
-const apiClient = new NotificationAPIClient({
+const apiClient = new Pingram({
   apiKey: 'pingram_sk_...'
 });
 ```
@@ -31,7 +31,7 @@ const apiClient = new NotificationAPIClient({
 For connecting to Canada or EU regions, set the region option:
 
 ```typescript
-const apiClient = new NotificationAPIClient({
+const apiClient = new Pingram({
   apiKey: 'pingram_sk_...',
   region: 'eu'
 });

package/dist/src/client.d.ts

@@ -22,18 +22,18 @@ import { DefaultApi } from '../generated/src';
 /**
  * Supported Pingram regions
  */
-export type NotificationAPIRegion = 'us' | 'eu' | 'ca';
+export type PingramRegion = 'us' | 'eu' | 'ca';
 /**
  * Configuration options for the Pingram client
  */
-export interface NotificationAPIClientConfig {
+export interface PingramConfig {
     /**
      * API region (defaults to 'us')
      * - 'us': api.pingram.io (default)
      * - 'eu': api.eu.pingram.io
      * - 'ca': api.ca.pingram.io
      */
-    region?: NotificationAPIRegion;
+    region?: PingramRegion;
     /**
      * Base URL for the API (overrides region setting)
      * Only use this if you need a custom endpoint
@@ -46,12 +46,12 @@ export interface NotificationAPIClientConfig {
      *
      * @example
      * // API Key authentication
-     * const client = new NotificationAPIClient({
+     * const client = new Pingram({
      *   apiKey: 'pingram_sk_...'
      * });
      *
      * // JWT token authentication
-     * const client = new NotificationAPIClient({
+     * const client = new Pingram({
      *   apiKey: 'eyJraWQiOiJJM0tuNitTVnp5K0lzam9TeXVvYlJKcFpCcDd...'
      * });
      */
@@ -73,18 +73,18 @@ export interface NotificationAPIClientConfig {
  * @example
  * ```typescript
  * // Basic usage with default US region
- * const client = new NotificationAPIClient({
+ * const client = new Pingram({
  *   apiKey: 'pingram_sk_...'
  * });
  *
  * // With specific region
- * const euClient = new NotificationAPIClient({
+ * const euClient = new Pingram({
  *   region: 'eu',
  *   apiKey: 'pingram_sk_...'
  * });
  *
  * // With custom base URL
- * const customClient = new NotificationAPIClient({
+ * const customClient = new Pingram({
  *   apiKey: 'pingram_sk_...',
  *   baseUrl: 'https://custom.api.example.com'
  * });
@@ -96,7 +96,7 @@ export interface NotificationAPIClientConfig {
  * });
  * ```
  */
-export declare class NotificationAPIClient {
+export declare class Pingram {
     private config;
     account: AccountApi;
     components: ComponentsApi;
@@ -114,7 +114,7 @@ export declare class NotificationAPIClient {
     user: UserApi;
     users: UsersApi;
     private defaultApi;
-    constructor(config: NotificationAPIClientConfig);
+    constructor(config: PingramConfig);
     /**
      * Update the base URL (overrides region)
      */

package/dist/src/client.js

@@ -8,7 +8,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationAPIClient = void 0;
+exports.Pingram = void 0;
 const src_1 = require("../generated/src");
 // @ts-expect-error - Path is correct at runtime (from dist/src/), not during compilation
 const package_json_1 = __importDefault(require("../../package.json"));
@@ -57,18 +57,18 @@ function buildAuthorizationHeader(apiKey) {
  * @example
  * ```typescript
  * // Basic usage with default US region
- * const client = new NotificationAPIClient({
+ * const client = new Pingram({
  *   apiKey: 'pingram_sk_...'
  * });
  *
  * // With specific region
- * const euClient = new NotificationAPIClient({
+ * const euClient = new Pingram({
  *   region: 'eu',
  *   apiKey: 'pingram_sk_...'
  * });
  *
  * // With custom base URL
- * const customClient = new NotificationAPIClient({
+ * const customClient = new Pingram({
  *   apiKey: 'pingram_sk_...',
  *   baseUrl: 'https://custom.api.example.com'
  * });
@@ -80,13 +80,13 @@ function buildAuthorizationHeader(apiKey) {
  * });
  * ```
  */
-class NotificationAPIClient {
+class Pingram {
     constructor(config) {
         // Use explicit baseUrl if provided, otherwise derive from region
         const baseUrl = config.baseUrl || getRegionBaseUrl(config.region);
         // Validate that apiKey is provided
         if (!config.apiKey) {
-            throw new Error('apiKey must be provided in NotificationAPIClientConfig');
+            throw new Error('apiKey must be provided in PingramConfig');
         }
         // Auto-detect: if mock is set, use it!
         let fetchApi = config.fetchApi;
@@ -155,4 +155,4 @@ class NotificationAPIClient {
         return this.defaultApi.send(requestParameters);
     }
 }
-exports.NotificationAPIClient = NotificationAPIClient;
+exports.Pingram = Pingram;

package/dist/src/index.d.ts

@@ -18,32 +18,27 @@
  * ## Usage
  *
  * ```typescript
- * import { NotificationAPIClient } from 'pingram';
+ * import { Pingram } from 'pingram';
  *
- * // Server-side: API Key
- * const client = NotificationAPIClient.withApiKey('your-api-key');
- *
- * // Client-side: End User
- * const client = NotificationAPIClient.withEndUser('clientId', 'userId');
- *
- * // Get a user
- * const user = await client.users.usersGet({
- *   accountId: 'abc123',
- *   userId: 'user456'
+ * // Initialize with API key
+ * const client = new Pingram({
+ *   apiKey: 'pingram_sk_...'
  * });
  *
- * // Query logs
- * const { queryId } = await client.logs.logsQuery({
- *   accountId: 'abc123',
- *   logQueryPostBody: {
- *     notificationId: 'welcome_email',
- *     startDate: '2024-01-01',
- *     endDate: '2024-01-31'
+ * // Get a user
+ * const user = await client.user.getUser('user456');
+ *
+ * // Send a notification
+ * await client.send({
+ *   type: 'welcome_email',
+ *   to: {
+ *     id: 'user456',
+ *     email: 'user@example.com'
  *   }
  * });
  * ```
  */
-export { NotificationAPIClient, NotificationAPIClientConfig, NotificationAPIRegion } from './client';
-export { NotificationAPIMock } from './testing';
+export { Pingram, PingramConfig, PingramRegion } from './client';
+export { PingramMock } from './testing';
 export * from '../generated/src/models';
 export * from '../generated/src/apis';

package/dist/src/index.js

@@ -19,27 +19,22 @@
  * ## Usage
  *
  * ```typescript
- * import { NotificationAPIClient } from 'pingram';
+ * import { Pingram } from 'pingram';
  *
- * // Server-side: API Key
- * const client = NotificationAPIClient.withApiKey('your-api-key');
- *
- * // Client-side: End User
- * const client = NotificationAPIClient.withEndUser('clientId', 'userId');
- *
- * // Get a user
- * const user = await client.users.usersGet({
- *   accountId: 'abc123',
- *   userId: 'user456'
+ * // Initialize with API key
+ * const client = new Pingram({
+ *   apiKey: 'pingram_sk_...'
  * });
  *
- * // Query logs
- * const { queryId } = await client.logs.logsQuery({
- *   accountId: 'abc123',
- *   logQueryPostBody: {
- *     notificationId: 'welcome_email',
- *     startDate: '2024-01-01',
- *     endDate: '2024-01-31'
+ * // Get a user
+ * const user = await client.user.getUser('user456');
+ *
+ * // Send a notification
+ * await client.send({
+ *   type: 'welcome_email',
+ *   to: {
+ *     id: 'user456',
+ *     email: 'user@example.com'
  *   }
  * });
  * ```
@@ -59,10 +54,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationAPIMock = exports.NotificationAPIClient = void 0;
+exports.PingramMock = exports.Pingram = void 0;
 var client_1 = require("./client");
-Object.defineProperty(exports, "NotificationAPIClient", { enumerable: true, get: function () { return client_1.NotificationAPIClient; } });
+Object.defineProperty(exports, "Pingram", { enumerable: true, get: function () { return client_1.Pingram; } });
 var testing_1 = require("./testing");
-Object.defineProperty(exports, "NotificationAPIMock", { enumerable: true, get: function () { return testing_1.NotificationAPIMock; } });
+Object.defineProperty(exports, "PingramMock", { enumerable: true, get: function () { return testing_1.PingramMock; } });
 __exportStar(require("../generated/src/models"), exports);
 __exportStar(require("../generated/src/apis"), exports);

package/dist/src/testing.d.ts

@@ -5,19 +5,19 @@
  *
  * @example
  * ```typescript
- * import { NotificationAPIClient, NotificationAPIMock } from 'pingram';
+ * import { Pingram, PingramMock } from 'pingram';
  *
  * // Mock all SDK requests
- * NotificationAPIMock.mock((request) => {
+ * PingramMock.mock((request) => {
  *   expect(request.body.name).toBe('Test');
  *   return { id: 'key123', name: 'Test' };
  * });
  *
- * const client = new NotificationAPIClient({ apiKey: 'test' });
+ * const client = new Pingram({ apiKey: 'test' });
  * await client.keys.createAPIKey(...);
  *
  * // Clear mocks
- * NotificationAPIMock.clearMock();
+ * PingramMock.clearMock();
  * ```
  */
 export type MockRequest = {
@@ -33,13 +33,13 @@ export type MockImplementation = (request: MockRequest) => any | Promise<any>;
  * Pingram Testing utilities
  * Jest-style API for mocking SDK behavior
  */
-export declare const NotificationAPIMock: {
+export declare const PingramMock: {
     /**
      * Set mock implementation for all SDK requests
      * Similar to jest.fn().mockImplementation()
      *
      * @example
-     * NotificationAPIMock.mock((request) => {
+     * PingramMock.mock((request) => {
      *   expect(request.body.name).toBe('Test');
      *   return { id: 'key123' };
      * });

package/dist/src/testing.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationAPIMock = void 0;
+exports.PingramMock = void 0;
 exports.getMockImplementation = getMockImplementation;
 exports.hasMock = hasMock;
 exports.createMockFetch = createMockFetch;
@@ -10,13 +10,13 @@ let mockImplementation = null;
  * Pingram Testing utilities
  * Jest-style API for mocking SDK behavior
  */
-exports.NotificationAPIMock = {
+exports.PingramMock = {
     /**
      * Set mock implementation for all SDK requests
      * Similar to jest.fn().mockImplementation()
      *
      * @example
-     * NotificationAPIMock.mock((request) => {
+     * PingramMock.mock((request) => {
      *   expect(request.body.name).toBe('Test');
      *   return { id: 'key123' };
      * });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "0.0.2-alpha.11",
+  "version": "0.0.2-alpha.12",
   "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
   "main": "dist/index.js",
   "module": "dist/index.js",