0.0.1 • Published 10 months ago

auto_squadra_api_openapi_generator v0.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
10 months ago

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

ClassMethodHTTP requestDescription
AutoSquadraApi.AccountApiaccountDeletePOST /api/v1/account/deletedelete account data
AutoSquadraApi.AccountApiaccountInfoGET /api/v1/account/infoGet User Account Info
AutoSquadraApi.AccountApibuyingAuctionsGET /api/v1/account/auctions/buyingGet All Buying Auctions of Current User
AutoSquadraApi.AccountApichangeAccountInfoPUT /api/v1/account/info/changingChange Account Inforamtion (Email, Username, Password)
AutoSquadraApi.AccountApichangePasswordPOST /api/v1/account/resetPassword/changePasswordprovide a new password (step 3)
AutoSquadraApi.AccountApigetUserIdGET /api/v1/account/userIdget user id for logged in user
AutoSquadraApi.AccountApigetUserProfileGET /api/v1/account/profileprovide user profile data by user id
AutoSquadraApi.AccountApiscreenNamePOST /api/v1/account/screenNameadd nickname to user
AutoSquadraApi.AccountApisellingAuctionsGET /api/v1/account/auctions/sellingGet All Selling Auctions of Current User
AutoSquadraApi.AccountApisendCodeForRecoveryPasswordPOST /api/v1/account/resetPassword/receiveCodereceive code for change password (step 1)
AutoSquadraApi.AccountApisetDeviceTokenPOST /api/v1/account/firebaseTokenset device token
AutoSquadraApi.AccountApisignInPOST /api/v1/account/signInLogin with existing user
AutoSquadraApi.AccountApisignUpPOST /api/v1/account/signUpCreate a new account
AutoSquadraApi.AccountApivalidateCodeForRecoveryPasswordPOST /api/v1/account/resetPassword/validateCodepass code for reset password (step 2)
AutoSquadraApi.AuctionApiauctionAboutGET /api/v1/auction/aboutget the necessary data for the auction about section
AutoSquadraApi.AuctionApifavouritePOST /api/v1/auction/favouriteadd to favourite or remove from favourite
AutoSquadraApi.AuctionApigetAllWatchedAuctionsGET /api/v1/auction/list/watchedget all watched auctions
AutoSquadraApi.AuctionApigetAuctionBiddingAmountGET /api/v1/auction/biddingAmountget bidding amount for auction by id
AutoSquadraApi.AuctionApigetAuctionByIdGET /api/v1/auctionget full auction details by id
AutoSquadraApi.AuctionApigetAuctionCommentsGET /api/v1/auction/commentsget auction comments
AutoSquadraApi.AuctionApigetAuctionDocumentsGET /api/v1/auction/documentsget auction documents
AutoSquadraApi.AuctionApigetAuctionExteriorImagesGET /api/v1/auction/images/exteriorget auction exterior images
AutoSquadraApi.AuctionApigetAuctionImagesGET /api/v1/auction/imagesget auction images
AutoSquadraApi.AuctionApigetAuctionInteriorImagesGET /api/v1/auction/images/interiorget auction interior images
AutoSquadraApi.AuctionApigetAuctionListGET /api/v1/auction/listget auctionList
AutoSquadraApi.AuctionApigetAuctionVideosGET /api/v1/auction/videosget auction videos
AutoSquadraApi.AuctionApigetBidInfoGET /api/v1/auction/bidInfoget bid info regarding user
AutoSquadraApi.AuctionApigetBiddingHistoryGET /api/v1/auction/biddingHistoryget bidding history
AutoSquadraApi.AuctionApigetFavouritesGET /api/v1/auction/favouritesget all favourites auctions
AutoSquadraApi.AuctionApigetSimilarCarsGET /api/v1/auction/similarget similar cars for current auction
AutoSquadraApi.AuctionApimarkAuctionAsWatchedPOST /api/v1/auction/markAsWatchedmark auction as watched
AutoSquadraApi.AuctionApipublishCommentPOST /api/v1/auction/publishCommentpublish new comment
AutoSquadraApi.AuctionApipublishReplyPOST /api/v1/auction/publishReplypublish reply to existing comment
AutoSquadraApi.AuctionApiuserStateGET /api/v1/auction/userStateget user info about current auction
AutoSquadraApi.BidApibidDetailsGET /api/v1/bid/detailsget details of current bid
AutoSquadraApi.BidApiplaceBidPOST /api/v1/bid/placeplace a bid
AutoSquadraApi.ClubApiaddMemberToClubPOST /api/v1/club/memberAdd new member to club
AutoSquadraApi.CommentApigetUnreadCommentsGET /api/v1/comment/unreadget unread comments
AutoSquadraApi.CommentApilikeCommentPOST /api/v1/comment/likelike comment or reply
AutoSquadraApi.CommentApimarkCommentAsInappropriatePOST /api/v1/comment/markAsInappropriatemark existing comment as inappropriate
AutoSquadraApi.CommentApimarkCommentsAsReadPOST /api/v1/comment/markAsReadmark comments as read
AutoSquadraApi.HealthcheckApistatuscodeGET /api/v1/healthcheck/statuscodeEndpoint for healthcheck
AutoSquadraApi.HomeApigetBannerImagesGET /api/v1/home/banner/imagesGet marketing images for main banner on home page
AutoSquadraApi.HomeApigetFavouritesAuctionGET /api/v1/home/favouritesget Favourites auctions for home page
AutoSquadraApi.HomeApigetFeaturedAuctionsGET /api/v1/home/featuredAuctionsget featured auctions for home page
AutoSquadraApi.HomeApigetHomePageGET /api/v1/home/auctionsget data for home page
AutoSquadraApi.HomeApigetRecommendedAuctionGET /api/v1/home/recommendedget recommended auctions for home page
AutoSquadraApi.HomeApigetTopAuctionGET /api/v1/home/topAuctionsget top auctions for home page
AutoSquadraApi.HomeApigetWatchedAuctionGET /api/v1/home/watchedget watched auctions for home page
AutoSquadraApi.LegalApigetCookiePolicyGET /api/v1/legal/cookiePolicyget cookie policy in html format
AutoSquadraApi.LegalApigetFAQGET /api/v1/legal/faqget frequently asked questions
AutoSquadraApi.LegalApigetPrivacyPolicyGET /api/v1/legal/privacyPolicyget privacy policy in html format
AutoSquadraApi.LegalApigetTermsAndConditionsGET /api/v1/legal/termsAndConditionsget terms and conditions in html format
AutoSquadraApi.ResultPageApiresultPageGET /api/v1/resultEndpoint for get data for results page
AutoSquadraApi.SearchApigetSearchHintsGET /api/v1/searchget available search hints
AutoSquadraApi.StripeBillingApicreateStripeIntentPOST /api/v1/billing/billing/stripeCreate Stripe intent for future payment
AutoSquadraApi.StripeBillingApiprocessStripeEventPOST /api/v1/billing/billing/stripe/webhookReceive and process stripe event webhook
AutoSquadraApi.StripeBillingApistripeKeysGET /api/v1/billing/billing/stripeGet stripe keys to process payment on frontend
AutoSquadraApi.TokenApirefreshPOST /api/v1/token/refreshRefresh access token

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

JWTAuth

  • Type: Bearer authentication (JWT)
0.0.1

10 months ago