@experteam-mx/ngx-services 18.8.13 → 18.8.14

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

@@ -1,7 +1,7 @@
 import { HttpClient, HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { Environment } from '../ngx-services.models';
-import { CollectionPaymentsOut, ExternalShipmentsOut, FileCheckOut, InvoicesOut, PartialWithdrawalsOut, PromotionCodeDiscountsOut, ShipmentsReportOut } from './models/api-reports.types';
+import { CollectionPaymentsOut, ExternalShipmentsOut, FileCheckOut, InvoicesOut, PartialWithdrawalsOut, PromotionCodeDiscountsOut, ShipmentsLandingReportOut, ShipmentsReportOut } from './models/api-reports.types';
 import { QueryParams } from './models/api.models';
 import * as i0 from "@angular/core";
 export declare class ApiReportsService {
@@ -28,6 +28,31 @@ export declare class ApiReportsService {
      * @return {Observable<ShipmentsReportOut>} An observable emitting the shipment report data.
      */
     getShipmentsReport(params: QueryParams): Observable<ShipmentsReportOut>;
+    /**
+     * Retrieves the shipments landing report from the reports API.
+     *
+     * Sends a GET request to the `/shipments-landing-report` endpoint with the provided query parameters.
+     * The HTTP response is expected to be wrapped in an `ApiSuccess` envelope, from which the `data`
+     * payload is extracted and returned as the stream value.
+     *
+     * @param params - Query parameters used to filter or paginate the shipments landing report.
+     * @returns An observable that emits the parsed `ShipmentsLandingReportOut` data from the API response.
+     *
+     * @remarks
+     * - The underlying HTTP call uses `HttpClient.get` with `params` serialized as query string values.
+     * - The response is piped through `map` to unwrap `data` from `ApiSuccess<T>`.
+     * - Errors from the HTTP request are propagated through the observable stream.
+     *
+     * @example
+     * ```ts
+     * // Basic usage:
+     * service.getShipmentsLandingReport({ page: 1, perPage: 25 })
+     *   .subscribe(report => {
+     *     // handle ShipmentsLandingReportOut
+     *   });
+     * ```
+     */
+    getShipmentsLandingReport(params: QueryParams): Observable<ShipmentsLandingReportOut>;
     /**
      * Retrieves a report of external shipments based on the provided query parameters.
      *

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

@@ -117,6 +117,75 @@ export interface ShipmentReports {
         };
     }[];
 }
+export interface ShipmentLandingReport extends ActiveLessLaravelModel {
+    authorization_numbers: string[];
+    commercial_invoice: boolean;
+    company_id: number;
+    company_name: string;
+    country_id: number;
+    currency_code: string | null;
+    document_id: number;
+    hasCreditCardPayment: boolean;
+    installation_id: number;
+    installation_number: number;
+    invoice_document_id: number | null;
+    is_document: boolean;
+    is_manual: boolean;
+    itn_number: string;
+    location_code: string;
+    location_facility_code: string;
+    location_id: number;
+    location_name: string;
+    price_override_approver_name: string;
+    price_override_reason_name: string;
+    product_global_name: string;
+    product_local_name: string;
+    question_description: string | null;
+    receiver_address_line1: string;
+    receiver_city_name: string;
+    receiver_company_name: string;
+    receiver_country_name: string;
+    receiver_full_name: string;
+    receiver_postal_code: string;
+    receiver_state_name: string;
+    send_to_api_inventories: boolean;
+    shipment_description: string;
+    shipment_group_id: number;
+    shipment_group_name: string;
+    shipment_pieces_tracking_numbers: string[];
+    shipment_status_code: string;
+    shipment_status_id: number;
+    shipment_status_name_EN: string;
+    shipment_status_name_ES: string;
+    shipment_status_name_FR: string;
+    shipment_status_name_PT: string;
+    shipment_tags: ShipmentTag[];
+    shipment_tracking_number: string;
+    shipment_type: string;
+    shipment_value: string;
+    shipper_account: string;
+    shipper_address_line1: string;
+    shipper_address_line2: string;
+    shipper_address_line3: string;
+    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_number: string;
+    shipper_postal_code: string;
+    shipper_state_name: string;
+    tracking: string | null;
+    user_id: number;
+    user_username: string;
+    additional_documents: {
+        country_id: number;
+        include_indemnity_letter: boolean;
+        shipment_content_type_id: number;
+        shipment_scope_id: number;
+    };
+}
 export interface ShipmentTag extends ActiveLessSymfonyModel {
     name: string;
     code: string;

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

@@ -1,4 +1,4 @@
-import { CollectionPayment, Invoice, PartialWithdrawal, PromotionCodeDiscount, ReportExternalShipment, ShipmentReports } from './api-reports.interfaces';
+import { CollectionPayment, Invoice, PartialWithdrawal, PromotionCodeDiscount, ReportExternalShipment, ShipmentLandingReport, ShipmentReports } from './api-reports.interfaces';
 import { QueryParams } from './api.models';
 import { Session } from './api-security.interfaces';
 export type CollectionPaymentsOut = {
@@ -9,6 +9,10 @@ export type ShipmentsReportOut = {
     shipments: ShipmentReports[];
     total: number;
 };
+export type ShipmentsLandingReportOut = {
+    shipments_landing: ShipmentLandingReport[];
+    total: number;
+};
 export type ExternalShipmentsOut = {
     external_shipments: ReportExternalShipment[];
     total: number;

package/package.json

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

package/public-api.d.ts

@@ -23,7 +23,6 @@ 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.models';
 export * from './lib/apis/models/api-billing-do.interfaces';
 export * from './lib/apis/models/api-billing-do.types';
 export * from './lib/apis/models/api-billing-mx.interfaces';
@@ -32,6 +31,7 @@ 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-sv.interfaces';
 export * from './lib/apis/models/api-billing-sv.types';
+export * from './lib/apis/models/api-billing.models';
 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.enum';
@@ -45,11 +45,11 @@ export * from './lib/apis/models/api-customs.interfaces';
 export * from './lib/apis/models/api-customs.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-events.enum';
 export * from './lib/apis/models/api-events.interfaces';
 export * from './lib/apis/models/api-events.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';
 export * from './lib/apis/models/api-inventories.enum';
 export * from './lib/apis/models/api-inventories.interfaces';
@@ -61,6 +61,7 @@ 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-reports.types';
 export * from './lib/apis/models/api-security.interfaces';
 export * from './lib/apis/models/api-security.types';
 export * from './lib/apis/models/api-services.interfaces';