@experteam-mx/ngx-services 18.2.0 → 18.3.1

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

@@ -1,4 +1,5 @@
-import { ChangeLanguageIn, CreateSessionIn, CreateSessionOut, GetUserOut, LoginIn, LoginOut, MeOut } from './models/api-security.types';
+import { QueryParams } from './models/api.models';
+import { ChangeLanguageIn, CreateSessionIn, CreateSessionOut, GetUserOut, LoginIn, LoginOut, MeOut, ModulePermissionsOut, RoleByIdOut, RolePermissionsIn, RoleTypesOut } from './models/api-security.types';
 import { HttpClient } from '@angular/common/http';
 import { Environment } from '../ngx-services.models';
 import { Observable } from 'rxjs';
@@ -74,6 +75,49 @@ export declare class ApiSecurityService {
      * @return {Observable<ApiSuccess<MeOut>>} An observable that emits the result of the language change request.
      */
     changeLanguage({ languageId }: ChangeLanguageIn): Observable<MeOut>;
+    /**
+     * Retrieves the role types from the API.
+     *
+     * @param {QueryParams} params - The query parameters to be sent with the request.
+     * @returns {Observable<RoleTypesOut>} An observable containing the role types output.
+     */
+    getRoleTypes(params: QueryParams): Observable<RoleTypesOut>;
+    /**
+     * Retrieves the permissions for a module.
+     *
+     * @param {QueryParams} params - The query parameters to be sent with the request.
+     * @returns {Observable<ModulePermissionsOut>} An observable containing the module permissions.
+     */
+    getPermissions(params: QueryParams): Observable<ModulePermissionsOut>;
+    /**
+     * Retrieves roles by the specified ID.
+     *
+     * @param params - The ID of the role to retrieve.
+     * @returns An Observable that emits the role data.
+     */
+    getRolesById(params: number): Observable<RoleByIdOut>;
+    /**
+     * Creates a new role with the specified permissions.
+     *
+     * @param {RolePermissionsIn} body - The permissions and details for the new role.
+     * @returns {Observable<ModulePermissionsOut>} An observable containing the created role's permissions.
+     */
+    createRole(body: RolePermissionsIn): Observable<ModulePermissionsOut>;
+    /**
+     * Updates the permissions of a specific role.
+     *
+     * @param id - The unique identifier of the role to update.
+     * @param body - The new permissions to assign to the role.
+     * @returns An Observable that emits the updated module permissions.
+     */
+    updateRolePermissions(id: number, body: RolePermissionsIn): Observable<ModulePermissionsOut>;
+    /**
+     * Deletes the permissions associated with a specific role.
+     *
+     * @param {number} id - The unique identifier of the role whose permissions are to be deleted.
+     * @returns {Observable<{}>} An observable that emits the result of the delete operation.
+     */
+    deleteRolePermissions(id: number): Observable<{}>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiSecurityService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiSecurityService>;
 }

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

@@ -0,0 +1,26 @@
+import { Environment } from '../ngx-services.models';
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { ValidateAccountIn, ValidateAccountOut } from './models/api-shipments.types';
+import * as i0 from "@angular/core";
+export declare class ApiShipmentsService {
+    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;
+    /**
+     * Retrieves the parameter values based on the provided parameter names.
+     *
+     * @param {ValidateAccountIn} body - An object of parameter names for which the values need to be fetched.
+     * @return {Observable<ValidateAccountIn>} An observable that emits the fetched parameter values
+     * @param body
+     */
+    validateAccount(body: ValidateAccountIn): Observable<ValidateAccountOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiShipmentsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiShipmentsService>;
+}

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

@@ -52,7 +52,7 @@ export interface CompanyCountryTax extends LaravelModel {
     tax_type: string;
 }
 export interface CountryCurrencyRate extends CountryReferenceCurrency {
-    rate: number;
+    rate: string;
 }
 export interface CountryReference extends LaravelModel {
     language_id: number;
@@ -106,9 +106,13 @@ export interface Exchange extends LaravelModel {
     company_country_currency_id: number;
     valid_since: string;
     valid_until: string | null;
-    value: number;
+    value: string;
     type: string;
 }
+export interface CountryExchange extends Exchange {
+    currency: Currency;
+    country_reference_currency: CountryReferenceCurrency;
+}
 export interface Installation extends LaravelModel {
     system_id: number;
     mac_address: string;
@@ -187,194 +191,3 @@ export interface Workflow {
     page: string;
     enabled: boolean;
 }
-export interface LocationEmployee extends LaravelModel {
-    location_id: number;
-    employee_id: number;
-    is_active: boolean;
-    is_supervisor: boolean;
-    employee: Employee;
-    location: Location;
-}
-export interface Employee extends LaravelModel {
-    name: string;
-    last_name: string;
-    number: string;
-    company_id: number;
-    country_id: number;
-    external: boolean;
-    phone_code: string;
-    phone_number: string;
-    is_active: boolean;
-    password: string;
-    roles: string[];
-    locations: Location[];
-}
-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;
-    address1: string;
-    address2: string;
-    address3: string;
-    service_area_code: string;
-    iata_code: string;
-    phone_code: string;
-    phone_number: string;
-    gmt_offset: string;
-    company_country_id: number;
-    country_zone_id: number;
-    country_region_id: number;
-    management_area_id: number;
-    google_maps_id: string;
-    route_number: string;
-    locker_enabled: boolean;
-    queue_manager_enabled: boolean;
-    commission_account: string;
-    service_point_id: string;
-    is_occurs: boolean;
-    accounts: Account[];
-    company_country: CompanyCountry;
-    state: State;
-}
-export interface Company extends LaravelModel {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    name: string;
-    contact_name: string;
-    contact_email: string;
-    contact_phone: string;
-    state: string;
-    city: string;
-    county_name: string;
-    zip_code: string;
-    address1: string;
-    address2: string;
-    address3: string;
-    is_active: boolean;
-}
-export interface CompanyCountry extends LaravelModel {
-    company_id: number;
-    country_id: number;
-    headquarters_city_code: string;
-    lp_code: string;
-    company: Company;
-    contact_name: string;
-    contact_email: string;
-    contact_phone_code: string;
-    contact_phone_number: string;
-    state: string;
-    city: string;
-    zip_code: string;
-    county_name: string;
-    address1: string;
-    address2: string;
-    address3: string;
-}
-export interface Installation extends LaravelModel {
-    system_id: number;
-    mac_address: string;
-    ip_address: string;
-    location_id: number;
-}
-export interface SupplyEntity extends LaravelModel {
-    name: string;
-    description: string;
-    country_id: number;
-    enabled_for_dropoff: boolean;
-    supply_type: SupplyType;
-    supply_packing: SupplyPacking;
-}
-export interface SupplyType extends LaravelModel {
-    name: string;
-}
-export interface SupplyPacking extends LaravelModel {
-    value: number;
-    weight: number;
-    height: number;
-    depth: number;
-    width: number;
-    emobile_code: string | null;
-}
-export interface Employee extends LaravelModel {
-    name: string;
-    last_name: string;
-    number: string;
-    company_id: number;
-    country_id: number;
-    external: boolean;
-    phone_code: string;
-    phone_number: string;
-    is_active: boolean;
-    password: string;
-    roles: string[];
-    locations: Location[];
-}
-export interface CountryReferenceCurrency extends LaravelModel {
-    country_id: number;
-    currency_id: number;
-    is_local: boolean;
-    can_transact: boolean;
-    code: string;
-    name: string;
-    is_default: boolean;
-    is_declared_insured: boolean;
-    currency: Currency;
-}
-export interface CompanyCountryTax extends LaravelModel {
-    code: string;
-    name: string;
-    percentage: number;
-    company_country_id: number;
-    shipment_scopes: number[];
-    base_percentage: number;
-    tax_type: string;
-}
-export interface Exchange extends LaravelModel {
-    company_country_currency_id: number;
-    valid_since: string;
-    valid_until: string | null;
-    value: number;
-    type: string;
-}
-export interface Parameter {
-    name: string;
-    value: any;
-    status?: string;
-}
-export interface CountryReference extends LaravelModel {
-    language_id: number;
-    decimal_point: number;
-    decimal_separator: string;
-    thousands_separator: string;
-    use_billing: boolean;
-    use_payments: boolean;
-    restricted_import_countries: number[];
-    currency_id: number;
-    max_quantity_document_piece: number;
-    max_quantity_package_piece: number;
-    weight_restriction_piece: number;
-    restriction_shipment: number;
-    restriction_dimension: number;
-    max_declared_value: number;
-    territories: number[];
-    some_openings: boolean;
-    locale: string;
-    country_id: number;
-    label_printer_name: string;
-    receipt_printer_name: string;
-    others_printer_name: string;
-}
-export interface Workflow {
-    page: string;
-    enabled: boolean;
-}

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

@@ -1,75 +1,83 @@
-import { Account, CompanyCountry, CompanyCountryTax, CountryReference, CountryReferenceCurrency, Employee, Exchange, Installation, Location, LocationEmployee, Parameter, SupplyEntity, Workflow } from './api-companies.interfaces';
-export type LocationEmployeesData = {
+import { Account, CompanyCountry, CompanyCountryTax, CountryExchange, CountryReference, CountryReferenceCurrency, Employee, Exchange, Installation, Location, LocationEmployee, Parameter, SupplyEntity, Workflow } from './api-companies.interfaces';
+export type LocationEmployeesOut = {
     location_employees: LocationEmployee[];
     total: number;
 };
-export type InstallationsData = {
+export type InstallationsOut = {
     installations: Installation[];
     total: number;
 };
-export type InstallationData = {
+export type InstallationOut = {
     installation: Installation;
 };
-export type LocationsData = {
+export type LocationsOut = {
     locations: Location[];
     total: number;
 };
-export type LocationData = {
+export type LocationOut = {
     location: Location;
 };
-export type SupplyEntitiesData = {
+export type SupplyEntitiesOut = {
     supply_entities: SupplyEntity[];
     total: number;
 };
-export type EmployeesData = {
+export type EmployeesOut = {
     employees: Employee[];
     total: number;
 };
-export type EmployeeData = {
+export type EmployeeOut = {
     employee: Employee;
 };
-export type CompanyCountriesData = {
+export type CompanyCountriesOut = {
     company_countries: CompanyCountry[];
     total: number;
 };
-export type CompanyCountryData = {
+export type CompanyCountryOut = {
     company_country: CompanyCountry;
 };
-export type CountryReferenceCurrenciesData = {
+export type CountryReferenceCurrenciesOut = {
     country_reference_currencies: CountryReferenceCurrency[];
     total: number;
 };
-export type CompanyCountryTaxesData = {
+export type CompanyCountryTaxesOut = {
     company_country_taxes: CompanyCountryTax[];
     total: number;
 };
-export type ExchangesData = {
+export type ExchangesOut = {
     exchanges: Exchange[];
     total: number;
 };
-export type AccountEntitiesData = {
+export type CountryExchangesData = {
+    exchanges: CountryExchange[];
+    total: number;
+};
+export type CountryExchangesOut = {
+    exchanges: CountryExchange[];
+    total: number;
+};
+export type AccountEntitiesOut = {
     account_entities: Account[];
     total: number;
 };
-export type ParametersProps = {
+export type ParametersIn = {
     paramNames: string[];
 };
-export type ParametersData = {
+export type ParametersOut = {
     parameters: Parameter[];
     total: number;
 };
-export type ParameterValueProps = {
+export type ParameterValueIn = {
     paramName: string;
 };
-export type ParameterValueData = {
+export type ParameterValueOut = {
     value: any;
 };
-export type CountryReferencesData = {
+export type CountryReferencesOut = {
     country_references: CountryReference[];
 };
-export type CountryReferenceData = {
+export type CountryReferenceOut = {
     country_reference: CountryReference;
 };
-export type WorkflowsData = {
+export type WorkflowsOut = {
     workflow: Workflow[];
 };

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

@@ -0,0 +1,139 @@
+import { LaravelModel } from './api.models';
+export interface Document extends LaravelModel {
+    id: number;
+    document_type_range_id: number;
+    document_number: number;
+    document_prefix: string;
+    document_suffix: string;
+    document_number_original: number;
+    document_prefix_original: string;
+    document_suffix_original: string;
+    customer_id: number;
+    customer_company_name: string;
+    customer_email: string;
+    customer_address_line1: string;
+    customer_identification_number: string;
+    customer_identification_type_id: number;
+    provider_name: string;
+    provider_identification_number: number;
+    document_authorization_number: string;
+    provider_extra_fields: {
+        phone: string;
+        fax: string;
+    };
+    document_id: number;
+    created_at: string;
+    updated_at: string;
+    transaction_id: string;
+    extra_fields: {
+        observation: string;
+        document_date: string;
+    };
+    customer_address_line2: string;
+    customer_address_line3: string;
+    customer_postal_code: string;
+    customer_state: string;
+    customer_county_name: string;
+    customer_city_name: string;
+    customer_country_id: number;
+    status: number;
+    user_id: number;
+    customer_full_name: string;
+    customer_phone_code: string;
+    customer_phone_number: string;
+    gmt_offset: string;
+    customer_type_id: number;
+    customer_extra_fields: string;
+    installation_id: number;
+    exchange: number;
+    authorization_numbers: string;
+    extra_fields_json: string;
+    provider_extra_fields_json: string;
+    document_type_range: DocumentTypeRange;
+    items: DocumentItem[];
+    document_payments: DocumentPayment[];
+    payments: Payment[];
+}
+export interface DocumentTypeRange extends LaravelModel {
+    id: number;
+    provider_id: number;
+    model_type: string;
+    model_id: number;
+    init_number: number;
+    final_number: number;
+    current_number: number;
+    used_numbers: number;
+    min_until_mail: number;
+    prefix: string;
+    sap_prefix: string;
+    suffix: string;
+    sap_suffix: string;
+    external_generated: boolean;
+    authorization_number: string;
+    environment: string;
+    is_manual: boolean;
+    auto_activation: boolean;
+    activation_key: string;
+    authorization_label: string;
+    valid_since: string;
+    valid_until: string;
+    created_at: string;
+    updated_at: string;
+    is_active: boolean;
+    country_document_type_id: number;
+}
+export interface DocumentItem extends LaravelModel {
+    id: number;
+    document_id: number;
+    details: {
+        account: number;
+        country_reference_currency_id: number;
+        customer_company_name: string;
+    };
+    model_origin: string;
+    model_type: string;
+    model_id: number;
+    quantity: number;
+    unit_price: number;
+    subtotal: number;
+    tax_detail: {};
+    total: number;
+    created_at: string;
+    updated_at: string;
+    discount: 0;
+    details_json: string;
+}
+export interface DocumentPayment extends LaravelModel {
+    id: number;
+    document_id: number;
+    payment_id: number;
+    amount: number;
+    created_at: string;
+    updated_at: string;
+    payment: Payment;
+}
+export interface Payment extends LaravelModel {
+    id: number;
+    amount: number;
+    country_reference_currency_id: number;
+    exchange: number;
+    company_country_payment_type_id: number;
+    due_date: string;
+    received: number;
+    status: number;
+    details: {};
+    created_at: string;
+    updated_at: string;
+    transaction_id: string;
+    gmt_offset: string;
+    country_payment_type_id: number;
+    opening_id: number;
+    installation_id: number;
+    details_json: {};
+    payment_adjustment: {};
+    pivot: {
+        document_id: number;
+        payment_id: number;
+        amount: number;
+    };
+}

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

@@ -0,0 +1,44 @@
+import { Document } from './api-invoices.interfaces';
+export interface AccountPaymentOperationIn {
+    document_type_range_id: number | null;
+    document_number: string | null;
+    observation: string | null;
+    document_date: string | null;
+    total_amount: number;
+    country_reference_currency_id: number;
+    customer: {
+        company_name: string;
+        full_name: string;
+        account_number: string;
+        country_id: number;
+    };
+    payments: AccountPayment[];
+}
+export type AccountPayment = {
+    country_payment_type_id: number;
+    country_reference_currency_id: number;
+    amount: number;
+    exchange: string;
+    due_date: string;
+    received: number;
+    status?: boolean;
+    details?: {};
+};
+export interface AccountPaymentOperationOut {
+    document: Document;
+    transaction_id: string;
+}
+export type CollectionReceiptOut = {
+    collection_receipt: string;
+};
+export type CancelPaymentReceiptIn = {
+    document_id: number;
+    is_canceled_invoice: boolean;
+    cancellation_reason_id: number;
+};
+export type CancelBillingIn = {
+    invoiceId: number;
+    cancellation_reason_id: number;
+    cancel_payment: boolean;
+    send_shipments: boolean;
+};

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

@@ -0,0 +1,47 @@
+import { 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: DocumentType;
+    document_category_id: number;
+    document_category: DocumentCategory;
+    collection_origin: string;
+    collection_type: string;
+    receipt_number: string;
+    customer_name: string;
+    account: string;
+    amount: number;
+    currency_id: number;
+    currency_code: string;
+}
+export interface DocumentType extends LaravelModel {
+    _id: number;
+    name: string;
+    code: string;
+    movement_type: number;
+    local_code: string;
+    translations: Translations;
+}
+export interface DocumentCategory extends LaravelModel {
+    _id: number;
+    name: string;
+    is_electronic: true;
+    taxable: number;
+    created_at: string;
+    updated_at: string;
+    translations: Translations;
+}

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

@@ -0,0 +1,6 @@
+import { LaravelModel } from './api.models';
+import { CollectionPayment } from './api-reports.interfaces';
+export interface CollectionPaymentsOut extends LaravelModel {
+    collection_payments: CollectionPayment[];
+    total: number;
+}

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

@@ -1,5 +1,6 @@
 import { LaravelModel } from './api.models';
 import { Language } from './api-catalog.interfaces';
+import { Pivot } from './api-security.types';
 export interface Session extends LaravelModel {
     name: string;
     username: string;
@@ -20,13 +21,13 @@ export interface Session extends LaravelModel {
     session: Session;
 }
 export interface Role extends LaravelModel {
-    code: string;
     name: string;
     guard_name: string;
-    permissions: Permission[];
+    company_country_id: number;
     role_type_id: number;
+    regional_country_id: number | null;
     role_type: RoleType;
-    company_country_id: number;
+    permissions: Permission[];
 }
 export interface RoleType extends LaravelModel {
     name: string;
@@ -35,10 +36,9 @@ export interface RoleType extends LaravelModel {
 export interface Permission extends LaravelModel {
     name: string;
     guard_name: string;
-    pivot: {
-        role_id: number;
-        permission_id: number;
-    };
+    description: string;
+    is_default: boolean;
+    pivot: Pivot;
 }
 export interface User extends LaravelModel {
     name: string;
@@ -53,3 +53,14 @@ export interface User extends LaravelModel {
     session: Session;
     language: Language;
 }
+export interface Module extends LaravelModel {
+    name: string;
+    code: string;
+    module_type_id: number;
+    module_type: ModuleType;
+    permissions: Permission[];
+}
+export interface ModuleType extends LaravelModel {
+    name: string;
+    description: string;
+}