@notificationapi/node 0.0.2-alpha.1

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

@@ -0,0 +1,98 @@
+/**
+ * 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 { MessageResponse, PostEmailTestRequest, PostEmailTestResponse, SenderPostBody } from '../models/index';
+export interface DeleteScheduleRequest {
+    trackingId: string;
+}
+export interface TestEmailRequest {
+    postEmailTestRequest: PostEmailTestRequest;
+}
+export interface UpdateScheduleRequest {
+    senderPostBody: SenderPostBody;
+}
+/**
+ * SenderApi - interface
+ *
+ * @export
+ * @interface SenderApiInterface
+ */
+export interface SenderApiInterface {
+    /**
+     *
+     * @summary Delete (unschedule) an already scheduled notification
+     * @param {string} trackingId The tracking ID of the scheduled notification
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SenderApiInterface
+     */
+    deleteScheduleRaw(requestParameters: DeleteScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Delete (unschedule) an already scheduled notification
+     */
+    deleteSchedule(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
+    /**
+     *
+     * @summary Test the emailer with a sample email
+     * @param {PostEmailTestRequest} postEmailTestRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SenderApiInterface
+     */
+    testEmailRaw(requestParameters: TestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostEmailTestResponse>>;
+    /**
+     * Test the emailer with a sample email
+     */
+    testEmail(postEmailTestRequest: PostEmailTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostEmailTestResponse>;
+    /**
+     *
+     * @summary Update the body or schedule of an already scheduled notification.
+     * @param {SenderPostBody} senderPostBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SenderApiInterface
+     */
+    updateScheduleRaw(requestParameters: UpdateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Update the body or schedule of an already scheduled notification.
+     */
+    updateSchedule(senderPostBody: SenderPostBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
+}
+/**
+ *
+ */
+export declare class SenderApi extends runtime.BaseAPI implements SenderApiInterface {
+    /**
+     * Delete (unschedule) an already scheduled notification
+     */
+    deleteScheduleRaw(requestParameters: DeleteScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Delete (unschedule) an already scheduled notification
+     */
+    deleteSchedule(trackingId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
+    /**
+     * Test the emailer with a sample email
+     */
+    testEmailRaw(requestParameters: TestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostEmailTestResponse>>;
+    /**
+     * Test the emailer with a sample email
+     */
+    testEmail(postEmailTestRequest: PostEmailTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostEmailTestResponse>;
+    /**
+     * Update the body or schedule of an already scheduled notification.
+     */
+    updateScheduleRaw(requestParameters: UpdateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
+    /**
+     * Update the body or schedule of an already scheduled notification.
+     */
+    updateSchedule(senderPostBody: SenderPostBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
+}

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

@@ -0,0 +1,221 @@
+"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.SenderApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class SenderApi extends runtime.BaseAPI {
+    /**
+     * Delete (unschedule) an already scheduled notification
+     */
+    async deleteScheduleRaw(requestParameters, initOverrides) {
+        if (requestParameters['trackingId'] == null) {
+            throw new runtime.RequiredError('trackingId', 'Required parameter "trackingId" was null or undefined when calling deleteSchedule().');
+        }
+        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 = `/sender/scheduler/{trackingId}`;
+        urlPath = urlPath.replace(`{${'trackingId'}}`, encodeURIComponent(String(requestParameters['trackingId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MessageResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Delete (unschedule) an already scheduled notification
+     */
+    async deleteSchedule(trackingId, initOverrides) {
+        const response = await this.deleteScheduleRaw({ trackingId: trackingId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Test the emailer with a sample email
+     */
+    async testEmailRaw(requestParameters, initOverrides) {
+        if (requestParameters['postEmailTestRequest'] == null) {
+            throw new runtime.RequiredError('postEmailTestRequest', 'Required parameter "postEmailTestRequest" was null or undefined when calling testEmail().');
+        }
+        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 = `/sender/test/email`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.PostEmailTestRequestToJSON)(requestParameters['postEmailTestRequest'])
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PostEmailTestResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Test the emailer with a sample email
+     */
+    async testEmail(postEmailTestRequest, initOverrides) {
+        const response = await this.testEmailRaw({ postEmailTestRequest: postEmailTestRequest }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Update the body or schedule of an already scheduled notification.
+     */
+    async updateScheduleRaw(requestParameters, initOverrides) {
+        if (requestParameters['senderPostBody'] == null) {
+            throw new runtime.RequiredError('senderPostBody', 'Required parameter "senderPostBody" was null or undefined when calling updateSchedule().');
+        }
+        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 = `/sender/scheduler`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.SenderPostBodyToJSON)(requestParameters['senderPostBody'])
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MessageResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Update the body or schedule of an already scheduled notification.
+     */
+    async updateSchedule(senderPostBody, initOverrides) {
+        const response = await this.updateScheduleRaw({ senderPostBody: senderPostBody }, initOverrides);
+        return await response.value();
+    }
+}
+exports.SenderApi = SenderApi;

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

@@ -0,0 +1,196 @@
+/**
+ * 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 { DeleteTemplateResponse, GetTemplatesResponse, SetDefaultTemplateRequest, Template, TemplatePatchRequest, TemplatePostRequest } from '../models/index';
+export interface CreateTemplateRequest {
+    notificationId: string;
+    channel: string;
+    templatePostRequest: TemplatePostRequest;
+}
+export interface DeleteTemplateRequest {
+    notificationId: string;
+    channel: string;
+    templateId: string;
+}
+export interface InitiateMigrationRequest {
+    notificationId: string;
+    channel: string;
+    templateId: string;
+}
+export interface ListTemplatesRequest {
+    notificationId: string;
+    channel: string;
+    templateId: string;
+}
+export interface SetDefaultTemplateOperationRequest {
+    notificationId: string;
+    channel: string;
+    setDefaultTemplateRequest: SetDefaultTemplateRequest;
+}
+export interface UpdateTemplateRequest {
+    notificationId: string;
+    channel: string;
+    templateId: string;
+    templatePatchRequest: TemplatePatchRequest;
+}
+/**
+ * TemplatesApi - interface
+ *
+ * @export
+ * @interface TemplatesApiInterface
+ */
+export interface TemplatesApiInterface {
+    /**
+     *
+     * @summary Create a new template for a notification
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {TemplatePostRequest} templatePostRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    createTemplateRaw(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Create a new template for a notification
+     */
+    createTemplate(notificationId: string, channel: string, templatePostRequest: TemplatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     *
+     * @summary Delete a template
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {string} templateId Template ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    deleteTemplateRaw(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteTemplateResponse>>;
+    /**
+     * Delete a template
+     */
+    deleteTemplate(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteTemplateResponse>;
+    /**
+     *
+     * @summary Initiate AI-powered template migration from complex to simple HTML
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {string} templateId Template ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    initiateMigrationRaw(requestParameters: InitiateMigrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Initiate AI-powered template migration from complex to simple HTML
+     */
+    initiateMigration(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     *
+     * @summary Get template(s) for a notification
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {string} templateId Template ID (optional for listing all)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    listTemplatesRaw(requestParameters: ListTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTemplatesResponse>>;
+    /**
+     * Get template(s) for a notification
+     */
+    listTemplates(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTemplatesResponse>;
+    /**
+     *
+     * @summary Set a template as default for specific delivery modes
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {SetDefaultTemplateRequest} setDefaultTemplateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    setDefaultTemplateRaw(requestParameters: SetDefaultTemplateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Set a template as default for specific delivery modes
+     */
+    setDefaultTemplate(notificationId: string, channel: string, setDefaultTemplateRequest: SetDefaultTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     *
+     * @summary Update a template\'s properties
+     * @param {string} notificationId Notification ID
+     * @param {string} channel Channel type
+     * @param {string} templateId Template ID
+     * @param {TemplatePatchRequest} templatePatchRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApiInterface
+     */
+    updateTemplateRaw(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Update a template\'s properties
+     */
+    updateTemplate(notificationId: string, channel: string, templateId: string, templatePatchRequest: TemplatePatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+}
+/**
+ *
+ */
+export declare class TemplatesApi extends runtime.BaseAPI implements TemplatesApiInterface {
+    /**
+     * Create a new template for a notification
+     */
+    createTemplateRaw(requestParameters: CreateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Create a new template for a notification
+     */
+    createTemplate(notificationId: string, channel: string, templatePostRequest: TemplatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     * Delete a template
+     */
+    deleteTemplateRaw(requestParameters: DeleteTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteTemplateResponse>>;
+    /**
+     * Delete a template
+     */
+    deleteTemplate(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteTemplateResponse>;
+    /**
+     * Initiate AI-powered template migration from complex to simple HTML
+     */
+    initiateMigrationRaw(requestParameters: InitiateMigrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Initiate AI-powered template migration from complex to simple HTML
+     */
+    initiateMigration(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     * Get template(s) for a notification
+     */
+    listTemplatesRaw(requestParameters: ListTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTemplatesResponse>>;
+    /**
+     * Get template(s) for a notification
+     */
+    listTemplates(notificationId: string, channel: string, templateId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTemplatesResponse>;
+    /**
+     * Set a template as default for specific delivery modes
+     */
+    setDefaultTemplateRaw(requestParameters: SetDefaultTemplateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Set a template as default for specific delivery modes
+     */
+    setDefaultTemplate(notificationId: string, channel: string, setDefaultTemplateRequest: SetDefaultTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+    /**
+     * Update a template\'s properties
+     */
+    updateTemplateRaw(requestParameters: UpdateTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Template>>;
+    /**
+     * Update a template\'s properties
+     */
+    updateTemplate(notificationId: string, channel: string, templateId: string, templatePatchRequest: TemplatePatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Template>;
+}