sendmux-mailbox 1.4.0 → 2.0.1

data/lib/sendmux_mailbox_generated/models/mailbox_query_meta.rb

@@ -0,0 +1,173 @@
+=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::Mailbox::Generated
+  class MailboxQueryMeta < ApiModelBase
+    attr_accessor :query_state
+
+    attr_accessor :request_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'query_state' => :'query_state',
+        :'request_id' => :'request_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
+      {
+        :'query_state' => :'String',
+        :'request_id' => :'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::Mailbox::Generated::MailboxQueryMeta` 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::Mailbox::Generated::MailboxQueryMeta`. 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?(:'query_state')
+        self.query_state = attributes[:'query_state']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id 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 @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    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 &&
+          query_state == o.query_state &&
+          request_id == o.request_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
+      [query_state, request_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

data/lib/sendmux_mailbox_generated/models/mailbox_quota_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxQueryMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxQuota>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_realtime_message.rb

@@ -15,10 +15,13 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class MailboxRealtimeMessage < ApiModelBase
+    # Attachment metadata for this message. Each item includes a short-lived `download_url`; if it expires, fetch message metadata again.
     attr_accessor :attachments
 
     attr_accessor :bcc
 
+    attr_accessor :body
+
     attr_accessor :cc
 
     attr_accessor :flags
@@ -39,6 +42,8 @@ module Sendmux::Mailbox::Generated
 
     attr_accessor :received_at
 
+    attr_accessor :rfc5322_message_id
+
     attr_accessor :sent_at
 
     attr_accessor :size_bytes
@@ -49,15 +54,12 @@ module Sendmux::Mailbox::Generated
 
     attr_accessor :to
 
-    attr_accessor :body
-
-    attr_accessor :rfc5322_message_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'attachments' => :'attachments',
         :'bcc' => :'bcc',
+        :'body' => :'body',
         :'cc' => :'cc',
         :'flags' => :'flags',
         :'folder_ids' => :'folder_ids',
@@ -67,13 +69,12 @@ module Sendmux::Mailbox::Generated
         :'keywords' => :'keywords',
         :'preview' => :'preview',
         :'received_at' => :'received_at',
+        :'rfc5322_message_id' => :'rfc5322_message_id',
         :'sent_at' => :'sent_at',
         :'size_bytes' => :'size_bytes',
         :'subject' => :'subject',
         :'thread_id' => :'thread_id',
-        :'to' => :'to',
-        :'body' => :'body',
-        :'rfc5322_message_id' => :'rfc5322_message_id'
+        :'to' => :'to'
       }
     end
 
@@ -92,6 +93,7 @@ module Sendmux::Mailbox::Generated
       {
         :'attachments' => :'Array<MailboxAttachment>',
         :'bcc' => :'Array<MailboxAddress>',
+        :'body' => :'MailboxRealtimeMessageBody',
         :'cc' => :'Array<MailboxAddress>',
         :'flags' => :'MailboxMessageFlags',
         :'folder_ids' => :'Array<String>',
@@ -101,13 +103,12 @@ module Sendmux::Mailbox::Generated
         :'keywords' => :'Array<String>',
         :'preview' => :'String',
         :'received_at' => :'String',
+        :'rfc5322_message_id' => :'String',
         :'sent_at' => :'String',
         :'size_bytes' => :'Integer',
         :'subject' => :'String',
         :'thread_id' => :'String',
-        :'to' => :'Array<MailboxAddress>',
-        :'body' => :'MailboxRealtimeMessageAllOfBody',
-        :'rfc5322_message_id' => :'String'
+        :'to' => :'Array<MailboxAddress>'
       }
     end
 
@@ -117,21 +118,14 @@ module Sendmux::Mailbox::Generated
         :'from',
         :'preview',
         :'received_at',
+        :'rfc5322_message_id',
         :'sent_at',
         :'size_bytes',
         :'subject',
         :'thread_id',
-        :'rfc5322_message_id'
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'MailboxMessageSummary'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -162,6 +156,12 @@ module Sendmux::Mailbox::Generated
         self.bcc = nil
       end
 
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      else
+        self.body = nil
+      end
+
       if attributes.key?(:'cc')
         if (value = attributes[:'cc']).is_a?(Array)
           self.cc = value
@@ -222,6 +222,12 @@ module Sendmux::Mailbox::Generated
         self.received_at = nil
       end
 
+      if attributes.key?(:'rfc5322_message_id')
+        self.rfc5322_message_id = attributes[:'rfc5322_message_id']
+      else
+        self.rfc5322_message_id = nil
+      end
+
       if attributes.key?(:'sent_at')
         self.sent_at = attributes[:'sent_at']
       else
@@ -253,18 +259,6 @@ module Sendmux::Mailbox::Generated
       else
         self.to = nil
       end
-
-      if attributes.key?(:'body')
-        self.body = attributes[:'body']
-      else
-        self.body = nil
-      end
-
-      if attributes.key?(:'rfc5322_message_id')
-        self.rfc5322_message_id = attributes[:'rfc5322_message_id']
-      else
-        self.rfc5322_message_id = nil
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -276,6 +270,10 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "bcc", bcc cannot be nil.')
       end
 
+      if @body.nil?
+        invalid_properties.push('invalid value for "body", body cannot be nil.')
+      end
+
       if @cc.nil?
         invalid_properties.push('invalid value for "cc", cc cannot be nil.')
       end
@@ -304,10 +302,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
 
-      if @body.nil?
-        invalid_properties.push('invalid value for "body", body cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -316,6 +310,7 @@ module Sendmux::Mailbox::Generated
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @bcc.nil?
+      return false if @body.nil?
       return false if @cc.nil?
       return false if @flags.nil?
       return false if @folder_ids.nil?
@@ -323,7 +318,6 @@ module Sendmux::Mailbox::Generated
       return false if @id.nil?
       return false if @keywords.nil?
       return false if @to.nil?
-      return false if @body.nil?
       true
     end
 
@@ -337,6 +331,16 @@ module Sendmux::Mailbox::Generated
       @bcc = bcc
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] body Value to be assigned
+    def body=(body)
+      if body.nil?
+        fail ArgumentError, 'body cannot be nil'
+      end
+
+      @body = body
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] cc Value to be assigned
     def cc=(cc)
@@ -407,16 +411,6 @@ module Sendmux::Mailbox::Generated
       @to = to
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] body Value to be assigned
-    def body=(body)
-      if body.nil?
-        fail ArgumentError, 'body cannot be nil'
-      end
-
-      @body = body
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -424,6 +418,7 @@ module Sendmux::Mailbox::Generated
       self.class == o.class &&
           attachments == o.attachments &&
           bcc == o.bcc &&
+          body == o.body &&
           cc == o.cc &&
           flags == o.flags &&
           folder_ids == o.folder_ids &&
@@ -433,13 +428,12 @@ module Sendmux::Mailbox::Generated
           keywords == o.keywords &&
           preview == o.preview &&
           received_at == o.received_at &&
+          rfc5322_message_id == o.rfc5322_message_id &&
           sent_at == o.sent_at &&
           size_bytes == o.size_bytes &&
           subject == o.subject &&
           thread_id == o.thread_id &&
-          to == o.to &&
-          body == o.body &&
-          rfc5322_message_id == o.rfc5322_message_id
+          to == o.to
     end
 
     # @see the `==` method
@@ -451,7 +445,7 @@ module Sendmux::Mailbox::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to, body, rfc5322_message_id].hash
+      [attachments, bcc, body, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, rfc5322_message_id, sent_at, size_bytes, subject, thread_id, to].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_mailbox_generated/models/{mailbox_realtime_message_all_of_body.rb → mailbox_realtime_message_body.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Sendmux::Mailbox::Generated
-  class MailboxRealtimeMessageAllOfBody < ApiModelBase
+  class MailboxRealtimeMessageBody < ApiModelBase
     attr_accessor :html
 
     attr_accessor :is_truncated
@@ -65,14 +65,14 @@ module Sendmux::Mailbox::Generated
     # @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::Mailbox::Generated::MailboxRealtimeMessageAllOfBody` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Sendmux::Mailbox::Generated::MailboxRealtimeMessageBody` 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::Mailbox::Generated::MailboxRealtimeMessageAllOfBody`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Sendmux::Mailbox::Generated::MailboxRealtimeMessageBody`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/sendmux_mailbox_generated/models/mailbox_submission_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxQueryMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxSubmission>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_sync_meta.rb

@@ -0,0 +1,173 @@
+=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::Mailbox::Generated
+  class MailboxSyncMeta < ApiModelBase
+    attr_accessor :request_id
+
+    attr_accessor :sync_state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_id' => :'request_id',
+        :'sync_state' => :'sync_state'
+      }
+    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
+      {
+        :'request_id' => :'String',
+        :'sync_state' => :'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::Mailbox::Generated::MailboxSyncMeta` 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::Mailbox::Generated::MailboxSyncMeta`. 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?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = nil
+      end
+
+      if attributes.key?(:'sync_state')
+        self.sync_state = attributes[:'sync_state']
+      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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id 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 @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    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 &&
+          request_id == o.request_id &&
+          sync_state == o.sync_state
+    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
+      [request_id, sync_state].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