octopian-apis 1.0.30 → 1.0.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "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/requestStepsServices.js

@@ -504,6 +504,89 @@ export async function PartiallyProcessCheckedOutRequestStepList(
   );
   return APIResponse;
 }
+/**
+ * @description
+ * Retrieves a list of assignable roles for a request step.
+ *
+ * @param {object} GetRequestStepAssignableRoleListDTO
+ * Data object containing fields necessary for retrieving the assignable roles for a request step.
+ *   RequestStepId: number
+ *   RoleType: string
+ *
+ * @param {string} AuthToken
+ * Authentication token for authorization purposes.
+ *
+ * @param {number} Timeout
+ * Time in milliseconds to wait before the request times out. Default is 30000.
+ *
+ * @returns
+ * An object containing the response from the Get Request Step Assignable Role List request, including
+ * success message, status code, and any additional data returned by the API.
+ * {
+ *   Message: string,
+ *   StatusCode: number,
+ *   Result: [{
+ *     RoleId: number,
+ *     Name: string,
+ *     RoleTypeId: number,
+ *     SystemName: string,
+ *     ObjectId: number,
+ *     ObjectName: string
+ *   }]
+ * }
+ */
+export async function GetRequestStepAssignableRoleList(
+  GetRequestStepAssignableRoleListDTO,
+  AuthToken = null,
+  Timeout = 30000
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestStepsAPIConstants.uriGetRequestStepAssignableRoleList(),
+    GetRequestStepAssignableRoleListDTO,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
+
+/**
+ * @description
+ * Processes a step special action using the provided data.
+ *
+ * @param {object} ProcessStepSpecialActionDTO
+ * Data object containing fields necessary for processing the step special action.
+ *   RequestStepId: number
+ *   RoleId: number
+ *   ActionType: string
+ *
+ * @param {string} AuthToken
+ * Authentication token for authorization purposes.
+ *
+ * @param {number} Timeout
+ * Time in milliseconds to wait before the request times out. Default is 30000.
+ *
+ * @returns
+ * An object containing the response from the Process Step Special Action request, including
+ * success message, status code, and any additional data returned by the API. 
+ * {
+ *   Message: string,
+ *   StatusCode: number,
+ *   Result: boolean
+ * }
+ */
+export async function ProcessStepSpecialAction(
+  ProcessStepSpecialActionDTO,
+  AuthToken = null,
+  Timeout = 30000
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestStepsAPIConstants.uriProcessStepSpecialAction(),
+    ProcessStepSpecialActionDTO,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
 //#endregion
 
 //#region Dispatch

package/src/index.d.ts

@@ -259,6 +259,9 @@ import { CorrespondenceSubmitDraftInput } from "./modals/input-modals/correspond
 import { GenerateDocumentInput } from "./modals/input-modals/transaction-catalog-modals/GenerateDocumentInput";
 import { GetProviderStepTypeCountOutput } from "./modals/output-modals/request-step-modals/GetProviderStepTypeCountOutput";
 import { GetMyCorrespondenceOutput } from "./modals/output-modals/correspondence-modals/GetMyCorrespondenceOutput";
+import { RequestStepAssignableRoleInput } from "./modals/input-modals/request-step-modals/RequestStepAssignableRoleInput";
+import { RequestStepAssignableRoleOutput } from "./modals/output-modals/request-step-modals/RequestStepAssignableRoleOutput";
+import { ProcessStepSpecialActionInput } from "./modals/input-modals/request-step-modals/ProcessStepSpecialActionInput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -5873,8 +5876,72 @@ interface RequestStepProviderServices {
     AuthToken?: string | null,
     Timeout?: number | null
   ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of assignable roles for a request step.
+   *
+   * @param {RequestStepAssignableRoleInput} Input
+   * Data object containing fields necessary for retrieving the list of assignable roles.
+   *   RequestStepId: number
+   *   RoleType: string
+   *
+   * @param {string} AuthToken
+   * Authentication token for authorization purposes.
+   *
+   * @param {number} Timeout  
+   * Time in milliseconds to wait before the request times out. Default is 30000.
+   *
+   * @returns
+   * An object containing the response from the Get Request Step Assignable Role List request, including
+   * success message, status code, and any additional data returned by the API.
+   * {
+   *   Message: string,
+   *   StatusCode: number,
+   *   Result: RequestStepAssignableRoleOutput[]
+   * }
+   */
+  GetRequestStepAssignableRoleList: (
+    Input: RequestStepAssignableRoleInput,
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<RequestStepAssignableRoleOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Processes a special action for a request step.
+   *
+   * @param {ProcessStepSpecialActionInput} Input
+   * Data object containing fields necessary for processing the special action.
+   *   RequestStepId: number
+   *   ActionType: string
+   *   RoleId: number
+   *
+   * @param {string} AuthToken
+   * Authentication token for authorization purposes.
+   *
+   * @param {number} Timeout
+   * Time in milliseconds to wait before the request times out. Default is 30000.
+   *
+   * @returns
+   * An object containing the response from the Process Step Special Action request, including
+   * success message, status code, and any additional data returned by the API.
+   * {  
+   *   Message: string,
+   *   StatusCode: number,
+   *   Result: boolean
+   * }
+   */
+  ProcessStepSpecialAction: (
+    Input: ProcessStepSpecialActionInput,
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<boolean | BaseErrorResponse>;
+  
+  
 }
 
+
 // Request Step Dispatch Services interface
 interface RequestStepDispatchServices {
   /**
@@ -6815,5 +6882,8 @@ export {
   GetMyCorrespondenceListDTO,
   CorrespondenceSubmitDraftInput,
   GetProviderStepTypeCountOutput,
-  GetMyCorrespondenceOutput
+  GetMyCorrespondenceOutput,
+  RequestStepAssignableRoleInput,
+  RequestStepAssignableRoleOutput,
+  ProcessStepSpecialActionInput
 };

package/src/index.js

@@ -340,6 +340,8 @@ const {
   NotFound,
   Reject,
   Start,
+  GetRequestStepAssignableRoleList,
+  ProcessStepSpecialAction
 } = require("./CoreServices/requestStepsServices");
 const RequestStepProviderServices = {
   AcceptOrder,
@@ -356,6 +358,8 @@ const RequestStepProviderServices = {
   ProcessRequestStepList,
   RejectOrder,
   UpdateDismissedRequestStepList,
+  GetRequestStepAssignableRoleList,
+  ProcessStepSpecialAction
 };
 const RequestStepDispatchServices = {
   Accept,
@@ -516,6 +520,7 @@ const {
   DABValidateAttributesWithIntegration,
   DABGetPaymentBatch,
   DABGetInvoiceDetails,
+  DABAddToCart
 } = require("./darAlBerServices/transactionsServices");
 const {
   DABCreateReadSAS,
@@ -759,6 +764,7 @@ const DarAlBerServices = {
   DABValidateAttributesWithIntegration,
   DABGetPaymentBatch,
   DABGetInvoiceDetails,
+  DABAddToCart
 };
 //#endregion
 const {

package/src/modals/input-modals/request-step-modals/ProcessStepSpecialActionInput.ts

@@ -0,0 +1,5 @@
+export interface ProcessStepSpecialActionInput {
+  RequestStepId: number;
+  ActionType: string;
+  RoleId: number;
+}

package/src/modals/input-modals/request-step-modals/RequestStepAssignableRoleInput.ts

@@ -0,0 +1,4 @@
+export interface RequestStepAssignableRoleInput {
+  RequestStepId: number;
+  RoleType: string;
+}

package/src/modals/output-modals/request-step-modals/GetRequestStepListOutput.ts

@@ -20,6 +20,7 @@ import { GetMyRequestOutput, RequestList } from "../request-modals/GetMyRequestG
     ProviderRoleId: number
     ProviderId: number
     ProviderComments: string
+    ProviderImagePath: string
     IsCheckedOut: boolean
     CheckedOutProviderId: number
     IsAssignable: boolean

package/src/modals/output-modals/request-step-modals/RequestStepAssignableRoleOutput.ts

@@ -0,0 +1,9 @@
+export interface RequestStepAssignableRoleOutput {
+  RoleId: number;
+  Name: string;
+  RoleTypeId: number;
+  SystemName: string;
+  ObjectId: number;
+  ObjectName: any;
+}
+  

package/src/web-services/apiConstants.js

@@ -584,6 +584,12 @@ export class RequestStepsAPIConstants {
   static uriGetProviderStepTypeCounts() {
     return requestStepURI + "/api/Provider/GetProviderStepTypeCounts";
   }
+  static uriGetRequestStepAssignableRoleList() {
+    return requestStepURI + "/api/Provider/GetRequestStepAssignableRoleList";
+  }
+  static uriProcessStepSpecialAction() {
+    return requestStepURI + "/api/Provider/ProcessStepSpecialAction";
+  }
   //#endregion
 
   //#region Dispatch