mailslurp_client 11.16666.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6657d1b8c1534a2d38ff9915d2bcbadb372ecb43862f13166d85dde81c3f5dd
-  data.tar.gz: 05c885f72bdcc988e20d8788dac50ecc274cb04196179982d99e84c098f5068f
+  metadata.gz: 60f577d6063320652418dd98cc34b8c5eac1520c9de0502b5618b15074eb174a
+  data.tar.gz: 8c5f529426d03525054f96133e15c367aa2eb05c9aa5035f30d9bd6870c183b9
 SHA512:
-  metadata.gz: b94e72b897ef85627079f0b578c430253bd3bdb3a3ac7c9a10b45c6aa073478e675c18c6e2a4df5d43232d507c584f852d7e00ff899d8bd8db145e61b7751404
-  data.tar.gz: 77416b34c3166778a16f36e0a6fcfb4306efd7fd7086c00574daadd14cb71019bb390c8a1a26b0626e577beaf0334e55288b16985d2f72a71a6c3e50f067a922
+  metadata.gz: ec20b6535a6cbc97d2d2de3d2e841a639a12a1a77a9707249f833a587e7c33bb0d988ca42697e7e81c9f22f7a055094679adf8f1bef79e07c270dddf4db16137
+  data.tar.gz: aea00c01340e7b541c2b512c9e9850413844bcba73542ed688eec20bbbfe1a6051cac661f1adfe769c2e08916c2bc7f52eb815c37096dac94d4dc1f63faa1607

data/lib/mailslurp_client.rb

@@ -20,8 +20,8 @@ require 'mailslurp_client/configuration'
 require 'mailslurp_client/models/abstract_webhook_payload'
 require 'mailslurp_client/models/alias_dto'
 require 'mailslurp_client/models/alias_projection'
-require 'mailslurp_client/models/attachment_entity'
 require 'mailslurp_client/models/attachment_meta_data'
+require 'mailslurp_client/models/attachment_projection'
 require 'mailslurp_client/models/basic_auth_options'
 require 'mailslurp_client/models/bulk_send_email_options'
 require 'mailslurp_client/models/contact_dto'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -268,6 +268,7 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [Integer] :page Optional page index event list pagination (default to 0)
     # @option opts [Integer] :size Optional page size event list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
@@ -280,6 +281,7 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [Integer] :page Optional page index event list pagination
     # @option opts [Integer] :size Optional page size event list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
@@ -297,6 +299,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'fileNameFilter'] = opts[:'file_name_filter'] if !opts[:'file_name_filter'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -204,7 +204,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
+    # Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -215,7 +215,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
+    # Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -397,7 +397,7 @@ module MailSlurpClient
     end
 
     # Forward email to recipients
-    # Forward an existing email to new recipients.
+    # Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
@@ -408,7 +408,7 @@ module MailSlurpClient
     end
 
     # Forward email to recipients
-    # Forward an existing email to new recipients.
+    # Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
@@ -532,7 +532,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all email attachment metadata. Metadata includes name and attachment size.
+    # Get all email attachment metadata. Metadata includes name and size of attachments.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -542,7 +542,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all email attachment metadata. Metadata includes name and attachment size.
+    # Get all email attachment metadata. Metadata includes name and size of attachments.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -927,7 +927,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all emails in all inboxes. Email API list all.
+    # Get all emails in all inboxes in paginated form. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -941,7 +941,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all emails in all inboxes. Email API list all.
+    # Get all emails in all inboxes in paginated form. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1446,7 +1446,7 @@ module MailSlurpClient
     end
 
     # Validate email HTML contents
-    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [ValidationDto]
@@ -1456,7 +1456,7 @@ module MailSlurpClient
     end
 
     # Validate email HTML contents
-    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(ValidationDto, Integer, Hash)>] ValidationDto data, response status code and response headers

data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_projection.rb}

@@ -13,17 +13,18 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  class AttachmentEntity
+  class AttachmentProjection
+    # Attachment ID
     attr_accessor :attachment_id
 
+    # Content length of attachment in bytes
     attr_accessor :content_length
 
+    # Content type of attachment.
     attr_accessor :content_type
 
     attr_accessor :created_at
 
-    attr_accessor :id
-
     attr_accessor :name
 
     attr_accessor :updated_at
@@ -37,7 +38,6 @@ module MailSlurpClient
         :'content_length' => :'contentLength',
         :'content_type' => :'contentType',
         :'created_at' => :'createdAt',
-        :'id' => :'id',
         :'name' => :'name',
         :'updated_at' => :'updatedAt',
         :'user_id' => :'userId'
@@ -51,7 +51,6 @@ module MailSlurpClient
         :'content_length' => :'Integer',
         :'content_type' => :'String',
         :'created_at' => :'DateTime',
-        :'id' => :'String',
         :'name' => :'String',
         :'updated_at' => :'DateTime',
         :'user_id' => :'String'
@@ -68,13 +67,13 @@ module MailSlurpClient
     # @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 `MailSlurpClient::AttachmentEntity` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::AttachmentProjection` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::AttachmentEntity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::AttachmentProjection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -95,10 +94,6 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -116,10 +111,6 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      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
@@ -138,7 +129,6 @@ 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 @attachment_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
@@ -154,7 +144,6 @@ module MailSlurpClient
           content_length == o.content_length &&
           content_type == o.content_type &&
           created_at == o.created_at &&
-          id == o.id &&
           name == o.name &&
           updated_at == o.updated_at &&
           user_id == o.user_id
@@ -169,7 +158,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachment_id, content_length, content_type, created_at, id, name, updated_at, user_id].hash
+      [attachment_id, content_length, content_type, created_at, name, updated_at, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/forward_email_options.rb

@@ -21,6 +21,9 @@ module MailSlurpClient
     # Optional cc recipients
     attr_accessor :cc
 
+    # Optional from override
+    attr_accessor :from
+
     # Subject for forwarded email
     attr_accessor :subject
 
@@ -32,6 +35,7 @@ module MailSlurpClient
       {
         :'bcc' => :'bcc',
         :'cc' => :'cc',
+        :'from' => :'from',
         :'subject' => :'subject',
         :'to' => :'to'
       }
@@ -42,6 +46,7 @@ module MailSlurpClient
       {
         :'bcc' => :'Array<String>',
         :'cc' => :'Array<String>',
+        :'from' => :'String',
         :'subject' => :'String',
         :'to' => :'Array<String>'
       }
@@ -80,6 +85,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
       if attributes.key?(:'subject')
         self.subject = attributes[:'subject']
       end
@@ -111,6 +120,7 @@ module MailSlurpClient
       self.class == o.class &&
           bcc == o.bcc &&
           cc == o.cc &&
+          from == o.from &&
           subject == o.subject &&
           to == o.to
     end
@@ -124,7 +134,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [bcc, cc, subject, to].hash
+      [bcc, cc, from, subject, to].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/page_attachment_entity.rb

@@ -57,7 +57,7 @@ module MailSlurpClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'content' => :'Array<AttachmentEntity>',
+        :'content' => :'Array<AttachmentProjection>',
         :'empty' => :'Boolean',
         :'first' => :'Boolean',
         :'last' => :'Boolean',

data/lib/mailslurp_client/models/page_sent_email_projection.rb

@@ -15,6 +15,7 @@ require 'date'
 module MailSlurpClient
   # Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.
   class PageSentEmailProjection
+    # Collection of items
     attr_accessor :content
 
     attr_accessor :empty
@@ -23,18 +24,23 @@ module MailSlurpClient
 
     attr_accessor :last
 
+    # Page number starting at 0
     attr_accessor :number
 
+    # Number of items returned
     attr_accessor :number_of_elements
 
     attr_accessor :pageable
 
+    # Size of page requested
     attr_accessor :size
 
     attr_accessor :sort
 
+    # Total number of items available for querying
     attr_accessor :total_elements
 
+    # Total number of pages available
     attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/models/upload_attachment_options.rb

@@ -80,12 +80,17 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @base64_contents.nil?
+        invalid_properties.push('invalid value for "base64_contents", base64_contents 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 @base64_contents.nil?
       true
     end
 

data/lib/mailslurp_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 11.16666.0
+  version: 12.0.0
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-05-22 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.
@@ -46,8 +46,8 @@ files:
 - lib/mailslurp_client/models/abstract_webhook_payload.rb
 - lib/mailslurp_client/models/alias_dto.rb
 - lib/mailslurp_client/models/alias_projection.rb
-- lib/mailslurp_client/models/attachment_entity.rb
 - lib/mailslurp_client/models/attachment_meta_data.rb
+- lib/mailslurp_client/models/attachment_projection.rb
 - lib/mailslurp_client/models/basic_auth_options.rb
 - lib/mailslurp_client/models/bulk_send_email_options.rb
 - lib/mailslurp_client/models/contact_dto.rb