@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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- QoodishApiJsClient.CollaboratorsApi | mapsMapIdCollaboratorsGet | GET /maps/{map_id}/collaborators | Fetch collaborators QoodishApiJsClient.CommentsApi | reviewsReviewIdCommentsCommentIdDelete | DELETE /reviews/{review_id}/comments/{comment_id} | Delete review comment QoodishApiJsClient.CommentsApi | reviewsReviewIdCommentsPost | POST /reviews/{review_id}/comments | Send review comment QoodishApiJsClient.DevicesApi | devicesRegistrationTokenDelete | DELETE /devices/{registration_token} | Delete device QoodishApiJsClient.DevicesApi | devicesRegistrationTokenPut | PUT /devices/{registration_token} | Register device QoodishApiJsClient.FollowsApi | mapsMapIdFollowDelete | DELETE /maps/{map_id}/follow | Unfollow map QoodishApiJsClient.FollowsApi | mapsMapIdFollowPost | POST /maps/{map_id}/follow | Follow map QoodishApiJsClient.InvitesApi | invitesGet | GET /invites | Fetch invites QoodishApiJsClient.InvitesApi | mapsMapIdInvitesPost | POST /maps/{map_id}/invites | Send invite QoodishApiJsClient.IssueContentsApi | inappropriateContentsPost | POST /inappropriate_contents | Issue inappropriate content QoodishApiJsClient.LikesApi | mapsMapIdLikeDelete | DELETE /maps/{map_id}/like | Unlike map QoodishApiJsClient.LikesApi | mapsMapIdLikePost | POST /maps/{map_id}/like | Like map QoodishApiJsClient.LikesApi | mapsMapIdLikesGet | GET /maps/{map_id}/likes | Fetch map likes QoodishApiJsClient.LikesApi | reviewsReviewIdCommentsCommentIdLikeDelete | DELETE /reviews/{review_id}/comments/{comment_id}/like | Unlike review comment QoodishApiJsClient.LikesApi | reviewsReviewIdCommentsCommentIdLikePost | POST /reviews/{review_id}/comments/{comment_id}/like | Like review comment QoodishApiJsClient.LikesApi | reviewsReviewIdCommentsCommentIdLikesGet | GET /reviews/{review_id}/comments/{comment_id}/likes | Fetch comment likes QoodishApiJsClient.LikesApi | reviewsReviewIdLikeDelete | DELETE /reviews/{review_id}/like | Unlike review QoodishApiJsClient.LikesApi | reviewsReviewIdLikePost | POST /reviews/{review_id}/like | Like review QoodishApiJsClient.LikesApi | reviewsReviewIdLikesGet | GET /reviews/{review_id}/likes | Fetch review likes QoodishApiJsClient.LikesApi | usersUserIdLikesGet | GET /users/{user_id}/likes | Fetch user likes QoodishApiJsClient.MapsApi | mapsGet | GET /maps | List Maps QoodishApiJsClient.MapsApi | mapsMapIdDelete | DELETE /maps/{map_id} | Delete a Map QoodishApiJsClient.MapsApi | mapsMapIdGet | GET /maps/{map_id} | Get Map detail QoodishApiJsClient.MapsApi | mapsMapIdPut | PUT /maps/{map_id} | Update a Map QoodishApiJsClient.MapsApi | mapsPost | POST /maps | Create a new Map QoodishApiJsClient.MetadataApi | mapsMapIdMetadataGet | GET /maps/{map_id}/metadata | Get Map metadata QoodishApiJsClient.MetadataApi | reviewsReviewIdMetadataGet | GET /reviews/{review_id}/metadata | Get Review metadata QoodishApiJsClient.MetadataApi | spotsPlaceIdMetadataGet | GET /spots/{place_id}/metadata | Get Spot metadata QoodishApiJsClient.NotificationsApi | notificationsGet | GET /notifications | Fetch notifications QoodishApiJsClient.NotificationsApi | notificationsNotificationIdPut | PUT /notifications/{notification_id} | Update notification QoodishApiJsClient.PlacesApi | placesGet | GET /places | Fetch places QoodishApiJsClient.PushNotificationApi | usersUserIdPushNotificationPut | PUT /users/{user_id}/push_notification | Update push notification QoodishApiJsClient.ReviewsApi | mapsMapIdReviewsGet | GET /maps/{map_id}/reviews | Fetch map reviews QoodishApiJsClient.ReviewsApi | mapsMapIdReviewsPost | POST /maps/{map_id}/reviews | Create review QoodishApiJsClient.ReviewsApi | mapsMapIdReviewsReviewIdGet | GET /maps/{map_id}/reviews/{review_id} | Fetch review QoodishApiJsClient.ReviewsApi | mapsMapIdSpotsPlaceIdReviewsGet | GET /maps/{map_id}/spots/{place_id}/reviews | Fetch reviews on spot QoodishApiJsClient.ReviewsApi | reviewsGet | GET /reviews | Fetch reviews QoodishApiJsClient.ReviewsApi | reviewsReviewIdDelete | DELETE /reviews/{review_id} | Delete review QoodishApiJsClient.ReviewsApi | reviewsReviewIdPut | PUT /reviews/{review_id} | Update review QoodishApiJsClient.ReviewsApi | spotsPlaceIdReviewsGet | GET /spots/{place_id}/reviews | Fetch spot reviews QoodishApiJsClient.ReviewsApi | usersUserIdReviewsGet | GET /users/{user_id}/reviews | Fetch user reviews QoodishApiJsClient.SpotsApi | mapsMapIdSpotsGet | GET /maps/{map_id}/spots | Fetch spots on map QoodishApiJsClient.SpotsApi | mapsMapIdSpotsPlaceIdGet | GET /maps/{map_id}/spots/{place_id} | Fetch a spot on map QoodishApiJsClient.SpotsApi | spotsGet | GET /spots | Fetch spots QoodishApiJsClient.SpotsApi | spotsPlaceIdGet | GET /spots/{place_id} | Fetch a spot QoodishApiJsClient.UserMapsApi | usersUserIdMapsGet | GET /users/{user_id}/maps | Fetch user Maps QoodishApiJsClient.UsersApi | usersGet | GET /users | Search users QoodishApiJsClient.UsersApi | usersPost | POST /users | Sign in QoodishApiJsClient.UsersApi | usersUserIdDelete | DELETE /users/{user_id} | Delete user account QoodishApiJsClient.UsersApi | usersUserIdGet | GET /users/{user_id} | Get user profile QoodishApiJsClient.UsersApi | usersUserIdPut | PUT /users/{user_id} | Update user profile

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