incident_io_api 2.8.0 → 2.10.0

data/lib/incident_io/models/incident_forms_list_result_v3.rb

@@ -0,0 +1,192 @@
+=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 IncidentFormsListResultV3 < ApiModelBase
+    attr_accessor :incident_forms
+
+    attr_accessor :pagination_meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'incident_forms' => :'incident_forms',
+        :'pagination_meta' => :'pagination_meta'
+      }
+    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
+      {
+        :'incident_forms' => :'Array<IncidentFormV3>',
+        :'pagination_meta' => :'PaginationMetaResultV3'
+      }
+    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::IncidentFormsListResultV3` 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::IncidentFormsListResultV3`. 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?(:'incident_forms')
+        if (value = attributes[:'incident_forms']).is_a?(Array)
+          self.incident_forms = value
+        end
+      else
+        self.incident_forms = nil
+      end
+
+      if attributes.key?(:'pagination_meta')
+        self.pagination_meta = attributes[:'pagination_meta']
+      else
+        self.pagination_meta = 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 @incident_forms.nil?
+        invalid_properties.push('invalid value for "incident_forms", incident_forms cannot be nil.')
+      end
+
+      if @pagination_meta.nil?
+        invalid_properties.push('invalid value for "pagination_meta", pagination_meta 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 @incident_forms.nil?
+      return false if @pagination_meta.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] incident_forms Value to be assigned
+    def incident_forms=(incident_forms)
+      if incident_forms.nil?
+        fail ArgumentError, 'incident_forms cannot be nil'
+      end
+
+      @incident_forms = incident_forms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pagination_meta Value to be assigned
+    def pagination_meta=(pagination_meta)
+      if pagination_meta.nil?
+        fail ArgumentError, 'pagination_meta cannot be nil'
+      end
+
+      @pagination_meta = pagination_meta
+    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 &&
+          incident_forms == o.incident_forms &&
+          pagination_meta == o.pagination_meta
+    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
+      [incident_forms, pagination_meta].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_forms_show_result_v3.rb

@@ -0,0 +1,164 @@
+=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 IncidentFormsShowResultV3 < ApiModelBase
+    attr_accessor :incident_form
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'incident_form' => :'incident_form'
+      }
+    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
+      {
+        :'incident_form' => :'IncidentFormV3'
+      }
+    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::IncidentFormsShowResultV3` 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::IncidentFormsShowResultV3`. 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?(:'incident_form')
+        self.incident_form = attributes[:'incident_form']
+      else
+        self.incident_form = 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 @incident_form.nil?
+        invalid_properties.push('invalid value for "incident_form", incident_form 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 @incident_form.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] incident_form Value to be assigned
+    def incident_form=(incident_form)
+      if incident_form.nil?
+        fail ArgumentError, 'incident_form cannot be nil'
+      end
+
+      @incident_form = incident_form
+    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 &&
+          incident_form == o.incident_form
+    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
+      [incident_form].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_forms_update_payload_v3.rb

@@ -0,0 +1,216 @@
+=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 IncidentFormsUpdatePayloadV3 < ApiModelBase
+    # Expressions available to every element's conditions and defaults. Referenced by reference, not by ID.
+    attr_accessor :expressions
+
+    # Which form this is. Escalate forms are not part of this API.  Known values: `declare`, `accept`, `update`, `resolve`, `retrospective`, `custom-fields`
+    attr_accessor :form_type
+
+    # The incident type this form belongs to. Leave unset for the organisation's default form of this type.
+    attr_accessor :incident_type_id
+
+    # Elements on this form, in display order. List position is the order: there is no separate rank.
+    attr_accessor :lifecycle_elements
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expressions' => :'expressions',
+        :'form_type' => :'form_type',
+        :'incident_type_id' => :'incident_type_id',
+        :'lifecycle_elements' => :'lifecycle_elements'
+      }
+    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
+      {
+        :'expressions' => :'Array<ExpressionPayloadV3>',
+        :'form_type' => :'String',
+        :'incident_type_id' => :'String',
+        :'lifecycle_elements' => :'Array<IncidentFormLifecycleElementPayloadV3>'
+      }
+    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::IncidentFormsUpdatePayloadV3` 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::IncidentFormsUpdatePayloadV3`. 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?(:'expressions')
+        if (value = attributes[:'expressions']).is_a?(Array)
+          self.expressions = value
+        end
+      else
+        self.expressions = nil
+      end
+
+      if attributes.key?(:'form_type')
+        self.form_type = attributes[:'form_type']
+      else
+        self.form_type = nil
+      end
+
+      if attributes.key?(:'incident_type_id')
+        self.incident_type_id = attributes[:'incident_type_id']
+      end
+
+      if attributes.key?(:'lifecycle_elements')
+        if (value = attributes[:'lifecycle_elements']).is_a?(Array)
+          self.lifecycle_elements = 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 @expressions.nil?
+        invalid_properties.push('invalid value for "expressions", expressions cannot be nil.')
+      end
+
+      if @form_type.nil?
+        invalid_properties.push('invalid value for "form_type", form_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 @expressions.nil?
+      return false if @form_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expressions Value to be assigned
+    def expressions=(expressions)
+      if expressions.nil?
+        fail ArgumentError, 'expressions cannot be nil'
+      end
+
+      @expressions = expressions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] form_type Value to be assigned
+    def form_type=(form_type)
+      if form_type.nil?
+        fail ArgumentError, 'form_type cannot be nil'
+      end
+
+      @form_type = form_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 &&
+          expressions == o.expressions &&
+          form_type == o.form_type &&
+          incident_type_id == o.incident_type_id &&
+          lifecycle_elements == o.lifecycle_elements
+    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
+      [expressions, form_type, incident_type_id, lifecycle_elements].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