sendmux-management 1.0.0 → 1.1.0

data/lib/sendmux_management_generated/models/mailbox_domain_mail_from_records.rb

@@ -0,0 +1,191 @@
+=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
+  # Custom MAIL FROM records for Amazon SES bounce handling
+  class MailboxDomainMailFromRecords < ApiModelBase
+    attr_accessor :mx
+
+    attr_accessor :spf
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'mx' => :'mx',
+        :'spf' => :'spf'
+      }
+    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
+      {
+        :'mx' => :'MailboxDomainNamedMxRecord',
+        :'spf' => :'MailboxDomainNameValueRecord'
+      }
+    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 `Sendmux::Management::Generated::MailboxDomainMailFromRecords` 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::MailboxDomainMailFromRecords`. 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?(:'mx')
+        self.mx = attributes[:'mx']
+      else
+        self.mx = nil
+      end
+
+      if attributes.key?(:'spf')
+        self.spf = attributes[:'spf']
+      else
+        self.spf = 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 @mx.nil?
+        invalid_properties.push('invalid value for "mx", mx cannot be nil.')
+      end
+
+      if @spf.nil?
+        invalid_properties.push('invalid value for "spf", spf 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 @mx.nil?
+      return false if @spf.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mx Value to be assigned
+    def mx=(mx)
+      if mx.nil?
+        fail ArgumentError, 'mx cannot be nil'
+      end
+
+      @mx = mx
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] spf Value to be assigned
+    def spf=(spf)
+      if spf.nil?
+        fail ArgumentError, 'spf cannot be nil'
+      end
+
+      @spf = spf
+    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 &&
+          mx == o.mx &&
+          spf == o.spf
+    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
+      [mx, spf].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_name_value_record.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Sendmux::Management::Generated
-  # SPF TXT record covering both SES and Sendmux includes
+  # SPF TXT record for the custom MAIL FROM subdomain
   class MailboxDomainNameValueRecord < ApiModelBase
     attr_accessor :name
 

data/lib/sendmux_management_generated/models/mailbox_domain_named_mx_record.rb

@@ -0,0 +1,217 @@
+=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
+  # MX record for Amazon SES bounce handling
+  class MailboxDomainNamedMxRecord < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :priority
+
+    attr_accessor :target
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'priority' => :'priority',
+        :'target' => :'target'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'priority' => :'Integer',
+        :'target' => :'String'
+      }
+    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 `Sendmux::Management::Generated::MailboxDomainNamedMxRecord` 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::MailboxDomainNamedMxRecord`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      else
+        self.priority = nil
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      else
+        self.target = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @priority.nil?
+        invalid_properties.push('invalid value for "priority", priority cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target 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 @name.nil?
+      return false if @priority.nil?
+      return false if @target.nil?
+      true
+    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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] priority Value to be assigned
+    def priority=(priority)
+      if priority.nil?
+        fail ArgumentError, 'priority cannot be nil'
+      end
+
+      @priority = priority
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target Value to be assigned
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'target cannot be nil'
+      end
+
+      @target = target
+    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 &&
+          name == o.name &&
+          priority == o.priority &&
+          target == o.target
+    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
+      [name, priority, target].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_verify_checks.rb

@@ -18,7 +18,13 @@ module Sendmux::Management::Generated
     # DMARC TXT record matches expected value
     attr_accessor :dmarc
 
-    # MX record present with priority 10 pointing at mail.sendmux.ai
+    # Custom MAIL FROM MX record matches expected value
+    attr_accessor :mail_from_mx
+
+    # Custom MAIL FROM SPF TXT record matches expected value
+    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
@@ -31,6 +37,8 @@ module Sendmux::Management::Generated
     def self.attribute_map
       {
         :'dmarc' => :'dmarc',
+        :'mail_from_mx' => :'mail_from_mx',
+        :'mail_from_spf' => :'mail_from_spf',
         :'mx' => :'mx',
         :'spf' => :'spf',
         :'verification_txt' => :'verification_txt'
@@ -51,6 +59,8 @@ module Sendmux::Management::Generated
     def self.openapi_types
       {
         :'dmarc' => :'Boolean',
+        :'mail_from_mx' => :'Boolean',
+        :'mail_from_spf' => :'Boolean',
         :'mx' => :'Boolean',
         :'spf' => :'Boolean',
         :'verification_txt' => :'Boolean'
@@ -85,6 +95,18 @@ module Sendmux::Management::Generated
         self.dmarc = nil
       end
 
+      if attributes.key?(:'mail_from_mx')
+        self.mail_from_mx = attributes[:'mail_from_mx']
+      else
+        self.mail_from_mx = nil
+      end
+
+      if attributes.key?(:'mail_from_spf')
+        self.mail_from_spf = attributes[:'mail_from_spf']
+      else
+        self.mail_from_spf = nil
+      end
+
       if attributes.key?(:'mx')
         self.mx = attributes[:'mx']
       else
@@ -113,6 +135,14 @@ module Sendmux::Management::Generated
         invalid_properties.push('invalid value for "dmarc", dmarc cannot be nil.')
       end
 
+      if @mail_from_mx.nil?
+        invalid_properties.push('invalid value for "mail_from_mx", mail_from_mx cannot be nil.')
+      end
+
+      if @mail_from_spf.nil?
+        invalid_properties.push('invalid value for "mail_from_spf", mail_from_spf cannot be nil.')
+      end
+
       if @mx.nil?
         invalid_properties.push('invalid value for "mx", mx cannot be nil.')
       end
@@ -133,6 +163,8 @@ module Sendmux::Management::Generated
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @dmarc.nil?
+      return false if @mail_from_mx.nil?
+      return false if @mail_from_spf.nil?
       return false if @mx.nil?
       return false if @spf.nil?
       return false if @verification_txt.nil?
@@ -149,6 +181,26 @@ module Sendmux::Management::Generated
       @dmarc = dmarc
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] mail_from_mx Value to be assigned
+    def mail_from_mx=(mail_from_mx)
+      if mail_from_mx.nil?
+        fail ArgumentError, 'mail_from_mx cannot be nil'
+      end
+
+      @mail_from_mx = mail_from_mx
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mail_from_spf Value to be assigned
+    def mail_from_spf=(mail_from_spf)
+      if mail_from_spf.nil?
+        fail ArgumentError, 'mail_from_spf cannot be nil'
+      end
+
+      @mail_from_spf = mail_from_spf
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] mx Value to be assigned
     def mx=(mx)
@@ -185,6 +237,8 @@ module Sendmux::Management::Generated
       return true if self.equal?(o)
       self.class == o.class &&
           dmarc == o.dmarc &&
+          mail_from_mx == o.mail_from_mx &&
+          mail_from_spf == o.mail_from_spf &&
           mx == o.mx &&
           spf == o.spf &&
           verification_txt == o.verification_txt
@@ -199,7 +253,7 @@ module Sendmux::Management::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [dmarc, mx, spf, verification_txt].hash
+      [dmarc, mail_from_mx, mail_from_spf, mx, spf, verification_txt].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_management_generated/models/mailbox_domain_verify_result.rb

@@ -17,9 +17,12 @@ module Sendmux::Management::Generated
   class MailboxDomainVerifyResult < ApiModelBase
     attr_accessor :checks
 
-    # Latest SES DKIM status from AWS
+    # Latest Amazon SES DKIM status
     attr_accessor :ses_dkim_status
 
+    # Latest Amazon SES MAIL FROM status
+    attr_accessor :ses_mail_from_status
+
     # Post-check verification status
     attr_accessor :status
 
@@ -50,6 +53,7 @@ module Sendmux::Management::Generated
       {
         :'checks' => :'checks',
         :'ses_dkim_status' => :'ses_dkim_status',
+        :'ses_mail_from_status' => :'ses_mail_from_status',
         :'status' => :'status'
       }
     end
@@ -69,6 +73,7 @@ module Sendmux::Management::Generated
       {
         :'checks' => :'MailboxDomainVerifyChecks',
         :'ses_dkim_status' => :'String',
+        :'ses_mail_from_status' => :'String',
         :'status' => :'String'
       }
     end
@@ -107,6 +112,12 @@ module Sendmux::Management::Generated
         self.ses_dkim_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?(:'status')
         self.status = attributes[:'status']
       else
@@ -127,6 +138,10 @@ module Sendmux::Management::Generated
         invalid_properties.push('invalid value for "ses_dkim_status", ses_dkim_status cannot be nil.')
       end
 
+      if @ses_mail_from_status.nil?
+        invalid_properties.push('invalid value for "ses_mail_from_status", ses_mail_from_status cannot be nil.')
+      end
+
       if @status.nil?
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
@@ -140,6 +155,7 @@ module Sendmux::Management::Generated
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @checks.nil?
       return false if @ses_dkim_status.nil?
+      return false if @ses_mail_from_status.nil?
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["verified", "pending", "unknown_default_open_api"])
       return false unless status_validator.valid?(@status)
@@ -166,6 +182,16 @@ module Sendmux::Management::Generated
       @ses_dkim_status = ses_dkim_status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] ses_mail_from_status Value to be assigned
+    def ses_mail_from_status=(ses_mail_from_status)
+      if ses_mail_from_status.nil?
+        fail ArgumentError, 'ses_mail_from_status cannot be nil'
+      end
+
+      @ses_mail_from_status = ses_mail_from_status
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -183,6 +209,7 @@ module Sendmux::Management::Generated
       self.class == o.class &&
           checks == o.checks &&
           ses_dkim_status == o.ses_dkim_status &&
+          ses_mail_from_status == o.ses_mail_from_status &&
           status == o.status
     end
 
@@ -195,7 +222,7 @@ module Sendmux::Management::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [checks, ses_dkim_status, status].hash
+      [checks, ses_dkim_status, ses_mail_from_status, status].hash
     end
 
     # Builds the object from hash