@experteam-mx/ngx-services 18.8.23 → 18.8.24

package/lib/apis/api-external-ops.service.d.ts

@@ -0,0 +1,54 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { Environment } from '../ngx-services.models';
+import { DeliveryConfirmationCompleteIn, DeliveryConfirmationGenerateIn, DeliveryConfirmationGenerateOut, DeliveryConfirmationIn, DeliveryConfirmationSearchOut } from './models/api-external-ops.types';
+import * as i0 from "@angular/core";
+export declare class ApiExternalOperationsService {
+    private http;
+    private environment;
+    private appKey;
+    constructor(http: HttpClient, environment: Environment);
+    /**
+     * Getter method to retrieve the API's external operations URL.
+     * Fetches the URL from the `apiExternalOperationsUrl` property of the environment object.
+     * Defaults to an empty string if the property is undefined or null.
+     *
+     * @return {string} The external operations URL or an empty string if unavailable.
+     */
+    get url(): string;
+    /**
+     * Retrieves delivery confirmation details based on the provided OTP code.
+     *
+     * @param {string} otpCode - The OTP code used to search for delivery confirmation.
+     * @return {Observable<DeliveryConfirmationData>} An observable containing the delivery confirmation data.
+     */
+    getDeliveryConfirmation(otpCode: string): Observable<DeliveryConfirmationSearchOut>;
+    /**
+     * Generates a delivery confirmation by sending the provided payload to the API.
+     *
+     * @param {DeliveryConfirmationGenerateIn} payload - The input payload required to generate the delivery confirmation.
+     * @return {Observable<DeliveryConfirmationGenerateOut>} An observable that emits the generated delivery confirmation data.
+     */
+    postDeliveryConfirmationGenerate(payload: DeliveryConfirmationGenerateIn): Observable<DeliveryConfirmationGenerateOut>;
+    /**
+     * Confirms the completion of a delivery operation by making a PATCH request.
+     *
+     * @param {Object} input - The input parameters for the method.
+     * @param {string} input.operationId - The unique identifier of the delivery operation to be confirmed.
+     * @param {string} input.keyOTP - The one-time password (OTP) key associated with the delivery confirmation.
+     * @return {Observable<Object>} - An observable containing the response data from the API.
+     */
+    patchDeliveryConfirmationComplete({ keyOTP, operationId, }: DeliveryConfirmationCompleteIn): Observable<{}>;
+    /**
+     * Cancels a delivery confirmation by sending an OTP and additional data to the server.
+     *
+     * @param {Object} param0 - The parameter object containing the required properties.
+     * @param {string} param0.otp - The one-time password to authenticate the cancellation request.
+     * @param {Object} param0.body - Additional body data required for cancellation.
+     * @return {Observable<Object>} An observable that emits the server's response when the cancellation is processed.
+     */
+    putDeliveryConfirmation({ otp, ...body }: DeliveryConfirmationIn): Observable<{}>;
+    private getAppKeyHeader;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiExternalOperationsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiExternalOperationsService>;
+}

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

@@ -0,0 +1,65 @@
+import { Environment } from '../ngx-services.models';
+import { HttpClient } from '@angular/common/http';
+import { QueryParams } from './models/api.models';
+import { Observable } from 'rxjs';
+import { QuoteEventIn, QuoteEventOut, QuoteEventsOut, QuoteEventTypesOut } from './models/api-quote.types';
+import * as i0 from "@angular/core";
+/**
+ * Service to manage quote-related events.
+ *
+ * This service provides methods to retrieve, create, and get event types
+ * related to quote processes.
+ */
+export declare class ApiQuoteService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Base URL for the Quotes API.
+     */
+    get url(): string;
+    /**
+     * Retrieves all registered events for a specific quote.
+     *
+     * @param id - Quote identifier.
+     * @param params - Optional query parameters such as pagination or filtering.
+     * @returns Observable containing the list of quote events.
+     *
+     * @example
+     * ```ts
+     * this.apiQuoteService.getQuoteEvents(10, { page: 1 })
+     *   .subscribe((events) => console.log(events))
+     * ```
+     */
+    getQuoteEvents(id: number, params: QueryParams): Observable<QuoteEventsOut>;
+    /**
+     * Registers a new event related to a specific quote.
+     *
+     * @param id - Quote identifier.
+     * @param body - Event payload to be created.
+     * @returns Observable containing the newly created event.
+     *
+     * @example
+     * ```ts
+     * const event: QuoteEventIn = { code: 'WON', note: 'Client approved' }
+     * this.apiQuoteService.postQuoteEvents(10, event)
+     *   .subscribe((response) => console.log(response))
+     * ```
+     */
+    postQuoteEvents(id: number, body: QuoteEventIn): Observable<QuoteEventOut>;
+    /**
+     * Retrieves the available quote event types.
+     *
+     * @param params - Optional query parameters such as pagination or filtering.
+     * @returns Observable containing the list of event types.
+     *
+     * @example
+     * ```ts
+     * this.apiQuoteService.getQuoteEventTypes({ page: 1 })
+     *   .subscribe((types) => console.log(types))
+     * ```
+     */
+    getQuoteEventTypes(params: QueryParams): Observable<QuoteEventTypesOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiQuoteService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiQuoteService>;
+}

package/lib/apis/models/api-external-ops.interfaces.d.ts

@@ -0,0 +1,21 @@
+import { LaravelModel } from './api.models';
+export interface Operation extends LaravelModel {
+    _id: string;
+    operation_id: number;
+    status: 'Pending' | 'Completed' | 'Canceled';
+    code: number;
+    signature: {
+        signature_base_64: string;
+        mime_type: 'image/png';
+        client: {
+            full_name: string;
+        };
+        package_detail: {
+            shipment_tracking_number: string;
+            pieces: {
+                tracking_number: string;
+                status: null | 'damaged' | 'lost';
+            }[];
+        }[];
+    };
+}

package/lib/apis/models/api-external-ops.types.d.ts

@@ -0,0 +1,35 @@
+import { Operation } from './api-external-ops.interfaces';
+export type DeliveryConfirmationGenerateOut = {
+    code: string;
+};
+export type DeliveryConfirmationGenerateIn = {
+    operation_id: number;
+    signature: {
+        client: {
+            full_name: string;
+        };
+        package_detail: {
+            shipment_tracking_number: string;
+            pieces: {
+                tracking_number: string;
+                status: string;
+            }[];
+        }[];
+    };
+};
+export type DeliveryConfirmationCompleteIn = {
+    operationId: number;
+    keyOTP: string;
+};
+export type DeliveryConfirmationIn = {
+    signature: {
+        status: string;
+        operation_id: number;
+        signature_base_64: string;
+        mime_type: string;
+    };
+    otp?: string;
+};
+export type DeliveryConfirmationSearchOut = {
+    operation: Operation;
+};

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

@@ -0,0 +1,13 @@
+import { ActiveLessSymfonyModel, SymfonyModel } from './api.models';
+export interface QuoteEvent extends ActiveLessSymfonyModel {
+    date: string;
+    quoteEventType: QuoteEventType;
+    comment: string;
+    userId: number;
+    userUsername: string;
+    userName: string;
+}
+export interface QuoteEventType extends SymfonyModel {
+    code: string;
+    name: string;
+}

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

@@ -0,0 +1,17 @@
+import { QuoteEvent, QuoteEventType } from './api-quote.interfaces';
+export type QuoteEventsOut = {
+    total: number;
+    quoteEvents: QuoteEvent[];
+};
+export type QuoteEventIn = {
+    date: string;
+    quoteEventTypeId: number;
+    comment: string;
+};
+export interface QuoteEventOut {
+    quoteEvent: QuoteEvent;
+}
+export interface QuoteEventTypesOut {
+    total: number;
+    quoteEventTypes: QuoteEventType[];
+}

package/lib/interceptors/api-key.interceptor.d.ts

@@ -0,0 +1,35 @@
+import { HttpEvent, HttpHandlerFn, HttpRequest } from '@angular/common/http';
+import { Observable } from 'rxjs';
+/**
+ * HTTP interceptor that injects the external operations API key into outbound requests.
+ *
+ * The interceptor:
+ * 1. Reads `apiExternalOperationsKey` from the injected `ENVIRONMENT_TOKEN`.
+ * 2. Skips modification if the key is absent.
+ * 3. Leaves the request unchanged if it already contains an `AppKey` header (caller override).
+ * 4. Otherwise clones the request adding `AppKey: apiExternalOperationsKey`.
+ *
+ * This enables centralized, transparent authentication for services targeting external
+ * operations endpoints while allowing explicit per-request overrides.
+ *
+ * Example:
+ * ```ts
+ * provideHttpClient(
+ *   withInterceptors([apiKeyInterceptor])
+ * );
+ * ```
+ *
+ * @param request The original immutable `HttpRequest` instance.
+ * @param next The next handler in the interceptor chain, used to forward the (possibly cloned) request.
+ * @returns An `Observable` stream of the HTTP events for the (potentially augmented) request.
+ *
+ * @remarks
+ * - If you need to intentionally send a different key for a specific request, set the `AppKey`
+ *   header manually before this interceptor runs.
+ * - If `apiExternalOperationsKey` is undefined (e.g., missing configuration), the request is passed through unchanged.
+ * - Order matters: place this interceptor before others that rely on the presence of the `AppKey` header.
+ *
+ * @see HttpRequest
+ * @see HttpHandlerFn
+ */
+export declare function apiKeyInterceptor(request: HttpRequest<unknown>, next: HttpHandlerFn): Observable<HttpEvent<unknown>>;

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

@@ -27,14 +27,15 @@ export type Environment = {
     apiCompositionUrl?: string;
     apiCustomsUrl?: string;
     apiDiscountsUrl?: string;
-    apiEventsUrl?: string;
     apiEToolsAutoBilling?: string;
+    apiEventsUrl?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;
     apiInventoriesUrl?: string;
     apiInvoicesUrl?: string;
     apiNotificationsUrl?: string;
     apiOpenItemsUrl?: string;
+    apiQuotesUrl?: string;
     apiReportsUrl?: string;
     apiSecurityUrl?: string;
     apiServicesUrl?: string;

package/package.json

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

package/public-api.d.ts

@@ -11,13 +11,14 @@ export * from './lib/apis/api-companies.service';
 export * from './lib/apis/api-composition.service';
 export * from './lib/apis/api-customs.service';
 export * from './lib/apis/api-discounts.service';
-export * from './lib/apis/api-events.service';
 export * from './lib/apis/api-e-tools-auto-billing.service';
+export * from './lib/apis/api-events.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-notifications.service';
 export * from './lib/apis/api-open-items.service';
+export * from './lib/apis/api-quote.service';
 export * from './lib/apis/api-reports.service';
 export * from './lib/apis/api-security.service';
 export * from './lib/apis/api-services.service';
@@ -60,6 +61,8 @@ export * from './lib/apis/models/api-notifications.interfaces';
 export * from './lib/apis/models/api-notifications.types';
 export * from './lib/apis/models/api-open-items.interfaces';
 export * from './lib/apis/models/api-open-items.types';
+export * from './lib/apis/models/api-quote.interfaces';
+export * from './lib/apis/models/api-quote.types';
 export * from './lib/apis/models/api-reports.interfaces';
 export * from './lib/apis/models/api-reports.types';
 export * from './lib/apis/models/api-security.interfaces';