octopian-apis 1.0.42 → 1.0.43

package/package.json

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

@@ -986,6 +986,41 @@ export async function SubmitCartOrder(
   return APIResponse;
 }
 
+/**
+ * @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
+ *     },..]
+ */
+export async function GetServiceManagementRequestDistinctServiceList(
+  AuthToken = null,
+  Timeout = 30000
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    RequestsAPIConstants.uriGetServiceManagementRequestDistinctServiceList(),
+    null,
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
 //#endregion
 
 //#region TransactionCommon

package/src/CoreServices/transactionsServices.js

@@ -3664,6 +3664,284 @@ export async function GetDocumentRecordTemplate(
   );
   return APIResponse;
 }
+
+/**
+ * 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
+ */
+export async function GetAssetManagementAssetSubGroupList(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetAssetManagementAssetSubGroupList(),
+    null,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * 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
+ */
+export async function GetServiceManagementServiceList(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetServiceManagementServiceList(),
+    null,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of asset management asset sub groups.
+ *
+ * @param {object} 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: --- update asset management asset sub group list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainAssetManagementAssetSubGroupList(
+  MaintainAssetManagementAssetSubGroupListDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainAssetManagementAssetSubGroupList(),
+    MaintainAssetManagementAssetSubGroupListDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Retrieves a list of my personal unit members.
+ *
+ * @param {object} 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
+ */
+export async function GetMyPersonalUnitMemberList(
+  GetMyPersonalUnitMemberListDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetMyPersonalUnitMemberList(),
+    GetMyPersonalUnitMemberListDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Converts a personal unit member to a record.
+ *
+ * @param {object} 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: --- personal unit member data ---,
+ *   HeaderValue: string
+ */
+export async function ConvertPersonalUnitMemberToRecord(
+  ConvertPersonalUnitMemberToRecordDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriConvertPersonalUnitMemberToRecord(),
+    ConvertPersonalUnitMemberToRecordDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of service management services.
+ *
+ * @param {object} 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: --- update service management service list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainServiceManagementServiceList(
+  MaintainServiceManagementServiceListDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainServiceManagementServiceList(),
+    MaintainServiceManagementServiceListDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * @description
+ * Generates a document based on the provided input data.
+ *
+ * @param {object} GenerateDocumentInput
+ * Data object containing fields necessary for generating the document.
+ *    ServiceId: number
+ *    TemplateAttributeAlias: string
+ *    ClientRequestAttributes: ClientRequestAttribute[]
+ *
+ * @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 Document API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: string (document id)
+ */
+export async function GenerateDocument(
+  GenerateDocumentInput,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGenerateDocument(),
+    GenerateDocumentInput,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
 //#endregion
 
 //#region Agent
@@ -4096,15 +4374,13 @@ export async function GetAssignbleRoleList(
   );
   return APIResponse;
 }
+
 /**
- * @description
- * Generates a document based on the provided input data.
+ * Retrieves the profile of the current agent.
  *
- * @param {object} GenerateDocumentInput
- * Data object containing fields necessary for generating the document.
- *    ServiceId: number
- *    TemplateAttributeAlias: string
- *    ClientRequestAttributes: ClientRequestAttribute[]
+ * @param {object} GetAgentProfileDTO
+ * Data object containing fields necessary for retrieving the agent profile.
+ *   --- agent profile data---  
  *
  * @param {string} AuthToken
  * Authentication token for authorization purposes.
@@ -4112,25 +4388,303 @@ export async function GetAssignbleRoleList(
  * @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
+ */
+export async function GetAgentProfile(
+  GetAgentProfileDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetMyProfileAgent(),
+    GetAgentProfileDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of attributes for an agent.
+ *
+ * @param {object} 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 Generate Document API,
+ * 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: string (document id)
+ *   Result: --- update agent attribute list ---,
+ *   HeaderValue: string
  */
-export async function GenerateDocument(
-  GenerateDocumentInput,
+export async function MaintainMyAttributeListAgent(
+  MaintainMyAttributeListAgentDTO,
   AuthToken = null,
   Timeout = 30000,
   RequiredHeaderValue = null
 ) {
   let APIResponse = await apiHandler.PostMethod(
-    TransactionsAPIConstants.uriGenerateDocument(),
-    GenerateDocumentInput,
+    TransactionsAPIConstants.uriMaintainMyAttributeListAgent(),
+    MaintainMyAttributeListAgentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Updates the profile of the current agent.
+ *
+ * @param {object} UpdateMyProfileAgentDTO
+ * 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
+ */
+export async function UpdateMyProfileAgent(
+  UpdateMyProfileAgentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriUpdateMyProfileAgent(),
+    UpdateMyProfileAgentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of addresses for an agent.
+ *
+ * @param {object} MaintainMyAddressListAgentDTO
+ * Data object containing fields necessary for maintaining the agent address list.
+ *   --- agent address 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 Address List Agent API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,  
+ *   StatusCode: 200,
+ *   Result: --- update agent address list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainMyAddressListAgent(
+  MaintainMyAddressListAgentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainMyAddressListAgent(),
+    MaintainMyAddressListAgentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of documents for an agent.
+ *
+ * @param {object} MaintainMyDocumentAgentDTO
+ * Data object containing fields necessary for maintaining the agent document list.
+ *   --- agent document 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 Document Agent API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: --- update agent document list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainMyDocumentAgent(
+  MaintainMyDocumentAgentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainMyDocumentAgent(),
+    MaintainMyDocumentAgentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Retrieves a list of eligible documents for an interactor.
+ *
+ * @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 document data ---
+ *   ],
+ *   HeaderValue: string
+ */
+export async function GetInteractorEligibleDocumentListAgent(
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriGetInteractorEligibleDocumentListAgent(),
+    null,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of agent units.
+ *
+ * @param {object} MaintainAgentUnitListDTO
+ * Data object containing fields necessary for maintaining the agent unit list.
+ *   --- agent unit 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 Agent Unit List Agent API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200,
+ *   Result: --- update agent unit list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainAgentUnitList(
+  MaintainAgentUnitListAgentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainAgentUnitListAgent(),
+    MaintainAgentUnitListAgentDTO,
+    AuthToken,
+    Timeout,
+    RequiredHeaderValue
+  );
+  return APIResponse;
+}
+
+/**
+ * Maintains a list of agent interactors.
+ *
+ * @param {object} MaintainAgentInteractorListDTO
+ * Data object containing fields necessary for maintaining the agent interactor list.
+ *   --- agent interactor 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 Agent Interactor List Agent API,
+ * including success message, status code, and any additional data returned by the API.
+ *   Message: Success,
+ *   StatusCode: 200, 
+ *   Result: --- update agent interactor list ---,
+ *   HeaderValue: string
+ */
+export async function MaintainAgentInteractorList(
+  MaintainAgentInteractorListAgentDTO,
+  AuthToken = null,
+  Timeout = 30000,
+  RequiredHeaderValue = null
+) {
+  let APIResponse = await apiHandler.PostMethod(
+    TransactionsAPIConstants.uriMaintainAgentInteractorListAgent(),
+    MaintainAgentInteractorListAgentDTO,
     AuthToken,
     Timeout,
     RequiredHeaderValue