shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/error_record.rb

@@ -0,0 +1,597 @@
+=begin
+#Shipeasy Admin API
+
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # A tracked production error — one row per distinct issue, keyed by `fingerprint`. Rows are never created by hand: an ingestion path (worker log drain / the `see()` SDK reporter) folds each occurrence into the matching row, bumping `count` and `lastSeenAt`. The admin surface only lists them, reads one, and flips `status`.  Field names are camelCase (the D1 row projected through Drizzle). Many columns are nullable because the reporting source may not supply them.
+  class ErrorRecord < ApiModelBase
+    # Stable opaque error id.
+    attr_accessor :id
+
+    # Project this issue belongs to.
+    attr_accessor :project_id
+
+    # Stable dedupe key (hash of `errorType` + normalized `message` + consequence). Unique per project — every occurrence with the same fingerprint folds into this one row.
+    attr_accessor :fingerprint
+
+    # Fingerprint of the issue this one descends from — set when `see()` reported the same error (re-throw) or its `{ cause }` (wrap) at an inner boundary first. Points at another error's `fingerprint` in the same project (soft reference, no FK). `null` for a root issue.
+    attr_accessor :caused_by_fingerprint
+
+    # Error message text.
+    attr_accessor :message
+
+    # Error class/name, e.g. `TypeError`. `null` when the source didn't supply one.
+    attr_accessor :error_type
+
+    # Stack trace of the latest occurrence, or `null` if none was captured.
+    attr_accessor :stack
+
+    # Where it surfaced — Worker name (`shipeasy`, `shipeasy-worker`) or `sdk-client` / `sdk-server`. `null` if unknown.
+    attr_accessor :source
+
+    # Latest occurrence's raw URL (with ids intact), or `null`.
+    attr_accessor :url
+
+    # Distinct, id-normalized route templates this issue has surfaced on, as a JSON-encoded string array (e.g. `[\"https://app/dashboard/#/gates\"]`). UUIDs / numeric ids / opaque tokens are collapsed to `#` so the same route under different ids counts once. `null` if none recorded.
+    attr_accessor :seen_urls
+
+    # Consequence subject — `<errorType> causes the <subject> to <outcome>`. `null` if no consequence was reported.
+    attr_accessor :subject
+
+    # Consequence outcome — see `subject`. `null` if no consequence was reported.
+    attr_accessor :outcome
+
+    # Which SDK side reported it — `client` or `server`. `null` if unknown.
+    attr_accessor :side
+
+    # Published env the reporting SDK ran against (e.g. `dev`, `staging`, `prod`). `null` if unknown.
+    attr_accessor :env
+
+    # `see()` error kind. `null` when the source didn't classify the occurrence.
+    attr_accessor :kind
+
+    # Latest occurrence's sanitized extras, JSON-encoded. `null` if none.
+    attr_accessor :last_extras_json
+
+    # `@shipeasy/sdk` version of the latest occurrence, or `null`.
+    attr_accessor :sdk_version
+
+    # Number of folded occurrences for this fingerprint.
+    attr_accessor :count
+
+    # Triage state. `open` is the default; a `resolved` error reopens automatically (ingestion-side) if it recurs; `ignored` is sticky until flipped back here.
+    attr_accessor :status
+
+    # ISO-8601 timestamp of the first folded occurrence.
+    attr_accessor :first_seen_at
+
+    # ISO-8601 timestamp of the most recent folded occurrence. Rows are ordered by this, descending.
+    attr_accessor :last_seen_at
+
+    # ISO-8601 timestamp the row was created.
+    attr_accessor :created_at
+
+    # ISO-8601 timestamp of the last mutation (e.g. a status flip).
+    attr_accessor :updated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'project_id' => :'projectId',
+        :'fingerprint' => :'fingerprint',
+        :'caused_by_fingerprint' => :'causedByFingerprint',
+        :'message' => :'message',
+        :'error_type' => :'errorType',
+        :'stack' => :'stack',
+        :'source' => :'source',
+        :'url' => :'url',
+        :'seen_urls' => :'seenUrls',
+        :'subject' => :'subject',
+        :'outcome' => :'outcome',
+        :'side' => :'side',
+        :'env' => :'env',
+        :'kind' => :'kind',
+        :'last_extras_json' => :'lastExtrasJson',
+        :'sdk_version' => :'sdkVersion',
+        :'count' => :'count',
+        :'status' => :'status',
+        :'first_seen_at' => :'firstSeenAt',
+        :'last_seen_at' => :'lastSeenAt',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'project_id' => :'String',
+        :'fingerprint' => :'String',
+        :'caused_by_fingerprint' => :'String',
+        :'message' => :'String',
+        :'error_type' => :'String',
+        :'stack' => :'String',
+        :'source' => :'String',
+        :'url' => :'String',
+        :'seen_urls' => :'String',
+        :'subject' => :'String',
+        :'outcome' => :'String',
+        :'side' => :'String',
+        :'env' => :'String',
+        :'kind' => :'String',
+        :'last_extras_json' => :'String',
+        :'sdk_version' => :'String',
+        :'count' => :'Integer',
+        :'status' => :'String',
+        :'first_seen_at' => :'String',
+        :'last_seen_at' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'caused_by_fingerprint',
+        :'error_type',
+        :'stack',
+        :'source',
+        :'url',
+        :'seen_urls',
+        :'subject',
+        :'outcome',
+        :'side',
+        :'env',
+        :'kind',
+        :'last_extras_json',
+        :'sdk_version',
+      ])
+    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 `Shipeasy::Admin::Generated::ErrorRecord` 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 `Shipeasy::Admin::Generated::ErrorRecord`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = nil
+      end
+
+      if attributes.key?(:'fingerprint')
+        self.fingerprint = attributes[:'fingerprint']
+      else
+        self.fingerprint = nil
+      end
+
+      if attributes.key?(:'caused_by_fingerprint')
+        self.caused_by_fingerprint = attributes[:'caused_by_fingerprint']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'error_type')
+        self.error_type = attributes[:'error_type']
+      end
+
+      if attributes.key?(:'stack')
+        self.stack = attributes[:'stack']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'seen_urls')
+        self.seen_urls = attributes[:'seen_urls']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'side')
+        self.side = attributes[:'side']
+      end
+
+      if attributes.key?(:'env')
+        self.env = attributes[:'env']
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'last_extras_json')
+        self.last_extras_json = attributes[:'last_extras_json']
+      end
+
+      if attributes.key?(:'sdk_version')
+        self.sdk_version = attributes[:'sdk_version']
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      else
+        self.count = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'first_seen_at')
+        self.first_seen_at = attributes[:'first_seen_at']
+      else
+        self.first_seen_at = nil
+      end
+
+      if attributes.key?(:'last_seen_at')
+        self.last_seen_at = attributes[:'last_seen_at']
+      else
+        self.last_seen_at = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id cannot be nil.')
+      end
+
+      if @fingerprint.nil?
+        invalid_properties.push('invalid value for "fingerprint", fingerprint cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      if @count.nil?
+        invalid_properties.push('invalid value for "count", count cannot be nil.')
+      end
+
+      if @count < 1
+        invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @first_seen_at.nil?
+        invalid_properties.push('invalid value for "first_seen_at", first_seen_at cannot be nil.')
+      end
+
+      if @last_seen_at.nil?
+        invalid_properties.push('invalid value for "last_seen_at", last_seen_at cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @project_id.nil?
+      return false if @fingerprint.nil?
+      return false if @message.nil?
+      kind_validator = EnumAttributeValidator.new('String', ["caught", "uncaught", "unhandled_rejection", "network", "violation"])
+      return false unless kind_validator.valid?(@kind)
+      return false if @count.nil?
+      return false if @count < 1
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["open", "resolved", "ignored"])
+      return false unless status_validator.valid?(@status)
+      return false if @first_seen_at.nil?
+      return false if @last_seen_at.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.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] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fingerprint Value to be assigned
+    def fingerprint=(fingerprint)
+      if fingerprint.nil?
+        fail ArgumentError, 'fingerprint cannot be nil'
+      end
+
+      @fingerprint = fingerprint
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["caught", "uncaught", "unhandled_rejection", "network", "violation"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] count Value to be assigned
+    def count=(count)
+      if count.nil?
+        fail ArgumentError, 'count cannot be nil'
+      end
+
+      if count < 1
+        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.'
+      end
+
+      @count = count
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["open", "resolved", "ignored"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_seen_at Value to be assigned
+    def first_seen_at=(first_seen_at)
+      if first_seen_at.nil?
+        fail ArgumentError, 'first_seen_at cannot be nil'
+      end
+
+      @first_seen_at = first_seen_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_seen_at Value to be assigned
+    def last_seen_at=(last_seen_at)
+      if last_seen_at.nil?
+        fail ArgumentError, 'last_seen_at cannot be nil'
+      end
+
+      @last_seen_at = last_seen_at
+    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] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          id == o.id &&
+          project_id == o.project_id &&
+          fingerprint == o.fingerprint &&
+          caused_by_fingerprint == o.caused_by_fingerprint &&
+          message == o.message &&
+          error_type == o.error_type &&
+          stack == o.stack &&
+          source == o.source &&
+          url == o.url &&
+          seen_urls == o.seen_urls &&
+          subject == o.subject &&
+          outcome == o.outcome &&
+          side == o.side &&
+          env == o.env &&
+          kind == o.kind &&
+          last_extras_json == o.last_extras_json &&
+          sdk_version == o.sdk_version &&
+          count == o.count &&
+          status == o.status &&
+          first_seen_at == o.first_seen_at &&
+          last_seen_at == o.last_seen_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, project_id, fingerprint, caused_by_fingerprint, message, error_type, stack, source, url, seen_urls, subject, outcome, side, env, kind, last_extras_json, sdk_version, count, status, first_seen_at, last_seen_at, created_at, updated_at].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