incident_io_api 2.22.0 → 2.24.0

data/lib/incident_io/models/glossary_entry_v2.rb

@@ -0,0 +1,319 @@
+=begin
+#incident.io
+
+#Ruby client for the incident.io API.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module IncidentIo
+  # A glossary entry is one term an organisation has coined — an acronym, a service name, or a piece of internal jargon — and the description of what it means.  AI features use the glossary, in rank order, so they understand those terms. Lower ranks come first. Deleting an entry archives it, which frees the term so it can be coined again as a new entry.
+  class GlossaryEntryV2 < ApiModelBase
+    # When the entry was created
+    attr_accessor :created_at
+
+    # What the term means
+    attr_accessor :description
+
+    # Unique identifier for this glossary entry
+    attr_accessor :id
+
+    # The term, e.g. an acronym or service name
+    attr_accessor :item
+
+    # The entry's position in the glossary
+    attr_accessor :rank
+
+    # When the entry was last updated
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'created_at' => :'created_at',
+        :'description' => :'description',
+        :'id' => :'id',
+        :'item' => :'item',
+        :'rank' => :'rank',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'created_at' => :'Time',
+        :'description' => :'String',
+        :'id' => :'String',
+        :'item' => :'String',
+        :'rank' => :'Integer',
+        :'updated_at' => :'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 `IncidentIo::GlossaryEntryV2` 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 `IncidentIo::GlossaryEntryV2`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'item')
+        self.item = attributes[:'item']
+      else
+        self.item = nil
+      end
+
+      if attributes.key?(:'rank')
+        self.rank = attributes[:'rank']
+      else
+        self.rank = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @item.nil?
+        invalid_properties.push('invalid value for "item", item cannot be nil.')
+      end
+
+      if @item.to_s.length > 128
+        invalid_properties.push('invalid value for "item", the character length must be smaller than or equal to 128.')
+      end
+
+      if @rank.nil?
+        invalid_properties.push('invalid value for "rank", rank cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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_at.nil?
+      return false if @description.nil?
+      return false if @description.to_s.length > 2000
+      return false if @id.nil?
+      return false if @item.nil?
+      return false if @item.to_s.length > 128
+      return false if @rank.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    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] item Value to be assigned
+    def item=(item)
+      if item.nil?
+        fail ArgumentError, 'item cannot be nil'
+      end
+
+      if item.to_s.length > 128
+        fail ArgumentError, 'invalid value for "item", the character length must be smaller than or equal to 128.'
+      end
+
+      @item = item
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rank Value to be assigned
+    def rank=(rank)
+      if rank.nil?
+        fail ArgumentError, 'rank cannot be nil'
+      end
+
+      @rank = rank
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          created_at == o.created_at &&
+          description == o.description &&
+          id == o.id &&
+          item == o.item &&
+          rank == o.rank &&
+          updated_at == o.updated_at
+    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
+      [created_at, description, id, item, rank, updated_at].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/incident_io/version.rb

@@ -4,5 +4,5 @@ module IncidentIo
   # The release workflow sets this before building, so it tracks whatever we
   # last published. Listed in .openapi-generator-ignore so regeneration can't
   # reset it.
-  VERSION = "2.22.0"
+  VERSION = "2.24.0"
 end

data/lib/incident_io.rb

@@ -768,6 +768,16 @@ IncidentIo.autoload :FollowUpsUpdatePayloadV2, 'incident_io/models/follow_ups_up
 IncidentIo.autoload :FollowUpsUpdatePayloadV3, 'incident_io/models/follow_ups_update_payload_v3'
 IncidentIo.autoload :FollowUpsUpdateResultV2, 'incident_io/models/follow_ups_update_result_v2'
 IncidentIo.autoload :FollowUpsUpdateResultV3, 'incident_io/models/follow_ups_update_result_v3'
+IncidentIo.autoload :GlossaryEntriesCreatePayloadV2, 'incident_io/models/glossary_entries_create_payload_v2'
+IncidentIo.autoload :GlossaryEntriesCreateResultV2, 'incident_io/models/glossary_entries_create_result_v2'
+IncidentIo.autoload :GlossaryEntriesListResultV2, 'incident_io/models/glossary_entries_list_result_v2'
+IncidentIo.autoload :GlossaryEntriesShowResultV2, 'incident_io/models/glossary_entries_show_result_v2'
+IncidentIo.autoload :GlossaryEntriesUpdatePayloadV2, 'incident_io/models/glossary_entries_update_payload_v2'
+IncidentIo.autoload :GlossaryEntriesUpdateRanksPayloadV2, 'incident_io/models/glossary_entries_update_ranks_payload_v2'
+IncidentIo.autoload :GlossaryEntriesUpdateRanksResultV2, 'incident_io/models/glossary_entries_update_ranks_result_v2'
+IncidentIo.autoload :GlossaryEntriesUpdateResultV2, 'incident_io/models/glossary_entries_update_result_v2'
+IncidentIo.autoload :GlossaryEntryRankUpdateV2, 'incident_io/models/glossary_entry_rank_update_v2'
+IncidentIo.autoload :GlossaryEntryV2, 'incident_io/models/glossary_entry_v2'
 IncidentIo.autoload :GroupingKeyV2, 'incident_io/models/grouping_key_v2'
 IncidentIo.autoload :GroupingKeyV3, 'incident_io/models/grouping_key_v3'
 IncidentIo.autoload :GroupingSettingsV3, 'incident_io/models/grouping_settings_v3'
@@ -1268,6 +1278,7 @@ IncidentIo.autoload :EscalationPathTemplatesV2Api, 'incident_io/api/escalation_p
 IncidentIo.autoload :EscalationsV2Api, 'incident_io/api/escalations_v2_api'
 IncidentIo.autoload :FollowUpsV2Api, 'incident_io/api/follow_ups_v2_api'
 IncidentIo.autoload :FollowUpsV3Api, 'incident_io/api/follow_ups_v3_api'
+IncidentIo.autoload :GlossaryEntriesV2Api, 'incident_io/api/glossary_entries_v2_api'
 IncidentIo.autoload :HeartbeatV2Api, 'incident_io/api/heartbeat_v2_api'
 IncidentIo.autoload :IPAllowlistsV1Api, 'incident_io/api/ip_allowlists_v1_api'
 IncidentIo.autoload :IncidentActivityLogEntriesV2Api, 'incident_io/api/incident_activity_log_entries_v2_api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: incident_io_api
 version: !ruby/object:Gem::Version
-  version: 2.22.0
+  version: 2.24.0
 platform: ruby
 authors:
 - incident.io
@@ -100,6 +100,7 @@ files:
 - lib/incident_io/api/escalations_v2_api.rb
 - lib/incident_io/api/follow_ups_v2_api.rb
 - lib/incident_io/api/follow_ups_v3_api.rb
+- lib/incident_io/api/glossary_entries_v2_api.rb
 - lib/incident_io/api/heartbeat_v2_api.rb
 - lib/incident_io/api/incident_activity_log_entries_v2_api.rb
 - lib/incident_io/api/incident_attachments_v1_api.rb
@@ -894,6 +895,16 @@ files:
 - lib/incident_io/models/follow_ups_update_payload_v3.rb
 - lib/incident_io/models/follow_ups_update_result_v2.rb
 - lib/incident_io/models/follow_ups_update_result_v3.rb
+- lib/incident_io/models/glossary_entries_create_payload_v2.rb
+- lib/incident_io/models/glossary_entries_create_result_v2.rb
+- lib/incident_io/models/glossary_entries_list_result_v2.rb
+- lib/incident_io/models/glossary_entries_show_result_v2.rb
+- lib/incident_io/models/glossary_entries_update_payload_v2.rb
+- lib/incident_io/models/glossary_entries_update_ranks_payload_v2.rb
+- lib/incident_io/models/glossary_entries_update_ranks_result_v2.rb
+- lib/incident_io/models/glossary_entries_update_result_v2.rb
+- lib/incident_io/models/glossary_entry_rank_update_v2.rb
+- lib/incident_io/models/glossary_entry_v2.rb
 - lib/incident_io/models/grouping_key_v2.rb
 - lib/incident_io/models/grouping_key_v3.rb
 - lib/incident_io/models/grouping_settings_v3.rb