mailslurp_client 15.17.39 → 15.17.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f5d60da3ff10007bc4a48cc7a9261afa4ccdb407ffb41b22746239069b3e372
-  data.tar.gz: 11af728ec4658a8376e8063b2ce028676dcc007b6c170a348434ecf1a755c45c
+  metadata.gz: 1877e1d62462c84900b2f639ad0fdbfd7ec15e07595bbac9e4a15f7a9767d0b2
+  data.tar.gz: df302298ff1be36183a7dee03b5349758460b332c98e66b9cc35f386249bebc5
 SHA512:
-  metadata.gz: 40def13a34fe9f4a21ceedea0161642a51d59a9e6b8ed98da0179f4c60f83e6a3434acae77f1cdf7a08ae1d22a514d8297296be031b18f91c064d5af0794c744
-  data.tar.gz: f4875321cef30d37701231dec91af1946e0eb01462131b18937da80804364acc2ed90196c0b8c06a784d819959a8e663f74c136f3fd984eabefa687d8d407cd3
+  metadata.gz: a160571de0f62f45e66209e4532644bba01cf4935b9a2a36b78d7f5e98f157788bd9f86d51ba3fe741a8bda042ebc927eebd3b120de90796b871f04fde7d3f75
+  data.tar.gz: e1183548bff3750e0e28c8d610c427ca4f4269a452f9bffd1655964b99c9a389ed33dd53ad51a3eb63e495c55a05700e02db2a896696d35316f500552a507ff2

data/README.md

@@ -4,6 +4,8 @@
 
 MailSlurp is an email API service that lets you create real email addresses in code. You can then send and receive emails and attachments in Ruby applications and tests.
 
+[![ruby smtp tutorial](https://www.mailslurp.com/video-thumbnails/ruby-tutorial.jpg)](https://youtu.be/NEIIrU1E3H8)
+
 ## Quick links
 
 - [API documentation](https://docs.mailslurp.com/api/)
@@ -48,9 +50,7 @@ gem install mailslurp_client
 
 Or in your `Gemfile`:
 
-```ruby
-gem 'mailslurp_client', '~> 8.3', '>= 8.3.0'
-```
+{{<gen_ruby_ruby_minitest_gemspec>}}
 
 And then run bundler install:
 
@@ -63,17 +63,19 @@ bundle install
 
 You may need to install `typhoeus` if you encounter libcurl errors.
 
+```
+gem 'typhoeus'
+```
+
 
 ### Configure the client
 
-```ruby
-require 'mailslurp_client'
+{{<gen_ruby_ruby_minitest_configure>}}
 
-# configure mailslurp client globally with API key (or pass each controller a client instance)
-MailSlurpClient.configure do |config|
-    config.api_key['x-api-key'] = "YOUR_API_KEY_HERE"
-end
-```
+### Create controllers
+To call the API create a controller like this:
+
+{{<gen_ruby_ruby_minitest_create_controller>}}
 
 ## Common uses
 
@@ -85,10 +87,7 @@ Here are some common uses:
 
 To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address. See methods on the [inbox controller](https://ruby.mailslurp.com/MailSlurpClient/InboxControllerApi.html) for more information.
 
-```ruby
-inbox_controller = MailSlurpClient::InboxControllerApi.new
-inbox = inbox_controller.create_inbox
-```
+{{<gen_ruby_ruby_minitest_create_inbox>}}
 
 In a test:
 
@@ -199,6 +198,9 @@ end
 ### Send emails
 
 You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
+
+{{<gen_ruby_ruby_minitest_send_email>}}
+
 To send attachments see the [Method Documentation](https://ruby.mailslurp.com/).
 
 ```ruby
@@ -238,23 +240,22 @@ opts = {
 inbox_controller.send_email(inbox_1.id, opts)
 ```
 
+### Send with SMTP
+
+{{<gen_ruby_ruby_minitest_smtp_send>}}
+
 ### Receive emails
 
 To read already existing emails use the [Email Controller](https://ruby.mailslurp.com/MailSlurpClient/EmailControllerApi.html). To wait for expected emails to arrive use the [WaitFor Controller](https://ruby.mailslurp.com/MailSlurpClient/WaitForControllerApi.html).
 You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
 If a timeout is exceeded it will throw an error instead:
 
-```ruby
-waitfor_controller = MailSlurpClient::WaitForControllerApi.new
-email = waitfor_controller.wait_for_latest_email({ inbox_id: inbox.id, unread_only: true, timeout: 30_000 })
-
-# verify email contents
-expect(email.subject).to include("Test")
-expect(email.body).to include("Your email body")
-```
+{{<gen_ruby_ruby_minitest_receive_email>}}
 
 ### Extract email content
 
+{{<gen_ruby_ruby_minitest_extract_code>}}
+
 To parse an email and extract content use regex patterns like so:
 
 ```ruby

data/lib/mailslurp_client/models/alias_projection.rb

@@ -15,17 +15,17 @@ require 'date'
 module MailSlurpClient
   # Representation of a alias
   class AliasProjection
-    attr_accessor :inbox_id
+    attr_accessor :created_at
 
-    attr_accessor :user_id
+    attr_accessor :updated_at
 
     attr_accessor :email_address
 
-    attr_accessor :use_threads
+    attr_accessor :user_id
 
-    attr_accessor :created_at
+    attr_accessor :inbox_id
 
-    attr_accessor :updated_at
+    attr_accessor :use_threads
 
     attr_accessor :name
 
@@ -34,12 +34,12 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'inbox_id' => :'inboxId',
-        :'user_id' => :'userId',
-        :'email_address' => :'emailAddress',
-        :'use_threads' => :'useThreads',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
+        :'email_address' => :'emailAddress',
+        :'user_id' => :'userId',
+        :'inbox_id' => :'inboxId',
+        :'use_threads' => :'useThreads',
         :'name' => :'name',
         :'id' => :'id'
       }
@@ -48,12 +48,12 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'inbox_id' => :'String',
-        :'user_id' => :'String',
-        :'email_address' => :'String',
-        :'use_threads' => :'Boolean',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
+        :'email_address' => :'String',
+        :'user_id' => :'String',
+        :'inbox_id' => :'String',
+        :'use_threads' => :'Boolean',
         :'name' => :'String',
         :'id' => :'String'
       }
@@ -80,28 +80,28 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
       end
 
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'use_threads')
-        self.use_threads = attributes[:'use_threads']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
       end
 
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
+      if attributes.key?(:'use_threads')
+        self.use_threads = attributes[:'use_threads']
       end
 
       if attributes.key?(:'name')
@@ -117,24 +117,24 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
       if @email_address.nil?
         invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
 
-      if @created_at.nil?
-        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
 
-      if @updated_at.nil?
-        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
       end
 
       if @id.nil?
@@ -147,11 +147,11 @@ module MailSlurpClient
     # 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 @inbox_id.nil?
-      return false if @user_id.nil?
-      return false if @email_address.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
+      return false if @email_address.nil?
+      return false if @user_id.nil?
+      return false if @inbox_id.nil?
       return false if @id.nil?
       true
     end
@@ -161,12 +161,12 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          inbox_id == o.inbox_id &&
-          user_id == o.user_id &&
-          email_address == o.email_address &&
-          use_threads == o.use_threads &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
+          email_address == o.email_address &&
+          user_id == o.user_id &&
+          inbox_id == o.inbox_id &&
+          use_threads == o.use_threads &&
           name == o.name &&
           id == o.id
     end
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [inbox_id, user_id, email_address, use_threads, created_at, updated_at, name, id].hash
+      [created_at, updated_at, email_address, user_id, inbox_id, use_threads, name, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/attachment_projection.rb

@@ -15,6 +15,10 @@ require 'date'
 module MailSlurpClient
   # Email attachment data
   class AttachmentProjection
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
     attr_accessor :user_id
 
     # Content ID of attachment.
@@ -23,10 +27,6 @@ module MailSlurpClient
     # Attachment ID
     attr_accessor :attachment_id
 
-    attr_accessor :created_at
-
-    attr_accessor :updated_at
-
     attr_accessor :name
 
     # Content length of attachment in bytes
@@ -38,11 +38,11 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
         :'user_id' => :'userId',
         :'content_id' => :'contentId',
         :'attachment_id' => :'attachmentId',
-        :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt',
         :'name' => :'name',
         :'content_length' => :'contentLength',
         :'content_type' => :'contentType'
@@ -52,11 +52,11 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime',
         :'user_id' => :'String',
         :'content_id' => :'String',
         :'attachment_id' => :'String',
-        :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime',
         :'name' => :'String',
         :'content_length' => :'Integer',
         :'content_type' => :'String'
@@ -88,6 +88,14 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -100,14 +108,6 @@ module MailSlurpClient
         self.attachment_id = attributes[:'attachment_id']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      end
-
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -125,14 +125,6 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
-      end
-
-      if @attachment_id.nil?
-        invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -141,16 +133,24 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
 
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @attachment_id.nil?
+        invalid_properties.push('invalid value for "attachment_id", attachment_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?
-      return false if @user_id.nil?
-      return false if @attachment_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
+      return false if @user_id.nil?
+      return false if @attachment_id.nil?
       true
     end
 
@@ -159,11 +159,11 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
           user_id == o.user_id &&
           content_id == o.content_id &&
           attachment_id == o.attachment_id &&
-          created_at == o.created_at &&
-          updated_at == o.updated_at &&
           name == o.name &&
           content_length == o.content_length &&
           content_type == o.content_type
@@ -178,7 +178,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [user_id, content_id, attachment_id, created_at, updated_at, name, content_length, content_type].hash
+      [created_at, updated_at, user_id, content_id, attachment_id, name, content_length, content_type].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_projection.rb

@@ -15,7 +15,7 @@ require 'date'
 module MailSlurpClient
   # Bounced email event
   class BounceProjection
-    attr_accessor :subject
+    attr_accessor :created_at
 
     attr_accessor :sender
 
@@ -23,18 +23,18 @@ module MailSlurpClient
 
     attr_accessor :bounce_mta
 
-    attr_accessor :created_at
+    attr_accessor :subject
 
     attr_accessor :id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subject' => :'subject',
+        :'created_at' => :'createdAt',
         :'sender' => :'sender',
         :'bounce_type' => :'bounceType',
         :'bounce_mta' => :'bounceMta',
-        :'created_at' => :'createdAt',
+        :'subject' => :'subject',
         :'id' => :'id'
       }
     end
@@ -42,11 +42,11 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subject' => :'String',
+        :'created_at' => :'DateTime',
         :'sender' => :'String',
         :'bounce_type' => :'String',
         :'bounce_mta' => :'String',
-        :'created_at' => :'DateTime',
+        :'subject' => :'String',
         :'id' => :'String'
       }
     end
@@ -54,9 +54,9 @@ module MailSlurpClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'subject',
         :'bounce_type',
         :'bounce_mta',
+        :'subject',
       ])
     end
 
@@ -75,8 +75,8 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
       if attributes.key?(:'sender')
@@ -91,8 +91,8 @@ module MailSlurpClient
         self.bounce_mta = attributes[:'bounce_mta']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
       end
 
       if attributes.key?(:'id')
@@ -104,22 +104,22 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @sender.nil?
-        invalid_properties.push('invalid value for "sender", sender cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @sender.nil?
+        invalid_properties.push('invalid value for "sender", sender 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 @sender.nil?
       return false if @created_at.nil?
+      return false if @sender.nil?
       true
     end
 
@@ -128,11 +128,11 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subject == o.subject &&
+          created_at == o.created_at &&
           sender == o.sender &&
           bounce_type == o.bounce_type &&
           bounce_mta == o.bounce_mta &&
-          created_at == o.created_at &&
+          subject == o.subject &&
           id == o.id
     end
 
@@ -145,7 +145,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subject, sender, bounce_type, bounce_mta, created_at, id].hash
+      [created_at, sender, bounce_type, bounce_mta, subject, id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_recipient_projection.rb

@@ -15,15 +15,15 @@ require 'date'
 module MailSlurpClient
   # Bounced recipient
   class BounceRecipientProjection
+    attr_accessor :created_at
+
     attr_accessor :sent_email_id
 
     attr_accessor :recipient
 
-    attr_accessor :bounce_type
-
     attr_accessor :action
 
-    attr_accessor :created_at
+    attr_accessor :bounce_type
 
     attr_accessor :id
 
@@ -32,11 +32,11 @@ module MailSlurpClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'created_at' => :'createdAt',
         :'sent_email_id' => :'sentEmailId',
         :'recipient' => :'recipient',
-        :'bounce_type' => :'bounceType',
         :'action' => :'action',
-        :'created_at' => :'createdAt',
+        :'bounce_type' => :'bounceType',
         :'id' => :'id',
         :'status' => :'status'
       }
@@ -45,11 +45,11 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'created_at' => :'DateTime',
         :'sent_email_id' => :'String',
         :'recipient' => :'String',
-        :'bounce_type' => :'String',
         :'action' => :'String',
-        :'created_at' => :'DateTime',
+        :'bounce_type' => :'String',
         :'id' => :'String',
         :'status' => :'String'
       }
@@ -59,8 +59,8 @@ module MailSlurpClient
     def self.openapi_nullable
       Set.new([
         :'sent_email_id',
-        :'bounce_type',
         :'action',
+        :'bounce_type',
         :'status'
       ])
     end
@@ -80,6 +80,10 @@ module MailSlurpClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'sent_email_id')
         self.sent_email_id = attributes[:'sent_email_id']
       end
@@ -88,16 +92,12 @@ module MailSlurpClient
         self.recipient = attributes[:'recipient']
       end
 
-      if attributes.key?(:'bounce_type')
-        self.bounce_type = attributes[:'bounce_type']
-      end
-
       if attributes.key?(:'action')
         self.action = attributes[:'action']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'bounce_type')
+        self.bounce_type = attributes[:'bounce_type']
       end
 
       if attributes.key?(:'id')
@@ -113,22 +113,22 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @recipient.nil?
-        invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @recipient.nil?
+        invalid_properties.push('invalid value for "recipient", recipient 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 @recipient.nil?
       return false if @created_at.nil?
+      return false if @recipient.nil?
       true
     end
 
@@ -137,11 +137,11 @@ module MailSlurpClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          created_at == o.created_at &&
           sent_email_id == o.sent_email_id &&
           recipient == o.recipient &&
-          bounce_type == o.bounce_type &&
           action == o.action &&
-          created_at == o.created_at &&
+          bounce_type == o.bounce_type &&
           id == o.id &&
           status == o.status
     end
@@ -155,7 +155,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sent_email_id, recipient, bounce_type, action, created_at, id, status].hash
+      [created_at, sent_email_id, recipient, action, bounce_type, id, status].hash
     end
 
     # Builds the object from hash