octopian-apis 1.0.54 → 1.0.55

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.54",
+  "version": "1.0.55",
   "description": "Transaction APIs SDK that implements Octopian Services which will be used for any node project typescript or javascript",
   "main": "./src/index.js",
   "scripts": {

package/src/CoreServices/transactionsServices.js

@@ -3985,6 +3985,44 @@ export async function GenerateStepDocument(
   );
   return APIResponse;
 }
+
+/**
+ * @description
+ * Retrieves a list of notifications.
+ *
+ * @param {string} AuthToken
+ * Authentication token for authorization purposes.
+ *
+ * @param {number} Timeout  
+ * Time in milliseconds to wait before the request times out. Default is 30000.
+ *
+ * @param {string} RequiredHeaderValue
+ * Value for any required header. Default is null.
+ *
+ * @returns
+ * An object containing the response from the Get Notification List API,  
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: [
+ *     --- notification data ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function GetNotificationList(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetNotificationList(),
+    null,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
 //#endregion
 
 //#region Agent

package/src/index.d.ts

@@ -271,6 +271,7 @@ import { MaintainAgentInteractorInput } from "./modals/input-modals/transaction-
 import { MaintainAgentInteractorOutput } from "./modals/output-modals/transaction-catalog-modals/MaintainAgentInteractorOutput";
 import { GetServiceManagementServiceListOutput } from "./modals/output-modals/request-modals/GetServiceManagementServiceListOutput";
 import { GetAppStyles } from "./modals/output-modals/correspondence-modals/GetAppStyles";
+import { NotificationListOutput } from "./modals/output-modals/transaction-catalog-modals/NotificationListOutput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -4118,6 +4119,35 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of notifications.
+   *
+   * @param {string} AuthToken
+   * Authentication token for authorization purposes.
+   *
+   * @param {number} Timeout
+   * Time in milliseconds to wait before the request times out. Default is 30000.
+   *
+   * @param {string} RequiredHeaderValue
+   * Value for any required header. Default is null.
+   *
+   * @returns 
+   * An object containing the response from the Get Notification List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- notification data ---
+   *   ], 
+   *   HeaderValue: string
+   */
+  GetNotificationList: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<NotificationListOutput[] | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -7526,5 +7556,6 @@ export {
   GetServiceManagementServiceListOutput,
   DynamicStepList,
   GetAppStyles,
-  GenerateStepDocumentInput
+  GenerateStepDocumentInput,
+  NotificationListOutput
 };

package/src/index.js

@@ -139,6 +139,7 @@ const {
   GetInteractorEligibleDocumentListAgent,
   MaintainAgentUnitList,
   MaintainAgentInteractorList,
+  GetNotificationList,
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -237,7 +238,8 @@ const TransactionCommonServices = {
   GetServiceManagementServiceList,
   MaintainServiceManagementServiceList,
   GetMyPersonalUnitMemberList,
-  ConvertPersonalUnitMemberToRecord
+  ConvertPersonalUnitMemberToRecord,
+  GetNotificationList,
 };
 
 const {

package/src/modals/output-modals/transaction-catalog-modals/NotificationListOutput.ts

@@ -0,0 +1,8 @@
+export interface NotificationListOutput {
+    Message: string;
+    Action: string;
+    UserId: string;
+    GroupName: string;
+    Method: string;
+    Error: string;
+}

package/src/web-services/apiConstants.js

@@ -384,6 +384,9 @@ export class TransactionsAPIConstants {
   static uriMaintainServiceManagementServiceList() {
     return transactionCatalogURI + "/api/TransactionCommon/MaintainServiceManagementServiceList";
   }
+  static uriGetNotificationList(){
+    return transactionCatalogURI + "/api/Notification/GetNotificationList";
+  }
   //#endregion
 
   //#region Agent