temper-rb 0.5.1

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

@@ -0,0 +1,592 @@
+=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
+  # Everything a resource is, except its body — one shape for every read and write surface.  Replaces the six near-identical projections a caller used to have to tell apart (`ResourceRow`, `ResourceDetail`, `ResourceMetaResponse`, `ResourceSummary`, the search `HitIdentity`, and the inlined identity half of `ExactHit`/`WideHit`). A human or agent learns this shape once and it is the shape `list`, `show`, `create`, `update`, `annotate` and both search arms all answer in.  Three properties are load-bearing and each has its own test below:  1. **The anchor is `id`, never `resource_id`.** The retired `ResourceMetaResponse`    recorded why: \"With two different anchor names the subset relation is unachievable.\"    Here the relation is stronger than subset — it is identity. 2. **No workflow field is hoisted.** `stage`/`mode`/`effort`/`seq` were flat columns on    `ResourceRow`; they live in [`ManagedMeta`] under their canonical `temper-*` names and    nowhere else. Dropping them is lossless *because* of property 3. 3. **`managed_meta` is not an `Option`.** A consumer reads `view.managed_meta.stage`    without first distinguishing \"no meta\" from \"no stage\".  **No `#[serde(flatten)]` anywhere**, deliberately: ts-rs cannot codegen a flattened field, which is why `ResourceDetail` had to drop its `TS` derive and why the identity fields on `ExactHit`/`WideHit` were hand-inlined. This type is ts-rs-exported, so the constraint is structural, not stylistic.  **No `FromRow` derive, deliberately.** `ref` and `context_ref` are derived rather than selected and `content` arrives from a different read, so a `query_as` into this type could never be complete. `ResourceRow` carried a `FromRow` derive with **zero** `query_as` call sites anywhere in the repo — decorative, and an invitation to try something that cannot work. Construction is by hand, as `substrate_read` already does.
+  class ResourceView < ApiModelBase
+    # SHA-256 hash of the resource body, from `kb_resource_manifests`. `None` when no manifest row exists.
+    attr_accessor :body_hash
+
+    # Do the bytes read back exactly, or only approximately? `Option` purely for version skew, as with `ingest_state`.
+    attr_accessor :body_storage
+
+    # Set when the resource is homed in a cognitive map. Mutually exclusive with the `context_*` fields.
+    attr_accessor :cogmap_id
+
+    # Display name of the home cognitive map. `Some` iff `cogmap_id` is `Some`.
+    attr_accessor :cogmap_name
+
+    # The reconstructed markdown body — the `body` section.  Absent means **not requested**, never \"empty body\". An empty body is `Some(String::new())`, which serializes as `\"\"`; the two are distinguishable on the wire and after a round-trip.
+    attr_accessor :content
+
+    attr_accessor :context_name
+
+    # Already-sigil'd owner: `@<handle>` for profiles, `+<team-slug>` for teams.
+    attr_accessor :context_owner_ref
+
+    # The composed home-context address, `{context_owner_ref}/{context_slug}`.  Not a column — derived by [`ResourceView::with_derived_refs`]. `None` for a cogmap-homed resource, which has no context half; never a half-formed ref.
+    attr_accessor :context_ref
+
+    # Slug of the home context (the natural-key half of `@owner/slug`).
+    attr_accessor :context_slug
+
+    attr_accessor :created
+
+    attr_accessor :doc_type_name
+
+    # A `kb_resources.id` value.
+    attr_accessor :id
+
+    # Are all the bytes here? `Option` purely for version skew — the column is `NOT NULL` server-side, so `None` means the server predates W2 PR 1. Do not read `None` as \"incomplete\".
+    attr_accessor :ingest_state
+
+    attr_accessor :is_active
+
+    # `Some` for a context-homed resource, `None` when homed in a cognitive map (Surface B). Mutually exclusive with the `cogmap_*` fields.
+    attr_accessor :kb_context_id
+
+    # Typed managed (`temper-*`) frontmatter — the closed Property vocabulary.  **Not an `Option`.** This is what makes dropping the hoisted `stage`/`mode`/ `effort`/`seq` columns lossless: the values did not go away, they went home. A resource with no managed metadata carries an all-`None` `ManagedMeta`, which serializes as `{}` — present and empty, never absent.
+    attr_accessor :managed_meta
+
+    attr_accessor :open_meta
+
+    # Original source URL or file reference.  There is deliberately no `kb_uri` beside this. `ExactHit`/`WideHit` carried one whose doc comment promised a \"canonical `kb://` URI ... from `kb_resource_uri`\", but `kb_resource_uri` does not exist in `migrations/` and the assembly wrote `kb_uri: self.origin_uri.clone()` (`substrate_read.rs:898,912`) — the same value under a second name and a false description. It joins `origin` (the constant `\"unified\"`) and `slug` (always `String::new()`) as a field this arc dropped for never having carried what it claimed.
+    attr_accessor :origin_uri
+
+    # A `kb_profiles.id` value.
+    attr_accessor :originator_profile_id
+
+    attr_accessor :owner_handle
+
+    # A `kb_profiles.id` value.
+    attr_accessor :owner_profile_id
+
+    # The decorated, self-resolving address: `sluggify(title)-<uuid>`.  Not a column — derived by [`ResourceView::with_derived_refs`] from `title` + `id`. Until this task it was injected render-time by the CLI alone (`temper-cli/src/commands/resource.rs`), so MCP callers never received one even though the shipped skill instructs agents to use it.
+    attr_accessor :ref
+
+    attr_accessor :title
+
+    attr_accessor :updated
+
+    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
+      {
+        :'body_hash' => :'body_hash',
+        :'body_storage' => :'body_storage',
+        :'cogmap_id' => :'cogmap_id',
+        :'cogmap_name' => :'cogmap_name',
+        :'content' => :'content',
+        :'context_name' => :'context_name',
+        :'context_owner_ref' => :'context_owner_ref',
+        :'context_ref' => :'context_ref',
+        :'context_slug' => :'context_slug',
+        :'created' => :'created',
+        :'doc_type_name' => :'doc_type_name',
+        :'id' => :'id',
+        :'ingest_state' => :'ingest_state',
+        :'is_active' => :'is_active',
+        :'kb_context_id' => :'kb_context_id',
+        :'managed_meta' => :'managed_meta',
+        :'open_meta' => :'open_meta',
+        :'origin_uri' => :'origin_uri',
+        :'originator_profile_id' => :'originator_profile_id',
+        :'owner_handle' => :'owner_handle',
+        :'owner_profile_id' => :'owner_profile_id',
+        :'ref' => :'ref',
+        :'title' => :'title',
+        :'updated' => :'updated'
+      }
+    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
+      {
+        :'body_hash' => :'String',
+        :'body_storage' => :'BodyStorage',
+        :'cogmap_id' => :'String',
+        :'cogmap_name' => :'String',
+        :'content' => :'String',
+        :'context_name' => :'String',
+        :'context_owner_ref' => :'String',
+        :'context_ref' => :'String',
+        :'context_slug' => :'String',
+        :'created' => :'Time',
+        :'doc_type_name' => :'String',
+        :'id' => :'String',
+        :'ingest_state' => :'IngestState',
+        :'is_active' => :'Boolean',
+        :'kb_context_id' => :'String',
+        :'managed_meta' => :'ManagedMeta',
+        :'open_meta' => :'Object',
+        :'origin_uri' => :'String',
+        :'originator_profile_id' => :'String',
+        :'owner_handle' => :'String',
+        :'owner_profile_id' => :'String',
+        :'ref' => :'String',
+        :'title' => :'String',
+        :'updated' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'body_hash',
+        :'body_storage',
+        :'cogmap_id',
+        :'cogmap_name',
+        :'content',
+        :'context_name',
+        :'context_owner_ref',
+        :'context_ref',
+        :'context_slug',
+        :'ingest_state',
+        :'kb_context_id',
+        :'open_meta',
+      ])
+    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::ResourceView` 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::ResourceView`. 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?(:'body_hash')
+        self.body_hash = attributes[:'body_hash']
+      end
+
+      if attributes.key?(:'body_storage')
+        self.body_storage = attributes[:'body_storage']
+      end
+
+      if attributes.key?(:'cogmap_id')
+        self.cogmap_id = attributes[:'cogmap_id']
+      end
+
+      if attributes.key?(:'cogmap_name')
+        self.cogmap_name = attributes[:'cogmap_name']
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'context_name')
+        self.context_name = attributes[:'context_name']
+      end
+
+      if attributes.key?(:'context_owner_ref')
+        self.context_owner_ref = attributes[:'context_owner_ref']
+      end
+
+      if attributes.key?(:'context_ref')
+        self.context_ref = attributes[:'context_ref']
+      end
+
+      if attributes.key?(:'context_slug')
+        self.context_slug = attributes[:'context_slug']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      else
+        self.created = nil
+      end
+
+      if attributes.key?(:'doc_type_name')
+        self.doc_type_name = attributes[:'doc_type_name']
+      else
+        self.doc_type_name = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'ingest_state')
+        self.ingest_state = attributes[:'ingest_state']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      else
+        self.is_active = nil
+      end
+
+      if attributes.key?(:'kb_context_id')
+        self.kb_context_id = attributes[:'kb_context_id']
+      end
+
+      if attributes.key?(:'managed_meta')
+        self.managed_meta = attributes[:'managed_meta']
+      end
+
+      if attributes.key?(:'open_meta')
+        self.open_meta = attributes[:'open_meta']
+      end
+
+      if attributes.key?(:'origin_uri')
+        self.origin_uri = attributes[:'origin_uri']
+      else
+        self.origin_uri = nil
+      end
+
+      if attributes.key?(:'originator_profile_id')
+        self.originator_profile_id = attributes[:'originator_profile_id']
+      else
+        self.originator_profile_id = nil
+      end
+
+      if attributes.key?(:'owner_handle')
+        self.owner_handle = attributes[:'owner_handle']
+      else
+        self.owner_handle = nil
+      end
+
+      if attributes.key?(:'owner_profile_id')
+        self.owner_profile_id = attributes[:'owner_profile_id']
+      else
+        self.owner_profile_id = nil
+      end
+
+      if attributes.key?(:'ref')
+        self.ref = attributes[:'ref']
+      else
+        self.ref = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      else
+        self.updated = 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 @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @doc_type_name.nil?
+        invalid_properties.push('invalid value for "doc_type_name", doc_type_name cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @is_active.nil?
+        invalid_properties.push('invalid value for "is_active", is_active cannot be nil.')
+      end
+
+      if @origin_uri.nil?
+        invalid_properties.push('invalid value for "origin_uri", origin_uri cannot be nil.')
+      end
+
+      if @originator_profile_id.nil?
+        invalid_properties.push('invalid value for "originator_profile_id", originator_profile_id cannot be nil.')
+      end
+
+      if @owner_handle.nil?
+        invalid_properties.push('invalid value for "owner_handle", owner_handle cannot be nil.')
+      end
+
+      if @owner_profile_id.nil?
+        invalid_properties.push('invalid value for "owner_profile_id", owner_profile_id cannot be nil.')
+      end
+
+      if @ref.nil?
+        invalid_properties.push('invalid value for "ref", ref cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @updated.nil?
+        invalid_properties.push('invalid value for "updated", updated 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 @created.nil?
+      return false if @doc_type_name.nil?
+      return false if @id.nil?
+      return false if @is_active.nil?
+      return false if @origin_uri.nil?
+      return false if @originator_profile_id.nil?
+      return false if @owner_handle.nil?
+      return false if @owner_profile_id.nil?
+      return false if @ref.nil?
+      return false if @title.nil?
+      return false if @updated.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created Value to be assigned
+    def created=(created)
+      if created.nil?
+        fail ArgumentError, 'created cannot be nil'
+      end
+
+      @created = created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] doc_type_name Value to be assigned
+    def doc_type_name=(doc_type_name)
+      if doc_type_name.nil?
+        fail ArgumentError, 'doc_type_name cannot be nil'
+      end
+
+      @doc_type_name = doc_type_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_active Value to be assigned
+    def is_active=(is_active)
+      if is_active.nil?
+        fail ArgumentError, 'is_active cannot be nil'
+      end
+
+      @is_active = is_active
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] origin_uri Value to be assigned
+    def origin_uri=(origin_uri)
+      if origin_uri.nil?
+        fail ArgumentError, 'origin_uri cannot be nil'
+      end
+
+      @origin_uri = origin_uri
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] originator_profile_id Value to be assigned
+    def originator_profile_id=(originator_profile_id)
+      if originator_profile_id.nil?
+        fail ArgumentError, 'originator_profile_id cannot be nil'
+      end
+
+      @originator_profile_id = originator_profile_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_handle Value to be assigned
+    def owner_handle=(owner_handle)
+      if owner_handle.nil?
+        fail ArgumentError, 'owner_handle cannot be nil'
+      end
+
+      @owner_handle = owner_handle
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_profile_id Value to be assigned
+    def owner_profile_id=(owner_profile_id)
+      if owner_profile_id.nil?
+        fail ArgumentError, 'owner_profile_id cannot be nil'
+      end
+
+      @owner_profile_id = owner_profile_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ref Value to be assigned
+    def ref=(ref)
+      if ref.nil?
+        fail ArgumentError, 'ref cannot be nil'
+      end
+
+      @ref = ref
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated Value to be assigned
+    def updated=(updated)
+      if updated.nil?
+        fail ArgumentError, 'updated cannot be nil'
+      end
+
+      @updated = updated
+    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 &&
+          body_hash == o.body_hash &&
+          body_storage == o.body_storage &&
+          cogmap_id == o.cogmap_id &&
+          cogmap_name == o.cogmap_name &&
+          content == o.content &&
+          context_name == o.context_name &&
+          context_owner_ref == o.context_owner_ref &&
+          context_ref == o.context_ref &&
+          context_slug == o.context_slug &&
+          created == o.created &&
+          doc_type_name == o.doc_type_name &&
+          id == o.id &&
+          ingest_state == o.ingest_state &&
+          is_active == o.is_active &&
+          kb_context_id == o.kb_context_id &&
+          managed_meta == o.managed_meta &&
+          open_meta == o.open_meta &&
+          origin_uri == o.origin_uri &&
+          originator_profile_id == o.originator_profile_id &&
+          owner_handle == o.owner_handle &&
+          owner_profile_id == o.owner_profile_id &&
+          ref == o.ref &&
+          title == o.title &&
+          updated == o.updated
+    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
+      [body_hash, body_storage, cogmap_id, cogmap_name, content, context_name, context_owner_ref, context_ref, context_slug, created, doc_type_name, id, ingest_state, is_active, kb_context_id, managed_meta, open_meta, origin_uri, originator_profile_id, owner_handle, owner_profile_id, ref, title, updated].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