katapult-ruby 0.0.4 → 0.0.5

data/lib/katapult-ruby/models/infrastructure_dns_zone_cannot_be_edited_enum.rb

@@ -0,0 +1,39 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  class InfrastructureDNSZoneCannotBeEditedEnum
+    INFRASTRUCTURE_DNS_ZONE_CANNOT_BE_EDITED = "infrastructure_dns_zone_cannot_be_edited".freeze
+
+    def self.all_vars
+      @all_vars ||= [INFRASTRUCTURE_DNS_ZONE_CANNOT_BE_EDITED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if InfrastructureDNSZoneCannotBeEditedEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InfrastructureDNSZoneCannotBeEditedEnum"
+    end
+  end
+end

data/lib/katapult-ruby/models/{infrastructure_dns_zone_cannot_be_edited_response.rb → infrastructure_dns_zone_cannot_be_edited_schema.rb}

@@ -15,7 +15,7 @@ require 'time'
 
 module KatapultAPI
   # Infrastructure DNS zones cannot be edited through the API. These are managed exclusively by Katapult.
-  class InfrastructureDNSZoneCannotBeEditedResponse
+  class InfrastructureDNSZoneCannotBeEditedSchema
     attr_accessor :code
 
     attr_accessor :description
@@ -61,7 +61,7 @@ module KatapultAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'code' => :'String',
+        :'code' => :'InfrastructureDNSZoneCannotBeEditedEnum',
         :'description' => :'String',
         :'detail' => :'Object'
       }
@@ -77,13 +77,13 @@ module KatapultAPI
     # @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 `KatapultAPI::InfrastructureDNSZoneCannotBeEditedResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KatapultAPI::InfrastructureDNSZoneCannotBeEditedSchema` 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 `KatapultAPI::InfrastructureDNSZoneCannotBeEditedResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KatapultAPI::InfrastructureDNSZoneCannotBeEditedSchema`. 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
       }
@@ -113,21 +113,9 @@ module KatapultAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["infrastructure_dns_zone_cannot_be_edited"])
-      return false unless code_validator.valid?(@code)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] code Object to be assigned
-    def code=(code)
-      validator = EnumAttributeValidator.new('String', ["infrastructure_dns_zone_cannot_be_edited"])
-      unless validator.valid?(code)
-        fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
-      end
-      @code = code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/katapult-ruby/models/interface_not_found_enum.rb

@@ -0,0 +1,39 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  class InterfaceNotFoundEnum
+    INTERFACE_NOT_FOUND = "interface_not_found".freeze
+
+    def self.all_vars
+      @all_vars ||= [INTERFACE_NOT_FOUND].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if InterfaceNotFoundEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InterfaceNotFoundEnum"
+    end
+  end
+end

data/lib/katapult-ruby/models/{network_not_found_response.rb → interface_not_found_schema.rb}

@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module KatapultAPI
-  # No network was found matching any of the criteria provided in the arguments
-  class NetworkNotFoundResponse
+  # An interface could not be found for the specified network
+  class InterfaceNotFoundSchema
     attr_accessor :code
 
     attr_accessor :description
@@ -61,7 +61,7 @@ module KatapultAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'code' => :'String',
+        :'code' => :'InterfaceNotFoundEnum',
         :'description' => :'String',
         :'detail' => :'Object'
       }
@@ -77,13 +77,13 @@ module KatapultAPI
     # @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 `KatapultAPI::NetworkNotFoundResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KatapultAPI::InterfaceNotFoundSchema` 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 `KatapultAPI::NetworkNotFoundResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KatapultAPI::InterfaceNotFoundSchema`. 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
       }
@@ -113,21 +113,9 @@ module KatapultAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["network_not_found"])
-      return false unless code_validator.valid?(@code)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] code Object to be assigned
-    def code=(code)
-      validator = EnumAttributeValidator.new('String', ["network_not_found"])
-      unless validator.valid?(code)
-        fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
-      end
-      @code = code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/katapult-ruby/models/invalid_api_token_enum.rb

@@ -0,0 +1,39 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  class InvalidAPITokenEnum
+    INVALID_API_TOKEN = "invalid_api_token".freeze
+
+    def self.all_vars
+      @all_vars ||= [INVALID_API_TOKEN].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if InvalidAPITokenEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InvalidAPITokenEnum"
+    end
+  end
+end

data/lib/katapult-ruby/models/{invalid_api_token_response.rb → invalid_api_token_schema.rb}

@@ -15,7 +15,7 @@ require 'time'
 
 module KatapultAPI
   # The API token provided was not valid (it may not exist or have expired)
-  class InvalidAPITokenResponse
+  class InvalidAPITokenSchema
     attr_accessor :code
 
     attr_accessor :description
@@ -61,7 +61,7 @@ module KatapultAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'code' => :'String',
+        :'code' => :'InvalidAPITokenEnum',
         :'description' => :'String',
         :'detail' => :'InvalidAPIToken'
       }
@@ -77,13 +77,13 @@ module KatapultAPI
     # @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 `KatapultAPI::InvalidAPITokenResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KatapultAPI::InvalidAPITokenSchema` 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 `KatapultAPI::InvalidAPITokenResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KatapultAPI::InvalidAPITokenSchema`. 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
       }
@@ -113,21 +113,9 @@ module KatapultAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["invalid_api_token"])
-      return false unless code_validator.valid?(@code)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] code Object to be assigned
-    def code=(code)
-      validator = EnumAttributeValidator.new('String', ["invalid_api_token"])
-      unless validator.valid?(code)
-        fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
-      end
-      @code = code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/katapult-ruby/models/invalid_ip_enum.rb

@@ -0,0 +1,39 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  class InvalidIPEnum
+    INVALID_IP = "invalid_ip".freeze
+
+    def self.all_vars
+      @all_vars ||= [INVALID_IP].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if InvalidIPEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InvalidIPEnum"
+    end
+  end
+end

data/lib/katapult-ruby/models/{invalid_ip_response.rb → invalid_ip_schema.rb}

@@ -15,7 +15,7 @@ require 'time'
 
 module KatapultAPI
   # This IP address is not valid for this network interface.
-  class InvalidIPResponse
+  class InvalidIPSchema
     attr_accessor :code
 
     attr_accessor :description
@@ -61,7 +61,7 @@ module KatapultAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'code' => :'String',
+        :'code' => :'InvalidIPEnum',
         :'description' => :'String',
         :'detail' => :'Object'
       }
@@ -77,13 +77,13 @@ module KatapultAPI
     # @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 `KatapultAPI::InvalidIPResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KatapultAPI::InvalidIPSchema` 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 `KatapultAPI::InvalidIPResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KatapultAPI::InvalidIPSchema`. 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
       }
@@ -113,21 +113,9 @@ module KatapultAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      code_validator = EnumAttributeValidator.new('String', ["invalid_ip"])
-      return false unless code_validator.valid?(@code)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] code Object to be assigned
-    def code=(code)
-      validator = EnumAttributeValidator.new('String', ["invalid_ip"])
-      unless validator.valid?(code)
-        fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
-      end
-      @code = code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/katapult-ruby/models/invalid_spec_xml_enum.rb

@@ -0,0 +1,39 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  class InvalidSpecXMLEnum
+    INVALID_SPEC_XML = "invalid_spec_xml".freeze
+
+    def self.all_vars
+      @all_vars ||= [INVALID_SPEC_XML].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if InvalidSpecXMLEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InvalidSpecXMLEnum"
+    end
+  end
+end

data/lib/katapult-ruby/models/invalid_spec_xml_schema.rb

@@ -0,0 +1,255 @@
+=begin
+#Katapult Core API
+
+#Welcome to the documentation for the Katapult Core API
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KatapultAPI
+  # The spec XML provided is invalid
+  class InvalidSpecXMLSchema
+    attr_accessor :code
+
+    attr_accessor :description
+
+    attr_accessor :detail
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'description' => :'description',
+        :'detail' => :'detail'
+      }
+    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
+      {
+        :'code' => :'InvalidSpecXMLEnum',
+        :'description' => :'String',
+        :'detail' => :'InvalidSpecXML'
+      }
+    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 `KatapultAPI::InvalidSpecXMLSchema` 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 `KatapultAPI::InvalidSpecXMLSchema`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          code == o.code &&
+          description == o.description &&
+          detail == o.detail
+    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
+      [code, description, detail].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = KatapultAPI.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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