ionoscloud-dbaas-postgres 1.0.0

data/docs/api/MetadataApi.md

@@ -0,0 +1,153 @@
+# MetadataApi
+
+All URIs are relative to *https://api.ionos.com/databases/postgresql*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**infos_version_get**](MetadataApi.md#infos_version_get) | **GET** /infos/version | Get the current API version |
+| [**infos_versions_get**](MetadataApi.md#infos_versions_get) | **GET** /infos/versions | Fetch all API versions |
+
+
+## infos_version_get
+
+> <APIVersion> infos_version_get
+
+Get the current API version
+
+Retrieves the current version of the responding API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-postgres'
+# setup authorization
+IonoscloudDbaasPostgres.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 = IonoscloudDbaasPostgres::MetadataApi.new
+
+begin
+  # Get the current API version
+  result = api_instance.infos_version_get
+  p result
+rescue IonoscloudDbaasPostgres::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 the current API version
+  data, status_code, headers = api_instance.infos_version_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <APIVersion>
+rescue IonoscloudDbaasPostgres::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
+
+Fetch all API versions
+
+Retrieves all available versions of the responding API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-postgres'
+# setup authorization
+IonoscloudDbaasPostgres.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 = IonoscloudDbaasPostgres::MetadataApi.new
+
+begin
+  # Fetch all API versions
+  result = api_instance.infos_versions_get
+  p result
+rescue IonoscloudDbaasPostgres::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
+  # Fetch 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 IonoscloudDbaasPostgres::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/postgresql*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cluster_restore_post**](RestoresApi.md#cluster_restore_post) | **POST** /clusters/{clusterId}/restore | In-place restore of a cluster |
+
+
+## cluster_restore_post
+
+> cluster_restore_post(cluster_id, create_restore_request)
+
+In-place restore of a cluster
+
+Triggers an in-place restore of the given PostgreSQL.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ionoscloud-dbaas-postgres'
+# setup authorization
+IonoscloudDbaasPostgres.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 = IonoscloudDbaasPostgres::RestoresApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+create_restore_request = IonoscloudDbaasPostgres::CreateRestoreRequest.new({backup_id: 'dcd31531-3ac8-11eb-9feb-046c59cc737e'}) # CreateRestoreRequest | The restore request to create.
+
+begin
+  # In-place restore of a cluster
+  api_instance.cluster_restore_post(cluster_id, create_restore_request)
+rescue IonoscloudDbaasPostgres::ApiError => e
+  puts "Error when calling RestoresApi->cluster_restore_post: #{e}"
+end
+```
+
+#### Using the cluster_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)> cluster_restore_post_with_http_info(cluster_id, create_restore_request)
+
+```ruby
+begin
+  # In-place restore of a cluster
+  data, status_code, headers = api_instance.cluster_restore_post_with_http_info(cluster_id, create_restore_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue IonoscloudDbaasPostgres::ApiError => e
+  puts "Error when calling RestoresApi->cluster_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/models/APIVersion.md

@@ -0,0 +1,20 @@
+# APIVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **swagger_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::APIVersion.new(
+  name: v2.1,
+  swagger_url: https://api.ionos.com/databases/postgres/infos/assets/swagger-v2.1.yml
+)
+```
+

data/docs/models/BackupLocation.md

@@ -0,0 +1,15 @@
+# BackupLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::BackupLocation.new()
+```
+

data/docs/models/BackupMetadata.md

@@ -0,0 +1,20 @@
+# BackupMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_date** | **Time** | The ISO 8601 creation timestamp. | [optional] |
+| **state** | [**State**](State.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::BackupMetadata.new(
+  created_date: 2020-12-10T13:37:50+01:00,
+  state: null
+)
+```
+

data/docs/models/BackupResponse.md

@@ -0,0 +1,24 @@
+# BackupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **metadata** | [**BackupMetadata**](BackupMetadata.md) |  | [optional] |
+| **properties** | [**ClusterBackup**](ClusterBackup.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::BackupResponse.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/models/ClusterBackup.md

@@ -0,0 +1,26 @@
+# ClusterBackup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **cluster_id** | **String** | The unique ID of the cluster. | [optional] |
+| **version** | **String** | The PostgreSQL version this backup was created from. | [optional] |
+| **is_active** | **Boolean** | Whether a cluster currently backs up data to this backup. | [optional] |
+| **earliest_recovery_target_time** | **Time** | The oldest available timestamp to which you can restore. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterBackup.new(
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  cluster_id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  version: 12,
+  is_active: true,
+  earliest_recovery_target_time: 2021-10-23T01:21:10Z
+)
+```
+

data/docs/models/ClusterBackupList.md

@@ -0,0 +1,28 @@
+# ClusterBackupList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **items** | [**Array<BackupResponse>**](BackupResponse.md) |  | [optional] |
+| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0) (not implemented yet).  | [optional][readonly] |
+| **limit** | **Integer** | The limit specified in the request (if none was specified, use the endpoint's default pagination limit) (not implemented yet, always return number of items).  | [optional][readonly] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterBackupList.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  items: null,
+  offset: 0,
+  limit: 42,
+  _links: null
+)
+```
+

data/docs/models/ClusterBackupListAllOf.md

@@ -0,0 +1,22 @@
+# ClusterBackupListAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **items** | [**Array<BackupResponse>**](BackupResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterBackupListAllOf.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  items: null
+)
+```
+

data/docs/models/ClusterList.md

@@ -0,0 +1,28 @@
+# ClusterList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **items** | [**Array<ClusterResponse>**](ClusterResponse.md) |  | [optional] |
+| **offset** | **Integer** | The offset specified in the request (if none was specified, the default offset is 0) (not implemented yet).  | [optional][readonly] |
+| **limit** | **Integer** | The limit specified in the request (if none was specified, use the endpoint's default pagination limit) (not implemented yet, always return number of items).  | [optional][readonly] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterList.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  items: null,
+  offset: 0,
+  limit: 42,
+  _links: null
+)
+```
+

data/docs/models/ClusterListAllOf.md

@@ -0,0 +1,22 @@
+# ClusterListAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **items** | [**Array<ClusterResponse>**](ClusterResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterListAllOf.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  items: null
+)
+```
+

data/docs/models/ClusterLogs.md

@@ -0,0 +1,18 @@
+# ClusterLogs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **instances** | [**Array<ClusterLogsInstances>**](ClusterLogsInstances.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterLogs.new(
+  instances: null
+)
+```
+

data/docs/models/ClusterLogsInstances.md

@@ -0,0 +1,20 @@
+# ClusterLogsInstances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the PostgreSQL instance. | [optional] |
+| **messages** | [**Array<ClusterLogsMessages>**](ClusterLogsMessages.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterLogsInstances.new(
+  name: postgres-cluster-0,
+  messages: null
+)
+```
+

data/docs/models/ClusterLogsMessages.md

@@ -0,0 +1,20 @@
+# ClusterLogsMessages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterLogsMessages.new(
+  time: 2021-09-06T10:00:38.253+02:00,
+  message: Hello World
+)
+```
+

data/docs/models/ClusterProperties.md

@@ -0,0 +1,40 @@
+# ClusterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | The friendly name of your cluster. | [optional] |
+| **postgres_version** | **String** | The PostgreSQL version of your cluster. | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **backup_location** | [**BackupLocation**](BackupLocation.md) |  | [optional] |
+| **instances** | **Integer** | The total number of instances in the cluster (one master and n-1 standbys).  | [optional] |
+| **ram** | **Integer** | The amount of memory per instance in megabytes. Has to be a multiple of 1024. | [optional] |
+| **cores** | **Integer** | The number of CPU cores per instance. | [optional] |
+| **storage_size** | **Integer** | The amount of storage per instance in megabytes. | [optional] |
+| **storage_type** | [**StorageType**](StorageType.md) |  | [optional] |
+| **connections** | [**Array<Connection>**](Connection.md) |  | [optional] |
+| **maintenance_window** | [**MaintenanceWindow**](MaintenanceWindow.md) |  | [optional] |
+| **synchronization_mode** | [**SynchronizationMode**](SynchronizationMode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterProperties.new(
+  display_name: PostgreSQL cluster,
+  postgres_version: 13,
+  location: null,
+  backup_location: null,
+  instances: 2,
+  ram: 2048,
+  cores: 4,
+  storage_size: 5000,
+  storage_type: null,
+  connections: null,
+  maintenance_window: null,
+  synchronization_mode: null
+)
+```
+

data/docs/models/ClusterResponse.md

@@ -0,0 +1,24 @@
+# ClusterResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ResourceType**](ResourceType.md) |  | [optional] |
+| **id** | **String** | The unique ID of the resource. | [optional] |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **properties** | [**ClusterProperties**](ClusterProperties.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::ClusterResponse.new(
+  type: null,
+  id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/models/Connection.md

@@ -0,0 +1,22 @@
+# Connection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_id** | **String** | The datacenter to connect your cluster to. |  |
+| **lan_id** | **String** | The numeric LAN ID to connect your cluster to. |  |
+| **cidr** | **String** | The IP and subnet for your cluster. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::Connection.new(
+  datacenter_id: null,
+  lan_id: 2,
+  cidr: 192.168.1.100/24
+)
+```
+

data/docs/models/CreateClusterProperties.md

@@ -0,0 +1,42 @@
+# CreateClusterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **postgres_version** | **String** | The PostgreSQL version of your cluster. |  |
+| **instances** | **Integer** | The total number of instances in the cluster (one master and n-1 standbys).  |  |
+| **cores** | **Integer** | The number of CPU cores per instance. |  |
+| **ram** | **Integer** | The amount of memory per instance in megabytes. Has to be a multiple of 1024. |  |
+| **storage_size** | **Integer** | The amount of storage per instance in megabytes. |  |
+| **storage_type** | [**StorageType**](StorageType.md) |  |  |
+| **connections** | [**Array<Connection>**](Connection.md) |  |  |
+| **location** | [**Location**](Location.md) |  |  |
+| **display_name** | **String** | The friendly name of your cluster. |  |
+| **maintenance_window** | [**MaintenanceWindow**](MaintenanceWindow.md) |  | [optional] |
+| **credentials** | [**DBUser**](DBUser.md) |  |  |
+| **synchronization_mode** | [**SynchronizationMode**](SynchronizationMode.md) |  |  |
+| **from_backup** | [**CreateRestoreRequest**](CreateRestoreRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::CreateClusterProperties.new(
+  postgres_version: 13,
+  instances: 2,
+  cores: 4,
+  ram: 2048,
+  storage_size: 5000,
+  storage_type: null,
+  connections: null,
+  location: null,
+  display_name: PostgreSQL cluster,
+  maintenance_window: null,
+  credentials: null,
+  synchronization_mode: null,
+  from_backup: null
+)
+```
+

data/docs/models/CreateClusterRequest.md

@@ -0,0 +1,20 @@
+# CreateClusterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Metadata**](Metadata.md) |  | [optional] |
+| **properties** | [**CreateClusterProperties**](CreateClusterProperties.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::CreateClusterRequest.new(
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/models/CreateRestoreRequest.md

@@ -0,0 +1,20 @@
+# CreateRestoreRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **backup_id** | **String** | The unique ID of the backup you want to restore. |  |
+| **recovery_target_time** | **Time** | If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-postgres'
+
+instance = IonoscloudDbaasPostgres::CreateRestoreRequest.new(
+  backup_id: dcd31531-3ac8-11eb-9feb-046c59cc737e,
+  recovery_target_time: 2020-12-10T13:37:50+01:00
+)
+```
+