# here-data-config-v1-client
The `config` service provides basic catalog management operations. It manages all platform resources needed for different kinds of catalogs and operations on them.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.1.6
- Package version: 1.2.97
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import here_data_config_v1_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import here_data_config_v1_client
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import here_data_config_v1_client
from pprint import pprint
from here_data_config_v1_client.api import config_api
from here_data_config_v1_client.model.catalog import Catalog
from here_data_config_v1_client.model.catalog_failure_status import CatalogFailureStatus
from here_data_config_v1_client.model.catalog_operation_success_status import CatalogOperationSuccessStatus
from here_data_config_v1_client.model.catalog_pending_status import CatalogPendingStatus
from here_data_config_v1_client.model.catalog_success_status import CatalogSuccessStatus
from here_data_config_v1_client.model.create_catalog import CreateCatalog
from here_data_config_v1_client.model.patch_catalog import PatchCatalog
from here_data_config_v1_client.model.patch_layer import PatchLayer
from here_data_config_v1_client.model.status_link import StatusLink
# Defining the host is optional and defaults to http://Use API Lookup for a base URL
# See configuration.py for a list of all supported configuration parameters.
configuration = here_data_config_v1_client.Configuration(
    host = "http://Use API Lookup for a base URL"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = here_data_config_v1_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)


# Enter a context with an instance of the API client
with here_data_config_v1_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = config_api.ConfigApi(api_client)
    catalog_hrn = "catalogHrn_example" # str | The HERE Resource Name (HRN) of the catalog.
billing_tag = "billingTag_example" # str | The `billingTag` parameter is an optional free-form tag that you can use to group billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters  [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases. (optional)

    try:
        # Checks the existence of a catalog
        api_instance.catalog_exists(catalog_hrn, billing_tag=billing_tag)
    except here_data_config_v1_client.ApiException as e:
        print("Exception when calling ConfigApi->catalog_exists: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *http://Use API Lookup for a base URL*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConfigApi* | [**catalog_exists**](docs/ConfigApi.md#catalog_exists) | **HEAD** /catalogs/{catalogHrn} | Checks the existence of a catalog
*ConfigApi* | [**create_catalog**](docs/ConfigApi.md#create_catalog) | **POST** /catalogs | Creates a catalog
*ConfigApi* | [**delete_catalog**](docs/ConfigApi.md#delete_catalog) | **DELETE** /catalogs/{catalogHrn} | Deletes a catalog
*ConfigApi* | [**delete_layer**](docs/ConfigApi.md#delete_layer) | **DELETE** /catalogs/{catalogHrn}/layers/{layerId} | Delete a layer
*ConfigApi* | [**disable_automatic_version_deletion**](docs/ConfigApi.md#disable_automatic_version_deletion) | **DELETE** /catalogs/{catalogHrn}/automaticVersionDeletion | Disable automatic version deletion
*ConfigApi* | [**get_catalog**](docs/ConfigApi.md#get_catalog) | **GET** /catalogs/{catalogHrn} | Gets the details of a catalog
*ConfigApi* | [**get_catalog_status**](docs/ConfigApi.md#get_catalog_status) | **GET** /status/{token} | Gets the status of a create, update or delete catalog request.
*ConfigApi* | [**get_catalogs**](docs/ConfigApi.md#get_catalogs) | **GET** /catalogs | Gets a list of all catalogs
*ConfigApi* | [**patch_catalog**](docs/ConfigApi.md#patch_catalog) | **PATCH** /catalogs/{catalogHrn} | Modify a catalog
*ConfigApi* | [**patch_layer**](docs/ConfigApi.md#patch_layer) | **PATCH** /catalogs/{catalogHrn}/layers/{layerId} | Modify a catalog layer
*ConfigApi* | [**update_catalog**](docs/ConfigApi.md#update_catalog) | **PUT** /catalogs/{catalogHrn} | Updates a catalog


## Documentation For Models

 - [AutomaticVersionDeletion](docs/AutomaticVersionDeletion.md)
 - [BillingTags](docs/BillingTags.md)
 - [CRC](docs/CRC.md)
 - [Catalog](docs/Catalog.md)
 - [CatalogFailureStatus](docs/CatalogFailureStatus.md)
 - [CatalogLink](docs/CatalogLink.md)
 - [CatalogOperationSuccessStatus](docs/CatalogOperationSuccessStatus.md)
 - [CatalogPendingStatus](docs/CatalogPendingStatus.md)
 - [CatalogSuccessStatus](docs/CatalogSuccessStatus.md)
 - [CatalogSummary](docs/CatalogSummary.md)
 - [CatalogsList](docs/CatalogsList.md)
 - [CatalogsListResult](docs/CatalogsListResult.md)
 - [CatalogsListResultAllOf](docs/CatalogsListResultAllOf.md)
 - [CatalogsResultBase](docs/CatalogsResultBase.md)
 - [CatalogsSummaryList](docs/CatalogsSummaryList.md)
 - [CatalogsSummaryListResult](docs/CatalogsSummaryListResult.md)
 - [CatalogsSummaryListResultAllOf](docs/CatalogsSummaryListResultAllOf.md)
 - [ContentEncoding](docs/ContentEncoding.md)
 - [Coverage](docs/Coverage.md)
 - [CreateBaseLayer](docs/CreateBaseLayer.md)
 - [CreateCatalog](docs/CreateCatalog.md)
 - [CreateIndexLayer](docs/CreateIndexLayer.md)
 - [CreateIndexLayerAllOf](docs/CreateIndexLayerAllOf.md)
 - [CreateInteractiveMapsLayer](docs/CreateInteractiveMapsLayer.md)
 - [CreateInteractiveMapsLayerAllOf](docs/CreateInteractiveMapsLayerAllOf.md)
 - [CreateObjectstoreLayer](docs/CreateObjectstoreLayer.md)
 - [CreateObjectstoreLayerAllOf](docs/CreateObjectstoreLayerAllOf.md)
 - [CreateStreamLayer](docs/CreateStreamLayer.md)
 - [CreateStreamLayerAllOf](docs/CreateStreamLayerAllOf.md)
 - [CreateVersionedLayer](docs/CreateVersionedLayer.md)
 - [CreateVersionedLayerAllOf](docs/CreateVersionedLayerAllOf.md)
 - [CreateVolatileLayer](docs/CreateVolatileLayer.md)
 - [CreateVolatileLayerAllOf](docs/CreateVolatileLayerAllOf.md)
 - [Creator](docs/Creator.md)
 - [DeprecatedPartitioningScheme](docs/DeprecatedPartitioningScheme.md)
 - [Digest](docs/Digest.md)
 - [DurableVolume](docs/DurableVolume.md)
 - [GetBaseLayer](docs/GetBaseLayer.md)
 - [IndexDefinition](docs/IndexDefinition.md)
 - [IndexLayer](docs/IndexLayer.md)
 - [IndexLayerAllOf](docs/IndexLayerAllOf.md)
 - [IndexLayerType](docs/IndexLayerType.md)
 - [IndexProperties](docs/IndexProperties.md)
 - [InteractiveMapsLayer](docs/InteractiveMapsLayer.md)
 - [InteractiveMapsLayerAllOf](docs/InteractiveMapsLayerAllOf.md)
 - [InteractiveMapsLayerType](docs/InteractiveMapsLayerType.md)
 - [InteractiveMapsProperties](docs/InteractiveMapsProperties.md)
 - [LayerDescription](docs/LayerDescription.md)
 - [LayerId](docs/LayerId.md)
 - [LayerName](docs/LayerName.md)
 - [LayerSummary](docs/LayerSummary.md)
 - [Notifications](docs/Notifications.md)
 - [ObjectstoreLayer](docs/ObjectstoreLayer.md)
 - [ObjectstoreLayerAllOf](docs/ObjectstoreLayerAllOf.md)
 - [ObjectstoreLayerType](docs/ObjectstoreLayerType.md)
 - [Organisation](docs/Organisation.md)
 - [Owner](docs/Owner.md)
 - [Partitioning](docs/Partitioning.md)
 - [PartitioningScheme](docs/PartitioningScheme.md)
 - [PatchCatalog](docs/PatchCatalog.md)
 - [PatchIndexProperties](docs/PatchIndexProperties.md)
 - [PatchInteractiveMapsProperties](docs/PatchInteractiveMapsProperties.md)
 - [PatchLayer](docs/PatchLayer.md)
 - [PatchStreamProperties](docs/PatchStreamProperties.md)
 - [Replication](docs/Replication.md)
 - [ReplicationRegion](docs/ReplicationRegion.md)
 - [Schema](docs/Schema.md)
 - [StatusLink](docs/StatusLink.md)
 - [StreamLayer](docs/StreamLayer.md)
 - [StreamLayerAllOf](docs/StreamLayerAllOf.md)
 - [StreamLayerType](docs/StreamLayerType.md)
 - [StreamProperties](docs/StreamProperties.md)
 - [Tags](docs/Tags.md)
 - [VersionedLayer](docs/VersionedLayer.md)
 - [VersionedLayerAllOf](docs/VersionedLayerAllOf.md)
 - [VersionedLayerType](docs/VersionedLayerType.md)
 - [VolatileLayer](docs/VolatileLayer.md)
 - [VolatileLayerAllOf](docs/VolatileLayerAllOf.md)
 - [VolatileLayerType](docs/VolatileLayerType.md)
 - [VolatileProperties](docs/VolatileProperties.md)
 - [VolatileVolume](docs/VolatileVolume.md)


## Documentation For Authorization


## Bearer

- **Type**: Bearer authentication (JWT)


## Author




## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in here_data_config_v1_client.apis and here_data_config_v1_client.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1:
Use specific imports for apis and models like:
- `from here_data_config_v1_client.api.default_api import DefaultApi`
- `from here_data_config_v1_client.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import here_data_config_v1_client
from here_data_config_v1_client.apis import *
from here_data_config_v1_client.models import *
```

