xbim_aim 2.0.0

data/lib/xbim_aim/models/document_create.rb

@@ -0,0 +1,345 @@
+=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
+  # Represents a new document.  This is an simplification of the IfcDocumentInformation and IfcDocumentReference concepts.  See https://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ifcexternalreferenceresource/lexical/ifcdocumentinformation.htm
+  class DocumentCreate
+    # The Url of the document. Prefer Location over setting the URL
+    attr_accessor :url
+
+    # Location, where the external source (classification, document or library).   For externally hosted documents normally given as an URL location string. For documents hosted in Flex, use the value 'Flex',   and provide the Flex 'fileId' in the Item Reference
+    attr_accessor :location
+
+    # Identifier for the referenced item in the external source (classification, document or library)  For documents hosted in Flex this should be the fileId
+    attr_accessor :item_reference
+
+    # Scope for this document.
+    attr_accessor :scope
+
+    # Document revision designation
+    attr_accessor :revision
+
+    # Purpose for this document.
+    attr_accessor :purpose
+
+    # Intended Use for this document.
+    attr_accessor :intended_use
+
+    # The identifier of the Model this entity belongs to
+    attr_accessor :asset_model_id
+
+    # Gets or sets the entity identifier / Label.
+    attr_accessor :entity_id
+
+    # The immutable unique identifier key for this Entity
+    attr_accessor :external_identifier
+
+    # The name of the entity
+    attr_accessor :name
+
+    # Optional Description of the document
+    attr_accessor :description
+
+    # A system identifier of the type of entity
+    attr_accessor :external_object_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url',
+        :'location' => :'Location',
+        :'item_reference' => :'ItemReference',
+        :'scope' => :'Scope',
+        :'revision' => :'Revision',
+        :'purpose' => :'Purpose',
+        :'intended_use' => :'IntendedUse',
+        :'asset_model_id' => :'AssetModelId',
+        :'entity_id' => :'EntityId',
+        :'external_identifier' => :'ExternalIdentifier',
+        :'name' => :'Name',
+        :'description' => :'Description',
+        :'external_object_type' => :'ExternalObjectType'
+      }
+    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
+      {
+        :'url' => :'String',
+        :'location' => :'String',
+        :'item_reference' => :'String',
+        :'scope' => :'String',
+        :'revision' => :'String',
+        :'purpose' => :'String',
+        :'intended_use' => :'String',
+        :'asset_model_id' => :'Integer',
+        :'entity_id' => :'Integer',
+        :'external_identifier' => :'String',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'external_object_type' => :'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::DocumentCreate` 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::DocumentCreate`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'item_reference')
+        self.item_reference = attributes[:'item_reference']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      end
+
+      if attributes.key?(:'purpose')
+        self.purpose = attributes[:'purpose']
+      end
+
+      if attributes.key?(:'intended_use')
+        self.intended_use = attributes[:'intended_use']
+      end
+
+      if attributes.key?(:'asset_model_id')
+        self.asset_model_id = attributes[:'asset_model_id']
+      end
+
+      if attributes.key?(:'entity_id')
+        self.entity_id = attributes[:'entity_id']
+      end
+
+      if attributes.key?(:'external_identifier')
+        self.external_identifier = attributes[:'external_identifier']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'external_object_type')
+        self.external_object_type = attributes[:'external_object_type']
+      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
+
+      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?
+      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 &&
+          url == o.url &&
+          location == o.location &&
+          item_reference == o.item_reference &&
+          scope == o.scope &&
+          revision == o.revision &&
+          purpose == o.purpose &&
+          intended_use == o.intended_use &&
+          asset_model_id == o.asset_model_id &&
+          entity_id == o.entity_id &&
+          external_identifier == o.external_identifier &&
+          name == o.name &&
+          description == o.description &&
+          external_object_type == o.external_object_type
+    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
+      [url, location, item_reference, scope, revision, purpose, intended_use, asset_model_id, entity_id, external_identifier, name, description, external_object_type].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/document_edit.rb

@@ -0,0 +1,310 @@
+=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
+  # Represents an edit to a document.   This is an simplification of the IfcDocumentInformation and IfcDocumentReference concepts.  See https://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ifcexternalreferenceresource/lexical/ifcdocumentinformation.htm
+  class DocumentEdit
+    # The Url of the document. Prefer Location over setting the URL
+    attr_accessor :url
+
+    # Location, where the external source (classification, document or library).   For externally hosted documents normally given as an URL location string. For documents hosted in Flex, use the value 'Flex',   and provide the Flex 'fileId' in the Item Reference
+    attr_accessor :location
+
+    # Identifier for the referenced item in the external source (classification, document or library)  For documents hosted in Flex this should be the fileId
+    attr_accessor :item_reference
+
+    # Scope for this document.
+    attr_accessor :scope
+
+    # Document revision designation
+    attr_accessor :revision
+
+    # Purpose for this document.
+    attr_accessor :purpose
+
+    # Intended Use for this document.
+    attr_accessor :intended_use
+
+    # The name of the entity
+    attr_accessor :name
+
+    # Optional Description of the document
+    attr_accessor :description
+
+    # A system identifier of the type of entity
+    attr_accessor :external_object_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url',
+        :'location' => :'Location',
+        :'item_reference' => :'ItemReference',
+        :'scope' => :'Scope',
+        :'revision' => :'Revision',
+        :'purpose' => :'Purpose',
+        :'intended_use' => :'IntendedUse',
+        :'name' => :'Name',
+        :'description' => :'Description',
+        :'external_object_type' => :'ExternalObjectType'
+      }
+    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
+      {
+        :'url' => :'String',
+        :'location' => :'String',
+        :'item_reference' => :'String',
+        :'scope' => :'String',
+        :'revision' => :'String',
+        :'purpose' => :'String',
+        :'intended_use' => :'String',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'external_object_type' => :'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::DocumentEdit` 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::DocumentEdit`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'item_reference')
+        self.item_reference = attributes[:'item_reference']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      end
+
+      if attributes.key?(:'purpose')
+        self.purpose = attributes[:'purpose']
+      end
+
+      if attributes.key?(:'intended_use')
+        self.intended_use = attributes[:'intended_use']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'external_object_type')
+        self.external_object_type = attributes[:'external_object_type']
+      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 &&
+          url == o.url &&
+          location == o.location &&
+          item_reference == o.item_reference &&
+          scope == o.scope &&
+          revision == o.revision &&
+          purpose == o.purpose &&
+          intended_use == o.intended_use &&
+          name == o.name &&
+          description == o.description &&
+          external_object_type == o.external_object_type
+    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
+      [url, location, item_reference, scope, revision, purpose, intended_use, name, description, external_object_type].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