mailslurp_client 11.8.5 → 11.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780bee8a1b3a2c9b4ade2473c1b15df9a823c279b6cb239fe1e97c77b9ec0fc4
-  data.tar.gz: c32c5feae01ce487df31b625e53ef5d815701935fd2c0842f3bd4f50b89a48f0
+  metadata.gz: 6867c00e2f8dad1441bea7df5b91bf82411c42690c5dc9634c45fade5b7c63d2
+  data.tar.gz: 9b3421995e3525fb513a08251b76b570d43881b395598ccc81d3c5632f53b059
 SHA512:
-  metadata.gz: 20f75845fae597b3c43e8742bc7ed6d2bbef73dbdfc09823ad7a68a90c7fca610bfb143a9a64f85081d12f3530d6a1f67e793b1dab39ab52c92e1f797a7d8edb
-  data.tar.gz: 9a7156c4080e3fbe36e94c06a8397163c450b0ebf97ce47f34eebd5cedb2e51b6f1e4362b6694af5fdd8d5a094384b559bb1084d328ba4c7e4d8e7223ba6034d
+  metadata.gz: 693859869f69748f75192d1aa90dc6af9ecb1cb6028258d51c4ac502057a8fc15dcddb8035f8aef493b743d15cc0948fb49260ecb5a15869f650b69548f1ca7c
+  data.tar.gz: ac9e5bc9858733932da00dac7172893d49d8b9884c5d2522834fccec81a0ce5f99f3184308c56775f31df2dfd243a95afbc4fbda2ed1f8cb513a6884a2fb01d9

data/lib/mailslurp_client.rb

@@ -104,6 +104,7 @@ require 'mailslurp_client/models/validation_message'
 require 'mailslurp_client/models/verify_email_address_options'
 require 'mailslurp_client/models/wait_for_conditions'
 require 'mailslurp_client/models/webhook_dto'
+require 'mailslurp_client/models/webhook_payload'
 require 'mailslurp_client/models/webhook_projection'
 require 'mailslurp_client/models/webhook_test_request'
 require 'mailslurp_client/models/webhook_test_response'

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -803,7 +803,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. 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.
@@ -817,7 +817,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all emails
+    # Get all emails in all inboxes. 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.
@@ -996,7 +996,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team 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.
@@ -1010,7 +1010,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all organization emails
+    # Get all organization emails. List team or shared test email accounts
     # By default returns all emails across all team 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.
@@ -1196,7 +1196,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [UnreadCount]
     def get_unread_email_count(opts = {})
@@ -1205,7 +1205,7 @@ module MailSlurpClient
     end
 
     # Get unread email count
-    # Get number of emails unread
+    # Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
     # @param [Hash] opts the optional parameters
     # @return [Array<(UnreadCount, Integer, Hash)>] UnreadCount data, response status code and response headers
     def get_unread_email_count_with_http_info(opts = {})

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -156,8 +156,8 @@ module MailSlurpClient
     # List Webhooks Paginated
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size in inbox list pagination (default to 20)
+    # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageWebhookProjection]
     def get_all_webhooks(opts = {})
@@ -168,8 +168,8 @@ module MailSlurpClient
     # List Webhooks Paginated
     # List webhooks in paginated form. Allows for page index, page size, and sort direction.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Optional page index in inbox list pagination
-    # @option opts [Integer] :size Optional page size in inbox list pagination
+    # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageWebhookProjection, Integer, Hash)>] PageWebhookProjection data, response status code and response headers
     def get_all_webhooks_with_http_info(opts = {})
@@ -222,6 +222,60 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get test webhook payload example
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookPayload]
+    def get_test_webhook_payload(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_with_http_info(opts)
+      data
+    end
+
+    # Get test webhook payload example
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookPayload, Integer, Hash)>] WebhookPayload data, response status code and response headers
+    def get_test_webhook_payload_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test'
+
+      # 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(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'WebhookPayload' 
+
+      # 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: WebhookControllerApi#get_test_webhook_payload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a webhook for an Inbox
     # @param webhook_id [String] webhookId
     # @param [Hash] opts the optional parameters
@@ -282,7 +336,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all Webhooks for an Inbox
+    # Get all webhooks for an Inbox
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [Array<WebhookDto>]
@@ -291,7 +345,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all Webhooks for an Inbox
+    # Get all webhooks for an Inbox
     # @param inbox_id [String] inboxId
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<WebhookDto>, Integer, Hash)>] Array<WebhookDto> data, response status code and response headers

data/lib/mailslurp_client/models/webhook_payload.rb

@@ -0,0 +1,370 @@
+=begin
+#MailSlurp API
+
+#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.   ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # MailSlurp webhook payload schema. This schema describes the JSON object that is sent via HTTP POST to webhook urls when an email is received by an inbox that a webhook is attached to. Payloads may be delivered multiple times so use the ID as a key for event uniqueness. The payload contains IDs for the email and inbox affected. Use these to fetch more data related to the event using appropriate inbox and email endpoints. See https://www.mailslurp.com/guides/email-webhooks/ for more information. Your webhook endpoint should accept POST HTTP request and return a 200 in under 30 seconds. Process the webhook asynchronously if you need to.
+  class WebhookPayload
+    # List of attachment meta data objects if attachments present
+    attr_accessor :attachment_meta_datas
+
+    # List of `BCC` recipients email was addressed to
+    attr_accessor :bcc
+
+    # List of `CC` recipients email was addressed to
+    attr_accessor :cc
+
+    # Date time of event creation
+    attr_accessor :created_at
+
+    # ID of the email that was received. Use this ID for fetching the email
+    attr_accessor :email_id
+
+    # Name of the event type webhook is being triggered for
+    attr_accessor :event_name
+
+    # Who the email was sent from
+    attr_accessor :from
+
+    # Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
+    attr_accessor :id
+
+    # Id of the inbox that receive an email
+    attr_accessor :inbox_id
+
+    # The subject line of the email message
+    attr_accessor :subject
+
+    # List of `To` recipients email was addressed to
+    attr_accessor :to
+
+    # ID of webhook entity being triggered
+    attr_accessor :webhook_id
+
+    # Name of the webhook being triggered
+    attr_accessor :webhook_name
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_meta_datas' => :'attachmentMetaDatas',
+        :'bcc' => :'bcc',
+        :'cc' => :'cc',
+        :'created_at' => :'createdAt',
+        :'email_id' => :'emailId',
+        :'event_name' => :'eventName',
+        :'from' => :'from',
+        :'id' => :'id',
+        :'inbox_id' => :'inboxId',
+        :'subject' => :'subject',
+        :'to' => :'to',
+        :'webhook_id' => :'webhookId',
+        :'webhook_name' => :'webhookName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attachment_meta_datas' => :'Array<AttachmentMetaData>',
+        :'bcc' => :'Array<String>',
+        :'cc' => :'Array<String>',
+        :'created_at' => :'DateTime',
+        :'email_id' => :'String',
+        :'event_name' => :'String',
+        :'from' => :'String',
+        :'id' => :'String',
+        :'inbox_id' => :'String',
+        :'subject' => :'String',
+        :'to' => :'Array<String>',
+        :'webhook_id' => :'String',
+        :'webhook_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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::WebhookPayload` 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::WebhookPayload`. 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
+      }
+
+      if attributes.key?(:'attachment_meta_datas')
+        if (value = attributes[:'attachment_meta_datas']).is_a?(Array)
+          self.attachment_meta_datas = value
+        end
+      end
+
+      if attributes.key?(:'bcc')
+        if (value = attributes[:'bcc']).is_a?(Array)
+          self.bcc = value
+        end
+      end
+
+      if attributes.key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'email_id')
+        self.email_id = attributes[:'email_id']
+      end
+
+      if attributes.key?(:'event_name')
+        self.event_name = attributes[:'event_name']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      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
+      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?
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED"])
+      return false unless event_name_validator.valid?(@event_name)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_name Object to be assigned
+    def event_name=(event_name)
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED"])
+      unless validator.valid?(event_name)
+        fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
+      end
+      @event_name = event_name
+    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 &&
+          attachment_meta_datas == o.attachment_meta_datas &&
+          bcc == o.bcc &&
+          cc == o.cc &&
+          created_at == o.created_at &&
+          email_id == o.email_id &&
+          event_name == o.event_name &&
+          from == o.from &&
+          id == o.id &&
+          inbox_id == o.inbox_id &&
+          subject == o.subject &&
+          to == o.to &&
+          webhook_id == o.webhook_id &&
+          webhook_name == o.webhook_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [attachment_meta_datas, bcc, cc, created_at, email_id, event_name, from, id, inbox_id, subject, to, webhook_id, webhook_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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 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
+        MailSlurpClient.const_get(type).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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 11.8.5
+  version: 11.8.11
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-25 00:00:00.000000000 Z
+date: 2021-04-29 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.
@@ -130,6 +130,7 @@ files:
 - lib/mailslurp_client/models/verify_email_address_options.rb
 - lib/mailslurp_client/models/wait_for_conditions.rb
 - lib/mailslurp_client/models/webhook_dto.rb
+- lib/mailslurp_client/models/webhook_payload.rb
 - lib/mailslurp_client/models/webhook_projection.rb
 - lib/mailslurp_client/models/webhook_test_request.rb
 - lib/mailslurp_client/models/webhook_test_response.rb