mailslurp_client 15.12.14 → 15.12.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5115bc2f8ca0c4cbfe748f3e3c7d6eae3d8aa1ab4711fab5e3eaea505364e81
-  data.tar.gz: 5d8ee9139852ead5bfed33d4addfc9b30ec967516cd3f3522ca7dc4d8d0741c2
+  metadata.gz: 1b8e7e366076b52e650de96ef4978c5a3aa66496afc619770c3ec9729b4589eb
+  data.tar.gz: 8bb32eb87a3d0d93aa92862d382f1fa2ea1c62341225dfe2ce9047bae43be7aa
 SHA512:
-  metadata.gz: 3a375671aad02955aa43a22aab055768224ef24573b433ac210035b4e9b6c6e240c64bd5ecd5594213b35e6660dd52169dc40fb7360562ada40a90b7ad453d95
-  data.tar.gz: db485fe77b62ddb0d681faee23296f505ad7d9dc957b5380a12e73af8832d97ed0b8d33102e2b53bd7a4a54d26392e8d92f3f13464370c55bc41bff949515227
+  metadata.gz: 7847af2adeaee0f7c7f058b7364225a3455c5ad8cee0ba6bd1e79e3ea0e0b170e3d356234db273c171651e5e7a0778d29f9633112554930f66b807f3fe758eb0
+  data.tar.gz: cae9e3474cf492b809b9b2cfe2bce0fe98e05939b9cccad3832513a52e7981f69c3386ac52f75892974f7443247d84875d6137278fd75663c85e5ed7a7ea0150

data/lib/mailslurp_client/api/api_user_controller_api.rb

@@ -19,6 +19,110 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_smtp_password(opts = {})
+      data, _status_code, _headers = get_smtp_password_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_smtp_password_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiUserControllerApi.get_smtp_password ...'
+      end
+      # resource path
+      local_var_path = '/user/smtp/password'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiUserControllerApi#get_smtp_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_smtp_username(opts = {})
+      data, _status_code, _headers = get_smtp_username_with_http_info(opts)
+      data
+    end
+
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_smtp_username_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiUserControllerApi.get_smtp_username ...'
+      end
+      # resource path
+      local_var_path = '/user/smtp/username'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'String' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiUserControllerApi#get_smtp_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # @param [Hash] opts the optional parameters
     # @return [UserInfoDto]
     def get_user_info(opts = {})

data/lib/mailslurp_client/models/alias_projection.rb

@@ -19,12 +19,12 @@ module MailSlurpClient
 
     attr_accessor :id
 
+    attr_accessor :inbox_id
+
     attr_accessor :user_id
 
     attr_accessor :email_address
 
-    attr_accessor :inbox_id
-
     attr_accessor :created_at
 
     attr_accessor :updated_at
@@ -36,9 +36,9 @@ module MailSlurpClient
       {
         :'name' => :'name',
         :'id' => :'id',
+        :'inbox_id' => :'inboxId',
         :'user_id' => :'userId',
         :'email_address' => :'emailAddress',
-        :'inbox_id' => :'inboxId',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'use_threads' => :'useThreads'
@@ -50,9 +50,9 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'id' => :'String',
+        :'inbox_id' => :'String',
         :'user_id' => :'String',
         :'email_address' => :'String',
-        :'inbox_id' => :'String',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
         :'use_threads' => :'Boolean'
@@ -88,6 +88,10 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -96,10 +100,6 @@ module MailSlurpClient
         self.email_address = attributes[:'email_address']
       end
 
-      if attributes.key?(:'inbox_id')
-        self.inbox_id = attributes[:'inbox_id']
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -121,6 +121,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
+      if @inbox_id.nil?
+        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
+      end
+
       if @user_id.nil?
         invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
       end
@@ -129,10 +133,6 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
       end
 
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -148,9 +148,9 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
+      return false if @inbox_id.nil?
       return false if @user_id.nil?
       return false if @email_address.nil?
-      return false if @inbox_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       true
@@ -163,9 +163,9 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           id == o.id &&
+          inbox_id == o.inbox_id &&
           user_id == o.user_id &&
           email_address == o.email_address &&
-          inbox_id == o.inbox_id &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           use_threads == o.use_threads
@@ -180,7 +180,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, id, user_id, email_address, inbox_id, created_at, updated_at, use_threads].hash
+      [name, id, inbox_id, user_id, email_address, created_at, updated_at, use_threads].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/attachment_projection.rb

@@ -20,9 +20,6 @@ module MailSlurpClient
     # Content length of attachment in bytes
     attr_accessor :content_length
 
-    # Content type of attachment.
-    attr_accessor :content_type
-
     attr_accessor :user_id
 
     # Attachment ID
@@ -32,16 +29,19 @@ module MailSlurpClient
 
     attr_accessor :updated_at
 
+    # Content type of attachment.
+    attr_accessor :content_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'content_length' => :'contentLength',
-        :'content_type' => :'contentType',
         :'user_id' => :'userId',
         :'attachment_id' => :'attachmentId',
         :'created_at' => :'createdAt',
-        :'updated_at' => :'updatedAt'
+        :'updated_at' => :'updatedAt',
+        :'content_type' => :'contentType'
       }
     end
 
@@ -50,11 +50,11 @@ module MailSlurpClient
       {
         :'name' => :'String',
         :'content_length' => :'Integer',
-        :'content_type' => :'String',
         :'user_id' => :'String',
         :'attachment_id' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'content_type' => :'String'
       }
     end
 
@@ -87,10 +87,6 @@ module MailSlurpClient
         self.content_length = attributes[:'content_length']
       end
 
-      if attributes.key?(:'content_type')
-        self.content_type = attributes[:'content_type']
-      end
-
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -106,6 +102,10 @@ module MailSlurpClient
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -148,11 +148,11 @@ module MailSlurpClient
       self.class == o.class &&
           name == o.name &&
           content_length == o.content_length &&
-          content_type == o.content_type &&
           user_id == o.user_id &&
           attachment_id == o.attachment_id &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          content_type == o.content_type
     end
 
     # @see the `==` method
@@ -164,7 +164,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, content_length, content_type, user_id, attachment_id, created_at, updated_at].hash
+      [name, content_length, user_id, attachment_id, created_at, updated_at, content_type].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_projection.rb

@@ -17,25 +17,25 @@ module MailSlurpClient
   class BounceProjection
     attr_accessor :id
 
-    attr_accessor :subject
-
     attr_accessor :sender
 
-    attr_accessor :created_at
+    attr_accessor :subject
 
-    attr_accessor :bounce_mta
+    attr_accessor :created_at
 
     attr_accessor :bounce_type
 
+    attr_accessor :bounce_mta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'subject' => :'subject',
         :'sender' => :'sender',
+        :'subject' => :'subject',
         :'created_at' => :'createdAt',
-        :'bounce_mta' => :'bounceMta',
-        :'bounce_type' => :'bounceType'
+        :'bounce_type' => :'bounceType',
+        :'bounce_mta' => :'bounceMta'
       }
     end
 
@@ -43,11 +43,11 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'id' => :'String',
-        :'subject' => :'String',
         :'sender' => :'String',
+        :'subject' => :'String',
         :'created_at' => :'DateTime',
-        :'bounce_mta' => :'String',
-        :'bounce_type' => :'String'
+        :'bounce_type' => :'String',
+        :'bounce_mta' => :'String'
       }
     end
 
@@ -76,25 +76,25 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'subject')
-        self.subject = attributes[:'subject']
-      end
-
       if attributes.key?(:'sender')
         self.sender = attributes[:'sender']
       end
 
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
       end
 
-      if attributes.key?(:'bounce_mta')
-        self.bounce_mta = attributes[:'bounce_mta']
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
       end
 
       if attributes.key?(:'bounce_type')
         self.bounce_type = attributes[:'bounce_type']
       end
+
+      if attributes.key?(:'bounce_mta')
+        self.bounce_mta = attributes[:'bounce_mta']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,11 +126,11 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          subject == o.subject &&
           sender == o.sender &&
+          subject == o.subject &&
           created_at == o.created_at &&
-          bounce_mta == o.bounce_mta &&
-          bounce_type == o.bounce_type
+          bounce_type == o.bounce_type &&
+          bounce_mta == o.bounce_mta
     end
 
     # @see the `==` method
@@ -142,7 +142,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, subject, sender, created_at, bounce_mta, bounce_type].hash
+      [id, sender, subject, created_at, bounce_type, bounce_mta].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/bounce_recipient_projection.rb

@@ -17,8 +17,6 @@ module MailSlurpClient
   class BounceRecipientProjection
     attr_accessor :id
 
-    attr_accessor :action
-
     attr_accessor :status
 
     attr_accessor :sent_email_id
@@ -27,15 +25,17 @@ module MailSlurpClient
 
     attr_accessor :recipient
 
+    attr_accessor :action
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'action' => :'action',
         :'status' => :'status',
         :'sent_email_id' => :'sentEmailId',
         :'created_at' => :'createdAt',
-        :'recipient' => :'recipient'
+        :'recipient' => :'recipient',
+        :'action' => :'action'
       }
     end
 
@@ -43,11 +43,11 @@ module MailSlurpClient
     def self.openapi_types
       {
         :'id' => :'String',
-        :'action' => :'String',
         :'status' => :'String',
         :'sent_email_id' => :'String',
         :'created_at' => :'DateTime',
-        :'recipient' => :'String'
+        :'recipient' => :'String',
+        :'action' => :'String'
       }
     end
 
@@ -76,10 +76,6 @@ module MailSlurpClient
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'action')
-        self.action = attributes[:'action']
-      end
-
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -95,6 +91,10 @@ module MailSlurpClient
       if attributes.key?(:'recipient')
         self.recipient = attributes[:'recipient']
       end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -126,11 +126,11 @@ module MailSlurpClient
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          action == o.action &&
           status == o.status &&
           sent_email_id == o.sent_email_id &&
           created_at == o.created_at &&
-          recipient == o.recipient
+          recipient == o.recipient &&
+          action == o.action
     end
 
     # @see the `==` method
@@ -142,7 +142,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, action, status, sent_email_id, created_at, recipient].hash
+      [id, status, sent_email_id, created_at, recipient, action].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_webhook_options.rb

@@ -13,9 +13,9 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.
+  # Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale.
   class CreateWebhookOptions
-    # Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. The default `EMAIL_RECEIVED` payload is described by `https://ruby.api.mailslurp.com/schemas/webhook-payload`. The other events, `NEW_EMAIL`, `NEW_CONTACT`, and `NEW_ATTACHMENT` are described by `https://ruby.api.mailslurp.com/schemas/webhook-new-email-payload`, `https://ruby.api.mailslurp.com/schemas/webhook-new-contact-payload`,`https://ruby.api.mailslurp.com/schemas/webhook-new-attachment-payload` respectively.
+    # Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.
     attr_accessor :url
 
     attr_accessor :basic_auth
@@ -23,7 +23,7 @@ module MailSlurpClient
     # Optional name for the webhook
     attr_accessor :name
 
-    # Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. The other events are `NEW_EMAIL`, `NEW_CONTACT`, and `NEW_ATTACHMENT` and `EMAIL_OPENED`. `EMAIL_OPENED` requires the use of tracking pixels when sending. See the email tracking guide for more information.
+    # Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.
     attr_accessor :event_name
 
     attr_accessor :include_headers
@@ -76,7 +76,6 @@ module MailSlurpClient
     def self.openapi_nullable
       Set.new([
         :'basic_auth',
-        :'event_name',
       ])
     end
 
@@ -124,6 +123,10 @@ module MailSlurpClient
         invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
+      if @event_name.nil?
+        invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -131,6 +134,7 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @url.nil?
+      return false if @event_name.nil?
       event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"])
       return false unless event_name_validator.valid?(@event_name)
       true

data/lib/mailslurp_client/models/page_alias.rb

@@ -21,22 +21,22 @@ module MailSlurpClient
 
     attr_accessor :total
 
-    attr_accessor :last
-
     attr_accessor :total_elements
 
     attr_accessor :total_pages
 
+    attr_accessor :last
+
     attr_accessor :size
 
     attr_accessor :number
 
     attr_accessor :sort
 
-    attr_accessor :first
-
     attr_accessor :number_of_elements
 
+    attr_accessor :first
+
     attr_accessor :empty
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -45,14 +45,14 @@ module MailSlurpClient
         :'content' => :'content',
         :'pageable' => :'pageable',
         :'total' => :'total',
-        :'last' => :'last',
         :'total_elements' => :'totalElements',
         :'total_pages' => :'totalPages',
+        :'last' => :'last',
         :'size' => :'size',
         :'number' => :'number',
         :'sort' => :'sort',
-        :'first' => :'first',
         :'number_of_elements' => :'numberOfElements',
+        :'first' => :'first',
         :'empty' => :'empty'
       }
     end
@@ -63,14 +63,14 @@ module MailSlurpClient
         :'content' => :'Array<AliasProjection>',
         :'pageable' => :'PageableObject',
         :'total' => :'Integer',
-        :'last' => :'Boolean',
         :'total_elements' => :'Integer',
         :'total_pages' => :'Integer',
+        :'last' => :'Boolean',
         :'size' => :'Integer',
         :'number' => :'Integer',
         :'sort' => :'Sort',
-        :'first' => :'Boolean',
         :'number_of_elements' => :'Integer',
+        :'first' => :'Boolean',
         :'empty' => :'Boolean'
       }
     end
@@ -110,10 +110,6 @@ module MailSlurpClient
         self.total = attributes[:'total']
       end
 
-      if attributes.key?(:'last')
-        self.last = attributes[:'last']
-      end
-
       if attributes.key?(:'total_elements')
         self.total_elements = attributes[:'total_elements']
       end
@@ -122,6 +118,10 @@ module MailSlurpClient
         self.total_pages = attributes[:'total_pages']
       end
 
+      if attributes.key?(:'last')
+        self.last = attributes[:'last']
+      end
+
       if attributes.key?(:'size')
         self.size = attributes[:'size']
       end
@@ -134,14 +134,14 @@ module MailSlurpClient
         self.sort = attributes[:'sort']
       end
 
-      if attributes.key?(:'first')
-        self.first = attributes[:'first']
-      end
-
       if attributes.key?(:'number_of_elements')
         self.number_of_elements = attributes[:'number_of_elements']
       end
 
+      if attributes.key?(:'first')
+        self.first = attributes[:'first']
+      end
+
       if attributes.key?(:'empty')
         self.empty = attributes[:'empty']
       end
@@ -168,14 +168,14 @@ module MailSlurpClient
           content == o.content &&
           pageable == o.pageable &&
           total == o.total &&
-          last == o.last &&
           total_elements == o.total_elements &&
           total_pages == o.total_pages &&
+          last == o.last &&
           size == o.size &&
           number == o.number &&
           sort == o.sort &&
-          first == o.first &&
           number_of_elements == o.number_of_elements &&
+          first == o.first &&
           empty == o.empty
     end
 
@@ -188,7 +188,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content, pageable, total, last, total_elements, total_pages, size, number, sort, first, number_of_elements, empty].hash
+      [content, pageable, total, total_elements, total_pages, last, size, number, sort, number_of_elements, first, empty].hash
     end
 
     # Builds the object from hash