ionoscloud 5.0.0 → 5.0.1

data/docs/DataCenterEntities.md

@@ -0,0 +1,24 @@
+# DataCenterEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **servers** | [**Servers**](Servers.md) |  | [optional] |
+| **volumes** | [**Volumes**](Volumes.md) |  | [optional] |
+| **loadbalancers** | [**Loadbalancers**](Loadbalancers.md) |  | [optional] |
+| **lans** | [**Lans**](Lans.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::DataCenterEntities.new(
+  servers: null,
+  volumes: null,
+  loadbalancers: null,
+  lans: null
+)
+```
+

data/docs/Datacenter.md

@@ -0,0 +1,28 @@
+# Datacenter
+
+## 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** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**DatacenterProperties**](DatacenterProperties.md) |  |  |
+| **entities** | [**DataCenterEntities**](DataCenterEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Datacenter.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "datacenter",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/DatacenterElementMetadata.md

@@ -0,0 +1,32 @@
+# DatacenterElementMetadata
+
+## 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 last time the resource was created | [optional][readonly] |
+| **created_by** | **String** | The user who created the resource. | [optional][readonly] |
+| **created_by_user_id** | **String** | The user id of the user who has created the resource. | [optional][readonly] |
+| **last_modified_date** | **Time** | The last time the resource has been modified | [optional][readonly] |
+| **last_modified_by** | **String** | The user who last modified the resource. | [optional][readonly] |
+| **last_modified_by_user_id** | **String** | The user id of the user who has last modified the resource. | [optional][readonly] |
+| **state** | **String** | State of the resource. *AVAILABLE* There are no pending modification requests for this item; *BUSY* There is at least one modification request pending and all following requests will be queued; *INACTIVE* Resource has been de-provisioned; *DEPLOYING* Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; *ACTIVE* Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; *FAILED* Resource state FAILED - relevant for Kubernetes cluster/nodepool; *SUSPENDED* Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; *FAILED_SUSPENDED* Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; *UPDATING* Resource state UPDATING - relevant for Kubernetes cluster/nodepool; *FAILED_UPDATING* Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; *DESTROYING* Resource state DESTROYING - relevant for Kubernetes cluster; *FAILED_DESTROYING* Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; *TERMINATED* Resource state TERMINATED - relevant for Kubernetes cluster/nodepool | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::DatacenterElementMetadata.new(
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  created_date: 2015-12-04T14:34:09.809Z,
+  created_by: user@example.com,
+  created_by_user_id: user@example.com,
+  last_modified_date: 2015-12-04T14:34:09.809Z,
+  last_modified_by: user@example.com,
+  last_modified_by_user_id: 63cef532-26fe-4a64-a4e0-de7c8a506c90,
+  state: AVAILABLE
+)
+```
+

data/docs/DatacenterProperties.md

@@ -0,0 +1,28 @@
+# DatacenterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **description** | **String** | A description for the datacenter, e.g. staging, production | [optional] |
+| **location** | **String** | The physical location where the datacenter will be created. This will be where all of your servers live. Property cannot be modified after datacenter creation (disallowed in update requests) |  |
+| **version** | **Integer** | The version of that Data Center. Gets incremented with every change | [optional][readonly] |
+| **features** | **Array<String>** | List of features supported by the location this data center is part of | [optional][readonly] |
+| **sec_auth_protection** | **Boolean** | Boolean value representing if the data center requires extra protection e.g. two factor protection | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::DatacenterProperties.new(
+  name: My resource,
+  description: My Production Datacenter,
+  location: us/las,
+  version: 8,
+  features: [SSD],
+  sec_auth_protection: true
+)
+```
+

data/docs/Datacenters.md

@@ -0,0 +1,30 @@
+# Datacenters
+
+## 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<Datacenter>**](Datacenter.md) | Array of items in that collection | [optional][readonly] |
+| **offset** | **Float** | the offset (if specified in the request) | [optional] |
+| **limit** | **Float** | the limit (if specified in the request) | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Datacenters.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/DefaultApi.md

@@ -0,0 +1,84 @@
+# DefaultApi
+
+All URIs are relative to *https://api.ionos.com/cloudapi/v5*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_info_get**](DefaultApi.md#api_info_get) | **GET** / | Display API information |
+
+
+## api_info_get
+
+> <Info> api_info_get(opts)
+
+Display API information
+
+Display API information
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud'
+# setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Ionoscloud::DefaultApi.new
+opts = {
+  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
+  depth: 56, # Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
+  x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+}
+
+begin
+  # Display API information
+  result = api_instance.api_info_get(opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling DefaultApi->api_info_get: #{e}"
+end
+```
+
+#### Using the api_info_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Info>, Integer, Hash)> api_info_get_with_http_info(opts)
+
+```ruby
+begin
+  # Display API information
+  data, status_code, headers = api_instance.api_info_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Info>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling DefaultApi->api_info_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
+| **depth** | **Integer** | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included  - depth&#x3D;1: direct properties and children references are included  - depth&#x3D;2: direct properties and children properties are included  - depth&#x3D;3: direct properties and children properties and children&#39;s children are included  - depth&#x3D;... and so on | [optional][default to 0] |
+| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
+
+### Return type
+
+[**Info**](Info.md)
+
+### Authorization
+
+Basic Authentication
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **http_status** | **Integer** | HTTP status code of the operation | [optional][readonly] |
+| **messages** | [**Array<ErrorMessage>**](ErrorMessage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Error.new(
+  http_status: 400,
+  messages: null
+)
+```
+

data/docs/ErrorMessage.md

@@ -0,0 +1,20 @@
+# ErrorMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** | Application internal error code | [optional][readonly] |
+| **message** | **String** | Human readable message | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ErrorMessage.new(
+  error_code: 123,
+  message: Error message example
+)
+```
+

data/docs/FirewallRule.md

@@ -0,0 +1,26 @@
+# FirewallRule
+
+## 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** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**FirewallruleProperties**](FirewallruleProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::FirewallRule.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "firewall-rule",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/FirewallRules.md

@@ -0,0 +1,30 @@
+# FirewallRules
+
+## 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<FirewallRule>**](FirewallRule.md) | Array of items in that collection | [optional][readonly] |
+| **offset** | **Float** | the offset (if specified in the request) | [optional] |
+| **limit** | **Float** | the limit (if specified in the request) | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::FirewallRules.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/FirewallruleProperties.md

@@ -0,0 +1,34 @@
+# FirewallruleProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **protocol** | **String** | The protocol for the rule. Property cannot be modified after creation (disallowed in update requests) |  |
+| **source_mac** | **String** | Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address | [optional] |
+| **source_ip** | **String** | Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs | [optional] |
+| **target_ip** | **String** | In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed. Value null allows all target IPs | [optional] |
+| **icmp_code** | **Integer** | Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes | [optional] |
+| **icmp_type** | **Integer** | Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types | [optional] |
+| **port_range_start** | **Integer** | Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports | [optional] |
+| **port_range_end** | **Integer** | Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd null to allow all ports | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::FirewallruleProperties.new(
+  name: My resource,
+  protocol: TCP,
+  source_mac: 00:0a:95:9d:68:16,
+  source_ip: 22.231.113.64,
+  target_ip: 22.231.113.64,
+  icmp_code: 0,
+  icmp_type: 8,
+  port_range_start: 8,
+  port_range_end: 8
+)
+```
+

data/docs/Group.md

@@ -0,0 +1,26 @@
+# Group
+
+## 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] |
+| **properties** | [**GroupProperties**](GroupProperties.md) |  |  |
+| **entities** | [**GroupEntities**](GroupEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Group.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "group",
+  href: https://<API_HOST>/cloudapi/v5/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/GroupEntities.md

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

data/docs/GroupMembers.md

@@ -0,0 +1,24 @@
+# GroupMembers
+
+## 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<User>**](User.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::GroupMembers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v5/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/users,
+  items: null
+)
+```
+