@experteam-mx/ngx-services 18.2.0 → 18.3.0

package/fesm2022/experteam-mx-ngx-services.mjs

@@ -44,7 +44,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImpo
  * @return {string} - The generated query string.
  */
 const queryString = (params) => {
-    let queryElements = [];
+    const queryElements = [];
     Object.entries(params).forEach(([key, value]) => {
         if (Array.isArray(value)) {
             const arrayQuery = value
@@ -79,7 +79,7 @@ const httpParams = (params) => new HttpParams({
  */
 const pdfHeaders = (format = 'object') => {
     const headers = {
-        'Accept': 'application/pdf'
+        Accept: 'application/pdf'
     };
     return format === 'object'
         ? headers
@@ -94,7 +94,7 @@ const pdfHeaders = (format = 'object') => {
  */
 const xmlHeaders = (format = 'object') => {
     const headers = {
-        'Accept': 'application/xml',
+        Accept: 'application/xml',
     };
     return format === 'object'
         ? headers
@@ -120,7 +120,7 @@ class ApiCompaniesService {
      * Fetches the installations based on the provided query parameters.
      *
      * @param {QueryParams} params - The parameters used to filter the installations query.
-     * @return {Observable<InstallationsData>} An observable that emits the installations data.
+     * @return {Observable<InstallationsOut>} An observable that emits the installation's data.
      */
     getInstallations(params) {
         return this.http.get(`${this.url}/installations`, {
@@ -131,7 +131,7 @@ class ApiCompaniesService {
      * Retrieves the installation details based on the given installation ID.
      *
      * @param {number} id - The unique identifier of the installation to retrieve.
-     * @returns {Observable<InstallationData>} An observable of the installation details.
+     * @returns {Observable<InstallationOut>} An observable of the installation details.
      */
     getInstallation(id) {
         return this.http.get(`${this.url}/installations/${id}`)
@@ -141,7 +141,7 @@ class ApiCompaniesService {
      * Retrieves a list of locations based on the provided query parameters.
      *
      * @param {QueryParams} params - The parameters to use for querying locations.
-     * @return {Observable<LocationsData>} An observable that emits the locations data.
+     * @return {Observable<LocationsOut>} An observable that emits the location's data.
      */
     getLocations(params) {
         return this.http.get(`${this.url}/locations`, {
@@ -152,7 +152,7 @@ class ApiCompaniesService {
      * Fetches the location details for a given location ID.
      *
      * @param {number} id - The unique identifier of the location.
-     * @return {Observable<LocationData>} An Observable containing the location details.
+     * @return {Observable<LocationOut>} An Observable containing the location details.
      */
     getLocation(id) {
         return this.http.get(`${this.url}/locations/${id}`)
@@ -162,7 +162,7 @@ class ApiCompaniesService {
      * Retrieves a list of active supply entities.
      *
      * @param {QueryParams} params - The query parameters to filter supply entities.
-     * @return {Observable<SupplyEntitiesData>} Observable emitting supply entities data.
+     * @return {Observable<SupplyEntitiesOut>} Observable emitting supply entities data.
      */
     getSupplyEntitiesActive(params) {
         return this.http.get(`${this.url}/supply-entities/actives`, {
@@ -173,7 +173,7 @@ class ApiCompaniesService {
      * Fetches a list of employees based on the specified query parameters.
      *
      * @param {QueryParams} params - The parameters to filter and sort the employees.
-     * @return {Observable<EmployeesData>} An observable that emits the list of employees.
+     * @return {Observable<EmployeesOut>} An observable that emits the list of employees.
      */
     getEmployees(params) {
         return this.http.get(`${this.url}/employees`, {
@@ -184,7 +184,7 @@ class ApiCompaniesService {
      * Fetches an employee's details based on the provided employee ID.
      *
      * @param {number} id - The unique identifier of the employee.
-     * @return {Observable<EmployeeData>} An observable that emits the employee's details.
+     * @return {Observable<EmployeeOut>} An observable that emits the employee's details.
      */
     getEmployee(id) {
         return this.http.get(`${this.url}/employees/${id}`)
@@ -194,7 +194,7 @@ class ApiCompaniesService {
      * Retrieves the list of employees for a specified location based on provided query parameters.
      *
      * @param {QueryParams} params - The query parameters used to filter and retrieve the location employees.
-     * @returns {Observable<LocationEmployeesData>} An observable that emits the list of employees for the specified location.
+     * @returns {Observable<LocationEmployeesOut>} An observable that emits the list of employees for the specified location.
      */
     getLocationEmployees(params) {
         return this.http.get(`${this.url}/location-employees`, {
@@ -205,7 +205,7 @@ class ApiCompaniesService {
      * Retrieves a list of countries where the company operates.
      *
      * @param {QueryParams} params - The query parameters for the API request.
-     * @return {Observable<CompanyCountriesData>} An observable containing the list of company countries.
+     * @return {Observable<CompanyCountriesOut>} An observable containing the list of company countries.
      */
     getCompanyCountries(params) {
         return this.http.get(`${this.url}/company-countries`, {
@@ -216,7 +216,7 @@ class ApiCompaniesService {
      * Retrieves the country information for a specified company by its ID.
      *
      * @param {number} id - The unique identifier of the company.
-     * @return {Observable<CompanyCountryData>} An observable containing the country information of the company.
+     * @return {Observable<CompanyCountryOut>} An observable containing the country information of the company.
      */
     getCompanyCountry(id) {
         return this.http.get(`${this.url}/company-countries/${id}`)
@@ -226,7 +226,7 @@ class ApiCompaniesService {
      * Fetches the reference currencies for a given country.
      *
      * @param {QueryParams} params - The query parameters to include in the request.
-     * @return {Observable<CountryReferenceCurrenciesData>} The observable containing the country reference currencies data.
+     * @return {Observable<CountryReferenceCurrenciesOut>} The observable containing the country reference currencies data.
      */
     getCountryReferenceCurrencies(params) {
         return this.http.get(`${this.url}/country-reference-currencies`, { params }).pipe(map(({ data }) => data));
@@ -241,21 +241,32 @@ class ApiCompaniesService {
         return this.getCountryReferenceCurrencies(params)
             .pipe(mergeMap((currenciesData) => {
             const $observables = currenciesData.country_reference_currencies
-                .map((country_reference_currency) => this.getCurrentExchanges({
-                currency_id: country_reference_currency.currency.id,
+                .map((item) => this.getCurrentExchanges({
+                currency_id: item.currency.id,
             }).pipe(map((exchangesData) => ({
-                ...country_reference_currency,
-                rate: exchangesData.exchanges[0]?.value ?? 1.00,
+                ...item,
+                rate: exchangesData.exchanges[0]?.value,
             }))));
             return forkJoin($observables);
         }));
     }
+    /**
+     * Fetches exchange data based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters for retrieving exchange data.
+     * @return {Observable<CountryExchangesOut>} An observable containing the exchange data.
+     */
+    getExchanges(params) {
+        return this.http.get(`${this.url}/exchanges`, {
+            params: httpParams(params),
+        }).pipe(map(({ data }) => data));
+    }
     /**
      * Retrieves the current exchanges based on the given query parameters.
      *
      * @param {QueryParams} params - The query parameters to filter the exchanges.
      *
-     * @returns {Observable<ExchangesData>} - An observable that emits the API response data containing the current exchanges.
+     * @returns {Observable<ExchangesOut>} - An observable that emits the API response data containing the current exchanges.
      */
     getCurrentExchanges(params) {
         return this.http.get(`${this.url}/exchanges/current`, {
@@ -266,7 +277,7 @@ class ApiCompaniesService {
      * Fetches the country-specific tax information for a company.
      *
      * @param {QueryParams} params - The parameters used to filter and query the taxes.
-     * @return {Observable<CompanyCountryTaxesData>} An observable that emits the tax information.
+     * @return {Observable<CompanyCountryTaxesOut>} An observable that emits the tax information.
      */
     getCompanyCountryTaxes(params) {
         return this.http.get(`${this.url}/company-country-taxes`, {
@@ -277,7 +288,7 @@ class ApiCompaniesService {
      * Retrieves the list of active account entities based on the provided query parameters.
      *
      * @param {QueryParams} params - The parameters to filter and query active account entities.
-     * @return {Observable<AccountEntitiesData>} An observable that emits the list of active account entities.
+     * @return {Observable<AccountEntitiesOut>} An observable that emits the list of active account entities.
      */
     getActiveAccountEntities(params) {
         return this.http.get(`${this.url}/account-entities/actives`, {
@@ -289,7 +300,7 @@ class ApiCompaniesService {
      *
      * @param {Object} params - An object containing the required parameters.
      * @param {string[]} params.paramNames - An array of parameter names for which the values need to be fetched.
-     * @return {Observable<ParametersData>} An observable that emits the fetched parameter values.
+     * @return {Observable<ParametersOut>} An observable that emits the fetched parameter values.
      */
     getParameters({ paramNames, }) {
         const parameters = paramNames.map((p) => ({ name: p }));
@@ -302,7 +313,7 @@ class ApiCompaniesService {
      *
      * @param {Object} input - The input object containing the parameter details.
      * @param {string} input.paramName - The name of the parameter whose value is to be retrieved.
-     * @return {Observable<ParameterValueData>} An observable emitting the value of the specified parameter.
+     * @return {Observable<ParameterValueOut>} An observable emitting the value of the specified parameter.
      */
     getParameterValue({ paramName, }) {
         return this.http.get(`${this.url}/parameters-values/${paramName}`)
@@ -312,7 +323,7 @@ class ApiCompaniesService {
      * Retrieves a list of country references based on the given query parameters.
      *
      * @param {QueryParams} params - The query parameters for retrieving country references.
-     * @return {Observable<CountryReferencesData>} An observable containing the country reference data.
+     * @return {Observable<CountryReferencesOut>} An observable containing the country reference data.
      */
     getCountryReferences(params) {
         return this.http.get(`${this.url}/country-references`, {
@@ -323,7 +334,7 @@ class ApiCompaniesService {
      * Fetches the country reference data for a given country ID.
      *
      * @param {number} id - The unique identifier of the country for which the reference data is to be retrieved.
-     * @return {Observable<CountryReferenceData>} An observable containing the country reference data.
+     * @return {Observable<CountryReferenceOut>} An observable containing the country reference data.
      */
     getCountryReference(id) {
         return this.http.get(`${this.url}/country-references/${id}`)
@@ -333,7 +344,7 @@ class ApiCompaniesService {
      * Fetches the list of workflows based on the provided query parameters.
      *
      * @param {QueryParams} params - The query parameters used to filter workflows.
-     * @return {Observable<WorkflowsData>} An observable containing the workflow data.
+     * @return {Observable<WorkflowsOut>} An observable containing the workflow data.
      */
     getWorkflows(params) {
         return this.http.get(`${this.url}/workflows`, {
@@ -353,6 +364,115 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImpo
                     args: ['env']
                 }] }, { type: i1.HttpClient }] });
 
+class ApiInvoicesService {
+    environments;
+    http;
+    constructor(environments, http) {
+        this.environments = environments;
+        this.http = http;
+    }
+    /**
+     * Retrieves the API URL for invoices from the environments configuration.
+     *
+     * @return {string} The API URL for invoices.
+     */
+    get url() {
+        return this.environments.apiInvoicesUrl;
+    }
+    /**
+     * Fetches and returns the collection receipt data for a given collection ID.
+     *
+     * @param {number} id - The unique identifier of the collection for which the receipt needs to be retrieved.
+     * @return {Observable<CollectionReceiptOut>} An observable containing the collection receipt data.
+     */
+    printCollectionReceipt(id) {
+        return this.http.get(`${this.url}/operation/print/collection-receipt/${id}`)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Handles the account payment operation by sending a POST request to the specified endpoint.
+     * Processes the response and returns the operation data.
+     *
+     * @param {AccountPaymentOperationIn} body The payload containing information for the account payment operation.
+     * @return {Observable<AccountPaymentOperationOut>} An observable emitting the processed account payment operation data.
+     */
+    accountPaymentOperation(body) {
+        return this.http.post(`${this.url}/operation/account-payment`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Cancels a payment receipt based on the provided input.
+     * This method sends a POST request to cancel a document.
+     *
+     * @param body The data required to cancel the payment receipt, encapsulated in a CancelPaymentReceiptIn object.
+     * @return An Observable representing the result of the cancellation. Emits an empty object on success.
+     */
+    cancelPaymentReceipt(body) {
+        return this.http.post(`${this.url}/operation/cancel-document`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Cancels an invoice based on the provided invoice ID and additional parameters.
+     *
+     * @param {Object} parameters - The parameters required to cancel the invoice, encapsulated in a CancelBillingIn object.
+     * @return {Observable<Object>} An observable that emits the response of the cancellation operation.
+     */
+    cancelInvoice({ invoiceId, ...body }) {
+        return this.http.post(`${this.url}/operation/cancel-billing/${invoiceId}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiInvoicesService, deps: [{ token: 'env' }, { token: i1.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiInvoicesService, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiInvoicesService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root'
+                }]
+        }], ctorParameters: () => [{ type: undefined, decorators: [{
+                    type: Inject,
+                    args: ['env']
+                }] }, { type: i1.HttpClient }] });
+
+class ApiReportsService {
+    environments;
+    http;
+    constructor(environments, http) {
+        this.environments = environments;
+        this.http = http;
+    }
+    /**
+     * Retrieves the URL for the reports API from the environment configurations.
+     *
+     * @return {string} The URL of the reports API.
+     */
+    get url() {
+        return this.environments.apiReportsUrl;
+    }
+    /**
+     * Retrieves the list of collection payments
+     *
+     * @param {QueryParams} params - The query parameters used to fetch the collection payments.
+     * @return {Observable<CollectionPaymentsOut[]>} An observable that emits an array of collection payment.
+     */
+    getCollectionPayments(params) {
+        return this.http.get(`${this.url}/collection-payment`, {
+            params
+        }).pipe(map(({ data }) => data));
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiReportsService, deps: [{ token: 'env' }, { token: i1.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiReportsService, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiReportsService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root'
+                }]
+        }], ctorParameters: () => [{ type: undefined, decorators: [{
+                    type: Inject,
+                    args: ['env']
+                }] }, { type: i1.HttpClient }] });
+
 class ApiSecurityService {
     environments;
     cookie;
@@ -410,8 +530,9 @@ class ApiSecurityService {
      */
     createSession({ modelType, modelId, token, }) {
         let headers = new HttpHeaders({});
-        if (token)
+        if (token) {
             headers = headers.set('Authorization', `Bearer ${token}`);
+        }
         return this.http.post(`${this.url}/sessions`, {
             model_type: modelType,
             model_id: modelId,
@@ -478,6 +599,45 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImpo
                     args: ['env']
                 }] }, { type: i1$1.CookieService }, { type: i1.HttpClient }] });
 
+class ApiShipmentsService {
+    environments;
+    http;
+    constructor(environments, http) {
+        this.environments = environments;
+        this.http = http;
+    }
+    /**
+     * Retrieves the URL for the shipments API from the environment configurations.
+     *
+     * @return {string} The URL of the shipments API.
+     */
+    get url() {
+        return this.environments.apiShipmentUrl;
+    }
+    /**
+     * Retrieves the parameter values based on the provided parameter names.
+     *
+     * @param {ValidateAccountIn} body - An object of parameter names for which the values need to be fetched.
+     * @return {Observable<ValidateAccountIn>} An observable that emits the fetched parameter values
+     * @param body
+     */
+    validateAccount(body) {
+        return this.http.post(`${this.url}/accounts`, body)
+            .pipe(map(({ data }) => data));
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiShipmentsService, deps: [{ token: 'env' }, { token: i1.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiShipmentsService, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImport: i0, type: ApiShipmentsService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root'
+                }]
+        }], ctorParameters: () => [{ type: undefined, decorators: [{
+                    type: Inject,
+                    args: ['env']
+                }] }, { type: i1.HttpClient }] });
+
 class CryptoService {
     environments;
     constructor(environments) {
@@ -500,15 +660,16 @@ class CryptoService {
     async decryptAES(payload) {
         // Extract the Initialization Vector (IV), and the cypher text
         const [base64IV, base64Ciphertext] = payload.split(':');
-        if (!base64IV || !base64Ciphertext)
+        if (!base64IV || !base64Ciphertext) {
             throw new Error('The payload must contain the IV and the cipher text.');
+        }
         const cryptoKey = await this.loadKey();
         const iv = this.base64ToUint8Array(base64IV);
         const cipherText = this.base64ToArrayBuffer(base64Ciphertext);
         // Decrypt the cypher text
         const decrypted = await crypto.subtle.decrypt({
             name: 'AES-GCM',
-            iv: iv,
+            iv,
         }, cryptoKey, cipherText);
         // Decode the decrypted text
         const decoder = new TextDecoder();
@@ -570,25 +731,29 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImpo
 
 class ApiHeadersInterceptor {
     /**
-     * Intercepts HTTP requests and adds common headers.
+     * Intercepts HTTP requests and modifies request headers to include caching, content type,
+     * accept language, and other HTTP-specific configurations before forwarding the request onward.
      *
-     * @param {HttpRequest<unknown>} request - The HTTP request intercepted.
-     * @param {HttpHandler} next - The next handler in the chain.
-     *
-     * @returns {Observable<HttpEvent<unknown>>} - Observable of the HTTP event after interception.
+     * @param {HttpRequest<unknown>} request - The HTTP request instance to be intercepted and modified.
+     * @param {HttpHandler} next - The next handler instance in the HTTP pipeline which processes
+     * the modified request and forwards it.
+     * @return {Observable<HttpEvent<unknown>>} An observable of the processed HTTP event.
      */
     intercept(request, next) {
         let headers = new HttpHeaders({
             'cache-control': 'max-age=0, no-cache, no-store, must-revalidate',
-            'expires': '0',
-            'pragma': 'no-cache'
+            expires: '0',
+            pragma: 'no-cache'
         });
-        if (!request.headers.has('Content-Type'))
+        if (!request.headers.has('Content-Type')) {
             headers = headers.set('Content-Type', 'application/json');
-        if (!request.headers.has('Accept'))
+        }
+        if (!request.headers.has('Accept')) {
             headers = headers.set('Accept', 'application/json');
-        if (!request.headers.has('Accept-Language'))
+        }
+        if (!request.headers.has('Accept-Language')) {
             headers = headers.set('Accept-Language', localStorage.getItem('lang') ?? 'en');
+        }
         request = request.clone({ headers });
         return next.handle(request);
     }
@@ -607,16 +772,17 @@ class ApiTokenInterceptor {
         this.cookie = cookie;
     }
     /**
-     * Intercepts the HTTP request and adds the Authorization header.
-     *
-     * @param {HttpRequest<unknown>} request - The HTTP request to intercept.
-     * @param {HttpHandler} next - The next HTTP handler in the chain.
+     * Intercepts and modifies the outgoing HTTP request to include an authorization token
+     * from cookies if the request does not already have an Authorization or AppKey header.
      *
-     * @returns {Observable<HttpEvent<unknown>>} - An observable containing the HTTP event.
+     * @param {HttpRequest<unknown>} request - The outgoing HTTP request to be intercepted.
+     * @param {HttpHandler} next - The next handler in the HTTP request processing chain.
+     * @return {Observable<HttpEvent<unknown>>} An observable of the HTTP event, modified or unmodified.
      */
     intercept(request, next) {
-        if (request.headers.has('Authorization'))
+        if (request.headers.has('Authorization') || request.headers.has('AppKey')) {
             return next.handle(request);
+        }
         const token = this.cookie.get(this.environments.authCookie);
         if (!token)
             return next.handle(request);
@@ -644,19 +810,30 @@ class HttpCachingInterceptor {
     constructor(envs) {
         this.envs = envs;
     }
+    /**
+     * Intercepts HTTP requests to add caching functionality for GET requests.
+     * Non-GET requests are passed through without caching.
+     *
+     * @param {HttpRequest<any>} req - The HTTP request being intercepted.
+     * @param {HttpHandler} next - The next handler in the HTTP pipeline to execute the request.
+     * @return {Observable<HttpEvent<any>>} - An observable containing the HTTP response event, either from cache or the backend service.
+     */
     intercept(req, next) {
-        if (req.method !== 'GET')
+        if (req.method !== 'GET') {
             return next.handle(req);
+        }
         const cached = this.cache.get(req.urlWithParams);
         if (cached) {
             const isExpired = Date.now() > cached.ttl;
-            if (!isExpired)
+            if (!isExpired) {
                 return of(cached.res);
+            }
             this.cache.delete(req.urlWithParams); // If expired, remove the entry from cache
         }
         return next.handle(req).pipe(tap$1((res) => {
-            if (!(res instanceof HttpResponse))
+            if (!(res instanceof HttpResponse)) {
                 return;
+            }
             const ttl = Date.now() + (this.envs.cacheTtl ?? DEFAULT_TTL);
             this.cache.set(req.urlWithParams, { res, ttl });
         }));
@@ -679,5 +856,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.11", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { ApiCompaniesService, ApiHeadersInterceptor, ApiSecurityService, ApiTokenInterceptor, CryptoService, HttpCachingInterceptor, NgxServicesModule, httpParams, pdfHeaders, queryString, xmlHeaders };
+export { ApiCompaniesService, ApiHeadersInterceptor, ApiInvoicesService, ApiReportsService, ApiSecurityService, ApiShipmentsService, ApiTokenInterceptor, CryptoService, HttpCachingInterceptor, NgxServicesModule, httpParams, pdfHeaders, queryString, xmlHeaders };
 //# sourceMappingURL=experteam-mx-ngx-services.mjs.map