@futdevpro/nts-dynamo 1.9.15 → 1.9.16

package/src/_services/core/api.service.ts

@@ -1,453 +1,453 @@
-
-import * as Axios from 'axios';
-import { 
-  DynamoFM_AnyError, DynamoFM_Error, DynamoFM_Error_Settings, DynamoFM_Log 
-} from '@futdevpro/fsm-dynamo';
-
-import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
-import { DynamoNTS_HttpResponseType } from '../../_enums/http/http-response-type.enum';
-import {
-  DynamoNTS_ApiCall_Params
-} from '../../_models/control-models/api-call-params.control-model';
-import { DynamoNTS_globalSettings } from '../../_constants';
-
-export interface DynamoNTS_ApiCallInput_Params<T_Body = any> {
-  pathParams?: {
-    /**
-     * path params setted in endpoint
-     */
-    [param: string]: string;
-  };
-  /**
-   * api call's body
-   */
-  body?: T_Body;
-}
-
-/**
- * This predefined Api service contains the basic API call function which can be used in various ways
- */
-export class DynamoNTS_ApiService {
-
-  static defaultErrorUserMsg =
-    `We encountered a BackEnd API Error, ` +
-    `\nplease contact the responsible development team.\n` +
-    `\n(Internal BE to BE error)`;
-
-  /**
-   * if the callParams.getFullResponse is set to true, 
-   * use the Axios.AxiosResponse type as T_Response
-   * 
-   * @param callParams 
-   * @param inputParams 
-   * @returns 
-   */
-  public static async startApiCall<T_Response, T_Body = any>(
-    /**
-     * you must setup the basic api call params with this.
-     * follow the instructions in the constructor: new DynamoNTS_ApiCallParams({ ... })
-     */
-    callParams: DynamoNTS_ApiCall_Params,
-    /**
-     * you can pass data and other inputs in this section
-     */
-    inputParams?: DynamoNTS_ApiCallInput_Params<T_Body>
-  ): Promise<T_Response /* | Axios.AxiosResponse */> {
-    try {
-      let a: T_Response;
-      let url: string = callParams.baseUrl + callParams.endPoint;
-      const axios = Axios.default.create();
-
-      if (callParams?.httpOptions?.headers) {
-        this.setupHeaders(callParams, axios);
-      }
-
-      if (inputParams?.pathParams) {
-        url = this.setupPathParams(inputParams.pathParams, url);
-      }
-
-      /* if (inputParams?.queryParams) {
-        this.setupQueryParams<T_Body>(inputParams, callParams);
-      } */
-
-      if (DynamoNTS_globalSettings.logApiEvents) {
-        this.logEvent(url, inputParams, callParams);
-      }
-
-      switch (callParams.type) {
-        case DynamoNTS_HttpCallType.get:
-          if (inputParams?.body) {
-            DynamoFM_Log.warn('WARNING you cant send body in get calls');
-          }
-
-          a = await this.get<T_Response>(axios, url, callParams);
-          break;
-
-        case DynamoNTS_HttpCallType.delete:
-          if (inputParams?.body) {
-            DynamoFM_Log.warn('WARNING you cant send body in delete calls');
-          }
-
-          a = await this.delete<T_Response>(axios, url, callParams);
-          break;
-
-        case DynamoNTS_HttpCallType.post:
-        case DynamoNTS_HttpCallType.put:
-        case DynamoNTS_HttpCallType.patch:
-          if (!inputParams?.body) {
-            if (!inputParams) {
-              inputParams = {};
-            }
-
-            inputParams.body = {} as T_Body;
-          }
-
-          a = await this.postPutPatch<T_Response, T_Body>(axios, callParams, url, inputParams);
-          break;
-
-        default:
-          throw new DynamoFM_Error({
-            ...this._getDefaultErrorSettings(
-              'startApiCall',
-              new Error('wrong api call type')
-            ),
-            errorCode: 'NTS-API-SAC0',
-            additionalContent: {
-              callParams,
-              inputParams,
-            },
-          });
-          //DynamoFM_Log.error('DYNAMO-NTS ERROR: \n wrong api call type'/* , '\n\n', new Error() */);
-          break;
-      }
-
-      if (callParams.getFullResponse) {
-        return a as T_Response /* Axios.AxiosResponse */;
-
-      } else {
-        return a as T_Response;
-      }
-    } catch (error) {
-      this.handleError<T_Body>(callParams, error, inputParams);
-    }
-  }
-
-  /* private static setupQueryParams<T_Body = any>(
-    inputParams: DynamoNTS_ApiCallInputParams<T_Body>, callParams: DynamoNTS_ApiCallParams) {
-    const httpParams = new HttpParams();
-
-    for (const queryParamKey in inputParams.queryParams) {
-      if (inputParams.queryParams[queryParamKey]) {
-        switch (typeof inputParams.queryParams[queryParamKey]) {
-          case 'number':
-            httpParams.set(queryParamKey, inputParams.queryParams[queryParamKey].toString());
-            break;
-
-          case 'string':
-            httpParams.set(queryParamKey, inputParams.queryParams[queryParamKey]);
-            break;
-
-          default:
-            console.error('DYNAMO-NTS ERROR: \n wrong query param type', '\n\n', new Error());
-            break;
-        }
-      }
-    }
-    callParams.httpOptions.params = httpParams;
-  } */
-
-  private static handleError<T_Body>(
-    callParams: DynamoNTS_ApiCall_Params,
-    error: any,
-    inputParams: {
-      pathParams?: { [param: string]: string; };
-      /**
-       * api call's body
-       */
-      body?: T_Body;
-    }
-  ): void {
-    DynamoFM_Log.error(
-      `\n--->   API ERROR: '${callParams?.name}' failed...` +
-      `\n${callParams?.baseUrl}${callParams?.endPoint}`
-    );
-
-    if (DynamoNTS_globalSettings.logDetailedErrors) {
-      DynamoFM_Log.error(`\ncallParams:`, callParams);
-    }
-
-    if (error && callParams?.httpOptions?.responseType === DynamoNTS_HttpResponseType.text) {
-      error.error = JSON.parse(error?.error);
-    }
-
-    if ((error?.response?.data as DynamoFM_Error)?.flag?.includes('DYNAMO')) {
-      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
-
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          callParams.name + ' startApiCall',
-          error.response.data
-        ),
-
-        errorCode: 'NTS-API-SAC1',
-        message: 'API call failed on the other end! error response found...',
-        additionalContent: {
-          callParams,
-          inputParams,
-        },
-      });
-
-    } else if (error.code === 'ENOTFOUND') {
-      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
-
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          callParams.name + ' startApiCall',
-          error
-        ),
-
-        status: 404,
-        errorCode: 'NTS-API-SAC2',
-        message: 'DNS error; address cannot be resolved!',
-        additionalContent: {
-          callParams,
-          inputParams,
-        },
-      });
-
-    } else if (error.code === 'ECONNREFUSED') {
-      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
-
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          callParams.name + ' startApiCall',
-          error
-        ),
-
-        status: 404,
-        errorCode: 'NTS-API-SAC3',
-        message: `Can't connect to the endpoint!`,
-        additionalContent: {
-          callParams,
-          inputParams,
-        },
-      });
-
-    } else if (error.config && error.message) {
-
-      throw new DynamoFM_Error({
-        ...this._getDefaultErrorSettings(
-          callParams.name + ' startApiCall',
-          error
-        ),
-
-        status: +error.message.substring(error.message.length - 4, 3),
-        errorCode: 'NTS-API-SAC4',
-        additionalContent: {
-          callParams,
-          inputParams,
-        },
-      });
-    } else {
-      DynamoFM_Log.error(
-        `\n${callParams.name} was UNSUCCESSFUL`, 
-        error /*, '\n\n' , new Error() */
-      );
-
-      throw error;
-    }
-  }
-
-  private static async postPutPatch<T_Response, T_Body>(
-    axios: Axios.AxiosInstance,
-    callParams: DynamoNTS_ApiCall_Params,
-    url: string,
-    inputParams: DynamoNTS_ApiCallInput_Params<T_Body>
-  ): Promise<T_Response> {
-    return await axios[callParams.type]<T_Response>(
-      url,
-      inputParams.body,
-      callParams.httpOptions
-    ).then((res: Axios.AxiosResponse): T_Response => {
-      if (DynamoNTS_globalSettings.logApiEvents) {
-        if (DynamoNTS_globalSettings.logApiResponseContents) {
-          DynamoFM_Log.success(`--->   '${callParams.name}' api call was successful`, res.data);
-
-        } else {
-          DynamoFM_Log.success(`--->   '${callParams.name}' api call was successful`);
-        }
-      }
-
-      if (callParams.getFullResponse) {
-        return res as T_Response;
-      } else {
-        return res.data;
-      }
-    });
-  }
-
-  private static async delete<T_Response>(
-    axios: Axios.AxiosInstance,
-    url: string,
-    callParams: DynamoNTS_ApiCall_Params
-  ): Promise<T_Response> {
-    return await axios.delete<T_Response>(url, callParams.httpOptions).then(
-      (res: Axios.AxiosResponse): T_Response => {
-        if (DynamoNTS_globalSettings.logApiEvents) {
-          if (DynamoNTS_globalSettings.logApiResponseContents) {
-            DynamoFM_Log.success(`'${callParams.name}' was successful`, res.data);
-          } else {
-            DynamoFM_Log.success(`'${callParams.name}' was successful`);
-          }
-        }
-
-        if (callParams.getFullResponse) {
-          return res as T_Response;
-        }
-      }
-    );
-  }
-
-  private static async get<T_Response>(
-    axios: Axios.AxiosInstance,
-    url: string,
-    callParams: DynamoNTS_ApiCall_Params
-  ): Promise<T_Response> {
-    return await axios.get<T_Response>(url, callParams.httpOptions).then(
-      (res: Axios.AxiosResponse): T_Response => {
-        if (DynamoNTS_globalSettings.logApiEvents) {
-          if (DynamoNTS_globalSettings.logApiResponseContents) {
-            DynamoFM_Log.success(`'${callParams.name}' was successful`, res.data);
-          } else {
-            DynamoFM_Log.success(`'${callParams.name}' was successful`);
-          }
-        }
-
-        if (callParams.getFullResponse) {
-          return res as T_Response;
-        } else {
-          return res.data;
-        }
-      }
-    );
-  }
-
-  private static logEvent<T_Body>(
-    url: string,
-    inputParams: DynamoNTS_ApiCallInput_Params<T_Body>,
-    callParams: DynamoNTS_ApiCall_Params
-  ): void {
-    if (DynamoNTS_globalSettings.logApiRequestContents) {
-      DynamoFM_Log.log(
-        `<---   outgoing API call: '${callParams?.name}' ` +
-        `\n(${url})` +
-        `\nbody:`, inputParams?.body
-      );
-
-    } else {
-      DynamoFM_Log.log(`<---   outgoing API call: '${callParams?.name}'`);
-    }
-
-    if (DynamoNTS_globalSettings.logApiRequestSettings) {
-      DynamoFM_Log.log(`callParams:`, callParams);
-      DynamoFM_Log.log('inputParams:', {
-        pathParams: inputParams.pathParams ?? {},
-        body: inputParams.body ?? null,
-      });
-    }
-  }
-
-  private static setupHeaders(
-    callParams: DynamoNTS_ApiCall_Params,
-    axios: Axios.AxiosInstance
-  ): void {
-    for (const headerKey in callParams.httpOptions.headers) {
-      if (callParams.httpOptions.headers[headerKey]) {
-        axios.defaults.headers.common[headerKey] = callParams.httpOptions.headers[headerKey];
-
-      } else {
-        throw new DynamoFM_Error({
-          ...this._getDefaultErrorSettings(
-            'setupHeaders',
-            new Error(`missing header: ${headerKey}`)
-          ),
-          errorCode: 'NTS-API-SH0',
-        });
-      }
-    }
-  }
-
-  private static setupPathParams(
-    pathParams: { [param: string]: string; },
-    url: string
-  ): string {
-    for (const pathParamKey in pathParams) {
-      if (pathParams[pathParamKey]) {
-        const paramType = typeof pathParams[pathParamKey];
-
-        switch (paramType) {
-          case 'number':
-            url = url.replace(
-              `:${pathParamKey}`,
-              pathParams[pathParamKey].toString()
-            );
-            break;
-
-          case 'string':
-            url = url.replace(`:${pathParamKey}`, pathParams[pathParamKey]);
-            break;
-
-          default:
-            /* DynamoFM_Log.error(
-              `DYNAMO-NTS ERROR:`+
-              `\nwrong path param type: (${pathParamKey}): ${paramType} ` +
-              `\n${pathParams[pathParamKey]}` +
-              `\nMUST BE string or number` +
-              `\n\n`,
-              new Error()
-            ); */
-            throw new DynamoFM_Error({
-              ...this._getDefaultErrorSettings(
-                'setupPathParams',
-                new Error(
-                  `wrong path param type: (${pathParamKey}): ${paramType}` +
-                  `\n${pathParams[pathParamKey]}`
-                )
-              ),
-              errorCode: 'NTS-API-SP1',
-              additionalContent: {
-                pathParams: pathParams,
-                url: url,
-              },
-            });
-            break;
-        }
-      } else {
-        throw new DynamoFM_Error({
-          ...this._getDefaultErrorSettings(
-            'setupPathParams',
-            new Error(`missing pathParam: ${pathParamKey}`)
-          ),
-          errorCode: 'NTS-API-SP0',
-        });
-      }
-    }
-
-    return url;
-  }
-
-  private static _getDefaultErrorSettings(
-    fnName: string, 
-    error: DynamoFM_AnyError
-  ): DynamoFM_Error_Settings {
-    return {
-      status: (error as DynamoFM_Error)?.___status ?? 500,
-      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS)`,
-      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
-      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
-      issuerService: `${this?.constructor?.name}-${this?.name}-DynamoNTS_ApiService`,
-      error: error,
-    };
-  }
-}
-
+
+import * as Axios from 'axios';
+import { 
+  DynamoFM_AnyError, DynamoFM_Error, DynamoFM_Error_Settings, DynamoFM_Log 
+} from '@futdevpro/fsm-dynamo';
+
+import { DynamoNTS_HttpCallType } from '../../_enums/http/http-call-type.enum';
+import { DynamoNTS_HttpResponseType } from '../../_enums/http/http-response-type.enum';
+import {
+  DynamoNTS_ApiCall_Params
+} from '../../_models/control-models/api-call-params.control-model';
+import { DynamoNTS_globalSettings } from '../../_constants';
+
+export interface DynamoNTS_ApiCallInput_Params<T_Body = any> {
+  pathParams?: {
+    /**
+     * path params setted in endpoint
+     */
+    [param: string]: string;
+  };
+  /**
+   * api call's body
+   */
+  body?: T_Body;
+}
+
+/**
+ * This predefined Api service contains the basic API call function which can be used in various ways
+ */
+export class DynamoNTS_ApiService {
+
+  static defaultErrorUserMsg =
+    `We encountered a BackEnd API Error, ` +
+    `\nplease contact the responsible development team.\n` +
+    `\n(Internal BE to BE error)`;
+
+  /**
+   * if the callParams.getFullResponse is set to true, 
+   * use the Axios.AxiosResponse type as T_Response
+   * 
+   * @param callParams 
+   * @param inputParams 
+   * @returns 
+   */
+  public static async startApiCall<T_Response, T_Body = any>(
+    /**
+     * you must setup the basic api call params with this.
+     * follow the instructions in the constructor: new DynamoNTS_ApiCallParams({ ... })
+     */
+    callParams: DynamoNTS_ApiCall_Params,
+    /**
+     * you can pass data and other inputs in this section
+     */
+    inputParams?: DynamoNTS_ApiCallInput_Params<T_Body>
+  ): Promise<T_Response /* | Axios.AxiosResponse */> {
+    try {
+      let a: T_Response;
+      let url: string = callParams.baseUrl + callParams.endPoint;
+      const axios = Axios.default.create();
+
+      if (callParams?.httpOptions?.headers) {
+        this.setupHeaders(callParams, axios);
+      }
+
+      if (inputParams?.pathParams) {
+        url = this.setupPathParams(inputParams.pathParams, url);
+      }
+
+      /* if (inputParams?.queryParams) {
+        this.setupQueryParams<T_Body>(inputParams, callParams);
+      } */
+
+      if (DynamoNTS_globalSettings.logApiEvents) {
+        this.logEvent(url, inputParams, callParams);
+      }
+
+      switch (callParams.type) {
+        case DynamoNTS_HttpCallType.get:
+          if (inputParams?.body) {
+            DynamoFM_Log.warn('WARNING you cant send body in get calls');
+          }
+
+          a = await this.get<T_Response>(axios, url, callParams);
+          break;
+
+        case DynamoNTS_HttpCallType.delete:
+          if (inputParams?.body) {
+            DynamoFM_Log.warn('WARNING you cant send body in delete calls');
+          }
+
+          a = await this.delete<T_Response>(axios, url, callParams);
+          break;
+
+        case DynamoNTS_HttpCallType.post:
+        case DynamoNTS_HttpCallType.put:
+        case DynamoNTS_HttpCallType.patch:
+          if (!inputParams?.body) {
+            if (!inputParams) {
+              inputParams = {};
+            }
+
+            inputParams.body = {} as T_Body;
+          }
+
+          a = await this.postPutPatch<T_Response, T_Body>(axios, callParams, url, inputParams);
+          break;
+
+        default:
+          throw new DynamoFM_Error({
+            ...this._getDefaultErrorSettings(
+              'startApiCall',
+              new Error('wrong api call type')
+            ),
+            errorCode: 'NTS-API-SAC0',
+            additionalContent: {
+              callParams,
+              inputParams,
+            },
+          });
+          //DynamoFM_Log.error('DYNAMO-NTS ERROR: \n wrong api call type'/* , '\n\n', new Error() */);
+          break;
+      }
+
+      if (callParams.getFullResponse) {
+        return a as T_Response /* Axios.AxiosResponse */;
+
+      } else {
+        return a as T_Response;
+      }
+    } catch (error) {
+      this.handleError<T_Body>(callParams, error, inputParams);
+    }
+  }
+
+  /* private static setupQueryParams<T_Body = any>(
+    inputParams: DynamoNTS_ApiCallInputParams<T_Body>, callParams: DynamoNTS_ApiCallParams) {
+    const httpParams = new HttpParams();
+
+    for (const queryParamKey in inputParams.queryParams) {
+      if (inputParams.queryParams[queryParamKey]) {
+        switch (typeof inputParams.queryParams[queryParamKey]) {
+          case 'number':
+            httpParams.set(queryParamKey, inputParams.queryParams[queryParamKey].toString());
+            break;
+
+          case 'string':
+            httpParams.set(queryParamKey, inputParams.queryParams[queryParamKey]);
+            break;
+
+          default:
+            console.error('DYNAMO-NTS ERROR: \n wrong query param type', '\n\n', new Error());
+            break;
+        }
+      }
+    }
+    callParams.httpOptions.params = httpParams;
+  } */
+
+  private static handleError<T_Body>(
+    callParams: DynamoNTS_ApiCall_Params,
+    error: any,
+    inputParams: {
+      pathParams?: { [param: string]: string; };
+      /**
+       * api call's body
+       */
+      body?: T_Body;
+    }
+  ): void {
+    DynamoFM_Log.error(
+      `\n--->   API ERROR: '${callParams?.name}' failed...` +
+      `\n${callParams?.baseUrl}${callParams?.endPoint}`
+    );
+
+    if (DynamoNTS_globalSettings.logDetailedErrors) {
+      DynamoFM_Log.error(`\ncallParams:`, callParams);
+    }
+
+    if (error && callParams?.httpOptions?.responseType === DynamoNTS_HttpResponseType.text) {
+      error.error = JSON.parse(error?.error);
+    }
+
+    if ((error?.response?.data as DynamoFM_Error)?.flag?.includes('DYNAMO')) {
+      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
+
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          callParams.name + ' startApiCall',
+          error.response.data
+        ),
+
+        errorCode: 'NTS-API-SAC1',
+        message: 'API call failed on the other end! error response found...',
+        additionalContent: {
+          callParams,
+          inputParams,
+        },
+      });
+
+    } else if (error.code === 'ENOTFOUND') {
+      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
+
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          callParams.name + ' startApiCall',
+          error
+        ),
+
+        status: 404,
+        errorCode: 'NTS-API-SAC2',
+        message: 'DNS error; address cannot be resolved!',
+        additionalContent: {
+          callParams,
+          inputParams,
+        },
+      });
+
+    } else if (error.code === 'ECONNREFUSED') {
+      DynamoFM_Log.error(`\n'${callParams.name}' was UNSUCCESSFUL` /* , new Error() */);
+
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          callParams.name + ' startApiCall',
+          error
+        ),
+
+        status: 404,
+        errorCode: 'NTS-API-SAC3',
+        message: `Can't connect to the endpoint!`,
+        additionalContent: {
+          callParams,
+          inputParams,
+        },
+      });
+
+    } else if (error.config && error.message) {
+
+      throw new DynamoFM_Error({
+        ...this._getDefaultErrorSettings(
+          callParams.name + ' startApiCall',
+          error
+        ),
+
+        status: +error.message.substring(error.message.length - 4, 3),
+        errorCode: 'NTS-API-SAC4',
+        additionalContent: {
+          callParams,
+          inputParams,
+        },
+      });
+    } else {
+      DynamoFM_Log.error(
+        `\n${callParams.name} was UNSUCCESSFUL`, 
+        error /*, '\n\n' , new Error() */
+      );
+
+      throw error;
+    }
+  }
+
+  private static async postPutPatch<T_Response, T_Body>(
+    axios: Axios.AxiosInstance,
+    callParams: DynamoNTS_ApiCall_Params,
+    url: string,
+    inputParams: DynamoNTS_ApiCallInput_Params<T_Body>
+  ): Promise<T_Response> {
+    return await axios[callParams.type]<T_Response>(
+      url,
+      inputParams.body,
+      callParams.httpOptions
+    ).then((res: Axios.AxiosResponse): T_Response => {
+      if (DynamoNTS_globalSettings.logApiEvents) {
+        if (DynamoNTS_globalSettings.logApiResponseContents) {
+          DynamoFM_Log.success(`--->   '${callParams.name}' api call was successful`, res.data);
+
+        } else {
+          DynamoFM_Log.success(`--->   '${callParams.name}' api call was successful`);
+        }
+      }
+
+      if (callParams.getFullResponse) {
+        return res as T_Response;
+      } else {
+        return res.data;
+      }
+    });
+  }
+
+  private static async delete<T_Response>(
+    axios: Axios.AxiosInstance,
+    url: string,
+    callParams: DynamoNTS_ApiCall_Params
+  ): Promise<T_Response> {
+    return await axios.delete<T_Response>(url, callParams.httpOptions).then(
+      (res: Axios.AxiosResponse): T_Response => {
+        if (DynamoNTS_globalSettings.logApiEvents) {
+          if (DynamoNTS_globalSettings.logApiResponseContents) {
+            DynamoFM_Log.success(`'${callParams.name}' was successful`, res.data);
+          } else {
+            DynamoFM_Log.success(`'${callParams.name}' was successful`);
+          }
+        }
+
+        if (callParams.getFullResponse) {
+          return res as T_Response;
+        }
+      }
+    );
+  }
+
+  private static async get<T_Response>(
+    axios: Axios.AxiosInstance,
+    url: string,
+    callParams: DynamoNTS_ApiCall_Params
+  ): Promise<T_Response> {
+    return await axios.get<T_Response>(url, callParams.httpOptions).then(
+      (res: Axios.AxiosResponse): T_Response => {
+        if (DynamoNTS_globalSettings.logApiEvents) {
+          if (DynamoNTS_globalSettings.logApiResponseContents) {
+            DynamoFM_Log.success(`'${callParams.name}' was successful`, res.data);
+          } else {
+            DynamoFM_Log.success(`'${callParams.name}' was successful`);
+          }
+        }
+
+        if (callParams.getFullResponse) {
+          return res as T_Response;
+        } else {
+          return res.data;
+        }
+      }
+    );
+  }
+
+  private static logEvent<T_Body>(
+    url: string,
+    inputParams: DynamoNTS_ApiCallInput_Params<T_Body>,
+    callParams: DynamoNTS_ApiCall_Params
+  ): void {
+    if (DynamoNTS_globalSettings.logApiRequestContents) {
+      DynamoFM_Log.log(
+        `<---   outgoing API call: '${callParams?.name}' ` +
+        `\n(${url})` +
+        `\nbody:`, inputParams?.body
+      );
+
+    } else {
+      DynamoFM_Log.log(`<---   outgoing API call: '${callParams?.name}'`);
+    }
+
+    if (DynamoNTS_globalSettings.logApiRequestSettings) {
+      DynamoFM_Log.log(`callParams:`, callParams);
+      DynamoFM_Log.log('inputParams:', {
+        pathParams: inputParams.pathParams ?? {},
+        body: inputParams.body ?? null,
+      });
+    }
+  }
+
+  private static setupHeaders(
+    callParams: DynamoNTS_ApiCall_Params,
+    axios: Axios.AxiosInstance
+  ): void {
+    for (const headerKey in callParams.httpOptions.headers) {
+      if (callParams.httpOptions.headers[headerKey]) {
+        axios.defaults.headers.common[headerKey] = callParams.httpOptions.headers[headerKey];
+
+      } else {
+        throw new DynamoFM_Error({
+          ...this._getDefaultErrorSettings(
+            'setupHeaders',
+            new Error(`missing header: ${headerKey}`)
+          ),
+          errorCode: 'NTS-API-SH0',
+        });
+      }
+    }
+  }
+
+  private static setupPathParams(
+    pathParams: { [param: string]: string; },
+    url: string
+  ): string {
+    for (const pathParamKey in pathParams) {
+      if (pathParams[pathParamKey]) {
+        const paramType = typeof pathParams[pathParamKey];
+
+        switch (paramType) {
+          case 'number':
+            url = url.replace(
+              `:${pathParamKey}`,
+              pathParams[pathParamKey].toString()
+            );
+            break;
+
+          case 'string':
+            url = url.replace(`:${pathParamKey}`, pathParams[pathParamKey]);
+            break;
+
+          default:
+            /* DynamoFM_Log.error(
+              `DYNAMO-NTS ERROR:`+
+              `\nwrong path param type: (${pathParamKey}): ${paramType} ` +
+              `\n${pathParams[pathParamKey]}` +
+              `\nMUST BE string or number` +
+              `\n\n`,
+              new Error()
+            ); */
+            throw new DynamoFM_Error({
+              ...this._getDefaultErrorSettings(
+                'setupPathParams',
+                new Error(
+                  `wrong path param type: (${pathParamKey}): ${paramType}` +
+                  `\n${pathParams[pathParamKey]}`
+                )
+              ),
+              errorCode: 'NTS-API-SP1',
+              additionalContent: {
+                pathParams: pathParams,
+                url: url,
+              },
+            });
+            break;
+        }
+      } else {
+        throw new DynamoFM_Error({
+          ...this._getDefaultErrorSettings(
+            'setupPathParams',
+            new Error(`missing pathParam: ${pathParamKey}`)
+          ),
+          errorCode: 'NTS-API-SP0',
+        });
+      }
+    }
+
+    return url;
+  }
+
+  private static _getDefaultErrorSettings(
+    fnName: string, 
+    error: DynamoFM_AnyError
+  ): DynamoFM_Error_Settings {
+    return {
+      status: (error as DynamoFM_Error)?.___status ?? 500,
+      message: (error as Error)?.message ?? `${fnName} was UNSUCCESFUL (NTS)`,
+      addECToUserMsg: !(error as DynamoFM_Error)?.__userMessage,
+      userMessage: (error as DynamoFM_Error)?.__userMessage ?? this.defaultErrorUserMsg,
+      issuerService: `${this?.constructor?.name}-${this?.name}-DynamoNTS_ApiService`,
+      error: error,
+    };
+  }
+}
+