octopian-apis 1.0.42 → 1.0.43

package/src/index.d.ts

@@ -263,6 +263,13 @@ import { RequestStepAssignableRoleInput } from "./modals/input-modals/request-st
 import { RequestStepAssignableRoleOutput } from "./modals/output-modals/request-step-modals/RequestStepAssignableRoleOutput";
 import { ProcessStepSpecialActionInput } from "./modals/input-modals/request-step-modals/ProcessStepSpecialActionInput";
 import { LinkedLoginOutput } from "./modals/output-modals/authentications-modals/LinkedLoginOutput";
+import { GetPersonalUnitMemberInput } from "./modals/input-modals/transaction-catalog-modals/GetPersonalUnitMemberInput";
+import { ConvertPersonalUnitMemberInput } from "./modals/input-modals/transaction-catalog-modals/ConvertPersonalUnitMemberInput";
+import { MaintainServiceManagementInput } from "./modals/input-modals/transaction-catalog-modals/MaintainServiceManagementInput";
+import { MaintainAgentUnitInput } from "./modals/input-modals/transaction-catalog-modals/MaintainAgentUnitInput";
+import { MaintainAgentInteractorInput } from "./modals/input-modals/transaction-catalog-modals/MaintainAgentInteractorInput";
+import { MaintainAgentInteractorOutput } from "./modals/output-modals/transaction-catalog-modals/MaintainAgentInteractorOutput";
+import { GetServiceManagementServiceListOutput } from "./modals/output-modals/request-modals/GetServiceManagementServiceListOutput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -2064,6 +2071,257 @@ interface TransactionAgentServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<GetAssignableRoleListOutput | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves the profile of the current agent.
+   *
+   * @param {GetMyProfileInput} GetMyProfileDTO
+   * Data object containing fields necessary for retrieving the agent profile.
+   *   --- agent profile 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 Get My Profile Agent API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,    
+   *   StatusCode: 200,
+   *   Result: --- agent profile data---,
+   *   HeaderValue: string
+   */
+  GetAgentProfile: (
+    Input: GetMyProfileInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetMyProfileOutput | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the list of attributes for an agent.
+   *
+   * @param {MaintainMyAttributeInput} MaintainMyAttributeListAgentDTO
+   * Data object containing fields necessary for maintaining the agent attribute list.
+   *   --- agent attribute 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 Maintain My Attribute List Agent API,   
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: --- update agent attribute list ---,
+   *   HeaderValue: string
+   */
+  MaintainMyAttributeListAgent: (
+    Input: MaintainMyAttributeInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<MaintainMyAttributeInput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Updates the profile of the current agent.
+   *
+   * @param {UpdateMyProfileInput} UpdateMyProfileDTO
+   * Data object containing fields necessary for updating the agent profile.  
+   *   --- agent profile 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 Update My Profile Agent API,    
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: --- update agent profile ---,
+   *   HeaderValue: string
+   */
+  UpdateMyProfileAgent: (
+    Input: UpdateMyProfileInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetMyProfileOutput | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the list of addresses for an agent.
+   *
+   * @param {MaintainAddressListInput} MaintainMyAddressListAgentDTO
+   * Data object containing fields necessary for maintaining the list of addresses.
+   *   --- list of addresses 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 Maintain My Address List Agent API, 
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [--- updated addresses list ---],
+   *   HeaderValue: string
+   */
+  MaintainMyAddressListAgent: (
+    Input: MaintainAddressListInput[],
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<MaintainAddressListOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the list of documents for an agent.
+   *
+   * @param {MaintainMyDocumentInput} MaintainMyDocumentAgentDTO
+   * Data object containing fields necessary for maintaining the list of documents.
+   *   --- list of documents 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 Maintain My Document Agent API,   
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [--- updated documents list ---],
+   *   HeaderValue: string
+   */
+  MaintainMyDocumentAgent: (
+    Input: MaintainMyDocumentInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<MaintainMyDocumentOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of eligible documents for an agent.
+   *
+   * @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 Eligible Document List Agent API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [--- eligible documents list ---],
+   *   HeaderValue: string
+   */
+  GetInteractorEligibleDocumentListAgent: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<InteractorEligibleDocumentOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the list of units for an agent.
+   *
+   * @param {MaintainAgentUnitInput} MaintainAgentUnitListDTO
+   * Data object containing fields necessary for maintaining the list of units.
+   *   --- list of units 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 Maintain Agent Unit List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,  
+   *   StatusCode: 200,
+   *   Result: [--- updated units list ---],
+   *   HeaderValue: string
+   */
+  MaintainAgentUnitList: (
+    Input: MaintainAgentUnitInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Maintains the list of interactors for an agent.
+   *
+   * @param {MaintainAgentInteractorInput} MaintainAgentInteractorListDTO
+   * Data object containing fields necessary for maintaining the list of interactors.
+   *   --- list of interactors 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 Maintain Agent Interactor List API, 
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [--- updated interactors list ---],
+   *   HeaderValue: string
+   */ 
+  MaintainAgentInteractorList: (
+    Input: MaintainAgentInteractorInput[],
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<MaintainAgentInteractorOutput[]| BaseErrorResponse>;
 }
 
 // Transaction Common Services interface
@@ -3663,6 +3921,194 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<string | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of asset management asset sub groups.
+   *
+   * @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 Asset Management Asset Sub Group List API,
+   * including success message, status code, and any additional data returned by the API. 
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- asset management asset sub group data ---
+   *   ],
+   *   HeaderValue: string
+   */
+  GetAssetManagementAssetSubGroupList: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<ServiceAssetOutput[] | BaseErrorResponse>;
+  
+  /**
+   * @description
+   * Retrieves a list of service management services.
+   *
+   * @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 Service Management Service List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- service management service data ---
+   *   ], 
+   *   HeaderValue: string
+   */
+  GetServiceManagementServiceList: (
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<FullServiceList[] | BaseErrorResponse>;
+  
+  /**
+   * @description
+   * Maintains a list of asset management asset sub groups.
+   *
+   * @param {Assetlist[]} MaintainAssetManagementAssetSubGroupListDTO
+   * Data object containing fields necessary for maintaining the asset management asset sub group list.
+   *   --- asset management asset sub group 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 Maintain Asset Management Asset Sub Group List API, 
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,  
+   *   StatusCode: 200,
+   *   Result: boolean,
+   *   HeaderValue: string
+   */ 
+  MaintainAssetManagementAssetSubGroupList: (
+    Input: Assetlist[],
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<boolean | BaseErrorResponse>;
+  
+  /**
+   * @description
+   * Retrieves a list of my personal unit members.
+   *
+   * @param {GetPersonalUnitMemberInput} GetMyPersonalUnitMemberListDTO
+   * Data object containing fields necessary for retrieving the my personal unit member list.
+   *   --- my personal unit member 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 Get My Personal Unit Member List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,  
+   *   StatusCode: 200,
+   *   Result: [
+   *     --- my personal unit member data ---
+   *   ],
+   *   HeaderValue: string
+   */
+  GetMyPersonalUnitMemberList: (
+    Input: GetPersonalUnitMemberInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<GetAgentInteractorListOutput[] | BaseErrorResponse>;
+  
+  /**
+   * @description
+   * Converts a personal unit member to a record.
+   *
+   * @param {ConvertPersonalUnitMemberInput} ConvertPersonalUnitMemberToRecordDTO
+   * Data object containing fields necessary for converting the personal unit member to a record.
+   *   --- personal unit member 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 Convert Personal Unit Member To Record API, 
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: string,
+   *   HeaderValue: string
+   */
+  ConvertPersonalUnitMemberToRecord: (
+    Input: ConvertPersonalUnitMemberInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<string | BaseErrorResponse>;
+  
+  /**
+   * @description
+   * Maintains a list of service management services.
+   *
+   * @param {MaintainServiceManagementInput} MaintainServiceManagementServiceListDTO
+   * Data object containing fields necessary for maintaining the service management service list.
+   *   --- service management service 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 Maintain Service Management Service List API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,  
+   *   StatusCode: 200,
+   *   Result: boolean,
+   *   HeaderValue: string
+   */
+  MaintainServiceManagementServiceList: (
+    Input: MaintainServiceManagementInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<boolean | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -4699,6 +5145,35 @@ interface RequestsRequesterServices {
     AuthToken?: string | null,
     Timeout?: number | null
   ) => BaseResponse<SubmitCartOrderOutput | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Retrieves a list of distinct services from the service management 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 Get Service Management Request Distinct Service List request, including
+   * success message, status code, and any additional data returned by the API.
+   * {    
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: [
+   *     {
+   *       ServiceId: number,
+   *       Name: string
+   *       Translations: string
+   *     },..]
+   * }
+   */
+  GetServiceManagementRequestDistinctServiceList: (
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<GetServiceManagementServiceListOutput[] | BaseErrorResponse>;
 }
 
 // Requests Transaction Common Services interface
@@ -6972,5 +7447,12 @@ export {
   RequestStepAssignableRoleOutput,
   ProcessStepSpecialActionInput,
   LinkedLoginOutput,
-  Attachment
+  Attachment,
+  GetPersonalUnitMemberInput,
+  ConvertPersonalUnitMemberInput,
+  MaintainServiceManagementInput,
+  MaintainAgentUnitInput,
+  MaintainAgentInteractorInput,
+  MaintainAgentInteractorOutput,
+  GetServiceManagementServiceListOutput
 };

package/src/index.js

@@ -123,7 +123,21 @@ const {
   GetInvoiceDetails,
   ValidateAttributesWithIntegration,
   GetPaymentBatch,
-  GenerateDocument
+  GenerateDocument,
+  GetAssetManagementAssetSubGroupList,
+  MaintainAssetManagementAssetSubGroupList,
+  GetServiceManagementServiceList,
+  MaintainServiceManagementServiceList,
+  GetMyPersonalUnitMemberList,
+  ConvertPersonalUnitMemberToRecord,
+  GetAgentProfile,
+  MaintainMyAttributeListAgent,
+  UpdateMyProfileAgent,
+  MaintainMyAddressListAgent,
+  MaintainMyDocumentAgent,
+  GetInteractorEligibleDocumentListAgent,
+  MaintainAgentUnitList,
+  MaintainAgentInteractorList,
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -157,6 +171,14 @@ const TransactionAgentServices = {
   GetServiceAssetAttributeListAgent,
   GetServiceItemAttributeListAgent,
   GetAssignbleRoleList,
+  GetAgentProfile,
+  MaintainMyAttributeListAgent,
+  UpdateMyProfileAgent,
+  MaintainMyAddressListAgent,
+  MaintainMyDocumentAgent,
+  GetInteractorEligibleDocumentListAgent,
+  MaintainAgentUnitList,
+  MaintainAgentInteractorList,
 };
 const TransactionCommonServices = {
   GetStyle,
@@ -207,7 +229,13 @@ const TransactionCommonServices = {
   MaintainInteractorRoleDelegationList,
   GetDocumentRecordTemplate,
   GetCompanyCustomLabelList,
-  GenerateDocument
+  GenerateDocument,
+  GetAssetManagementAssetSubGroupList,
+  MaintainAssetManagementAssetSubGroupList,
+  GetServiceManagementServiceList,
+  MaintainServiceManagementServiceList,
+  GetMyPersonalUnitMemberList,
+  ConvertPersonalUnitMemberToRecord
 };
 
 const {
@@ -267,6 +295,7 @@ const {
   UpdateRequestDismiss,
   DispatcherGetRequestStatus,
   DispatcherCancelRequest,
+  GetServiceManagementRequestDistinctServiceList,
 } = require("./CoreServices/requestsServices");
 const RequestsAgentServices = {
   AgentAddRequest,
@@ -298,6 +327,7 @@ const RequestsRequesterServices = {
   PostComment,
   SubmitCart,
   SubmitCartOrder,
+  GetServiceManagementRequestDistinctServiceList,
 };
 const RequestsTransactionCommonServices = {
   AssignBatchToRequestList,
@@ -528,7 +558,7 @@ const {
   DABValidateAttributesWithIntegration,
   DABGetPaymentBatch,
   DABGetInvoiceDetails,
-  DABAddToCart
+  DABAddToCart,
 } = require("./darAlBerServices/transactionsServices");
 const {
   DABCreateReadSAS,

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

@@ -0,0 +1,3 @@
+export interface ConvertPersonalUnitMemberInput {
+    InteractorId?: number
+  }

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

@@ -0,0 +1,5 @@
+export interface GetPersonalUnitMemberInput {
+    AttributeTypeId: number
+    UnitId: number
+  }
+