incident_io_api 2.8.0 → 2.9.0

data/lib/incident_io/models/incident_form_lifecycle_element_payload_v3.rb

@@ -0,0 +1,287 @@
+=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 IncidentFormLifecycleElementPayloadV3 < ApiModelBase
+    # Whether the user can explicitly choose no value. Only meaningful for custom field elements.
+    attr_accessor :can_select_no_value
+
+    attr_accessor :config
+
+    # The custom field this element edits. Set only when element_type is custom_field.
+    attr_accessor :custom_field_id
+
+    attr_accessor :default_value
+
+    # Description shown beside this element, as markdown
+    attr_accessor :description
+
+    # What this element captures  Known values: `name`, `status`, `severity`, `incident_role`, `incident_type`, `summary`, `custom_field`, `timestamp`, `update_message`, `next_update_in`, `triage`, `visibility`, `divider`, `text`, `incident_attachments`, `slack_channel`, `announce_retro_incident`, `enter_post_incident_flow`, `investigation_feedback`
+    attr_accessor :element_type
+
+    # Identifier of an existing divider or text element. Omit when adding an element.
+    attr_accessor :id
+
+    # The incident role this element assigns. Set only when element_type is incident_role.
+    attr_accessor :incident_role_id
+
+    # The incident timestamp this element sets. Set only when element_type is timestamp.
+    attr_accessor :incident_timestamp_id
+
+    # Placeholder text shown in the empty field
+    attr_accessor :placeholder
+
+    # When this element must be filled in  Known values: `check_engine_config`, `always_require`, `never_require`
+    attr_accessor :required_if
+
+    # Condition groups that make this element required. Used when required_if is check_engine_config.
+    attr_accessor :required_if_condition_groups
+
+    # The element is shown when any of these condition groups match. Unset means it is always shown.
+    attr_accessor :show_if_condition_groups
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'can_select_no_value' => :'can_select_no_value',
+        :'config' => :'config',
+        :'custom_field_id' => :'custom_field_id',
+        :'default_value' => :'default_value',
+        :'description' => :'description',
+        :'element_type' => :'element_type',
+        :'id' => :'id',
+        :'incident_role_id' => :'incident_role_id',
+        :'incident_timestamp_id' => :'incident_timestamp_id',
+        :'placeholder' => :'placeholder',
+        :'required_if' => :'required_if',
+        :'required_if_condition_groups' => :'required_if_condition_groups',
+        :'show_if_condition_groups' => :'show_if_condition_groups'
+      }
+    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_select_no_value' => :'Boolean',
+        :'config' => :'IncidentFormLifecycleElementConfigV3',
+        :'custom_field_id' => :'String',
+        :'default_value' => :'EngineParamBindingPayloadV3',
+        :'description' => :'String',
+        :'element_type' => :'String',
+        :'id' => :'String',
+        :'incident_role_id' => :'String',
+        :'incident_timestamp_id' => :'String',
+        :'placeholder' => :'String',
+        :'required_if' => :'String',
+        :'required_if_condition_groups' => :'Array<ConditionGroupPayloadV3>',
+        :'show_if_condition_groups' => :'Array<ConditionGroupPayloadV3>'
+      }
+    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::IncidentFormLifecycleElementPayloadV3` 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::IncidentFormLifecycleElementPayloadV3`. 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_select_no_value')
+        self.can_select_no_value = attributes[:'can_select_no_value']
+      end
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'custom_field_id')
+        self.custom_field_id = attributes[:'custom_field_id']
+      end
+
+      if attributes.key?(:'default_value')
+        self.default_value = attributes[:'default_value']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'element_type')
+        self.element_type = attributes[:'element_type']
+      else
+        self.element_type = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'incident_role_id')
+        self.incident_role_id = attributes[:'incident_role_id']
+      end
+
+      if attributes.key?(:'incident_timestamp_id')
+        self.incident_timestamp_id = attributes[:'incident_timestamp_id']
+      end
+
+      if attributes.key?(:'placeholder')
+        self.placeholder = attributes[:'placeholder']
+      end
+
+      if attributes.key?(:'required_if')
+        self.required_if = attributes[:'required_if']
+      end
+
+      if attributes.key?(:'required_if_condition_groups')
+        if (value = attributes[:'required_if_condition_groups']).is_a?(Array)
+          self.required_if_condition_groups = value
+        end
+      end
+
+      if attributes.key?(:'show_if_condition_groups')
+        if (value = attributes[:'show_if_condition_groups']).is_a?(Array)
+          self.show_if_condition_groups = value
+        end
+      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 @element_type.nil?
+        invalid_properties.push('invalid value for "element_type", element_type 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 @element_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] element_type Value to be assigned
+    def element_type=(element_type)
+      if element_type.nil?
+        fail ArgumentError, 'element_type cannot be nil'
+      end
+
+      @element_type = element_type
+    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_select_no_value == o.can_select_no_value &&
+          config == o.config &&
+          custom_field_id == o.custom_field_id &&
+          default_value == o.default_value &&
+          description == o.description &&
+          element_type == o.element_type &&
+          id == o.id &&
+          incident_role_id == o.incident_role_id &&
+          incident_timestamp_id == o.incident_timestamp_id &&
+          placeholder == o.placeholder &&
+          required_if == o.required_if &&
+          required_if_condition_groups == o.required_if_condition_groups &&
+          show_if_condition_groups == o.show_if_condition_groups
+    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_select_no_value, config, custom_field_id, default_value, description, element_type, id, incident_role_id, incident_timestamp_id, placeholder, required_if, required_if_condition_groups, show_if_condition_groups].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/incident_form_lifecycle_element_v3.rb

@@ -0,0 +1,287 @@
+=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 IncidentFormLifecycleElementV3 < ApiModelBase
+    # Whether the user can explicitly choose no value. Only meaningful for custom field elements.
+    attr_accessor :can_select_no_value
+
+    attr_accessor :config
+
+    # The custom field this element edits. Set only when element_type is custom_field.
+    attr_accessor :custom_field_id
+
+    attr_accessor :default_value
+
+    # Description shown beside this element, as markdown
+    attr_accessor :description
+
+    # What this element captures  Known values: `name`, `status`, `severity`, `incident_role`, `incident_type`, `summary`, `custom_field`, `timestamp`, `update_message`, `next_update_in`, `triage`, `visibility`, `divider`, `text`, `incident_attachments`, `slack_channel`, `announce_retro_incident`, `enter_post_incident_flow`, `investigation_feedback`
+    attr_accessor :element_type
+
+    # Unique identifier for this element. divider and text elements are matched on this, because they have no natural key.
+    attr_accessor :id
+
+    # The incident role this element assigns. Set only when element_type is incident_role.
+    attr_accessor :incident_role_id
+
+    # The incident timestamp this element sets. Set only when element_type is timestamp.
+    attr_accessor :incident_timestamp_id
+
+    # Placeholder text shown in the empty field
+    attr_accessor :placeholder
+
+    # When this element must be filled in  Known values: `check_engine_config`, `always_require`, `never_require`
+    attr_accessor :required_if
+
+    # Condition groups that make this element required. Used when required_if is check_engine_config.
+    attr_accessor :required_if_condition_groups
+
+    # The element is shown when any of these condition groups match. Unset means it is always shown.
+    attr_accessor :show_if_condition_groups
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'can_select_no_value' => :'can_select_no_value',
+        :'config' => :'config',
+        :'custom_field_id' => :'custom_field_id',
+        :'default_value' => :'default_value',
+        :'description' => :'description',
+        :'element_type' => :'element_type',
+        :'id' => :'id',
+        :'incident_role_id' => :'incident_role_id',
+        :'incident_timestamp_id' => :'incident_timestamp_id',
+        :'placeholder' => :'placeholder',
+        :'required_if' => :'required_if',
+        :'required_if_condition_groups' => :'required_if_condition_groups',
+        :'show_if_condition_groups' => :'show_if_condition_groups'
+      }
+    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_select_no_value' => :'Boolean',
+        :'config' => :'IncidentFormLifecycleElementConfigV3',
+        :'custom_field_id' => :'String',
+        :'default_value' => :'EngineParamBindingV3',
+        :'description' => :'String',
+        :'element_type' => :'String',
+        :'id' => :'String',
+        :'incident_role_id' => :'String',
+        :'incident_timestamp_id' => :'String',
+        :'placeholder' => :'String',
+        :'required_if' => :'String',
+        :'required_if_condition_groups' => :'Array<ConditionGroupV3>',
+        :'show_if_condition_groups' => :'Array<ConditionGroupV3>'
+      }
+    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::IncidentFormLifecycleElementV3` 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::IncidentFormLifecycleElementV3`. 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_select_no_value')
+        self.can_select_no_value = attributes[:'can_select_no_value']
+      end
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'custom_field_id')
+        self.custom_field_id = attributes[:'custom_field_id']
+      end
+
+      if attributes.key?(:'default_value')
+        self.default_value = attributes[:'default_value']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'element_type')
+        self.element_type = attributes[:'element_type']
+      else
+        self.element_type = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'incident_role_id')
+        self.incident_role_id = attributes[:'incident_role_id']
+      end
+
+      if attributes.key?(:'incident_timestamp_id')
+        self.incident_timestamp_id = attributes[:'incident_timestamp_id']
+      end
+
+      if attributes.key?(:'placeholder')
+        self.placeholder = attributes[:'placeholder']
+      end
+
+      if attributes.key?(:'required_if')
+        self.required_if = attributes[:'required_if']
+      end
+
+      if attributes.key?(:'required_if_condition_groups')
+        if (value = attributes[:'required_if_condition_groups']).is_a?(Array)
+          self.required_if_condition_groups = value
+        end
+      end
+
+      if attributes.key?(:'show_if_condition_groups')
+        if (value = attributes[:'show_if_condition_groups']).is_a?(Array)
+          self.show_if_condition_groups = value
+        end
+      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 @element_type.nil?
+        invalid_properties.push('invalid value for "element_type", element_type 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 @element_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] element_type Value to be assigned
+    def element_type=(element_type)
+      if element_type.nil?
+        fail ArgumentError, 'element_type cannot be nil'
+      end
+
+      @element_type = element_type
+    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_select_no_value == o.can_select_no_value &&
+          config == o.config &&
+          custom_field_id == o.custom_field_id &&
+          default_value == o.default_value &&
+          description == o.description &&
+          element_type == o.element_type &&
+          id == o.id &&
+          incident_role_id == o.incident_role_id &&
+          incident_timestamp_id == o.incident_timestamp_id &&
+          placeholder == o.placeholder &&
+          required_if == o.required_if &&
+          required_if_condition_groups == o.required_if_condition_groups &&
+          show_if_condition_groups == o.show_if_condition_groups
+    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_select_no_value, config, custom_field_id, default_value, description, element_type, id, incident_role_id, incident_timestamp_id, placeholder, required_if, required_if_condition_groups, show_if_condition_groups].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