sendmux-management 1.1.0 → 1.2.0

data/lib/sendmux_management_generated/models/delivery_log_item.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module Sendmux::Management::Generated
   class DeliveryLogItem < ApiModelBase
+    # Recipient occurrences accepted by the provider, or null when no recipient snapshot exists
+    attr_accessor :accepted_recipient_count
+
     attr_accessor :attempts
 
     # ISO 8601 creation timestamp
@@ -34,6 +37,12 @@ module Sendmux::Management::Generated
     # Provider display name
     attr_accessor :provider_name
 
+    # Total recipient occurrences, or null when no recipient snapshot exists
+    attr_accessor :recipient_count
+
+    # Recipient occurrences rejected by the provider, or null when no recipient snapshot exists
+    attr_accessor :rejected_recipient_count
+
     # ISO 8601 timestamp when email was sent
     attr_accessor :sent_at
 
@@ -75,6 +84,7 @@ module Sendmux::Management::Generated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'accepted_recipient_count' => :'accepted_recipient_count',
         :'attempts' => :'attempts',
         :'created_at' => :'created_at',
         :'from_email' => :'from_email',
@@ -82,6 +92,8 @@ module Sendmux::Management::Generated
         :'message_id' => :'message_id',
         :'provider_id' => :'provider_id',
         :'provider_name' => :'provider_name',
+        :'recipient_count' => :'recipient_count',
+        :'rejected_recipient_count' => :'rejected_recipient_count',
         :'sent_at' => :'sent_at',
         :'sent_from_email' => :'sent_from_email',
         :'size_bytes' => :'size_bytes',
@@ -105,6 +117,7 @@ module Sendmux::Management::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'accepted_recipient_count' => :'Integer',
         :'attempts' => :'Float',
         :'created_at' => :'String',
         :'from_email' => :'String',
@@ -112,6 +125,8 @@ module Sendmux::Management::Generated
         :'message_id' => :'String',
         :'provider_id' => :'String',
         :'provider_name' => :'String',
+        :'recipient_count' => :'Integer',
+        :'rejected_recipient_count' => :'Integer',
         :'sent_at' => :'String',
         :'sent_from_email' => :'String',
         :'size_bytes' => :'Float',
@@ -125,10 +140,13 @@ module Sendmux::Management::Generated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'accepted_recipient_count',
         :'from_email',
         :'message_id',
         :'provider_id',
         :'provider_name',
+        :'recipient_count',
+        :'rejected_recipient_count',
         :'sent_at',
         :'sent_from_email',
         :'size_bytes',
@@ -154,6 +172,12 @@ module Sendmux::Management::Generated
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'accepted_recipient_count')
+        self.accepted_recipient_count = attributes[:'accepted_recipient_count']
+      else
+        self.accepted_recipient_count = nil
+      end
+
       if attributes.key?(:'attempts')
         self.attempts = attributes[:'attempts']
       else
@@ -196,6 +220,18 @@ module Sendmux::Management::Generated
         self.provider_name = nil
       end
 
+      if attributes.key?(:'recipient_count')
+        self.recipient_count = attributes[:'recipient_count']
+      else
+        self.recipient_count = nil
+      end
+
+      if attributes.key?(:'rejected_recipient_count')
+        self.rejected_recipient_count = attributes[:'rejected_recipient_count']
+      else
+        self.rejected_recipient_count = nil
+      end
+
       if attributes.key?(:'sent_at')
         self.sent_at = attributes[:'sent_at']
       else
@@ -244,6 +280,14 @@ module Sendmux::Management::Generated
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @accepted_recipient_count > 50
+        invalid_properties.push('invalid value for "accepted_recipient_count", must be smaller than or equal to 50.')
+      end
+
+      if @accepted_recipient_count < 0
+        invalid_properties.push('invalid value for "accepted_recipient_count", must be greater than or equal to 0.')
+      end
+
       if @attempts.nil?
         invalid_properties.push('invalid value for "attempts", attempts cannot be nil.')
       end
@@ -256,6 +300,22 @@ module Sendmux::Management::Generated
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @recipient_count > 50
+        invalid_properties.push('invalid value for "recipient_count", must be smaller than or equal to 50.')
+      end
+
+      if @recipient_count < 0
+        invalid_properties.push('invalid value for "recipient_count", must be greater than or equal to 0.')
+      end
+
+      if @rejected_recipient_count > 50
+        invalid_properties.push('invalid value for "rejected_recipient_count", must be smaller than or equal to 50.')
+      end
+
+      if @rejected_recipient_count < 0
+        invalid_properties.push('invalid value for "rejected_recipient_count", must be greater than or equal to 0.')
+      end
+
       if @status.nil?
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
@@ -267,15 +327,35 @@ module Sendmux::Management::Generated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @accepted_recipient_count > 50
+      return false if @accepted_recipient_count < 0
       return false if @attempts.nil?
       return false if @created_at.nil?
       return false if @id.nil?
+      return false if @recipient_count > 50
+      return false if @recipient_count < 0
+      return false if @rejected_recipient_count > 50
+      return false if @rejected_recipient_count < 0
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["pending", "sent", "failed", "rejected", "unknown_default_open_api"])
       return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] accepted_recipient_count Value to be assigned
+    def accepted_recipient_count=(accepted_recipient_count)
+      if !accepted_recipient_count.nil? && accepted_recipient_count > 50
+        fail ArgumentError, 'invalid value for "accepted_recipient_count", must be smaller than or equal to 50.'
+      end
+
+      if !accepted_recipient_count.nil? && accepted_recipient_count < 0
+        fail ArgumentError, 'invalid value for "accepted_recipient_count", must be greater than or equal to 0.'
+      end
+
+      @accepted_recipient_count = accepted_recipient_count
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] attempts Value to be assigned
     def attempts=(attempts)
@@ -306,6 +386,34 @@ module Sendmux::Management::Generated
       @id = id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_count Value to be assigned
+    def recipient_count=(recipient_count)
+      if !recipient_count.nil? && recipient_count > 50
+        fail ArgumentError, 'invalid value for "recipient_count", must be smaller than or equal to 50.'
+      end
+
+      if !recipient_count.nil? && recipient_count < 0
+        fail ArgumentError, 'invalid value for "recipient_count", must be greater than or equal to 0.'
+      end
+
+      @recipient_count = recipient_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rejected_recipient_count Value to be assigned
+    def rejected_recipient_count=(rejected_recipient_count)
+      if !rejected_recipient_count.nil? && rejected_recipient_count > 50
+        fail ArgumentError, 'invalid value for "rejected_recipient_count", must be smaller than or equal to 50.'
+      end
+
+      if !rejected_recipient_count.nil? && rejected_recipient_count < 0
+        fail ArgumentError, 'invalid value for "rejected_recipient_count", must be greater than or equal to 0.'
+      end
+
+      @rejected_recipient_count = rejected_recipient_count
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -321,6 +429,7 @@ module Sendmux::Management::Generated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          accepted_recipient_count == o.accepted_recipient_count &&
           attempts == o.attempts &&
           created_at == o.created_at &&
           from_email == o.from_email &&
@@ -328,6 +437,8 @@ module Sendmux::Management::Generated
           message_id == o.message_id &&
           provider_id == o.provider_id &&
           provider_name == o.provider_name &&
+          recipient_count == o.recipient_count &&
+          rejected_recipient_count == o.rejected_recipient_count &&
           sent_at == o.sent_at &&
           sent_from_email == o.sent_from_email &&
           size_bytes == o.size_bytes &&
@@ -346,7 +457,7 @@ module Sendmux::Management::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attempts, created_at, from_email, id, message_id, provider_id, provider_name, sent_at, sent_from_email, size_bytes, status, status_reason, subject, to_email].hash
+      [accepted_recipient_count, attempts, created_at, from_email, id, message_id, provider_id, provider_name, recipient_count, rejected_recipient_count, sent_at, sent_from_email, size_bytes, status, status_reason, subject, to_email].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_management_generated/models/delivery_log_item_response.rb

@@ -45,7 +45,7 @@ module Sendmux::Management::Generated
       {
         :'meta' => :'ResponseMeta',
         :'ok' => :'Boolean',
-        :'data' => :'DeliveryLogItem'
+        :'data' => :'DeliveryLogDetail'
       }
     end
 

data/lib/sendmux_management_generated/models/delivery_log_recipient.rb

@@ -0,0 +1,254 @@
+=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 DeliveryLogRecipient < ApiModelBase
+    # Recipient email address
+    attr_accessor :email
+
+    # Recipient-specific rejection reason when available
+    attr_accessor :reason
+
+    # Provider acceptance outcome
+    attr_accessor :status
+
+    # Recipient header type when known
+    attr_accessor :type
+
+    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
+      {
+        :'email' => :'email',
+        :'reason' => :'reason',
+        :'status' => :'status',
+        :'type' => :'type'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'reason' => :'String',
+        :'status' => :'String',
+        :'type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'reason',
+        :'type'
+      ])
+    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::DeliveryLogRecipient` 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::DeliveryLogRecipient`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      else
+        self.reason = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @email.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["accepted", "rejected", "unknown_default_open_api"])
+      return false unless status_validator.valid?(@status)
+      type_validator = EnumAttributeValidator.new('String', ["to", "cc", "bcc", "unknown_default_open_api"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["accepted", "rejected", "unknown_default_open_api"])
+      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 checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["to", "cc", "bcc", "unknown_default_open_api"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          email == o.email &&
+          reason == o.reason &&
+          status == o.status &&
+          type == o.type
+    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
+      [email, reason, status, type].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/mailbox_domain.rb

@@ -32,12 +32,24 @@ module Sendmux::Management::Generated
     # `send_only` verifies outbound DNS only. `send_receive` also verifies MX records and can host mailboxes.
     attr_accessor :mode
 
+    # Whether Amazon SES DKIM signing is currently enabled for this identity
+    attr_accessor :ses_dkim_signing_enabled
+
     # Amazon SES DKIM status (pending/success/failed/temporary_failure/not_started)
     attr_accessor :ses_dkim_status
 
+    # ISO 8601 timestamp of the latest complete Amazon SES identity check
+    attr_accessor :ses_identity_checked_at
+
+    # Latest Amazon SES identity verification status
+    attr_accessor :ses_identity_verification_status
+
     # Amazon SES MAIL FROM status (pending/success/failed/temporary_failure/not_started)
     attr_accessor :ses_mail_from_status
 
+    # Whether Amazon SES currently permits sending for this identity
+    attr_accessor :ses_verified_for_sending
+
     # Current verification state
     attr_accessor :verification_status
 
@@ -75,8 +87,12 @@ module Sendmux::Management::Generated
         :'id' => :'id',
         :'mailbox_count' => :'mailbox_count',
         :'mode' => :'mode',
+        :'ses_dkim_signing_enabled' => :'ses_dkim_signing_enabled',
         :'ses_dkim_status' => :'ses_dkim_status',
+        :'ses_identity_checked_at' => :'ses_identity_checked_at',
+        :'ses_identity_verification_status' => :'ses_identity_verification_status',
         :'ses_mail_from_status' => :'ses_mail_from_status',
+        :'ses_verified_for_sending' => :'ses_verified_for_sending',
         :'verification_status' => :'verification_status',
         :'verified_at' => :'verified_at'
       }
@@ -101,8 +117,12 @@ module Sendmux::Management::Generated
         :'id' => :'String',
         :'mailbox_count' => :'Integer',
         :'mode' => :'String',
+        :'ses_dkim_signing_enabled' => :'Boolean',
         :'ses_dkim_status' => :'String',
+        :'ses_identity_checked_at' => :'String',
+        :'ses_identity_verification_status' => :'String',
         :'ses_mail_from_status' => :'String',
+        :'ses_verified_for_sending' => :'Boolean',
         :'verification_status' => :'String',
         :'verified_at' => :'String'
       }
@@ -111,8 +131,12 @@ module Sendmux::Management::Generated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'ses_dkim_signing_enabled',
         :'ses_dkim_status',
+        :'ses_identity_checked_at',
+        :'ses_identity_verification_status',
         :'ses_mail_from_status',
+        :'ses_verified_for_sending',
         :'verified_at'
       ])
     end
@@ -169,18 +193,42 @@ module Sendmux::Management::Generated
         self.mode = nil
       end
 
+      if attributes.key?(:'ses_dkim_signing_enabled')
+        self.ses_dkim_signing_enabled = attributes[:'ses_dkim_signing_enabled']
+      else
+        self.ses_dkim_signing_enabled = nil
+      end
+
       if attributes.key?(:'ses_dkim_status')
         self.ses_dkim_status = attributes[:'ses_dkim_status']
       else
         self.ses_dkim_status = nil
       end
 
+      if attributes.key?(:'ses_identity_checked_at')
+        self.ses_identity_checked_at = attributes[:'ses_identity_checked_at']
+      else
+        self.ses_identity_checked_at = nil
+      end
+
+      if attributes.key?(:'ses_identity_verification_status')
+        self.ses_identity_verification_status = attributes[:'ses_identity_verification_status']
+      else
+        self.ses_identity_verification_status = nil
+      end
+
       if attributes.key?(:'ses_mail_from_status')
         self.ses_mail_from_status = attributes[:'ses_mail_from_status']
       else
         self.ses_mail_from_status = nil
       end
 
+      if attributes.key?(:'ses_verified_for_sending')
+        self.ses_verified_for_sending = attributes[:'ses_verified_for_sending']
+      else
+        self.ses_verified_for_sending = nil
+      end
+
       if attributes.key?(:'verification_status')
         self.verification_status = attributes[:'verification_status']
       else
@@ -338,8 +386,12 @@ module Sendmux::Management::Generated
           id == o.id &&
           mailbox_count == o.mailbox_count &&
           mode == o.mode &&
+          ses_dkim_signing_enabled == o.ses_dkim_signing_enabled &&
           ses_dkim_status == o.ses_dkim_status &&
+          ses_identity_checked_at == o.ses_identity_checked_at &&
+          ses_identity_verification_status == o.ses_identity_verification_status &&
           ses_mail_from_status == o.ses_mail_from_status &&
+          ses_verified_for_sending == o.ses_verified_for_sending &&
           verification_status == o.verification_status &&
           verified_at == o.verified_at
     end
@@ -353,7 +405,7 @@ module Sendmux::Management::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, dns_records, domain, id, mailbox_count, mode, ses_dkim_status, ses_mail_from_status, verification_status, verified_at].hash
+      [created_at, dns_records, domain, id, mailbox_count, mode, ses_dkim_signing_enabled, ses_dkim_status, ses_identity_checked_at, ses_identity_verification_status, ses_mail_from_status, ses_verified_for_sending, verification_status, verified_at].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_management_generated/models/mailbox_domain_verify_checks.rb

@@ -15,19 +15,19 @@ require 'time'
 
 module Sendmux::Management::Generated
   class MailboxDomainVerifyChecks < ApiModelBase
-    # DMARC TXT record matches expected value
+    # Published DMARC policy provides at least the required enforcement level.
     attr_accessor :dmarc
 
     # Custom MAIL FROM MX record matches expected value
     attr_accessor :mail_from_mx
 
-    # Custom MAIL FROM SPF TXT record matches expected value
+    # Custom MAIL FROM SPF policy is compatible with the required Amazon SES sender authorisation.
     attr_accessor :mail_from_spf
 
     # MX record present when the domain is configured for receiving. Always true for send-only domains.
     attr_accessor :mx
 
-    # SPF TXT record matches expected value
+    # Published SPF policy is compatible with the required Amazon SES sender authorisation.
     attr_accessor :spf
 
     # Ownership TXT record present with correct value