❤
npm
Sign UpSign In

@optimiser/apaleo

1.0.5 • Public • Published

apaleo_api

ApaleoApi - JavaScript client for apaleo_api Resources and methods to manage apaleo. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: v1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install apaleo_api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your apaleo_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApaleoApi = require('apaleo_api');

var defaultClient = ApaleoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new ApaleoApi.AgeCategoryApi()
var id = "id_example"; // {String} The id of the age category.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.settingsAgeCategoriesByIdDelete(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ApaleoApi.AgeCategoryApi settingsAgeCategoriesByIdDelete DELETE /settings/v1/age-categories/{id} Delete an age category
ApaleoApi.AgeCategoryApi settingsAgeCategoriesByIdGet GET /settings/v1/age-categories/{id} Get an age category
ApaleoApi.AgeCategoryApi settingsAgeCategoriesByIdPatch PATCH /settings/v1/age-categories/{id} Allows to modify properties of an age category
ApaleoApi.AgeCategoryApi settingsAgeCategoriesGet GET /settings/v1/age-categories Get an age category list
ApaleoApi.AgeCategoryApi settingsAgeCategoriesPost POST /settings/v1/age-categories Create an age category
ApaleoApi.BlockApi bookingBlocksByIdDelete DELETE /booking/v1/blocks/{id} Delete a specific block
ApaleoApi.BlockApi bookingBlocksByIdGet GET /booking/v1/blocks/{id} Returns a specific block.
ApaleoApi.BlockApi bookingBlocksByIdHead HEAD /booking/v1/blocks/{id} Check if a block exists
ApaleoApi.BlockApi bookingBlocksByIdPatch PATCH /booking/v1/blocks/{id} Allows to modify the block [DEPRECATED]
ApaleoApi.BlockApi bookingBlocksGet GET /booking/v1/blocks Returns a list of blocks
ApaleoApi.BlockApi bookingBlocksPost POST /booking/v1/blocks Creates a block
ApaleoApi.BlockApi bookingBlockscountGet GET /booking/v1/blocks/$count Returns number of blocks
ApaleoApi.BlockActionsApi bookingBlockActionsByIdAmendPut PUT /booking/v1/block-actions/{id}/amend Allow to modify a block
ApaleoApi.BlockActionsApi bookingBlockActionsByIdCancelPut PUT /booking/v1/block-actions/{id}/cancel Cancel a block.
ApaleoApi.BlockActionsApi bookingBlockActionsByIdConfirmPut PUT /booking/v1/block-actions/{id}/confirm Confirm a block.
ApaleoApi.BlockActionsApi bookingBlockActionsByIdReleasePut PUT /booking/v1/block-actions/{id}/release Release a block.
ApaleoApi.BlockActionsApi bookingBlockActionsByIdWashPut PUT /booking/v1/block-actions/{id}/wash Wash a block.
ApaleoApi.BookingApi bookingBookingsByIdGet GET /booking/v1/bookings/{id} Returns a specific booking.
ApaleoApi.BookingApi bookingBookingsByIdPatch PATCH /booking/v1/bookings/{id} Allows to modify certain booking properties
ApaleoApi.BookingApi bookingBookingsByIdReservationsPost POST /booking/v1/bookings/{id}/reservations Add one or multiple reservations to an existing booking.
ApaleoApi.BookingApi bookingBookingsByIdReservationsforcePost POST /booking/v1/bookings/{id}/reservations/$force Add one or multiple reservations to an existing booking regardless of availability or restrictions.
ApaleoApi.BookingApi bookingBookingsGet GET /booking/v1/bookings Returns a list of all bookings, filtered by the specified parameters.
ApaleoApi.BookingApi bookingBookingsPost POST /booking/v1/bookings Creates a booking for one or more reservations.
ApaleoApi.BookingApi bookingBookingsforcePost POST /booking/v1/bookings/$force Creates a booking for one or more reservations regardless of availability or restrictions.
ApaleoApi.CancellationPolicyApi rateplanCancellationPoliciesByIdDelete DELETE /rateplan/v1/cancellation-policies/{id} Delete a cancellation policy
ApaleoApi.CancellationPolicyApi rateplanCancellationPoliciesByIdGet GET /rateplan/v1/cancellation-policies/{id} Get a specific cancellation policy.
ApaleoApi.CancellationPolicyApi rateplanCancellationPoliciesByIdPatch PATCH /rateplan/v1/cancellation-policies/{id} Allows to modify properties of a cancellation policy
ApaleoApi.CancellationPolicyApi rateplanCancellationPoliciesGet GET /rateplan/v1/cancellation-policies Get all cancellation policies.
ApaleoApi.CancellationPolicyApi rateplanCancellationPoliciesPost POST /rateplan/v1/cancellation-policies Create a cancellation policy.
ApaleoApi.CapturePoliciesApi settingsCapturePoliciesByIdGet GET /settings/v1/capture-policies/{id} Get a specific capture policy.
ApaleoApi.CapturePoliciesApi settingsCapturePoliciesByIdPatch PATCH /settings/v1/capture-policies/{id} Allows to modify properties of a capture policy.
ApaleoApi.CapturePoliciesApi settingsCapturePoliciesGet GET /settings/v1/capture-policies Get all capture policies.
ApaleoApi.CityTaxApi settingsCityTaxByIdDelete DELETE /settings/v1/city-tax/{id} Delete a city tax
ApaleoApi.CityTaxApi settingsCityTaxByIdGet GET /settings/v1/city-tax/{id} Get a specific city tax.
ApaleoApi.CityTaxApi settingsCityTaxByIdPatch PATCH /settings/v1/city-tax/{id} Allows to modify city tax
ApaleoApi.CityTaxApi settingsCityTaxGet GET /settings/v1/city-tax Get all city taxes.
ApaleoApi.CityTaxApi settingsCityTaxPost POST /settings/v1/city-tax Create a city tax.
ApaleoApi.CompanyApi rateplanCompaniesByIdDelete DELETE /rateplan/v1/companies/{id} Delete a company
ApaleoApi.CompanyApi rateplanCompaniesByIdGet GET /rateplan/v1/companies/{id} Get a company
ApaleoApi.CompanyApi rateplanCompaniesByIdPatch PATCH /rateplan/v1/companies/{id} Modify a company
ApaleoApi.CompanyApi rateplanCompaniesGet GET /rateplan/v1/companies Get a list of companies
ApaleoApi.CompanyApi rateplanCompaniesPost POST /rateplan/v1/companies Create a company
ApaleoApi.CorporateCodesApi rateplanCorporateCodesCodesGet GET /rateplan/v1/corporate-codes/codes Returns a list of corporate codes.
ApaleoApi.CustomSubAccountsApi settingsSubAccountsByIdDelete DELETE /settings/v1/sub-accounts/{id} Delete a custom sub-account
ApaleoApi.CustomSubAccountsApi settingsSubAccountsByIdGet GET /settings/v1/sub-accounts/{id} Returns one sub-account.
ApaleoApi.CustomSubAccountsApi settingsSubAccountsByIdHead HEAD /settings/v1/sub-accounts/{id} Check if the sub-account exists.
ApaleoApi.CustomSubAccountsApi settingsSubAccountsByIdPatch PATCH /settings/v1/sub-accounts/{id} Allows to modify the name of the sub-account.
ApaleoApi.CustomSubAccountsApi settingsSubAccountsGet GET /settings/v1/sub-accounts Returns a list of all sub-accounts.
ApaleoApi.CustomSubAccountsApi settingsSubAccountsPost POST /settings/v1/sub-accounts Create a sub-account.
ApaleoApi.CustomSubAccountsApi settingsSubAccountscountGet GET /settings/v1/sub-accounts/$count Returns number of sub-accounts.
ApaleoApi.FeatureSettingsApi settingsFeaturesByPropertyIdGet GET /settings/v1/features/{propertyId} Get feature settings for a property.
ApaleoApi.FeatureSettingsApi settingsFeaturesByPropertyIdPatch PATCH /settings/v1/features/{propertyId} Allows to modify feature settings
ApaleoApi.FolioApi financeFoliosByIdDelete DELETE /finance/v1/folios/{id} Deletes a folio.
ApaleoApi.FolioApi financeFoliosByIdGet GET /finance/v1/folios/{id} Returns one folio.
ApaleoApi.FolioApi financeFoliosByIdHead HEAD /finance/v1/folios/{id} Check if the folio exists.
ApaleoApi.FolioApi financeFoliosByIdPatch PATCH /finance/v1/folios/{id} Allows to modify certain properties of a folio
ApaleoApi.FolioApi financeFoliosGet GET /finance/v1/folios Returns a list of all folios.
ApaleoApi.FolioApi financeFoliosPost POST /finance/v1/folios Create additional folios for a reservation, or new external folios
ApaleoApi.FolioApi financeFolioscountGet GET /finance/v1/folios/$count Returns number of folios.
ApaleoApi.FolioActionsApi financeFolioActionsBulkMovePut PUT /finance/v1/folio-actions/bulk-move Move multiple charges from one folio to another. Multiple source folios and multiple target folios can be specified.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdAllowancesPost POST /finance/v1/folio-actions/{folioId}/allowances Posts an allowance for a folio
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdBulkAllowancesPost POST /finance/v1/folio-actions/{folioId}/bulk-allowances Posts allowances for a folio
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdCancellationFeePost POST /finance/v1/folio-actions/{folioId}/cancellation-fee Adds and directly posts a cancellation fee to the folio. If there are any fees configured for the property, an additional charge for each configured fee will be added. If a routing instruction is defined for the cancellation fee service type, the fee will be moved to the destination folio.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdChargesByChargeIdAllowancesPost POST /finance/v1/folio-actions/{folioId}/charges/{chargeId}/allowances Posts an allowance for a charge
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdChargesByChargeIdSplitPost POST /finance/v1/folio-actions/{folioId}/charges/{chargeId}/split Splits a charge into two using the percent or amount provided Creates an allowance and two new charges.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdChargesPost POST /finance/v1/folio-actions/{folioId}/charges Adds and directly posts a charge to the folio. If there are any fees configured for the property, an additional charge for each configured fee will be added.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdClosePut PUT /finance/v1/folio-actions/{folioId}/close Closes a folio.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdCorrectPost POST /finance/v1/folio-actions/{folioId}/correct Corrects a folio by moving some charges. This operation creates a new folio with the charges from the request. The payment, equal to the sum of charges, is also split to this new folio so that both folios will have 0 balance.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdMoveAllChargesPut PUT /finance/v1/folio-actions/{folioId}/move-all-charges Move all charges and transitory charges from one folio to another.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdMoveChargesPut PUT /finance/v1/folio-actions/{folioId}/move-charges Move multiple charges, allowances and transitory charges from one folio to another.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdMovePaymentsPut PUT /finance/v1/folio-actions/{folioId}/move-payments Move multiple payments from one guest/booking folio to another.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdNoShowFeePost POST /finance/v1/folio-actions/{folioId}/no-show-fee Adds and directly posts a no-show fee to the folio. If there are any fees configured for the property, an additional charge for each configured fee will be added. If a routing instruction is defined for the no-show fee service type, the fee will be moved to the destination folio.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdPaymentsByPaymentIdSplitPost POST /finance/v1/folio-actions/{folioId}/payments/{paymentId}/split Splits a payment into two using the percent or amount provided Creates a refund and two new payments.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdPostChargesPut PUT /finance/v1/folio-actions/{folioId}/post-charges Posts all unposted charges for the whole length of stay.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdReopenPut PUT /finance/v1/folio-actions/{folioId}/reopen Reopens a folio.
ApaleoApi.FolioActionsApi financeFolioActionsByFolioIdTransitoryChargesPost POST /finance/v1/folio-actions/{folioId}/transitory-charges Adds and directly posts a transitory charge to the folio. If there are any fees configured for the property, an additional charge for each configured fee will be added.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByAuthorizationPost POST /finance/v1/folios/{folioId}/payments/by-authorization Captures a specific amount from a pre-authorization and posts it to the folio.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByLinkPost POST /finance/v1/folios/{folioId}/payments/by-link Creates a link to a payment form where guests can pay.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByPaymentAccountPost POST /finance/v1/folios/{folioId}/payments/by-payment-account Trigger a payment using the payment account stored on the reservation.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByPaymentIdCancelPut PUT /finance/v1/folios/{folioId}/payments/{paymentId}/cancel Cancels a payment.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByPaymentIdGet GET /finance/v1/folios/{folioId}/payments/{paymentId} Get a payment by ID.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByPaymentIdRefundsPost POST /finance/v1/folios/{folioId}/payments/{paymentId}/refunds Trigger a refund for a specific payment.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsByTerminalPost POST /finance/v1/folios/{folioId}/payments/by-terminal Trigger a payment on a card terminal for the folio.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsGet GET /finance/v1/folios/{folioId}/payments Get a list of payments.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdPaymentsPost POST /finance/v1/folios/{folioId}/payments Trigger a custom payment for the folio.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdRefundsByRefundIdGet GET /finance/v1/folios/{folioId}/refunds/{refundId} Get a refund by ID.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdRefundsGet GET /finance/v1/folios/{folioId}/refunds Get a list of refunds.
ApaleoApi.FolioPaymentsApi financeFoliosByFolioIdRefundsPost POST /finance/v1/folios/{folioId}/refunds Trigger a refund for the folio.
ApaleoApi.GroupApi bookingGroupsByIdDelete DELETE /booking/v1/groups/{id} Delete a certain group booking
ApaleoApi.GroupApi bookingGroupsByIdGet GET /booking/v1/groups/{id} Returns a specific group booking.
ApaleoApi.GroupApi bookingGroupsByIdHead HEAD /booking/v1/groups/{id} Check if a certain group booking exists
ApaleoApi.GroupApi bookingGroupsByIdPatch PATCH /booking/v1/groups/{id} Allows to modify certain group booking properties
ApaleoApi.GroupApi bookingGroupsByIdReservationsPost POST /booking/v1/groups/{id}/reservations Add one or multiple reservations to an existing group booking using blocked inventory.
ApaleoApi.GroupApi bookingGroupsGet GET /booking/v1/groups Returns a list of all group bookings, filtered by the specified parameters.
ApaleoApi.GroupApi bookingGroupsPost POST /booking/v1/groups Creates a group booking.
ApaleoApi.GroupApi bookingGroupscountGet GET /booking/v1/groups/$count Returns number of group bookings
ApaleoApi.InvoiceApi financeInvoicesByIdGet GET /finance/v1/invoices/{id} Gets invoice data.
ApaleoApi.InvoiceApi financeInvoicesByIdPdfGet GET /finance/v1/invoices/{id}/pdf Gets an invoice PDF file.
ApaleoApi.InvoiceApi financeInvoicesGet GET /finance/v1/invoices Gets the list of all invoices (the metadata only, not the files).
ApaleoApi.InvoiceApi financeInvoicesPost POST /finance/v1/invoices Creates an invoice for one specific folio.
ApaleoApi.InvoiceApi financeInvoicesPreviewGet GET /finance/v1/invoices/preview Gets an invoice preview for one specific folio.
ApaleoApi.InvoiceApi financeInvoicesPreviewPdfGet GET /finance/v1/invoices/preview-pdf Gets a preview invoice PDF for one specific folio.
ApaleoApi.InvoiceActionApi financeInvoiceActionsByIdCancelPut PUT /finance/v1/invoice-actions/{id}/cancel Cancels an invoice
ApaleoApi.InvoiceActionApi financeInvoiceActionsByIdPayPut PUT /finance/v1/invoice-actions/{id}/pay Marks an invoice as paid.
ApaleoApi.InvoiceAddressApi settingsInvoiceAddressGet GET /settings/v1/invoice-address Get invoice addresses
ApaleoApi.InvoiceAddressApi settingsInvoiceAddressPatch PATCH /settings/v1/invoice-address Change fields in the invoice address of one or more properties.
ApaleoApi.InvoiceAddressApi settingsInvoiceAddressPut PUT /settings/v1/invoice-address Create or update invoice addresses for one or more properties.
ApaleoApi.LanguagesApi settingsLanguagesGet GET /settings/v1/languages Get the language settings for the account
ApaleoApi.LanguagesApi settingsLanguagesPut PUT /settings/v1/languages Replaces the language settings for the account
ApaleoApi.MarketSegmentApi settingsMarketSegmentsByIdDelete DELETE /settings/v1/market-segments/{id} Delete a market segment.
ApaleoApi.MarketSegmentApi settingsMarketSegmentsByIdGet GET /settings/v1/market-segments/{id} Get a market segment.
ApaleoApi.MarketSegmentApi settingsMarketSegmentsByIdHead HEAD /settings/v1/market-segments/{id} Check if a market segment exists.
ApaleoApi.MarketSegmentApi settingsMarketSegmentsByIdPatch PATCH /settings/v1/market-segments/{id} Allows to modify market segment.
ApaleoApi.MarketSegmentApi settingsMarketSegmentsGet GET /settings/v1/market-segments Returns a list of all market segments, filtered by the specified parameters.
ApaleoApi.MarketSegmentApi settingsMarketSegmentsPost POST /settings/v1/market-segments Create a market segment
ApaleoApi.MarketSegmentApi settingsMarketSegmentscountGet GET /settings/v1/market-segments/$count Returns number of market segments.
ApaleoApi.NoShowPolicyApi rateplanNoShowPoliciesByIdDelete DELETE /rateplan/v1/no-show-policies/{id} Delete a no-show policy
ApaleoApi.NoShowPolicyApi rateplanNoShowPoliciesByIdGet GET /rateplan/v1/no-show-policies/{id} Get a specific no-show policy.
ApaleoApi.NoShowPolicyApi rateplanNoShowPoliciesByIdPatch PATCH /rateplan/v1/no-show-policies/{id} Allows to modify properties of a no-show policy
ApaleoApi.NoShowPolicyApi rateplanNoShowPoliciesGet GET /rateplan/v1/no-show-policies Get all no-show policies.
ApaleoApi.NoShowPolicyApi rateplanNoShowPoliciesPost POST /rateplan/v1/no-show-policies Create a no-show policy.
ApaleoApi.OfferApi bookingOfferIndexGet GET /booking/v1/offer-index Returns offers with rates and availabilities for the specified range.
ApaleoApi.OfferApi bookingOffersGet GET /booking/v1/offers Returns offers for one specific stay.
ApaleoApi.OfferApi bookingRatePlanOffersGet GET /booking/v1/rate-plan-offers Returns offers for a specific rate plan.
ApaleoApi.OfferApi bookingServiceOffersGet GET /booking/v1/service-offers Returns service offers for one specific stay.
ApaleoApi.PromoCodesApi rateplanPromoCodesCodesGet GET /rateplan/v1/promo-codes/codes Returns a list of promo codes.
ApaleoApi.PropertyApi inventoryPropertiesByIdGet GET /inventory/v1/properties/{id} Get a property
ApaleoApi.PropertyApi inventoryPropertiesByIdHead HEAD /inventory/v1/properties/{id} Check if a property exists
ApaleoApi.PropertyApi inventoryPropertiesByIdPatch PATCH /inventory/v1/properties/{id} Allows to modify property
ApaleoApi.PropertyApi inventoryPropertiesGet GET /inventory/v1/properties Get a properties list
ApaleoApi.PropertyApi inventoryPropertiesPost POST /inventory/v1/properties Creates a property
ApaleoApi.PropertyApi inventoryPropertiescountGet GET /inventory/v1/properties/$count Return total count of properties
ApaleoApi.PropertyActionsApi inventoryPropertyActionsByIdArchivePut PUT /inventory/v1/property-actions/{id}/archive Archive a property
ApaleoApi.PropertyActionsApi inventoryPropertyActionsByIdClonePost POST /inventory/v1/property-actions/{id}/clone Clones a property
ApaleoApi.PropertyActionsApi inventoryPropertyActionsByIdResetPut PUT /inventory/v1/property-actions/{id}/reset Reset a test property and delete all transactional data
ApaleoApi.PropertyActionsApi inventoryPropertyActionsByIdSetLivePut PUT /inventory/v1/property-actions/{id}/set-live Move property to live
ApaleoApi.PropertySettingsApi settingsPropertiesByIdGet GET /settings/v1/properties/{id} Get property settings
ApaleoApi.RateApi rateplanRatePlansByIdRatesDelete DELETE /rateplan/v1/rate-plans/{id}/rates Deletes the rates for the rate plan
ApaleoApi.RateApi rateplanRatePlansByIdRatesGet GET /rateplan/v1/rate-plans/{id}/rates Returns a list of rates.
ApaleoApi.RateApi rateplanRatePlansByIdRatesPut PUT /rateplan/v1/rate-plans/{id}/rates Initializes and changes the rates for the rate plan.
ApaleoApi.RateApi rateplanRatePlansByIdRatescountGet GET /rateplan/v1/rate-plans/{id}/rates/$count Returns the number of rates for a specific rate plan within the specifed time range.
ApaleoApi.RateApi rateplanRatesPatch PATCH /rateplan/v1/rates Allows to patch the rates of multiple rate plans.
ApaleoApi.RatePlanApi rateplanRatePlansByIdDelete DELETE /rateplan/v1/rate-plans/{id} Delete a rate plan
ApaleoApi.RatePlanApi rateplanRatePlansByIdGet GET /rateplan/v1/rate-plans/{id} Get a rate plan
ApaleoApi.RatePlanApi rateplanRatePlansByIdHead HEAD /rateplan/v1/rate-plans/{id} Check if a rate plan exists
ApaleoApi.RatePlanApi rateplanRatePlansByIdPut PUT /rateplan/v1/rate-plans/{id} Replace a rate plan
ApaleoApi.RatePlanApi rateplanRatePlansDelete DELETE /rateplan/v1/rate-plans Delete multiple rate plans
ApaleoApi.RatePlanApi rateplanRatePlansGet GET /rateplan/v1/rate-plans Get a rate plan list
ApaleoApi.RatePlanApi rateplanRatePlansPatch PATCH /rateplan/v1/rate-plans Allows to patch one or more rate plans
ApaleoApi.RatePlanApi rateplanRatePlansPost POST /rateplan/v1/rate-plans Create a rate plan
ApaleoApi.RatePlanApi rateplanRatePlanscountGet GET /rateplan/v1/rate-plans/$count Returns number of rate plans
ApaleoApi.RatePlanCodesApi rateplanRateplanCodesGet GET /rateplan/v1/rateplan-codes Returns a list of rate plan codes.
ApaleoApi.ReservationApi bookingReservationsByIdGet GET /booking/v1/reservations/{id} Returns a specific reservation.
ApaleoApi.ReservationApi bookingReservationsByIdOffersGet GET /booking/v1/reservations/{id}/offers Returns offers for one specific reservation.
ApaleoApi.ReservationApi bookingReservationsByIdPatch PATCH /booking/v1/reservations/{id} Allows to modify certain reservation properties
ApaleoApi.ReservationApi bookingReservationsByIdServiceOffersGet GET /booking/v1/reservations/{id}/service-offers Returns service offers for one specific reservation.
ApaleoApi.ReservationApi bookingReservationsByIdServicesDelete DELETE /booking/v1/reservations/{id}/services Removes a service from a reservation.
ApaleoApi.ReservationApi bookingReservationsByIdServicesGet GET /booking/v1/reservations/{id}/services Returns the services booked for a specific reservation.
ApaleoApi.ReservationApi bookingReservationsGet GET /booking/v1/reservations Returns a list of all reservations, filtered by the specified parameters.
ApaleoApi.ReservationApi bookingReservationscountGet GET /booking/v1/reservations/$count Returns the number of reservations fulfilling the criteria specified in the parameters.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdAddCityTaxPut PUT /booking/v1/reservation-actions/{id}/add-city-tax Adds the city tax to a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdAmendPut PUT /booking/v1/reservation-actions/{id}/amend Allows you to amend the stay details of a reservation
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdAmendforcePut PUT /booking/v1/reservation-actions/{id}/amend/$force Allows you to amend the stay details of a reservation regardless of availability or restrictions.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdAssignUnitByUnitIdPut PUT /booking/v1/reservation-actions/{id}/assign-unit/{unitId} Assign a specific unit to a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdAssignUnitPut PUT /booking/v1/reservation-actions/{id}/assign-unit Assign a unit to a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdBookServicePut PUT /booking/v1/reservation-actions/{id}/book-service Book the service for a specific reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdBookServiceforcePut PUT /booking/v1/reservation-actions/{id}/book-service/$force Book the service for a specific reservation regardless of availability.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdCancelPut PUT /booking/v1/reservation-actions/{id}/cancel Cancel a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdCheckinPut PUT /booking/v1/reservation-actions/{id}/checkin Check-in of a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdCheckoutPut PUT /booking/v1/reservation-actions/{id}/checkout Check-out of a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdNoshowPut PUT /booking/v1/reservation-actions/{id}/noshow Set a reservation to No-show.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdRemoveCityTaxPut PUT /booking/v1/reservation-actions/{id}/remove-city-tax Removes the city tax from a reservation.
ApaleoApi.ReservationActionsApi bookingReservationActionsByIdUnassignUnitsPut PUT /booking/v1/reservation-actions/{id}/unassign-units Unassign units from a reservation.
ApaleoApi.ServiceApi rateplanServicesByIdDelete DELETE /rateplan/v1/services/{id} Delete a service
ApaleoApi.ServiceApi rateplanServicesByIdGet GET /rateplan/v1/services/{id} Get a specific service.
ApaleoApi.ServiceApi rateplanServicesByIdHead HEAD /rateplan/v1/services/{id} Check if a service exists
ApaleoApi.ServiceApi rateplanServicesByIdPatch PATCH /rateplan/v1/services/{id} Modify a service.
ApaleoApi.ServiceApi rateplanServicesGet GET /rateplan/v1/services Get all services.
ApaleoApi.ServiceApi rateplanServicesPost POST /rateplan/v1/services Create a service.
ApaleoApi.ServiceApi rateplanServicescountGet GET /rateplan/v1/services/$count Returns number of services.
ApaleoApi.SubLedgerApi financeAccountsAggregateDailyPost POST /finance/v1/accounts/aggregate-daily Aggregates transactions by date (business day) for all accounts and a given period.
ApaleoApi.SubLedgerApi financeAccountsAggregatePairsDailyPost POST /finance/v1/accounts/aggregate-pairs-daily Aggregates transactions pairs by date (business day) for all accounts and a given period.
ApaleoApi.SubLedgerApi financeAccountsAggregatePost POST /finance/v1/accounts/aggregate Aggregates transactions by timestamp for all accounts and a given period.
ApaleoApi.SubLedgerApi financeAccountsByNumberGet GET /finance/v1/accounts/{number} Returns one account.
ApaleoApi.SubLedgerApi financeAccountsChildAccountsGet GET /finance/v1/accounts/child-accounts Returns a list of child accounts for a specified parent account.
ApaleoApi.SubLedgerApi financeAccountsExportDailyPost POST /finance/v1/accounts/export-daily Returns transactions filtered by date (business day) for a property for a given period.
ApaleoApi.SubLedgerApi financeAccountsExportGrossDailyPost POST /finance/v1/accounts/export-gross-daily Returns gross transactions filtered by date (business day) for a property for a given period.
ApaleoApi.SubLedgerApi financeAccountsExportPost POST /finance/v1/accounts/export Returns transactions filtered by timestamp for a property for a given period.
ApaleoApi.SubLedgerApi financeAccountsSchemaGet GET /finance/v1/accounts/schema Returns the chart of accounts of the subledger.
ApaleoApi.SubLedgerApi financeExternalAccountsGet GET /finance/v1/external-accounts Returns a list of external accounts.
ApaleoApi.SubLedgerApi financeGlobalAccountsGet GET /finance/v1/global-accounts Returns a list of global accounts.
ApaleoApi.SubLedgerApi financeGuestAccountsGet GET /finance/v1/guest-accounts Returns a list of guest accounts.
ApaleoApi.TimeSliceDefinitionsApi settingsPropertiesByPropertyIdTimeSliceDefinitionsByIdDelete DELETE /settings/v1/properties/{propertyId}/time-slice-definitions/{id} Delete a certain time slice definition
ApaleoApi.TimeSliceDefinitionsApi settingsPropertiesByPropertyIdTimeSliceDefinitionsByIdGet GET /settings/v1/properties/{propertyId}/time-slice-definitions/{id} Get a specific time slice definition
ApaleoApi.TimeSliceDefinitionsApi settingsPropertiesByPropertyIdTimeSliceDefinitionsByIdPatch PATCH /settings/v1/properties/{propertyId}/time-slice-definitions/{id} Modifies a specific time slice definition for the property
ApaleoApi.TimeSliceDefinitionsApi settingsPropertiesByPropertyIdTimeSliceDefinitionsGet GET /settings/v1/properties/{propertyId}/time-slice-definitions Get time slice definitions
ApaleoApi.TimeSliceDefinitionsApi settingsPropertiesByPropertyIdTimeSliceDefinitionsPost POST /settings/v1/properties/{propertyId}/time-slice-definitions Creates a time slice definition
ApaleoApi.TypesApi bookingTypesSourcesGet GET /booking/v1/types/sources Returns a list of supported sources.
ApaleoApi.TypesApi financeTypesCurrenciesGet GET /finance/v1/types/currencies Returns a list of all currencies.
ApaleoApi.TypesApi financeTypesPaymentMethodsGet GET /finance/v1/types/payment-methods Returns a list of all supported payment methods.
ApaleoApi.TypesApi financeTypesServiceTypesGet GET /finance/v1/types/service-types Returns a list of all supported service types.
ApaleoApi.TypesApi financeTypesVatGet GET /finance/v1/types/vat Returns a list of all VAT types.
ApaleoApi.TypesApi inventoryTypesCountriesGet GET /inventory/v1/types/countries Returns a list of supported countries.
ApaleoApi.UnitApi inventoryUnitsBulkPost POST /inventory/v1/units/bulk Create multiple units
ApaleoApi.UnitApi inventoryUnitsByIdDelete DELETE /inventory/v1/units/{id} Delete a unit
ApaleoApi.UnitApi inventoryUnitsByIdGet GET /inventory/v1/units/{id} Get a unit
ApaleoApi.UnitApi inventoryUnitsByIdHead HEAD /inventory/v1/units/{id} Check if a unit exists
ApaleoApi.UnitApi inventoryUnitsByIdPatch PATCH /inventory/v1/units/{id} Allows to patch unit
ApaleoApi.UnitApi inventoryUnitsGet GET /inventory/v1/units Get a units list
ApaleoApi.UnitApi inventoryUnitsPatch PATCH /inventory/v1/units Allows to patch one or more units
ApaleoApi.UnitApi inventoryUnitsPost POST /inventory/v1/units Create a unit
ApaleoApi.UnitApi inventoryUnitscountGet GET /inventory/v1/units/$count Returns number of units
ApaleoApi.UnitAttributeApi inventoryUnitAttributesByIdDelete DELETE /inventory/v1/unit-attributes/{id} Deletes unit attribute
ApaleoApi.UnitAttributeApi inventoryUnitAttributesByIdGet GET /inventory/v1/unit-attributes/{id} Get unit attribute by id
ApaleoApi.UnitAttributeApi inventoryUnitAttributesByIdHead HEAD /inventory/v1/unit-attributes/{id} Check if a unit attribute exists
ApaleoApi.UnitAttributeApi inventoryUnitAttributesByIdPatch PATCH /inventory/v1/unit-attributes/{id} Allows to modify unit attribute
ApaleoApi.UnitAttributeApi inventoryUnitAttributesGet GET /inventory/v1/unit-attributes Get unit attribute list
ApaleoApi.UnitAttributeApi inventoryUnitAttributesPost POST /inventory/v1/unit-attributes Create a unit attribute
ApaleoApi.UnitGroupApi inventoryUnitGroupsByIdDelete DELETE /inventory/v1/unit-groups/{id} Delete a unit group
ApaleoApi.UnitGroupApi inventoryUnitGroupsByIdGet GET /inventory/v1/unit-groups/{id} Get a unit group
ApaleoApi.UnitGroupApi inventoryUnitGroupsByIdHead HEAD /inventory/v1/unit-groups/{id} Check if a unit group exists
ApaleoApi.UnitGroupApi inventoryUnitGroupsByIdPut PUT /inventory/v1/unit-groups/{id} Replace a unit group
ApaleoApi.UnitGroupApi inventoryUnitGroupsGet GET /inventory/v1/unit-groups Get all unit groups, or all unit groups for a property
ApaleoApi.UnitGroupApi inventoryUnitGroupsPost POST /inventory/v1/unit-groups Create a unit group
ApaleoApi.UnitGroupApi inventoryUnitGroupscountGet GET /inventory/v1/unit-groups/$count Returns number of unit groups

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

oauth2

Readme

Keywords

none

Package Sidebar

Install

npm i @optimiser/apaleo

Weekly Downloads

5

Version

1.0.5

License

ISC

Unpacked Size

1.3 MB

Total Files

374

Last publish

Collaborators

  • glotelligence
Try on RunKit
Report malware