temper-rb 0.5.1

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

@@ -0,0 +1,307 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # Outcome of a materialize trigger. When `materialized` is false the delta was below threshold and nothing ran (the idempotent no-op); when true, `regions` + `membership_fingerprint` describe the materialize that ran.  ## Why `cogmap_id` survives beside the anchor pair  T8 made this command anchor-addressed (a context materializes too), so the target is now `anchor_table` + `anchor_id`. `cogmap_id` is kept — and still populated whenever the anchor IS a cogmap — deliberately, because this is a **wire type on a deployed instance** and *removal* is the breaking direction. A temper-rb client silently ignores a wire key it does not know (`build_from_hash` walks the model's own `openapi_types`), but a key it requires and does not receive reaches the generated `attr=` setter as `nil` and raises there; the generated TS is consumed by a UI that ships on its own cadence. Dropping `cogmap_id` would hard-fail an older client on the cogmap path it already uses.  A client old enough to depend on `cogmap_id` cannot address a context (the route did not exist), so it never receives an ack where the field is absent. New clients read the anchor pair and ignore `cogmap_id`; it goes away with the rest of the `cogmap_*` naming at M3.
+  class MaterializeAck < ApiModelBase
+    # The anchor the trigger targeted.
+    attr_accessor :anchor_id
+
+    # The anchor table the trigger targeted — `kb_contexts` or `kb_cogmaps`.
+    attr_accessor :anchor_table
+
+    # Legacy alias for `anchor_id`, present iff the anchor is a cogmap. Prefer the anchor pair; see the type's docs for why this is still here.
+    attr_accessor :cogmap_id
+
+    # The delta observed when the gate was evaluated.
+    attr_accessor :formation_events
+
+    # Whether a materialize actually ran (`formation_events >= threshold`). False = idempotent no-op.
+    attr_accessor :materialized
+
+    # The full-clustering membership fingerprint the materialize produced — `Some` only when `materialized`.
+    attr_accessor :membership_fingerprint
+
+    # Regions produced by the materialize — `Some` only when `materialized` is true.
+    attr_accessor :regions
+
+    # The threshold the delta was compared against.
+    attr_accessor :threshold
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'anchor_id' => :'anchor_id',
+        :'anchor_table' => :'anchor_table',
+        :'cogmap_id' => :'cogmap_id',
+        :'formation_events' => :'formation_events',
+        :'materialized' => :'materialized',
+        :'membership_fingerprint' => :'membership_fingerprint',
+        :'regions' => :'regions',
+        :'threshold' => :'threshold'
+      }
+    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
+      {
+        :'anchor_id' => :'String',
+        :'anchor_table' => :'String',
+        :'cogmap_id' => :'String',
+        :'formation_events' => :'Integer',
+        :'materialized' => :'Boolean',
+        :'membership_fingerprint' => :'String',
+        :'regions' => :'Integer',
+        :'threshold' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cogmap_id',
+        :'membership_fingerprint',
+        :'regions',
+      ])
+    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::MaterializeAck` 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::MaterializeAck`. 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?(:'anchor_id')
+        self.anchor_id = attributes[:'anchor_id']
+      else
+        self.anchor_id = nil
+      end
+
+      if attributes.key?(:'anchor_table')
+        self.anchor_table = attributes[:'anchor_table']
+      else
+        self.anchor_table = nil
+      end
+
+      if attributes.key?(:'cogmap_id')
+        self.cogmap_id = attributes[:'cogmap_id']
+      end
+
+      if attributes.key?(:'formation_events')
+        self.formation_events = attributes[:'formation_events']
+      else
+        self.formation_events = nil
+      end
+
+      if attributes.key?(:'materialized')
+        self.materialized = attributes[:'materialized']
+      else
+        self.materialized = nil
+      end
+
+      if attributes.key?(:'membership_fingerprint')
+        self.membership_fingerprint = attributes[:'membership_fingerprint']
+      end
+
+      if attributes.key?(:'regions')
+        self.regions = attributes[:'regions']
+      end
+
+      if attributes.key?(:'threshold')
+        self.threshold = attributes[:'threshold']
+      else
+        self.threshold = 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 @anchor_id.nil?
+        invalid_properties.push('invalid value for "anchor_id", anchor_id cannot be nil.')
+      end
+
+      if @anchor_table.nil?
+        invalid_properties.push('invalid value for "anchor_table", anchor_table cannot be nil.')
+      end
+
+      if @formation_events.nil?
+        invalid_properties.push('invalid value for "formation_events", formation_events cannot be nil.')
+      end
+
+      if @materialized.nil?
+        invalid_properties.push('invalid value for "materialized", materialized cannot be nil.')
+      end
+
+      if @threshold.nil?
+        invalid_properties.push('invalid value for "threshold", threshold 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 @anchor_id.nil?
+      return false if @anchor_table.nil?
+      return false if @formation_events.nil?
+      return false if @materialized.nil?
+      return false if @threshold.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anchor_id Value to be assigned
+    def anchor_id=(anchor_id)
+      if anchor_id.nil?
+        fail ArgumentError, 'anchor_id cannot be nil'
+      end
+
+      @anchor_id = anchor_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anchor_table Value to be assigned
+    def anchor_table=(anchor_table)
+      if anchor_table.nil?
+        fail ArgumentError, 'anchor_table cannot be nil'
+      end
+
+      @anchor_table = anchor_table
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] formation_events Value to be assigned
+    def formation_events=(formation_events)
+      if formation_events.nil?
+        fail ArgumentError, 'formation_events cannot be nil'
+      end
+
+      @formation_events = formation_events
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] materialized Value to be assigned
+    def materialized=(materialized)
+      if materialized.nil?
+        fail ArgumentError, 'materialized cannot be nil'
+      end
+
+      @materialized = materialized
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] threshold Value to be assigned
+    def threshold=(threshold)
+      if threshold.nil?
+        fail ArgumentError, 'threshold cannot be nil'
+      end
+
+      @threshold = threshold
+    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 &&
+          anchor_id == o.anchor_id &&
+          anchor_table == o.anchor_table &&
+          cogmap_id == o.cogmap_id &&
+          formation_events == o.formation_events &&
+          materialized == o.materialized &&
+          membership_fingerprint == o.membership_fingerprint &&
+          regions == o.regions &&
+          threshold == o.threshold
+    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
+      [anchor_id, anchor_table, cogmap_id, formation_events, materialized, membership_fingerprint, regions, threshold].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/materialize_delta.rb

@@ -0,0 +1,296 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # The materialize delta for an ANCHOR since its last materialize — the trigger signal the region-materialize cron pulls. `formation_events` is the gated metric (a structural-drift count); `exceeds_threshold` is the \"should this re-materialize\" answer.  ## Why `cogmap_id` survives beside the anchor pair  The read path followed the write path onto the anchor pair (`anchor_table` + `anchor_id`), so a context can now be asked when it last materialized. `cogmap_id` is kept — and still populated whenever the anchor IS a cogmap — for exactly the reason [`MaterializeAck`] keeps its own: this is a **wire type on a deployed instance**, and *removing* a field from it is the breaking direction. A temper-rb client tolerates a field it has never heard of — `build_from_hash` walks the model's OWN `openapi_types`, so an unknown wire key is silently dropped — but not one it requires and does not receive: the missing key arrives at the generated `attr=` setter as `nil` and that setter raises. The generated TS is likewise consumed by a UI that ships on its own cadence. Adding to this type is therefore cheap; taking away is not.  A client old enough to depend on `cogmap_id` cannot address a context (the route did not exist), so it never receives a delta where the field is absent. New clients read the anchor pair and ignore `cogmap_id`; it goes away with the rest of the `cogmap_*` naming at M3.
+  class MaterializeDelta < ApiModelBase
+    # The anchor this delta measures.
+    attr_accessor :anchor_id
+
+    # The anchor table this delta measures — `kb_contexts` or `kb_cogmaps`.
+    attr_accessor :anchor_table
+
+    # Legacy alias for `anchor_id`, present iff the anchor is a cogmap. Prefer the anchor pair; see the type's docs for why this is still here.
+    attr_accessor :cogmap_id
+
+    # Whether `formation_events >= threshold` — i.e. the anchor should re-materialize.
+    attr_accessor :exceeds_threshold
+
+    # Formation-affecting events anchored to the anchor since the watermark (the gated drift signal).
+    attr_accessor :formation_events
+
+    # The threshold `formation_events` was compared against (the caller's, or the default).
+    attr_accessor :threshold
+
+    # The materialize watermark the delta was computed against (the anchor's `shape_materialized_event_id`); `None` when the anchor has never been materialized (the delta then counts from the beginning).
+    attr_accessor :watermark
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'anchor_id' => :'anchor_id',
+        :'anchor_table' => :'anchor_table',
+        :'cogmap_id' => :'cogmap_id',
+        :'exceeds_threshold' => :'exceeds_threshold',
+        :'formation_events' => :'formation_events',
+        :'threshold' => :'threshold',
+        :'watermark' => :'watermark'
+      }
+    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
+      {
+        :'anchor_id' => :'String',
+        :'anchor_table' => :'String',
+        :'cogmap_id' => :'String',
+        :'exceeds_threshold' => :'Boolean',
+        :'formation_events' => :'Integer',
+        :'threshold' => :'Integer',
+        :'watermark' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cogmap_id',
+        :'watermark'
+      ])
+    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::MaterializeDelta` 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::MaterializeDelta`. 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?(:'anchor_id')
+        self.anchor_id = attributes[:'anchor_id']
+      else
+        self.anchor_id = nil
+      end
+
+      if attributes.key?(:'anchor_table')
+        self.anchor_table = attributes[:'anchor_table']
+      else
+        self.anchor_table = nil
+      end
+
+      if attributes.key?(:'cogmap_id')
+        self.cogmap_id = attributes[:'cogmap_id']
+      end
+
+      if attributes.key?(:'exceeds_threshold')
+        self.exceeds_threshold = attributes[:'exceeds_threshold']
+      else
+        self.exceeds_threshold = nil
+      end
+
+      if attributes.key?(:'formation_events')
+        self.formation_events = attributes[:'formation_events']
+      else
+        self.formation_events = nil
+      end
+
+      if attributes.key?(:'threshold')
+        self.threshold = attributes[:'threshold']
+      else
+        self.threshold = nil
+      end
+
+      if attributes.key?(:'watermark')
+        self.watermark = attributes[:'watermark']
+      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 @anchor_id.nil?
+        invalid_properties.push('invalid value for "anchor_id", anchor_id cannot be nil.')
+      end
+
+      if @anchor_table.nil?
+        invalid_properties.push('invalid value for "anchor_table", anchor_table cannot be nil.')
+      end
+
+      if @exceeds_threshold.nil?
+        invalid_properties.push('invalid value for "exceeds_threshold", exceeds_threshold cannot be nil.')
+      end
+
+      if @formation_events.nil?
+        invalid_properties.push('invalid value for "formation_events", formation_events cannot be nil.')
+      end
+
+      if @threshold.nil?
+        invalid_properties.push('invalid value for "threshold", threshold 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 @anchor_id.nil?
+      return false if @anchor_table.nil?
+      return false if @exceeds_threshold.nil?
+      return false if @formation_events.nil?
+      return false if @threshold.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anchor_id Value to be assigned
+    def anchor_id=(anchor_id)
+      if anchor_id.nil?
+        fail ArgumentError, 'anchor_id cannot be nil'
+      end
+
+      @anchor_id = anchor_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anchor_table Value to be assigned
+    def anchor_table=(anchor_table)
+      if anchor_table.nil?
+        fail ArgumentError, 'anchor_table cannot be nil'
+      end
+
+      @anchor_table = anchor_table
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] exceeds_threshold Value to be assigned
+    def exceeds_threshold=(exceeds_threshold)
+      if exceeds_threshold.nil?
+        fail ArgumentError, 'exceeds_threshold cannot be nil'
+      end
+
+      @exceeds_threshold = exceeds_threshold
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] formation_events Value to be assigned
+    def formation_events=(formation_events)
+      if formation_events.nil?
+        fail ArgumentError, 'formation_events cannot be nil'
+      end
+
+      @formation_events = formation_events
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] threshold Value to be assigned
+    def threshold=(threshold)
+      if threshold.nil?
+        fail ArgumentError, 'threshold cannot be nil'
+      end
+
+      @threshold = threshold
+    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 &&
+          anchor_id == o.anchor_id &&
+          anchor_table == o.anchor_table &&
+          cogmap_id == o.cogmap_id &&
+          exceeds_threshold == o.exceeds_threshold &&
+          formation_events == o.formation_events &&
+          threshold == o.threshold &&
+          watermark == o.watermark
+    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
+      [anchor_id, anchor_table, cogmap_id, exceeds_threshold, formation_events, threshold, watermark].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