temper-rb 0.5.1

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

@@ -0,0 +1,404 @@
+=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
+  # Response row for context endpoints.
+  class ContextRow < ApiModelBase
+    # Whether the reading principal may **author into** this context — `context_authorable_by_profile`, which is also the container-write cascade arm of `can_modify_resource`. Because that arm keys on the **home**, not the resource, this one boolean answers the cascade for every resource homed here, which is why authority is carried on the container read rather than on every response that carries a resource.  **Read is strictly broader than this.** A `watcher`, and a read-only grant, reach the context and do not author it, so this must never be derived from visibility. See migration `20260712000010`'s `COMMENT ON FUNCTION`.  **Not the whole write gate.** `can_modify_resource` also admits the resource's home owner and explicit per-resource grants. A surface deriving offerability from this must union it with the owner check (`ResourceView.owner_profile_id`) under the `is_active` floor, and accepts that a reader whose only authority is a per-resource grant is not covered.
+    attr_accessor :can_write
+
+    attr_accessor :created
+
+    # A `kb_contexts.id` value.
+    attr_accessor :id
+
+    attr_accessor :kb_owner_id
+
+    attr_accessor :kb_owner_table
+
+    attr_accessor :name
+
+    # The already-sigil'd owner addressable: `@<handle>` for profiles, `+<team-slug>` for teams. Together with `slug`, forms the full decorated context ref `{owner_ref}/{slug}`.
+    attr_accessor :owner_ref
+
+    # Whether this context is retired — invisible to every read path and unwriteable, with every row it homes preserved.  **Polarity is inverted from the column on purpose.** The database stores `is_active`, mirroring `kb_teams`; the wire says `retired`, which is the word the product uses. The inversion is written as the identical SQL literal `NOT c.is_active AS \"retired!\"` in every query that selects this column — the two read-axis queries (`list_visible`, `get_visible`, always `false` there by construction) and the two admin-axis queries (`list_retired_administered`, `get_retired_administered`) — and is never re-derived any other way, e.g. never inverted in Rust after the fact.
+    attr_accessor :retired
+
+    # The context's per-owner-unique slug (the natural-key half of `@owner/slug`).
+    attr_accessor :slug
+
+    attr_accessor :updated
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'can_write' => :'can_write',
+        :'created' => :'created',
+        :'id' => :'id',
+        :'kb_owner_id' => :'kb_owner_id',
+        :'kb_owner_table' => :'kb_owner_table',
+        :'name' => :'name',
+        :'owner_ref' => :'owner_ref',
+        :'retired' => :'retired',
+        :'slug' => :'slug',
+        :'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
+      {
+        :'can_write' => :'Boolean',
+        :'created' => :'Time',
+        :'id' => :'String',
+        :'kb_owner_id' => :'String',
+        :'kb_owner_table' => :'String',
+        :'name' => :'String',
+        :'owner_ref' => :'String',
+        :'retired' => :'Boolean',
+        :'slug' => :'String',
+        :'updated' => :'Time'
+      }
+    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::ContextRow` 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::ContextRow`. 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?(:'can_write')
+        self.can_write = attributes[:'can_write']
+      else
+        self.can_write = nil
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      else
+        self.created = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'kb_owner_id')
+        self.kb_owner_id = attributes[:'kb_owner_id']
+      else
+        self.kb_owner_id = nil
+      end
+
+      if attributes.key?(:'kb_owner_table')
+        self.kb_owner_table = attributes[:'kb_owner_table']
+      else
+        self.kb_owner_table = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'owner_ref')
+        self.owner_ref = attributes[:'owner_ref']
+      else
+        self.owner_ref = nil
+      end
+
+      if attributes.key?(:'retired')
+        self.retired = attributes[:'retired']
+      else
+        self.retired = nil
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      else
+        self.slug = 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 @can_write.nil?
+        invalid_properties.push('invalid value for "can_write", can_write cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @kb_owner_id.nil?
+        invalid_properties.push('invalid value for "kb_owner_id", kb_owner_id cannot be nil.')
+      end
+
+      if @kb_owner_table.nil?
+        invalid_properties.push('invalid value for "kb_owner_table", kb_owner_table cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @owner_ref.nil?
+        invalid_properties.push('invalid value for "owner_ref", owner_ref cannot be nil.')
+      end
+
+      if @retired.nil?
+        invalid_properties.push('invalid value for "retired", retired cannot be nil.')
+      end
+
+      if @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug 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 @can_write.nil?
+      return false if @created.nil?
+      return false if @id.nil?
+      return false if @kb_owner_id.nil?
+      return false if @kb_owner_table.nil?
+      return false if @name.nil?
+      return false if @owner_ref.nil?
+      return false if @retired.nil?
+      return false if @slug.nil?
+      return false if @updated.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] can_write Value to be assigned
+    def can_write=(can_write)
+      if can_write.nil?
+        fail ArgumentError, 'can_write cannot be nil'
+      end
+
+      @can_write = can_write
+    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] 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] kb_owner_id Value to be assigned
+    def kb_owner_id=(kb_owner_id)
+      if kb_owner_id.nil?
+        fail ArgumentError, 'kb_owner_id cannot be nil'
+      end
+
+      @kb_owner_id = kb_owner_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kb_owner_table Value to be assigned
+    def kb_owner_table=(kb_owner_table)
+      if kb_owner_table.nil?
+        fail ArgumentError, 'kb_owner_table cannot be nil'
+      end
+
+      @kb_owner_table = kb_owner_table
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_ref Value to be assigned
+    def owner_ref=(owner_ref)
+      if owner_ref.nil?
+        fail ArgumentError, 'owner_ref cannot be nil'
+      end
+
+      @owner_ref = owner_ref
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] retired Value to be assigned
+    def retired=(retired)
+      if retired.nil?
+        fail ArgumentError, 'retired cannot be nil'
+      end
+
+      @retired = retired
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] slug Value to be assigned
+    def slug=(slug)
+      if slug.nil?
+        fail ArgumentError, 'slug cannot be nil'
+      end
+
+      @slug = slug
+    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 &&
+          can_write == o.can_write &&
+          created == o.created &&
+          id == o.id &&
+          kb_owner_id == o.kb_owner_id &&
+          kb_owner_table == o.kb_owner_table &&
+          name == o.name &&
+          owner_ref == o.owner_ref &&
+          retired == o.retired &&
+          slug == o.slug &&
+          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
+      [can_write, created, id, kb_owner_id, kb_owner_table, name, owner_ref, retired, slug, 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