dreamtable_api

API_for_Dreamtable_Backend

Usage no npm install needed!

<script type="module">
  import dreamtableApi from 'https://cdn.skypack.dev/dreamtable_api';
</script>

README

dreamtable_api

DreamtableApi - JavaScript client for dreamtable_api API for Dreamtable Backend This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • 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 dreamtable_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 dreamtable_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 DreamtableApi = require('dreamtable_api');

var defaultClient = DreamtableApi.ApiClient.instance;
// Configure Bearer (Bearer) access token for authorization: jwtAuth
var jwtAuth = defaultClient.authentications['jwtAuth'];
jwtAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new DreamtableApi.GameApi()
var id = 56; // {Number} A unique integer value identifying this character sheets.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.gameCharacterSheetDestroy(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DreamtableApi.GameApi gameCharacterSheetDestroy DELETE /game/character-sheet/{id}/
DreamtableApi.GameApi gameCharacterSheetList GET /game/character-sheet/
DreamtableApi.GameApi gameCharacterSheetPartialUpdate PATCH /game/character-sheet/{id}/
DreamtableApi.GameApi gameCharacterSheetRetrieve GET /game/character-sheet/{id}/
DreamtableApi.GameApi gameCharacterSheetUpdate PUT /game/character-sheet/{id}/
DreamtableApi.GameApi gameInvitationDestroy DELETE /game/invitation/{id}/
DreamtableApi.GameApi gameInvitationList GET /game/invitation/
DreamtableApi.GameApi gameInvitationPartialUpdate PATCH /game/invitation/{id}/
DreamtableApi.GameApi gameInvitationRetrieve GET /game/invitation/{id}/
DreamtableApi.GameApi gameInvitationUpdate PUT /game/invitation/{id}/
DreamtableApi.GameApi gameListAddCsCreate POST /game/list/{game_pk}/add-cs
DreamtableApi.GameApi gameListAddMapCreate POST /game/list/{game_pk}/add-map
DreamtableApi.GameApi gameListAddMembershipsCreate POST /game/list/{game_pk}/add-memberships
DreamtableApi.GameApi gameListCreate POST /game/list/
DreamtableApi.GameApi gameListDestroy DELETE /game/list/{id}/
DreamtableApi.GameApi gameListInviteCreate POST /game/list/{game_pk}/invite
DreamtableApi.GameApi gameListList GET /game/list/
DreamtableApi.GameApi gameListPartialUpdate PATCH /game/list/{id}/
DreamtableApi.GameApi gameListRetrieve GET /game/list/{id}/
DreamtableApi.GameApi gameListUpdate PUT /game/list/{id}/
DreamtableApi.GameApi gameMapsDestroy DELETE /game/maps/{id}/
DreamtableApi.GameApi gameMapsList GET /game/maps/
DreamtableApi.GameApi gameMapsPartialUpdate PATCH /game/maps/{id}/
DreamtableApi.GameApi gameMapsRetrieve GET /game/maps/{id}/
DreamtableApi.GameApi gameMapsUpdate PUT /game/maps/{id}/
DreamtableApi.GameApi gameMembershipsDestroy DELETE /game/memberships/{id}/
DreamtableApi.GameApi gameMembershipsList GET /game/memberships/
DreamtableApi.GameApi gameMembershipsPartialUpdate PATCH /game/memberships/{id}/
DreamtableApi.GameApi gameMembershipsRetrieve GET /game/memberships/{id}/
DreamtableApi.GameApi gameMembershipsUpdate PUT /game/memberships/{id}/
DreamtableApi.ProfileApi profileAddFriendCreate POST /profile/add-friend/
DreamtableApi.ProfileApi profileAddFriendDestroy DELETE /profile/add-friend/{id}/
DreamtableApi.ProfileApi profileAddFriendList GET /profile/add-friend/
DreamtableApi.ProfileApi profileAddFriendPartialUpdate PATCH /profile/add-friend/{id}/
DreamtableApi.ProfileApi profileAddFriendRetrieve GET /profile/add-friend/{id}/
DreamtableApi.ProfileApi profileAddFriendUpdate PUT /profile/add-friend/{id}/
DreamtableApi.ProfileApi profileChangePasswordUpdate PUT /profile/change-password
DreamtableApi.ProfileApi profileDetailRetrieve GET /profile/detail/{slug}
DreamtableApi.ProfileApi profileListList GET /profile/list
DreamtableApi.ProfileApi profileMePartialUpdate PATCH /profile/me
DreamtableApi.ProfileApi profileMeRetrieve GET /profile/me
DreamtableApi.ProfileApi profileMeUpdate PUT /profile/me
DreamtableApi.ProfileApi profileRegisterCreate POST /profile/register
DreamtableApi.ProfileApi profileUpdatePartialUpdate PATCH /profile/update/{slug}
DreamtableApi.ProfileApi profileUpdateRetrieve GET /profile/update/{slug}
DreamtableApi.ProfileApi profileUpdateUpdate PUT /profile/update/{slug}
DreamtableApi.SchemaApi schemaRetrieve GET /schema/
DreamtableApi.SessionApi sessionListCreate POST /session/list/
DreamtableApi.SessionApi sessionListList GET /session/list/
DreamtableApi.SessionApi sessionListPartialUpdate PATCH /session/list/{id}/
DreamtableApi.SessionApi sessionListRetrieve GET /session/list/{id}/
DreamtableApi.SessionApi sessionListUpdate PUT /session/list/{id}/
DreamtableApi.TokenApi tokenCreate POST /token/
DreamtableApi.TokenApi tokenRefreshCreate POST /token/refresh/

Documentation for Models

Documentation for Authorization

jwtAuth

  • Type: Bearer authentication (Bearer)