@experteam-mx/ngx-services 18.4.9 → 18.5.0

package/lib/apis/api-e-tools-auto-billing.service.d.ts

@@ -0,0 +1,39 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Environment } from '../ngx-services.models';
+import { ExternalShipmentAddressesIn, ExternalShipmentAddressesOut, ExternalShipmentFileOut, ExternalShipmentHistoriesIn } from './models/api-e-tools-auto-billing.types';
+import * as i0 from "@angular/core";
+export declare class ApiEToolsAutoBillingService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the shipments API from the environment configurations.
+     *
+     * @return {string} The URL of the shipments API.
+     */
+    get url(): string;
+    /**
+     * Updates external shipment addresses using the provided parameters and returns the updated addresses.
+     *
+     * @param {ExternalShipmentAddressesIn} body - The input parameters containing details of the shipment addresses to be updated.
+     * @return {Observable<ExternalShipmentAddressesOut>} An observable containing the updated external shipment addresses.
+     */
+    patchExternalShipmentAddresses(body: ExternalShipmentAddressesIn): Observable<ExternalShipmentAddressesOut>;
+    /**
+     * Fetches the external shipment file by its identifier.
+     *
+     * @param {number} fileId - The unique identifier of the external shipment file to be retrieved.
+     * @return {Observable<ExternalShipmentFileOut>} An observable containing the external shipment file data.
+     */
+    getExternalShipmentFile(fileId: number): Observable<ExternalShipmentFileOut>;
+    /**
+     * Retrieves the history entries for a specific external shipment.
+     *
+     * @param {number} id - The ID of the external shipment to retrieve history for.
+     * @return {Observable<ExternalShipmentHistoriesIn>} An observable containing the external shipment history entries.
+     */
+    getExternalShipmentHistories(id: number): Observable<ExternalShipmentHistoriesIn>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiEToolsAutoBillingService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiEToolsAutoBillingService>;
+}

package/lib/apis/api-reports.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 { CollectionPaymentsOut, ExistPendingInvoicesIn, ExistPendingPaymentsIn, ShipmentsReportOut } from './models/api-reports.types';
+import { CollectionPaymentsOut, ExistPendingInvoicesIn, ExistPendingPaymentsIn, ExternalShipmentsOut, ShipmentsReportOut } from './models/api-reports.types';
 import * as i0 from "@angular/core";
 export declare class ApiReportsService {
     private environments;
@@ -44,6 +44,13 @@ export declare class ApiReportsService {
      * @return {Observable<ShipmentsReportOut>} An observable emitting the shipment report data.
      */
     getShipmentsReport(params: QueryParams): Observable<ShipmentsReportOut>;
+    /**
+     * Retrieves a report of external shipments based on the provided query parameters.
+     *
+     * @param {QueryParams} params - An object representing the query parameters for filtering the external shipments report.
+     * @return {Observable<ExternalShipmentsOut>} An observable that emits the external shipments report data.
+     */
+    getExternalShipmentsReport(params: QueryParams): Observable<ExternalShipmentsOut>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiReportsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiReportsService>;
 }

package/lib/apis/models/api-e-tools-auto-billing.interfaces.d.ts

@@ -0,0 +1,42 @@
+import { ActiveLessSymfonyModel } from './api.models';
+export interface ExternalShipmentAddress extends ActiveLessSymfonyModel {
+    addressLine1: string;
+    addressLine2: string;
+    addressLine3: string;
+    cityName: string;
+    companyName: string;
+    countryId: number;
+    email: string;
+    externalShipmentId: number;
+    fullName: string;
+    identificationNumber: string;
+    identificationTypeId: number;
+    phoneCode: string;
+    phoneNumber: string;
+    postalCode: string;
+    roleType: string;
+    serviceAreaCode: string;
+}
+export interface ExternalShipmentStatus extends ActiveLessSymfonyModel {
+    name: string;
+    isActive: boolean;
+}
+export interface ExternalShipmentHistory extends ActiveLessSymfonyModel {
+    externalShipmentId: number;
+    externalShipmentStatus: ExternalShipmentStatus;
+    messages: string[];
+}
+export interface ExternalShipmentFile extends ActiveLessSymfonyModel {
+    companyCountryId: string;
+    name: string;
+    finished: false;
+    statusId: number;
+    externalShipmentFileHistories: ExternalShipmentFileHistory[];
+    externalShipmentId: number;
+    content: string;
+}
+export interface ExternalShipmentFileHistory extends ActiveLessSymfonyModel {
+    statusId: number;
+    messages: string[];
+    externalShipmentFileId: number;
+}

package/lib/apis/models/api-e-tools-auto-billing.types.d.ts

@@ -0,0 +1,25 @@
+import { ExternalShipmentAddress, ExternalShipmentFile, ExternalShipmentHistory } from './api-e-tools-auto-billing.interfaces';
+export type ExternalShipmentAddressesIn = {
+    addressLine1: string;
+    addressLine2: string;
+    addressLine3: string;
+    cityName: string;
+    companyName: string;
+    email: string;
+    fullName: string;
+    identificationNumber: string;
+    identificationTypeId: number;
+    phoneCode: string;
+    phoneNumber: string;
+    postalCode: string;
+};
+export type ExternalShipmentAddressesOut = {
+    externalShipmentAddress: ExternalShipmentAddress;
+};
+export type ExternalShipmentFileOut = {
+    externalShipmentFile: ExternalShipmentFile;
+};
+export type ExternalShipmentHistoriesIn = {
+    total: number;
+    externalShipmentHistories: ExternalShipmentHistory[];
+};

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

@@ -1,4 +1,4 @@
-import { LaravelModel, Translations } from './api.models';
+import { ActiveLessLaravelModel, ApiModel, LaravelModel, Translations } from './api.models';
 import { DocumentPayment } from './api-invoices.interfaces';
 import { OperationType } from './api-catalog.interfaces';
 export interface CollectionPayment extends LaravelModel {
@@ -47,120 +47,124 @@ export interface DocumentCategory extends LaravelModel {
     updated_at: string;
     translations: Translations;
 }
-export interface Shipment {
-    id: number;
-    document_id: number;
-    shipment_scope_name: string;
-    is_document: boolean;
-    origin_service_area_code: string;
-    origin_facility_code: string;
-    destination_facility_code: string;
-    destination_service_area_code: string;
-    shipment_pieces_tracking_numbers: string[];
-    shipment_tracking_number: string;
-    shipper_full_name: string;
-    shipper_company_name: string;
-    shipper_email: string;
-    shipper_phone_number: string;
-    shipper_phone_code: string;
-    shipper_full_phone_number: string;
-    shipper_address_line1: string;
-    shipper_address_line2: string;
-    shipper_city_name: string;
-    shipper_state_name: string;
-    shipper_state_code: string;
-    shipper_postal_code: string;
-    receiver_full_name: string;
-    receiver_company_name: string;
-    receiver_address_line1: string;
-    receiver_address_line2: string;
-    receiver_city_name: string;
-    receiver_state_name: string;
-    receiver_state_code: string;
-    receiver_postal_code: string;
-    shipper_account: string;
-    promotion_code: string;
-    customer_identification_type_id: number;
-    customer_identification_number: string;
+export interface Shipment extends LaravelModel {
+    amount_1: number;
+    amount_2: number;
+    amount_collected: number;
+    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;
-    price_override_approver_id: number;
-    price_override_reason_id: number;
-    price_override_approver_name: string;
-    price_override_reason_name: string;
-    is_proforma: boolean;
+    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;
+    document_id: number;
+    document_payments?: DocumentPayment[];
+    ein_number: string;
+    installation_id: number;
+    installation_number: number;
+    insured_value: number;
+    invoice?: string[];
+    invoice_document_id?: number | null;
+    is_document: boolean;
     is_kiosk: boolean;
-    to_landing: boolean;
+    is_manual: boolean;
+    is_marketing_consent: boolean;
     is_price_override: boolean;
+    is_proforma: boolean;
     is_promotion_code: boolean;
     is_retail_rate: boolean;
-    payment_type_1: string;
-    payment_code_1: string;
-    amount_1: number;
-    reference_1: string;
-    payment_type_2: string;
-    payment_code_2: string;
-    amount_2: number;
-    reference_2: string;
-    document_payments?: DocumentPayment[];
+    is_term_condition: boolean;
+    itn_number: string;
+    location_facility_code: string;
     location_id: number;
-    installation_id: number;
-    user_id: number;
-    user_username: string;
-    company_id: number;
-    country_id: number;
-    company_country_id: number;
-    country_name: string;
-    company_name: string;
-    country_code: string;
     location_name: string;
-    location_facility_code: string;
-    installation_number: number;
+    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;
-    shipment_gmt_offset: string;
-    shipment_pieces_number: number;
-    shipment_bill_weight: number;
-    total_published_value: number;
-    total_partner_account_value: number;
-    question_id: number;
+    product_subtotal: number;
+    product_tax: number;
+    product_total: number;
+    promotion_code: string;
     question_description: string;
+    question_id: number;
     question_type: string;
-    amount_collected: number;
-    shipment_value: number;
-    declared_value: number;
-    insured_value: number;
-    shipment_status_id: number;
-    transaction_id: string;
-    shipment_type: string;
-    ein_number: string;
-    itn_number: string;
-    created_at: string;
-    updated_at: string;
+    receiver_address_line1: string;
+    receiver_address_line2: string;
+    receiver_city_name: string;
+    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_translations: {
-        description: {
-            [key: string]: string;
-        };
+    shipment_status_id: number;
+    shipment_tracking_number: string;
+    shipment_type: string;
+    shipment_value: number;
+    shipper_account: string;
+    shipper_address_line1: string;
+    shipper_address_line2: string;
+    shipper_city_name: string;
+    shipper_company_name: string;
+    shipper_email: string;
+    shipper_full_name: string;
+    shipper_full_phone_number: string;
+    shipper_phone_code: string;
+    shipper_phone_number: string;
+    shipper_postal_code: string;
+    shipper_state_code: string;
+    shipper_state_name: string;
+    subtotal: number;
+    tax: number;
+    to_landing: boolean;
+    total: number;
+    total_partner_account_value: number;
+    total_published_value: number;
+    transaction_id: 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;
     };
-    authorization_numbers: string[];
-    is_term_condition: boolean;
-    is_marketing_consent: boolean;
-    is_manual: boolean;
-    commercial_invoice: boolean;
-    shipment_id: number;
-    date: string;
-    date_og: string;
-    invoice_document_id?: number | null;
-    currency_code: string | null;
-    send_to_api_inventories: boolean;
-    selected?: boolean;
-    delivery_date_time: string;
-    product_subtotal: number;
-    product_tax: number;
-    product_total: number;
     product_taxes: {
         code: string;
         percent: number;
@@ -187,11 +191,41 @@ export interface Shipment {
         local_service_name: string;
         is_discount: false;
     }[];
-    additional_documents: {
-        country_id: number;
-        include_indemnity_letter: boolean;
-        include_pdf: boolean;
-        shipment_content_type_id: number;
-        shipment_scope_id: number;
+    shipment_status_translations: {
+        description: {
+            [key: string]: string;
+        };
     };
 }
+export interface ReportExternalShipment extends ActiveLessLaravelModel {
+    account_number: string;
+    collection_date: string;
+    document_id: number | null;
+    document_number: string | null;
+    external_shipment_addresses: ReportExternalShipmentAddress[];
+    external_shipment_file_id: number;
+    external_shipment_status_id: number;
+    external_shipment_status_name: string;
+    external_shipment_status_translations: Translations;
+    installation_id: number;
+    subtotal: number;
+    tax: number;
+    total: number;
+    tracking_number: string;
+    user_id: number;
+}
+export interface ReportExternalShipmentAddress extends ApiModel {
+    address_line_1: string;
+    address_line_2: string;
+    city_name: string;
+    company_name: string;
+    country_id: number;
+    email: string;
+    full_name: string;
+    identification_number: string | null;
+    identification_type_id: number | null;
+    phone_number: string;
+    postal_code: string;
+    role_type: string;
+    service_area_code: string;
+}

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

@@ -1,4 +1,4 @@
-import { CollectionPayment, Shipment } from './api-reports.interfaces';
+import { CollectionPayment, ReportExternalShipment, Shipment } from './api-reports.interfaces';
 export type CollectionPaymentsOut = {
     collection_payments: CollectionPayment[];
     total: number;
@@ -13,3 +13,7 @@ export type ExistPendingPaymentsIn = {
 export type ExistPendingInvoicesIn = {
     installation_id: number;
 };
+export type ExternalShipmentsOut = {
+    external_shipments: ReportExternalShipment[];
+    total: number;
+};

package/lib/apis/models/api.models.d.ts

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

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

@@ -19,6 +19,7 @@ export type Environment = {
     apiBillingMX?: string;
     apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
+    apiEToolsAutoBilling?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;
     apiInvoicesUrl?: string;

package/package.json

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

package/public-api.d.ts

@@ -4,6 +4,7 @@ export * from './lib/apis/api-billing-do.service';
 export * from './lib/apis/api-billing-mx.service';
 export * from './lib/apis/api-catalogs.service';
 export * from './lib/apis/api-companies.service';
+export * from './lib/apis/api-e-tools-auto-billing.service';
 export * from './lib/apis/api-external-pickups.service';
 export * from './lib/apis/api-invoices.service';
 export * from './lib/apis/api-open-items.service';
@@ -15,6 +16,8 @@ export * from './lib/apis/models/api-catalog.interfaces';
 export * from './lib/apis/models/api-catalog.types';
 export * from './lib/apis/models/api-companies.interfaces';
 export * from './lib/apis/models/api-companies.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-invoices.interfaces';
 export * from './lib/apis/models/api-invoices.types';