@experteam-mx/ngx-services 18.7.8 → 18.7.10

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

@@ -0,0 +1,152 @@
+import { HttpClient } from '@angular/common/http';
+import { Environment } from '../ngx-services.models';
+import { Observable } from 'rxjs';
+import { QueryParams } from './models/api.models';
+import { CustomerRestrictionIn, CustomerRestrictionOut, CustomerRestrictionsOut, DiscountIn, DiscountOut, DiscountsOut, LoyaltyPeriodIn, LoyaltyPeriodOut, LoyaltyPeriodsOut, LoyaltyRuleIn, LoyaltyRuleOut, LoyaltyRulesOut, OperationsLoadTopCustomerV2In, TopCustomersOut } from './models/api-discounts.types';
+import * as i0 from "@angular/core";
+export declare class ApiDiscountsService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the shipments API from the environment configurations.
+     *
+     * @return {string} The URL of the shipments API.
+     */
+    get url(): string;
+    /**
+     * Fetches available discounts based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters used to filter and retrieve discounts.
+     * @return {Observable<DiscountsOut>} An Observable that emits the retrieved discounts data.
+     */
+    getDiscounts(params: QueryParams): Observable<DiscountsOut>;
+    /**
+     * Sends a request to create or update discounts on the server.
+     *
+     * @param {DiscountIn} body - The discount information to be submitted.
+     * @return {Observable<DiscountOut>} An Observable emitting the server's response containing the created or updated discount details.
+     */
+    postDiscounts(body: DiscountIn): Observable<DiscountOut>;
+    /**
+     * Updates the discount information for a specific item.
+     *
+     * @param {number} id - The unique identifier of the item whose discount is to be updated.
+     * @param {DiscountIn} body - The payload containing the updated discount details.
+     * @return {Observable<DiscountOut>} An observable emitting the updated discount details.
+     */
+    putDiscounts(id: number, body: DiscountIn): Observable<DiscountOut>;
+    /**
+     * Retrieves the top customers based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter and sort the top customers.
+     * @return {Observable<TopCustomersOut>} An observable emitting the list of top customers.
+     */
+    getTopCustomers(params: QueryParams): Observable<TopCustomersOut>;
+    /**
+     * Sends a POST request to load the top customer data in the system, using the provided input.
+     * Transforms the API response to extract the data field containing the discount information.
+     *
+     * @param {OperationsLoadTopCustomerV2In} body - The input payload containing the company country ID and the file.
+     * @param {number} body.company_country_id - The ID of the company's country.
+     * @param {File} body.file - The file containing data to be processed.
+     * @return {Observable<DiscountOut>} An observable containing the discount output information.
+     */
+    postOperationsLoadTopCustomerV2(body: OperationsLoadTopCustomerV2In): Observable<{}>;
+    /**
+     * Fetches the loyalty periods based on the provided query parameters.
+     *
+     * @param {QueryParams} params - An object containing query parameters to filter the periods.
+     * @return {Observable<LoyaltyPeriodsOut>} An observable that emits the fetched loyalty periods.
+     */
+    getLoyaltyPeriods(params: QueryParams): Observable<LoyaltyPeriodsOut>;
+    /**
+     * Retrieves the loyalty period details for the given ID.
+     *
+     * @param {number} id - The unique identifier of the loyalty period to retrieve.
+     * @return {Observable<LoyaltyPeriodOut>} An observable emitting the loyalty period details.
+     */
+    getLoyaltyPeriod(id: number): Observable<LoyaltyPeriodOut>;
+    /**
+     * Sends a PUT request to update the loyalty period with the provided data.
+     *
+     * @param {LoyaltyPeriodIn} body - The data for the loyalty period to be updated.
+     * @return {Observable<LoyaltyPeriodOut>} An observable that emits the updated loyalty period data.
+     */
+    postLoyaltyPeriod(body: LoyaltyPeriodIn): Observable<LoyaltyPeriodOut>;
+    /**
+     * Updates the loyalty period for a specified ID with the provided data.
+     *
+     * @param {number} id - The unique identifier of the loyalty period to update.
+     * @param {LoyaltyPeriodIn} body - An object containing the updated details of the loyalty period.
+     * @return {Observable<LoyaltyPeriodOut>} An observable that emits the updated loyalty period details.
+     */
+    putLoyaltyPeriod(id: number, body: LoyaltyPeriodIn): Observable<LoyaltyPeriodOut>;
+    /**
+     * Retrieves the loyalty rules based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter the loyalty rules.
+     * @return {Observable<LoyaltyRulesOut>} An observable containing the loyalty rules output.
+     */
+    getLoyaltyRules(params: QueryParams): Observable<LoyaltyRulesOut>;
+    /**
+     * Retrieves a specific loyalty rule based on the provided ID.
+     *
+     * @param {number} id - The unique identifier of the loyalty rule to retrieve.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the details of the specified loyalty rule.
+     */
+    getLoyaltyRule(id: number): Observable<LoyaltyRuleOut>;
+    /**
+     * Sends a request to add or update a loyalty rule.
+     *
+     * @param {LoyaltyRuleIn} body - The loyalty rule data to be sent to the server.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the updated loyalty rule details.
+     */
+    postLoyaltyRule(body: LoyaltyRuleIn): Observable<LoyaltyRuleOut>;
+    /**
+     * Updates an existing loyalty rule with the provided data.
+     *
+     * @param {number} id - The unique identifier of the loyalty rule to update.
+     * @param {LoyaltyRuleIn} body - The data to update the loyalty rule with.
+     * @return {Observable<LoyaltyRuleOut>} An observable that emits the updated loyalty rule.
+     */
+    putLoyaltyRule(id: number, body: LoyaltyRuleIn): Observable<LoyaltyRuleOut>;
+    /**
+     * Fetches customer restrictions based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The query parameters to filter customer restrictions.
+     * @return {Observable<CustomerRestrictionsOut>} An observable that emits the customer restrictions data.
+     */
+    getCustomerRestrictions(params: QueryParams): Observable<CustomerRestrictionsOut>;
+    /**
+     * Retrieves customer restriction details for a given customer ID.
+     *
+     * @param {number} id - The unique identifier of the customer.
+     * @return {Observable<CustomerRestrictionOut>} An observable containing the customer restriction details.
+     */
+    getCustomerRestriction(id: number): Observable<CustomerRestrictionOut>;
+    /**
+     * Sends a request to apply a restriction to a customer.
+     *
+     * @param {CustomerRestrictionIn} body - The restriction details to be applied to the customer.
+     * @return {Observable<CustomerRestrictionOut>} An observable containing the response with the applied customer restriction.
+     */
+    postCustomerRestriction(body: CustomerRestrictionIn): Observable<CustomerRestrictionOut>;
+    /**
+     * Updates customer restrictions using the provided ID and data.
+     *
+     * @param {number} id - The unique identifier of the customer restriction to be updated.
+     * @param {LoyaltyRuleIn} body - The data object containing the customer restriction details to be updated.
+     * @return {Observable<CustomerRestrictionOut>} An observable emitting the updated customer restriction details.
+     */
+    putCustomerRestriction(id: number, body: CustomerRestrictionIn): Observable<CustomerRestrictionOut>;
+    /**
+     * Deletes a customer restriction by its ID.
+     *
+     * @param {number} id - The unique identifier of the customer restriction to delete.
+     * @return {Observable<{}>} An Observable that emits the result of the deletion operation.
+     */
+    deleteCustomerRestriction(id: number): Observable<{}>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiDiscountsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiDiscountsService>;
+}

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, OperationPrintDocumentOut, OperationShipmentExternalIn, OperationShipmentExternalOut, PaymentTypeFieldAccountIn, PaymentTypeFieldAccountOut, PaymentTypeFieldAccountsOut, PaymentTypeFieldCardTypeIn, PaymentTypeFieldCardTypeOut, PaymentTypeFieldCardTypesOut, PaymentTypesOut, PrintCollectionReceiptOut } from './models/api-invoices.types';
+import { CancelPaymentReceiptIn, CountryPaymentTypeFieldIn, CountryPaymentTypeFieldOut, CountryPaymentTypeFieldsOut, CountryPaymentTypeIn, CountryPaymentTypeOut, CountryPaymentTypesOut, CustomerDocumentTypesOut, CustomersOut, CustomerTypesOut, OperationAccountPaymentIn, OperationAccountPaymentOut, OperationCancelBillingIn, OperationCancelBillingOut, OperationDocumentIn, OperationDocumentOut, 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 {
@@ -204,6 +204,42 @@ export declare class ApiInvoicesService {
      * @returns {Observable<PaymentTypeFieldAccountOut>} An observable that emits the result of the update operation.
      */
     putCountryPaymentTypeFieldAccount(id: number, body: PaymentTypeFieldAccountIn): Observable<PaymentTypeFieldAccountOut>;
+    /**
+     * Fetches tolerance data from the server based on the provided query parameters.
+     *
+     * @param {QueryParams} params - The parameters to use for querying tolerances.
+     * @return {Observable<TolerancesOut>} An observable emitting the tolerance data.
+     */
+    getTolerances(params: QueryParams): Observable<TolerancesOut>;
+    /**
+     * Retrieves the tolerance detail for a given identifier.
+     *
+     * @param {number} id - The unique identifier for the tolerance to retrieve.
+     * @return {Observable<ToleranceOut>} An observable containing the tolerance data.
+     */
+    getTolerance(id: number): Observable<ToleranceOut>;
+    /**
+     * Sends a request to update or create a tolerance record using the provided data.
+     *
+     * @param {ToleranceIn} body - The tolerance input object containing the data to be sent in the request.
+     * @return {Observable<ToleranceOut>} An observable that emits the updated or created tolerance output object.
+     */
+    postTolerance(body: ToleranceIn): Observable<ToleranceOut>;
+    /**
+     * Updates the tolerance with the specified ID using the provided data.
+     *
+     * @param {number} id - The unique identifier of the tolerance to update.
+     * @param {ToleranceIn} body - The data to update the tolerance with.
+     * @return {Observable<ToleranceOut>} An observable containing the updated tolerance information.
+     */
+    putTolerance(id: number, body: ToleranceIn): Observable<ToleranceOut>;
+    /**
+     * Deletes the tolerance entry corresponding to the given ID.
+     *
+     * @param {number} id - The unique identifier of the tolerance to be deleted.
+     * @return {Observable<{}>} An Observable that emits the result of the delete operation.
+     */
+    deleteTolerance(id: number): Observable<{}>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ApiInvoicesService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ApiInvoicesService>;
 }

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

@@ -0,0 +1,74 @@
+import { ActiveLessLaravelModel, LaravelModel } from './api.models';
+import { IdentificationType } from './api-catalog.interfaces';
+export interface Discount extends LaravelModel {
+    code: string;
+    company_country_id: number;
+    name: string;
+    description: string | null;
+    account_number: string;
+    percentage: string;
+    start_date: string;
+    end_date: string | null;
+    start_weight: number;
+    end_weight: number | null;
+    shipment_scopes: number[];
+    country_reference_products: number[];
+    applies_to_all_locations: boolean;
+    locations: number[] | null;
+    reference_required: boolean;
+    reference_restriction: boolean | null;
+    reference_restriction_period: number | null;
+    reference_restriction_amount: number | null;
+    reference_restriction_message: string | null;
+    shipment_scope_names: string;
+    applies_to_all_locations_langs: {
+        [key: string]: string;
+    };
+    reference_required_langs: {
+        [key: string]: string;
+    };
+    status_langs: {
+        [key: string]: string;
+    };
+    applies_to_all_locations_lang: string | null;
+    reference_required_lang: string | null;
+    status_lang: string | null;
+}
+export interface TopCustomer extends ActiveLessLaravelModel {
+    identification_type_id: number;
+    identification_number: string;
+    contact_name_1: string;
+    contact_name_2: string;
+    contact_name_3: string;
+    email: string;
+    phone_number: string;
+    discount_percentage: string;
+    account: string | null;
+    shipment_scopes: string | null;
+    company_country_id: number;
+    company_name: string | null;
+    level: string | null;
+}
+export interface LoyaltyPeriod extends LaravelModel {
+    company_country_id: number;
+    days: number;
+    shipment_scopes: number[];
+    products: string[];
+}
+export interface LoyaltyRule extends LaravelModel {
+    name: string;
+    loyalty_period_id: number;
+    min_quantity: number;
+    max_quantity: number;
+    discount_percentage: number;
+    account: string;
+    products: string[];
+    valid_since: string;
+    valid_until: string;
+}
+export interface CustomerRestriction extends ActiveLessLaravelModel {
+    identification_type_id: number;
+    identification_number: string;
+    company_country_id: number;
+    identificationType: IdentificationType;
+}

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

@@ -0,0 +1,83 @@
+import { CustomerRestriction, Discount, LoyaltyPeriod, LoyaltyRule, TopCustomer } from './api-discounts.interfaces';
+export type DiscountIn = {
+    code: string;
+    company_country_id: number;
+    name: string;
+    description: string;
+    account_number: string;
+    percentage: number;
+    start_date: string;
+    end_date: string;
+    start_weight: number;
+    end_weight: number;
+    shipment_scopes: number[];
+    country_reference_products: number[];
+    applies_to_all_locations: boolean;
+    locations: number[];
+    reference_required: boolean;
+    reference_restriction: boolean;
+    reference_restriction_period: number;
+    reference_restriction_amount: number;
+    reference_restriction_message: string;
+    is_active: boolean;
+};
+export type DiscountOut = {
+    discount: Discount;
+};
+export type DiscountsOut = {
+    discounts: Discount[];
+    total: number;
+};
+export type TopCustomersOut = {
+    top_customers: TopCustomer[];
+    total: number;
+};
+export type OperationsLoadTopCustomerV2In = {
+    company_country_id: number;
+    file: File;
+};
+export type LoyaltyPeriodsOut = {
+    loyalty_periods: LoyaltyPeriod[];
+    total: number;
+};
+export type LoyaltyPeriodIn = {
+    company_country_id: number;
+    days: number;
+    shipment_scopes: number[];
+    products: string[];
+    is_active: boolean;
+};
+export type LoyaltyPeriodOut = {
+    loyalty_period: LoyaltyPeriod;
+};
+export type LoyaltyRulesOut = {
+    loyalty_rules: LoyaltyRule[];
+    total: number;
+};
+export type LoyaltyRuleIn = {
+    name: string;
+    loyalty_period_id: number;
+    min_quantity: number;
+    max_quantity: number;
+    discount_percentage: number;
+    products: string[];
+    account: string;
+    valid_since: string;
+    valid_until: string;
+    is_active: boolean;
+};
+export type LoyaltyRuleOut = {
+    loyalty_rule: LoyaltyRule;
+};
+export type CustomerRestrictionsOut = {
+    customer_restrictions: CustomerRestriction[];
+    total: number;
+};
+export type CustomerRestrictionIn = {
+    identification_type_id: number;
+    identification_number: string;
+    company_country_id: number;
+};
+export type CustomerRestrictionOut = {
+    customer_restriction: CustomerRestriction;
+};

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

@@ -179,13 +179,12 @@ export interface CountryPaymentTypeField extends LaravelModel {
     country_payment_type_id: number;
     code: string;
     name: string;
-    description: string;
+    description: string | null;
     format: string;
     is_required: boolean;
-    catalog: [] | null;
+    catalog: string[] | null;
     regex: string | null;
     is_interface: boolean;
-    value?: string;
     is_bank_reference: boolean;
 }
 export interface PaymentType extends LaravelModel {
@@ -210,3 +209,9 @@ export interface PaymentTypeFieldAccount extends LaravelModel {
     currency_id: number;
     currency: Currency;
 }
+export interface Tolerance extends LaravelModel {
+    tolerance_type: number;
+    min_amount: number;
+    max_amount: number;
+    tolerance: number;
+}

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

@@ -1,4 +1,4 @@
-import { CountryPaymentType, CountryPaymentTypeField, Customer, CustomerType, Document, PaymentType, PaymentTypeFieldAccount, PaymentTypeFieldCardType } from './api-invoices.interfaces';
+import { CountryPaymentType, CountryPaymentTypeField, Customer, CustomerType, Document, PaymentType, PaymentTypeFieldAccount, PaymentTypeFieldCardType, Tolerance } from './api-invoices.interfaces';
 import { CustomerCountryDocumentType } from './api-billing.interfaces';
 export interface OperationAccountPaymentIn {
     document_type_range_id: number | null;
@@ -165,3 +165,18 @@ export type PaymentTypeFieldAccountIn = {
 export type PaymentTypeFieldAccountOut = {
     country_payment_type_field_account: PaymentTypeFieldAccount;
 };
+export type TolerancesOut = {
+    tolerances: Tolerance[];
+    total: number;
+};
+export type ToleranceIn = {
+    company_country_id: number;
+    tolerance_type: number;
+    min_amount: number;
+    max_amount: number;
+    tolerance: number;
+    is_active: boolean;
+};
+export type ToleranceOut = {
+    tolerance: Tolerance;
+};

package/lib/apis/models/api.models.d.ts

@@ -10,21 +10,21 @@ export interface ApiModel {
 }
 export interface LaravelModel extends ApiModel {
     is_active: boolean;
-    created_at: Date | string;
-    updated_at: Date | string;
+    created_at: string;
+    updated_at: string;
 }
 export interface ActiveLessLaravelModel extends ApiModel {
-    created_at: Date | string;
-    updated_at: Date | string;
+    created_at: string;
+    updated_at: string;
 }
 export interface SymfonyModel extends ApiModel {
     isActive: boolean;
-    createdAt: Date | string;
-    updatedAt: Date | string;
+    createdAt: string;
+    updatedAt: string;
 }
 export interface ActiveLessSymfonyModel extends ApiModel {
-    createdAt: Date | string;
-    updatedAt: Date | string;
+    createdAt: string;
+    updatedAt: string;
 }
 export type QueryParams = {
     [param: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;

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

@@ -22,6 +22,7 @@ export type Environment = {
     apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
     apiCompositionUrl?: string;
+    apiDiscounts?: string;
     apiEToolsAutoBilling?: string;
     apiExternalOperationsKey?: string;
     apiExternalOperationsUrl?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@experteam-mx/ngx-services",
-  "version": "18.7.8",
+  "version": "18.7.10",
   "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-cash-operations.service';
 export * from './lib/apis/api-catalogs.service';
 export * from './lib/apis/api-companies.service';
 export * from './lib/apis/api-composition.service';
+export * from './lib/apis/api-discounts.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';
@@ -15,9 +16,9 @@ export * from './lib/apis/api-open-items.service';
 export * from './lib/apis/api-reports.service';
 export * from './lib/apis/api-security.service';
 export * from './lib/apis/api-shipments.service';
-export * from './lib/apis/models/api-billing.types';
 export * from './lib/apis/models/api-billing-pa.interfaces';
 export * from './lib/apis/models/api-billing-pa.types';
+export * from './lib/apis/models/api-billing.types';
 export * from './lib/apis/models/api-cash-operations.interfaces';
 export * from './lib/apis/models/api-cash-operations.types';
 export * from './lib/apis/models/api-catalog.interfaces';
@@ -26,6 +27,8 @@ export * from './lib/apis/models/api-companies.interfaces';
 export * from './lib/apis/models/api-companies.types';
 export * from './lib/apis/models/api-composition.interfaces';
 export * from './lib/apis/models/api-composition.types';
+export * from './lib/apis/models/api-discounts.interfaces';
+export * from './lib/apis/models/api-discounts.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';