@emilgroup/notification-sdk-node 1.4.1-beta.0 → 1.4.1-beta.14

package/.openapi-generator/FILES

@@ -4,6 +4,8 @@
 README.md
 api.ts
 api/default-api.ts
+api/email-messages-api.ts
+api/email-tracking-api.ts
 api/email-verifications-api.ts
 api/layouts-api.ts
 api/notification-templates-api.ts
@@ -21,6 +23,12 @@ models/create-notification-template-request-dto.ts
 models/create-notification-template-response-class.ts
 models/delete-layout-request-dto.ts
 models/delete-notification-template-request-dto.ts
+models/download-attachment-response-class.ts
+models/email-attachment-class.ts
+models/email-message-class.ts
+models/email-thread-class.ts
+models/get-email-message-response-class.ts
+models/get-email-thread-response-class.ts
 models/get-layout-request-dto.ts
 models/get-layout-response-class.ts
 models/get-notification-template-request-dto.ts
@@ -32,6 +40,9 @@ models/initiate-email-verification-response-class.ts
 models/inline-response200.ts
 models/inline-response503.ts
 models/layout-class.ts
+models/list-email-attachments-response-class.ts
+models/list-email-messages-response-class.ts
+models/list-email-threads-response-class.ts
 models/list-layouts-response-class.ts
 models/list-notification-templates-response-class.ts
 models/notification-template-class.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/notification-sdk-node@1.4.1-beta.0 --save
+npm install @emilgroup/notification-sdk-node@1.4.1-beta.14 --save
 ```
 or 
 ```
-yarn add @emilgroup/notification-sdk-node@1.4.1-beta.0
+yarn add @emilgroup/notification-sdk-node@1.4.1-beta.14
 ```
 
 And then you can import `LayoutApi`.

package/api/email-messages-api.ts

@@ -0,0 +1,372 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL NotificationService
+ * The EMIL NotificationService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { DownloadAttachmentResponseClass } from '../models';
+// @ts-ignore
+import { GetEmailMessageResponseClass } from '../models';
+// @ts-ignore
+import { ListEmailAttachmentsResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * EmailMessagesApi - axios parameter creator
+ * @export
+ */
+export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {number} attachmentId 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAttachment: async (code: string, attachmentId: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('downloadAttachment', 'code', code)
+            // verify required parameter 'attachmentId' is not null or undefined
+            assertParamExists('downloadAttachment', 'attachmentId', attachmentId)
+            const localVarPath = `/notificationservice/v1/email-messages/{code}/attachments/{attachmentId}/download`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)))
+                .replace(`{${"attachmentId"}}`, encodeURIComponent(String(attachmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMessage: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getMessage', 'code', code)
+            const localVarPath = `/notificationservice/v1/email-messages/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAttachments: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('listAttachments', 'code', code)
+            const localVarPath = `/notificationservice/v1/email-messages/{code}/attachments`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * EmailMessagesApi - functional programming interface
+ * @export
+ */
+export const EmailMessagesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {number} attachmentId 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadAttachment(code, attachmentId, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMessage(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listAttachments(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * EmailMessagesApi - factory interface
+ * @export
+ */
+export const EmailMessagesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = EmailMessagesApiFp(configuration)
+    return {
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {number} attachmentId 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass> {
+            return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass> {
+            return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * undefined  **Required Permissions**  none
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass> {
+            return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for downloadAttachment operation in EmailMessagesApi.
+ * @export
+ * @interface EmailMessagesApiDownloadAttachmentRequest
+ */
+export interface EmailMessagesApiDownloadAttachmentRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailMessagesApiDownloadAttachment
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailMessagesApiDownloadAttachment
+     */
+    readonly attachmentId: number
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof EmailMessagesApiDownloadAttachment
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getMessage operation in EmailMessagesApi.
+ * @export
+ * @interface EmailMessagesApiGetMessageRequest
+ */
+export interface EmailMessagesApiGetMessageRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailMessagesApiGetMessage
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof EmailMessagesApiGetMessage
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listAttachments operation in EmailMessagesApi.
+ * @export
+ * @interface EmailMessagesApiListAttachmentsRequest
+ */
+export interface EmailMessagesApiListAttachmentsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailMessagesApiListAttachments
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof EmailMessagesApiListAttachments
+     */
+    readonly authorization?: string
+}
+
+/**
+ * EmailMessagesApi - object-oriented interface
+ * @export
+ * @class EmailMessagesApi
+ * @extends {BaseAPI}
+ */
+export class EmailMessagesApi extends BaseAPI {
+    /**
+     * undefined  **Required Permissions**  none
+     * @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailMessagesApi
+     */
+    public downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig) {
+        return EmailMessagesApiFp(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * undefined  **Required Permissions**  none
+     * @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailMessagesApi
+     */
+    public getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig) {
+        return EmailMessagesApiFp(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * undefined  **Required Permissions**  none
+     * @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailMessagesApi
+     */
+    public listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig) {
+        return EmailMessagesApiFp(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}