ionoscloud-dbaas-mongo 1.0.0

data/docs/api/LogsApi.md

@@ -0,0 +1,93 @@
+# LogsApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clusters_logs_get**](LogsApi.md#clusters_logs_get) | **GET** /clusters/{clusterId}/logs | Get logs of your cluster |
+
+
+## clusters_logs_get
+
+> <ClusterLogs> clusters_logs_get(cluster_id, opts)
+
+Get logs of your cluster
+
+Retrieves MongoDB logs based on the given parameters.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::LogsApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+opts = {
+  start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.
+  _end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.
+  direction: 'BACKWARD', # String | The direction in which to scan through the logs. The logs are returned in order of the direction.
+  limit: 56 # Integer | The maximal number of log lines to return.  If the limit is reached then log lines will be cut at the end (respecting the scan direction).
+}
+
+begin
+  # Get logs of your cluster
+  result = api_instance.clusters_logs_get(cluster_id, opts)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling LogsApi->clusters_logs_get: #{e}"
+end
+```
+
+#### Using the clusters_logs_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClusterLogs>, Integer, Hash)> clusters_logs_get_with_http_info(cluster_id, opts)
+
+```ruby
+begin
+  # Get logs of your cluster
+  data, status_code, headers = api_instance.clusters_logs_get_with_http_info(cluster_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClusterLogs>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling LogsApi->clusters_logs_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+| **start** | **Time** | The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago. | [optional] |
+| **_end** | **Time** | The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp. | [optional] |
+| **direction** | **String** | The direction in which to scan through the logs. The logs are returned in order of the direction. | [optional][default to &#39;BACKWARD&#39;] |
+| **limit** | **Integer** | The maximal number of log lines to return.  If the limit is reached then log lines will be cut at the end (respecting the scan direction). | [optional][default to 100] |
+
+### Return type
+
+[**ClusterLogs**](ClusterLogs.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/api/MetadataApi.md

@@ -0,0 +1,153 @@
+# MetadataApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**infos_version_get**](MetadataApi.md#infos_version_get) | **GET** /infos/version | Get API Version |
+| [**infos_versions_get**](MetadataApi.md#infos_versions_get) | **GET** /infos/versions | Get All API Versions |
+
+
+## infos_version_get
+
+> <APIVersion> infos_version_get
+
+Get API Version
+
+Retrieves the current version of the responding API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::MetadataApi.new
+
+begin
+  # Get API Version
+  result = api_instance.infos_version_get
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling MetadataApi->infos_version_get: #{e}"
+end
+```
+
+#### Using the infos_version_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<APIVersion>, Integer, Hash)> infos_version_get_with_http_info
+
+```ruby
+begin
+  # Get API Version
+  data, status_code, headers = api_instance.infos_version_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <APIVersion>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling MetadataApi->infos_version_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**APIVersion**](APIVersion.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## infos_versions_get
+
+> <Array<APIVersion>> infos_versions_get
+
+Get All API Versions
+
+Retrieves all available versions of the responding API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::MetadataApi.new
+
+begin
+  # Get All API Versions
+  result = api_instance.infos_versions_get
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling MetadataApi->infos_versions_get: #{e}"
+end
+```
+
+#### Using the infos_versions_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<APIVersion>>, Integer, Hash)> infos_versions_get_with_http_info
+
+```ruby
+begin
+  # Get All API Versions
+  data, status_code, headers = api_instance.infos_versions_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<APIVersion>>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling MetadataApi->infos_versions_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;APIVersion&gt;**](APIVersion.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/api/RestoresApi.md

@@ -0,0 +1,84 @@
+# RestoresApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clusters_restore_post**](RestoresApi.md#clusters_restore_post) | **POST** /clusters/{clusterId}/restore | In-place restore of a cluster |
+
+
+## clusters_restore_post
+
+> clusters_restore_post(cluster_id, create_restore_request)
+
+In-place restore of a cluster
+
+Triggers an in-place restore of the given MongoDB cluster.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::RestoresApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+create_restore_request = IonoscloudDbaasMongo::CreateRestoreRequest.new({snapshot_id: 'dcd31531-3ac8-11eb-9feb-046c59cc737e'}) # CreateRestoreRequest | The restore request to create.
+
+begin
+  # In-place restore of a cluster
+  api_instance.clusters_restore_post(cluster_id, create_restore_request)
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling RestoresApi->clusters_restore_post: #{e}"
+end
+```
+
+#### Using the clusters_restore_post_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> clusters_restore_post_with_http_info(cluster_id, create_restore_request)
+
+```ruby
+begin
+  # In-place restore of a cluster
+  data, status_code, headers = api_instance.clusters_restore_post_with_http_info(cluster_id, create_restore_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling RestoresApi->clusters_restore_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+| **create_restore_request** | [**CreateRestoreRequest**](CreateRestoreRequest.md) | The restore request to create. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/api/SnapshotsApi.md

@@ -0,0 +1,83 @@
+# SnapshotsApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clusters_snapshots_get**](SnapshotsApi.md#clusters_snapshots_get) | **GET** /clusters/{clusterId}/snapshots | Get the snapshots of your cluster |
+
+
+## clusters_snapshots_get
+
+> <SnapshotList> clusters_snapshots_get(cluster_id)
+
+Get the snapshots of your cluster
+
+Retrieves MongoDB snapshots.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::SnapshotsApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+
+begin
+  # Get the snapshots of your cluster
+  result = api_instance.clusters_snapshots_get(cluster_id)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling SnapshotsApi->clusters_snapshots_get: #{e}"
+end
+```
+
+#### Using the clusters_snapshots_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotList>, Integer, Hash)> clusters_snapshots_get_with_http_info(cluster_id)
+
+```ruby
+begin
+  # Get the snapshots of your cluster
+  data, status_code, headers = api_instance.clusters_snapshots_get_with_http_info(cluster_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotList>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling SnapshotsApi->clusters_snapshots_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+
+### Return type
+
+[**SnapshotList**](SnapshotList.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/api/TemplatesApi.md

@@ -0,0 +1,80 @@
+# TemplatesApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**templates_get**](TemplatesApi.md#templates_get) | **GET** /templates | Get Templates |
+
+
+## templates_get
+
+> <TemplateList> templates_get
+
+Get Templates
+
+Retrieves a list of valid templates. These templates can be used to create MongoDB clusters; they contain properties, such as number of cores, RAM, and the storage size. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-mongo'
+# setup authorization
+IonoscloudDbaasMongo.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: tokenAuth
+  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 = IonoscloudDbaasMongo::TemplatesApi.new
+
+begin
+  # Get Templates
+  result = api_instance.templates_get
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_get: #{e}"
+end
+```
+
+#### Using the templates_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplateList>, Integer, Hash)> templates_get_with_http_info
+
+```ruby
+begin
+  # Get Templates
+  data, status_code, headers = api_instance.templates_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateList>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TemplateList**](TemplateList.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+