1.6.7 • Published 2 years ago

professorbclient v1.6.7

Weekly downloads
-
License
Unlicense
Repository
-
Last release
2 years ago

Professor Bentley Exquisite E-Wares E-Commerce API

ProfessorBentleyExquisiteEWaresECommerceApi - JavaScript client for Professor Bentley Exquisite E-Wares E-Commerce API An ecommerce REST API for a retail electronics store. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.5
  • Package version: 1.67
  • 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 Exquisite E-Wares E-Commerce 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 Configurat

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 ProfessorBentleyExquisiteEWaresECommerceApi = require('Professor Bentley Exquisite E-Wares E-Commerce API');
var defaultClient = new ProfessorBentleyExquisiteEWaresECommerceApi.ApiClient.instance;
// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME'
basic.password = 'YOUR PASSWORD'

var api = new ProfessorBentleyExquisiteEWaresECommerceApi.AuthApi()
var opts = { 
  'body': new ProfessorBentleyExquisiteEWaresECommerceApi.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 https://virtserver.swaggerhub.com/holtenterprises/prof-bentley_ecommerce_api/1.5

ClassMethodHTTP requestDescription
ProfessorBentleyExquisiteEWaresECommerceApi.AuthApiregisterNewUserPOST /auth/registerregisters a user into the systme
ProfessorBentleyExquisiteEWaresECommerceApi.AuthApiuserLoginPOST /auth/loginauthorizes user to use system
ProfessorBentleyExquisiteEWaresECommerceApi.CartApiaddCartItemsPOST /cart/{cartid}Adds items to cart
ProfessorBentleyExquisiteEWaresECommerceApi.CartApipostNewCartPOST /cartcreates a new user cart
ProfessorBentleyExquisiteEWaresECommerceApi.CartApiupdateCartItemsPUT /cart/{cartid}update user cart by id
ProfessorBentleyExquisiteEWaresECommerceApi.CheckoutApipostPaymentPOST /checkout/{orderid}post a payment for user order
ProfessorBentleyExquisiteEWaresECommerceApi.OrdersApigetAllUserOrdersGET /ordersfetchs all user orders
ProfessorBentleyExquisiteEWaresECommerceApi.OrdersApipostNewOrderPOST /orders/{orderid}post a new user order
ProfessorBentleyExquisiteEWaresECommerceApi.OrdersApipostPaymentPOST /checkout/{orderid}post a payment for user order
ProfessorBentleyExquisiteEWaresECommerceApi.ProductsApigetAllproductsGET /store/productsfetchs all product records
ProfessorBentleyExquisiteEWaresECommerceApi.ProductsApigetProductGET /store/products/{productid}get user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.ProductsApiupdateProductPUT /store/products/{productid}update user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.StoreApigetAllproductsGET /store/productsfetchs all product records
ProfessorBentleyExquisiteEWaresECommerceApi.StoreApigetProductGET /store/products/{productid}get user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.StoreApiupdateProductPUT /store/products/{productid}update user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.UsersApigetAllUsersGET /usersfetchs all user records
ProfessorBentleyExquisiteEWaresECommerceApi.UsersApigetUserGET /users/{userid}get user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.UsersApiupdateUserPUT /users/{userid}update user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.VendorsApigetAllvendorsGET /store/vendorsfetchs all vendor records
ProfessorBentleyExquisiteEWaresECommerceApi.VendorsApigetVendorGET /store/vendors/{vendorid}get user record by id
ProfessorBentleyExquisiteEWaresECommerceApi.VendorsApiupdateVendorPUT /store/vendors/{vendorid}update vendor record by id

Documentation for Models

Documentation for Authorization

basic

  • Type: HTTP basic authentication