incident_io_api 1.3.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf9f1c5912e372c6d2c203c09ef2e9d21b734512db214f0d7e5a0eb21f176f1
-  data.tar.gz: 77f62d6fed7b3a19a6e60ade9be517c565cdf6d7a70cdb3ecb436329516066ea
+  metadata.gz: 2e7a91e1f3d5eaf63c351ce67902096216d151d5979a86a655f3abac5c78159e
+  data.tar.gz: e1cce06d29e94ff99d12e21c06ae9bb9d89500cd633a2417a68ef1fb7e514345
 SHA512:
-  metadata.gz: '02308c9db7f0125ab0a839de724fc37551230154b265257537a1041cb311ac315149858317b78d2dc568e4ba9c7f3fdc492577ef7da649c85298cc5c92482a61'
-  data.tar.gz: f56c5bf6541e09cc54f9acf7199d57eeed10103efb7e637733a3839a063d665830d76df6541fa092deea8f148245a2248c2dc714f503d13dd111b5790b39573e
+  metadata.gz: 6e00237b007db00f61cbca80606093577b79cd5a7b62c295505284ec20128738fdf69605f17333e5eca442e11cb38b812bc9d9a7c2d9572584dcaafa34aaf153
+  data.tar.gz: a34c42ca564d0f7fcd46f5e4410a94b8f4415af7f030c3970c8a6b6dd654db07652ad063dbc64aa116f68c1d861a6ff7fb597d62bdaa1326e7bb20dc97c71408

data/lib/incident_io/api/incident_team_memberships_v1_api.rb

@@ -0,0 +1,158 @@
+=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 IncidentTeamMembershipsV1Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Incident Team Memberships V1
+    # Grants a team access to a private incident
+    # @param incident_team_memberships_create_payload_v1 [IncidentTeamMembershipsCreatePayloadV1] 
+    # @param [Hash] opts the optional parameters
+    # @return [IncidentTeamMembershipsCreateResultV1]
+    def incident_team_memberships_v1_create(incident_team_memberships_create_payload_v1, opts = {})
+      data, _status_code, _headers = incident_team_memberships_v1_create_with_http_info(incident_team_memberships_create_payload_v1, opts)
+      data
+    end
+
+    # Create Incident Team Memberships V1
+    # Grants a team access to a private incident
+    # @param incident_team_memberships_create_payload_v1 [IncidentTeamMembershipsCreatePayloadV1] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncidentTeamMembershipsCreateResultV1, Integer, Hash)>] IncidentTeamMembershipsCreateResultV1 data, response status code and response headers
+    def incident_team_memberships_v1_create_with_http_info(incident_team_memberships_create_payload_v1, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentTeamMembershipsV1Api.incident_team_memberships_v1_create ...'
+      end
+      # verify the required parameter 'incident_team_memberships_create_payload_v1' is set
+      if @api_client.config.client_side_validation && incident_team_memberships_create_payload_v1.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_team_memberships_create_payload_v1' when calling IncidentTeamMembershipsV1Api.incident_team_memberships_v1_create"
+      end
+      # resource path
+      local_var_path = '/v1/incident_team_memberships'
+
+      # 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_team_memberships_create_payload_v1)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncidentTeamMembershipsCreateResultV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentTeamMembershipsV1Api.incident_team_memberships_v1_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: IncidentTeamMembershipsV1Api#incident_team_memberships_v1_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke Incident Team Memberships V1
+    # Revoke a team's access to a private incident. Members who only had access through this team lose it too; directly-added members and members still covered by another team keep theirs.
+    # @param incident_team_memberships_revoke_payload_v1 [IncidentTeamMembershipsRevokePayloadV1] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def incident_team_memberships_v1_revoke(incident_team_memberships_revoke_payload_v1, opts = {})
+      incident_team_memberships_v1_revoke_with_http_info(incident_team_memberships_revoke_payload_v1, opts)
+      nil
+    end
+
+    # Revoke Incident Team Memberships V1
+    # Revoke a team&#39;s access to a private incident. Members who only had access through this team lose it too; directly-added members and members still covered by another team keep theirs.
+    # @param incident_team_memberships_revoke_payload_v1 [IncidentTeamMembershipsRevokePayloadV1] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def incident_team_memberships_v1_revoke_with_http_info(incident_team_memberships_revoke_payload_v1, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentTeamMembershipsV1Api.incident_team_memberships_v1_revoke ...'
+      end
+      # verify the required parameter 'incident_team_memberships_revoke_payload_v1' is set
+      if @api_client.config.client_side_validation && incident_team_memberships_revoke_payload_v1.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_team_memberships_revoke_payload_v1' when calling IncidentTeamMembershipsV1Api.incident_team_memberships_v1_revoke"
+      end
+      # resource path
+      local_var_path = '/v1/incident_team_memberships/actions/revoke'
+
+      # 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_team_memberships_revoke_payload_v1)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"IncidentTeamMembershipsV1Api.incident_team_memberships_v1_revoke",
+        :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: IncidentTeamMembershipsV1Api#incident_team_memberships_v1_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/incident_io/api/schedules_v2_api.rb

@@ -723,7 +723,7 @@ module IncidentIo
     end
 
     # ListScheduleEntries Schedules V2
-    # List the schedule entries for a schedule over a window of time.  Use this endpoint to find out who is on-call for a schedule, either right now or at any point in the future. Common uses include:  - Building a calendar or timeline view of who is on-call. - Looking up who was on-call at a particular moment (for example, when an   incident fired). - Exporting upcoming shifts into another system, such as a payroll or   scheduling tool.  The response groups entries into three lists: `scheduled` (the entries the rotation rules produce, before any overrides), `overrides` (any one-off overrides that apply in the window) and `final` (the effective schedule after overrides have been merged in — this is normally the list you want).  Each entry includes the `rotation_id` and `layer_id` it belongs to. Schedules can be made up of multiple rotations (for example, a primary and a secondary rotation) and each rotation can have several layers, and we return entries for every rotation and layer on the schedule.  The endpoint returns all entries that overlap with the given window. If no window is provided we default to a sensible range starting from now.  ## Pagination  Responses are paginated. When more entries are available than fit on a single page, the response includes a `pagination_meta` block with two fields:  - `after_url` — a fully-formed URL for the next page. The simplest way   to paginate is to keep following this URL until it is no longer present. - `after` — an opaque cursor token. To fetch the next page manually,   re-issue the request with `entry_window_start` set to this value and   `entry_window_end` left unchanged from the original request. Treat   the token as opaque — do not parse or modify it.  Keep paginating until `pagination_meta` is absent from the response, at which point you have received every entry in the window.
+    # List the schedule entries for a schedule over a window of time.  Use this endpoint to find out who is on-call for a schedule, either right now or at any point in the future. Common uses include:  - Building a calendar or timeline view of who is on-call. - Looking up who was on-call at a particular moment (for example, when an   incident fired). - Exporting upcoming shifts into another system, such as a payroll or   scheduling tool.  The response groups entries into three lists: `scheduled` (the entries the rotation rules produce, before any overrides), `overrides` (any one-off overrides that apply in the window) and `final` (the effective schedule after overrides have been merged in — this is normally the list you want).  Each entry includes the `rotation_id` it belongs to. Schedules can be made up of multiple rotations (for example, a primary and a secondary rotation) and each rotation can have several layers, and we return entries for every rotation and layer on the schedule.  The endpoint returns all entries that overlap with the given window. If no window is provided we default to a sensible range starting from now.  ## Pagination  Responses are paginated. When more entries are available than fit on a single page, the response includes a `pagination_meta` block with two fields:  - `after_url` — a fully-formed URL for the next page. The simplest way   to paginate is to keep following this URL until it is no longer present. - `after` — an opaque cursor token. To fetch the next page manually,   re-issue the request with `entry_window_start` set to this value and   `entry_window_end` left unchanged from the original request. Treat   the token as opaque — do not parse or modify it.  Keep paginating until `pagination_meta` is absent from the response, at which point you have received every entry in the window.
     # @param schedule_id [String] The ID of the schedule to get entries for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :entry_window_start The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).
@@ -735,7 +735,7 @@ module IncidentIo
     end
 
     # ListScheduleEntries Schedules V2
-    # List the schedule entries for a schedule over a window of time.  Use this endpoint to find out who is on-call for a schedule, either right now or at any point in the future. Common uses include:  - Building a calendar or timeline view of who is on-call. - Looking up who was on-call at a particular moment (for example, when an   incident fired). - Exporting upcoming shifts into another system, such as a payroll or   scheduling tool.  The response groups entries into three lists: `scheduled` (the entries the rotation rules produce, before any overrides), `overrides` (any one-off overrides that apply in the window) and `final` (the effective schedule after overrides have been merged in — this is normally the list you want).  Each entry includes the `rotation_id` and `layer_id` it belongs to. Schedules can be made up of multiple rotations (for example, a primary and a secondary rotation) and each rotation can have several layers, and we return entries for every rotation and layer on the schedule.  The endpoint returns all entries that overlap with the given window. If no window is provided we default to a sensible range starting from now.  ## Pagination  Responses are paginated. When more entries are available than fit on a single page, the response includes a `pagination_meta` block with two fields:  - `after_url` — a fully-formed URL for the next page. The simplest way   to paginate is to keep following this URL until it is no longer present. - `after` — an opaque cursor token. To fetch the next page manually,   re-issue the request with `entry_window_start` set to this value and   `entry_window_end` left unchanged from the original request. Treat   the token as opaque — do not parse or modify it.  Keep paginating until `pagination_meta` is absent from the response, at which point you have received every entry in the window.
+    # List the schedule entries for a schedule over a window of time.  Use this endpoint to find out who is on-call for a schedule, either right now or at any point in the future. Common uses include:  - Building a calendar or timeline view of who is on-call. - Looking up who was on-call at a particular moment (for example, when an   incident fired). - Exporting upcoming shifts into another system, such as a payroll or   scheduling tool.  The response groups entries into three lists: `scheduled` (the entries the rotation rules produce, before any overrides), `overrides` (any one-off overrides that apply in the window) and `final` (the effective schedule after overrides have been merged in — this is normally the list you want).  Each entry includes the `rotation_id` it belongs to. Schedules can be made up of multiple rotations (for example, a primary and a secondary rotation) and each rotation can have several layers, and we return entries for every rotation and layer on the schedule.  The endpoint returns all entries that overlap with the given window. If no window is provided we default to a sensible range starting from now.  ## Pagination  Responses are paginated. When more entries are available than fit on a single page, the response includes a `pagination_meta` block with two fields:  - `after_url` — a fully-formed URL for the next page. The simplest way   to paginate is to keep following this URL until it is no longer present. - `after` — an opaque cursor token. To fetch the next page manually,   re-issue the request with `entry_window_start` set to this value and   `entry_window_end` left unchanged from the original request. Treat   the token as opaque — do not parse or modify it.  Keep paginating until `pagination_meta` is absent from the response, at which point you have received every entry in the window.
     # @param schedule_id [String] The ID of the schedule to get entries for.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :entry_window_start The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).

data/lib/incident_io/models/audit_logs_on_call_notification_pause_resumed_v1.rb

@@ -0,0 +1,326 @@
+=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 AuditLogsOnCallNotificationPauseResumedV1 < ApiModelBase
+    # The type of log entry that this is
+    attr_accessor :action
+
+    attr_accessor :actor
+
+    attr_accessor :context
+
+    attr_accessor :metadata
+
+    # When the entry occurred
+    attr_accessor :occurred_at
+
+    # The custom field that was created
+    attr_accessor :targets
+
+    # Which version the event is
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'actor' => :'actor',
+        :'context' => :'context',
+        :'metadata' => :'metadata',
+        :'occurred_at' => :'occurred_at',
+        :'targets' => :'targets',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'action' => :'String',
+        :'actor' => :'AuditLogActorV2',
+        :'context' => :'AuditLogEntryContextV2',
+        :'metadata' => :'AuditLogOnCallNotificationPauseMetadataV2',
+        :'occurred_at' => :'Time',
+        :'targets' => :'Array<AuditLogTargetV2>',
+        :'version' => :'Integer'
+      }
+    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::AuditLogsOnCallNotificationPauseResumedV1` 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::AuditLogsOnCallNotificationPauseResumedV1`. 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?(:'action')
+        self.action = attributes[:'action']
+      else
+        self.action = nil
+      end
+
+      if attributes.key?(:'actor')
+        self.actor = attributes[:'actor']
+      else
+        self.actor = nil
+      end
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      else
+        self.context = nil
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      else
+        self.metadata = nil
+      end
+
+      if attributes.key?(:'occurred_at')
+        self.occurred_at = attributes[:'occurred_at']
+      else
+        self.occurred_at = nil
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      else
+        self.targets = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = 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 @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @actor.nil?
+        invalid_properties.push('invalid value for "actor", actor cannot be nil.')
+      end
+
+      if @context.nil?
+        invalid_properties.push('invalid value for "context", context cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @occurred_at.nil?
+        invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
+      end
+
+      if @targets.nil?
+        invalid_properties.push('invalid value for "targets", targets cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version 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 @action.nil?
+      return false if @actor.nil?
+      return false if @context.nil?
+      return false if @metadata.nil?
+      return false if @occurred_at.nil?
+      return false if @targets.nil?
+      return false if @version.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] action Value to be assigned
+    def action=(action)
+      if action.nil?
+        fail ArgumentError, 'action cannot be nil'
+      end
+
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actor Value to be assigned
+    def actor=(actor)
+      if actor.nil?
+        fail ArgumentError, 'actor cannot be nil'
+      end
+
+      @actor = actor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] context Value to be assigned
+    def context=(context)
+      if context.nil?
+        fail ArgumentError, 'context cannot be nil'
+      end
+
+      @context = context
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      if metadata.nil?
+        fail ArgumentError, 'metadata cannot be nil'
+      end
+
+      @metadata = metadata
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] occurred_at Value to be assigned
+    def occurred_at=(occurred_at)
+      if occurred_at.nil?
+        fail ArgumentError, 'occurred_at cannot be nil'
+      end
+
+      @occurred_at = occurred_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] targets Value to be assigned
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'targets cannot be nil'
+      end
+
+      @targets = targets
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      @version = version
+    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 &&
+          action == o.action &&
+          actor == o.actor &&
+          context == o.context &&
+          metadata == o.metadata &&
+          occurred_at == o.occurred_at &&
+          targets == o.targets &&
+          version == o.version
+    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
+      [action, actor, context, metadata, occurred_at, targets, version].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