octopian-apis 1.0.26 → 1.0.27

package/README.md

@@ -73,7 +73,7 @@ OctopianSDKConfig.Init('Your-API-Key',"Domain-Name")
 
 ## 🎈 Usage <a name="usage"></a>
 
-For detailed usage and services available in this SDK download our [documentation](https://in4ma-my.sharepoint.com/:u:/g/personal/mohammad_saeed_in4ma_onmicrosoft_com/Ee62SmLnu0ZIpPVi-Yxji0MBOj4f3TuEp_1vci4T0hDo0g?e=Z3i67j)
+For detailed usage and services available in this SDK download our [documentation](https://in4ma-my.sharepoint.com/:u:/g/personal/mohammad_saeed_in4ma_onmicrosoft_com/EWPwDObJewFFtGjI32P5dWcBGQIVoGblICedbwx-wxmszw?e=ECvvnt)
 
 ```typescript
 import {AuthenticationServices} from 'octopian-apis';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octopian-apis",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "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/storageServices.js

@@ -170,3 +170,58 @@ export async function UploadAttachments(
     return attachmentsResponse;
   } else return writeSASResponse;
 }
+/**
+ * @description
+ * Generates a Shared Access Signature (SAS) for reading from the storage.
+ *
+ * @param {string} AuthToken 
+ * Authentication token for authorization purposes.
+ *
+ * @param {number} Timeout
+ * Optional timeout in milliseconds for the request.
+ *
+ * @returns
+ * An object containing the generated read SAS, including
+ * success message, status code, and any additional data returned by the API. 
+ * {
+ *         Message: Success,
+ *         StatusCode: 200,
+ *         Result: string
+ *  }
+ */
+export async function GetOnPremiseReadSAS(AuthToken = null, Timeout = 30000) {
+  let APIResponse = await apiHandler.GetMethod(
+    StorageAPIConstants.uriGetOnPremiseReadSAS(),
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
+/**
+ * @description
+ * Generates a Shared Access Signature (SAS) for writing to the storage.
+ *
+ * @param {string} AuthToken 
+ * Authentication token for authorization purposes.
+ *
+ * @param {number} Timeout
+ * Optional timeout in milliseconds for the request.
+ *
+ * @returns
+ * An object containing the generated write SAS, including
+ * success message, status code, and any additional data returned by the API. 
+ * {
+ *         Message: Success,
+ *         StatusCode: 200,
+ *         Result: string
+ *  }
+ */
+export async function GetOnPremiseWriteSAS(AuthToken = null, Timeout = 30000) {
+  let APIResponse = await apiHandler.GetMethod(
+    StorageAPIConstants.uriGetOnPremiseWriteSAS(),
+    AuthToken,
+    Timeout
+  );
+  return APIResponse;
+}
+

package/src/CoreServices/transactionsServices.js

@@ -4096,6 +4096,47 @@ export async function GetAssignbleRoleList(
   );
   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 Provider

package/src/index.d.ts

@@ -256,6 +256,7 @@ import {
 } from "./modals/output-modals/transaction-catalog-modals/PaymentInvoiceOutput";
 import { GetMyCorrespondenceListDTO } from "./modals/input-modals/correspondence-modals/GetMyCorrespondenceListDTO";
 import { CorrespondenceSubmitDraftInput } from "./modals/input-modals/correspondence-modals/CorrespondenceSubmitDraftInput";
+import { GenerateDocumentInput } from "./modals/input-modals/transaction-catalog-modals/GenerateDocumentInput";
 // Define each module with its specific functions
 
 interface AuthenticationServices {
@@ -3628,6 +3629,34 @@ interface TransactionCommonServices {
     Timeout?: number | null,
     RequiredHeaderValue?: string
   ) => BaseResponse<DocumentRecordTemplateOutput[] | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Generates a document using the provided data object.
+   *
+   * @param {GenerateDocumentInput} GenerateDocumentDTO
+   * Data object containing fields necessary for generating a document.
+   *
+   * @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 Generate Document API,
+   * including success message, status code, and any additional data returned by the API.
+   *   Message: Success,
+   *   StatusCode: 200,
+   *   Result: string (document id) 
+   *   HeaderValue: string
+   */
+  GenerateDocument: (
+    Input: GenerateDocumentInput,
+    AuthToken?: string | null,
+    Timeout?: number | null,
+    RequiredHeaderValue?: string
+  ) => BaseResponse<string | BaseErrorResponse>;
 }
 
 // Storage Services interface
@@ -3757,6 +3786,54 @@ interface StorageServices {
     AuthToken?: string | null,
     Timeout?: number | null
   ) => BaseResponse<boolean | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Generates a Shared Access Signature (SAS) for reading from the storage.
+   *
+   * @param {string} AuthToken
+   * Authentication token for authorization purposes.
+   *
+   * @param {number} Timeout
+   * Optional Timeout in milliseconds for the request.
+   *
+   * @returns 
+   * An object containing the generated read SAS, including
+   * success message, status code, and any additional data returned by the API.
+   * {
+   *         Message: Success,
+   *         StatusCode: 200,
+   *         Result: string
+   * }
+   */
+  GetOnPremiseReadSAS: (
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<string | BaseErrorResponse>;
+
+  /**
+   * @description
+   * Generates a Shared Access Signature (SAS) for writing to the storage.
+   *
+   * @param {string} AuthToken
+   * Authentication token for authorization purposes.
+   *
+   * @param {number} Timeout
+   * Optional Timeout in milliseconds for the request.
+   *
+   * @returns
+   * An object containing the generated write SAS, including
+   * success message, status code, and any additional data returned by the API. 
+   * {
+   *         Message: Success,
+   *         StatusCode: 200,
+   *         Result: string
+   * }
+   */ 
+  GetOnPremiseWriteSAS: (
+    AuthToken?: string | null,
+    Timeout?: number | null
+  ) => BaseResponse<string | BaseErrorResponse>;
 }
 
 // Requests Agent Services interface
@@ -6447,6 +6524,7 @@ export {
   RequestsDispatchServices,
   TaxiServices,
   CorrespondenceServices,
+  GenerateDocumentInput,
   ChangeAccountPasswordInput,
   ExecuteServiceSelectorListIntegrationInput,
   DomainAvailableInput,

package/src/index.js

@@ -123,6 +123,7 @@ const {
   GetInvoiceDetails,
   ValidateAttributesWithIntegration,
   GetPaymentBatch,
+  GenerateDocument
 } = require("./CoreServices/transactionsServices");
 const TransactionRequesterServices = {
   GetCompanyLanguageList,
@@ -206,6 +207,7 @@ const TransactionCommonServices = {
   MaintainInteractorRoleDelegationList,
   GetDocumentRecordTemplate,
   GetCompanyCustomLabelList,
+  GenerateDocument
 };
 
 const {
@@ -213,14 +215,18 @@ const {
   CreateWriteSAS,
   DeleteFile,
   UploadAttachments,
-  AIVisionCopyFile
+  AIVisionCopyFile,
+  GetOnPremiseReadSAS,
+  GetOnPremiseWriteSAS
 } = require("./CoreServices/storageServices");
 const StorageServices = {
   CreateReadSAS,
   CreateWriteSAS,
   DeleteFile,
   UploadAttachments,
-  AIVisionCopyFile
+  AIVisionCopyFile,
+  GetOnPremiseReadSAS,
+  GetOnPremiseWriteSAS
 };
 
 const {

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

@@ -0,0 +1,16 @@
+export interface GenerateDocumentInput {
+    serviceId: number
+    templateAttributeAlias: string
+    clientRequestAttributes: ClientRequestAttribute[]
+  }
+  
+  export interface ClientRequestAttribute {
+    RequestAttributeId: number
+    Name: string
+    Value: string
+    AttributeGroupId: number
+    SourceServiceAttributeId: number
+    ExtendedValue: string
+    Alias: string
+  }
+  

package/src/web-services/apiConstants.js

@@ -360,6 +360,9 @@ export class TransactionsAPIConstants {
       transactionCatalogURI + "/api/TransactionCommon/GetDocumentRecordTemplate"
     );
   }
+  static uriGenerateDocument() {
+    return transactionCatalogURI + "/api/TransactionCommon/GenerateDocument";
+  }
   //#endregion
 
   //#region Agent
@@ -633,6 +636,12 @@ export class StorageAPIConstants {
   static uriAIVisionCopyFile() {
     return storageURI + "/api/AIVision/CopyFile";
   }
+  static uriGetOnPremiseReadSAS() {
+    return storageURI + "/api/OnPremStorage/GenerateDownloadSas";
+  }
+  static uriGetOnPremiseWriteSAS() {
+    return storageURI + "/api/OnPremStorage/GenerateUploadSas";
+  }
 }
 
 export class TaxiAPIConstants {