sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/webhook_delivery_attempt.rb

@@ -0,0 +1,562 @@
+=begin
+#Sendmux API
+
+#Programmatic access to your Sendmux email infrastructure.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Sendmux::Management::Generated
+  class WebhookDeliveryAttempt < ApiModelBase
+    # ISO 8601 attempt timestamp
+    attr_accessor :created_at
+
+    # 1-based retry attempt number.
+    attr_accessor :delivery_attempt
+
+    # Public-safe network error category when no HTTP response was received.
+    attr_accessor :error_message
+
+    # Webhook event ID
+    attr_accessor :event_id
+
+    # Event types a webhook may subscribe to. `sendmux.test` is accepted so you can verify end-to-end delivery via POST /webhooks/{id}/test.
+    attr_accessor :event_type
+
+    # Delivery-attempt public ID
+    attr_accessor :id
+
+    # Maximum attempts before the subscription is marked failing.
+    attr_accessor :max_attempts
+
+    # Next retry timestamp when result is retrying; otherwise null.
+    attr_accessor :next_retry_at
+
+    # True while the delivered request payload can still be fetched.
+    attr_accessor :payload_available
+
+    # Timestamp when the retained request payload expires.
+    attr_accessor :payload_expires_at
+
+    # Size of the delivered request payload in bytes.
+    attr_accessor :request_payload_bytes
+
+    # SHA-256 digest of the delivered request payload.
+    attr_accessor :request_payload_sha256
+
+    # Truncated endpoint response preview, if any.
+    attr_accessor :response_body
+
+    # End-to-end delivery latency in milliseconds.
+    attr_accessor :response_ms
+
+    # HTTP status returned by the endpoint, or null for network/timeout failures.
+    attr_accessor :response_status
+
+    # Delivery result for this attempt.
+    attr_accessor :result
+
+    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
+      {
+        :'created_at' => :'created_at',
+        :'delivery_attempt' => :'delivery_attempt',
+        :'error_message' => :'error_message',
+        :'event_id' => :'event_id',
+        :'event_type' => :'event_type',
+        :'id' => :'id',
+        :'max_attempts' => :'max_attempts',
+        :'next_retry_at' => :'next_retry_at',
+        :'payload_available' => :'payload_available',
+        :'payload_expires_at' => :'payload_expires_at',
+        :'request_payload_bytes' => :'request_payload_bytes',
+        :'request_payload_sha256' => :'request_payload_sha256',
+        :'response_body' => :'response_body',
+        :'response_ms' => :'response_ms',
+        :'response_status' => :'response_status',
+        :'result' => :'result'
+      }
+    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
+      {
+        :'created_at' => :'String',
+        :'delivery_attempt' => :'Integer',
+        :'error_message' => :'String',
+        :'event_id' => :'String',
+        :'event_type' => :'String',
+        :'id' => :'String',
+        :'max_attempts' => :'Integer',
+        :'next_retry_at' => :'String',
+        :'payload_available' => :'Boolean',
+        :'payload_expires_at' => :'String',
+        :'request_payload_bytes' => :'Integer',
+        :'request_payload_sha256' => :'String',
+        :'response_body' => :'String',
+        :'response_ms' => :'Integer',
+        :'response_status' => :'Integer',
+        :'result' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'error_message',
+        :'next_retry_at',
+        :'request_payload_sha256',
+        :'response_body',
+        :'response_status',
+      ])
+    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 `Sendmux::Management::Generated::WebhookDeliveryAttempt` 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 `Sendmux::Management::Generated::WebhookDeliveryAttempt`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'delivery_attempt')
+        self.delivery_attempt = attributes[:'delivery_attempt']
+      else
+        self.delivery_attempt = nil
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      else
+        self.error_message = nil
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      else
+        self.event_id = nil
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'max_attempts')
+        self.max_attempts = attributes[:'max_attempts']
+      else
+        self.max_attempts = nil
+      end
+
+      if attributes.key?(:'next_retry_at')
+        self.next_retry_at = attributes[:'next_retry_at']
+      else
+        self.next_retry_at = nil
+      end
+
+      if attributes.key?(:'payload_available')
+        self.payload_available = attributes[:'payload_available']
+      else
+        self.payload_available = nil
+      end
+
+      if attributes.key?(:'payload_expires_at')
+        self.payload_expires_at = attributes[:'payload_expires_at']
+      else
+        self.payload_expires_at = nil
+      end
+
+      if attributes.key?(:'request_payload_bytes')
+        self.request_payload_bytes = attributes[:'request_payload_bytes']
+      else
+        self.request_payload_bytes = nil
+      end
+
+      if attributes.key?(:'request_payload_sha256')
+        self.request_payload_sha256 = attributes[:'request_payload_sha256']
+      else
+        self.request_payload_sha256 = nil
+      end
+
+      if attributes.key?(:'response_body')
+        self.response_body = attributes[:'response_body']
+      else
+        self.response_body = nil
+      end
+
+      if attributes.key?(:'response_ms')
+        self.response_ms = attributes[:'response_ms']
+      else
+        self.response_ms = nil
+      end
+
+      if attributes.key?(:'response_status')
+        self.response_status = attributes[:'response_status']
+      else
+        self.response_status = nil
+      end
+
+      if attributes.key?(:'result')
+        self.result = attributes[:'result']
+      else
+        self.result = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @delivery_attempt.nil?
+        invalid_properties.push('invalid value for "delivery_attempt", delivery_attempt cannot be nil.')
+      end
+
+      if @delivery_attempt <= 0
+        invalid_properties.push('invalid value for "delivery_attempt", must be greater than 0.')
+      end
+
+      if @event_id.nil?
+        invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @max_attempts.nil?
+        invalid_properties.push('invalid value for "max_attempts", max_attempts cannot be nil.')
+      end
+
+      if @max_attempts <= 0
+        invalid_properties.push('invalid value for "max_attempts", must be greater than 0.')
+      end
+
+      if @payload_available.nil?
+        invalid_properties.push('invalid value for "payload_available", payload_available cannot be nil.')
+      end
+
+      if @payload_expires_at.nil?
+        invalid_properties.push('invalid value for "payload_expires_at", payload_expires_at cannot be nil.')
+      end
+
+      if @request_payload_bytes.nil?
+        invalid_properties.push('invalid value for "request_payload_bytes", request_payload_bytes cannot be nil.')
+      end
+
+      if @request_payload_bytes < 0
+        invalid_properties.push('invalid value for "request_payload_bytes", must be greater than or equal to 0.')
+      end
+
+      if @response_ms.nil?
+        invalid_properties.push('invalid value for "response_ms", response_ms cannot be nil.')
+      end
+
+      if @response_ms < 0
+        invalid_properties.push('invalid value for "response_ms", must be greater than or equal to 0.')
+      end
+
+      if @result.nil?
+        invalid_properties.push('invalid value for "result", result cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @created_at.nil?
+      return false if @delivery_attempt.nil?
+      return false if @delivery_attempt <= 0
+      return false if @event_id.nil?
+      return false if @event_type.nil?
+      event_type_validator = EnumAttributeValidator.new('String', ["message.delivered", "message.bounced", "message.complained", "message.rejected", "message.delivery_delayed", "message.received", "message.received.spam", "sendmux.test", "unknown_default_open_api"])
+      return false unless event_type_validator.valid?(@event_type)
+      return false if @id.nil?
+      return false if @max_attempts.nil?
+      return false if @max_attempts <= 0
+      return false if @payload_available.nil?
+      return false if @payload_expires_at.nil?
+      return false if @request_payload_bytes.nil?
+      return false if @request_payload_bytes < 0
+      return false if @response_ms.nil?
+      return false if @response_ms < 0
+      return false if @result.nil?
+      result_validator = EnumAttributeValidator.new('String', ["success", "retrying", "failed", "permanent_failure", "unknown_default_open_api"])
+      return false unless result_validator.valid?(@result)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] delivery_attempt Value to be assigned
+    def delivery_attempt=(delivery_attempt)
+      if delivery_attempt.nil?
+        fail ArgumentError, 'delivery_attempt cannot be nil'
+      end
+
+      if delivery_attempt <= 0
+        fail ArgumentError, 'invalid value for "delivery_attempt", must be greater than 0.'
+      end
+
+      @delivery_attempt = delivery_attempt
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_id Value to be assigned
+    def event_id=(event_id)
+      if event_id.nil?
+        fail ArgumentError, 'event_id cannot be nil'
+      end
+
+      @event_id = event_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_type Object to be assigned
+    def event_type=(event_type)
+      validator = EnumAttributeValidator.new('String', ["message.delivered", "message.bounced", "message.complained", "message.rejected", "message.delivery_delayed", "message.received", "message.received.spam", "sendmux.test", "unknown_default_open_api"])
+      unless validator.valid?(event_type)
+        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      end
+      @event_type = event_type
+    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] max_attempts Value to be assigned
+    def max_attempts=(max_attempts)
+      if max_attempts.nil?
+        fail ArgumentError, 'max_attempts cannot be nil'
+      end
+
+      if max_attempts <= 0
+        fail ArgumentError, 'invalid value for "max_attempts", must be greater than 0.'
+      end
+
+      @max_attempts = max_attempts
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payload_available Value to be assigned
+    def payload_available=(payload_available)
+      if payload_available.nil?
+        fail ArgumentError, 'payload_available cannot be nil'
+      end
+
+      @payload_available = payload_available
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payload_expires_at Value to be assigned
+    def payload_expires_at=(payload_expires_at)
+      if payload_expires_at.nil?
+        fail ArgumentError, 'payload_expires_at cannot be nil'
+      end
+
+      @payload_expires_at = payload_expires_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_payload_bytes Value to be assigned
+    def request_payload_bytes=(request_payload_bytes)
+      if request_payload_bytes.nil?
+        fail ArgumentError, 'request_payload_bytes cannot be nil'
+      end
+
+      if request_payload_bytes < 0
+        fail ArgumentError, 'invalid value for "request_payload_bytes", must be greater than or equal to 0.'
+      end
+
+      @request_payload_bytes = request_payload_bytes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_ms Value to be assigned
+    def response_ms=(response_ms)
+      if response_ms.nil?
+        fail ArgumentError, 'response_ms cannot be nil'
+      end
+
+      if response_ms < 0
+        fail ArgumentError, 'invalid value for "response_ms", must be greater than or equal to 0.'
+      end
+
+      @response_ms = response_ms
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] result Object to be assigned
+    def result=(result)
+      validator = EnumAttributeValidator.new('String', ["success", "retrying", "failed", "permanent_failure", "unknown_default_open_api"])
+      unless validator.valid?(result)
+        fail ArgumentError, "invalid value for \"result\", must be one of #{validator.allowable_values}."
+      end
+      @result = result
+    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 &&
+          created_at == o.created_at &&
+          delivery_attempt == o.delivery_attempt &&
+          error_message == o.error_message &&
+          event_id == o.event_id &&
+          event_type == o.event_type &&
+          id == o.id &&
+          max_attempts == o.max_attempts &&
+          next_retry_at == o.next_retry_at &&
+          payload_available == o.payload_available &&
+          payload_expires_at == o.payload_expires_at &&
+          request_payload_bytes == o.request_payload_bytes &&
+          request_payload_sha256 == o.request_payload_sha256 &&
+          response_body == o.response_body &&
+          response_ms == o.response_ms &&
+          response_status == o.response_status &&
+          result == o.result
+    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
+      [created_at, delivery_attempt, error_message, event_id, event_type, id, max_attempts, next_retry_at, payload_available, payload_expires_at, request_payload_bytes, request_payload_sha256, response_body, response_ms, response_status, result].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