ionoscloud 5.0.0.beta.1 → 5.1.1

data/docs/models/LanPost.md

@@ -0,0 +1,28 @@
+# LanPost
+
+## 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] |
+| **entities** | [**LanEntities**](LanEntities.md) |  | [optional] |
+| **properties** | [**LanPropertiesPost**](LanPropertiesPost.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::LanPost.new(
+  id: 5,
+  type: "lan",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  entities: null,
+  properties: null
+)
+```
+

data/docs/models/LanProperties.md

@@ -0,0 +1,24 @@
+# LanProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **ip_failover** | [**Array<IPFailover>**](IPFailover.md) | IP failover configurations for lan | [optional] |
+| **pcc** | **String** | Unique identifier of the private cross connect the given LAN is connected to if any | [optional] |
+| **public** | **Boolean** | Does this LAN faces the public Internet or not | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::LanProperties.new(
+  name: My resource,
+  ip_failover: null,
+  pcc: 3c11273c-b3e1-4ca3-8134-84fd2dd4ebec,
+  public: true
+)
+```
+

data/docs/models/LanPropertiesPost.md

@@ -0,0 +1,24 @@
+# LanPropertiesPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **ip_failover** | [**Array<IPFailover>**](IPFailover.md) | IP failover configurations for lan | [optional] |
+| **pcc** | **String** | Unique identifier of the private cross connect the given LAN is connected to if any | [optional] |
+| **public** | **Boolean** | Does this LAN faces the public Internet or not | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::LanPropertiesPost.new(
+  name: My resource,
+  ip_failover: null,
+  pcc: 3c11273c-b3e1-4ca3-8134-84fd2dd4ebec,
+  public: true
+)
+```
+

data/docs/models/Lans.md

@@ -0,0 +1,30 @@
+# Lans
+
+## 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<Lan>**](Lan.md) | Array of items in lans 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::Lans.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/models/Loadbalancer.md

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

data/docs/models/LoadbalancerEntities.md

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

data/docs/models/LoadbalancerProperties.md

@@ -0,0 +1,22 @@
+# LoadbalancerProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **ip** | **String** | IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically | [optional] |
+| **dhcp** | **Boolean** | Indicates if the loadbalancer will reserve an IP using DHCP | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::LoadbalancerProperties.new(
+  name: My resource,
+  ip: 22.231.113.64,
+  dhcp: true
+)
+```
+

data/docs/models/Loadbalancers.md

@@ -0,0 +1,30 @@
+# Loadbalancers
+
+## 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<Loadbalancer>**](Loadbalancer.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::Loadbalancers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/models/Location.md

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

data/docs/models/LocationProperties.md

@@ -0,0 +1,22 @@
+# LocationProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **features** | **Array<String>** | List of features supported by the location | [optional][readonly] |
+| **image_aliases** | **Array<String>** | List of image aliases available for the location | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::LocationProperties.new(
+  name: My resource,
+  features: [SSD],
+  image_aliases: null
+)
+```
+

data/docs/models/Locations.md

@@ -0,0 +1,24 @@
+# Locations
+
+## 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<Location>**](Location.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Locations.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null
+)
+```
+

data/docs/models/Nic.md

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

data/docs/models/NicEntities.md

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

data/docs/models/NicProperties.md

@@ -0,0 +1,30 @@
+# NicProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **mac** | **String** | The MAC address of the NIC | [optional][readonly] |
+| **ips** | **Array<String>** | Collection of IP addresses assigned to a nic. Explicitly assigned public IPs need to come from reserved IP blocks, Passing value null or empty array will assign an IP address automatically. | [optional] |
+| **dhcp** | **Boolean** | Indicates if the nic will reserve an IP using DHCP | [optional] |
+| **lan** | **Integer** | The LAN ID the NIC will sit on. If the LAN ID does not exist it will be implicitly created |  |
+| **firewall_active** | **Boolean** | Activate or deactivate the firewall. By default an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, ip addresses and ports. | [optional] |
+| **nat** | **Boolean** | Indicates if NAT is enabled on this NIC. This is now deprecated. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::NicProperties.new(
+  name: My resource,
+  mac: 00:0a:95:9d:68:16,
+  ips: null,
+  dhcp: true,
+  lan: 2,
+  firewall_active: false,
+  nat: true
+)
+```
+

data/docs/models/Nics.md

@@ -0,0 +1,30 @@
+# Nics
+
+## 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<Nic>**](Nic.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::Nics.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+

data/docs/models/NoStateMetaData.md

@@ -0,0 +1,30 @@
+# NoStateMetaData
+
+## 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 Resource was created | [optional][readonly] |
+| **created_by** | **String** | The user who has 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] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::NoStateMetaData.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
+)
+```
+

data/docs/models/PaginationLinks.md

@@ -0,0 +1,22 @@
+# PaginationLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prev** | **String** | URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0 | [optional][readonly] |
+| **_self** | **String** | URL (with offset and limit parameters) of the current page | [optional][readonly] |
+| **_next** | **String** | URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::PaginationLinks.new(
+  prev: <PREVIOUS-PAGE-URI>,
+  _self: <THIS-PAGE-URI>,
+  _next: <NEXT-PAGE-URI>
+)
+```
+

data/docs/models/Peer.md

@@ -0,0 +1,26 @@
+# Peer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **datacenter_id** | **String** |  | [optional] |
+| **datacenter_name** | **String** |  | [optional] |
+| **location** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Peer.new(
+  id: null,
+  name: null,
+  datacenter_id: null,
+  datacenter_name: null,
+  location: null
+)
+```
+

data/docs/models/PrivateCrossConnect.md

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

data/docs/models/PrivateCrossConnectProperties.md

@@ -0,0 +1,24 @@
+# PrivateCrossConnectProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A name of that resource | [optional] |
+| **description** | **String** | Human readable description | [optional] |
+| **peers** | [**Array<Peer>**](Peer.md) | Read-Only attribute. Lists LAN's joined to this private cross connect | [optional][readonly] |
+| **connectable_datacenters** | [**Array<ConnectableDatacenter>**](ConnectableDatacenter.md) | Read-Only attribute. Lists datacenters that can be joined to this private cross connect | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::PrivateCrossConnectProperties.new(
+  name: My resource,
+  description: Private Cross-Connect between datacenter 'A' and datacenter 'B' ,
+  peers: { "peers": [ { "id": "<lan-id>", "name": "<lan-name>", "datacenterId": "<dc-uuid>",  "datacenterName": "<dc-name>", "location": "<de/fra>"} ] },
+  connectable_datacenters: { "connectableDatacenters": [ { "id": "<dc-id>", "name": "<dc-name>", "location": "<de/fra>"} ] }
+)
+```
+

data/docs/models/PrivateCrossConnects.md

@@ -0,0 +1,24 @@
+# PrivateCrossConnects
+
+## 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<PrivateCrossConnect>**](PrivateCrossConnect.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::PrivateCrossConnects.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null
+)
+```
+

data/docs/models/Request.md

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

data/docs/models/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/models/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/models/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
+)
+```
+