sendmux-mailbox 1.0.0 → 1.1.0

data/lib/sendmux_mailbox_generated/models/batch_delete_mailbox_messages_body.rb

@@ -15,6 +15,7 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class BatchDeleteMailboxMessagesBody < ApiModelBase
+    # Message IDs to delete, maximum 100.
     attr_accessor :ids
 
     # Optional message state token for stale-write protection.

data/lib/sendmux_mailbox_generated/models/batch_update_mailbox_messages_body.rb

@@ -15,8 +15,10 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class BatchUpdateMailboxMessagesBody < ApiModelBase
+    # Set or clear the flagged marker.
     attr_accessor :flagged
 
+    # Message IDs to update, maximum 100.
     attr_accessor :ids
 
     # Optional message state token for stale-write protection.
@@ -25,6 +27,7 @@ module Sendmux::Mailbox::Generated
     # Map of message keyword names to booleans. `true` sets the keyword; `false` clears it. Keyword names are normalised to lowercase. Lifecycle keywords such as `$draft` are read-only.
     attr_accessor :keywords
 
+    # Set or clear the seen flag.
     attr_accessor :seen
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/sendmux_mailbox_generated/models/{mailbox_message_summary_from.rb → granted_mailbox.rb}

@@ -14,16 +14,18 @@ require 'date'
 require 'time'
 
 module Sendmux::Mailbox::Generated
-  class MailboxMessageSummaryFrom < ApiModelBase
+  class GrantedMailbox < ApiModelBase
+    # Mailbox email address
     attr_accessor :email
 
-    attr_accessor :name
+    # Mailbox public ID
+    attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'email' => :'email',
-        :'name' => :'name'
+        :'id' => :'id'
       }
     end
 
@@ -41,36 +43,28 @@ module Sendmux::Mailbox::Generated
     def self.openapi_types
       {
         :'email' => :'String',
-        :'name' => :'String'
+        :'id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'name'
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'MailboxAddress'
-      ]
-    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::MailboxMessageSummaryFrom` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Sendmux::Mailbox::Generated::GrantedMailbox` 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::MailboxMessageSummaryFrom`. 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::GrantedMailbox`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -81,10 +75,10 @@ module Sendmux::Mailbox::Generated
         self.email = nil
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       else
-        self.name = nil
+        self.id = nil
       end
     end
 
@@ -97,6 +91,10 @@ module Sendmux::Mailbox::Generated
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -105,6 +103,7 @@ module Sendmux::Mailbox::Generated
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @email.nil?
+      return false if @id.nil?
       true
     end
 
@@ -118,13 +117,23 @@ module Sendmux::Mailbox::Generated
       @email = email
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = 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 &&
           email == o.email &&
-          name == o.name
+          id == o.id
     end
 
     # @see the `==` method
@@ -136,7 +145,7 @@ module Sendmux::Mailbox::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, name].hash
+      [email, id].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_mailbox_generated/models/granted_mailbox_list_response.rb

@@ -0,0 +1,251 @@
+=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 GrantedMailboxListResponse < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    attr_accessor :data
+
+    attr_accessor :pagination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok',
+        :'data' => :'data',
+        :'pagination' => :'pagination'
+      }
+    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' => :'Array<GrantedMailbox>',
+        :'pagination' => :'CursorPagination'
+      }
+    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::GrantedMailboxListResponse` 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::GrantedMailboxListResponse`. 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')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      else
+        self.pagination = 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
+
+      if @pagination.nil?
+        invalid_properties.push('invalid value for "pagination", pagination 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?
+      return false if @pagination.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
+
+    # Custom attribute writer method with validation
+    # @param [Object] pagination Value to be assigned
+    def pagination=(pagination)
+      if pagination.nil?
+        fail ArgumentError, 'pagination cannot be nil'
+      end
+
+      @pagination = pagination
+    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 &&
+          pagination == o.pagination
+    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, pagination].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_attachment.rb

@@ -15,17 +15,19 @@ require 'time'
 
 module Sendmux::Mailbox::Generated
   class MailboxAttachment < ApiModelBase
+    # Content ID for inline attachments, when present.
     attr_accessor :content_id
 
     attr_accessor :content_type
 
     attr_accessor :disposition
 
+    # Short-lived URL for this exact attachment. Fetch it promptly; if it expires, call the message or attachment metadata endpoint again to receive a fresh URL.
     attr_accessor :download_url
 
     attr_accessor :filename
 
-    # Attachment ID
+    # Attachment blob ID.
     attr_accessor :id
 
     attr_accessor :size_bytes

data/lib/sendmux_mailbox_generated/models/mailbox_attachment_upload_intent_body.rb

@@ -0,0 +1,228 @@
+=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 MailboxAttachmentUploadIntentBody < ApiModelBase
+    # Content-Type that must be sent on the later PUT request.
+    attr_accessor :content_type
+
+    # Filename to use when sending the uploaded attachment.
+    attr_accessor :filename
+
+    # Exact byte length that must be sent on the later PUT request.
+    attr_accessor :size_bytes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content_type' => :'content_type',
+        :'filename' => :'filename',
+        :'size_bytes' => :'size_bytes'
+      }
+    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
+      {
+        :'content_type' => :'String',
+        :'filename' => :'String',
+        :'size_bytes' => :'Integer'
+      }
+    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::MailboxAttachmentUploadIntentBody` 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::MailboxAttachmentUploadIntentBody`. 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?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      else
+        self.content_type = nil
+      end
+
+      if attributes.key?(:'filename')
+        self.filename = attributes[:'filename']
+      else
+        self.filename = nil
+      end
+
+      if attributes.key?(:'size_bytes')
+        self.size_bytes = attributes[:'size_bytes']
+      else
+        self.size_bytes = 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 @content_type.nil?
+        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
+      end
+
+      if @filename.nil?
+        invalid_properties.push('invalid value for "filename", filename cannot be nil.')
+      end
+
+      if @size_bytes.nil?
+        invalid_properties.push('invalid value for "size_bytes", size_bytes cannot be nil.')
+      end
+
+      if @size_bytes < 1
+        invalid_properties.push('invalid value for "size_bytes", must be greater than or equal to 1.')
+      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 @content_type.nil?
+      return false if @filename.nil?
+      return false if @size_bytes.nil?
+      return false if @size_bytes < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content_type Value to be assigned
+    def content_type=(content_type)
+      if content_type.nil?
+        fail ArgumentError, 'content_type cannot be nil'
+      end
+
+      @content_type = content_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] filename Value to be assigned
+    def filename=(filename)
+      if filename.nil?
+        fail ArgumentError, 'filename cannot be nil'
+      end
+
+      @filename = filename
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] size_bytes Value to be assigned
+    def size_bytes=(size_bytes)
+      if size_bytes.nil?
+        fail ArgumentError, 'size_bytes cannot be nil'
+      end
+
+      if size_bytes < 1
+        fail ArgumentError, 'invalid value for "size_bytes", must be greater than or equal to 1.'
+      end
+
+      @size_bytes = size_bytes
+    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 &&
+          content_type == o.content_type &&
+          filename == o.filename &&
+          size_bytes == o.size_bytes
+    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
+      [content_type, filename, size_bytes].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