Oco-research-nodejs-sdk NPM

Garage Week 2021

Autogenerated JavaScript client oco-research-nodejs-sdk

API version: 1.1.14

Package version: 1.1.14

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

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 oco-research-nodejs-sdk --save

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

Finally, switch to the directory you want to use your oco-research-nodejs-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('oco-research-nodejs-sdk') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 OcoResearchNodejsSdk = require('oco-research-nodejs-sdk');

var defaultClient = OcoResearchNodejsSdk.ApiClient.instance;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new OcoResearchNodejsSdk.PetApi()
var pet = new OcoResearchNodejsSdk.Pet(); // {Pet} Create a new pet in the store
api.addPet(pet).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

To browse the REST API reference and try sending the requests from your browser, see our REST docs website.

All URIs are relative to https://petstore3.swagger.io/api/v3

Class	Method	HTTP request	Description
OcoResearchNodejsSdk.PetApi	addPet	POST /pet	Add a new pet to the store
OcoResearchNodejsSdk.PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
OcoResearchNodejsSdk.PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
OcoResearchNodejsSdk.PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
OcoResearchNodejsSdk.PetApi	getPetById	GET /pet/{petId}	Find pet by ID
OcoResearchNodejsSdk.PetApi	updatePet	PUT /pet	Update an existing pet
OcoResearchNodejsSdk.PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
OcoResearchNodejsSdk.PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
OcoResearchNodejsSdk.StoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
OcoResearchNodejsSdk.StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
OcoResearchNodejsSdk.StoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
OcoResearchNodejsSdk.StoreApi	placeOrder	POST /store/order	Place an order for a pet
OcoResearchNodejsSdk.UserApi	createUser	POST /user	Create user
OcoResearchNodejsSdk.UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
OcoResearchNodejsSdk.UserApi	deleteUser	DELETE /user/{username}	Delete user
OcoResearchNodejsSdk.UserApi	getUserByName	GET /user/{username}	Get user by user name
OcoResearchNodejsSdk.UserApi	loginUser	GET /user/login	Logs user into the system
OcoResearchNodejsSdk.UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
OcoResearchNodejsSdk.UserApi	updateUser	PUT /user/{username}	Update user

Documentation for Models

Documentation for Authorization

api_key

Type: API key
API key parameter name: api_key
Location: HTTP header

petstore_auth

Type: OAuth
Flow: implicit
Authorization URL: https://petstore3.swagger.io/oauth/authorize
Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets