pnap_bmc_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c5b2ad68bc62ada47f95823ea403da174846a41862b669d57ceb31005f052b3
+  data.tar.gz: 573723f8e01729414d1116d49ec40ffa8a0365cfb1282e40843551f8f8e1e4ca
+SHA512:
+  metadata.gz: 3c731149eec84270fdee84251dd0a14dcc20859514769828d1c72e23b8de40a15fc54a5ffabb44d3b497bf188a65b056d38a56aca79de37152926873adbbab02
+  data.tar.gz: e632cd3cf73c9ad514ddc09b9d34d5dd70f6f7ccd89f5d87121599462030c5309e27145aabb52d6543461e5f9e44986d7d511e9d7aa1e1d51b024a65d78f4aca

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,196 @@
+# pnap_bmc_api
+
+BmcApi - the Ruby gem for the Bare Metal Cloud API
+
+Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
+Deprovision servers, get or edit SSH key details, and a lot more. Manage your infrastructure more efficiently
+using just a few simple api calls.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1
+For more information, please visit [https://phoenixnap.com/](https://phoenixnap.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pnap_bmc_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_bmc_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_bmc_api-<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:
+
+    gem 'pnap_bmc_api', '~> <VERSION>'
+
+### Install from Git
+
+To install this Gem from this repository, you'll need to get Bundler by doing `gem install bundler`. Add the following line in your Gemfile:
+
+    gem 'pnap_bmc_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'BmcApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_bmc_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'BmcApi/*.gemspec', branch: 'develop'
+
+Then run `bundle install`.
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pnap_bmc_api'
+
+# Setup authorization
+BmcApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BmcApi::QuotasApi.new
+
+begin
+  #List quotas
+  result = api_instance.quotas_get
+  p result
+rescue BmcApi::ApiError => e
+  puts "Exception when calling QuotasApi->quotas_get: #{e}"
+end
+
+```
+
+Authorization can also be setup by using the [`oauth`](https://github.com/oauth-xx/oauth2) library:
+
+```ruby
+# Load the gem
+require 'pnap_bmc_api'
+require 'oauth2'
+
+# Setup variables for getting a token.
+client_id = 'YOUR_CLIENT_ID'
+client_secret = 'YOUR_CLIENT_SECRET'
+auth_url = 'https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token'
+
+
+# Setup authorization
+BmcApi.configure do |config|
+  # Retrieve the token using OAuth2.
+  client = OAuth2::Client.new(client_id, client_secret, token_url: auth_url)
+  token = client.client_credentials.get_token
+
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = token.token
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phoenixnap.com/bmc/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BmcApi::QuotasApi* | [**quotas_get**](docs/QuotasApi.md#quotas_get) | **GET** /quotas | List quotas
+*BmcApi::QuotasApi* | [**quotas_quota_id_actions_request_edit_post**](docs/QuotasApi.md#quotas_quota_id_actions_request_edit_post) | **POST** /quotas/{quotaId}/actions/request-edit | Request quota limit change.
+*BmcApi::QuotasApi* | [**quotas_quota_id_get**](docs/QuotasApi.md#quotas_quota_id_get) | **GET** /quotas/{quotaId} | Get a quota.
+*BmcApi::SSHKeysApi* | [**ssh_keys_get**](docs/SSHKeysApi.md#ssh_keys_get) | **GET** /ssh-keys | List SSH Keys.
+*BmcApi::SSHKeysApi* | [**ssh_keys_post**](docs/SSHKeysApi.md#ssh_keys_post) | **POST** /ssh-keys | Create SSH Key.
+*BmcApi::SSHKeysApi* | [**ssh_keys_ssh_key_id_delete**](docs/SSHKeysApi.md#ssh_keys_ssh_key_id_delete) | **DELETE** /ssh-keys/{sshKeyId} | Delete SSH Key.
+*BmcApi::SSHKeysApi* | [**ssh_keys_ssh_key_id_get**](docs/SSHKeysApi.md#ssh_keys_ssh_key_id_get) | **GET** /ssh-keys/{sshKeyId} | Get SSH Key.
+*BmcApi::SSHKeysApi* | [**ssh_keys_ssh_key_id_put**](docs/SSHKeysApi.md#ssh_keys_ssh_key_id_put) | **PUT** /ssh-keys/{sshKeyId} | Edit SSH Key.
+*BmcApi::ServersApi* | [**delete_private_network**](docs/ServersApi.md#delete_private_network) | **DELETE** /servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId} | Removes the server from private network.
+*BmcApi::ServersApi* | [**servers_get**](docs/ServersApi.md#servers_get) | **GET** /servers | List servers.
+*BmcApi::ServersApi* | [**servers_post**](docs/ServersApi.md#servers_post) | **POST** /servers | Create new server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_deprovision_post**](docs/ServersApi.md#servers_server_id_actions_deprovision_post) | **POST** /servers/{serverId}/actions/deprovision | Deprovision a server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_power_off_post**](docs/ServersApi.md#servers_server_id_actions_power_off_post) | **POST** /servers/{serverId}/actions/power-off | Power off server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_power_on_post**](docs/ServersApi.md#servers_server_id_actions_power_on_post) | **POST** /servers/{serverId}/actions/power-on | Power on server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_reboot_post**](docs/ServersApi.md#servers_server_id_actions_reboot_post) | **POST** /servers/{serverId}/actions/reboot | Reboot server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_reserve_post**](docs/ServersApi.md#servers_server_id_actions_reserve_post) | **POST** /servers/{serverId}/actions/reserve | Reserve server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_reset_post**](docs/ServersApi.md#servers_server_id_actions_reset_post) | **POST** /servers/{serverId}/actions/reset | Reset server.
+*BmcApi::ServersApi* | [**servers_server_id_actions_shutdown_post**](docs/ServersApi.md#servers_server_id_actions_shutdown_post) | **POST** /servers/{serverId}/actions/shutdown | Shutdown server.
+*BmcApi::ServersApi* | [**servers_server_id_delete**](docs/ServersApi.md#servers_server_id_delete) | **DELETE** /servers/{serverId} | Delete server.
+*BmcApi::ServersApi* | [**servers_server_id_get**](docs/ServersApi.md#servers_server_id_get) | **GET** /servers/{serverId} | Get server.
+*BmcApi::ServersApi* | [**servers_server_id_ip_blocks_ip_block_id_delete**](docs/ServersApi.md#servers_server_id_ip_blocks_ip_block_id_delete) | **DELETE** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks/{ipBlockId} | Unassign IP Block from Server.
+*BmcApi::ServersApi* | [**servers_server_id_ip_blocks_post**](docs/ServersApi.md#servers_server_id_ip_blocks_post) | **POST** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks | Assign IP Block to Server.
+*BmcApi::ServersApi* | [**servers_server_id_patch**](docs/ServersApi.md#servers_server_id_patch) | **PATCH** /servers/{serverId} | Patch a Server.
+*BmcApi::ServersApi* | [**servers_server_id_private_networks_post**](docs/ServersApi.md#servers_server_id_private_networks_post) | **POST** /servers/{serverId}/network-configuration/private-network-configuration/private-networks | Adds the server to a private network.
+*BmcApi::ServersApi* | [**servers_server_id_tags_put**](docs/ServersApi.md#servers_server_id_tags_put) | **PUT** /servers/{serverId}/tags | Set server tags.
+
+
+## Documentation for Models
+
+ - [BmcApi::ActionResult](docs/ActionResult.md)
+ - [BmcApi::DeleteResult](docs/DeleteResult.md)
+ - [BmcApi::DeleteSshKeyResult](docs/DeleteSshKeyResult.md)
+ - [BmcApi::Error](docs/Error.md)
+ - [BmcApi::IpBlocksConfiguration](docs/IpBlocksConfiguration.md)
+ - [BmcApi::NetworkConfiguration](docs/NetworkConfiguration.md)
+ - [BmcApi::OsConfiguration](docs/OsConfiguration.md)
+ - [BmcApi::OsConfigurationMap](docs/OsConfigurationMap.md)
+ - [BmcApi::OsConfigurationMapEsxi](docs/OsConfigurationMapEsxi.md)
+ - [BmcApi::OsConfigurationMapProxmox](docs/OsConfigurationMapProxmox.md)
+ - [BmcApi::OsConfigurationWindows](docs/OsConfigurationWindows.md)
+ - [BmcApi::PrivateNetworkConfiguration](docs/PrivateNetworkConfiguration.md)
+ - [BmcApi::Quota](docs/Quota.md)
+ - [BmcApi::QuotaEditLimitRequest](docs/QuotaEditLimitRequest.md)
+ - [BmcApi::QuotaEditLimitRequestDetails](docs/QuotaEditLimitRequestDetails.md)
+ - [BmcApi::QuotaEditLimitRequestDetailsAllOf](docs/QuotaEditLimitRequestDetailsAllOf.md)
+ - [BmcApi::RelinquishIpBlock](docs/RelinquishIpBlock.md)
+ - [BmcApi::ResetResult](docs/ResetResult.md)
+ - [BmcApi::Server](docs/Server.md)
+ - [BmcApi::ServerCreate](docs/ServerCreate.md)
+ - [BmcApi::ServerIpBlock](docs/ServerIpBlock.md)
+ - [BmcApi::ServerPatch](docs/ServerPatch.md)
+ - [BmcApi::ServerPrivateNetwork](docs/ServerPrivateNetwork.md)
+ - [BmcApi::ServerReserve](docs/ServerReserve.md)
+ - [BmcApi::ServerReset](docs/ServerReset.md)
+ - [BmcApi::SshKey](docs/SshKey.md)
+ - [BmcApi::SshKeyCreate](docs/SshKeyCreate.md)
+ - [BmcApi::SshKeyUpdate](docs/SshKeyUpdate.md)
+ - [BmcApi::TagAssignment](docs/TagAssignment.md)
+ - [BmcApi::TagAssignmentRequest](docs/TagAssignmentRequest.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - bmc: Grants full access to bmc-api.
+  - bmc.read: Grants read only access to bmc-api.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/docs/ActionResult.md

@@ -0,0 +1,18 @@
+# BmcApi::ActionResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | Message describing the action's result. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ActionResult.new(
+  result: Powering on server.
+)
+```
+

data/docs/DeleteResult.md

@@ -0,0 +1,20 @@
+# BmcApi::DeleteResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | Server has been deleted. |  |
+| **server_id** | **String** | The unique identifier of the server. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::DeleteResult.new(
+  result: Server has been deleted.,
+  server_id: x78sdkjds879sd7cx8
+)
+```
+

data/docs/DeleteSshKeyResult.md

@@ -0,0 +1,20 @@
+# BmcApi::DeleteSshKeyResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | Resource has been deleted. |  |
+| **ssh_key_id** | **String** | The unique identifier of the deleted resource. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::DeleteSshKeyResult.new(
+  result: Resource has been deleted.,
+  ssh_key_id: 5fa54d1e91867c03a0a7b4a4
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# BmcApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The description detailing the cause of the error code. | [readonly] |
+| **validation_errors** | **Array<String>** | Validation errors, if any. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/IpBlocksConfiguration.md

@@ -0,0 +1,20 @@
+# BmcApi::IpBlocksConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configuration_type** | **String** | Determines the approach for configuring IP blocks for the server being provisioned. If PURCHASE_NEW is selected, the smallest supported range, depending on the operating system, is allocated to the server. | [optional][default to 'PURCHASE_NEW'] |
+| **ip_blocks** | [**Array<ServerIpBlock>**](ServerIpBlock.md) | Used to specify the previously purchased IP blocks to assign to this server upon provisioning. Used alongside the USER_DEFINED configurationType. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::IpBlocksConfiguration.new(
+  configuration_type: null,
+  ip_blocks: null
+)
+```
+

data/docs/NetworkConfiguration.md

@@ -0,0 +1,20 @@
+# BmcApi::NetworkConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **private_network_configuration** | [**PrivateNetworkConfiguration**](PrivateNetworkConfiguration.md) |  | [optional] |
+| **ip_blocks_configuration** | [**IpBlocksConfiguration**](IpBlocksConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::NetworkConfiguration.new(
+  private_network_configuration: null,
+  ip_blocks_configuration: null
+)
+```
+

data/docs/OsConfiguration.md

@@ -0,0 +1,24 @@
+# BmcApi::OsConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **windows** | [**OsConfigurationWindows**](OsConfigurationWindows.md) |  | [optional] |
+| **root_password** | **String** | Password set for user root on an ESXi server which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfiguration.new(
+  windows: null,
+  root_password: MyP@ssw0rd_01,
+  management_ui_url: https://172.217.22.14,
+  management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"]
+)
+```
+

data/docs/OsConfigurationMap.md

@@ -0,0 +1,22 @@
+# BmcApi::OsConfigurationMap
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **windows** | [**OsConfigurationWindows**](OsConfigurationWindows.md) |  | [optional] |
+| **esxi** | [**OsConfigurationMapEsxi**](OsConfigurationMapEsxi.md) |  | [optional] |
+| **proxmox** | [**OsConfigurationMapProxmox**](OsConfigurationMapProxmox.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfigurationMap.new(
+  windows: null,
+  esxi: null,
+  proxmox: null
+)
+```
+

data/docs/OsConfigurationMapEsxi.md

@@ -0,0 +1,22 @@
+# BmcApi::OsConfigurationMapEsxi
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **root_password** | **String** | Password set for user root on an ESXi server which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfigurationMapEsxi.new(
+  root_password: MyP@ssw0rd_01,
+  management_ui_url: https://172.217.22.14,
+  management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"]
+)
+```
+

data/docs/OsConfigurationMapProxmox.md

@@ -0,0 +1,22 @@
+# BmcApi::OsConfigurationMapProxmox
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **root_password** | **String** | Password set for user root on a Proxmox server which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
+| **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfigurationMapProxmox.new(
+  root_password: MyP@ssw0rd_01,
+  management_ui_url: https://172.217.22.14:8006,
+  management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"]
+)
+```
+

data/docs/OsConfigurationWindows.md

@@ -0,0 +1,18 @@
+# BmcApi::OsConfigurationWindows
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rdp_allowed_ips** | **Array<String>** | List of IPs allowed for RDP access to Windows OS. Supported in single IP, CIDR and range format. When undefined, RDP is disabled. To allow RDP access from any IP use 0.0.0.0/0. This will only be returned in response to provisioning a server. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfigurationWindows.new(
+  rdp_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"]
+)
+```
+

data/docs/PrivateNetworkConfiguration.md

@@ -0,0 +1,22 @@
+# BmcApi::PrivateNetworkConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server. It'll be null and won't be displayed as part of response body if server is a member of both public and private networks. When used as part of request body, it has to match one of the IP addresses used in the existing assigned private networks for the relevant location. Also, this field can be submitted only when provisioning a server without being a member of any public network. | [optional] |
+| **configuration_type** | **String** | Determines the approach for configuring private network(s) for the server being provisioned. Currently this field should be set to `USE_OR_CREATE_DEFAULT` or `USER_DEFINED`. | [optional][default to 'USE_OR_CREATE_DEFAULT'] |
+| **private_networks** | [**Array<ServerPrivateNetwork>**](ServerPrivateNetwork.md) | The list of private networks this server is member of. When this field is part of request body, it'll be used to specify the private networks to assign to this server upon provisioning. Used alongside the `USER_DEFINED` configurationType. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::PrivateNetworkConfiguration.new(
+  gateway_address: 10.0.0.10,
+  configuration_type: USER_DEFINED,
+  private_networks: [{"id":"60f81608e2f4665962b214db","ips":["10.0.0.11 - 10.0.0.15"],"dhcp":false},{"id":"60f93142c5c1d6082d31382a","ips":["10.0.0.16","10.0.0.17"],"dhcp":false}]
+)
+```
+

data/docs/Quota.md

@@ -0,0 +1,32 @@
+# BmcApi::Quota
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the Quota. |  |
+| **name** | **String** | The name of the Quota. |  |
+| **description** | **String** | The Quota description. |  |
+| **status** | **String** | The status of the quota resource usage. |  |
+| **limit** | **Integer** | The limit set for the quota. |  |
+| **unit** | **String** | An enum field describing what the limit is measured in. |  |
+| **used** | **Integer** | The quota used expressed as a number. |  |
+| **quota_edit_limit_request_details** | [**Array<QuotaEditLimitRequestDetails>**](QuotaEditLimitRequestDetails.md) |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::Quota.new(
+  id: bmc.servers.max_count,
+  name: Servers,
+  description: Maximum number of BMC servers,
+  status: OVER_LIMIT,
+  limit: 2,
+  unit: null,
+  used: 2,
+  quota_edit_limit_request_details: null
+)
+```
+

data/docs/QuotaEditLimitRequest.md

@@ -0,0 +1,20 @@
+# BmcApi::QuotaEditLimitRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The new limit that is requested. |  |
+| **reason** | **String** | The reason for changing the limit. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::QuotaEditLimitRequest.new(
+  limit: 10,
+  reason: I need more servers for my cluster.
+)
+```
+

data/docs/QuotaEditLimitRequestDetails.md

@@ -0,0 +1,22 @@
+# BmcApi::QuotaEditLimitRequestDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The new limit that is requested. |  |
+| **reason** | **String** | The reason for changing the limit. |  |
+| **requested_on** | **Time** | The point in time the request was submitted. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::QuotaEditLimitRequestDetails.new(
+  limit: 10,
+  reason: I need more servers for my cluster.,
+  requested_on: 2021-09-01T10:10:10Z
+)
+```
+

data/docs/QuotaEditLimitRequestDetailsAllOf.md

@@ -0,0 +1,18 @@
+# BmcApi::QuotaEditLimitRequestDetailsAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requested_on** | **Time** | The point in time the request was submitted. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::QuotaEditLimitRequestDetailsAllOf.new(
+  requested_on: 2021-09-01T10:10:10Z
+)
+```
+