incident_io_api 2.21.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c59f8990c0ddc45735a373e4a3c74aa42ac348a536924bc76732fe4860dfdd3
-  data.tar.gz: 999001913a5e5f621d6684f553b604d6b8939bcae2b52e6502c5e5a9af63a690
+  metadata.gz: 3c11fe241a77504154d7122ebfc330fade678ade0ec21fd62a105b104abb9dd3
+  data.tar.gz: df8da2aa6995fe8afa18ca6961891afc6ff45a11d31eb813924e7ce599b5b005
 SHA512:
-  metadata.gz: 16c56c802ddafe6d9d3f31b22a13f9d21e9e6cba3332a5dd3f9c0edbe2a794c5d39ea955b288ead1ebf423dce6def541a7e7286a794ad10d362ba29957edf1e9
-  data.tar.gz: adc4ff38e1cc39b8c409899e4418691fa645a413be84200219474851bb460b9c4ceec4f95732394e484e4efe3be48f8ff91d98f037ed0c3d63f715af45b5b2b4
+  metadata.gz: 0e038699f484bca48c61d1d3ec78e6443d62893b9c40452e5ed8362ef41708c202b7f8a2f4b50b4df4b2f7bc37962b00d1cddb3928be1d343217cc3ccb272406
+  data.tar.gz: 66e74980778818746989c627ef4fbef0df5a2f75798ab79d9ab92482fe76dba686b7e3251097f782c7d19408b854f4bde991e8733104e01d30e927b244cb5488

data/lib/incident_io/api/incidents_v2_api.rb

@@ -19,6 +19,80 @@ module IncidentIo
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # ConnectExternalIssue Incidents V2
+    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This works whether or not automatic incident ticket creation is turned on. While it is off, no tickets are created for other incidents, and the incident's fields are not written into this issue until it is turned on.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
+    # @param id [String] The unique identifier of the incident
+    # @param incidents_connect_external_issue_payload_v2 [IncidentsConnectExternalIssuePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def incidents_v2_connect_external_issue(id, incidents_connect_external_issue_payload_v2, opts = {})
+      incidents_v2_connect_external_issue_with_http_info(id, incidents_connect_external_issue_payload_v2, opts)
+      nil
+    end
+
+    # ConnectExternalIssue Incidents V2
+    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This works whether or not automatic incident ticket creation is turned on. While it is off, no tickets are created for other incidents, and the incident's fields are not written into this issue until it is turned on.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
+    # @param id [String] The unique identifier of the incident
+    # @param incidents_connect_external_issue_payload_v2 [IncidentsConnectExternalIssuePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def incidents_v2_connect_external_issue_with_http_info(id, incidents_connect_external_issue_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentsV2Api.incidents_v2_connect_external_issue ...'
+      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 IncidentsV2Api.incidents_v2_connect_external_issue"
+      end
+      # verify the required parameter 'incidents_connect_external_issue_payload_v2' is set
+      if @api_client.config.client_side_validation && incidents_connect_external_issue_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'incidents_connect_external_issue_payload_v2' when calling IncidentsV2Api.incidents_v2_connect_external_issue"
+      end
+      # resource path
+      local_var_path = '/v2/incidents/{id}/actions/connect_external_issue'.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(incidents_connect_external_issue_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentsV2Api.incidents_v2_connect_external_issue",
+        :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: IncidentsV2Api#incidents_v2_connect_external_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Incidents V2
     # Create a new incident.  Note that if the incident mode is set to \"retrospective\" then the new incident will not be announced in Slack. 
     # @param incidents_create_payload_v2 [IncidentsCreatePayloadV2] 

data/lib/incident_io/models/incidents_connect_external_issue_payload_v2.rb

@@ -0,0 +1,231 @@
+=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 IncidentsConnectExternalIssuePayloadV2 < ApiModelBase
+    # ID of the incident ticket template to sync the issue with
+    attr_accessor :issue_template_id
+
+    # The issue tracker provider the issue belongs to. It must match the provider of the incident ticket template.  Known values: `asana`, `azure_devops`, `click_up`, `freshservice`, `linear`, `jira`, `salesforce`, `jira_server`, `github`, `gitlab`, `service_now`, `shortcut`, `notion`
+    attr_accessor :provider
+
+    # Whether to replace the incident's current external issue, if it has a different one
+    attr_accessor :replace
+
+    # URL of the issue in the issue tracker
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'issue_template_id' => :'issue_template_id',
+        :'provider' => :'provider',
+        :'replace' => :'replace',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'issue_template_id' => :'String',
+        :'provider' => :'String',
+        :'replace' => :'Boolean',
+        :'url' => :'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::IncidentsConnectExternalIssuePayloadV2` 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::IncidentsConnectExternalIssuePayloadV2`. 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?(:'issue_template_id')
+        self.issue_template_id = attributes[:'issue_template_id']
+      else
+        self.issue_template_id = nil
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'replace')
+        self.replace = attributes[:'replace']
+      else
+        self.replace = false
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = 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 @issue_template_id.nil?
+        invalid_properties.push('invalid value for "issue_template_id", issue_template_id cannot be nil.')
+      end
+
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @issue_template_id.nil?
+      return false if @provider.nil?
+      return false if @url.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issue_template_id Value to be assigned
+    def issue_template_id=(issue_template_id)
+      if issue_template_id.nil?
+        fail ArgumentError, 'issue_template_id cannot be nil'
+      end
+
+      @issue_template_id = issue_template_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] provider Value to be assigned
+    def provider=(provider)
+      if provider.nil?
+        fail ArgumentError, 'provider cannot be nil'
+      end
+
+      @provider = provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      @url = url
+    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 &&
+          issue_template_id == o.issue_template_id &&
+          provider == o.provider &&
+          replace == o.replace &&
+          url == o.url
+    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
+      [issue_template_id, provider, replace, url].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.21.0"
+  VERSION = "2.23.0"
 end

data/lib/incident_io.rb

@@ -891,6 +891,7 @@ IncidentIo.autoload :IncidentUpdatesListResultV2, 'incident_io/models/incident_u
 IncidentIo.autoload :IncidentV1, 'incident_io/models/incident_v1'
 IncidentIo.autoload :IncidentV2, 'incident_io/models/incident_v2'
 IncidentIo.autoload :IncidentWithStatusChangeV2, 'incident_io/models/incident_with_status_change_v2'
+IncidentIo.autoload :IncidentsConnectExternalIssuePayloadV2, 'incident_io/models/incidents_connect_external_issue_payload_v2'
 IncidentIo.autoload :IncidentsCreatePayloadV1, 'incident_io/models/incidents_create_payload_v1'
 IncidentIo.autoload :IncidentsCreatePayloadV2, 'incident_io/models/incidents_create_payload_v2'
 IncidentIo.autoload :IncidentsCreateResultV1, 'incident_io/models/incidents_create_result_v1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incident_io_api
 version: !ruby/object:Gem::Version
-  version: 2.21.0
+  version: 2.23.0
 platform: ruby
 authors:
 - incident.io
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-22 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -1011,6 +1011,7 @@ files:
 - lib/incident_io/models/incident_v1.rb
 - lib/incident_io/models/incident_v2.rb
 - lib/incident_io/models/incident_with_status_change_v2.rb
+- lib/incident_io/models/incidents_connect_external_issue_payload_v2.rb
 - lib/incident_io/models/incidents_create_payload_v1.rb
 - lib/incident_io/models/incidents_create_payload_v2.rb
 - lib/incident_io/models/incidents_create_result_v1.rb