@experteam-mx/ngx-services 18.6.1 → 18.7.1

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

@@ -0,0 +1,27 @@
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { Observable } from 'rxjs';
+import { CookieService } from 'ngx-cookie-service';
+import { ShipmentOut } from './models/api-composition.types';
+import * as i0 from "@angular/core";
+export declare class ApiCompositionService {
+    private environments;
+    private cookie;
+    private http;
+    constructor(environments: Environment, cookie: CookieService, http: HttpClient);
+    /**
+     * Retrieves the API security URL from the environment configuration.
+     *
+     * @return {string} The API security URL.
+     */
+    get url(): string;
+    /**
+     * Retrieves shipment details based on the provided shipment ID.
+     *
+     * @param {number} id - The unique identifier of the shipment to retrieve.
+     * @return {Observable<ShipmentOut>} An observable that emits the details of the shipment.
+     */
+    getShipment(id: number): Observable<ShipmentOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiCompositionService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiCompositionService>;
+}

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

@@ -1,8 +1,8 @@
 import { Environment } from '../ngx-services.models';
-import { HttpClient } from '@angular/common/http';
+import { HttpClient, HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { QueryParams } from './models/api.models';
-import { CollectionPaymentsOut, ExistPendingInvoicesIn, ExistPendingPaymentsIn, ExternalShipmentsOut, PromotionCodeDiscountsOut, ShipmentsReportOut } from './models/api-reports.types';
+import { CollectionPaymentsOut, ExistPendingInvoicesIn, ExistPendingPaymentsIn, ExternalShipmentsOut, FileCheckOut, PromotionCodeDiscountsOut, ShipmentsReportOut } from './models/api-reports.types';
 import * as i0 from "@angular/core";
 export declare class ApiReportsService {
     private environments;
@@ -58,6 +58,27 @@ export declare class ApiReportsService {
      * @return {Observable<PromotionCodeDiscountsOut>} An observable that emits the promotion code discounts report data.
      */
     getPromotionCodeDiscounts(params: QueryParams): Observable<PromotionCodeDiscountsOut>;
+    /**
+     * Retrieves the downloadable resource associated with the given transaction ID.
+     *
+     * @param {string} transactionId - The unique identifier of the transaction whose download is requested.
+     * @return {Observable<HttpResponse<ArrayBuffer>>} An observable that emits the HTTP response containing the resource in the form of an ArrayBuffer.
+     */
+    getDownload(transactionId: string): Observable<HttpResponse<ArrayBuffer>>;
+    /**
+     * Retrieves file check information for the specified transaction ID.
+     *
+     * @param {string} transactionId - The ID of the transaction for which the file check information is to be retrieved.
+     * @return {Observable<FileCheckOut>} An observable that emits the file check information associated with the given transaction ID.
+     */
+    getFileCheck(transactionId: string): Observable<FileCheckOut>;
+    /**
+     * Deletes the file check associated with the provided transaction ID.
+     *
+     * @param {string} transactionId - The unique identifier of the transaction whose file check is to be deleted.
+     * @return {Observable<{}>} An observable emitting the response data after the deletion is processed.
+     */
+    deleteFileCheck(transactionId: string): Observable<{}>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiReportsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiReportsService>;
 }

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

@@ -148,45 +148,51 @@ export interface Installation extends LaravelModel {
     system: System;
 }
 export interface Location extends LaravelModel {
-    name: string;
-    contact_name: string;
-    email: string;
-    facility_code: string;
-    location_code: string;
-    type: string;
-    state_name: string;
-    state_id: number;
-    state_code: string;
-    city_name: string;
-    zip_code: string;
-    county_name: string;
+    accounts: Account[];
     address1: string;
     address2: string;
     address3: string;
-    service_area_code: string;
-    iata_code: string;
-    phone_code: string;
-    phone_number: string;
-    gmt_offset: string;
+    billing_code: string | null;
+    city_name: string;
+    commission_account: string | null;
+    company_country: CompanyCountry;
     company_country_id: number;
-    country_zone_id: number;
-    country_region_id: number;
-    management_area_id: number;
+    contact_name: string | null;
+    country_region: null;
+    country_region_id: number | null;
+    country_zone: null;
+    country_zone_id: number | null;
+    county_name: string;
+    default_account_id: number | null;
+    email: string | null;
+    etools_auto_billing_enabled: boolean;
+    extra_fields: {
+        [key: string]: string | number | boolean | null;
+    };
+    facility_code: string;
+    facility_id: number;
+    gmt_offset: string;
     google_maps_id: string;
-    route_number: string;
+    iata_code: string;
+    is_occurs: boolean;
+    location_code: string | null;
     locker_enabled: boolean;
+    management_area: null;
+    management_area_id: number | null;
+    name: string;
+    phone_code: string;
+    phone_number: string;
     queue_manager_enabled: boolean;
-    commission_account: string;
+    route_number: string;
+    service_area_code: string;
     service_point_id: string;
-    is_occurs: boolean;
-    default_account_id: number;
-    extra_fields: {
-        [key: string]: string;
-    };
-    facility_id: number;
-    accounts: Account[];
-    company_country: CompanyCountry;
     state: State;
+    state_code: string | null;
+    state_id: number;
+    state_name: string;
+    supervisor: Employee;
+    type: string;
+    zip_code: string;
 }
 export interface LocationEmployee extends LaravelModel {
     location_id: number;

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

@@ -0,0 +1,289 @@
+import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
+import { CustomerType } from './api-shipments.enums';
+export interface ShipmentComposition extends SymfonyModel {
+    currencyCode: string;
+    extraCharges: ExtraChargeComposition[];
+    globalProductCode: string;
+    globalProductName: string;
+    localProductCode: string;
+    localProductName: string;
+    trackingNumber: string;
+    contentDescription: string;
+    realWeight: number;
+    piecesNumber: number;
+    productSubtotal: number;
+    productTax: number;
+    productTotal: number;
+    declaredValue: number;
+    insuredValue: number;
+    accountNumber: string;
+    userId: number;
+    installationId: number;
+    companyCountryId: number;
+    productId: number;
+    countryReferenceCurrencyId: number;
+    commercialExchangeRate: number;
+    ibsExchangeRate: number;
+    shipmentStatusId: number;
+    shipmentAddresses: ShipmentAddresses[];
+    shipmentPieces: ShipmentPieces[];
+    shipmentCompanyCountryExtraCharges: ShipmentCompanyCountryExtraCharges[];
+    shipmentGsop: ShipmentGsop;
+    additionalData: AdditionalData;
+    transactionId: string;
+    requiresPayment: boolean;
+    originServiceAreaCode: string;
+    originFacilityCode: string;
+    destinationServiceAreaCode: string;
+    destinationFacilityCode: string;
+    productTaxes: string[];
+    isInspected: boolean;
+    extraFields: {
+        [key: string]: string | number | boolean;
+    };
+    shipmentContentTypeId: number;
+    commercialInvoice: CommercialInvoice;
+    shipmentScopeId: number;
+    shipmentGroupId: number;
+    product: string[];
+    declaredCurrency: string;
+    insuredCurrency: string;
+    deliveryDateTime: string;
+    date: string;
+    promotionCode: string;
+    priceOverrideApproverId: number;
+    priceOverrideReasonId: number;
+    customs: Customs;
+    exportReasonId: number;
+    exportReason: string[];
+    shipmentBookPickup: ShipmentBookPickup;
+    questionId: number;
+    isInsured: boolean;
+    itnNumber: string;
+    einNumber: string;
+    otherAccountNumber: string;
+    dutiesAndTaxesAccountNumber: string;
+    discountId: string;
+    discountReference: string;
+    totalPublishedValue: number;
+    totalPartnerAccountValue: number;
+    isMarketingConsent: boolean;
+    isTermCondition: boolean;
+    isDocument: boolean;
+    isCash: boolean;
+    isPriceOverride: boolean;
+    isProforma: boolean;
+    isPromotionCode: boolean;
+    isRetailRate: boolean;
+    isOtherOrigin: boolean;
+    isOccurs: boolean;
+    isDutiesAndTaxes: boolean;
+}
+export interface ExtraChargeComposition {
+    globalServiceCode: string;
+    localServiceCode: string;
+    globalServiceName: string;
+    localServiceName: string;
+    subtotal: number;
+    tax: number;
+    total: number;
+    taxes: Tax[];
+}
+export interface Tax {
+    code: string;
+    percent: number;
+    baseAmount: number;
+    amount: number;
+}
+export interface ShipmentAddresses extends SymfonyModel {
+    index: number;
+    identificationTypeId: number;
+    identificationNumber: string;
+    companyName: string;
+    fullName: string;
+    email: string;
+    phoneCode: string;
+    phoneNumber: string;
+    postalCode: string;
+    stateCode: string;
+    countyName: string;
+    cityName: string;
+    addressLine1: string;
+    addressLine2: string;
+    addressLine3: string;
+    countryId: number;
+    identificationType: IdentificationTypeComposition;
+    roleType: CustomerType;
+}
+export interface IdentificationTypeComposition extends SymfonyModel {
+    name: string;
+    companyCountryId: number;
+}
+export interface ShipmentPieces extends ActiveLessSymfonyModel {
+    number: number;
+    height: number;
+    length: number;
+    width: number;
+    realWeight: number;
+    volumetricWeight: number;
+    dataIdentifier: string;
+    trackingNumber: string;
+    licensePlateBarCode: string;
+    shipmentPieceCompanyCountrySupplies: ShipmentPieceCompanyCountrySupplies[];
+}
+export interface ShipmentPieceCompanyCountrySupplies extends ActiveLessSymfonyModel {
+    supplyId: number;
+    quantity: number;
+    subtotal: number;
+    taxBase: number;
+    taxPercent: number;
+    tax: number;
+    total: number;
+    description: string;
+    supply: Supply;
+}
+export interface Supply extends ActiveLessSymfonyModel {
+    name: string;
+    description: string;
+    countryId: number;
+    enabledForDropoff: boolean;
+    supplyType: SupplyTypeComposition;
+    supplyPacking: SupplyPackingComposition;
+}
+export interface SupplyTypeComposition extends SymfonyModel {
+    name: string;
+}
+export interface SupplyPackingComposition extends ActiveLessSymfonyModel {
+    value: number;
+    weight: number;
+    height: number;
+    depth: number;
+    width: number;
+}
+export interface CommercialInvoice extends ActiveLessSymfonyModel {
+    documentTypeId: number;
+    tradingTransactionTypeId: number;
+    documentFunctionId: number;
+    number: string;
+    remarks: string;
+    items: Item[];
+    documentType: DocumentType;
+    tradingTransactionType: TradingTransactionType;
+    documentFunction: DocumentFunction;
+}
+export interface Item extends ActiveLessSymfonyModel {
+    description: string;
+    quantity: number;
+    quantityUnitId: number;
+    subtotal: number;
+    manufactureCountryCode: string;
+    realWeight: number;
+    commodityId: number;
+    quantityUnit: QuantityUnit;
+    manufactureCountry: ManufactureCountry;
+    commodity: Commodity;
+}
+export interface QuantityUnit extends SymfonyModel {
+    code: string;
+    name: string;
+}
+export interface ManufactureCountry {
+    id: string;
+    code: string;
+    name: string;
+    locationType: string[];
+    unit: string[];
+    timezone: string;
+    hasImportService: boolean;
+    isActive: boolean;
+    regions: string[];
+    zones: string[];
+    isoCode: string;
+}
+export interface Commodity extends SymfonyModel {
+    code: string;
+    name: string;
+    countryId: number;
+}
+export interface DocumentType extends SymfonyModel {
+    code: string;
+    name: string;
+    description: string;
+}
+export interface TradingTransactionType extends SymfonyModel {
+    code: string;
+    name: string;
+    description: string;
+}
+export interface DocumentFunction extends SymfonyModel {
+    code: string;
+    name: string;
+}
+export interface ShipmentGsop extends ActiveLessSymfonyModel {
+    productContentCode: string;
+    originServiceAreaCode: string;
+    destinationServiceAreaCode: string;
+    internalServiceCode: string;
+    awbBarCode: string;
+    dhlRoutingBarCode: string;
+}
+export interface ShipmentCompanyCountryExtraCharges extends ActiveLessSymfonyModel {
+    subtotal: number;
+    tax: number;
+    total: number;
+    extraChargeId: number;
+    extraChargeCode: string;
+}
+export interface AdditionalData {
+    awbTypeCode: string;
+    countryCode: string;
+    shipmentTypeCode: string;
+    productGlobalCode: string;
+    productLocalCode: string;
+    currencyCode: string;
+    userUsername: string;
+    locationFacilityCode: string;
+}
+export interface Customs {
+    criteria: Criteria;
+    rules: Rules[];
+}
+export interface Criteria {
+    origin: string;
+    destination: string;
+    dutiable: boolean;
+    declaredValue: number;
+}
+export interface Rules {
+    id: number;
+    level: string;
+    attributes: Attributes[];
+}
+export interface Attributes {
+    id: number;
+    field: string;
+    dhlCode: string;
+    values: Values;
+}
+export interface Values {
+    shipment: string;
+    customer: CustomerComposition;
+    invoiceHeader: string;
+    invoiceItem: string[];
+}
+export interface CustomerComposition {
+    SP: string;
+    RV: string;
+}
+export interface ShipmentBookPickup extends ActiveLessSymfonyModel {
+    pickupDate: string;
+    readyByTime: string;
+    closeTime: string;
+    confirmationNumber: string;
+    packageLocationId: number;
+    remarks: string;
+    packageLocation: PackageLocation;
+}
+export interface PackageLocation extends SymfonyModel {
+    name: string;
+}

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

@@ -0,0 +1,4 @@
+import { ShipmentComposition } from './api-composition.interfaces';
+export type ShipmentOut = {
+    shipment: ShipmentComposition;
+};

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

@@ -22,8 +22,6 @@ export interface Document extends LaravelModel {
         fax: string;
     };
     document_id: number;
-    created_at: string;
-    updated_at: string;
     transaction_id: string;
     extra_fields: {
         observation: string;
@@ -155,7 +153,7 @@ export interface Customer extends LaravelModel {
     company_id: number;
     identification_type_id: number;
     extra_fields: {
-        [key: string]: string;
+        [key: string]: string | number | boolean | null;
     };
     country_id: number;
     customer_type_id: number;

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

@@ -48,29 +48,31 @@ export type OperationCancelBillingOut = {
 };
 export type OperationDocumentIn = {
     country_document_type_id: number;
+    document_id: number;
     customer: {
+        customer_type_id: number;
         company_name: string;
         full_name: string;
         email: string;
-        phone_code: string;
-        phone_number: string;
-        address_line1: string;
-        address_line2: string;
-        address_line3: string;
+        phone_code: string | null;
+        phone_number: string | null;
+        address_line1: string | null;
+        address_line2: string | null;
+        address_line3: string | null;
         identification_number: string;
         identification_type_id: number;
-        postal_code: string;
-        state: string;
-        county_name: string;
-        city_name: string;
+        postal_code: string | null;
+        state: string | null;
+        county_name: string | null;
+        city_name: string | null;
         country_id: number;
         extra_fields: {
-            [key: string]: string;
-        };
+            [key: string]: string | number | boolean;
+        } | null;
     };
     document_extra_fields: {
-        [key: string]: string;
-    };
+        [key: string]: string | number | boolean;
+    } | null;
 };
 export type OperationDocumentOut = {
     document: Document;

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

@@ -18,7 +18,7 @@ export interface CollectionPayment extends LaravelModel {
     user_id: number;
     user_username: string;
     document_type_id: number;
-    document_type: DocumentType;
+    document_type: DocumentTypeReports;
     document_category_id: number;
     document_category: DocumentCategory;
     receipt_number: string;
@@ -30,7 +30,7 @@ export interface CollectionPayment extends LaravelModel {
     operation_type_id: number;
     operation_type: OperationType;
 }
-export interface DocumentType extends LaravelModel {
+export interface DocumentTypeReports extends LaravelModel {
     _id: number;
     name: string;
     code: string;
@@ -47,7 +47,7 @@ export interface DocumentCategory extends LaravelModel {
     updated_at: string;
     translations: Translations;
 }
-export interface Shipment extends LaravelModel {
+export interface ShipmentReports extends LaravelModel {
     amount_1: number;
     amount_2: number;
     amount_collected: number;

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

@@ -1,10 +1,12 @@
-import { CollectionPayment, PromotionCodeDiscount, ReportExternalShipment, Shipment } from './api-reports.interfaces';
+import { CollectionPayment, PromotionCodeDiscount, ReportExternalShipment, ShipmentReports } from './api-reports.interfaces';
+import { QueryParams } from './api.models';
+import { Session } from './api-security.interfaces';
 export type CollectionPaymentsOut = {
     collection_payments: CollectionPayment[];
     total: number;
 };
 export type ShipmentsReportOut = {
-    shipments: Shipment[];
+    shipments: ShipmentReports[];
     total: number;
 };
 export type ExistPendingPaymentsIn = {
@@ -23,3 +25,24 @@ export type PromotionCodeDiscountsOut = {
 } | {
     transaction_id: string;
 };
+export type FileCheckOut = {
+    report_file: {
+        user_id: number;
+        role_type_level: number;
+        type: string;
+        status: number;
+        progress: number;
+        file_size: number;
+        file_name: string | null;
+        report_request: QueryParams;
+        transaction_id: string;
+        headers: {
+            [key: string]: string;
+        };
+        user_session: Session;
+        role_company_country_id: number;
+        updated_at: string;
+        created_at: string;
+        id: string;
+    };
+};

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

@@ -1,23 +1,23 @@
 import { LaravelModel } from './api.models';
 import { Pivot } from './api-security.types';
 export interface Session extends LaravelModel {
-    name: string;
-    username: string;
-    email: string;
     model_type: string;
     model_id: number;
-    auth_type: string;
-    language_id: number;
-    country_id: number;
-    location_id: number;
+    status: string;
+    last_activity: string;
+    user_agent: string;
+    gmt_offset: string;
+    opening_id: number;
+    user_id: number;
     installation_id: number;
+    locale: string | null;
+    decimal_point: number;
+    country_id: number;
+    company_id: number;
     company_country_id: number;
+    location_id: number;
     country_reference_currency_id: number;
-    opening_id: number;
-    locale: string;
-    permissions: string[];
-    roles: Role[];
-    session: Session;
+    location_employee_id: number;
 }
 export interface Role extends LaravelModel {
     name: string;
@@ -26,7 +26,6 @@ export interface Role extends LaravelModel {
     role_type_id: number;
     regional_country_id: number | null;
     role_type: RoleType;
-    permissions: Permission[];
 }
 export interface RoleType extends LaravelModel {
     name: string;
@@ -49,6 +48,11 @@ export interface User extends LaravelModel {
     email: string;
     roles: Role[];
 }
+export interface UserMe extends Omit<User, 'roles'> {
+    permissions: string[];
+    session: Session | null;
+    role: Role;
+}
 export interface Module extends LaravelModel {
     name: string;
     code: string;

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

@@ -1,4 +1,4 @@
-import { Module, Permission, Role, RoleType, Session, User } from './api-security.interfaces';
+import { Module, Role, RoleType, Session, User, UserMe } from './api-security.interfaces';
 export type AuthLoginIn = {
     username: string;
     password: string;
@@ -35,22 +35,7 @@ export type GetUsersOut = {
     total: number;
 };
 export type AuthMeOut = {
-    user: {
-        id: number;
-        name: string;
-        username: string;
-        model_type: string;
-        model_id: number;
-        is_active: boolean;
-        created_at: string;
-        updated_at: string;
-        auth_type: string;
-        language_id: number;
-        email: string;
-        role: Role;
-        permissions: Permission[];
-        session: Session | null;
-    };
+    user: UserMe;
 };
 export type ChangeLanguageIn = {
     languageId: number;

package/lib/apis/models/api-shipments.enums.d.ts

@@ -0,0 +1,6 @@
+export declare enum CustomerType {
+    SHIPPER = "SP",
+    CONSIGNEE = "RV",
+    IMPORTER = "IP",
+    EXPORTER = "EP"
+}

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

@@ -21,6 +21,7 @@ export type Environment = {
     apiCashOperationsUrl?: string;
     apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
+    apiCompositionUrl?: string;
     apiEToolsAutoBilling?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;

package/package.json

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