sendmux-management 1.0.0

data/lib/sendmux_management_generated/models/webhook_delivery_payload_response.rb

@@ -0,0 +1,223 @@
+=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 WebhookDeliveryPayloadResponse < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok',
+        :'data' => :'data'
+      }
+    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
+      {
+        :'meta' => :'ResponseMeta',
+        :'ok' => :'Boolean',
+        :'data' => :'WebhookDeliveryPayload'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SuccessEnvelope'
+      ]
+    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::WebhookDeliveryPayloadResponse` 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::WebhookDeliveryPayloadResponse`. 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?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @meta.nil?
+      return false if @ok.nil?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          meta == o.meta &&
+          ok == o.ok &&
+          data == o.data
+    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
+      [meta, ok, data].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

data/lib/sendmux_management_generated/models/webhook_event_data.rb

@@ -0,0 +1,395 @@
+=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 WebhookEventData < ApiModelBase
+    # More specific bounce category when available.
+    attr_accessor :bounce_subtype
+
+    # Bounce category for `message.bounced` events.
+    attr_accessor :bounce_type
+
+    # More specific complaint category when available.
+    attr_accessor :complaint_subtype
+
+    # Complaint category for `message.complained` events.
+    attr_accessor :complaint_type
+
+    # When delivery retries are expected to stop, when provided.
+    attr_accessor :delay_expires_at
+
+    # Delay category for `message.delivery_delayed` events.
+    attr_accessor :delay_type
+
+    # Only populated for inbound mailbox events.
+    attr_accessor :is_spam
+
+    # Mailbox public ID for inbound mailbox events when resolved.
+    attr_accessor :mailbox_id
+
+    # Message identifier from the event source.
+    attr_accessor :message_id
+
+    # `provider` for sending feedback IDs; `rfc5322` for inbound email Message-ID header values.
+    attr_accessor :message_id_kind
+
+    # All affected recipients. Empty for synthetic test events.
+    attr_accessor :recipients
+
+    # Reject reason for `message.rejected` events.
+    attr_accessor :reject_reason
+
+    # Sender/envelope-from address when available.
+    attr_accessor :sender
+
+    # Sendmux message correlation ID for outbound sending feedback when available.
+    attr_accessor :sendmux_message_id
+
+    # Target webhook ID for synthetic `sendmux.test` payloads.
+    attr_accessor :webhook_id
+
+    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
+      {
+        :'bounce_subtype' => :'bounce_subtype',
+        :'bounce_type' => :'bounce_type',
+        :'complaint_subtype' => :'complaint_subtype',
+        :'complaint_type' => :'complaint_type',
+        :'delay_expires_at' => :'delay_expires_at',
+        :'delay_type' => :'delay_type',
+        :'is_spam' => :'is_spam',
+        :'mailbox_id' => :'mailbox_id',
+        :'message_id' => :'message_id',
+        :'message_id_kind' => :'message_id_kind',
+        :'recipients' => :'recipients',
+        :'reject_reason' => :'reject_reason',
+        :'sender' => :'sender',
+        :'sendmux_message_id' => :'sendmux_message_id',
+        :'webhook_id' => :'webhook_id'
+      }
+    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
+      {
+        :'bounce_subtype' => :'String',
+        :'bounce_type' => :'String',
+        :'complaint_subtype' => :'String',
+        :'complaint_type' => :'String',
+        :'delay_expires_at' => :'String',
+        :'delay_type' => :'String',
+        :'is_spam' => :'Boolean',
+        :'mailbox_id' => :'String',
+        :'message_id' => :'String',
+        :'message_id_kind' => :'String',
+        :'recipients' => :'Array<String>',
+        :'reject_reason' => :'String',
+        :'sender' => :'String',
+        :'sendmux_message_id' => :'String',
+        :'webhook_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'bounce_subtype',
+        :'bounce_type',
+        :'complaint_subtype',
+        :'complaint_type',
+        :'delay_expires_at',
+        :'delay_type',
+        :'is_spam',
+        :'mailbox_id',
+        :'message_id',
+        :'message_id_kind',
+        :'reject_reason',
+        :'sender',
+        :'sendmux_message_id',
+        :'webhook_id'
+      ])
+    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::WebhookEventData` 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::WebhookEventData`. 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?(:'bounce_subtype')
+        self.bounce_subtype = attributes[:'bounce_subtype']
+      else
+        self.bounce_subtype = nil
+      end
+
+      if attributes.key?(:'bounce_type')
+        self.bounce_type = attributes[:'bounce_type']
+      else
+        self.bounce_type = nil
+      end
+
+      if attributes.key?(:'complaint_subtype')
+        self.complaint_subtype = attributes[:'complaint_subtype']
+      else
+        self.complaint_subtype = nil
+      end
+
+      if attributes.key?(:'complaint_type')
+        self.complaint_type = attributes[:'complaint_type']
+      else
+        self.complaint_type = nil
+      end
+
+      if attributes.key?(:'delay_expires_at')
+        self.delay_expires_at = attributes[:'delay_expires_at']
+      else
+        self.delay_expires_at = nil
+      end
+
+      if attributes.key?(:'delay_type')
+        self.delay_type = attributes[:'delay_type']
+      else
+        self.delay_type = nil
+      end
+
+      if attributes.key?(:'is_spam')
+        self.is_spam = attributes[:'is_spam']
+      else
+        self.is_spam = nil
+      end
+
+      if attributes.key?(:'mailbox_id')
+        self.mailbox_id = attributes[:'mailbox_id']
+      else
+        self.mailbox_id = nil
+      end
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      else
+        self.message_id = nil
+      end
+
+      if attributes.key?(:'message_id_kind')
+        self.message_id_kind = attributes[:'message_id_kind']
+      else
+        self.message_id_kind = nil
+      end
+
+      if attributes.key?(:'recipients')
+        if (value = attributes[:'recipients']).is_a?(Array)
+          self.recipients = value
+        end
+      else
+        self.recipients = nil
+      end
+
+      if attributes.key?(:'reject_reason')
+        self.reject_reason = attributes[:'reject_reason']
+      else
+        self.reject_reason = nil
+      end
+
+      if attributes.key?(:'sender')
+        self.sender = attributes[:'sender']
+      else
+        self.sender = nil
+      end
+
+      if attributes.key?(:'sendmux_message_id')
+        self.sendmux_message_id = attributes[:'sendmux_message_id']
+      else
+        self.sendmux_message_id = nil
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      else
+        self.webhook_id = 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 @recipients.nil?
+        invalid_properties.push('invalid value for "recipients", recipients 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'
+      bounce_type_validator = EnumAttributeValidator.new('String', ["Permanent", "Transient", "Undetermined", "unknown_default_open_api"])
+      return false unless bounce_type_validator.valid?(@bounce_type)
+      message_id_kind_validator = EnumAttributeValidator.new('String', ["provider", "rfc5322", "unknown_default_open_api"])
+      return false unless message_id_kind_validator.valid?(@message_id_kind)
+      return false if @recipients.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] bounce_type Object to be assigned
+    def bounce_type=(bounce_type)
+      validator = EnumAttributeValidator.new('String', ["Permanent", "Transient", "Undetermined", "unknown_default_open_api"])
+      unless validator.valid?(bounce_type)
+        fail ArgumentError, "invalid value for \"bounce_type\", must be one of #{validator.allowable_values}."
+      end
+      @bounce_type = bounce_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] message_id_kind Object to be assigned
+    def message_id_kind=(message_id_kind)
+      validator = EnumAttributeValidator.new('String', ["provider", "rfc5322", "unknown_default_open_api"])
+      unless validator.valid?(message_id_kind)
+        fail ArgumentError, "invalid value for \"message_id_kind\", must be one of #{validator.allowable_values}."
+      end
+      @message_id_kind = message_id_kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipients Value to be assigned
+    def recipients=(recipients)
+      if recipients.nil?
+        fail ArgumentError, 'recipients cannot be nil'
+      end
+
+      @recipients = recipients
+    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 &&
+          bounce_subtype == o.bounce_subtype &&
+          bounce_type == o.bounce_type &&
+          complaint_subtype == o.complaint_subtype &&
+          complaint_type == o.complaint_type &&
+          delay_expires_at == o.delay_expires_at &&
+          delay_type == o.delay_type &&
+          is_spam == o.is_spam &&
+          mailbox_id == o.mailbox_id &&
+          message_id == o.message_id &&
+          message_id_kind == o.message_id_kind &&
+          recipients == o.recipients &&
+          reject_reason == o.reject_reason &&
+          sender == o.sender &&
+          sendmux_message_id == o.sendmux_message_id &&
+          webhook_id == o.webhook_id
+    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
+      [bounce_subtype, bounce_type, complaint_subtype, complaint_type, delay_expires_at, delay_type, is_spam, mailbox_id, message_id, message_id_kind, recipients, reject_reason, sender, sendmux_message_id, webhook_id].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