@experteam-mx/ngx-services 18.7.10 → 18.7.11

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/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/ngx-services.models.d.ts

@@ -28,6 +28,7 @@ export type Environment = {
     apiExternalOperationsUrl?: string;
     apiInventoriesUrl?: string;
     apiInvoicesUrl?: string;
+    apiNotificationsUrl?: string;
     apiOpenItemsUrl?: string;
     apiReportsUrl?: string;
     apiSecurityUrl?: string;

package/package.json

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

package/public-api.d.ts

@@ -12,6 +12,7 @@ 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';
@@ -37,6 +38,8 @@ 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';