ionoscloud-dbaas-mongo 1.0.0

data/docs/api/UsersApi.md

@@ -0,0 +1,321 @@
+# UsersApi
+
+All URIs are relative to *https://api.ionos.com/databases/mongodb*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**clusters_users_delete**](UsersApi.md#clusters_users_delete) | **DELETE** /clusters/{clusterId}/users/{database}/{username} | Delete a MongoDB User by ID |
+| [**clusters_users_find_by_id**](UsersApi.md#clusters_users_find_by_id) | **GET** /clusters/{clusterId}/users/{database}/{username} | Get a MongoDB User by ID |
+| [**clusters_users_get**](UsersApi.md#clusters_users_get) | **GET** /clusters/{clusterId}/users | Get a Cluster Users |
+| [**clusters_users_post**](UsersApi.md#clusters_users_post) | **POST** /clusters/{clusterId}/users | Create MongoDB User |
+
+
+## clusters_users_delete
+
+> <User> clusters_users_delete(cluster_id, database, username)
+
+Delete a MongoDB User by ID
+
+Deletes a MongoDB user specified by its ID.
+
+### 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::UsersApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+database = 'database_example' # String | The authentication database.
+username = 'username_example' # String | The authentication username.
+
+begin
+  # Delete a MongoDB User by ID
+  result = api_instance.clusters_users_delete(cluster_id, database, username)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_delete: #{e}"
+end
+```
+
+#### Using the clusters_users_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> clusters_users_delete_with_http_info(cluster_id, database, username)
+
+```ruby
+begin
+  # Delete a MongoDB User by ID
+  data, status_code, headers = api_instance.clusters_users_delete_with_http_info(cluster_id, database, username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+| **database** | **String** | The authentication database. |  |
+| **username** | **String** | The authentication username. |  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_users_find_by_id
+
+> <User> clusters_users_find_by_id(cluster_id, database, username)
+
+Get a MongoDB User by ID
+
+Retrieves the MongoDB user identified by the username and database 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::UsersApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+database = 'database_example' # String | The authentication database.
+username = 'username_example' # String | The authentication username.
+
+begin
+  # Get a MongoDB User by ID
+  result = api_instance.clusters_users_find_by_id(cluster_id, database, username)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_find_by_id: #{e}"
+end
+```
+
+#### Using the clusters_users_find_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> clusters_users_find_by_id_with_http_info(cluster_id, database, username)
+
+```ruby
+begin
+  # Get a MongoDB User by ID
+  data, status_code, headers = api_instance.clusters_users_find_by_id_with_http_info(cluster_id, database, username)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_find_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+| **database** | **String** | The authentication database. |  |
+| **username** | **String** | The authentication username. |  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_users_get
+
+> <UsersList> clusters_users_get(cluster_id)
+
+Get a Cluster Users
+
+Retrieves a list of MongoDB users.
+
+### 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::UsersApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+
+begin
+  # Get a Cluster Users
+  result = api_instance.clusters_users_get(cluster_id)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_get: #{e}"
+end
+```
+
+#### Using the clusters_users_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsersList>, Integer, Hash)> clusters_users_get_with_http_info(cluster_id)
+
+```ruby
+begin
+  # Get a Cluster Users
+  data, status_code, headers = api_instance.clusters_users_get_with_http_info(cluster_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsersList>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+
+### Return type
+
+[**UsersList**](UsersList.md)
+
+### Authorization
+
+basicAuth, tokenAuth
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## clusters_users_post
+
+> <User> clusters_users_post(cluster_id, user)
+
+Create MongoDB User
+
+Creates a MongoDB user. 
+
+### 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::UsersApi.new
+cluster_id = 'cluster_id_example' # String | The unique ID of the cluster.
+user = IonoscloudDbaasMongo::User.new # User | The user to be created.
+
+begin
+  # Create MongoDB User
+  result = api_instance.clusters_users_post(cluster_id, user)
+  p result
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_post: #{e}"
+end
+```
+
+#### Using the clusters_users_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> clusters_users_post_with_http_info(cluster_id, user)
+
+```ruby
+begin
+  # Create MongoDB User
+  data, status_code, headers = api_instance.clusters_users_post_with_http_info(cluster_id, user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue IonoscloudDbaasMongo::ApiError => e
+  puts "Error when calling UsersApi->clusters_users_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_id** | **String** | The unique ID of the cluster. |  |
+| **user** | [**User**](User.md) | The user to be created. |  |
+
+### Return type
+
+[**User**](User.md)
+
+### 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-mongo'
+
+instance = IonoscloudDbaasMongo::APIVersion.new(
+  name: v2.1,
+  swagger_url: https://api.ionos.com/databases/mongodb/infos/assets/swagger-v2.1.yml
+)
+```
+

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-mongo'
+
+instance = IonoscloudDbaasMongo::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-mongo'
+
+instance = IonoscloudDbaasMongo::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-mongo'
+
+instance = IonoscloudDbaasMongo::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 MongoDB instance. | [optional] |
+| **messages** | [**Array<ClusterLogsMessages>**](ClusterLogsMessages.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::ClusterLogsInstances.new(
+  name: mongodb-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-mongo'
+
+instance = IonoscloudDbaasMongo::ClusterLogsMessages.new(
+  time: 2021-09-06T10:00:38.253+02:00,
+  message: Hello World
+)
+```
+

data/docs/models/ClusterProperties.md

@@ -0,0 +1,32 @@
+# ClusterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | The name of your cluster. | [optional] |
+| **mongo_db_version** | **String** | The MongoDB version of your cluster. | [optional] |
+| **location** | **String** | The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.  | [optional] |
+| **instances** | **Integer** | The total number of instances in the cluster (one primary and n-1 secondaries).  | [optional] |
+| **connections** | [**Array<Connection>**](Connection.md) |  | [optional] |
+| **maintenance_window** | [**MaintenanceWindow**](MaintenanceWindow.md) |  | [optional] |
+| **template_id** | **String** | The unique ID of the template, which specifies the number of cores, storage size, and memory.  | [optional] |
+| **connection_string** | **String** | The connection string for your cluster. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::ClusterProperties.new(
+  display_name: MongoDB cluster,
+  mongo_db_version: 5.0,
+  location: de/txl,
+  instances: 3,
+  connections: null,
+  maintenance_window: null,
+  template_id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  connection_string: mongo+srv://m-498ae72f-411f-11eb-9d07-046c59cc737e.mongodb.de-txl.ionos.com
+)
+```
+

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-mongo'
+
+instance = IonoscloudDbaasMongo::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 which your cluster will be connected. |  |
+| **lan_id** | **String** | The numeric LAN ID with which you connect your cluster. |  |
+| **cidr_list** | **Array<String>** | The list of IPs 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-mongo'
+
+instance = IonoscloudDbaasMongo::Connection.new(
+  datacenter_id: 5a029f4a-72e5-11ec-90d6-0242ac120003,
+  lan_id: 2,
+  cidr_list: ["192.168.1.100/24","192.168.1.101/24"]
+)
+```
+

data/docs/models/CreateClusterProperties.md

@@ -0,0 +1,30 @@
+# CreateClusterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The unique ID of the template, which specifies the number of cores, storage size, and memory.  |  |
+| **mongo_db_version** | **String** | The MongoDB version of your cluster. | [optional] |
+| **instances** | **Integer** | The total number of instances in the cluster (one primary and n-1 secondaries).  |  |
+| **connections** | [**Array<Connection>**](Connection.md) |  |  |
+| **location** | **String** | The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.  |  |
+| **display_name** | **String** | The name of your cluster. |  |
+| **maintenance_window** | [**MaintenanceWindow**](MaintenanceWindow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::CreateClusterProperties.new(
+  template_id: 498ae72f-411f-11eb-9d07-046c59cc737e,
+  mongo_db_version: 5.0,
+  instances: 3,
+  connections: null,
+  location: de/txl,
+  display_name: MongoDB cluster,
+  maintenance_window: 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-mongo'
+
+instance = IonoscloudDbaasMongo::CreateClusterRequest.new(
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/models/CreateRestoreRequest.md

@@ -0,0 +1,18 @@
+# CreateRestoreRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snapshot_id** | **String** | The unique ID of the snapshot you want to restore. |  |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::CreateRestoreRequest.new(
+  snapshot_id: dcd31531-3ac8-11eb-9feb-046c59cc737e
+)
+```
+

data/docs/models/DayOfTheWeek.md

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

data/docs/models/ErrorMessage.md

@@ -0,0 +1,20 @@
+# ErrorMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** | Application internal error code.  | [optional] |
+| **message** | **String** | A human readable explanation specific to this occurrence of the problem.  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::ErrorMessage.new(
+  error_code: dbaas-err-api-123,
+  message: Error message example
+)
+```
+

data/docs/models/ErrorResponse.md

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

data/docs/models/MaintenanceWindow.md

@@ -0,0 +1,20 @@
+# MaintenanceWindow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **String** |  |  |
+| **day_of_the_week** | [**DayOfTheWeek**](DayOfTheWeek.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud-dbaas-mongo'
+
+instance = IonoscloudDbaasMongo::MaintenanceWindow.new(
+  time: 16:30:59,
+  day_of_the_week: null
+)
+```
+