drbent_client

professor_bentley_electronics_retail_api

ProfessorBentleyElectronicsRetailApi - JavaScript client for professor_bentley_electronics_retail_api An ecommerce REST API for a retail electronics store. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1
• Package version: 1.1
• Build package: io.swagger.codegen.v3.generators.javascript.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 professor_bentley_electronics_retail_api --save

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 ProfessorBentleyElectronicsRetailApi = require('professor_bentley_electronics_retail_api');
var defaultClient = ProfessorBentleyElectronicsRetailApi.ApiClient.instance;
// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME'
basic.password = 'YOUR PASSWORD'

var api = new ProfessorBentleyElectronicsRetailApi.AuthApi()
var opts = { 
  'body': new ProfessorBentleyElectronicsRetailApi.User() // {User} A new user record to add to the system
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerNewUser(opts, callback);

Documentation for API Endpoints

All URIs are relative to localhost:8080

Class	Method	HTTP request	Description
ProfessorBentleyElectronicsRetailApi.AuthApi	registerNewUser	POST /auth/register	registers a user into the systme
ProfessorBentleyElectronicsRetailApi.AuthApi	userLogin	POST /auth/login	authorizes user to use system
ProfessorBentleyElectronicsRetailApi.CartApi	addCartItems	POST /cart/{cartid}	Adds items to cart
ProfessorBentleyElectronicsRetailApi.CartApi	postNewCart	POST /cart	creates a new user cart
ProfessorBentleyElectronicsRetailApi.CartApi	updateCartItems	PUT /cart/{cartid}	update user cart by id
ProfessorBentleyElectronicsRetailApi.CheckoutApi	postPayment	POST /checkout/{orderid}	post a payment for user order
ProfessorBentleyElectronicsRetailApi.OrdersApi	getAllUserOrders	GET /orders	fetchs all user orders
ProfessorBentleyElectronicsRetailApi.OrdersApi	postNewOrder	POST /orders/{orderid}	post a new user order
ProfessorBentleyElectronicsRetailApi.OrdersApi	postPayment	POST /checkout/{orderid}	post a payment for user order
ProfessorBentleyElectronicsRetailApi.ProductsApi	getAllproducts	GET /store/products	fetchs all product records
ProfessorBentleyElectronicsRetailApi.ProductsApi	getProduct	GET /store/products/{productid}	get user record by id
ProfessorBentleyElectronicsRetailApi.ProductsApi	updateProduct	PUT /store/products/{productid}	update user record by id
ProfessorBentleyElectronicsRetailApi.StoreApi	getAllproducts	GET /store/products	fetchs all product records
ProfessorBentleyElectronicsRetailApi.StoreApi	getProduct	GET /store/products/{productid}	get user record by id
ProfessorBentleyElectronicsRetailApi.StoreApi	updateProduct	PUT /store/products/{productid}	update user record by id
ProfessorBentleyElectronicsRetailApi.UsersApi	getAllUsers	GET /users	fetchs all user records
ProfessorBentleyElectronicsRetailApi.UsersApi	getUser	GET /users/{userid}	get user record by id
ProfessorBentleyElectronicsRetailApi.UsersApi	updateUser	PUT /users/{userid}	update user record by id
ProfessorBentleyElectronicsRetailApi.VendorsApi	getAllvendors	GET /store/vendors	fetchs all vendor records
ProfessorBentleyElectronicsRetailApi.VendorsApi	getVendor	GET /store/vendors/{vendorid}	get user record by id
ProfessorBentleyElectronicsRetailApi.VendorsApi	updateVendor	PUT /store/vendors/{vendorid}	update vendor record by id

Documentation for Models

• ProfessorBentleyElectronicsRetailApi.Address
• ProfessorBentleyElectronicsRetailApi.Cart
• ProfessorBentleyElectronicsRetailApi.CartItems
• ProfessorBentleyElectronicsRetailApi.Category
• ProfessorBentleyElectronicsRetailApi.Delivery
• ProfessorBentleyElectronicsRetailApi.ErrorModel
• ProfessorBentleyElectronicsRetailApi.ExtendedErrorModel
• ProfessorBentleyElectronicsRetailApi.InlineResponse200
• ProfessorBentleyElectronicsRetailApi.InlineResponseDefault
• ProfessorBentleyElectronicsRetailApi.Method
• ProfessorBentleyElectronicsRetailApi.Order
• ProfessorBentleyElectronicsRetailApi.OrderItems
• ProfessorBentleyElectronicsRetailApi.Payment
• ProfessorBentleyElectronicsRetailApi.Product
• ProfessorBentleyElectronicsRetailApi.Status
• ProfessorBentleyElectronicsRetailApi.Type
• ProfessorBentleyElectronicsRetailApi.User
• ProfessorBentleyElectronicsRetailApi.UserAddress
• ProfessorBentleyElectronicsRetailApi.Vendor

Documentation for Authorization

basic

• Type: HTTP basic authentication