pnap_network_storage_api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98790b752c44df0148ad5371bd2044d5dff91b569b25c8b7c38e2bc016dd1e5a
-  data.tar.gz: '089913181ec8d92e0560bf0d13991d9dacc5ed2839bc48e92564bbfe3577fd54'
+  metadata.gz: 825f2d86eab01b72dc080b416b4b20fd8d51ebdf62595e0f564630f8e62bb15b
+  data.tar.gz: 3e77f5f15f2154ceb8eca25a3bebac2d418b1d52f94cf5b5a7d180e13c960ccd
 SHA512:
-  metadata.gz: 3d619f8343b73ad20a8e9bdd40b7efe43ea8c1f2833f3a408af32477a097b70cd0155f8888d0434709d2ee49216ce4f8427074363bf41c2cbd8def0b6f7b616b
-  data.tar.gz: 94b4b770f57606f873a1da64360e4c1faba2737cf2ba6a7ec792f981feb418a4687fb9292793f4d9e8b8a366205da8e37770d5630496280fa1512e217faeba91
+  metadata.gz: 5ae1bca9d78dab9bbd1bbd8553f9e4eaabc2c6c512b2790562b1a1c1951da9af03221ef8a011c25c046b0ca7951e1fbd8be6677d233096aa37c2bb57ab07742f
+  data.tar.gz: f746fb54257b7774e25be56a40b283d9e2fc7a7ead0b8873e59de563aa1de78ee27f08f1e1aaf20225fdd296517b28b2c34aef745eea333b08d146eaa95dc301

data/README.md

@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_id_patch**](docs/StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageNetworkId} | Update storage network details.
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_post**](docs/StorageNetworksApi.md#storage_networks_post) | **POST** /storage-networks | Create a storage network and volume.
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{storageNetworkId}/volumes | Display one or more volumes belonging to a storage network.
+*NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_post**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{storageNetworkId}/volumes | Create a volume belonging to a storage network.
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_delete**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Delete a Storage Network's Volume
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_get**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Get a storage network's volume details.
 *NetworkStorageApi::StorageNetworksApi* | [**storage_networks_storage_network_id_volumes_volume_id_patch**](docs/StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Update a storage network's volume details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/docs/StorageNetworkCreate.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Storage network friendly name. |  |
 | **description** | **String** | Storage network description. | [optional] |
-| **location** | **String** | Location of storage network. Currently this field should be set to `PHX`. |  |
+| **location** | **String** | Location of storage network. Currently this field should be set to `PHX` or `ASH`. |  |
 | **volumes** | [**Array<VolumeCreate>**](VolumeCreate.md) | Volume to be created alongside storage. Currently only 1 volume is supported. |  |
 
 ## Example

data/docs/StorageNetworksApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.phoenixnap.com/network-storage/v1*
 | [**storage_networks_id_patch**](StorageNetworksApi.md#storage_networks_id_patch) | **PATCH** /storage-networks/{storageNetworkId} | Update storage network details. |
 | [**storage_networks_post**](StorageNetworksApi.md#storage_networks_post) | **POST** /storage-networks | Create a storage network and volume. |
 | [**storage_networks_storage_network_id_volumes_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_get) | **GET** /storage-networks/{storageNetworkId}/volumes | Display one or more volumes belonging to a storage network. |
+| [**storage_networks_storage_network_id_volumes_post**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_post) | **POST** /storage-networks/{storageNetworkId}/volumes | Create a volume belonging to a storage network. |
 | [**storage_networks_storage_network_id_volumes_volume_id_delete**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_delete) | **DELETE** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Delete a Storage Network's Volume |
 | [**storage_networks_storage_network_id_volumes_volume_id_get**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_get) | **GET** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Get a storage network's volume details. |
 | [**storage_networks_storage_network_id_volumes_volume_id_patch**](StorageNetworksApi.md#storage_networks_storage_network_id_volumes_volume_id_patch) | **PATCH** /storage-networks/{storageNetworkId}/volumes/{volumeId} | Update a storage network's volume details. |
@@ -436,6 +437,79 @@ end
 - **Accept**: application/json
 
 
+## storage_networks_storage_network_id_volumes_post
+
+> <Volume> storage_networks_storage_network_id_volumes_post(storage_network_id, opts)
+
+Create a volume belonging to a storage network.
+
+Create a volume belonging to a storage network.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pnap_network_storage_api'
+# setup authorization
+NetworkStorageApi.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = NetworkStorageApi::StorageNetworksApi.new
+storage_network_id = '50dc434c-9bba-427b-bcd6-0bdba45c4dd2' # String | ID of storage network.
+opts = {
+  volume_create: NetworkStorageApi::VolumeCreate.new({name: 'My volume name', capacity_in_gb: 2000}) # VolumeCreate | 
+}
+
+begin
+  # Create a volume belonging to a storage network.
+  result = api_instance.storage_networks_storage_network_id_volumes_post(storage_network_id, opts)
+  p result
+rescue NetworkStorageApi::ApiError => e
+  puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_post: #{e}"
+end
+```
+
+#### Using the storage_networks_storage_network_id_volumes_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Volume>, Integer, Hash)> storage_networks_storage_network_id_volumes_post_with_http_info(storage_network_id, opts)
+
+```ruby
+begin
+  # Create a volume belonging to a storage network.
+  data, status_code, headers = api_instance.storage_networks_storage_network_id_volumes_post_with_http_info(storage_network_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Volume>
+rescue NetworkStorageApi::ApiError => e
+  puts "Error when calling StorageNetworksApi->storage_networks_storage_network_id_volumes_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storage_network_id** | **String** | ID of storage network. |  |
+| **volume_create** | [**VolumeCreate**](VolumeCreate.md) |  | [optional] |
+
+### Return type
+
+[**Volume**](Volume.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## storage_networks_storage_network_id_volumes_volume_id_delete
 
 > storage_networks_storage_network_id_volumes_volume_id_delete(storage_network_id, volume_id)

data/docs/VolumeUpdate.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **name** | **String** | Volume friendly name. | [optional] |
+| **description** | **String** | Volume description. | [optional] |
 | **capacity_in_gb** | **Integer** | Capacity of Volume in GB. Currently only whole numbers and multiples of 1000GB are supported. | [optional] |
+| **path_suffix** | **String** | Last part of volume's path. | [optional] |
 
 ## Example
 
@@ -12,7 +15,10 @@
 require 'pnap_network_storage_api'
 
 instance = NetworkStorageApi::VolumeUpdate.new(
-  capacity_in_gb: 2000
+  name: New Volume name,
+  description: New Volume description,
+  capacity_in_gb: 2000,
+  path_suffix: null
 )
 ```
 

data/lib/pnap_network_storage_api/api/storage_networks_api.rb

@@ -402,6 +402,76 @@ module NetworkStorageApi
       return data, status_code, headers
     end
 
+    # Create a volume belonging to a storage network.
+    # Create a volume belonging to a storage network.
+    # @param storage_network_id [String] ID of storage network.
+    # @param [Hash] opts the optional parameters
+    # @option opts [VolumeCreate] :volume_create 
+    # @return [Volume]
+    def storage_networks_storage_network_id_volumes_post(storage_network_id, opts = {})
+      data, _status_code, _headers = storage_networks_storage_network_id_volumes_post_with_http_info(storage_network_id, opts)
+      data
+    end
+
+    # Create a volume belonging to a storage network.
+    # Create a volume belonging to a storage network.
+    # @param storage_network_id [String] ID of storage network.
+    # @param [Hash] opts the optional parameters
+    # @option opts [VolumeCreate] :volume_create 
+    # @return [Array<(Volume, Integer, Hash)>] Volume data, response status code and response headers
+    def storage_networks_storage_network_id_volumes_post_with_http_info(storage_network_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorageNetworksApi.storage_networks_storage_network_id_volumes_post ...'
+      end
+      # verify the required parameter 'storage_network_id' is set
+      if @api_client.config.client_side_validation && storage_network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'storage_network_id' when calling StorageNetworksApi.storage_networks_storage_network_id_volumes_post"
+      end
+      # resource path
+      local_var_path = '/storage-networks/{storageNetworkId}/volumes'.sub('{' + 'storageNetworkId' + '}', CGI.escape(storage_network_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'volume_create'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Volume'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"StorageNetworksApi.storage_networks_storage_network_id_volumes_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorageNetworksApi#storage_networks_storage_network_id_volumes_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a Storage Network's Volume
     # Delete a Storage Network's Volume
     # @param storage_network_id [String] ID of storage network.

data/lib/pnap_network_storage_api/models/storage_network_create.rb

@@ -22,7 +22,7 @@ module NetworkStorageApi
     # Storage network description.
     attr_accessor :description
 
-    # Location of storage network. Currently this field should be set to `PHX`.
+    # Location of storage network. Currently this field should be set to `PHX` or `ASH`.
     attr_accessor :location
 
     # Volume to be created alongside storage. Currently only 1 volume is supported.

data/lib/pnap_network_storage_api/models/volume_create.rb

@@ -111,15 +111,15 @@ module NetworkStorageApi
         invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
       end
 
-      if !@path_suffix.nil? && @path_suffix.to_s.length > 100
-        invalid_properties.push('invalid value for "path_suffix", the character length must be smaller than or equal to 100.')
+      if !@path_suffix.nil? && @path_suffix.to_s.length > 27
+        invalid_properties.push('invalid value for "path_suffix", the character length must be smaller than or equal to 27.')
       end
 
-      if !@path_suffix.nil? && @path_suffix.to_s.length < 1
-        invalid_properties.push('invalid value for "path_suffix", the character length must be great than or equal to 1.')
+      if !@path_suffix.nil? && @path_suffix.to_s.length < 0
+        invalid_properties.push('invalid value for "path_suffix", the character length must be great than or equal to 0.')
       end
 
-      pattern = Regexp.new(/^(\/[\w-]+)+$/)
+      pattern = Regexp.new(/^(\/[\w-]+)+$|^$/)
       if !@path_suffix.nil? && @path_suffix !~ pattern
         invalid_properties.push("invalid value for \"path_suffix\", must conform to the pattern #{pattern}.")
       end
@@ -142,9 +142,9 @@ module NetworkStorageApi
       return false if @name.to_s.length > 100
       return false if @name.to_s.length < 1
       return false if !@description.nil? && @description.to_s.length > 250
-      return false if !@path_suffix.nil? && @path_suffix.to_s.length > 100
-      return false if !@path_suffix.nil? && @path_suffix.to_s.length < 1
-      return false if !@path_suffix.nil? && @path_suffix !~ Regexp.new(/^(\/[\w-]+)+$/)
+      return false if !@path_suffix.nil? && @path_suffix.to_s.length > 27
+      return false if !@path_suffix.nil? && @path_suffix.to_s.length < 0
+      return false if !@path_suffix.nil? && @path_suffix !~ Regexp.new(/^(\/[\w-]+)+$|^$/)
       return false if @capacity_in_gb.nil?
       return false if @capacity_in_gb < 1000
       true
@@ -181,15 +181,15 @@ module NetworkStorageApi
     # Custom attribute writer method with validation
     # @param [Object] path_suffix Value to be assigned
     def path_suffix=(path_suffix)
-      if !path_suffix.nil? && path_suffix.to_s.length > 100
-        fail ArgumentError, 'invalid value for "path_suffix", the character length must be smaller than or equal to 100.'
+      if !path_suffix.nil? && path_suffix.to_s.length > 27
+        fail ArgumentError, 'invalid value for "path_suffix", the character length must be smaller than or equal to 27.'
       end
 
-      if !path_suffix.nil? && path_suffix.to_s.length < 1
-        fail ArgumentError, 'invalid value for "path_suffix", the character length must be great than or equal to 1.'
+      if !path_suffix.nil? && path_suffix.to_s.length < 0
+        fail ArgumentError, 'invalid value for "path_suffix", the character length must be great than or equal to 0.'
       end
 
-      pattern = Regexp.new(/^(\/[\w-]+)+$/)
+      pattern = Regexp.new(/^(\/[\w-]+)+$|^$/)
       if !path_suffix.nil? && path_suffix !~ pattern
         fail ArgumentError, "invalid value for \"path_suffix\", must conform to the pattern #{pattern}."
       end

data/lib/pnap_network_storage_api/models/volume_update.rb

@@ -16,13 +16,25 @@ require 'time'
 module NetworkStorageApi
   # Update storage network volume.
   class VolumeUpdate
+    # Volume friendly name.
+    attr_accessor :name
+
+    # Volume description.
+    attr_accessor :description
+
     # Capacity of Volume in GB. Currently only whole numbers and multiples of 1000GB are supported.
     attr_accessor :capacity_in_gb
 
+    # Last part of volume's path.
+    attr_accessor :path_suffix
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'capacity_in_gb' => :'capacityInGb'
+        :'name' => :'name',
+        :'description' => :'description',
+        :'capacity_in_gb' => :'capacityInGb',
+        :'path_suffix' => :'pathSuffix'
       }
     end
 
@@ -34,7 +46,10 @@ module NetworkStorageApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'capacity_in_gb' => :'Integer'
+        :'name' => :'String',
+        :'description' => :'String',
+        :'capacity_in_gb' => :'Integer',
+        :'path_suffix' => :'String'
       }
     end
 
@@ -59,29 +74,96 @@ module NetworkStorageApi
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'capacity_in_gb')
         self.capacity_in_gb = attributes[:'capacity_in_gb']
       end
+
+      if attributes.key?(:'path_suffix')
+        self.path_suffix = attributes[:'path_suffix']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 250
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 250.')
+      end
+
       if !@capacity_in_gb.nil? && @capacity_in_gb < 2000
         invalid_properties.push('invalid value for "capacity_in_gb", must be greater than or equal to 2000.')
       end
 
+      if !@path_suffix.nil? && @path_suffix.to_s.length > 27
+        invalid_properties.push('invalid value for "path_suffix", the character length must be smaller than or equal to 27.')
+      end
+
+      if !@path_suffix.nil? && @path_suffix.to_s.length < 0
+        invalid_properties.push('invalid value for "path_suffix", the character length must be great than or equal to 0.')
+      end
+
+      pattern = Regexp.new(/^(\/[\w-]+)+$|^$/)
+      if !@path_suffix.nil? && @path_suffix !~ pattern
+        invalid_properties.push("invalid value for \"path_suffix\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@name.nil? && @name.to_s.length < 1
+      return false if !@description.nil? && @description.to_s.length > 250
       return false if !@capacity_in_gb.nil? && @capacity_in_gb < 2000
+      return false if !@path_suffix.nil? && @path_suffix.to_s.length > 27
+      return false if !@path_suffix.nil? && @path_suffix.to_s.length < 0
+      return false if !@path_suffix.nil? && @path_suffix !~ Regexp.new(/^(\/[\w-]+)+$|^$/)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      if !name.nil? && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 250
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 250.'
+      end
+
+      @description = description
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] capacity_in_gb Value to be assigned
     def capacity_in_gb=(capacity_in_gb)
@@ -92,12 +174,34 @@ module NetworkStorageApi
       @capacity_in_gb = capacity_in_gb
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] path_suffix Value to be assigned
+    def path_suffix=(path_suffix)
+      if !path_suffix.nil? && path_suffix.to_s.length > 27
+        fail ArgumentError, 'invalid value for "path_suffix", the character length must be smaller than or equal to 27.'
+      end
+
+      if !path_suffix.nil? && path_suffix.to_s.length < 0
+        fail ArgumentError, 'invalid value for "path_suffix", the character length must be great than or equal to 0.'
+      end
+
+      pattern = Regexp.new(/^(\/[\w-]+)+$|^$/)
+      if !path_suffix.nil? && path_suffix !~ pattern
+        fail ArgumentError, "invalid value for \"path_suffix\", must conform to the pattern #{pattern}."
+      end
+
+      @path_suffix = path_suffix
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          capacity_in_gb == o.capacity_in_gb
+          name == o.name &&
+          description == o.description &&
+          capacity_in_gb == o.capacity_in_gb &&
+          path_suffix == o.path_suffix
     end
 
     # @see the `==` method
@@ -109,7 +213,7 @@ module NetworkStorageApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [capacity_in_gb].hash
+      [name, description, capacity_in_gb, path_suffix].hash
     end
 
     # Builds the object from hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnap_network_storage_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - PhoenixNAP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -131,14 +131,14 @@ test_files:
 - spec/api/storage_networks_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/permissions_spec.rb
-- spec/models/storage_network_create_spec.rb
 - spec/models/volume_create_spec.rb
+- spec/models/permissions_spec.rb
+- spec/models/storage_network_update_spec.rb
 - spec/models/error_spec.rb
+- spec/models/volume_spec.rb
 - spec/models/storage_network_spec.rb
 - spec/models/nfs_permissions_spec.rb
 - spec/models/status_spec.rb
-- spec/models/volume_spec.rb
 - spec/models/volume_update_spec.rb
-- spec/models/storage_network_update_spec.rb
+- spec/models/storage_network_create_spec.rb
 - spec/spec_helper.rb