athenian 2.1.81

data/lib/athenian/models/code_filter.rb

@@ -0,0 +1,351 @@
+=begin
+This is an automatically generated file. DO NOT EDIT.
+
+Generated from version 2.1.81 of the OpenAPI specification at
+https://github.com/athenianco/api-spec/releases/tag/2.1.81.
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+=end
+
+require 'date'
+require 'time'
+
+module Athenian
+  # Filter for revealing code bypassing PRs.
+  class CodeFilter
+    # Session account ID.
+    attr_accessor :account
+
+    # Commits must be made later than or equal to this date.
+    attr_accessor :date_from
+
+    # Commits must be made earlier than or equal to this date.
+    attr_accessor :date_to
+
+    # Local time zone offset in minutes, used to adjust `date_from` and `date_to`.
+    attr_accessor :timezone
+
+    # Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
+    attr_accessor :_in
+
+    # A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.
+    attr_accessor :with_author
+
+    # A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.
+    attr_accessor :with_committer
+
+    # How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\\d* )?(aligned )?(day|week|month|year))$/. \"all\" produces a single interval [`date_from`, `date_to`]. \"aligned week/month/year\" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`.
+    attr_accessor :granularity
+
+    # Consider only commits that are accessible from the head of the default branch. For example, if your workflow includes PR-ing feature branches, you rebase and merge them and don't delete afterward, `bypassing_prs` will report the commits in those feature branches unless you set `only_default_branch` to `true`.
+    attr_accessor :only_default_branch
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'date_from' => :'date_from',
+        :'date_to' => :'date_to',
+        :'timezone' => :'timezone',
+        :'_in' => :'in',
+        :'with_author' => :'with_author',
+        :'with_committer' => :'with_committer',
+        :'granularity' => :'granularity',
+        :'only_default_branch' => :'only_default_branch'
+      }
+    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
+      {
+        :'account' => :'Integer',
+        :'date_from' => :'Date',
+        :'date_to' => :'Date',
+        :'timezone' => :'Integer',
+        :'_in' => :'Array<String>',
+        :'with_author' => :'Array<String>',
+        :'with_committer' => :'Array<String>',
+        :'granularity' => :'String',
+        :'only_default_branch' => :'Boolean'
+      }
+    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 `Athenian::CodeFilter` 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 `Athenian::CodeFilter`. 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?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.key?(:'date_from')
+        self.date_from = attributes[:'date_from']
+      end
+
+      if attributes.key?(:'date_to')
+        self.date_to = attributes[:'date_to']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
+      if attributes.key?(:'_in')
+        if (value = attributes[:'_in']).is_a?(Array)
+          self._in = value
+        end
+      end
+
+      if attributes.key?(:'with_author')
+        if (value = attributes[:'with_author']).is_a?(Array)
+          self.with_author = value
+        end
+      end
+
+      if attributes.key?(:'with_committer')
+        if (value = attributes[:'with_committer']).is_a?(Array)
+          self.with_committer = value
+        end
+      end
+
+      if attributes.key?(:'granularity')
+        self.granularity = attributes[:'granularity']
+      end
+
+      if attributes.key?(:'only_default_branch')
+        self.only_default_branch = attributes[:'only_default_branch']
+      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 @account.nil?
+        invalid_properties.push('invalid value for "account", account cannot be nil.')
+      end
+
+      if @date_from.nil?
+        invalid_properties.push('invalid value for "date_from", date_from cannot be nil.')
+      end
+
+      if @date_to.nil?
+        invalid_properties.push('invalid value for "date_to", date_to cannot be nil.')
+      end
+
+      if !@timezone.nil? && @timezone > 780
+        invalid_properties.push('invalid value for "timezone", must be smaller than or equal to 780.')
+      end
+
+      if !@timezone.nil? && @timezone < -720
+        invalid_properties.push('invalid value for "timezone", must be greater than or equal to -720.')
+      end
+
+      if @_in.nil?
+        invalid_properties.push('invalid value for "_in", _in cannot be nil.')
+      end
+
+      if @granularity.nil?
+        invalid_properties.push('invalid value for "granularity", granularity 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 @account.nil?
+      return false if @date_from.nil?
+      return false if @date_to.nil?
+      return false if !@timezone.nil? && @timezone > 780
+      return false if !@timezone.nil? && @timezone < -720
+      return false if @_in.nil?
+      return false if @granularity.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timezone Value to be assigned
+    def timezone=(timezone)
+      if !timezone.nil? && timezone > 780
+        fail ArgumentError, 'invalid value for "timezone", must be smaller than or equal to 780.'
+      end
+
+      if !timezone.nil? && timezone < -720
+        fail ArgumentError, 'invalid value for "timezone", must be greater than or equal to -720.'
+      end
+
+      @timezone = timezone
+    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 &&
+          account == o.account &&
+          date_from == o.date_from &&
+          date_to == o.date_to &&
+          timezone == o.timezone &&
+          _in == o._in &&
+          with_author == o.with_author &&
+          with_committer == o.with_committer &&
+          granularity == o.granularity &&
+          only_default_branch == o.only_default_branch
+    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
+      [account, date_from, date_to, timezone, _in, with_author, with_committer, granularity, only_default_branch].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = Athenian.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