1.1.0 • Published 3 years ago

@slovensko/register-adries v1.1.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
3 years ago

@slovensko/register-adries

@SlovenskoRegisterAdries - JavaScript client for @slovensko/register-adries Register adries popis This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://himalia.sk

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 @slovensko/register-adries --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 @slovensko/register-adries 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 @SlovenskoRegisterAdries = require('@slovensko/register-adries');

var defaultClient = @SlovenskoRegisterAdries.ApiClient.instance;
// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['api-key'] = "Token"
// Configure API key authorization: apiKeyQuery
var apiKeyQuery = defaultClient.authentications['apiKeyQuery'];
apiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyQuery.apiKeyPrefix['api-key'] = "Token"

var api = new @SlovenskoRegisterAdries.BudovaApi()
var id = "id_example"; // {String} Budova identifikátor
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.budovaControllerCastObce(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:3002

ClassMethodHTTP requestDescription
@SlovenskoRegisterAdries.BudovaApibudovaControllerCastObceGET /Budova/{id}/castObceVráti castObce, do ktorého Budova patrí
@SlovenskoRegisterAdries.BudovaApibudovaControllerGetGET /BudovaVráti všetky budovy
@SlovenskoRegisterAdries.BudovaApibudovaControllerGetByIdGET /Budova/{id}Vráti Budova s príslušným identifikátorom
@SlovenskoRegisterAdries.BudovaApibudovaControllerObecGET /Budova/{id}/obecVráti obec, do ktorého Budova patrí
@SlovenskoRegisterAdries.BudovaApibudovaControllerVchodyGET /Budova/{id}/vchodyVráti všetky vchody ktoré sa nachádzajú v Budova
@SlovenskoRegisterAdries.BytApibytControllerGetGET /BytVráti všetky byty
@SlovenskoRegisterAdries.BytApibytControllerGetByIdGET /Byt/{id}Vráti Byt s príslušným identifikátorom
@SlovenskoRegisterAdries.BytApibytControllerVchodyGET /Byt/{id}/vchodyVráti vchody, do ktorého Byt patrí
@SlovenskoRegisterAdries.CastObceApicastObceControllerBudovyGET /CastObce/{id}/budovyVráti všetky budovy ktoré sa nachádzajú v CastObce
@SlovenskoRegisterAdries.CastObceApicastObceControllerGetGET /CastObceVráti všetky castiObce
@SlovenskoRegisterAdries.CastObceApicastObceControllerGetByIdGET /CastObce/{id}Vráti CastObce s príslušným identifikátorom
@SlovenskoRegisterAdries.CastObceApicastObceControllerObecGET /CastObce/{id}/obecVráti obec, do ktorého CastObce patrí
@SlovenskoRegisterAdries.CastObceApicastObceControllerUliceGET /CastObce/{id}/uliceVráti všetky ulice ktoré sa nachádzajú v CastObce
@SlovenskoRegisterAdries.DefaultApisearchControllerSearchGET /search/{search}
@SlovenskoRegisterAdries.KrajApikrajControllerGetGET /KrajVráti všetky kraje
@SlovenskoRegisterAdries.KrajApikrajControllerGetByIdGET /Kraj/{id}Vráti Kraj s príslušným identifikátorom
@SlovenskoRegisterAdries.KrajApikrajControllerOkresyGET /Kraj/{id}/okresyVráti všetky okresy ktoré sa nachádzajú v Kraj
@SlovenskoRegisterAdries.ObecApiobecControllerBudovyGET /Obec/{id}/budovyVráti všetky budovy ktoré sa nachádzajú v Obec
@SlovenskoRegisterAdries.ObecApiobecControllerCastiObceGET /Obec/{id}/castiObceVráti všetky castiObce ktoré sa nachádzajú v Obec
@SlovenskoRegisterAdries.ObecApiobecControllerGetGET /ObecVráti všetky obce
@SlovenskoRegisterAdries.ObecApiobecControllerGetByIdGET /Obec/{id}Vráti Obec s príslušným identifikátorom
@SlovenskoRegisterAdries.ObecApiobecControllerMestskeCastiGET /Obec/{id}/mestskeCastiVráti všetky mestskeCasti ktoré sa nachádzajú v Obec
@SlovenskoRegisterAdries.ObecApiobecControllerOkresGET /Obec/{id}/okresVráti okres, do ktorého Obec patrí
@SlovenskoRegisterAdries.ObecApiobecControllerUliceGET /Obec/{id}/uliceVráti všetky ulice ktoré sa nachádzajú v Obec
@SlovenskoRegisterAdries.OkresApiokresControllerGetGET /OkresVráti všetky okresy
@SlovenskoRegisterAdries.OkresApiokresControllerGetByIdGET /Okres/{id}Vráti Okres s príslušným identifikátorom
@SlovenskoRegisterAdries.OkresApiokresControllerKrajGET /Okres/{id}/krajVráti kraj, do ktorého Okres patrí
@SlovenskoRegisterAdries.OkresApiokresControllerObceGET /Okres/{id}/obceVráti všetky obce ktoré sa nachádzajú v Okres
@SlovenskoRegisterAdries.UlicaApiulicaControllerCastiObceGET /Ulica/{id}/castiObceVráti všetky castiObce ktoré sa nachádzajú v Ulica
@SlovenskoRegisterAdries.UlicaApiulicaControllerGetGET /UlicaVráti všetky ulice
@SlovenskoRegisterAdries.UlicaApiulicaControllerGetByIdGET /Ulica/{id}Vráti Ulica s príslušným identifikátorom
@SlovenskoRegisterAdries.UlicaApiulicaControllerVchodyGET /Ulica/{id}/vchodyVráti všetky vchody ktoré sa nachádzajú v Ulica
@SlovenskoRegisterAdries.VchodApivchodControllerBudovaGET /Vchod/{id}/budovaVráti budova, do ktorého Vchod patrí
@SlovenskoRegisterAdries.VchodApivchodControllerBytyGET /Vchod/{id}/bytyVráti všetky byty ktoré sa nachádzajú v Vchod
@SlovenskoRegisterAdries.VchodApivchodControllerGetGET /VchodVráti všetky vchody
@SlovenskoRegisterAdries.VchodApivchodControllerGetByIdGET /Vchod/{id}Vráti Vchod s príslušným identifikátorom
@SlovenskoRegisterAdries.VchodApivchodControllerUlicaGET /Vchod/{id}/ulicaVráti ulica, do ktorého Vchod patrí

Documentation for Models

Documentation for Authorization

apiKeyHeader

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

apiKeyQuery

  • Type: API key
  • API key parameter name: api-key
  • Location: URL query string