profb-js-client

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

var api = new ProfbJsClient.AuthApi()
var opts = { 
  'body': new ProfbJsClient.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

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

Documentation for Models

• ProfbJsClient.Address
• ProfbJsClient.Cart
• ProfbJsClient.CartItems
• ProfbJsClient.Cartid
• ProfbJsClient.Category
• ProfbJsClient.Delivery
• ProfbJsClient.ErrorModel
• ProfbJsClient.ExtendedErrorModel
• ProfbJsClient.InlineResponse200
• ProfbJsClient.InlineResponse404
• ProfbJsClient.Method
• ProfbJsClient.Order
• ProfbJsClient.OrderItems
• ProfbJsClient.Orderid
• ProfbJsClient.Payment
• ProfbJsClient.Product
• ProfbJsClient.Productid
• ProfbJsClient.Status
• ProfbJsClient.Type
• ProfbJsClient.User
• ProfbJsClient.UserAddress
• ProfbJsClient.Userid
• ProfbJsClient.Vendor

Documentation for Authorization

basic

• Type: HTTP basic authentication