ionoscloud 5.0.0 → 5.0.1

data/docs/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/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/README.md

@@ -0,0 +1,111 @@
+# Introduction
+
+![CI](https://github.com/ionos-cloud/sdk-resources/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/ionoscloud.svg)](https://badge.fury.io/rb/ionoscloud) [![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
+
+## Overview
+
+The IONOS Cloud SDK for Ruby provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Ruby. The SDK for Ruby wraps the IONOS Cloud API. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.
+
+## Getting Started
+
+### Instalation
+
+### 1. Build a gem
+
+To build the Ruby code into a gem:
+
+```text
+gem build ionoscloud.gemspec
+```
+
+Then either install the gem locally:
+
+```text
+gem install ./ionoscloud-<gem-version>.gem
+```
+
+\(for development, run `gem install --dev ./ionoscloud-<gem-version>.gem` to install the development dependencies\)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+```text
+gem 'ionoscloud', '~> <gem-version>'
+```
+
+### 2. Install from Git
+
+If the Ruby gem is hosted at a git repository: [https://github.com/ionos-cloud/sdk-ruby](https://github.com/ionos-cloud/sdk-ruby), then add the following in the Gemfile:
+
+```text
+gem 'ionoscloud', :git => 'https://github.com/ionos-cloud/sdk-ruby.git'
+```
+
+### 3. Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```text
+ruby -Ilib script.rb
+```
+
+### 4. Install from RubyGems
+
+Just add this to the Gemfile:
+
+```text
+gem 'ionoscloud', '~> <gem-version>'
+```
+
+### After installing please run the following code:
+
+```ruby
+# Load the gem
+require 'ionoscloud'
+
+# Setup authorization
+Ionoscloud.configure do |config|
+  # Configure HTTP basic authorization: Basic Authentication
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+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 "Exception when calling DefaultApi->api_info_get: #{e}"
+end
+```
+
+## Feature Reference
+
+The IONOS Cloud SDK for Ruby aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:
+
+* authentication for API calls
+* handling of asynchronous requests 
+
+## FAQ
+
+1. How can I open a bug/feature request? 
+
+Bugs & feature requests can be open on the repository issues: [https://github.com/ionos-cloud/sdk-ruby/issues/new/choose](https://github.com/ionos-cloud/sdk-ruby/issues/new/choose)
+
+1. Can I contribute to the Ruby SDK?
+
+Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you need changes please open an issue and we’ll try to take care of it.
+

data/docs/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/RequestApi.md

@@ -0,0 +1,267 @@
+# RequestApi
+
+All URIs are relative to *https://api.ionos.com/cloudapi/v5*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**requests_find_by_id**](RequestApi.md#requests_find_by_id) | **GET** /requests/{requestId} | Retrieve a Request |
+| [**requests_get**](RequestApi.md#requests_get) | **GET** /requests | List Requests |
+| [**requests_status_get**](RequestApi.md#requests_status_get) | **GET** /requests/{requestId}/status | Retrieve Request Status |
+
+
+## requests_find_by_id
+
+> <Request> requests_find_by_id(request_id, opts)
+
+Retrieve a Request
+
+Retrieves the attributes of a given request.
+
+### 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'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::RequestApi.new
+request_id = 'request_id_example' # String | 
+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
+  # Retrieve a Request
+  result = api_instance.requests_find_by_id(request_id, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_find_by_id: #{e}"
+end
+```
+
+#### Using the requests_find_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Request>, Integer, Hash)> requests_find_by_id_with_http_info(request_id, opts)
+
+```ruby
+begin
+  # Retrieve a Request
+  data, status_code, headers = api_instance.requests_find_by_id_with_http_info(request_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Request>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_find_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+| **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
+
+[**Request**](Request.md)
+
+### Authorization
+
+Basic Authentication, Token Authentication
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## requests_get
+
+> <Requests> requests_get(opts)
+
+List Requests
+
+Retrieve a list of API requests.
+
+### 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'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::RequestApi.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
+  filter_status: 'filter_status_example', # String | Request status filter to fetch all the request based on a particular status [QUEUED, RUNNING, DONE, FAILED]
+  filter_created_after: 'filter_created_after_example', # String | Filter all the requests after the created date
+  filter_created_before: 'filter_created_before_example', # String | Filter all the requests before the created date
+  offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
+  limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
+}
+
+begin
+  # List Requests
+  result = api_instance.requests_get(opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_get: #{e}"
+end
+```
+
+#### Using the requests_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Requests>, Integer, Hash)> requests_get_with_http_info(opts)
+
+```ruby
+begin
+  # List Requests
+  data, status_code, headers = api_instance.requests_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Requests>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_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] |
+| **filter_status** | **String** | Request status filter to fetch all the request based on a particular status [QUEUED, RUNNING, DONE, FAILED] | [optional] |
+| **filter_created_after** | **String** | Filter all the requests after the created date | [optional] |
+| **filter_created_before** | **String** | Filter all the requests before the created date | [optional] |
+| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
+| **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
+
+### Return type
+
+[**Requests**](Requests.md)
+
+### Authorization
+
+Basic Authentication, Token Authentication
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## requests_status_get
+
+> <RequestStatus> requests_status_get(request_id, opts)
+
+Retrieve Request Status
+
+Retrieves the status of a given request.
+
+### 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'
+
+  # Configure API key authorization: Token Authentication
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Ionoscloud::RequestApi.new
+request_id = 'request_id_example' # String | 
+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
+  # Retrieve Request Status
+  result = api_instance.requests_status_get(request_id, opts)
+  p result
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_status_get: #{e}"
+end
+```
+
+#### Using the requests_status_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RequestStatus>, Integer, Hash)> requests_status_get_with_http_info(request_id, opts)
+
+```ruby
+begin
+  # Retrieve Request Status
+  data, status_code, headers = api_instance.requests_status_get_with_http_info(request_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RequestStatus>
+rescue Ionoscloud::ApiError => e
+  puts "Error when calling RequestApi->requests_status_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  |  |
+| **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
+
+[**RequestStatus**](RequestStatus.md)
+
+### Authorization
+
+Basic Authentication, Token Authentication
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+