mailslurp_client 4.3.3

data/lib/mailslurp_client/models/webhook.rb

@@ -0,0 +1,242 @@
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Representation of a webhook for an inbox.
+  class Webhook
+    # Does Webhook expect basic authentication
+    attr_accessor :basic_auth
+
+    attr_accessor :created_at
+
+    # ID of the Webhook
+    attr_accessor :id
+
+    # The inbox that the Webhook will be triggered by
+    attr_accessor :inbox_id
+
+    attr_accessor :name
+
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'basic_auth' => :'basicAuth',
+        :'created_at' => :'createdAt',
+        :'id' => :'id',
+        :'inbox_id' => :'inboxId',
+        :'name' => :'name',
+        :'updated_at' => :'updatedAt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'basic_auth' => :'BOOLEAN',
+        :'created_at' => :'DateTime',
+        :'id' => :'String',
+        :'inbox_id' => :'String',
+        :'name' => :'String',
+        :'updated_at' => :'DateTime'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'basicAuth')
+        self.basic_auth = attributes[:'basicAuth']
+      end
+
+      if attributes.has_key?(:'createdAt')
+        self.created_at = attributes[:'createdAt']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'inboxId')
+        self.inbox_id = attributes[:'inboxId']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'updatedAt')
+        self.updated_at = attributes[:'updatedAt']
+      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
+      invalid_properties = Array.new
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    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 &&
+          basic_auth == o.basic_auth &&
+          created_at == o.created_at &&
+          id == o.id &&
+          inbox_id == o.inbox_id &&
+          name == o.name &&
+          updated_at == o.updated_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [basic_auth, created_at, id, inbox_id, name, updated_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = MailSlurpClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mailslurp_client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+module MailSlurpClient
+  VERSION = '4.3.3'
+end

data/mailslurp_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mailslurp_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mailslurp_client"
+  s.version     = MailSlurpClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["MailSlurp"]
+  s.email       = ["contact@mailslurp.dev"]
+  s.homepage    = "https://github.com/mailslurp/mailslurp-client-ruby"
+  s.summary     = "Official MailSlurp API Client"
+  s.description = "Send and receive real emails in Ruby. See https://www.mailslurp.com/developers/ for full Ruby documentation."
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/common_operations_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MailSlurpClient::CommonOperationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CommonOperationsApi' do
+  before do
+    # run before each test
+    @instance = MailSlurpClient::CommonOperationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CommonOperationsApi' do
+    it 'should create an instance of CommonOperationsApi' do
+      expect(@instance).to be_instance_of(MailSlurpClient::CommonOperationsApi)
+    end
+  end
+
+  # unit tests for create_new_email_address
+  # Create new email address
+  # Returns an Inbox with an `id` and an `emailAddress`
+  # @param [Hash] opts the optional parameters
+  # @return [Inbox]
+  describe 'create_new_email_address test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_email_simple
+  # Send an email from a random email address
+  # To specify an email address first create an inbox and use that with the other send email methods
+  # @param send_email_options sendEmailOptions
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_email_simple test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for wait_for_latest_email
+  # Fetch inbox's latest email or if empty wait for email to arrive
+  # Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox see the other receive methods.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :inbox_email_address Email address of the inbox we are fetching emails from
+  # @option opts [String] :inbox_id Id of the inbox we are fetching emails from
+  # @return [Email]
+  describe 'wait_for_latest_email test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/extra_operations_api_spec.rb

@@ -0,0 +1,231 @@
+=begin
+#MailSlurp API
+
+#For documentation see [developer guide](https://www.mailslurp.com/developers). [Create an account](https://app.mailslurp.com) in the MailSlurp Dashboard to [view your API Key](https://app). For all bugs, feature requests, or help please [see support](https://www.mailslurp.com/support/).
+
+OpenAPI spec version: 0.0.1-alpha
+Contact: contact@mailslurp.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MailSlurpClient::ExtraOperationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ExtraOperationsApi' do
+  before do
+    # run before each test
+    @instance = MailSlurpClient::ExtraOperationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExtraOperationsApi' do
+    it 'should create an instance of ExtraOperationsApi' do
+      expect(@instance).to be_instance_of(MailSlurpClient::ExtraOperationsApi)
+    end
+  end
+
+  # unit tests for bulk_create_inboxes
+  # Bulk create Inboxes (email addresses)
+  # Enterprise Plan Required
+  # @param count Number of inboxes to be created in bulk
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Inbox>]
+  describe 'bulk_create_inboxes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for bulk_delete_inboxes
+  # Bulk Delete Inboxes
+  # Enterprise Plan Required
+  # @param request_body ids
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'bulk_delete_inboxes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for bulk_send_emails
+  # Bulk Send Emails
+  # Enterprise Plan Required
+  # @param bulk_send_email_options bulkSendEmailOptions
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'bulk_send_emails test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_inbox
+  # Create an Inbox (email address)
+  # Create a new inbox and ephemeral email address to send and receive from. This is a necessary step before sending or receiving emails. The response contains the inbox&#39;s ID and its associated email address. It is recommended that you create a new inbox during each test method so that it is unique and empty
+  # @param [Hash] opts the optional parameters
+  # @return [Inbox]
+  describe 'create_inbox test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_webhook
+  # Attach a WebHook URL to an inbox
+  # Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
+  # @param inbox_id inboxId
+  # @param create_webhook_options options
+  # @param [Hash] opts the optional parameters
+  # @return [Webhook]
+  describe 'create_webhook test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_email
+  # Delete Email
+  # Deletes an email and removes it from the inbox
+  # @param email_id emailId
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_email test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_inbox
+  # Delete Inbox / Email Address
+  # Permanently delete an inbox and associated email address
+  # @param inbox_id inboxId
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_inbox test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_webhook
+  # Delete and disable a WebHook for an Inbox
+  # @param inbox_id inboxId
+  # @param webhook_id webhookId
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_webhook test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for download_attachment
+  # Get email attachment
+  # Returns the specified attachment for a given email as a byte stream (file download). Get the attachmentId from the email response. Requires enterprise account.
+  # @param attachment_id attachmentId
+  # @param email_id emailId
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'download_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_email
+  # Get Email Content
+  # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawMessage endpoint
+  # @param email_id emailId
+  # @param [Hash] opts the optional parameters
+  # @return [Email]
+  describe 'get_email test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_emails
+  # List Emails in an Inbox / EmailAddress
+  # List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached
+  # @param inbox_id Id of inbox that emails belongs to
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Limit the result set, ordered by descending received date time
+  # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
+  # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
+  # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
+  # @return [Array<EmailPreview>]
+  describe 'get_emails test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_inbox
+  # Get Inbox / EmailAddress
+  # Returns an inbox&#39;s properties, including its email address and ID.
+  # @param inbox_id inboxId
+  # @param [Hash] opts the optional parameters
+  # @return [Inbox]
+  describe 'get_inbox test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_inboxes
+  # List Inboxes / Email Addresses
+  # List the inboxes you have created
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Inbox>]
+  describe 'get_inboxes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_raw_email_contents
+  # Get Raw Email Content
+  # Returns a raw, unparsed and unprocessed email
+  # @param email_id emailId
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_raw_email_contents test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_webhooks
+  # Get all WebHooks for an Inbox
+  # @param inbox_id inboxId
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Webhook>]
+  describe 'get_webhooks test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_email
+  # Send Email
+  # Send an email from the inbox&#39;s email address. Specify the email recipients and contents in the request body. See the &#x60;SendEmailOptions&#x60; for more information. Note the &#x60;inboxId&#x60; refers to the inbox&#39;s id NOT its email address
+  # @param inbox_id inboxId
+  # @param send_email_options sendEmailOptions
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_email test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end