pnap_bmc_api 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3841d9054027bca48af40d89d6657b3c049884b09835945414cd428c134a01d6
-  data.tar.gz: 231d9d1ca92bc9e44861c6f8f99d2ad797566ebfaa091b9aa7ce3fcf84980c15
+  metadata.gz: c963cbc0d6e9a73b1d20d9fc4ebdae4f26841905700f25cd1d4194b3f5389622
+  data.tar.gz: 2cdf867849e85e583276bc0403f3556eedc7bdc94d69fed2bbea52475d386a13
 SHA512:
-  metadata.gz: 28f2fb161b5fc678f8dcd89df2ced16da0608b84d028244de9bc259709d6b8c2aaef47add2fb228747973c35425eae612ed4df0733f9ed64170174351c9f6706
-  data.tar.gz: 51ac942559c3a31c27f4a7e343b9efac71e20b851efe6922a921f5735c11033de6e34e12219a216caab0cf55ab464f76c84458ee5ed5e7aa0b10e4cc5dbf6e2a
+  metadata.gz: 39130877d89b21a46619f58fc59549a9ff56f7d4d2f93f078c6bf13cb6a36619aab4f4cd544fc977c3ab1d7f294fa051aacaa30c56f903e4d95db2b6a4ca7808
+  data.tar.gz: ad7384db61dd6d4dd691b61b7f251c203dc106c92ffb75d95817c815e0113362a68486a6be92ccaa4ab7252c69ff9980559f5621e2ca215eea85fa8a5179f100

data/README.md

@@ -158,6 +158,7 @@ Class | Method | HTTP request | Description
  - [BmcApi::IpBlocksConfiguration](docs/IpBlocksConfiguration.md)
  - [BmcApi::NetworkConfiguration](docs/NetworkConfiguration.md)
  - [BmcApi::OsConfiguration](docs/OsConfiguration.md)
+ - [BmcApi::OsConfigurationCloudInit](docs/OsConfigurationCloudInit.md)
  - [BmcApi::OsConfigurationMap](docs/OsConfigurationMap.md)
  - [BmcApi::OsConfigurationMapEsxi](docs/OsConfigurationMapEsxi.md)
  - [BmcApi::OsConfigurationMapProxmox](docs/OsConfigurationMapProxmox.md)

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/docs/OsConfiguration.md

@@ -9,6 +9,7 @@
 | **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
 | **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
 | **install_os_to_ram** | **Boolean** | If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal. | [optional][default to false] |
+| **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) |  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = BmcApi::OsConfiguration.new(
   root_password: MyP@ssw0rd_01,
   management_ui_url: https://172.217.22.14,
   management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
-  install_os_to_ram: null
+  install_os_to_ram: null,
+  cloud_init: null
 )
 ```
 

data/docs/OsConfigurationCloudInit.md

@@ -0,0 +1,18 @@
+# BmcApi::OsConfigurationCloudInit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_data** | **String** | User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic and ubuntu/focal are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference. | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::OsConfigurationCloudInit.new(
+  user_data: null
+)
+```
+

data/lib/pnap_bmc_api/models/os_configuration.rb

@@ -30,6 +30,8 @@ module BmcApi
     # If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal.
     attr_accessor :install_os_to_ram
 
+    attr_accessor :cloud_init
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +39,8 @@ module BmcApi
         :'root_password' => :'rootPassword',
         :'management_ui_url' => :'managementUiUrl',
         :'management_access_allowed_ips' => :'managementAccessAllowedIps',
-        :'install_os_to_ram' => :'installOsToRam'
+        :'install_os_to_ram' => :'installOsToRam',
+        :'cloud_init' => :'cloudInit'
       }
     end
 
@@ -53,7 +56,8 @@ module BmcApi
         :'root_password' => :'String',
         :'management_ui_url' => :'String',
         :'management_access_allowed_ips' => :'Array<String>',
-        :'install_os_to_ram' => :'Boolean'
+        :'install_os_to_ram' => :'Boolean',
+        :'cloud_init' => :'OsConfigurationCloudInit'
       }
     end
 
@@ -101,6 +105,10 @@ module BmcApi
       else
         self.install_os_to_ram = false
       end
+
+      if attributes.key?(:'cloud_init')
+        self.cloud_init = attributes[:'cloud_init']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -140,7 +148,8 @@ module BmcApi
           root_password == o.root_password &&
           management_ui_url == o.management_ui_url &&
           management_access_allowed_ips == o.management_access_allowed_ips &&
-          install_os_to_ram == o.install_os_to_ram
+          install_os_to_ram == o.install_os_to_ram &&
+          cloud_init == o.cloud_init
     end
 
     # @see the `==` method
@@ -152,7 +161,7 @@ module BmcApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram].hash
+      [windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram, cloud_init].hash
     end
 
     # Builds the object from hash

data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb

@@ -0,0 +1,221 @@
+=begin
+#Bare Metal Cloud API
+
+#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.  Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more.  Manage your infrastructure more efficiently using just a few simple API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module BmcApi
+  # Cloud-init configuration details.
+  class OsConfigurationCloudInit
+    # User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic and ubuntu/focal are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference.
+    attr_accessor :user_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user_data' => :'userData'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'user_data' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BmcApi::OsConfigurationCloudInit` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `BmcApi::OsConfigurationCloudInit`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'user_data')
+        self.user_data = attributes[:'user_data']
+      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
+      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?
+      true
+    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 &&
+          user_data == o.user_data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [user_data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = BmcApi.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/pnap_bmc_api.rb

@@ -24,6 +24,7 @@ require 'pnap_bmc_api/models/error'
 require 'pnap_bmc_api/models/ip_blocks_configuration'
 require 'pnap_bmc_api/models/network_configuration'
 require 'pnap_bmc_api/models/os_configuration'
+require 'pnap_bmc_api/models/os_configuration_cloud_init'
 require 'pnap_bmc_api/models/os_configuration_map'
 require 'pnap_bmc_api/models/os_configuration_map_esxi'
 require 'pnap_bmc_api/models/os_configuration_map_proxmox'

data/spec/models/os_configuration_cloud_init_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#Bare Metal Cloud API
+
+#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.  Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more.  Manage your infrastructure more efficiently using just a few simple API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for BmcApi::OsConfigurationCloudInit
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe BmcApi::OsConfigurationCloudInit do
+  let(:instance) { BmcApi::OsConfigurationCloudInit.new }
+
+  describe 'test an instance of OsConfigurationCloudInit' do
+    it 'should create an instance of OsConfigurationCloudInit' do
+      expect(instance).to be_instance_of(BmcApi::OsConfigurationCloudInit)
+    end
+  end
+  describe 'test attribute "user_data"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnap_bmc_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - PhoenixNAP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -68,6 +68,7 @@ files:
 - docs/IpBlocksConfiguration.md
 - docs/NetworkConfiguration.md
 - docs/OsConfiguration.md
+- docs/OsConfigurationCloudInit.md
 - docs/OsConfigurationMap.md
 - docs/OsConfigurationMapEsxi.md
 - docs/OsConfigurationMapProxmox.md
@@ -110,6 +111,7 @@ files:
 - lib/pnap_bmc_api/models/ip_blocks_configuration.rb
 - lib/pnap_bmc_api/models/network_configuration.rb
 - lib/pnap_bmc_api/models/os_configuration.rb
+- lib/pnap_bmc_api/models/os_configuration_cloud_init.rb
 - lib/pnap_bmc_api/models/os_configuration_map.rb
 - lib/pnap_bmc_api/models/os_configuration_map_esxi.rb
 - lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb
@@ -148,6 +150,7 @@ files:
 - spec/models/error_spec.rb
 - spec/models/ip_blocks_configuration_spec.rb
 - spec/models/network_configuration_spec.rb
+- spec/models/os_configuration_cloud_init_spec.rb
 - spec/models/os_configuration_map_esxi_spec.rb
 - spec/models/os_configuration_map_proxmox_spec.rb
 - spec/models/os_configuration_map_spec.rb
@@ -195,46 +198,47 @@ 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: Bare Metal Cloud API Ruby Gem
 test_files:
-- spec/api/quotas_api_spec.rb
-- spec/api/servers_api_spec.rb
 - spec/api/ssh_keys_api_spec.rb
+- spec/api/servers_api_spec.rb
+- spec/api/quotas_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
+- spec/models/quota_edit_limit_request_details_all_of_spec.rb
+- spec/models/delete_result_spec.rb
+- spec/models/os_configuration_map_proxmox_spec.rb
+- spec/models/server_reset_spec.rb
+- spec/models/server_create_spec.rb
+- spec/models/public_network_configuration_spec.rb
 - spec/models/ssh_key_create_spec.rb
-- spec/models/network_configuration_spec.rb
-- spec/models/server_spec.rb
+- spec/models/os_configuration_windows_spec.rb
+- spec/models/tag_assignment_request_spec.rb
+- spec/models/quota_edit_limit_request_details_spec.rb
+- spec/models/quota_spec.rb
+- spec/models/relinquish_ip_block_spec.rb
+- spec/models/ssh_key_spec.rb
+- spec/models/os_configuration_spec.rb
 - spec/models/quota_edit_limit_request_spec.rb
+- spec/models/server_private_network_spec.rb
+- spec/models/os_configuration_map_spec.rb
+- spec/models/error_spec.rb
 - spec/models/os_configuration_map_esxi_spec.rb
 - spec/models/ssh_key_update_spec.rb
-- spec/models/public_network_configuration_spec.rb
+- spec/models/server_reserve_spec.rb
+- spec/models/os_configuration_cloud_init_spec.rb
+- spec/models/tag_assignment_spec.rb
+- spec/models/server_spec.rb
 - spec/models/action_result_spec.rb
-- spec/models/quota_edit_limit_request_details_spec.rb
-- spec/models/server_reset_spec.rb
-- spec/models/os_configuration_map_proxmox_spec.rb
-- spec/models/server_ip_block_spec.rb
+- spec/models/server_patch_spec.rb
+- spec/models/network_configuration_spec.rb
 - spec/models/ip_blocks_configuration_spec.rb
-- spec/models/error_spec.rb
-- spec/models/delete_result_spec.rb
-- spec/models/tag_assignment_request_spec.rb
-- spec/models/ssh_key_spec.rb
-- spec/models/tag_assignment_spec.rb
-- spec/models/quota_edit_limit_request_details_all_of_spec.rb
-- spec/models/server_reserve_spec.rb
-- spec/models/reset_result_spec.rb
-- spec/models/server_private_network_spec.rb
-- spec/models/server_create_spec.rb
-- spec/models/os_configuration_map_spec.rb
-- spec/models/os_configuration_spec.rb
-- spec/models/quota_spec.rb
+- spec/models/server_public_network_spec.rb
+- spec/models/server_ip_block_spec.rb
 - spec/models/private_network_configuration_spec.rb
 - spec/models/delete_ssh_key_result_spec.rb
-- spec/models/server_public_network_spec.rb
-- spec/models/relinquish_ip_block_spec.rb
-- spec/models/server_patch_spec.rb
-- spec/models/os_configuration_windows_spec.rb
+- spec/models/reset_result_spec.rb
 - spec/spec_helper.rb