auto_squadra_api_openapi_generator

v0.0.1

Published

a year ago

Rest API based on java which provides read/write/delete/search operations for Auto Squadra project

Downloads

0High
0Medium
0Low

bshakhov

auto_squadra_api

AutoSquadraApi - JavaScript client for auto_squadra_api Rest API based on java which provides read/write/delete/search operations for Auto Squadra project 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 auto_squadra_api_openapi_generator --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 auto_squadra_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 AutoSquadraApi = require('auto_squadra_api_openapi_generator');

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

var api = new AutoSquadraApi.AccountApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountDelete(callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8073

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AutoSquadraApi.AccountApi | accountDelete | POST /api/v1/account/delete | delete account data AutoSquadraApi.AccountApi | accountInfo | GET /api/v1/account/info | Get User Account Info AutoSquadraApi.AccountApi | buyingAuctions | GET /api/v1/account/auctions/buying | Get All Buying Auctions of Current User AutoSquadraApi.AccountApi | changeAccountInfo | PUT /api/v1/account/info/changing | Change Account Inforamtion (Email, Username, Password) AutoSquadraApi.AccountApi | changePassword | POST /api/v1/account/resetPassword/changePassword | provide a new password (step 3) AutoSquadraApi.AccountApi | getUserId | GET /api/v1/account/userId | get user id for logged in user AutoSquadraApi.AccountApi | getUserProfile | GET /api/v1/account/profile | provide user profile data by user id AutoSquadraApi.AccountApi | screenName | POST /api/v1/account/screenName | add nickname to user AutoSquadraApi.AccountApi | sellingAuctions | GET /api/v1/account/auctions/selling | Get All Selling Auctions of Current User AutoSquadraApi.AccountApi | sendCodeForRecoveryPassword | POST /api/v1/account/resetPassword/receiveCode | receive code for change password (step 1) AutoSquadraApi.AccountApi | setDeviceToken | POST /api/v1/account/firebaseToken | set device token AutoSquadraApi.AccountApi | signIn | POST /api/v1/account/signIn | Login with existing user AutoSquadraApi.AccountApi | signUp | POST /api/v1/account/signUp | Create a new account AutoSquadraApi.AccountApi | validateCodeForRecoveryPassword | POST /api/v1/account/resetPassword/validateCode | pass code for reset password (step 2) AutoSquadraApi.AuctionApi | auctionAbout | GET /api/v1/auction/about | get the necessary data for the auction about section AutoSquadraApi.AuctionApi | favourite | POST /api/v1/auction/favourite | add to favourite or remove from favourite AutoSquadraApi.AuctionApi | getAllWatchedAuctions | GET /api/v1/auction/list/watched | get all watched auctions AutoSquadraApi.AuctionApi | getAuctionBiddingAmount | GET /api/v1/auction/biddingAmount | get bidding amount for auction by id AutoSquadraApi.AuctionApi | getAuctionById | GET /api/v1/auction | get full auction details by id AutoSquadraApi.AuctionApi | getAuctionComments | GET /api/v1/auction/comments | get auction comments AutoSquadraApi.AuctionApi | getAuctionDocuments | GET /api/v1/auction/documents | get auction documents AutoSquadraApi.AuctionApi | getAuctionExteriorImages | GET /api/v1/auction/images/exterior | get auction exterior images AutoSquadraApi.AuctionApi | getAuctionImages | GET /api/v1/auction/images | get auction images AutoSquadraApi.AuctionApi | getAuctionInteriorImages | GET /api/v1/auction/images/interior | get auction interior images AutoSquadraApi.AuctionApi | getAuctionList | GET /api/v1/auction/list | get auctionList AutoSquadraApi.AuctionApi | getAuctionVideos | GET /api/v1/auction/videos | get auction videos AutoSquadraApi.AuctionApi | getBidInfo | GET /api/v1/auction/bidInfo | get bid info regarding user AutoSquadraApi.AuctionApi | getBiddingHistory | GET /api/v1/auction/biddingHistory | get bidding history AutoSquadraApi.AuctionApi | getFavourites | GET /api/v1/auction/favourites | get all favourites auctions AutoSquadraApi.AuctionApi | getSimilarCars | GET /api/v1/auction/similar | get similar cars for current auction AutoSquadraApi.AuctionApi | markAuctionAsWatched | POST /api/v1/auction/markAsWatched | mark auction as watched AutoSquadraApi.AuctionApi | publishComment | POST /api/v1/auction/publishComment | publish new comment AutoSquadraApi.AuctionApi | publishReply | POST /api/v1/auction/publishReply | publish reply to existing comment AutoSquadraApi.AuctionApi | userState | GET /api/v1/auction/userState | get user info about current auction AutoSquadraApi.BidApi | bidDetails | GET /api/v1/bid/details | get details of current bid AutoSquadraApi.BidApi | placeBid | POST /api/v1/bid/place | place a bid AutoSquadraApi.ClubApi | addMemberToClub | POST /api/v1/club/member | Add new member to club AutoSquadraApi.CommentApi | getUnreadComments | GET /api/v1/comment/unread | get unread comments AutoSquadraApi.CommentApi | likeComment | POST /api/v1/comment/like | like comment or reply AutoSquadraApi.CommentApi | markCommentAsInappropriate | POST /api/v1/comment/markAsInappropriate | mark existing comment as inappropriate AutoSquadraApi.CommentApi | markCommentsAsRead | POST /api/v1/comment/markAsRead | mark comments as read AutoSquadraApi.HealthcheckApi | statuscode | GET /api/v1/healthcheck/statuscode | Endpoint for healthcheck AutoSquadraApi.HomeApi | getBannerImages | GET /api/v1/home/banner/images | Get marketing images for main banner on home page AutoSquadraApi.HomeApi | getFavouritesAuction | GET /api/v1/home/favourites | get Favourites auctions for home page AutoSquadraApi.HomeApi | getFeaturedAuctions | GET /api/v1/home/featuredAuctions | get featured auctions for home page AutoSquadraApi.HomeApi | getHomePage | GET /api/v1/home/auctions | get data for home page AutoSquadraApi.HomeApi | getRecommendedAuction | GET /api/v1/home/recommended | get recommended auctions for home page AutoSquadraApi.HomeApi | getTopAuction | GET /api/v1/home/topAuctions | get top auctions for home page AutoSquadraApi.HomeApi | getWatchedAuction | GET /api/v1/home/watched | get watched auctions for home page AutoSquadraApi.LegalApi | getCookiePolicy | GET /api/v1/legal/cookiePolicy | get cookie policy in html format AutoSquadraApi.LegalApi | getFAQ | GET /api/v1/legal/faq | get frequently asked questions AutoSquadraApi.LegalApi | getPrivacyPolicy | GET /api/v1/legal/privacyPolicy | get privacy policy in html format AutoSquadraApi.LegalApi | getTermsAndConditions | GET /api/v1/legal/termsAndConditions | get terms and conditions in html format AutoSquadraApi.ResultPageApi | resultPage | GET /api/v1/result | Endpoint for get data for results page AutoSquadraApi.SearchApi | getSearchHints | GET /api/v1/search | get available search hints AutoSquadraApi.StripeBillingApi | createStripeIntent | POST /api/v1/billing/billing/stripe | Create Stripe intent for future payment AutoSquadraApi.StripeBillingApi | processStripeEvent | POST /api/v1/billing/billing/stripe/webhook | Receive and process stripe event webhook AutoSquadraApi.StripeBillingApi | stripeKeys | GET /api/v1/billing/billing/stripe | Get stripe keys to process payment on frontend AutoSquadraApi.TokenApi | refresh | POST /api/v1/token/refresh | Refresh access token

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme