@yusuke-suzuki/qoodish-api-js-client v0.2.4

@yusuke-suzuki/qoodish-api-js-client

QoodishApiJsClient - JavaScript client for @yusuke-suzuki/qoodish-api-js-client Qoodish API JavaScript Client.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.2.4
• Package version: 0.2.4
• 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 @yusuke-suzuki/qoodish-api-js-client --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 @yusuke-suzuki/qoodish-api-js-client 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 QoodishApiJsClient = require('@yusuke-suzuki/qoodish-api-js-client');

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

var api = new QoodishApiJsClient.CollaboratorsApi()
var mapId = 1; // {Number} A valid Map ID.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mapsMapIdCollaboratorsGet(mapId, callback);

Documentation for API Endpoints

All URIs are relative to https://api.qoodish.com

Documentation for Models

• QoodishApiJsClient.Author
• QoodishApiJsClient.Collaborator
• QoodishApiJsClient.Comment
• QoodishApiJsClient.CurrentUser
• QoodishApiJsClient.InappropreateContent
• QoodishApiJsClient.InlineObject
• QoodishApiJsClient.InlineObject1
• QoodishApiJsClient.Invite
• QoodishApiJsClient.InviteInvitable
• QoodishApiJsClient.Like
• QoodishApiJsClient.MapDetail
• QoodishApiJsClient.MapDetailBase
• QoodishApiJsClient.Metadata
• QoodishApiJsClient.NewInvite
• QoodishApiJsClient.NewMap
• QoodishApiJsClient.NewReview
• QoodishApiJsClient.NewUser
• QoodishApiJsClient.Notification
• QoodishApiJsClient.NotificationNotifiable
• QoodishApiJsClient.Place
• QoodishApiJsClient.PushNotification
• QoodishApiJsClient.Review
• QoodishApiJsClient.ReviewImage
• QoodishApiJsClient.ReviewMap
• QoodishApiJsClient.Spot

Documentation for Authorization

firebaseAuth

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