econoday v2.0.0
econoday_res_tful_api
EconodayResTfulApi - JavaScript client for econoday_res_tful_api This API allows communication with Econoday Economic Event Delivery system This SDK is automatically generated by the OpenAPI Generator project:
- API version: v2
- Package version: v2
- Build package: org.openapitools.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 econoday_res_tful_api --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your econoday_res_tful_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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 EconodayResTfulApi = require('econoday_res_tful_api');
var api = new EconodayResTfulApi.DefaultApi()
var token = P6MQA5RVKIHJ4L189ICE7092M; // {String} Pass an API code identifying the user.
var opts = {
'format': json // {String} Type of output.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.apiV1GetdeletedGet(token, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://api.econoday.com
Class | Method | HTTP request | Description |
---|---|---|---|
EconodayResTfulApi.DefaultApi | apiV1GetdeletedGet | GET /api/v1/getdeleted | Get list deleted events for the past 30 days |
EconodayResTfulApi.DefaultApi | apiV1GeteventdetailsGet | GET /api/v1/geteventdetails | Get Event Details of a particulate event |
EconodayResTfulApi.DefaultApi | apiV1GeteventsbylastmodGet | GET /api/v1/geteventsbylastmod | Get a list of events based on a passed modify date |
EconodayResTfulApi.DefaultApi | apiV1GeteventsbyrangeGet | GET /api/v1/geteventsbyrange | Get a list of events based on date ranges |
EconodayResTfulApi.DefaultApi | apiV1GettodayGet | GET /api/v1/gettoday | Get a list of the current day's events |
EconodayResTfulApi.DefaultApi | apiV1GettomorrowGet | GET /api/v1/gettomorrow | Get a list of tomorrow's events |
EconodayResTfulApi.DefaultApi | apiV1GetweekGet | GET /api/v1/getweek | Get a list of the week's events |
EconodayResTfulApi.DefaultApi | apiV1ListcountrycodesGet | GET /api/v1/listcountrycodes | Get a list of Country Codes that are accessable |
EconodayResTfulApi.DefaultApi | apiV1ListeventcodesGet | GET /api/v1/listeventcodes | Get a list of Event Codes |
Documentation for Models
- EconodayResTfulApi.ChartsResponse
- EconodayResTfulApi.CountryCodeResponse
- EconodayResTfulApi.EventCodeResponse
- EconodayResTfulApi.EventDeleteListResponse
- EconodayResTfulApi.EventListResponse
- EconodayResTfulApi.InlineResponse200
- EconodayResTfulApi.InlineResponse2001
- EconodayResTfulApi.InlineResponse2002
- EconodayResTfulApi.InlineResponse2003
- EconodayResTfulApi.InlineResponse2004
- EconodayResTfulApi.PDFResponse
- EconodayResTfulApi.StatusResponse
- EconodayResTfulApi.ValuesResponse
Documentation for Authorization
All endpoints do not require authorization.