xbim_comms 2.0.0

data/lib/xbim_comms/models/viewpoint.rb

@@ -0,0 +1,296 @@
+=begin
+#Flex Comms API 2.0
+
+#Communication centralised around construction data
+
+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 XbimComms
+  class Viewpoint
+    attr_accessor :index
+
+    attr_accessor :guid
+
+    attr_accessor :orthogonal_camera
+
+    attr_accessor :perspective_camera
+
+    attr_accessor :lines
+
+    attr_accessor :clipping_planes
+
+    attr_accessor :bitmaps
+
+    attr_accessor :snapshot
+
+    attr_accessor :components
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'index' => :'index',
+        :'guid' => :'guid',
+        :'orthogonal_camera' => :'orthogonal_camera',
+        :'perspective_camera' => :'perspective_camera',
+        :'lines' => :'lines',
+        :'clipping_planes' => :'clipping_planes',
+        :'bitmaps' => :'bitmaps',
+        :'snapshot' => :'snapshot',
+        :'components' => :'components'
+      }
+    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
+      {
+        :'index' => :'Integer',
+        :'guid' => :'String',
+        :'orthogonal_camera' => :'OrthogonalCamera',
+        :'perspective_camera' => :'PerspectiveCamera',
+        :'lines' => :'Array<Line>',
+        :'clipping_planes' => :'Array<ClippingPlane>',
+        :'bitmaps' => :'Array<Bitmap>',
+        :'snapshot' => :'Snapshot',
+        :'components' => :'Components'
+      }
+    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 `XbimComms::Viewpoint` 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 `XbimComms::Viewpoint`. 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?(:'index')
+        self.index = attributes[:'index']
+      end
+
+      if attributes.key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.key?(:'orthogonal_camera')
+        self.orthogonal_camera = attributes[:'orthogonal_camera']
+      end
+
+      if attributes.key?(:'perspective_camera')
+        self.perspective_camera = attributes[:'perspective_camera']
+      end
+
+      if attributes.key?(:'lines')
+        if (value = attributes[:'lines']).is_a?(Array)
+          self.lines = value
+        end
+      end
+
+      if attributes.key?(:'clipping_planes')
+        if (value = attributes[:'clipping_planes']).is_a?(Array)
+          self.clipping_planes = value
+        end
+      end
+
+      if attributes.key?(:'bitmaps')
+        if (value = attributes[:'bitmaps']).is_a?(Array)
+          self.bitmaps = value
+        end
+      end
+
+      if attributes.key?(:'snapshot')
+        self.snapshot = attributes[:'snapshot']
+      end
+
+      if attributes.key?(:'components')
+        self.components = attributes[:'components']
+      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 &&
+          index == o.index &&
+          guid == o.guid &&
+          orthogonal_camera == o.orthogonal_camera &&
+          perspective_camera == o.perspective_camera &&
+          lines == o.lines &&
+          clipping_planes == o.clipping_planes &&
+          bitmaps == o.bitmaps &&
+          snapshot == o.snapshot &&
+          components == o.components
+    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
+      [index, guid, orthogonal_camera, perspective_camera, lines, clipping_planes, bitmaps, snapshot, components].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 = XbimComms.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_comms/models/visibility.rb

@@ -0,0 +1,238 @@
+=begin
+#Flex Comms API 2.0
+
+#Communication centralised around construction data
+
+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 XbimComms
+  class Visibility
+    attr_accessor :default_visibility
+
+    attr_accessor :view_setup_hints
+
+    attr_accessor :exceptions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'default_visibility' => :'default_visibility',
+        :'view_setup_hints' => :'view_setup_hints',
+        :'exceptions' => :'exceptions'
+      }
+    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
+      {
+        :'default_visibility' => :'Boolean',
+        :'view_setup_hints' => :'ViewSetupHints',
+        :'exceptions' => :'Array<Component>'
+      }
+    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 `XbimComms::Visibility` 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 `XbimComms::Visibility`. 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?(:'default_visibility')
+        self.default_visibility = attributes[:'default_visibility']
+      end
+
+      if attributes.key?(:'view_setup_hints')
+        self.view_setup_hints = attributes[:'view_setup_hints']
+      end
+
+      if attributes.key?(:'exceptions')
+        if (value = attributes[:'exceptions']).is_a?(Array)
+          self.exceptions = value
+        end
+      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 &&
+          default_visibility == o.default_visibility &&
+          view_setup_hints == o.view_setup_hints &&
+          exceptions == o.exceptions
+    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
+      [default_visibility, view_setup_hints, exceptions].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 = XbimComms.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_comms/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Flex Comms API 2.0
+
+#Communication centralised around construction data
+
+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
+
+module XbimComms
+  VERSION = '2.0.0'
+end

data/lib/xbim_comms.rb

@@ -0,0 +1,104 @@
+=begin
+#Flex Comms API 2.0
+
+#Communication centralised around construction data
+
+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
+
+# Common files
+require 'xbim_comms/api_client'
+require 'xbim_comms/api_error'
+require 'xbim_comms/version'
+require 'xbim_comms/configuration'
+
+# Models
+require 'xbim_comms/models/aggregate'
+require 'xbim_comms/models/aggregate_list_value'
+require 'xbim_comms/models/analytical_result_all_of'
+require 'xbim_comms/models/animation_all_of'
+require 'xbim_comms/models/bitmap'
+require 'xbim_comms/models/blob'
+require 'xbim_comms/models/boolean_value'
+require 'xbim_comms/models/clipping_plane'
+require 'xbim_comms/models/coloring'
+require 'xbim_comms/models/column_request'
+require 'xbim_comms/models/component'
+require 'xbim_comms/models/components'
+require 'xbim_comms/models/contact'
+require 'xbim_comms/models/contact_list'
+require 'xbim_comms/models/conversation'
+require 'xbim_comms/models/conversation_create'
+require 'xbim_comms/models/conversation_list'
+require 'xbim_comms/models/conversation_tenant'
+require 'xbim_comms/models/conversation_update'
+require 'xbim_comms/models/entity_key'
+require 'xbim_comms/models/exception_message'
+require 'xbim_comms/models/file_all_of'
+require 'xbim_comms/models/int32_value'
+require 'xbim_comms/models/key_frame'
+require 'xbim_comms/models/line'
+require 'xbim_comms/models/message'
+require 'xbim_comms/models/message_content'
+require 'xbim_comms/models/message_create'
+require 'xbim_comms/models/message_list'
+require 'xbim_comms/models/message_part'
+require 'xbim_comms/models/message_update'
+require 'xbim_comms/models/orthogonal_camera'
+require 'xbim_comms/models/participant'
+require 'xbim_comms/models/participant_with_role'
+require 'xbim_comms/models/participant_with_role_create'
+require 'xbim_comms/models/participant_with_role_list'
+require 'xbim_comms/models/participant_with_role_update'
+require 'xbim_comms/models/perspective_camera'
+require 'xbim_comms/models/pie_chart_all_of'
+require 'xbim_comms/models/point'
+require 'xbim_comms/models/preview_row'
+require 'xbim_comms/models/schedule_all_of'
+require 'xbim_comms/models/schedule_column'
+require 'xbim_comms/models/schedule_request_all_of'
+require 'xbim_comms/models/section_box'
+require 'xbim_comms/models/sheet_all_of'
+require 'xbim_comms/models/sheet_part'
+require 'xbim_comms/models/snapshot'
+require 'xbim_comms/models/view_all_of'
+require 'xbim_comms/models/view_setup_hints'
+require 'xbim_comms/models/viewpoint'
+require 'xbim_comms/models/visibility'
+require 'xbim_comms/models/analytical_result'
+require 'xbim_comms/models/animation'
+require 'xbim_comms/models/file'
+require 'xbim_comms/models/pie_chart'
+require 'xbim_comms/models/schedule'
+require 'xbim_comms/models/schedule_request'
+require 'xbim_comms/models/sheet'
+require 'xbim_comms/models/text'
+require 'xbim_comms/models/view'
+
+# APIs
+require 'xbim_comms/api/contacts_api'
+require 'xbim_comms/api/conversations_api'
+require 'xbim_comms/api/files_api'
+require 'xbim_comms/api/snapshots_api'
+
+module XbimComms
+  class << self
+    # Customize default settings for the SDK using block.
+    #   XbimComms.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end