xbim_comms 2.0.0

data/lib/xbim_comms/models/schedule_all_of.rb

@@ -0,0 +1,258 @@
+=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 ScheduleAllOf
+    attr_accessor :schedule_name
+
+    attr_accessor :columns
+
+    attr_accessor :preview_rows
+
+    attr_accessor :number_of_rows
+
+    attr_accessor :png_preview
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'schedule_name' => :'scheduleName',
+        :'columns' => :'columns',
+        :'preview_rows' => :'previewRows',
+        :'number_of_rows' => :'numberOfRows',
+        :'png_preview' => :'pngPreview'
+      }
+    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
+      {
+        :'schedule_name' => :'String',
+        :'columns' => :'Array<ScheduleColumn>',
+        :'preview_rows' => :'Array<PreviewRow>',
+        :'number_of_rows' => :'Integer',
+        :'png_preview' => :'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 `XbimComms::ScheduleAllOf` 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::ScheduleAllOf`. 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?(:'schedule_name')
+        self.schedule_name = attributes[:'schedule_name']
+      end
+
+      if attributes.key?(:'columns')
+        if (value = attributes[:'columns']).is_a?(Array)
+          self.columns = value
+        end
+      end
+
+      if attributes.key?(:'preview_rows')
+        if (value = attributes[:'preview_rows']).is_a?(Array)
+          self.preview_rows = value
+        end
+      end
+
+      if attributes.key?(:'number_of_rows')
+        self.number_of_rows = attributes[:'number_of_rows']
+      end
+
+      if attributes.key?(:'png_preview')
+        self.png_preview = attributes[:'png_preview']
+      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 &&
+          schedule_name == o.schedule_name &&
+          columns == o.columns &&
+          preview_rows == o.preview_rows &&
+          number_of_rows == o.number_of_rows &&
+          png_preview == o.png_preview
+    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
+      [schedule_name, columns, preview_rows, number_of_rows, png_preview].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/schedule_column.rb

@@ -0,0 +1,384 @@
+=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 ScheduleColumn
+    attr_accessor :column_name
+
+    attr_accessor :heading_orientation
+
+    attr_accessor :horizontal_alignment
+
+    attr_accessor :accuracy
+
+    attr_accessor :can_have_unit_symbol
+
+    attr_accessor :rounding_method
+
+    attr_accessor :suppress_leading_zeros
+
+    attr_accessor :suppress_spaces
+
+    attr_accessor :suppress_trailing_zeros
+
+    attr_accessor :unit_symbol
+
+    attr_accessor :use_plus_prefix
+
+    attr_accessor :use_digit_grouping
+
+    attr_accessor :display_units
+
+    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
+      {
+        :'column_name' => :'columnName',
+        :'heading_orientation' => :'headingOrientation',
+        :'horizontal_alignment' => :'horizontalAlignment',
+        :'accuracy' => :'accuracy',
+        :'can_have_unit_symbol' => :'canHaveUnitSymbol',
+        :'rounding_method' => :'roundingMethod',
+        :'suppress_leading_zeros' => :'suppressLeadingZeros',
+        :'suppress_spaces' => :'suppressSpaces',
+        :'suppress_trailing_zeros' => :'suppressTrailingZeros',
+        :'unit_symbol' => :'unitSymbol',
+        :'use_plus_prefix' => :'usePlusPrefix',
+        :'use_digit_grouping' => :'useDigitGrouping',
+        :'display_units' => :'displayUnits'
+      }
+    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
+      {
+        :'column_name' => :'String',
+        :'heading_orientation' => :'String',
+        :'horizontal_alignment' => :'String',
+        :'accuracy' => :'Float',
+        :'can_have_unit_symbol' => :'Boolean',
+        :'rounding_method' => :'String',
+        :'suppress_leading_zeros' => :'Boolean',
+        :'suppress_spaces' => :'Boolean',
+        :'suppress_trailing_zeros' => :'Boolean',
+        :'unit_symbol' => :'String',
+        :'use_plus_prefix' => :'Boolean',
+        :'use_digit_grouping' => :'Boolean',
+        :'display_units' => :'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 `XbimComms::ScheduleColumn` 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::ScheduleColumn`. 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?(:'column_name')
+        self.column_name = attributes[:'column_name']
+      end
+
+      if attributes.key?(:'heading_orientation')
+        self.heading_orientation = attributes[:'heading_orientation']
+      end
+
+      if attributes.key?(:'horizontal_alignment')
+        self.horizontal_alignment = attributes[:'horizontal_alignment']
+      end
+
+      if attributes.key?(:'accuracy')
+        self.accuracy = attributes[:'accuracy']
+      end
+
+      if attributes.key?(:'can_have_unit_symbol')
+        self.can_have_unit_symbol = attributes[:'can_have_unit_symbol']
+      end
+
+      if attributes.key?(:'rounding_method')
+        self.rounding_method = attributes[:'rounding_method']
+      end
+
+      if attributes.key?(:'suppress_leading_zeros')
+        self.suppress_leading_zeros = attributes[:'suppress_leading_zeros']
+      end
+
+      if attributes.key?(:'suppress_spaces')
+        self.suppress_spaces = attributes[:'suppress_spaces']
+      end
+
+      if attributes.key?(:'suppress_trailing_zeros')
+        self.suppress_trailing_zeros = attributes[:'suppress_trailing_zeros']
+      end
+
+      if attributes.key?(:'unit_symbol')
+        self.unit_symbol = attributes[:'unit_symbol']
+      end
+
+      if attributes.key?(:'use_plus_prefix')
+        self.use_plus_prefix = attributes[:'use_plus_prefix']
+      end
+
+      if attributes.key?(:'use_digit_grouping')
+        self.use_digit_grouping = attributes[:'use_digit_grouping']
+      end
+
+      if attributes.key?(:'display_units')
+        self.display_units = attributes[:'display_units']
+      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?
+      heading_orientation_validator = EnumAttributeValidator.new('String', ["Vertical", "Horizontal"])
+      return false unless heading_orientation_validator.valid?(@heading_orientation)
+      horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Left", "Right", "Center"])
+      return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
+      rounding_method_validator = EnumAttributeValidator.new('String', ["Nearest", "Up", "Down"])
+      return false unless rounding_method_validator.valid?(@rounding_method)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] heading_orientation Object to be assigned
+    def heading_orientation=(heading_orientation)
+      validator = EnumAttributeValidator.new('String', ["Vertical", "Horizontal"])
+      unless validator.valid?(heading_orientation)
+        fail ArgumentError, "invalid value for \"heading_orientation\", must be one of #{validator.allowable_values}."
+      end
+      @heading_orientation = heading_orientation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] horizontal_alignment Object to be assigned
+    def horizontal_alignment=(horizontal_alignment)
+      validator = EnumAttributeValidator.new('String', ["Left", "Right", "Center"])
+      unless validator.valid?(horizontal_alignment)
+        fail ArgumentError, "invalid value for \"horizontal_alignment\", must be one of #{validator.allowable_values}."
+      end
+      @horizontal_alignment = horizontal_alignment
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rounding_method Object to be assigned
+    def rounding_method=(rounding_method)
+      validator = EnumAttributeValidator.new('String', ["Nearest", "Up", "Down"])
+      unless validator.valid?(rounding_method)
+        fail ArgumentError, "invalid value for \"rounding_method\", must be one of #{validator.allowable_values}."
+      end
+      @rounding_method = rounding_method
+    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 &&
+          column_name == o.column_name &&
+          heading_orientation == o.heading_orientation &&
+          horizontal_alignment == o.horizontal_alignment &&
+          accuracy == o.accuracy &&
+          can_have_unit_symbol == o.can_have_unit_symbol &&
+          rounding_method == o.rounding_method &&
+          suppress_leading_zeros == o.suppress_leading_zeros &&
+          suppress_spaces == o.suppress_spaces &&
+          suppress_trailing_zeros == o.suppress_trailing_zeros &&
+          unit_symbol == o.unit_symbol &&
+          use_plus_prefix == o.use_plus_prefix &&
+          use_digit_grouping == o.use_digit_grouping &&
+          display_units == o.display_units
+    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
+      [column_name, heading_orientation, horizontal_alignment, accuracy, can_have_unit_symbol, rounding_method, suppress_leading_zeros, suppress_spaces, suppress_trailing_zeros, unit_symbol, use_plus_prefix, use_digit_grouping, display_units].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