@experteam-mx/ngx-services 18.7.9 → 18.7.11

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

@@ -0,0 +1,152 @@
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { Observable } from 'rxjs';
+import { QueryParams } from './models/api.models';
+import { CustomerRestrictionIn, CustomerRestrictionOut, CustomerRestrictionsOut, DiscountIn, DiscountOut, DiscountsOut, LoyaltyPeriodIn, LoyaltyPeriodOut, LoyaltyPeriodsOut, LoyaltyRuleIn, LoyaltyRuleOut, LoyaltyRulesOut, OperationsLoadTopCustomerV2In, TopCustomersOut } from './models/api-discounts.types';
+import * as i0 from "@angular/core";
+export declare class ApiDiscountsService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Gets the API endpoint URL for discounts from the environments configuration.
+     *
+     * @return {string} The URL for the discounts API. Returns an empty string if not defined.
+     */
+    get url(): string;
+    /**
+     * Fetches available discounts based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter and retrieve discounts.
+     * @return {Observable<DiscountsOut>} An Observable that emits the retrieved discounts data.
+     */
+    getDiscounts(params: QueryParams): Observable<DiscountsOut>;
+    /**
+     * Sends a request to create or update discounts on the server.
+     *
+     * @param {DiscountIn} body - The discount information to be submitted.
+     * @return {Observable<DiscountOut>} An Observable emitting the server's response containing the created or updated discount details.
+     */
+    postDiscounts(body: DiscountIn): Observable<DiscountOut>;
+    /**
+     * Updates the discount information for a specific item.
+     *
+     * @param {number} id - The unique identifier of the item whose discount is to be updated.
+     * @param {DiscountIn} body - The payload containing the updated discount details.
+     * @return {Observable<DiscountOut>} An observable emitting the updated discount details.
+     */
+    putDiscounts(id: number, body: DiscountIn): Observable<DiscountOut>;
+    /**
+     * Retrieves the top customers based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter and sort the top customers.
+     * @return {Observable<TopCustomersOut>} An observable emitting the list of top customers.
+     */
+    getTopCustomers(params: QueryParams): Observable<TopCustomersOut>;
+    /**
+     * Sends a POST request to load the top customer data in the system, using the provided input.
+     * Transforms the API response to extract the data field containing the discount information.
+     *
+     * @param {OperationsLoadTopCustomerV2In} body - The input payload containing the company country ID and the file.
+     * @param {number} body.company_country_id - The ID of the company's country.
+     * @param {File} body.file - The file containing data to be processed.
+     * @return {Observable<DiscountOut>} An observable containing the discount output information.
+     */
+    postOperationsLoadTopCustomerV2(body: OperationsLoadTopCustomerV2In): Observable<{}>;
+    /**
+     * Fetches the loyalty periods based on the provided query parameters.
+     *
+     * @param {QueryParams} params - An object containing query parameters to filter the periods.
+     * @return {Observable<LoyaltyPeriodsOut>} An observable that emits the fetched loyalty periods.
+     */
+    getLoyaltyPeriods(params: QueryParams): Observable<LoyaltyPeriodsOut>;
+    /**
+     * Retrieves the loyalty period details for the given ID.
+     *
+     * @param {number} id - The unique identifier of the loyalty period to retrieve.
+     * @return {Observable<LoyaltyPeriodOut>} An observable emitting the loyalty period details.
+     */
+    getLoyaltyPeriod(id: number): Observable<LoyaltyPeriodOut>;
+    /**
+     * Sends a PUT request to update the loyalty period with the provided data.
+     *
+     * @param {LoyaltyPeriodIn} body - The data for the loyalty period to be updated.
+     * @return {Observable<LoyaltyPeriodOut>} An observable that emits the updated loyalty period data.
+     */
+    postLoyaltyPeriod(body: LoyaltyPeriodIn): Observable<LoyaltyPeriodOut>;
+    /**
+     * Updates the loyalty period for a specified ID with the provided data.
+     *
+     * @param {number} id - The unique identifier of the loyalty period to update.
+     * @param {LoyaltyPeriodIn} body - An object containing the updated details of the loyalty period.
+     * @return {Observable<LoyaltyPeriodOut>} An observable that emits the updated loyalty period details.
+     */
+    putLoyaltyPeriod(id: number, body: LoyaltyPeriodIn): Observable<LoyaltyPeriodOut>;
+    /**
+     * Retrieves the loyalty rules based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the loyalty rules.
+     * @return {Observable<LoyaltyRulesOut>} An observable containing the loyalty rules output.
+     */
+    getLoyaltyRules(params: QueryParams): Observable<LoyaltyRulesOut>;
+    /**
+     * Retrieves a specific loyalty rule based on the provided ID.
+     *
+     * @param {number} id - The unique identifier of the loyalty rule to retrieve.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the details of the specified loyalty rule.
+     */
+    getLoyaltyRule(id: number): Observable<LoyaltyRuleOut>;
+    /**
+     * Sends a request to add or update a loyalty rule.
+     *
+     * @param {LoyaltyRuleIn} body - The loyalty rule data to be sent to the server.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the updated loyalty rule details.
+     */
+    postLoyaltyRule(body: LoyaltyRuleIn): Observable<LoyaltyRuleOut>;
+    /**
+     * Updates an existing loyalty rule with the provided data.
+     *
+     * @param {number} id - The unique identifier of the loyalty rule to update.
+     * @param {LoyaltyRuleIn} body - The data to update the loyalty rule with.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the updated loyalty rule.
+     */
+    putLoyaltyRule(id: number, body: LoyaltyRuleIn): Observable<LoyaltyRuleOut>;
+    /**
+     * Fetches customer restrictions based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter customer restrictions.
+     * @return {Observable<CustomerRestrictionsOut>} An observable that emits the customer restrictions data.
+     */
+    getCustomerRestrictions(params: QueryParams): Observable<CustomerRestrictionsOut>;
+    /**
+     * Retrieves customer restriction details for a given customer ID.
+     *
+     * @param {number} id - The unique identifier of the customer.
+     * @return {Observable<CustomerRestrictionOut>} An observable containing the customer restriction details.
+     */
+    getCustomerRestriction(id: number): Observable<CustomerRestrictionOut>;
+    /**
+     * Sends a request to apply a restriction to a customer.
+     *
+     * @param {CustomerRestrictionIn} body - The restriction details to be applied to the customer.
+     * @return {Observable<CustomerRestrictionOut>} An observable containing the response with the applied customer restriction.
+     */
+    postCustomerRestriction(body: CustomerRestrictionIn): Observable<CustomerRestrictionOut>;
+    /**
+     * Updates customer restrictions using the provided ID and data.
+     *
+     * @param {number} id - The unique identifier of the customer restriction to be updated.
+     * @param {LoyaltyRuleIn} body - The data object containing the customer restriction details to be updated.
+     * @return {Observable<CustomerRestrictionOut>} An observable emitting the updated customer restriction details.
+     */
+    putCustomerRestriction(id: number, body: CustomerRestrictionIn): Observable<CustomerRestrictionOut>;
+    /**
+     * Deletes a customer restriction by its ID.
+     *
+     * @param {number} id - The unique identifier of the customer restriction to delete.
+     * @return {Observable<{}>} An Observable that emits the result of the deletion operation.
+     */
+    deleteCustomerRestriction(id: number): Observable<{}>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiDiscountsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiDiscountsService>;
+}

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-discounts.interfaces.d.ts

@@ -0,0 +1,74 @@
+import { ActiveLessLaravelModel, LaravelModel } from './api.models';
+import { IdentificationType } from './api-catalog.interfaces';
+export interface Discount extends LaravelModel {
+    code: string;
+    company_country_id: number;
+    name: string;
+    description: string | null;
+    account_number: string;
+    percentage: string;
+    start_date: string;
+    end_date: string | null;
+    start_weight: number;
+    end_weight: number | null;
+    shipment_scopes: number[];
+    country_reference_products: number[];
+    applies_to_all_locations: boolean;
+    locations: number[] | null;
+    reference_required: boolean;
+    reference_restriction: boolean | null;
+    reference_restriction_period: number | null;
+    reference_restriction_amount: number | null;
+    reference_restriction_message: string | null;
+    shipment_scope_names: string;
+    applies_to_all_locations_langs: {
+        [key: string]: string;
+    };
+    reference_required_langs: {
+        [key: string]: string;
+    };
+    status_langs: {
+        [key: string]: string;
+    };
+    applies_to_all_locations_lang: string | null;
+    reference_required_lang: string | null;
+    status_lang: string | null;
+}
+export interface TopCustomer extends ActiveLessLaravelModel {
+    identification_type_id: number;
+    identification_number: string;
+    contact_name_1: string;
+    contact_name_2: string;
+    contact_name_3: string;
+    email: string;
+    phone_number: string;
+    discount_percentage: string;
+    account: string | null;
+    shipment_scopes: string | null;
+    company_country_id: number;
+    company_name: string | null;
+    level: string | null;
+}
+export interface LoyaltyPeriod extends LaravelModel {
+    company_country_id: number;
+    days: number;
+    shipment_scopes: number[];
+    products: string[];
+}
+export interface LoyaltyRule extends LaravelModel {
+    name: string;
+    loyalty_period_id: number;
+    min_quantity: number;
+    max_quantity: number;
+    discount_percentage: number;
+    account: string;
+    products: string[];
+    valid_since: string;
+    valid_until: string;
+}
+export interface CustomerRestriction extends ActiveLessLaravelModel {
+    identification_type_id: number;
+    identification_number: string;
+    company_country_id: number;
+    identificationType: IdentificationType;
+}

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

@@ -0,0 +1,83 @@
+import { CustomerRestriction, Discount, LoyaltyPeriod, LoyaltyRule, TopCustomer } from './api-discounts.interfaces';
+export type DiscountIn = {
+    code: string;
+    company_country_id: number;
+    name: string;
+    description: string;
+    account_number: string;
+    percentage: number;
+    start_date: string;
+    end_date: string;
+    start_weight: number;
+    end_weight: number;
+    shipment_scopes: number[];
+    country_reference_products: number[];
+    applies_to_all_locations: boolean;
+    locations: number[];
+    reference_required: boolean;
+    reference_restriction: boolean;
+    reference_restriction_period: number;
+    reference_restriction_amount: number;
+    reference_restriction_message: string;
+    is_active: boolean;
+};
+export type DiscountOut = {
+    discount: Discount;
+};
+export type DiscountsOut = {
+    discounts: Discount[];
+    total: number;
+};
+export type TopCustomersOut = {
+    top_customers: TopCustomer[];
+    total: number;
+};
+export type OperationsLoadTopCustomerV2In = {
+    company_country_id: number;
+    file: File;
+};
+export type LoyaltyPeriodsOut = {
+    loyalty_periods: LoyaltyPeriod[];
+    total: number;
+};
+export type LoyaltyPeriodIn = {
+    company_country_id: number;
+    days: number;
+    shipment_scopes: number[];
+    products: string[];
+    is_active: boolean;
+};
+export type LoyaltyPeriodOut = {
+    loyalty_period: LoyaltyPeriod;
+};
+export type LoyaltyRulesOut = {
+    loyalty_rules: LoyaltyRule[];
+    total: number;
+};
+export type LoyaltyRuleIn = {
+    name: string;
+    loyalty_period_id: number;
+    min_quantity: number;
+    max_quantity: number;
+    discount_percentage: number;
+    products: string[];
+    account: string;
+    valid_since: string;
+    valid_until: string;
+    is_active: boolean;
+};
+export type LoyaltyRuleOut = {
+    loyalty_rule: LoyaltyRule;
+};
+export type CustomerRestrictionsOut = {
+    customer_restrictions: CustomerRestriction[];
+    total: number;
+};
+export type CustomerRestrictionIn = {
+    identification_type_id: number;
+    identification_number: string;
+    company_country_id: number;
+};
+export type CustomerRestrictionOut = {
+    customer_restriction: CustomerRestriction;
+};

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

@@ -10,21 +10,21 @@ export interface ApiModel {
 }
 export interface LaravelModel extends ApiModel {
     is_active: boolean;
-    created_at: Date | string;
-    updated_at: Date | string;
+    created_at: string;
+    updated_at: string;
 }
 export interface ActiveLessLaravelModel extends ApiModel {
-    created_at: Date | string;
-    updated_at: Date | string;
+    created_at: string;
+    updated_at: string;
 }
 export interface SymfonyModel extends ApiModel {
     isActive: boolean;
-    createdAt: Date | string;
-    updatedAt: Date | string;
+    createdAt: string;
+    updatedAt: string;
 }
 export interface ActiveLessSymfonyModel extends ApiModel {
-    createdAt: Date | string;
-    updatedAt: Date | string;
+    createdAt: string;
+    updatedAt: string;
 }
 export type QueryParams = {
     [param: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;

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

@@ -22,11 +22,13 @@ export type Environment = {
     apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
     apiCompositionUrl?: string;
+    apiDiscounts?: string;
     apiEToolsAutoBilling?: string;
     apiExternalOperationsKey?: string;
     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.9",
+  "version": "18.7.11",
   "description": "Angular common services for Experteam apps",
   "author": "Experteam Cía. Ltda.",
   "keywords": [

package/public-api.d.ts

@@ -7,17 +7,19 @@ export * from './lib/apis/api-cash-operations.service';
 export * from './lib/apis/api-catalogs.service';
 export * from './lib/apis/api-companies.service';
 export * from './lib/apis/api-composition.service';
+export * from './lib/apis/api-discounts.service';
 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-shipments.service';
-export * from './lib/apis/models/api-billing.types';
 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';
 export * from './lib/apis/models/api-cash-operations.interfaces';
 export * from './lib/apis/models/api-cash-operations.types';
 export * from './lib/apis/models/api-catalog.interfaces';
@@ -26,6 +28,8 @@ export * from './lib/apis/models/api-companies.interfaces';
 export * from './lib/apis/models/api-companies.types';
 export * from './lib/apis/models/api-composition.interfaces';
 export * from './lib/apis/models/api-composition.types';
+export * from './lib/apis/models/api-discounts.interfaces';
+export * from './lib/apis/models/api-discounts.types';
 export * from './lib/apis/models/api-e-tools-auto-billing.interfaces';
 export * from './lib/apis/models/api-e-tools-auto-billing.types';
 export * from './lib/apis/models/api-external-pickups.types';
@@ -34,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';