@experteam-mx/ngx-services 18.5.4 → 18.5.6

package/fesm2022/experteam-mx-ngx-services.mjs

@@ -250,6 +250,315 @@ class ApiCatalogsService {
             params
         }).pipe(map(({ data }) => data));
     }
+    /**
+     * Submits an extra charge request to the server and returns the created extra charge details.
+     *
+     * @param {ExtraChargeIn} body - The data for the extra charge to be created.
+     * @return {Observable<ExtraChargeOut>} An observable that emits the details of the created extra charge.
+     */
+    postExtraCharge(body) {
+        return this.http.post(`${this.url}/extracharges`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates an extra charge entity with new data and returns the updated entity.
+     *
+     * @param {number} id - The unique identifier of the extra charge to update.
+     * @param {ExtraChargeIn} body - The new data for the extra charge.
+     * @return {Observable<ExtraChargeOut>} An observable emitting the updated extra charge entity.
+     */
+    putExtraCharge(id, body) {
+        return this.http.put(`${this.url}/extracharges/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches a list of countries from the API.
+     *
+     * @param {QueryParams} params - The query parameters to be passed to the API request.
+     * @return {Observable<CountriesOut>} An observable containing the list of countries.
+     */
+    getCountries(params) {
+        return this.http.get(`${this.url}/countries`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves the details of a country based on its ID.
+     *
+     * @param {number} id - The identifier of the country to fetch.
+     * @return {Observable<CountryOut>} An observable that emits the country data.
+     */
+    getCountry(id) {
+        return this.http.get(`${this.url}/countries/${id}`)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates the details of a specific country by its ID.
+     *
+     * @param {number} id - The unique identifier of the country to be updated.
+     * @param {CountryIn} body - The data to update the country with.
+     * @return {Observable<CountryOut>} An observable that emits the updated country data.
+     */
+    putCountry(id, body) {
+        return this.http.put(`${this.url}/countries/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches postal location details based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter and fetch postal location data.
+     * @return {Observable<PostalLocationsOut>} An observable that emits the postal location details.
+     */
+    getPostalLocations(params) {
+        return this.http.get(`${this.url}/postal-locations`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches a list of regions based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter the regions.
+     * @return {Observable<RegionsOut>} An observable that emits the list of regions.
+     */
+    getRegions(params) {
+        return this.http.get(`${this.url}/regions`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches the zones data based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter the zones data.
+     * @return {Observable<ZonesOut>} An observable that emits the fetched zones data.
+     */
+    getZones(params) {
+        return this.http.get(`${this.url}/zones`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches the management areas based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the management areas.
+     * @return {Observable<ManagementAreasOut>} An observable that emits the management areas data.
+     */
+    getManagementAreas(params) {
+        return this.http.get(`${this.url}/management-areas`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves cancellation reasons from the server based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the cancellation reasons.
+     * @return {Observable<CancellationReasonsOut>} An observable containing the retrieved cancellation reasons.
+     */
+    getCancellationReasons(params) {
+        return this.http.get(`${this.url}/cancellation-reasons`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a cancellation reason to the server.
+     *
+     * @param {CancellationReasonIn} body - The cancellation reason object to be sent.
+     * @return {Observable<CancellationReasonOut>} An observable containing the server's response with the processed cancellation reason.
+     */
+    postCancellationReason(body) {
+        return this.http.post(`${this.url}/cancellation-reasons`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates the cancellation reason for the specified ID with the provided data.
+     *
+     * @param {number} id - The unique identifier of the cancellation reason to update.
+     * @param {CancellationReasonIn} body - The details of the cancellation reason to be updated.
+     * @return {Observable<CancellationReasonOut>} An observable containing the updated cancellation reason.
+     */
+    putCancellationReason(id, body) {
+        return this.http.put(`${this.url}/cancellation-reasons/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves a list of currencies based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to customize the currency retrieval request.
+     * @return {Observable<CurrenciesOut>} An observable that emits the retrieved currencies data.
+     */
+    getCurrencies(params) {
+        return this.http.get(`${this.url}/currencies`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches the list of available languages based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to pass with the HTTP request.
+     * @return {Observable<LanguagesOut>} An observable that emits the available languages.
+     */
+    getLanguages(params) {
+        return this.http.get(`${this.url}/languages`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches the available units from the API based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the units being fetched.
+     * @return {Observable<UnitsOut>} An observable that emits the retrieved units data.
+     */
+    getUnits(params) {
+        return this.http.get(`${this.url}/units`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves the shipment scopes based on the provided query parameters.
+     *
+     * @param {QueryParams} params The query parameters to filter or modify the request for shipment scopes.
+     * @return {Observable<ShipmentScopesOut>} An observable that emits the shipment scopes data.
+     */
+    getShipmentScopes(params) {
+        return this.http.get(`${this.url}/shipment-scopes`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches the available shipment content types based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the shipment content types.
+     * @return {Observable<ShipmentContentTypesOut>} An observable that emits the shipment content types data.
+     */
+    getShipmentContentTypes(params) {
+        return this.http.get(`${this.url}/shipment-content-types`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Fetches a list of generic folios based on the given query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter the generic folios.
+     * @return {Observable<GenericFoliosOut>} An observable containing the fetched generic folios.
+     */
+    getGenericFolios(params) {
+        return this.http.get(`${this.url}/generic-folios`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a POST request to create or update a generic folio.
+     *
+     * @param {GenericFolioIn} body - The payload containing the details of the generic folio to be created or updated.
+     * @return {Observable<GenericFolioOut>} An observable containing the response data of the created or updated generic folio.
+     */
+    postGenericFolio(body) {
+        return this.http.post(`${this.url}/generic-folios`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates a generic folio with the specified ID using the provided data.
+     *
+     * @param {number} id - The unique identifier of the generic folio to update.
+     * @param {GenericFolioIn} body - The data to update the generic folio with.
+     * @return {Observable<GenericFolioOut>} An observable containing the updated generic folio.
+     */
+    putGenericFolio(id, body) {
+        return this.http.put(`${this.url}/generic-folios/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a PUT request to update a Generic Folio resource with the specified ID and body data, and returns the updated resource.
+     *
+     * @param {number} id - The unique identifier of the Generic Folio to be updated.
+     * @param {Partial<GenericFolioIn>} body - The partial data representing the changes to be applied to the Generic Folio.
+     * @return {Observable<GenericFolioOut>} An observable containing the updated Generic Folio resource.
+     */
+    pathGenericFolio(id, body) {
+        return this.http.put(`${this.url}/generic-folios/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a POST request to create a new product.
+     *
+     * @param {ProductIn} body - The product data to be sent in the request body.
+     * @return {Observable<ProductOut>} An observable emitting the created product data.
+     */
+    postProduct(body) {
+        return this.http.post(`${this.url}/products`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates an existing product with the given ID using the provided data.
+     *
+     * @param {number} id - The unique identifier of the product to update.
+     * @param {ProductIn} body - The product data to update.
+     * @return {Observable<ProductOut>} An observable containing the updated product data.
+     */
+    putProduct(id, body) {
+        return this.http.put(`${this.url}/products/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves a list of shipment income types based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the shipment income types.
+     * @return {Observable<ShipmentIncomeTypesOut>} An observable containing the shipment income types data.
+     */
+    getShipmentIncomeTypes(params) {
+        return this.http.get(`${this.url}/shipment-income-types`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a POST request to create a new shipment income type.
+     *
+     * @param {ShipmentIncomeTypeIn} body The payload containing the details of the shipment income type to be created.
+     * @return {Observable<ShipmentIncomeTypeOut>} An observable that emits the created shipment income type data.
+     */
+    postShipmentIncomeType(body) {
+        return this.http.post(`${this.url}/shipment-income-types`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates the shipment income type with the specified ID.
+     *
+     * @param {number} id - The identifier of the shipment income type to update.
+     * @param {ShipmentIncomeTypeIn} body - The data to update the shipment income type with.
+     * @return {Observable<ShipmentIncomeTypeOut>} An observable emitting the updated shipment income type.
+     */
+    putShipmentIncomeType(id, body) {
+        return this.http.put(`${this.url}/shipment-income-types/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Retrieves a list of unique folios based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter and fetch unique folios.
+     * @return {Observable<UniqueFoliosOut>} An observable that emits the unique folios data.
+     */
+    getUniqueFolios(params) {
+        return this.http.get(`${this.url}/unique-folios`, { params })
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Sends a POST request to create a unique folio.
+     *
+     * @param {UniqueFolioIn} body - The data object containing details for the unique folio to be created.
+     * @return {Observable<UniqueFolioOut>} An observable that emits the created unique folio details.
+     */
+    postUniqueFolio(body) {
+        return this.http.post(`${this.url}/unique-folios`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates a unique folio with the given data using the provided ID.
+     *
+     * @param {number} id - The ID of the unique folio to be updated.
+     * @param {UniqueFolioIn} body - The payload containing the details of the unique folio to update.
+     * @return {Observable<UniqueFolioOut>} An observable that emits the updated unique folio.
+     */
+    putUniqueFolio(id, body) {
+        return this.http.put(`${this.url}/unique-folios/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
+    /**
+     * Updates a unique folio by its identifier with the provided data.
+     *
+     * @param {number} id - The identifier of the unique folio to update.
+     * @param {Partial<UniqueFolioIn>} body - The partial data of the unique folio to update.
+     * @return {Observable<UniqueFolioOut>} An observable emitting the updated unique folio data.
+     */
+    pathUniqueFolio(id, body) {
+        return this.http.put(`${this.url}/unique-folios/${id}`, body)
+            .pipe(map(({ data }) => data));
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: ApiCatalogsService, deps: [{ token: 'env' }, { token: i1.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: ApiCatalogsService, providedIn: 'root' });
 }
@@ -1033,6 +1342,17 @@ class ApiReportsService {
         return this.http.get(`${this.url}/external-shipments-report`, { params })
             .pipe(map(({ data }) => data));
     }
+    /**
+     * Retrieves a report of promotion code discounts based on the provided query parameters.
+     *
+     * @param {QueryParams} params - An object representing the query parameters for filtering the promotion code discounts report.
+     * @return {Observable<PromotionCodeDiscountsOut>} An observable that emits the promotion code discounts report data.
+     */
+    getPromotionCodeDiscounts(params) {
+        return this.http.get(`${this.url}/promotion-code-discounts`, {
+            params
+        }).pipe(map(({ data }) => data));
+    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: ApiReportsService, deps: [{ token: 'env' }, { token: i1.HttpClient }], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.13", ngImport: i0, type: ApiReportsService, providedIn: 'root' });
 }