sendmux-mailbox 1.0.0

data/lib/sendmux_mailbox_generated/models/success_envelope.rb

@@ -0,0 +1,192 @@
+=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 SuccessEnvelope < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok'
+      }
+    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' => :'Hash<String, Object>',
+        :'ok' => :'Boolean'
+      }
+    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::SuccessEnvelope` 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::SuccessEnvelope`. 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')
+        if (value = attributes[:'meta']).is_a?(Hash)
+          self.meta = value
+        end
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = 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
+
+      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?
+      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
+
+    # 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
+    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].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/update_mailbox_identity_body.rb

@@ -0,0 +1,216 @@
+=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 UpdateMailboxIdentityBody < ApiModelBase
+    # HTML signature appended to Mailbox API sends that include html_body.
+    attr_accessor :html_signature
+
+    # Default sender name. Send null or an empty string to clear it.
+    attr_accessor :name
+
+    # Plain text signature appended to Mailbox API sends that include text_body.
+    attr_accessor :text_signature
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'html_signature' => :'html_signature',
+        :'name' => :'name',
+        :'text_signature' => :'text_signature'
+      }
+    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
+      {
+        :'html_signature' => :'String',
+        :'name' => :'String',
+        :'text_signature' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'html_signature',
+        :'name',
+        :'text_signature'
+      ])
+    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::UpdateMailboxIdentityBody` 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::UpdateMailboxIdentityBody`. 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?(:'html_signature')
+        self.html_signature = attributes[:'html_signature']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'text_signature')
+        self.text_signature = attributes[:'text_signature']
+      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 !@html_signature.nil? && @html_signature.to_s.length > 2047
+        invalid_properties.push('invalid value for "html_signature", the character length must be smaller than or equal to 2047.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 254
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 254.')
+      end
+
+      if !@text_signature.nil? && @text_signature.to_s.length > 2047
+        invalid_properties.push('invalid value for "text_signature", the character length must be smaller than or equal to 2047.')
+      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 !@html_signature.nil? && @html_signature.to_s.length > 2047
+      return false if !@name.nil? && @name.to_s.length > 254
+      return false if !@text_signature.nil? && @text_signature.to_s.length > 2047
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] html_signature Value to be assigned
+    def html_signature=(html_signature)
+      if !html_signature.nil? && html_signature.to_s.length > 2047
+        fail ArgumentError, 'invalid value for "html_signature", the character length must be smaller than or equal to 2047.'
+      end
+
+      @html_signature = html_signature
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 254
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 254.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text_signature Value to be assigned
+    def text_signature=(text_signature)
+      if !text_signature.nil? && text_signature.to_s.length > 2047
+        fail ArgumentError, 'invalid value for "text_signature", the character length must be smaller than or equal to 2047.'
+      end
+
+      @text_signature = text_signature
+    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 &&
+          html_signature == o.html_signature &&
+          name == o.name &&
+          text_signature == o.text_signature
+    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
+      [html_signature, name, text_signature].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/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module Sendmux::Mailbox::Generated
+  VERSION = '1.0.0'
+end

data/lib/sendmux_mailbox_generated.rb

@@ -0,0 +1,166 @@
+=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
+
+# Common files
+require 'sendmux_mailbox_generated/api_client'
+require 'sendmux_mailbox_generated/api_error'
+require 'sendmux_mailbox_generated/api_model_base'
+require 'sendmux_mailbox_generated/version'
+require 'sendmux_mailbox_generated/configuration'
+
+# Models
+require 'sendmux_mailbox_generated/models/api_error_detail'
+require 'sendmux_mailbox_generated/models/api_error_error'
+require 'sendmux_mailbox_generated/models/api_error_meta'
+require 'sendmux_mailbox_generated/models/api_error_response'
+require 'sendmux_mailbox_generated/models/batch_delete_mailbox_messages_body'
+require 'sendmux_mailbox_generated/models/batch_update_mailbox_messages_body'
+require 'sendmux_mailbox_generated/models/create_mailbox_folder_body'
+require 'sendmux_mailbox_generated/models/cursor_pagination'
+require 'sendmux_mailbox_generated/models/mailbox'
+require 'sendmux_mailbox_generated/models/mailbox_address'
+require 'sendmux_mailbox_generated/models/mailbox_attachment'
+require 'sendmux_mailbox_generated/models/mailbox_attachment_upload_result'
+require 'sendmux_mailbox_generated/models/mailbox_attachment_upload_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_batch_delete_messages_result'
+require 'sendmux_mailbox_generated/models/mailbox_batch_delete_messages_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_batch_get_body'
+require 'sendmux_mailbox_generated/models/mailbox_batch_get_item'
+require 'sendmux_mailbox_generated/models/mailbox_batch_get_result'
+require 'sendmux_mailbox_generated/models/mailbox_batch_get_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_batch_get_result_states'
+require 'sendmux_mailbox_generated/models/mailbox_batch_message_failure'
+require 'sendmux_mailbox_generated/models/mailbox_batch_message_states'
+require 'sendmux_mailbox_generated/models/mailbox_batch_update_messages_result'
+require 'sendmux_mailbox_generated/models/mailbox_batch_update_messages_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_changes'
+require 'sendmux_mailbox_generated/models/mailbox_changes_response'
+require 'sendmux_mailbox_generated/models/mailbox_content_headers'
+require 'sendmux_mailbox_generated/models/mailbox_content_headers_full_inner'
+require 'sendmux_mailbox_generated/models/mailbox_content_headers_selected'
+require 'sendmux_mailbox_generated/models/mailbox_folder'
+require 'sendmux_mailbox_generated/models/mailbox_folder_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_folder_deleted_response'
+require 'sendmux_mailbox_generated/models/mailbox_folder_deleted_response_all_of_data'
+require 'sendmux_mailbox_generated/models/mailbox_folder_query_changes'
+require 'sendmux_mailbox_generated/models/mailbox_folder_query_changes_added_inner'
+require 'sendmux_mailbox_generated/models/mailbox_folder_query_changes_response'
+require 'sendmux_mailbox_generated/models/mailbox_folder_response'
+require 'sendmux_mailbox_generated/models/mailbox_get_changes200_response'
+require 'sendmux_mailbox_generated/models/mailbox_identity'
+require 'sendmux_mailbox_generated/models/mailbox_identity_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_identity_response'
+require 'sendmux_mailbox_generated/models/mailbox_me'
+require 'sendmux_mailbox_generated/models/mailbox_me_item_response'
+require 'sendmux_mailbox_generated/models/mailbox_message'
+require 'sendmux_mailbox_generated/models/mailbox_message_content'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_body'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_dates'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_participants'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_response_all_of_data'
+require 'sendmux_mailbox_generated/models/mailbox_message_content_states'
+require 'sendmux_mailbox_generated/models/mailbox_message_count'
+require 'sendmux_mailbox_generated/models/mailbox_message_count_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_deleted_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_detail_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_flags'
+require 'sendmux_mailbox_generated/models/mailbox_message_query_changes'
+require 'sendmux_mailbox_generated/models/mailbox_message_query_changes_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_summary'
+require 'sendmux_mailbox_generated/models/mailbox_message_summary_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_message_summary_from'
+require 'sendmux_mailbox_generated/models/mailbox_quota'
+require 'sendmux_mailbox_generated/models/mailbox_quota_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_raw_body'
+require 'sendmux_mailbox_generated/models/mailbox_raw_body_body'
+require 'sendmux_mailbox_generated/models/mailbox_raw_body_response'
+require 'sendmux_mailbox_generated/models/mailbox_raw_body_response_all_of_data'
+require 'sendmux_mailbox_generated/models/mailbox_realtime_event'
+require 'sendmux_mailbox_generated/models/mailbox_realtime_message'
+require 'sendmux_mailbox_generated/models/mailbox_realtime_message_all_of_body'
+require 'sendmux_mailbox_generated/models/mailbox_search_snippet'
+require 'sendmux_mailbox_generated/models/mailbox_search_snippets_result'
+require 'sendmux_mailbox_generated/models/mailbox_search_snippets_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_send_result_response'
+require 'sendmux_mailbox_generated/models/mailbox_send_scope'
+require 'sendmux_mailbox_generated/models/mailbox_session'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_attachments'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_folders'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_identities'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_messages'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_quotas'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_submissions'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_sync'
+require 'sendmux_mailbox_generated/models/mailbox_session_capabilities_threads'
+require 'sendmux_mailbox_generated/models/mailbox_session_endpoints'
+require 'sendmux_mailbox_generated/models/mailbox_session_gated'
+require 'sendmux_mailbox_generated/models/mailbox_session_limits'
+require 'sendmux_mailbox_generated/models/mailbox_session_mailbox'
+require 'sendmux_mailbox_generated/models/mailbox_session_response'
+require 'sendmux_mailbox_generated/models/mailbox_session_states'
+require 'sendmux_mailbox_generated/models/mailbox_submission'
+require 'sendmux_mailbox_generated/models/mailbox_submission_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_submission_delivery_status'
+require 'sendmux_mailbox_generated/models/mailbox_submission_envelope'
+require 'sendmux_mailbox_generated/models/mailbox_submission_envelope_address'
+require 'sendmux_mailbox_generated/models/mailbox_submission_envelope_rcpt_to_inner'
+require 'sendmux_mailbox_generated/models/mailbox_submission_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread'
+require 'sendmux_mailbox_generated/models/mailbox_thread_content_meta'
+require 'sendmux_mailbox_generated/models/mailbox_thread_content_meta_states'
+require 'sendmux_mailbox_generated/models/mailbox_thread_content_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread_content_response_all_of_data'
+require 'sendmux_mailbox_generated/models/mailbox_thread_detail_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread_summary'
+require 'sendmux_mailbox_generated/models/mailbox_thread_summary_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread_summary_last_message'
+require 'sendmux_mailbox_generated/models/mailbox_thread_summary_states'
+require 'sendmux_mailbox_generated/models/mailbox_typed_changes'
+require 'sendmux_mailbox_generated/models/mailbox_typed_changes_response'
+require 'sendmux_mailbox_generated/models/mailbox_typed_changes_types'
+require 'sendmux_mailbox_generated/models/mailbox_usage'
+require 'sendmux_mailbox_generated/models/mailbox_usage_resource'
+require 'sendmux_mailbox_generated/models/mailbox_usage_response'
+require 'sendmux_mailbox_generated/models/mailbox_usage_states'
+require 'sendmux_mailbox_generated/models/patch_mailbox_folder_body'
+require 'sendmux_mailbox_generated/models/patch_mailbox_message_body'
+require 'sendmux_mailbox_generated/models/response_meta'
+require 'sendmux_mailbox_generated/models/send_mailbox_message_body'
+require 'sendmux_mailbox_generated/models/send_mailbox_message_body_attachments_inner'
+require 'sendmux_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of'
+require 'sendmux_mailbox_generated/models/send_mailbox_message_body_attachments_inner_any_of1'
+require 'sendmux_mailbox_generated/models/send_mailbox_message_result'
+require 'sendmux_mailbox_generated/models/success_envelope'
+require 'sendmux_mailbox_generated/models/update_mailbox_identity_body'
+
+# APIs
+require 'sendmux_mailbox_generated/api/mailbox_api_api'
+
+module Sendmux::Mailbox::Generated
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Sendmux::Mailbox::Generated.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end