octopian-apis 1.0.56 → 1.0.58

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.56",
+  "version": "1.0.58",
   "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/correspondenceServices.js

@@ -920,14 +920,13 @@ export async function GetMyClosedCorrespondenceRequests(
   Timeout = 30000,
   RequiredHeaderValue = null
 ) {
-  GetMyCorrespondenceListDTO["WithRequest"] = true;
-  GetMyCorrespondenceListDTO["WithRequestStepAttributes"] = true;
-  GetMyCorrespondenceListDTO["WithRequestAttributes"] = true;
-  GetMyCorrespondenceListDTO["RequestStepStatus"] = "Archived";
-  GetMyCorrespondenceListDTO["WithPreviousClosedRequestSteps"] = true;
+  GetMyCorrespondenceListDTO["RequestStatus"] = "Closed";
+  GetMyCorrespondenceListDTO["WithRequestStep"] = true;
+  GetMyCorrespondenceListDTO["WithRequestStepAttribute"] = true;
+  GetMyCorrespondenceListDTO["WithRequestAttribute"] = true;
 
   let APIResponse = await apiHandler.PostMethod(
-    RequestStepsAPIConstants.uriGetMyRequestStepList(),
+    RequestsAPIConstants.uriGetMyRequestList(),
     GetMyCorrespondenceListDTO,
     AuthToken,
     Timeout,
@@ -937,15 +936,14 @@ export async function GetMyClosedCorrespondenceRequests(
   let ReadSASResult = await CreateReadSAS(AuthToken, Timeout);
   if (APIResponse.StatusCode === 200 && APIResponse.Result?.length > 0) {
     APIResponse.Result.forEach((element) => {
-      let subject = element.Request.ServiceName;
+      let subject = element.ServiceName;
       let notes = "";
       let ImagePath = "";
-      let ProcessFlow = [];
       let ToName = "";
       let GeneratedDocument = "";
       let Attachments = [];
-      if (element.Request.RequestAttributeList?.length > 0) {
-        element.Request.RequestAttributeList.forEach((attribute) => {
+      if (element.RequestAttributeList?.length > 0) {
+        element.RequestAttributeList.forEach((attribute) => {
           if (attribute.Alias === "Subject") {
             subject = attribute.Value;
           }
@@ -958,7 +956,7 @@ export async function GetMyClosedCorrespondenceRequests(
           if (attribute.Alias === "To") {
             ToName = attribute.Value;
           }
-          if (attribute.Alias === element.Request.CustomField5 && attribute.Value) {
+          if (attribute.Alias === element.CustomField5 && attribute.Value) {
             GeneratedDocument = attribute.Value.includes('https') ? attribute.Value : (ReadSASResult?.Result
               ? ReadSASResult.Result.split("?")[0] +
                 "/" +
@@ -967,30 +965,6 @@ export async function GetMyClosedCorrespondenceRequests(
                 ReadSASResult.Result.split("?")[1]
               : "");
           }
-          if (element.PreviousClosedRequestStepList?.length > 0) {
-            let PreviousSteps = element.PreviousClosedRequestStepList.filter(
-              (step) => step.IsNeutralEmotion
-            );
-            if (PreviousSteps.length > 0) {
-              let PreviousStep = PreviousSteps.reduce((prev, current) =>
-                +prev.RequestStepId > +current.RequestStepId ? prev : current
-              );
-
-              let PreviousStepDocumentAttachment =
-                PreviousStep.RequestAttributeList.find(
-                  (PrevAttribute) => PrevAttribute.Alias === PreviousStep.ExtraLine1
-                );
-              if (PreviousStepDocumentAttachment && PreviousStepDocumentAttachment.Value) {
-                GeneratedDocument =PreviousStepDocumentAttachment.Value.includes('https') ? PreviousStepDocumentAttachment.Value : (ReadSASResult?.Result
-                  ? ReadSASResult.Result.split("?")[0] +
-                    "/" +
-                    PreviousStepDocumentAttachment.Value +
-                    "?" +
-                    ReadSASResult.Result.split("?")[1]
-                  : "");
-              }
-            }
-          }
           if (
             attribute.Alias === "Attachments" &&
             !attribute.IsRequesterVisible
@@ -1025,9 +999,6 @@ export async function GetMyClosedCorrespondenceRequests(
           }
         });
       }
-      if (element.ProviderImagePath) {
-        ImagePath = element.ProviderImagePath;
-      }
       if (ImagePath && ReadSASResult.StatusCode === 200) {
         ImagePath =
           ReadSASResult.Result.split("?")[0] +
@@ -1036,45 +1007,19 @@ export async function GetMyClosedCorrespondenceRequests(
           "?" +
           ReadSASResult.Result.split("?")[1];
       }
-      if (element.PreviousClosedRequestStepList) {
-        element.PreviousClosedRequestStepList.forEach((step) => {
-          let ProviderImagePath = "";
-          if (step.ProviderImagePath) {
-            ProviderImagePath = step.ProviderImagePath;
-          }
-          if (ProviderImagePath && ReadSASResult.StatusCode === 200) {
-            ProviderImagePath =
-              ReadSASResult.Result.split("?")[0] +
-              "/" +
-              ProviderImagePath +
-              "?" +
-              ReadSASResult.Result.split("?")[1];
-          }
-          ProcessFlow.push({
-            Id: step.RequestStepId,
-            ImagePath: ProviderImagePath,
-            Name: step.ProviderName || step.ProviderRoleName,
-            Comment: step.ProviderComments,
-            SubmitDate: step.StartDate,
-            ParentRequestStepId: step.ParentRequestStepId || 0,
-          });
-        });
-      }
       MappedResult.push({
         RequestId: element.RequestId,
-        StepId: element.RequestStepId,
+        StepId: 0,
         RequesterImagePath: ImagePath,
-        RequesterName: element.Request.InteractorName,
+        RequesterName: element.InteractorName,
         ToName: ToName,
-        CategoryColor: element.Request.ExtraLine1
-          ? element.Request.ExtraLine1
-          : "#FB4C2F",
-        CategoryName: element.Request.ServiceSubCategoryName,
-        SubmitDate: element.StartDate,
+        CategoryColor: element.ExtraLine1 ? element.ExtraLine1 : "#FB4C2F",
+        CategoryName: element.ServiceSubCategoryName,
+        SubmitDate: element.SubmitDate,
         Subject: subject,
         Notes: notes,
         IsRead: true,
-        ProcessFlow: ProcessFlow,
+        ProcessFlow: [],
         GeneratedDocument: GeneratedDocument,
         Attachments: Attachments,
       });

package/src/CoreServices/transactionsServices.js

@@ -4023,6 +4023,85 @@ export async function GetNotificationList(
   );
   return APIResponse;
 }
+
+/**
+ * @description
+ * Updates a list of notifications.
+ *
+ * @param {object} UpdateNotificationListDTO
+ * Data object containing fields necessary for updating the notification list.
+ *   --- notification data list---
+ *
+ * @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 Update Notification List API,   
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: boolean,
+ *   HeaderValue: string
+ */
+export async function UpdateNotificationList(
+  UpdateNotificationListDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(  
+    TransactionsAPIConstants.uriUpdateNotificationList(),
+    UpdateNotificationListDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );  
+  return APIResponse;
+}
+
+/**
+ * @description
+ * Retrieves a list of step types.
+ *
+ * @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 Step Type List API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: [
+ *     --- step type data ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function GetStepTypeList(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) { 
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetStepTypeList(),
+    null,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
 //#endregion
 
 //#region Agent

package/src/index.d.ts

@@ -272,6 +272,8 @@ import { MaintainAgentInteractorOutput } from "./modals/output-modals/transactio
 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";
+import { UpdateNotificationInput } from "./modals/input-modals/transaction-catalog-modals/UpdateNotificationInput";
+import { GetStepTypeOutput } from "./modals/output-modals/transaction-catalog-modals/GetStepTypesOutput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -4148,6 +4150,66 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<NotificationListOutput[] | BaseErrorResponse>;
+ /**
+  * @description
+  * Updates a list of notifications.
+  *
+  * @param {UpdateNotificationInput} UpdateNotificationListDTO
+  * Data object containing fields necessary for updating the notification list.
+  *   --- notification data list---
+  *
+  * @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 Update Notification List API,
+  * including success message, status code, and any additional data returned by the API.
+  *   Message: Success,
+  *   StatusCode: 200,
+  *   Result: boolean,
+  *   HeaderValue: string
+  */
+  UpdateNotificationList: (
+    Input: UpdateNotificationInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of step types.
+   *
+   * @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 Step Type List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- step type data ---
+   *   ], 
+   *   HeaderValue: string
+   */
+  GetStepTypeList: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetStepTypeOutput[] | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -7557,5 +7619,7 @@ export {
   DynamicStepList,
   GetAppStyles,
   GenerateStepDocumentInput,
-  NotificationListOutput
+  NotificationListOutput,
+  UpdateNotificationInput,
+  GetStepTypeOutput
 };

package/src/index.js

@@ -140,6 +140,8 @@ const {
   MaintainAgentUnitList,
   MaintainAgentInteractorList,
   GetNotificationList,
+  UpdateNotificationList,
+  GetStepTypeList,
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -240,6 +242,8 @@ const TransactionCommonServices = {
   GetMyPersonalUnitMemberList,
   ConvertPersonalUnitMemberToRecord,
   GetNotificationList,
+  UpdateNotificationList,
+  GetStepTypeList,
 };
 
 const {

package/src/modals/input-modals/transaction-catalog-modals/UpdateNotificationInput.ts

@@ -0,0 +1,4 @@
+export interface UpdateNotificationInput {
+    RowKey: string;
+    PartitionKey: string;
+}

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

@@ -0,0 +1,6 @@
+export interface GetStepTypeOutput {
+    StepTypeId: number;
+    Name: string;
+    DtoState: number;
+    Translations: string;
+}

package/src/web-services/apiConstants.js

@@ -387,6 +387,12 @@ export class TransactionsAPIConstants {
   static uriGetNotificationList(){
     return transactionCatalogURI + "/api/Notification/GetNotificationList";
   }
+  static uriUpdateNotificationList(){
+    return transactionCatalogURI + "/api/Notification/UpdateNotificationList";
+  }
+  static uriGetStepTypeList(){
+    return transactionCatalogURI + "/api/TransactionCommon/GetStepTypeList";
+  }
   //#endregion
 
   //#region Agent