octopian-apis 1.0.56 → 1.0.57

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.56",
+  "version": "1.0.57",
   "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

@@ -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/TransactionCommon/UpdateNotificationList";
+  }
+  static uriGetStepTypeList(){
+    return transactionCatalogURI + "/api/TransactionCommon/GetStepTypeList";
+  }
   //#endregion
 
   //#region Agent