pnap_network_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c32455cd457e2d564fd3df4eaf12df1d5ec05dfcd27c8529a83561fc43f1f7ea
+  data.tar.gz: e85981c47c3c0956c62e21ba9635f37e53963601464dd8a698dc4f21915986d3
+SHA512:
+  metadata.gz: 199f1064336c7b4a9da8659797e6abdc12c97851159bf0cb5d0d951558526c8daba21180cdd35dcb812580ef081eff3c68b533289133ae47c76ea2a2c097767f
+  data.tar.gz: f8597618363bbd2743f032ee80bd1a55afbfc118418004a5e083e14c328d1d5f8e73b1af92962c4e215e8ea27eeb15089cc36041b2b2ce7142c80f0564791c1e

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,154 @@
+# pnap_network_api
+
+NetworkApi - the Ruby gem for the Networks API
+
+Use the Networks API to create, list, edit, and delete private networks to best fit your business needs.
+Private networks allow your servers to communicate without connecting to the public internet, avoiding unnecessary
+egress data charges.<br>
+<br>
+<span class='pnap-api-knowledge-base-link'>
+Knowledge base articles to help you can be found
+<a href='https://phoenixnap.com/kb/bmc-server-management-via-api#multi-private-backend-network-api' target='_blank'>here</a>
+</span><br>
+<br>
+<b>All URLs are relative to (https://api.phoenixnap.com/networks/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_network_api.gemspec
+```
+
+Then either install the gem locally, replacing `<VERSION>` with the actual version:
+
+```shell
+gem install ./pnap_network_api-<VERSION>.gem
+```
+
+(for development, run `gem install --dev ./pnap_network_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_network_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_network_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'NetworkApi/*.gemspec'
+
+If you'd like the development version:
+
+    gem 'pnap_network_api', git: 'https://github.com/phoenixnap/ruby-sdk-bmc-poc', glob: 'NetworkApi/*.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_network_api'
+
+# Setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+opts = {
+  location: 'PHX' # String | If present will filter the result by the given location of the Private Networks.
+}
+
+begin
+  #List Private Networks.
+  result = api_instance.private_networks_get(opts)
+  p result
+rescue NetworkApi::ApiError => e
+  puts "Exception when calling PrivateNetworksApi->private_networks_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_network_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
+NetworkApi.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/networks/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*NetworkApi::PrivateNetworksApi* | [**private_networks_get**](docs/PrivateNetworksApi.md#private_networks_get) | **GET** /private-networks | List Private Networks.
+*NetworkApi::PrivateNetworksApi* | [**private_networks_network_id_delete**](docs/PrivateNetworksApi.md#private_networks_network_id_delete) | **DELETE** /private-networks/{privateNetworkId} | Delete a Private Network.
+*NetworkApi::PrivateNetworksApi* | [**private_networks_network_id_get**](docs/PrivateNetworksApi.md#private_networks_network_id_get) | **GET** /private-networks/{privateNetworkId} | Get a Private Network.
+*NetworkApi::PrivateNetworksApi* | [**private_networks_network_id_put**](docs/PrivateNetworksApi.md#private_networks_network_id_put) | **PUT** /private-networks/{privateNetworkId} | Update a Private Network.
+*NetworkApi::PrivateNetworksApi* | [**private_networks_post**](docs/PrivateNetworksApi.md#private_networks_post) | **POST** /private-networks | Create a Private Network.
+
+
+## Documentation for Models
+
+ - [NetworkApi::Error](docs/Error.md)
+ - [NetworkApi::PrivateNetwork](docs/PrivateNetwork.md)
+ - [NetworkApi::PrivateNetworkCreate](docs/PrivateNetworkCreate.md)
+ - [NetworkApi::PrivateNetworkModify](docs/PrivateNetworkModify.md)
+ - [NetworkApi::PrivateNetworkServer](docs/PrivateNetworkServer.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/Error.md

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

data/docs/PrivateNetwork.md

@@ -0,0 +1,34 @@
+# NetworkApi::PrivateNetwork
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The private network identifier. |  |
+| **name** | **String** | The friendly name of this private network. |  |
+| **description** | **String** | The description of this private network. | [optional] |
+| **vlan_id** | **Integer** | The VLAN of this private network. |  |
+| **type** | **String** | The type of the private network. |  |
+| **location** | **String** | The location of this private network. |  |
+| **location_default** | **Boolean** | Identifies network as the default private network for the specified location. |  |
+| **cidr** | **String** | IP range associated with this private network in CIDR notation. |  |
+| **servers** | [**Array<PrivateNetworkServer>**](PrivateNetworkServer.md) |  |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PrivateNetwork.new(
+  id: 604721852cf65253d151528b,
+  name: Sample Network,
+  description: Further details on the network,
+  vlan_id: 10,
+  type: PRIVATE,
+  location: PHX,
+  location_default: true,
+  cidr: 10.0.0.0/24,
+  servers: null
+)
+```
+

data/docs/PrivateNetworkCreate.md

@@ -0,0 +1,26 @@
+# NetworkApi::PrivateNetworkCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The friendly name of this private network. This name should be unique. |  |
+| **description** | **String** | The description of this private network. | [optional] |
+| **location** | **String** | The location of this private network. Supported values are `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` and `AUS`. |  |
+| **location_default** | **Boolean** | Identifies network as the default private network for the specified location. | [optional][default to false] |
+| **cidr** | **String** | IP range associated with this private network in CIDR notation. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PrivateNetworkCreate.new(
+  name: Sample Network,
+  description: Further details on the network,
+  location: PHX,
+  location_default: true,
+  cidr: 10.0.0.0/24
+)
+```
+

data/docs/PrivateNetworkModify.md

@@ -0,0 +1,22 @@
+# NetworkApi::PrivateNetworkModify
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A friendly name given to the private network. This name should be unique. |  |
+| **description** | **String** | A description of this private network | [optional] |
+| **location_default** | **Boolean** | Identifies network as the default private network for the specified location. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PrivateNetworkModify.new(
+  name: Sample network,
+  description: Further details on the network.,
+  location_default: true
+)
+```
+

data/docs/PrivateNetworkServer.md

@@ -0,0 +1,20 @@
+# NetworkApi::PrivateNetworkServer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The server identifier. |  |
+| **ips** | **Array<String>** | List of private IPs associated to the server. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PrivateNetworkServer.new(
+  id: 603f3e995c18d515cda9c4f8,
+  ips: ["10.0.0.2","10.0.0.3"]
+)
+```
+

data/docs/PrivateNetworksApi.md

@@ -0,0 +1,364 @@
+# NetworkApi::PrivateNetworksApi
+
+All URIs are relative to *https://api.phoenixnap.com/networks/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**private_networks_get**](PrivateNetworksApi.md#private_networks_get) | **GET** /private-networks | List Private Networks. |
+| [**private_networks_network_id_delete**](PrivateNetworksApi.md#private_networks_network_id_delete) | **DELETE** /private-networks/{privateNetworkId} | Delete a Private Network. |
+| [**private_networks_network_id_get**](PrivateNetworksApi.md#private_networks_network_id_get) | **GET** /private-networks/{privateNetworkId} | Get a Private Network. |
+| [**private_networks_network_id_put**](PrivateNetworksApi.md#private_networks_network_id_put) | **PUT** /private-networks/{privateNetworkId} | Update a Private Network. |
+| [**private_networks_post**](PrivateNetworksApi.md#private_networks_post) | **POST** /private-networks | Create a Private Network. |
+
+
+## private_networks_get
+
+> <Array<PrivateNetwork>> private_networks_get(opts)
+
+List Private Networks.
+
+List all Private Networks owned by account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_api'
+# setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+opts = {
+  location: 'PHX' # String | If present will filter the result by the given location of the Private Networks.
+}
+
+begin
+  # List Private Networks.
+  result = api_instance.private_networks_get(opts)
+  p result
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_get: #{e}"
+end
+```
+
+#### Using the private_networks_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<PrivateNetwork>>, Integer, Hash)> private_networks_get_with_http_info(opts)
+
+```ruby
+begin
+  # List Private Networks.
+  data, status_code, headers = api_instance.private_networks_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<PrivateNetwork>>
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | **String** | If present will filter the result by the given location of the Private Networks. | [optional] |
+
+### Return type
+
+[**Array&lt;PrivateNetwork&gt;**](PrivateNetwork.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## private_networks_network_id_delete
+
+> private_networks_network_id_delete(private_network_id)
+
+Delete a Private Network.
+
+Delete Private Network.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_api'
+# setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+private_network_id = '603f3b2cfcaf050643b89a4b' # String | The private network identifier.
+
+begin
+  # Delete a Private Network.
+  api_instance.private_networks_network_id_delete(private_network_id)
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_delete: #{e}"
+end
+```
+
+#### Using the private_networks_network_id_delete_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)> private_networks_network_id_delete_with_http_info(private_network_id)
+
+```ruby
+begin
+  # Delete a Private Network.
+  data, status_code, headers = api_instance.private_networks_network_id_delete_with_http_info(private_network_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **private_network_id** | **String** | The private network identifier. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## private_networks_network_id_get
+
+> <PrivateNetwork> private_networks_network_id_get(private_network_id)
+
+Get a Private Network.
+
+Retrieve Private Network Details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_api'
+# setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+private_network_id = '603f3b2cfcaf050643b89a4b' # String | The private network identifier.
+
+begin
+  # Get a Private Network.
+  result = api_instance.private_networks_network_id_get(private_network_id)
+  p result
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_get: #{e}"
+end
+```
+
+#### Using the private_networks_network_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PrivateNetwork>, Integer, Hash)> private_networks_network_id_get_with_http_info(private_network_id)
+
+```ruby
+begin
+  # Get a Private Network.
+  data, status_code, headers = api_instance.private_networks_network_id_get_with_http_info(private_network_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PrivateNetwork>
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **private_network_id** | **String** | The private network identifier. |  |
+
+### Return type
+
+[**PrivateNetwork**](PrivateNetwork.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## private_networks_network_id_put
+
+> <PrivateNetwork> private_networks_network_id_put(private_network_id, opts)
+
+Update a Private Network.
+
+Update Private Network Details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_api'
+# setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+private_network_id = '603f3b2cfcaf050643b89a4b' # String | The private network identifier.
+opts = {
+  private_network_modify: NetworkApi::PrivateNetworkModify.new({name: 'Sample network', location_default: true}) # PrivateNetworkModify | 
+}
+
+begin
+  # Update a Private Network.
+  result = api_instance.private_networks_network_id_put(private_network_id, opts)
+  p result
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_put: #{e}"
+end
+```
+
+#### Using the private_networks_network_id_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PrivateNetwork>, Integer, Hash)> private_networks_network_id_put_with_http_info(private_network_id, opts)
+
+```ruby
+begin
+  # Update a Private Network.
+  data, status_code, headers = api_instance.private_networks_network_id_put_with_http_info(private_network_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PrivateNetwork>
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_network_id_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **private_network_id** | **String** | The private network identifier. |  |
+| **private_network_modify** | [**PrivateNetworkModify**](PrivateNetworkModify.md) |  | [optional] |
+
+### Return type
+
+[**PrivateNetwork**](PrivateNetwork.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## private_networks_post
+
+> <PrivateNetwork> private_networks_post(opts)
+
+Create a Private Network.
+
+Create a Private Network.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_api'
+# setup authorization
+NetworkApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkApi::PrivateNetworksApi.new
+opts = {
+  private_network_create: NetworkApi::PrivateNetworkCreate.new({name: 'Sample Network', location: 'PHX', cidr: '10.0.0.0/24'}) # PrivateNetworkCreate | 
+}
+
+begin
+  # Create a Private Network.
+  result = api_instance.private_networks_post(opts)
+  p result
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_post: #{e}"
+end
+```
+
+#### Using the private_networks_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PrivateNetwork>, Integer, Hash)> private_networks_post_with_http_info(opts)
+
+```ruby
+begin
+  # Create a Private Network.
+  data, status_code, headers = api_instance.private_networks_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PrivateNetwork>
+rescue NetworkApi::ApiError => e
+  puts "Error when calling PrivateNetworksApi->private_networks_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **private_network_create** | [**PrivateNetworkCreate**](PrivateNetworkCreate.md) |  | [optional] |
+
+### Return type
+
+[**PrivateNetwork**](PrivateNetwork.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+