@experteam-mx/ngx-services 18.7.10 → 18.7.12

package/lib/apis/api-discounts.service.d.ts

@@ -9,9 +9,9 @@ export declare class ApiDiscountsService {
     private http;
     constructor(environments: Environment, http: HttpClient);
     /**
-     * Retrieves the URL for the shipments API from the environment configurations.
+     * Gets the API endpoint URL for discounts from the environments configuration.
      *
-     * @return {string} The URL of the shipments API.
+     * @return {string} The URL for the discounts API. Returns an empty string if not defined.
      */
     get url(): string;
     /**

package/lib/apis/api-notifications.service.d.ts

@@ -0,0 +1,70 @@
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { QueryParams } from './models/api.models';
+import { NotificationConfigurationIn, NotificationConfigurationOut, NotificationIn, NotificationOut, NotificationsOut, NotificationsTypeOut } from './models/api-notifications.types';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class ApiNotificationsService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the notifications API from the environment settings.
+     * If the URL is not defined, an empty string is returned.
+     *
+     * @return {string} The API Notifications URL or an empty string if not defined.
+     */
+    get url(): string;
+    /**
+     * Retrieves notifications based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter and retrieve notifications.
+     * @return {Observable<NotificationsOut>} An observable that emits the fetched notifications.
+     */
+    getNotifications(params: QueryParams): Observable<NotificationsOut>;
+    /**
+     * Sends a notification request to the server using the provided body.
+     *
+     * @param {NotificationIn} body - The notification data to be sent in the request body.
+     * @return {Observable<NotificationOut>} An observable emitting the response containing the notification output data.
+     */
+    postNotification(body: NotificationIn): Observable<NotificationOut>;
+    /**
+     * Sends a PUT request to update a notification with the provided ID and body.
+     *
+     * @param {number} id - The unique identifier of the notification to be updated.
+     * @param {NotificationIn} body - The data to update the notification with.
+     * @return {Observable<NotificationOut>} An observable containing the updated notification data.
+     */
+    putNotification(id: number, body: NotificationIn): Observable<NotificationOut>;
+    /**
+     * Deletes a notification by its unique identifier.
+     *
+     * @param {number} id - The unique identifier of the notification to delete.
+     * @return {Observable<{}>} An observable that emits the response after deleting the notification.
+     */
+    deleteNotification(id: number): Observable<{}>;
+    /**
+     * Marks the notification as finished for the specified notification ID.
+     *
+     * @param {number} id - The unique identifier of the notification to be marked as finished.
+     * @return {Observable<NotificationOut>} An Observable emitting the updated notification object.
+     */
+    putNotificationFinish(id: number): Observable<NotificationOut>;
+    /**
+     * Sends a POST request to create or update notification configurations.
+     *
+     * @param {NotificationConfigurationIn} body - The notification configuration payload to be sent in the request.
+     * @return {Observable<NotificationConfigurationOut>} An observable emitting the response containing the created or updated notification configuration.
+     */
+    postNotificationConfigurations(body: NotificationConfigurationIn): Observable<NotificationConfigurationOut>;
+    /**
+     * Retrieves the notification types based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters for fetching the notification types.
+     * @return {Observable<NotificationsTypeOut>} An observable that emits the fetched notification types.
+     */
+    getNotificationsType(params: QueryParams): Observable<NotificationsTypeOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiNotificationsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiNotificationsService>;
+}

package/lib/apis/api-services.service.d.ts

@@ -0,0 +1,61 @@
+import { Environment } from '../ngx-services.models';
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { ValidateFacilityIn, ValidateFacilityOut, ServiceAreasOut, EmailErrorIn, PromotionIn, PromotionOut, ValidateNIPOut, ValidateNIPIn, ValidateIdentificationBROut, ValidateIdentificationBRIn, ServiceAreaIn } from './models/api-services.types';
+import * as i0 from "@angular/core";
+export declare class ApiServicesService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the services API from the environment settings.
+     * If the URL is not defined, an empty string is returned.
+     *
+     * @return {string} The API Services URL or an empty string if not defined.
+     */
+    get url(): string;
+    /**
+     * Retrieves service areas based on the provided query parameters.
+     *
+     * @param {ServiceAreaIn} body - The query parameters used to filter and retrieve service areas.
+     * @return {Observable<NotificationsOut>} An observable that emits the fetched service areas.
+     */
+    postServiceAreas(body: ServiceAreaIn): Observable<ServiceAreasOut>;
+    /**
+     * Validate facility values based on the provided parameter.
+     *
+     * @param {ValidateFacilityIn} body - The facility data to be sent in the request body
+     * @return {Observable<ValidateFacilityOut>} An observable emitting the response containing the facility validated output data.
+     */
+    postValidateFacility(body: ValidateFacilityIn): Observable<ValidateFacilityOut>;
+    /**
+     * Create an email resource.
+     *
+     * @param {EmailErrorIn} body - The email data to be sent in the request body
+     * @return {Observable<{}>} An observable emitting the response data.
+     */
+    postEmailError(body: EmailErrorIn): Observable<{}>;
+    /**
+     * Sends a promotion request to the server using the provided body.
+     *
+     * @param {PromotionIn} body - The promotion data to be sent in the request body.
+     * @return {Observable<PromotionOut>} An observable emitting the response containing the promotion output data.
+     */
+    postPromotion(body: PromotionIn): Observable<PromotionOut>;
+    /**
+     * Validate NIP account value based on the provided parameter.
+     *
+     * @param {ValidateNIPIn} body - The NIP account data to be sent in the request body
+     * @return {Observable<ValidateNIPOut>} An observable emitting the response containing the NIP account validated data.
+     */
+    postValidateNIP(body: ValidateNIPIn): Observable<ValidateNIPOut>;
+    /**
+     * Validate BR Identification value based on the provided parameter.
+     *
+     * @param {ValidateIdentificationBRIn} body - The BR Identification data to be sent in the request body
+     * @return {Observable<ValidateIdentificationBROut>} An observable emitting the response containing the BR Identification validated data.
+     */
+    postValidateIdentificationBR(body: ValidateIdentificationBRIn): Observable<ValidateIdentificationBROut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiServicesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiServicesService>;
+}

package/lib/apis/api-supplies.service.d.ts

@@ -0,0 +1,55 @@
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { Observable } from 'rxjs';
+import { QueryParams } from './models/api.models';
+import { SuppliesOut, SupplyIn, SupplyOut, SupplyTypesOut } from './models/api-supplies.types';
+import * as i0 from "@angular/core";
+export declare class ApiSuppliesService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the API supplies endpoint.
+     *
+     * @return {string} The API supplies URL or an empty string if not defined.
+     */
+    get url(): string;
+    /**
+     * Fetches a list of supplies based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the supplies.
+     * @return {Observable<SuppliesOut>} An observable containing the list of supplies.
+     */
+    getSupplies(params: QueryParams): Observable<SuppliesOut>;
+    /**
+     * Retrieves the supply details for a given supply ID.
+     *
+     * @param {number} id - The unique identifier of the supply to retrieve.
+     * @return {Observable<SupplyOut>} An observable containing the supply details.
+     */
+    getSupply(id: number): Observable<SupplyOut>;
+    /**
+     * Sends a supply object to the server and returns the created or updated supply information.
+     *
+     * @param {SupplyIn} body - The supply information to be sent to the server.
+     * @return {Observable<SupplyOut>} An observable containing the response with the supply data.
+     */
+    postSupply(body: SupplyIn): Observable<SupplyOut>;
+    /**
+     * Updates an existing supply with the provided data.
+     *
+     * @param {number} id - The unique identifier of the supply to update.
+     * @param {SupplyIn} body - The data to update the supply with.
+     * @return {Observable<SupplyOut>} An observable containing the updated supply information.
+     */
+    putSupply(id: number, body: SupplyIn): Observable<SupplyOut>;
+    /**
+     * Fetches the supply types based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the supply types.
+     * @return {Observable<SupplyTypesOut>} An Observable that emits the supply types data.
+     */
+    getSupplyTypes(params: QueryParams): Observable<SupplyTypesOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiSuppliesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiSuppliesService>;
+}

package/lib/apis/models/api-companies.interfaces.d.ts

@@ -224,25 +224,6 @@ export interface ParameterConfig {
     };
     parameter: Parameter;
 }
-export interface SupplyEntity extends LaravelModel {
-    name: string;
-    description: string;
-    country_id: number;
-    enabled_for_dropoff: boolean;
-    supply_type: SupplyType;
-    supply_packing: SupplyPacking;
-}
-export interface SupplyPacking extends LaravelModel {
-    value: number;
-    weight: number;
-    height: number;
-    depth: number;
-    width: number;
-    emobile_code: string | null;
-}
-export interface SupplyType extends LaravelModel {
-    name: string;
-}
 export interface WorkflowConfig {
     id: number;
     system_id: number;

package/lib/apis/models/api-companies.types.d.ts

@@ -1,4 +1,5 @@
-import { Account, AccountCategory, AccountType, BoardingProcess, Company, CompanyCountry, CompanyCountryTax, CountryExchange, CountryReference, CountryReferenceCurrency, CountryReferenceExtraCharge, CountryReferenceProduct, Employee, EmployeeCustomerDhl, ExtraChargeEntity, Installation, Location, LocationEmployee, Parameter, ParameterConfig, ProductEntity, SupplyEntity, System, TDXAccountSetting, WorkflowConfig } from './api-companies.interfaces';
+import { Account, AccountCategory, AccountType, BoardingProcess, Company, CompanyCountry, CompanyCountryTax, CountryExchange, CountryReference, CountryReferenceCurrency, CountryReferenceExtraCharge, CountryReferenceProduct, Employee, EmployeeCustomerDhl, ExtraChargeEntity, Installation, Location, LocationEmployee, Parameter, ParameterConfig, ProductEntity, System, TDXAccountSetting, WorkflowConfig } from './api-companies.interfaces';
+import { Supply } from './api-supplies.interfaces';
 export type LocationEmployeesOut = {
     location_employees: LocationEmployee[];
     total: number;
@@ -78,7 +79,7 @@ export type SupplyEntitiesIn = {
     }[];
 };
 export type SupplyEntitiesOut = {
-    supply_entities: SupplyEntity[];
+    supply_entities: Supply[];
     total: number;
 };
 export type EmployeesOut = {

package/lib/apis/models/api-composition.interfaces.d.ts

@@ -1,5 +1,6 @@
 import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
 import { CustomerType } from './api-shipments.enums';
+import { Supply } from './api-supplies.interfaces';
 export interface ShipmentComposition extends SymfonyModel {
     currencyCode: string;
     extraCharges: ExtraChargeComposition[];
@@ -142,24 +143,6 @@ export interface ShipmentPieceCompanyCountrySupplies extends ActiveLessSymfonyMo
     description: string;
     supply: Supply;
 }
-export interface Supply extends ActiveLessSymfonyModel {
-    name: string;
-    description: string;
-    countryId: number;
-    enabledForDropoff: boolean;
-    supplyType: SupplyTypeComposition;
-    supplyPacking: SupplyPackingComposition;
-}
-export interface SupplyTypeComposition extends SymfonyModel {
-    name: string;
-}
-export interface SupplyPackingComposition extends ActiveLessSymfonyModel {
-    value: number;
-    weight: number;
-    height: number;
-    depth: number;
-    width: number;
-}
 export interface CommercialInvoice extends ActiveLessSymfonyModel {
     documentTypeId: number;
     tradingTransactionTypeId: number;

package/lib/apis/models/api-notifications.interfaces.d.ts

@@ -0,0 +1,36 @@
+import { SymfonyModel } from './api.models';
+export interface Notification extends SymfonyModel {
+    name: string;
+    notificationType: NotificationType;
+    notificationStatus: NotificationStatus;
+    userId: string;
+    content: string;
+    url: string;
+    image: string;
+    starDate: string;
+    endDate: string;
+    countryId: string;
+}
+export interface NotificationConfiguration extends SymfonyModel {
+    notification: Notification;
+    entity: Entity;
+}
+export interface NotificationType extends SymfonyModel {
+    name: string;
+}
+export interface NotificationStatus extends SymfonyModel {
+    name: string;
+}
+export interface Entity {
+    id: number;
+    level: string;
+    modelId: string;
+    modelType: string;
+    extraFields: {
+        countryId: number;
+        companyCountryId: number;
+        locationId: number;
+        installationId: number;
+        systemId: number;
+    };
+}

package/lib/apis/models/api-notifications.types.d.ts

@@ -0,0 +1,34 @@
+import { Notification, NotificationConfiguration, NotificationType } from './api-notifications.interfaces';
+export type NotificationsOut = {
+    notifications: Notification[];
+    total: number;
+};
+export type NotificationIn = {
+    name: string;
+    notificationTypeId: number;
+    userId?: string;
+    content: string;
+    url: string;
+    image: string;
+    starDate: string;
+    endDate: string;
+    isActive: boolean;
+};
+export type NotificationOut = {
+    notification: Notification;
+};
+export type NotificationConfigurationIn = {
+    modelId: number[];
+    modelType: string;
+    notificationId: number;
+    extraFields: {
+        [key: string]: string;
+    };
+};
+export type NotificationConfigurationOut = {
+    notificationConfiguration: NotificationConfiguration;
+};
+export type NotificationsTypeOut = {
+    notificationTypes: NotificationType[];
+    total: number;
+};

package/lib/apis/models/api-services.interfaces.d.ts

@@ -0,0 +1,43 @@
+import { SymfonyModel } from './api.models';
+export interface ServiceArea extends SymfonyModel {
+    serviceAreaCodeName: string;
+    referenceDataCode: string;
+    serviceAreaCode: string;
+    serviceAreaName: string;
+    serviceAreaStatusCode: string;
+    serviceAreaStatusCodeDescription: string;
+    iataCode: string;
+    iataAirportName: string;
+    countryCode: string;
+    countryName: string;
+    timezoneCode: string;
+    timezoneCodeName: string;
+    offNetServiceIndicator: string;
+    offNetServiceIndicatorDescription: string;
+    effectiveDate: string;
+}
+export interface Facility extends SymfonyModel {
+    facilityIdentifier: string;
+    facilityCode: string;
+    serviceAreaCode: string;
+    serviceAreaName: string;
+    facilityName: string;
+    countryCode: string;
+    countryName: string;
+    facilityStatusCode: string;
+    facilityCompanyName: string;
+    facilityTypeIndicator: string;
+    cityName: string;
+    addressLine1: string;
+    postcode: string;
+    addressLongitude: string;
+    addressLatitude: string;
+    stateProvinceCode: string;
+    stateProvinceName: string;
+    regionCode: string;
+    regionName: string;
+    facilityWeightUnitOfMeasure: string;
+    facilityDimensionUnitOfMeasure: string;
+    facilityPrintIndicator: string;
+    effectiveDate: string;
+}

package/lib/apis/models/api-services.types.d.ts

@@ -0,0 +1,57 @@
+import { Facility, ServiceArea } from './api-services.interfaces';
+export type ServiceAreaIn = {
+    countryCodes: string[];
+};
+export type ServiceAreasOut = {
+    serviceAreas: ServiceArea[];
+    total: number;
+};
+export type ValidateFacilityOut = {
+    facility: Facility;
+    transactionId: string;
+};
+export type ValidateFacilityIn = {
+    facilityIdentifier: string;
+};
+export type EmailErrorIn = {
+    transactionId: string;
+    details: string;
+    extraFields: {
+        [key: string]: string;
+    };
+};
+export type PromotionIn = {
+    code: string;
+    destinationCountryCode: string;
+    shipmentDatetime: string;
+    shipper: {
+        countryCode: string;
+        accountNumber: string;
+    };
+};
+export type PromotionOut = {
+    promotion: {
+        accountNumber: string;
+    };
+    transactionId: string;
+};
+export type ValidateNIPOut = {
+    nip: {
+        valid: string;
+        message: string;
+    };
+};
+export type ValidateNIPIn = {
+    accountValue: string;
+    nip: string;
+    user: number;
+};
+export type ValidateIdentificationBROut = {
+    identification: {
+        valid: boolean;
+    };
+};
+export type ValidateIdentificationBRIn = {
+    identification_number: string;
+    validate_state_tax: boolean;
+};

package/lib/apis/models/api-supplies.interfaces.d.ts

@@ -0,0 +1,20 @@
+import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
+export interface Supply extends ActiveLessSymfonyModel {
+    name: string;
+    description: string;
+    countryId: number;
+    enabledForDropoff: boolean;
+    supplyType: SupplyType;
+    supplyPacking: SupplyPacking;
+}
+export interface SupplyType extends SymfonyModel {
+    name: string;
+}
+export interface SupplyPacking extends SymfonyModel {
+    value: number;
+    weight: number;
+    height: number;
+    depth: number;
+    width: number;
+    emobileCode: string;
+}

package/lib/apis/models/api-supplies.types.d.ts

@@ -0,0 +1,26 @@
+import { Supply, SupplyType } from './api-supplies.interfaces';
+export type SuppliesOut = {
+    supplies: Supply[];
+    total: number;
+};
+export type SupplyIn = {
+    supplyTypeId: number;
+    name: string;
+    description: string;
+    countryId: number;
+    enabledForDropoff: boolean;
+    supplyPacking: {
+        value: number;
+        weight: number;
+        height: number;
+        depth: number;
+        width: number;
+    };
+};
+export type SupplyOut = {
+    supply: Supply;
+};
+export type SupplyTypesOut = {
+    supplyTypes: SupplyType[];
+    total: number;
+};

package/lib/ngx-services.models.d.ts

@@ -28,10 +28,13 @@ export type Environment = {
     apiExternalOperationsUrl?: string;
     apiInventoriesUrl?: string;
     apiInvoicesUrl?: string;
+    apiNotificationsUrl?: string;
     apiOpenItemsUrl?: string;
     apiReportsUrl?: string;
     apiSecurityUrl?: string;
+    apiServicesUrl?: string;
     apiShipmentUrl?: string;
+    apiSuppliesUrl?: string;
     authCookie: string;
     cacheTtl?: number;
     printUrl?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@experteam-mx/ngx-services",
-  "version": "18.7.10",
+  "version": "18.7.12",
   "description": "Angular common services for Experteam apps",
   "author": "Experteam Cía. Ltda.",
   "keywords": [

package/public-api.d.ts

@@ -12,10 +12,13 @@ export * from './lib/apis/api-e-tools-auto-billing.service';
 export * from './lib/apis/api-external-pickups.service';
 export * from './lib/apis/api-inventories.service';
 export * from './lib/apis/api-invoices.service';
+export * from './lib/apis/api-notifications.service';
 export * from './lib/apis/api-open-items.service';
 export * from './lib/apis/api-reports.service';
 export * from './lib/apis/api-security.service';
+export * from './lib/apis/api-services.service';
 export * from './lib/apis/api-shipments.service';
+export * from './lib/apis/api-supplies.service';
 export * from './lib/apis/models/api-billing-pa.interfaces';
 export * from './lib/apis/models/api-billing-pa.types';
 export * from './lib/apis/models/api-billing.types';
@@ -37,12 +40,18 @@ export * from './lib/apis/models/api-inventories.interfaces';
 export * from './lib/apis/models/api-inventories.types';
 export * from './lib/apis/models/api-invoices.interfaces';
 export * from './lib/apis/models/api-invoices.types';
+export * from './lib/apis/models/api-notifications.interfaces';
+export * from './lib/apis/models/api-notifications.types';
 export * from './lib/apis/models/api-open-items.interfaces';
 export * from './lib/apis/models/api-open-items.types';
 export * from './lib/apis/models/api-reports.interfaces';
 export * from './lib/apis/models/api-security.interfaces';
 export * from './lib/apis/models/api-security.types';
+export * from './lib/apis/models/api-services.interfaces';
+export * from './lib/apis/models/api-services.types';
 export * from './lib/apis/models/api-shipments.types';
+export * from './lib/apis/models/api-supplies.interfaces';
+export * from './lib/apis/models/api-supplies.types';
 export * from './lib/apis/models/api.models';
 export * from './lib/websockets/web-sockets.service';
 export * from './lib/cypher/crypto.service';