Socket
Socket
Sign inDemoInstall

econoday

Package Overview
Dependencies
121
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    econoday

This_API_allows_communication_with_Econoday_Economic_Event_Delivery_system


Version published
Weekly downloads
4
Maintainers
1
Install size
3.49 MB
Created
Weekly downloads
 

Readme

Source

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

ClassMethodHTTP requestDescription
EconodayResTfulApi.DefaultApiapiV1GetdeletedGetGET /api/v1/getdeletedGet list deleted events for the past 30 days
EconodayResTfulApi.DefaultApiapiV1GeteventdetailsGetGET /api/v1/geteventdetailsGet Event Details of a particulate event
EconodayResTfulApi.DefaultApiapiV1GeteventsbylastmodGetGET /api/v1/geteventsbylastmodGet a list of events based on a passed modify date
EconodayResTfulApi.DefaultApiapiV1GeteventsbyrangeGetGET /api/v1/geteventsbyrangeGet a list of events based on date ranges
EconodayResTfulApi.DefaultApiapiV1GettodayGetGET /api/v1/gettodayGet a list of the current day's events
EconodayResTfulApi.DefaultApiapiV1GettomorrowGetGET /api/v1/gettomorrowGet a list of tomorrow's events
EconodayResTfulApi.DefaultApiapiV1GetweekGetGET /api/v1/getweekGet a list of the week's events
EconodayResTfulApi.DefaultApiapiV1ListcountrycodesGetGET /api/v1/listcountrycodesGet a list of Country Codes that are accessable
EconodayResTfulApi.DefaultApiapiV1ListeventcodesGetGET /api/v1/listeventcodesGet a list of Event Codes

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Keywords

FAQs

Last updated on 07 Oct 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc