incident_io_api 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88daae7a11ae6a22dace5ad124eebabc05b3f360c702994d827acced6173f38e
-  data.tar.gz: a2733e0e4f10772dbdef5d0523b851d50dfdbb02a22c06aa2caa3ff871610385
+  metadata.gz: 754c359d331c3c2915e2e2f976cb275811c672a8e30ebfde71bb4144431046a9
+  data.tar.gz: 19ad13c29f33fe0459eb0126c485a7b18e4e379a2e10f622b7777947927c0d0f
 SHA512:
-  metadata.gz: 1e34e7a095212b9c326399810364c4e74c2785e6d40712beb33004614e9bf51938e78b5347668f543df4b14aa9cda3627a50af42f628bd522c1247cbb72edeff
-  data.tar.gz: 7079869a49eeedaa334271895d3d352caf479666116c4296d8db37e9a5611a9e5f83db8fe39b395da91513060ae2c10c7415acda05c318d1601a405559065517
+  metadata.gz: '08abaa68086d2f8a36e9c110fc87d8fbad8e34e7433fcbee65ba6445e1c9988c4f1b052484939e3bf24e289fedf6db371011b7fb89adc4dd46aae19a711f20aa'
+  data.tar.gz: 916edbfebaf0318b91a9331810e1a1f471e0d8254199b3ada9ad1275feb3aea83abb1fa9cdce66c2ad627cb8452d937bb48c2443f85260445542ef4182db08af

data/lib/incident_io/api/status_page_components_v2_api.rb

@@ -0,0 +1,347 @@
+=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 StatusPageComponentsV2Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Status Page Components V2
+    # Create a status page component. Placement on a page is controlled separately via status page structures.
+    # @param status_page_components_create_payload_v2 [StatusPageComponentsCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [StatusPageComponentsCreateResultV2]
+    def status_page_components_v2_create(status_page_components_create_payload_v2, opts = {})
+      data, _status_code, _headers = status_page_components_v2_create_with_http_info(status_page_components_create_payload_v2, opts)
+      data
+    end
+
+    # Create Status Page Components V2
+    # Create a status page component. Placement on a page is controlled separately via status page structures.
+    # @param status_page_components_create_payload_v2 [StatusPageComponentsCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StatusPageComponentsCreateResultV2, Integer, Hash)>] StatusPageComponentsCreateResultV2 data, response status code and response headers
+    def status_page_components_v2_create_with_http_info(status_page_components_create_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatusPageComponentsV2Api.status_page_components_v2_create ...'
+      end
+      # verify the required parameter 'status_page_components_create_payload_v2' is set
+      if @api_client.config.client_side_validation && status_page_components_create_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'status_page_components_create_payload_v2' when calling StatusPageComponentsV2Api.status_page_components_v2_create"
+      end
+      # resource path
+      local_var_path = '/v2/status_page_components'
+
+      # 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(status_page_components_create_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'StatusPageComponentsCreateResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StatusPageComponentsV2Api.status_page_components_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: StatusPageComponentsV2Api#status_page_components_v2_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Destroy Status Page Components V2
+    # Archive a status page component.
+    # @param id [String] Unique identifier of the status page component
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def status_page_components_v2_destroy(id, opts = {})
+      status_page_components_v2_destroy_with_http_info(id, opts)
+      nil
+    end
+
+    # Destroy Status Page Components V2
+    # Archive a status page component.
+    # @param id [String] Unique identifier of the status page component
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def status_page_components_v2_destroy_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatusPageComponentsV2Api.status_page_components_v2_destroy ...'
+      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 StatusPageComponentsV2Api.status_page_components_v2_destroy"
+      end
+      # resource path
+      local_var_path = '/v2/status_page_components/{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 => :"StatusPageComponentsV2Api.status_page_components_v2_destroy",
+        :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: StatusPageComponentsV2Api#status_page_components_v2_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Status Page Components V2
+    # List all status page components for an organisation.
+    # @param [Hash] opts the optional parameters
+    # @return [StatusPageComponentsListResultV2]
+    def status_page_components_v2_list(opts = {})
+      data, _status_code, _headers = status_page_components_v2_list_with_http_info(opts)
+      data
+    end
+
+    # List Status Page Components V2
+    # List all status page components for an organisation.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StatusPageComponentsListResultV2, Integer, Hash)>] StatusPageComponentsListResultV2 data, response status code and response headers
+    def status_page_components_v2_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatusPageComponentsV2Api.status_page_components_v2_list ...'
+      end
+      # resource path
+      local_var_path = '/v2/status_page_components'
+
+      # 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] || 'StatusPageComponentsListResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StatusPageComponentsV2Api.status_page_components_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: StatusPageComponentsV2Api#status_page_components_v2_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Show Status Page Components V2
+    # Show a single status page component.
+    # @param id [String] Unique identifier of the status page component
+    # @param [Hash] opts the optional parameters
+    # @return [StatusPageComponentsShowResultV2]
+    def status_page_components_v2_show(id, opts = {})
+      data, _status_code, _headers = status_page_components_v2_show_with_http_info(id, opts)
+      data
+    end
+
+    # Show Status Page Components V2
+    # Show a single status page component.
+    # @param id [String] Unique identifier of the status page component
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StatusPageComponentsShowResultV2, Integer, Hash)>] StatusPageComponentsShowResultV2 data, response status code and response headers
+    def status_page_components_v2_show_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatusPageComponentsV2Api.status_page_components_v2_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 StatusPageComponentsV2Api.status_page_components_v2_show"
+      end
+      # resource path
+      local_var_path = '/v2/status_page_components/{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] || 'StatusPageComponentsShowResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StatusPageComponentsV2Api.status_page_components_v2_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: StatusPageComponentsV2Api#status_page_components_v2_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Status Page Components V2
+    # Update a status page component's name and description.
+    # @param id [String] Unique identifier of the status page component
+    # @param status_page_components_update_payload_v2 [StatusPageComponentsUpdatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [StatusPageComponentsUpdateResultV2]
+    def status_page_components_v2_update(id, status_page_components_update_payload_v2, opts = {})
+      data, _status_code, _headers = status_page_components_v2_update_with_http_info(id, status_page_components_update_payload_v2, opts)
+      data
+    end
+
+    # Update Status Page Components V2
+    # Update a status page component&#39;s name and description.
+    # @param id [String] Unique identifier of the status page component
+    # @param status_page_components_update_payload_v2 [StatusPageComponentsUpdatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StatusPageComponentsUpdateResultV2, Integer, Hash)>] StatusPageComponentsUpdateResultV2 data, response status code and response headers
+    def status_page_components_v2_update_with_http_info(id, status_page_components_update_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatusPageComponentsV2Api.status_page_components_v2_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 StatusPageComponentsV2Api.status_page_components_v2_update"
+      end
+      # verify the required parameter 'status_page_components_update_payload_v2' is set
+      if @api_client.config.client_side_validation && status_page_components_update_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'status_page_components_update_payload_v2' when calling StatusPageComponentsV2Api.status_page_components_v2_update"
+      end
+      # resource path
+      local_var_path = '/v2/status_page_components/{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(status_page_components_update_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'StatusPageComponentsUpdateResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"StatusPageComponentsV2Api.status_page_components_v2_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: StatusPageComponentsV2Api#status_page_components_v2_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/incident_io/models/status_page_component_v2.rb

@@ -0,0 +1,229 @@
+=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
+  # A status page component that can appear on one or more status pages.  Components are organisation-scoped. Placement on a page is controlled by that page's structure, not by ownership of the component.
+  class StatusPageComponentV2 < ApiModelBase
+    # Optional short description of this component
+    attr_accessor :description
+
+    # Unique identifier for this component
+    attr_accessor :id
+
+    attr_accessor :management_meta
+
+    # Human-readable name for the component
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'id' => :'id',
+        :'management_meta' => :'management_meta',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'description' => :'String',
+        :'id' => :'String',
+        :'management_meta' => :'ManagementMetaV2',
+        :'name' => :'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::StatusPageComponentV2` 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::StatusPageComponentV2`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'management_meta')
+        self.management_meta = attributes[:'management_meta']
+      else
+        self.management_meta = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @management_meta.nil?
+        invalid_properties.push('invalid value for "management_meta", management_meta cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @id.nil?
+      return false if @management_meta.nil?
+      return false if @name.nil?
+      true
+    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] management_meta Value to be assigned
+    def management_meta=(management_meta)
+      if management_meta.nil?
+        fail ArgumentError, 'management_meta cannot be nil'
+      end
+
+      @management_meta = management_meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    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 &&
+          description == o.description &&
+          id == o.id &&
+          management_meta == o.management_meta &&
+          name == o.name
+    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
+      [description, id, management_meta, name].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