Skip to content

Latest commit

 

History

History
124 lines (89 loc) · 7.37 KB

README.md

File metadata and controls

124 lines (89 loc) · 7.37 KB

pms-connect 🏨

A common interface for handling pms data at @cord-travel

Available Adapters 🔩

Repository PMS API Driver Web Hooks ARI Subscription Booking
@cord-travel/pms-connect-apaleo Apaleo 🦁 Rest ✅ Yes ✅ Yes [WIP]

Create New Adapters 🍯

Create your own pms connect adapters by implement the IBaseAdapter interface

Example 🐣 :

import {
  IBaseAdapter,
  RestRequestDriver,
  Models
} from '@cord-travel/pms-connect';

class MyAdapter extends RestRequestDriver implements IBaseAdapter {
  // Implement all available methods here...
  // ...
}

API Reference 📚 [WIP]

IBaseAdapter Interface methods

This methods are implemented in adapters. all methods return Promise

Account

Method Drescription Params Return
getAccount Get Authorized account details None

Hotel

Method Description Params Return
getHotels List hotels None IConnected_ListOf<IConnected_Hotel>
getHotelById Get a single hotel details by id ID IConnected_Hotel

RoomType

Method Description Params Return
getRoomsTypes List room types HotelId IConnected_ListOf<IConnected_RoomType>
getRoomTypeById Room type detail RoomTypeId IConnected_RoomType

RatePlan

Method Description Params Return
getRatePlansByHotelId Get rateplan list by hotel hotelId IConnected_ListOf<IConnected_RatePlan>
getRatePlanById Get rateplan details id IConnected_RatePlan

Rate

Method Description Params Return
getRatesByRatePlan Get rates rateplan<IConnected_RatePlan> or <IConnected_RatePlanItem> IConnected_ListOf<IConnected_Rate>

Policies

Method Description Params Return
getCancellationPolicies Get list of cancellation policies hotelId IConnected_ListOf<IConnected_CancellationPolicy>
getCancellationPolicyById Cancellation policy id IConnected_CancellationPolicy
getNoShowPolicies List of no show policies hotelId IConnected_ListOf<IConnected_NoShowPolicy>
getNoShowPolicyById No show policy id IConnected_NoShowPolicy

Categories

Method Description Params Return
getAgeCategories Get list of age categories hotelId IConnected_ListOf<IConnected_AgeCategory>
getAgeCategoryById Get age catgory by id id IConnected_AgeCategory

Services

Method Description Params Return
getServices Get list of services hotelId IConnected_ListOf<IConnected_Service>
getServiceById Get service by id id IConnected_Service

TimeSlice Definition

Method Description Params Return
getTimeSliceDefinitions Get list of TimeSlice Definition hotelId IConnected_ListOf<IConnected_TimeSliceDefinition>
getTimeSliceDefinitionDetail Get TimeSlice Definition Details hotel_id, id IConnected_TimeSliceDefinition

Promo codes

Method Description Params Return
getPromoCodes Get list of promo codes none IConnected_ListOf<IConnected_PromoCode>

Webhook Subscriptions

Method Description Params Return
webhooksList List webhook subscriptions none IConnected_WebHookDefinition[]
webhooksGetById Get webhook subscription by id id IConnected_WebHookDefinition
webhooksCreate Create webhook subscription body <IConnected_WebHookDefinition> id
webhooksUpdate Update webhook subscription body <IConnected_WebHookDefinition> id
webhooksDelete Delete webhook subscription id id

ARI Data subscription

Method Description Params Return
getARISubscriptions List ari subscriptions none IConnected_SubscriptionDefinition[]
getARISubscriptionById Get subscription details id IConnected_SubscriptionDefinition
createARISubscription Create new ari subscription data<IConnected_SubscriptionBody> id
updateARISubscription Update ari subscription data<IConnected_SubscriptionBody> id
deleteARISubscription Delete ari subscription id id
triggerARISubscriptionEvent Trigger ari events id, event id