npm package: @slovensko/register-adries
Description: Register_adries_popis
Latest version: 1.1.0

# @slovensko/register-adries

@SlovenskoRegisterAdries - JavaScript client for @slovensko/register-adries
Register adries popis
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://himalia.sk](https://himalia.sk)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @slovensko/register-adries --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*@SlovenskoRegisterAdries.BudovaApi* | [**budovaControllerCastObce**](docs/BudovaApi.md#budovaControllerCastObce) | **GET** /Budova/{id}/castObce | Vráti castObce, do ktorého Budova patrí
*@SlovenskoRegisterAdries.BudovaApi* | [**budovaControllerGet**](docs/BudovaApi.md#budovaControllerGet) | **GET** /Budova | Vráti všetky budovy
*@SlovenskoRegisterAdries.BudovaApi* | [**budovaControllerGetById**](docs/BudovaApi.md#budovaControllerGetById) | **GET** /Budova/{id} | Vráti Budova s príslušným identifikátorom
*@SlovenskoRegisterAdries.BudovaApi* | [**budovaControllerObec**](docs/BudovaApi.md#budovaControllerObec) | **GET** /Budova/{id}/obec | Vráti obec, do ktorého Budova patrí
*@SlovenskoRegisterAdries.BudovaApi* | [**budovaControllerVchody**](docs/BudovaApi.md#budovaControllerVchody) | **GET** /Budova/{id}/vchody | Vráti všetky vchody ktoré sa nachádzajú v Budova
*@SlovenskoRegisterAdries.BytApi* | [**bytControllerGet**](docs/BytApi.md#bytControllerGet) | **GET** /Byt | Vráti všetky byty
*@SlovenskoRegisterAdries.BytApi* | [**bytControllerGetById**](docs/BytApi.md#bytControllerGetById) | **GET** /Byt/{id} | Vráti Byt s príslušným identifikátorom
*@SlovenskoRegisterAdries.BytApi* | [**bytControllerVchody**](docs/BytApi.md#bytControllerVchody) | **GET** /Byt/{id}/vchody | Vráti vchody, do ktorého Byt patrí
*@SlovenskoRegisterAdries.CastObceApi* | [**castObceControllerBudovy**](docs/CastObceApi.md#castObceControllerBudovy) | **GET** /CastObce/{id}/budovy | Vráti všetky budovy ktoré sa nachádzajú v CastObce
*@SlovenskoRegisterAdries.CastObceApi* | [**castObceControllerGet**](docs/CastObceApi.md#castObceControllerGet) | **GET** /CastObce | Vráti všetky castiObce
*@SlovenskoRegisterAdries.CastObceApi* | [**castObceControllerGetById**](docs/CastObceApi.md#castObceControllerGetById) | **GET** /CastObce/{id} | Vráti CastObce s príslušným identifikátorom
*@SlovenskoRegisterAdries.CastObceApi* | [**castObceControllerObec**](docs/CastObceApi.md#castObceControllerObec) | **GET** /CastObce/{id}/obec | Vráti obec, do ktorého CastObce patrí
*@SlovenskoRegisterAdries.CastObceApi* | [**castObceControllerUlice**](docs/CastObceApi.md#castObceControllerUlice) | **GET** /CastObce/{id}/ulice | Vráti všetky ulice ktoré sa nachádzajú v CastObce
*@SlovenskoRegisterAdries.DefaultApi* | [**searchControllerSearch**](docs/DefaultApi.md#searchControllerSearch) | **GET** /search/{search} | 
*@SlovenskoRegisterAdries.KrajApi* | [**krajControllerGet**](docs/KrajApi.md#krajControllerGet) | **GET** /Kraj | Vráti všetky kraje
*@SlovenskoRegisterAdries.KrajApi* | [**krajControllerGetById**](docs/KrajApi.md#krajControllerGetById) | **GET** /Kraj/{id} | Vráti Kraj s príslušným identifikátorom
*@SlovenskoRegisterAdries.KrajApi* | [**krajControllerOkresy**](docs/KrajApi.md#krajControllerOkresy) | **GET** /Kraj/{id}/okresy | Vráti všetky okresy ktoré sa nachádzajú v Kraj
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerBudovy**](docs/ObecApi.md#obecControllerBudovy) | **GET** /Obec/{id}/budovy | Vráti všetky budovy ktoré sa nachádzajú v Obec
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerCastiObce**](docs/ObecApi.md#obecControllerCastiObce) | **GET** /Obec/{id}/castiObce | Vráti všetky castiObce ktoré sa nachádzajú v Obec
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerGet**](docs/ObecApi.md#obecControllerGet) | **GET** /Obec | Vráti všetky obce
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerGetById**](docs/ObecApi.md#obecControllerGetById) | **GET** /Obec/{id} | Vráti Obec s príslušným identifikátorom
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerMestskeCasti**](docs/ObecApi.md#obecControllerMestskeCasti) | **GET** /Obec/{id}/mestskeCasti | Vráti všetky mestskeCasti ktoré sa nachádzajú v Obec
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerOkres**](docs/ObecApi.md#obecControllerOkres) | **GET** /Obec/{id}/okres | Vráti okres, do ktorého Obec patrí
*@SlovenskoRegisterAdries.ObecApi* | [**obecControllerUlice**](docs/ObecApi.md#obecControllerUlice) | **GET** /Obec/{id}/ulice | Vráti všetky ulice ktoré sa nachádzajú v Obec
*@SlovenskoRegisterAdries.OkresApi* | [**okresControllerGet**](docs/OkresApi.md#okresControllerGet) | **GET** /Okres | Vráti všetky okresy
*@SlovenskoRegisterAdries.OkresApi* | [**okresControllerGetById**](docs/OkresApi.md#okresControllerGetById) | **GET** /Okres/{id} | Vráti Okres s príslušným identifikátorom
*@SlovenskoRegisterAdries.OkresApi* | [**okresControllerKraj**](docs/OkresApi.md#okresControllerKraj) | **GET** /Okres/{id}/kraj | Vráti kraj, do ktorého Okres patrí
*@SlovenskoRegisterAdries.OkresApi* | [**okresControllerObce**](docs/OkresApi.md#okresControllerObce) | **GET** /Okres/{id}/obce | Vráti všetky obce ktoré sa nachádzajú v Okres
*@SlovenskoRegisterAdries.UlicaApi* | [**ulicaControllerCastiObce**](docs/UlicaApi.md#ulicaControllerCastiObce) | **GET** /Ulica/{id}/castiObce | Vráti všetky castiObce ktoré sa nachádzajú v Ulica
*@SlovenskoRegisterAdries.UlicaApi* | [**ulicaControllerGet**](docs/UlicaApi.md#ulicaControllerGet) | **GET** /Ulica | Vráti všetky ulice
*@SlovenskoRegisterAdries.UlicaApi* | [**ulicaControllerGetById**](docs/UlicaApi.md#ulicaControllerGetById) | **GET** /Ulica/{id} | Vráti Ulica s príslušným identifikátorom
*@SlovenskoRegisterAdries.UlicaApi* | [**ulicaControllerVchody**](docs/UlicaApi.md#ulicaControllerVchody) | **GET** /Ulica/{id}/vchody | Vráti všetky vchody ktoré sa nachádzajú v Ulica
*@SlovenskoRegisterAdries.VchodApi* | [**vchodControllerBudova**](docs/VchodApi.md#vchodControllerBudova) | **GET** /Vchod/{id}/budova | Vráti budova, do ktorého Vchod patrí
*@SlovenskoRegisterAdries.VchodApi* | [**vchodControllerByty**](docs/VchodApi.md#vchodControllerByty) | **GET** /Vchod/{id}/byty | Vráti všetky byty ktoré sa nachádzajú v Vchod
*@SlovenskoRegisterAdries.VchodApi* | [**vchodControllerGet**](docs/VchodApi.md#vchodControllerGet) | **GET** /Vchod | Vráti všetky vchody
*@SlovenskoRegisterAdries.VchodApi* | [**vchodControllerGetById**](docs/VchodApi.md#vchodControllerGetById) | **GET** /Vchod/{id} | Vráti Vchod s príslušným identifikátorom
*@SlovenskoRegisterAdries.VchodApi* | [**vchodControllerUlica**](docs/VchodApi.md#vchodControllerUlica) | **GET** /Vchod/{id}/ulica | Vráti ulica, do ktorého Vchod patrí


## Documentation for Models

 - [@SlovenskoRegisterAdries.BooleanFieldComparison](docs/BooleanFieldComparison.md)
 - [@SlovenskoRegisterAdries.BudovaFilter](docs/BudovaFilter.md)
 - [@SlovenskoRegisterAdries.BudovaPaginated](docs/BudovaPaginated.md)
 - [@SlovenskoRegisterAdries.BudovaSort](docs/BudovaSort.md)
 - [@SlovenskoRegisterAdries.BytFilter](docs/BytFilter.md)
 - [@SlovenskoRegisterAdries.BytPaginated](docs/BytPaginated.md)
 - [@SlovenskoRegisterAdries.BytSort](docs/BytSort.md)
 - [@SlovenskoRegisterAdries.CastObceFilter](docs/CastObceFilter.md)
 - [@SlovenskoRegisterAdries.CastObcePaginated](docs/CastObcePaginated.md)
 - [@SlovenskoRegisterAdries.CastObceSort](docs/CastObceSort.md)
 - [@SlovenskoRegisterAdries.Kraj](docs/Kraj.md)
 - [@SlovenskoRegisterAdries.KrajFilter](docs/KrajFilter.md)
 - [@SlovenskoRegisterAdries.KrajPaginated](docs/KrajPaginated.md)
 - [@SlovenskoRegisterAdries.KrajSort](docs/KrajSort.md)
 - [@SlovenskoRegisterAdries.NumberFieldComparison](docs/NumberFieldComparison.md)
 - [@SlovenskoRegisterAdries.NumberFieldComparisonBetween](docs/NumberFieldComparisonBetween.md)
 - [@SlovenskoRegisterAdries.Obec](docs/Obec.md)
 - [@SlovenskoRegisterAdries.ObecFilter](docs/ObecFilter.md)
 - [@SlovenskoRegisterAdries.ObecPaginated](docs/ObecPaginated.md)
 - [@SlovenskoRegisterAdries.ObecSort](docs/ObecSort.md)
 - [@SlovenskoRegisterAdries.Okres](docs/Okres.md)
 - [@SlovenskoRegisterAdries.OkresFilter](docs/OkresFilter.md)
 - [@SlovenskoRegisterAdries.OkresPaginated](docs/OkresPaginated.md)
 - [@SlovenskoRegisterAdries.OkresSort](docs/OkresSort.md)
 - [@SlovenskoRegisterAdries.PaginationLinks](docs/PaginationLinks.md)
 - [@SlovenskoRegisterAdries.PaginationMeta](docs/PaginationMeta.md)
 - [@SlovenskoRegisterAdries.StringFieldComparison](docs/StringFieldComparison.md)
 - [@SlovenskoRegisterAdries.UlicaFilter](docs/UlicaFilter.md)
 - [@SlovenskoRegisterAdries.UlicaPaginated](docs/UlicaPaginated.md)
 - [@SlovenskoRegisterAdries.UlicaSort](docs/UlicaSort.md)
 - [@SlovenskoRegisterAdries.VchodFilter](docs/VchodFilter.md)
 - [@SlovenskoRegisterAdries.VchodPaginated](docs/VchodPaginated.md)
 - [@SlovenskoRegisterAdries.VchodSort](docs/VchodSort.md)


## 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