@experteam-mx/ngx-services 18.5.7 → 18.5.8

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

@@ -0,0 +1,134 @@
+import { Environment } from '../ngx-services.models';
+import { HttpClient } from '@angular/common/http';
+import { QueryParams } from './models/api.models';
+import { Observable } from 'rxjs';
+import { CheckpointEventReasonsOut, CheckpointsOut, IncidentIn, IncidentOut, IncidentReasonComplementIn, IncidentReasonComplementOut, IncidentReasonComplementsOut, IncidentReasonIn, IncidentReasonOut, IncidentReasonsOut, IncidentsOut } from './models/api-inventories.types';
+import * as i0 from "@angular/core";
+export declare class ApiInventoriesService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the Inventories API from the environment configurations.
+     *
+     * @return {string} The URL of the Inventories API.
+     */
+    get url(): string;
+    /**
+     * Retrieves a list of checkpoints based on query parameters.
+     *
+     * @param {QueryParams} params - Query parameters for filtering the checkpoints.
+     * @returns {Observable<CheckpointsOut>} The list of checkpoints.
+     */
+    getCheckpoints(params: QueryParams): Observable<CheckpointsOut>;
+    /**
+     * Retrieves a list of checkpoint event reasons based on query parameters.
+     *
+     * @param {QueryParams} params - Query parameters for filtering the checkpoint event reasons.
+     * @returns {Observable<CheckpointEventReasonsOut>} The list of checkpoint event reasons.
+     */
+    getCheckpointEventReasons(params: QueryParams): Observable<CheckpointEventReasonsOut>;
+    /**
+     * Retrieves a list of incidents based on query parameters.
+     *
+     * @param {QueryParams} params - Query parameters for filtering the incidents.
+     * @returns {Observable<IncidentsOut>} An observable that emits the list of incidents.
+     */
+    getIncidents(params: QueryParams): Observable<IncidentsOut>;
+    /**
+     * Fetches the incident details based on the provided incident ID.
+     *
+     * @param {number} id - The identifier of the incident record to get detail.
+     * @return {Observable<IncidentOut>} An observable that emits the detail incident data.
+     */
+    getIncident(id: Number): Observable<IncidentOut>;
+    /**
+     * Creates a new incident.
+     *
+     * @param {IncidentIn} body - The data for the new incident.
+     * @returns {Observable<IncidentOut>} An observable the created incident detail.
+     */
+    postIncident(body: IncidentIn): Observable<IncidentOut>;
+    /**
+     * Updates an existing incident.
+     *
+     * @param {number} id - The identifier of the incident record to update.
+     * @param {IncidentIn} body - The incident data to be updated.
+     * @returns {Observable<IncidentOut>} An observable detail of the updated incident.
+     */
+    putIncident(id: Number, body: IncidentIn): Observable<IncidentOut>;
+    /**
+     * Delete an existing incident.
+     *
+     * @param {number} id - The unique identifier of the incident to be deleted.
+     * @returns {Observable<IncidentOut>} An observable that emits the result of the delete incident.
+     */
+    deleteIncident(id: Number): Observable<IncidentOut>;
+    /**
+     * Retrieves a list of incident reasons based on query parameters.
+     *
+     * @param {QueryParams} params - Query parameters for filtering the incident reasons.
+     * @returns {Observable<IncidentReasonsOut>} An observable that emits the list of incident reasons.
+     */
+    getIncidentReasons(params: QueryParams): Observable<IncidentReasonsOut>;
+    /**
+     * Fetches the incident reason details based on the provided incident reason ID.
+     *
+     * @param {number} id - The identifier of the incident reason record to get detail.
+     * @return {Observable<IncidentReasonOut>} An observable that emits the detail incident reason data.
+     */
+    getIncidentReason(id: Number): Observable<IncidentReasonOut>;
+    /**
+     * Creates a new incident reason.
+     *
+     * @param {IncidentReasonIn} body - The data for the new incident reason.
+     * @returns {Observable<IncidentReasonOut>} An observable the created incident reason detail.
+     */
+    postIncidentReason(body: IncidentReasonIn): Observable<IncidentReasonOut>;
+    /**
+     * Updates an existing incident reason.
+     *
+     * @param {number} id - The identifier of the incident reason record to update.
+     * @param {IncidentIn} body - The incident reason data to be updated.
+     * @returns {Observable<IncidentReasonOut>} An observable detail of the updated incident reason.
+     */
+    putIncidentReason(id: Number, body: IncidentReasonIn): Observable<IncidentReasonOut>;
+    /**
+     * Delete an existing incident reason.
+     *
+     * @param {number} id - The unique identifier of the incident reason to be deleted.
+     * @returns {Observable<IncidentReasonOut>} An observable that emits the result of the delete incident reason.
+     */
+    deleteIncidentReason(id: Number): Observable<IncidentReasonOut>;
+    /**
+     * Retrieves a list of incident reason complements based on query parameters.
+     *
+     * @param {QueryParams} params - Query parameters for filtering the incident reason complements.
+     * @returns {Observable<IncidentReasonComplementsOut>} An observable that emits the list of incident reason complements.
+     */
+    getIncidentReasonComplements(params: QueryParams): Observable<IncidentReasonComplementsOut>;
+    /**
+     * Creates a new incident reason complement.
+     *
+     * @param {IncidentReasonIn} body - The data for the new incident reason complement.
+     * @returns {Observable<IncidentReasonComplementOut>} An observable the created incident reason complement detail.
+     */
+    postIncidentReasonComplement(body: IncidentReasonComplementIn): Observable<IncidentReasonComplementOut>;
+    /**
+     * Updates an existing incident reason complement.
+     *
+     * @param {number} id - The identifier of the incident reason complement record to update.
+     * @param {IncidentIn} body - The incident reason complement data to be updated.
+     * @returns {Observable<IncidentReasonComplementOut>} An observable detail of the updated incident reason complement.
+     */
+    putIncidentReasonComplement(id: Number, body: IncidentReasonComplementIn): Observable<IncidentReasonComplementOut>;
+    /**
+     * Delete an existing incident reason complement.
+     *
+     * @param {number} id - The unique identifier of the incident reason complement to be deleted.
+     * @returns {Observable<IncidentReasonComplementOut>} An observable that emits the result of the delete incident reason complement.
+     */
+    deleteIncidentReasonComplement(id: Number): Observable<IncidentReasonComplementOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiInventoriesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiInventoriesService>;
+}

package/lib/apis/models/api-inventories.enum.d.ts

@@ -0,0 +1,18 @@
+export declare enum Event {
+    damage = "damage",
+    lost = "lost",
+    rejected = "rejected",
+    return = "return "
+}
+export declare enum DefaultValueType {
+    payment_type = "payment_type",
+    currency_code = "currency_code",
+    destination = "destination",
+    payment_amount = "payment_amount"
+}
+export declare enum AlphaNumeric {
+    alpha_numeric = "alpha_numeric",
+    numeric = "numeric",
+    alphabetic = "alphabetic",
+    amount = "amount"
+}

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

@@ -0,0 +1,40 @@
+import { AlphaNumeric, DefaultValueType, Event } from './api-inventories.enum';
+import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
+export interface Checkpoint extends ActiveLessSymfonyModel {
+    code: string;
+    name: string;
+    event: Event;
+    isFinisher: boolean;
+}
+export interface CheckpointEventReason extends ActiveLessSymfonyModel {
+    code: string;
+    name: string;
+    extraFields: {
+        [key: string]: string;
+    };
+    checkpoint: Checkpoint | null;
+}
+export interface Incident extends SymfonyModel {
+    checkpoint: Checkpoint | null;
+    countryId: string;
+    event: Event;
+    name: string;
+    isFinisher: boolean;
+}
+export interface IncidentReason extends SymfonyModel {
+    checkpointEventReason: CheckpointEventReason | null;
+    description: string;
+    incident: Incident | null;
+    isDefaultChecking: boolean;
+    name: string;
+}
+export interface IncidentReasonComplement extends SymfonyModel {
+    alphaNumeric: AlphaNumeric | null;
+    eventReasonCodeKey: string;
+    description: string;
+    defaultValueType: DefaultValueType | null;
+    incidentReason: IncidentReason;
+    maxLength: number;
+    name: string;
+    readOnly: boolean;
+}

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

@@ -0,0 +1,56 @@
+import { AlphaNumeric, DefaultValueType, Event } from './api-inventories.enum';
+import { CheckpointEventReason, Checkpoint, Incident, IncidentReason, IncidentReasonComplement } from './api-inventories.interfaces';
+export type CheckpointsOut = {
+    total: number;
+    checkpoints: Checkpoint[];
+};
+export type CheckpointEventReasonsOut = {
+    total: number;
+    checkpointEventReasons: CheckpointEventReason[];
+};
+export type IncidentsOut = {
+    total: number;
+    incidents: Incident[];
+};
+export type IncidentOut = {
+    incident: Incident;
+};
+export type IncidentIn = {
+    checkpointId: Number | null;
+    countryId: string;
+    name: string;
+    isActive: boolean;
+    event: Event | null;
+};
+export type IncidentReasonsOut = {
+    total: number;
+    incidentReasons: IncidentReason[];
+};
+export type IncidentReasonOut = {
+    incidentReason: IncidentReason;
+};
+export type IncidentReasonIn = {
+    checkpointEventReasonId?: number;
+    description: string;
+    incidentId?: number;
+    isActive: boolean;
+    name: string;
+};
+export type IncidentReasonComplementsOut = {
+    total: number;
+    incidentReasonComplements: IncidentReasonComplement[];
+};
+export type IncidentReasonComplementOut = {
+    incidentReasonComplement: IncidentReasonComplement;
+};
+export type IncidentReasonComplementIn = {
+    alphaNumeric?: AlphaNumeric;
+    eventReasonCodeKey: string;
+    description: string;
+    defaultValueType?: DefaultValueType;
+    incidentReasonId?: Number;
+    maxLength: number;
+    name: string;
+    readOnly?: boolean;
+    isActive?: boolean;
+};

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

@@ -23,6 +23,7 @@ export type Environment = {
     apiEToolsAutoBilling?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;
+    apiInventoriesUrl?: string;
     apiInvoicesUrl?: string;
     apiOpenItemsUrl?: string;
     apiReportsUrl?: string;

package/package.json

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

package/public-api.d.ts

@@ -7,6 +7,7 @@ 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-inventories.service';
 export * from './lib/apis/api-invoices.service';
 export * from './lib/apis/api-open-items.service';
 export * from './lib/apis/api-reports.service';
@@ -22,6 +23,9 @@ 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-inventories.interfaces';
+export * from './lib/apis/models/api-inventories.enum';
+export * from './lib/apis/models/api-inventories.types';
 export * from './lib/apis/models/api-invoices.interfaces';
 export * from './lib/apis/models/api-invoices.types';
 export * from './lib/apis/models/api-open-items.interfaces';