ionoscloud 5.0.0 → 5.0.1

data/docs/RequestMetadata.md

@@ -0,0 +1,24 @@
+# RequestMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_date** | **Time** | The last time the resource was created | [optional][readonly] |
+| **created_by** | **String** | The user who created the resource. | [optional][readonly] |
+| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.  | [optional][readonly] |
+| **request_status** | [**RequestStatus**](RequestStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::RequestMetadata.new(
+  created_date: 2015-12-04T14:34:09.809Z,
+  created_by: user@example.com,
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  request_status: null
+)
+```
+

data/docs/RequestProperties.md

@@ -0,0 +1,24 @@
+# RequestProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  | [optional] |
+| **headers** | **Hash<String, String>** |  | [optional] |
+| **body** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::RequestProperties.new(
+  method: null,
+  headers: null,
+  body: null,
+  url: null
+)
+```
+

data/docs/RequestStatus.md

@@ -0,0 +1,24 @@
+# RequestStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**RequestStatusMetadata**](RequestStatusMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::RequestStatus.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "request-status",
+  href: <RESOURCE-URI>,
+  metadata: null
+)
+```
+

data/docs/RequestStatusMetadata.md

@@ -0,0 +1,24 @@
+# RequestStatusMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.  | [optional][readonly] |
+| **targets** | [**Array<RequestTarget>**](RequestTarget.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::RequestStatusMetadata.new(
+  status: null,
+  message: null,
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  targets: null
+)
+```
+

data/docs/RequestTarget.md

@@ -0,0 +1,20 @@
+# RequestTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target** | [**ResourceReference**](ResourceReference.md) |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::RequestTarget.new(
+  target: null,
+  status: null
+)
+```
+

data/docs/Requests.md

@@ -0,0 +1,30 @@
+# Requests
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Request>**](Request.md) | Array of items in that collection | [optional][readonly] |
+| **offset** | **Float** | the offset specified in the request (or, if none was specified, the default offset of 0) |  |
+| **limit** | **Float** | the limit specified in the request (or, if none was specified, the default limit of 0) |  |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Requests.new(
+  id: requests,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/Resource.md

@@ -0,0 +1,28 @@
+# Resource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**ResourceProperties**](ResourceProperties.md) |  | [optional] |
+| **entities** | [**ResourceEntities**](ResourceEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Resource.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "group",
+  href: https://<API_HOST>/cloudapi/v5/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/ResourceEntities.md

@@ -0,0 +1,18 @@
+# ResourceEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | [**ResourceGroups**](ResourceGroups.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceEntities.new(
+  groups: null
+)
+```
+

data/docs/ResourceGroups.md

@@ -0,0 +1,24 @@
+# ResourceGroups
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceGroups.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v5/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources,
+  items: null
+)
+```
+

data/docs/ResourceLimits.md

@@ -0,0 +1,50 @@
+# ResourceLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores_per_server** | **Integer** | maximum number of cores per server |  |
+| **cores_per_contract** | **Integer** | maximum cores per contract |  |
+| **cores_provisioned** | **Integer** | number of cores provisioned |  |
+| **ram_per_server** | **Integer** | maximum ram per server |  |
+| **ram_per_contract** | **Integer** | maximum ram per contract |  |
+| **ram_provisioned** | **Integer** | ram provisioned |  |
+| **hdd_limit_per_volume** | **Integer** | hdd limit per volume |  |
+| **hdd_limit_per_contract** | **Integer** | hdd limit per contract |  |
+| **hdd_volume_provisioned** | **Integer** | hdd volume provisioned |  |
+| **ssd_limit_per_volume** | **Integer** | ssd limit per volume |  |
+| **ssd_limit_per_contract** | **Integer** | ssd limit per contract |  |
+| **ssd_volume_provisioned** | **Integer** | ssd volume provisioned |  |
+| **reservable_ips** | **Integer** | total reservable ip limit of the customer |  |
+| **reserved_ips_on_contract** | **Integer** | reserved ips on a contract |  |
+| **reserved_ips_in_use** | **Integer** | reserved ips in use |  |
+| **k8s_cluster_limit_total** | **Integer** | k8s clusters total limit |  |
+| **k8s_clusters_provisioned** | **Integer** | k8s clusters provisioned |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceLimits.new(
+  cores_per_server: null,
+  cores_per_contract: null,
+  cores_provisioned: null,
+  ram_per_server: null,
+  ram_per_contract: null,
+  ram_provisioned: null,
+  hdd_limit_per_volume: null,
+  hdd_limit_per_contract: null,
+  hdd_volume_provisioned: null,
+  ssd_limit_per_volume: null,
+  ssd_limit_per_contract: null,
+  ssd_volume_provisioned: null,
+  reservable_ips: null,
+  reserved_ips_on_contract: null,
+  reserved_ips_in_use: null,
+  k8s_cluster_limit_total: null,
+  k8s_clusters_provisioned: null
+)
+```
+

data/docs/ResourceProperties.md

@@ -0,0 +1,20 @@
+# ResourceProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name of the resource | [optional] |
+| **sec_auth_protection** | **Boolean** | Boolean value representing if the resource is multi factor protected or not e.g. using two factor protection. Currently only Data Centers and Snapshots are allowed to be multi factor protected, The value of attribute if null is intentional and it means that the resource doesn't support multi factor protection at all. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceProperties.new(
+  name: null,
+  sec_auth_protection: true
+)
+```
+

data/docs/ResourceReference.md

@@ -0,0 +1,22 @@
+# ResourceReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier |  |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceReference.new(
+  id: null,
+  type: "resource",
+  href: <RESOURCE-URI>
+)
+```
+

data/docs/Resources.md

@@ -0,0 +1,24 @@
+# Resources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Resources.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v5/um/resources,
+  items: null
+)
+```
+

data/docs/ResourcesUsers.md

@@ -0,0 +1,24 @@
+# ResourcesUsers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourcesUsers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v5/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns,
+  items: null
+)
+```
+

data/docs/S3Key.md

@@ -0,0 +1,26 @@
+# S3Key
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**S3KeyMetadata**](S3KeyMetadata.md) |  | [optional] |
+| **properties** | [**S3KeyProperties**](S3KeyProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3Key.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "group",
+  href: https://<API_HOST>/cloudapi/v5/um/users/15f67991-0f51-4efc-a8ad-ef1fb31a480c/s3keys/78fa888e106456c1482d,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/S3KeyMetadata.md

@@ -0,0 +1,20 @@
+# S3KeyMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.  | [optional][readonly] |
+| **created_date** | **Time** | The time the S3 key was created | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3KeyMetadata.new(
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  created_date: 2015-12-04T14:34:09.809Z
+)
+```
+

data/docs/S3KeyProperties.md

@@ -0,0 +1,20 @@
+# S3KeyProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **secret_key** | **String** | secret of the s3 key | [optional][readonly] |
+| **active** | **Boolean** | denotes if the s3 key is active or not | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3KeyProperties.new(
+  secret_key: tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG,
+  active: null
+)
+```
+