xyzspaces.iml.apis.data_config_api module

This module contains a DataConfigApi class to perform API operations.

The HERE API reference documentation used in this module can be found here: Config API Reference # noqa E501

class xyzspaces.iml.apis.data_config_api.DataConfigApi(auth, proxies=None)[source]

Bases: xyzspaces.iml.apis.api.Api

This class defines data config APIs

Parameters
__init__(auth, proxies=None)[source]
Parameters
create_catalog(data, billing_tag=None)[source]

Create a catalog.

Parameters

  • data (Dict[str, Any]) – a dict with a catalog metadata.

  • billing_tag (Optional[str]) – A string which is used for grouping billing records.

Returns

response from the API.

Return type

Dict

get_catalog_status(catalog_status_href, billing_tag=None)[source]

Get the status of the catalog operations for the given token.

Parameters

  • catalog_status_href (str) – a catalog status href url.

  • billing_tag (Optional[str]) – A string which is used for grouping billing records.

Returns

response from the API.

Return type

tuple

get_catalog_details(catalog_hrn, billing_tag=None)[source]

Get the full catalog configuration for the requested catalog.

Parameters

  • catalog_hrn (str) – a HERE Resource Name

  • billing_tag (Optional[str]) – A string which is used for grouping billing records.

Returns

response from the API.

Return type

Dict

update_catalog(catalog_hrn, data, billing_tag=None)[source]

Update a catalog.

Parameters

  • catalog_hrn (str) – a HERE Resource Name.

  • data (Dict[str, Any]) – body of the update catalog request.

  • billing_tag (Optional[str]) – A string which is used for grouping billing records.

Returns

a dict with catalog update status.

Return type

dict

delete_catalog(catalog_hrn, billing_tag=None)[source]

Delete a catalog.

Parameters

  • catalog_hrn (str) – a HERE Resource Name.

  • billing_tag (Optional[str]) – a string which is used for grouping billing records.

Returns

a dict with catalog deletion status.

Return type

dict