0.0.1 • Published 9 months ago

sema_tree_currency_rest_services v0.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
9 months ago

sema_tree_currency_rest_services

SemaTreeCurrencyRestServices - JavaScript client for sema_tree_currency_rest_services Currency Services Application This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • 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 sema_tree_currency_rest_services --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 sema_tree_currency_rest_services 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 SemaTreeCurrencyRestServices = require('sema_tree_currency_rest_services');


var api = new SemaTreeCurrencyRestServices.AdminApi()
var opts = {
  'body': [new SemaTreeCurrencyRestServices.CurrencyPOSTData()] // {[CurrencyPOSTData]} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCurrency(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://devops2.intigna.io/dc-currency-service/currency

ClassMethodHTTP requestDescription
SemaTreeCurrencyRestServices.AdminApicreateCurrencyPOST /admin/currenciesCreates a new currency.
SemaTreeCurrencyRestServices.AdminApicreateCurrencyFormatPOST /admin/currency-formatsCreates a new program certification type.
SemaTreeCurrencyRestServices.AdminApicreateCurrencyRatePeriodPOST /admin/rateperiodsCreates a new rate period.
SemaTreeCurrencyRestServices.AdminApideleteCurrencyDELETE /admin/currencies/{id}Deletes a currency.
SemaTreeCurrencyRestServices.AdminApideleteCurrencyFormatDELETE /admin/currency-formats/{id}Deletes a currency format.
SemaTreeCurrencyRestServices.AdminApideleteCurrencyRatePeriodDELETE /admin/rateperiods/{id}Deletes a currency rate period.
SemaTreeCurrencyRestServices.AdminApifindCurrenciesGET /admin/currenciesFetches a list of currencies.
SemaTreeCurrencyRestServices.AdminApifindCurrencyFormatsGET /admin/currency-formatsFetches a list of currency formats.
SemaTreeCurrencyRestServices.AdminApifindCurrencyOptionsGET /admin/currencies/optionsFetches a list of currency options.
SemaTreeCurrencyRestServices.AdminApifindRatePeriodsGET /admin/rateperiodsFetches a list of rate periods.
SemaTreeCurrencyRestServices.AdminApigetCurrencyGET /admin/currencies/{id}Gets a currency based on its id.
SemaTreeCurrencyRestServices.AdminApigetCurrencyFormatGET /admin/currency-formats/{id}Gets a document type category based on its id.
SemaTreeCurrencyRestServices.AdminApigetCurrencyHelperGET /admin/currencies/widgetGets info required for formatting, calculating conversion amounts.
SemaTreeCurrencyRestServices.AdminApigetCurrencyRatePeriodGET /admin/rateperiods/{id}Gets a rate period based on its id.
SemaTreeCurrencyRestServices.AdminApigetCurrentRatePeriodGET /admin/rateperiods/currentGet current rate period.
SemaTreeCurrencyRestServices.AdminApiupdateCurrencyPUT /admin/currencies/{id}Updates a currency.
SemaTreeCurrencyRestServices.AdminApiupdateCurrencyFormatPUT /admin/currency-formats/{id}Updates a currency format.
SemaTreeCurrencyRestServices.AdminApiupdateCurrencyRatePeriodPUT /admin/rateperiods/{id}Updates a rate period.
SemaTreeCurrencyRestServices.AdminexchangeRatesApigetLatestExchangeRatesGET /admin/exchange-rates/latestFetches a list of rate periods.
SemaTreeCurrencyRestServices.AdminexchangeRatesApiupdateExchangeRatesPUT /admin/exchange-rates/exchange-ratesUpdate latest exchange rates.
SemaTreeCurrencyRestServices.OptionsApigetCurrencyOptionsPOST /options/currenciesFetches all Currency Options.

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

0.0.1

9 months ago