sendmux-mailbox 1.0.0 → 1.1.0

data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_result_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::Mailbox::Generated
+  class MailboxAttachmentUploadIntentResultResponse < 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' => :'MailboxAttachmentUploadIntentResult'
+      }
+    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::Mailbox::Generated::MailboxAttachmentUploadIntentResultResponse` 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::MailboxAttachmentUploadIntentResultResponse`. 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_mailbox_generated/models/mailbox_batch_get_body.rb

@@ -15,24 +15,34 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class MailboxBatchGetBody < ApiModelBase
+    # Body shape to include for each message.
     attr_accessor :body_mode
 
+    # Message IDs to fetch, maximum 100.
     attr_accessor :ids
 
+    # Attachment detail to include. Contents are not returned.
     attr_accessor :include_attachments
 
+    # Header detail to include in each message.
     attr_accessor :include_headers
 
+    # When true, include HTML content when available.
     attr_accessor :include_html
 
+    # When true, include links extracted from the body.
     attr_accessor :include_links
 
+    # Maximum body characters per message before truncation.
     attr_accessor :max_body_chars
 
+    # Body part to return when body_mode is not `none`.
     attr_accessor :part
 
+    # When true, remove quoted reply text.
     attr_accessor :strip_quotes
 
+    # When true, remove detected email signatures.
     attr_accessor :strip_signature
 
     class EnumAttributeValidator

data/lib/sendmux_mailbox_generated/models/mailbox_changes.rb

@@ -25,6 +25,9 @@ module Sendmux::Mailbox::Generated
 
     attr_accessor :old_state
 
+    # When true, refetch this resource list instead of applying the incremental arrays.
+    attr_accessor :sync_required
+
     attr_accessor :updated
 
     attr_accessor :updated_properties
@@ -37,6 +40,7 @@ module Sendmux::Mailbox::Generated
         :'has_more' => :'has_more',
         :'new_state' => :'new_state',
         :'old_state' => :'old_state',
+        :'sync_required' => :'sync_required',
         :'updated' => :'updated',
         :'updated_properties' => :'updated_properties'
       }
@@ -60,6 +64,7 @@ module Sendmux::Mailbox::Generated
         :'has_more' => :'Boolean',
         :'new_state' => :'String',
         :'old_state' => :'String',
+        :'sync_required' => :'Boolean',
         :'updated' => :'Array<String>',
         :'updated_properties' => :'Array<String>'
       }
@@ -122,6 +127,10 @@ module Sendmux::Mailbox::Generated
         self.old_state = nil
       end
 
+      if attributes.key?(:'sync_required')
+        self.sync_required = attributes[:'sync_required']
+      end
+
       if attributes.key?(:'updated')
         if (value = attributes[:'updated']).is_a?(Array)
           self.updated = value
@@ -237,6 +246,7 @@ module Sendmux::Mailbox::Generated
           has_more == o.has_more &&
           new_state == o.new_state &&
           old_state == o.old_state &&
+          sync_required == o.sync_required &&
           updated == o.updated &&
           updated_properties == o.updated_properties
     end
@@ -250,7 +260,7 @@ module Sendmux::Mailbox::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created, destroyed, has_more, new_state, old_state, updated, updated_properties].hash
+      [created, destroyed, has_more, new_state, old_state, sync_required, updated, updated_properties].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_mailbox_generated/models/mailbox_message.rb

@@ -15,6 +15,8 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class MailboxMessage < ApiModelBase
+    attr_accessor :attachments
+
     attr_accessor :bcc
 
     attr_accessor :cc
@@ -47,8 +49,6 @@ module Sendmux::Mailbox::Generated
 
     attr_accessor :to
 
-    attr_accessor :attachments
-
     attr_accessor :html_body
 
     attr_accessor :text_body
@@ -56,6 +56,7 @@ module Sendmux::Mailbox::Generated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'attachments' => :'attachments',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
         :'flags' => :'flags',
@@ -71,7 +72,6 @@ module Sendmux::Mailbox::Generated
         :'subject' => :'subject',
         :'thread_id' => :'thread_id',
         :'to' => :'to',
-        :'attachments' => :'attachments',
         :'html_body' => :'html_body',
         :'text_body' => :'text_body'
       }
@@ -90,11 +90,12 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attachments' => :'Array<MailboxAttachment>',
         :'bcc' => :'Array<MailboxAddress>',
         :'cc' => :'Array<MailboxAddress>',
         :'flags' => :'MailboxMessageFlags',
         :'folder_ids' => :'Array<String>',
-        :'from' => :'MailboxMessageSummaryFrom',
+        :'from' => :'MailboxAddress',
         :'has_attachments' => :'Boolean',
         :'id' => :'String',
         :'keywords' => :'Array<String>',
@@ -105,7 +106,6 @@ module Sendmux::Mailbox::Generated
         :'subject' => :'String',
         :'thread_id' => :'String',
         :'to' => :'Array<MailboxAddress>',
-        :'attachments' => :'Array<MailboxAttachment>',
         :'html_body' => :'String',
         :'text_body' => :'String'
       }
@@ -114,6 +114,7 @@ module Sendmux::Mailbox::Generated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'from',
         :'preview',
         :'received_at',
         :'sent_at',
@@ -148,6 +149,12 @@ module Sendmux::Mailbox::Generated
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
       if attributes.key?(:'bcc')
         if (value = attributes[:'bcc']).is_a?(Array)
           self.bcc = value
@@ -248,14 +255,6 @@ module Sendmux::Mailbox::Generated
         self.to = nil
       end
 
-      if attributes.key?(:'attachments')
-        if (value = attributes[:'attachments']).is_a?(Array)
-          self.attachments = value
-        end
-      else
-        self.attachments = nil
-      end
-
       if attributes.key?(:'html_body')
         self.html_body = attributes[:'html_body']
       else
@@ -290,10 +289,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "folder_ids", folder_ids cannot be nil.')
       end
 
-      if @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
-      end
-
       if @has_attachments.nil?
         invalid_properties.push('invalid value for "has_attachments", has_attachments cannot be nil.')
       end
@@ -310,10 +305,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "to", to cannot be nil.')
       end
 
-      if @attachments.nil?
-        invalid_properties.push('invalid value for "attachments", attachments cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -325,12 +316,10 @@ module Sendmux::Mailbox::Generated
       return false if @cc.nil?
       return false if @flags.nil?
       return false if @folder_ids.nil?
-      return false if @from.nil?
       return false if @has_attachments.nil?
       return false if @id.nil?
       return false if @keywords.nil?
       return false if @to.nil?
-      return false if @attachments.nil?
       true
     end
 
@@ -374,16 +363,6 @@ module Sendmux::Mailbox::Generated
       @folder_ids = folder_ids
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] from Value to be assigned
-    def from=(from)
-      if from.nil?
-        fail ArgumentError, 'from cannot be nil'
-      end
-
-      @from = from
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] has_attachments Value to be assigned
     def has_attachments=(has_attachments)
@@ -424,21 +403,12 @@ module Sendmux::Mailbox::Generated
       @to = to
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] attachments Value to be assigned
-    def attachments=(attachments)
-      if attachments.nil?
-        fail ArgumentError, 'attachments cannot be nil'
-      end
-
-      @attachments = attachments
-    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 &&
+          attachments == o.attachments &&
           bcc == o.bcc &&
           cc == o.cc &&
           flags == o.flags &&
@@ -454,7 +424,6 @@ module Sendmux::Mailbox::Generated
           subject == o.subject &&
           thread_id == o.thread_id &&
           to == o.to &&
-          attachments == o.attachments &&
           html_body == o.html_body &&
           text_body == o.text_body
     end
@@ -468,7 +437,7 @@ module Sendmux::Mailbox::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to, attachments, html_body, text_body].hash
+      [attachments, bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to, html_body, text_body].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_mailbox_generated/models/mailbox_message_content_participants.rb

@@ -51,7 +51,7 @@ module Sendmux::Mailbox::Generated
       {
         :'bcc' => :'Array<MailboxAddress>',
         :'cc' => :'Array<MailboxAddress>',
-        :'from' => :'MailboxMessageSummaryFrom',
+        :'from' => :'MailboxAddress',
         :'reply_to' => :'Array<MailboxAddress>',
         :'to' => :'Array<MailboxAddress>'
       }
@@ -60,6 +60,7 @@ module Sendmux::Mailbox::Generated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'from',
       ])
     end
 
@@ -131,10 +132,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "cc", cc cannot be nil.')
       end
 
-      if @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
-      end
-
       if @reply_to.nil?
         invalid_properties.push('invalid value for "reply_to", reply_to cannot be nil.')
       end
@@ -152,7 +149,6 @@ module Sendmux::Mailbox::Generated
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @bcc.nil?
       return false if @cc.nil?
-      return false if @from.nil?
       return false if @reply_to.nil?
       return false if @to.nil?
       true
@@ -178,16 +174,6 @@ module Sendmux::Mailbox::Generated
       @cc = cc
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] from Value to be assigned
-    def from=(from)
-      if from.nil?
-        fail ArgumentError, 'from cannot be nil'
-      end
-
-      @from = from
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] reply_to Value to be assigned
     def reply_to=(reply_to)

data/lib/sendmux_mailbox_generated/models/mailbox_message_summary.rb

@@ -15,6 +15,9 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class MailboxMessageSummary < 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 :cc
@@ -50,6 +53,7 @@ module Sendmux::Mailbox::Generated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'attachments' => :'attachments',
         :'bcc' => :'bcc',
         :'cc' => :'cc',
         :'flags' => :'flags',
@@ -81,11 +85,12 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'attachments' => :'Array<MailboxAttachment>',
         :'bcc' => :'Array<MailboxAddress>',
         :'cc' => :'Array<MailboxAddress>',
         :'flags' => :'MailboxMessageFlags',
         :'folder_ids' => :'Array<String>',
-        :'from' => :'MailboxMessageSummaryFrom',
+        :'from' => :'MailboxAddress',
         :'has_attachments' => :'Boolean',
         :'id' => :'String',
         :'keywords' => :'Array<String>',
@@ -102,6 +107,7 @@ module Sendmux::Mailbox::Generated
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'from',
         :'preview',
         :'received_at',
         :'sent_at',
@@ -127,6 +133,12 @@ module Sendmux::Mailbox::Generated
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
       if attributes.key?(:'bcc')
         if (value = attributes[:'bcc']).is_a?(Array)
           self.bcc = value
@@ -249,10 +261,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "folder_ids", folder_ids cannot be nil.')
       end
 
-      if @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
-      end
-
       if @has_attachments.nil?
         invalid_properties.push('invalid value for "has_attachments", has_attachments cannot be nil.')
       end
@@ -280,7 +288,6 @@ module Sendmux::Mailbox::Generated
       return false if @cc.nil?
       return false if @flags.nil?
       return false if @folder_ids.nil?
-      return false if @from.nil?
       return false if @has_attachments.nil?
       return false if @id.nil?
       return false if @keywords.nil?
@@ -328,16 +335,6 @@ module Sendmux::Mailbox::Generated
       @folder_ids = folder_ids
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] from Value to be assigned
-    def from=(from)
-      if from.nil?
-        fail ArgumentError, 'from cannot be nil'
-      end
-
-      @from = from
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] has_attachments Value to be assigned
     def has_attachments=(has_attachments)
@@ -383,6 +380,7 @@ module Sendmux::Mailbox::Generated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          attachments == o.attachments &&
           bcc == o.bcc &&
           cc == o.cc &&
           flags == o.flags &&
@@ -409,7 +407,7 @@ module Sendmux::Mailbox::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to].hash
+      [attachments, bcc, cc, flags, folder_ids, from, has_attachments, id, keywords, preview, received_at, sent_at, size_bytes, subject, thread_id, to].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_mailbox_generated/models/mailbox_realtime_event.rb

@@ -103,6 +103,7 @@ module Sendmux::Mailbox::Generated
     def self.openapi_nullable
       Set.new([
         :'is_spam',
+        :'message',
         :'message_id',
         :'message_id_kind',
         :'sender',
@@ -201,10 +202,6 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "mailbox_id", mailbox_id cannot be nil.')
       end
 
-      if @message.nil?
-        invalid_properties.push('invalid value for "message", message cannot be nil.')
-      end
-
       if @occurred_at.nil?
         invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
       end
@@ -228,7 +225,6 @@ module Sendmux::Mailbox::Generated
       event_type_validator = EnumAttributeValidator.new('String', ["message.received", "message.received.spam", "sync_required", "unknown_default_open_api"])
       return false unless event_type_validator.valid?(@event_type)
       return false if @mailbox_id.nil?
-      return false if @message.nil?
       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 @occurred_at.nil?
@@ -257,16 +253,6 @@ module Sendmux::Mailbox::Generated
       @mailbox_id = mailbox_id
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] message Value to be assigned
-    def message=(message)
-      if message.nil?
-        fail ArgumentError, 'message cannot be nil'
-      end
-
-      @message = message
-    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)