incident_io_api 2.29.0 → 2.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a74cd0e95f6cef1e4dcb2a3ff4fb55c5c1fb59a01bf57f05040a5f5fced152cf
-  data.tar.gz: d865d70d83caa8b325be9cb802855f911f4472842a30a01b3c2b4444811f5c87
+  metadata.gz: ba73a5d757889226f11342b7b9c31d21ce20d74c8450b9545451bd3e90eec754
+  data.tar.gz: 71d1d3dc999e515eed83d35396132851d57efd588954a6b79ae157a640dfe368
 SHA512:
-  metadata.gz: 5a422f7cadebf0cda16605e479f14b39f9c971c58dd1996f3d3df74afdaa1d7ef8c1485cacd31bcdc5f5a4e0babd49f6fa07764083ddfa04accd632e363e6ac9
-  data.tar.gz: 2eeaf35048f66e2485218d12aa5e1a55024c7d0d583e9871f75e30571ca841a91351f2f77734eb720d27859406e6cb5cb1222b2c5b7b7256e91bcc4c3703e0f7
+  metadata.gz: 826a9ca4862968efab7d3b3a487bfa97ba474f6d9b9bc714fa546810bbff6e1493fa222040cfaf6373050150942180154cc344da70f4eff1f84ef062fb71a304
+  data.tar.gz: 377ed2f317323bd2f138d1ce14403851af6040ba2343bdaca2191901f6d0f0969a6d8e133557c9e3a86c15eef0111c2d2a7cb9a2caa8eb10dd6f22fab1b55a9c

data/lib/incident_io/api/alert_attachments_v2_api.rb

@@ -0,0 +1,230 @@
+=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 AlertAttachmentsV2Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Alert Attachments V2
+    # Attach a URL to an alert or alert group. Provide exactly one of alert_id or alert_group_id. A URL for a ticket or pull request from a connected integration is attached as that ticket or pull request. Any other URL is attached as a link. A URL that is already attached returns a 422.
+    # @param alert_attachments_create_payload_v2 [AlertAttachmentsCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [AlertAttachmentsCreateResultV2]
+    def alert_attachments_v2_create(alert_attachments_create_payload_v2, opts = {})
+      data, _status_code, _headers = alert_attachments_v2_create_with_http_info(alert_attachments_create_payload_v2, opts)
+      data
+    end
+
+    # Create Alert Attachments V2
+    # Attach a URL to an alert or alert group. Provide exactly one of alert_id or alert_group_id. A URL for a ticket or pull request from a connected integration is attached as that ticket or pull request. Any other URL is attached as a link. A URL that is already attached returns a 422.
+    # @param alert_attachments_create_payload_v2 [AlertAttachmentsCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AlertAttachmentsCreateResultV2, Integer, Hash)>] AlertAttachmentsCreateResultV2 data, response status code and response headers
+    def alert_attachments_v2_create_with_http_info(alert_attachments_create_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertAttachmentsV2Api.alert_attachments_v2_create ...'
+      end
+      # verify the required parameter 'alert_attachments_create_payload_v2' is set
+      if @api_client.config.client_side_validation && alert_attachments_create_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'alert_attachments_create_payload_v2' when calling AlertAttachmentsV2Api.alert_attachments_v2_create"
+      end
+      # resource path
+      local_var_path = '/v2/alert_attachments'
+
+      # 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(alert_attachments_create_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AlertAttachmentsCreateResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AlertAttachmentsV2Api.alert_attachments_v2_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: AlertAttachmentsV2Api#alert_attachments_v2_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Alert Attachments V2
+    # Remove an attachment from its alert or alert group.
+    # @param id [String] ID of the alert attachment
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def alert_attachments_v2_delete(id, opts = {})
+      alert_attachments_v2_delete_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Alert Attachments V2
+    # Remove an attachment from its alert or alert group.
+    # @param id [String] ID of the alert attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def alert_attachments_v2_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertAttachmentsV2Api.alert_attachments_v2_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 AlertAttachmentsV2Api.alert_attachments_v2_delete"
+      end
+      # resource path
+      local_var_path = '/v2/alert_attachments/{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 => :"AlertAttachmentsV2Api.alert_attachments_v2_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: AlertAttachmentsV2Api#alert_attachments_v2_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Alert Attachments V2
+    # List the attachments on an alert or alert group, newest first. Provide exactly one of alert_id or alert_group_id. Listing by alert_id returns only what is attached to that alert, not what is attached to its alert group.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :alert_id ID of the alert to list attachments for. Provide exactly one of alert_id or alert_group_id.
+    # @option opts [String] :alert_group_id ID of the alert group to list attachments for. Provide exactly one of alert_id or alert_group_id.
+    # @option opts [Integer] :page_size Integer number of records to return (default to 25)
+    # @option opts [String] :after An alert attachment&#39;s ID. This endpoint will return the attachments after this one in the response order.
+    # @return [AlertAttachmentsListResultV2]
+    def alert_attachments_v2_list(opts = {})
+      data, _status_code, _headers = alert_attachments_v2_list_with_http_info(opts)
+      data
+    end
+
+    # List Alert Attachments V2
+    # List the attachments on an alert or alert group, newest first. Provide exactly one of alert_id or alert_group_id. Listing by alert_id returns only what is attached to that alert, not what is attached to its alert group.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :alert_id ID of the alert to list attachments for. Provide exactly one of alert_id or alert_group_id.
+    # @option opts [String] :alert_group_id ID of the alert group to list attachments for. Provide exactly one of alert_id or alert_group_id.
+    # @option opts [Integer] :page_size Integer number of records to return (default to 25)
+    # @option opts [String] :after An alert attachment&#39;s ID. This endpoint will return the attachments after this one in the response order.
+    # @return [Array<(AlertAttachmentsListResultV2, Integer, Hash)>] AlertAttachmentsListResultV2 data, response status code and response headers
+    def alert_attachments_v2_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertAttachmentsV2Api.alert_attachments_v2_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 AlertAttachmentsV2Api.alert_attachments_v2_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 AlertAttachmentsV2Api.alert_attachments_v2_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/alert_attachments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'alert_id'] = opts[:'alert_id'] if !opts[:'alert_id'].nil?
+      query_params[:'alert_group_id'] = opts[:'alert_group_id'] if !opts[:'alert_group_id'].nil?
+      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] || 'AlertAttachmentsListResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AlertAttachmentsV2Api.alert_attachments_v2_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: AlertAttachmentsV2Api#alert_attachments_v2_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/incident_io/models/alert_attachment_v2.rb

@@ -0,0 +1,267 @@
+=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
+  # Something attached to an alert or alert group, such as a ticket, a pull request or a link.
+  class AlertAttachmentV2 < ApiModelBase
+    # ID of the alert group this is attached to. Exactly one of alert_id or alert_group_id is set.
+    attr_accessor :alert_group_id
+
+    # ID of the alert this is attached to. Exactly one of alert_id or alert_group_id is set.
+    attr_accessor :alert_id
+
+    # When it was attached
+    attr_accessor :created_at
+
+    # Unique identifier for the alert attachment
+    attr_accessor :id
+
+    # The ticket or pull request's title, or the link's title
+    attr_accessor :title
+
+    # URL of the attached ticket, pull request or link
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'alert_group_id' => :'alert_group_id',
+        :'alert_id' => :'alert_id',
+        :'created_at' => :'created_at',
+        :'id' => :'id',
+        :'title' => :'title',
+        :'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
+      {
+        :'alert_group_id' => :'String',
+        :'alert_id' => :'String',
+        :'created_at' => :'Time',
+        :'id' => :'String',
+        :'title' => :'String',
+        :'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::AlertAttachmentV2` 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::AlertAttachmentV2`. 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?(:'alert_group_id')
+        self.alert_group_id = attributes[:'alert_group_id']
+      end
+
+      if attributes.key?(:'alert_id')
+        self.alert_id = attributes[:'alert_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title 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 @created_at.nil?
+      return false if @id.nil?
+      return false if @title.nil?
+      return false if @url.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      @title = title
+    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 &&
+          alert_group_id == o.alert_group_id &&
+          alert_id == o.alert_id &&
+          created_at == o.created_at &&
+          id == o.id &&
+          title == o.title &&
+          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
+      [alert_group_id, alert_id, created_at, id, title, 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