xbim_aim 2.0.0

data/lib/xbim_aim/models/attribute_definition.rb

@@ -0,0 +1,354 @@
+=begin
+#XBIM Flex API v2
+
+#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
+
+The version of the OpenAPI document: 2.0
+Contact: info@xbim.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module XbimAim
+  class AttributeDefinition
+    attr_accessor :full_name
+
+    attr_accessor :group_name
+
+    attr_accessor :group_type
+
+    attr_accessor :name
+
+    attr_accessor :canonical_name
+
+    attr_accessor :imported
+
+    attr_accessor :semantic_type
+
+    attr_accessor :unit
+
+    attr_accessor :data_type
+
+    attr_accessor :date_created
+
+    attr_accessor :date_modified
+
+    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
+      {
+        :'full_name' => :'FullName',
+        :'group_name' => :'GroupName',
+        :'group_type' => :'GroupType',
+        :'name' => :'Name',
+        :'canonical_name' => :'CanonicalName',
+        :'imported' => :'Imported',
+        :'semantic_type' => :'SemanticType',
+        :'unit' => :'Unit',
+        :'data_type' => :'DataType',
+        :'date_created' => :'DateCreated',
+        :'date_modified' => :'DateModified'
+      }
+    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
+      {
+        :'full_name' => :'String',
+        :'group_name' => :'String',
+        :'group_type' => :'String',
+        :'name' => :'String',
+        :'canonical_name' => :'String',
+        :'imported' => :'Boolean',
+        :'semantic_type' => :'String',
+        :'unit' => :'String',
+        :'data_type' => :'String',
+        :'date_created' => :'Time',
+        :'date_modified' => :'Time'
+      }
+    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 `XbimAim::AttributeDefinition` 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 `XbimAim::AttributeDefinition`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'group_type')
+        self.group_type = attributes[:'group_type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'canonical_name')
+        self.canonical_name = attributes[:'canonical_name']
+      end
+
+      if attributes.key?(:'imported')
+        self.imported = attributes[:'imported']
+      end
+
+      if attributes.key?(:'semantic_type')
+        self.semantic_type = attributes[:'semantic_type']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'data_type')
+        self.data_type = attributes[:'data_type']
+      end
+
+      if attributes.key?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      end
+
+      if attributes.key?(:'date_modified')
+        self.date_modified = attributes[:'date_modified']
+      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?
+      group_type_validator = EnumAttributeValidator.new('String', ["AimSystemAttribute", "Classification", "PsetAttribute", "UserAttribute", "QuantityAttribute", "DerivedAttribute", "RequiredAttribute", "Unknown"])
+      return false unless group_type_validator.valid?(@group_type)
+      data_type_validator = EnumAttributeValidator.new('String', ["Undefined", "NotNull", "Date", "Integer", "Real", "Logical", "Text"])
+      return false unless data_type_validator.valid?(@data_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] group_type Object to be assigned
+    def group_type=(group_type)
+      validator = EnumAttributeValidator.new('String', ["AimSystemAttribute", "Classification", "PsetAttribute", "UserAttribute", "QuantityAttribute", "DerivedAttribute", "RequiredAttribute", "Unknown"])
+      unless validator.valid?(group_type)
+        fail ArgumentError, "invalid value for \"group_type\", must be one of #{validator.allowable_values}."
+      end
+      @group_type = group_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] data_type Object to be assigned
+    def data_type=(data_type)
+      validator = EnumAttributeValidator.new('String', ["Undefined", "NotNull", "Date", "Integer", "Real", "Logical", "Text"])
+      unless validator.valid?(data_type)
+        fail ArgumentError, "invalid value for \"data_type\", must be one of #{validator.allowable_values}."
+      end
+      @data_type = data_type
+    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 &&
+          full_name == o.full_name &&
+          group_name == o.group_name &&
+          group_type == o.group_type &&
+          name == o.name &&
+          canonical_name == o.canonical_name &&
+          imported == o.imported &&
+          semantic_type == o.semantic_type &&
+          unit == o.unit &&
+          data_type == o.data_type &&
+          date_created == o.date_created &&
+          date_modified == o.date_modified
+    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
+      [full_name, group_name, group_type, name, canonical_name, imported, semantic_type, unit, data_type, date_created, date_modified].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)
+      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 = XbimAim.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/xbim_aim/models/attribute_definition_create.rb

@@ -0,0 +1,338 @@
+=begin
+#XBIM Flex API v2
+
+#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
+
+The version of the OpenAPI document: 2.0
+Contact: info@xbim.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module XbimAim
+  class AttributeDefinitionCreate
+    attr_accessor :asset_model_id
+
+    attr_accessor :name
+
+    attr_accessor :group_name
+
+    attr_accessor :group_type
+
+    attr_accessor :data_type
+
+    attr_accessor :semantic_type
+
+    attr_accessor :unit
+
+    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
+      {
+        :'asset_model_id' => :'AssetModelId',
+        :'name' => :'Name',
+        :'group_name' => :'GroupName',
+        :'group_type' => :'GroupType',
+        :'data_type' => :'DataType',
+        :'semantic_type' => :'SemanticType',
+        :'unit' => :'Unit'
+      }
+    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
+      {
+        :'asset_model_id' => :'Integer',
+        :'name' => :'String',
+        :'group_name' => :'String',
+        :'group_type' => :'String',
+        :'data_type' => :'String',
+        :'semantic_type' => :'String',
+        :'unit' => :'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 `XbimAim::AttributeDefinitionCreate` 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 `XbimAim::AttributeDefinitionCreate`. 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?(:'asset_model_id')
+        self.asset_model_id = attributes[:'asset_model_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'group_type')
+        self.group_type = attributes[:'group_type']
+      end
+
+      if attributes.key?(:'data_type')
+        self.data_type = attributes[:'data_type']
+      end
+
+      if attributes.key?(:'semantic_type')
+        self.semantic_type = attributes[:'semantic_type']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      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 @asset_model_id.nil?
+        invalid_properties.push('invalid value for "asset_model_id", asset_model_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @group_name.nil?
+        invalid_properties.push('invalid value for "group_name", group_name cannot be nil.')
+      end
+
+      if @data_type.nil?
+        invalid_properties.push('invalid value for "data_type", data_type cannot be nil.')
+      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 @asset_model_id.nil?
+      return false if @name.nil?
+      return false if @group_name.nil?
+      group_type_validator = EnumAttributeValidator.new('String', ["AimSystemAttribute", "Classification", "PsetAttribute", "UserAttribute", "QuantityAttribute", "DerivedAttribute", "RequiredAttribute", "Unknown"])
+      return false unless group_type_validator.valid?(@group_type)
+      return false if @data_type.nil?
+      data_type_validator = EnumAttributeValidator.new('String', ["Undefined", "NotNull", "Date", "Integer", "Real", "Logical", "Text"])
+      return false unless data_type_validator.valid?(@data_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] group_type Object to be assigned
+    def group_type=(group_type)
+      validator = EnumAttributeValidator.new('String', ["AimSystemAttribute", "Classification", "PsetAttribute", "UserAttribute", "QuantityAttribute", "DerivedAttribute", "RequiredAttribute", "Unknown"])
+      unless validator.valid?(group_type)
+        fail ArgumentError, "invalid value for \"group_type\", must be one of #{validator.allowable_values}."
+      end
+      @group_type = group_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] data_type Object to be assigned
+    def data_type=(data_type)
+      validator = EnumAttributeValidator.new('String', ["Undefined", "NotNull", "Date", "Integer", "Real", "Logical", "Text"])
+      unless validator.valid?(data_type)
+        fail ArgumentError, "invalid value for \"data_type\", must be one of #{validator.allowable_values}."
+      end
+      @data_type = data_type
+    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 &&
+          asset_model_id == o.asset_model_id &&
+          name == o.name &&
+          group_name == o.group_name &&
+          group_type == o.group_type &&
+          data_type == o.data_type &&
+          semantic_type == o.semantic_type &&
+          unit == o.unit
+    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
+      [asset_model_id, name, group_name, group_type, data_type, semantic_type, unit].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)
+      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 = XbimAim.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