mailslurp_client 11.9.1 → 11.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a7170ea201d4a298ba5b6b0849e258ae06e38805e56882f7b478debd341745d
-  data.tar.gz: 5fe4ccf57eaf5e65a1291b3c0714c094e512c6d1599f6190ad4dae787b86c845
+  metadata.gz: 02a8ff40a73da5d30250d02a5bfed53138036c65229f98b7b08aff3cee2a1333
+  data.tar.gz: f60df01fa25d8c5f882640ec7897382ecd109df7c4ef58e980c12472ff97c9d8
 SHA512:
-  metadata.gz: d8e43add6138188ae58691f6c8607e2c2a91efd2308579918473d12a912ac6f34d482dd2786daa21b840880774d2fe75cec5f99583742cddc6d84fa2d5fe4442
-  data.tar.gz: edcc020a32184faf3452069aeb18df5be485d7ff366a007ccc85b511e0cf9dea5510d9e2da72edbecc7afc1293e5bfd45b9751ef3732396957870d51660ccfb2
+  metadata.gz: 6944996acaa881427c510bf699fcf4451bb1e4632761b3c0b62247f6856c488e8b72ad7c78f666df92f4bbe8c54c73953c811db35defb30b8c955cf79da374dc
+  data.tar.gz: c157b393de6c93f30fcfd7ebbdb8d3a92c0a44c0a5bffe44f3665ad80709d6569b43fc76131f71f8c8ed18ebe81aa83f9d33dd9bde1706ed2eeb0970bee2b3cf

data/README.md

@@ -10,6 +10,14 @@ MailSlurp is an email API service that lets you create real email addresses in c
 - [Gem Package](https://rubygems.org/gems/mailslurp_client)
 - [Github Source](https://github.com/mailslurp/mailslurp-client-ruby)
 
+### Common controllers
+- [Email controller](https://www.mailslurp.com/docs/ruby/docs/EmailControllerApi/) send and receive emails
+- [Inbox controller](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/) create and manage email addresses
+- [WaitFor controller](https://www.mailslurp.com/docs/ruby/docs/WaitForControllerApi/) wait for expected emails to arrive
+
+
+### Example tutorials
+
 ## Get started
 
 This section describes how to get up and running with the Ruby client.
@@ -70,7 +78,7 @@ Here are some common uses:
 
 ### Create inboxes
 
-To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address.
+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://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/) for more information.
 
 ```ruby
 inbox_controller = MailSlurpClient::InboxControllerApi.new
@@ -120,7 +128,7 @@ end
 
 ### List inboxes
 
-Inboxes you create can be listed in a paginated way.
+Inboxes you create can be listed in a paginated way using the [InboxController](https://www.mailslurp.com/docs/ruby/docs/InboxControllerApi/)).
 
 ```ruby
 it 'can list inboxes' do
@@ -181,7 +189,7 @@ opts = {
 inbox_controller.send_email(inbox_1.id, opts)
 ```
 ### Receive emails
-
+To read already existing emails use the [Email Controller](https://www.mailslurp.com/docs/ruby/docs/EmailControllerApi/). To wait for expected emails to arrive use the [WaitFor Controller](https://www.mailslurp.com/docs/ruby/docs/WaitForControllerApi/).
 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:
 
@@ -214,7 +222,7 @@ code, * = match.captures
 
 ### Attachments
 
-You can send attachments by first uploading files with the `AttachmentControllerApi` then using the returned attachment IDs in the send email method.
+You can send attachments by first uploading files with the [AttachmentControllerApi](https://www.mailslurp.com/docs/ruby/docs/AttachmentControllerApi/) then using the returned attachment IDs in the send email method.
 
 MailSlurp endpoints use base64 string encoding for upload and download files. To encode or decode strings in Ruby make sure you use the **strict** variables that avoid added newlines.
 

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -470,7 +470,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email content
+    # Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
     # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters
@@ -481,7 +481,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email content
+    # Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
     # Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
     # @param email_id [String] emailId
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/models/inbox.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Representation of an inbox with an email address. Emails can be sent to or from this email address.
+  # Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments.
   class Inbox
     # When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
     attr_accessor :created_at
@@ -36,13 +36,13 @@ module MailSlurpClient
     # Name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
-    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
     attr_accessor :read_only
 
     # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
-    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
     attr_accessor :team_access
 
     # ID of user that inbox belongs to

data/lib/mailslurp_client/models/organization_inbox_projection.rb

@@ -29,13 +29,13 @@ module MailSlurpClient
     # Name of the inbox. Displayed in the dashboard for easier search
     attr_accessor :name
 
-    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified.
+    # Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
     attr_accessor :read_only
 
     # Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
     attr_accessor :tags
 
-    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it.
+    # Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at https://www.mailslurp.com/guides/team-email-account-sharing/
     attr_accessor :team_access
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '11.9.1'
+  VERSION = '11.9.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 11.9.1
+  version: 11.9.7
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.