@experteam-mx/ngx-services 18.7.27 → 18.7.29

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

@@ -0,0 +1,110 @@
+import { Environment } from '../ngx-services.models';
+import { HttpClient } from '@angular/common/http';
+import { QueryParams } from './models/api.models';
+import { Observable } from 'rxjs';
+import { CatalogsOut, CountryGroupsOut, CriteriaIn, CriteriaOut, FieldsOut, OverridesOut, RuleCriteriaIn, RuleIn, RuleOut, RulesByCriteriaOut, RulesIn, RulesOut } from './models/api-customs.types';
+import * as i0 from "@angular/core";
+export declare class ApiCustomsService {
+    private environments;
+    private http;
+    constructor(environments: Environment, http: HttpClient);
+    /**
+     * Retrieves the URL for the cash operations API from the environment configurations.
+     *
+     * @return {string} The URL of the cash operations API.
+     */
+    get url(): string;
+    /**
+     * Fetches the available fields for a given level.
+     *
+     * @return {Observable<FieldsOut>} An Observable that emits the list of fields.
+     * @param params
+     */
+    getFields(params: QueryParams): Observable<FieldsOut>;
+    /**
+     * Retrieves override configurations for a given level.
+     *
+     * @return {Observable<OverridesOut>} An Observable that emits the overrides configuration.
+     * @param params
+     */
+    getOverrides(params: QueryParams): Observable<OverridesOut>;
+    /**
+     * Fetches the catalogs used in customs operations.
+     *
+     * @return {Observable<CatalogsOut>} An Observable that emits the catalogs.
+     */
+    getCatalogs(params: QueryParams): Observable<CatalogsOut>;
+    /**
+     * Retrieves the list of rules based on the provided query parameters.
+     *
+     * @param {QueryParams} params - Query parameters to filter the rules.
+     * @return {Observable<RulesOut>} An Observable that emits the list of rules.
+     */
+    getRules(params: QueryParams): Observable<RulesOut>;
+    /**
+     * Retrieves the details of a specific rule by its ID.
+     *
+     * @param {number} id - The ID of the rule.
+     * @return {Observable<RuleOut>} An Observable that emits the rule details.
+     */
+    getRule(id: number): Observable<RuleOut>;
+    /**
+     * Creates a new criteria.
+     *
+     * @param {CriteriaIn} body - The criteria payload to create.
+     * @return {Observable<CriteriaOut>} An Observable that emits the created criteria.
+     */
+    postCriteria(body: CriteriaIn): Observable<CriteriaOut>;
+    /**
+     * Creates a new rule.
+     *
+     * @param {RuleIn} body - The rule payload to create.
+     * @return {Observable<RuleOut>} An Observable that emits the created rule.
+     */
+    postRules(body: RuleIn): Observable<RuleOut>;
+    /**
+     * Retrieves rules that match the given criteria.
+     *
+     * @param {RuleCriteriaIn} params - Criteria used to search for matching rules.
+     * @return {Observable<RulesByCriteriaOut>} An Observable that emits the list of matching rules.
+     */
+    postRulesByCriteria(params: RuleCriteriaIn): Observable<RulesByCriteriaOut>;
+    /**
+     * Enables a specific rule by its ID.
+     *
+     * @param {number} id - The ID of the rule to enable.
+     * @return {Observable<{}>} An Observable that emits an empty array on success.
+     */
+    putRuleActivate(id: number): Observable<{}>;
+    /**
+     * Disables (deletes) a specific rule by its ID.
+     *
+     * @param {number} id - The ID of the rule to disable.
+     * @return {Observable<[]>} An Observable that emits an empty array on success.
+     */
+    deleteRule(id: number): Observable<{}>;
+    /**
+     * Updates an existing criteria by its ID.
+     *
+     * @param {number} id - The ID of the criteria.
+     * @param {CriteriaIn} body - The updated criteria payload.
+     * @return {Observable<CriteriaOut>} An Observable that emits the updated criteria.
+     */
+    putCriteria(id: number, body: CriteriaIn): Observable<CriteriaOut>;
+    /**
+     * Updates an existing rule by its ID.
+     *
+     * @param {number} id - The ID of the rule.
+     * @param {RulesIn} body - The updated rule payload.
+     * @return {Observable<RuleOut>} An Observable that emits the updated rule.
+     */
+    putRule(id: number, body: RulesIn): Observable<RuleOut>;
+    /**
+     * Retrieves the list of country groups used in customs operations.
+     *
+     * @return {Observable<CountryGroupsOut>} An Observable that emits the list of country groups.
+     */
+    getCountryGroups(params: QueryParams): Observable<CountryGroupsOut>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiCustomsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApiCustomsService>;
+}

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

@@ -146,6 +146,11 @@ export interface Installation extends LaravelModel {
     location_id: number;
     number: number;
     system: System;
+    customer_screen: boolean;
+    epod_capture: boolean;
+    cx_survey: boolean;
+    customer_flow: boolean;
+    promotional_content: boolean;
 }
 export interface Location extends LaravelModel {
     accounts: Account[];

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

@@ -23,6 +23,11 @@ export type InstallationIn = {
     ip_address: string;
     location_id: number;
     number: number;
+    customer_screen: boolean;
+    epod_capture: boolean;
+    cx_survey: boolean;
+    customer_flow: boolean;
+    promotional_content: boolean;
 };
 export type InstallationOut = {
     installation: Installation;

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

@@ -0,0 +1,125 @@
+import { ActiveLessSymfonyModel, ApiModel, SymfonyModel } from './api.models';
+export interface Field extends ActiveLessSymfonyModel {
+    name: string;
+    label: string;
+    level: string;
+    dhlCodes: DhlCode[];
+}
+export interface DhlCode extends ActiveLessSymfonyModel {
+    code: string;
+    customerCode: string;
+    description: string;
+}
+export interface Override extends ApiModel {
+    field: string;
+    name: string;
+    level: string;
+}
+export interface Catalog extends SymfonyModel {
+    name: string;
+}
+export interface Rule extends SymfonyModel {
+    ruleType: string;
+    criteria: CriteriaCustom | null;
+    name: string;
+    description: string | null;
+    level: string;
+    roleTypes: string[];
+    warning: string | null;
+    attributes: Attribute[];
+}
+export interface CriteriaCustom extends ApiModel {
+    origins: string[];
+    originGroups: string[];
+    originExclusions: string[];
+    destinations: string[];
+    destinationGroups: string[];
+    destinationExclusions: string[];
+    dutiable: boolean;
+    declaredValue: null | {
+        operator: number;
+    };
+}
+export interface Attribute extends ActiveLessSymfonyModel {
+    field: FieldLess | null;
+    dhlCode: DhlCodeLess | null;
+    inputType: string;
+    inputLabel: string;
+    inputTooltip: string | null;
+    exclusive: boolean;
+    exclusiveDefault: boolean;
+    required: boolean;
+    text: TextConfig | null;
+    dropdown: DropdownConfig | null;
+    number: null | {
+        min: number;
+        max: number;
+    };
+    dependentRules: DependentRules | null;
+    fillFrom: FillFrom | null;
+    override: Override | null;
+}
+export interface FieldLess extends ApiModel {
+    name: string;
+    label: string;
+}
+export interface TextConfig {
+    minLength: number | null;
+    maxLength: number | null;
+    regex: string | null;
+    alphaNumeric: string | null;
+    placeHolder: string | null;
+    format: string | null;
+    prefix: string | null;
+    suffix: string | null;
+    masked: boolean;
+    isFormat?: boolean;
+}
+export interface DropdownConfig extends Dropdown {
+    catalog: CatalogLess | null | number;
+}
+export interface DependentRules {
+    conditionType: string;
+    ruleIds: number[];
+}
+export interface FillFrom {
+    attributeIndex: number;
+    attributeId: number;
+    using: string;
+    disabled: boolean;
+}
+export interface CatalogLess extends ApiModel {
+    name: string;
+    isActive: boolean;
+}
+export interface CriteriaWithTimestamps {
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CountryGroups extends ActiveLessSymfonyModel {
+    code: string;
+    name: string;
+    countries: string[];
+}
+export interface DhlCodeLess extends ApiModel {
+    code: string;
+    customerCode: string;
+    description: string;
+}
+export interface RuleByCriteria extends ApiModel {
+    ruleType: string;
+    criteria: CriteriaCustom | null;
+    name: string;
+    description: string | null;
+    level: string;
+    roleTypes: string[];
+}
+export interface Dropdown {
+    values: string[];
+    catalogId: number;
+    loadOnDemand: boolean;
+    defaultValue: string | null;
+    prefix: string | null;
+    suffix: string | null;
+    _catalogName?: string | null;
+}

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

@@ -0,0 +1,90 @@
+import { Catalog, CountryGroups, CriteriaCustom, CriteriaWithTimestamps, DependentRules, Dropdown, Field, Override, Rule, RuleByCriteria, TextConfig } from './api-customs.interfaces';
+export type FieldsOut = {
+    total: number;
+    fields: Field[];
+};
+export type OverridesOut = {
+    total: number;
+    overrides: Override[];
+};
+export type CatalogsOut = {
+    total: number;
+    catalogs: Catalog[];
+};
+export type RulesOut = {
+    total: number;
+    rules: Rule[];
+};
+export type RuleOut = {
+    rule: Rule;
+};
+export type CriteriaIn = {
+    origins: string[];
+    originGroups: string[];
+    originExclusions: string[];
+    destinations: string[];
+    destinationGroups: string[];
+    destinationExclusions: string[];
+    dutiable: boolean;
+    declaredValue: {
+        operator: number;
+    } | null;
+    touched?: boolean;
+    valid?: boolean;
+};
+export type CriteriaOut = {
+    criteria: CriteriaCustom & CriteriaWithTimestamps;
+};
+export type RuleIn = {
+    ruleType: string;
+    criteriaId: number | null;
+    name: string;
+    description: string | null;
+    level: string;
+    roleTypes: string[];
+    warning: string | null;
+    attributes: AttributeIn[];
+    isActive: boolean;
+};
+export type AttributeIn = {
+    fieldId: number | null;
+    dhlCodeId: number | null;
+    inputType: string;
+    inputLabel: string;
+    inputTooltip: string | null;
+    exclusive: boolean;
+    exclusiveDefault: boolean;
+    required: boolean;
+    text: TextConfig | null;
+    dropdown: Dropdown | null;
+    number: number | null | {
+        min: number | null;
+        max: number | null;
+    };
+    dependentRules: DependentRules | null;
+    fillFrom: FillFromIn | null;
+    overrideId: number | null;
+    isActive: boolean;
+};
+export type FillFromIn = {
+    attributeIndex: number;
+    using: string;
+    disabled: boolean;
+};
+export type RuleCriteriaIn = CriteriaIn & {
+    ruleType: string | null;
+};
+export type AttributeWithId = AttributeIn & {
+    id: number;
+};
+export type RulesIn = Omit<RuleIn, 'attributes'> & {
+    id: number | null;
+    attributes: AttributeWithId[];
+};
+export type CountryGroupsOut = {
+    countryGroups: CountryGroups[];
+};
+export type RulesByCriteriaOut = {
+    total: number;
+    rules: RuleByCriteria[];
+};

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

@@ -25,6 +25,7 @@ export type Environment = {
     apiCatalogsUrl?: string;
     apiCompaniesUrl?: string;
     apiCompositionUrl?: string;
+    apiCustomsUrl?: string;
     apiDiscountsUrl?: string;
     apiEventsUrl?: string;
     apiEToolsAutoBilling?: string;

package/package.json

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

package/public-api.d.ts

@@ -9,6 +9,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-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';
@@ -39,6 +40,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-customs.interfaces';
+export * from './lib/apis/models/api-customs.types';
 export * from './lib/apis/models/api-discounts.interfaces';
 export * from './lib/apis/models/api-discounts.types';
 export * from './lib/apis/models/api-events.enum';