@notificationapi/node 0.0.2-alpha.1

package/dist/generated/src/runtime.js

@@ -0,0 +1,344 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * NotificationAPI
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
+exports.querystring = querystring;
+exports.exists = exists;
+exports.mapValues = mapValues;
+exports.canConsumeForm = canConsumeForm;
+exports.BASE_PATH = 'https://api.notificationapi.com'.replace(/\/+$/, '');
+class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null
+            ? this.configuration.basePath
+            : exports.BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function'
+                ? accessToken
+                : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+exports.Configuration = Configuration;
+exports.DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+class BaseAPI {
+    constructor(configuration = exports.DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = async (url, init) => {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams =
+                        (await middleware.pre({
+                            fetch: this.fetchApi,
+                            ...fetchParams
+                        })) || fetchParams;
+                }
+            }
+            let response = undefined;
+            try {
+                response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            }
+            catch (e) {
+                for (const middleware of this.middleware) {
+                    if (middleware.onError) {
+                        response =
+                            (await middleware.onError({
+                                fetch: this.fetchApi,
+                                url: fetchParams.url,
+                                init: fetchParams.init,
+                                error: e,
+                                response: response ? response.clone() : undefined
+                            })) || response;
+                    }
+                }
+                if (response === undefined) {
+                    if (e instanceof Error) {
+                        throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response =
+                        (await middleware.post({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            response: response.clone()
+                        })) || response;
+                }
+            }
+            return response;
+        };
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && response.status >= 200 && response.status < 300) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined &&
+            Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach((key) => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === 'function'
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials
+        };
+        const overriddenInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context
+            }))
+        };
+        let body;
+        if (isFormData(overriddenInit.body) ||
+            overriddenInit.body instanceof URLSearchParams ||
+            isBlob(overriddenInit.body)) {
+            body = overriddenInit.body;
+        }
+        else if (this.isJsonMime(headers['Content-Type'])) {
+            body = JSON.stringify(overriddenInit.body);
+        }
+        else {
+            body = overriddenInit.body;
+        }
+        const init = {
+            ...overriddenInit,
+            body
+        };
+        return { url, init };
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+exports.BaseAPI = BaseAPI;
+BaseAPI.jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== 'undefined' && value instanceof FormData;
+}
+class ResponseError extends Error {
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        this.name = 'ResponseError';
+    }
+}
+exports.ResponseError = ResponseError;
+class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = 'FetchError';
+    }
+}
+exports.FetchError = FetchError;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = 'RequiredError';
+    }
+}
+exports.RequiredError = RequiredError;
+exports.COLLECTION_FORMATS = {
+    csv: ',',
+    ssv: ' ',
+    tsv: '\t',
+    pipes: '|'
+};
+function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map((key) => querystringSingleKey(key, params[key], prefix))
+        .filter((part) => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value
+            .map((singleValue) => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+exports.JSONApiResponse = JSONApiResponse;
+class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+exports.VoidApiResponse = VoidApiResponse;
+class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+}
+exports.BlobApiResponse = BlobApiResponse;
+class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+}
+exports.TextApiResponse = TextApiResponse;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * NotificationAPI TypeScript SDK
+ *
+ * Main entry point for the SDK
+ */
+export * from './src/index';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * NotificationAPI TypeScript SDK
+ *
+ * Main entry point for the SDK
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./src/index"), exports);

package/dist/src/client.d.ts

@@ -0,0 +1,111 @@
+/**
+ * This file is auto-generated by generate-client.ts
+ * DO NOT EDIT MANUALLY - changes will be overwritten
+ * Edit templates/client-wrapper.mustache instead
+ */
+import { AccountApi } from '../generated/src';
+import { ComponentsApi } from '../generated/src';
+import { DomainsApi } from '../generated/src';
+import { EditorApi } from '../generated/src';
+import { EnvironmentsApi } from '../generated/src';
+import { HealthApi } from '../generated/src';
+import { InsightsApi } from '../generated/src';
+import { KeysApi } from '../generated/src';
+import { LogsApi } from '../generated/src';
+import { SenderApi } from '../generated/src';
+import { TemplatesApi } from '../generated/src';
+import { TypesApi } from '../generated/src';
+import { UserApi } from '../generated/src';
+import { UsersApi } from '../generated/src';
+import { DefaultApi } from '../generated/src';
+/**
+ * Supported NotificationAPI regions
+ */
+export type NotificationAPIRegion = 'us' | 'eu' | 'ca';
+/**
+ * Configuration options for the NotificationAPI client
+ */
+export interface NotificationAPIClientConfig {
+    /**
+     * API region (defaults to 'us')
+     * - 'us': api.notificationapi.com (default)
+     * - 'eu': api.eu.notificationapi.com
+     * - 'ca': api.ca.notificationapi.com
+     */
+    region?: NotificationAPIRegion;
+    /**
+     * Base URL for the API (overrides region setting)
+     * Only use this if you need a custom endpoint
+     */
+    baseUrl?: string;
+    /**
+     * API Key - Secret key (pingram_sk_...) for server-side authentication
+     */
+    apiKey: string;
+    /**
+     * Optional additional headers
+     */
+    headers?: Record<string, string>;
+    /**
+     * Optional fetch implementation (defaults to global fetch)
+     */
+    fetchApi?: typeof fetch;
+}
+/**
+ * NotificationAPI Client
+ *
+ * A typed client for the NotificationAPI Internal API.
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with default US region
+ * const client = new NotificationAPIClient({
+ *   apiKey: 'pingram_sk_...'
+ * });
+ *
+ * // With specific region
+ * const euClient = new NotificationAPIClient({
+ *   region: 'eu',
+ *   apiKey: 'pingram_sk_...'
+ * });
+ *
+ * // With custom base URL
+ * const customClient = new NotificationAPIClient({
+ *   apiKey: 'pingram_sk_...',
+ *   baseUrl: 'https://custom.api.example.com'
+ * });
+ *
+ * // Usage
+ * const user = await client.users.usersGet({
+ *   accountId: 'abc123',
+ *   userId: 'user456'
+ * });
+ * ```
+ */
+export declare class NotificationAPIClient {
+    private config;
+    account: AccountApi;
+    components: ComponentsApi;
+    domains: DomainsApi;
+    editor: EditorApi;
+    environments: EnvironmentsApi;
+    health: HealthApi;
+    insights: InsightsApi;
+    keys: KeysApi;
+    logs: LogsApi;
+    sender: SenderApi;
+    templates: TemplatesApi;
+    types: TypesApi;
+    user: UserApi;
+    users: UsersApi;
+    private defaultApi;
+    constructor(config: NotificationAPIClientConfig);
+    /**
+     * Update the base URL (overrides region)
+     */
+    setBaseUrl(baseUrl: string): void;
+    /**
+     * send
+     */
+    send(requestParameters: Parameters<DefaultApi['send']>[0]): Promise<import("../generated/src").SenderPostResponse>;
+}

package/dist/src/client.js

@@ -0,0 +1,141 @@
+"use strict";
+/**
+ * This file is auto-generated by generate-client.ts
+ * DO NOT EDIT MANUALLY - changes will be overwritten
+ * Edit templates/client-wrapper.mustache instead
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationAPIClient = void 0;
+const src_1 = require("../generated/src");
+const src_2 = require("../generated/src");
+const src_3 = require("../generated/src");
+const src_4 = require("../generated/src");
+const src_5 = require("../generated/src");
+const src_6 = require("../generated/src");
+const src_7 = require("../generated/src");
+const src_8 = require("../generated/src");
+const src_9 = require("../generated/src");
+const src_10 = require("../generated/src");
+const src_11 = require("../generated/src");
+const src_12 = require("../generated/src");
+const src_13 = require("../generated/src");
+const src_14 = require("../generated/src");
+const src_15 = require("../generated/src");
+const src_16 = require("../generated/src");
+const testing_1 = require("./testing");
+/**
+ * Get the base URL for a given region
+ */
+function getRegionBaseUrl(region = 'us') {
+    const regionUrls = {
+        us: 'https://api.notificationapi.com',
+        eu: 'https://api.eu.notificationapi.com',
+        ca: 'https://api.ca.notificationapi.com'
+    };
+    return regionUrls[region];
+}
+/**
+ * Build the Authorization header for API key authentication
+ */
+function buildAuthorizationHeader(apiKey) {
+    return `Bearer ${apiKey}`;
+}
+/**
+ * NotificationAPI Client
+ *
+ * A typed client for the NotificationAPI Internal API.
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with default US region
+ * const client = new NotificationAPIClient({
+ *   apiKey: 'pingram_sk_...'
+ * });
+ *
+ * // With specific region
+ * const euClient = new NotificationAPIClient({
+ *   region: 'eu',
+ *   apiKey: 'pingram_sk_...'
+ * });
+ *
+ * // With custom base URL
+ * const customClient = new NotificationAPIClient({
+ *   apiKey: 'pingram_sk_...',
+ *   baseUrl: 'https://custom.api.example.com'
+ * });
+ *
+ * // Usage
+ * const user = await client.users.usersGet({
+ *   accountId: 'abc123',
+ *   userId: 'user456'
+ * });
+ * ```
+ */
+class NotificationAPIClient {
+    constructor(config) {
+        // Use explicit baseUrl if provided, otherwise derive from region
+        const baseUrl = config.baseUrl || getRegionBaseUrl(config.region);
+        // Build the authorization header
+        const authHeader = buildAuthorizationHeader(config.apiKey);
+        // Auto-detect: if mock is set, use it!
+        let fetchApi = config.fetchApi;
+        if (!fetchApi && (0, testing_1.hasMock)()) {
+            fetchApi = (0, testing_1.createMockFetch)();
+        }
+        this.config = new src_1.Configuration({
+            basePath: baseUrl,
+            headers: {
+                Authorization: authHeader,
+                'Content-Type': 'application/json',
+                ...config.headers
+            },
+            fetchApi: fetchApi
+        });
+        this.account = new src_2.AccountApi(this.config);
+        this.components = new src_3.ComponentsApi(this.config);
+        this.domains = new src_4.DomainsApi(this.config);
+        this.editor = new src_5.EditorApi(this.config);
+        this.environments = new src_6.EnvironmentsApi(this.config);
+        this.health = new src_7.HealthApi(this.config);
+        this.insights = new src_8.InsightsApi(this.config);
+        this.keys = new src_9.KeysApi(this.config);
+        this.logs = new src_10.LogsApi(this.config);
+        this.sender = new src_11.SenderApi(this.config);
+        this.templates = new src_12.TemplatesApi(this.config);
+        this.types = new src_13.TypesApi(this.config);
+        this.user = new src_14.UserApi(this.config);
+        this.users = new src_15.UsersApi(this.config);
+        this.defaultApi = new src_16.DefaultApi(this.config);
+    }
+    /**
+     * Update the base URL (overrides region)
+     */
+    setBaseUrl(baseUrl) {
+        this.config = new src_1.Configuration({
+            ...this.config,
+            basePath: baseUrl
+        });
+        this.account = new src_2.AccountApi(this.config);
+        this.components = new src_3.ComponentsApi(this.config);
+        this.domains = new src_4.DomainsApi(this.config);
+        this.editor = new src_5.EditorApi(this.config);
+        this.environments = new src_6.EnvironmentsApi(this.config);
+        this.health = new src_7.HealthApi(this.config);
+        this.insights = new src_8.InsightsApi(this.config);
+        this.keys = new src_9.KeysApi(this.config);
+        this.logs = new src_10.LogsApi(this.config);
+        this.sender = new src_11.SenderApi(this.config);
+        this.templates = new src_12.TemplatesApi(this.config);
+        this.types = new src_13.TypesApi(this.config);
+        this.user = new src_14.UserApi(this.config);
+        this.users = new src_15.UsersApi(this.config);
+        this.defaultApi = new src_16.DefaultApi(this.config);
+    }
+    /**
+     * send
+     */
+    async send(requestParameters) {
+        return this.defaultApi.send(requestParameters);
+    }
+}
+exports.NotificationAPIClient = NotificationAPIClient;

package/dist/src/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @packageDocumentation
+ * NotificationAPI Internal SDK
+ *
+ * A fully typed TypeScript client for the NotificationAPI Internal API.
+ *
+ * ## Installation
+ *
+ * This is an internal SDK. Import directly from the source or build the package locally.
+ *
+ * ## Authentication
+ *
+ * The SDK supports three authentication methods:
+ * - **API Key** (Bearer) - Server-side project auth
+ * - **End User** (Basic) - Client-side with clientId/userId
+ * - **End User Hashed** (Basic) - Client-side with clientId/userId/hashedUserId
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * import { NotificationAPIClient } from '@notificationapi/internal-sdk';
+ *
+ * // 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'
+ * });
+ *
+ * // Query logs
+ * const { queryId } = await client.logs.logsQuery({
+ *   accountId: 'abc123',
+ *   logQueryPostBody: {
+ *     notificationId: 'welcome_email',
+ *     startDate: '2024-01-01',
+ *     endDate: '2024-01-31'
+ *   }
+ * });
+ * ```
+ */
+export { NotificationAPIClient, NotificationAPIClientConfig, NotificationAPIRegion } from './client';
+export { NotificationAPIMock } from './testing';
+export * from '../generated/src/models';
+export * from '../generated/src/apis';