pnap_ip_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0621b6cfe51d0216c6b878169fe8fdaa6f605e275f1beeba3d8e0f162b24a4ab
+  data.tar.gz: 885941b7eab57da49c3f17e4f9589c8d163af90f0a4efa05ba4de87e708232d7
+SHA512:
+  metadata.gz: 10b942c79b848d3a116b6a0d4eb7bcbbc41788299f058bb1e53714e3027408578c4583f1be2bdaa29441bcab809cb69454fa8cbd0b8e4eeee9275f236f3f5e87
+  data.tar.gz: 47e5baafabd8a2de3b4affeb1ef10ab2ec080ec1aeb1d87cf32883000167ecee35a480d71db3f20161a9c95d065ecf72b8b862743c5630e27549ab376daf11ad

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,150 @@
+# pnap_ip_api
+
+IpApi - the Ruby gem for the IP Addresses API
+
+Public IP blocks are a set of contiguous IPs that allow you to access your servers or networks from the internet.
+Use the IP Addresses API to request and delete IP blocks.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/public-ip-management#bmc-public-ip-allocations-api' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/ips/v1/)</b>
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+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_ip_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_ip_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_ip_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_ip_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_ip_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'IpApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_ip_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'IpApi/*.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_ip_api'
+
+# Setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+
+begin
+  #List IP Blocks.
+  result = api_instance.ip_blocks_get
+  p result
+rescue IpApi::ApiError => e
+  puts "Exception when calling IPBlocksApi->ip_blocks_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_ip_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
+IpApi.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/ips/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*IpApi::IPBlocksApi* | [**ip_blocks_get**](docs/IPBlocksApi.md#ip_blocks_get) | **GET** /ip-blocks | List IP Blocks.
+*IpApi::IPBlocksApi* | [**ip_blocks_ip_block_id_delete**](docs/IPBlocksApi.md#ip_blocks_ip_block_id_delete) | **DELETE** /ip-blocks/{ipBlockId} | Delete IP Block.
+*IpApi::IPBlocksApi* | [**ip_blocks_ip_block_id_get**](docs/IPBlocksApi.md#ip_blocks_ip_block_id_get) | **GET** /ip-blocks/{ipBlockId} | Get IP Block.
+*IpApi::IPBlocksApi* | [**ip_blocks_ip_block_id_patch**](docs/IPBlocksApi.md#ip_blocks_ip_block_id_patch) | **PATCH** /ip-blocks/{ipBlockId} | Update IP block.
+*IpApi::IPBlocksApi* | [**ip_blocks_post**](docs/IPBlocksApi.md#ip_blocks_post) | **POST** /ip-blocks | Create an IP Block.
+
+
+## Documentation for Models
+
+ - [IpApi::DeleteIpBlockResult](docs/DeleteIpBlockResult.md)
+ - [IpApi::Error](docs/Error.md)
+ - [IpApi::IpBlock](docs/IpBlock.md)
+ - [IpApi::IpBlockCreate](docs/IpBlockCreate.md)
+ - [IpApi::IpBlockPatch](docs/IpBlockPatch.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/DeleteIpBlockResult.md

@@ -0,0 +1,20 @@
+# IpApi::DeleteIpBlockResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result** | **String** | IP Block has been deleted. |  |
+| **ip_block_id** | **String** | The unique identifier of the IP Block. |  |
+
+## Example
+
+```ruby
+require 'pnap_ip_api'
+
+instance = IpApi::DeleteIpBlockResult.new(
+  result: IP Block has been deleted.,
+  ip_block_id: 6047127fed34ecc3ba8402d2
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,20 @@
+# IpApi::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_ip_api'
+
+instance = IpApi::Error.new(
+  message: null,
+  validation_errors: null
+)
+```
+

data/docs/IPBlocksApi.md

@@ -0,0 +1,360 @@
+# IpApi::IPBlocksApi
+
+All URIs are relative to *https://api.phoenixnap.com/ips/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**ip_blocks_get**](IPBlocksApi.md#ip_blocks_get) | **GET** /ip-blocks | List IP Blocks. |
+| [**ip_blocks_ip_block_id_delete**](IPBlocksApi.md#ip_blocks_ip_block_id_delete) | **DELETE** /ip-blocks/{ipBlockId} | Delete IP Block. |
+| [**ip_blocks_ip_block_id_get**](IPBlocksApi.md#ip_blocks_ip_block_id_get) | **GET** /ip-blocks/{ipBlockId} | Get IP Block. |
+| [**ip_blocks_ip_block_id_patch**](IPBlocksApi.md#ip_blocks_ip_block_id_patch) | **PATCH** /ip-blocks/{ipBlockId} | Update IP block. |
+| [**ip_blocks_post**](IPBlocksApi.md#ip_blocks_post) | **POST** /ip-blocks | Create an IP Block. |
+
+
+## ip_blocks_get
+
+> <Array<IpBlock>> ip_blocks_get
+
+List IP Blocks.
+
+List all IP Blocks.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_ip_api'
+# setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+
+begin
+  # List IP Blocks.
+  result = api_instance.ip_blocks_get
+  p result
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_get: #{e}"
+end
+```
+
+#### Using the ip_blocks_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IpBlock>>, Integer, Hash)> ip_blocks_get_with_http_info
+
+```ruby
+begin
+  # List IP Blocks.
+  data, status_code, headers = api_instance.ip_blocks_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IpBlock>>
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;IpBlock&gt;**](IpBlock.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## ip_blocks_ip_block_id_delete
+
+> <DeleteIpBlockResult> ip_blocks_ip_block_id_delete(ip_block_id)
+
+Delete IP Block.
+
+Delete an IP Block. An IP Block can only be deleted if not assigned to any resource.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_ip_api'
+# setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
+
+begin
+  # Delete IP Block.
+  result = api_instance.ip_blocks_ip_block_id_delete(ip_block_id)
+  p result
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_delete: #{e}"
+end
+```
+
+#### Using the ip_blocks_ip_block_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteIpBlockResult>, Integer, Hash)> ip_blocks_ip_block_id_delete_with_http_info(ip_block_id)
+
+```ruby
+begin
+  # Delete IP Block.
+  data, status_code, headers = api_instance.ip_blocks_ip_block_id_delete_with_http_info(ip_block_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteIpBlockResult>
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_block_id** | **String** | The IP Block identifier. |  |
+
+### Return type
+
+[**DeleteIpBlockResult**](DeleteIpBlockResult.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## ip_blocks_ip_block_id_get
+
+> <IpBlock> ip_blocks_ip_block_id_get(ip_block_id)
+
+Get IP Block.
+
+Get IP Block.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_ip_api'
+# setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
+
+begin
+  # Get IP Block.
+  result = api_instance.ip_blocks_ip_block_id_get(ip_block_id)
+  p result
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_get: #{e}"
+end
+```
+
+#### Using the ip_blocks_ip_block_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpBlock>, Integer, Hash)> ip_blocks_ip_block_id_get_with_http_info(ip_block_id)
+
+```ruby
+begin
+  # Get IP Block.
+  data, status_code, headers = api_instance.ip_blocks_ip_block_id_get_with_http_info(ip_block_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpBlock>
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_block_id** | **String** | The IP Block identifier. |  |
+
+### Return type
+
+[**IpBlock**](IpBlock.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## ip_blocks_ip_block_id_patch
+
+> <IpBlock> ip_blocks_ip_block_id_patch(ip_block_id, opts)
+
+Update IP block.
+
+Update IP Block's details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_ip_api'
+# setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
+opts = {
+  ip_block_patch: IpApi::IpBlockPatch.new # IpBlockPatch | 
+}
+
+begin
+  # Update IP block.
+  result = api_instance.ip_blocks_ip_block_id_patch(ip_block_id, opts)
+  p result
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_patch: #{e}"
+end
+```
+
+#### Using the ip_blocks_ip_block_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpBlock>, Integer, Hash)> ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, opts)
+
+```ruby
+begin
+  # Update IP block.
+  data, status_code, headers = api_instance.ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpBlock>
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_ip_block_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_block_id** | **String** | The IP Block identifier. |  |
+| **ip_block_patch** | [**IpBlockPatch**](IpBlockPatch.md) |  | [optional] |
+
+### Return type
+
+[**IpBlock**](IpBlock.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## ip_blocks_post
+
+> <IpBlock> ip_blocks_post(opts)
+
+Create an IP Block.
+
+Request an IP Block. An IP Block is a set of contiguous IPs that can be assigned to other resources such as servers.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_ip_api'
+# setup authorization
+IpApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = IpApi::IPBlocksApi.new
+opts = {
+  ip_block_create: IpApi::IpBlockCreate.new({location: 'PHX', cidr_block_size: '/30'}) # IpBlockCreate | 
+}
+
+begin
+  # Create an IP Block.
+  result = api_instance.ip_blocks_post(opts)
+  p result
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_post: #{e}"
+end
+```
+
+#### Using the ip_blocks_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IpBlock>, Integer, Hash)> ip_blocks_post_with_http_info(opts)
+
+```ruby
+begin
+  # Create an IP Block.
+  data, status_code, headers = api_instance.ip_blocks_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IpBlock>
+rescue IpApi::ApiError => e
+  puts "Error when calling IPBlocksApi->ip_blocks_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_block_create** | [**IpBlockCreate**](IpBlockCreate.md) |  | [optional] |
+
+### Return type
+
+[**IpBlock**](IpBlock.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/IpBlock.md

@@ -0,0 +1,32 @@
+# IpApi::IpBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | IP Block identifier. |  |
+| **location** | **String** | IP Block location ID. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
+| **cidr_block_size** | **String** | CIDR IP Block Size. Currently this field should be set to either `/31`, `/30`, `/29`, `/28`, `/27`, `/26`, `/25`, `/24`, `/23` or `/22`. |  |
+| **cidr** | **String** | The IP Block in CIDR notation. |  |
+| **status** | **String** | The status of the IP Block. |  |
+| **assigned_resource_id** | **String** | ID of the resource assigned to the IP Block. | [optional] |
+| **assigned_resource_type** | **String** | Type of the resource assigned to the IP Block. | [optional] |
+| **description** | **String** | The description of the IP Block. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_ip_api'
+
+instance = IpApi::IpBlock.new(
+  id: 6047127fed34ecc3ba8402d2,
+  location: PHX,
+  cidr_block_size: /30,
+  cidr: 1.1.1.0/31,
+  status: unassigned,
+  assigned_resource_id: 6047127fed34ecc3ba8402d2,
+  assigned_resource_type: server,
+  description: IP Block #1 used for publicly accessing server #1.
+)
+```
+

data/docs/IpBlockCreate.md

@@ -0,0 +1,22 @@
+# IpApi::IpBlockCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | **String** | IP Block location ID. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
+| **cidr_block_size** | **String** | CIDR IP Block Size. Currently this field should be set to either `/31`, `/30`, `/29` or `/28`. For a larger Block Size contact support. |  |
+| **description** | **String** | The description of the IP Block. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_ip_api'
+
+instance = IpApi::IpBlockCreate.new(
+  location: PHX,
+  cidr_block_size: /30,
+  description: IP Block #1 used for publicly accessing server #1.
+)
+```
+

data/docs/IpBlockPatch.md

@@ -0,0 +1,18 @@
+# IpApi::IpBlockPatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The description of the Ip Block. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_ip_api'
+
+instance = IpApi::IpBlockPatch.new(
+  description: Ip Block allocation.
+)
+```
+