@notificationapi/node 0.0.2-alpha.1

package/README.md

@@ -0,0 +1,66 @@
+# NotificationAPI Node SDK (Server-side)
+
+[![npm version](https://badge.fury.io/js/%40notificationapi%2Fnode.svg)](https://www.npmjs.com/package/@notificationapi/node)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A fully-typed TypeScript SDK for NotificationAPI.
+
+## Installation
+
+### Production (latest stable)
+
+```bash
+npm install @notificationapi/node
+```
+
+## Usage
+
+### Basic Setup
+
+Import and initialize the client:
+
+```typescript
+import { NotificationAPIClient } from '@notificationapi/js';
+
+// Server-side: Secret Key (Bearer token)
+const apiClient = new NotificationAPIClient({
+  apiKey: 'pingram_sk_...'
+});
+```
+
+For connecting to Canada or EU regions, set the region option:
+
+```typescript
+const apiClient = new NotificationAPIClient({
+  apiKey: 'pingram_sk_...',
+  region: 'eu'
+});
+```
+
+### Send
+
+```typescript
+await apiClient.send({
+  type: 'otp',
+  to: {
+    id: 'user123',
+    email: 'user@example.com',
+    number: '+15005550006'
+  },
+  email: {
+    subject: 'Hello',
+    html: '<h1>Hello, world!</h1>'
+  },
+  sms: {
+    message: 'Hello, world!'
+  }
+});
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines before submitting a pull request.

package/dist/generated/src/apis/AccountApi.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { AccountGetResponse, BillingPostRequestBody, BillingPostResponseBody, CreateAccountRequestBody, CreateAccountResponse } from '../models/index';
+export interface PrepareCheckoutSessionRequest {
+    billingPostRequestBody: BillingPostRequestBody;
+}
+export interface UpdateAccountRequest {
+    createAccountRequestBody: CreateAccountRequestBody;
+}
+/**
+ * AccountApi - interface
+ *
+ * @export
+ * @interface AccountApiInterface
+ */
+export interface AccountApiInterface {
+    /**
+     *
+     * @summary Get account information for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    getAccountDetailsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountGetResponse>>;
+    /**
+     * Get account information for the authenticated user
+     */
+    getAccountDetails(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountGetResponse>;
+    /**
+     *
+     * @summary Get or create Stripe customer and optionally create checkout session
+     * @param {BillingPostRequestBody} billingPostRequestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    prepareCheckoutSessionRaw(requestParameters: PrepareCheckoutSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingPostResponseBody>>;
+    /**
+     * Get or create Stripe customer and optionally create checkout session
+     */
+    prepareCheckoutSession(billingPostRequestBody: BillingPostRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingPostResponseBody>;
+    /**
+     *
+     * @summary Create or update an account name
+     * @param {CreateAccountRequestBody} createAccountRequestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    updateAccountRaw(requestParameters: UpdateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
+    /**
+     * Create or update an account name
+     */
+    updateAccount(createAccountRequestBody: CreateAccountRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
+}
+/**
+ *
+ */
+export declare class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
+    /**
+     * Get account information for the authenticated user
+     */
+    getAccountDetailsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountGetResponse>>;
+    /**
+     * Get account information for the authenticated user
+     */
+    getAccountDetails(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountGetResponse>;
+    /**
+     * Get or create Stripe customer and optionally create checkout session
+     */
+    prepareCheckoutSessionRaw(requestParameters: PrepareCheckoutSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BillingPostResponseBody>>;
+    /**
+     * Get or create Stripe customer and optionally create checkout session
+     */
+    prepareCheckoutSession(billingPostRequestBody: BillingPostRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BillingPostResponseBody>;
+    /**
+     * Create or update an account name
+     */
+    updateAccountRaw(requestParameters: UpdateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
+    /**
+     * Create or update an account name
+     */
+    updateAccount(createAccountRequestBody: CreateAccountRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
+}

package/dist/generated/src/apis/AccountApi.js

@@ -0,0 +1,217 @@
+"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.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AccountApi extends runtime.BaseAPI {
+    /**
+     * Get account information for the authenticated user
+     */
+    async getAccountDetailsRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('apiKey', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        let urlPath = `/account`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AccountGetResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Get account information for the authenticated user
+     */
+    async getAccountDetails(initOverrides) {
+        const response = await this.getAccountDetailsRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Get or create Stripe customer and optionally create checkout session
+     */
+    async prepareCheckoutSessionRaw(requestParameters, initOverrides) {
+        if (requestParameters['billingPostRequestBody'] == null) {
+            throw new runtime.RequiredError('billingPostRequestBody', 'Required parameter "billingPostRequestBody" was null or undefined when calling prepareCheckoutSession().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('apiKey', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        let urlPath = `/billing`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.BillingPostRequestBodyToJSON)(requestParameters['billingPostRequestBody'])
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BillingPostResponseBodyFromJSON)(jsonValue));
+    }
+    /**
+     * Get or create Stripe customer and optionally create checkout session
+     */
+    async prepareCheckoutSession(billingPostRequestBody, initOverrides) {
+        const response = await this.prepareCheckoutSessionRaw({ billingPostRequestBody: billingPostRequestBody }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Create or update an account name
+     */
+    async updateAccountRaw(requestParameters, initOverrides) {
+        if (requestParameters['createAccountRequestBody'] == null) {
+            throw new runtime.RequiredError('createAccountRequestBody', 'Required parameter "createAccountRequestBody" was null or undefined when calling updateAccount().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('apiKey', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        let urlPath = `/account`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateAccountRequestBodyToJSON)(requestParameters['createAccountRequestBody'])
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateAccountResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Create or update an account name
+     */
+    async updateAccount(createAccountRequestBody, initOverrides) {
+        const response = await this.updateAccountRaw({ createAccountRequestBody: createAccountRequestBody }, initOverrides);
+        return await response.value();
+    }
+}
+exports.AccountApi = AccountApi;

package/dist/generated/src/apis/ComponentsApi.d.ts

@@ -0,0 +1,168 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { EmailComponentPatchRequest, EmailComponentPostRequest, EmailComponentResponse, GetEmailComponentsResponseInner, SuccessResponse } from '../models/index';
+export interface CreateComponentRequest {
+    emailComponentPostRequest: EmailComponentPostRequest;
+}
+export interface DeleteComponentRequest {
+    componentId: string;
+}
+export interface GetComponentRequest {
+    componentId: string;
+}
+export interface ListComponentsRequest {
+    channel: string;
+}
+export interface PatchComponentRequest {
+    componentId: string;
+    emailComponentPatchRequest: EmailComponentPatchRequest;
+}
+/**
+ * ComponentsApi - interface
+ *
+ * @export
+ * @interface ComponentsApiInterface
+ */
+export interface ComponentsApiInterface {
+    /**
+     *
+     * @summary Create a new component
+     * @param {EmailComponentPostRequest} emailComponentPostRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    createComponentRaw(requestParameters: CreateComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Create a new component
+     */
+    createComponent(emailComponentPostRequest: EmailComponentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+    /**
+     *
+     * @summary Delete a component
+     * @param {string} componentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    deleteComponentRaw(requestParameters: DeleteComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResponse>>;
+    /**
+     * Delete a component
+     */
+    deleteComponent(componentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
+    /**
+     *
+     * @summary Get a specific component by ID
+     * @param {string} componentId Component ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    getComponentRaw(requestParameters: GetComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Get a specific component by ID
+     */
+    getComponent(componentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+    /**
+     *
+     * @summary List email components
+     * @param {string} channel Channel type (EMAIL, SMS, etc.)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    listComponentsRaw(requestParameters: ListComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetEmailComponentsResponseInner>>>;
+    /**
+     * List email components
+     */
+    listComponents(channel: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetEmailComponentsResponseInner>>;
+    /**
+     *
+     * @summary List all account components with the internal JSON parsed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    listComponentsParsedRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<any>>>;
+    /**
+     * List all account components with the internal JSON parsed
+     */
+    listComponentsParsed(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<any>>;
+    /**
+     *
+     * @summary Update a component\'s properties
+     * @param {string} componentId Component ID
+     * @param {EmailComponentPatchRequest} emailComponentPatchRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    patchComponentRaw(requestParameters: PatchComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Update a component\'s properties
+     */
+    patchComponent(componentId: string, emailComponentPatchRequest: EmailComponentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+}
+/**
+ *
+ */
+export declare class ComponentsApi extends runtime.BaseAPI implements ComponentsApiInterface {
+    /**
+     * Create a new component
+     */
+    createComponentRaw(requestParameters: CreateComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Create a new component
+     */
+    createComponent(emailComponentPostRequest: EmailComponentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+    /**
+     * Delete a component
+     */
+    deleteComponentRaw(requestParameters: DeleteComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessResponse>>;
+    /**
+     * Delete a component
+     */
+    deleteComponent(componentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
+    /**
+     * Get a specific component by ID
+     */
+    getComponentRaw(requestParameters: GetComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Get a specific component by ID
+     */
+    getComponent(componentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+    /**
+     * List email components
+     */
+    listComponentsRaw(requestParameters: ListComponentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetEmailComponentsResponseInner>>>;
+    /**
+     * List email components
+     */
+    listComponents(channel: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetEmailComponentsResponseInner>>;
+    /**
+     * List all account components with the internal JSON parsed
+     */
+    listComponentsParsedRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<any>>>;
+    /**
+     * List all account components with the internal JSON parsed
+     */
+    listComponentsParsed(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<any>>;
+    /**
+     * Update a component\'s properties
+     */
+    patchComponentRaw(requestParameters: PatchComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailComponentResponse>>;
+    /**
+     * Update a component\'s properties
+     */
+    patchComponent(componentId: string, emailComponentPatchRequest: EmailComponentPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailComponentResponse>;
+}