fast_api

FastApi - JavaScript client for fast_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.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 fast_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 fast_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 FastApi = require('fast_api');


var api = new FastApi.AdminApi()
var urlId = 56; // {Number} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateOrDeactivateUrlApiV1AdminUrlUrlIdActivatePut(urlId, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
FastApi.AdminApi	activateOrDeactivateUrlApiV1AdminUrlUrlIdActivatePut	PUT /api/v1/admin/url/{url_id}/activate	Activate Or Deactivate Url
FastApi.AdminApi	deletePlaylistApiV1AdminPlaylistPlaylistIdDelete	DELETE /api/v1/admin/playlist/{playlist_id}	Delete Playlist
FastApi.AdminApi	deleteUrlApiV1AdminUrlUrlIdDelete	DELETE /api/v1/admin/url/{url_id}	Delete Url
FastApi.AdminApi	getPlaylistApiV1AdminPlaylistPlaylistIdGet	GET /api/v1/admin/playlist/{playlist_id}	Get Playlist
FastApi.AdminApi	getPlaylistsApiV1AdminPlaylistGet	GET /api/v1/admin/playlist/	Get Playlists
FastApi.AdminApi	getUrlApiV1AdminUrlUrlIdGet	GET /api/v1/admin/url/{url_id}	Get Url
FastApi.AdminApi	getUrlsApiV1AdminUrlGet	GET /api/v1/admin/url/	Get Urls
FastApi.AdminApi	newPlaylistApiV1AdminPlaylistPost	POST /api/v1/admin/playlist/	New Playlist
FastApi.AdminApi	newUrlApiV1AdminUrlPost	POST /api/v1/admin/url/	New Url
FastApi.AdminApi	updateCoverImageApiV1AdminPlaylistPlaylistIdCoverImagePut	PUT /api/v1/admin/playlist/{playlist_id}/cover-image	Update Cover Image
FastApi.AdminApi	updatePlaylistApiV1AdminPlaylistPlaylistIdPut	PUT /api/v1/admin/playlist/{playlist_id}	Update Playlist
FastApi.AdminApi	updateUrlApiV1AdminUrlUrlIdPut	PUT /api/v1/admin/url/{url_id}	Update Url
FastApi.DefaultApi	readRootGet	GET /	Read Root
FastApi.PlaylistApi	deletePlaylistApiV1AdminPlaylistPlaylistIdDelete	DELETE /api/v1/admin/playlist/{playlist_id}	Delete Playlist
FastApi.PlaylistApi	getPlaylistApiV1AdminPlaylistPlaylistIdGet	GET /api/v1/admin/playlist/{playlist_id}	Get Playlist
FastApi.PlaylistApi	getPlaylistsApiV1AdminPlaylistGet	GET /api/v1/admin/playlist/	Get Playlists
FastApi.PlaylistApi	newPlaylistApiV1AdminPlaylistPost	POST /api/v1/admin/playlist/	New Playlist
FastApi.PlaylistApi	updateCoverImageApiV1AdminPlaylistPlaylistIdCoverImagePut	PUT /api/v1/admin/playlist/{playlist_id}/cover-image	Update Cover Image
FastApi.PlaylistApi	updatePlaylistApiV1AdminPlaylistPlaylistIdPut	PUT /api/v1/admin/playlist/{playlist_id}	Update Playlist
FastApi.SpotifyApi	callbackApiV1CallbackGet	GET /api/v1/callback	Callback
FastApi.SpotifyApi	loginApiV1LoginGet	GET /api/v1/login	Login
FastApi.UrlApi	activateOrDeactivateUrlApiV1AdminUrlUrlIdActivatePut	PUT /api/v1/admin/url/{url_id}/activate	Activate Or Deactivate Url
FastApi.UrlApi	deleteUrlApiV1AdminUrlUrlIdDelete	DELETE /api/v1/admin/url/{url_id}	Delete Url
FastApi.UrlApi	getUrlApiV1AdminUrlUrlIdGet	GET /api/v1/admin/url/{url_id}	Get Url
FastApi.UrlApi	getUrlsApiV1AdminUrlGet	GET /api/v1/admin/url/	Get Urls
FastApi.UrlApi	newUrlApiV1AdminUrlPost	POST /api/v1/admin/url/	New Url
FastApi.UrlApi	updateUrlApiV1AdminUrlUrlIdPut	PUT /api/v1/admin/url/{url_id}	Update Url
FastApi.UserApi	getUrlPlaylistsApiV1UserUrlUrlCodeGet	GET /api/v1/user/url/{url_code}	Get Url Playlists
FastApi.UserApi	getUserRatingApiV1UserPlaylistSpotifyPlaylistIdRatingGet	GET /api/v1/user/playlist/{spotify_playlist_id}/rating	Get User Rating
FastApi.UserApi	rateOrUpdateRatingApiV1UserPlaylistSpotifyPlaylistIdRatePost	POST /api/v1/user/playlist/{spotify_playlist_id}/rate	Rate Or Update Rating

Documentation for Models

• FastApi.HTTPValidationError
• FastApi.PlaylistCreate
• FastApi.PlaylistUpdate
• FastApi.RatingSchema
• FastApi.URLCreateUpdate
• FastApi.ValidationError
• FastApi.ValidationErrorLocInner

Documentation for Authorization

Endpoints do not require authorization.