topological_inventory-api-client 1.0.0

data/docs/ErrorNotFound.md

@@ -0,0 +1,17 @@
+# TopologicalInventoryApiClient::ErrorNotFound
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorNotFoundErrors>**](ErrorNotFoundErrors.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::ErrorNotFound.new(errors: null)
+```
+
+

data/docs/ErrorNotFoundErrors.md

@@ -0,0 +1,19 @@
+# TopologicalInventoryApiClient::ErrorNotFoundErrors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **Integer** |  | [optional] 
+**detail** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::ErrorNotFoundErrors.new(status: 404,
+                                 detail: Record not found)
+```
+
+

data/docs/Flavor.md

@@ -0,0 +1,41 @@
+# TopologicalInventoryApiClient::Flavor
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**cpus** | **Integer** | Number of CPUs | [optional] [readonly] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**disk_count** | **Integer** | The number of default disks | [optional] [readonly] 
+**disk_size** | **Integer** | Size of the default disks in bytes | [optional] [readonly] 
+**extra** | [**Object**](.md) |  | [optional] [readonly] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**memory** | **Integer** | Amount of RAM in bytes | [optional] [readonly] 
+**name** | **String** |  | [optional] [readonly] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::Flavor.new(archived_at: null,
+                                 cpus: 2,
+                                 created_at: null,
+                                 disk_count: 2,
+                                 disk_size: 17179869184,
+                                 extra: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 memory: 17179869184,
+                                 name: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 updated_at: null)
+```
+
+

data/docs/FlavorsCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::FlavorsCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Flavor>**](Flavor.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::FlavorsCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/GraphQLRequest.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::GraphQLRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | The GraphQL query | [default to '{}']
+**operation_name** | **String** | If the Query contains several named operations, the operationName controls which one should be executed | [optional] [default to '']
+**variables** | [**Object**](.md) | Optional Query variables | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::GraphQLRequest.new(query: null,
+                                 operation_name: null,
+                                 variables: null)
+```
+
+

data/docs/GraphQLResponse.md

@@ -0,0 +1,19 @@
+# TopologicalInventoryApiClient::GraphQLResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) | Results from the GraphQL query | [optional] 
+**errors** | **Array<Object>** | Errors resulting from the GraphQL query | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::GraphQLResponse.new(data: null,
+                                 errors: null)
+```
+
+

data/docs/Host.md

@@ -0,0 +1,51 @@
+# TopologicalInventoryApiClient::Host
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**cluster_id** | **String** | ID of the resource | [optional] [readonly] 
+**cpus** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**description** | **String** |  | [optional] 
+**extra** | [**Object**](.md) |  | [optional] 
+**hostname** | **String** |  | [optional] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**memory** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**power_state** | **String** |  | [optional] 
+**source_created_at** | **DateTime** |  | [optional] 
+**source_deleted_at** | **DateTime** |  | [optional] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] 
+**uid_ems** | **String** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::Host.new(archived_at: null,
+                                 cluster_id: null,
+                                 cpus: null,
+                                 created_at: null,
+                                 description: null,
+                                 extra: null,
+                                 hostname: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 memory: null,
+                                 name: null,
+                                 power_state: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 uid_ems: null,
+                                 updated_at: null)
+```
+
+

data/docs/HostsCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::HostsCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Host>**](Host.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::HostsCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,17 @@
+# TopologicalInventoryApiClient::InlineResponse200
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::InlineResponse200.new(task_id: null)
+```
+
+

data/docs/Ipaddress.md

@@ -0,0 +1,49 @@
+# TopologicalInventoryApiClient::Ipaddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**extra** | [**Object**](.md) |  | [optional] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**ipaddress** | **String** |  | [optional] 
+**kind** | **String** |  | [optional] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**network_adapter_id** | **String** | ID of the resource | [optional] [readonly] 
+**orchestration_stack_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_created_at** | **DateTime** |  | [optional] 
+**source_deleted_at** | **DateTime** |  | [optional] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] 
+**source_region_id** | **String** | ID of the resource | [optional] [readonly] 
+**subnet_id** | **String** | ID of the resource | [optional] [readonly] 
+**subscription_id** | **String** | ID of the resource | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::Ipaddress.new(archived_at: null,
+                                 created_at: null,
+                                 extra: null,
+                                 id: null,
+                                 ipaddress: null,
+                                 kind: null,
+                                 last_seen_at: null,
+                                 network_adapter_id: null,
+                                 orchestration_stack_id: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 source_region_id: null,
+                                 subnet_id: null,
+                                 subscription_id: null,
+                                 updated_at: null)
+```
+
+

data/docs/IpaddressesCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::IpaddressesCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Ipaddress>**](Ipaddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::IpaddressesCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/Network.md

@@ -0,0 +1,47 @@
+# TopologicalInventoryApiClient::Network
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**cidr** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**extra** | [**Object**](.md) |  | [optional] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**name** | **String** |  | [optional] 
+**orchestration_stack_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_created_at** | **DateTime** |  | [optional] 
+**source_deleted_at** | **DateTime** |  | [optional] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] 
+**source_region_id** | **String** | ID of the resource | [optional] [readonly] 
+**status** | **String** |  | [optional] 
+**subscription_id** | **String** | ID of the resource | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::Network.new(archived_at: null,
+                                 cidr: null,
+                                 created_at: null,
+                                 extra: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 name: null,
+                                 orchestration_stack_id: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 source_region_id: null,
+                                 status: null,
+                                 subscription_id: null,
+                                 updated_at: null)
+```
+
+

data/docs/NetworkAdapter.md

@@ -0,0 +1,47 @@
+# TopologicalInventoryApiClient::NetworkAdapter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**device_id** | **String** | ID of the resource | [optional] [readonly] 
+**device_type** | **String** |  | [optional] 
+**extra** | [**Object**](.md) |  | [optional] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**mac_address** | **String** |  | [optional] 
+**orchestration_stack_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_created_at** | **DateTime** |  | [optional] 
+**source_deleted_at** | **DateTime** |  | [optional] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] 
+**source_region_id** | **String** | ID of the resource | [optional] [readonly] 
+**subscription_id** | **String** | ID of the resource | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::NetworkAdapter.new(archived_at: null,
+                                 created_at: null,
+                                 device_id: null,
+                                 device_type: null,
+                                 extra: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 mac_address: null,
+                                 orchestration_stack_id: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 source_region_id: null,
+                                 subscription_id: null,
+                                 updated_at: null)
+```
+
+

data/docs/NetworkAdaptersCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::NetworkAdaptersCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<NetworkAdapter>**](NetworkAdapter.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::NetworkAdaptersCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/NetworksCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::NetworksCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Network>**](Network.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::NetworksCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/OrchestrationStack.md

@@ -0,0 +1,43 @@
+# TopologicalInventoryApiClient::OrchestrationStack
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**description** | **String** | Description of the OrchestrationStack | [optional] [readonly] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**name** | **String** |  | [optional] [readonly] 
+**parent_orchestration_stack_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_created_at** | **DateTime** |  | [optional] [readonly] 
+**source_deleted_at** | **DateTime** |  | [optional] [readonly] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] [readonly] 
+**source_region_id** | **String** | ID of the resource | [optional] [readonly] 
+**subscription_id** | **String** | ID of the resource | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::OrchestrationStack.new(archived_at: null,
+                                 created_at: null,
+                                 description: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 name: Sample OrchestrationStack,
+                                 parent_orchestration_stack_id: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 source_region_id: null,
+                                 subscription_id: null,
+                                 updated_at: null)
+```
+
+

data/docs/OrchestrationStacksCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::OrchestrationStacksCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<OrchestrationStack>**](OrchestrationStack.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::OrchestrationStacksCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/docs/OrderParametersServiceOffering.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::OrderParametersServiceOffering
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_parameters** | [**Object**](.md) | JSON object with provisioning parameters | [optional] 
+**provider_control_parameters** | [**Object**](.md) | The provider specific parameters needed to provision this service. This might include namespaces, special keys | [optional] 
+**service_plan_id** | **String** | ID of the resource | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::OrderParametersServiceOffering.new(service_parameters: null,
+                                 provider_control_parameters: null,
+                                 service_plan_id: null)
+```
+
+

data/docs/OrderParametersServicePlan.md

@@ -0,0 +1,19 @@
+# TopologicalInventoryApiClient::OrderParametersServicePlan
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_parameters** | [**Object**](.md) | JSON object with provisioning parameters | [optional] 
+**provider_control_parameters** | [**Object**](.md) | The provider specific parameters needed to provision this service. This might include namespaces, special keys | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::OrderParametersServicePlan.new(service_parameters: null,
+                                 provider_control_parameters: null)
+```
+
+

data/docs/SecurityGroup.md

@@ -0,0 +1,47 @@
+# TopologicalInventoryApiClient::SecurityGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived_at** | **DateTime** |  | [optional] [readonly] 
+**created_at** | **DateTime** |  | [optional] [readonly] 
+**description** | **String** |  | [optional] 
+**extra** | [**Object**](.md) |  | [optional] 
+**id** | **String** | ID of the resource | [optional] [readonly] 
+**last_seen_at** | **DateTime** |  | [optional] [readonly] 
+**name** | **String** |  | [optional] 
+**network_id** | **String** | ID of the resource | [optional] [readonly] 
+**orchestration_stack_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_created_at** | **DateTime** |  | [optional] 
+**source_deleted_at** | **DateTime** |  | [optional] 
+**source_id** | **String** | ID of the resource | [optional] [readonly] 
+**source_ref** | **String** |  | [optional] 
+**source_region_id** | **String** | ID of the resource | [optional] [readonly] 
+**subscription_id** | **String** | ID of the resource | [optional] [readonly] 
+**updated_at** | **DateTime** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::SecurityGroup.new(archived_at: null,
+                                 created_at: null,
+                                 description: null,
+                                 extra: null,
+                                 id: null,
+                                 last_seen_at: null,
+                                 name: null,
+                                 network_id: null,
+                                 orchestration_stack_id: null,
+                                 source_created_at: null,
+                                 source_deleted_at: null,
+                                 source_id: null,
+                                 source_ref: null,
+                                 source_region_id: null,
+                                 subscription_id: null,
+                                 updated_at: null)
+```
+
+

data/docs/SecurityGroupsCollection.md

@@ -0,0 +1,21 @@
+# TopologicalInventoryApiClient::SecurityGroupsCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<SecurityGroup>**](SecurityGroup.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TopologicalInventoryApiClient'
+
+instance = TopologicalInventoryApiClient::SecurityGroupsCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+