lodgea_js

LodgeaJs - JavaScript client for lodgea_js LODGEA SDK for javascript. Check out https://docs.lodgea.io for more information. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.0
• Package version: 1.2.0
• 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 lodgea_js --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 lodgea_js 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 LodgeaJs = require('lodgea_js');

var defaultClient = LodgeaJs.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['apiKey'] = "Token"

var api = new LodgeaJs.DefaultApi()
var opts = {
  'inlineObject1': new LodgeaJs.InlineObject1() // {InlineObject1} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.availabilitySearchPost(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.eu.lodgea.io/v1

Class	Method	HTTP request	Description
LodgeaJs.DefaultApi	availabilitySearchPost	POST /availability/search	Search for availability
LodgeaJs.DefaultApi	locationSearchPost	POST /location/search	Search for location
LodgeaJs.DefaultApi	propertiesGet	GET /properties	List (filtered) properties
LodgeaJs.DefaultApi	propertiesPropertyIdAvailabilityGet	GET /properties/{propertyId}/availability	Get a properties availability
LodgeaJs.DefaultApi	propertiesPropertyIdGet	GET /properties/{propertyId}	Get a properties details

Documentation for Models

• LodgeaJs.InlineObject
• LodgeaJs.InlineObject1
• LodgeaJs.InlineResponse200
• LodgeaJs.InlineResponse2001
• LodgeaJs.InlineResponse2001AttractionList
• LodgeaJs.InlineResponse2001Distance
• LodgeaJs.InlineResponse2001Geo
• LodgeaJs.InlineResponse2001GeoLocation
• LodgeaJs.InlineResponse2001List
• LodgeaJs.InlineResponse2001LowestPrice
• LodgeaJs.InlineResponse2001MediaList
• LodgeaJs.InlineResponse2002
• LodgeaJs.InlineResponse2002List
• LodgeaJs.InlineResponse2003
• LodgeaJs.InlineResponse2003PolicyInfo
• LodgeaJs.InlineResponse2003PolicyInfoFeePolicyList
• LodgeaJs.InlineResponse2003PolicyInfoTaxPolicyList
• LodgeaJs.InlineResponse2003PricingList
• LodgeaJs.InlineResponse2003ProductList
• LodgeaJs.InlineResponse2003Property
• LodgeaJs.InlineResponse2003PropertyAddressList
• LodgeaJs.InlineResponse2003PropertyAwardList
• LodgeaJs.InlineResponse2003PropertyCancellationGracePeriod
• LodgeaJs.InlineResponse2003PropertyCancellationPolicyList
• LodgeaJs.InlineResponse2003PropertyContactList
• LodgeaJs.InlineResponse2003PropertyFacilityInfo
• LodgeaJs.InlineResponse2003PropertyFacilityInfoAmenityList
• LodgeaJs.InlineResponse2003PropertyFacilityInfoGuestRoomList
• LodgeaJs.InlineResponse2003PropertyFacilityInfoMediaList
• LodgeaJs.InlineResponse2003PropertyFacilityInfoMessageList
• LodgeaJs.InlineResponse2003PropertyFeePolicyList
• LodgeaJs.InlineResponse2003PropertyGuaranteePolicy
• LodgeaJs.InlineResponse2003PropertyGuestInfo
• LodgeaJs.InlineResponse2003PropertyMediaList
• LodgeaJs.InlineResponse2003PropertyOperationTimeList
• LodgeaJs.InlineResponse2003PropertyPetsPolicy
• LodgeaJs.InlineResponse2003PropertyPolicyList
• LodgeaJs.InlineResponse2003PropertyPropertyInfo
• LodgeaJs.InlineResponse2003PropertyPropertyInfoAcceptedPaymentList
• LodgeaJs.InlineResponse2003PropertyPropertyInfoMessageList
• LodgeaJs.InlineResponse2003PropertyRecordCreated
• LodgeaJs.InlineResponse2003PropertyRecordModified
• LodgeaJs.InlineResponse2003PropertyServiceList
• LodgeaJs.InlineResponse2003PropertyTaxPolicyList
• LodgeaJs.InlineResponse2003RatePlanList
• LodgeaJs.InlineResponse2004
• LodgeaJs.InlineResponse2004AvailabilityList
• LodgeaJs.InlineResponse2004PricingList
• LodgeaJs.InlineResponse2004RatePlanList
• LodgeaJs.InlineResponse200List
• LodgeaJs.InlineResponse400
• LodgeaJs.InlineResponse4001
• LodgeaJs.InlineResponse4001ValidationErrors
• LodgeaJs.InlineResponse400ValidationErrors

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: apiKey
• Location: HTTP header