sema_tree_currency_rest_services v0.0.1
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
Class | Method | HTTP request | Description |
---|---|---|---|
SemaTreeCurrencyRestServices.AdminApi | createCurrency | POST /admin/currencies | Creates a new currency. |
SemaTreeCurrencyRestServices.AdminApi | createCurrencyFormat | POST /admin/currency-formats | Creates a new program certification type. |
SemaTreeCurrencyRestServices.AdminApi | createCurrencyRatePeriod | POST /admin/rateperiods | Creates a new rate period. |
SemaTreeCurrencyRestServices.AdminApi | deleteCurrency | DELETE /admin/currencies/{id} | Deletes a currency. |
SemaTreeCurrencyRestServices.AdminApi | deleteCurrencyFormat | DELETE /admin/currency-formats/{id} | Deletes a currency format. |
SemaTreeCurrencyRestServices.AdminApi | deleteCurrencyRatePeriod | DELETE /admin/rateperiods/{id} | Deletes a currency rate period. |
SemaTreeCurrencyRestServices.AdminApi | findCurrencies | GET /admin/currencies | Fetches a list of currencies. |
SemaTreeCurrencyRestServices.AdminApi | findCurrencyFormats | GET /admin/currency-formats | Fetches a list of currency formats. |
SemaTreeCurrencyRestServices.AdminApi | findCurrencyOptions | GET /admin/currencies/options | Fetches a list of currency options. |
SemaTreeCurrencyRestServices.AdminApi | findRatePeriods | GET /admin/rateperiods | Fetches a list of rate periods. |
SemaTreeCurrencyRestServices.AdminApi | getCurrency | GET /admin/currencies/{id} | Gets a currency based on its id. |
SemaTreeCurrencyRestServices.AdminApi | getCurrencyFormat | GET /admin/currency-formats/{id} | Gets a document type category based on its id. |
SemaTreeCurrencyRestServices.AdminApi | getCurrencyHelper | GET /admin/currencies/widget | Gets info required for formatting, calculating conversion amounts. |
SemaTreeCurrencyRestServices.AdminApi | getCurrencyRatePeriod | GET /admin/rateperiods/{id} | Gets a rate period based on its id. |
SemaTreeCurrencyRestServices.AdminApi | getCurrentRatePeriod | GET /admin/rateperiods/current | Get current rate period. |
SemaTreeCurrencyRestServices.AdminApi | updateCurrency | PUT /admin/currencies/{id} | Updates a currency. |
SemaTreeCurrencyRestServices.AdminApi | updateCurrencyFormat | PUT /admin/currency-formats/{id} | Updates a currency format. |
SemaTreeCurrencyRestServices.AdminApi | updateCurrencyRatePeriod | PUT /admin/rateperiods/{id} | Updates a rate period. |
SemaTreeCurrencyRestServices.AdminexchangeRatesApi | getLatestExchangeRates | GET /admin/exchange-rates/latest | Fetches a list of rate periods. |
SemaTreeCurrencyRestServices.AdminexchangeRatesApi | updateExchangeRates | PUT /admin/exchange-rates/exchange-rates | Update latest exchange rates. |
SemaTreeCurrencyRestServices.OptionsApi | getCurrencyOptions | POST /options/currencies | Fetches all Currency Options. |
Documentation for Models
- SemaTreeCurrencyRestServices.APIExchangeRatePUTData
- SemaTreeCurrencyRestServices.CurrencyCriteria
- SemaTreeCurrencyRestServices.CurrencyExchangeRateGETData
- SemaTreeCurrencyRestServices.CurrencyExchangeRatePeriodGETData
- SemaTreeCurrencyRestServices.CurrencyExchangeRatePeriodPOSTData
- SemaTreeCurrencyRestServices.CurrencyExchangeRatePeriodPUTData
- SemaTreeCurrencyRestServices.CurrencyFormatGETData
- SemaTreeCurrencyRestServices.CurrencyFormatPOSTData
- SemaTreeCurrencyRestServices.CurrencyFormatPUTData
- SemaTreeCurrencyRestServices.CurrencyGETData
- SemaTreeCurrencyRestServices.CurrencyHelperViewGETData
- SemaTreeCurrencyRestServices.CurrencyPOSTData
- SemaTreeCurrencyRestServices.CurrencyPUTData
- SemaTreeCurrencyRestServices.CurrencyWidgetGETData
- SemaTreeCurrencyRestServices.DCPageData
- SemaTreeCurrencyRestServices.DateGETData
- SemaTreeCurrencyRestServices.ExchangeRateCurrencyData
- SemaTreeCurrencyRestServices.RelationshipGETData
- SemaTreeCurrencyRestServices.RelationshipPOSTData
- SemaTreeCurrencyRestServices.SearchResults
Documentation for Authorization
Endpoints do not require authorization.
9 months ago