@emilgroup/public-api-sdk-node 1.0.2 → 1.1.0

package/api/leads-api.ts

@@ -0,0 +1,482 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 { CreateLeadRequestDto } from '../models';
+// @ts-ignore
+import { CreateLeadResponseClass } from '../models';
+// @ts-ignore
+import { GetLeadResponseClass } from '../models';
+// @ts-ignore
+import { InitiateLeadResponseClass } from '../models';
+// @ts-ignore
+import { UpdateLeadRequestDto } from '../models';
+// @ts-ignore
+import { UpdateLeadResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * LeadsApi - axios parameter creator
+ * @export
+ */
+export const LeadsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+         * @summary Create the lead
+         * @param {CreateLeadRequestDto} createLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createLead: async (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createLeadRequestDto' is not null or undefined
+            assertParamExists('createLead', 'createLeadRequestDto', createLeadRequestDto)
+            const localVarPath = `/publicapi/v1/leads`;
+            // 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: 'POST', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createLeadRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+         * @summary Retrieve the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLead: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getLead', 'code', code)
+            const localVarPath = `/publicapi/v1/leads/{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,
+            };
+        },
+        /**
+         * This will initiate a lead code.
+         * @summary Initiate a lead code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        initiateLead: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/publicapi/v1/leads/initiate`;
+            // 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: 'POST', ...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,
+            };
+        },
+        /**
+         * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateLeadRequestDto} updateLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateLead: async (code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateLead', 'code', code)
+            // verify required parameter 'updateLeadRequestDto' is not null or undefined
+            assertParamExists('updateLead', 'updateLeadRequestDto', updateLeadRequestDto)
+            const localVarPath = `/publicapi/v1/leads/{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: 'PUT', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(updateLeadRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * LeadsApi - functional programming interface
+ * @export
+ */
+export const LeadsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = LeadsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+         * @summary Create the lead
+         * @param {CreateLeadRequestDto} createLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createLead(createLeadRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+         * @summary Retrieve the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLead(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This will initiate a lead code.
+         * @summary Initiate a lead code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async initiateLead(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateLeadResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.initiateLead(authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateLeadRequestDto} updateLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateLead(code, updateLeadRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * LeadsApi - factory interface
+ * @export
+ */
+export const LeadsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = LeadsApiFp(configuration)
+    return {
+        /**
+         * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+         * @summary Create the lead
+         * @param {CreateLeadRequestDto} createLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass> {
+            return localVarFp.createLead(createLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+         * @summary Retrieve the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLead(code: string, authorization?: string, options?: any): AxiosPromise<GetLeadResponseClass> {
+            return localVarFp.getLead(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This will initiate a lead code.
+         * @summary Initiate a lead code
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        initiateLead(authorization?: string, options?: any): AxiosPromise<InitiateLeadResponseClass> {
+            return localVarFp.initiateLead(authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the lead
+         * @param {string} code Unique identifier for the object.
+         * @param {UpdateLeadRequestDto} updateLeadRequestDto 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass> {
+            return localVarFp.updateLead(code, updateLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiCreateLeadRequest
+ */
+export interface LeadsApiCreateLeadRequest {
+    /**
+     * 
+     * @type {CreateLeadRequestDto}
+     * @memberof LeadsApiCreateLead
+     */
+    readonly createLeadRequestDto: CreateLeadRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiCreateLead
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiGetLeadRequest
+ */
+export interface LeadsApiGetLeadRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiGetLead
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiGetLead
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for initiateLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiInitiateLeadRequest
+ */
+export interface LeadsApiInitiateLeadRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiInitiateLead
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for updateLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiUpdateLeadRequest
+ */
+export interface LeadsApiUpdateLeadRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {UpdateLeadRequestDto}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly updateLeadRequestDto: UpdateLeadRequestDto
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly authorization?: string
+}
+
+/**
+ * LeadsApi - object-oriented interface
+ * @export
+ * @class LeadsApi
+ * @extends {BaseAPI}
+ */
+export class LeadsApi extends BaseAPI {
+    /**
+     * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+     * @summary Create the lead
+     * @param {LeadsApiCreateLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    public createLead(requestParameters: LeadsApiCreateLeadRequest, options?: AxiosRequestConfig) {
+        return LeadsApiFp(this.configuration).createLead(requestParameters.createLeadRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+     * @summary Retrieve the lead
+     * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    public getLead(requestParameters: LeadsApiGetLeadRequest, options?: AxiosRequestConfig) {
+        return LeadsApiFp(this.configuration).getLead(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This will initiate a lead code.
+     * @summary Initiate a lead code
+     * @param {LeadsApiInitiateLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    public initiateLead(requestParameters: LeadsApiInitiateLeadRequest = {}, options?: AxiosRequestConfig) {
+        return LeadsApiFp(this.configuration).initiateLead(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    public updateLead(requestParameters: LeadsApiUpdateLeadRequest, options?: AxiosRequestConfig) {
+        return LeadsApiFp(this.configuration).updateLead(requestParameters.code, requestParameters.updateLeadRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api/notifications-api.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL PublicAPI
- * The EMIL Public API description
+ * Emil PublicAPI
+ * The Emil Public 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
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
 import { SendNotificationRequestDto } from '../models';
+// @ts-ignore
+import { SendNotificationResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -33,7 +35,8 @@ const FormData = require('form-data');
 export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will send an email to the specific recipient set to receive customers\' messages.
+         * @summary Send an email.
          * @param {SendNotificationRequestDto} sendNotificationRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -89,13 +92,14 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * This will send an email to the specific recipient set to receive customers\' messages.
+         * @summary Send an email.
          * @param {SendNotificationRequestDto} sendNotificationRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+        async sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendNotificationResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.sendNotification(sendNotificationRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -110,13 +114,14 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
     const localVarFp = NotificationsApiFp(configuration)
     return {
         /**
-         * 
+         * This will send an email to the specific recipient set to receive customers\' messages.
+         * @summary Send an email.
          * @param {SendNotificationRequestDto} sendNotificationRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
+        sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: any): AxiosPromise<SendNotificationResponseClass> {
             return localVarFp.sendNotification(sendNotificationRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };
@@ -151,7 +156,8 @@ export interface NotificationsApiSendNotificationRequest {
  */
 export class NotificationsApi extends BaseAPI {
     /**
-     * 
+     * This will send an email to the specific recipient set to receive customers\' messages.
+     * @summary Send an email.
      * @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}