octopian-apis 1.0.63 → 1.0.64

package/package.json

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

@@ -3,6 +3,43 @@ import * as apiHandler from "../web-services/apiHandler";
 
 //#region Provider
 
+/**
+ * @description
+ * Updates the attribute list of a correspondence step.
+ *
+ * @param {object} UpdateCorrespondenceStepAttributeListDTO
+ * Data object containing fields necessary for updating the correspondence step attribute list.
+ *   --- correspondence step attribute 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.
+ *
+ * @returns
+ * An object containing the response from the Update Correspondence Step Attribute List API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: [
+ *     --- updated correspondence step attribute list ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function UpdateCorrespondenceStepAttributeList(
+  UpdateCorrespondenceStepAttributeListDTO,
+  AuthToken = null,
+  Timeout = 30000
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestStepsAPIConstants.uriUpdateCorrespondenceStepAttributeList(),
+    UpdateCorrespondenceStepAttributeListDTO,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
 /**
  * @description
  * Processes a list of request steps based on the provided data.

package/src/CoreServices/requestsServices.js

@@ -672,6 +672,40 @@ export async function AddRequest(AddRequestDTO, AuthToken = null, Timeout = 3000
   return APIResponse;
 }
 
+/**
+ * @description
+ * Adds a batch request to requester as draft or not.
+ *
+ * @param {object} AddBatchRequestDTO
+ * Data object containing fields necessary for adding a batch request.
+ *   --- batch request 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.
+ *
+ * @returns
+ * An object containing the response from the Add Batch Request request, including
+ * success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: {
+ *   BatchId: number
+ * }
+ * }
+ */
+export async function AddBatchRequest(AddBatchRequestDTO, AuthToken = null, Timeout = 30000) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestsAPIConstants.uriAddBatchRequest(),
+    AddBatchRequestDTO,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
+
 export async function AddRequestAndSubmit(AddRequestDTO, AuthToken = null, Timeout = 30000) {
   let APIResponse = await apiHandler.PostMethod(
     RequestsAPIConstants.uriAddRequest(),

package/src/CoreServices/transactionsServices.js

@@ -3942,6 +3942,51 @@ export async function GenerateDocument(
   );
   return APIResponse;
 }
+ /**
+  * @description
+  * Generates a child request step document based on the provided input data.
+  *
+  * @param {object} GenerateChildRequestStepDocumentInput
+  * Data object containing fields necessary for generating the child request step document.
+  *    parentRequestId: number
+  *    templateAttributeAlias: string
+  *    clientRequestAttributes: ClientRequestAttribute[]
+  *    isGeneratedWord: boolean
+  *
+  * @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 Generate Child Request Step Document API,
+  * including success message, status code, and any additional data returned by the API.
+  *   Message: Success,
+  *   StatusCode: 200,
+  *   Result: [
+  * RequestStepId: id,
+  * DocumentPath: added document path
+  * ]
+  */
+ export async function GenerateChildRequestStepDocument(
+  GenerateChildRequestStepDocumentInput,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGenerateChildRequestStepDocument(),
+    GenerateChildRequestStepDocumentInput,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
 
 /**
  * @description
@@ -4219,6 +4264,49 @@ export async function SignDocument(
   );  
   return APIResponse;
 }
+
+/**
+ * @description
+ * Retrieves a list of signed documents.
+ *
+ * @param {object} SignDocumentListDTO
+ * Data object containing fields necessary for retrieving the signed document list.
+ *   --- 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 List API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: [
+ *     --- signed document data ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function SignDocumentList(
+  SignDocumentListDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(  
+    TransactionsAPIConstants.uriSignDocumentList(),
+    SignDocumentListDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );  
+  return APIResponse;
+}
 //#endregion
 
 //#region Agent

package/src/index.d.ts

@@ -278,6 +278,11 @@ import { GetStepTypeOutput } from "./modals/output-modals/transaction-catalog-mo
 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";
+import { SignDocumentListInput } from "./modals/input-modals/transaction-catalog-modals/SignDocumentListInput";
+import { GenerateChildDocumentsInput } from "./modals/input-modals/transaction-catalog-modals/GenerateChildDocumentsInput";
+import { GenerateChildDocumentsOutput } from "./modals/output-modals/transaction-catalog-modals/GenerateChildDocumentsOutput";
+import { RequesterAddBatchRequestInput } from "./modals/input-modals/request-modals/RequesterAddBatchRequestInput";
+import { UpdateRequestStepAttributesInput } from "./modals/input-modals/request-step-modals/UpdateRequestStepAttributesInput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -3930,6 +3935,12 @@ interface TransactionCommonServices {
     RequiredHeaderValue?: string
   ) => BaseResponse<string | BaseErrorResponse>;
 
+  GenerateChildRequestStepDocument: (
+    Input: GenerateChildDocumentsInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GenerateChildDocumentsOutput[] | BaseErrorResponse>;
 
   GenerateStepDocument: (
     Input: GenerateStepDocumentInput,
@@ -4306,6 +4317,40 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<string | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of signed documents.
+   *
+   * @param {SignDocumentListInput} SignDocumentListDTO
+   * Data object containing fields necessary for retrieving the signed document list.
+   *   --- 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 List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- signed document data ---
+   *   ],
+   *   HeaderValue: string
+   */
+  SignDocumentList: (
+    Input: SignDocumentListInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<string[] | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -5042,6 +5087,37 @@ interface RequestsRequesterServices {
     Timeout?: number | null
   ) => BaseResponse<AddRequestOutput | BaseErrorResponse>;
   
+  /**
+   * @description
+   * Adds a batch request to requester as draft or not.
+   *
+   * @param {RequesterAddBatchRequestInput} AddBatchRequestDTO
+   * Data object containing fields necessary for adding a batch request.
+   *
+   * @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 Add Batch Request request, including
+   * success message, status code, and any additional data returned by the API.
+   * {
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: {
+   *   RequestGuid: string,
+   *   RequestId: number,
+   *   BatchId: number
+   * }
+   * }
+   */
+  AddBatchRequest: (
+    Input: RequesterAddBatchRequestInput,
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<AddRequestOutput | BaseErrorResponse>;
   /**
    * @description
    * Adds a request and submits it.
@@ -6626,6 +6702,12 @@ interface RequestStepProviderServices {
     AuthToken?: string | null,
     Timeout?: number | null
   ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  UpdateCorrespondenceStepAttributeList: (
+    Input: UpdateRequestStepAttributesInput[],
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<boolean | BaseErrorResponse>;
   
   
 }
@@ -7739,4 +7821,9 @@ export {
   SignDocumentInput,
   GetSignatureBlobOutput,
   GetInteractorSignatureOutput,
+  SignDocumentListInput,
+  GenerateChildDocumentsInput,
+  GenerateChildDocumentsOutput,
+  RequesterAddBatchRequestInput,
+  UpdateRequestStepAttributesInput,
 };

package/src/index.js

@@ -145,6 +145,8 @@ const {
   GetInteractorSignatures,
   GetSignatureBlob,
   SignDocument,
+  SignDocumentList,
+  GenerateChildRequestStepDocument
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -250,6 +252,8 @@ const TransactionCommonServices = {
   GetInteractorSignatures,
   GetSignatureBlob,
   SignDocument,
+  SignDocumentList,
+  GenerateChildRequestStepDocument,
 };
 
 const {
@@ -311,6 +315,7 @@ const {
   DispatcherGetRequestStatus,
   DispatcherCancelRequest,
   GetServiceManagementRequestDistinctServiceList,
+  AddBatchRequest,
 } = require("./CoreServices/requestsServices");
 const RequestsAgentServices = {
   AgentAddRequest,
@@ -343,6 +348,7 @@ const RequestsRequesterServices = {
   SubmitCart,
   SubmitCartOrder,
   GetServiceManagementRequestDistinctServiceList,
+  AddBatchRequest,
 };
 const RequestsTransactionCommonServices = {
   AssignBatchToRequestList,
@@ -387,7 +393,8 @@ const {
   Reject,
   Start,
   GetRequestStepAssignableRoleList,
-  ProcessStepSpecialAction
+  ProcessStepSpecialAction,
+  UpdateCorrespondenceStepAttributeList
 } = require("./CoreServices/requestStepsServices");
 const RequestStepProviderServices = {
   AcceptOrder,
@@ -405,7 +412,8 @@ const RequestStepProviderServices = {
   RejectOrder,
   UpdateDismissedRequestStepList,
   GetRequestStepAssignableRoleList,
-  ProcessStepSpecialAction
+  ProcessStepSpecialAction,
+  UpdateCorrespondenceStepAttributeList
 };
 const RequestStepDispatchServices = {
   Accept,

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

@@ -0,0 +1,131 @@
+export interface RequesterAddBatchRequestInput {
+    ServiceId: number
+    ItemId?: number
+    AssetId?: number
+    InteractorId?: number
+    AgentId?: number
+    RoleType?: string
+    BatchId?: number
+    IsSync?: boolean
+    ClientRequestAttributeDtos?: ClientRequestAttributeDto[]
+    RequestLanguageCode?: string
+    DynamicStepList?: DynamicStepList[]
+    ChildRequestList?: ChildRequestList[]
+    IsGeneratedDocument?: boolean
+  }
+  
+  export interface ChildRequestList {
+    ClientRequestAttributeDtos: ClientRequestAttributeDto[]
+  }
+
+  export interface DynamicStepList {
+    StepTypeName: string
+    StepName: string
+    SequenceNo: number
+    ProviderRoleId: number
+    CloseWhenChildCompleted: boolean
+    CloseWhenParentCompleted: boolean
+    SetWaitingOnStart: boolean
+    IsRequesterVisible: boolean
+    IsProviderVisible: boolean
+    IsRejectable: boolean
+    IsAssignable: boolean
+    ChildSteps: ChildStep[]
+  }
+  
+  export interface ChildStep {
+    StepTypeName: string
+    StepName: string
+    SequenceNo: number
+    ProviderRoleId: number
+    CloseWhenChildCompleted: boolean
+    CloseWhenParentCompleted: boolean
+    SetWaitingOnStart: boolean
+  }
+
+  export interface ClientRequestAttributeDto {
+    IsSystemGenerated: boolean
+    DtoState: number
+    RequestAttributeId: number
+    RequestId: number
+    Name: string
+    IsRequired: boolean
+    Value: string
+    AttributeTypeId: number
+    AttributeGroupId: number
+    IsRequesterVisible: boolean
+    IsProviderVisible: boolean
+    IsRequesterEditable: boolean
+    IsProviderEditable: boolean
+    RequestStepId: number
+    SequenceNo: number
+    IsComputed: boolean
+    Formula: string
+    SourceServiceAttributeId: number
+    Group: string
+    GroupSequenceNo: number
+    ExtendedValue: string
+    GroupId: number
+    AttachmentOriginalName: string
+    AlternateName: string
+    AlternateValue: string
+    AlternateGroup: string
+    Alias: string
+    PlaceHolder: string
+    ShowInReport: boolean
+    Description: string
+    AlternateDescription: string
+    AlternatePlaceHolder: string
+    Prefix: string
+    IsFiltered: boolean
+    FilterAttributeAlias: string
+    IsParameter: boolean
+    Extra1: string
+    Extra2: string
+    BatchId: number
+    IsComputedInitialValue: boolean
+    InitialValueFormula: string
+    IsValidationEnabled: boolean
+    ValidationRule: string
+    ValidationRuleFailedComment: string
+    IsIntegrationEditable: boolean
+    IsRequiredCondition: string
+    OnChangeRecalculate: boolean
+    PageNumber: number
+    AttributeTypeValueTypeName: string
+    FormatCategoryId: number
+    FormatTypeName: string
+    Hint: string
+    HideLabel: boolean
+    IsIntegration: boolean
+    IsRecord: boolean
+    IsRecordName: boolean
+    Regex: string
+    ReturnType: string
+    CounterMaxValue: string
+    CounterMinValue: string
+    CounterStepValue: string
+    HideValue: boolean
+    IsPicker: boolean
+    AttributeLength: string
+    ShowInQuestionnaire: boolean
+    IsMultipleChoice: boolean
+    AttributeDefinition: string
+    IsPasswordMask: boolean
+    IsEncryptionEnabled: boolean
+    AllowOthers: boolean
+    UseGridControl: boolean
+    UIControlAlias: string
+    ShowInProfile: boolean
+    ObjectType: number
+    DocumentId: number
+    FormatTypeId: number
+    Translations: string
+    DescriptionTranslations: string
+    PlaceHolderTranslations: string
+    ValueTranslations: string
+    ValidationRuleFailedCommentTranslation: string
+    GroupTranslations: string
+  }
+  
+  

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

@@ -0,0 +1,5 @@
+export interface UpdateRequestStepAttributesInput {
+    requestStepId: number;
+    alias: string;
+    value: string;
+}

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

@@ -0,0 +1,16 @@
+export interface GenerateChildDocumentsInput {
+    parentRequestId: number;
+    templateAttributeAlias: string;
+    clientRequestAttributes: ClientRequestAttribute[];
+    isGeneratedWord: boolean;
+}
+
+export interface ClientRequestAttribute {
+    RequestAttributeId: number
+    Name: string
+    Value: string
+    AttributeGroupId: number
+    SourceServiceAttributeId: number
+    ExtendedValue: string
+    Alias: string
+  }

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

@@ -0,0 +1,5 @@
+export interface SignDocumentListInput {
+    documentPath: string[];
+    alias: string;
+    interactorSignatureId: number;
+}

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

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

package/src/web-services/apiConstants.js

@@ -366,6 +366,9 @@ export class TransactionsAPIConstants {
   static uriGenerateStepDocument() {
     return transactionCatalogURI + "/api/TransactionCommon/GenerateStepDocument";
   }
+  static uriGenerateChildRequestStepDocument() {
+    return transactionCatalogURI + "/api/TransactionCommon/GenerateChildRequestStepDocument";
+  }
   static uriGetAssetManagementAssetSubGroupList() {
     return transactionCatalogURI + "/api/TransactionCommon/GetAssetManagementAssetSubGroupList";
   }
@@ -402,6 +405,9 @@ export class TransactionsAPIConstants {
   static uriSignDocument(){
     return signatureURI + "/api/SignDocument";
   }
+  static uriSignDocumentList(){
+    return signatureURI + "/api/SignDocument/List";
+  }
   //#endregion
 
   //#region Agent
@@ -509,6 +515,9 @@ export class RequestsAPIConstants {
   static uriAddRequest() {
     return requestServicesURI + "/api/Requester/AddRequest";
   }
+  static uriAddBatchRequest() {
+    return requestServicesURI + "/api/CorrespondenceRequester/AddBatchRequest";
+  }
   static uriSubmitCart() {
     return requestServicesURI + "/api/Requester/SubmitCart";
   }
@@ -661,6 +670,9 @@ export class RequestStepsAPIConstants {
   static uriProcessStepSpecialAction() {
     return requestStepURI + "/api/Provider/ProcessStepSpecialAction";
   }
+  static uriUpdateCorrespondenceStepAttributeList(){
+    return requestStepURI + "/api/CorrespondenceProvider/UpdateRequestStepAttributeList";
+  }
   //#endregion
 
   //#region Dispatch