octopian-apis 1.0.60 → 1.0.62

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.60",
+  "version": "1.0.62",
   "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/requestsServices.js

@@ -1097,6 +1097,44 @@ export async function MaintainRequestAttributeList(
   );
   return APIResponse;
 }
+
+/**
+ * @description
+ * Maintains the request steps.
+ *
+ * @param {object} MaintainRequestStepListDTO
+ * An object containing fields necessary for maintaining the request steps.
+ * DynamicSteps : DynamicStep[]
+ * RequestId : 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 Maintain Request Step List request, including
+ * success message, status code, and any additional data returned by the API.
+ * {
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: -- list of updated request steps --
+ * }
+ */
+export async function MaintainRequestStepList(
+  MaintainRequestStepListDTO,
+  AuthToken = null,
+  Timeout = 30000
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestsAPIConstants.uriMaintainRequestStepList(),
+    MaintainRequestStepListDTO,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
 /**
  * @description
  * Updates the dismiss status of a request.

package/src/CoreServices/transactionsServices.js

@@ -4102,6 +4102,123 @@ export async function GetStepTypeList(
   );
   return APIResponse;
 }
+
+/**
+ * @description
+ * Retrieves a list of interactor signatures.
+ *
+ * @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 Interactor Signatures API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: [
+ *     --- interactor signature data ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function GetInteractorSignatures(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.GetMethod(
+    TransactionsAPIConstants.uriGetInteractorSignatures(),
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * @description
+ * Retrieves a signature blob.
+ *
+ * @param {string} signatureId
+ * The ID of the signature to retrieve.
+ *
+ * @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 Signature Blob API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: string (signature blob),
+ *   HeaderValue: string
+ */
+export async function GetSignatureBlob(
+  signatureId,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.GetMethod(
+    TransactionsAPIConstants.uriGetSignatureBlob(signatureId),
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * @description
+ * Signs a document.
+ *
+ * @param {object} SignDocumentDTO
+ * Data object containing fields necessary for signing the document.
+ *   --- signature data ---
+ *
+ * @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 Sign Document API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: string (signature id),
+ *   HeaderValue: string
+ */
+export async function SignDocument(
+  SignDocumentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(  
+    TransactionsAPIConstants.uriSignDocument(),
+    SignDocumentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );  
+  return APIResponse;
+}
 //#endregion
 
 //#region Agent

package/src/index.d.ts

@@ -102,6 +102,7 @@ import { DispatchOrderInput } from "./modals/input-modals/request-step-modals/Di
 import { GetDriverDetailsInput } from "./modals/input-modals/request-step-modals/GetDriverDetailsInput";
 import { GetOrderDetailsInput } from "./modals/input-modals/request-step-modals/GetOrderDetailsInput";
 import { GetOrderStatusInput } from "./modals/input-modals/request-step-modals/GetOrderStatusInput";
+import { MaintainRequestStepListInput } from "./modals/input-modals/request-modals/MaintainRequestStepListInput"; 
 import {
   ProcessRequestStepListInput,
   ProcessCheckedOutStepListInput,
@@ -274,6 +275,9 @@ import { GetAppStyles } from "./modals/output-modals/correspondence-modals/GetAp
 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";
+import { GetInteractorSignatureOutput } from "./modals/output-modals/transaction-catalog-modals/GetInteractorSignatureOutput";
+import { GetSignatureBlobOutput } from "./modals/output-modals/transaction-catalog-modals/GetSignatureBlobOutput";
+import { SignDocumentInput } from "./modals/input-modals/transaction-catalog-modals/SignDocumentInput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -4210,6 +4214,98 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<GetStepTypeOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of interactor signatures.
+   *
+   * @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 Interactor Signatures API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- interactor signature data ---
+   *   ],
+   *   HeaderValue: string
+   */
+  GetInteractorSignatures: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetInteractorSignatureOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a signature blob.
+   *
+   * @param {string} signatureId
+   * The ID of the signature to retrieve.
+   *
+   * @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 Signature Blob API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: GetSignatureBlobOutput,
+   *   HeaderValue: string
+   */
+  GetSignatureBlob: (
+    signatureId: string,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetSignatureBlobOutput | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Signs a document.
+   *
+   * @param {SignDocumentInput} SignDocumentDTO
+   * Data object containing fields necessary for signing the document.
+   *   --- signature data ---
+   *
+   * @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 Sign Document API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: string (signature id),
+   *   HeaderValue: string
+   */
+  SignDocument: (
+    SignDocumentDTO: SignDocumentInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<string | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -5577,6 +5673,22 @@ interface RequestsTransactionCommonServices {
     AuthToken?: string | null,
     Timeout?: number | null
   ) => BaseResponse<MaintainRequestAttributeListOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the request steps.
+   *
+   * @param {MaintainRequestStepListInput} MaintainRequestStepListDTO
+   * An object containing fields necessary for maintaining the request steps.
+   * DynamicSteps : DynamicStep[]
+   * RequestId : number
+   */
+  MaintainRequestStepList: (
+    Input: MaintainRequestStepListInput,
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<boolean | BaseErrorResponse>;
+
   /**
    * @description
    * Reorders a trackable batch for a given batch identifier.
@@ -7622,5 +7734,9 @@ export {
   NotificationListOutput,
   UpdateNotificationInput,
   GetStepTypeOutput,
-  ChildStep
+  ChildStep,
+  MaintainRequestStepListInput,
+  SignDocumentInput,
+  GetSignatureBlobOutput,
+  GetInteractorSignatureOutput,
 };

package/src/index.js

@@ -142,6 +142,9 @@ const {
   GetNotificationList,
   UpdateNotificationList,
   GetStepTypeList,
+  GetInteractorSignatures,
+  GetSignatureBlob,
+  SignDocument,
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -244,6 +247,9 @@ const TransactionCommonServices = {
   GetNotificationList,
   UpdateNotificationList,
   GetStepTypeList,
+  GetInteractorSignatures,
+  GetSignatureBlob,
+  SignDocument,
 };
 
 const {
@@ -298,6 +304,7 @@ const {
   JoinGroupOrder,
   LeaveGroupOrder,
   MaintainRequestAttributeList,
+  MaintainRequestStepList,
   ReorderTrackableBatch,
   TrackBatch,
   UpdateRequestDismiss,
@@ -348,6 +355,7 @@ const RequestsTransactionCommonServices = {
   JoinGroupOrder,
   LeaveGroupOrder,
   MaintainRequestAttributeList,
+  MaintainRequestStepList,
   ReorderTrackableBatch,
   TrackBatch,
   UpdateRequestDismiss,

package/src/modals/input-modals/request-modals/MaintainRequestStepListInput.ts

@@ -0,0 +1,6 @@
+import { DynamicStepList } from "./RequesterAddRequestInput"
+
+export interface MaintainRequestStepListInput {
+    DynamicSteps : DynamicStepList[]
+    RequestId : number
+}

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

@@ -1,6 +1,7 @@
 export interface GenerateDocumentInput {
     serviceId: number
     templateAttributeAlias: string
+    IsGeneratedWord:boolean
     clientRequestAttributes: ClientRequestAttribute[]
   }
   
@@ -17,6 +18,7 @@ export interface GenerateDocumentInput {
   export interface GenerateStepDocumentInput {
     RequestStepId: number
     TemplateAttributeAlias: string
+    IsGeneratedWord:boolean
     ClientRequestAttributes: ClientRequestAttribute[]
   }
   

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

@@ -0,0 +1,6 @@
+export interface SignDocumentInput
+{
+    DocumentPath: string;
+    Alias: string;
+    InteractorSignatureId: number;
+}

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

@@ -142,6 +142,7 @@ import { GetMyRequestOutput, RequestList } from "../request-modals/GetMyRequestG
     PreviousClosedRequestStepList: GetRequestStepListOutput[]
     CurrentActiveRequestStep: GetRequestStepListOutput
     StepStatusCounter: StepStatusCounter
+    IsSignDocument: boolean
   }
   
   export interface RequestAttributeList {

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

@@ -0,0 +1,7 @@
+export interface GetInteractorSignatureOutput
+{
+    Id: number;
+    Name: string;
+    Label: string;
+    CreatedAtUtc: string;
+}

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

@@ -0,0 +1,7 @@
+export interface GetSignatureBlobOutput
+{
+    Ciphertext: string;
+    MimeType: string;
+    ByteLength: number;
+    Iv: string;
+}

package/src/web-services/apiConstants.js

@@ -393,6 +393,15 @@ export class TransactionsAPIConstants {
   static uriGetStepTypeList(){
     return transactionCatalogURI + "/api/TransactionCommon/GetStepTypeList";
   }
+  static uriGetInteractorSignatures(){
+    return signatureURI + "/api/InteractorSignatures";
+  }
+  static uriGetSignatureBlob(signatureId){
+    return signatureURI + `/api/InteractorSignatures/Blob/${signatureId}`;
+  }
+  static uriSignDocument(){
+    return signatureURI + "/api/SignDocument";
+  }
   //#endregion
 
   //#region Agent
@@ -540,6 +549,11 @@ export class RequestsAPIConstants {
       requestServicesURI + "/api/TransactionCommon/MaintainRequestAttributeList"
     );
   }
+  static uriMaintainRequestStepList() {
+    return (
+      requestServicesURI + "/api/TransactionCommon/MaintainRequestStepList"
+    );
+  }
   static uriUpdateRequestDismiss() {
     return requestServicesURI + "/api/TransactionCommon/UpdateRequestDismiss";
   }
@@ -749,5 +763,5 @@ let requestServicesURI = "/Request";
 let requestStepURI = "/RequestStep";
 let storageURI = "/Storage";
 let transactionCatalogURI = "/TransactionCatalog";
-
+let signatureURI = "/Signature";
 //#endregion