vt_sales_api
v1.0.0
Published
API_Aggregation_and_and_Orchestration_layer_for_VT_Sales_Leads_and_Payment_clients_
Downloads
3
Readme
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
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- VtSalesApi.CreditCardsApi | clientsClientIdCreditCardsCreditCardIdDelete | DELETE /clients/{clientId}/credit_cards/{creditCardId} | Delete a credit card VtSalesApi.CreditCardsApi | clientsClientIdCreditCardsCreditCardIdGet | GET /clients/{clientId}/credit_cards/{creditCardId} | Get a credit card VtSalesApi.CreditCardsApi | clientsClientIdCreditCardsCreditCardIdPut | PUT /clients/{clientId}/credit_cards/{creditCardId} | Update a credit card VtSalesApi.CreditCardsApi | clientsClientIdCreditCardsGet | GET /clients/{clientId}/credit_cards | Get a list of a client's credit cards VtSalesApi.CreditCardsApi | clientsClientIdCreditCardsPost | POST /clients/{clientId}/credit_cards | Save a new credit card VtSalesApi.PackagesApi | clientsClientIdAvailablePackagesGet | GET /clients/{clientId}/availablePackages | Get available packages for a client VtSalesApi.PackagesApi | clientsClientIdPriceLockPost | POST /clients/{clientId}/price_lock | Lock prices for a client VtSalesApi.PackagesApi | leadsLeadIdAvailablePackagesGet | GET /leads/{leadId}/availablePackages | Get available packages for a lead VtSalesApi.PackagesApi | leadsLeadIdPriceLockPost | POST /leads/{leadId}/price_lock | Lock prices for a lead VtSalesApi.PaymentsApi | clientsClientIdPaymentsPurchasePost | POST /clients/{clientId}/payments/purchase | Process a payment for a client VtSalesApi.PaymentsApi | leadsLeadIdPaymentsPurchasePost | POST /leads/{leadId}/payments/purchase | Process a payment for a lead and Convert to client
Documentation for Models
- VtSalesApi.Address
- VtSalesApi.AvailablePackages
- VtSalesApi.CreditCard
- VtSalesApi.ModelPackage
- VtSalesApi.PriceLock
- VtSalesApi.Purchase
- VtSalesApi.PurchaseItem
- VtSalesApi.SalePriceFactor
Documentation for Authorization
All endpoints do not require authorization.