incident_io_sdk 0.1.0

data/lib/incident_io_sdk/models/custom_fields_create_payload_v1.rb

@@ -0,0 +1,460 @@
+=begin
+#incident.io
+
+#This is the API reference for incident.io.  It documents available API endpoints, provides examples of how to use it, and instructions around things like authentication and error handling.  The API is hosted at:  - https://api.incident.io/  And you will need to create an API key via your [incident.io dashboard](https://app.incident.io/settings/api-keys) to make requests.  # Making requests  Here are the key concepts required to make requests to the incident.io API.  ## Authentication  For all requests made to the incident.io API, you'll need an API key.  To create an API key, head to the incident dashboard and visit [API keys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it can take for your account: choose carefully, as those roles can only be set when you first create the key. We'll only show you the token once, so make sure you store it somewhere safe.  API keys are global to your incident.io account, and can be managed by anyone who has the right permissions. We display the user that created the API key, and the API key will remain valid if that user becomes deactivated.  Once you have the key, you should make requests to the API that set the `Authorization` request header using a \"Bearer\" authentication scheme:  ``` Authorization: Bearer <YOUR_API_KEY> ```  ## Rate Limits  The incident.io API enforces rate limits to ensure consistent performance for all users.  The default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API.  Some endpoints have lower rate limits, particularly those that interact with external third-party systems that impose their own limitations. These specific limits vary by endpoint, and we recommend relying on the rate-limit error responses to understand usage patterns and implement appropriate retry strategies.  When you exceed a rate limit, the API will respond with a `429 Too Many Requests` status code, along with a JSON response that includes information about the limit and when you can retry:  ```json {     \"type\": \"too_many_requests\",     \"status\": 429,     \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\",     \"rate_limit\": {         \"name\": \"api_key_name\",         \"limit\": 1200,         \"remaining\": 0,         \"retry_after\": \"Thu, 17 Apr 2025 11:17:18 UTC\"     },     \"errors\": [         {             \"code\": \"too_many_requests\",             \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"         }     ] } ```  The response includes: * The name of the API key (`name`) * The bucket limit (`limit`) * The number of requests remaining (`remaining`) * When you can retry requests (`retry_after`)  ## Errors  We use standard HTTP response codes to indicate the status or failure of API requests.  The API response body will be JSON, and contain more detailed information on the nature of the error.  An example error when a request is made without an API key:  ```json {   \"type\": \"authentication_error\",   \"status\": 401,   \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\",   \"errors\": [     {       \"code\": \"missing_authorization_material\",       \"message\": \"No authorization material provided in request\"     }   ] } ```  Note that the error:  - Contains the HTTP status (`401`) - References the type of error (`authentication_error`) - Includes a `request_id` that can be provided to incident.io support to help  debug questions with your API request - Provides a list of individual errors, which go into detail about why the error  occurred  The most common error will be a 422 Validation Error, which is returned when the request was rejected due to failing validations.  These errors look like this:  ```json {   \"type\": \"validation_error\",   \"status\": 422,   \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\",   \"errors\": [     {       \"code\": \"is_required\",       \"message\": \"A severity is required to open an incident\",       \"source\": {         \"field\": \"severity_id\"       }     }   ] } ```  This error is caused by not providing a severity identifier, which should be at the `severity_id` field of the request payload. Errors like these can be mapped to forms, should you be integrating with the API from a user-interface.  ## Compatibility  We won't make breaking changes to existing API services or endpoints, but will expect integrators to upgrade themselves to the latest API endpoints within 3 months of us deprecating the old service.  We will make changes that are considered backwards compatible, which include:  - Adding new API endpoints and services - Adding new properties to responses from existing API endpoints - Reordering properties returned from existing API endpoints - Adding optional request parameters to existing API endpoints - Altering the format or length of IDs - Adding new values to enums  It is important that clients are robust to these changes, to ensure reliable integrations.  As an example, if you are generating a client using an openapi-generator, ensure the generated client is configured to support unknown enum values, often configured via the `enumUnknownDefaultCase` parameter.  When breaking changes are unavoidable, we'll create a new service version on a separate path, and run them in parallel.  For example:  - https://api.incident.io/v1/incidents - https://api.incident.io/v2/incidents  For any questions, email support@incident.io. 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module IncidentIoSdk
+  class CustomFieldsCreatePayloadV1
+    # Description of the custom field
+    attr_accessor :description
+
+    # Type of custom field
+    attr_accessor :field_type
+
+    # Human readable name for the custom field
+    attr_accessor :name
+
+    # When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].
+    attr_accessor :required
+
+    # When this custom field must be set during the incident lifecycle.
+    attr_accessor :required_v2
+
+    # Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.
+    attr_accessor :show_before_closure
+
+    # Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.
+    attr_accessor :show_before_creation
+
+    # Whether a custom field should be shown in the incident update modal.
+    attr_accessor :show_before_update
+
+    # Whether a custom field should be shown in the list of fields as part of the announcement post when set.
+    attr_accessor :show_in_announcement_post
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'field_type' => :'field_type',
+        :'name' => :'name',
+        :'required' => :'required',
+        :'required_v2' => :'required_v2',
+        :'show_before_closure' => :'show_before_closure',
+        :'show_before_creation' => :'show_before_creation',
+        :'show_before_update' => :'show_before_update',
+        :'show_in_announcement_post' => :'show_in_announcement_post'
+      }
+    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',
+        :'field_type' => :'String',
+        :'name' => :'String',
+        :'required' => :'String',
+        :'required_v2' => :'String',
+        :'show_before_closure' => :'Boolean',
+        :'show_before_creation' => :'Boolean',
+        :'show_before_update' => :'Boolean',
+        :'show_in_announcement_post' => :'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 `IncidentIoSdk::CustomFieldsCreatePayloadV1` 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 `IncidentIoSdk::CustomFieldsCreatePayloadV1`. 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']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'field_type')
+        self.field_type = attributes[:'field_type']
+      else
+        self.field_type = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'required')
+        self.required = attributes[:'required']
+      end
+
+      if attributes.key?(:'required_v2')
+        self.required_v2 = attributes[:'required_v2']
+      end
+
+      if attributes.key?(:'show_before_closure')
+        self.show_before_closure = attributes[:'show_before_closure']
+      else
+        self.show_before_closure = nil
+      end
+
+      if attributes.key?(:'show_before_creation')
+        self.show_before_creation = attributes[:'show_before_creation']
+      else
+        self.show_before_creation = nil
+      end
+
+      if attributes.key?(:'show_before_update')
+        self.show_before_update = attributes[:'show_before_update']
+      else
+        self.show_before_update = nil
+      end
+
+      if attributes.key?(:'show_in_announcement_post')
+        self.show_in_announcement_post = attributes[:'show_in_announcement_post']
+      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 @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @field_type.nil?
+        invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 50
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
+      end
+
+      if @show_before_closure.nil?
+        invalid_properties.push('invalid value for "show_before_closure", show_before_closure cannot be nil.')
+      end
+
+      if @show_before_creation.nil?
+        invalid_properties.push('invalid value for "show_before_creation", show_before_creation cannot be nil.')
+      end
+
+      if @show_before_update.nil?
+        invalid_properties.push('invalid value for "show_before_update", show_before_update 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 @description.nil?
+      return false if @field_type.nil?
+      field_type_validator = EnumAttributeValidator.new('String', ["single_select", "multi_select", "text", "link", "numeric"])
+      return false unless field_type_validator.valid?(@field_type)
+      return false if @name.nil?
+      return false if @name.to_s.length > 50
+      required_validator = EnumAttributeValidator.new('String', ["never", "before_closure", "always"])
+      return false unless required_validator.valid?(@required)
+      required_v2_validator = EnumAttributeValidator.new('String', ["never", "before_resolution", "always"])
+      return false unless required_v2_validator.valid?(@required_v2)
+      return false if @show_before_closure.nil?
+      return false if @show_before_creation.nil?
+      return false if @show_before_update.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] field_type Object to be assigned
+    def field_type=(field_type)
+      validator = EnumAttributeValidator.new('String', ["single_select", "multi_select", "text", "link", "numeric"])
+      unless validator.valid?(field_type)
+        fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}."
+      end
+      @field_type = field_type
+    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
+
+      if name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] required Object to be assigned
+    def required=(required)
+      validator = EnumAttributeValidator.new('String', ["never", "before_closure", "always"])
+      unless validator.valid?(required)
+        fail ArgumentError, "invalid value for \"required\", must be one of #{validator.allowable_values}."
+      end
+      @required = required
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] required_v2 Object to be assigned
+    def required_v2=(required_v2)
+      validator = EnumAttributeValidator.new('String', ["never", "before_resolution", "always"])
+      unless validator.valid?(required_v2)
+        fail ArgumentError, "invalid value for \"required_v2\", must be one of #{validator.allowable_values}."
+      end
+      @required_v2 = required_v2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] show_before_closure Value to be assigned
+    def show_before_closure=(show_before_closure)
+      if show_before_closure.nil?
+        fail ArgumentError, 'show_before_closure cannot be nil'
+      end
+
+      @show_before_closure = show_before_closure
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] show_before_creation Value to be assigned
+    def show_before_creation=(show_before_creation)
+      if show_before_creation.nil?
+        fail ArgumentError, 'show_before_creation cannot be nil'
+      end
+
+      @show_before_creation = show_before_creation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] show_before_update Value to be assigned
+    def show_before_update=(show_before_update)
+      if show_before_update.nil?
+        fail ArgumentError, 'show_before_update cannot be nil'
+      end
+
+      @show_before_update = show_before_update
+    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 &&
+          field_type == o.field_type &&
+          name == o.name &&
+          required == o.required &&
+          required_v2 == o.required_v2 &&
+          show_before_closure == o.show_before_closure &&
+          show_before_creation == o.show_before_creation &&
+          show_before_update == o.show_before_update &&
+          show_in_announcement_post == o.show_in_announcement_post
+    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, field_type, name, required, required_v2, show_before_closure, show_before_creation, show_before_update, show_in_announcement_post].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = IncidentIoSdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end