Skip to content

ThemeParks/ThemeParks_JavaScript

Repository files navigation

themeparks

Themeparks - JavaScript client for themeparks api.themeparks.wiki This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0-alpha
  • Package version: 6.0.1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

npm

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

Then install it via:

npm install themeparks --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 themeparks 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 Themeparks = require('themeparks');


var api = new Themeparks.DestinationsApi()
api.getDestinations().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.themeparks.wiki/v1

Class Method HTTP request Description
Themeparks.DestinationsApi getDestinations GET /destinations Get a list of supported destinations available on the live API
Themeparks.EntitiesApi getEntity GET /entity/{entityID} Get entity document
Themeparks.EntitiesApi getEntityChildren GET /entity/{entityID}/children Get all children for a given entity document
Themeparks.EntitiesApi getEntityLiveData GET /entity/{entityID}/live Get live data for this entity and any child entities
Themeparks.EntitiesApi getEntityScheduleUpcoming GET /entity/{entityID}/schedule Get entity schedule
Themeparks.EntitiesApi getEntityScheduleYearMonth GET /entity/{entityID}/schedule/{year}/{month} Get entity schedule for a specific month and year

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

JavaScript library for ThemeParks.Wiki API

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published