temper-rb 0.6.0 → 0.6.1

data/lib/temper/generated/models/field_scrub_family.rb

@@ -0,0 +1,358 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.6.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # One row of the family listing (field-grain scrub spec S1): the title, the origin URI, or one resource-owned property family. Structure only, never a key or a value.
+  class FieldScrubFamily < ApiModelBase
+    # The sweep has read all of the resource with every enabled detector. The same on every row.
+    attr_accessor :covered
+
+    # The same, on today's place only: the title or origin URI, or a live row. A flagged current value survives a scrub unless the request says `clear`.
+    attr_accessor :current_flagged
+
+    # How many events carry the field.
+    attr_accessor :events
+
+    # The family's handle, for `property`: the id of the first event still carrying its key text (the `doc_type` family's is the resource's `resource_created`). Absent for the title and origin URI, which need none.
+    attr_accessor :family
+
+    # `title`, `origin_uri` or `property`.
+    attr_accessor :field
+
+    # The profile behind the first event's emitter.
+    attr_accessor :first_by
+
+    attr_accessor :first_seen
+
+    # The sensitivity sweep holds an open finding on a place of the field: a redactable path of one of its events, or the projection's title, origin URI or one of the family's rows. A flag confirms a leak; its absence never means the field is clean.
+    attr_accessor :flagged
+
+    # Some row the field's events asserted is live. Always true for the title and origin URI.
+    attr_accessor :live
+
+    # The family has a `property_unset`, so its key text up to the latest one is scrubbable in keep mode.
+    attr_accessor :unset
+
+    # The JSON type of the latest value the field carries; absent for a family only ever unset.
+    attr_accessor :value_type
+
+    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
+      {
+        :'covered' => :'covered',
+        :'current_flagged' => :'current_flagged',
+        :'events' => :'events',
+        :'family' => :'family',
+        :'field' => :'field',
+        :'first_by' => :'first_by',
+        :'first_seen' => :'first_seen',
+        :'flagged' => :'flagged',
+        :'live' => :'live',
+        :'unset' => :'unset',
+        :'value_type' => :'value_type'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'covered' => :'Boolean',
+        :'current_flagged' => :'Boolean',
+        :'events' => :'Integer',
+        :'family' => :'String',
+        :'field' => :'ScrubFieldKind',
+        :'first_by' => :'String',
+        :'first_seen' => :'Time',
+        :'flagged' => :'Boolean',
+        :'live' => :'Boolean',
+        :'unset' => :'Boolean',
+        :'value_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'family',
+        :'first_by',
+        :'value_type'
+      ])
+    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 `Temper::Generated::FieldScrubFamily` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::FieldScrubFamily`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'covered')
+        self.covered = attributes[:'covered']
+      end
+
+      if attributes.key?(:'current_flagged')
+        self.current_flagged = attributes[:'current_flagged']
+      end
+
+      if attributes.key?(:'events')
+        self.events = attributes[:'events']
+      else
+        self.events = nil
+      end
+
+      if attributes.key?(:'family')
+        self.family = attributes[:'family']
+      end
+
+      if attributes.key?(:'field')
+        self.field = attributes[:'field']
+      else
+        self.field = nil
+      end
+
+      if attributes.key?(:'first_by')
+        self.first_by = attributes[:'first_by']
+      end
+
+      if attributes.key?(:'first_seen')
+        self.first_seen = attributes[:'first_seen']
+      else
+        self.first_seen = nil
+      end
+
+      if attributes.key?(:'flagged')
+        self.flagged = attributes[:'flagged']
+      end
+
+      if attributes.key?(:'live')
+        self.live = attributes[:'live']
+      else
+        self.live = nil
+      end
+
+      if attributes.key?(:'unset')
+        self.unset = attributes[:'unset']
+      else
+        self.unset = nil
+      end
+
+      if attributes.key?(:'value_type')
+        self.value_type = attributes[:'value_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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @events.nil?
+        invalid_properties.push('invalid value for "events", events cannot be nil.')
+      end
+
+      if @field.nil?
+        invalid_properties.push('invalid value for "field", field cannot be nil.')
+      end
+
+      if @first_seen.nil?
+        invalid_properties.push('invalid value for "first_seen", first_seen cannot be nil.')
+      end
+
+      if @live.nil?
+        invalid_properties.push('invalid value for "live", live cannot be nil.')
+      end
+
+      if @unset.nil?
+        invalid_properties.push('invalid value for "unset", unset 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 @events.nil?
+      return false if @field.nil?
+      return false if @first_seen.nil?
+      return false if @live.nil?
+      return false if @unset.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] events Value to be assigned
+    def events=(events)
+      if events.nil?
+        fail ArgumentError, 'events cannot be nil'
+      end
+
+      @events = events
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] field Value to be assigned
+    def field=(field)
+      if field.nil?
+        fail ArgumentError, 'field cannot be nil'
+      end
+
+      @field = field
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_seen Value to be assigned
+    def first_seen=(first_seen)
+      if first_seen.nil?
+        fail ArgumentError, 'first_seen cannot be nil'
+      end
+
+      @first_seen = first_seen
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] live Value to be assigned
+    def live=(live)
+      if live.nil?
+        fail ArgumentError, 'live cannot be nil'
+      end
+
+      @live = live
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unset Value to be assigned
+    def unset=(unset)
+      if unset.nil?
+        fail ArgumentError, 'unset cannot be nil'
+      end
+
+      @unset = unset
+    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 &&
+          covered == o.covered &&
+          current_flagged == o.current_flagged &&
+          events == o.events &&
+          family == o.family &&
+          field == o.field &&
+          first_by == o.first_by &&
+          first_seen == o.first_seen &&
+          flagged == o.flagged &&
+          live == o.live &&
+          unset == o.unset &&
+          value_type == o.value_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
+      [covered, current_flagged, events, family, field, first_by, first_seen, flagged, live, unset, value_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)
+      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
+
+    # 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
+
+  end
+
+end

data/lib/temper/generated/models/field_scrub_held_paths.rb

@@ -0,0 +1,220 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.6.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # Paths of one event the scrub holds back, and why: `current` (today's value, kept), `after_latest_unset` (key text after the family's latest unset) or `after_whole_facet_fold` (a facet event after the latest whole-facet fold). Paths only, never values.
+  class FieldScrubHeldPaths < ApiModelBase
+    # A `kb_events.id` value. Always UUIDv7 (time-sortable).
+    attr_accessor :event
+
+    attr_accessor :paths
+
+    attr_accessor :why
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event' => :'event',
+        :'paths' => :'paths',
+        :'why' => :'why'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event' => :'String',
+        :'paths' => :'Array<String>',
+        :'why' => :'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 `Temper::Generated::FieldScrubHeldPaths` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::FieldScrubHeldPaths`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'event')
+        self.event = attributes[:'event']
+      else
+        self.event = nil
+      end
+
+      if attributes.key?(:'paths')
+        if (value = attributes[:'paths']).is_a?(Array)
+          self.paths = value
+        end
+      else
+        self.paths = nil
+      end
+
+      if attributes.key?(:'why')
+        self.why = attributes[:'why']
+      else
+        self.why = 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 @event.nil?
+        invalid_properties.push('invalid value for "event", event cannot be nil.')
+      end
+
+      if @paths.nil?
+        invalid_properties.push('invalid value for "paths", paths cannot be nil.')
+      end
+
+      if @why.nil?
+        invalid_properties.push('invalid value for "why", why 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 @event.nil?
+      return false if @paths.nil?
+      return false if @why.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event Value to be assigned
+    def event=(event)
+      if event.nil?
+        fail ArgumentError, 'event cannot be nil'
+      end
+
+      @event = event
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] paths Value to be assigned
+    def paths=(paths)
+      if paths.nil?
+        fail ArgumentError, 'paths cannot be nil'
+      end
+
+      @paths = paths
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] why Value to be assigned
+    def why=(why)
+      if why.nil?
+        fail ArgumentError, 'why cannot be nil'
+      end
+
+      @why = why
+    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 &&
+          event == o.event &&
+          paths == o.paths &&
+          why == o.why
+    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
+      [event, paths, why].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
+
+    # 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
+
+  end
+
+end