incident_io_api 2.10.0 → 2.11.0

data/lib/incident_io/models/audit_log_investigation_trigger_metadata_v2.rb

@@ -0,0 +1,293 @@
+=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
+  class AuditLogInvestigationTriggerMetadataV2 < ApiModelBase
+    # Whether the investigation waits for the trigger to finish before moving on (true, false)
+    attr_accessor :blocks
+
+    # Whether the trigger fires (true, false)
+    attr_accessor :enabled
+
+    # How often the trigger fires across one investigation
+    attr_accessor :frequency
+
+    # When in an investigation the trigger runs
+    attr_accessor :moment
+
+    # The extension plugin holding the skill the trigger runs, absent for a trigger that only gives a task
+    attr_accessor :plugin_id
+
+    # The skill directory the trigger runs, absent when the trigger leaves the choice of skill to the investigation
+    attr_accessor :skill
+
+    # Whether the trigger hands the agent a task of its own (true, false)
+    attr_accessor :task_set
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'blocks' => :'blocks',
+        :'enabled' => :'enabled',
+        :'frequency' => :'frequency',
+        :'moment' => :'moment',
+        :'plugin_id' => :'plugin_id',
+        :'skill' => :'skill',
+        :'task_set' => :'task_set'
+      }
+    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
+      {
+        :'blocks' => :'String',
+        :'enabled' => :'String',
+        :'frequency' => :'String',
+        :'moment' => :'String',
+        :'plugin_id' => :'String',
+        :'skill' => :'String',
+        :'task_set' => :'String'
+      }
+    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::AuditLogInvestigationTriggerMetadataV2` 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::AuditLogInvestigationTriggerMetadataV2`. 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?(:'blocks')
+        self.blocks = attributes[:'blocks']
+      else
+        self.blocks = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'frequency')
+        self.frequency = attributes[:'frequency']
+      else
+        self.frequency = nil
+      end
+
+      if attributes.key?(:'moment')
+        self.moment = attributes[:'moment']
+      else
+        self.moment = nil
+      end
+
+      if attributes.key?(:'plugin_id')
+        self.plugin_id = attributes[:'plugin_id']
+      end
+
+      if attributes.key?(:'skill')
+        self.skill = attributes[:'skill']
+      end
+
+      if attributes.key?(:'task_set')
+        self.task_set = attributes[:'task_set']
+      else
+        self.task_set = 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 @blocks.nil?
+        invalid_properties.push('invalid value for "blocks", blocks cannot be nil.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @frequency.nil?
+        invalid_properties.push('invalid value for "frequency", frequency cannot be nil.')
+      end
+
+      if @moment.nil?
+        invalid_properties.push('invalid value for "moment", moment cannot be nil.')
+      end
+
+      if @task_set.nil?
+        invalid_properties.push('invalid value for "task_set", task_set 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 @blocks.nil?
+      return false if @enabled.nil?
+      return false if @frequency.nil?
+      return false if @moment.nil?
+      return false if @task_set.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] blocks Value to be assigned
+    def blocks=(blocks)
+      if blocks.nil?
+        fail ArgumentError, 'blocks cannot be nil'
+      end
+
+      @blocks = blocks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'enabled cannot be nil'
+      end
+
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] frequency Value to be assigned
+    def frequency=(frequency)
+      if frequency.nil?
+        fail ArgumentError, 'frequency cannot be nil'
+      end
+
+      @frequency = frequency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] moment Value to be assigned
+    def moment=(moment)
+      if moment.nil?
+        fail ArgumentError, 'moment cannot be nil'
+      end
+
+      @moment = moment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] task_set Value to be assigned
+    def task_set=(task_set)
+      if task_set.nil?
+        fail ArgumentError, 'task_set cannot be nil'
+      end
+
+      @task_set = task_set
+    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 &&
+          blocks == o.blocks &&
+          enabled == o.enabled &&
+          frequency == o.frequency &&
+          moment == o.moment &&
+          plugin_id == o.plugin_id &&
+          skill == o.skill &&
+          task_set == o.task_set
+    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
+      [blocks, enabled, frequency, moment, plugin_id, skill, task_set].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/models/audit_log_target_v2.rb

@@ -21,7 +21,7 @@ module IncidentIo
     # The name of the target
     attr_accessor :name
 
-    # The type of target  Known values: `api_key`, `alert`, `alert_chat_message_template`, `alert_route`, `alert_schema`, `alert_source`, `alert_priority`, `announcement_rule`, `announcement_post_template`, `catalog_type`, `catalog_entry`, `catalog_attribute`, `connector_config`, `custom_field`, `debrief_invite_rule`, `escalation`, `escalation_path`, `escalation_path_template`, `extension_connector`, `extension_connector_tool`, `follow_up_category`, `follow_up_priority`, `holiday_user_feed`, `hris_time_off_policy`, `incident`, `incident_call_transcription_session`, `incident_call_setting`, `incident_duration_metric`, `incident_template`, `maintenance_window`, `incident_role`, `incident_status`, `incident_timestamp`, `incident_timestamp_set_by_rule`, `incident_type`, `integration`, `internal_status_page`, `ip_allowlist`, `nudge`, `on_call_notification_method`, `on_call_notification_pause`, `organisation`, `organisation_settings`, `schedule_override`, `schedule_sync_rule`, `schedule_sync_target`, `policy`, `policy_report_schedule`, `post_incident_task`, `postmortem_template`, `postmortem_template_section`, `private_incident_membership`, `rbac_role`, `scim_group`, `schedule`, `team_role`, `secret`, `severity`, `status_page`, `status_page_sub_page`, `status_page_template`, `team_settings`, `telemetry_data_source`, `twilio_connection`, `user`, `user_api_key`, `workflow`, `activity_log`, `timeline_item`, `on_call_upsell_request`
+    # The type of target  Known values: `api_key`, `alert`, `alert_chat_message_template`, `alert_route`, `alert_schema`, `alert_source`, `alert_priority`, `announcement_rule`, `announcement_post_template`, `catalog_type`, `catalog_entry`, `catalog_attribute`, `connector_config`, `custom_field`, `debrief_invite_rule`, `escalation`, `escalation_path`, `escalation_path_template`, `extension_connector`, `extension_connector_tool`, `extension_plugin`, `glossary_entry`, `investigation_trigger`, `follow_up_category`, `follow_up_priority`, `holiday_user_feed`, `hris_time_off_policy`, `incident`, `incident_call_transcription_session`, `incident_call_setting`, `incident_duration_metric`, `incident_template`, `maintenance_window`, `incident_role`, `incident_status`, `incident_timestamp`, `incident_timestamp_set_by_rule`, `incident_type`, `integration`, `internal_status_page`, `ip_allowlist`, `nudge`, `on_call_notification_method`, `on_call_notification_pause`, `organisation`, `organisation_settings`, `schedule_override`, `schedule_sync_rule`, `schedule_sync_target`, `policy`, `policy_report_schedule`, `post_incident_task`, `postmortem_template`, `postmortem_template_section`, `private_incident_membership`, `rbac_role`, `scim_group`, `schedule`, `team_role`, `secret`, `severity`, `status_page`, `status_page_sub_page`, `status_page_template`, `team_settings`, `telemetry_data_source`, `twilio_connection`, `user`, `user_api_key`, `workflow`, `activity_log`, `timeline_item`, `on_call_upsell_request`
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/incident_io/models/audit_logs_extension_plugin_created_v1.rb

@@ -0,0 +1,326 @@
+=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
+  class AuditLogsExtensionPluginCreatedV1 < ApiModelBase
+    # The type of log entry that this is
+    attr_accessor :action
+
+    attr_accessor :actor
+
+    attr_accessor :context
+
+    attr_accessor :metadata
+
+    # When the entry occurred
+    attr_accessor :occurred_at
+
+    # The custom field that was created
+    attr_accessor :targets
+
+    # Which version the event is
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'actor' => :'actor',
+        :'context' => :'context',
+        :'metadata' => :'metadata',
+        :'occurred_at' => :'occurred_at',
+        :'targets' => :'targets',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'action' => :'String',
+        :'actor' => :'AuditLogActorV2',
+        :'context' => :'AuditLogEntryContextV2',
+        :'metadata' => :'AuditLogExtensionPluginCreatedMetadataV2',
+        :'occurred_at' => :'Time',
+        :'targets' => :'Array<AuditLogTargetV2>',
+        :'version' => :'Integer'
+      }
+    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::AuditLogsExtensionPluginCreatedV1` 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::AuditLogsExtensionPluginCreatedV1`. 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?(:'action')
+        self.action = attributes[:'action']
+      else
+        self.action = nil
+      end
+
+      if attributes.key?(:'actor')
+        self.actor = attributes[:'actor']
+      else
+        self.actor = nil
+      end
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      else
+        self.context = nil
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      else
+        self.metadata = nil
+      end
+
+      if attributes.key?(:'occurred_at')
+        self.occurred_at = attributes[:'occurred_at']
+      else
+        self.occurred_at = nil
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      else
+        self.targets = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = 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 @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @actor.nil?
+        invalid_properties.push('invalid value for "actor", actor cannot be nil.')
+      end
+
+      if @context.nil?
+        invalid_properties.push('invalid value for "context", context cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @occurred_at.nil?
+        invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
+      end
+
+      if @targets.nil?
+        invalid_properties.push('invalid value for "targets", targets cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version 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 @action.nil?
+      return false if @actor.nil?
+      return false if @context.nil?
+      return false if @metadata.nil?
+      return false if @occurred_at.nil?
+      return false if @targets.nil?
+      return false if @version.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] action Value to be assigned
+    def action=(action)
+      if action.nil?
+        fail ArgumentError, 'action cannot be nil'
+      end
+
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actor Value to be assigned
+    def actor=(actor)
+      if actor.nil?
+        fail ArgumentError, 'actor cannot be nil'
+      end
+
+      @actor = actor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] context Value to be assigned
+    def context=(context)
+      if context.nil?
+        fail ArgumentError, 'context cannot be nil'
+      end
+
+      @context = context
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] occurred_at Value to be assigned
+    def occurred_at=(occurred_at)
+      if occurred_at.nil?
+        fail ArgumentError, 'occurred_at cannot be nil'
+      end
+
+      @occurred_at = occurred_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] targets Value to be assigned
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'targets cannot be nil'
+      end
+
+      @targets = targets
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      @version = version
+    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 &&
+          action == o.action &&
+          actor == o.actor &&
+          context == o.context &&
+          metadata == o.metadata &&
+          occurred_at == o.occurred_at &&
+          targets == o.targets &&
+          version == o.version
+    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
+      [action, actor, context, metadata, occurred_at, targets, version].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