@experteam-mx/ngx-services 20.0.0-beta.4 → 20.0.1

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

@@ -0,0 +1,342 @@
+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;
+    country_id: number;
+    country_name: string;
+    company_id: number;
+    company_name: string;
+    company_country_id: number;
+    installation_id: number;
+    installation_number: number;
+    location_facility_code: string;
+    location_id: number;
+    location_location_code: string;
+    location_name: string;
+    user_id: number;
+    user_username: string;
+    document_type_id: number;
+    document_type: DocumentTypeReports;
+    document_category_id: number;
+    document_category: DocumentCategoryReports;
+    receipt_number: string;
+    customer_name: string;
+    account: string;
+    amount: number;
+    currency_id: number;
+    currency_code: string;
+    operation_type_id: number;
+    operation_type: OperationType;
+}
+export interface DocumentTypeReports extends LaravelModel {
+    _id: number;
+    name: string;
+    code: string;
+    movement_type: number;
+    local_code: string;
+    translations: Translations;
+}
+export interface DocumentCategoryReports extends LaravelModel {
+    _id: number;
+    name: string;
+    is_electronic: true;
+    taxable: number;
+    created_at: string;
+    updated_at: string;
+    translations: Translations;
+}
+export interface ShipmentReports {
+    authorization_numbers: string[];
+    commercial_invoice: boolean;
+    company_name: string;
+    country_id: number;
+    country_name: string;
+    currency_code: string;
+    customer_identification_number: string | null;
+    customer_identification_type_id: number | null;
+    document_id: number;
+    id: number;
+    installation_id: number;
+    installation_number: number;
+    invoice_document_id: number | null;
+    is_document: boolean;
+    is_manual: boolean;
+    itn_number: string | null;
+    location_id: number;
+    location_name: string;
+    price_override_approver_name: string | null;
+    price_override_reason_name: string | null;
+    product_subtotal: number;
+    product_tax: number;
+    question_description: string | null;
+    receiver_company_name: string;
+    receiver_full_name: string;
+    send_to_api_inventories: boolean;
+    shipment_id: number;
+    shipment_pieces_tracking_numbers: 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: string;
+    shipper_account: string;
+    shipper_address_line1: 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 | null;
+    shipper_phone_number: string;
+    shipper_postal_code: string;
+    shipper_state_name: string | null;
+    subtotal: number;
+    tax: number;
+    total: number;
+    tracking: string | null;
+    updated_at: string;
+    user_id: number;
+    user_username: string;
+    additional_documents: {
+        country_id: number;
+        include_indemnity_letter: boolean;
+        shipment_content_type_id: number;
+        shipment_scope_id: number;
+    };
+    document_payments: {
+        payment: {
+            countryPaymentType: {
+                code: string;
+            };
+        };
+    }[];
+}
+export interface ShipmentLandingReport extends ActiveLessLaravelModel {
+    authorization_numbers: string[] | null;
+    commercial_invoice: boolean | null;
+    company_id: number;
+    company_name: string;
+    country_id: number;
+    country_name: string;
+    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 | null;
+    location_code: string;
+    location_facility_code: string;
+    location_id: number;
+    location_name: string;
+    price_override_approver_name: string | null;
+    price_override_reason_name: string | null;
+    product_global_name: string;
+    product_local_name: string;
+    question_description: string | null;
+    receiver_address_line1: string;
+    receiver_address_line2: string | null;
+    receiver_address_line3: string | null;
+    receiver_city_name: string;
+    receiver_company_name: string;
+    receiver_country_name: string;
+    receiver_county_name: string | null;
+    receiver_email: string | null;
+    receiver_full_name: string;
+    receiver_full_phone_number: string | null;
+    receiver_identification_number: string | null;
+    receiver_postal_code: string | null;
+    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: number;
+    shipper_account: string;
+    shipper_address_line1: string;
+    shipper_address_line2: string | null;
+    shipper_address_line3: string | null;
+    shipper_city_name: string | null;
+    shipper_company_name: string;
+    shipper_country_name: string;
+    shipper_county_name: string | null;
+    shipper_email: string | null;
+    shipper_full_name: string;
+    shipper_full_phone_number: string;
+    shipper_identification_number: string | null;
+    shipper_phone_number: string | null;
+    shipper_postal_code: string | null;
+    shipper_state_name: string | null;
+    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;
+    } | null;
+}
+export interface ShipmentTag extends ActiveLessSymfonyModel {
+    name: string;
+    code: string;
+    translations: Translations;
+}
+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;
+}
+export interface PromotionCodeDiscount extends ApiModel {
+    country_id: number;
+    company_country_id: number;
+    location_id: number;
+    installation_id: number;
+    user_id: number;
+    user_username: string;
+    updated_at: Date | string;
+    tracking_number: string;
+    product_id: number;
+    product_global_code: string;
+    product_global_name: string;
+    origin_facility_code: string;
+    destination_facility_code: string;
+    origin_company_name: string;
+    origin_full_name: string;
+    promotion_code: string;
+    discount_percentage: number;
+    product_subtotals: ProductSubtotal[];
+}
+export interface ProductSubtotal {
+    country_reference_currency_id: number;
+    currency_id: number;
+    currency_code: string;
+    value: number;
+    shipment_total: number;
+    discount_amount: number;
+}
+export interface WithdrawalAmount {
+    country_reference_currency_id: number;
+    currency_id: number;
+    currency_code: string;
+    value: number | null;
+}
+export interface PartialWithdrawal extends ActiveLessLaravelModel {
+    country_id: number;
+    company_country_id: number;
+    location_id: number;
+    installation_id: number;
+    opening_user_id: number;
+    opening_user_username: string;
+    opening_user_name: string;
+    opening_reference_user_id: number;
+    opening_reference_user_username: string;
+    opening_reference_user_name: string;
+    receipt_number: string;
+    amounts: WithdrawalAmount[];
+}
+export interface Invoice extends ActiveLessLaravelModel {
+    complete_document_number: string;
+    tracking_numbers: string[];
+    local_currency_total_amount: number;
+    identification_type_name: string;
+    identification_number: string;
+    customer_full_name: string;
+    customer_address: string;
+    customer_email: string;
+    customer_extra_fields: {
+        field: string;
+        value: string;
+    }[];
+    document_type_name: string;
+    document_type_name_ES: string;
+    document_type_name_EN: string;
+    document_category_name: string;
+    document_category_name_ES: string;
+    document_category_name_EN: string;
+    document_status_id: number;
+    document_status_code: string;
+    transaction_type: string;
+    installation_id: number;
+    location_id: number;
+    company_country_id: number;
+    country_id: number;
+    customer_phone_code: string;
+    customer_phone_number: string;
+    customer_city_name: string;
+    customer_county_name: string;
+    shipment_id: number;
+}
+export interface Sales extends ActiveLessLaravelModel {
+    company_country_id: number;
+    country_document_type_id: number;
+    country_id: number;
+    customer_address_line1: string;
+    customer_email: string;
+    customer_name: string;
+    customer_phone: string;
+    document_full_number: string;
+    document_sap_full_number: string;
+    document_status_name: string;
+    document_status: number;
+    document_type_name_EN: string;
+    document_type_name_ES: string;
+    document_type_name_FR: string;
+    document_type_name_PT: string;
+    document_type_name: string;
+    exempt: number;
+    identification_number: string;
+    identification_type_id: number;
+    identification_type_name: string;
+    installation_id: number;
+    location_id: number;
+    subtotal: number;
+    tax: number;
+    total: number;
+    user_id: number;
+}

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

@@ -0,0 +1,59 @@
+import { CollectionPayment, Invoice, PartialWithdrawal, PromotionCodeDiscount, ReportExternalShipment, Sales, ShipmentLandingReport, ShipmentReports } from './api-reports.interfaces';
+import { Session } from './api-security.interfaces';
+import { QueryParams } from './api.models';
+export type CollectionPaymentsOut = {
+    collection_payments: CollectionPayment[];
+    total: number;
+};
+export type ShipmentsReportOut = {
+    shipments: ShipmentReports[];
+    total: number;
+};
+export type ShipmentsLandingReportOut = {
+    shipments_landing: ShipmentLandingReport[];
+    total: number;
+};
+export type ExternalShipmentsOut = {
+    external_shipments: ReportExternalShipment[];
+    total: number;
+};
+export type PromotionCodeDiscountsOut = {
+    total: number;
+    promotion_code_discounts: PromotionCodeDiscount[];
+} | {
+    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;
+    };
+};
+export type PartialWithdrawalsOut = {
+    partial_withdrawals: PartialWithdrawal[];
+    total: number;
+};
+export type InvoicesOut = {
+    invoices: Invoice[];
+    total: number;
+};
+export type SalesBookReportOut = {
+    sale_books: Sales[];
+    total: number;
+    transaction_id?: string;
+};

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

@@ -0,0 +1,68 @@
+import { LaravelModel } from './api.models';
+import { Pivot } from './api-security.types';
+export interface Session extends LaravelModel {
+    model_type: string;
+    model_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;
+    location_employee_id: number;
+}
+export interface Role extends LaravelModel {
+    name: string;
+    guard_name: string;
+    company_country_id: number;
+    role_type_id: number;
+    regional_country_id: number | null;
+    role_type: RoleType;
+    permissions?: Permission[];
+}
+export interface RoleType extends LaravelModel {
+    name: string;
+    level: number;
+}
+export interface Permission extends LaravelModel {
+    name: string;
+    guard_name: string;
+    description: string;
+    is_default: boolean;
+    pivot: Pivot;
+}
+export interface User extends LaravelModel {
+    name: string;
+    username: string;
+    model_type: string;
+    model_id: number;
+    auth_type: string;
+    language_id: number;
+    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;
+    module_type_id: number;
+    module_type: ModuleType;
+    permissions: Permission[];
+    require_default_permission?: boolean;
+}
+export interface ModuleType extends LaravelModel {
+    name: string;
+    description: string;
+}

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

@@ -0,0 +1,72 @@
+import { Module, Role, RoleType, Session, User, UserMe } from './api-security.interfaces';
+export type AuthLoginIn = {
+    username: string;
+    password: string;
+    role?: number;
+    system_name?: string;
+};
+export type AuthLoginOut = {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+};
+export type AuthUserLoginIn = {
+    username: string;
+};
+export type SessionIn = {
+    modelType: string;
+    modelId: number;
+    token?: string;
+};
+export type SessionOut = {
+    session: Session;
+};
+export type PutUsersIn = {
+    user: User;
+};
+export type PutUsersOut = {
+    user: User;
+};
+export type GetUserOut = {
+    user: User;
+};
+export type GetUsersOut = {
+    users: User[];
+    total: number;
+};
+export type AuthMeOut = {
+    user: UserMe;
+};
+export type ChangeLanguageIn = {
+    languageId: number;
+};
+export type RolesOut = {
+    roles: Role[];
+    total: number;
+};
+export type Pivot = {
+    role_id: number;
+    permission_id: number;
+} | {
+    module_id: string;
+    permission_id: string;
+};
+export type RoleOut = {
+    role: Role;
+};
+export type RoleIn = {
+    name: string;
+    role_type_id: number;
+    company_country_id: number;
+    regional_country_id?: number[] | null;
+    is_active: boolean;
+    permissions?: string[];
+};
+export type RoleTypesOut = {
+    role_types: RoleType[];
+    total: number;
+};
+export type ModulesOut = {
+    modules: Module[];
+    total: number;
+};

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

@@ -0,0 +1,43 @@
+import { SymfonyModel } from './api.models';
+export interface ServiceArea extends SymfonyModel {
+    serviceAreaCodeName: string;
+    referenceDataCode: string;
+    serviceAreaCode: string;
+    serviceAreaName: string;
+    serviceAreaStatusCode: string;
+    serviceAreaStatusCodeDescription: string;
+    iataCode: string;
+    iataAirportName: string;
+    countryCode: string;
+    countryName: string;
+    timezoneCode: string;
+    timezoneCodeName: string;
+    offNetServiceIndicator: string;
+    offNetServiceIndicatorDescription: string;
+    effectiveDate: string;
+}
+export interface Facility extends SymfonyModel {
+    facilityIdentifier: string;
+    facilityCode: string;
+    serviceAreaCode: string;
+    serviceAreaName: string;
+    facilityName: string;
+    countryCode: string;
+    countryName: string;
+    facilityStatusCode: string;
+    facilityCompanyName: string;
+    facilityTypeIndicator: string;
+    cityName: string;
+    addressLine1: string;
+    postcode: string;
+    addressLongitude: string;
+    addressLatitude: string;
+    stateProvinceCode: string;
+    stateProvinceName: string;
+    regionCode: string;
+    regionName: string;
+    facilityWeightUnitOfMeasure: string;
+    facilityDimensionUnitOfMeasure: string;
+    facilityPrintIndicator: string;
+    effectiveDate: string;
+}

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

@@ -0,0 +1,57 @@
+import { Facility, ServiceArea } from './api-services.interfaces';
+export type ServiceAreaIn = {
+    countryCodes: string[];
+};
+export type ServiceAreasOut = {
+    serviceAreas: ServiceArea[];
+    total: number;
+};
+export type ValidateFacilityOut = {
+    facility: Facility;
+    transactionId: string;
+};
+export type ValidateFacilityIn = {
+    facilityIdentifier: string;
+};
+export type EmailErrorIn = {
+    transactionId: string;
+    details: string;
+    extraFields: {
+        [key: string]: string;
+    };
+};
+export type PromotionIn = {
+    code: string;
+    destinationCountryCode: string;
+    shipmentDatetime: string;
+    shipper: {
+        countryCode: string;
+        accountNumber: string;
+    };
+};
+export type PromotionOut = {
+    promotion: {
+        accountNumber: string;
+    };
+    transactionId: string;
+};
+export type ValidateNIPOut = {
+    nip: {
+        valid: string;
+        message: string;
+    };
+};
+export type ValidateNIPIn = {
+    accountValue: string;
+    nip: string;
+    user: number;
+};
+export type ValidateIdentificationBROut = {
+    identification: {
+        valid: boolean;
+    };
+};
+export type ValidateIdentificationBRIn = {
+    identification_number: string;
+    validate_state_tax: boolean;
+};

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/apis/models/api-shipments.interfaces.d.ts

@@ -0,0 +1,41 @@
+import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
+import { ShipmentContentType } from './api-catalog.interfaces';
+export interface ShipmentEmployeeCustomers extends ActiveLessSymfonyModel {
+    trackingNumber: string;
+    employeeCustomerId: number;
+    shipment: {
+        id: number;
+    } | null;
+}
+export interface ExportType extends SymfonyModel {
+    code: string;
+    name: string;
+}
+export interface DestinationCountry extends ActiveLessSymfonyModel {
+    code: string;
+    name: string;
+}
+export interface EmbassyShipment extends SymfonyModel {
+    id: number;
+    countryId: number;
+    name: string;
+    destinationCountry: DestinationCountry;
+    destinationCityName: string | null;
+    destinationPostalCode: string | null;
+    destinationCountyName: string | null;
+    contentDescription: string | null;
+    shipmentContentType: ShipmentContentType;
+    piecesNumber: number | null;
+    destinationCompanyName: string | null;
+    destinationFullName: string | null;
+    destinationAddressLine1: string | null;
+    destinationAddressLine2: string | null;
+    destinationAddressLine3: string | null;
+    destinationPhoneCode: string | null;
+    destinationPhoneNumber: string | null;
+    destinationEmail: string | null;
+    businessPartyTraderTypeId: number | null;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+}