sendmux-management 1.0.0 → 1.1.0

data/lib/sendmux_management_generated/models/mailbox_availability_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 MailboxAvailabilityResponse < 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' => :'MailboxAvailabilityResult'
+      }
+    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::MailboxAvailabilityResponse` 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::MailboxAvailabilityResponse`. 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/mailbox_availability_result.rb

@@ -0,0 +1,240 @@
+=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 MailboxAvailabilityResult < ApiModelBase
+    # Whether this address can be reserved for mailbox creation.
+    attr_accessor :available
+
+    # Normalised mailbox email address checked.
+    attr_accessor :email
+
+    attr_accessor :reason
+
+    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
+      {
+        :'available' => :'available',
+        :'email' => :'email',
+        :'reason' => :'reason'
+      }
+    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
+      {
+        :'available' => :'Boolean',
+        :'email' => :'String',
+        :'reason' => :'MailboxAvailabilityReason'
+      }
+    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::MailboxAvailabilityResult` 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::MailboxAvailabilityResult`. 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?(:'available')
+        self.available = attributes[:'available']
+      else
+        self.available = nil
+      end
+
+      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
+    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 @available.nil?
+        invalid_properties.push('invalid value for "available", available cannot be nil.')
+      end
+
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @reason.nil?
+        invalid_properties.push('invalid value for "reason", reason 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 @available.nil?
+      return false if @email.nil?
+      return false if @reason.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] available Value to be assigned
+    def available=(available)
+      if available.nil?
+        fail ArgumentError, 'available cannot be nil'
+      end
+
+      @available = available
+    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 with validation
+    # @param [Object] reason Value to be assigned
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'reason cannot be nil'
+      end
+
+      @reason = reason
+    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 &&
+          available == o.available &&
+          email == o.email &&
+          reason == o.reason
+    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
+      [available, email, reason].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

@@ -29,9 +29,15 @@ module Sendmux::Management::Generated
     # Active mailboxes currently using this domain
     attr_accessor :mailbox_count
 
-    # SES DKIM status (pending/success/failed/temporary_failure/not_started)
+    # `send_only` verifies outbound DNS only. `send_receive` also verifies MX records and can host mailboxes.
+    attr_accessor :mode
+
+    # Amazon SES DKIM status (pending/success/failed/temporary_failure/not_started)
     attr_accessor :ses_dkim_status
 
+    # Amazon SES MAIL FROM status (pending/success/failed/temporary_failure/not_started)
+    attr_accessor :ses_mail_from_status
+
     # Current verification state
     attr_accessor :verification_status
 
@@ -68,7 +74,9 @@ module Sendmux::Management::Generated
         :'domain' => :'domain',
         :'id' => :'id',
         :'mailbox_count' => :'mailbox_count',
+        :'mode' => :'mode',
         :'ses_dkim_status' => :'ses_dkim_status',
+        :'ses_mail_from_status' => :'ses_mail_from_status',
         :'verification_status' => :'verification_status',
         :'verified_at' => :'verified_at'
       }
@@ -92,7 +100,9 @@ module Sendmux::Management::Generated
         :'domain' => :'String',
         :'id' => :'String',
         :'mailbox_count' => :'Integer',
+        :'mode' => :'String',
         :'ses_dkim_status' => :'String',
+        :'ses_mail_from_status' => :'String',
         :'verification_status' => :'String',
         :'verified_at' => :'String'
       }
@@ -102,6 +112,7 @@ module Sendmux::Management::Generated
     def self.openapi_nullable
       Set.new([
         :'ses_dkim_status',
+        :'ses_mail_from_status',
         :'verified_at'
       ])
     end
@@ -152,12 +163,24 @@ module Sendmux::Management::Generated
         self.mailbox_count = nil
       end
 
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = 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_mail_from_status')
+        self.ses_mail_from_status = attributes[:'ses_mail_from_status']
+      else
+        self.ses_mail_from_status = nil
+      end
+
       if attributes.key?(:'verification_status')
         self.verification_status = attributes[:'verification_status']
       else
@@ -200,6 +223,10 @@ module Sendmux::Management::Generated
         invalid_properties.push('invalid value for "mailbox_count", must be greater than or equal to 0.')
       end
 
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
       if @verification_status.nil?
         invalid_properties.push('invalid value for "verification_status", verification_status cannot be nil.')
       end
@@ -217,6 +244,9 @@ module Sendmux::Management::Generated
       return false if @id.nil?
       return false if @mailbox_count.nil?
       return false if @mailbox_count < 0
+      return false if @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["send_only", "send_receive", "unknown_default_open_api"])
+      return false unless mode_validator.valid?(@mode)
       return false if @verification_status.nil?
       verification_status_validator = EnumAttributeValidator.new('String', ["pending", "verified", "failed", "unknown_default_open_api"])
       return false unless verification_status_validator.valid?(@verification_status)
@@ -277,6 +307,16 @@ module Sendmux::Management::Generated
       @mailbox_count = mailbox_count
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["send_only", "send_receive", "unknown_default_open_api"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] verification_status Object to be assigned
     def verification_status=(verification_status)
@@ -297,7 +337,9 @@ module Sendmux::Management::Generated
           domain == o.domain &&
           id == o.id &&
           mailbox_count == o.mailbox_count &&
+          mode == o.mode &&
           ses_dkim_status == o.ses_dkim_status &&
+          ses_mail_from_status == o.ses_mail_from_status &&
           verification_status == o.verification_status &&
           verified_at == o.verified_at
     end
@@ -311,7 +353,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, ses_dkim_status, verification_status, verified_at].hash
+      [created_at, dns_records, domain, id, mailbox_count, mode, ses_dkim_status, ses_mail_from_status, verification_status, verified_at].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_management_generated/models/mailbox_domain_dns_records.rb

@@ -15,15 +15,18 @@ require 'time'
 
 module Sendmux::Management::Generated
   class MailboxDomainDnsRecords < ApiModelBase
-    # Three SES DKIM CNAME records
+    # Three Amazon SES DKIM CNAME records
     attr_accessor :dkim
 
     # DMARC enforcement record (quarantine, no reporting)
     attr_accessor :dmarc
 
+    attr_accessor :mail_from
+
     # MX records the customer must place. All point at Sendmux's inbound mail servers.
     attr_accessor :mx
 
+    # SPF TXT record covering Amazon SES sending
     attr_accessor :spf
 
     # Ownership-proof TXT record (Sendmux-specific)
@@ -34,6 +37,7 @@ module Sendmux::Management::Generated
       {
         :'dkim' => :'dkim',
         :'dmarc' => :'dmarc',
+        :'mail_from' => :'mail_from',
         :'mx' => :'mx',
         :'spf' => :'spf',
         :'verification' => :'verification'
@@ -55,6 +59,7 @@ module Sendmux::Management::Generated
       {
         :'dkim' => :'Array<MailboxDomainNameValueRecord>',
         :'dmarc' => :'MailboxDomainNameValueRecord',
+        :'mail_from' => :'MailboxDomainMailFromRecords',
         :'mx' => :'Array<MailboxDomainMxRecord>',
         :'spf' => :'MailboxDomainNameValueRecord',
         :'verification' => :'MailboxDomainNameValueRecord'
@@ -97,6 +102,12 @@ module Sendmux::Management::Generated
         self.dmarc = nil
       end
 
+      if attributes.key?(:'mail_from')
+        self.mail_from = attributes[:'mail_from']
+      else
+        self.mail_from = nil
+      end
+
       if attributes.key?(:'mx')
         if (value = attributes[:'mx']).is_a?(Array)
           self.mx = value
@@ -131,6 +142,10 @@ module Sendmux::Management::Generated
         invalid_properties.push('invalid value for "dmarc", dmarc cannot be nil.')
       end
 
+      if @mail_from.nil?
+        invalid_properties.push('invalid value for "mail_from", mail_from cannot be nil.')
+      end
+
       if @mx.nil?
         invalid_properties.push('invalid value for "mx", mx cannot be nil.')
       end
@@ -152,6 +167,7 @@ module Sendmux::Management::Generated
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @dkim.nil?
       return false if @dmarc.nil?
+      return false if @mail_from.nil?
       return false if @mx.nil?
       return false if @spf.nil?
       return false if @verification.nil?
@@ -178,6 +194,16 @@ module Sendmux::Management::Generated
       @dmarc = dmarc
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] mail_from Value to be assigned
+    def mail_from=(mail_from)
+      if mail_from.nil?
+        fail ArgumentError, 'mail_from cannot be nil'
+      end
+
+      @mail_from = mail_from
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] mx Value to be assigned
     def mx=(mx)
@@ -215,6 +241,7 @@ module Sendmux::Management::Generated
       self.class == o.class &&
           dkim == o.dkim &&
           dmarc == o.dmarc &&
+          mail_from == o.mail_from &&
           mx == o.mx &&
           spf == o.spf &&
           verification == o.verification
@@ -229,7 +256,7 @@ module Sendmux::Management::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [dkim, dmarc, mx, spf, verification].hash
+      [dkim, dmarc, mail_from, mx, spf, verification].hash
     end
 
     # Builds the object from hash