seatschart 0.3.0 → 0.5.0

data/lib/seatschart/models/get_api_workspaces_overview200_response_items_inner_usage.rb

@@ -0,0 +1,271 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  class GetApiWorkspacesOverview200ResponseItemsInnerUsage
+    # `YYYY-MM`.
+    attr_accessor :month
+
+    attr_accessor :used_objects
+
+    attr_accessor :used_seats
+
+    # Used seats of the month at the current pace.
+    attr_accessor :projected_seats
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'month' => :'month',
+        :'used_objects' => :'usedObjects',
+        :'used_seats' => :'usedSeats',
+        :'projected_seats' => :'projectedSeats'
+      }
+    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
+      {
+        :'month' => :'String',
+        :'used_objects' => :'Integer',
+        :'used_seats' => :'Integer',
+        :'projected_seats' => :'Integer'
+      }
+    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 `SeatsChart::GetApiWorkspacesOverview200ResponseItemsInnerUsage` 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 `SeatsChart::GetApiWorkspacesOverview200ResponseItemsInnerUsage`. 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?(:'month')
+        self.month = attributes[:'month']
+      else
+        self.month = nil
+      end
+
+      if attributes.key?(:'used_objects')
+        self.used_objects = attributes[:'used_objects']
+      else
+        self.used_objects = nil
+      end
+
+      if attributes.key?(:'used_seats')
+        self.used_seats = attributes[:'used_seats']
+      else
+        self.used_seats = nil
+      end
+
+      if attributes.key?(:'projected_seats')
+        self.projected_seats = attributes[:'projected_seats']
+      else
+        self.projected_seats = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @month.nil?
+        invalid_properties.push('invalid value for "month", month cannot be nil.')
+      end
+
+      if @used_objects.nil?
+        invalid_properties.push('invalid value for "used_objects", used_objects cannot be nil.')
+      end
+
+      if @used_seats.nil?
+        invalid_properties.push('invalid value for "used_seats", used_seats cannot be nil.')
+      end
+
+      if @projected_seats.nil?
+        invalid_properties.push('invalid value for "projected_seats", projected_seats 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @month.nil?
+      return false if @used_objects.nil?
+      return false if @used_seats.nil?
+      return false if @projected_seats.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 &&
+          month == o.month &&
+          used_objects == o.used_objects &&
+          used_seats == o.used_seats &&
+          projected_seats == o.projected_seats
+    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
+      [month, used_objects, used_seats, projected_seats].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = SeatsChart.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/seatschart/models/get_api_workspaces_overview200_response_seats.rb

@@ -0,0 +1,431 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  # Seat billing of the caller's billing account for the month; `null` without an account.
+  class GetApiWorkspacesOverview200ResponseSeats
+    attr_accessor :month
+
+    attr_accessor :plan_id
+
+    attr_accessor :mode
+
+    attr_accessor :used_seats
+
+    attr_accessor :included_seats
+
+    # US cents per seat beyond the included ones (may be fractional).
+    attr_accessor :overage_price_cents_per_seat
+
+    attr_accessor :overage
+
+    attr_accessor :allowance_exceeded
+
+    attr_accessor :allowance_near
+
+    attr_accessor :projected
+
+    attr_accessor :billing_owner_user_id
+
+    attr_accessor :rolled_up
+
+    attr_accessor :workspace_count
+
+    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
+      {
+        :'month' => :'month',
+        :'plan_id' => :'planId',
+        :'mode' => :'mode',
+        :'used_seats' => :'usedSeats',
+        :'included_seats' => :'includedSeats',
+        :'overage_price_cents_per_seat' => :'overagePriceCentsPerSeat',
+        :'overage' => :'overage',
+        :'allowance_exceeded' => :'allowanceExceeded',
+        :'allowance_near' => :'allowanceNear',
+        :'projected' => :'projected',
+        :'billing_owner_user_id' => :'billingOwnerUserId',
+        :'rolled_up' => :'rolledUp',
+        :'workspace_count' => :'workspaceCount'
+      }
+    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
+      {
+        :'month' => :'String',
+        :'plan_id' => :'String',
+        :'mode' => :'String',
+        :'used_seats' => :'Integer',
+        :'included_seats' => :'Integer',
+        :'overage_price_cents_per_seat' => :'Float',
+        :'overage' => :'GetApiWorkspacesOverview200ResponseSeatsOverage',
+        :'allowance_exceeded' => :'Boolean',
+        :'allowance_near' => :'Boolean',
+        :'projected' => :'GetApiWorkspacesOverview200ResponseSeatsProjected',
+        :'billing_owner_user_id' => :'String',
+        :'rolled_up' => :'Boolean',
+        :'workspace_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'included_seats',
+        :'overage_price_cents_per_seat',
+        :'projected',
+        :'billing_owner_user_id',
+      ])
+    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 `SeatsChart::GetApiWorkspacesOverview200ResponseSeats` 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 `SeatsChart::GetApiWorkspacesOverview200ResponseSeats`. 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?(:'month')
+        self.month = attributes[:'month']
+      else
+        self.month = nil
+      end
+
+      if attributes.key?(:'plan_id')
+        self.plan_id = attributes[:'plan_id']
+      else
+        self.plan_id = nil
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'used_seats')
+        self.used_seats = attributes[:'used_seats']
+      else
+        self.used_seats = nil
+      end
+
+      if attributes.key?(:'included_seats')
+        self.included_seats = attributes[:'included_seats']
+      else
+        self.included_seats = nil
+      end
+
+      if attributes.key?(:'overage_price_cents_per_seat')
+        self.overage_price_cents_per_seat = attributes[:'overage_price_cents_per_seat']
+      else
+        self.overage_price_cents_per_seat = nil
+      end
+
+      if attributes.key?(:'overage')
+        self.overage = attributes[:'overage']
+      else
+        self.overage = nil
+      end
+
+      if attributes.key?(:'allowance_exceeded')
+        self.allowance_exceeded = attributes[:'allowance_exceeded']
+      else
+        self.allowance_exceeded = nil
+      end
+
+      if attributes.key?(:'allowance_near')
+        self.allowance_near = attributes[:'allowance_near']
+      else
+        self.allowance_near = nil
+      end
+
+      if attributes.key?(:'projected')
+        self.projected = attributes[:'projected']
+      end
+
+      if attributes.key?(:'billing_owner_user_id')
+        self.billing_owner_user_id = attributes[:'billing_owner_user_id']
+      else
+        self.billing_owner_user_id = nil
+      end
+
+      if attributes.key?(:'rolled_up')
+        self.rolled_up = attributes[:'rolled_up']
+      else
+        self.rolled_up = nil
+      end
+
+      if attributes.key?(:'workspace_count')
+        self.workspace_count = attributes[:'workspace_count']
+      else
+        self.workspace_count = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @month.nil?
+        invalid_properties.push('invalid value for "month", month cannot be nil.')
+      end
+
+      if @plan_id.nil?
+        invalid_properties.push('invalid value for "plan_id", plan_id cannot be nil.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      if @used_seats.nil?
+        invalid_properties.push('invalid value for "used_seats", used_seats cannot be nil.')
+      end
+
+      if @overage.nil?
+        invalid_properties.push('invalid value for "overage", overage cannot be nil.')
+      end
+
+      if @allowance_exceeded.nil?
+        invalid_properties.push('invalid value for "allowance_exceeded", allowance_exceeded cannot be nil.')
+      end
+
+      if @allowance_near.nil?
+        invalid_properties.push('invalid value for "allowance_near", allowance_near cannot be nil.')
+      end
+
+      if @rolled_up.nil?
+        invalid_properties.push('invalid value for "rolled_up", rolled_up cannot be nil.')
+      end
+
+      if @workspace_count.nil?
+        invalid_properties.push('invalid value for "workspace_count", workspace_count 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @month.nil?
+      return false if @plan_id.nil?
+      return false if @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["allowance", "overage", "on_demand"])
+      return false unless mode_validator.valid?(@mode)
+      return false if @used_seats.nil?
+      return false if @overage.nil?
+      return false if @allowance_exceeded.nil?
+      return false if @allowance_near.nil?
+      return false if @rolled_up.nil?
+      return false if @workspace_count.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["allowance", "overage", "on_demand"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    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 &&
+          month == o.month &&
+          plan_id == o.plan_id &&
+          mode == o.mode &&
+          used_seats == o.used_seats &&
+          included_seats == o.included_seats &&
+          overage_price_cents_per_seat == o.overage_price_cents_per_seat &&
+          overage == o.overage &&
+          allowance_exceeded == o.allowance_exceeded &&
+          allowance_near == o.allowance_near &&
+          projected == o.projected &&
+          billing_owner_user_id == o.billing_owner_user_id &&
+          rolled_up == o.rolled_up &&
+          workspace_count == o.workspace_count
+    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
+      [month, plan_id, mode, used_seats, included_seats, overage_price_cents_per_seat, overage, allowance_exceeded, allowance_near, projected, billing_owner_user_id, rolled_up, workspace_count].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = SeatsChart.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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