@fiado/type-kit 2.0.14 → 2.0.16

package/src/address/dtos/LocationAddress.ts

@@ -1,25 +1,25 @@
-/**
- * Unified address representation
- */
-export class LocationAddress {
-    // Common address representation
-    fullAddress?: string;
-    // Standard address components (common across providers)
-    address1?: string;
-    address2?: string;
-    city?: string;
-    // Provider specific region naming
-    state?: string;     // Provider B
-    region?: string;    // Provider A
-    // Postal code
-    zipCode?: string;
-    // Additional address details (typically from Provider B)
-    neighborhood?: string;
-    reference?: string;
-    betweenRoadName1?: string;
-    betweenRoadName2?: string;
-    externalNumber?: string;
-    internalNumber?: string;
-    roadTypeCode?: string;
-    roadTypeAbbName?: string;
-}
+/**
+ * Unified address representation
+ */
+export class LocationAddress {
+    // Common address representation
+    fullAddress?: string;
+    // Standard address components (common across providers)
+    address1?: string;
+    address2?: string;
+    city?: string;
+    // Provider specific region naming
+    state?: string;     // Provider B
+    region?: string;    // Provider A
+    // Postal code
+    zipCode?: string;
+    // Additional address details (typically from Provider B)
+    neighborhood?: string;
+    reference?: string;
+    betweenRoadName1?: string;
+    betweenRoadName2?: string;
+    externalNumber?: string;
+    internalNumber?: string;
+    roadTypeCode?: string;
+    roadTypeAbbName?: string;
+}

package/src/address/dtos/OfficeDetails.ts

@@ -1,31 +1,31 @@
-import { OperationSchedule } from "./OperationSchedule"
-
-
-export type OfficeDetails = {
-    code: string;
-    name: string;
-    ownerName: string;
-    address: AddressDetail;
-    latitude: string;
-    longitude: string;
-    distance: number;
-    phoneNumber: string;
-    operationSchedule: OperationSchedule[];
-};
-
-export type AddressDetail = {
-    fullAddress: string;
-    address1: string;
-    address2: string;
-    city: string;
-    neighorhood: string;
-    state: string;
-    zipCode: string;
-    reference: string;
-    betweenRoadName1: string;
-    betweenRoadName2: string;
-    externalNumber: string;
-    internalNumber: string;
-    roadTypeCode: string;
-    roadTypeAbbName: string;
+import { OperationSchedule } from "./OperationSchedule"
+
+
+export type OfficeDetails = {
+    code: string;
+    name: string;
+    ownerName: string;
+    address: AddressDetail;
+    latitude: string;
+    longitude: string;
+    distance: number;
+    phoneNumber: string;
+    operationSchedule: OperationSchedule[];
+};
+
+export type AddressDetail = {
+    fullAddress: string;
+    address1: string;
+    address2: string;
+    city: string;
+    neighorhood: string;
+    state: string;
+    zipCode: string;
+    reference: string;
+    betweenRoadName1: string;
+    betweenRoadName2: string;
+    externalNumber: string;
+    internalNumber: string;
+    roadTypeCode: string;
+    roadTypeAbbName: string;
 };

package/src/address/dtos/OperationSchedule.ts

@@ -1,9 +1,9 @@
-
-
-export type OperationSchedule = {
-    Weekday: string
-    StartHourDay: string
-    FinishHourDay: string
-    StartHourLunchDay: string
-    FinishHourLunchDay: string
+
+
+export type OperationSchedule = {
+    Weekday: string
+    StartHourDay: string
+    FinishHourDay: string
+    StartHourLunchDay: string
+    FinishHourLunchDay: string
 }

package/src/address/dtos/Place.ts

@@ -1,96 +1,96 @@
-import { IsArray, IsBoolean, IsEnum, IsOptional, IsString, Length, ValidateNested } from 'class-validator';
-import { Geometry } from "./Geometry";
-import { Timezone } from "./Timezone";
-import { Country } from '../../country/enums/Country';
-import { Type } from 'class-transformer';
-
-export class Place {
-    @ValidateNested()
-    geometry: Geometry;
-
-    @IsOptional()
-    @IsString()
-    addressNumber?: string;
-
-    @IsOptional()
-    @IsArray()
-    @IsString({ each: true })
-    categories?: string[];
-
-    @IsOptional()
-    @IsEnum(Country)
-    country?: string;
-
-    @IsBoolean()
-    interpolated: boolean;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 300)
-    label?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 60)
-    municipality?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(2, 60)
-    neighborhood?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(5, 10)
-    postalCode?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(5, 10)
-    region?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 100)
-    street?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(2, 60)
-    subMunicipality?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(2, 60)
-    subRegion?: string;
-
-    @IsOptional()
-    @IsArray()
-    @IsString({ each: true })
-    supplementalCategories?: string[];
-
-    @IsOptional()
-    @ValidateNested()
-    @Type(() => Timezone)
-    timezone?: Timezone;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 10)
-    unitNumber?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 10)
-    unitType?: string;
-
-    @IsOptional()
-    @IsString()
-    @Length(1, 60)
-    city?: string;   
-    
-    @IsOptional()
-    @IsString()
-    @Length(1, 60)
-    state?: string;       
+import { IsArray, IsBoolean, IsEnum, IsOptional, IsString, Length, ValidateNested } from 'class-validator';
+import { Geometry } from "./Geometry";
+import { Timezone } from "./Timezone";
+import { Country } from '../../country/enums/Country';
+import { Type } from 'class-transformer';
+
+export class Place {
+    @ValidateNested()
+    geometry: Geometry;
+
+    @IsOptional()
+    @IsString()
+    addressNumber?: string;
+
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    categories?: string[];
+
+    @IsOptional()
+    @IsEnum(Country)
+    country?: string;
+
+    @IsBoolean()
+    interpolated: boolean;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 300)
+    label?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 60)
+    municipality?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    neighborhood?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(5, 10)
+    postalCode?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(5, 10)
+    region?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    street?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    subMunicipality?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(2, 60)
+    subRegion?: string;
+
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    supplementalCategories?: string[];
+
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => Timezone)
+    timezone?: Timezone;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 10)
+    unitNumber?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 10)
+    unitType?: string;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 60)
+    city?: string;   
+    
+    @IsOptional()
+    @IsString()
+    @Length(1, 60)
+    state?: string;       
 }

package/src/address/dtos/Shipping.ts

@@ -1,36 +1,36 @@
-import { IsString, Length, IsOptional } from 'class-validator';
-import { CountryId } from '../../country/enums/CountryId';
-
-export class Shipping {
-  @IsString()
-  @Length(2, 60)
-  municipality: string;
-
-  @IsString()
-  @Length(2, 60)
-  neighborhood: string;
-
-  @IsString()
-  @Length(5, 10)
-  postalCode: string;
-
-  @IsString()
-  @Length(2, 100)
-  street: string;
-
-  @IsString()
-  @Length(2, 60)
-  subRegion: string;
-
-  @IsString()
-  @Length(1, 10)
-  addressNumber: string;
-
-  @IsOptional()
-  @IsString()
-  @Length(1, 200)
-  internalNumber?: string;
-
-  @IsString()
-  countryId: CountryId;
-}
+import { IsString, Length, IsOptional } from 'class-validator';
+import { CountryId } from '../../country/enums/CountryId';
+
+export class Shipping {
+  @IsString()
+  @Length(2, 60)
+  municipality: string;
+
+  @IsString()
+  @Length(2, 60)
+  neighborhood: string;
+
+  @IsString()
+  @Length(5, 10)
+  postalCode: string;
+
+  @IsString()
+  @Length(2, 100)
+  street: string;
+
+  @IsString()
+  @Length(2, 60)
+  subRegion: string;
+
+  @IsString()
+  @Length(1, 10)
+  addressNumber: string;
+
+  @IsOptional()
+  @IsString()
+  @Length(1, 200)
+  internalNumber?: string;
+
+  @IsString()
+  countryId: CountryId;
+}

package/src/address/dtos/Timezone.ts

@@ -1,10 +1,10 @@
-
-import { IsString } from 'class-validator';
-
-export class Timezone {
-  @IsString()
-  name: string;
-
-  @IsString()
-  offset: string;
+
+import { IsString } from 'class-validator';
+
+export class Timezone {
+  @IsString()
+  name: string;
+
+  @IsString()
+  offset: string;
 }

package/src/address/dtos/ValidateAddressRequest.ts

@@ -0,0 +1,5 @@
+import { AddressBase } from "./AddressBase";
+
+export class ValidateAddressRequest extends AddressBase {
+
+}

package/src/address/dtos/ValidateAddressResponse.ts

@@ -0,0 +1,7 @@
+import { ValidateAddressResult } from "./ValidateAddressResult";
+import { AddressBase } from "./AddressBase"
+
+export class ValidateAddressResponse {
+    validationResult: ValidateAddressResult
+    suggestedAddresses: AddressBase[];
+}

package/src/address/dtos/ValidateAddressResult.ts

@@ -0,0 +1,7 @@
+import { ValidateAddressStatusEnum } from "../enums/ValidateAddressStatusEnum";
+import { ValidateAddressErrorCodeEnum } from "../enums/ValidateAddressErrorCodeEnum";
+
+export class ValidateAddressResult {
+    validationStatus: ValidateAddressStatusEnum;
+    validationCodeError: ValidateAddressErrorCodeEnum;
+}

package/src/address/enums/AddressProvider.ts

@@ -1,10 +1,10 @@
-
-/**
- * AddressProvider enum
- * @description AddressProvider enum is used to define the address provider
- * @enum {string} AddressProvider
- */
-export enum AddressProvider {
-    AWS = "AWS",
-    MANUAL = "MANUAL"
-}
+
+/**
+ * AddressProvider enum
+ * @description AddressProvider enum is used to define the address provider
+ * @enum {string} AddressProvider
+ */
+export enum AddressProvider {
+    AWS = "AWS",
+    MANUAL = "MANUAL"
+}

package/src/address/enums/AddressStatus.ts

@@ -1,10 +1,10 @@
-
-/**
- * AddressProvider Status
- * @description AddressProvider Status is used to define the address provider status
- * @enum {string} AddressStatus
- */
-export enum AddressStatus {
-    VISIBLE = "VISIBLE",
-    NOT_VISIBLE = "NOT_VISIBLE"
+
+/**
+ * AddressProvider Status
+ * @description AddressProvider Status is used to define the address provider status
+ * @enum {string} AddressStatus
+ */
+export enum AddressStatus {
+    VISIBLE = "VISIBLE",
+    NOT_VISIBLE = "NOT_VISIBLE"
 }

package/src/address/enums/LocationTypeEnum.ts

@@ -1,4 +1,4 @@
-export enum LocationTypeEnum {
-    USA_MERCHANT_LOCATIONS = 'USA_MERCHANT_LOCATIONS',
-    MEX_SHIPPING_OFFICES = 'MEX_SHIPPING_OFFICES',
+export enum LocationTypeEnum {
+    USA_MERCHANT_LOCATIONS = 'USA_MERCHANT_LOCATIONS',
+    MEX_SHIPPING_OFFICES = 'MEX_SHIPPING_OFFICES',
 }

package/src/address/enums/ValidateAddressErrorCodeEnum.ts

@@ -0,0 +1,14 @@
+
+/**
+ * ValidateAddressErrorCodeEnum enum
+ * @description ValidateAddressErrorCodeEnum enum is used to define the error code for address validation
+ * @enum {string} ValidateAddressErrorCodeEnum
+ */
+export enum ValidateAddressErrorCodeEnum {
+    ADDRESS_INVALID = "ADDRESS_INVALID",
+    ADDRESS_INCOMPLETE_PRIMARY = "ADDRESS_INCOMPLETE_PRIMARY",
+    ADDRESS_INCOMPLETE_SECONDARY = "ADDRESS_INCOMPLETE_SECONDARY",
+    ADDRESS_INCOMPLETE_PO_BOX = "ADDRESS_INCOMPLETE_PO_BOX",
+    ADDRESS_VACANT = "ADDRESS_VACANT",
+    ADDRESS_UNKNOWN = "ADDRESS_UNKNOWN",
+}

package/src/address/enums/ValidateAddressStatusEnum.ts

@@ -0,0 +1,10 @@
+
+/**
+ * ValidateAddressStatusEnum enum
+ * @description ValidateAddressStatusEnum enum is used to define the status for address validation
+ * @enum {string} ValidateAddressStatusEnum
+ */
+export enum ValidateAddressStatusEnum {
+    INVALID = "INVALID",
+    VALID = "VALID"
+}

package/src/address/index.ts

@@ -1,21 +1,25 @@
-//dtos  
-export * from './dtos/Shipping';
-export * from './dtos/AddressCreateRequest';
-export * from './dtos/AddressResponse';
-export * from './dtos/Geometry';
-export * from './dtos/Place';
-export * from './dtos/Timezone';
-export * from './dtos/OfficeDetails'
-export * from './dtos/OperationSchedule'
-export * from './dtos/AddressShippingCardResponse'
-export * from './dtos/AddressShippingCardRequest'
-export * from './dtos/LocationAddress';
-export * from './dtos/Location';
-export * from './dtos/GetLocationResponse';
-
-
-//enums
-export * from './enums/AddressStatus';
-export * from './enums/AddressProvider';
-export * from './enums/LocationTypeEnum';
-
+//dtos  
+export * from './dtos/Shipping';
+export * from './dtos/AddressCreateRequest';
+export * from './dtos/AddressResponse';
+export * from './dtos/Geometry';
+export * from './dtos/Place';
+export * from './dtos/Timezone';
+export * from './dtos/OfficeDetails'
+export * from './dtos/OperationSchedule'
+export * from './dtos/AddressShippingCardResponse'
+export * from './dtos/AddressShippingCardRequest'
+export * from './dtos/LocationAddress';
+export * from './dtos/Location';
+export * from './dtos/GetLocationResponse';
+export * from './dtos/ValidateAddressRequest';
+export * from './dtos/ValidateAddressResult';
+export * from './dtos/ValidateAddressResponse';
+
+
+//enums
+export * from './enums/AddressStatus';
+export * from './enums/AddressProvider';
+export * from './enums/LocationTypeEnum';
+export * from './enums/ValidateAddressErrorCodeEnum'
+export * from './enums/ValidateAddressStatusEnum'

package/src/apiResponse/dtos/FiadoApiResponse.ts

@@ -1,8 +1,8 @@
-
-export default interface FiadoApiResponse<T> {
-    data:T;
-    date:string|null;
-    code:string|null;
-    msg:string|null; 
-    description:string|null;
+
+export default interface FiadoApiResponse<T> {
+    data:T;
+    date:string|null;
+    code:string|null;
+    msg:string|null; 
+    description:string|null;
 }

package/src/app/enums/App.ts

@@ -1,11 +1,11 @@
-
-
-export enum App {
-    USER = "USER",
-    MERCHANT = "MERCHANT",
-    BACKOFFICE = "BACKOFFICE",
-    AGENT = "AGENT",
-    USER_APP = "APP",
-    USER_WEB = "WEB",
-    HYBRID = "HYBRID"
+
+
+export enum App {
+    USER = "USER",
+    MERCHANT = "MERCHANT",
+    BACKOFFICE = "BACKOFFICE",
+    AGENT = "AGENT",
+    USER_APP = "APP",
+    USER_WEB = "WEB",
+    HYBRID = "HYBRID"
 }

package/src/app/index.ts

@@ -1,4 +1,4 @@
-
-
-//enums
+
+
+//enums
 export * from './enums/App';

package/src/appSelectionData/dtos/AppSelectionDataCreateRequest.ts

@@ -1,27 +1,27 @@
-import { IsBoolean, IsNotEmpty, IsNumber, IsString } from 'class-validator';
-
-
-export class AppSelectionDataCreateRequest {
-
-  @IsString()
-  additionalInfo: string;
-
-  @IsString()
-  dataType: string;
-
-  @IsString()
-  description: string;
-
-  @IsString()
-  displayName: string;
-
-  @IsBoolean()
-  isActive: boolean;
-
-  @IsNumber()
-  order: number;
-
-  @IsString()
-  value: string;
-
-}
+import { IsBoolean, IsNotEmpty, IsNumber, IsString } from 'class-validator';
+
+
+export class AppSelectionDataCreateRequest {
+
+  @IsString()
+  additionalInfo: string;
+
+  @IsString()
+  dataType: string;
+
+  @IsString()
+  description: string;
+
+  @IsString()
+  displayName: string;
+
+  @IsBoolean()
+  isActive: boolean;
+
+  @IsNumber()
+  order: number;
+
+  @IsString()
+  value: string;
+
+}