xbim_aim 2.0.0

data/lib/xbim_aim/models/model.rb

@@ -0,0 +1,617 @@
+=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 Model
+    attr_accessor :entities
+
+    # See #/definitions/Asset
+    attr_accessor :asset
+
+    # See #/definitions/AssetSegment
+    attr_accessor :segment
+
+    attr_accessor :attribute_definitions
+
+    attr_accessor :spaces
+
+    attr_accessor :components
+
+    attr_accessor :component_types
+
+    attr_accessor :levels
+
+    attr_accessor :zones
+
+    attr_accessor :facilities
+
+    attr_accessor :documents
+
+    attr_accessor :contacts
+
+    attr_accessor :sites
+
+    attr_accessor :applications
+
+    attr_accessor :forward_mappings
+
+    attr_accessor :reverse_mappings
+
+    attr_accessor :roles
+
+    attr_accessor :permissions
+
+    attr_accessor :state
+
+    attr_accessor :asset_model_id
+
+    attr_accessor :asset_id
+
+    attr_accessor :name
+
+    attr_accessor :revision
+
+    attr_accessor :status
+
+    attr_accessor :is_current
+
+    attr_accessor :uploaded_by_id
+
+    attr_accessor :segment_name
+
+    attr_accessor :segment_id
+
+    attr_accessor :asset_name
+
+    attr_accessor :model_path
+
+    attr_accessor :model_size
+
+    attr_accessor :one_meter
+
+    attr_accessor :original_author_id
+
+    attr_accessor :date_uploaded
+
+    attr_accessor :date_processed
+
+    attr_accessor :last_entity_id
+
+    attr_accessor :processing_stage
+
+    attr_accessor :processing_status
+
+    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
+      {
+        :'entities' => :'Entities',
+        :'asset' => :'Asset',
+        :'segment' => :'Segment',
+        :'attribute_definitions' => :'AttributeDefinitions',
+        :'spaces' => :'Spaces',
+        :'components' => :'Components',
+        :'component_types' => :'ComponentTypes',
+        :'levels' => :'Levels',
+        :'zones' => :'Zones',
+        :'facilities' => :'Facilities',
+        :'documents' => :'Documents',
+        :'contacts' => :'Contacts',
+        :'sites' => :'Sites',
+        :'applications' => :'Applications',
+        :'forward_mappings' => :'ForwardMappings',
+        :'reverse_mappings' => :'ReverseMappings',
+        :'roles' => :'Roles',
+        :'permissions' => :'Permissions',
+        :'state' => :'State',
+        :'asset_model_id' => :'AssetModelId',
+        :'asset_id' => :'AssetId',
+        :'name' => :'Name',
+        :'revision' => :'Revision',
+        :'status' => :'Status',
+        :'is_current' => :'IsCurrent',
+        :'uploaded_by_id' => :'UploadedById',
+        :'segment_name' => :'SegmentName',
+        :'segment_id' => :'SegmentId',
+        :'asset_name' => :'AssetName',
+        :'model_path' => :'ModelPath',
+        :'model_size' => :'ModelSize',
+        :'one_meter' => :'OneMeter',
+        :'original_author_id' => :'OriginalAuthorId',
+        :'date_uploaded' => :'DateUploaded',
+        :'date_processed' => :'DateProcessed',
+        :'last_entity_id' => :'LastEntityId',
+        :'processing_stage' => :'ProcessingStage',
+        :'processing_status' => :'ProcessingStatus'
+      }
+    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
+      {
+        :'entities' => :'Array<Object>',
+        :'asset' => :'Object',
+        :'segment' => :'Object',
+        :'attribute_definitions' => :'Array<AttributeDefinitionEntity>',
+        :'spaces' => :'Array<Object>',
+        :'components' => :'Array<Object>',
+        :'component_types' => :'Array<Object>',
+        :'levels' => :'Array<Object>',
+        :'zones' => :'Array<Object>',
+        :'facilities' => :'Array<Object>',
+        :'documents' => :'Array<Object>',
+        :'contacts' => :'Array<Object>',
+        :'sites' => :'Array<Object>',
+        :'applications' => :'Array<Application>',
+        :'forward_mappings' => :'Array<ModelMapping>',
+        :'reverse_mappings' => :'Array<ModelMapping>',
+        :'roles' => :'Array<Role>',
+        :'permissions' => :'UserPermissions',
+        :'state' => :'String',
+        :'asset_model_id' => :'Integer',
+        :'asset_id' => :'Integer',
+        :'name' => :'String',
+        :'revision' => :'String',
+        :'status' => :'String',
+        :'is_current' => :'Boolean',
+        :'uploaded_by_id' => :'String',
+        :'segment_name' => :'String',
+        :'segment_id' => :'String',
+        :'asset_name' => :'String',
+        :'model_path' => :'String',
+        :'model_size' => :'Integer',
+        :'one_meter' => :'Float',
+        :'original_author_id' => :'Integer',
+        :'date_uploaded' => :'Time',
+        :'date_processed' => :'Time',
+        :'last_entity_id' => :'Integer',
+        :'processing_stage' => :'String',
+        :'processing_status' => :'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::Model` 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::Model`. 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?(:'entities')
+        if (value = attributes[:'entities']).is_a?(Array)
+          self.entities = value
+        end
+      end
+
+      if attributes.key?(:'asset')
+        self.asset = attributes[:'asset']
+      end
+
+      if attributes.key?(:'segment')
+        self.segment = attributes[:'segment']
+      end
+
+      if attributes.key?(:'attribute_definitions')
+        if (value = attributes[:'attribute_definitions']).is_a?(Array)
+          self.attribute_definitions = value
+        end
+      end
+
+      if attributes.key?(:'spaces')
+        if (value = attributes[:'spaces']).is_a?(Array)
+          self.spaces = value
+        end
+      end
+
+      if attributes.key?(:'components')
+        if (value = attributes[:'components']).is_a?(Array)
+          self.components = value
+        end
+      end
+
+      if attributes.key?(:'component_types')
+        if (value = attributes[:'component_types']).is_a?(Array)
+          self.component_types = value
+        end
+      end
+
+      if attributes.key?(:'levels')
+        if (value = attributes[:'levels']).is_a?(Array)
+          self.levels = value
+        end
+      end
+
+      if attributes.key?(:'zones')
+        if (value = attributes[:'zones']).is_a?(Array)
+          self.zones = value
+        end
+      end
+
+      if attributes.key?(:'facilities')
+        if (value = attributes[:'facilities']).is_a?(Array)
+          self.facilities = value
+        end
+      end
+
+      if attributes.key?(:'documents')
+        if (value = attributes[:'documents']).is_a?(Array)
+          self.documents = value
+        end
+      end
+
+      if attributes.key?(:'contacts')
+        if (value = attributes[:'contacts']).is_a?(Array)
+          self.contacts = value
+        end
+      end
+
+      if attributes.key?(:'sites')
+        if (value = attributes[:'sites']).is_a?(Array)
+          self.sites = value
+        end
+      end
+
+      if attributes.key?(:'applications')
+        if (value = attributes[:'applications']).is_a?(Array)
+          self.applications = value
+        end
+      end
+
+      if attributes.key?(:'forward_mappings')
+        if (value = attributes[:'forward_mappings']).is_a?(Array)
+          self.forward_mappings = value
+        end
+      end
+
+      if attributes.key?(:'reverse_mappings')
+        if (value = attributes[:'reverse_mappings']).is_a?(Array)
+          self.reverse_mappings = value
+        end
+      end
+
+      if attributes.key?(:'roles')
+        if (value = attributes[:'roles']).is_a?(Array)
+          self.roles = value
+        end
+      end
+
+      if attributes.key?(:'permissions')
+        self.permissions = attributes[:'permissions']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'asset_model_id')
+        self.asset_model_id = attributes[:'asset_model_id']
+      end
+
+      if attributes.key?(:'asset_id')
+        self.asset_id = attributes[:'asset_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'is_current')
+        self.is_current = attributes[:'is_current']
+      end
+
+      if attributes.key?(:'uploaded_by_id')
+        self.uploaded_by_id = attributes[:'uploaded_by_id']
+      end
+
+      if attributes.key?(:'segment_name')
+        self.segment_name = attributes[:'segment_name']
+      end
+
+      if attributes.key?(:'segment_id')
+        self.segment_id = attributes[:'segment_id']
+      end
+
+      if attributes.key?(:'asset_name')
+        self.asset_name = attributes[:'asset_name']
+      end
+
+      if attributes.key?(:'model_path')
+        self.model_path = attributes[:'model_path']
+      end
+
+      if attributes.key?(:'model_size')
+        self.model_size = attributes[:'model_size']
+      end
+
+      if attributes.key?(:'one_meter')
+        self.one_meter = attributes[:'one_meter']
+      end
+
+      if attributes.key?(:'original_author_id')
+        self.original_author_id = attributes[:'original_author_id']
+      end
+
+      if attributes.key?(:'date_uploaded')
+        self.date_uploaded = attributes[:'date_uploaded']
+      end
+
+      if attributes.key?(:'date_processed')
+        self.date_processed = attributes[:'date_processed']
+      end
+
+      if attributes.key?(:'last_entity_id')
+        self.last_entity_id = attributes[:'last_entity_id']
+      end
+
+      if attributes.key?(:'processing_stage')
+        self.processing_stage = attributes[:'processing_stage']
+      end
+
+      if attributes.key?(:'processing_status')
+        self.processing_status = attributes[:'processing_status']
+      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?
+      state_validator = EnumAttributeValidator.new('String', ["Active", "Hidden", "Archived"])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["Active", "Hidden", "Archived"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          entities == o.entities &&
+          asset == o.asset &&
+          segment == o.segment &&
+          attribute_definitions == o.attribute_definitions &&
+          spaces == o.spaces &&
+          components == o.components &&
+          component_types == o.component_types &&
+          levels == o.levels &&
+          zones == o.zones &&
+          facilities == o.facilities &&
+          documents == o.documents &&
+          contacts == o.contacts &&
+          sites == o.sites &&
+          applications == o.applications &&
+          forward_mappings == o.forward_mappings &&
+          reverse_mappings == o.reverse_mappings &&
+          roles == o.roles &&
+          permissions == o.permissions &&
+          state == o.state &&
+          asset_model_id == o.asset_model_id &&
+          asset_id == o.asset_id &&
+          name == o.name &&
+          revision == o.revision &&
+          status == o.status &&
+          is_current == o.is_current &&
+          uploaded_by_id == o.uploaded_by_id &&
+          segment_name == o.segment_name &&
+          segment_id == o.segment_id &&
+          asset_name == o.asset_name &&
+          model_path == o.model_path &&
+          model_size == o.model_size &&
+          one_meter == o.one_meter &&
+          original_author_id == o.original_author_id &&
+          date_uploaded == o.date_uploaded &&
+          date_processed == o.date_processed &&
+          last_entity_id == o.last_entity_id &&
+          processing_stage == o.processing_stage &&
+          processing_status == o.processing_status
+    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
+      [entities, asset, segment, attribute_definitions, spaces, components, component_types, levels, zones, facilities, documents, contacts, sites, applications, forward_mappings, reverse_mappings, roles, permissions, state, asset_model_id, asset_id, name, revision, status, is_current, uploaded_by_id, segment_name, segment_id, asset_name, model_path, model_size, one_meter, original_author_id, date_uploaded, date_processed, last_entity_id, processing_stage, processing_status].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