pnap_network_api 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06c353b308f28f82070f0cf8ad710908265e3e34ce32d4f97e4a73d49d0092e
-  data.tar.gz: 6232a6388512978c71a5adb5c65f1ff8af1c1978258b41f3db594674f3e3a08c
+  metadata.gz: cf9a797a07f6f245ed99ec1c1a482905d245b2ffed74838c70ef87d99c0e632f
+  data.tar.gz: b284838b33280acb5c66fd541cb81e9aa5b542889da8744b60106a6fe2c78a96
 SHA512:
-  metadata.gz: a9e7667be380283d21f7aa923f43c70e7f1b17cc40847193fa98fcd206ebd2ac63abcc7a8955b1546073e6dd76575881ef9c09744f65f4c43f721bfbf77a4cef
-  data.tar.gz: 38f14f5ad05197c064788f9d628f8028cb7785e6e4544ad964b24fb8bf7d0b2e4d03f6c0677fdabe5372a1831e52d40f1453d3cf83a9dcd1e25a86a3c94360d4
+  metadata.gz: a0c5019d81b10ec07d674c4ae612139fac5ea94b049a367be641abda8f59454d10394fac2be81fc1d28585756c1703d3b8747d1eab63e992d3829b0e50472f5c
+  data.tar.gz: a8256f45c8a6ecfc1f08f5bdae596d85f881c06b7c4d9d80c9e5c275a4cb97e55b48b82d1e041fb03943335eb6c69b8db06cdfc4e5121534d9d97a46183003d1

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.3.0

data/docs/PrivateNetwork.md

@@ -11,7 +11,7 @@
 | **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. |  |
+| **cidr** | **String** | IP range associated with this private network in CIDR notation. | [optional] |
 | **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`. |  |

data/docs/PrivateNetworkCreate.md

@@ -8,7 +8,8 @@
 | **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. |  |
+| **vlan_id** | **Integer** | The VLAN that will be assigned to this network. | [optional] |
+| **cidr** | **String** | IP range associated with this private network in CIDR notation.<br> Setting the `force` query parameter to `true` allows you to skip assigning a specific IP range to network. | [optional] |
 
 ## Example
 
@@ -20,6 +21,7 @@ instance = NetworkApi::PrivateNetworkCreate.new(
   description: Further details on the network,
   location: PHX,
   location_default: true,
+  vlan_id: 10,
   cidr: 10.0.0.0/24
 )
 ```

data/docs/PrivateNetworksApi.md

@@ -313,7 +313,8 @@ 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 | 
+  force: true, # Boolean | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups.
+  private_network_create: NetworkApi::PrivateNetworkCreate.new({name: 'Sample Network', location: 'PHX'}) # PrivateNetworkCreate | 
 }
 
 begin
@@ -347,6 +348,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **force** | **Boolean** | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. | [optional][default to false] |
 | **private_network_create** | [**PrivateNetworkCreate**](PrivateNetworkCreate.md) |  | [optional] |
 
 ### Return type

data/docs/PublicNetworkCreate.md

@@ -7,6 +7,7 @@
 | **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`. |  |
+| **vlan_id** | **Integer** | The VLAN that will be assigned to this network. | [optional] |
 | **ip_blocks** | [**Array<PublicNetworkIpBlock>**](PublicNetworkIpBlock.md) | A list of IP Blocks that will be associated with this public network. | [optional] |
 
 ## Example
@@ -18,6 +19,7 @@ instance = NetworkApi::PublicNetworkCreate.new(
   name: Sample Network,
   description: Further details on the network.,
   location: PHX,
+  vlan_id: 10,
   ip_blocks: null
 )
 ```

data/docs/PublicNetworksApi.md

@@ -223,11 +223,11 @@ end
 
 ## public_networks_network_id_ip_blocks_ip_block_id_delete
 
-> String public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id)
+> String public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts)
 
 Removes the IP Block from the Public Network.
 
-Removes the IP Block from the Public Network. The result of this is that any traffic addressed to any IP within the block will not be routed to this network anymore. Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.
+Removes the IP Block from the Public Network.<br> Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.<br> Defining `force` query parameter allows resource assigned IP block to be removed anyway.  As a result, traffic addressed to any IP within the block will not be routed to this network anymore.
 
 ### Examples
 
@@ -243,10 +243,13 @@ end
 api_instance = NetworkApi::PublicNetworksApi.new
 public_network_id = '603f3b2cfcaf050643b89a4b' # String | The Public Network identifier.
 ip_block_id = '6047127fed34ecc3ba8402d2' # String | The IP Block identifier.
+opts = {
+  force: true # Boolean | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups.
+}
 
 begin
   # Removes the IP Block from the Public Network.
-  result = api_instance.public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id)
+  result = api_instance.public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts)
   p result
 rescue NetworkApi::ApiError => e
   puts "Error when calling PublicNetworksApi->public_networks_network_id_ip_blocks_ip_block_id_delete: #{e}"
@@ -257,12 +260,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(String, Integer, Hash)> public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id)
+> <Array(String, Integer, Hash)> public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts)
 
 ```ruby
 begin
   # Removes the IP Block from the Public Network.
-  data, status_code, headers = api_instance.public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id)
+  data, status_code, headers = api_instance.public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => String
@@ -277,6 +280,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **public_network_id** | **String** | The Public Network identifier. |  |
 | **ip_block_id** | **String** | The IP Block identifier. |  |
+| **force** | **Boolean** | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. | [optional][default to false] |
 
 ### Return type
 

data/lib/pnap_network_api/api/private_networks_api.rb

@@ -278,6 +278,7 @@ module NetworkApi
     # Create a Private Network.
     # Create a Private Network.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [PrivateNetworkCreate] :private_network_create 
     # @return [PrivateNetwork]
     def private_networks_post(opts = {})
@@ -288,6 +289,7 @@ module NetworkApi
     # Create a Private Network.
     # Create a Private Network.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [PrivateNetworkCreate] :private_network_create 
     # @return [Array<(PrivateNetwork, Integer, Hash)>] PrivateNetwork data, response status code and response headers
     def private_networks_post_with_http_info(opts = {})
@@ -299,6 +301,7 @@ module NetworkApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/pnap_network_api/api/public_networks_api.rb

@@ -206,10 +206,11 @@ module NetworkApi
     end
 
     # Removes the IP Block from the Public Network.
-    # Removes the IP Block from the Public Network. The result of this is that any traffic addressed to any IP within the block will not be routed to this network anymore. Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.
+    # Removes the IP Block from the Public Network.<br> Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.<br> Defining `force` query parameter allows resource assigned IP block to be removed anyway.  As a result, traffic addressed to any IP within the block will not be routed to this network anymore.
     # @param public_network_id [String] The Public Network identifier.
     # @param ip_block_id [String] The IP Block identifier.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @return [String]
     def public_networks_network_id_ip_blocks_ip_block_id_delete(public_network_id, ip_block_id, opts = {})
       data, _status_code, _headers = public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts)
@@ -217,10 +218,11 @@ module NetworkApi
     end
 
     # Removes the IP Block from the Public Network.
-    # Removes the IP Block from the Public Network. The result of this is that any traffic addressed to any IP within the block will not be routed to this network anymore. Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.
+    # Removes the IP Block from the Public Network.&lt;br&gt; Please ensure that no resource members within this network have any IPs assigned from the IP Block being removed.&lt;br&gt; Defining &#x60;force&#x60; query parameter allows resource assigned IP block to be removed anyway.  As a result, traffic addressed to any IP within the block will not be routed to this network anymore.
     # @param public_network_id [String] The Public Network identifier.
     # @param ip_block_id [String] The IP Block identifier.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
     def public_networks_network_id_ip_blocks_ip_block_id_delete_with_http_info(public_network_id, ip_block_id, opts = {})
       if @api_client.config.debugging
@@ -239,6 +241,7 @@ module NetworkApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/pnap_network_api/models/private_network.rb

@@ -206,10 +206,6 @@ module NetworkApi
         invalid_properties.push('invalid value for "location_default", location_default cannot be nil.')
       end
 
-      if @cidr.nil?
-        invalid_properties.push('invalid value for "cidr", cidr cannot be nil.')
-      end
-
       if @servers.nil?
         invalid_properties.push('invalid value for "servers", servers cannot be nil.')
       end
@@ -241,7 +237,6 @@ module NetworkApi
       return false if @type.nil?
       return false if @location.nil?
       return false if @location_default.nil?
-      return false if @cidr.nil?
       return false if @servers.nil?
       return false if @memberships.nil?
       return false if @status.nil?

data/lib/pnap_network_api/models/private_network_create.rb

@@ -28,7 +28,10 @@ module NetworkApi
     # Identifies network as the default private network for the specified location.
     attr_accessor :location_default
 
-    # IP range associated with this private network in CIDR notation.
+    # The VLAN that will be assigned to this network.
+    attr_accessor :vlan_id
+
+    # IP range associated with this private network in CIDR notation.<br> Setting the `force` query parameter to `true` allows you to skip assigning a specific IP range to network.
     attr_accessor :cidr
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,6 +41,7 @@ module NetworkApi
         :'description' => :'description',
         :'location' => :'location',
         :'location_default' => :'locationDefault',
+        :'vlan_id' => :'vlanId',
         :'cidr' => :'cidr'
       }
     end
@@ -54,6 +58,7 @@ module NetworkApi
         :'description' => :'String',
         :'location' => :'String',
         :'location_default' => :'Boolean',
+        :'vlan_id' => :'Integer',
         :'cidr' => :'String'
       }
     end
@@ -97,6 +102,10 @@ module NetworkApi
         self.location_default = false
       end
 
+      if attributes.key?(:'vlan_id')
+        self.vlan_id = attributes[:'vlan_id']
+      end
+
       if attributes.key?(:'cidr')
         self.cidr = attributes[:'cidr']
       end
@@ -126,8 +135,12 @@ module NetworkApi
         invalid_properties.push('invalid value for "location", location cannot be nil.')
       end
 
-      if @cidr.nil?
-        invalid_properties.push('invalid value for "cidr", cidr cannot be nil.')
+      if !@vlan_id.nil? && @vlan_id > 4094
+        invalid_properties.push('invalid value for "vlan_id", must be smaller than or equal to 4094.')
+      end
+
+      if !@vlan_id.nil? && @vlan_id < 2
+        invalid_properties.push('invalid value for "vlan_id", must be greater than or equal to 2.')
       end
 
       invalid_properties
@@ -141,7 +154,8 @@ module NetworkApi
       return false if @name.to_s.length < 1
       return false if !@description.nil? && @description.to_s.length > 250
       return false if @location.nil?
-      return false if @cidr.nil?
+      return false if !@vlan_id.nil? && @vlan_id > 4094
+      return false if !@vlan_id.nil? && @vlan_id < 2
       true
     end
 
@@ -173,6 +187,20 @@ module NetworkApi
       @description = description
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] vlan_id Value to be assigned
+    def vlan_id=(vlan_id)
+      if !vlan_id.nil? && vlan_id > 4094
+        fail ArgumentError, 'invalid value for "vlan_id", must be smaller than or equal to 4094.'
+      end
+
+      if !vlan_id.nil? && vlan_id < 2
+        fail ArgumentError, 'invalid value for "vlan_id", must be greater than or equal to 2.'
+      end
+
+      @vlan_id = vlan_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -182,6 +210,7 @@ module NetworkApi
           description == o.description &&
           location == o.location &&
           location_default == o.location_default &&
+          vlan_id == o.vlan_id &&
           cidr == o.cidr
     end
 
@@ -194,7 +223,7 @@ module NetworkApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, location, location_default, cidr].hash
+      [name, description, location, location_default, vlan_id, cidr].hash
     end
 
     # Builds the object from hash

data/lib/pnap_network_api/models/public_network_create.rb

@@ -25,6 +25,9 @@ module NetworkApi
     # The location of this public network. Supported values are `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` and `AUS`.
     attr_accessor :location
 
+    # The VLAN that will be assigned to this network.
+    attr_accessor :vlan_id
+
     # A list of IP Blocks that will be associated with this public network.
     attr_accessor :ip_blocks
 
@@ -34,6 +37,7 @@ module NetworkApi
         :'name' => :'name',
         :'description' => :'description',
         :'location' => :'location',
+        :'vlan_id' => :'vlanId',
         :'ip_blocks' => :'ipBlocks'
       }
     end
@@ -49,6 +53,7 @@ module NetworkApi
         :'name' => :'String',
         :'description' => :'String',
         :'location' => :'String',
+        :'vlan_id' => :'Integer',
         :'ip_blocks' => :'Array<PublicNetworkIpBlock>'
       }
     end
@@ -86,6 +91,10 @@ module NetworkApi
         self.location = attributes[:'location']
       end
 
+      if attributes.key?(:'vlan_id')
+        self.vlan_id = attributes[:'vlan_id']
+      end
+
       if attributes.key?(:'ip_blocks')
         if (value = attributes[:'ip_blocks']).is_a?(Array)
           self.ip_blocks = value
@@ -117,6 +126,14 @@ module NetworkApi
         invalid_properties.push('invalid value for "location", location cannot be nil.')
       end
 
+      if !@vlan_id.nil? && @vlan_id > 4094
+        invalid_properties.push('invalid value for "vlan_id", must be smaller than or equal to 4094.')
+      end
+
+      if !@vlan_id.nil? && @vlan_id < 2
+        invalid_properties.push('invalid value for "vlan_id", must be greater than or equal to 2.')
+      end
+
       if !@ip_blocks.nil? && @ip_blocks.length > 10
         invalid_properties.push('invalid value for "ip_blocks", number of items must be less than or equal to 10.')
       end
@@ -132,6 +149,8 @@ module NetworkApi
       return false if @name.to_s.length < 1
       return false if !@description.nil? && @description.to_s.length > 250
       return false if @location.nil?
+      return false if !@vlan_id.nil? && @vlan_id > 4094
+      return false if !@vlan_id.nil? && @vlan_id < 2
       return false if !@ip_blocks.nil? && @ip_blocks.length > 10
       true
     end
@@ -164,6 +183,20 @@ module NetworkApi
       @description = description
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] vlan_id Value to be assigned
+    def vlan_id=(vlan_id)
+      if !vlan_id.nil? && vlan_id > 4094
+        fail ArgumentError, 'invalid value for "vlan_id", must be smaller than or equal to 4094.'
+      end
+
+      if !vlan_id.nil? && vlan_id < 2
+        fail ArgumentError, 'invalid value for "vlan_id", must be greater than or equal to 2.'
+      end
+
+      @vlan_id = vlan_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] ip_blocks Value to be assigned
     def ip_blocks=(ip_blocks)
@@ -182,6 +215,7 @@ module NetworkApi
           name == o.name &&
           description == o.description &&
           location == o.location &&
+          vlan_id == o.vlan_id &&
           ip_blocks == o.ip_blocks
     end
 
@@ -194,7 +228,7 @@ module NetworkApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, location, ip_blocks].hash
+      [name, description, location, vlan_id, ip_blocks].hash
     end
 
     # Builds the object from hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnap_network_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - PhoenixNAP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -129,24 +129,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Networks API Ruby Gem
 test_files:
-- spec/api/public_networks_api_spec.rb
 - spec/api/private_networks_api_spec.rb
+- spec/api/public_networks_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/public_network_modify_spec.rb
-- spec/models/private_network_spec.rb
-- spec/models/private_network_modify_spec.rb
-- spec/models/public_network_ip_block_spec.rb
-- spec/models/error_spec.rb
-- spec/models/network_membership_spec.rb
 - spec/models/public_network_spec.rb
-- spec/models/private_network_create_spec.rb
+- spec/models/error_spec.rb
 - spec/models/private_network_server_spec.rb
-- spec/models/public_network_create_spec.rb
+- spec/models/public_network_ip_block_spec.rb
 - spec/models/public_network_membership_spec.rb
+- spec/models/private_network_create_spec.rb
+- spec/models/private_network_modify_spec.rb
+- spec/models/private_network_spec.rb
+- spec/models/network_membership_spec.rb
+- spec/models/public_network_create_spec.rb
+- spec/models/public_network_modify_spec.rb
 - spec/spec_helper.rb