1.0.1 • Published 2 years ago
pet-store-typescript-sdk v1.0.1
pet-store-typescript-sdk@1.0.1
This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.
Installing
npm
npm install pet-store-typescript-sdk --saveyarn
yarn add pet-store-typescript-sdkImportant note: this library is can be used in both the client-side or server-side, but using it in client-side browser code is not recommended as you would expose security credentials.
Getting Started
import { PetStore } from "pet-store-typescript-sdk";
const petstore = new PetStore({
// Defining the base path is optional and defaults to https://petstore.swagger.io/v2
// basePath: "https://petstore.swagger.io/v2",
apiKey: "API_KEY",
accessToken: "ACCESS_TOKEN",
});
const paginateResponse = await petstore.miscellaneous.paginate({});
console.log(paginateResponse);Documentation for API Endpoints
All URIs are relative to https://petstore.swagger.io/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| MiscellaneousApi | paginate | GET /pagination | Pagination sandbox |
| PetApi | add | POST /pet | Add a new pet to the store |
| PetApi | delete | DELETE /pet/{petId} | Deletes a pet |
| PetApi | findByStatus | GET /pet/findByStatus | Finds Pets by status |
| PetApi | findByTags | GET /pet/findByTags | Finds Pets by tags |
| PetApi | getById | GET /pet/{petId} | Find pet by ID |
| PetApi | update | PUT /pet | Update an existing pet |
| PetApi | updateWithForm | POST /pet/{petId} | Updates a pet in the store with form data |
| PetApi | uploadImage | POST /pet/{petId}/uploadImage | uploads an image |
| StoreApi | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID |
| StoreApi | getInventory | GET /store/inventory | Returns pet inventories by status |
| StoreApi | getOrderById | GET /store/order/{orderId} | Find purchase order by ID |
| StoreApi | placeOrder | POST /store/order | Place an order for a pet |
| UserApi | create | POST /user | Create user |
| UserApi | createWithArray | POST /user/createWithArray | Creates list of users with given input array |
| UserApi | createWithList | POST /user/createWithList | Creates list of users with given input array |
| UserApi | delete | DELETE /user/{username} | Delete user |
| UserApi | getByName | GET /user/{username} | Get user by user name |
| UserApi | login | GET /user/login | Logs user into the system |
| UserApi | logout | GET /user/logout | Logs out current logged in user session |
| UserApi | update | PUT /user/{username} | Updated user |