pnap_network_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32455cd457e2d564fd3df4eaf12df1d5ec05dfcd27c8529a83561fc43f1f7ea
-  data.tar.gz: e85981c47c3c0956c62e21ba9635f37e53963601464dd8a698dc4f21915986d3
+  metadata.gz: fed5342265483dbe49bda94d48dda2c5cba9409082b8f68404667c15dbcef88d
+  data.tar.gz: 110ec3b7beeea62c621943c3019886757ecdb22c1fdfe22fc799c26d44eec604
 SHA512:
-  metadata.gz: 199f1064336c7b4a9da8659797e6abdc12c97851159bf0cb5d0d951558526c8daba21180cdd35dcb812580ef081eff3c68b533289133ae47c76ea2a2c097767f
-  data.tar.gz: f8597618363bbd2743f032ee80bd1a55afbfc118418004a5e083e14c328d1d5f8e73b1af92962c4e215e8ea27eeb15089cc36041b2b2ce7142c80f0564791c1e
+  metadata.gz: 70d9dfcb1c734266da2fbdd981781228c2729a04eeac7d4604451c19a6c2e3d007804867944cfa614fb2c406f62fd3c75dbb7ad0fbdc11e2cef3b4ffa27684c4
+  data.tar.gz: 40257eb3c0b9294c92f3d162db4600d3f6953a11001b8e56eb118df70137eb0e8a7032ac45d7c8a2f19b4be4aa9432ad247a028323018a219806fdf7a0f46cb4

data/README.md

@@ -2,13 +2,14 @@
 
 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>
+Create, list, edit and delete public/private networks with the Network API. Use public networks to place multiple 
+servers on the same network or VLAN. Assign new servers with IP addresses from the same CIDR range. Use private 
+networks to avoid unnecessary egress data charges. Model your networks according to your business needs.<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>
+Helpful knowledge base articles are available for 
+<a href='https://phoenixnap.com/kb/bmc-server-management-via-api#multi-private-backend-network-api' target='_blank'>multi-private backend networks</a>
+and <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-15' target='_blank'>public networks</a>.
 </span><br>
 <br>
 <b>All URLs are relative to (https://api.phoenixnap.com/networks/v1/)</b>
@@ -128,15 +129,27 @@ Class | Method | HTTP request | Description
 *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.
+*NetworkApi::PublicNetworksApi* | [**public_networks_get**](docs/PublicNetworksApi.md#public_networks_get) | **GET** /public-networks | List Public Networks.
+*NetworkApi::PublicNetworksApi* | [**public_networks_network_id_delete**](docs/PublicNetworksApi.md#public_networks_network_id_delete) | **DELETE** /public-networks/{publicNetworkId} | Delete a Public Network.
+*NetworkApi::PublicNetworksApi* | [**public_networks_network_id_get**](docs/PublicNetworksApi.md#public_networks_network_id_get) | **GET** /public-networks/{publicNetworkId} | Get a Public Network.
+*NetworkApi::PublicNetworksApi* | [**public_networks_network_id_ip_blocks_ip_block_id_delete**](docs/PublicNetworksApi.md#public_networks_network_id_ip_blocks_ip_block_id_delete) | **DELETE** /public-networks/{publicNetworkId}/ip-blocks/{ipBlockId} | Removes the IP Block from the Public Network.
+*NetworkApi::PublicNetworksApi* | [**public_networks_network_id_ip_blocks_post**](docs/PublicNetworksApi.md#public_networks_network_id_ip_blocks_post) | **POST** /public-networks/{publicNetworkId}/ip-blocks | Adds an IP block to this public network.
+*NetworkApi::PublicNetworksApi* | [**public_networks_network_id_patch**](docs/PublicNetworksApi.md#public_networks_network_id_patch) | **PATCH** /public-networks/{publicNetworkId} | Update Public Network's Details.
+*NetworkApi::PublicNetworksApi* | [**public_networks_post**](docs/PublicNetworksApi.md#public_networks_post) | **POST** /public-networks | Create a public network.
 
 
 ## Documentation for Models
 
  - [NetworkApi::Error](docs/Error.md)
+ - [NetworkApi::NetworkMembership](docs/NetworkMembership.md)
  - [NetworkApi::PrivateNetwork](docs/PrivateNetwork.md)
  - [NetworkApi::PrivateNetworkCreate](docs/PrivateNetworkCreate.md)
  - [NetworkApi::PrivateNetworkModify](docs/PrivateNetworkModify.md)
  - [NetworkApi::PrivateNetworkServer](docs/PrivateNetworkServer.md)
+ - [NetworkApi::PublicNetwork](docs/PublicNetwork.md)
+ - [NetworkApi::PublicNetworkCreate](docs/PublicNetworkCreate.md)
+ - [NetworkApi::PublicNetworkIpBlock](docs/PublicNetworkIpBlock.md)
+ - [NetworkApi::PublicNetworkModify](docs/PublicNetworkModify.md)
 
 
 ## Documentation for Authorization

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/docs/NetworkMembership.md

@@ -0,0 +1,22 @@
+# NetworkApi::NetworkMembership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_id** | **String** | The resource identifier. |  |
+| **resource_type** | **String** | The resource's type. |  |
+| **ips** | **Array<String>** | List of IPs associated to the resource. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::NetworkMembership.new(
+  resource_id: 603f3e995c18d515cda9c4f8,
+  resource_type: server,
+  ips: ["10.111.14.104","10.111.14.105","10.111.14.106"]
+)
+```
+

data/docs/PrivateNetwork.md

@@ -13,6 +13,9 @@
 | **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) |  |  |
+| **memberships** | [**Array<NetworkMembership>**](NetworkMembership.md) | A list of resources that are members of this private network. |  |
+| **status** | **String** | The status of the private network. Can have one of the following values: `BUSY` or `READY`. |  |
+| **created_on** | **Time** | Date and time when this private network was created. |  |
 
 ## Example
 
@@ -28,7 +31,10 @@ instance = NetworkApi::PrivateNetwork.new(
   location: PHX,
   location_default: true,
   cidr: 10.0.0.0/24,
-  servers: null
+  servers: null,
+  memberships: null,
+  status: READY,
+  created_on: 2022-04-07T13:30:30.491Z
 )
 ```
 

data/docs/PublicNetwork.md

@@ -0,0 +1,34 @@
+# NetworkApi::PublicNetwork
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The public network identifier. |  |
+| **vlan_id** | **Integer** | The VLAN of this public network. |  |
+| **memberships** | [**Array<NetworkMembership>**](NetworkMembership.md) | A list of resources that are members of this public network. |  |
+| **name** | **String** | The friendly name of this public network. |  |
+| **location** | **String** | The location of this public network. Supported values are `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` and `AUS`. |  |
+| **description** | **String** | The description of this public network. | [optional] |
+| **status** | **String** | The status of the public network. Can have one of the following values: `BUSY` or `READY`. |  |
+| **created_on** | **Time** | Date and time when this public network was created. |  |
+| **ip_blocks** | [**Array<PublicNetworkIpBlock>**](PublicNetworkIpBlock.md) | A list of IP Blocks that are associated with this public network. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PublicNetwork.new(
+  id: 604721852cf65253d151528b,
+  vlan_id: 10,
+  memberships: null,
+  name: Sample Network,
+  location: PHX,
+  description: Further details on the network.,
+  status: READY,
+  created_on: 2022-04-05T13:50:30.491Z,
+  ip_blocks: null
+)
+```
+

data/docs/PublicNetworkCreate.md

@@ -0,0 +1,24 @@
+# NetworkApi::PublicNetworkCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The friendly name of this public network. This name should be unique. |  |
+| **description** | **String** | The description of this public network. | [optional] |
+| **location** | **String** | The location of this public network. Supported values are `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` and `AUS`. |  |
+| **ip_blocks** | [**Array<PublicNetworkIpBlock>**](PublicNetworkIpBlock.md) | A list of IP Blocks that will be associated with this public network. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PublicNetworkCreate.new(
+  name: Sample Network,
+  description: Further details on the network.,
+  location: PHX,
+  ip_blocks: null
+)
+```
+

data/docs/PublicNetworkIpBlock.md

@@ -0,0 +1,18 @@
+# NetworkApi::PublicNetworkIpBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The IP Block identifier. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PublicNetworkIpBlock.new(
+  id: 60473a6115e34466c9f8f083
+)
+```
+

data/docs/PublicNetworkMembership.md

@@ -0,0 +1,22 @@
+# NetworkApi::PublicNetworkMembership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_id** | **String** | The resource identifier. |  |
+| **resource_type** | **String** | The resource's type. |  |
+| **ips** | **Array<String>** | List of public IPs associated to the resource. |  |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PublicNetworkMembership.new(
+  resource_id: 603f3e995c18d515cda9c4f8,
+  resource_type: server,
+  ips: ["10.111.14.104","10.111.14.105","10.111.14.106"]
+)
+```
+

data/docs/PublicNetworkModify.md

@@ -0,0 +1,20 @@
+# NetworkApi::PublicNetworkModify
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A friendly name given to the network. This name should be unique. | [optional] |
+| **description** | **String** | The description of this public network | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_network_api'
+
+instance = NetworkApi::PublicNetworkModify.new(
+  name: Sample Network,
+  description: Further details on the network.
+)
+```
+