incident_io_api 2.8.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 754c359d331c3c2915e2e2f976cb275811c672a8e30ebfde71bb4144431046a9
-  data.tar.gz: 19ad13c29f33fe0459eb0126c485a7b18e4e379a2e10f622b7777947927c0d0f
+  metadata.gz: 042dc0ebc895dba1a981bede7ee341dd036cdd6494037e3dc98768f17e4cad2e
+  data.tar.gz: dafbc91e94c7e3638acb1d87b0a562312f10f6fb984a9a469d939d905b4f0d9e
 SHA512:
-  metadata.gz: '08abaa68086d2f8a36e9c110fc87d8fbad8e34e7433fcbee65ba6445e1c9988c4f1b052484939e3bf24e289fedf6db371011b7fb89adc4dd46aae19a711f20aa'
-  data.tar.gz: 916edbfebaf0318b91a9331810e1a1f471e0d8254199b3ada9ad1275feb3aea83abb1fa9cdce66c2ad627cb8452d937bb48c2443f85260445542ef4182db08af
+  metadata.gz: e8c3387db062ecd66f07fd44af6334f69e73b62e1074133b08485f4fe322daf01dcd68261de85607f9fc890ef92a26d0d86eb043381654c5722742f911e39684
+  data.tar.gz: 5c51d11cae0d1415662c1d8c09ad692ac3907406ee32b875c0cf69f081929f588494e2deb116542d7a4d27a7de056078d7b51fc6d25401c9f733868a76e10c26

data/lib/incident_io/api/incident_forms_v3_api.rb

@@ -0,0 +1,361 @@
+=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 'cgi'
+
+module IncidentIo
+  class IncidentFormsV3Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Incident Forms V3
+    # Create an incident form for an incident type. A form that already exists for that form type and incident type is rejected.
+    # @param incident_forms_create_payload_v3 [IncidentFormsCreatePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [IncidentFormsCreateResultV3]
+    def incident_forms_v3_create(incident_forms_create_payload_v3, opts = {})
+      data, _status_code, _headers = incident_forms_v3_create_with_http_info(incident_forms_create_payload_v3, opts)
+      data
+    end
+
+    # Create Incident Forms V3
+    # Create an incident form for an incident type. A form that already exists for that form type and incident type is rejected.
+    # @param incident_forms_create_payload_v3 [IncidentFormsCreatePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncidentFormsCreateResultV3, Integer, Hash)>] IncidentFormsCreateResultV3 data, response status code and response headers
+    def incident_forms_v3_create_with_http_info(incident_forms_create_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentFormsV3Api.incident_forms_v3_create ...'
+      end
+      # verify the required parameter 'incident_forms_create_payload_v3' is set
+      if @api_client.config.client_side_validation && incident_forms_create_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_forms_create_payload_v3' when calling IncidentFormsV3Api.incident_forms_v3_create"
+      end
+      # resource path
+      local_var_path = '/v3/incident_forms'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(incident_forms_create_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncidentFormsCreateResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentFormsV3Api.incident_forms_v3_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentFormsV3Api#incident_forms_v3_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Incident Forms V3
+    # Archive an incident form. The organisation's default form of a type cannot be archived.
+    # @param id [String] Unique identifier for this incident form
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def incident_forms_v3_delete(id, opts = {})
+      incident_forms_v3_delete_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Incident Forms V3
+    # Archive an incident form. The organisation&#39;s default form of a type cannot be archived.
+    # @param id [String] Unique identifier for this incident form
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def incident_forms_v3_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentFormsV3Api.incident_forms_v3_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IncidentFormsV3Api.incident_forms_v3_delete"
+      end
+      # resource path
+      local_var_path = '/v3/incident_forms/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentFormsV3Api.incident_forms_v3_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentFormsV3Api#incident_forms_v3_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Incident Forms V3
+    # List incident forms for your account, including their elements and expressions.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Integer number of records to return (default to 25)
+    # @option opts [String] :after An incident form&#39;s ID. This endpoint will return a list of forms after this ID in relation to the API response order.
+    # @return [IncidentFormsListResultV3]
+    def incident_forms_v3_list(opts = {})
+      data, _status_code, _headers = incident_forms_v3_list_with_http_info(opts)
+      data
+    end
+
+    # List Incident Forms V3
+    # List incident forms for your account, including their elements and expressions.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Integer number of records to return (default to 25)
+    # @option opts [String] :after An incident form&#39;s ID. This endpoint will return a list of forms after this ID in relation to the API response order.
+    # @return [Array<(IncidentFormsListResultV3, Integer, Hash)>] IncidentFormsListResultV3 data, response status code and response headers
+    def incident_forms_v3_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentFormsV3Api.incident_forms_v3_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IncidentFormsV3Api.incident_forms_v3_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IncidentFormsV3Api.incident_forms_v3_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v3/incident_forms'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncidentFormsListResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentFormsV3Api.incident_forms_v3_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentFormsV3Api#incident_forms_v3_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Show Incident Forms V3
+    # Get a single incident form, including its elements and expressions.
+    # @param id [String] Unique identifier for this incident form
+    # @param [Hash] opts the optional parameters
+    # @return [IncidentFormsShowResultV3]
+    def incident_forms_v3_show(id, opts = {})
+      data, _status_code, _headers = incident_forms_v3_show_with_http_info(id, opts)
+      data
+    end
+
+    # Show Incident Forms V3
+    # Get a single incident form, including its elements and expressions.
+    # @param id [String] Unique identifier for this incident form
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncidentFormsShowResultV3, Integer, Hash)>] IncidentFormsShowResultV3 data, response status code and response headers
+    def incident_forms_v3_show_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentFormsV3Api.incident_forms_v3_show ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IncidentFormsV3Api.incident_forms_v3_show"
+      end
+      # resource path
+      local_var_path = '/v3/incident_forms/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncidentFormsShowResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentFormsV3Api.incident_forms_v3_show",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentFormsV3Api#incident_forms_v3_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Incident Forms V3
+    # Replace an incident form, including its elements and expressions.
+    # @param id [String] Unique identifier of the incident form
+    # @param incident_forms_update_payload_v3 [IncidentFormsUpdatePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [IncidentFormsUpdateResultV3]
+    def incident_forms_v3_update(id, incident_forms_update_payload_v3, opts = {})
+      data, _status_code, _headers = incident_forms_v3_update_with_http_info(id, incident_forms_update_payload_v3, opts)
+      data
+    end
+
+    # Update Incident Forms V3
+    # Replace an incident form, including its elements and expressions.
+    # @param id [String] Unique identifier of the incident form
+    # @param incident_forms_update_payload_v3 [IncidentFormsUpdatePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncidentFormsUpdateResultV3, Integer, Hash)>] IncidentFormsUpdateResultV3 data, response status code and response headers
+    def incident_forms_v3_update_with_http_info(id, incident_forms_update_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentFormsV3Api.incident_forms_v3_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IncidentFormsV3Api.incident_forms_v3_update"
+      end
+      # verify the required parameter 'incident_forms_update_payload_v3' is set
+      if @api_client.config.client_side_validation && incident_forms_update_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_forms_update_payload_v3' when calling IncidentFormsV3Api.incident_forms_v3_update"
+      end
+      # resource path
+      local_var_path = '/v3/incident_forms/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(incident_forms_update_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncidentFormsUpdateResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentFormsV3Api.incident_forms_v3_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentFormsV3Api#incident_forms_v3_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/incident_io/models/incident_form_lifecycle_element_config_v3.rb

@@ -0,0 +1,148 @@
+=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 IncidentFormLifecycleElementConfigV3 < ApiModelBase
+    # Whether the free-text comment must be filled in, for anyone giving investigation feedback
+    attr_accessor :require_comment
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'require_comment' => :'require_comment'
+      }
+    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
+      {
+        :'require_comment' => :'Boolean'
+      }
+    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::IncidentFormLifecycleElementConfigV3` 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::IncidentFormLifecycleElementConfigV3`. 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?(:'require_comment')
+        self.require_comment = attributes[:'require_comment']
+      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
+      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'
+      true
+    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 &&
+          require_comment == o.require_comment
+    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
+      [require_comment].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