sm-types 1.0.1

package/sm-airlines/index.d.ts

@@ -0,0 +1,578 @@
+import { ISmTTravelOffer } from "../sm-tech";
+export { IAddOfferReqDto, IBuyOfferReqDto, IReserveOfferReqDto, IListOffersReqDto, IListOffersResDto, IAddOfferResDto, IGetOfferDetailsResDto, IRefreshAvailabilityResDto, IReplaceOfferResDto, IReserveOfferResDto, ICheckReserveOfferResDto, IBuyOfferResDto, ICancelOfferResDto, } from "./dtos";
+export { IAddOfferCommandParams, IRefreshAvailabilityCommandParams, IBuyOfferCommandParams, ICancelOfferCommandParams, IReserveOfferCommandParams, IReplaceOfferCommandParams, ICheckReserveQueryParams, } from "./command-params";
+export interface IWrappedResponse<T> {
+    status: IResponseStatus;
+    data?: T;
+    message?: string;
+    code?: number;
+}
+export interface ISmAzulTariffedJourney {
+    notForGeneralUse: boolean;
+    sellKey: string;
+    fare: ISmAzulFare;
+    segments: ISmAzulDetailedSegment[];
+    salesDate: Date;
+}
+export interface ISmAzulFare {
+    classOfService: string;
+    ruleTariff: string;
+    carrierCode: string;
+    ruleCode: string;
+    fareBasis: string;
+    paxFares: ISmPaxFareDto[];
+    fareApplicationType: ISmAzulFareApplicationType;
+    inboundOutbound: string;
+    isAllotmentMarketFare: boolean;
+    sellKey: string;
+    tripTypeRule: string;
+}
+export interface ISmPaxFareDto {
+    paxType: IPassengerType;
+    discountCode: string;
+    ruleTariff: string;
+    carrierCode: string;
+    ruleCode: string;
+    fareBasis: string;
+    fareDiscountCode: string;
+    actionStatusCode: string;
+    productClass: string;
+    productClassName: ISmAzulProductClassName;
+    fareStatus: ISmAzulFareStatus;
+    charges: ISmAzulServiceCharge[];
+    lastModified: Date;
+    availableCount: number;
+    status: string;
+}
+export interface ISmAzulSegment {
+    state: ISmAzulState;
+    departure: {
+        station: string;
+        dateTime: Date;
+        terminalOverride?: string;
+    };
+    arrival: {
+        station: string;
+        dateTime: Date;
+        terminalOverride?: string;
+    };
+    flightDesignator: ISmAzulFlightDesignator;
+    segmentType: string;
+    international: boolean;
+    legs: ISmAzulLeg[];
+    sellKey: string;
+    trafficRestriction: string;
+}
+export interface ISmAzulDetailedSegment extends ISmAzulSegment {
+    fares: ISmAzulFare[];
+    cancelSegment: boolean;
+    actionStatusCode: string;
+    classOfService: string;
+    classType: string;
+    paxCount: number;
+    priorityCode: string;
+    priorityDate: Date;
+    changeReasonCode: string;
+    timeChanged: boolean;
+    tripType: ISmAzulTripType;
+    checkInStatus: ISmAzulCheckInStatus;
+    createdDate: Date;
+    paxSegmentServices: ISmAzulPaxSegmentService[];
+    fareClassOfService: string;
+    cabinOfService: string;
+    aVSStatusIndicator: ISmAzulClassStatus;
+    segmentId: string;
+}
+export interface ISmAzulPaxSegmentService {
+    passengerId: number;
+    passengerNumber: number;
+    baggageCount: number;
+    baggageWeight: number;
+    paxLegServices?: any[];
+}
+export interface ISmAzulLeg {
+    departure: {
+        station: string;
+        dateTime: Date;
+        paxDateTime: Date;
+        terminal: string;
+        LTV: number;
+    };
+    arrival: {
+        station: string;
+        dateTime: Date;
+        paxDateTime: Date;
+        terminal: string;
+        LTV: number;
+    };
+    flightDesignator: ISmAzulFlightDesignator;
+    status: string;
+    inventoryLegKey: string;
+    aircraftType: string;
+    aircraftTypeSuffix: string;
+    PRBCCode: string;
+    scheduleServiceType: string;
+    onTime: string;
+    eTicket: boolean;
+    IROP: boolean;
+    FLIFOUpdated: boolean;
+    subjectToGovtApproval: boolean;
+    capacity: number;
+    lid: number;
+    adjustedCapacity: number;
+    sold: number;
+    soldNonStop: number;
+    soldConnect: number;
+    outMoveDays: number;
+    backMoveDays: number;
+    soldThru: number;
+    codeShareIndicator: string;
+    operatingCarrier: string;
+    operatingFlightNumber: string;
+    operatingOpSuffix: string;
+    operatedByText: string;
+    transitLayover: number;
+    transitDays: number;
+}
+export interface ISmAzulFlightDesignator {
+    carrierCode: string;
+    flightNumber: string;
+    opSuffix: string;
+}
+export interface ISmAzulBookingPassenger {
+    paxType: IPassengerType;
+    passengerFees: ISmAzulPassengerFee[];
+}
+export interface ISmAzulPassengerFee {
+    feeCode: string;
+    feeType: string;
+    charges: ISmAzulServiceCharge[];
+}
+export interface ISmAzulServiceCharge {
+    chargeType: ISmAzulChargeType;
+    collectType: ISmAzulCollectType;
+    chargeCode: string;
+    ticketCode: string;
+    currencyCode: string;
+    amount: number;
+    chargeDetail: string;
+    foreignCurrencyCode: string;
+    foreignAmount: number;
+}
+export interface ISmAzulJourney {
+    classOfService: string;
+    ruleTariff: string;
+    carrierCode: string;
+    ruleCode: string;
+    fareBasis: string;
+    paxFares: ISmAzulPaxFare[];
+    fareApplicationType: ISmAzulFareApplicationType;
+    inboundOutbound: string;
+    isAllotmentMarketFare: boolean;
+    sellKey: string;
+    tripTypeRule: string;
+}
+export interface ISmAzulPaxFare {
+    paxType: IPassengerType;
+    discountCode: string;
+    ruleTariff: string;
+    carrierCode: string;
+    ruleCode: string;
+    fareBasis: string;
+    fareDiscountCode: string;
+    actionStatusCode: string;
+    productClass: string;
+    productClassName: ISmAzulProductClassName;
+    fareStatus: ISmAzulFareStatus;
+    charges: ISmAzulServiceCharge[];
+    lastModified: Date;
+    availableCount: number;
+    status: string;
+}
+export interface ISmAzulOffer {
+    currencyCode: string;
+    total: number;
+    priceStatus: ISmAzulPriceStatus;
+    tariffedJourneys: ISmAzulTariffedJourney[];
+    bookingPassengers: ISmAzulBookingPassenger[];
+}
+export interface ISmWcfOffer {
+    outbound: ISmWcfBound;
+    inbound: ISmWcfBound | null;
+    supplier: string;
+    itineraryId?: number;
+    travelIdentification: string | IJourneyIdentificator[];
+    price: number;
+    priceDetails: IPriceDetails;
+    flightIdentification: string;
+    stopType: string;
+    cabinClass: string;
+    diffAirports: boolean;
+    familyOffers?: any[];
+    selectedItineraryId?: number;
+    supplierSearchId?: string;
+}
+export interface ISmWcfBound {
+    segments: ISmWcfSegment[];
+    supplier: string;
+    type: string;
+    departure: string;
+    departureHour: string;
+    departureTextDate: string;
+    departureWeekDay: string;
+    arrival: string;
+    arrivalHour: string;
+    arrivalTextDate: string;
+    arrivalWeekDay: string;
+    daysDiff: number;
+    origin: ISmWcfStation;
+    destination: ISmWcfStation;
+    totalStops: number;
+    carrier: ISmWcfCarrier;
+    durationMinutes: number;
+    cabinClass: string;
+    family: string;
+    baggage: boolean;
+    baggagePieces: number;
+    baggageWeight: number;
+    stops: any[];
+    durationHours: string;
+}
+export interface ISmWcfSegment {
+    departureMoment: string;
+    departure: string;
+    departureHour: string;
+    departureTextDate: string;
+    departureWeekDay: string;
+    arrivalMoment: string;
+    arrival: string;
+    arrivalHour: string;
+    arrivalTextDate: string;
+    arrivalWeekDay: string;
+    daysDiff: number;
+    durationMinutes: number;
+    durationHours: string;
+    origin: ISmWcfStation;
+    destination: ISmWcfStation;
+    carrier: ISmWcfCarrier;
+    family: string;
+    familyCode: string;
+    cabinClass: string;
+    flightNumber: string;
+    flightCode: string;
+    baggage: boolean;
+    baggagePieces: number;
+    baggageWeight: number;
+    fareInfo: ISmWcfFare;
+}
+interface ISmWcfStation {
+    code: string;
+    name: string;
+    type: string;
+}
+interface ISmWcfCarrier {
+    code: string;
+    name: string;
+    imageUrl: string;
+}
+export interface ISmWcfFare {
+    base: string;
+    class: string;
+    flightNumber: string;
+}
+export interface IJourneyIdentificator {
+    journeyKey: string;
+    fareKey: string;
+    fareInfo: IFareInfo | ISmTechFareInfo;
+}
+export interface IFareInfo {
+    classOfService: string;
+    ruleTariff: string;
+    carrierCode: string;
+    ruleCode: string;
+    fareBasis: string;
+    productClass: string;
+    productClassName: ISmAzulProductClassName;
+}
+export interface ISmTechFareInfo {
+    productClass: string;
+    productClassName: string;
+    fareBasis: string;
+    totalPrice: number;
+    baggageCount: number;
+}
+export interface IDateInfo {
+    writtenFormatWithDayOfWeek: string;
+    writtenFormat: string;
+    dateOnly: string;
+    hourMinuteOnly: string;
+}
+export interface IStationInfo {
+    code: string;
+    name: string;
+    type: string;
+}
+export interface ICarrierInfo {
+    code: string;
+    name: string;
+    imageUrl: string;
+}
+export interface IPriceDetails {
+    total: number;
+    totalFare: number;
+    totalTaxes: number;
+    totalAdditional: number;
+    totalDiscount: number;
+    totalPassengerFees?: number;
+    totalDiscountMargin: number;
+}
+export interface IReserveDetails {
+    status: string;
+    recordLocator: string;
+    price: number;
+    priceDetails?: IPriceDetails;
+    reservedUntil: Date | string;
+    extraLocators?: string;
+    supplierOrderId?: string;
+    refreshedOffer: ISmWcfOffer | ISmAzulOffer | ISmTTravelOffer;
+}
+export interface IContactInfo {
+    firstName: string;
+    surname: string;
+    email: string;
+    phone: {
+        ddi: string;
+        number: string;
+    };
+    companyName: string;
+    address: {
+        street: string;
+        number: number;
+        complement: string;
+        postalCode: string;
+        city: string;
+        stateCode: string;
+        countryCode: string;
+    };
+}
+export interface IPassengerInfo {
+    firstName: string;
+    surname: string;
+    birthDate: Date | string;
+    sex: ISex;
+    nationality: string;
+    residenceCountry: string;
+    cpf: {
+        number: number;
+    };
+    passport: {
+        number: number;
+        issuingCountry: string;
+        expirationDate: Date | string;
+    };
+}
+export interface IAirlinesOffer {
+    id: number;
+    status: IOfferStatus;
+    supplier: ISuppliers;
+    supplierOfferDetails: ISmAzulOffer | ISmWcfOffer;
+    price: number;
+    routes: IRoute[];
+    paxInfo: IPaxInfo;
+    oneway: boolean;
+    international: boolean;
+    recordLocator: string;
+    carrier: string;
+    availability: boolean;
+}
+export interface IRoute {
+    date: string;
+    departureStation: string;
+    arrivalStation: string;
+    stopover: {
+        station: string;
+        days: number;
+    };
+    filters?: IRouteFilters;
+}
+export interface IRouteFilters {
+    productClassName: ISmAzulProductClassName;
+    flightNumber: string;
+}
+export interface IPaxInfo {
+    adults: number;
+    children: number;
+    babies: number;
+}
+export interface IListOffersFiltersInfo {
+    carriersDataByName: Record<string, any>;
+    cheapestStopPricesMap: Record<string, number>;
+    cheapestMinStopPrice: number;
+    cheapestCarrierPricesMap: Record<string, number>;
+    cheapestAirportPricesMap: Record<string, number>;
+}
+export interface IReservationData {
+    contactInfo: IContactInfo;
+    passengersInfo: IPassengerInfo[];
+}
+export interface IOfferCancelationInfo {
+    supplier: ISuppliers;
+    recordLocator: string;
+    costToCancel?: number;
+    refundedValue?: number;
+}
+export interface IAvailabilityInfo {
+    availability: boolean;
+    currentPrice: number | null;
+    selectedPrice: number;
+    isSamePrice: boolean;
+    smWcfOffer: ISmWcfOffer | null;
+    updatedAirOfferDetails: ISmWcfOffer | ISmAzulOffer | ISmTTravelOffer;
+}
+export interface ISearchData {
+    international: boolean;
+    cabinClass: string;
+    promoCode: string;
+    paxInfo: IPaxInfo;
+    routes: IRoute[];
+}
+export interface IReserveCheckInfo {
+    availability: boolean;
+    currentPrice: number;
+    selectedPrice: number;
+    priceDetails: IPriceDetails;
+    isSamePrice: boolean;
+    error?: boolean;
+    message?: string;
+}
+export interface IOfferEmissionData {
+    recordLocator: string;
+    bookingCode: string;
+    price: number;
+    emittedAt: Date;
+}
+declare type ValueOf<T> = T[keyof T];
+declare const RESPONSE_STATUS: {
+    readonly SUCCESS: "success";
+    readonly ERROR: "error";
+    readonly FAIL: "fail";
+};
+declare const SUPPLIERS: {
+    readonly SKYTEAM: "skyteam";
+    readonly AZUL: "azul";
+    readonly TTECH: "tech-travel";
+};
+declare const OFFER_STATUS: {
+    readonly ADDED: "added";
+    readonly RESERVED: "reserved";
+    readonly EMITTED: "emitted";
+    readonly CANCELED: "canceled";
+};
+declare const ORDER_OPTIONS: {
+    readonly RELEVANCE: "RELEVANCE";
+    readonly DURATION: "DURATION";
+    readonly PRICE: "PRICE";
+};
+declare const PASSENGER_TYPE: {
+    readonly ADULT: "ADT";
+    readonly CHILDREN: "CHD";
+    readonly INFANT: "INF";
+};
+declare const SEX: {
+    readonly MALE: "Male";
+    readonly FEMALE: "Female";
+};
+declare const SM_AZUL_PRICE_STATUS: {
+    readonly INVALID: "Invalid";
+    readonly OVERRIDE: "Override";
+    readonly VALID: "Valid";
+};
+declare const SM_AZUL_CHARGE_TYPE: {
+    readonly FARE_PRICE: "FarePrice";
+    readonly DISCOUNT: "Discount";
+    readonly INCLUDED_TRAVEL_FEE: "IncludedTravelFee";
+    readonly INCLUDED_TAX: "IncludedTax";
+    readonly TRAVEL_FEE: "TravelFee";
+    readonly TAX: "Tax";
+    readonly SERVICE_CHARGE: "ServiceCharge";
+    readonly PROMOTION_DISCOUNT: "PromotionDiscount";
+    readonly CONNECTION_ADJUSTMENT_AMOUNT: "ConnectionAdjustmentAmount";
+    readonly ADD_ON_SERVICE_PRICE: "AddOnServicePrice";
+    readonly POINTS: "Points";
+    readonly INCLUDED_ADD_ON_SERVICE_FEE: "IncludedAddOnServiceFee";
+    readonly ADD_ON_SERVICE_FEE: "AddOnServiceFee";
+    readonly ADD_ON_SERVICE_MARKUP: "AddOnServiceMarkup";
+    readonly CALCULATED: "Calculated";
+    readonly NOTE: "Note";
+};
+declare const SM_AZUL_COLLECT_TYPE: {
+    readonly IMMEDIATE: "Immediate";
+    readonly DEFERRED: "Deferred";
+};
+declare const SM_AZUL_PRODUCT_CLASS_NAME: {
+    readonly AZUL: "azul";
+    readonly AZUL_MAIS: "azul+";
+    readonly AZUL_SOUTH_AMERICA: "azulSA";
+    readonly AZUL_MAIS_SOUTH_AMERICA: "azul+SA";
+    readonly AZUL_NORTH_AMERICA_AND_EUROPE: "azulEUAndSA";
+    readonly AZUL_MAIS_NORTH_AMERICA_AND_EUROPE: "azul+EUAndSA";
+    readonly AZUL_SUPER: "azulSuper";
+    readonly AZUL_BUSINESS: "azulBusiness";
+};
+declare const SM_AZUL_TRIP_TYPE: {
+    readonly NONE: "None";
+    readonly ONE_WAY: "OneWay";
+    readonly ROUND_TRIP: "RoundTrip";
+    readonly HALF_ROUND: "HalfRound";
+    readonly OPEN_JAW: "OpenJaw";
+    readonly CIRCLE_TRIP: "CircleTrip";
+    readonly ALL: "All";
+};
+declare const SM_AZUL_FARE_STATUS: {
+    readonly DEFAULT: "Default";
+    readonly SAME_DAY_STAND_BY: "SameDayStandBy";
+    readonly FARE_OVERRIDE_CONFIRMING: "FareOverrideConfirming";
+    readonly FARE_OVERRIDE_CONFIRMED: "FareOverrideConfirmed";
+    readonly UNMAPPED: "Unmapped";
+};
+declare const SM_AZUL_FARE_APPLICATION_TYPE: {
+    readonly ROUTE: "Route";
+    readonly SECTOR: "Sector";
+    readonly GOVERNING: "Governing";
+    readonly UNMAPPED: "Unmapped";
+};
+declare const SM_AZUL_CHECK_IN_STATUS: {
+    readonly NOT_YET_OPEN: "NotYetOpen";
+    readonly OPEN: "Open";
+    readonly CLOSED: "Closed";
+};
+declare const SM_AZUL_CLASS_STATUS: {
+    readonly ACTIVE: "Active";
+    readonly INACTIVE: "InActive";
+    readonly AVS_OPEN: "AVSOpen";
+    readonly AVS_ON_REQUEST: "AVSOnRequest";
+    readonly AVS_CLOSED: "AVSClosed";
+};
+declare const SM_AZUL_STATE: {
+    readonly CLEAN: "Clean";
+    readonly NEW: "New";
+    readonly MODIFIED: "Modified";
+    readonly DELETED: "Deleted";
+    readonly CONFIRMED: "Confirmed";
+};
+export declare type IResponseStatus = ValueOf<typeof RESPONSE_STATUS>;
+export declare type ISuppliers = ValueOf<typeof SUPPLIERS>;
+export declare type IOfferStatus = ValueOf<typeof OFFER_STATUS>;
+export declare type IOrderOptions = ValueOf<typeof ORDER_OPTIONS>;
+export declare type IPassengerType = ValueOf<typeof PASSENGER_TYPE>;
+export declare type ISex = ValueOf<typeof SEX>;
+export declare type ISmAzulPriceStatus = ValueOf<typeof SM_AZUL_PRICE_STATUS>;
+export declare type ISmAzulChargeType = ValueOf<typeof SM_AZUL_CHARGE_TYPE>;
+export declare type ISmAzulCollectType = ValueOf<typeof SM_AZUL_COLLECT_TYPE>;
+export declare type ISmAzulProductClassName = ValueOf<typeof SM_AZUL_PRODUCT_CLASS_NAME>;
+export declare type ISmAzulFareStatus = ValueOf<typeof SM_AZUL_FARE_STATUS>;
+export declare type ISmAzulFareApplicationType = ValueOf<typeof SM_AZUL_FARE_APPLICATION_TYPE>;
+export declare type ISmAzulTripType = ValueOf<typeof SM_AZUL_TRIP_TYPE>;
+export declare type ISmAzulCheckInStatus = ValueOf<typeof SM_AZUL_CHECK_IN_STATUS>;
+export declare type ISmAzulClassStatus = ValueOf<typeof SM_AZUL_CLASS_STATUS>;
+export declare type ISmAzulState = ValueOf<typeof SM_AZUL_STATE>;

package/sm-airlines/index.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var RESPONSE_STATUS = {
+    SUCCESS: "success",
+    ERROR: "error",
+    FAIL: "fail",
+};
+var SUPPLIERS = {
+    SKYTEAM: "skyteam",
+    AZUL: "azul",
+    TTECH: 'tech-travel'
+};
+var OFFER_STATUS = {
+    ADDED: "added",
+    RESERVED: "reserved",
+    EMITTED: "emitted",
+    CANCELED: "canceled",
+};
+var ORDER_OPTIONS = {
+    RELEVANCE: "RELEVANCE",
+    DURATION: "DURATION",
+    PRICE: "PRICE",
+};
+var PASSENGER_TYPE = {
+    ADULT: "ADT",
+    CHILDREN: "CHD",
+    INFANT: "INF",
+};
+var SEX = {
+    MALE: "Male",
+    FEMALE: "Female",
+};
+var SM_AZUL_PRICE_STATUS = {
+    INVALID: "Invalid",
+    OVERRIDE: "Override",
+    VALID: "Valid",
+};
+var SM_AZUL_CHARGE_TYPE = {
+    FARE_PRICE: "FarePrice",
+    DISCOUNT: "Discount",
+    INCLUDED_TRAVEL_FEE: "IncludedTravelFee",
+    INCLUDED_TAX: "IncludedTax",
+    TRAVEL_FEE: "TravelFee",
+    TAX: "Tax",
+    SERVICE_CHARGE: "ServiceCharge",
+    PROMOTION_DISCOUNT: "PromotionDiscount",
+    CONNECTION_ADJUSTMENT_AMOUNT: "ConnectionAdjustmentAmount",
+    ADD_ON_SERVICE_PRICE: "AddOnServicePrice",
+    POINTS: "Points",
+    INCLUDED_ADD_ON_SERVICE_FEE: "IncludedAddOnServiceFee",
+    ADD_ON_SERVICE_FEE: "AddOnServiceFee",
+    ADD_ON_SERVICE_MARKUP: "AddOnServiceMarkup",
+    CALCULATED: "Calculated",
+    NOTE: "Note",
+};
+var SM_AZUL_COLLECT_TYPE = {
+    IMMEDIATE: "Immediate",
+    DEFERRED: "Deferred",
+};
+var SM_AZUL_PRODUCT_CLASS_NAME = {
+    AZUL: "azul",
+    AZUL_MAIS: "azul+",
+    AZUL_SOUTH_AMERICA: "azulSA",
+    AZUL_MAIS_SOUTH_AMERICA: "azul+SA",
+    AZUL_NORTH_AMERICA_AND_EUROPE: "azulEUAndSA",
+    AZUL_MAIS_NORTH_AMERICA_AND_EUROPE: "azul+EUAndSA",
+    AZUL_SUPER: "azulSuper",
+    AZUL_BUSINESS: "azulBusiness",
+};
+var SM_AZUL_TRIP_TYPE = {
+    NONE: "None",
+    ONE_WAY: "OneWay",
+    ROUND_TRIP: "RoundTrip",
+    HALF_ROUND: "HalfRound",
+    OPEN_JAW: "OpenJaw",
+    CIRCLE_TRIP: "CircleTrip",
+    ALL: "All",
+};
+var SM_AZUL_FARE_STATUS = {
+    DEFAULT: "Default",
+    SAME_DAY_STAND_BY: "SameDayStandBy",
+    FARE_OVERRIDE_CONFIRMING: "FareOverrideConfirming",
+    FARE_OVERRIDE_CONFIRMED: "FareOverrideConfirmed",
+    UNMAPPED: "Unmapped",
+};
+var SM_AZUL_FARE_APPLICATION_TYPE = {
+    ROUTE: "Route",
+    SECTOR: "Sector",
+    GOVERNING: "Governing",
+    UNMAPPED: "Unmapped",
+};
+var SM_AZUL_CHECK_IN_STATUS = {
+    NOT_YET_OPEN: "NotYetOpen",
+    OPEN: "Open",
+    CLOSED: "Closed",
+};
+var SM_AZUL_CLASS_STATUS = {
+    ACTIVE: "Active",
+    INACTIVE: "InActive",
+    AVS_OPEN: "AVSOpen",
+    AVS_ON_REQUEST: "AVSOnRequest",
+    AVS_CLOSED: "AVSClosed",
+};
+var SM_AZUL_STATE = {
+    CLEAN: "Clean",
+    NEW: "New",
+    MODIFIED: "Modified",
+    DELETED: "Deleted",
+    CONFIRMED: "Confirmed",
+};