npm package: @manageiq/topological_inventory
Description: Topological_Inventory
Latest version: 1.2.0

# @manageiq/topological_inventory

@ManageiqTopologicalInventory - JavaScript client for @manageiq/topological_inventory
Topological Inventory
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## 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 @manageiq/topological_inventory --save
```

#### 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 @ManageiqTopologicalInventory = require('@manageiq/topological_inventory');

var defaultClient = @ManageiqTopologicalInventory.ApiClient.instance;
// Configure HTTP basic authorization: UserSecurity
var UserSecurity = defaultClient.authentications['UserSecurity'];
UserSecurity.username = 'YOUR USERNAME'
UserSecurity.password = 'YOUR PASSWORD'

var api = new @ManageiqTopologicalInventory.DefaultApi()
var authentication = new @ManageiqTopologicalInventory.Authentication(); // {Authentication} Authentication attributes to create
api.createAuthentication(authentication).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://virtserver.swaggerhub.com/r/insights/platform/topological-inventory/v0.1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*@ManageiqTopologicalInventory.DefaultApi* | [**createAuthentication**](docs/DefaultApi.md#createAuthentication) | **POST** /authentications | Create a new Authentication
*@ManageiqTopologicalInventory.DefaultApi* | [**createEndpoint**](docs/DefaultApi.md#createEndpoint) | **POST** /endpoints | Create a new Endpoint
*@ManageiqTopologicalInventory.DefaultApi* | [**createSource**](docs/DefaultApi.md#createSource) | **POST** /sources | Create a new Source
*@ManageiqTopologicalInventory.DefaultApi* | [**createSourceType**](docs/DefaultApi.md#createSourceType) | **POST** /source_types | Create a new SourceType
*@ManageiqTopologicalInventory.DefaultApi* | [**deleteAuthentication**](docs/DefaultApi.md#deleteAuthentication) | **DELETE** /authentications/{id} | Delete an existing Authentication
*@ManageiqTopologicalInventory.DefaultApi* | [**deleteEndpoint**](docs/DefaultApi.md#deleteEndpoint) | **DELETE** /endpoints/{id} | Delete an existing Endpoint
*@ManageiqTopologicalInventory.DefaultApi* | [**deleteSource**](docs/DefaultApi.md#deleteSource) | **DELETE** /sources/{id} | Delete an existing Source
*@ManageiqTopologicalInventory.DefaultApi* | [**getDocumentation**](docs/DefaultApi.md#getDocumentation) | **GET** /openapi.json | Return this API document in JSON format
*@ManageiqTopologicalInventory.DefaultApi* | [**listAuthentications**](docs/DefaultApi.md#listAuthentications) | **GET** /authentications | List Authentications
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerGroupContainers**](docs/DefaultApi.md#listContainerGroupContainers) | **GET** /container_groups/{id}/containers | List Containers for ContainerGroup
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerGroups**](docs/DefaultApi.md#listContainerGroups) | **GET** /container_groups | List ContainerGroups
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerImages**](docs/DefaultApi.md#listContainerImages) | **GET** /container_images | List ContainerImages
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerNodeContainerGroups**](docs/DefaultApi.md#listContainerNodeContainerGroups) | **GET** /container_nodes/{id}/container_groups | List ContainerGroups for ContainerNode
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerNodes**](docs/DefaultApi.md#listContainerNodes) | **GET** /container_nodes | List ContainerNodes
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerProjectContainerGroups**](docs/DefaultApi.md#listContainerProjectContainerGroups) | **GET** /container_projects/{id}/container_groups | List ContainerGroups for ContainerProject
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerProjectContainerTemplates**](docs/DefaultApi.md#listContainerProjectContainerTemplates) | **GET** /container_projects/{id}/container_templates | List ContainerTemplates for ContainerProject
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerProjects**](docs/DefaultApi.md#listContainerProjects) | **GET** /container_projects | List ContainerProjects
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainerTemplates**](docs/DefaultApi.md#listContainerTemplates) | **GET** /container_templates | List ContainerTemplates
*@ManageiqTopologicalInventory.DefaultApi* | [**listContainers**](docs/DefaultApi.md#listContainers) | **GET** /containers | List Containers
*@ManageiqTopologicalInventory.DefaultApi* | [**listEndpointAuthentications**](docs/DefaultApi.md#listEndpointAuthentications) | **GET** /endpoints/{id}/authentications | List Authentications for Endpoint
*@ManageiqTopologicalInventory.DefaultApi* | [**listEndpoints**](docs/DefaultApi.md#listEndpoints) | **GET** /endpoints | List Endpoints
*@ManageiqTopologicalInventory.DefaultApi* | [**listFlavors**](docs/DefaultApi.md#listFlavors) | **GET** /flavors | List Flavors
*@ManageiqTopologicalInventory.DefaultApi* | [**listOrchestrationStacks**](docs/DefaultApi.md#listOrchestrationStacks) | **GET** /orchestration_stacks | List OrchestrationStacks
*@ManageiqTopologicalInventory.DefaultApi* | [**listServiceInstances**](docs/DefaultApi.md#listServiceInstances) | **GET** /service_instances | List ServiceInstances
*@ManageiqTopologicalInventory.DefaultApi* | [**listServiceOfferingIcons**](docs/DefaultApi.md#listServiceOfferingIcons) | **GET** /service_offering_icons | List ServiceOfferingIcons
*@ManageiqTopologicalInventory.DefaultApi* | [**listServiceOfferingServiceInstances**](docs/DefaultApi.md#listServiceOfferingServiceInstances) | **GET** /service_offerings/{id}/service_instances | List ServiceInstances for ServiceOffering
*@ManageiqTopologicalInventory.DefaultApi* | [**listServiceOfferingServicePlans**](docs/DefaultApi.md#listServiceOfferingServicePlans) | **GET** /service_offerings/{id}/service_plans | List ServicePlans for ServiceOffering
*@ManageiqTopologicalInventory.DefaultApi* | [**listServiceOfferings**](docs/DefaultApi.md#listServiceOfferings) | **GET** /service_offerings | List ServiceOfferings
*@ManageiqTopologicalInventory.DefaultApi* | [**listServicePlanServiceInstances**](docs/DefaultApi.md#listServicePlanServiceInstances) | **GET** /service_plans/{id}/service_instances | List ServiceInstances for ServicePlan
*@ManageiqTopologicalInventory.DefaultApi* | [**listServicePlans**](docs/DefaultApi.md#listServicePlans) | **GET** /service_plans | List ServicePlans
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceAvailabilities**](docs/DefaultApi.md#listSourceAvailabilities) | **GET** /sources/{id}/availabilities | List Availabilities for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainerGroups**](docs/DefaultApi.md#listSourceContainerGroups) | **GET** /sources/{id}/container_groups | List ContainerGroups for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainerImages**](docs/DefaultApi.md#listSourceContainerImages) | **GET** /sources/{id}/container_images | List ContainerImages for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainerNodes**](docs/DefaultApi.md#listSourceContainerNodes) | **GET** /sources/{id}/container_nodes | List ContainerNodes for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainerProjects**](docs/DefaultApi.md#listSourceContainerProjects) | **GET** /sources/{id}/container_projects | List ContainerProjects for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainerTemplates**](docs/DefaultApi.md#listSourceContainerTemplates) | **GET** /sources/{id}/container_templates | List ContainerTemplates for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceContainers**](docs/DefaultApi.md#listSourceContainers) | **GET** /sources/{id}/containers | List Containers for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceEndpoints**](docs/DefaultApi.md#listSourceEndpoints) | **GET** /sources/{id}/endpoints | List Endpoints for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceOrchestrationStacks**](docs/DefaultApi.md#listSourceOrchestrationStacks) | **GET** /sources/{id}/orchestration_stacks | List OrchestrationStacks for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceServiceInstances**](docs/DefaultApi.md#listSourceServiceInstances) | **GET** /sources/{id}/service_instances | List ServiceInstances for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceServiceOfferings**](docs/DefaultApi.md#listSourceServiceOfferings) | **GET** /sources/{id}/service_offerings | List ServiceOfferings for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceServicePlans**](docs/DefaultApi.md#listSourceServicePlans) | **GET** /sources/{id}/service_plans | List ServicePlans for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceTypeAvailabilities**](docs/DefaultApi.md#listSourceTypeAvailabilities) | **GET** /source_types/{id}/availabilities | List Availabilities for SourceType
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceTypeSources**](docs/DefaultApi.md#listSourceTypeSources) | **GET** /source_types/{id}/sources | List Sources for SourceType
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceTypes**](docs/DefaultApi.md#listSourceTypes) | **GET** /source_types | List SourceTypes
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceVms**](docs/DefaultApi.md#listSourceVms) | **GET** /sources/{id}/vms | List Vms for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceVolumeTypes**](docs/DefaultApi.md#listSourceVolumeTypes) | **GET** /sources/{id}/volume_types | List VolumeTypes for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSourceVolumes**](docs/DefaultApi.md#listSourceVolumes) | **GET** /sources/{id}/volumes | List Volumes for Source
*@ManageiqTopologicalInventory.DefaultApi* | [**listSources**](docs/DefaultApi.md#listSources) | **GET** /sources | List Sources
*@ManageiqTopologicalInventory.DefaultApi* | [**listTags**](docs/DefaultApi.md#listTags) | **GET** /tags | List Tags
*@ManageiqTopologicalInventory.DefaultApi* | [**listTasks**](docs/DefaultApi.md#listTasks) | **GET** /tasks | List Tasks
*@ManageiqTopologicalInventory.DefaultApi* | [**listVmVolumeAttachments**](docs/DefaultApi.md#listVmVolumeAttachments) | **GET** /vms/{id}/volume_attachments | List VolumeAttachments for Vm
*@ManageiqTopologicalInventory.DefaultApi* | [**listVmVolumes**](docs/DefaultApi.md#listVmVolumes) | **GET** /vms/{id}/volumes | List Volumes for Vm
*@ManageiqTopologicalInventory.DefaultApi* | [**listVms**](docs/DefaultApi.md#listVms) | **GET** /vms | List Vms
*@ManageiqTopologicalInventory.DefaultApi* | [**listVolumeAttachments**](docs/DefaultApi.md#listVolumeAttachments) | **GET** /volume_attachments | List VolumeAttachments
*@ManageiqTopologicalInventory.DefaultApi* | [**listVolumeTypes**](docs/DefaultApi.md#listVolumeTypes) | **GET** /volume_types | List VolumeTypes
*@ManageiqTopologicalInventory.DefaultApi* | [**listVolumes**](docs/DefaultApi.md#listVolumes) | **GET** /volumes | List Volumes
*@ManageiqTopologicalInventory.DefaultApi* | [**orderServicePlan**](docs/DefaultApi.md#orderServicePlan) | **POST** /service_plans/{id}/order | Order an existing ServicePlan
*@ManageiqTopologicalInventory.DefaultApi* | [**showAuthentication**](docs/DefaultApi.md#showAuthentication) | **GET** /authentications/{id} | Show an existing Authentication
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainer**](docs/DefaultApi.md#showContainer) | **GET** /containers/{id} | Show an existing Container
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainerGroup**](docs/DefaultApi.md#showContainerGroup) | **GET** /container_groups/{id} | Show an existing ContainerGroup
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainerImage**](docs/DefaultApi.md#showContainerImage) | **GET** /container_images/{id} | Show an existing ContainerImage
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainerNode**](docs/DefaultApi.md#showContainerNode) | **GET** /container_nodes/{id} | Show an existing ContainerNode
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainerProject**](docs/DefaultApi.md#showContainerProject) | **GET** /container_projects/{id} | Show an existing ContainerProject
*@ManageiqTopologicalInventory.DefaultApi* | [**showContainerTemplate**](docs/DefaultApi.md#showContainerTemplate) | **GET** /container_templates/{id} | Show an existing ContainerTemplate
*@ManageiqTopologicalInventory.DefaultApi* | [**showEndpoint**](docs/DefaultApi.md#showEndpoint) | **GET** /endpoints/{id} | Show an existing Endpoint
*@ManageiqTopologicalInventory.DefaultApi* | [**showFlavor**](docs/DefaultApi.md#showFlavor) | **GET** /flavors/{id} | Show an existing Flavor
*@ManageiqTopologicalInventory.DefaultApi* | [**showOrchestrationStack**](docs/DefaultApi.md#showOrchestrationStack) | **GET** /orchestration_stacks/{id} | Show an existing OrchestrationStack
*@ManageiqTopologicalInventory.DefaultApi* | [**showServiceInstance**](docs/DefaultApi.md#showServiceInstance) | **GET** /service_instances/{id} | Show an existing ServiceInstance
*@ManageiqTopologicalInventory.DefaultApi* | [**showServiceOffering**](docs/DefaultApi.md#showServiceOffering) | **GET** /service_offerings/{id} | Show an existing ServiceOffering
*@ManageiqTopologicalInventory.DefaultApi* | [**showServiceOfferingIcon**](docs/DefaultApi.md#showServiceOfferingIcon) | **GET** /service_offering_icons/{id} | Show an existing ServiceOfferingIcon
*@ManageiqTopologicalInventory.DefaultApi* | [**showServicePlan**](docs/DefaultApi.md#showServicePlan) | **GET** /service_plans/{id} | Show an existing ServicePlan
*@ManageiqTopologicalInventory.DefaultApi* | [**showSource**](docs/DefaultApi.md#showSource) | **GET** /sources/{id} | Show an existing Source
*@ManageiqTopologicalInventory.DefaultApi* | [**showSourceType**](docs/DefaultApi.md#showSourceType) | **GET** /source_types/{id} | Show an existing SourceType
*@ManageiqTopologicalInventory.DefaultApi* | [**showTag**](docs/DefaultApi.md#showTag) | **GET** /tags/{id} | Show an existing Tag
*@ManageiqTopologicalInventory.DefaultApi* | [**showTask**](docs/DefaultApi.md#showTask) | **GET** /tasks/{id} | Show an existing Task
*@ManageiqTopologicalInventory.DefaultApi* | [**showVm**](docs/DefaultApi.md#showVm) | **GET** /vms/{id} | Show an existing Vm
*@ManageiqTopologicalInventory.DefaultApi* | [**showVolume**](docs/DefaultApi.md#showVolume) | **GET** /volumes/{id} | Show an existing Volume
*@ManageiqTopologicalInventory.DefaultApi* | [**showVolumeAttachment**](docs/DefaultApi.md#showVolumeAttachment) | **GET** /volume_attachments/{id} | Show an existing VolumeAttachment
*@ManageiqTopologicalInventory.DefaultApi* | [**showVolumeType**](docs/DefaultApi.md#showVolumeType) | **GET** /volume_types/{id} | Show an existing VolumeType
*@ManageiqTopologicalInventory.DefaultApi* | [**updateAuthentication**](docs/DefaultApi.md#updateAuthentication) | **PATCH** /authentications/{id} | Update an existing Authentication
*@ManageiqTopologicalInventory.DefaultApi* | [**updateEndpoint**](docs/DefaultApi.md#updateEndpoint) | **PATCH** /endpoints/{id} | Update an existing Endpoint
*@ManageiqTopologicalInventory.DefaultApi* | [**updateSource**](docs/DefaultApi.md#updateSource) | **PATCH** /sources/{id} | Update an existing Source
*@ManageiqTopologicalInventory.DefaultApi* | [**updateTask**](docs/DefaultApi.md#updateTask) | **PATCH** /tasks/{id} | Update an existing Task


## Documentation for Models

 - [@ManageiqTopologicalInventory.Authentication](docs/Authentication.md)
 - [@ManageiqTopologicalInventory.AuthenticationsCollection](docs/AuthenticationsCollection.md)
 - [@ManageiqTopologicalInventory.AvailabilitiesCollection](docs/AvailabilitiesCollection.md)
 - [@ManageiqTopologicalInventory.Availability](docs/Availability.md)
 - [@ManageiqTopologicalInventory.CollectionLinks](docs/CollectionLinks.md)
 - [@ManageiqTopologicalInventory.CollectionMetadata](docs/CollectionMetadata.md)
 - [@ManageiqTopologicalInventory.Container](docs/Container.md)
 - [@ManageiqTopologicalInventory.ContainerGroup](docs/ContainerGroup.md)
 - [@ManageiqTopologicalInventory.ContainerGroupsCollection](docs/ContainerGroupsCollection.md)
 - [@ManageiqTopologicalInventory.ContainerImage](docs/ContainerImage.md)
 - [@ManageiqTopologicalInventory.ContainerImagesCollection](docs/ContainerImagesCollection.md)
 - [@ManageiqTopologicalInventory.ContainerNode](docs/ContainerNode.md)
 - [@ManageiqTopologicalInventory.ContainerNodesCollection](docs/ContainerNodesCollection.md)
 - [@ManageiqTopologicalInventory.ContainerProject](docs/ContainerProject.md)
 - [@ManageiqTopologicalInventory.ContainerProjectsCollection](docs/ContainerProjectsCollection.md)
 - [@ManageiqTopologicalInventory.ContainerTemplate](docs/ContainerTemplate.md)
 - [@ManageiqTopologicalInventory.ContainerTemplatesCollection](docs/ContainerTemplatesCollection.md)
 - [@ManageiqTopologicalInventory.ContainersCollection](docs/ContainersCollection.md)
 - [@ManageiqTopologicalInventory.Endpoint](docs/Endpoint.md)
 - [@ManageiqTopologicalInventory.EndpointsCollection](docs/EndpointsCollection.md)
 - [@ManageiqTopologicalInventory.Flavor](docs/Flavor.md)
 - [@ManageiqTopologicalInventory.FlavorsCollection](docs/FlavorsCollection.md)
 - [@ManageiqTopologicalInventory.InlineResponse200](docs/InlineResponse200.md)
 - [@ManageiqTopologicalInventory.OrchestrationStack](docs/OrchestrationStack.md)
 - [@ManageiqTopologicalInventory.OrchestrationStacksCollection](docs/OrchestrationStacksCollection.md)
 - [@ManageiqTopologicalInventory.OrderParameters](docs/OrderParameters.md)
 - [@ManageiqTopologicalInventory.ServiceInstance](docs/ServiceInstance.md)
 - [@ManageiqTopologicalInventory.ServiceInstancesCollection](docs/ServiceInstancesCollection.md)
 - [@ManageiqTopologicalInventory.ServiceOffering](docs/ServiceOffering.md)
 - [@ManageiqTopologicalInventory.ServiceOfferingIcon](docs/ServiceOfferingIcon.md)
 - [@ManageiqTopologicalInventory.ServiceOfferingIconsCollection](docs/ServiceOfferingIconsCollection.md)
 - [@ManageiqTopologicalInventory.ServiceOfferingsCollection](docs/ServiceOfferingsCollection.md)
 - [@ManageiqTopologicalInventory.ServicePlan](docs/ServicePlan.md)
 - [@ManageiqTopologicalInventory.ServicePlansCollection](docs/ServicePlansCollection.md)
 - [@ManageiqTopologicalInventory.Source](docs/Source.md)
 - [@ManageiqTopologicalInventory.SourceType](docs/SourceType.md)
 - [@ManageiqTopologicalInventory.SourceTypesCollection](docs/SourceTypesCollection.md)
 - [@ManageiqTopologicalInventory.SourcesCollection](docs/SourcesCollection.md)
 - [@ManageiqTopologicalInventory.Tag](docs/Tag.md)
 - [@ManageiqTopologicalInventory.Tagging](docs/Tagging.md)
 - [@ManageiqTopologicalInventory.TagsCollection](docs/TagsCollection.md)
 - [@ManageiqTopologicalInventory.Task](docs/Task.md)
 - [@ManageiqTopologicalInventory.TasksCollection](docs/TasksCollection.md)
 - [@ManageiqTopologicalInventory.Vm](docs/Vm.md)
 - [@ManageiqTopologicalInventory.VmsCollection](docs/VmsCollection.md)
 - [@ManageiqTopologicalInventory.Volume](docs/Volume.md)
 - [@ManageiqTopologicalInventory.VolumeAttachment](docs/VolumeAttachment.md)
 - [@ManageiqTopologicalInventory.VolumeAttachmentsCollection](docs/VolumeAttachmentsCollection.md)
 - [@ManageiqTopologicalInventory.VolumeType](docs/VolumeType.md)
 - [@ManageiqTopologicalInventory.VolumeTypesCollection](docs/VolumeTypesCollection.md)
 - [@ManageiqTopologicalInventory.VolumesCollection](docs/VolumesCollection.md)


## Documentation for Authorization


### UserSecurity

- **Type**: HTTP basic authentication