temper-rb 0.5.4 → 0.6.1

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

@@ -0,0 +1,284 @@
+=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
+  # The plan `resource_field_scrub_plan` computes (field-grain scrub spec S5): the act consumes the same computation. Event ids, row ids and paths only. In keep mode an empty `redacted_fields` means the field has nothing prior, and the act would answer 400.
+  class FieldScrubPlan < ApiModelBase
+    # The events clear mode would append first. Empty in keep mode.
+    attr_accessor :clears
+
+    # The folded `kb_properties` rows the act would rewrite to what replay projects.
+    attr_accessor :folded_rows
+
+    # Today's value, kept (`why: current`).
+    attr_accessor :kept
+
+    # The ledger paths the act would rewrite to their sentinels.
+    attr_accessor :redacted_fields
+
+    # Paths the act cannot reach, and why.
+    attr_accessor :unreachable
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clears' => :'clears',
+        :'folded_rows' => :'folded_rows',
+        :'kept' => :'kept',
+        :'redacted_fields' => :'redacted_fields',
+        :'unreachable' => :'unreachable'
+      }
+    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
+      {
+        :'clears' => :'Array<FieldScrubClearingEvent>',
+        :'folded_rows' => :'Array<String>',
+        :'kept' => :'Array<FieldScrubHeldPaths>',
+        :'redacted_fields' => :'Array<RedactedEventFields>',
+        :'unreachable' => :'Array<FieldScrubHeldPaths>'
+      }
+    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::FieldScrubPlan` 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::FieldScrubPlan`. 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?(:'clears')
+        if (value = attributes[:'clears']).is_a?(Array)
+          self.clears = value
+        end
+      else
+        self.clears = nil
+      end
+
+      if attributes.key?(:'folded_rows')
+        if (value = attributes[:'folded_rows']).is_a?(Array)
+          self.folded_rows = value
+        end
+      else
+        self.folded_rows = nil
+      end
+
+      if attributes.key?(:'kept')
+        if (value = attributes[:'kept']).is_a?(Array)
+          self.kept = value
+        end
+      else
+        self.kept = nil
+      end
+
+      if attributes.key?(:'redacted_fields')
+        if (value = attributes[:'redacted_fields']).is_a?(Array)
+          self.redacted_fields = value
+        end
+      else
+        self.redacted_fields = nil
+      end
+
+      if attributes.key?(:'unreachable')
+        if (value = attributes[:'unreachable']).is_a?(Array)
+          self.unreachable = value
+        end
+      else
+        self.unreachable = 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 @clears.nil?
+        invalid_properties.push('invalid value for "clears", clears cannot be nil.')
+      end
+
+      if @folded_rows.nil?
+        invalid_properties.push('invalid value for "folded_rows", folded_rows cannot be nil.')
+      end
+
+      if @kept.nil?
+        invalid_properties.push('invalid value for "kept", kept cannot be nil.')
+      end
+
+      if @redacted_fields.nil?
+        invalid_properties.push('invalid value for "redacted_fields", redacted_fields cannot be nil.')
+      end
+
+      if @unreachable.nil?
+        invalid_properties.push('invalid value for "unreachable", unreachable 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 @clears.nil?
+      return false if @folded_rows.nil?
+      return false if @kept.nil?
+      return false if @redacted_fields.nil?
+      return false if @unreachable.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] clears Value to be assigned
+    def clears=(clears)
+      if clears.nil?
+        fail ArgumentError, 'clears cannot be nil'
+      end
+
+      @clears = clears
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] folded_rows Value to be assigned
+    def folded_rows=(folded_rows)
+      if folded_rows.nil?
+        fail ArgumentError, 'folded_rows cannot be nil'
+      end
+
+      @folded_rows = folded_rows
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kept Value to be assigned
+    def kept=(kept)
+      if kept.nil?
+        fail ArgumentError, 'kept cannot be nil'
+      end
+
+      @kept = kept
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] redacted_fields Value to be assigned
+    def redacted_fields=(redacted_fields)
+      if redacted_fields.nil?
+        fail ArgumentError, 'redacted_fields cannot be nil'
+      end
+
+      @redacted_fields = redacted_fields
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unreachable Value to be assigned
+    def unreachable=(unreachable)
+      if unreachable.nil?
+        fail ArgumentError, 'unreachable cannot be nil'
+      end
+
+      @unreachable = unreachable
+    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 &&
+          clears == o.clears &&
+          folded_rows == o.folded_rows &&
+          kept == o.kept &&
+          redacted_fields == o.redacted_fields &&
+          unreachable == o.unreachable
+    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
+      [clears, folded_rows, kept, redacted_fields, unreachable].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_refusal_reason.rb

@@ -0,0 +1,42 @@
+=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
+  class FieldScrubRefusalReason
+    CHARTER_RESOURCE = "charter_resource".freeze
+    ALREADY_ERASED = "already_erased".freeze
+    SENTINEL_COLLISION = "sentinel_collision".freeze
+    PROJECTION_DISAGREES = "projection_disagrees".freeze
+
+    def self.all_vars
+      @all_vars ||= [CHARTER_RESOURCE, ALREADY_ERASED, SENTINEL_COLLISION, PROJECTION_DISAGREES].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if FieldScrubRefusalReason.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FieldScrubRefusalReason"
+    end
+  end
+end

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

@@ -0,0 +1,234 @@
+=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
+  # The request the field scrub's execute and survey doors take (field-grain scrub spec S1, S2): the resource, the field by kind, the family's handle for `property`, and `clear`. No text: the field is named by its kind and a family by the id of the first event still carrying its key text, read from the family listing. `clear` is the operator's statement that today's value is part of the leak; absent, today's value is kept and only the field's prior history is redacted. `deny_unknown_fields`: the act's request reference is minted by the service, so a caller that sends one is refused, not ignored.
+  class FieldScrubRequestBody < ApiModelBase
+    # Clear today's value first, then redact every value the field held. Refused for `properties`: clear always names one field.
+    attr_accessor :clear
+
+    # The family's handle. Required for `property`, refused for every other field.
+    attr_accessor :family
+
+    attr_accessor :field
+
+    attr_accessor :resource
+
+    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
+      {
+        :'clear' => :'clear',
+        :'family' => :'family',
+        :'field' => :'field',
+        :'resource' => :'resource'
+      }
+    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
+      {
+        :'clear' => :'Boolean',
+        :'family' => :'String',
+        :'field' => :'ScrubFieldKind',
+        :'resource' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'family',
+      ])
+    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::FieldScrubRequestBody` 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::FieldScrubRequestBody`. 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?(:'clear')
+        self.clear = attributes[:'clear']
+      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?(:'resource')
+        self.resource = attributes[:'resource']
+      else
+        self.resource = 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 @field.nil?
+        invalid_properties.push('invalid value for "field", field cannot be nil.')
+      end
+
+      if @resource.nil?
+        invalid_properties.push('invalid value for "resource", resource 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 @field.nil?
+      return false if @resource.nil?
+      true
+    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] resource Value to be assigned
+    def resource=(resource)
+      if resource.nil?
+        fail ArgumentError, 'resource cannot be nil'
+      end
+
+      @resource = resource
+    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 &&
+          clear == o.clear &&
+          family == o.family &&
+          field == o.field &&
+          resource == o.resource
+    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
+      [clear, family, field, resource].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