@experteam-mx/ngx-services 16.1.1 → 18.0.0

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

@@ -1,79 +1,79 @@
-import { ChangeLanguageIn, CreateSessionIn, CreateSessionOut, GetUserOut, LoginIn, LoginOut, MeOut } from './models/api-security.types';
-import { HttpClient } from '@angular/common/http';
-import { Environment } from '../ngx-services.models';
-import { Observable } from 'rxjs';
-import { CookieService } from 'ngx-cookie-service';
-import * as i0 from "@angular/core";
-export declare class ApiSecurityService {
-    private environments;
-    private http;
-    private cookie;
-    constructor(environments: Environment, http: HttpClient, cookie: CookieService);
-    /**
-     * Retrieves the API security URL from the environments configuration.
-     *
-     * @return {string} The API security URL.
-     */
-    get url(): string;
-    /**
-     * Authenticates a user with the provided credentials and role.
-     *
-     * @param {Object} param0 - The login input object.
-     * @param {string} param0.username - The username of the user.
-     * @param {string} param0.password - The password of the user.
-     * @param {string} param0.role - The role of the user.
-     * @return {Observable<LoginOut>} An observable emitting the login output object.
-     */
-    login({ username, password, role, }: LoginIn): Observable<LoginOut>;
-    /**
-     * Logs out the current user by making a POST request to the logout endpoint.
-     *
-     * This method deletes all cookies after a successful logout.
-     *
-     * @return {Observable<{}>} An observable that emits the server's response to the logout request.
-     */
-    logout(): Observable<{}>;
-    /**
-     * Creates a new session for a specified model.
-     *
-     * @param {Object} params - The parameters for creating the session.
-     * @param {string} params.modelType - The type of the model.
-     * @param {string} params.modelId - The ID of the model.
-     * @param {string} [params.token] - Optional authorization token.
-     *
-     * @return {Observable<CreateSessionOut>} An observable containing the created session details.
-     */
-    createSession({ modelType, modelId, token, }: CreateSessionIn): Observable<CreateSessionOut>;
-    /**
-     * Fetches the authenticated user's information.
-     * Sends a GET request to the endpoint '/auth/me' to retrieve information
-     * about the currently authenticated user.
-     *
-     * @return {Observable<MeOut>} An observable that emits the authenticated user's data.
-     */
-    me(): Observable<MeOut>;
-    /**
-     * Fetches the authenticated user's details from the server.
-     *
-     * @param token The JWT token used for authorization.
-     * @return An Observable that emits the user's details encapsulated in a MeOut object.
-     */
-    otherMe(token: string): Observable<MeOut>;
-    /**
-     * Fetches a user by their unique ID.
-     *
-     * @param {number} id - The unique identifier of the user to be fetched.
-     * @return {Observable<GetUserOut>} An observable containing the user information.
-     */
-    user(id: number): Observable<GetUserOut>;
-    /**
-     * Changes the language for the authenticated user.
-     *
-     * @param {Object} params - The input parameters for changing the language.
-     * @param {string} params.languageId - The ID of the new language to be set.
-     * @return {Observable<ApiSuccess<MeOut>>} An observable that emits the result of the language change request.
-     */
-    changeLanguage({ languageId }: ChangeLanguageIn): Observable<MeOut>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ApiSecurityService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ApiSecurityService>;
-}
+import { ChangeLanguageIn, CreateSessionIn, CreateSessionOut, GetUserOut, LoginIn, LoginOut, MeOut } from './models/api-security.types';
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { Observable } from 'rxjs';
+import { CookieService } from 'ngx-cookie-service';
+import * as i0 from "@angular/core";
+export declare class ApiSecurityService {
+    private environments;
+    private cookie;
+    private http;
+    constructor(environments: Environment, cookie: CookieService, http: HttpClient);
+    /**
+     * Retrieves the API security URL from the environments configuration.
+     *
+     * @return {string} The API security URL.
+     */
+    get url(): string;
+    /**
+     * Authenticates a user with the provided credentials and role.
+     *
+     * @param {Object} param0 - The login input object.
+     * @param {string} param0.username - The username of the user.
+     * @param {string} param0.password - The password of the user.
+     * @param {string} param0.role - The role of the user.
+     * @return {Observable<LoginOut>} An observable emitting the login output object.
+     */
+    login({ username, password, role, }: LoginIn): Observable<LoginOut>;
+    /**
+     * Logs out the current user by making a POST request to the logout endpoint.
+     *
+     * This method deletes all cookies after a successful logout.
+     *
+     * @return {Observable<{}>} An observable that emits the server's response to the logout request.
+     */
+    logout(): Observable<{}>;
+    /**
+     * Creates a new session for a specified model.
+     *
+     * @param {Object} params - The parameters for creating the session.
+     * @param {string} params.modelType - The type of the model.
+     * @param {string} params.modelId - The ID of the model.
+     * @param {string} [params.token] - Optional authorization token.
+     *
+     * @return {Observable<CreateSessionOut>} An observable containing the created session details.
+     */
+    createSession({ modelType, modelId, token, }: CreateSessionIn): Observable<CreateSessionOut>;
+    /**
+     * Fetches the authenticated user's information.
+     * Sends a GET request to the endpoint '/auth/me' to retrieve information
+     * about the currently authenticated user.
+     *
+     * @return {Observable<MeOut>} An observable that emits the authenticated user's data.
+     */
+    me(): Observable<MeOut>;
+    /**
+     * Fetches the authenticated user's details from the server.
+     *
+     * @param token The JWT token used for authorization.
+     * @return An Observable that emits the user's details encapsulated in a MeOut object.
+     */
+    otherMe(token: string): Observable<MeOut>;
+    /**
+     * Fetches a user by their unique ID.
+     *
+     * @param {number} id - The unique identifier of the user to be fetched.
+     * @return {Observable<GetUserOut>} An observable containing the user information.
+     */
+    user(id: number): Observable<GetUserOut>;
+    /**
+     * Changes the language for the authenticated user.
+     *
+     * @param {Object} params - The input parameters for changing the language.
+     * @param {string} params.languageId - The ID of the new language to be set.
+     * @return {Observable<ApiSuccess<MeOut>>} An observable that emits the result of the language change request.
+     */
+    changeLanguage({ languageId }: ChangeLanguageIn): Observable<MeOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiSecurityService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiSecurityService>;
+}

package/lib/apis/models/{api-catalogs.interfaces.d.ts → api-catalog.interfaces.d.ts}

@@ -1,75 +1,71 @@
-import { SymfonyModel } from './api.models';
-export interface Country extends SymfonyModel {
-    name: string;
-    code: string;
-    codeAndName: string;
-    isoCode: string;
-    codePhone: string;
-    locale: string;
-    locationType: LocationType;
-    unit: Unit;
-    timezone: string;
-    hasImportService: boolean;
-    phoneDigits: number;
-    locationTypeFields: LocationTypeFields;
-    postalCodeSuffixRegex: string;
-    decimalPoint: 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;
-    decimal_separator: string;
-    thousands_separator: string;
-    label_printer_name: string;
-    receipt_printer_name: string;
-    others_printer_name: string;
-    territories: number[];
-    use_billing?: boolean;
-}
-export interface LocationType extends SymfonyModel {
-    code: string;
-    name: string;
-    priority: number;
-}
-export interface Unit extends SymfonyModel {
-    name: string;
-    weight: string;
-    dimension: string;
-}
-export interface LocationTypeFields {
-    city: City;
-    postalCode: PostalCode;
-    suburb: Suburb;
-}
-export interface City {
-    enabled: boolean;
-    required: boolean;
-}
-export interface PostalCode {
-    enabled: boolean;
-    required: boolean;
-}
-export interface Suburb {
-    enabled: boolean;
-    required: boolean;
-}
-export interface Language extends SymfonyModel {
-    code: string;
-    name: string;
-}
-export interface State extends SymfonyModel {
-    country: Country;
-    code: string;
-    name: string;
-}
-export interface Currency extends SymfonyModel {
-    code: string;
-    name: string;
-    symbol: string;
-}
-export interface Language extends SymfonyModel {
-    code: string;
-    name: string;
-}
+import { SymfonyModel } from './api.models';
+export interface Country extends SymfonyModel {
+    name: string;
+    code: string;
+    codeAndName: string;
+    isoCode: string;
+    codePhone: string;
+    locale: string;
+    locationType: LocationType;
+    unit: Unit;
+    timezone: string;
+    hasImportService: boolean;
+    phoneDigits: number;
+    locationTypeFields: LocationTypeFields;
+    postalCodeSuffixRegex: string;
+    decimalPoint: 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;
+    decimal_separator: string;
+    thousands_separator: string;
+    label_printer_name: string;
+    receipt_printer_name: string;
+    others_printer_name: string;
+    territories: number[];
+    use_billing?: boolean;
+}
+export interface LocationType extends SymfonyModel {
+    code: string;
+    name: string;
+    priority: number;
+}
+export interface Unit extends SymfonyModel {
+    name: string;
+    weight: string;
+    dimension: string;
+}
+export interface LocationTypeFields {
+    city: City;
+    postalCode: PostalCode;
+    suburb: Suburb;
+}
+export interface City {
+    enabled: boolean;
+    required: boolean;
+}
+export interface PostalCode {
+    enabled: boolean;
+    required: boolean;
+}
+export interface Suburb {
+    enabled: boolean;
+    required: boolean;
+}
+export interface Language extends SymfonyModel {
+    code: string;
+    name: string;
+}
+export interface State extends SymfonyModel {
+    country: Country;
+    code: string;
+    name: string;
+}
+export interface Currency extends SymfonyModel {
+    code: string;
+    name: string;
+    symbol: string;
+}