@experteam-mx/ngx-services 18.7.29 → 18.7.31

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

@@ -2,7 +2,7 @@ import { Environment } from '../ngx-services.models';
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { QueryParams } from './models/api.models';
-import { CancellationReasonIn, CancellationReasonOut, CancellationReasonsOut, CountriesOut, CountryIn, CountryOut, CurrenciesOut, ExtraChargeIn, ExtraChargeOut, ExtraChargesOut, GenericFolioIn, GenericFolioOut, GenericFoliosOut, IdentificationTypesOut, LanguagesOut, ManagementAreasOut, OperationTypesOut, PostalLocationsOut, ProductIn, ProductOut, RegionsOut, ShipmentContentTypesOut, ShipmentGroupsOut, ShipmentIncomeTypeIn, ShipmentIncomeTypeOut, ShipmentIncomeTypesOut, ShipmentScopesOut, ShipmentStatusesOut, UniqueFolioIn, UniqueFolioOut, UniqueFoliosOut, UnitsOut, ZonesOut } from './models/api-catalog.types';
+import { CancellationReasonIn, CancellationReasonOut, CancellationReasonsOut, CountriesOut, CountryIn, CountryOut, CurrenciesOut, ExtraChargeIn, ExtraChargeOut, ExtraChargesOut, GenericFolioIn, GenericFolioOut, GenericFoliosOut, IdentificationTypesOut, LanguagesOut, ManagementAreasOut, OperationTypesOut, PostalLocationsOut, ProductIn, ProductOut, QuestionIn, QuestionOut, QuestionsOut, RegionsOut, ShipmentContentTypesOut, ShipmentGroupsOut, ShipmentIncomeTypeIn, ShipmentIncomeTypeOut, ShipmentIncomeTypesOut, ShipmentScopesOut, ShipmentStatusesOut, UniqueFolioIn, UniqueFolioOut, UniqueFoliosOut, UnitsOut, ZonesOut } from './models/api-catalog.types';
 import * as i0 from "@angular/core";
 export declare class ApiCatalogsService {
     private environments;
@@ -268,6 +268,65 @@ export declare class ApiCatalogsService {
      * @returns An Observable that emits the shipment statuses output.
      */
     getShipmentStatuses(params: QueryParams): Observable<ShipmentStatusesOut>;
+    /**
+     * Fetches questions from the catalogs API.
+     *
+     * Sends an HTTP GET request to `${this.url}/questions` using the supplied query parameters
+     * and returns the unwrapped payload (`data`) from the API response.
+     *
+     * @param params - Query parameters to include in the request (e.g. paging, filters, sorting).
+     * @returns An Observable that emits the QuestionsOut payload (the `data` field from ApiSuccess<QuestionsOut>).
+     */
+    getQuestions(params: QueryParams): Observable<QuestionsOut>;
+    /**
+     * Retrieve a single question by its id.
+     *
+     * Sends an HTTP GET request to the questions endpoint and returns an Observable that emits
+     * the QuestionOut payload extracted from the API success envelope.
+     *
+     * @param id - The numeric identifier of the question to fetch.
+     * @returns An Observable that emits the requested QuestionOut. The Observable will error
+     *          if the HTTP request fails (for example network issues or non-2xx responses).
+     */
+    getQuestion(id: number): Observable<QuestionOut>;
+    /**
+     * Sends a POST request to create a new question and returns the created resource.
+     *
+     * The request payload is sent as an object with a `body` property containing the provided
+     * QuestionIn value (i.e. { body: QuestionIn }). On success the HTTP response is expected
+     * to follow the ApiSuccess<T> shape; the operator maps that response to the inner `data`
+     * object and emits it as a QuestionOut.
+     *
+     * @param body - The question payload to create (QuestionIn).
+     * @returns Observable<QuestionOut> that emits the created question on success.
+     */
+    postQuestion(body: QuestionIn): Observable<QuestionOut>;
+    /**
+     * Update a question by its ID.
+     *
+     * Sends an HTTP PUT to `${this.url}/questions/${id}` with the provided payload.
+     * The request body is sent as an object with a `body` property containing the
+     * `QuestionIn` data. The server response is expected to be an `ApiSuccess<QuestionOut>`
+     * and this method returns an Observable that emits the unwrapped `QuestionOut`.
+     *
+     * @param id - The identifier of the question to update.
+     * @param body - The update payload for the question.
+     * @returns An Observable that emits the updated `QuestionOut` on success.
+     */
+    putQuestion(id: number, body: QuestionIn): Observable<QuestionOut>;
+    /**
+     * Deletes a question by its ID.
+     *
+     * Sends an HTTP DELETE request to the backend endpoint `/questions/{id}` and
+     * returns an Observable that emits the API response's `data` payload (typically an empty object).
+     *
+     * The implementation maps an ApiSuccess wrapper to its `data` property before emitting.
+     *
+     * @param id - The numeric identifier of the question to delete.
+     * @returns An Observable that emits the deleted resource payload ({} expected) on success.
+     *          The Observable will emit an error if the HTTP request fails.
+     */
+    deleteQuestion(id: number): Observable<{}>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiCatalogsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiCatalogsService>;
 }

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

@@ -1,7 +1,7 @@
 import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { Environment } from '../ngx-services.models';
-import { CancelPaymentReceiptIn, CountryPaymentTypeFieldIn, CountryPaymentTypeFieldOut, CountryPaymentTypeFieldsOut, CountryPaymentTypeIn, CountryPaymentTypeOut, CountryPaymentTypesOut, CustomerDocumentTypesOut, CustomersOut, CustomerTypesOut, OperationAccountPaymentIn, OperationAccountPaymentOut, OperationCancelBillingIn, OperationCancelBillingOut, OperationDocumentIn, OperationDocumentOut, OperationDocumentRequestsOut, OperationPrintDocumentOut, OperationShipmentExternalIn, OperationShipmentExternalOut, PaymentTypeFieldAccountIn, PaymentTypeFieldAccountOut, PaymentTypeFieldAccountsOut, PaymentTypeFieldCardTypeIn, PaymentTypeFieldCardTypeOut, PaymentTypeFieldCardTypesOut, PaymentTypesOut, PrintCollectionReceiptOut, ToleranceIn, ToleranceOut, TolerancesOut } from './models/api-invoices.types';
+import { CancelPaymentReceiptIn, CountryPaymentTypeFieldIn, CountryPaymentTypeFieldOut, CountryPaymentTypeFieldsOut, CountryPaymentTypeIn, CountryPaymentTypeOut, CountryPaymentTypesOut, CustomerDocumentTypesOut, CustomersOut, CustomerTypesOut, GetDocumentsOut, OperationAccountPaymentIn, OperationAccountPaymentOut, OperationCancelBillingIn, OperationCancelBillingOut, OperationDocumentIn, OperationDocumentOut, OperationDocumentRequestsOut, OperationPrintDocumentOut, OperationShipmentExternalIn, OperationShipmentExternalOut, PaymentTypeFieldAccountIn, PaymentTypeFieldAccountOut, PaymentTypeFieldAccountsOut, PaymentTypeFieldCardTypeIn, PaymentTypeFieldCardTypeOut, PaymentTypeFieldCardTypesOut, PaymentTypesOut, PrintCollectionReceiptOut, ToleranceIn, ToleranceOut, TolerancesOut } from './models/api-invoices.types';
 import { QueryParams } from './models/api.models';
 import * as i0 from "@angular/core";
 export declare class ApiInvoicesService {
@@ -247,6 +247,13 @@ export declare class ApiInvoicesService {
      * @returns An observable that emits the document requests data.
      */
     getOperationDocumentRequests(id: number): Observable<OperationDocumentRequestsOut>;
+    /**
+     * Retrieves a list of documents based on the provided query parameters.
+     *
+     * @param params - The query parameters to filter and paginate the documents
+     * @returns An Observable that emits the documents data when the HTTP request completes
+     */
+    getDocuments(params: QueryParams): Observable<GetDocumentsOut>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiInvoicesService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiInvoicesService>;
 }

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

@@ -197,3 +197,10 @@ export interface ShipmentStatus extends SymfonyModel {
     code: string;
     description: string;
 }
+export interface Question extends SymfonyModel {
+    description: string;
+    type: string;
+    questionOrder: number;
+    countryId: number;
+    isRequiredValue: boolean;
+}

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

@@ -1,4 +1,4 @@
-import { CancellationReason, Country, Currency, ExtraCharge, GenericFolio, IdentificationType, Language, ManagementArea, OperationType, PostalLocation, Product, Region, ShipmentContentType, ShipmentGroup, ShipmentIncomeType, ShipmentScope, ShipmentStatus, UniqueFolio, Unit, Zone } from './api-catalog.interfaces';
+import { CancellationReason, Country, Currency, ExtraCharge, GenericFolio, IdentificationType, Language, ManagementArea, OperationType, PostalLocation, Product, Question, Region, ShipmentContentType, ShipmentGroup, ShipmentIncomeType, ShipmentScope, ShipmentStatus, UniqueFolio, Unit, Zone } from './api-catalog.interfaces';
 export type OperationTypesOut = {
     total: number;
     operationTypes: OperationType[];
@@ -163,3 +163,18 @@ export type ShipmentStatusesOut = {
     shipmentStatuses: ShipmentStatus[];
     total: number;
 };
+export type QuestionsOut = {
+    questions: Question[];
+    total: number;
+};
+export type QuestionOut = {
+    question: Question;
+};
+export type QuestionIn = {
+    description: string;
+    type: 'marketing';
+    questionOrder: number;
+    isActive: boolean;
+    countryId: number;
+    isRequiredValue: boolean;
+};

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

@@ -182,3 +182,7 @@ export type ToleranceOut = {
 export type OperationDocumentRequestsOut = {
     requests: DocumentRequests[];
 };
+export type GetDocumentsOut = {
+    documents: Document[];
+    total: number;
+};

package/package.json

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