1.0.0 • Published 7 years ago

vt_sales_api v1.0.0

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

vt_sales_api

VtSalesApi - JavaScript client for vt_sales_api API Aggregation and and Orchestration layer for VT Sales, Leads and Payment clients. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.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 vt_sales_api --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 vt_sales_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('vt_sales_api') 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/YOUR_USERNAME/vt_sales_api then install it via:

    npm install YOUR_USERNAME/vt_sales_api --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 VtSalesApi = require('vt_sales_api');

var api = new VtSalesApi.CreditCardsApi()

var clientId = "clientId_example"; // {String} UUID of client

var creditCardId = "creditCardId_example"; // {String} UUID of client credit card


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clientsClientIdCreditCardsCreditCardIdDelete(clientId, creditCardId, callback);

Documentation for API Endpoints

All URIs are relative to http://vt-sales-api.varsitytutors.com/v1

ClassMethodHTTP requestDescription
VtSalesApi.CreditCardsApiclientsClientIdCreditCardsCreditCardIdDeleteDELETE /clients/{clientId}/credit_cards/{creditCardId}Delete a credit card
VtSalesApi.CreditCardsApiclientsClientIdCreditCardsCreditCardIdGetGET /clients/{clientId}/credit_cards/{creditCardId}Get a credit card
VtSalesApi.CreditCardsApiclientsClientIdCreditCardsCreditCardIdPutPUT /clients/{clientId}/credit_cards/{creditCardId}Update a credit card
VtSalesApi.CreditCardsApiclientsClientIdCreditCardsGetGET /clients/{clientId}/credit_cardsGet a list of a client's credit cards
VtSalesApi.CreditCardsApiclientsClientIdCreditCardsPostPOST /clients/{clientId}/credit_cardsSave a new credit card
VtSalesApi.PackagesApiclientsClientIdAvailablePackagesGetGET /clients/{clientId}/availablePackagesGet available packages for a client
VtSalesApi.PackagesApiclientsClientIdPriceLockPostPOST /clients/{clientId}/price_lockLock prices for a client
VtSalesApi.PackagesApileadsLeadIdAvailablePackagesGetGET /leads/{leadId}/availablePackagesGet available packages for a lead
VtSalesApi.PackagesApileadsLeadIdPriceLockPostPOST /leads/{leadId}/price_lockLock prices for a lead
VtSalesApi.PaymentsApiclientsClientIdPaymentsPurchasePostPOST /clients/{clientId}/payments/purchaseProcess a payment for a client
VtSalesApi.PaymentsApileadsLeadIdPaymentsPurchasePostPOST /leads/{leadId}/payments/purchaseProcess a payment for a lead and Convert to client

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.