@experteam-mx/ngx-services 18.9.4 → 18.9.7

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

@@ -2,7 +2,7 @@ import { Environment } from '../ngx-services.models';
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { QueryParams } from './models/api.models';
-import { CancellationReasonIn, CancellationReasonOut, CancellationReasonsOut, CountriesOut, CountryIn, CountryOut, CurrenciesOut, ExtraChargeIn, ExtraChargeOut, ExtraChargesOut, GenericFolioIn, GenericFolioOut, GenericFoliosOut, IdentificationTypesOut, LanguagesOut, ManagementAreasOut, OperationTypesOut, ProductIn, ProductOut, QuestionIn, QuestionOut, QuestionsOut, RegionsOut, ShipmentContentTypesOut, ShipmentGroupsOut, ShipmentIncomeTypeIn, ShipmentIncomeTypeOut, ShipmentIncomeTypesOut, ShipmentScopesOut, ShipmentStatusesOut, UniqueFolioIn, UniqueFolioOut, UniqueFoliosOut, UnitsOut, ZonesOut } from './models/api-catalog.types';
+import { CancellationReasonIn, CancellationReasonOut, CancellationReasonsOut, CountriesOut, CountryIn, CountryOut, CurrenciesOut, ExtraChargeIn, ExtraChargeOut, ExtraChargesOut, GenericFolioIn, GenericFolioOut, GenericFoliosOut, HolidayIn, HolidayOut, HolidaysOut, IdentificationTypesOut, LanguagesOut, ManagementAreasOut, OperationTypesOut, ProductIn, ProductOut, QuestionIn, QuestionOut, QuestionsOut, RegionsOut, ShipmentContentTypesOut, ShipmentGroupsOut, ShipmentIncomeTypeIn, ShipmentIncomeTypeOut, ShipmentIncomeTypesOut, ShipmentScopesOut, ShipmentStatusesOut, UniqueFolioIn, UniqueFolioOut, UniqueFoliosOut, UnitsOut, ZonesOut } from './models/api-catalog.types';
 import * as i0 from "@angular/core";
 export declare class ApiCatalogsService {
     private environments;
@@ -320,6 +320,65 @@ export declare class ApiCatalogsService {
      *          The Observable will emit an error if the HTTP request fails.
      */
     deleteQuestion(id: number): Observable<{}>;
+    /**
+     * Fetches holidays from the catalogs API.
+     *
+     * Sends an HTTP GET request to `${this.url}/holidays` using the supplied query parameters
+     * and returns the unwrapped payload (`data`) from the API response.
+     *
+     * @param params - Query parameters to include in the request (e.g. paging, filters, sorting).
+     * @returns An Observable that emits the HolidaysOut payload (the `data` field from ApiSuccess<HolidaysOut>).
+     */
+    getHolidays(params: QueryParams): Observable<HolidaysOut>;
+    /**
+     * Retrieve a single holiday by its id.
+     *
+     * Sends an HTTP GET request to the holidays endpoint and returns an Observable that emits
+     * the HolidayOut payload extracted from the API success envelope.
+     *
+     * @param id - The numeric identifier of the holiday to fetch.
+     * @returns An Observable that emits the requested HolidayOut. The Observable will error
+     *          if the HTTP request fails (for example network issues or non-2xx responses).
+     */
+    getHoliday(id: number): Observable<HolidayOut>;
+    /**
+     * Sends a POST request to create a new holiday and returns the created resource.
+     *
+     * The request payload is sent as an object with a `body` property containing the provided
+     * HolidayIn value (i.e. { body: HolidayIn }). On success the HTTP response is expected
+     * to follow the ApiSuccess<T> shape; the operator maps that response to the inner `data`
+     * object and emits it as a HolidayOut.
+     *
+     * @param body - The holiday payload to create (HolidayIn).
+     * @returns Observable<HolidayOut> that emits the created holiday on success.
+     */
+    postHoliday(body: HolidayIn): Observable<HolidayOut>;
+    /**
+     * Update a holiday by its ID.
+     *
+     * Sends an HTTP PUT to `${this.url}/holidays/${id}` with the provided payload.
+     * The request body is sent as an object with a `body` property containing the
+     * `HolidayIn` data. The server response is expected to be an `ApiSuccess<HolidayOut>`
+     * and this method returns an Observable that emits the unwrapped `HolidayOut`.
+     *
+     * @param id - The identifier of the holiday to update.
+     * @param body - The update payload for the holiday.
+     * @returns An Observable that emits the updated `HolidayOut` on success.
+     */
+    putHoliday(id: number, body: HolidayIn): Observable<HolidayOut>;
+    /**
+     * Deletes a question by its ID.
+     *
+     * Sends an HTTP DELETE request to the backend endpoint `/questions/{id}` and
+     * returns an Observable that emits the API response's `data` payload (typically an empty object).
+     *
+     * The implementation maps an ApiSuccess wrapper to its `data` property before emitting.
+     *
+     * @param id - The numeric identifier of the question to delete.
+     * @returns An Observable that emits the deleted resource payload ({} expected) on success.
+     *          The Observable will emit an error if the HTTP request fails.
+     */
+    deleteHoliday(id: number): Observable<{}>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiCatalogsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiCatalogsService>;
 }

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

@@ -196,3 +196,8 @@ export interface Question extends SymfonyModel {
     countryId: number;
     isRequiredValue: boolean;
 }
+export interface Holiday extends SymfonyModel {
+    date: string;
+    description: string;
+    country: Country;
+}

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

@@ -1,4 +1,4 @@
-import { CancellationReason, Country, Currency, ExtraCharge, GenericFolio, IdentificationType, Language, ManagementArea, OperationType, Product, Question, Region, ShipmentContentType, ShipmentGroup, ShipmentIncomeType, ShipmentScope, ShipmentStatus, UniqueFolio, Unit, Zone } from './api-catalog.interfaces';
+import { CancellationReason, Country, Currency, ExtraCharge, GenericFolio, Holiday, IdentificationType, Language, ManagementArea, OperationType, Product, Question, Region, ShipmentContentType, ShipmentGroup, ShipmentIncomeType, ShipmentScope, ShipmentStatus, UniqueFolio, Unit, Zone } from './api-catalog.interfaces';
 export type OperationTypesOut = {
     total: number;
     operationTypes: OperationType[];
@@ -174,3 +174,16 @@ export type QuestionIn = {
     countryId: number;
     isRequiredValue: boolean;
 };
+export type HolidaysOut = {
+    holidays: Holiday[];
+    total: number;
+};
+export type HolidayOut = {
+    holiday: Holiday;
+};
+export type HolidayIn = {
+    date: string;
+    description: string;
+    countryId: number;
+    isActive: boolean;
+};

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

@@ -1,6 +1,5 @@
-import { ActiveLessLaravelModel, ActiveLessSymfonyModel, ApiModel, LaravelModel, Translations } from './api.models';
-import { DocumentPayment } from './api-invoices.interfaces';
 import { OperationType } from './api-catalog.interfaces';
+import { ActiveLessLaravelModel, ActiveLessSymfonyModel, ApiModel, LaravelModel, Translations } from './api.models';
 export interface CollectionPayment extends LaravelModel {
     _id: number;
     country_code: string;
@@ -47,159 +46,74 @@ export interface DocumentCategoryReports extends LaravelModel {
     updated_at: string;
     translations: Translations;
 }
-export interface ShipmentReports extends LaravelModel {
-    amount_1: number;
-    amount_2: number;
-    amount_collected: number;
+export interface ShipmentReports {
     authorization_numbers: string[];
     commercial_invoice: boolean;
-    company_country_id: number;
-    company_id: number;
     company_name: string;
-    country_code: string;
     country_id: number;
     country_name: string;
-    currency_code: string | null;
-    customer_email: string;
-    customer_full_phone_number: string;
-    customer_identification_number: string;
-    customer_identification_type_id: number;
-    date: string;
-    date_og: string;
-    declared_value: number;
-    delivery_date_time: string;
-    destination_facility_code: string;
-    destination_service_area_code: string;
+    currency_code: string;
+    customer_identification_number: string | null;
+    customer_identification_type_id: number | null;
     document_id: number;
-    document_payments?: DocumentPayment[];
-    ein_number: string;
+    id: number;
     installation_id: number;
     installation_number: number;
-    insured_value: number;
-    invoice?: string[];
-    invoice_document_id?: number | null;
+    invoice_document_id: number | null;
     is_document: boolean;
-    is_kiosk: boolean;
     is_manual: boolean;
-    is_marketing_consent: boolean;
-    is_price_override: boolean;
-    is_proforma: boolean;
-    is_promotion_code: boolean;
-    is_retail_rate: boolean;
-    is_term_condition: boolean;
-    itn_number: string;
-    location_facility_code: string;
+    itn_number: string | null;
     location_id: number;
     location_name: string;
-    origin_facility_code: string;
-    origin_service_area_code: string;
-    payment_code_1: string;
-    payment_code_2: string;
-    payment_type_1: string;
-    payment_type_2: string;
-    price_override_approver_id: number;
-    price_override_approver_name: string;
-    price_override_reason_id: number;
-    price_override_reason_name: string;
-    product_global_code: string;
-    product_local_code: string;
+    price_override_approver_name: string | null;
+    price_override_reason_name: string | null;
     product_subtotal: number;
     product_tax: number;
-    product_total: number;
-    promotion_code: string;
-    question_description: string;
-    question_id: number;
-    question_type: string;
-    receiver_address_line1: string;
-    receiver_address_line2: string;
-    receiver_city_name: string;
+    question_description: string | null;
     receiver_company_name: string;
     receiver_full_name: string;
-    receiver_postal_code: string;
-    receiver_state_code: string;
-    receiver_state_name: string;
-    reference_1: string;
-    reference_2: string;
-    retail_rate_adjustment: number;
-    selected?: boolean;
     send_to_api_inventories: boolean;
-    shipment?: string[];
-    shipment_bill_weight: number;
-    shipment_gmt_offset: string;
     shipment_id: number;
-    shipment_pieces_number: number;
     shipment_pieces_tracking_numbers: string[];
-    shipment_scope_name: string;
     shipment_status_code: string;
     shipment_status_description: string;
     shipment_status_id: number;
+    shipment_status_translations: Translations;
     shipment_tags: ShipmentTag[];
     shipment_tracking_number: string;
     shipment_type: string;
-    shipment_value: number;
+    shipment_value: string;
     shipper_account: string;
     shipper_address_line1: string;
-    shipper_address_line2: string;
-    shipper_address_line3: string;
+    shipper_address_line2: string | null;
+    shipper_address_line3: string | null;
     shipper_city_name: string;
     shipper_company_name: string;
     shipper_email: string;
     shipper_full_name: string;
     shipper_full_phone_number: string;
-    shipper_identification_number: string;
-    shipper_phone_code: string;
+    shipper_identification_number: string | null;
     shipper_phone_number: string;
     shipper_postal_code: string;
-    shipper_state_code: string;
-    shipper_state_name: string;
-    subtotal: number;
-    tax: number;
-    to_landing: boolean;
+    shipper_state_name: string | null;
     total: number;
-    total_partner_account_value: number;
-    total_published_value: number;
-    transaction_id: string;
+    tracking: string | null;
+    updated_at: string;
     user_id: number;
     user_username: string;
     additional_documents: {
         country_id: number;
         include_indemnity_letter: boolean;
-        include_pdf: boolean;
         shipment_content_type_id: number;
         shipment_scope_id: number;
     };
-    product_taxes: {
-        code: string;
-        percent: number;
-        base_amount: number;
-        amount: number;
-    }[];
-    shipment_company_country_extra_charges: {
-        _id: number;
-        subtotal: number;
-        tax: number;
-        total: number;
-        extra_charge_id: number;
-        taxes: {
-            code: string;
-            percent: number;
-            base_amount: number;
-            amount: number;
-        }[];
-        created_at: string;
-        updated_at: string;
-        global_service_code: string;
-        local_service_code: string;
-        global_service_name: string;
-        local_service_name: string;
-        is_discount: false;
-    }[];
-    shipment_status_translations: {
-        description: {
-            [key: string]: string;
+    document_payments: {
+        payment: {
+            countryPaymentType: {
+                code: string;
+            };
         };
-    };
-    tracking?: string;
+    }[];
 }
 export interface ShipmentTag extends ActiveLessSymfonyModel {
     name: string;

package/package.json

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