teak_origin_data_api v1.0.0
teak_origin_data_api
TeakOriginDataApi - JavaScript client for teak_origin_data_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: v1
- Package version: v1
- 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 teak_origin_data_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 teak_origin_data_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('teak_origin_data_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/teak_origin_data_api then install it via:
npm install YOUR_USERNAME/teak_origin_data_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 TeakOriginDataApi = require('teak_origin_data_api');
var api = new TeakOriginDataApi.ProduceByLocationApi()
var location = "location_example"; // {String} The location.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getLocationProduce(location, callback);
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
TeakOriginDataApi.ProduceByLocationApi | getLocationProduce | GET /api/{location}/produce | Gets the produce for the given location in URL path. |
TeakOriginDataApi.ProduceByLocationApi | getLocationProduceBycode | GET /api/{location}/produce/{produceCode} | Gets the produce by ProduceCode like 'apple', 'grapes' etc. for a given location in the URL path. |
TeakOriginDataApi.RetailersByLocationApi | getLocationRetailer | GET /api/{location}/retailers | Gets all the retailers for a given location(e.g. 'boston', 'los-angeles' etc.) in the URL path. |
TeakOriginDataApi.RetailersByLocationApi | getLocationRetailerBycode | GET /api/{location}/retailers/{retailerCode} | Gets a retailer by RetailerCode ('walmart', 'target' etc.) for a given location(e.g. 'boston', 'los-angeles' etc.) in URL path. |
Documentation for Models
- TeakOriginDataApi.Criteria
- TeakOriginDataApi.Error
- TeakOriginDataApi.ProblemDetails
- TeakOriginDataApi.Produce
- TeakOriginDataApi.ProduceResponse
- TeakOriginDataApi.Retailer
- TeakOriginDataApi.RetailerResponse
Documentation for Authorization
All endpoints do not require authorization.
5 years ago